Add exports macro to allow Shared Library with hidden symbols by default (e.g. Windows) (#127)

Author: Bertrand Darbon

CMakeLists.txt

@@ -27,15 +27,26 @@ if(BUILD_TRANTOR_SHARED)
     set(CMAKE_INSTALL_RPATH "${CMAKE_INSTALL_PREFIX}/${INSTALL_LIB_DIR}")
   endif("${isSystemDir}" STREQUAL "-1")
   add_library(${PROJECT_NAME} SHARED)
+  if(CMAKE_CXX_COMPILER_ID MATCHES MSVC)
+    # Ignore MSVC C4251 and C4275 warning of exporting std objects with no dll export
+    # We export class to facilitate maintenance, thus if you compile
+    # drogon on windows as a shared library, you will need to use
+    # exact same compiler for drogon and your app.
+    target_compile_options(${PROJECT_NAME} PUBLIC /wd4251 /wd4275)
+  endif()
 else(BUILD_TRANTOR_SHARED)
   add_library(${PROJECT_NAME} STATIC)
 endif(BUILD_TRANTOR_SHARED)
 
+include(GenerateExportHeader)
+generate_export_header(${PROJECT_NAME} EXPORT_FILE_NAME ${CMAKE_CURRENT_BINARY_DIR}/exports/trantor/exports.h)
+
 # include directories
 target_include_directories(
   ${PROJECT_NAME}
   PUBLIC $<BUILD_INTERFACE:${PROJECT_SOURCE_DIR}>
          $<INSTALL_INTERFACE:${INSTALL_INCLUDE_DIR}>
+         $<BUILD_INTERFACE:${CMAKE_CURRENT_BINARY_DIR}/exports>
   PRIVATE ${PROJECT_SOURCE_DIR}
           ${PROJECT_SOURCE_DIR}/trantor/utils
           ${PROJECT_SOURCE_DIR}/trantor/net
@@ -95,13 +106,13 @@ else()
 endif()
 target_sources(${PROJECT_NAME} PRIVATE ${TRANTOR_SOURCES})
 
+find_package(Threads)
+target_link_libraries(${PROJECT_NAME} PRIVATE Threads::Threads)
 if(WIN32)
   target_link_libraries(${PROJECT_NAME} PRIVATE ws2_32 Rpcrt4)
   if(OpenSSL_FOUND)
     target_link_libraries(${PROJECT_NAME} PRIVATE Crypt32 Secur32)
   endif(OpenSSL_FOUND)
-else(WIN32)
-  target_link_libraries(${PROJECT_NAME} PRIVATE pthread)
 endif(WIN32)
 
 set_target_properties(${PROJECT_NAME} PROPERTIES CXX_STANDARD 14)
@@ -153,9 +164,11 @@ source_group("Public API"
 install(TARGETS trantor
                 # IMPORTANT: Add the trantor library to the "export-set"
         EXPORT TrantorTargets
+        RUNTIME DESTINATION "${INSTALL_BIN_DIR}" COMPONENT bin
         ARCHIVE DESTINATION "${INSTALL_LIB_DIR}" COMPONENT lib
         LIBRARY DESTINATION "${INSTALL_LIB_DIR}" COMPONENT lib)
-
+install(FILES ${CMAKE_CURRENT_BINARY_DIR}/exports/trantor/exports.h
+        DESTINATION ${INSTALL_INCLUDE_DIR}/trantor)
 install(FILES ${public_net_headers}
         DESTINATION ${INSTALL_INCLUDE_DIR}/trantor/net)
 install(FILES ${public_utils_headers}

trantor/net/Channel.h

@@ -16,6 +16,7 @@
 
 #include <trantor/utils/Logger.h>
 #include <trantor/utils/NonCopyable.h>
+#include <trantor/exports.h>
 #include <functional>
 #include <assert.h>
 #include <memory>
@@ -28,7 +29,7 @@ class EventLoop;
  * events on the socket it manages.
  *
  */
-class Channel : NonCopyable
+class TRANTOR_EXPORT Channel : NonCopyable
 {
   public:
     using EventCallback = std::function<void()>;

trantor/net/EventLoop.h

@@ -19,6 +19,7 @@
 #include <trantor/utils/NonCopyable.h>
 #include <trantor/utils/Date.h>
 #include <trantor/utils/LockFreeQueue.h>
+#include <trantor/exports.h>
 #include <thread>
 #include <memory>
 #include <vector>
@@ -50,7 +51,7 @@ enum
  * the event loop of the thread it belongs to, or call that thread the thread of
  * the event loop.
  */
-class EventLoop : NonCopyable
+class TRANTOR_EXPORT EventLoop : NonCopyable
 {
   public:
     EventLoop();

trantor/net/EventLoopThread.h

@@ -16,6 +16,7 @@
 
 #include <trantor/net/EventLoop.h>
 #include <trantor/utils/NonCopyable.h>
+#include <trantor/exports.h>
 #include <mutex>
 #include <thread>
 #include <memory>
@@ -28,7 +29,7 @@ namespace trantor
  * @brief This class represents an event loop thread.
  *
  */
-class EventLoopThread : NonCopyable
+class TRANTOR_EXPORT EventLoopThread : NonCopyable
 {
   public:
     explicit EventLoopThread(const std::string &threadName = "EventLoopThread");

trantor/net/EventLoopThreadPool.h

@@ -15,6 +15,7 @@
 #pragma once
 
 #include <trantor/net/EventLoopThread.h>
+#include <trantor/exports.h>
 #include <vector>
 #include <memory>
 
@@ -24,7 +25,7 @@ namespace trantor
  * @brief This class represents a pool of EventLoopThread objects
  *
  */
-class EventLoopThreadPool : NonCopyable
+class TRANTOR_EXPORT EventLoopThreadPool : NonCopyable
 {
   public:
     EventLoopThreadPool() = delete;

trantor/net/InetAddress.h

@@ -21,6 +21,7 @@
 #define MUDUO_NET_INETADDRESS_H
 
 #include <trantor/utils/Date.h>
+#include <trantor/exports.h>
 
 #ifdef _WIN32
 #include <ws2tcpip.h>
@@ -41,7 +42,7 @@ namespace trantor
  * @brief Wrapper of sockaddr_in. This is an POD interface class.
  *
  */
-class InetAddress
+class TRANTOR_EXPORT InetAddress
 {
   public:
     /**

trantor/net/Resolver.h

@@ -6,6 +6,7 @@
 // Author: Tao An
 
 #pragma once
+#include <trantor/exports.h>
 #include <memory>
 #include <trantor/net/EventLoop.h>
 #include <trantor/net/InetAddress.h>
@@ -17,7 +18,7 @@ namespace trantor
  * @note Although the c-ares library is not essential, it is recommended to
  * install it for higher performance
  */
-class Resolver
+class TRANTOR_EXPORT Resolver
 {
   public:
     using Callback = std::function<void(const trantor::InetAddress&)>;

trantor/net/TcpClient.h

@@ -20,6 +20,7 @@
 #include <trantor/net/EventLoop.h>
 #include <trantor/net/InetAddress.h>
 #include <trantor/net/TcpConnection.h>
+#include <trantor/exports.h>
 #include <functional>
 #include <thread>
 #include <atomic>
@@ -33,7 +34,7 @@ class SSLContext;
  * @brief This class represents a TCP client.
  *
  */
-class TcpClient : NonCopyable
+class TRANTOR_EXPORT TcpClient : NonCopyable
 {
   public:
     /**

trantor/net/TcpConnection.h

@@ -13,6 +13,7 @@
  */
 
 #pragma once
+#include <trantor/exports.h>
 #include <trantor/net/EventLoop.h>
 #include <trantor/net/InetAddress.h>
 #include <trantor/utils/NonCopyable.h>
@@ -25,14 +26,15 @@
 namespace trantor
 {
 class SSLContext;
-std::shared_ptr<SSLContext> newSSLServerContext(const std::string &certPath,
-                                                const std::string &keyPath,
-                                                bool useOldTLS = false);
+TRANTOR_EXPORT std::shared_ptr<SSLContext> newSSLServerContext(
+    const std::string &certPath,
+    const std::string &keyPath,
+    bool useOldTLS = false);
 /**
  * @brief This class represents a TCP connection.
  *
  */
-class TcpConnection
+class TRANTOR_EXPORT TcpConnection
 {
   public:
     TcpConnection() = default;

trantor/net/TcpServer.h

@@ -20,6 +20,7 @@
 #include <trantor/net/InetAddress.h>
 #include <trantor/net/TcpConnection.h>
 #include <trantor/utils/TimingWheel.h>
+#include <trantor/exports.h>
 #include <string>
 #include <memory>
 #include <set>
@@ -32,7 +33,7 @@ class SSLContext;
  * @brief This class represents a TCP server.
  *
  */
-class TcpServer : NonCopyable
+class TRANTOR_EXPORT TcpServer : NonCopyable
 {
   public:
     /**

trantor/tests/CMakeLists.txt

@@ -46,4 +46,4 @@ set_property(TARGET ${targets_list} PROPERTY CXX_EXTENSIONS OFF)
 
 foreach(T ${targets_list})
   target_link_libraries(${T} PRIVATE trantor)
-endforeach()
+endforeach()

trantor/utils/AsyncFileLogger.h

@@ -16,6 +16,7 @@
 
 #include <trantor/utils/NonCopyable.h>
 #include <trantor/utils/Date.h>
+#include <trantor/exports.h>
 #include <thread>
 #include <mutex>
 #include <string>
@@ -34,7 +35,7 @@ using StringPtrQueue = std::queue<StringPtr>;
  * asynchronously.
  *
  */
-class AsyncFileLogger : NonCopyable
+class TRANTOR_EXPORT AsyncFileLogger : NonCopyable
 {
   public:
     /**

trantor/utils/ConcurrentTaskQueue.h

@@ -15,6 +15,7 @@
 #pragma once
 
 #include <trantor/utils/TaskQueue.h>
+#include <trantor/exports.h>
 #include <list>
 #include <memory>
 #include <vector>
@@ -28,7 +29,7 @@ namespace trantor
  * can be called a threads pool.
  *
  */
-class ConcurrentTaskQueue : public TaskQueue
+class TRANTOR_EXPORT ConcurrentTaskQueue : public TaskQueue
 {
   public:
     /**

trantor/utils/Date.h

@@ -14,6 +14,7 @@
 
 #pragma once
 
+#include <trantor/exports.h>
 #include <stdint.h>
 #include <string>
 
@@ -25,7 +26,7 @@ namespace trantor
  * @brief This class represents a time point.
  *
  */
-class Date
+class TRANTOR_EXPORT Date
 {
   public:
     Date() : microSecondsSinceEpoch_(0){};

trantor/utils/LogStream.cc

@@ -258,16 +258,16 @@ Fmt::Fmt(const char *fmt, T val)
 
 // Explicit instantiations
 
-template Fmt::Fmt(const char *fmt, char);
-
-template Fmt::Fmt(const char *fmt, short);
-template Fmt::Fmt(const char *fmt, unsigned short);
-template Fmt::Fmt(const char *fmt, int);
-template Fmt::Fmt(const char *fmt, unsigned int);
-template Fmt::Fmt(const char *fmt, long);
-template Fmt::Fmt(const char *fmt, unsigned long);
-template Fmt::Fmt(const char *fmt, long long);
-template Fmt::Fmt(const char *fmt, unsigned long long);
-
-template Fmt::Fmt(const char *fmt, float);
-template Fmt::Fmt(const char *fmt, double);
+template TRANTOR_EXPORT Fmt::Fmt(const char *fmt, char);
+
+template TRANTOR_EXPORT Fmt::Fmt(const char *fmt, short);
+template TRANTOR_EXPORT Fmt::Fmt(const char *fmt, unsigned short);
+template TRANTOR_EXPORT Fmt::Fmt(const char *fmt, int);
+template TRANTOR_EXPORT Fmt::Fmt(const char *fmt, unsigned int);
+template TRANTOR_EXPORT Fmt::Fmt(const char *fmt, long);
+template TRANTOR_EXPORT Fmt::Fmt(const char *fmt, unsigned long);
+template TRANTOR_EXPORT Fmt::Fmt(const char *fmt, long long);
+template TRANTOR_EXPORT Fmt::Fmt(const char *fmt, unsigned long long);
+
+template TRANTOR_EXPORT Fmt::Fmt(const char *fmt, float);
+template TRANTOR_EXPORT Fmt::Fmt(const char *fmt, double);

trantor/utils/LogStream.h

@@ -16,6 +16,7 @@
 
 // Taken from muduo lib and modified. Classes in this file are used internally.
 #include <trantor/utils/NonCopyable.h>
+#include <trantor/exports.h>
 
 #include <assert.h>
 #include <string.h>  // memcpy
@@ -115,7 +116,7 @@ class FixedBuffer : NonCopyable
 
 }  // namespace detail
 
-class LogStream : NonCopyable
+class TRANTOR_EXPORT LogStream : NonCopyable
 {
     using self = LogStream;
 
@@ -247,7 +248,7 @@ class LogStream : NonCopyable
     std::string exBuffer_;
 };
 
-class Fmt  // : boost::noncopyable
+class TRANTOR_EXPORT Fmt  // : boost::noncopyable
 {
   public:
     template <typename T>

trantor/utils/Logger.cc

@@ -168,7 +168,10 @@ Logger::Logger(SourceFile file, int line, bool)
 Logger::~Logger()
 {
     logStream_ << T(" - ", 3) << sourceFile_ << ':' << fileLine_ << '\n';
-    Logger::outputFunc_()(logStream_.bufferData(), logStream_.bufferLength());
+    auto oFunc = Logger::outputFunc_();
+    if (!oFunc)
+        return;
+    oFunc(logStream_.bufferData(), logStream_.bufferLength());
     if (level_ >= kError)
         Logger::flushFunc_()();
     // logStream_.resetBuffer();

trantor/utils/Logger.h

@@ -17,6 +17,7 @@
 #include <trantor/utils/NonCopyable.h>
 #include <trantor/utils/Date.h>
 #include <trantor/utils/LogStream.h>
+#include <trantor/exports.h>
 #include <string.h>
 #include <functional>
 #include <iostream>
@@ -27,7 +28,7 @@ namespace trantor
  * @brief This class implements log functions.
  *
  */
-class Logger : public NonCopyable
+class TRANTOR_EXPORT Logger : public NonCopyable
 {
   public:
     enum LogLevel

trantor/utils/MsgBuffer.h

@@ -14,6 +14,7 @@
 
 #pragma once
 #include <trantor/utils/NonCopyable.h>
+#include <trantor/exports.h>
 #include <vector>
 #include <string>
 #include <algorithm>
@@ -34,7 +35,7 @@ static constexpr char CRLF[]{"\r\n"};
  * data.
  *
  */
-class MsgBuffer
+class TRANTOR_EXPORT MsgBuffer
 {
   public:
     /**

trantor/utils/NonCopyable.h

@@ -13,13 +13,16 @@
  */
 
 #pragma once
+
+#include <trantor/exports.h>
+
 namespace trantor
 {
 /**
  * @brief This class represents a non-copyable object.
  *
  */
-class NonCopyable
+class TRANTOR_EXPORT NonCopyable
 {
   protected:
     NonCopyable()