ed/gencpp

Fork 0

mirror of https://github.com/Ed94/gencpp.git synced 2024-12-22 15:54:45 -08:00

Ed_ 8891657eb1 Large updates to docs

2024-12-10 19:31:50 -05:00

12 KiB

Raw Blame History

Top

<- docs - General

AST Types Documentation

While the Readme for docs covers the data layout per AST, this will focus on the AST types avaialble, and their nuances.

Body

These are containers representing a scope body of a definition that can be of the following CodeType type:

Class_Body
Enum_Body
Export_Body
Extern_Linkage_Body
Function_Body
Global_Body
Namespace_Body
Struct_Body
Union_Body

Fields:

Code           Front;
Code           Back;
parser::Token* Tok;
Code           Parent;
StringCached   Name;
CodeT          Type;
s32            NumEntries;

The Front member represents the start of the link list and Back the end. NumEntries is the number of entries in the body.

Parent should have a compatible ECode type for the type of defintion used.

Serialization:

Will output only the entries, the braces are handled by the parent.

<Front>...
<Back>

Attributes

Represent standard or vendor specific C/C++ attributes.

Fields:

StringCached   Content;
Code           Prev;
Code           Next;
parser::Token* Tok;
Code           Parent;
StringCached   Name;
CodeT          Type;

Serialization:

<Content>

While the parser supports the __declspec and __attribute__ syntax, the upfront constructor ( def_attributes ) must have the user specify the entire attribute, including the [[]], __declspec or __attribute__ parts.

Comment

Stores a comment.

Fields:

StringCached   Content;
Code           Prev;
Code           Next;
parser::Token* Tok;
Code           Parent;
StringCached   Name;
CodeT          Type;

Serialization:

<Content>

The parser will perserve comments found if residing with a body or in accepted inline-to-definition locations. Otherwise they will be skipped by the TokArray::__eat and TokArray::current( skip foramtting enabled ) functions.

The upfront constructor: def_comment expects to recieve a comment without the // or /* */ parts. It will add them during construction.

Class & Struct

Fields:

CodeComment    InlineCmt;  // Only supported by forward declarations
CodeAttributes Attributes;
CodeType       ParentType;
CodeBody       Body;
CodeType       Prev;       // Used to store references to interfaces
CodeType       Next;       // Used to store references to interfaces
parser::Token* Tok;
Code           Parent;
StringCached   Name;
CodeT          Type;
ModuleFlag     ModuleFlags;
AccessSpec     ParentAccess;

Serialization:

// Class_Fwd
<ModuleFlags> <class/struct> <Name>; <InlineCmt>

// Class
<ModuleFlags> <class/struct> <Attributes> <Name> : <ParentAccess> <ParentType>, public <ParentType->Next>, ... <InlineCmt>
{
    <Body>
};

You'll notice that only one parent type is supported only with parent access. This library only supports single inheritance, the rest must be done through interfaces.

Constructor

Fields:

CodeComment    InlineCmt;  // Only supported by forward declarations
Code           InitializerList;
CodeParam      Params;
Code           Body;
Code           Prev;
Code           Next;
parser::Token* Tok;
Code           Parent;
StringCached   Name;
CodeT          Type;

Serialization:

// Constructor_Fwd
<Specs> <Parent->Name>( <Params> ); <InlineCmt>

// Constructor
<Specs> <Parent->Name>( <Params> ) <InlineCmt>
    : <InitializerList>
{
    <Body>
}

// Constructor Source Implementation
<Specs> <Parent>::~<Parent->Name>( <Params> ) <Specs>
{
    <Body>
}

Define

Represents a preprocessor define

Fields:

StringCached   Content;
Code           Prev;
Code           Next;
parser::Token* Tok;
Code           Parent;
StringCached   Name;
CodeT          Type;

Serialization:

#define <Name> <Content>

Destructor

Fields:

CodeComment    InlineCmt;
CodeSpecifiers Specs;
Code           Body;
Code           Prev;
Code           Next;
parser::Token* Tok;
Code           Parent;
StringCached   Name;
CodeT          Type;

Serialization:

// Destructor_Fwd
<Specs> ~<Parent->Name>( <Params> ) <Specs>; <InlineCmt>

// Destructor
<Specs> ~<Parent->Name>( <Params> ) <Specs>
{
    <Body>
}

// Destructor Source Implementation
<Specs> <Parent>::~<Parent->Name>( <Params> ) <Specs>
{
    <Body>
}

Enum

Fields:

CodeComment    InlineCmt;
CodeAttributes Attributes;
CodeType       UnderlyingType;
CodeBody       Body;
Code           Prev;
Code           Next;
parser::Token* Tok;
Code           Parent;
StringCached   Name;
CodeT          Type;
ModuleFlag     ModuleFlags;

Serialization:

// Enum_Fwd
<ModuleFlags> enum class <Name> : <UnderlyingType>; <InlineCmt>

// Enum
<ModuleFlags> <enum or enum class> <Name> : <UnderlyingType>
{
    <Body>
};

Execution

Just represents an execution body. Equivalent to an untyped body. Will be obsolute when function body parsing is implemented.

Fields:

StringCached   Content;
Code           Prev;
Code           Next;
parser::Token* Tok;
Code           Parent;
StringCached   Name;
CodeT          Type;

Serialization:

<Content>

External Linkage

Fields:

CodeBody       Body;
Code           Prev;
Code           Next;
parser::Token* Tok;
Code           Parent;
StringCached   Name;
CodeT          Type;

Serialization:

extern "<Name>"
{
    <Body>
}

Include

Fields:

StringCached   Content;
Code           Prev;
Code           Next;
Code           Parent;
parser::Token* Tok;
StringCached   Name;
CodeT          Type;

Serialization:

#include <Content>

Friend

This library (until its necessary become some third-party library to do otherwise) does not support friend declarations with in-statment function definitions.

Fields:

CodeComment    InlineCmt;
Code           Declaration;
Code           Prev;
Code           Next;
parser::Token* Tok;
Code           Parent;
StringCached   Name;
CodeT          Type;

Serialization:

friend <Declaration>; <InlineCmt>

Function

Fields:

CodeComment    InlineCmt;
CodeAttributes Attributes;
CodeSpecifiers Specs;
CodeType       ReturnType;
CodeParam      Params;
CodeBody       Body;
Code           Prev;
Code           Next;
parser::Token* Tok;
Code           Parent;
StringCached   Name;
CodeT          Type;
ModuleFlag     ModuleFlags;

Serialization:

// Function_Fwd
<ModuleFlags> <Attributes> <Specs> <ReturnType> <Name>( <Params> ) <Specs>; <InlineCmt>

// Function
<ModuleFlags> <Attributes> <Specs> <ReturnType> <Name>( <Params> ) <Specs>
{
    <Body>
}

Module

Fields:

Code           Prev;
Code           Next;
parser::Token* Tok;
Code           Parent;
StringCached   Name;
CodeT          Type;
ModuleFlag     ModuleFlags;

Serialization:

<ModuleFlags> module <Name>;

Namespace

Fields:

CodeBody       Body;
Code           Prev;
Code           Next;
parser::Token* Tok;
Code           Parent;
StringCached   Name;
CodeT          Type;
ModuleFlag     ModuleFlags;

Serialization:

<ModuleFlags> namespace <Name>
{
    <Body>
}

Operator Overload

Fields:

CodeComment    InlineCmt;
CodeAttributes Attributes;
CodeSpecifiers Specs;
CodeType       ReturnType;
CodeParam      Params;
CodeBody       Body;
Code           Prev;
Code           Next;
parser::Token* Tok;
Code           Parent;
StringCached   Name;
CodeT          Type;
ModuleFlag     ModuleFlags;
OperatorT      Op;

Serialization:

// Operator_Fwd
<ModuleFlags> <Attributes> <Specs> <ReturnType> operator <Op>( <Params> ) <Specs>; <InlineCmt>

// Operator
<ModuleFlags> <Attributes> <Specs> <ReturnType> <Name>operator <Op>( <Params> ) <Specs>
{
    <Body>
}

Operator Cast Overload ( User-Defined Type Conversion )

Fields:

CodeComment    InlineCmt;
CodeSpecifiers Specs;
CodeType       ValueType;
CodeBody       Body;
Code           Prev;
Code           Next;
parser::Token* Tok;
Code           Parent;
StringCached   Name;
CodeT          Type;

Serialization:

// Operator_Cast_Fwd
<Specs> operator <ValueType>() <Specs>; <InlineCmt>

// Operator_Cast
<Specs> <Name>operator <ValueType>() <Specs>
{
    <Body>
}

Parameters (AST_Param)

Fields:

CodeType       ValueType;
Code           Macro;
Code           Value;
CodeParam      Last;
CodeParam      Next;
parser::Token* Tok;
Code           Parent;
StringCached   Name;
CodeT          Type;
s32            NumEntries;

Serialization:

<Macro>, <Next> ... <Last>

<Macro> <ValueType> <Name>, <Next>... <Last>

Pragma

Fields:

StringCached   Content;
Code           Prev;
Code           Next;
parser::Token* Tok;
Code           Parent;
StringCached   Name;
CodeT          Type;

Serialization:

#pragma <Content>

Preprocessor Conditional

Fields:

StringCached  Content;
Code          Prev;
Code          Next;
paser::Token* Tok;
Code          Parent;
StringCached  Name;
CodeT         Type;

Serialization:

#<based off Type> <Content>

Specifiers

Fields:

SpecifierT     ArrSpecs[ AST_ArrSpecs_Cap ];
CodeSpecifiers NextSpecs;
Code           Prev;
Code           Next;
parser::Token* Tok;
Code           Parent;
StringCached   Name;
CodeT          Type;
s32            NumEntries;

Serialization:

<Spec>, ...

Template

Fields:

CodeParam      Params;
Code           Declaration;
Code           Prev;
Code           Next;
parser::Token* Tok;
Code           Parent;
StringCached   Name;
CodeT          Type;
ModuleFlag     ModuleFlags;

Serialization:

<ModuleFlags>
template< <Params> >
<Declaration>

Typename

Typenames represent the type "symbol".

Fields:

CodeAttributes Attributes;
CodeSpecifiers Specs;
CodeReturnType ReturnType;
CodeParam      Params;
Code           ArrExpr;
Code           Prev;
Code           Next;
parser::Token* Tok;
Code           Parent;
StringCached   Name;
CodeT          Type;
b32            IsParamPack;

Serialization:

<Attributes> <Name> <Specs> <IsParamPack ?: ...>

Typedef

Behave as usual except function or macro typedefs.
Those (macros) don't use the underlying type field as everything was serialized under the Name field.

Fields:

CodeComment   InlineCmt;
Code          UnderlyingType;
Code          Prev;
Code          Next;
parse::Token* Tok
Code          Parent;
StringCached  Name;
CodeT         Type;
ModuleFlag    ModuleFlags;
b32           IsFunction;

Serialization:

// Regular
<ModuleFlags> typedef <UnderlyingType> <Name>; <InlineCmt>

// Functions
<ModuleFlags> typedef <ReturnType> <Name>( <Parameters> ); <InlineCmt>
<ModuleFlags> typedef <ReturnType> ( <Expression that yeilds an Identifier signature> )( <Parameters> ); <InlineCmt>

Union

Fields:

CodeAttributes Attributes;
CodeBody       Body;
Code           Prev;
Code           Next;
parser::Token* Tok;
Code           Parent;
StringCached   Name;
CodeT          Type;
ModuleFlag     ModuleFlags;

Serialization:

<ModuleFlags> union <Attributes> <Name>
{
    <Body>
}

Using

Fields:

CodeComment    InlineCmt;
CodeAttributes Attributes;
CodeType       UnderlyingType;
Code           Prev;
Code           Next;
parser::Token* Tok;
Code           Parent;
StringCached   Name;
CodeT          Type;
ModuleFlag     ModuleFlags;

Serialization:

// Regular
<ModuleFlags> using <Attributes> <Name> = <UnderlyingType>; <InlineCmt>

// Namespace
<ModuleFlags> using namespace <Name>; <InlineCmt>

Variable

Algo

Fields:

CodeComment    InlineCmt;
CodeAttributes Attributes;
CodeSpecifiers Specs;
CodeType       ValueType;
Code           BitfieldSize;
Code           Value;
CodeVar        NextVar;
Code           Prev;
Code           Next;
parser::Token* Tok;
Code           Parent;
StringCached   Name;
CodeT          Type;
ModuleFlag     ModuleFlags;

Serialization:

// Regular
<ModuleFlags> <Attributes> <Specs> <ValueType> <Name> = <Value>, NextVar ...; <InlineCmt>

// Bitfield
<ModuleFlags> <Attributes> <Specs> <ValueType> <Name> : <BitfieldSize> = <Value>, NextVar ...; <InlineCmt>

12 KiB Raw Blame History

Navigation

AST Types Documentation

Body

Attributes

Comment

Class & Struct

Constructor

Define

Destructor

Enum

Execution

External Linkage

Include

Friend

Function

Module

Namespace

Operator Overload

Operator Cast Overload ( User-Defined Type Conversion )

Parameters (AST_Param)

Pragma

Preprocessor Conditional

Specifiers

Template

Typename

Typedef

Union

Using

Variable

12 KiB

Raw Blame History