CppSharp/src/CppParser/AST.h

/************************************************************************
*
* CppSharp
* Licensed under the MIT license.
*
************************************************************************/

#pragma once

#include <cstdint>
#include <vector>
#include <map>
#include <string>

#define CS_FLAGS

#if defined(_MSC_VER) && !defined(__clang__)
#define CS_API __declspec(dllexport)
#else
#define CS_API 
#endif

#define VECTOR(type, name) \
    std::vector<type> name; \
    type get##name (unsigned i) { return name[i]; } \
    unsigned get##name##Count () { return name.size(); }

#define VECTOR_STRING(name) \
    std::vector<std::string> name; \
    const char* get##name (unsigned i) { return name[i].c_str(); } \
    unsigned get##name##Count () { return name.size(); }

#define STRING(name) \
    std::string name; \
    const char* get##name() { return name.c_str(); } \
    void set##name(const char* s) { name = s; }

namespace CppSharp { namespace CppParser { namespace AST {

// Types

enum struct TypeKind
{
    Tag,
    Array,
    Function,
    Pointer,
    MemberPointer,
    Typedef,
    Attributed,
    Decayed,
    TemplateSpecialization,
    TemplateParameter,
    TemplateParameterSubstitution,
    InjectedClassName,
    DependentName,
    Builtin
};

#define DECLARE_TYPE_KIND(kind) \
    kind##Type() : CppSharp::CppParser::AST::Type(TypeKind::kind) {}

struct CS_API Type
{
    Type(TypeKind kind) : Kind(kind) {}
    TypeKind Kind;
    bool IsDependent;
};

struct CS_API TypeQualifiers
{
    bool IsConst;
    bool IsVolatile;
    bool IsRestrict;
};

struct CS_API QualifiedType
{
    QualifiedType() : Type(0) {}
    CppSharp::CppParser::AST::Type* Type;
    TypeQualifiers Qualifiers;
};

struct Declaration;

struct CS_API TagType : public Type
{
    DECLARE_TYPE_KIND(Tag)
    CppSharp::CppParser::AST::Declaration* Declaration;
};

struct CS_API ArrayType : public Type
{
    enum class ArraySize
    {
        Constant,
        Variable,
        Dependent,
        Incomplete
    };

    DECLARE_TYPE_KIND(Array)
    CppSharp::CppParser::AST::QualifiedType QualifiedType;
    ArraySize SizeType;
    long Size;
};

struct Parameter;

enum class CallingConvention
{
    Default,
    C,
    StdCall,
    ThisCall,
    FastCall,
    Unknown
};

struct CS_API FunctionType : public Type
{
    DECLARE_TYPE_KIND(Function)
    QualifiedType ReturnType;
    CppSharp::CppParser::AST::CallingConvention CallingConvention;
    VECTOR(Parameter*, Parameters)
};

struct CS_API PointerType : public Type
{
    enum struct TypeModifier
    {
        Value,
        Pointer,
        LVReference,
        RVReference
    };

    DECLARE_TYPE_KIND(Pointer)
    QualifiedType QualifiedPointee;
    TypeModifier Modifier;
};

struct CS_API MemberPointerType : public Type
{
    DECLARE_TYPE_KIND(MemberPointer)
    QualifiedType Pointee;
};

struct TypedefDecl;

struct CS_API TypedefType : public Type
{
    TypedefType() : Type(TypeKind::Typedef), Declaration(0) {}
    TypedefDecl* Declaration;
};

struct CS_API AttributedType : public Type
{
    DECLARE_TYPE_KIND(Attributed)
    QualifiedType Modified;
    QualifiedType Equivalent;
};

struct CS_API DecayedType : public Type
{
    DECLARE_TYPE_KIND(Decayed)
    QualifiedType Decayed;
    QualifiedType Original;
    QualifiedType Pointee;
};

struct CS_API TemplateArgument
{
    TemplateArgument() : Declaration(0) {}

    enum struct ArgumentKind
    {
        Type,
        Declaration,
        NullPtr,
        Integral,
        Template,
        TemplateExpansion,
        Expression,
        Pack
    };

    ArgumentKind Kind;
    QualifiedType Type;
    CppSharp::CppParser::AST::Declaration* Declaration;
    long Integral;
};

struct Template;

struct CS_API TemplateSpecializationType : public Type
{
    TemplateSpecializationType() : Type(TypeKind::TemplateSpecialization),
        Template(0), Desugared(0) {}
    VECTOR(TemplateArgument, Arguments)
    CppSharp::CppParser::AST::Template* Template;
    Type* Desugared;
};

struct CS_API TemplateParameter
{
    bool operator==(const TemplateParameter& param) const
    {
        return Name == param.Name;
    }

    STRING(Name)
};

struct CS_API TemplateParameterType : public Type
{
    DECLARE_TYPE_KIND(TemplateParameter)
    TemplateParameter Parameter;
};

struct CS_API TemplateParameterSubstitutionType : public Type
{
    DECLARE_TYPE_KIND(TemplateParameterSubstitution)
    QualifiedType Replacement;
};

struct Class;

struct CS_API InjectedClassNameType : public Type
{
    InjectedClassNameType() : Type(TypeKind::InjectedClassName),
        Class(0) {}
    TemplateSpecializationType TemplateSpecialization;
    CppSharp::CppParser::AST::Class* Class;
};

struct CS_API DependentNameType : public Type
{
    DECLARE_TYPE_KIND(DependentName)
};

enum struct PrimitiveType
{
    Null,
    Void,
    Bool,
    WideChar,
    Int8,
    Char = Int8,
    UInt8,
    UChar = UInt8,
    Int16,
    UInt16,
    Int32,
    UInt32,
    Int64,
    UInt64,
    Float,
    Double,
    IntPtr
};

struct CS_API BuiltinType : public Type
{
    DECLARE_TYPE_KIND(Builtin)
    PrimitiveType Type;
};

// Comments

enum struct RawCommentKind
{
    Invalid,
    OrdinaryBCPL,
    OrdinaryC,
    BCPLSlash,
    BCPLExcl,
    JavaDoc,
    Qt,
    Merged
};

struct FullComment;

struct CS_API RawComment
{
    RawCommentKind Kind;
    STRING(Text)
    STRING(BriefText)
    CppSharp::CppParser::AST::FullComment* FullComment;
};

// Class layouts

enum struct VTableComponentKind
{
    VCallOffset,
    VBaseOffset,
    OffsetToTop,
    RTTI,
    FunctionPointer,
    CompleteDtorPointer,
    DeletingDtorPointer,
    UnusedFunctionPointer,
};

struct CS_API VTableComponent
{
    VTableComponent() : Offset(0), Declaration(0) {}
    VTableComponentKind Kind;
    unsigned Offset;
    CppSharp::CppParser::AST::Declaration* Declaration;
};

struct CS_API VTableLayout
{
    VECTOR(VTableComponent, Components)
};

struct CS_API VFTableInfo
{
    uint64_t VBTableIndex;
    uint32_t VFPtrOffset;
    uint32_t VFPtrFullOffset;
    VTableLayout Layout;
};

enum struct CppAbi
{
    Itanium,
    Microsoft,
    ARM
};

struct CS_API ClassLayout
{
    ClassLayout() : ABI(CppAbi::Itanium) {}
    CppAbi ABI;
    VECTOR(VFTableInfo, VFTables)
    VTableLayout Layout;
    bool HasOwnVFPtr;
    long VBPtrOffset;
    int Alignment;
    int Size;
    int DataSize;
};

// Declarations

enum struct MacroLocation
{
    Unknown,
    ClassHead,
    ClassBody,
    FunctionHead,
    FunctionParameters,
    FunctionBody,
};

enum struct AccessSpecifier
{
    Private,
    Protected,
    Public
};

struct DeclarationContext;
struct PreprocessedEntity;

enum struct DeclarationKind
{
    DeclarationContext,
    Typedef,
    Parameter,
    Function,
    Method,
    Enumeration,
    EnumerationItem,
    Variable,
    Field,
    AccessSpecifier,
    Class,
    Template,
    ClassTemplate,
    ClassTemplateSpecialization,
    ClassTemplatePartialSpecialization,
    FunctionTemplate,
    Namespace,
    PreprocessedEntity,
    MacroDefinition,
    MacroExpansion,
    TranslationUnit
};

#define DECLARE_DECL_KIND(klass, kind) \
    klass() : Declaration(DeclarationKind::kind) {}

struct CS_API Declaration
{
    Declaration(DeclarationKind kind);

    DeclarationKind Kind;
    AccessSpecifier Access;
    DeclarationContext* _Namespace;
    STRING(Name)
    RawComment* Comment;
    STRING(DebugText)
    bool IsIncomplete;
    bool IsDependent;
    Declaration* CompleteDeclaration;
    unsigned DefinitionOrder;
    VECTOR(PreprocessedEntity*, PreprocessedEntities)
    void* OriginalPtr;
};

struct Class;
struct Enumeration;
struct Function;
struct TypedefDecl;
struct Namespace;
struct Template;
struct FunctionTemplate;
struct Variable;

struct CS_API DeclarationContext : public Declaration
{
    DECLARE_DECL_KIND(DeclarationContext, DeclarationContext)

    Declaration* FindAnonymous(uint64_t key);

    CppSharp::CppParser::AST::Namespace* FindNamespace(const std::string& Name);
    CppSharp::CppParser::AST::Namespace* FindNamespace(const std::vector<std::string>&);
    CppSharp::CppParser::AST::Namespace* FindCreateNamespace(const std::string& Name);

    Class* CreateClass(std::string Name, bool IsComplete);
    Class* FindClass(const std::string& Name);
    Class* FindClass(const std::string& Name, bool IsComplete,
        bool Create = false);

    FunctionTemplate* FindFunctionTemplate(void* OriginalPtr);
    FunctionTemplate* FindFunctionTemplate(const std::string& Name,
        const std::vector<TemplateParameter>& Params);

    Enumeration* FindEnum(const std::string& Name, bool Create = false);

    Function* FindFunction(const std::string& Name, bool Create = false);

    TypedefDecl* FindTypedef(const std::string& Name, bool Create = false);

    VECTOR(Namespace*, Namespaces)
    VECTOR(Enumeration*, Enums)
    VECTOR(Function*, Functions)
    VECTOR(Class*, Classes)
    VECTOR(Template*, Templates)
    VECTOR(TypedefDecl*, Typedefs)
    VECTOR(Variable*, Variables)
    std::map<uint64_t, Declaration*> Anonymous;
};

struct CS_API TypedefDecl : public Declaration
{
    DECLARE_DECL_KIND(TypedefDecl, Typedef)
    CppSharp::CppParser::AST::QualifiedType QualifiedType;
};

struct CS_API Parameter : public Declaration
{
    Parameter() : Declaration(DeclarationKind::Parameter),
        IsIndirect(false), HasDefaultValue(false) {}

    CppSharp::CppParser::AST::QualifiedType QualifiedType;
    bool IsIndirect;
    bool HasDefaultValue;
};

enum struct CXXMethodKind
{
    Normal,
    Constructor,
    Destructor,
    Conversion,
    Operator,
    UsingDirective
};

enum struct CXXOperatorKind
{
    None,
    New,
    Delete,
    Array_New,
    Array_Delete,
    Plus,
    Minus,
    Star,
    Slash,
    Percent,
    Caret,
    Amp,
    Pipe,
    Tilde,
    Exclaim,
    Equal,
    Less,
    Greater,
    PlusEqual,
    MinusEqual,
    StarEqual,
    SlashEqual,
    PercentEqual,
    CaretEqual,
    AmpEqual,
    PipeEqual,
    LessLess,
    GreaterGreater,
    LessLessEqual,
    GreaterGreaterEqual,
    EqualEqual,
    ExclaimEqual,
    LessEqual,
    GreaterEqual,
    AmpAmp,
    PipePipe,
    PlusPlus,
    MinusMinus,
    Comma,
    ArrowStar,
    Arrow,
    Call,
    Subscript,
    Conditional
};

struct CS_API Function : public Declaration
{
    Function() : Declaration(DeclarationKind::Function),
        IsReturnIndirect(false) {}

    QualifiedType ReturnType;
    bool IsReturnIndirect;

    bool IsVariadic;
    bool IsInline;
    bool IsPure;
    bool IsDeleted;
    CXXOperatorKind OperatorKind;
    STRING(Mangled)
    STRING(Signature)
    CppSharp::CppParser::AST::CallingConvention CallingConvention;
    VECTOR(Parameter*, Parameters)
};

struct AccessSpecifierDecl;

struct CS_API Method : public Function
{
    Method() : IsDefaultConstructor(false), IsCopyConstructor(false),
        IsMoveConstructor(false) { Kind = DeclarationKind::Method; }

    AccessSpecifierDecl* AccessDecl;

    bool IsVirtual;
    bool IsStatic;
    bool IsConst;
    bool IsImplicit;
    bool IsOverride;

    CXXMethodKind MethodKind;

    bool IsDefaultConstructor;
    bool IsCopyConstructor;
    bool IsMoveConstructor;

    QualifiedType ConversionType;
};

struct CS_API Enumeration : public Declaration
{
    DECLARE_DECL_KIND(Enumeration, Enumeration)

    struct CS_API Item : public Declaration
    {
        DECLARE_DECL_KIND(Item, EnumerationItem)
        STRING(Expression)
        uint64_t Value;
    };

    enum struct CS_FLAGS EnumModifiers
    {
        Anonymous = 1 << 0,
        Scoped = 1 << 1,
        Flags  = 1 << 2,
    };

    EnumModifiers Modifiers;
    CppSharp::CppParser::AST::Type* Type;
    CppSharp::CppParser::AST::BuiltinType* BuiltinType;
    VECTOR(Item, Items)
};

struct CS_API Variable : public Declaration
{
    DECLARE_DECL_KIND(Variable, Variable)

    STRING(Mangled)
    CppSharp::CppParser::AST::QualifiedType QualifiedType;
};

struct CS_API BaseClassSpecifier
{
    AccessSpecifier Access;
    bool IsVirtual;
    CppSharp::CppParser::AST::Type* Type;
};

struct Class;

struct CS_API Field : public Declaration
{
    DECLARE_DECL_KIND(Field, Field)
    CppSharp::CppParser::AST::QualifiedType QualifiedType;
    AccessSpecifier Access;
    unsigned Offset;
    CppSharp::CppParser::AST::Class* Class;
};

struct CS_API AccessSpecifierDecl : public Declaration
{
    DECLARE_DECL_KIND(AccessSpecifierDecl, AccessSpecifier)
};

struct CS_API Class : public DeclarationContext
{
    Class() { Kind = DeclarationKind::Class; }

    VECTOR(BaseClassSpecifier*, Bases)
    VECTOR(Field*, Fields)
    VECTOR(Method*, Methods)
    VECTOR(AccessSpecifierDecl*, Specifiers)

    bool IsPOD;
    bool IsAbstract;
    bool IsUnion;
    bool IsDynamic;
    bool IsPolymorphic;
    bool HasNonTrivialDefaultConstructor;
    bool HasNonTrivialCopyConstructor;
    bool HasNonTrivialDestructor;

    ClassLayout Layout;
};

struct CS_API Template : public Declaration
{
    DECLARE_DECL_KIND(Template, Template)
    Declaration* TemplatedDecl;
    VECTOR(TemplateParameter, Parameters)
};

struct ClassTemplateSpecialization;
struct ClassTemplatePartialSpecialization;

struct CS_API ClassTemplate : public Template
{
    ClassTemplate() { Kind = DeclarationKind::ClassTemplate; }
    VECTOR(ClassTemplateSpecialization*, Specializations)
    ClassTemplateSpecialization* FindSpecialization(void* ptr);
    ClassTemplateSpecialization* FindSpecialization(TemplateSpecializationType type);
    ClassTemplatePartialSpecialization* FindPartialSpecialization(void* ptr);
    ClassTemplatePartialSpecialization* FindPartialSpecialization(TemplateSpecializationType type);
};

enum struct TemplateSpecializationKind
{
    Undeclared,
    ImplicitInstantiation,
    ExplicitSpecialization,
    ExplicitInstantiationDeclaration,
    ExplicitInstantiationDefinition
};

struct CS_API ClassTemplateSpecialization : public Class
{
    ClassTemplateSpecialization() {
        Kind = DeclarationKind::ClassTemplateSpecialization; }
    ClassTemplate* TemplatedDecl;
    VECTOR(TemplateArgument, Arguments)
    TemplateSpecializationKind SpecializationKind;
};

struct CS_API ClassTemplatePartialSpecialization : public ClassTemplateSpecialization
{
    ClassTemplatePartialSpecialization() { Kind =
        DeclarationKind::ClassTemplatePartialSpecialization; }
};

struct CS_API FunctionTemplate : public Template
{
    FunctionTemplate() { Kind = DeclarationKind::FunctionTemplate; }
};

struct CS_API Namespace : public DeclarationContext
{
    Namespace() { Kind = DeclarationKind::Namespace; }
};

struct CS_API PreprocessedEntity : public Declaration
{
    PreprocessedEntity() : Declaration(DeclarationKind::PreprocessedEntity),
        Location(MacroLocation::Unknown) {}

    MacroLocation Location;
};

struct CS_API MacroDefinition : public PreprocessedEntity
{
    MacroDefinition() { Kind = DeclarationKind::MacroDefinition; }
    STRING(Expression)
};

struct CS_API MacroExpansion : public PreprocessedEntity
{
    MacroExpansion() { Kind = DeclarationKind::MacroExpansion; }
    STRING(Text)
    MacroDefinition* Definition;
};

struct CS_API TranslationUnit : public Namespace
{
    TranslationUnit() { Kind = DeclarationKind::TranslationUnit; }
    STRING(FileName)
    bool IsSystemHeader;
    VECTOR(MacroDefinition*, Macros)
};

struct CS_API NativeLibrary
{
    STRING(FileName)
    VECTOR_STRING(Symbols)
};

struct CS_API ASTContext
{
    TranslationUnit* FindOrCreateModule(const std::string& File);
    VECTOR(TranslationUnit*, TranslationUnits)
};

} } }