clang.c.index

Undocumented in source.

Public Imports

clang.c.CXErrorCode public import clang.c.CXErrorCode;

clang.c.CXString public import clang.c.CXString;

Members

Aliases

CINDEX_VERSION_STRINGIZE alias CINDEX_VERSION_STRINGIZE = CINDEX_VERSION_STRINGIZE_: Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
CXClientData alias CXClientData = void*: \brief Opaque pointer representing client data that will be passed through to various callbacks and visitors.
CXCompletionString alias CXCompletionString = void*: \brief A semantic string that describes a code-completion result.
CXCursorSet alias CXCursorSet = CXCursorSetImpl*: Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
CXCursorVisitor alias CXCursorVisitor = CXChildVisitResult function(CXCursor cursor, CXCursor parent, CXClientData client_data): \brief Visitor invoked for each cursor found by a traversal.
CXDiagnostic alias CXDiagnostic = void*: \brief A single diagnostic, containing the diagnostic's severity, location, text, source ranges, and fix-it hints.
CXDiagnosticSet alias CXDiagnosticSet = void*: \brief A group of CXDiagnostics.
CXEvalResult alias CXEvalResult = void*: \brief Evaluation result of a cursor
CXFieldVisitor alias CXFieldVisitor = CXVisitorResult function(CXCursor C, CXClientData client_data): \brief Visitor invoked for each field found by a traversal.
CXFile alias CXFile = void*: \brief A particular source file that is part of a translation unit.
CXIdxClientASTFile alias CXIdxClientASTFile = void*: \brief The client's data object that is associated with an AST file (PCH or module).
CXIdxClientContainer alias CXIdxClientContainer = void*: \brief The client's data object that is associated with a semantic container of entities.
CXIdxClientEntity alias CXIdxClientEntity = void*: \brief The client's data object that is associated with a semantic entity.
CXIdxClientFile alias CXIdxClientFile = void*: \brief The client's data object that is associated with a CXFile.
CXInclusionVisitor alias CXInclusionVisitor = void function(CXFile included_file, CXSourceLocation* inclusion_stack, uint include_len, CXClientData client_data): \brief Visitor invoked for each file in a translation unit (used with clang_getInclusions()).
CXIndex alias CXIndex = void*: \brief An "index" that consists of a set of translation units that would typically be linked together into an executable or library.
CXIndexAction alias CXIndexAction = void*: \brief An indexing action/session, to be applied to one or multiple translation units.
CXModule alias CXModule = void*: \defgroup CINDEX_MODULE Module introspection
CXRemapping alias CXRemapping = void*: \brief A remapping of original source files and their translated files.
CXTranslationUnit alias CXTranslationUnit = CXTranslationUnitImpl*: Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.

Enums

CXAvailabilityKind enum CXAvailabilityKind: \brief Describes the availability of a particular entity, which indicates whether the use of this entity will result in a warning or error due to it being deprecated or unavailable.
CXCallingConv enum CXCallingConv: \brief Describes the calling convention of a function type
CXChildVisitResult enum CXChildVisitResult: \brief Describes how the traversal of the children of a particular cursor should proceed after visiting a particular child cursor.
CXCodeComplete_Flags enum CXCodeComplete_Flags: \brief Flags that can be passed to \c clang_codeCompleteAt() to modify its behavior.
CXCompletionChunkKind enum CXCompletionChunkKind: \brief Describes a single piece of text within a code-completion string.
CXCompletionContext enum CXCompletionContext: \brief Bits that represent the context under which completion is occurring.
CXCursorKind enum CXCursorKind: \brief Describes the kind of entity that a cursor refers to.
CXCursor_ExceptionSpecificationKind enum CXCursor_ExceptionSpecificationKind: \brief Describes the exception specification of a cursor.
CXDiagnosticDisplayOptions enum CXDiagnosticDisplayOptions: \brief Options to control the display of diagnostics.
CXDiagnosticSeverity enum CXDiagnosticSeverity: \brief Describes the severity of a particular diagnostic.
CXEvalResultKind enum CXEvalResultKind: Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
CXGlobalOptFlags enum CXGlobalOptFlags: Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
CXIdxAttrKind enum CXIdxAttrKind: Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
CXIdxDeclInfoFlags enum CXIdxDeclInfoFlags: Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
CXIdxEntityCXXTemplateKind enum CXIdxEntityCXXTemplateKind: \brief Extra C++ template information for an entity. This can apply to: CXIdxEntity_Function CXIdxEntity_CXXClass CXIdxEntity_CXXStaticMethod CXIdxEntity_CXXInstanceMethod CXIdxEntity_CXXConstructor CXIdxEntity_CXXConversionFunction CXIdxEntity_CXXTypeAlias
CXIdxEntityKind enum CXIdxEntityKind: Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
CXIdxEntityLanguage enum CXIdxEntityLanguage: Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
CXIdxEntityRefKind enum CXIdxEntityRefKind: \brief Data for IndexerCallbacks#indexEntityReference.
CXIdxObjCContainerKind enum CXIdxObjCContainerKind: Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
CXIndexOptFlags enum CXIndexOptFlags: Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
CXLanguageKind enum CXLanguageKind: \brief Describe the "language" of the entity referred to by a cursor.
CXLinkageKind enum CXLinkageKind: \brief Describe the linkage of the entity referred to by a cursor.
CXLoadDiag_Error enum CXLoadDiag_Error: \brief Describes the kind of error that occurred (if any) in a call to \c clang_loadDiagnostics.
CXNameRefFlags enum CXNameRefFlags: Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
CXObjCDeclQualifierKind enum CXObjCDeclQualifierKind: \brief 'Qualifiers' written next to the return and parameter types in Objective-C method declarations.
CXObjCPropertyAttrKind enum CXObjCPropertyAttrKind: \brief Property attributes for a \c CXCursor_ObjCPropertyDecl.
CXRefQualifierKind enum CXRefQualifierKind: Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
CXReparse_Flags enum CXReparse_Flags: \brief Flags that control the reparsing of translation units.
CXResult enum CXResult: Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
CXSaveError enum CXSaveError: \brief Describes the kind of error that occurred (if any) in a call to \c clang_saveTranslationUnit().
CXSaveTranslationUnit_Flags enum CXSaveTranslationUnit_Flags: \brief Flags that control how translation units are saved.
CXTUResourceUsageKind enum CXTUResourceUsageKind: \brief Categorizes how memory is being used by a translation unit.
CXTemplateArgumentKind enum CXTemplateArgumentKind: \brief Describes the kind of a template argument.
CXTokenKind enum CXTokenKind: \brief Describes a kind of token.
CXTranslationUnit_Flags enum CXTranslationUnit_Flags: \brief Flags that control the creation of translation units.
CXTypeKind enum CXTypeKind: \defgroup CINDEX_TYPES Type information for CXCursors
CXTypeLayoutError enum CXTypeLayoutError: \brief List the possible error codes for \c clang_Type_getSizeOf, \c clang_Type_getAlignOf, \c clang_Type_getOffsetOf and \c clang_Cursor_getOffsetOf.
CXVisibilityKind enum CXVisibilityKind: Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
CXVisitorResult enum CXVisitorResult: \defgroup CINDEX_HIGH Higher level API functions
CX_CXXAccessSpecifier enum CX_CXXAccessSpecifier: \brief Represents the C++ access control level to a base class for a cursor with kind CX_CXXBaseSpecifier.
CX_StorageClass enum CX_StorageClass: \brief Represents the storage classes as declared in the source. CX_SC_Invalid was added for the case that the passed cursor in not a declaration.

Functions

CINDEX_VERSION_ENCODE auto CINDEX_VERSION_ENCODE(T0 major, T1 minor): Undocumented in source. Be warned that the author may not have intended to support it.
CINDEX_VERSION_STRINGIZE_ string CINDEX_VERSION_STRINGIZE_(T0 major, T1 minor): Undocumented in source. Be warned that the author may not have intended to support it.
clang_CXCursorSet_contains uint clang_CXCursorSet_contains(CXCursorSet cset, CXCursor cursor): * \brief Queries a CXCursorSet to see if it contains a specific CXCursor. * * \returns non-zero if the set contains the specified cursor.
clang_CXCursorSet_insert uint clang_CXCursorSet_insert(CXCursorSet cset, CXCursor cursor): * \brief Inserts a CXCursor into a CXCursorSet. * * \returns zero if the CXCursor was already in the set, and non-zero otherwise.
clang_CXIndex_getGlobalOptions uint clang_CXIndex_getGlobalOptions(CXIndex ): \brief Gets the general options associated with a CXIndex.
clang_CXIndex_setGlobalOptions void clang_CXIndex_setGlobalOptions(CXIndex , uint options): \brief Sets general options associated with a CXIndex.
clang_CXXConstructor_isConvertingConstructor uint clang_CXXConstructor_isConvertingConstructor(CXCursor C): \brief Determine if a C++ constructor is a converting constructor.
clang_CXXConstructor_isCopyConstructor uint clang_CXXConstructor_isCopyConstructor(CXCursor C): \brief Determine if a C++ constructor is a copy constructor.
clang_CXXConstructor_isDefaultConstructor uint clang_CXXConstructor_isDefaultConstructor(CXCursor C): \brief Determine if a C++ constructor is the default constructor.
clang_CXXConstructor_isMoveConstructor uint clang_CXXConstructor_isMoveConstructor(CXCursor C): \brief Determine if a C++ constructor is a move constructor.
clang_CXXField_isMutable uint clang_CXXField_isMutable(CXCursor C): \brief Determine if a C++ field is declared 'mutable'.
clang_CXXMethod_isConst uint clang_CXXMethod_isConst(CXCursor C): \brief Determine if a C++ member function or member function template is declared 'const'.
clang_CXXMethod_isDefaulted uint clang_CXXMethod_isDefaulted(CXCursor C): \brief Determine if a C++ method is declared '= default'.
clang_CXXMethod_isPureVirtual uint clang_CXXMethod_isPureVirtual(CXCursor C): \brief Determine if a C++ member function or member function template is pure virtual.
clang_CXXMethod_isStatic uint clang_CXXMethod_isStatic(CXCursor C): \brief Determine if a C++ member function or member function template is declared 'static'.
clang_CXXMethod_isVirtual uint clang_CXXMethod_isVirtual(CXCursor C): \brief Determine if a C++ member function or member function template is explicitly declared 'virtual' or if it overrides a virtual method from one of the base classes.
clang_Cursor_Evaluate CXEvalResult clang_Cursor_Evaluate(CXCursor C): \brief If cursor is a statement declaration tries to evaluate the statement and if its variable, tries to evaluate its initializer, into its corresponding type.
clang_Cursor_getArgument CXCursor clang_Cursor_getArgument(CXCursor C, uint i): \brief Retrieve the argument cursor of a function or method.
clang_Cursor_getBriefCommentText CXString clang_Cursor_getBriefCommentText(CXCursor C): \brief Given a cursor that represents a documentable entity (e.g., declaration), return the associated \\brief paragraph; otherwise return the first paragraph.
clang_Cursor_getCXXManglings CXStringSet* clang_Cursor_getCXXManglings(CXCursor ): \brief Retrieve the CXStrings representing the mangled symbols of the C++ constructor or destructor at the cursor.
clang_Cursor_getCommentRange CXSourceRange clang_Cursor_getCommentRange(CXCursor C): \brief Given a cursor that represents a declaration, return the associated comment's source range. The range may include multiple consecutive comments with whitespace in between.
clang_Cursor_getMangling CXString clang_Cursor_getMangling(CXCursor ): \brief Retrieve the CXString representing the mangled name of the cursor.
clang_Cursor_getModule CXModule clang_Cursor_getModule(CXCursor C): \brief Given a CXCursor_ModuleImportDecl cursor, return the associated module.
clang_Cursor_getNumArguments int clang_Cursor_getNumArguments(CXCursor C): \brief Retrieve the number of non-variadic arguments associated with a given cursor.
clang_Cursor_getNumTemplateArguments int clang_Cursor_getNumTemplateArguments(CXCursor C): \brief Returns the number of template args of a function decl representing a template specialization.
clang_Cursor_getObjCDeclQualifiers uint clang_Cursor_getObjCDeclQualifiers(CXCursor C): \brief Given a cursor that represents an Objective-C method or parameter declaration, return the associated Objective-C qualifiers for the return type or the parameter respectively. The bits are formed from CXObjCDeclQualifierKind.
clang_Cursor_getObjCPropertyAttributes uint clang_Cursor_getObjCPropertyAttributes(CXCursor C, uint reserved): \brief Given a cursor that represents a property declaration, return the associated property attributes. The bits are formed from \c CXObjCPropertyAttrKind.
clang_Cursor_getObjCSelectorIndex int clang_Cursor_getObjCSelectorIndex(CXCursor ): \brief If the cursor points to a selector identifier in an Objective-C method or message expression, this returns the selector index.
clang_Cursor_getOffsetOfField long clang_Cursor_getOffsetOfField(CXCursor C): \brief Return the offset of the field represented by the Cursor.
clang_Cursor_getRawCommentText CXString clang_Cursor_getRawCommentText(CXCursor C): \brief Given a cursor that represents a declaration, return the associated comment text, including comment markers.
clang_Cursor_getReceiverType CXType clang_Cursor_getReceiverType(CXCursor C): \brief Given a cursor pointing to an Objective-C message, returns the CXType of the receiver.
clang_Cursor_getSpellingNameRange CXSourceRange clang_Cursor_getSpellingNameRange(CXCursor , uint pieceIndex, uint options): \brief Retrieve a range for a piece that forms the cursors spelling name. Most of the times there is only one range for the complete spelling but for Objective-C methods and Objective-C message expressions, there are multiple pieces for each selector identifier.
clang_Cursor_getStorageClass CX_StorageClass clang_Cursor_getStorageClass(CXCursor ): \brief Returns the storage class for a function or variable declaration.
clang_Cursor_getTemplateArgumentKind CXTemplateArgumentKind clang_Cursor_getTemplateArgumentKind(CXCursor C, uint I): \brief Retrieve the kind of the I'th template argument of the CXCursor C.
clang_Cursor_getTemplateArgumentType CXType clang_Cursor_getTemplateArgumentType(CXCursor C, uint I): \brief Retrieve a CXType representing the type of a TemplateArgument of a function decl representing a template specialization.
clang_Cursor_getTemplateArgumentUnsignedValue ulong clang_Cursor_getTemplateArgumentUnsignedValue(CXCursor C, uint I): \brief Retrieve the value of an Integral TemplateArgument (of a function decl representing a template specialization) as an unsigned long long.
clang_Cursor_getTemplateArgumentValue long clang_Cursor_getTemplateArgumentValue(CXCursor C, uint I): \brief Retrieve the value of an Integral TemplateArgument (of a function decl representing a template specialization) as a signed long long.
clang_Cursor_getTranslationUnit CXTranslationUnit clang_Cursor_getTranslationUnit(CXCursor ): \brief Returns the translation unit that a cursor originated from.
clang_Cursor_hasAttrs uint clang_Cursor_hasAttrs(CXCursor C): \brief Determine whether the given cursor has any attributes.
clang_Cursor_isAnonymous uint clang_Cursor_isAnonymous(CXCursor C): \brief Determine whether the given cursor represents an anonymous record declaration.
clang_Cursor_isBitField uint clang_Cursor_isBitField(CXCursor C): \brief Returns non-zero if the cursor specifies a Record member that is a bitfield.
clang_Cursor_isDynamicCall int clang_Cursor_isDynamicCall(CXCursor C): \brief Given a cursor pointing to a C++ method call or an Objective-C message, returns non-zero if the method/message is "dynamic", meaning:
clang_Cursor_isFunctionInlined uint clang_Cursor_isFunctionInlined(CXCursor C): \brief Determine whether a CXCursor that is a function declaration, is an inline declaration.
clang_Cursor_isMacroBuiltin uint clang_Cursor_isMacroBuiltin(CXCursor C): \brief Determine whether a CXCursor that is a macro, is a builtin one.
clang_Cursor_isMacroFunctionLike uint clang_Cursor_isMacroFunctionLike(CXCursor C): \brief Determine whether a CXCursor that is a macro, is function like.
clang_Cursor_isNull int clang_Cursor_isNull(CXCursor cursor): \brief Returns non-zero if \p cursor is null.
clang_Cursor_isObjCOptional uint clang_Cursor_isObjCOptional(CXCursor C): \brief Given a cursor that represents an Objective-C method or property declaration, return non-zero if the declaration was affected by "@optional". Returns zero if the cursor is not such a declaration or it is "@required".
clang_Cursor_isVariadic uint clang_Cursor_isVariadic(CXCursor C): \brief Returns non-zero if the given cursor is a variadic function or method.
clang_EvalResult_dispose void clang_EvalResult_dispose(CXEvalResult E): \brief Disposes the created Eval memory.
clang_EvalResult_getAsDouble double clang_EvalResult_getAsDouble(CXEvalResult E): \brief Returns the evaluation result as double if the kind is double.
clang_EvalResult_getAsInt int clang_EvalResult_getAsInt(CXEvalResult E): \brief Returns the evaluation result as integer if the kind is Int.
clang_EvalResult_getAsLongLong long clang_EvalResult_getAsLongLong(CXEvalResult E): \brief Returns the evaluation result as a long long integer if the kind is Int. This prevents overflows that may happen if the result is returned with clang_EvalResult_getAsInt.
clang_EvalResult_getAsStr const(char)* clang_EvalResult_getAsStr(CXEvalResult E): \brief Returns the evaluation result as a constant string if the kind is other than Int or float. User must not free this pointer, instead call clang_EvalResult_dispose on the CXEvalResult returned by clang_Cursor_Evaluate.
clang_EvalResult_getAsUnsigned ulong clang_EvalResult_getAsUnsigned(CXEvalResult E): \brief Returns the evaluation result as an unsigned integer if the kind is Int and clang_EvalResult_isUnsignedInt is non-zero.
clang_EvalResult_getKind CXEvalResultKind clang_EvalResult_getKind(CXEvalResult E): \brief Returns the kind of the evaluated result.
clang_EvalResult_isUnsignedInt uint clang_EvalResult_isUnsignedInt(CXEvalResult E): \brief Returns a non-zero value if the kind is Int and the evaluation result resulted in an unsigned integer.
clang_File_isEqual int clang_File_isEqual(CXFile file1, CXFile file2): \brief Returns non-zero if the \c file1 and \c file2 point to the same file, or they are both NULL.
clang_IndexAction_create CXIndexAction clang_IndexAction_create(CXIndex CIdx): \brief An indexing action/session, to be applied to one or multiple translation units.
clang_IndexAction_dispose void clang_IndexAction_dispose(CXIndexAction ): \brief Destroy the given index action.
clang_Location_isFromMainFile int clang_Location_isFromMainFile(CXSourceLocation location): \brief Returns non-zero if the given source location is in the main file of the corresponding translation unit.
clang_Location_isInSystemHeader int clang_Location_isInSystemHeader(CXSourceLocation location): \brief Returns non-zero if the given source location is in a system header.
clang_Module_getASTFile CXFile clang_Module_getASTFile(CXModule Module): \param Module a module object.
clang_Module_getFullName CXString clang_Module_getFullName(CXModule Module): \param Module a module object.
clang_Module_getName CXString clang_Module_getName(CXModule Module): \param Module a module object.
clang_Module_getNumTopLevelHeaders uint clang_Module_getNumTopLevelHeaders(CXTranslationUnit , CXModule Module): \param Module a module object.
clang_Module_getParent CXModule clang_Module_getParent(CXModule Module): \param Module a module object.
clang_Module_getTopLevelHeader CXFile clang_Module_getTopLevelHeader(CXTranslationUnit , CXModule Module, uint Index): \param Module a module object.
clang_Module_isSystem int clang_Module_isSystem(CXModule Module): \param Module a module object.
clang_Range_isNull int clang_Range_isNull(CXSourceRange range): \brief Returns non-zero if \p range is null.
clang_Type_getAlignOf long clang_Type_getAlignOf(CXType T): \brief Return the alignment of a type in bytes as per C++expr.alignof standard.
clang_Type_getCXXRefQualifier CXRefQualifierKind clang_Type_getCXXRefQualifier(CXType T): \brief Retrieve the ref-qualifier kind of a function or method.
clang_Type_getClassType CXType clang_Type_getClassType(CXType T): \brief Return the class type of an member pointer type.
clang_Type_getNamedType CXType clang_Type_getNamedType(CXType T): \brief Retrieve the type named by the qualified-id.
clang_Type_getNumTemplateArguments int clang_Type_getNumTemplateArguments(CXType T): \brief Returns the number of template arguments for given template specialization, or -1 if type \c T is not a template specialization.
clang_Type_getObjCEncoding CXString clang_Type_getObjCEncoding(CXType type): Returns the Objective-C type encoding for the specified CXType.
clang_Type_getOffsetOf long clang_Type_getOffsetOf(CXType T, const(char)* S): \brief Return the offset of a field named S in a record of type T in bits as it would be returned by __offsetof__ as per C++11[18.2p4]
clang_Type_getSizeOf long clang_Type_getSizeOf(CXType T): \brief Return the size of a type in bytes as per C++expr.sizeof standard.
clang_Type_getTemplateArgumentAsType CXType clang_Type_getTemplateArgumentAsType(CXType T, uint i): \brief Returns the type template argument of a template class specialization at given index.
clang_Type_visitFields uint clang_Type_visitFields(CXType T, CXFieldVisitor visitor, CXClientData client_data): \brief Visit the fields of a particular type.
clang_annotateTokens void clang_annotateTokens(CXTranslationUnit TU, CXToken* Tokens, uint NumTokens, CXCursor* Cursors): \brief Annotate the given set of tokens by providing cursors for each token that can be mapped to a specific entity within the abstract syntax tree.
clang_codeCompleteAt CXCodeCompleteResults* clang_codeCompleteAt(CXTranslationUnit TU, const(char)* complete_filename, uint complete_line, uint complete_column, CXUnsavedFile* unsaved_files, uint num_unsaved_files, uint options): \brief Perform code completion at a given location in a translation unit.
clang_codeCompleteGetContainerKind CXCursorKind clang_codeCompleteGetContainerKind(CXCodeCompleteResults* Results, uint* IsIncomplete): \brief Returns the cursor kind for the container for the current code completion context. The container is only guaranteed to be set for contexts where a container exists (i.e. member accesses or Objective-C message sends); if there is not a container, this function will return CXCursor_InvalidCode.
clang_codeCompleteGetContainerUSR CXString clang_codeCompleteGetContainerUSR(CXCodeCompleteResults* Results): \brief Returns the USR for the container for the current code completion context. If there is not a container for the current context, this function will return the empty string.
clang_codeCompleteGetContexts ulong clang_codeCompleteGetContexts(CXCodeCompleteResults* Results): \brief Determines what completions are appropriate for the context the given code completion.
clang_codeCompleteGetDiagnostic CXDiagnostic clang_codeCompleteGetDiagnostic(CXCodeCompleteResults* Results, uint Index): \brief Retrieve a diagnostic associated with the given code completion.
clang_codeCompleteGetNumDiagnostics uint clang_codeCompleteGetNumDiagnostics(CXCodeCompleteResults* Results): \brief Determine the number of diagnostics produced prior to the location where code completion was performed.
clang_codeCompleteGetObjCSelector CXString clang_codeCompleteGetObjCSelector(CXCodeCompleteResults* Results): \brief Returns the currently-entered selector for an Objective-C message send, formatted like "initWithFoo:bar:". Only guaranteed to return a non-empty string for CXCompletionContext_ObjCInstanceMessage and CXCompletionContext_ObjCClassMessage.
clang_constructUSR_ObjCCategory CXString clang_constructUSR_ObjCCategory(const(char)* class_name, const(char)* category_name): \brief Construct a USR for a specified Objective-C category.
clang_constructUSR_ObjCClass CXString clang_constructUSR_ObjCClass(const(char)* class_name): \brief Construct a USR for a specified Objective-C class.
clang_constructUSR_ObjCIvar CXString clang_constructUSR_ObjCIvar(const(char)* name, CXString classUSR): \brief Construct a USR for a specified Objective-C instance variable and the USR for its containing class.
clang_constructUSR_ObjCMethod CXString clang_constructUSR_ObjCMethod(const(char)* name, uint isInstanceMethod, CXString classUSR): \brief Construct a USR for a specified Objective-C method and the USR for its containing class.
clang_constructUSR_ObjCProperty CXString clang_constructUSR_ObjCProperty(const(char)* property, CXString classUSR): \brief Construct a USR for a specified Objective-C property and the USR for its containing class.
clang_constructUSR_ObjCProtocol CXString clang_constructUSR_ObjCProtocol(const(char)* protocol_name): \brief Construct a USR for a specified Objective-C protocol.
clang_createCXCursorSet CXCursorSet clang_createCXCursorSet(): \brief Creates an empty CXCursorSet.
clang_createIndex CXIndex clang_createIndex(int excludeDeclarationsFromPCH, int displayDiagnostics): \brief Provides a shared context for creating translation units.
clang_createTranslationUnit CXTranslationUnit clang_createTranslationUnit(CXIndex CIdx, const(char)* ast_filename): \brief Same as \c clang_createTranslationUnit2, but returns the \c CXTranslationUnit instead of an error code. In case of an error this routine returns a \c NULL \c CXTranslationUnit, without further detailed error codes.
clang_createTranslationUnit2 CXErrorCode clang_createTranslationUnit2(CXIndex CIdx, const(char)* ast_filename, CXTranslationUnit* out_TU): \brief Create a translation unit from an AST file (\c -emit-ast).
clang_createTranslationUnitFromSourceFile CXTranslationUnit clang_createTranslationUnitFromSourceFile(CXIndex CIdx, const(char)* source_filename, int num_clang_command_line_args, const(char*)* clang_command_line_args, uint num_unsaved_files, CXUnsavedFile* unsaved_files): \brief Return the CXTranslationUnit for a given source file and the provided command line arguments one would pass to the compiler.
clang_defaultCodeCompleteOptions uint clang_defaultCodeCompleteOptions(): \brief Returns a default set of code-completion options that can be passed to\c clang_codeCompleteAt().
clang_defaultDiagnosticDisplayOptions uint clang_defaultDiagnosticDisplayOptions(): \brief Retrieve the set of display options most similar to the default behavior of the clang compiler.
clang_defaultEditingTranslationUnitOptions uint clang_defaultEditingTranslationUnitOptions(): \brief Returns the set of flags that is suitable for parsing a translation unit that is being edited.
clang_defaultReparseOptions uint clang_defaultReparseOptions(CXTranslationUnit TU): \brief Returns the set of flags that is suitable for reparsing a translation unit.
clang_defaultSaveOptions uint clang_defaultSaveOptions(CXTranslationUnit TU): \brief Returns the set of flags that is suitable for saving a translation unit.
clang_disposeCXCursorSet void clang_disposeCXCursorSet(CXCursorSet cset): \brief Disposes a CXCursorSet and releases its associated memory.
clang_disposeCXPlatformAvailability void clang_disposeCXPlatformAvailability(CXPlatformAvailability* availability): \brief Free the memory associated with a \c CXPlatformAvailability structure.
clang_disposeCXTUResourceUsage void clang_disposeCXTUResourceUsage(CXTUResourceUsage usage): Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
clang_disposeCodeCompleteResults void clang_disposeCodeCompleteResults(CXCodeCompleteResults* Results): \brief Free the given set of code-completion results.
clang_disposeDiagnostic void clang_disposeDiagnostic(CXDiagnostic Diagnostic): \brief Destroy a diagnostic.
clang_disposeDiagnosticSet void clang_disposeDiagnosticSet(CXDiagnosticSet Diags): \brief Release a CXDiagnosticSet and all of its contained diagnostics.
clang_disposeIndex void clang_disposeIndex(CXIndex index): \brief Destroy the given index.
clang_disposeOverriddenCursors void clang_disposeOverriddenCursors(CXCursor* overridden): \brief Free the set of overridden cursors returned by \c clang_getOverriddenCursors().
clang_disposeSourceRangeList void clang_disposeSourceRangeList(CXSourceRangeList* ranges): \brief Destroy the given \c CXSourceRangeList.
clang_disposeTokens void clang_disposeTokens(CXTranslationUnit TU, CXToken* Tokens, uint NumTokens): \brief Free the given set of tokens.
clang_disposeTranslationUnit void clang_disposeTranslationUnit(CXTranslationUnit ): \brief Destroy the specified CXTranslationUnit object.
clang_enableStackTraces void clang_enableStackTraces(): Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
clang_equalCursors uint clang_equalCursors(CXCursor , CXCursor ): \brief Determine whether two cursors are equivalent.
clang_equalLocations uint clang_equalLocations(CXSourceLocation loc1, CXSourceLocation loc2): \brief Determine whether two source locations, which must refer into the same translation unit, refer to exactly the same point in the source code.
clang_equalRanges uint clang_equalRanges(CXSourceRange range1, CXSourceRange range2): \brief Determine whether two ranges are equivalent.
clang_equalTypes uint clang_equalTypes(CXType A, CXType B): \brief Determine whether two CXTypes represent the same type.
clang_executeOnThread void clang_executeOnThread(void function(void*) fn, void* user_data, uint stack_size): Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
clang_findIncludesInFile CXResult clang_findIncludesInFile(CXTranslationUnit TU, CXFile file, CXCursorAndRangeVisitor visitor): \brief Find #import/#include directives in a specific file.
clang_findReferencesInFile CXResult clang_findReferencesInFile(CXCursor cursor, CXFile file, CXCursorAndRangeVisitor visitor): \brief Find references of a declaration in a specific file.
clang_formatDiagnostic CXString clang_formatDiagnostic(CXDiagnostic Diagnostic, uint Options): \brief Format the given diagnostic in a manner that is suitable for display.
clang_getAllSkippedRanges CXSourceRangeList* clang_getAllSkippedRanges(CXTranslationUnit tu): \brief Retrieve all ranges from all files that were skipped by the preprocessor.
clang_getArgType CXType clang_getArgType(CXType T, uint i): \brief Retrieve the type of a parameter of a function type.
clang_getArrayElementType CXType clang_getArrayElementType(CXType T): \brief Return the element type of an array type.
clang_getArraySize long clang_getArraySize(CXType T): \brief Return the array size of a constant array.
clang_getCXTUResourceUsage CXTUResourceUsage clang_getCXTUResourceUsage(CXTranslationUnit TU): \brief Return the memory usage of a translation unit. This object should be released with clang_disposeCXTUResourceUsage().
clang_getCXXAccessSpecifier CX_CXXAccessSpecifier clang_getCXXAccessSpecifier(CXCursor ): \brief Returns the access control level for the referenced object.
clang_getCanonicalCursor CXCursor clang_getCanonicalCursor(CXCursor ): \brief Retrieve the canonical cursor corresponding to the given cursor.
clang_getCanonicalType CXType clang_getCanonicalType(CXType T): \brief Return the canonical type for a CXType.
clang_getChildDiagnostics CXDiagnosticSet clang_getChildDiagnostics(CXDiagnostic D): \brief Retrieve the child diagnostics of a CXDiagnostic.
clang_getClangVersion CXString clang_getClangVersion(): \brief Return a version string, suitable for showing to a user, but not intended to be parsed (the format is not guaranteed to be stable).
clang_getCompletionAnnotation CXString clang_getCompletionAnnotation(CXCompletionString completion_string, uint annotation_number): \brief Retrieve the annotation associated with the given completion string.
clang_getCompletionAvailability CXAvailabilityKind clang_getCompletionAvailability(CXCompletionString completion_string): \brief Determine the availability of the entity that this code-completion string refers to.
clang_getCompletionBriefComment CXString clang_getCompletionBriefComment(CXCompletionString completion_string): \brief Retrieve the brief documentation comment attached to the declaration that corresponds to the given completion string.
clang_getCompletionChunkCompletionString CXCompletionString clang_getCompletionChunkCompletionString(CXCompletionString completion_string, uint chunk_number): \brief Retrieve the completion string associated with a particular chunk within a completion string.
clang_getCompletionChunkKind CXCompletionChunkKind clang_getCompletionChunkKind(CXCompletionString completion_string, uint chunk_number): \brief Determine the kind of a particular chunk within a completion string.
clang_getCompletionChunkText CXString clang_getCompletionChunkText(CXCompletionString completion_string, uint chunk_number): \brief Retrieve the text associated with a particular chunk within a completion string.
clang_getCompletionNumAnnotations uint clang_getCompletionNumAnnotations(CXCompletionString completion_string): \brief Retrieve the number of annotations associated with the given completion string.
clang_getCompletionParent CXString clang_getCompletionParent(CXCompletionString completion_string, CXCursorKind* kind): \brief Retrieve the parent context of the given completion string.
clang_getCompletionPriority uint clang_getCompletionPriority(CXCompletionString completion_string): \brief Determine the priority of this code completion.
clang_getCursor CXCursor clang_getCursor(CXTranslationUnit , CXSourceLocation ): \brief Map a source location to the cursor that describes the entity at that location in the source code.
clang_getCursorAvailability CXAvailabilityKind clang_getCursorAvailability(CXCursor cursor): \brief Determine the availability of the entity that this cursor refers to, taking the current target platform into account.
clang_getCursorCompletionString CXCompletionString clang_getCursorCompletionString(CXCursor cursor): \brief Retrieve a completion string for an arbitrary declaration or macro definition cursor.
clang_getCursorDefinition CXCursor clang_getCursorDefinition(CXCursor ): \brief For a cursor that is either a reference to or a declaration of some entity, retrieve a cursor that describes the definition of that entity.
clang_getCursorDisplayName CXString clang_getCursorDisplayName(CXCursor ): \brief Retrieve the display name for the entity referenced by this cursor.
clang_getCursorExtent CXSourceRange clang_getCursorExtent(CXCursor ): \brief Retrieve the physical extent of the source construct referenced by the given cursor.
clang_getCursorKind CXCursorKind clang_getCursorKind(CXCursor ): \brief Retrieve the kind of the given cursor.
clang_getCursorKindSpelling CXString clang_getCursorKindSpelling(CXCursorKind Kind): \defgroup CINDEX_DEBUG Debugging facilities
clang_getCursorLanguage CXLanguageKind clang_getCursorLanguage(CXCursor cursor): \brief Determine the "language" of the entity referred to by a given cursor.
clang_getCursorLexicalParent CXCursor clang_getCursorLexicalParent(CXCursor cursor): \brief Determine the lexical parent of the given cursor.
clang_getCursorLinkage CXLinkageKind clang_getCursorLinkage(CXCursor cursor): \brief Determine the linkage of the entity referred to by a given cursor.
clang_getCursorLocation CXSourceLocation clang_getCursorLocation(CXCursor ): \brief Retrieve the physical location of the source constructor referenced by the given cursor.
clang_getCursorPlatformAvailability int clang_getCursorPlatformAvailability(CXCursor cursor, int* always_deprecated, CXString* deprecated_message, int* always_unavailable, CXString* unavailable_message, CXPlatformAvailability* availability, int availability_size): \brief Determine the availability of the entity that this cursor refers to on any platforms for which availability information is known.
clang_getCursorReferenceNameRange CXSourceRange clang_getCursorReferenceNameRange(CXCursor C, uint NameFlags, uint PieceIndex): \brief Given a cursor that references something else, return the source range covering that reference.
clang_getCursorReferenced CXCursor clang_getCursorReferenced(CXCursor ): \brief For a cursor that is a reference, retrieve a cursor representing the entity that it references.
clang_getCursorResultType CXType clang_getCursorResultType(CXCursor C): \brief Retrieve the return type associated with a given cursor.
clang_getCursorSemanticParent CXCursor clang_getCursorSemanticParent(CXCursor cursor): \brief Determine the semantic parent of the given cursor.
clang_getCursorSpelling CXString clang_getCursorSpelling(CXCursor ): \brief Retrieve a name for the entity referenced by this cursor.
clang_getCursorType CXType clang_getCursorType(CXCursor C): \brief Retrieve the type of a CXCursor (if any).
clang_getCursorUSR CXString clang_getCursorUSR(CXCursor ): \brief Retrieve a Unified Symbol Resolution (USR) for the entity referenced by the given cursor.
clang_getCursorVisibility CXVisibilityKind clang_getCursorVisibility(CXCursor cursor): \brief Describe the visibility of the entity referred to by a cursor.
clang_getDeclObjCTypeEncoding CXString clang_getDeclObjCTypeEncoding(CXCursor C): Returns the Objective-C type encoding for the specified declaration.
clang_getDefinitionSpellingAndExtent void clang_getDefinitionSpellingAndExtent(CXCursor , const(char*)* startBuf, const(char*)* endBuf, uint* startLine, uint* startColumn, uint* endLine, uint* endColumn): Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
clang_getDiagnostic CXDiagnostic clang_getDiagnostic(CXTranslationUnit Unit, uint Index): \brief Retrieve a diagnostic associated with the given translation unit.
clang_getDiagnosticCategory uint clang_getDiagnosticCategory(CXDiagnostic ): \brief Retrieve the category number for this diagnostic.
clang_getDiagnosticCategoryName CXString clang_getDiagnosticCategoryName(uint Category): \brief Retrieve the name of a particular diagnostic category. This is now deprecated. Use clang_getDiagnosticCategoryText() instead.
clang_getDiagnosticCategoryText CXString clang_getDiagnosticCategoryText(CXDiagnostic ): \brief Retrieve the diagnostic category text for a given diagnostic.
clang_getDiagnosticFixIt CXString clang_getDiagnosticFixIt(CXDiagnostic Diagnostic, uint FixIt, CXSourceRange* ReplacementRange): \brief Retrieve the replacement information for a given fix-it.
clang_getDiagnosticInSet CXDiagnostic clang_getDiagnosticInSet(CXDiagnosticSet Diags, uint Index): \brief Retrieve a diagnostic associated with the given CXDiagnosticSet.
clang_getDiagnosticLocation CXSourceLocation clang_getDiagnosticLocation(CXDiagnostic ): \brief Retrieve the source location of the given diagnostic.
clang_getDiagnosticNumFixIts uint clang_getDiagnosticNumFixIts(CXDiagnostic Diagnostic): \brief Determine the number of fix-it hints associated with the given diagnostic.
clang_getDiagnosticNumRanges uint clang_getDiagnosticNumRanges(CXDiagnostic ): \brief Determine the number of source ranges associated with the given diagnostic.
clang_getDiagnosticOption CXString clang_getDiagnosticOption(CXDiagnostic Diag, CXString* Disable): \brief Retrieve the name of the command-line option that enabled this diagnostic.
clang_getDiagnosticRange CXSourceRange clang_getDiagnosticRange(CXDiagnostic Diagnostic, uint Range): \brief Retrieve a source range associated with the diagnostic.
clang_getDiagnosticSetFromTU CXDiagnosticSet clang_getDiagnosticSetFromTU(CXTranslationUnit Unit): \brief Retrieve the complete set of diagnostics associated with a translation unit.
clang_getDiagnosticSeverity CXDiagnosticSeverity clang_getDiagnosticSeverity(CXDiagnostic ): \brief Determine the severity of the given diagnostic.
clang_getDiagnosticSpelling CXString clang_getDiagnosticSpelling(CXDiagnostic ): \brief Retrieve the text of the given diagnostic.
clang_getElementType CXType clang_getElementType(CXType T): \brief Return the element type of an array, complex, or vector type.
clang_getEnumConstantDeclUnsignedValue ulong clang_getEnumConstantDeclUnsignedValue(CXCursor C): \brief Retrieve the integer value of an enum constant declaration as an unsigned long long.
clang_getEnumConstantDeclValue long clang_getEnumConstantDeclValue(CXCursor C): \brief Retrieve the integer value of an enum constant declaration as a signed long long.
clang_getEnumDeclIntegerType CXType clang_getEnumDeclIntegerType(CXCursor C): \brief Retrieve the integer type of an enum declaration.
clang_getExpansionLocation void clang_getExpansionLocation(CXSourceLocation location, CXFile* file, uint* line, uint* column, uint* offset): \brief Retrieve the file, line, column, and offset represented by the given source location.
clang_getFieldDeclBitWidth int clang_getFieldDeclBitWidth(CXCursor C): \brief Retrieve the bit width of a bit field declaration as an integer.
clang_getFile CXFile clang_getFile(CXTranslationUnit tu, const(char)* file_name): \brief Retrieve a file handle within the given translation unit.
clang_getFileLocation void clang_getFileLocation(CXSourceLocation location, CXFile* file, uint* line, uint* column, uint* offset): \brief Retrieve the file, line, column, and offset represented by the given source location.
clang_getFileName CXString clang_getFileName(CXFile SFile): \brief Retrieve the complete file and path name of the given file.
clang_getFileTime time_t clang_getFileTime(CXFile SFile): \brief Retrieve the last modification time of the given file.
clang_getFileUniqueID int clang_getFileUniqueID(CXFile file, CXFileUniqueID* outID): * \brief Retrieve the unique ID for the given \c file. * * \param file the file to get the ID for. * \param outID stores the returned CXFileUniqueID. * \returns If there was a failure getting the unique ID, returns non-zero, * otherwise returns 0.
clang_getFunctionTypeCallingConv CXCallingConv clang_getFunctionTypeCallingConv(CXType T): \brief Retrieve the calling convention associated with a function type.
clang_getIBOutletCollectionType CXType clang_getIBOutletCollectionType(CXCursor ): \brief For cursors representing an iboutletcollection attribute, this function returns the collection element type.
clang_getIncludedFile CXFile clang_getIncludedFile(CXCursor cursor): \brief Retrieve the file that is included by the given inclusion directive cursor.
clang_getInclusions void clang_getInclusions(CXTranslationUnit tu, CXInclusionVisitor visitor, CXClientData client_data): \brief Visit the set of preprocessor inclusions in a translation unit. The visitor function is called with the provided data for every included file. This does not include headers included by the PCH file (unless one is inspecting the inclusions in the PCH file itself).
clang_getInstantiationLocation void clang_getInstantiationLocation(CXSourceLocation location, CXFile* file, uint* line, uint* column, uint* offset): \brief Legacy API to retrieve the file, line, column, and offset represented by the given source location.
clang_getLocation CXSourceLocation clang_getLocation(CXTranslationUnit tu, CXFile file, uint line, uint column): \brief Retrieves the source location associated with a given file/line/column in a particular translation unit.
clang_getLocationForOffset CXSourceLocation clang_getLocationForOffset(CXTranslationUnit tu, CXFile file, uint offset): \brief Retrieves the source location associated with a given character offset in a particular translation unit.
clang_getModuleForFile CXModule clang_getModuleForFile(CXTranslationUnit , CXFile ): \brief Given a CXFile header file, return the module that contains it, if one exists.
clang_getNullCursor CXCursor clang_getNullCursor(): \brief Retrieve the NULL cursor, which represents no entity.
clang_getNullLocation CXSourceLocation clang_getNullLocation(): \brief Retrieve a NULL (invalid) source location.
clang_getNullRange CXSourceRange clang_getNullRange(): \brief Retrieve a NULL (invalid) source range.
clang_getNumArgTypes int clang_getNumArgTypes(CXType T): \brief Retrieve the number of non-variadic parameters associated with a function type.
clang_getNumCompletionChunks uint clang_getNumCompletionChunks(CXCompletionString completion_string): \brief Retrieve the number of chunks in the given code-completion string.
clang_getNumDiagnostics uint clang_getNumDiagnostics(CXTranslationUnit Unit): \brief Determine the number of diagnostics produced for the given translation unit.
clang_getNumDiagnosticsInSet uint clang_getNumDiagnosticsInSet(CXDiagnosticSet Diags): \brief Determine the number of diagnostics in a CXDiagnosticSet.
clang_getNumElements long clang_getNumElements(CXType T): \brief Return the number of elements of an array or vector type.
clang_getNumOverloadedDecls uint clang_getNumOverloadedDecls(CXCursor cursor): \brief Determine the number of overloaded declarations referenced by a \c CXCursor_OverloadedDeclRef cursor.
clang_getOverloadedDecl CXCursor clang_getOverloadedDecl(CXCursor cursor, uint index): \brief Retrieve a cursor for one of the overloaded declarations referenced by a \c CXCursor_OverloadedDeclRef cursor.
clang_getOverriddenCursors
void clang_getOverriddenCursors(CXCursor cursor, CXCursor** overridden, uint* num_overridden): \brief Determine the set of methods that are overridden by the given method.
clang_getPointeeType CXType clang_getPointeeType(CXType T): \brief For pointer types, returns the type of the pointee.
clang_getPresumedLocation void clang_getPresumedLocation(CXSourceLocation location, CXString* filename, uint* line, uint* column): \brief Retrieve the file, line, column, and offset represented by the given source location, as specified in a # line directive.
clang_getRange CXSourceRange clang_getRange(CXSourceLocation begin, CXSourceLocation end): \brief Retrieve a source range given the beginning and ending source locations.
clang_getRangeEnd CXSourceLocation clang_getRangeEnd(CXSourceRange range): \brief Retrieve a source location representing the last character within a source range.
clang_getRangeStart CXSourceLocation clang_getRangeStart(CXSourceRange range): \brief Retrieve a source location representing the first character within a source range.
clang_getRemappings CXRemapping clang_getRemappings(const(char)* path): \brief Retrieve a remapping.
clang_getRemappingsFromFileList CXRemapping clang_getRemappingsFromFileList(const(char*)* filePaths, uint numFiles): \brief Retrieve a remapping.
clang_getResultType CXType clang_getResultType(CXType T): \brief Retrieve the return type associated with a function type.
clang_getSkippedRanges CXSourceRangeList* clang_getSkippedRanges(CXTranslationUnit tu, CXFile file): \brief Retrieve all ranges that were skipped by the preprocessor.
clang_getSpecializedCursorTemplate CXCursor clang_getSpecializedCursorTemplate(CXCursor C): \brief Given a cursor that may represent a specialization or instantiation of a template, retrieve the cursor that represents the template that it specializes or from which it was instantiated.
clang_getSpellingLocation void clang_getSpellingLocation(CXSourceLocation location, CXFile* file, uint* line, uint* column, uint* offset): \brief Retrieve the file, line, column, and offset represented by the given source location.
clang_getTUResourceUsageName const(char)* clang_getTUResourceUsageName(CXTUResourceUsageKind kind): \brief Returns the human-readable null-terminated C string that represents the name of the memory category. This string should never be freed.
clang_getTemplateCursorKind CXCursorKind clang_getTemplateCursorKind(CXCursor C): \brief Given a cursor that represents a template, determine the cursor kind of the specializations would be generated by instantiating the template.
clang_getTokenExtent CXSourceRange clang_getTokenExtent(CXTranslationUnit , CXToken ): \brief Retrieve a source range that covers the given token.
clang_getTokenKind CXTokenKind clang_getTokenKind(CXToken ): \brief Determine the kind of the given token.
clang_getTokenLocation CXSourceLocation clang_getTokenLocation(CXTranslationUnit , CXToken ): \brief Retrieve the source location of the given token.
clang_getTokenSpelling CXString clang_getTokenSpelling(CXTranslationUnit , CXToken ): \brief Determine the spelling of the given token.
clang_getTranslationUnitCursor CXCursor clang_getTranslationUnitCursor(CXTranslationUnit ): \brief Retrieve the cursor that represents the given translation unit.
clang_getTranslationUnitSpelling CXString clang_getTranslationUnitSpelling(CXTranslationUnit CTUnit): \brief Get the original translation unit source file name.
clang_getTypeDeclaration CXCursor clang_getTypeDeclaration(CXType T): \brief Return the cursor for the declaration of the given type.
clang_getTypeKindSpelling CXString clang_getTypeKindSpelling(CXTypeKind K): \brief Retrieve the spelling of a given CXTypeKind.
clang_getTypeSpelling CXString clang_getTypeSpelling(CXType CT): \brief Pretty-print the underlying type using the rules of the language of the translation unit from which it came.
clang_getTypedefDeclUnderlyingType CXType clang_getTypedefDeclUnderlyingType(CXCursor C): \brief Retrieve the underlying type of a typedef declaration.
clang_hashCursor uint clang_hashCursor(CXCursor ): \brief Compute a hash value for the given cursor.
clang_indexLoc_getCXSourceLocation CXSourceLocation clang_indexLoc_getCXSourceLocation(CXIdxLoc loc): \brief Retrieve the CXSourceLocation represented by the given CXIdxLoc.
clang_indexLoc_getFileLocation void clang_indexLoc_getFileLocation(CXIdxLoc loc, CXIdxClientFile* indexFile, CXFile* file, uint* line, uint* column, uint* offset): \brief Retrieve the CXIdxFile, file, line, column, and offset represented by the given CXIdxLoc.
clang_indexSourceFile int clang_indexSourceFile(CXIndexAction , CXClientData client_data, IndexerCallbacks* index_callbacks, uint index_callbacks_size, uint index_options, const(char)* source_filename, const(char*)* command_line_args, int num_command_line_args, CXUnsavedFile* unsaved_files, uint num_unsaved_files, CXTranslationUnit* out_TU, uint TU_options): \brief Index the given source file and the translation unit corresponding to that file via callbacks implemented through #IndexerCallbacks.
clang_indexSourceFileFullArgv int clang_indexSourceFileFullArgv(CXIndexAction , CXClientData client_data, IndexerCallbacks* index_callbacks, uint index_callbacks_size, uint index_options, const(char)* source_filename, const(char*)* command_line_args, int num_command_line_args, CXUnsavedFile* unsaved_files, uint num_unsaved_files, CXTranslationUnit* out_TU, uint TU_options): \brief Same as clang_indexSourceFile but requires a full command line for \c command_line_args including argv[0]. This is useful if the standard library paths are relative to the binary.
clang_indexTranslationUnit int clang_indexTranslationUnit(CXIndexAction , CXClientData client_data, IndexerCallbacks* index_callbacks, uint index_callbacks_size, uint index_options, CXTranslationUnit ): \brief Index the given translation unit via callbacks implemented through #IndexerCallbacks.
clang_index_getCXXClassDeclInfo const(CXIdxCXXClassDeclInfo)* clang_index_getCXXClassDeclInfo(const(CXIdxDeclInfo)* ): Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
clang_index_getClientContainer CXIdxClientContainer clang_index_getClientContainer(const(CXIdxContainerInfo)* ): \brief For retrieving a custom CXIdxClientContainer attached to a container.
clang_index_getClientEntity CXIdxClientEntity clang_index_getClientEntity(const(CXIdxEntityInfo)* ): \brief For retrieving a custom CXIdxClientEntity attached to an entity.
clang_index_getIBOutletCollectionAttrInfo const(CXIdxIBOutletCollectionAttrInfo)* clang_index_getIBOutletCollectionAttrInfo(const(CXIdxAttrInfo)* ): Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
clang_index_getObjCCategoryDeclInfo const(CXIdxObjCCategoryDeclInfo)* clang_index_getObjCCategoryDeclInfo(const(CXIdxDeclInfo)* ): Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
clang_index_getObjCContainerDeclInfo const(CXIdxObjCContainerDeclInfo)* clang_index_getObjCContainerDeclInfo(const(CXIdxDeclInfo)* ): Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
clang_index_getObjCInterfaceDeclInfo const(CXIdxObjCInterfaceDeclInfo)* clang_index_getObjCInterfaceDeclInfo(const(CXIdxDeclInfo)* ): Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
clang_index_getObjCPropertyDeclInfo const(CXIdxObjCPropertyDeclInfo)* clang_index_getObjCPropertyDeclInfo(const(CXIdxDeclInfo)* ): Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
clang_index_getObjCProtocolRefListInfo const(CXIdxObjCProtocolRefListInfo)* clang_index_getObjCProtocolRefListInfo(const(CXIdxDeclInfo)* ): Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
clang_index_isEntityObjCContainerKind int clang_index_isEntityObjCContainerKind(CXIdxEntityKind ): Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
clang_index_setClientContainer void clang_index_setClientContainer(const(CXIdxContainerInfo)* , CXIdxClientContainer ): \brief For setting a custom CXIdxClientContainer attached to a container.
clang_index_setClientEntity void clang_index_setClientEntity(const(CXIdxEntityInfo)* , CXIdxClientEntity ): \brief For setting a custom CXIdxClientEntity attached to an entity.
clang_isAttribute uint clang_isAttribute(CXCursorKind ): \brief Determine whether the given cursor kind represents an attribute.
clang_isConstQualifiedType uint clang_isConstQualifiedType(CXType T): \brief Determine whether a CXType has the "const" qualifier set, without looking through typedefs that may have added "const" at a different level.
clang_isCursorDefinition uint clang_isCursorDefinition(CXCursor ): \brief Determine whether the declaration pointed to by this cursor is also a definition of that entity.
clang_isDeclaration uint clang_isDeclaration(CXCursorKind ): \brief Determine whether the given cursor kind represents a declaration.
clang_isExpression uint clang_isExpression(CXCursorKind ): \brief Determine whether the given cursor kind represents an expression.
clang_isFileMultipleIncludeGuarded uint clang_isFileMultipleIncludeGuarded(CXTranslationUnit tu, CXFile file): \brief Determine whether the given header is guarded against multiple inclusions, either with the conventional \#ifndef/\#define/\#endif macro guards or with \#pragma once.
clang_isFunctionTypeVariadic uint clang_isFunctionTypeVariadic(CXType T): \brief Return 1 if the CXType is a variadic function type, and 0 otherwise.
clang_isInvalid uint clang_isInvalid(CXCursorKind ): \brief Determine whether the given cursor kind represents an invalid cursor.
clang_isPODType uint clang_isPODType(CXType T): \brief Return 1 if the CXType is a POD (plain old data) type, and 0 otherwise.
clang_isPreprocessing uint clang_isPreprocessing(CXCursorKind ): \brief Determine whether the given cursor represents a preprocessing element, such as a preprocessor directive or macro instantiation.
clang_isReference uint clang_isReference(CXCursorKind ): \brief Determine whether the given cursor kind represents a simple reference.
clang_isRestrictQualifiedType uint clang_isRestrictQualifiedType(CXType T): \brief Determine whether a CXType has the "restrict" qualifier set, without looking through typedefs that may have added "restrict" at a different level.
clang_isStatement uint clang_isStatement(CXCursorKind ): \brief Determine whether the given cursor kind represents a statement.
clang_isTranslationUnit uint clang_isTranslationUnit(CXCursorKind ): \brief Determine whether the given cursor kind represents a translation unit.
clang_isUnexposed uint clang_isUnexposed(CXCursorKind ): \brief Determine whether the given cursor represents a currently unexposed piece of the AST (e.g., CXCursor_UnexposedStmt).
clang_isVirtualBase uint clang_isVirtualBase(CXCursor ): \brief Returns 1 if the base class specified by the cursor with kind CX_CXXBaseSpecifier is virtual.
clang_isVolatileQualifiedType uint clang_isVolatileQualifiedType(CXType T): \brief Determine whether a CXType has the "volatile" qualifier set, without looking through typedefs that may have added "volatile" at a different level.
clang_loadDiagnostics CXDiagnosticSet clang_loadDiagnostics(const(char)* file, CXLoadDiag_Error* error, CXString* errorString): \brief Deserialize a set of diagnostics from a Clang diagnostics bitcode file.
clang_parseTranslationUnit CXTranslationUnit clang_parseTranslationUnit(CXIndex CIdx, const(char)* source_filename, const(char*)* command_line_args, int num_command_line_args, CXUnsavedFile* unsaved_files, uint num_unsaved_files, uint options): \brief Same as \c clang_parseTranslationUnit2, but returns the \c CXTranslationUnit instead of an error code. In case of an error this routine returns a \c NULL \c CXTranslationUnit, without further detailed error codes.
clang_parseTranslationUnit2 CXErrorCode clang_parseTranslationUnit2(CXIndex CIdx, const(char)* source_filename, const(char*)* command_line_args, int num_command_line_args, CXUnsavedFile* unsaved_files, uint num_unsaved_files, uint options, CXTranslationUnit* out_TU): \brief Parse the given source file and the translation unit corresponding to that file.
clang_parseTranslationUnit2FullArgv CXErrorCode clang_parseTranslationUnit2FullArgv(CXIndex CIdx, const(char)* source_filename, const(char*)* command_line_args, int num_command_line_args, CXUnsavedFile* unsaved_files, uint num_unsaved_files, uint options, CXTranslationUnit* out_TU): \brief Same as clang_parseTranslationUnit2 but requires a full command line for \c command_line_args including argv[0]. This is useful if the standard library paths are relative to the binary.
clang_remap_dispose void clang_remap_dispose(CXRemapping ): \brief Dispose the remapping.
clang_remap_getFilenames void clang_remap_getFilenames(CXRemapping , uint index, CXString* original, CXString* transformed): \brief Get the original and the associated filename from the remapping.
clang_remap_getNumFiles uint clang_remap_getNumFiles(CXRemapping ): \brief Determine the number of remappings.
clang_reparseTranslationUnit int clang_reparseTranslationUnit(CXTranslationUnit TU, uint num_unsaved_files, CXUnsavedFile* unsaved_files, uint options): \brief Reparse the source files that produced this translation unit.
clang_saveTranslationUnit int clang_saveTranslationUnit(CXTranslationUnit TU, const(char)* FileName, uint options): \brief Saves a translation unit into a serialized representation of that translation unit on disk.
clang_sortCodeCompletionResults void clang_sortCodeCompletionResults(CXCompletionResult* Results, uint NumResults): \brief Sort the code-completion results in case-insensitive alphabetical order.
clang_toggleCrashRecovery void clang_toggleCrashRecovery(uint isEnabled): \brief Enable/disable crash recovery.
clang_tokenize
void clang_tokenize(CXTranslationUnit TU, CXSourceRange Range, CXToken** Tokens, uint* NumTokens): \brief Tokenize the source code described by the given range into raw lexical tokens.
clang_visitChildren uint clang_visitChildren(CXCursor parent, CXCursorVisitor visitor, CXClientData client_data): \brief Visit the children of a particular cursor.

Manifest constants

CINDEX_VERSION enum CINDEX_VERSION;: Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
CINDEX_VERSION_MAJOR enum CINDEX_VERSION_MAJOR;: \brief The version constants for the libclang API. CINDEX_VERSION_MINOR should increase when there are API additions. CINDEX_VERSION_MAJOR is intended for "major" source/ABI breaking changes.
CINDEX_VERSION_MINOR enum CINDEX_VERSION_MINOR;: Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
CINDEX_VERSION_STRING enum CINDEX_VERSION_STRING;: Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
CXTUResourceUsage_AST enum CXTUResourceUsage_AST;: Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
CXTUResourceUsage_AST_SideTables enum CXTUResourceUsage_AST_SideTables;: Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
CXTUResourceUsage_ExternalASTSource_Membuffer_MMap enum CXTUResourceUsage_ExternalASTSource_Membuffer_MMap;: Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
CXTUResourceUsage_ExternalASTSource_Membuffer_Malloc enum CXTUResourceUsage_ExternalASTSource_Membuffer_Malloc;: Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
CXTUResourceUsage_First enum CXTUResourceUsage_First;: Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
CXTUResourceUsage_GlobalCompletionResults enum CXTUResourceUsage_GlobalCompletionResults;: Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
CXTUResourceUsage_Identifiers enum CXTUResourceUsage_Identifiers;: Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
CXTUResourceUsage_Last enum CXTUResourceUsage_Last;: Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
CXTUResourceUsage_MEMORY_IN_BYTES_BEGIN enum CXTUResourceUsage_MEMORY_IN_BYTES_BEGIN;: Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
CXTUResourceUsage_MEMORY_IN_BYTES_END enum CXTUResourceUsage_MEMORY_IN_BYTES_END;: Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
CXTUResourceUsage_PreprocessingRecord enum CXTUResourceUsage_PreprocessingRecord;: Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
CXTUResourceUsage_Preprocessor enum CXTUResourceUsage_Preprocessor;: Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
CXTUResourceUsage_Preprocessor_HeaderSearch enum CXTUResourceUsage_Preprocessor_HeaderSearch;: Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
CXTUResourceUsage_Selectors enum CXTUResourceUsage_Selectors;: Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
CXTUResourceUsage_SourceManagerContentCache enum CXTUResourceUsage_SourceManagerContentCache;: Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
CXTUResourceUsage_SourceManager_DataStructures enum CXTUResourceUsage_SourceManager_DataStructures;: Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
CXTUResourceUsage_SourceManager_Membuffer_MMap enum CXTUResourceUsage_SourceManager_Membuffer_MMap;: Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
CXTUResourceUsage_SourceManager_Membuffer_Malloc enum CXTUResourceUsage_SourceManager_Membuffer_Malloc;: Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.

Mixins

__anonymous mixin EnumC!CXTypeLayoutError: Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
__anonymous mixin EnumC!CXLanguageKind: Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
__anonymous mixin EnumC!CXVisibilityKind: Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
__anonymous mixin EnumC!CXRefQualifierKind: Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
__anonymous mixin EnumC!CXCodeComplete_Flags: Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
__anonymous mixin EnumC!CXTokenKind: Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
__anonymous mixin EnumC!CXCompletionContext: Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
__anonymous mixin EnumC!CXLinkageKind: Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
__anonymous mixin EnumC!CXDiagnosticDisplayOptions: Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
__anonymous mixin EnumC!CXTypeKind: Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
__anonymous mixin EnumC!CXCallingConv: Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
__anonymous mixin EnumC!CXNameRefFlags: Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
__anonymous mixin EnumC!CXLoadDiag_Error: Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
__anonymous mixin EnumC!CXTemplateArgumentKind: Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
__anonymous mixin EnumC!CXTranslationUnit_Flags: Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
__anonymous mixin EnumC!CXDiagnosticSeverity: Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
__anonymous mixin EnumC!CXEvalResultKind: Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
__anonymous mixin EnumC!CXSaveTranslationUnit_Flags: Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
__anonymous mixin EnumC!CXSaveError: Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
__anonymous mixin EnumC!CXReparse_Flags: Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
__anonymous mixin EnumC!CXVisitorResult: Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
__anonymous mixin EnumC!CXResult: Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
__anonymous mixin EnumC!CXIdxEntityKind: Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
__anonymous mixin EnumC!CXIdxEntityLanguage: Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
__anonymous mixin EnumC!CXIdxEntityCXXTemplateKind: Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
__anonymous mixin EnumC!CXGlobalOptFlags: Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
__anonymous mixin EnumC!CXIdxAttrKind: Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
__anonymous mixin EnumC!CXCursor_ExceptionSpecificationKind: Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
__anonymous mixin EnumC!CXIdxDeclInfoFlags: Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
__anonymous mixin EnumC!CXIdxObjCContainerKind: Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
__anonymous mixin EnumC!CXAvailabilityKind: Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
__anonymous mixin EnumC!CXIdxEntityRefKind: Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
__anonymous mixin EnumC!CXObjCDeclQualifierKind: Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
__anonymous mixin EnumC!CXObjCPropertyAttrKind: Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
__anonymous mixin EnumC!CXCursorKind: Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
__anonymous mixin EnumC!CXIndexOptFlags: Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
__anonymous mixin EnumC!CX_CXXAccessSpecifier: Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
__anonymous mixin EnumC!CX_StorageClass: Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
__anonymous mixin EnumC!CXChildVisitResult: Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
__anonymous mixin EnumC!CXCompletionChunkKind: Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.

Structs

CXCodeCompleteResults struct CXCodeCompleteResults: \brief Contains the results of code-completion.
CXCompletionResult struct CXCompletionResult: \brief A single result of code completion.
CXCursor struct CXCursor: \brief A cursor representing some element in the abstract syntax tree for a translation unit.
CXCursorAndRangeVisitor struct CXCursorAndRangeVisitor: Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
CXCursorSetImpl struct CXCursorSetImpl: \brief A fast container representing a set of CXCursors.
CXFileUniqueID struct CXFileUniqueID: \brief Uniquely identifies a CXFile, that refers to the same underlying file, across an indexing session.
CXIdxAttrInfo struct CXIdxAttrInfo: Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
CXIdxBaseClassInfo struct CXIdxBaseClassInfo: Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
CXIdxCXXClassDeclInfo struct CXIdxCXXClassDeclInfo: Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
CXIdxContainerInfo struct CXIdxContainerInfo: Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
CXIdxDeclInfo struct CXIdxDeclInfo: Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
CXIdxEntityInfo struct CXIdxEntityInfo: Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
CXIdxEntityRefInfo struct CXIdxEntityRefInfo: \brief Data for IndexerCallbacks#indexEntityReference.
CXIdxIBOutletCollectionAttrInfo struct CXIdxIBOutletCollectionAttrInfo: Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
CXIdxImportedASTFileInfo struct CXIdxImportedASTFileInfo: \brief Data for IndexerCallbacks#importedASTFile.
CXIdxIncludedFileInfo struct CXIdxIncludedFileInfo: \brief Data for ppIncludedFile callback.
CXIdxLoc struct CXIdxLoc: \brief Source location passed to index callbacks.
CXIdxObjCCategoryDeclInfo struct CXIdxObjCCategoryDeclInfo: Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
CXIdxObjCContainerDeclInfo struct CXIdxObjCContainerDeclInfo: Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
CXIdxObjCInterfaceDeclInfo struct CXIdxObjCInterfaceDeclInfo: Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
CXIdxObjCPropertyDeclInfo struct CXIdxObjCPropertyDeclInfo: Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
CXIdxObjCProtocolRefInfo struct CXIdxObjCProtocolRefInfo: Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
CXIdxObjCProtocolRefListInfo struct CXIdxObjCProtocolRefListInfo: Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
CXPlatformAvailability struct CXPlatformAvailability: Describes the availability of a given entity on a particular platform, e.g., a particular class might only be available on Mac OS 10.7 or newer.
CXSourceLocation struct CXSourceLocation: \brief Identifies a specific source location within a translation unit.
CXSourceRange struct CXSourceRange: \brief Identifies a half-open character range in the source code.
CXSourceRangeList struct CXSourceRangeList: \brief Identifies an array of ranges.
CXTUResourceUsage struct CXTUResourceUsage: \brief The memory usage of a CXTranslationUnit, broken into categories.
CXTUResourceUsageEntry struct CXTUResourceUsageEntry: Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
CXToken struct CXToken: \brief Describes a single preprocessing token.
CXTranslationUnitImpl struct CXTranslationUnitImpl: \brief A single translation unit, which resides in an index.
CXType struct CXType: \brief The type of an element in the abstract syntax tree.
CXUnsavedFile struct CXUnsavedFile: \brief Provides the contents of a file that has not yet been saved to disk.
CXVersion struct CXVersion: \brief Describes a version number of the form major.minor.subminor.
IndexerCallbacks struct IndexerCallbacks: \brief A group of callbacks used by #clang_indexSourceFile and #clang_indexTranslationUnit.

clang.c.index

Public Imports

Members

Aliases

Enums

Functions

Manifest constants

Mixins

Structs

Meta

Source