refactor sources

cppalliance · Apr 15, 2023 · 13adee3 · 13adee3
1 parent 778861b
commit 13adee3
Show file tree

Hide file tree

Showing 38 changed files with 92 additions and 64 deletions.
diff --git a/include/mrdox/meta/Types.hpp b/include/mrdox/meta/Types.hpp
@@ -57,7 +57,7 @@ namespace mrdox {
     A USRs is a string that provide an unambiguous
     reference to a symbol.
 */
-using SymbolID = std::array<uint8_t, 20>;
+using SymbolID = std::array<unsigned char, 20>;
 
 // Empty SymbolID for comparison, so we don't have to construct one every time.
 inline SymbolID const EmptySID = SymbolID();

diff --git a/source/lib/ClangDoc.cpp b/source/lib/ClangDoc.cpp
@@ -15,8 +15,8 @@
 // FrontendActionFactory.
 //
 
-#include "ClangDoc.h"
-#include "Visitor.hpp"
+#include "ClangDoc.hpp"
+#include "ast/Visitor.hpp"
 #include <clang/Frontend/CompilerInstance.h>
 #include <clang/Frontend/FrontendAction.h>
 

diff --git a/source/lib/ClangDoc.h → source/lib/ClangDoc.hpp b/source/lib/ClangDoc.h → source/lib/ClangDoc.hpp
diff --git a/source/lib/Corpus.cpp b/source/lib/Corpus.cpp
@@ -9,11 +9,11 @@
 // Official repository: https://github.com/cppalliance/mrdox
 //
 
-#include "BitcodeReader.h"
-#include "BitcodeWriter.h"
-#include "ClangDoc.h"
-#include "Reduce.h"
-#include "Serialize.h"
+#include "ClangDoc.hpp"
+#include "ast/BitcodeReader.hpp"
+#include "ast/BitcodeWriter.hpp"
+#include "ast/Serialize.hpp"
+#include "meta/Reduce.hpp"
 #include <mrdox/Corpus.hpp>
 #include <mrdox/Error.hpp>
 #include <mrdox/Metadata.hpp>

diff --git a/source/lib/BitcodeReader.cpp → source/lib/ast/BitcodeReader.cpp b/source/lib/BitcodeReader.cpp → source/lib/ast/BitcodeReader.cpp
@@ -9,7 +9,7 @@
 // Official repository: https://github.com/cppalliance/mrdox
 //
 
-#include "BitcodeReader.h"
+#include "BitcodeReader.hpp"
 #include <mrdox/Error.hpp>
 #include <mrdox/Metadata.hpp>
 #include <llvm/ADT/IndexedMap.h>

diff --git a/source/lib/BitcodeReader.h → source/lib/ast/BitcodeReader.hpp b/source/lib/BitcodeReader.h → source/lib/ast/BitcodeReader.hpp
@@ -18,7 +18,7 @@
 #ifndef LLVM_CLANG_TOOLS_EXTRA_CLANG_DOC_BITCODEREADER_H
 #define LLVM_CLANG_TOOLS_EXTRA_CLANG_DOC_BITCODEREADER_H
 
-#include "BitcodeWriter.h"
+#include "BitcodeWriter.hpp"
 #include <clang/AST/AST.h>
 #include <llvm/ADT/SmallVector.h>
 #include <llvm/Bitstream/BitstreamReader.h>

diff --git a/source/lib/BitcodeWriter.cpp → source/lib/ast/BitcodeWriter.cpp b/source/lib/BitcodeWriter.cpp → source/lib/ast/BitcodeWriter.cpp
@@ -9,9 +9,9 @@
 // Official repository: https://github.com/cppalliance/mrdox
 //
 
-#include "BitcodeWriter.h"
+#include "BitcodeWriter.hpp"
 #include <mrdox/Metadata.hpp>
-#include "llvm/ADT/IndexedMap.h"
+#include <llvm/ADT/IndexedMap.h>
 #include <initializer_list>
 
 namespace clang {

diff --git a/source/lib/BitcodeWriter.h → source/lib/ast/BitcodeWriter.hpp b/source/lib/BitcodeWriter.h → source/lib/ast/BitcodeWriter.hpp
@@ -19,11 +19,11 @@
 #define LLVM_CLANG_TOOLS_EXTRA_CLANG_DOC_BITCODEWRITER_H
 
 #include <mrdox/MetadataFwd.hpp>
-#include "clang/AST/AST.h"
-#include "llvm/ADT/DenseMap.h"
-#include "llvm/ADT/SmallVector.h"
-#include "llvm/ADT/StringRef.h"
-#include "llvm/Bitstream/BitstreamWriter.h"
+#include <clang/AST/AST.h>
+#include <llvm/ADT/DenseMap.h>
+#include <llvm/ADT/SmallVector.h>
+#include <llvm/ADT/StringRef.h>
+#include <llvm/Bitstream/BitstreamWriter.h>
 #include <initializer_list>
 #include <vector>
 

diff --git a/source/lib/CommentVisitor.cpp → source/lib/ast/CommentVisitor.cpp b/source/lib/CommentVisitor.cpp → source/lib/ast/CommentVisitor.cpp
@@ -9,19 +9,10 @@
 // Official repository: https://github.com/cppalliance/mrdox
 //
 
-#include "CommentVisitor.h"
+#include "CommentVisitor.hpp"
+#include "clangASTComment.hpp"
 #include <mrdox/Reporter.hpp>
 #include <mrdox/meta/Javadoc.hpp>
-#ifdef _MSC_VER
-#pragma warning(push)
-#pragma warning(disable: 5054) // C5054: operator '+': deprecated between enumerations of different types
-#endif
-#include <clang/AST/Comment.h>
-#include <clang/AST/CommentVisitor.h>
-#ifdef _MSC_VER
-#pragma warning(pop)
-#endif
-//#include <clang/AST/CommentCommandInfo.inc>
 
 namespace clang {
 namespace mrdox {

diff --git a/source/lib/CommentVisitor.h → source/lib/ast/CommentVisitor.hpp b/source/lib/CommentVisitor.h → source/lib/ast/CommentVisitor.hpp
diff --git a/source/lib/Serialize.cpp → source/lib/ast/Serialize.cpp b/source/lib/Serialize.cpp → source/lib/ast/Serialize.cpp
@@ -9,24 +9,16 @@
 // Official repository: https://github.com/cppalliance/mrdox
 //
 
-#include "Serialize.h"
-#include "CommentVisitor.h"
-#include "BitcodeWriter.h"
+#include "Serialize.hpp"
+#include "CommentVisitor.hpp"
+#include "BitcodeWriter.hpp"
 #include <mrdox/Metadata.hpp>
-#ifdef _MSC_VER
-#pragma warning(push)
-#pragma warning(disable: 5054) // C5054: operator '+': deprecated between enumerations of different types
-#include <clang/AST/Comment.h>
-#pragma warning(pop)
-#endif
-#include "clang/Index/USRGeneration.h"
-#include "clang/Lex/Lexer.h"
-#include "llvm/ADT/Hashing.h"
-#include "llvm/ADT/StringExtras.h"
-#include "llvm/Support/Path.h"
-#include "llvm/Support/SHA1.h"
-
-#include "base64.hpp"
+#include <clang/Index/USRGeneration.h>
+#include <clang/Lex/Lexer.h>
+#include <llvm/ADT/Hashing.h>
+#include <llvm/ADT/StringExtras.h>
+#include <llvm/Support/Path.h>
+#include <llvm/Support/SHA1.h>
 
 using clang::comments::FullComment;
 

diff --git a/source/lib/Serialize.h → source/lib/ast/Serialize.hpp b/source/lib/Serialize.h → source/lib/ast/Serialize.hpp
diff --git a/source/lib/Visitor.cpp → source/lib/ast/Visitor.cpp b/source/lib/Visitor.cpp → source/lib/ast/Visitor.cpp
@@ -9,17 +9,12 @@
 // Official repository: https://github.com/cppalliance/mrdox
 //
 
-#include "BitcodeWriter.h"
-#include "Serialize.h"
+#include "BitcodeWriter.hpp"
+#include "Serialize.hpp"
 #include "utility.hpp"
 #include "Visitor.hpp"
+//#include "ast/clangASTComment.hpp"
 #include <mrdox/Corpus.hpp>
-#ifdef _MSC_VER
-#pragma warning(push)
-#pragma warning(disable: 5054) // C5054: operator '+': deprecated between enumerations of different types
-#include <clang/AST/Comment.h>
-#pragma warning(pop)
-#endif
 #include <clang/Index/USRGeneration.h>
 #include <llvm/ADT/StringExtras.h>
 #include <llvm/Support/Error.h>

diff --git a/source/lib/Visitor.hpp → source/lib/ast/Visitor.hpp b/source/lib/Visitor.hpp → source/lib/ast/Visitor.hpp
diff --git a/source/lib/ast/clangASTComment.hpp b/source/lib/ast/clangASTComment.hpp
@@ -0,0 +1,30 @@
+//
+// This is a derivative work. originally part of the LLVM Project.
+// 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
+//
+
+// This is a workaround for the annoying
+// warning in the current trunk of llvm
+
+#ifndef MRDOX_SOURCE_AST_CLANGASTCOMMENT_HPP
+#define MRDOX_SOURCE_AST_CLANGASTCOMMENT_HPP
+
+#ifdef _MSC_VER
+#pragma warning(push)
+#pragma warning(disable: 5054) // C5054: operator '+': deprecated between enumerations of different types
+#endif
+
+#include <clang/AST/Comment.h>
+#include <clang/AST/CommentVisitor.h>
+
+#ifdef _MSC_VER
+#pragma warning(pop)
+#endif
+
+#endif
diff --git a/source/lib/Asciidoc.cpp → source/lib/format/Asciidoc.cpp b/source/lib/Asciidoc.cpp → source/lib/format/Asciidoc.cpp
diff --git a/source/lib/Asciidoc.hpp → source/lib/format/Asciidoc.hpp b/source/lib/Asciidoc.hpp → source/lib/format/Asciidoc.hpp
diff --git a/source/lib/FlatWriter.cpp → source/lib/format/FlatWriter.cpp b/source/lib/FlatWriter.cpp → source/lib/format/FlatWriter.cpp
diff --git a/source/lib/Generator.cpp → source/lib/format/Generator.cpp b/source/lib/Generator.cpp → source/lib/format/Generator.cpp
@@ -9,7 +9,7 @@
 // Official repository: https://github.com/cppalliance/mrdox
 //
 
-#include <mrdox/Generator.hpp>
+#include <mrdox/format/Generator.hpp>
 #include <llvm/Support/FileSystem.h>
 #include <llvm/Support/Path.h>
 

diff --git a/source/lib/OverloadSet.cpp → source/lib/format/OverloadSet.cpp b/source/lib/OverloadSet.cpp → source/lib/format/OverloadSet.cpp
diff --git a/source/lib/RecursiveWriter.cpp → source/lib/format/RecursiveWriter.cpp b/source/lib/RecursiveWriter.cpp → source/lib/format/RecursiveWriter.cpp
diff --git a/source/lib/XML.cpp → source/lib/format/XML.cpp b/source/lib/XML.cpp → source/lib/format/XML.cpp
diff --git a/source/lib/XML.hpp → source/lib/format/XML.hpp b/source/lib/XML.hpp → source/lib/format/XML.hpp
diff --git a/source/lib/base64.cpp → source/lib/format/base64.cpp b/source/lib/base64.cpp → source/lib/format/base64.cpp
diff --git a/source/lib/base64.hpp → source/lib/format/base64.hpp b/source/lib/base64.hpp → source/lib/format/base64.hpp
diff --git a/source/lib/Enum.cpp → source/lib/meta/Enum.cpp b/source/lib/Enum.cpp → source/lib/meta/Enum.cpp
diff --git a/source/lib/Function.cpp → source/lib/meta/Function.cpp b/source/lib/Function.cpp → source/lib/meta/Function.cpp
diff --git a/source/lib/Index.cpp → source/lib/meta/Index.cpp b/source/lib/Index.cpp → source/lib/meta/Index.cpp
diff --git a/source/lib/Info.cpp → source/lib/meta/Info.cpp b/source/lib/Info.cpp → source/lib/meta/Info.cpp
@@ -9,8 +9,8 @@
 // Official repository: https://github.com/cppalliance/mrdox
 //
 
-#include <mrdox/Info.hpp>
-#include <mrdox/Record.hpp>
+#include <mrdox/meta/Info.hpp>
+#include <mrdox/meta/Record.hpp>
 #include <clang/AST/Type.h>
 #include <llvm/ADT/STLExtras.h>
 #include <llvm/Support/FileSystem.h>

diff --git a/source/lib/Javadoc.cpp → source/lib/meta/Javadoc.cpp b/source/lib/Javadoc.cpp → source/lib/meta/Javadoc.cpp
@@ -12,8 +12,8 @@
 #include <mrdox/meta/Javadoc.hpp>
 #include <mrdox/meta/Namespace.hpp>
 #include <mrdox/Config.hpp>
-#include "llvm/Support/Error.h"
-#include "llvm/Support/Path.h"
+#include <llvm/Support/Error.h>
+#include <llvm/Support/Path.h>
 
 namespace clang {
 namespace mrdox {

diff --git a/source/lib/Namespace.cpp → source/lib/meta/Namespace.cpp b/source/lib/Namespace.cpp → source/lib/meta/Namespace.cpp
@@ -9,11 +9,11 @@
 // Official repository: https://github.com/cppalliance/mrdox
 //
 
-#include "Reduce.h"
+#include "Reduce.hpp"
 #include <mrdox/meta/Namespace.hpp>
 #include <mrdox/Config.hpp>
-#include "llvm/Support/Error.h"
-#include "llvm/Support/Path.h"
+#include <llvm/Support/Error.h>
+#include <llvm/Support/Path.h>
 
 namespace clang {
 namespace mrdox {

diff --git a/source/lib/Record.cpp → source/lib/meta/Record.cpp b/source/lib/Record.cpp → source/lib/meta/Record.cpp
@@ -9,7 +9,7 @@
 // Official repository: https://github.com/cppalliance/mrdox
 //
 
-#include "Reduce.h"
+#include "Reduce.hpp"
 #include <mrdox/meta/Record.hpp>
 #include <cassert>
 #include <utility>

diff --git a/source/lib/Reduce.h → source/lib/meta/Reduce.hpp b/source/lib/Reduce.h → source/lib/meta/Reduce.hpp
@@ -9,8 +9,8 @@
 // Official repository: https://github.com/cppalliance/mrdox
 //
 
-#ifndef MRDOX_REDUCE_HPP
-#define MRDOX_REDUCE_HPP
+#ifndef MRDOX_SOURCE_META_REDUCE_HPP
+#define MRDOX_SOURCE_META_REDUCE_HPP
 
 #include <mrdox/meta/Info.hpp>
 #include <llvm/Support/Error.h>

diff --git a/source/lib/Reference.cpp → source/lib/meta/Reference.cpp b/source/lib/Reference.cpp → source/lib/meta/Reference.cpp
diff --git a/source/lib/Symbol.cpp → source/lib/meta/Symbol.cpp b/source/lib/Symbol.cpp → source/lib/meta/Symbol.cpp
diff --git a/source/lib/Templates.cpp → source/lib/meta/Templates.cpp b/source/lib/Templates.cpp → source/lib/meta/Templates.cpp
diff --git a/source/lib/Typedef.cpp → source/lib/meta/Typedef.cpp b/source/lib/Typedef.cpp → source/lib/meta/Typedef.cpp
diff --git a/source/lib/meta/Types.cpp b/source/lib/meta/Types.cpp
@@ -0,0 +1,20 @@
+//
+// This is a derivative work. originally part of the LLVM Project.
+// 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
+//
+
+#include <mrdox/meta/Types.hpp>
+
+namespace clang {
+namespace mrdox {
+
+static_assert(CHAR_BIT == 8);
+
+} // mrdox
+} // clang