C-Like Code Index¶

• Schema URL: https://cocotec.io/schemas/cp/code-index-clike-v1.schema.json
• Root schema: Index

JSONReference¶

Properties:	$ref (String) –

AccessSpecifier¶

If this declaration is contained within a RecordDecl, the C++ access specifier that specifies the level of access that is permitted to this object. Note that private declarations are omitted from the code index.

Enum:	public, protected, private

AnyDecl¶

One Of:	ConstructorDecl – EnumDecl – EnumClassDecl – FieldDecl – FunctionDecl – MethodDecl – NamespaceDecl – RecordDecl –

BaseClass¶

All Of:	BaseNode –
Properties:	kind ("BaseClassDecl") – type (QualifiedType) –

BaseNode¶

Properties:	coco_position (CocoPosition) – kind (String) –

ConstructorDecl¶

All Of:	NamedDecl –
Properties:	kind ("ConstructorDecl") – parameters (Array[ParameterDecl]) –

EnumDecl¶

All Of:	NamedDecl –
Properties:	kind ("EnumDecl") – declarations (Array[EnumConstantDecl]) –

EnumClassDecl¶

All Of:	NamedDecl –
Properties:	kind ("EnumClassDecl") – declarations (Array[EnumConstantDecl]) –

EnumConstantDecl¶

All Of:	NamedDecl –
Properties:	kind ("EnumConstantDecl") –

FieldDecl¶

A single field of a C++ class or struct (e.g. int field_x;).

All Of:	NamedDecl –
Properties:	kind ("FieldDecl") – declared_type (QualifiedType) –

ForwardDecl¶

Properties:	fully_qualified_name (String) – include_path (String) – simple_reference (JSONReference) –

FunctionDecl¶

A top-level function declaration. See MethodDecl for the representation of a member of a C++ struct or class.

All Of:	NamedDecl –
Properties:	kind ("FunctionDecl") – flags (Array[FunctionFlag]) – parameters (Array[ParameterDecl]) – return_type (QualifiedType) –

FunctionFlag¶

Enum:	const, override, inline, pure_virtual, static, virtual

GeneratedFile¶

All Of:	BaseNode –
Properties:	kind ("GeneratedFile") – declarations (Array[AnyDecl]) – forward_declarations (Array[ForwardDecl]) – header_output_path (String) – implementation_output_path (String) – include_path (String) – includes (Array[Include]) –

Include¶

A single include in a GeneratedFile

Properties:	in_header (Boolean) – If true, then this include will be present in the header of this GeneratedFile, otherwise it will only be in the implementation file. is_system (Boolean) – Whether this is a system include, to be included using <> rather than “”. include_path (String) – The full include path. simple_reference (JSONReference) –

Index¶

This is the root element of the generated code index for C-like languages.

All Of:	Index –
Properties:	generated (Array[GeneratedFile]) – The list of generated files when the packages listed in included_packages are generated.

MethodDecl¶

Represents a method of a C++ class/struct. This can only appear as the child of a RecordDecl.

All Of:	NamedDecl –
Properties:	kind ("MethodDecl") – flags (Array[FunctionFlag]) – parameters (Array[ParameterDecl]) – return_type (QualifiedType) –

NamedDecl¶

All Of:	BaseNode –
Properties:	access_specifier (AccessSpecifier) – name (String) – The unqualified name, excluding any namespace or scope qualifiers: e.g. duration. fully_qualified_name (String) – The fully-qualified name, including any namespace or scope qualifiers: e.g. std::chrono::duration.

NamespaceDecl¶

All Of:	NamedDecl –
Properties:	kind ("NamespaceDecl") – declarations (Array[AnyDecl]) –

NodeKind¶

Enum:	FieldDecl, RecordDecl, MethodDecl, ParameterDecl

ParameterDecl¶

All Of:	BaseNode –
Properties:	declared_type (QualifiedType) – fully_qualified_name (String) – kind ("ParameterDecl") – name (String) –

QualifiedType¶

All Of:	BaseNode –
Properties:	kind ("QualifiedType") – rendered (String) – simple_type_reference (JSONReference) –

RecordDecl¶

All Of:	NamedDecl –
Properties:	kind ("RecordDecl") – base_classes (Array[BaseClass]) – declarations (Array[AnyDecl]) – is_final (Boolean) – specialisation_arguemnts (Array[TemplateArgument]) – record_kind (RecordKind) –

RecordKind¶

Enum:	class, struct, union

TemplateArgument¶

Properties:	kind (String) –

RecordDecl¶

All Of:	NamedDecl –
Properties:	expr (BaseNode) –

RecordDecl¶

All Of:	NamedDecl –
Properties:	type (QualifiedType) –