deduction guides are represeted with GuideInfo

include/mrdocs/Corpus.hpp

@@ -240,7 +240,12 @@ traverseOverloads(
         auto first_func = std::ranges::find_if(
             lookup, [this](const SymbolID& elem)
             {
+            #if 0
+                const Info& I = get(elem);
+                return I.isFunction() || I.isGuide();
+            #else
                 return get(elem).isFunction();
+            #endif
             });
         if(lookup.size() == 1 ||
             first_func == lookup.end())

include/mrdocs/Metadata.hpp

@@ -23,6 +23,7 @@
 #include <mrdocs/Metadata/Field.hpp>
 #include <mrdocs/Metadata/Friend.hpp>
 #include <mrdocs/Metadata/Function.hpp>
+#include <mrdocs/Metadata/Guide.hpp>
 #include <mrdocs/Metadata/Info.hpp>
 #include <mrdocs/Metadata/Interface.hpp>
 #include <mrdocs/Metadata/Javadoc.hpp>

include/mrdocs/Metadata/Function.hpp

@@ -63,9 +63,7 @@ enum class FunctionClass
     Constructor,
     // conversion function
     Conversion,
-    Destructor,
-    // deduction guide
-    Deduction,
+    Destructor
 };
 
 MRDOCS_DECL dom::String toString(FunctionClass kind) noexcept;
@@ -157,6 +155,8 @@ struct FunctionInfo
     FnFlags0 specs0{.raw{0}};
     FnFlags1 specs1{.raw{0}};
 
+    NoexceptInfo Noexcept;
+
     //--------------------------------------------
 
     explicit FunctionInfo(SymbolID ID) noexcept

include/mrdocs/Metadata/Guide.hpp

@@ -0,0 +1,62 @@
+//
+// 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 Krystian Stasiowski ([email protected])
+//
+// Official repository: https://github.com/cppalliance/mrdocs
+//
+
+#ifndef MRDOCS_API_METADATA_GUIDE_HPP
+#define MRDOCS_API_METADATA_GUIDE_HPP
+
+#include <mrdocs/Platform.hpp>
+#include <mrdocs/Metadata/Function.hpp>
+#include <mrdocs/Metadata/Info.hpp>
+#include <mrdocs/Metadata/Source.hpp>
+#include <mrdocs/Metadata/Template.hpp>
+#include <mrdocs/Metadata/Type.hpp>
+#include <memory>
+#include <utility>
+#include <vector>
+
+namespace clang {
+namespace mrdocs {
+
+/** Info for deduction guides.
+*/
+struct GuideInfo
+    : IsInfo<InfoKind::Guide>
+    , SourceInfo
+{
+    /** The pattern for the deduced specialization.
+
+        This is always a SpecializationTypeInfo.
+    */
+    std::unique_ptr<TypeInfo> Deduced;
+
+    /** Template head, if any.
+    */
+    std::unique_ptr<TemplateInfo> Template;
+
+    /** The parameters of the deduction guide.
+    */
+    std::vector<Param> Params;
+
+    /** The explicit-specifier, if any.
+    */
+    ExplicitKind Explicit = ExplicitKind::None;
+
+    //--------------------------------------------
+
+    explicit GuideInfo(SymbolID ID) noexcept
+        : IsInfo(ID)
+    {
+    }
+};
+
+} // mrdocs
+} // clang
+
+#endif

include/mrdocs/Metadata/Info.hpp

@@ -37,6 +37,7 @@ struct VariableInfo;
 struct SpecializationInfo;
 struct FriendInfo;
 struct EnumeratorInfo;
+struct GuideInfo;
 
 /** Info variant discriminator
 */
@@ -51,7 +52,8 @@ enum class InfoKind
     Field,
     Specialization,
     Friend,
-    Enumerator
+    Enumerator,
+    Guide
 };
 
 MRDOCS_DECL dom::String toString(InfoKind kind) noexcept;
@@ -130,6 +132,7 @@ struct MRDOCS_VISIBLE
     constexpr bool isSpecialization() const noexcept { return Kind == InfoKind::Specialization; }
     constexpr bool isFriend()         const noexcept { return Kind == InfoKind::Friend; }
     constexpr bool isEnumerator()     const noexcept { return Kind == InfoKind::Enumerator; }
+    constexpr bool isGuide()          const noexcept { return Kind == InfoKind::Guide; }
 };
 
 //------------------------------------------------
@@ -157,6 +160,7 @@ struct IsInfo : Info
     static constexpr bool isSpecialization() noexcept { return K == InfoKind::Specialization; }
     static constexpr bool isFriend()         noexcept { return K == InfoKind::Friend; }
     static constexpr bool isEnumerator()     noexcept { return K == InfoKind::Enumerator; }
+    static constexpr bool isGuide()          noexcept { return K == InfoKind::Guide; }
 
 protected:
     constexpr explicit IsInfo(SymbolID ID)
@@ -203,6 +207,8 @@ visit(
         return visitor.template visit<FriendInfo>();
     case InfoKind::Enumerator:
         return visitor.template visit<EnumeratorInfo>();
+    case InfoKind::Guide:
+        return visitor.template visit<GuideInfo>();
     default:
         MRDOCS_UNREACHABLE();
     }

include/mrdocs/Metadata/Interface.hpp

@@ -36,6 +36,7 @@ struct Tranche
     std::vector<SymbolID> StaticFunctions;
     std::vector<SymbolID> Variables;
     std::vector<SymbolID> Friends;
+    std::vector<SymbolID> Guides;
 
     ScopeInfo Overloads;
     ScopeInfo StaticOverloads;

include/mrdocs/Metadata/Specifiers.hpp

@@ -13,6 +13,7 @@
 
 #include <mrdocs/Platform.hpp>
 #include <mrdocs/Dom.hpp>
+#include <string>
 #include <string_view>
 
 namespace clang {
@@ -70,30 +71,31 @@ enum class ExplicitKind
 */
 enum class NoexceptKind
 {
-    None = 0,
-    // throw()
-    ThrowNone,
-    // throw(type-id-list)
-    Throw,
-    // throw(...) (microsoft extension)
-    ThrowAny,
-    // __declspec(nothrow) (microsoft extension)
-    NoThrow,
-    // noexcept-specifier, no constant-expression
-    Noexcept,
-    // noexcept-specifier, constant-expression evaluates to false
-    NoexceptFalse,
-    // noexcept-specifier, constant-expression evaluates to true
-    NoexceptTrue,
-    // noexcept-specifier, dependent constant-expression
-    NoexceptDependent,
-
-    // not evaluated yet, for special member function
-    Unevaluated,
-    // not instantiated yet
-    Uninstantiated,
-    // not parsed yet
-    Unparsed
+    /** Potentially-throwing exception specification
+    */
+    False = 0,
+    /** Non-throwing exception specification
+    */
+    True,
+    /** Dependent exception specification
+    */
+    Dependent
+};
+
+// KRYSTIAN FIXME: this needs to be improved (a lot)
+struct NoexceptInfo
+{
+    /** Whether a noexcept-specifier was user-written.
+    */
+    bool Implicit = true;
+
+    /** The evaluated exception specification.
+    */
+    NoexceptKind Kind = NoexceptKind::False;
+
+    /** The operand of the noexcept-specifier, if any.
+    */
+    std::string Operand;
 };
 
 /** Operator kinds
@@ -183,6 +185,21 @@ MRDOCS_DECL dom::String toString(NoexceptKind kind) noexcept;
 MRDOCS_DECL dom::String toString(ReferenceKind kind) noexcept;
 MRDOCS_DECL dom::String toString(StorageClassKind kind) noexcept;
 
+/** Convert NoexceptInfo to a string.
+
+    @param resolved If true, the operand is not shown when
+    the exception specification is non-dependent.
+
+    @param implicit If true, implicit exception specifications
+    are shown.
+*/
+MRDOCS_DECL
+dom::String
+toString(
+    NoexceptInfo info,
+    bool resolved = false,
+    bool implicit = false);
+
 } // mrdocs
 } // clang
 

include/mrdocs/Metadata/Type.hpp

@@ -216,7 +216,7 @@ struct FunctionTypeInfo
     std::vector<std::unique_ptr<TypeInfo>> ParamTypes;
     QualifierKind CVQualifiers = QualifierKind::None;
     ReferenceKind RefQualifier = ReferenceKind::None;
-    NoexceptKind ExceptionSpec = NoexceptKind::None;
+    NoexceptInfo ExceptionSpec;
 
     TypeInfo* innerType() const noexcept override
     {

include/mrdocs/MetadataFwd.hpp

@@ -41,6 +41,7 @@ struct EnumeratorInfo;
 struct FieldInfo;
 struct FriendInfo;
 struct FunctionInfo;
+struct GuideInfo;
 struct Info;
 class Javadoc;
 struct Location;

mrdocs.rnc

@@ -74,7 +74,8 @@ grammar
             Name,
             Access?,
             ID,
-            attribute class { "constructor"|"destructor"|"conversion"|"deduction" } ?,
+            attribute class { "constructor"|"destructor"|"conversion" } ?,
+            attribute exception-spec { text } ?,
             Location *,
             (
                 Attr * |
@@ -92,6 +93,29 @@ grammar
 
     #---------------------------------------------
 
+    Guide =
+        element guide
+        {
+            Name,
+            Access?,
+            attribute explicit { "1" } ?,
+            ID,
+            Location *,
+            (
+                element deduced { TypeInfo } |
+                element param
+                {
+                    Name?,
+                    attribute default { text } ?,
+                    ID ?,
+                    TypeInfo
+                } * |
+                Javadoc ?
+            ) *
+        }
+
+    #---------------------------------------------
+
     Enum =
         element enum
         {
@@ -213,6 +237,7 @@ grammar
                 Function  |
                 Typedef   |
                 Var       |
+                Guide     |
                 Template
             )
         }
@@ -274,6 +299,7 @@ grammar
             Typedef        |
             Enum           |
             Var            |
+            Guide          |
             Template       |
             Specialization
         )*
@@ -286,6 +312,7 @@ grammar
             Enum           |
             Field          |
             Var            |
+            Guide          |
             Template       |
             Friend         |
             Specialization

share/mrdocs/addons/generator/asciidoc/partials/declarator-id.adoc.hbs

@@ -1,5 +1,7 @@
 {{#if (and (eq kind "function") (eq class "conversion"))~}}
     operator {{>declarator return nolink=nolink~}}
+{{else if (eq kind "guide")~}}
+    {{>declarator deduced nolink=nolink~}}
 {{else~}}
     {{#if (and link.ref (not nolink))}}xref:{{link.ref}}[{{name}}]{{else}}{{name}}{{/if~}}
     {{#if (or (eq template.kind "explicit") (eq template.kind "partial"))~}}

share/mrdocs/addons/generator/asciidoc/partials/qualified-path.adoc.hbs

@@ -1,4 +1,4 @@
-{{#unless (contains @root.symbol.namespace symbol)~}}
+{{#unless (or (contains @root.symbol.namespace symbol) (eq @root.symbol symbol))~}}
 {{#if symbol.parent~}}
 {{>qualified-path symbol=symbol.parent nolink=nolink~}}
 {{else~}}

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

@@ -19,7 +19,7 @@
 {{~#if symbol.isConst}} const{{/if~}}
 {{#if symbol.isVolatile}} volatile{{/if~}}
 {{#if symbol.refQualifier}} {{symbol.refQualifier}}{{/if~}}
-{{#if (eq symbol.exceptionSpec "noexcept")}} noexcept{{/if~}}
+{{#if symbol.exceptionSpec}} {{symbol.exceptionSpec}}{{/if~}}
 {{#if (eq symbol.class "normal")}}{{>declarator-after symbol.return}}{{/if~}}
 {{#if symbol.hasOverrideAttr}} override{{/if~}}
 {{#if symbol.isFinal}} final{{/if~}}

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

@@ -0,0 +1,8 @@
+{{#if symbol.template}}{{>template-head symbol.template}}
+{{/if~}}
+{{>declarator-id symbol}}
+({{#each symbol.params}}{{#unless (and @first @last)}}
+    {{/unless}}{{>declarator type decl-name=name~}}
+    {{#if default}} = {{default}}{{/if~}}
+    {{#unless @last}},{{/unless~}}
+{{/each~}}) -> {{>declarator symbol.deduced}}

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

@@ -0,0 +1,20 @@
+{{!-- guides --}}
+= Deduction guide {{>nested-name-specifier symbol=symbol.parent}}{{symbol.name}}
+
+{{symbol.doc.brief}}
+
+== Synopsis
+
+{{>source dcl=(primary_location symbol)}}
+
+[source,cpp,subs="verbatim,macros,-callouts"]
+----
+{{>signature/guide symbol=symbol}};
+----
+
+{{#if symbol.doc.description}}
+== Description
+
+{{symbol.doc.description}}
+
+{{/if}}

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

@@ -11,3 +11,4 @@
 {{>info-list members=tranche.variables title=(concat label " " "Static Data Members")}}
 {{>info-list members=tranche.friends title=(concat label " " "Friends")}}
 {{/if}}
+{{>info-list members=tranche.guides title=(concat label " " "Deduction Guides")}}