Add Platform.hpp

vinniefalco · vinniefalco · commit ce2fba1421c5 · 2023-04-23T14:42:39.000-07:00
diff --git a/CMakeLists.txt b/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(
diff --git a/include/mrdox/Config.hpp b/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>
diff --git a/include/mrdox/Corpus.hpp b/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>
diff --git a/include/mrdox/Debug.hpp b/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
diff --git a/include/mrdox/Error.hpp b/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>
diff --git a/include/mrdox/Generator.hpp b/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>
diff --git a/include/mrdox/Generators.hpp b/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 (vinnie.falco@gmail.com)
+//
+// 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
diff --git a/include/mrdox/Metadata.hpp b/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
 
diff --git a/include/mrdox/MetadataFwd.hpp b/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 {
 
diff --git a/include/mrdox/Platform.hpp b/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 (vinnie.falco@gmail.com)
+//
+// 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
diff --git a/include/mrdox/Reporter.hpp b/include/mrdox/Reporter.hpp
@@ -12,6 +12,7 @@
 #ifndef MRDOX_REPORTER_HPP
 #define MRDOX_REPORTER_HPP
 
+#include <mrdox/Platform.hpp>
 #include <mrdox/Error.hpp>
 #include <llvm/Support/Error.h>
 #include <llvm/Support/Mutex.h>
diff --git a/include/mrdox/meta/BaseRecord.hpp b/include/mrdox/meta/BaseRecord.hpp
@@ -12,6 +12,7 @@
 #ifndef MRDOX_META_BASERECORD_HPP
 #define MRDOX_META_BASERECORD_HPP
 
+#include <mrdox/Platform.hpp>
 #include <mrdox/meta/Record.hpp>
 
 namespace clang {
diff --git a/include/mrdox/meta/Enum.hpp b/include/mrdox/meta/Enum.hpp
@@ -9,14 +9,10 @@
 // Official repository: https://github.com/cppalliance/mrdox
 //
 
-//
-// This file defines the internal representations of different declaration
-// types for the clang-doc tool.
-//
-
 #ifndef MRDOX_META_ENUM_HPP
 #define MRDOX_META_ENUM_HPP
 
+#include <mrdox/Platform.hpp>
 #include <mrdox/meta/Symbol.hpp>
 #include <mrdox/meta/Type.hpp>
 #include <llvm/ADT/Optional.h>
diff --git a/include/mrdox/meta/FieldType.hpp b/include/mrdox/meta/FieldType.hpp
@@ -12,6 +12,7 @@
 #ifndef MRDOX_META_FIELDTYPE_HPP
 #define MRDOX_META_FIELDTYPE_HPP
 
+#include <mrdox/Platform.hpp>
 #include <mrdox/meta/Type.hpp>
 #include <llvm/ADT/SmallString.h>
 #include <utility>
diff --git a/include/mrdox/meta/Function.hpp b/include/mrdox/meta/Function.hpp
@@ -12,6 +12,7 @@
 #ifndef MRDOX_FUNCTION_HPP
 #define MRDOX_FUNCTION_HPP
 
+#include <mrdox/Platform.hpp>
 #include <mrdox/meta/FieldType.hpp>
 #include <mrdox/meta/Function.hpp>
 #include <mrdox/meta/Symbol.hpp>
diff --git a/include/mrdox/meta/Info.hpp b/include/mrdox/meta/Info.hpp
@@ -12,6 +12,7 @@
 #ifndef MRDOX_INFO_HPP
 #define MRDOX_INFO_HPP
 
+#include <mrdox/Platform.hpp>
 #include <mrdox/meta/Javadoc.hpp>
 #include <mrdox/meta/Reference.hpp>
 #include <mrdox/meta/Symbols.hpp>
diff --git a/include/mrdox/meta/Javadoc.hpp b/include/mrdox/meta/Javadoc.hpp
@@ -12,6 +12,7 @@
 #ifndef MRDOX_META_JAVADOC_HPP
 #define MRDOX_META_JAVADOC_HPP
 
+#include <mrdox/Platform.hpp>
 #include <mrdox/meta/List.hpp>
 #include <llvm/ADT/SmallString.h>
 #include <memory>
diff --git a/include/mrdox/meta/List.hpp b/include/mrdox/meta/List.hpp
@@ -12,6 +12,7 @@
 #ifndef MRDOX_META_LIST_HPP
 #define MRDOX_META_LIST_HPP
 
+#include <mrdox/Platform.hpp>
 #include <algorithm>
 #include <compare>
 #include <cstdint>
diff --git a/include/mrdox/meta/Location.hpp b/include/mrdox/meta/Location.hpp
@@ -12,6 +12,7 @@
 #ifndef MRDOX_LOCATION_HPP
 #define MRDOX_LOCATION_HPP
 
+#include <mrdox/Platform.hpp>
 #include <llvm/ADT/SmallString.h>
 #include <llvm/ADT/StringRef.h>
 
diff --git a/include/mrdox/meta/MemberType.hpp b/include/mrdox/meta/MemberType.hpp
@@ -12,6 +12,7 @@
 #ifndef MRDOX_META_MEMBERTYPE_HPP
 #define MRDOX_META_MEMBERTYPE_HPP
 
+#include <mrdox/Platform.hpp>
 #include <mrdox/meta/Javadoc.hpp>
 #include <mrdox/meta/FieldType.hpp>
 #include <mrdox/meta/Function.hpp>
diff --git a/include/mrdox/meta/Namespace.hpp b/include/mrdox/meta/Namespace.hpp
@@ -12,6 +12,7 @@
 #ifndef MRDOX_META_NAMESPACE_HPP
 #define MRDOX_META_NAMESPACE_HPP
 
+#include <mrdox/Platform.hpp>
 #include <mrdox/meta/Info.hpp>
 #include <mrdox/meta/Scope.hpp>
 
diff --git a/include/mrdox/meta/Overloads.hpp b/include/mrdox/meta/Overloads.hpp
@@ -12,6 +12,7 @@
 #ifndef MRDOX_META_OVERLOADS_HPP
 #define MRDOX_META_OVERLOADS_HPP
 
+#include <mrdox/Platform.hpp>
 #include <mrdox/meta/Function.hpp>
 #include <clang/Basic/Specifiers.h>
 #include <llvm/ADT/StringRef.h>
diff --git a/include/mrdox/meta/Record.hpp b/include/mrdox/meta/Record.hpp
@@ -12,6 +12,7 @@
 #ifndef MRDOX_META_RECORD_HPP
 #define MRDOX_META_RECORD_HPP
 
+#include <mrdox/Platform.hpp>
 #include <mrdox/meta/MemberType.hpp>
 #include <mrdox/meta/Reference.hpp>
 #include <mrdox/meta/Scope.hpp>
diff --git a/include/mrdox/meta/Reference.hpp b/include/mrdox/meta/Reference.hpp
@@ -12,6 +12,7 @@
 #ifndef MRDOX_META_REFERENCE_HPP
 #define MRDOX_META_REFERENCE_HPP
 
+#include <mrdox/Platform.hpp>
 #include <mrdox/meta/Symbols.hpp>
 #include <llvm/ADT/SmallString.h>
 #include <llvm/ADT/StringRef.h>
diff --git a/include/mrdox/meta/Scope.hpp b/include/mrdox/meta/Scope.hpp
@@ -12,6 +12,7 @@
 #ifndef MRDOX_META_SCOPE_HPP
 #define MRDOX_META_SCOPE_HPP
 
+#include <mrdox/Platform.hpp>
 #include <mrdox/meta/Reference.hpp>
 #include <mrdox/meta/Typedef.hpp>
 #include <mrdox/meta/Enum.hpp>
diff --git a/include/mrdox/meta/Symbol.hpp b/include/mrdox/meta/Symbol.hpp
@@ -12,6 +12,7 @@
 #ifndef MRDOX_META_SYMBOL_HPP
 #define MRDOX_META_SYMBOL_HPP
 
+#include <mrdox/Platform.hpp>
 #include <mrdox/meta/Info.hpp>
 #include <mrdox/meta/Location.hpp>
 #include <llvm/ADT/Optional.h>
diff --git a/include/mrdox/meta/Symbols.hpp b/include/mrdox/meta/Symbols.hpp
@@ -12,6 +12,7 @@
 #ifndef MRDOX_META_SYMBOLS_HPP
 #define MRDOX_META_SYMBOLS_HPP
 
+#include <mrdox/Platform.hpp>
 #include <llvm/ADT/StringRef.h>
 #include <array>
 
diff --git a/include/mrdox/meta/Template.hpp b/include/mrdox/meta/Template.hpp
@@ -12,6 +12,7 @@
 #ifndef MRDOX_META_TEMPLATE_HPP
 #define MRDOX_META_TEMPLATE_HPP
 
+#include <mrdox/Platform.hpp>
 #include <mrdox/meta/TemplateParam.hpp>
 #include <llvm/ADT/Optional.h>
 
diff --git a/include/mrdox/meta/TemplateParam.hpp b/include/mrdox/meta/TemplateParam.hpp
@@ -12,6 +12,7 @@
 #ifndef MRDOX_META_TEMPLATEPARAM_HPP
 #define MRDOX_META_TEMPLATEPARAM_HPP
 
+#include <mrdox/Platform.hpp>
 #include <clang/AST/Decl.h>
 #include <clang/AST/Type.h>
 #include <llvm/ADT/SmallString.h>
diff --git a/include/mrdox/meta/Type.hpp b/include/mrdox/meta/Type.hpp
@@ -12,6 +12,7 @@
 #ifndef MRDOX_META_TYPE_HPP
 #define MRDOX_META_TYPE_HPP
 
+#include <mrdox/Platform.hpp>
 #include <mrdox/meta/Reference.hpp>
 
 namespace clang {
diff --git a/include/mrdox/meta/Typedef.hpp b/include/mrdox/meta/Typedef.hpp
@@ -12,6 +12,7 @@
 #ifndef MRDOX_META_TYPEDEF_HPP
 #define MRDOX_META_TYPEDEF_HPP
 
+#include <mrdox/Platform.hpp>
 #include <mrdox/meta/Symbol.hpp>
 #include <mrdox/meta/Type.hpp>
 
diff --git a/source/lib/Bitcode.hpp b/source/lib/Bitcode.hpp
@@ -12,6 +12,7 @@
 #ifndef MRDOX_SOURCE_BITCODE_HPP
 #define MRDOX_SOURCE_BITCODE_HPP
 
+#include <mrdox/Platform.hpp>
 #include <mrdox/MetadataFwd.hpp>
 #include <mrdox/Reporter.hpp>
 #include <clang/Tooling/Execution.h>
diff --git a/source/lib/Commands.hpp b/source/lib/Commands.hpp
@@ -11,6 +11,8 @@
 #ifndef MRDOX_SOURCE_COMMANDS_HPP
 #define MRDOX_SOURCE_COMMANDS_HPP
 
+#include <mrdox/Platform.hpp>
+
 namespace clang {
 
 class ASTContext;
diff --git a/source/lib/CorpusImpl.hpp b/source/lib/CorpusImpl.hpp
@@ -12,6 +12,7 @@
 #ifndef MRDOX_SOURCE_CORPUSIMPL_HPP
 #define MRDOX_SOURCE_CORPUSIMPL_HPP
 
+#include <mrdox/Platform.hpp>
 #include "Bitcode.hpp"
 #include <mrdox/Corpus.hpp>
 #include <string>
diff --git a/source/lib/FrontendAction.hpp b/source/lib/FrontendAction.hpp
@@ -12,6 +12,7 @@
 #ifndef MRDOX_SOURCE_FRONTENDACTION_HPP
 #define MRDOX_SOURCE_FRONTENDACTION_HPP
 
+#include <mrdox/Platform.hpp>
 #include <clang/Tooling/Execution.h>
 #include <clang/Tooling/Tooling.h>
 #include <memory>
diff --git a/source/lib/_adoc/Asciidoc.hpp b/source/lib/_adoc/Asciidoc.hpp
@@ -12,6 +12,7 @@
 #ifndef MRDOX_SOURCE_ADOC_ASCIIDOC_HPP
 #define MRDOX_SOURCE_ADOC_ASCIIDOC_HPP
 
+#include <mrdox/Platform.hpp>
 #include <mrdox/Config.hpp>
 #include <mrdox/Corpus.hpp>
 #include <mrdox/MetadataFwd.hpp>
diff --git a/source/lib/_adoc/PagesBuilder.hpp b/source/lib/_adoc/PagesBuilder.hpp
@@ -11,6 +11,7 @@
 #ifndef MRDOX_SOURCE_ADOC_PAGESBUILDER_HPP
 #define MRDOX_SOURCE_ADOC_PAGESBUILDER_HPP
 
+#include <mrdox/Platform.hpp>
 #include <mrdox/Corpus.hpp>
 #include <mrdox/MetadataFwd.hpp>
 #include <llvm/ADT/SmallString.h>
diff --git a/source/lib/_xml/XML.hpp b/source/lib/_xml/XML.hpp
@@ -12,6 +12,7 @@
 #ifndef MRDOX_SOURCE_XML_XML_HPP
 #define MRDOX_SOURCE_XML_XML_HPP
 
+#include <mrdox/Platform.hpp>
 #include <mrdox/Generator.hpp>
 #include <mrdox/MetadataFwd.hpp>
 #include <mrdox/meta/Javadoc.hpp>
diff --git a/source/lib/ast/ASTVisitor.hpp b/source/lib/ast/ASTVisitor.hpp
diff --git a/source/lib/ast/AnyNodeList.hpp b/source/lib/ast/AnyNodeList.hpp
diff --git a/source/lib/ast/BitcodeIDs.hpp b/source/lib/ast/BitcodeIDs.hpp
diff --git a/source/lib/ast/BitcodeReader.hpp b/source/lib/ast/BitcodeReader.hpp
diff --git a/source/lib/ast/BitcodeWriter.hpp b/source/lib/ast/BitcodeWriter.hpp
diff --git a/source/lib/ast/ParseJavadoc.hpp b/source/lib/ast/ParseJavadoc.hpp
diff --git a/source/lib/ast/Serialize.hpp b/source/lib/ast/Serialize.hpp
diff --git a/source/lib/ast/clangASTComment.hpp b/source/lib/ast/clangASTComment.hpp
diff --git a/source/lib/radix.hpp b/source/lib/radix.hpp
diff --git a/source/lib/utility.hpp b/source/lib/utility.hpp
