Support building as a shared library on Windows

On Windows, it is necessary to add some __declspec() calls to expose
some symbols with different linkage types. This commit adds the
CUKE_API_ macro, which makes it possible for users to easily build
cucumber-cpp on Windows either as a static or dynamic library by
defining either CUKE_LINKED_AS_SHARED_LIBRARY or
CUKE_CREATE_SHARED_LIBRARY at build time.

Author: nre-ableton

CMakeLists.txt

@@ -4,6 +4,7 @@ project(Cucumber-Cpp)
 
 set(CUKE_USE_STATIC_BOOST ${WIN32} CACHE BOOL "Statically link Boost (except boost::test)")
 set(CUKE_USE_STATIC_GTEST ON CACHE BOOL "Statically link Google Test")
+set(CUKE_ENABLE_SHARED_LIB OFF CACHE BOOL "Generate a shared library")
 
 set(CUKE_DISABLE_BOOST_TEST OFF CACHE BOOL "Disable boost:test")
 set(CUKE_DISABLE_GTEST OFF CACHE BOOL "Disable Google Test framework")

include/cucumber-cpp/internal/ContextManager.hpp

@@ -1,6 +1,8 @@
 #ifndef CUKE_CONTEXTMANAGER_HPP_
 #define CUKE_CONTEXTMANAGER_HPP_
 
+#include "CukeDll.hpp"
+
 #include <vector>
 
 #include <boost/make_shared.hpp>
@@ -16,7 +18,7 @@ namespace internal {
 
 typedef std::vector<shared_ptr<void> > contexts_type;
 
-class ContextManager {
+class CUKE_API_ ContextManager {
 public:
     void purgeContexts();
     template<class T> weak_ptr<T> addContext();

include/cucumber-cpp/internal/CukeCommands.hpp

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

include/cucumber-cpp/internal/CukeDll.hpp

@@ -0,0 +1,14 @@
+#ifndef CUKE_CUKEDLL_HPP_
+#define CUKE_CUKEDLL_HPP_
+
+#ifndef CUKE_API_
+#if CUKE_LINKED_AS_SHARED_LIBRARY
+#define CUKE_API_ __declspec(dllimport)
+#elif CUKE_CREATE_SHARED_LIBRARY
+#define CUKE_API_ __declspec(dllexport)
+#else
+#define CUKE_API_
+#endif
+#endif
+
+#endif /* CUKE_CUKEDLL_HPP_ */

include/cucumber-cpp/internal/CukeEngine.hpp

@@ -1,6 +1,8 @@
 #ifndef CUKE_CUKEENGINE_HPP_
 #define CUKE_CUKEENGINE_HPP_
 
+#include "CukeDll.hpp"
+
 #include <string>
 #include <vector>
 
@@ -9,21 +11,21 @@
 namespace cucumber {
 namespace internal {
 
-class StepMatchArg {
+class CUKE_API_ StepMatchArg {
 public:
     std::string value;
     int position;
 };
 
-class StepMatch {
+class CUKE_API_ StepMatch {
 public:
     std::string id;
     std::vector<StepMatchArg> args;
     std::string source;
     std::string regexp;
 };
 
-class InvokeException {
+class CUKE_API_ InvokeException {
 private:
     const std::string message;
 
@@ -36,7 +38,7 @@ class InvokeException {
     virtual ~InvokeException() {}
 };
 
-class InvokeFailureException : public InvokeException {
+class CUKE_API_ InvokeFailureException : public InvokeException {
 private:
     const std::string exceptionType;
 
@@ -47,7 +49,7 @@ class InvokeFailureException : public InvokeException {
     const std::string getExceptionType() const;
 };
 
-class PendingStepException : public InvokeException {
+class CUKE_API_ PendingStepException : public InvokeException {
 public:
     PendingStepException(const std::string & message);
     PendingStepException(const PendingStepException &rhs);
@@ -59,7 +61,7 @@ class PendingStepException : public InvokeException {
  * It uses standard types (as much as possible) to be easier to call.
  * Returns standard types if possible.
  */
-class CukeEngine {
+class CUKE_API_ CukeEngine {
 private:
     typedef std::vector<std::string> string_array;
     typedef boost::multi_array<std::string, 2> string_2d_array;

include/cucumber-cpp/internal/CukeEngineImpl.hpp

@@ -13,7 +13,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 CUKE_API_ 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 "CukeDll.hpp"
+
 #include <vector>
 #include <map>
 #include <string>
@@ -9,7 +11,7 @@
 namespace cucumber {
 namespace internal {
 
-class Table {
+class CUKE_API_ Table {
 private:
     typedef std::vector<std::string> basic_type;
 public:

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

@@ -2,6 +2,7 @@
 #define CUKE_WIREPROTOCOL_HPP_
 
 #include "ProtocolHandler.hpp"
+#include "../../CukeDll.hpp"
 #include "../../CukeEngine.hpp"
 #include <boost/shared_ptr.hpp>
 
@@ -14,7 +15,7 @@ namespace internal {
 
 class WireResponseVisitor;
 
-class WireResponse {
+class CUKE_API_ WireResponse {
 public:
     WireResponse() {};
 
@@ -23,12 +24,12 @@ class WireResponse {
     virtual ~WireResponse() {};
 };
 
-class SuccessResponse : public WireResponse {
+class CUKE_API_ SuccessResponse : public WireResponse {
 public:
     void accept(WireResponseVisitor& visitor) const;
 };
 
-class FailureResponse : public WireResponse {
+class CUKE_API_ FailureResponse : public WireResponse {
 private:
     const std::string message, exceptionType;
 
@@ -41,7 +42,7 @@ class FailureResponse : public WireResponse {
     void accept(WireResponseVisitor& visitor) const;
 };
 
-class PendingResponse : public WireResponse {
+class CUKE_API_ PendingResponse : public WireResponse {
 private:
     const std::string message;
 
@@ -53,7 +54,7 @@ class PendingResponse : public WireResponse {
     void accept(WireResponseVisitor& visitor) const;
 };
 
-class StepMatchesResponse : public WireResponse {
+class CUKE_API_ StepMatchesResponse : public WireResponse {
 private:
     const std::vector<StepMatch> matchingSteps;
 
@@ -64,7 +65,7 @@ class StepMatchesResponse : public WireResponse {
     void accept(WireResponseVisitor& visitor) const;
 };
 
-class SnippetTextResponse : public WireResponse {
+class CUKE_API_ SnippetTextResponse : public WireResponse {
 private:
     const std::string stepSnippet;
 
@@ -76,7 +77,7 @@ class SnippetTextResponse : public WireResponse {
     void accept(WireResponseVisitor& visitor) const;
 };
 
-class WireResponseVisitor {
+class CUKE_API_ WireResponseVisitor {
 public:
     virtual void visit(const SuccessResponse& response) = 0;
     virtual void visit(const FailureResponse& response) = 0;
@@ -91,7 +92,7 @@ class WireResponseVisitor {
 /**
  * Wire protocol request command.
  */
-class WireCommand {
+class CUKE_API_ WireCommand {
 public:
     /**
      * Runs the command on the provided engine
@@ -105,7 +106,7 @@ class WireCommand {
     virtual ~WireCommand() {};
 };
 
-class WireMessageCodecException : public std::exception {
+class CUKE_API_ WireMessageCodecException : public std::exception {
 private:
     const char *description;
 
@@ -123,7 +124,7 @@ class WireMessageCodecException : public std::exception {
 /**
  * Transforms wire messages into commands and responses to messages.
  */
-class WireMessageCodec {
+class CUKE_API_ WireMessageCodec {
 public:
     /**
      * Decodes a wire message into a command.
@@ -151,7 +152,7 @@ class WireMessageCodec {
 /**
  * WireMessageCodec implementation with JsonSpirit.
  */
-class JsonSpiritWireMessageCodec : public WireMessageCodec {
+class CUKE_API_ JsonSpiritWireMessageCodec : public WireMessageCodec {
 public:
     JsonSpiritWireMessageCodec();
     boost::shared_ptr<WireCommand> decode(const std::string &request) const;
@@ -162,7 +163,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 CUKE_API_ WireProtocolHandler : public ProtocolHandler {
 private:
     const WireMessageCodec& codec;
     CukeEngine& engine;

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

@@ -2,6 +2,7 @@
 #define CUKE_WIRESERVER_HPP_
 
 #include "ProtocolHandler.hpp"
+#include "../../CukeDll.hpp"
 
 #include <string>
 
@@ -19,7 +20,7 @@ using namespace boost::asio::local;
 /**
  * Socket server that calls a protocol handler line by line
  */
-class SocketServer {
+class CUKE_API_ SocketServer {
 public:
     /**
       * Constructor for DI
@@ -46,7 +47,7 @@ class SocketServer {
 /**
  * Socket server that calls a protocol handler line by line
  */
-class TCPSocketServer : public SocketServer {
+class CUKE_API_ TCPSocketServer : public SocketServer {
 public:
     /**
      * Type definition for TCP port

include/cucumber-cpp/internal/defs.hpp

@@ -1,5 +1,6 @@
 #include "step/StepManager.hpp"
 #include "hook/HookRegistrar.hpp"
 #include "ContextManager.hpp"
+#include "CukeDll.hpp"
 #include "Macros.hpp"
 #include "drivers/DriverSelector.hpp"

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

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

include/cucumber-cpp/internal/hook/HookRegistrar.hpp

@@ -2,6 +2,7 @@
 #define CUKE_HOOKREGISTRAR_HPP_
 
 #include "Tag.hpp"
+#include "../CukeDll.hpp"
 #include "../Scenario.hpp"
 #include "../step/StepManager.hpp"
 
@@ -14,12 +15,12 @@ using boost::shared_ptr;
 namespace cucumber {
 namespace internal {
 
-class CallableStep {
+class CUKE_API_ CallableStep {
 public:
     virtual void call() = 0;
 };
 
-class Hook {
+class CUKE_API_ Hook {
 public:
     void setTags(const std::string &csvTagNotation);
     virtual void invokeHook(Scenario *scenario, CallableStep *step);
@@ -31,35 +32,35 @@ class Hook {
     shared_ptr<TagExpression> tagExpression;
 };
 
-class BeforeHook : public Hook {
+class CUKE_API_ BeforeHook : public Hook {
 };
 
-class AroundStepHook : public Hook {
+class CUKE_API_ AroundStepHook : public Hook {
 public:
     virtual void invokeHook(Scenario *scenario, CallableStep *step);
     virtual void skipHook();
 protected:
     CallableStep *step;
 };
 
-class AfterStepHook : public Hook {
+class CUKE_API_ AfterStepHook : public Hook {
 };
 
-class AfterHook : public Hook {
+class CUKE_API_ AfterHook : public Hook {
 };
 
-class UnconditionalHook : public Hook {
+class CUKE_API_ UnconditionalHook : public Hook {
 public:
     virtual void invokeHook(Scenario *scenario, CallableStep *step);
 };
 
-class BeforeAllHook : public UnconditionalHook {
+class CUKE_API_ BeforeAllHook : public UnconditionalHook {
 };
 
-class AfterAllHook : public UnconditionalHook {
+class CUKE_API_ AfterAllHook : public UnconditionalHook {
 };
 
-class HookRegistrar {
+class CUKE_API_ HookRegistrar {
 public:
     typedef std::list< boost::shared_ptr<Hook> > hook_list_type;
     typedef std::list< boost::shared_ptr<AroundStepHook> > aroundhook_list_type;
@@ -97,7 +98,7 @@ class HookRegistrar {
 };
 
 
-class StepCallChain {
+class CUKE_API_ StepCallChain {
 public:
     StepCallChain(Scenario *scenario, const boost::shared_ptr<const StepInfo>& stepInfo, const InvokeArgs *pStepArgs, HookRegistrar::aroundhook_list_type &aroundHooks);
     InvokeResult exec();
@@ -114,7 +115,7 @@ class StepCallChain {
     InvokeResult result;
 };
 
-class CallableStepChain : public CallableStep {
+class CUKE_API_ CallableStepChain : public CallableStep {
 public:
     CallableStepChain(StepCallChain *scc);
     void call();