enum work

Author: vinniefalco

include/mrdox/meta/Enum.hpp

@@ -61,10 +61,17 @@ struct EnumValueInfo
     llvm::SmallString<16> ValueExpr;
 };
 
+//------------------------------------------------
+
 // TODO: Expand to allow for documenting templating.
 // Info for types.
 struct EnumInfo : SymbolInfo
 {
+    // Indicates whether this enum is scoped (e.g. enum class).
+    bool Scoped = false;
+
+    //--------------------------------------------
+
     static constexpr InfoType type_id = InfoType::IT_enum;
 
     EnumInfo()
@@ -81,9 +88,6 @@ struct EnumInfo : SymbolInfo
 
     void merge(EnumInfo&& I);
 
-    // Indicates whether this enum is scoped (e.g. enum class).
-    bool Scoped = false;
-
     // Set to nonempty to the type when this is an explicitly typed enum. For
     //   enum Foo : short { ... };
     // this will be "short".

source/lib/format/xml/XML.cpp

@@ -172,6 +172,13 @@ struct XMLGenerator::Writer::
         , pred(id != EmptySID)
     {
     }
+
+    Attr(llvm::Optional<TypeInfo> const& opt)
+        : name("type")
+        , value(opt ? opt->Type.Name.str() : std::string())
+        , pred(opt)
+    {
+    }
 };
 
 //------------------------------------------------
@@ -513,10 +520,13 @@ visit(
 
     openTag("enum", {
         { "name", I.Name },
+        { "class", "scoped", I.Scoped },
+        { I.BaseType },
         { I.id }
         });
 
     writeInfo(I);
+    writeSymbol(I);
     for(auto const& v : I.Members)
         writeTag("element", {}, {
             { "name", v.Name },

source/tests/Options.cpp

@@ -30,6 +30,18 @@ Examples
 , Overview(
 R"(Test the output of MrDox against a set of input vectors.)")
 
+, badOption(
+    "bad",
+    llvm::cl::desc("Write a .bad.xml file for each test failure"),
+    llvm::cl::init(true),
+    llvm::cl::cat(TestCategory))
+
+, adocOption(
+    "adoc",
+    llvm::cl::desc("Write the corresponding Asciidoc (adoc) file for each input test file"),
+    llvm::cl::init(false),
+    llvm::cl::cat(TestCategory))
+
 , TestAction(
     "action",
     llvm::cl::desc(R"(Which action should be performed)"),
@@ -39,12 +51,6 @@ R"(Test the output of MrDox against a set of input vectors.)")
         clEnumVal(refresh, "Update all expected xml files")),
     llvm::cl::cat(TestCategory))
 
-, BadOption(
-    "bad",
-    llvm::cl::desc("Write a .bad.xml file for each input file test failure"),
-    llvm::cl::init(true),
-    llvm::cl::cat(TestCategory))
-
 , InputPaths(
     "inputs",
     llvm::cl::Sink,

source/tests/Options.hpp

@@ -29,8 +29,9 @@ class Options
 
 public:
     char const* Overview;
+    llvm::cl::opt<bool> badOption;
+    llvm::cl::opt<bool> adocOption;
     llvm::cl::opt<Action> TestAction;
-    llvm::cl::opt<bool> BadOption;
     llvm::cl::list<std::string> InputPaths;
 
     Options();

source/tests/TestMain.cpp

@@ -239,10 +239,10 @@ handleFile(
             results_.numberOfFailures++;
             R_.print("Failed: '", filePath, "'\n");
 
-            if(options_.BadOption.getValue())
+            if(options_.badOption.getValue())
             {
-                // Write the a .bad.xml file
-                path::replace_extension(outputPath, ".bad.xml");
+                // Write the .bad.xml file
+                path::replace_extension(outputPath, "bad.xml");
                 std::error_code ec;
                 llvm::raw_fd_ostream os(outputPath, ec, llvm::sys::fs::OF_None);
                 if(ec)
@@ -251,6 +251,10 @@ handleFile(
                     return makeError("raw_fd_ostream returned ", ec);
                 }
                 os << generatedXml;
+
+                // Fix the path for the code that follows
+                outputPath.pop_back_n(8);
+                path::replace_extension(outputPath, "xml");
             }
         }
         else
@@ -268,7 +272,8 @@ handleFile(
         }
     }
 
-    if(adocGen)
+    // Write Asciidoc if requested
+    if(options_.adocOption.getValue())
     {
         path::replace_extension(outputPath, adocGen->extension());
         if(R_.error(

tests/n4944/dcl.enum/1.cpp

@@ -1 +1,2 @@
+#pragma clang diagnostic ignored "-Wmissing-declarations"
 enum {};

tests/n4944/dcl.enum/1.xml

@@ -3,6 +3,7 @@
 <mrdox>
 <namespace name="">
   <enum name="" id="6WkHtky3/fMz+BLxKzQ7nsMgc4Y=">
+    <file path="dcl.enum/1.cpp" line="2" class="def"/>
   </enum>
 </namespace>
 </mrdox>

tests/n4944/dcl.enum/2.xml

@@ -2,7 +2,8 @@
 <!DOCTYPE mrdox SYSTEM "mrdox.dtd">
 <mrdox>
 <namespace name="">
-  <enum name="X" id="ST00Km++J5YixGbh0q74JrYHXAc=">
+  <enum name="X" class="scoped" type="int" id="ST00Km++J5YixGbh0q74JrYHXAc=">
+    <file path="dcl.enum/2.cpp" line="1"/>
   </enum>
 </namespace>
 </mrdox>

tests/n4944/dcl.enum/3.cpp

@@ -1,2 +1,3 @@
-enum E : char;
+enum struct X;
+enum struct X {};
 

tests/n4944/dcl.enum/3.xml

@@ -2,7 +2,9 @@
 <!DOCTYPE mrdox SYSTEM "mrdox.dtd">
 <mrdox>
 <namespace name="">
-  <enum name="E" id="xf6YhxRw8JpsHMwP6Tgyroti2gw=">
+  <enum name="X" class="scoped" type="int" id="ST00Km++J5YixGbh0q74JrYHXAc=">
+    <file path="dcl.enum/3.cpp" line="2" class="def"/>
+    <file path="dcl.enum/3.cpp" line="1"/>
   </enum>
 </namespace>
 </mrdox>

tests/n4944/dcl.enum/4.cpp

@@ -0,0 +1 @@
+enum E : char;

tests/n4944/dcl.enum/4.xml

@@ -0,0 +1,9 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE mrdox SYSTEM "mrdox.dtd">
+<mrdox>
+<namespace name="">
+  <enum name="E" type="char" id="xf6YhxRw8JpsHMwP6Tgyroti2gw=">
+    <file path="dcl.enum/4.cpp" line="1"/>
+  </enum>
+</namespace>
+</mrdox>

tests/n4944/dcl.enum/5.cpp

@@ -0,0 +1,3 @@
+enum E : char;
+enum E : char {};
+

tests/n4944/dcl.enum/5.xml

@@ -0,0 +1,10 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE mrdox SYSTEM "mrdox.dtd">
+<mrdox>
+<namespace name="">
+  <enum name="E" type="char" id="xf6YhxRw8JpsHMwP6Tgyroti2gw=">
+    <file path="dcl.enum/5.cpp" line="2" class="def"/>
+    <file path="dcl.enum/5.cpp" line="1"/>
+  </enum>
+</namespace>
+</mrdox>