[FOLD] add ConceptInfo

include/mrdocs/Metadata.hpp

@@ -18,6 +18,7 @@
 // metadata extracted from AST
 
 #include <mrdocs/Metadata/Alias.hpp>
+#include <mrdocs/Metadata/Concept.hpp>
 #include <mrdocs/Metadata/Enum.hpp>
 #include <mrdocs/Metadata/Enumerator.hpp>
 #include <mrdocs/Metadata/Expression.hpp>

include/mrdocs/Metadata/Concept.hpp

@@ -0,0 +1,47 @@
+//
+// 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) 2024 Krystian Stasiowski ([email protected])
+//
+// Official repository: https://github.com/cppalliance/mrdocs
+//
+
+#ifndef MRDOCS_API_METADATA_CONCEPT_HPP
+#define MRDOCS_API_METADATA_CONCEPT_HPP
+
+#include <mrdocs/Platform.hpp>
+#include <mrdocs/Metadata/Info.hpp>
+#include <mrdocs/Metadata/Expression.hpp>
+#include <mrdocs/Metadata/Source.hpp>
+
+namespace clang {
+namespace mrdocs {
+
+/** Info for concepts.
+*/
+struct ConceptInfo
+    : InfoCommonBase<InfoKind::Concept>
+    , SourceInfo
+{
+    /** The concepts template parameters
+    */
+    std::unique_ptr<TemplateInfo> Template;
+
+    /** The concepts constraint-expression
+    */
+    ExprInfo Constraint;
+
+    //--------------------------------------------
+
+    explicit ConceptInfo(SymbolID ID) noexcept
+        : InfoCommonBase(ID)
+    {
+    }
+};
+
+} // mrdocs
+} // clang
+
+#endif

include/mrdocs/Metadata/InfoNodes.inc

@@ -77,6 +77,7 @@ INFO(Enumerator,     Enumerators,     ENUMERATOR,     enumerator,     enumerator
 INFO(Guide,          Guides,          GUIDE,          guide,          guides,          The symbol is a deduction guide)
 INFO(Alias,          Aliases,         ALIAS,          alias,          aliases,         The symbol is a namespace alias)
 INFO(Using,          Usings,          USING,          using,          usings,          The symbol is a using declaration)
+INFO(Concept,        Concepts,        CONCEPT,        concept,        concepts,        The symbol is a concept)
 
 #ifdef INFO_PASCAL
 #undef INFO_PASCAL

mrdocs.rnc

@@ -246,6 +246,19 @@ grammar
 
     #---------------------------------------------
 
+    Concept =
+        element concept
+        {
+            Access ?,
+            ID,
+            Location *,
+            Javadoc ?,
+            attribute constraint { text },
+            element named { ID } *
+        }
+
+    #---------------------------------------------
+
     Symbol =
     (
         attribute Tag { text },
@@ -272,6 +285,7 @@ grammar
                 Typedef   |
                 Variable  |
                 Guide     |
+                Concept   |
                 Template
             )
         }
@@ -337,6 +351,7 @@ grammar
             Template       |
             Alias          |
             Using          |
+            Concept        |
             Specialization
         )*
 

share/mrdocs/addons/generator/asciidoc/partials/signature/concept.adoc.hbs

@@ -0,0 +1,3 @@
+{{>template-head symbol.template}}
+
+concept {{>declarator-id symbol}} = {{symbol.constraint}}

share/mrdocs/addons/generator/asciidoc/partials/symbols/concept.adoc.hbs

@@ -0,0 +1,30 @@
+{{!-- concept --}}
+= {{>nested-name-specifier symbol=symbol.parent includeNamespace=true}}{{symbol.name}}
+
+{{symbol.doc.brief}}
+
+== Synopsis
+
+{{>source dcl=(primary_location symbol)}}
+
+[source,cpp,subs="verbatim,macros,-callouts"]
+----
+{{>signature/concept symbol=symbol}};
+----
+
+{{#if symbol.doc.description}}
+== Description
+
+{{symbol.doc.description}}
+
+{{/if}}
+
+{{#if symbol.doc.see}}
+== See Also
+
+{{#each symbol.doc.see}}
+{{.}}
+
+{{/each}}
+
+{{/if}}

share/mrdocs/addons/generator/asciidoc/partials/template-head.adoc.hbs

@@ -1,4 +1,4 @@
 template<{{#each params}}{{#unless (and @first @last)}}
     {{/unless}}{{>template-param~}}
     {{#unless @last}},{{/unless~}}
-{{/each~}}>{{#if requires}} requires {{requires}}{{/if}}
+{{/each}}>{{#if requires}} requires {{requires}}{{/if}}

share/mrdocs/addons/generator/asciidoc/partials/tranche.adoc.hbs

@@ -4,6 +4,7 @@
 {{#if is-namespace}}
 {{>info-list members=tranche.overloads title="Functions"}}
 {{>info-list members=tranche.variables title="Variables"}}
+{{>info-list members=tranche.concepts title="Concepts"}}
 {{else}}
 {{>info-list members=tranche.overloads title=(concat label " " "Member Functions")}}
 {{>info-list members=tranche.staticoverloads title=(concat label " " "Static Member Functions")}}

src/lib/AST/ASTVisitor.cpp

@@ -622,10 +622,13 @@ class ASTVisitor
             return true;
 
         const auto* Described = dyn_cast_if_present<TemplateDecl>(D);
-        if(auto* TD = D->getDescribedTemplate())
-            Described = TD;
-        const auto* Templated =
-            Described ? Described->getTemplatedDecl() : D;
+        const auto* Templated = D;
+        if(auto* DT = D->getDescribedTemplate())
+        {
+            Described = DT;
+            if (auto* TD = DT->getTemplatedDecl())
+                Templated = TD;
+        }
 
         if(Described)
         {
@@ -2570,6 +2573,24 @@ class ASTVisitor
         getParentNamespaces(I, D);
     }
 
+    void
+    buildConcept(
+        ConceptInfo& I,
+        bool created,
+        ConceptDecl* D)
+    {
+        bool documented = parseRawComment(I.javadoc, D);
+        addSourceLocation(I, D->getBeginLoc(), true, documented);
+
+        if(! created)
+            return;
+
+        I.Name = extractName(D);
+        buildExprInfo(I.Constraint, D->getConstraintExpr());
+
+        getParentNamespaces(I, D);
+    }
+
     //------------------------------------------------
 
     /** Get the DeclType as a MrDocs Info object
@@ -2692,6 +2713,14 @@ class ASTVisitor
     void
     traverse(FieldDecl*);
 
+    /** Traverse a concept definition
+
+        This function is called by traverseDecl to traverse a
+        C++ concept definition.
+    */
+    void
+    traverse(ConceptDecl*);
+
     /** Traverse a deduction guide
 
         This function is called by traverseDecl to traverse a
@@ -2952,6 +2981,22 @@ traverse(FieldDecl* D)
     auto [I, created] = *exp;
     buildField(I, created, D);
 }
+//------------------------------------------------
+// ConceptDecl
+
+void
+ASTVisitor::
+traverse(ConceptDecl* D)
+{
+    auto exp = upsertMrDocsInfoFor(D);
+    if(! exp) { return; }
+    auto [I, created] = *exp;
+
+    if(! I.Template)
+        I.Template = std::make_unique<TemplateInfo>();
+    buildTemplateParams(*I.Template, D->getTemplateParameters());
+    buildConcept(I, created, D);
+}
 
 //------------------------------------------------
 // EnumConstantDecl

src/lib/AST/ASTVisitorHelpers.hpp

@@ -79,6 +79,9 @@ struct MrDocsType<UsingDecl> : std::type_identity<UsingInfo> {};
 template <>
 struct MrDocsType<NamespaceDecl> : std::type_identity<NamespaceInfo>{};
 
+template <>
+struct MrDocsType<ConceptDecl> : std::type_identity<ConceptInfo>{};
+
 /// @copydoc MrDocsType
 template <class DeclType>
 using MrDocsType_t = typename MrDocsType<DeclType>::type;

src/lib/AST/AnyBlock.hpp

@@ -2060,6 +2060,37 @@ readSubBlock(
     return AnyBlock::readSubBlock(ID);
 }
 
+//------------------------------------------------
+
+class ConceptBlock
+    : public TopLevelBlock<ConceptInfo>
+{
+public:
+    using TopLevelBlock::TopLevelBlock;
+
+    Error
+    readSubBlock(
+        unsigned ID) override
+    {
+        switch(ID)
+        {
+        case BI_EXPR_BLOCK_ID:
+        {
+            ExprBlock E(I->Constraint, br_);
+            return br_.readBlock(E, ID);
+        }
+        case BI_TEMPLATE_BLOCK_ID:
+        {
+            I->Template = std::make_unique<TemplateInfo>();
+            TemplateBlock T(*I->Template, br_);
+            return br_.readBlock(T, ID);
+        }
+        default:
+            return TopLevelBlock::readSubBlock(ID);
+        }
+    }
+};
+
 } // mrdocs
 } // clang
 

src/lib/AST/BitcodeWriter.cpp

@@ -453,6 +453,9 @@ RecordsByBlock{
     // EnumeratorInfo
     {BI_ENUMERATOR_BLOCK_ID,
         {}},
+    // ConceptInfo
+    {BI_CONCEPT_BLOCK_ID,
+        {}},
     // TypeInfo
     {BI_TYPEINFO_BLOCK_ID,
         {TYPEINFO_KIND, TYPEINFO_IS_PACK, TYPEINFO_CVQUAL,
@@ -1203,6 +1206,18 @@ emitBlock(
     emitBlock(I.Initializer);
 }
 
+void
+BitcodeWriter::
+emitBlock(
+    const ConceptInfo& I)
+{
+    StreamSubBlockGuard Block(Stream, BI_CONCEPT_BLOCK_ID);
+    emitInfoPart(I);
+    emitSourceInfo(I);
+    emitBlock(*I.Template);
+    emitBlock(I.Constraint);
+}
+
 void
 BitcodeWriter::
 emitBlock(

src/lib/AST/BitcodeWriter.hpp

@@ -163,6 +163,7 @@ class BitcodeWriter
     void emitBlock(NameInfo const& I);
     void emitBlock(AliasInfo const& I);
     void emitBlock(UsingInfo const& I);
+    void emitBlock(ConceptInfo const& I);
 
     void emitBlock(std::unique_ptr<TypeInfo> const& TI);
     void emitBlock(std::unique_ptr<TypeInfo> const& TI, BlockID ID);

src/lib/Gen/xml/XMLWriter.cpp

@@ -362,6 +362,29 @@ writeGuide(
     closeTemplate(I.Template);
 }
 
+void
+XMLWriter::
+writeConcept(
+    ConceptInfo const& I)
+{
+    openTemplate(I.Template);
+
+    tags_.open(conceptTagName, {
+        { "name", I.Name },
+        { I.Access },
+        { I.id },
+        { "constraint", I.Constraint.Written },
+        });
+
+    writeSourceInfo(I);
+
+    writeJavadoc(I.javadoc);
+
+    tags_.close(conceptTagName);
+
+    closeTemplate(I.Template);
+}
+
 void
 XMLWriter::
 writeAlias(

src/lib/Metadata/DomMetadata.cpp

@@ -891,6 +891,13 @@ DomInfo<T>::construct() const
 
         entries.emplace_back("explicitSpec", toString(I_.Explicit));
     }
+    if constexpr(T::isConcept())
+    {
+        entries.insert(entries.end(), {
+            { "template",       domCreate(I_.Template, domCorpus_) },
+            { "constraint",     dom::stringOrNull(I_.Constraint.Written) }
+            });
+    }
     return dom::Object(std::move(entries));
 }
 

src/lib/Metadata/Finalize.cpp

@@ -374,6 +374,13 @@ class Finalizer
         finalize(I.Deduced);
         finalize(I.Params);
     }
+
+    void operator()(ConceptInfo& I)
+    {
+        check(I.Namespace);
+        finalize(I.javadoc);
+        finalize(I.Template);
+    }
 };
 
 /** Finalizes a set of Info.

src/lib/Metadata/Finalize.hpp

@@ -1,4 +1,4 @@
-//
+    //
 // 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

src/lib/Metadata/Interface.cpp

@@ -294,6 +294,13 @@ class TrancheBuilder
             return;
         push(&Tranche::Guides, access, I);
     }
+
+    void operator()(
+        ConceptInfo const& I,
+        AccessKind access)
+    {
+        push(&Tranche::Concepts, access, I);
+    }
 };
 
 void