Merge #147 'Support building as DLL on Windows'

This exports all externally used functions and variables to make them
accessible from a DLL build. Additionally we now hide all non-marked
symbols by default to achieve a similar effect with shared library
builds on other platforms.

Author: muggenhor

CHANGELOG.md

@@ -8,6 +8,7 @@ Please see [CONTRIBUTING.md](https://github.com/cucumber/cucumber/blob/master/CO
 * Listen on localhost by default to avoid firewall warnings ([#158](https://github.com/cucumber/cucumber-cpp/pull/158) Nik Reiman)
 * Better integrate Qt into buildsystem, it can now be disabled, and test it in CI ([#160](https://github.com/cucumber/cucumber-cpp/pull/160) Kamil Strzempowicz & Giel van Schijndel)
 * Support taking regex captures as arguments to the step definition's function ([#159](https://github.com/cucumber/cucumber-cpp/pull/159) Giel van Schijndel)
+* Support building as shared library on Windows and hide internal symbols on all platforms ([#147](https://github.com/cucumber/cucumber-cpp/pull/147) [Nik Reiman](https://github.com/nre-ableton))
 
 ### Changed
 

CMakeLists.txt

@@ -1,7 +1,13 @@
 cmake_minimum_required(VERSION 3.1)
 
+if(NOT CMAKE_VERSION VERSION_LESS "3.3")
+    # Don't ignore visibility related properties for non-SHARED targets
+    cmake_policy(SET CMP0063 NEW)
+endif()
+
 project(Cucumber-Cpp)
 
+option(BUILD_SHARED_LIBS        "Generate shared libraries" OFF)
 option(CUKE_USE_STATIC_BOOST    "Statically link Boost (except boost::test)" ${WIN32})
 option(CUKE_USE_STATIC_GTEST    "Statically link Google Test" ON)
 option(CUKE_DISABLE_BOOST_TEST  "Disable boost:test" OFF)
@@ -311,6 +317,8 @@ else()
                 ${ARGN}
                 ${CUKE_FEATURES_DIR}
                 ${USES_TERMINAL}
+                # Execute in same directory as where DLLs appear on Windows
+                WORKING_DIRECTORY ${CMAKE_BINARY_DIR}/src
                 )
         endfunction(add_feature_target)
 

appveyor.yml

@@ -41,7 +41,7 @@ install:
 
 build_script:
 - cmake -E make_directory build
-- cmake -E chdir build cmake -G "%CMAKE_GENERATOR%" -DCUKE_ENABLE_EXAMPLES=ON -DBOOST_ROOT="%BOOST_ROOT%" -DBOOST_INCLUDEDIR="%BOOST_INCLUDEDIR%" -DBOOST_LIBRARYDIR="%BOOST_LIBRARYDIR%" -DCMAKE_PREFIX_PATH="%QT_DIR%" ..
+- cmake -E chdir build cmake -G "%CMAKE_GENERATOR%" -DCUKE_ENABLE_EXAMPLES=ON -DBUILD_SHARED_LIBS=ON -DBOOST_ROOT="%BOOST_ROOT%" -DBOOST_INCLUDEDIR="%BOOST_INCLUDEDIR%" -DBOOST_LIBRARYDIR="%BOOST_LIBRARYDIR%" -DCMAKE_PREFIX_PATH="%QT_DIR%" ..
 - cmake --build build
 
 test_script:

cmake/modules/FindGMock.cmake

@@ -260,6 +260,15 @@ if(NOT (${GMOCK_LIBRARY_EXISTS} AND ${GTEST_LIBRARY_EXISTS}))
 
     if(GTEST_USE_STATIC_LIBS)
         set(GTEST_CMAKE_ARGS -Dgtest_force_shared_crt:BOOL=ON -DBUILD_SHARED_LIBS=OFF)
+        if(BUILD_SHARED_LIBS)
+            list(APPEND GTEST_CMAKE_ARGS
+                -DCMAKE_POSITION_INDEPENDENT_CODE=ON
+                -Dgtest_hide_internal_symbols=ON
+                -DCMAKE_CXX_VISIBILITY_PRESET=hidden
+                -DCMAKE_VISIBILITY_INLINES_HIDDEN=ON
+                -DCMAKE_POLICY_DEFAULT_CMP0063=NEW
+            )
+        endif()
         set(GTEST_LIBRARY_PREFIX ${CMAKE_STATIC_LIBRARY_PREFIX})
     else()
         set(GTEST_CMAKE_ARGS -DBUILD_SHARED_LIBS=ON)

examples/Calc/CMakeLists.txt

@@ -1,6 +1,6 @@
 project(Calc)
 
-add_library(Calc src/Calculator)
+add_library(Calc STATIC src/Calculator)
 target_include_directories(Calc INTERFACE src)
 
 if(TARGET GTest::GTest)

examples/CalcQt/CMakeLists.txt

@@ -1,7 +1,7 @@
 project(CalcQt)
 
 if(TARGET Qt::Core AND TARGET Qt::Gui AND TARGET Qt::Widgets AND TARGET Qt::Test)
-    add_library(libcalcqt src/CalculatorWidget.cpp src/CalculatorWidget.h)
+    add_library(libcalcqt STATIC src/CalculatorWidget.cpp src/CalculatorWidget.h)
     set_target_properties(libcalcqt PROPERTIES AUTOMOC ON)
     target_include_directories(libcalcqt INTERFACE src)
     target_link_libraries(libcalcqt

include/cucumber-cpp/internal/ContextManager.hpp

@@ -1,6 +1,8 @@
 #ifndef CUKE_CONTEXTMANAGER_HPP_
 #define CUKE_CONTEXTMANAGER_HPP_
 
+#include <cucumber-cpp/internal/CukeExport.hpp>
+
 #include <vector>
 
 #include <boost/make_shared.hpp>
@@ -13,7 +15,7 @@ namespace internal {
 
 typedef std::vector<boost::shared_ptr<void> > contexts_type;
 
-class ContextManager {
+class CUCUMBER_CPP_EXPORT ContextManager {
 public:
     void purgeContexts();
     template<class T> boost::weak_ptr<T> addContext();

include/cucumber-cpp/internal/CukeCommands.hpp

@@ -2,6 +2,7 @@
 #define CUKE_CUKECOMMANDS_HPP_
 
 #include "ContextManager.hpp"
+#include <cucumber-cpp/internal/CukeExport.hpp>
 #include "Scenario.hpp"
 #include "Table.hpp"
 #include "step/StepManager.hpp"
@@ -20,7 +21,7 @@ using boost::shared_ptr;
 /**
  * Legacy class to be removed when feature #31 is complete, substituted by CukeEngineImpl.
  */
-class CukeCommands {
+class CUCUMBER_CPP_EXPORT CukeCommands {
 public:
 	CukeCommands();
 	virtual ~CukeCommands();

include/cucumber-cpp/internal/CukeEngine.hpp

@@ -7,24 +7,26 @@
 
 #include <boost/multi_array.hpp>
 
+#include <cucumber-cpp/internal/CukeExport.hpp>
+
 namespace cucumber {
 namespace internal {
 
-class StepMatchArg {
+class CUCUMBER_CPP_EXPORT StepMatchArg {
 public:
     std::string value;
     std::ptrdiff_t position;
 };
 
-class StepMatch {
+class CUCUMBER_CPP_EXPORT StepMatch {
 public:
     std::string id;
     std::vector<StepMatchArg> args;
     std::string source;
     std::string regexp;
 };
 
-class InvokeException {
+class CUCUMBER_CPP_EXPORT InvokeException {
 private:
     const std::string message;
 
@@ -37,7 +39,7 @@ class InvokeException {
     virtual ~InvokeException() {}
 };
 
-class InvokeFailureException : public InvokeException {
+class CUCUMBER_CPP_EXPORT InvokeFailureException : public InvokeException {
 private:
     const std::string exceptionType;
 
@@ -48,7 +50,7 @@ class InvokeFailureException : public InvokeException {
     const std::string getExceptionType() const;
 };
 
-class PendingStepException : public InvokeException {
+class CUCUMBER_CPP_EXPORT PendingStepException : public InvokeException {
 public:
     PendingStepException(const std::string & message);
     PendingStepException(const PendingStepException &rhs);
@@ -96,7 +98,8 @@ class CukeEngine {
      */
     virtual std::string snippetText(const std::string & keyword, const std::string & name, const std::string & multilineArgClass) const = 0;
 
-    virtual ~CukeEngine() {}
+    CUCUMBER_CPP_EXPORT CukeEngine();
+    CUCUMBER_CPP_EXPORT virtual ~CukeEngine();
 };
 
 }

include/cucumber-cpp/internal/CukeEngineImpl.hpp

@@ -2,6 +2,7 @@
 #define CUKE_CUKEENGINE_IMPL_HPP_
 
 #include "CukeEngine.hpp"
+#include <cucumber-cpp/internal/CukeExport.hpp>
 #include "CukeCommands.hpp"
 
 namespace cucumber {
@@ -13,7 +14,7 @@ namespace internal {
  * Currently it is a wrapper around CukeCommands. It will have its own
  * implementation when feature #31 is complete.
  */
-class CukeEngineImpl : public CukeEngine {
+class CUCUMBER_CPP_EXPORT CukeEngineImpl : public CukeEngine {
 private:
     CukeCommands cukeCommands;
 

include/cucumber-cpp/internal/Table.hpp

@@ -1,6 +1,8 @@
 #ifndef CUKE_TABLE_HPP_
 #define CUKE_TABLE_HPP_
 
+#include <cucumber-cpp/internal/CukeExport.hpp>
+
 #include <vector>
 #include <map>
 #include <string>
@@ -9,7 +11,7 @@
 namespace cucumber {
 namespace internal {
 
-class Table {
+class CUCUMBER_CPP_EXPORT Table {
 private:
     typedef std::vector<std::string> basic_type;
 public:

include/cucumber-cpp/internal/connectors/wire/WireProtocol.hpp

@@ -1,8 +1,10 @@
 #ifndef CUKE_WIREPROTOCOL_HPP_
 #define CUKE_WIREPROTOCOL_HPP_
 
+#include <cucumber-cpp/internal/CukeExport.hpp>
 #include "ProtocolHandler.hpp"
 #include "../../CukeEngine.hpp"
+
 #include <boost/shared_ptr.hpp>
 
 namespace cucumber {
@@ -14,7 +16,7 @@ namespace internal {
 
 class WireResponseVisitor;
 
-class WireResponse {
+class CUCUMBER_CPP_EXPORT WireResponse {
 public:
     WireResponse() {};
 
@@ -23,12 +25,12 @@ class WireResponse {
     virtual ~WireResponse() {};
 };
 
-class SuccessResponse : public WireResponse {
+class CUCUMBER_CPP_EXPORT SuccessResponse : public WireResponse {
 public:
     void accept(WireResponseVisitor& visitor) const;
 };
 
-class FailureResponse : public WireResponse {
+class CUCUMBER_CPP_EXPORT FailureResponse : public WireResponse {
 private:
     const std::string message, exceptionType;
 
@@ -41,7 +43,7 @@ class FailureResponse : public WireResponse {
     void accept(WireResponseVisitor& visitor) const;
 };
 
-class PendingResponse : public WireResponse {
+class CUCUMBER_CPP_EXPORT PendingResponse : public WireResponse {
 private:
     const std::string message;
 
@@ -53,7 +55,7 @@ class PendingResponse : public WireResponse {
     void accept(WireResponseVisitor& visitor) const;
 };
 
-class StepMatchesResponse : public WireResponse {
+class CUCUMBER_CPP_EXPORT StepMatchesResponse : public WireResponse {
 private:
     const std::vector<StepMatch> matchingSteps;
 
@@ -64,7 +66,7 @@ class StepMatchesResponse : public WireResponse {
     void accept(WireResponseVisitor& visitor) const;
 };
 
-class SnippetTextResponse : public WireResponse {
+class CUCUMBER_CPP_EXPORT SnippetTextResponse : public WireResponse {
 private:
     const std::string stepSnippet;
 
@@ -76,7 +78,7 @@ class SnippetTextResponse : public WireResponse {
     void accept(WireResponseVisitor& visitor) const;
 };
 
-class WireResponseVisitor {
+class CUCUMBER_CPP_EXPORT WireResponseVisitor {
 public:
     virtual void visit(const SuccessResponse& response) = 0;
     virtual void visit(const FailureResponse& response) = 0;
@@ -91,7 +93,7 @@ class WireResponseVisitor {
 /**
  * Wire protocol request command.
  */
-class WireCommand {
+class CUCUMBER_CPP_EXPORT WireCommand {
 public:
     /**
      * Runs the command on the provided engine
@@ -105,7 +107,7 @@ class WireCommand {
     virtual ~WireCommand() {};
 };
 
-class WireMessageCodecException : public std::exception {
+class CUCUMBER_CPP_EXPORT WireMessageCodecException : public std::exception {
 private:
     const char *description;
 
@@ -123,7 +125,7 @@ class WireMessageCodecException : public std::exception {
 /**
  * Transforms wire messages into commands and responses to messages.
  */
-class WireMessageCodec {
+class CUCUMBER_CPP_EXPORT WireMessageCodec {
 public:
     /**
      * Decodes a wire message into a command.
@@ -151,7 +153,7 @@ class WireMessageCodec {
 /**
  * WireMessageCodec implementation with JsonSpirit.
  */
-class JsonSpiritWireMessageCodec : public WireMessageCodec {
+class CUCUMBER_CPP_EXPORT JsonSpiritWireMessageCodec : public WireMessageCodec {
 public:
     JsonSpiritWireMessageCodec();
     boost::shared_ptr<WireCommand> decode(const std::string &request) const;
@@ -162,7 +164,7 @@ class JsonSpiritWireMessageCodec : public WireMessageCodec {
  * Wire protocol handler, delegating JSON encoding and decoding to a
  * codec object and running commands on a provided engine instance.
  */
-class WireProtocolHandler : public ProtocolHandler {
+class CUCUMBER_CPP_EXPORT WireProtocolHandler : public ProtocolHandler {
 private:
     const WireMessageCodec& codec;
     CukeEngine& engine;

include/cucumber-cpp/internal/connectors/wire/WireServer.hpp

@@ -1,6 +1,7 @@
 #ifndef CUKE_WIRESERVER_HPP_
 #define CUKE_WIRESERVER_HPP_
 
+#include <cucumber-cpp/internal/CukeExport.hpp>
 #include "ProtocolHandler.hpp"
 
 #include <string>
@@ -13,7 +14,7 @@ namespace internal {
 /**
  * Socket server that calls a protocol handler line by line
  */
-class SocketServer {
+class CUCUMBER_CPP_EXPORT SocketServer {
 public:
     /**
       * Constructor for DI
@@ -49,7 +50,7 @@ class SocketServer {
 /**
  * Socket server that calls a protocol handler line by line
  */
-class TCPSocketServer : public SocketServer {
+class CUCUMBER_CPP_EXPORT TCPSocketServer : public SocketServer {
 public:
     /**
      * Type definition for TCP port
@@ -90,7 +91,7 @@ class TCPSocketServer : public SocketServer {
 /**
  * Socket server that calls a protocol handler line by line
  */
-class UnixSocketServer : public SocketServer {
+class CUCUMBER_CPP_EXPORT UnixSocketServer : public SocketServer {
 public:
     /**
       * Constructor for DI

include/cucumber-cpp/internal/drivers/BoostDriver.hpp

@@ -2,13 +2,14 @@
 #define CUKE_BOOSTDRIVER_HPP_
 
 #include "../step/StepManager.hpp"
+#include <cucumber-cpp/internal/CukeExport.hpp>
 
 namespace cucumber {
 namespace internal {
 
 class CukeBoostLogInterceptor;
 
-class BoostStep : public BasicStep {
+class CUCUMBER_CPP_EXPORT BoostStep : public BasicStep {
 protected:
     const InvokeResult invokeStepBody();
 

include/cucumber-cpp/internal/drivers/GTestDriver.hpp

@@ -1,14 +1,15 @@
 #ifndef CUKE_GTESTDRIVER_HPP_
 #define CUKE_GTESTDRIVER_HPP_
 
+#include <cucumber-cpp/internal/CukeExport.hpp>
 #include "../step/StepManager.hpp"
 
 #include <iostream>
 
 namespace cucumber {
 namespace internal {
 
-class GTestStep : public BasicStep {
+class CUCUMBER_CPP_EXPORT GTestStep : public BasicStep {
 protected:
     const InvokeResult invokeStepBody();
 

include/cucumber-cpp/internal/drivers/GenericDriver.hpp

@@ -2,11 +2,12 @@
 #define CUKE_GENERICDRIVER_HPP_
 
 #include "../step/StepManager.hpp"
+#include <cucumber-cpp/internal/CukeExport.hpp>
 
 namespace cucumber {
 namespace internal {
 
-class GenericStep : public BasicStep {
+class CUCUMBER_CPP_EXPORT GenericStep : public BasicStep {
 protected:
     virtual const InvokeResult invokeStepBody();
 };