clang.cindex Namespace Reference

Classes
class	_CXString
class	_CXUnsavedFile
class	AccessSpecifier
class	BaseEnumeration
class	CachedProperty
class	CCRStructure
class	ClangObject
	CIndex Objects ##. More...
class	CodeCompletionResult
class	CodeCompletionResults
class	CompilationDatabase
class	CompilationDatabaseError
class	CompileCommand
class	CompileCommands
class	CompletionChunk
class	CompletionString
class	Config
class	Cursor
class	CursorKind
class	Diagnostic
class	File
class	FileInclusion
class	FixIt
class	Index
class	LibclangError
class	RefQualifierKind
class	SourceLocation
class	SourceRange
class	StorageClass
class	TemplateArgumentKind
class	Token
class	TokenGroup
class	TokenKind
class	TranslationUnit
class	TranslationUnitLoadError
	Exception Classes ###. More...
class	TranslationUnitSaveError
class	Type
class	TypeKind

Functions
def	register_function (lib, item, ignore_errors)
def	register_functions (lib, ignore_errors)
def	register_enumerations ()

Variables
	c_object_p = POINTER(c_void_p)
dictionary	callbacks = {}
dictionary	SpellingCache
dictionary	completionChunkKindMap
dictionary	availabilityKinds
list	functionList
	conf = Config()
list	__all__

Function Documentation

register_enumerations()

def clang.cindex.register_enumerations

(

)

Definition at line 3857 of file cindex.py.

register_function()

def clang.cindex.register_function	(		lib,
			item,
			ignore_errors
	)

Definition at line 3730 of file cindex.py.

register_functions()

def clang.cindex.register_functions	(		lib,
			ignore_errors
	)

Register function prototypes with a libclang library instance.

This must be called as part of library instantiation so Python knows how
to call out to the shared library.

Definition at line 3751 of file cindex.py.

Variable Documentation

__all__

list __all__

private

Initial value:

=  [
    'Config',
    'CodeCompletionResults',
    'CompilationDatabase',
    'CompileCommands',
    'CompileCommand',
    'CursorKind',
    'Cursor',
    'Diagnostic',
    'File',
    'FixIt',
    'Index',
    'SourceLocation',
    'SourceRange',
    'TokenKind',
    'Token',
    'TranslationUnitLoadError',
    'TranslationUnit',
    'TypeKind',
    'Type',
]

Definition at line 3864 of file cindex.py.

availabilityKinds

dictionary availabilityKinds

Initial value:

=  {
            0: CompletionChunk.Kind("Available"),
            1: CompletionChunk.Kind("Deprecated"),
            2: CompletionChunk.Kind("NotAvailable"),
            3: CompletionChunk.Kind("NotAccessible")}

Definition at line 2318 of file cindex.py.

c_object_p

c_object_p = POINTER(c_void_p)

Definition at line 74 of file cindex.py.

callbacks

dictionary callbacks = {}

Definition at line 76 of file cindex.py.

completionChunkKindMap

dictionary completionChunkKindMap

Initial value:

=  {
            0: CompletionChunk.Kind("Optional"),
            1: CompletionChunk.Kind("TypedText"),
            2: CompletionChunk.Kind("Text"),
            3: CompletionChunk.Kind("Placeholder"),
            4: CompletionChunk.Kind("Informative"),
            5: CompletionChunk.Kind("CurrentParameter"),
            6: CompletionChunk.Kind("LeftParen"),
            7: CompletionChunk.Kind("RightParen"),
            8: CompletionChunk.Kind("LeftBracket"),
            9: CompletionChunk.Kind("RightBracket"),
            10: CompletionChunk.Kind("LeftBrace"),
            11: CompletionChunk.Kind("RightBrace"),
            12: CompletionChunk.Kind("LeftAngle"),
            13: CompletionChunk.Kind("RightAngle"),
            14: CompletionChunk.Kind("Comma"),
            15: CompletionChunk.Kind("ResultType"),
            16: CompletionChunk.Kind("Colon"),
            17: CompletionChunk.Kind("SemiColon"),
            18: CompletionChunk.Kind("Equal"),
            19: CompletionChunk.Kind("HorizontalSpace"),
            20: CompletionChunk.Kind("VerticalSpace")}

Definition at line 2251 of file cindex.py.

conf

conf = Config()

Definition at line 3861 of file cindex.py.

functionList

list functionList

Definition at line 3032 of file cindex.py.

SpellingCache

dictionary SpellingCache

Initial value:

=  {
            # 0: CompletionChunk.Kind("Optional"),
            # 1: CompletionChunk.Kind("TypedText"),
            # 2: CompletionChunk.Kind("Text"),
            # 3: CompletionChunk.Kind("Placeholder"),
            # 4: CompletionChunk.Kind("Informative"),
            # 5 : CompletionChunk.Kind("CurrentParameter"),
            6: '(',   # CompletionChunk.Kind("LeftParen"),
            7: ')',   # CompletionChunk.Kind("RightParen"),
            8: '[',   # CompletionChunk.Kind("LeftBracket"),
            9: ']',   # CompletionChunk.Kind("RightBracket"),
            10: '{',  # CompletionChunk.Kind("LeftBrace"),
            11: '}',  # CompletionChunk.Kind("RightBrace"),
            12: '<',  # CompletionChunk.Kind("LeftAngle"),
            13: '>',  # CompletionChunk.Kind("RightAngle"),
            14: ', ', # CompletionChunk.Kind("Comma"),
            # 15: CompletionChunk.Kind("ResultType"),
            16: ':',  # CompletionChunk.Kind("Colon"),
            17: ';',  # CompletionChunk.Kind("SemiColon"),
            18: '=',  # CompletionChunk.Kind("Equal"),
            19: ' ',  # CompletionChunk.Kind("HorizontalSpace"),
            # 20: CompletionChunk.Kind("VerticalSpace")
}

Definition at line 2163 of file cindex.py.