Replace NULLs with nullptr (#1544)

* nullptr fixes from clang-tidy

* fix some clang-tidy warnings + typo

* get rid of all NULLs

* remove unnecessary change

* fix comments

* Fix comments

* fix format

* fix comments

---------

Co-authored-by: Liu, An-Chi <[email protected]>

Author: egecetin

Common++/header/GeneralUtils.h

@@ -47,7 +47,7 @@ namespace pcpp
 	 * @param[in] haystackLen Length of the haystack buffer
 	 * @param[in] needle A pointer to a buffer that will be searched for
 	 * @param[in] needleLen Length of the needle buffer
-	 * @return A pointer to the beginning of the substring, or NULL if the substring is not found
+	 * @return A pointer to the beginning of the substring, or nullptr if the substring is not found
 	 */
 	char* cross_platform_memmem(const char* haystack, size_t haystackLen, const char* needle, size_t needleLen);
 

Common++/header/IpUtils.h

@@ -31,7 +31,7 @@
  * @param[in] src Network address structure, can be either in_addr (IPv4) or in6_addr (IPv6)
  * @param[out] dst Network address string representation
  * @param[in] size 'dst' Maximum size
- * @return pointer to presentation format address ('dst'), or NULL (see errno).
+ * @return pointer to presentation format address ('dst'), or nullptr (see errno).
  */
 const char* inet_ntop(int af, const void* src, char* dst, size_t size);
 

Common++/header/LRUList.h

@@ -44,12 +44,13 @@ namespace pcpp
 		 * this method will remove the least recently used element and return a value in deletedValue. Method complexity
 		 * is O(log(getSize())). This is a optimized version of the method T* put(const T&).
 		 * @param[in] element The element to insert or to advance to the head of the list (if already exists)
-		 * @param[out] deletedValue The value of deleted element if a pointer is not NULL. This parameter is optional.
+		 * @param[out] deletedValue The value of deleted element if a pointer is not nullptr. This parameter is
+		 * optional.
 		 * @return 0 if the list didn't reach its max size, 1 otherwise. In case the list already reached its max size
-		 * and deletedValue is not NULL the value of deleted element is copied into the place the deletedValue points
+		 * and deletedValue is not nullptr the value of deleted element is copied into the place the deletedValue points
 		 * to.
 		 */
-		int put(const T& element, T* deletedValue = NULL)
+		int put(const T& element, T* deletedValue = nullptr)
 		{
 			m_CacheItemsList.push_front(element);
 
@@ -68,7 +69,7 @@ namespace pcpp
 				ListIterator lruIter = m_CacheItemsList.end();
 				--lruIter;
 
-				if (deletedValue != NULL)
+				if (deletedValue != nullptr)
 #if __cplusplus > 199711L || _MSC_VER >= 1800
 					*deletedValue = std::move(*lruIter);
 #else

Common++/src/IpUtils.cpp

@@ -138,7 +138,7 @@ static const char* inet_ntop4(const uint8_t* src, char* dst, size_t size)
 	/* Note: nprinted *excludes* the trailing '\0' character */
 	if ((size_t)nprinted >= size)
 	{
-		return (NULL);
+		return (nullptr);
 	}
 	strncpy(dst, tmp, size);
 	return (dst);
@@ -226,7 +226,7 @@ static const char* inet_ntop6(const uint8_t* src, char* dst, size_t size)
 		if (i == 6 && best.base == 0 && (best.len == 6 || (best.len == 5 && words[5] == 0xffff)))
 		{
 			if (!inet_ntop4(src + 12, tp, sizeof tmp - (tp - tmp)))
-				return (NULL);
+				return (nullptr);
 			tp += strlen(tp);
 			break;
 		}
@@ -242,7 +242,7 @@ static const char* inet_ntop6(const uint8_t* src, char* dst, size_t size)
 	 */
 	if ((size_t)(tp - tmp) > size)
 	{
-		return (NULL);
+		return (nullptr);
 	}
 	strncpy(dst, tmp, size);
 	return (dst);
@@ -271,7 +271,7 @@ static int inet_pton4(const char* src, uint8_t* dst)
 	{
 		const char* pch;
 
-		if ((pch = strchr(digits, ch)) != NULL)
+		if ((pch = strchr(digits, ch)) != nullptr)
 		{
 			size_t newSize = *tp * 10 + (pch - digits);
 
@@ -324,7 +324,7 @@ static int inet_pton6(const char* src, uint8_t* dst)
 
 	memset((tp = tmp), '\0', NS_IN6ADDRSZ);
 	endp = tp + NS_IN6ADDRSZ;
-	colonp = NULL;
+	colonp = nullptr;
 	/* Leading :: requires some special handling. */
 	if (*src == ':')
 		if (*++src != ':')
@@ -336,9 +336,9 @@ static int inet_pton6(const char* src, uint8_t* dst)
 	{
 		const char *pch, *xdigits;
 
-		if ((pch = strchr((xdigits = xdigits_l), ch)) == NULL)
+		if ((pch = strchr((xdigits = xdigits_l), ch)) == nullptr)
 			pch = strchr((xdigits = xdigits_u), ch);
-		if (pch != NULL)
+		if (pch != nullptr)
 		{
 			val <<= 4;
 			val |= (pch - xdigits);
@@ -384,7 +384,7 @@ static int inet_pton6(const char* src, uint8_t* dst)
 		*tp++ = (u_char)(val >> 8) & 0xff;
 		*tp++ = (u_char)val & 0xff;
 	}
-	if (colonp != NULL)
+	if (colonp != nullptr)
 	{
 		/*
 		 * Since some memmove()'s erroneously fail to handle
@@ -417,7 +417,7 @@ const char* inet_ntop(int af, const void* src, char* dst, size_t size)
 	case AF_INET6:
 		return (inet_ntop6((const uint8_t*)src, dst, size));
 	default:
-		return (NULL);
+		return (nullptr);
 	}
 	/* NOTREACHED */
 }

Common++/src/SystemUtils.cpp

@@ -319,7 +319,7 @@ namespace pcpp
 		case CTRL_C_EVENT:
 		case CTRL_BREAK_EVENT:
 		{
-			if (ApplicationEventHandler::getInstance().m_ApplicationInterruptedHandler != NULL)
+			if (ApplicationEventHandler::getInstance().m_ApplicationInterruptedHandler != nullptr)
 				ApplicationEventHandler::getInstance().m_ApplicationInterruptedHandler(
 				    ApplicationEventHandler::getInstance().m_ApplicationInterruptedCookie);
 			return TRUE;
@@ -341,7 +341,7 @@ namespace pcpp
 		{
 			// Most calls are unsafe in a signal handler, and this includes printf(). In particular,
 			// if the signal is caught while inside printf() it may be called twice at the same time which might not be
-			// a good idea The way to make sure the signal is called only once is using this lock and putting NULL in
+			// a good idea The way to make sure the signal is called only once is using this lock and putting nullptr in
 			// m_ApplicationInterruptedHandler
 			const std::lock_guard<std::mutex> lock(UnixLinuxHandlerRoutineMutex);
 

Examples/DpdkBridge/AppWorkerThread.h

@@ -66,7 +66,7 @@ class AppWorkerThread : public pcpp::DpdkWorkerThread
 		// free packet array (frees all mbufs as well)
 		for (int i = 0; i < MAX_RECEIVE_BURST; i++)
 		{
-			if (packetArr[i] != NULL)
+			if (packetArr[i] != nullptr)
 				delete packetArr[i];
 		}
 

Examples/DpdkBridge/Common.h

@@ -44,6 +44,6 @@ struct AppWorkerConfig
 	uint16_t RxQueues;
 	pcpp::DpdkDevice* TxDevice;
 
-	AppWorkerConfig() : CoreId(MAX_NUM_OF_CORES + 1), RxDevice(NULL), RxQueues(1), TxDevice(NULL)
+	AppWorkerConfig() : CoreId(MAX_NUM_OF_CORES + 1), RxDevice(nullptr), RxQueues(1), TxDevice(nullptr)
 	{}
 };

Examples/DpdkBridge/main.cpp

@@ -47,14 +47,14 @@
 
 // clang-format off
 static struct option DpdkBridgeOptions[] = {
-	{ "dpdk-ports",     required_argument, 0, 'd' },
-	{ "core-mask",      optional_argument, 0, 'c' },
-	{ "mbuf-pool-size", optional_argument, 0, 'm' },
-	{ "queue-quantity", optional_argument, 0, 'q' },
-	{ "help",           optional_argument, 0, 'h' },
-	{ "list",           optional_argument, 0, 'l' },
-	{ "version",        optional_argument, 0, 'v' },
-	{ 0,                0,                 0, 0   }
+	{ "dpdk-ports",     required_argument, nullptr, 'd' },
+	{ "core-mask",      optional_argument, nullptr, 'c' },
+	{ "mbuf-pool-size", optional_argument, nullptr, 'm' },
+	{ "queue-quantity", optional_argument, nullptr, 'q' },
+	{ "help",           optional_argument, nullptr, 'h' },
+	{ "list",           optional_argument, nullptr, 'l' },
+	{ "version",        optional_argument, nullptr, 'v' },
+	{ nullptr,          0,                 nullptr,  0  }
 };
 // clang-format on
 
@@ -137,7 +137,7 @@ struct DpdkBridgeArgs
 	bool shouldStop;
 	std::vector<pcpp::DpdkWorkerThread*>* workerThreadsVector;
 
-	DpdkBridgeArgs() : shouldStop(false), workerThreadsVector(NULL)
+	DpdkBridgeArgs() : shouldStop(false), workerThreadsVector(nullptr)
 	{}
 };
 
@@ -321,7 +321,7 @@ int main(int argc, char* argv[])
 	for (const auto& port : dpdkPortVec)
 	{
 		pcpp::DpdkDevice* dev = pcpp::DpdkDeviceList::getInstance().getDeviceByPort(port);
-		if (dev == NULL)
+		if (dev == nullptr)
 		{
 			EXIT_WITH_ERROR("DPDK device for port " << port << " doesn't exist");
 		}

Examples/DpdkExample-FilterTraffic/AppWorkerThread.h

@@ -48,7 +48,7 @@ class AppWorkerThread : public pcpp::DpdkWorkerThread
 		m_Stop = false;
 		m_Stats.workerId = coreId;
 		pcpp::DpdkDevice* sendPacketsTo = m_WorkerConfig.sendPacketsTo;
-		pcpp::PcapFileWriterDevice* pcapWriter = NULL;
+		pcpp::PcapFileWriterDevice* pcapWriter = nullptr;
 
 		// if needed, create the pcap file writer which all matched packets will be written into
 		if (m_WorkerConfig.writeMatchedPacketsToFile)
@@ -127,13 +127,13 @@ class AppWorkerThread : public pcpp::DpdkWorkerThread
 						if (packetMatched)
 						{
 							// send packet to TX port if needed
-							if (sendPacketsTo != NULL)
+							if (sendPacketsTo != nullptr)
 							{
 								sendPacketsTo->sendPacket(*packetArr[i], 0);
 							}
 
 							// save packet to file if needed
-							if (pcapWriter != NULL)
+							if (pcapWriter != nullptr)
 							{
 								pcapWriter->writePacket(*packetArr[i]);
 							}
@@ -148,12 +148,12 @@ class AppWorkerThread : public pcpp::DpdkWorkerThread
 		// free packet array (frees all mbufs as well)
 		for (int i = 0; i < MAX_RECEIVE_BURST; i++)
 		{
-			if (packetArr[i] != NULL)
+			if (packetArr[i] != nullptr)
 				delete packetArr[i];
 		}
 
 		// close and delete pcap file writer
-		if (pcapWriter != NULL)
+		if (pcapWriter != nullptr)
 		{
 			delete pcapWriter;
 		}

Examples/DpdkExample-FilterTraffic/main.cpp

@@ -44,22 +44,22 @@
 
 // clang-format off
 static struct option FilterTrafficOptions[] = {
-	{ "dpdk-ports",           required_argument, 0, 'd' },
-	{ "send-matched-packets", optional_argument, 0, 's' },
-	{ "save-matched-packets", optional_argument, 0, 'f' },
-	{ "match-source-ip",      optional_argument, 0, 'i' },
-	{ "match-dest-ip",        optional_argument, 0, 'I' },
-	{ "match-source-port",    optional_argument, 0, 'p' },
-	{ "match-dest-port",      optional_argument, 0, 'P' },
-	{ "match-protocol",       optional_argument, 0, 'o' },
-	{ "core-mask",            optional_argument, 0, 'c' },
-	{ "mbuf-pool-size",       optional_argument, 0, 'm' },
-	{ "rx-queues",            optional_argument, 0, 'r' },
-	{ "tx-queues",            optional_argument, 0, 't' },
-	{ "help",                 optional_argument, 0, 'h' },
-	{ "version",              optional_argument, 0, 'v' },
-	{ "list",                 optional_argument, 0, 'l' },
-	{ 0,	                     0,                 0, 0   }
+	{ "dpdk-ports",           required_argument, nullptr, 'd' },
+	{ "send-matched-packets", optional_argument, nullptr, 's' },
+	{ "save-matched-packets", optional_argument, nullptr, 'f' },
+	{ "match-source-ip",      optional_argument, nullptr, 'i' },
+	{ "match-dest-ip",        optional_argument, nullptr, 'I' },
+	{ "match-source-port",    optional_argument, nullptr, 'p' },
+	{ "match-dest-port",      optional_argument, nullptr, 'P' },
+	{ "match-protocol",       optional_argument, nullptr, 'o' },
+	{ "core-mask",            optional_argument, nullptr, 'c' },
+	{ "mbuf-pool-size",       optional_argument, nullptr, 'm' },
+	{ "rx-queues",            optional_argument, nullptr, 'r' },
+	{ "tx-queues",            optional_argument, nullptr, 't' },
+	{ "help",                 optional_argument, nullptr, 'h' },
+	{ "version",              optional_argument, nullptr, 'v' },
+	{ "list",                 optional_argument, nullptr, 'l' },
+	{ nullptr,                0,                 nullptr,  0  }
 };
 // clang-format on
 
@@ -235,7 +235,7 @@ struct FilterTrafficArgs
 	bool shouldStop;
 	std::vector<pcpp::DpdkWorkerThread*>* workerThreadsVector;
 
-	FilterTrafficArgs() : shouldStop(false), workerThreadsVector(NULL)
+	FilterTrafficArgs() : shouldStop(false), workerThreadsVector(nullptr)
 	{}
 };
 
@@ -545,7 +545,7 @@ int main(int argc, char* argv[])
 	for (const auto& port : dpdkPortVec)
 	{
 		pcpp::DpdkDevice* dev = pcpp::DpdkDeviceList::getInstance().getDeviceByPort(port);
-		if (dev == NULL)
+		if (dev == nullptr)
 		{
 			EXIT_WITH_ERROR("DPDK device for port " << port << " doesn't exist");
 		}
@@ -581,9 +581,9 @@ int main(int argc, char* argv[])
 		}
 	}
 
-	// get DPDK device to send packets to (or NULL if doesn't exist)
+	// get DPDK device to send packets to (or nullptr if doesn't exist)
 	pcpp::DpdkDevice* sendPacketsTo = pcpp::DpdkDeviceList::getInstance().getDeviceByPort(sendPacketsToPort);
-	if (sendPacketsTo != NULL && !sendPacketsTo->isOpened() && !sendPacketsTo->open())
+	if (sendPacketsTo != nullptr && !sendPacketsTo->isOpened() && !sendPacketsTo->open())
 	{
 		EXIT_WITH_ERROR("Could not open port#" << sendPacketsToPort << " for sending matched packets");
 	}