CXCursorKind

\brief Describes the kind of entity that a cursor refers to.

Values

ValueMeaning
CXCursor_UnexposedDecl1

\brief A declaration whose specific kind is not exposed via this interface.

Unexposed declarations have the same operations as any other kind of declaration; one can extract their location information, spelling, find their definitions, etc. However, the specific kind of the declaration is not reported.

CXCursor_StructDecl2

\brief A C or C++ struct.

CXCursor_UnionDecl3

\brief A C or C++ union.

CXCursor_ClassDecl4

\brief A C++ class.

CXCursor_EnumDecl5

\brief An enumeration.

CXCursor_FieldDecl6

\brief A field (in C) or non-static data member (in C++) in a struct, union, or C++ class.

CXCursor_EnumConstantDecl7

\brief An enumerator constant.

CXCursor_FunctionDecl8

\brief A function.

CXCursor_VarDecl9

\brief A variable.

CXCursor_ParmDecl10

\brief A function or method parameter.

CXCursor_ObjCInterfaceDecl11

\brief An Objective-C \@interface.

CXCursor_ObjCCategoryDecl12

\brief An Objective-C \@interface for a category.

CXCursor_ObjCProtocolDecl13

\brief An Objective-C \@protocol declaration.

CXCursor_ObjCPropertyDecl14

\brief An Objective-C \@property declaration.

CXCursor_ObjCIvarDecl15

\brief An Objective-C instance variable.

CXCursor_ObjCInstanceMethodDecl16

\brief An Objective-C instance method.

CXCursor_ObjCClassMethodDecl17

\brief An Objective-C class method.

CXCursor_ObjCImplementationDecl18

\brief An Objective-C \@implementation.

CXCursor_ObjCCategoryImplDecl19

\brief An Objective-C \@implementation for a category.

CXCursor_TypedefDecl20

\brief A typedef.

CXCursor_CXXMethod21

\brief A C++ class method.

CXCursor_Namespace22

\brief A C++ namespace.

CXCursor_LinkageSpec23

\brief A linkage specification, e.g. 'extern "C"'.

CXCursor_Constructor24

\brief A C++ constructor.

CXCursor_Destructor25

\brief A C++ destructor.

CXCursor_ConversionFunction26

\brief A C++ conversion function (cast operator).

CXCursor_TemplateTypeParameter27

\brief A C++ template type parameter.

CXCursor_NonTypeTemplateParameter28

\brief A C++ non-type template parameter.

CXCursor_TemplateTemplateParameter29

\brief A C++ template template parameter.

CXCursor_FunctionTemplate30

\brief A C++ function template.

CXCursor_ClassTemplate31

\brief A C++ class template.

CXCursor_ClassTemplatePartialSpecialization32

\brief A C++ class template partial specialization.

CXCursor_NamespaceAlias33

\brief A C++ namespace alias declaration.

CXCursor_UsingDirective34

\brief A C++ using directive.

CXCursor_UsingDeclaration35

\brief A C++ using declaration.

CXCursor_TypeAliasDecl36

\brief A C++ alias declaration

CXCursor_ObjCSynthesizeDecl37

\brief An Objective-C \@synthesize definition.

CXCursor_ObjCDynamicDecl38

\brief An Objective-C \@dynamic definition.

CXCursor_CXXAccessSpecifier39

\brief An access specifier.

CXCursor_FirstDeclCXCursor_UnexposedDecl
CXCursor_LastDeclCXCursor_CXXAccessSpecifier
CXCursor_FirstRef40
CXCursor_ObjCSuperClassRef40
CXCursor_ObjCProtocolRef41
CXCursor_ObjCClassRef42
CXCursor_TypeRef43

\brief A reference to a type declaration.

A type reference occurs anywhere where a type is named but not declared. For example, given:

\code typedef unsigned size_type; size_type size; \endcode

The typedef is a declaration of size_type (CXCursor_TypedefDecl), while the type of the variable "size" is referenced. The cursor referenced by the type of size is the typedef for size_type.

CXCursor_CXXBaseSpecifier44
CXCursor_TemplateRef45

\brief A reference to a class template, function template, template template parameter, or class template partial specialization.

CXCursor_NamespaceRef46

\brief A reference to a namespace or namespace alias.

CXCursor_MemberRef47

\brief A reference to a member of a struct, union, or class that occurs in some non-expression context, e.g., a designated initializer.

CXCursor_LabelRef48

\brief A reference to a labeled statement.

This cursor kind is used to describe the jump to "start_over" in the goto statement in the following example:

\code start_over: ++counter;

goto start_over; \endcode

A label reference cursor refers to a label statement.

CXCursor_OverloadedDeclRef49

\brief A reference to a set of overloaded functions or function templates that has not yet been resolved to a specific function or function template.

An overloaded declaration reference cursor occurs in C++ templates where a dependent name refers to a function. For example:

\code template<typename T> void swap(T&, T&);

struct X { ... }; void swap(X&, X&);

template<typename T> void reverse(T* first, T* last) { while (first < last - 1) { swap(*first, *--last); ++first; } }

struct Y { }; void swap(Y&, Y&); \endcode

Here, the identifier "swap" is associated with an overloaded declaration reference. In the template definition, "swap" refers to either of the two "swap" functions declared above, so both results will be available. At instantiation time, "swap" may also refer to other functions found via argument-dependent lookup (e.g., the "swap" function at the end of the example).

The functions \c clang_getNumOverloadedDecls() and \c clang_getOverloadedDecl() can be used to retrieve the definitions referenced by this cursor.

CXCursor_VariableRef50

\brief A reference to a variable that occurs in some non-expression context, e.g., a C++ lambda capture list.

CXCursor_LastRefCXCursor_VariableRef
CXCursor_FirstInvalid70
CXCursor_InvalidFile70
CXCursor_NoDeclFound71
CXCursor_NotImplemented72
CXCursor_InvalidCode73
CXCursor_LastInvalidCXCursor_InvalidCode
CXCursor_FirstExpr100
CXCursor_UnexposedExpr100

\brief An expression whose specific kind is not exposed via this interface.

Unexposed expressions have the same operations as any other kind of expression; one can extract their location information, spelling, children, etc. However, the specific kind of the expression is not reported.

CXCursor_DeclRefExpr101

\brief An expression that refers to some value declaration, such as a function, variable, or enumerator.

CXCursor_MemberRefExpr102

\brief An expression that refers to a member of a struct, union, class, Objective-C class, etc.

CXCursor_CallExpr103

\brief An expression that calls a function.

CXCursor_ObjCMessageExpr104

\brief An expression that sends a message to an Objective-C object or class.

CXCursor_BlockExpr105

\brief An expression that represents a block literal.

CXCursor_IntegerLiteral106

\brief An integer literal.

CXCursor_FloatingLiteral107

\brief A floating point number literal.

CXCursor_ImaginaryLiteral108

\brief An imaginary number literal.

CXCursor_StringLiteral109

\brief A string literal.

CXCursor_CharacterLiteral110

\brief A character literal.

CXCursor_ParenExpr111

\brief A parenthesized expression, e.g. "(1)".

This AST node is only formed if full location information is requested.

CXCursor_UnaryOperator112

\brief This represents the unary-expression's (except sizeof and alignof).

CXCursor_ArraySubscriptExpr113

\brief [C99 6.5.2.1] Array Subscripting.

CXCursor_BinaryOperator114

\brief A builtin binary operation expression such as "x + y" or "x <= y".

CXCursor_CompoundAssignOperator115

\brief Compound assignment such as "+=".

CXCursor_ConditionalOperator116

\brief The ?: ternary operator.

CXCursor_CStyleCastExpr117

\brief An explicit cast in C (C99 6.5.4) or a C-style cast in C++ (C++ expr.cast), which uses the syntax (Type)expr.

For example: (int)f.

CXCursor_CompoundLiteralExpr118

\brief [C99 6.5.2.5]

CXCursor_InitListExpr119

\brief Describes an C or C++ initializer list.

CXCursor_AddrLabelExpr120

\brief The GNU address of label extension, representing &&label.

CXCursor_StmtExpr121

\brief This is the GNU Statement Expression extension: ({int X=4; X;})

CXCursor_GenericSelectionExpr122

\brief Represents a C11 generic selection.

CXCursor_GNUNullExpr123

\brief Implements the GNU __null extension, which is a name for a null pointer constant that has integral type (e.g., int or long) and is the same size and alignment as a pointer.

The __null extension is typically only used by system headers, which define NULL as __null in C++ rather than using 0 (which is an integer that may not match the size of a pointer).

CXCursor_CXXStaticCastExpr124

\brief C++'s static_cast<> expression.

CXCursor_CXXDynamicCastExpr125

\brief C++'s dynamic_cast<> expression.

CXCursor_CXXReinterpretCastExpr126

\brief C++'s reinterpret_cast<> expression.

CXCursor_CXXConstCastExpr127

\brief C++'s const_cast<> expression.

CXCursor_CXXFunctionalCastExpr128

\brief Represents an explicit C++ type conversion that uses "functional" notion (C++ expr.type.conv).

Example: \code x = int(0.5); \endcode

CXCursor_CXXTypeidExpr129

\brief A C++ typeid expression (C++ expr.typeid).

CXCursor_CXXBoolLiteralExpr130

\brief [C++ 2.13.5] C++ Boolean Literal.

CXCursor_CXXNullPtrLiteralExpr131

\brief [C++0x 2.14.7] C++ Pointer Literal.

CXCursor_CXXThisExpr132

\brief Represents the "this" expression in C++

CXCursor_CXXThrowExpr133

\brief [C++ 15] C++ Throw Expression.

This handles 'throw' and 'throw' assignment-expression. When assignment-expression isn't present, Op will be null.

CXCursor_CXXNewExpr134

\brief A new expression for memory allocation and constructor calls, e.g: "new CXXNewExpr(foo)".

CXCursor_CXXDeleteExpr135

\brief A delete expression for memory deallocation and destructor calls, e.g. "delete[] pArray".

CXCursor_UnaryExpr136

\brief A unary expression. (noexcept, sizeof, or other traits)

CXCursor_ObjCStringLiteral137

\brief An Objective-C string literal i.e. @"foo".

CXCursor_ObjCEncodeExpr138

\brief An Objective-C \@encode expression.

CXCursor_ObjCSelectorExpr139

\brief An Objective-C \@selector expression.

CXCursor_ObjCProtocolExpr140

\brief An Objective-C \@protocol expression.

CXCursor_ObjCBridgedCastExpr141

\brief An Objective-C "bridged" cast expression, which casts between Objective-C pointers and C pointers, transferring ownership in the process.

\code NSString *str = (__bridge_transfer NSString *)CFCreateString(); \endcode

CXCursor_PackExpansionExpr142

\brief Represents a C++0x pack expansion that produces a sequence of expressions.

A pack expansion expression contains a pattern (which itself is an expression) followed by an ellipsis. For example:

\code template<typename F, typename ...Types> void forward(F f, Types &&...args) { f(static_cast<Types&&>(args)...); } \endcode

CXCursor_SizeOfPackExpr143

\brief Represents an expression that computes the length of a parameter pack.

\code template<typename ...Types> struct count { static const unsigned value = sizeof...(Types); }; \endcode

CXCursor_LambdaExpr144
CXCursor_ObjCBoolLiteralExpr145

\brief Objective-c Boolean Literal.

CXCursor_ObjCSelfExpr146

\brief Represents the "self" expression in an Objective-C method.

CXCursor_OMPArraySectionExpr147

\brief OpenMP 4.0 [2.4, Array Section].

CXCursor_ObjCAvailabilityCheckExpr148

\brief Represents an @available(...) check.

CXCursor_LastExprCXCursor_ObjCAvailabilityCheckExpr
CXCursor_FirstStmt200
CXCursor_UnexposedStmt200

\brief A statement whose specific kind is not exposed via this interface.

Unexposed statements have the same operations as any other kind of statement; one can extract their location information, spelling, children, etc. However, the specific kind of the statement is not reported.

CXCursor_LabelStmt201

\brief A labelled statement in a function.

This cursor kind is used to describe the "start_over:" label statement in the following example:

\code start_over: ++counter; \endcode

CXCursor_CompoundStmt202

\brief A group of statements like { stmt stmt }.

This cursor kind is used to describe compound statements, e.g. function bodies.

CXCursor_CaseStmt203

\brief A case statement.

CXCursor_DefaultStmt204

\brief A default statement.

CXCursor_IfStmt205

\brief An if statement

CXCursor_SwitchStmt206

\brief A switch statement.

CXCursor_WhileStmt207

\brief A while statement.

CXCursor_DoStmt208

\brief A do statement.

CXCursor_ForStmt209

\brief A for statement.

CXCursor_GotoStmt210

\brief A goto statement.

CXCursor_IndirectGotoStmt211

\brief An indirect goto statement.

CXCursor_ContinueStmt212

\brief A continue statement.

CXCursor_BreakStmt213

\brief A break statement.

CXCursor_ReturnStmt214

\brief A return statement.

CXCursor_GCCAsmStmt215

\brief A GCC inline assembly statement extension.

CXCursor_AsmStmtCXCursor_GCCAsmStmt
CXCursor_ObjCAtTryStmt216

\brief Objective-C's overall \@try-\@catch-\@finally statement.

CXCursor_ObjCAtCatchStmt217

\brief Objective-C's \@catch statement.

CXCursor_ObjCAtFinallyStmt218

\brief Objective-C's \@finally statement.

CXCursor_ObjCAtThrowStmt219

\brief Objective-C's \@throw statement.

CXCursor_ObjCAtSynchronizedStmt220

\brief Objective-C's \@synchronized statement.

CXCursor_ObjCAutoreleasePoolStmt221

\brief Objective-C's autorelease pool statement.

CXCursor_ObjCForCollectionStmt222

\brief Objective-C's collection statement.

CXCursor_CXXCatchStmt223

\brief C++'s catch statement.

CXCursor_CXXTryStmt224

\brief C++'s try statement.

CXCursor_CXXForRangeStmt225

\brief C++'s for (* : *) statement.

CXCursor_SEHTryStmt226

\brief Windows Structured Exception Handling's try statement.

CXCursor_SEHExceptStmt227

\brief Windows Structured Exception Handling's except statement.

CXCursor_SEHFinallyStmt228

\brief Windows Structured Exception Handling's finally statement.

CXCursor_MSAsmStmt229

\brief A MS inline assembly statement extension.

CXCursor_NullStmt230

\brief The null statement ";": C99 6.8.3p3.

This cursor kind is used to describe the null statement.

CXCursor_DeclStmt231

\brief Adaptor class for mixing declarations with statements and expressions.

CXCursor_OMPParallelDirective232

\brief OpenMP parallel directive.

CXCursor_OMPSimdDirective233

\brief OpenMP SIMD directive.

CXCursor_OMPForDirective234

\brief OpenMP for directive.

CXCursor_OMPSectionsDirective235

\brief OpenMP sections directive.

CXCursor_OMPSectionDirective236

\brief OpenMP section directive.

CXCursor_OMPSingleDirective237

\brief OpenMP single directive.

CXCursor_OMPParallelForDirective238

\brief OpenMP parallel for directive.

CXCursor_OMPParallelSectionsDirective239

\brief OpenMP parallel sections directive.

CXCursor_OMPTaskDirective240

\brief OpenMP task directive.

CXCursor_OMPMasterDirective241

\brief OpenMP master directive.

CXCursor_OMPCriticalDirective242

\brief OpenMP critical directive.

CXCursor_OMPTaskyieldDirective243

\brief OpenMP taskyield directive.

CXCursor_OMPBarrierDirective244

\brief OpenMP barrier directive.

CXCursor_OMPTaskwaitDirective245

\brief OpenMP taskwait directive.

CXCursor_OMPFlushDirective246

\brief OpenMP flush directive.

CXCursor_SEHLeaveStmt247

\brief Windows Structured Exception Handling's leave statement.

CXCursor_OMPOrderedDirective248

\brief OpenMP ordered directive.

CXCursor_OMPAtomicDirective249

\brief OpenMP atomic directive.

CXCursor_OMPForSimdDirective250

\brief OpenMP for SIMD directive.

CXCursor_OMPParallelForSimdDirective251

\brief OpenMP parallel for SIMD directive.

CXCursor_OMPTargetDirective252

\brief OpenMP target directive.

CXCursor_OMPTeamsDirective253

\brief OpenMP teams directive.

CXCursor_OMPTaskgroupDirective254

\brief OpenMP taskgroup directive.

CXCursor_OMPCancellationPointDirective255

\brief OpenMP cancellation point directive.

CXCursor_OMPCancelDirective256

\brief OpenMP cancel directive.

CXCursor_OMPTargetDataDirective257

\brief OpenMP target data directive.

CXCursor_OMPTaskLoopDirective258

\brief OpenMP taskloop directive.

CXCursor_OMPTaskLoopSimdDirective259

\brief OpenMP taskloop simd directive.

CXCursor_OMPDistributeDirective260

\brief OpenMP distribute directive.

CXCursor_OMPTargetEnterDataDirective261

\brief OpenMP target enter data directive.

CXCursor_OMPTargetExitDataDirective262

\brief OpenMP target exit data directive.

CXCursor_OMPTargetParallelDirective263

\brief OpenMP target parallel directive.

CXCursor_OMPTargetParallelForDirective264

\brief OpenMP target parallel for directive.

CXCursor_OMPTargetUpdateDirective265

\brief OpenMP target update directive.

CXCursor_OMPDistributeParallelForDirective266

\brief OpenMP distribute parallel for directive.

CXCursor_OMPDistributeParallelForSimdDirective267

\brief OpenMP distribute parallel for simd directive.

CXCursor_OMPDistributeSimdDirective268

\brief OpenMP distribute simd directive.

CXCursor_OMPTargetParallelForSimdDirective269

\brief OpenMP target parallel for simd directive.

CXCursor_OMPTargetSimdDirective270

\brief OpenMP target simd directive.

CXCursor_OMPTeamsDistributeDirective271

\brief OpenMP teams distribute directive.

CXCursor_OMPTeamsDistributeSimdDirective272

\brief OpenMP teams distribute simd directive.

CXCursor_OMPTeamsDistributeParallelForSimdDirective273

\brief OpenMP teams distribute parallel for simd directive.

CXCursor_OMPTeamsDistributeParallelForDirective274

\brief OpenMP teams distribute parallel for directive.

CXCursor_OMPTargetTeamsDirective275

\brief OpenMP target teams directive.

CXCursor_OMPTargetTeamsDistributeDirective276

\brief OpenMP target teams distribute directive.

CXCursor_OMPTargetTeamsDistributeParallelForDirective277

\brief OpenMP target teams distribute parallel for directive.

CXCursor_OMPTargetTeamsDistributeParallelForSimdDirective278

\brief OpenMP target teams distribute parallel for simd directive.

CXCursor_OMPTargetTeamsDistributeSimdDirective279

\brief OpenMP target teams distribute simd directive.

CXCursor_LastStmtCXCursor_OMPTargetTeamsDistributeSimdDirective
CXCursor_TranslationUnit300

\brief Cursor that represents the translation unit itself.

The translation unit cursor exists primarily to act as the root cursor for traversing the contents of a translation unit.

CXCursor_FirstAttr400
CXCursor_UnexposedAttr400

\brief An attribute whose specific kind is not exposed via this interface.

CXCursor_IBActionAttr401
CXCursor_IBOutletAttr402
CXCursor_IBOutletCollectionAttr403
CXCursor_CXXFinalAttr404
CXCursor_CXXOverrideAttr405
CXCursor_AnnotateAttr406
CXCursor_AsmLabelAttr407
CXCursor_PackedAttr408
CXCursor_PureAttr409
CXCursor_ConstAttr410
CXCursor_NoDuplicateAttr411
CXCursor_CUDAConstantAttr412
CXCursor_CUDADeviceAttr413
CXCursor_CUDAGlobalAttr414
CXCursor_CUDAHostAttr415
CXCursor_CUDASharedAttr416
CXCursor_VisibilityAttr417
CXCursor_DLLExport418
CXCursor_DLLImport419
CXCursor_LastAttrCXCursor_DLLImport
CXCursor_PreprocessingDirective500
CXCursor_MacroDefinition501
CXCursor_MacroExpansion502
CXCursor_MacroInstantiationCXCursor_MacroExpansion
CXCursor_InclusionDirective503
CXCursor_FirstPreprocessingCXCursor_PreprocessingDirective
CXCursor_LastPreprocessingCXCursor_InclusionDirective
CXCursor_ModuleImportDecl600

\brief A module import declaration.

CXCursor_TypeAliasTemplateDecl601
CXCursor_StaticAssert602

\brief A static_assert or _Static_assert node

CXCursor_FriendDecl603

\brief a friend declaration.

CXCursor_FirstExtraDeclCXCursor_ModuleImportDecl
CXCursor_LastExtraDeclCXCursor_FriendDecl
CXCursor_OverloadCandidate700

\brief A code completion overload candidate.

Meta