Support building as a shared library

nre-ableton · muggenhor · commit d7b95d0347d9 · 2018-05-18T20:35:44.000+02:00
On Windows, it is necessary to add some __declspec() calls to expose
some symbols with different linkage types. This commit adds the makes
it possible for users to easily build cucumber-cpp either as a static
or dynamic library by defining either CUKE_LINKED_AS_SHARED_LIBRARY or
CUKE_CREATE_SHARED_LIBRARY at build time.
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -2,6 +2,7 @@ cmake_minimum_required(VERSION 3.1)
 
 project(Cucumber-Cpp)
 
+option(CUKE_ENABLE_SHARED_LIB   "Generate a shared library" 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)
diff --git a/include/cucumber-cpp/internal/ContextManager.hpp b/include/cucumber-cpp/internal/ContextManager.hpp
@@ -1,6 +1,8 @@
 #ifndef CUKE_CONTEXTMANAGER_HPP_
 #define CUKE_CONTEXTMANAGER_HPP_
 
+#include "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();
diff --git a/include/cucumber-cpp/internal/CukeCommands.hpp b/include/cucumber-cpp/internal/CukeCommands.hpp
@@ -2,6 +2,7 @@
 #define CUKE_CUKECOMMANDS_HPP_
 
 #include "ContextManager.hpp"
+#include "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();
diff --git a/include/cucumber-cpp/internal/CukeEngine.hpp b/include/cucumber-cpp/internal/CukeEngine.hpp
@@ -7,24 +7,26 @@
 
 #include <boost/multi_array.hpp>
 
+#include "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();
 };
 
 }
diff --git a/include/cucumber-cpp/internal/CukeEngineImpl.hpp b/include/cucumber-cpp/internal/CukeEngineImpl.hpp
@@ -2,6 +2,7 @@
 #define CUKE_CUKEENGINE_IMPL_HPP_
 
 #include "CukeEngine.hpp"
+#include "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;
 
diff --git a/include/cucumber-cpp/internal/Table.hpp b/include/cucumber-cpp/internal/Table.hpp
@@ -1,6 +1,8 @@
 #ifndef CUKE_TABLE_HPP_
 #define CUKE_TABLE_HPP_
 
+#include "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:
diff --git a/include/cucumber-cpp/internal/connectors/wire/WireProtocol.hpp b/include/cucumber-cpp/internal/connectors/wire/WireProtocol.hpp
@@ -1,8 +1,10 @@
 #ifndef CUKE_WIREPROTOCOL_HPP_
 #define CUKE_WIREPROTOCOL_HPP_
 
+#include "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;
diff --git a/include/cucumber-cpp/internal/connectors/wire/WireServer.hpp b/include/cucumber-cpp/internal/connectors/wire/WireServer.hpp
@@ -1,6 +1,7 @@
 #ifndef CUKE_WIRESERVER_HPP_
 #define CUKE_WIRESERVER_HPP_
 
+#include "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
diff --git a/include/cucumber-cpp/internal/drivers/GTestDriver.hpp b/include/cucumber-cpp/internal/drivers/GTestDriver.hpp
@@ -1,14 +1,15 @@
 #ifndef CUKE_GTESTDRIVER_HPP_
 #define CUKE_GTESTDRIVER_HPP_
 
+#include "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();
 
diff --git a/include/cucumber-cpp/internal/hook/HookRegistrar.hpp b/include/cucumber-cpp/internal/hook/HookRegistrar.hpp
@@ -1,6 +1,7 @@
 #ifndef CUKE_HOOKREGISTRAR_HPP_
 #define CUKE_HOOKREGISTRAR_HPP_
 
+#include "CukeExport.hpp"
 #include "Tag.hpp"
 #include "../Scenario.hpp"
 #include "../step/StepManager.hpp"
@@ -14,12 +15,12 @@
 namespace cucumber {
 namespace internal {
 
-class CallableStep {
+class CUCUMBER_CPP_EXPORT CallableStep {
 public:
     virtual void call() = 0;
 };
 
-class Hook {
+class CUCUMBER_CPP_EXPORT Hook {
 public:
     void setTags(const std::string &csvTagNotation);
     virtual void invokeHook(Scenario *scenario, CallableStep *step);
@@ -36,35 +37,30 @@ class Hook {
     AndTagExpression tagExpression;
 };
 
-class BeforeHook : public Hook {
-};
+class CUCUMBER_CPP_EXPORT BeforeHook : public Hook {};
 
-class AroundStepHook : public Hook {
+class CUCUMBER_CPP_EXPORT AroundStepHook : public Hook {
 public:
     virtual void invokeHook(Scenario *scenario, CallableStep *step);
     virtual void skipHook();
 protected:
     CallableStep *step;
 };
 
-class AfterStepHook : public Hook {
-};
+class CUCUMBER_CPP_EXPORT AfterStepHook : public Hook {};
 
-class AfterHook : public Hook {
-};
+class CUCUMBER_CPP_EXPORT AfterHook : public Hook {};
 
-class UnconditionalHook : public Hook {
+class CUCUMBER_CPP_EXPORT UnconditionalHook : public Hook {
 public:
     virtual void invokeHook(Scenario *scenario, CallableStep *step);
 };
 
-class BeforeAllHook : public UnconditionalHook {
-};
+class CUCUMBER_CPP_EXPORT BeforeAllHook : public UnconditionalHook {};
 
-class AfterAllHook : public UnconditionalHook {
-};
+class CUCUMBER_CPP_EXPORT AfterAllHook : public UnconditionalHook {};
 
-class HookRegistrar {
+class CUCUMBER_CPP_EXPORT HookRegistrar {
 public:
     typedef std::list< boost::shared_ptr<Hook> > hook_list_type;
     typedef std::list< boost::shared_ptr<AroundStepHook> > aroundhook_list_type;
@@ -107,8 +103,7 @@ class HookRegistrar {
         ;
 };
 
-
-class StepCallChain {
+class CUCUMBER_CPP_EXPORT StepCallChain {
 public:
     StepCallChain(Scenario *scenario, const StepInfo* stepInfo, const InvokeArgs *pStepArgs, HookRegistrar::aroundhook_list_type &aroundHooks);
     InvokeResult exec();
@@ -125,7 +120,7 @@ class StepCallChain {
     InvokeResult result;
 };
 
-class CallableStepChain : public CallableStep {
+class CUCUMBER_CPP_EXPORT CallableStepChain : public CallableStep {
 public:
     CallableStepChain(StepCallChain *scc);
     void call();
diff --git a/include/cucumber-cpp/internal/hook/Tag.hpp b/include/cucumber-cpp/internal/hook/Tag.hpp
diff --git a/include/cucumber-cpp/internal/step/StepManager.hpp b/include/cucumber-cpp/internal/step/StepManager.hpp
diff --git a/src/CMakeLists.txt b/src/CMakeLists.txt
diff --git a/src/CukeEngine.cpp b/src/CukeEngine.cpp
