fix: avoid macro replacements in includes

Use strings in include strings definitions to avoid replacements by macros. This solves the issues with errno.h which could have end up in strange include errors, before.
dgreatwood · Dec 24, 2024 · 53e60a6 · 53e60a6
1 parent 6e45748
commit 53e60a6
Show file tree

Hide file tree

Showing 32 changed files with 149 additions and 142 deletions.
diff --git a/include/pistache/common.h b/include/pistache/common.h
@@ -20,10 +20,10 @@
 
 #include <pistache/winornix.h>
 
-#include PIST_QUOTE(PST_STRERROR_R_HDR)
+#include PST_STRERROR_R_HDR
 
-#include PIST_QUOTE(PST_NETDB_HDR)
-#include PIST_QUOTE(PST_SOCKET_HDR)
+#include PST_NETDB_HDR
+#include PST_SOCKET_HDR
 
 #include <sys/types.h>
 

diff --git a/include/pistache/eventmeth.h b/include/pistache/eventmeth.h
@@ -209,7 +209,7 @@ namespace Pistache
 #include <map>
 #include <condition_variable>
 
-#include PIST_QUOTE(PST_FCNTL_HDR) // For FD_CLOEXEC and O_NONBLOCK
+#include PST_FCNTL_HDR // For FD_CLOEXEC and O_NONBLOCK
 
 /* ------------------------------------------------------------------------- */
 

diff --git a/include/pistache/listener.h b/include/pistache/listener.h
@@ -24,7 +24,7 @@
 #include <pistache/ssl_wrappers.h>
 #include <pistache/tcp.h>
 
-#include PIST_QUOTE(PST_SYS_RESOURCE_HDR)
+#include PST_SYS_RESOURCE_HDR
 
 #include <memory>
 #include <thread>

diff --git a/include/pistache/mailbox.h b/include/pistache/mailbox.h
@@ -14,12 +14,12 @@
 
 #include <pistache/winornix.h>
 
-#include PIST_QUOTE(PST_STRERROR_R_HDR)
+#include PST_STRERROR_R_HDR
 
 #include <pistache/eventmeth.h>
 #include <pistache/pist_quote.h>
 
-#include PIST_QUOTE(PIST_SOCKFNS_HDR)
+#include PIST_SOCKFNS_HDR
 
 #include <pistache/common.h>
 #include <pistache/os.h>

diff --git a/include/pistache/net.h b/include/pistache/net.h
@@ -19,16 +19,16 @@
 
 #include <pistache/winornix.h>
 
-#include PIST_QUOTE(PST_NETDB_HDR)
+#include PST_NETDB_HDR
 
 // netinet/in.h defines in_port_t, in_addr_t, in_addr, sockaddr_in,
 // sockaddr_in6, IPPROTO_IP, INADDR_ANY, etc.
-#include PIST_QUOTE(PST_NETINET_IN_HDR)
+#include PST_NETINET_IN_HDR
 
-#include PIST_QUOTE(PST_SOCKET_HDR)
-#include PIST_QUOTE(PST_SYS_UN_HDR)
+#include PST_SOCKET_HDR
+#include PST_SYS_UN_HDR
 
-#include PIST_QUOTE(PIST_SOCKFNS_HDR)
+#include PIST_SOCKFNS_HDR
 
 #ifndef _KERNEL_FASTOPEN
 #define _KERNEL_FASTOPEN

diff --git a/include/pistache/pist_timelog.h b/include/pistache/pist_timelog.h
@@ -19,7 +19,7 @@
 #include <pistache/winornix.h>
 #include <pistache/emosandlibevdefs.h> // For _IS_BSD
 
-#include PIST_QUOTE(PST_CLOCK_GETTIME_HDR) // for clock_gettime and asctime
+#include PST_CLOCK_GETTIME_HDR // for clock_gettime and asctime
 #include <stdio.h> // snprintf
 #include <stdarg.h> // for vsnprintf
 

diff --git a/include/pistache/ps_basename.h b/include/pistache/ps_basename.h
@@ -13,7 +13,7 @@
 
 #include <pistache/winornix.h>
 
-#include PIST_QUOTE(PST_MAXPATH_HDR) // for PST_MAXPATHLEN
+#include PST_MAXPATH_HDR // for PST_MAXPATHLEN
 /* ------------------------------------------------------------------------- */
 
 #ifdef __APPLE__

diff --git a/include/pistache/pst_errno.h b/include/pistache/pst_errno.h
@@ -8,7 +8,7 @@
 //
 // Note that we use this intermediate include, rather than just relying solely
 // on defining PST_ERRNO_HDR to be 'errno.h' for Windows, because of mingw
-// gcc's treatment of errno as a macro - 'include PIST_QUOTE(PST_ERRNO_HDR)',
+// gcc's treatment of errno as a macro - 'include PST_ERRNO_HDR',
 // with PST_ERRNO_HDR defined as 'errno.h', can translate to "(*_errno()).h",
 // which is not what we want.
 //

diff --git a/include/pistache/timer_pool.h b/include/pistache/timer_pool.h
@@ -25,7 +25,7 @@
 #include <vector>
 
 #include <cassert>
-#include PIST_QUOTE(PST_MISC_IO_HDR) // e.g. unistd.h
+#include PST_MISC_IO_HDR // e.g. unistd.h
 
 namespace Pistache
 {

diff --git a/include/pistache/transport.h b/include/pistache/transport.h
@@ -14,7 +14,7 @@
 
 #include <pistache/winornix.h>
 
-#include PIST_QUOTE(PST_SYS_RESOURCE_HDR) // for PST_RUSAGE + PST_GETRUSAGE
+#include PST_SYS_RESOURCE_HDR // for PST_RUSAGE + PST_GETRUSAGE
 
 #include <pistache/pist_timelog.h>
 #include <pistache/pist_quote.h>

diff --git a/include/pistache/winornix.h b/include/pistache/winornix.h
@@ -12,8 +12,6 @@
 #ifndef _WINORNIX_H_
 #define _WINORNIX_H_
 
-#include <pistache/pist_quote.h>
-
 // DO NOT include emosandlibevdefs.h here
 // emosandlibevdefs.h includes winornix.h, and depends on it
 
@@ -66,11 +64,11 @@
 #define PST_GETRUSAGE getrusage
 #endif
 
-// Use #include PIST_QUOTE(PST_SYS_RESOURCE_HDR)
+// Use #include PST_SYS_RESOURCE_HDR
 #ifdef _IS_WINDOWS
-#define PST_SYS_RESOURCE_HDR pistache/pist_resource.h
+#define PST_SYS_RESOURCE_HDR "pistache/pist_resource.h"
 #else
-#define PST_SYS_RESOURCE_HDR sys/resource.h
+#define PST_SYS_RESOURCE_HDR "sys/resource.h"
 #endif
 
 #ifdef _IS_WINDOWS
@@ -150,45 +148,45 @@ typedef int PST_SOCK_OPT_VAL_T;
 // #define PST_CLOCK_BOOTTIME_ALARM CLOCK_BOOTTIME_ALARM
 #endif
 
-// Use #include PIST_QUOTE(PST_CLOCK_GETTIME_HDR)
+// Use #include PST_CLOCK_GETTIME_HDR
 #ifdef _IS_WINDOWS
-#define PST_CLOCK_GETTIME_HDR pistache/pist_clock_gettime.h
+#define PST_CLOCK_GETTIME_HDR "pistache/pist_clock_gettime.h"
 #else
-#define PST_CLOCK_GETTIME_HDR time.h
+#define PST_CLOCK_GETTIME_HDR "time.h"
 #endif
 
-// Use #include PIST_QUOTE(PST_IFADDRS_HDR)
+// Use #include PST_IFADDRS_HDR
 #ifdef _IS_WINDOWS
-#define PST_IFADDRS_HDR pistache/pist_ifaddrs.h
+#define PST_IFADDRS_HDR "pistache/pist_ifaddrs.h"
 #else
-#define PST_IFADDRS_HDR ifaddrs.h
+#define PST_IFADDRS_HDR "ifaddrs.h"
 #endif
 
-// Use #include PIST_QUOTE(PST_MAXPATH_HDR)
+// Use #include PST_MAXPATH_HDR
 #ifdef _IS_WINDOWS
-#define PST_MAXPATH_HDR Stdlib.h
+#define PST_MAXPATH_HDR "Stdlib.h"
 #define PST_MAXPATHLEN _MAX_PATH
 #elif defined __APPLE__
-#define PST_MAXPATH_HDR sys/syslimits.h
+#define PST_MAXPATH_HDR "sys/syslimits.h"
 #define PST_MAXPATHLEN PATH_MAX
 #else
-#define PST_MAXPATH_HDR sys/param.h
+#define PST_MAXPATH_HDR "sys/param.h"
 #define PST_MAXPATHLEN MAXPATHLEN
 #endif
 
 // Do this so the PST_DECL_SE_ERR_P_EXTRA / PST_STRERROR_R_ERRNO macros have
 // PST_MAXPATHLEN fully defined
-#include PIST_QUOTE(PST_MAXPATH_HDR)
+#include PST_MAXPATH_HDR
 
-// Use #include PIST_QUOTE(PST_STRERROR_R_HDR)
+// Use #include PST_STRERROR_R_HDR
 // mingw gcc doesn't define strerror_r (Oct/2024)
 // gcc on macOS does define strerror_r, but the XSI version not the POSIX one
 #if defined(__linux__) || (defined(__GNUC__) && (!defined(__MINGW32__)) && \
       (!defined(__clang__)) && (!defined(__NetBSD__)) && (!defined(__APPLE__)))
-#define PST_STRERROR_R_HDR string.h
+#define PST_STRERROR_R_HDR "string.h"
 #define PST_STRERROR_R strerror_r // returns char *
 #else
-#define PST_STRERROR_R_HDR pistache/pist_strerror_r.h
+#define PST_STRERROR_R_HDR "pistache/pist_strerror_r.h"
 #define PST_STRERROR_R pist_strerror_r // returns char *
 #endif
 
@@ -204,9 +202,9 @@ typedef int PST_SOCK_OPT_VAL_T;
 #define PST_DBG_DECL_SE_ERR_P_EXTRA
 #endif
 
-// Use #include PIST_QUOTE(PST_FCNTL_HDR)
+// Use #include PST_FCNTL_HDR
 #ifdef _IS_WINDOWS
-#define PST_FCNTL_HDR pistache/pist_fcntl.h
+#define PST_FCNTL_HDR "pistache/pist_fcntl.h"
 #define PST_FCNTL pist_fcntl
 
 // As per Linux /usr/include/x86_64-linux-gnu/bits/fcntl-linux.h
@@ -216,7 +214,7 @@ typedef int PST_SOCK_OPT_VAL_T;
 #define PST_F_SETFL		4	/* Set file status flags.  */
 
 #else
-#define PST_FCNTL_HDR fcntl.h
+#define PST_FCNTL_HDR "fcntl.h"
 #define PST_FCNTL fcntl
 
 #define PST_F_GETFD F_GETFD
@@ -229,60 +227,60 @@ typedef int PST_SOCK_OPT_VAL_T;
     (static_cast<int>((static_cast<unsigned int>((-1)/2))) - (0xded - 97))
 
 
-// Use #include PIST_QUOTE(PST_NETDB_HDR)
+// Use #include PST_NETDB_HDR
 #ifdef _IS_WINDOWS
-#define PST_NETDB_HDR ws2tcpip.h
+#define PST_NETDB_HDR "ws2tcpip.h"
 #else
-#define PST_NETDB_HDR netdb.h
+#define PST_NETDB_HDR "netdb.h"
 #endif
 
-// Use #include PIST_QUOTE(PST_SOCKET_HDR)
+// Use #include PST_SOCKET_HDR
 #ifdef _IS_WINDOWS
-#define PST_SOCKET_HDR winsock2.h
+#define PST_SOCKET_HDR "winsock2.h"
 #else
-#define PST_SOCKET_HDR sys/socket.h
+#define PST_SOCKET_HDR "sys/socket.h"
 #endif
 
-// Use #include PIST_QUOTE(PST_ARPA_INET_HDR)
+// Use #include PST_ARPA_INET_HDR
 #ifdef _IS_WINDOWS
-#define PST_ARPA_INET_HDR winsock2.h
+#define PST_ARPA_INET_HDR "winsock2.h"
 #else
-#define PST_ARPA_INET_HDR arpa/inet.h
+#define PST_ARPA_INET_HDR "arpa/inet.h"
 #endif
 
-// Use #include PIST_QUOTE(PST_NETINET_IN_HDR)
+// Use #include PST_NETINET_IN_HDR
 #ifdef _IS_WINDOWS
-#define PST_NETINET_IN_HDR ws2def.h
+#define PST_NETINET_IN_HDR "ws2def.h"
 #else
-#define PST_NETINET_IN_HDR netinet/in.h
+#define PST_NETINET_IN_HDR "netinet/in.h"
 #endif
 
-// Use #include PIST_QUOTE(PST_NETINET_TCP_HDR)
+// Use #include PST_NETINET_TCP_HDR
 #ifdef _IS_WINDOWS
-#define PST_NETINET_TCP_HDR winsock2.h
+#define PST_NETINET_TCP_HDR "winsock2.h"
 #else
-#define PST_NETINET_TCP_HDR netinet/tcp.h
+#define PST_NETINET_TCP_HDR "netinet/tcp.h"
 #endif
 
 
-// Use #include PIST_QUOTE(PST_IFADDRS_HDR)
+// Use #include PST_IFADDRS_HDR
 #ifdef _IS_WINDOWS
-#define PST_IFADDRS_HDR pistache/pist_ifaddrs.h
+#define PST_IFADDRS_HDR "pistache/pist_ifaddrs.h"
 #define PST_IFADDRS pist_ifaddrs
 #define PST_GETIFADDRS pist_getifaddrs
 #define PST_FREEIFADDRS pist_freeifaddrs
 #else
-#define PST_IFADDRS_HDR ifaddrs.h
+#define PST_IFADDRS_HDR "ifaddrs.h"
 #define PST_IFADDRS ifaddrs
 #define PST_GETIFADDRS getifaddrs
 #define PST_FREEIFADDRS freeifaddrs
 #endif
 
-// Use #include PIST_QUOTE(PST_SYS_UN_HDR)
+// Use #include PST_SYS_UN_HDR
 #ifdef _IS_WINDOWS
-#define PST_SYS_UN_HDR afunix.h
+#define PST_SYS_UN_HDR "afunix.h"
 #else
-#define PST_SYS_UN_HDR sys/un.h
+#define PST_SYS_UN_HDR "sys/un.h"
 #endif
 
 
@@ -300,56 +298,56 @@ typedef struct in_addr PST_IN_ADDR_T;
 
 
 
-// Use #include PIST_QUOTE(PST_THREAD_HDR)
+// Use #include PST_THREAD_HDR
 #ifdef _IS_WINDOWS
 // Note: processthreadsapi.h appears to require the prior inclusion of
 // windows.h as well.
 // So make sure to include PST_THREAD_HDR only in C/C++ files, not in a header
 // file where it could end up including the massive windows.h all over the
 // place.
-#define PST_THREAD_HDR processthreadsapi.h
+#define PST_THREAD_HDR "processthreadsapi.h"
 #else
-#define PST_THREAD_HDR pthread.h
+#define PST_THREAD_HDR "pthread.h"
 #endif
 
-// Use #include PIST_QUOTE(PST_ERRNO_HDR)
+// Use #include PST_ERRNO_HDR
 #ifndef __linux__
 // pistache/pst_errno.h prevents mingw gcc's bad macro substitution on errno
 // Same issue with clang on macOS and gcc on OpenBSD
-#define PST_ERRNO_HDR pistache/pst_errno.h
+#define PST_ERRNO_HDR "pistache/pst_errno.h"
 #else
-#define PST_ERRNO_HDR sys/errno.h
+#define PST_ERRNO_HDR "sys/errno.h"
 #endif
 
-// Use #include PIST_QUOTE(PST_MISC_IO_HDR)
+// Use #include PST_MISC_IO_HDR
 #ifdef _IS_WINDOWS
-#define PST_MISC_IO_HDR io.h
+#define PST_MISC_IO_HDR "io.h"
 // For _close etc.
 #else
-#define PST_MISC_IO_HDR unistd.h
+#define PST_MISC_IO_HDR "unistd.h"
 #endif
 
-// Use #include PIST_QUOTE(PIST_FILEFNS_HDR)
+// Use #include PIST_FILEFNS_HDR
 #ifdef _IS_WINDOWS
-#define PIST_FILEFNS_HDR pistache/pist_filefns.h
+#define PIST_FILEFNS_HDR "pistache/pist_filefns.h"
 #else
 // unistd.h defines pread
-#define PIST_FILEFNS_HDR unistd.h
+#define PIST_FILEFNS_HDR "unistd.h"
 #endif
 
-// Use #include PIST_QUOTE(PIST_POLL_HDR)
+// Use #include PIST_POLL_HDR
 #ifdef _IS_WINDOWS
-#define PIST_POLL_HDR pistache/pist_sockfns.h
+#define PIST_POLL_HDR "pistache/pist_sockfns.h"
 #else
-#define PIST_POLL_HDR poll.h
+#define PIST_POLL_HDR "poll.h"
 #endif
 
-// Use #include PIST_QUOTE(PIST_SOCKFNS_HDR)
+// Use #include PIST_SOCKFNS_HDR
 #ifdef _IS_WINDOWS
-#define PIST_SOCKFNS_HDR pistache/pist_sockfns.h
+#define PIST_SOCKFNS_HDR "pistache/pist_sockfns.h"
 #else
 // unistd.h defines pread
-#define PIST_SOCKFNS_HDR unistd.h // has close, read and write in Linux
+#define PIST_SOCKFNS_HDR "unistd.h" // has close, read and write in Linux
 #endif
 
 // PST_SOCK_xxx macros are for sockets. For files, use PST_FILE_xxx

diff --git a/src/client/client.cc b/src/client/client.cc
@@ -19,14 +19,14 @@
 #include <pistache/net.h>
 #include <pistache/stream.h>
 
-#include PIST_QUOTE(PST_NETDB_HDR)
-#include PIST_QUOTE(PST_SOCKET_HDR)
-#include PIST_QUOTE(PIST_SOCKFNS_HDR)
+#include PST_NETDB_HDR
+#include PST_SOCKET_HDR
+#include PIST_SOCKFNS_HDR
 
 // ps_sendfile.h includes sys/uio.h in macOS, and sys/sendfile.h in Linux
 #include <pistache/ps_sendfile.h>
 
-#include PIST_QUOTE(PST_STRERROR_R_HDR)
+#include PST_STRERROR_R_HDR
 
 #include <sys/types.h>