Add Platform.hpp

Author: vinniefalco

CMakeLists.txt

@@ -92,6 +92,11 @@ target_include_directories(mrdox-api
     PRIVATE
     "${PROJECT_SOURCE_DIR}/source/lib/"
 )
+target_compile_definitions(
+    mrdox-api
+    PRIVATE
+    -DMRDOX_LIB
+)
 
 # LLVM
 target_link_libraries(mrdox-api PUBLIC ${llvm_libs})
@@ -113,6 +118,7 @@ else()
 endif()
 target_include_directories(mrdox-api SYSTEM PUBLIC ${CLANG_INCLUDE_DIRS})
 
+
 # Windows, Win64
 if (WIN32)
     target_compile_definitions(

include/mrdox/Config.hpp

@@ -12,6 +12,7 @@
 #ifndef MRDOX_CONFIG_HPP
 #define MRDOX_CONFIG_HPP
 
+#include <mrdox/Platform.hpp>
 #include <mrdox/Reporter.hpp>
 #include <clang/Tooling/ArgumentsAdjusters.h>
 #include <llvm/ADT/Optional.h>

include/mrdox/Corpus.hpp

@@ -12,6 +12,7 @@
 #ifndef MRDOX_CORPUS_HPP
 #define MRDOX_CORPUS_HPP
 
+#include <mrdox/Platform.hpp>
 #include <mrdox/Config.hpp>
 #include <mrdox/Debug.hpp>
 #include <mrdox/MetadataFwd.hpp>

include/mrdox/Debug.hpp

@@ -11,6 +11,7 @@
 #ifndef MRDOX_DEBUG_HPP
 #define MRDOX_DEBUG_HPP
 
+#include <mrdox/Platform.hpp>
 #if ! defined(NDEBUG)
 #include <llvm/Support/ErrorHandling.h>
 #endif

include/mrdox/Error.hpp

@@ -12,6 +12,7 @@
 #ifndef MRDOX_ERROR_HPP
 #define MRDOX_ERROR_HPP
 
+#include <mrdox/Platform.hpp>
 #include <llvm/Support/Error.h>
 #include <llvm/Support/raw_ostream.h>
 #include <source_location>

include/mrdox/Generator.hpp

@@ -15,6 +15,7 @@
 #ifndef MRDOX_GENERATOR_HPP
 #define MRDOX_GENERATOR_HPP
 
+#include <mrdox/Platform.hpp>
 #include <mrdox/Config.hpp>
 #include <mrdox/Corpus.hpp>
 #include <mrdox/Reporter.hpp>

include/mrdox/Generators.hpp

@@ -0,0 +1,34 @@
+//
+// Licensed under the Apache License v2.0 with LLVM Exceptions.
+// See https://llvm.org/LICENSE.txt for license information.
+// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+//
+// Copyright (c) 2023 Vinnie Falco ([email protected])
+//
+// Official repository: https://github.com/cppalliance/mrdox
+//
+
+#ifndef MRDOX_GENERATORS_HPP
+#define MRDOX_GENERATORS_HPP
+
+#include <mrdox/Platform.hpp>
+
+namespace clang {
+namespace mrdox {
+
+/** A dynamic list of Generator
+*/
+class Generators
+{
+    Generators() noexcept;
+
+public:
+    /** Destructor.
+    */
+    virtual ~Generators() = default;
+};
+
+} // mrdox
+} // clang
+
+#endif

include/mrdox/Metadata.hpp

@@ -12,6 +12,8 @@
 #ifndef MRDOX_METADATA_HPP
 #define MRDOX_METADATA_HPP
 
+#include <mrdox/Platform.hpp>
+
 // All headers related to
 // metadata extracted from AST
 

include/mrdox/MetadataFwd.hpp

@@ -12,11 +12,12 @@
 #ifndef MRDOX_METADATA_FWD_HPP
 #define MRDOX_METADATA_FWD_HPP
 
+#include <mrdox/Platform.hpp>
+#include <mrdox/meta/Symbols.hpp>
+
 // Forward declarations for all types
 // related to metadata extracted from AST
 
-#include <mrdox/meta/Symbols.hpp>
-
 namespace clang {
 namespace mrdox {
 

include/mrdox/Platform.hpp

@@ -0,0 +1,44 @@
+//
+// Licensed under the Apache License v2.0 with LLVM Exceptions.
+// See https://llvm.org/LICENSE.txt for license information.
+// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+//
+// Copyright (c) 2023 Vinnie Falco ([email protected])
+//
+// Official repository: https://github.com/cppalliance/mrdox
+//
+
+#ifndef MRDOX_PLATFORM_HPP
+#define MRDOX_PLATFORM_HPP
+
+/*
+    Platform-specific things, and stuff
+    that is dependent on the toolchain.
+*/
+
+namespace clang {
+namespace mrdox {
+
+// MSVC
+#if defined(_MSC_VER)
+# define MRDOX_SYMBOL_EXPORT __declspec(dllexport)
+# define MRDOX_SYMBOL_IMPORT __declspec(dllimport)
+# define MRDOX_SYMBOL_VISIBLE
+# if defined(MRDOX_LIB) // building library
+#  define MRDOX_DECL MRDOX_SYMBOL_EXPORT
+# else
+#  define MRDOX_DECL MRDOX_SYMBOL_IMPORT
+# endif
+
+// (others)
+#else
+# define MRDOX_SYMBOL_EXPORT
+# define MRDOX_SYMBOL_IMPORT
+# define MRDOX_SYMBOL_VISIBLE
+# define MRDOX_DECL
+#endif
+
+} // mrdox
+} // clang
+
+#endif