Merge pull request SQFvm#190 from DarkWanderer/feature/dll-exports

Proper "export" header for library consumers

Author: X39

CMakeLists.txt

@@ -61,10 +61,14 @@ add_executable(sqfvm ${sqfvm_SOURCES})
 
 target_link_libraries(sqfvm ${CMAKE_DL_LIBS} ${CMAKE_THREAD_LIBS_INIT} ${ST_CXXFS_LIBS})
 target_include_directories(sqfvm PUBLIC ${PROJECT_SOURCE_DIR}/src)
+target_compile_definitions(sqfvm PRIVATE SQFVM_BUILD)
 
 add_library(libsqfvm SHARED ${sqfvm_SOURCES})
 target_include_directories(libsqfvm PUBLIC ${PROJECT_SOURCE_DIR}/src)
-target_compile_definitions(libsqfvm PUBLIC DISABLE_CLIPBOARD)
+target_compile_definitions(libsqfvm 
+    PUBLIC DISABLE_CLIPBOARD 
+    PRIVATE SQFVM_BUILD # this is a define visible only to the library itself
+)
 set_target_properties(libsqfvm PROPERTIES PREFIX "")
 
 if (SQFVM_ENABLE_SQC_SUPPORT)

src/export/dllexports.cpp src/export/sqfvm.cppsrc/export/dllexports.cpp renamed to src/export/sqfvm.cpp

@@ -6,7 +6,8 @@
 #include "../parser/preprocessor/default.h"
 #include "../operators/ops.h"
 #include "../fileio/default.h"
-#include "dllexports.h"
+
+#include "sqfvm.h"
 
 #ifdef SQF_SQC_SUPPORT
 #include "../sqc/sqc_parser.h"
@@ -147,23 +148,23 @@ namespace dllexports
     }
 }
 extern "C" {
-    DLLEXPORT_PREFIX void* sqfvm_create_instance(void* user_data, sqfvm_log_callback callback, float max_runtime_seconds)
+    SQFVM_EXPORT void* sqfvm_create_instance(void* user_data, sqfvm_log_callback callback, float max_runtime_seconds)
     {
         return dllexports::create_instance(user_data, callback, max_runtime_seconds, dllexports::ops_set::full);
     }
-    DLLEXPORT_PREFIX void* sqfvm_create_instance_basic(void* user_data, sqfvm_log_callback callback, float max_runtime_seconds)
+    SQFVM_EXPORT void* sqfvm_create_instance_basic(void* user_data, sqfvm_log_callback callback, float max_runtime_seconds)
     {
         return dllexports::create_instance(user_data, callback, max_runtime_seconds, dllexports::ops_set::basic);
     }
-    DLLEXPORT_PREFIX void* sqfvm_create_instance_empty(void* user_data, sqfvm_log_callback callback, float max_runtime_seconds)
+    SQFVM_EXPORT void* sqfvm_create_instance_empty(void* user_data, sqfvm_log_callback callback, float max_runtime_seconds)
     {
         return dllexports::create_instance(user_data, callback, max_runtime_seconds, dllexports::ops_set::none);
     }
-    DLLEXPORT_PREFIX void sqfvm_destroy_instance(void* instance)
+    SQFVM_EXPORT void sqfvm_destroy_instance(void* instance)
     {
         return dllexports::destroy_instance(instance);
     }
-    DLLEXPORT_PREFIX int32_t sqfvm_load_config(void* instance, const char* contents, uint32_t length)
+    SQFVM_EXPORT int32_t sqfvm_load_config(void* instance, const char* contents, uint32_t length)
     {
         const int32_t instance_invalid = -1;
         const int32_t preprocessing_failed = -2;
@@ -190,7 +191,7 @@ extern "C" {
             return instance_invalid;
         }
     }
-    DLLEXPORT_PREFIX int32_t sqfvm_call(void* instance, void* call_data, char type, const char* code, uint32_t length)
+    SQFVM_EXPORT int32_t sqfvm_call(void* instance, void* call_data, char type, const char* code, uint32_t length)
     {
         const int32_t instance_invalid = -1;
         const int32_t preprocessing_failed = -2;
@@ -341,7 +342,7 @@ extern "C" {
             return instance_invalid;
         }
     }
-    DLLEXPORT_PREFIX int32_t sqfvm_status(void* instance)
+    SQFVM_EXPORT int32_t sqfvm_status(void* instance)
     {
         auto result = dllexports::with_instance_do(instance, [](dllexports::instance& ref) -> int32_t {
             return static_cast<int32_t>(ref.runtime->runtime_state());
@@ -355,4 +356,4 @@ extern "C" {
             return -1;
         }
     }
-}
+}

src/export/dllexports.h src/export/sqfvm.hsrc/export/dllexports.h renamed to src/export/sqfvm.h

@@ -1,11 +1,13 @@
 #pragma once
-#include <vector>
-
 
 #ifdef _WIN32
-#define DLLEXPORT_PREFIX __declspec(dllexport)
+#ifdef SQFVM_BUILD
+#define SQFVM_EXPORT __declspec(dllexport)
+#else
+#define SQFVM_EXPORT __declspec(dllimport)
+#endif
 #else
-#define DLLEXPORT_PREFIX __attribute__((visibility("default")))
+#define SQFVM_EXPORT __attribute__((visibility("default")))
 #endif
 
 extern "C" {
@@ -27,24 +29,24 @@ extern "C" {
     // @param user_data Custom data from the callee that will be passed into callback
     // @param max_runtime_seconds the maximum runtime in seconds as float. Pass 0
     // Returns NULL on error
-    DLLEXPORT_PREFIX void* sqfvm_create_instance(void* user_data, sqfvm_log_callback callback, float max_runtime_seconds);
+    SQFVM_EXPORT void* sqfvm_create_instance(void* user_data, sqfvm_log_callback callback, float max_runtime_seconds);
 
     // Creates a new SQF-VM instance with the basic, non-arma specific operators loaded
     // @param callback The callback to report log messages on
     // @param user_data Custom data from the callee that will be passed into callback
     // @param max_runtime_seconds the maximum runtime in seconds as float. Pass 0
     // Returns NULL on error
-    DLLEXPORT_PREFIX void* sqfvm_create_instance_basic(void* user_data, sqfvm_log_callback callback, float max_runtime_seconds);
+    SQFVM_EXPORT void* sqfvm_create_instance_basic(void* user_data, sqfvm_log_callback callback, float max_runtime_seconds);
 
     // Creates a new SQF-VM instance without any operators loaded
     // @param callback The callback to report log messages on
     // @param user_data Custom data from the callee that will be passed into callback
     // @param max_runtime_seconds the maximum runtime in seconds as float. Pass 0
     // Returns NULL on error
-    DLLEXPORT_PREFIX void* sqfvm_create_instance_empty(void* user_data, sqfvm_log_callback callback, float max_runtime_seconds);
+    SQFVM_EXPORT void* sqfvm_create_instance_empty(void* user_data, sqfvm_log_callback callback, float max_runtime_seconds);
 
     // Destroys a previously created SQF-VM instance
-    DLLEXPORT_PREFIX void sqfvm_destroy_instance(void* instance);
+    SQFVM_EXPORT void sqfvm_destroy_instance(void* instance);
 
     // Loads the provided config into the config tree of the provided instance
     // @param instance A valid instance as returned from sqfvm_create_instance
@@ -54,7 +56,7 @@ extern "C" {
     //         -1 if the instance was null
     //         -2 if preprocessing failed
     //         -3 if parsing failed
-    DLLEXPORT_PREFIX int32_t sqfvm_load_config(void* instance, const char* contents, uint32_t length);
+    SQFVM_EXPORT int32_t sqfvm_load_config(void* instance, const char* contents, uint32_t length);
 
     // Checks the status of the instance
     // @param instance A valid instance as returned from sqfvm_create_instance
@@ -65,7 +67,7 @@ extern "C" {
     //         +3 Instance is in halted_error
     //         +4 evaluating
     //         
-    DLLEXPORT_PREFIX int32_t sqfvm_status(void* instance);
+    SQFVM_EXPORT int32_t sqfvm_status(void* instance);
 
     // Calls the provided code, using the SQF-VM instance.
     // @param instance A valid instance as returned from sqfvm_create_instance
@@ -86,5 +88,5 @@ extern "C" {
     //         -4 if the instance is already running
     //         -5 if the provided type was invalid
     //         -6 if the execution did not succeed
-    DLLEXPORT_PREFIX int32_t sqfvm_call(void* instance, void* call_data, char type, const char* code, uint32_t length);
-}
+    SQFVM_EXPORT int32_t sqfvm_call(void* instance, void* call_data, char type, const char* code, uint32_t length);
+}