add Generators

Author: vinniefalco

CMakeLists.txt

@@ -94,6 +94,8 @@ target_include_directories(mrdox-api
 )
 target_compile_definitions(
     mrdox-api
+    PUBLIC
+    -DMRDOX_STATIC_LINK
     PRIVATE
     -DMRDOX_LIB
 )

include/mrdox/Config.hpp

@@ -42,7 +42,9 @@ namespace mrdox {
     particular directory from which absolute paths
     are calculated from relative paths.
 */
-class Config : public std::enable_shared_from_this<Config>
+class MRDOX_VISIBLE
+    Config
+        : public std::enable_shared_from_this<Config>
 {
     template<class T>
     friend struct llvm::yaml::MappingTraits;
@@ -63,21 +65,23 @@ class Config : public std::enable_shared_from_this<Config>
     explicit Config(llvm::StringRef configDir);
 
 public:
-    virtual ~Config() = default;
+    MRDOX_DECL virtual ~Config() = default;
 
     /** Return a defaulted Config using an existing directory.
 
         @param dirPath The path to the directory.
         If this is relative, an absolute path will
         be calculated from the current directory.
     */
+    MRDOX_DECL
     static
     llvm::Expected<std::shared_ptr<Config>>
     createAtDirectory(
         llvm::StringRef dirPath);
 
     /** Return a Config loaded from the specified YAML file.
     */
+    MRDOX_DECL
     static
     llvm::Expected<std::shared_ptr<Config>>
     loadFromFile(
@@ -230,12 +234,14 @@ class Config : public std::enable_shared_from_this<Config>
 
         @param dirPath The directory.
     */
+    MRDOX_DECL
     void
     setSourceRoot(
         llvm::StringRef dirPath);
 
     /** Set the filter for including translation units.
     */
+    MRDOX_DECL
     void
     setInputFileIncludes(
         std::vector<std::string> const& list);
@@ -258,7 +264,7 @@ class Config::WorkGroup
         concurrency level. Calls to post and wait
         are blocking.
     */
-    WorkGroup() noexcept = default;
+    MRDOX_DECL WorkGroup() noexcept;
 
     /** Constructor.
     */
@@ -268,27 +274,35 @@ class Config::WorkGroup
 
     /** Constructor.
     */
-    WorkGroup(WorkGroup const& other);
+    MRDOX_DECL
+    WorkGroup(
+        WorkGroup const& other);
 
     /** Assignment.
     */
+    MRDOX_DECL
     WorkGroup&
-    operator=(WorkGroup const& other);
+    operator=(
+        WorkGroup const& other);
 
     /** Post work to the work group.
     */
-    void post(std::function<void(void)>);
+    MRDOX_DECL
+    void
+    post(std::function<void(void)>);
 
     /** Wait for all posted work in the work group to complete.
     */
-    void wait();
+    MRDOX_DECL
+    void
+    wait();
 
 private:
     friend class Config::Impl;
 
     struct Base
     {
-        virtual ~Base() = default;
+        MRDOX_DECL virtual ~Base() noexcept;
     };
 
     class Impl;

include/mrdox/Corpus.hpp

@@ -31,10 +31,13 @@ namespace mrdox {
 
 /** The collection of declarations in extracted form.
 */
-class Corpus
+class MRDOX_VISIBLE
+    Corpus
 {
 public:
-    virtual ~Corpus() = default;
+    MRDOX_DECL
+    virtual
+    ~Corpus() noexcept;
 
     //--------------------------------------------
 
@@ -46,20 +49,22 @@ class Corpus
 
     /** Return the list of all uniquely identified symbols.
     */
+    MRDOX_DECL
     virtual
     std::vector<SymbolID> const&
     allSymbols() const noexcept = 0;
 
     /** Return the metadata for the global namespace.
     */
+    MRDOX_DECL
     NamespaceInfo const&
     globalNamespace() const noexcept;
 
     /** Return the Info with the matching ID, or nullptr.
     */
     /** @{ */
-    virtual Info* find(SymbolID const& id) noexcept = 0;
-    virtual Info const* find(SymbolID const& id) const noexcept = 0;
+    MRDOX_DECL virtual Info* find(SymbolID const& id) noexcept = 0;
+    MRDOX_DECL virtual Info const* find(SymbolID const& id) const noexcept = 0;
     /** @} */
 
     /** Return true if an Info with the specified symbol ID exists.
@@ -86,22 +91,26 @@ class Corpus
     */
     struct Visitor
     {
-        virtual ~Visitor() = default;
-        virtual bool visit(NamespaceInfo const&);
-        virtual bool visit(RecordInfo const&);
-        virtual bool visit(Overloads const&);
-        virtual bool visit(FunctionInfo const&);
-        virtual bool visit(TypedefInfo const&);
-        virtual bool visit(EnumInfo const&);
+        MRDOX_DECL virtual ~Visitor() noexcept;
+        MRDOX_DECL virtual bool visit(NamespaceInfo const&);
+        MRDOX_DECL virtual bool visit(RecordInfo const&);
+        MRDOX_DECL virtual bool visit(Overloads const&);
+        MRDOX_DECL virtual bool visit(FunctionInfo const&);
+        MRDOX_DECL virtual bool visit(TypedefInfo const&);
+        MRDOX_DECL virtual bool visit(EnumInfo const&);
     };
 
     /** Visit the specified symbol ID or node.
     */
     /** @{ */
-    [[nodiscard]] bool visit(SymbolID id, Visitor& f) const;
-    [[nodiscard]] bool visit(Scope const& I, Visitor& f) const;
-    [[nodiscard]] bool visitWithOverloads(Scope const& I, Visitor& f) const;
-    [[nodiscard]] bool visit(Info const& I, Visitor& f) const;
+    MRDOX_DECL [[nodiscard]] bool visit(
+        SymbolID id, Visitor& f) const;
+    MRDOX_DECL [[nodiscard]] bool visit(
+        Scope const& I, Visitor& f) const;
+    MRDOX_DECL [[nodiscard]] bool visitWithOverloads(
+        Scope const& I, Visitor& f) const;
+    MRDOX_DECL [[nodiscard]] bool visit(
+        Info const& I, Visitor& f) const;
     /** @} */
 
     //--------------------------------------------
@@ -113,6 +122,7 @@ class Corpus
         @param R The diagnostic reporting object to
         use for delivering errors and information.
     */
+    MRDOX_DECL
     [[nodiscard]]
     static
     llvm::Expected<std::unique_ptr<Corpus>>

include/mrdox/Debug.hpp

@@ -26,14 +26,13 @@ namespace mrdox {
 /** Return a stream which writes output to the debugger.
 */
 /** @{ */
-llvm::raw_ostream& debug_outs();
-llvm::raw_ostream& debug_errs();
+MRDOX_DECL llvm::raw_ostream& debug_outs();
+MRDOX_DECL llvm::raw_ostream& debug_errs();
 /** @} */
 
 /** Enable debug heap checking.
 */
-void
-debugEnableHeapChecking();
+MRDOX_DECL void debugEnableHeapChecking();
 
 #if defined(NDEBUG)
 #define Assert(expr) ((void)0)

include/mrdox/Error.hpp

@@ -58,7 +58,9 @@ auto nice(llvm::ErrorOr<T>&& e)
     return nice(e.getError());
 }
 
-llvm::StringRef nice(std::source_location loc);
+MRDOX_DECL
+llvm::StringRef
+nice(std::source_location loc);
 
 //------------------------------------------------
 
@@ -68,6 +70,7 @@ llvm::StringRef nice(std::source_location loc);
 
     @param loc The source location where the failure occurred.
 */
+MRDOX_DECL
 [[nodiscard]]
 llvm::Error
 makeErrorString(

include/mrdox/Generator.hpp

@@ -26,18 +26,29 @@ namespace mrdox {
 
 /** Base class for documentation generators.
 */
-struct Generator
+struct MRDOX_VISIBLE
+    Generator
 {
     /** Destructor.
     */
-    virtual ~Generator() = default;
+    MRDOX_DECL
+    virtual
+    ~Generator() noexcept;
 
-    /** Return the full name of the generator.
+    /** Return the symbolic name of the generator.
     */
+    MRDOX_DECL
     virtual
     llvm::StringRef
     name() const noexcept = 0;
 
+    /** Return the display name of the generator.
+    */
+    MRDOX_DECL
+    virtual
+    llvm::StringRef
+    displayName() const noexcept = 0;
+
     /** Return the extension or tag of the generator.
 
         This should be in all lower case. Examples
@@ -49,6 +60,7 @@ struct Generator
         The returned string should not include
         a leading period.
     */
+    MRDOX_DECL
     virtual
     llvm::StringRef
     extension() const noexcept = 0;
@@ -73,6 +85,7 @@ struct Generator
         @param R The diagnostic reporting object to
         use for delivering errors and information.
     */
+    MRDOX_DECL
     virtual
     llvm::Error
     buildPages(
@@ -99,6 +112,7 @@ struct Generator
             fd_os->error() will be called periodically and
             the result returend if an error is indicated.
     */
+    MRDOX_DECL
     virtual
     llvm::Error
     buildSinglePage(
@@ -122,6 +136,7 @@ struct Generator
 
         @param R The diagnostic reporting object to use.
     */
+    MRDOX_DECL
     llvm::Error
     buildSinglePageFile(
         llvm::StringRef filePath,
@@ -144,16 +159,14 @@ struct Generator
 
         @param R The diagnostic reporting object to use.
     */
+    MRDOX_DECL
     llvm::Error
     buildSinglePageString(
         std::string& dest,
         Corpus const& corpus,
         Reporter& R) const;
 };
 
-extern std::unique_ptr<Generator> makeXMLGenerator();
-extern std::unique_ptr<Generator> makeAsciidocGenerator();
-
 } // mrdox
 } // clang
 

include/mrdox/Generators.hpp

@@ -12,22 +12,73 @@
 #define MRDOX_GENERATORS_HPP
 
 #include <mrdox/Platform.hpp>
+#include <mrdox/Generator.hpp>
+#include <llvm/ADT/StringRef.h>
+#include <cstdint>
 
 namespace clang {
 namespace mrdox {
 
 /** A dynamic list of Generator
 */
-class Generators
+class MRDOX_VISIBLE
+    Generators
 {
-    Generators() noexcept;
+    Generators(Generators const&) = delete;
+    Generators& operator=(Generators const&) = delete;
+
+protected:
+    Generators() noexcept = default;
 
 public:
+    using value_type = Generator const*;
+    using iterator = value_type const*;
+    using const_iterator = iterator;
+    using reference = value_type const&;
+    using const_reference = value_type const&;
+    using size_type = std::size_t;
+    using difference_type = std::ptrdiff_t;
+
     /** Destructor.
     */
-    virtual ~Generators() = default;
+    MRDOX_DECL
+    virtual
+    ~Generators() = default;
+
+    /** Return an iterator to the beginning.
+    */
+    MRDOX_DECL
+    virtual
+    iterator
+    begin() const noexcept = 0;
+
+    /** Return an iterator to the end.
+    */
+    MRDOX_DECL
+    virtual
+    iterator
+    end() const noexcept = 0;
+
+    /** Return a pointer to the matching generator.
+
+        @return A pointer to the generator, or `nullptr`.
+
+        @param name The name of the generator. The
+        name must be an exact match, including case.
+    */
+    MRDOX_DECL
+    virtual
+    Generator const*
+    find(
+        llvm::StringRef name) const noexcept = 0;
 };
 
+/** Return a reference to the global Generators instance.
+*/
+MRDOX_DECL
+Generators const&
+getGenerators() noexcept;
+
 } // mrdox
 } // clang