tidy up xml tag names

fix #140

Author: vinniefalco

mrdox.rng

@@ -157,7 +157,7 @@
   </define>
   <define name="TypedefInfo">
     <choice>
-      <element name="using">
+      <element name="alias">
         <ref name="Name"/>
         <ref name="Id"/>
         <ref name="SymbolInfo"/>

source/api/_XML/CXXTags.cpp

@@ -0,0 +1,57 @@
+//
+// 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 "CXXTags.hpp"
+#include <mrdox/Metadata/Typedef.hpp>
+
+namespace clang {
+namespace mrdox {
+namespace xml {
+
+llvm::StringRef
+getTagName(Info const& I) noexcept
+{
+    switch(I.IT)
+    {
+    case InfoType::IT_namespace:
+        return namespaceTagName;
+    case InfoType::IT_record:
+        switch(static_cast<RecordInfo const&>(I).TagType)
+        {
+        case TagTypeKind::TTK_Class:  return classTagName;
+        case TagTypeKind::TTK_Struct: return structTagName;
+        case TagTypeKind::TTK_Union:  return unionTagName;
+        default:
+            break;
+        }
+        break;
+    case InfoType::IT_function:
+        return functionTagName;
+    case InfoType::IT_typedef:
+        if(static_cast<TypedefInfo const&>(I).IsUsing)
+            return aliasTagName;
+        else
+            return typedefTagName;
+        break;
+    case InfoType::IT_enum:
+        return enumTagName;
+    case InfoType::IT_variable: 
+        return variableTagName;
+    default:
+        break;
+    }
+    Assert(false);
+    return "(unknown)";
+}
+
+} // xml
+} // mrdox
+} // clang

source/api/_XML/CXXTags.hpp

@@ -16,7 +16,9 @@
 #include "Support/Operator.hpp"
 #include <clang/AST/Attr.h>
 #include <mrdox/Metadata/Function.hpp>
+#include <mrdox/Metadata/Record.hpp>
 #include <mrdox/Metadata/Type.hpp>
+#include <mrdox/Metadata/Variable.hpp>
 
 /*
     This file holds the business logic for transforming
@@ -34,12 +36,16 @@ constexpr llvm::StringRef structTagName     = "struct";
 constexpr llvm::StringRef unionTagName      = "union";
 constexpr llvm::StringRef functionTagName   = "function";
 constexpr llvm::StringRef typedefTagName    = "typedef";
-constexpr llvm::StringRef usingTagName      = "using";
+constexpr llvm::StringRef aliasTagName      = "alias";
 constexpr llvm::StringRef enumTagName       = "enum";
 constexpr llvm::StringRef variableTagName   = "variable";
 constexpr llvm::StringRef attributeTagName  = "attr";
 constexpr llvm::StringRef returnTagName     = "return";
 constexpr llvm::StringRef paramTagName      = "param";
+constexpr llvm::StringRef friendTagName     = "friend";
+constexpr llvm::StringRef tparamTagName     = "tparam";
+constexpr llvm::StringRef dataMemberTagName = "data";
+constexpr llvm::StringRef javadocTagName    = "doc";
 
 constexpr llvm::StringRef getBitsIDName(RecFlags0 ID)
 {
@@ -295,6 +301,11 @@ inline void writeParam(FieldTypeInfo const& I, XMLTags& tags)
         { I.Type.id } });
 }
 
+/** Return the xml tag name for the Info.
+*/
+llvm::StringRef
+getTagName(Info const& I) noexcept;
+
 } // xml
 } // mrdox
 } // clang

source/api/_XML/XMLTags.cpp

@@ -78,23 +78,6 @@ toString(
     return toBase64(id);
 }
 
-llvm::StringRef
-toString(
-    InfoType it) noexcept
-{
-    switch(it)
-    {
-    case InfoType::IT_namespace:  return "namespace";
-    case InfoType::IT_record:     return "record";
-    case InfoType::IT_function:   return "function";
-    case InfoType::IT_typedef:    return "typedef";
-    case InfoType::IT_enum:       return "enum";
-    case InfoType::IT_variable:   return "variable";
-    default:
-        llvm_unreachable("unknown InfoType");
-    }
-}
-
 llvm::StringRef
 toString(
     Javadoc::Style style) noexcept

source/api/_XML/XMLWriter.cpp

@@ -166,46 +166,10 @@ writeIndex()
     temp.reserve(256);
     tags_.open("symbols");
     for(auto I : corpus_.index())
-    {
-        llvm::StringRef tag;
-        switch(I->IT)
-        {
-        case InfoType::IT_namespace:
-            tag = "namespace";
-            break;
-        case InfoType::IT_record:
-            switch(static_cast<RecordInfo const*>(I)->TagType)
-            {
-            case TagTypeKind::TTK_Class:  tag = "class"; break;
-            case TagTypeKind::TTK_Struct: tag = "struct"; break;
-            case TagTypeKind::TTK_Union:  tag = "struct"; break;
-            default:
-                Assert(false);
-            }
-            break;
-        case InfoType::IT_function:
-            tag = "function";
-            break;
-        case InfoType::IT_typedef:
-            if(static_cast<TypedefInfo const*>(I)->IsUsing)
-                tag = "using";
-            else
-                tag = "typedef";
-            break;
-        case InfoType::IT_enum:
-            tag = "enum";
-            break;
-        case InfoType::IT_variable: 
-            tag = "variable";
-            break;
-        default:
-            Assert(false);
-        }
         tags_.write("symbol", {}, {
             { "name", I->getFullyQualifiedName(temp) },
-            { "tag", tag },
+            { "tag", getTagName(*I) },
             { I->id } });
-    }
     tags_.close("symbols");
 }
 
@@ -270,7 +234,7 @@ visit(
 
     // Friends
     for(auto const& id : I.Friends)
-        tags_.write("friend", "", { { id } });
+        tags_.write(friendTagName, "", { { id } });
 
     writeJavadoc(I.javadoc);
 
@@ -324,9 +288,9 @@ visit(
 {
     llvm::StringRef tag;
     if(I.IsUsing)
-        tag = "using";
+        tag = aliasTagName;
     else
-        tag = "typedef";
+        tag = typedefTagName;
     tags_.open(tag, {
         { "name", I.Name },
         { I.id }
@@ -350,7 +314,7 @@ XMLWriter::
 visit(
     EnumInfo const& I)
 {
-    tags_.open("enum", {
+    tags_.open(enumTagName, {
         { "name", I.Name },
         { "class", "scoped", I.Scoped },
         { I.BaseType },
@@ -367,7 +331,7 @@ visit(
 
     writeJavadoc(I.javadoc);
 
-    tags_.close("enum");
+    tags_.close(enumTagName);
 
     return true;
 }
@@ -377,7 +341,7 @@ XMLWriter::
 visit(
     VariableInfo const& I)
 {
-    tags_.open("variable", {
+    tags_.open(variableTagName, {
         { "name", I.Name },
         { I.id }
         });
@@ -393,7 +357,7 @@ visit(
 
     writeJavadoc(I.javadoc);
 
-    tags_.close("variable");
+    tags_.close(variableTagName);
 
     return true;
 }
@@ -453,7 +417,7 @@ XMLWriter::
 writeTemplateParam(
     TemplateParamInfo const& I)
 {
-    tags_.write("tparam", {}, {
+    tags_.write(tparamTagName, {}, {
         { "decl", I.Contents }
         });
 }
@@ -463,44 +427,14 @@ XMLWriter::
 writeMemberType(
     MemberTypeInfo const& I)
 {
-    tags_.write("data", {}, {
+    tags_.write(dataMemberTagName, {}, {
         { "name", I.Name },
         { "type", I.Type.Name },
         { "value", I.DefaultValue, ! I.DefaultValue.empty() },
         { I.Access },
         { I.Type.id } });
 }
 
-void
-XMLWriter::
-writeStorageClass(
-    jit_indenter& os, StorageClass SC)
-{
-    switch(SC)
-    {
-    case StorageClass::SC_None:
-        break;
-    case StorageClass::SC_Extern:
-        os << "<extern/>";
-        break;
-    case StorageClass::SC_Static:
-        os << "<static/>";
-        break;
-    case StorageClass::SC_PrivateExtern:
-        os << "<private-extern/>";
-        break;
-    case StorageClass::SC_Auto:
-        os << "<sc-auto/>";
-        break;
-    case StorageClass::SC_Register:
-        os << "<sc-register/>";
-        break;
-    default:
-        llvm_unreachable("unknown StorageClass");
-        break;
-    }
-}
-
 //------------------------------------------------
 
 void
@@ -510,13 +444,13 @@ writeJavadoc(
 {
     if(! javadoc.has_value())
         return;
-    tags_.open("doc");
+    tags_.open(javadocTagName);
     if(auto brief = javadoc->getBrief())
         writeBrief(*brief);
     writeNodes(javadoc->getBlocks());
     writeNodes(javadoc->getParams());
     writeNodes(javadoc->getTParams());
-    tags_.close("doc");
+    tags_.close(javadocTagName);
 }
 
 template<class T>

source/api/_XML/XMLWriter.hpp

@@ -72,7 +72,6 @@ class XMLWriter
     void writeBaseRecord(BaseRecordInfo const& I);
     void writeTemplateParam(TemplateParamInfo const& I);
     void writeMemberType(MemberTypeInfo const& I);
-    void writeStorageClass(jit_indenter&, StorageClass SC);
     void writeJavadoc(llvm::Optional<Javadoc> const& javadoc);
 
     template<class T>

test-files/old-tests/record-1.xml

@@ -58,10 +58,10 @@
       <file path="record-1.cpp" line="4" class="def"/>
       <type name="char"/>
     </typedef>
-    <using name="U1" id="6UtddyCJy89K/bZpTmDb5jVXwAY=">
+    <alias name="U1" id="6UtddyCJy89K/bZpTmDb5jVXwAY=">
       <file path="record-1.cpp" line="3" class="def"/>
       <type name="int"/>
-    </using>
+    </alias>
   </struct>
 </namespace>
 </mrdox>