Cursor_getArgument: Functions for operating on CXCursor objects

In omegahat/RClangSimple: R Interface to the clang parser's C API

Functions for operating on CXCursor objects

Description

This is a large collection of functions from the libclang API for working with CXCursor objects.

Usage

Cursor_getArgument(C, i)
Cursor_getBriefCommentText(C)
Cursor_getNumArguments(C)
Cursor_getParsedComment(C)
Cursor_getRawCommentText(C)
Cursor_getReceiverType(C)
Cursor_isBitField(C)
Cursor_isDynamicCall(C)
Cursor_isNull(cursor)
CXCursorSet_contains(cset, cursor)
CXCursorSet_insert(cset, cursor)
getCanonicalCursor(arg1)
getCursorAvailability(cursor)
getCursorExtent(x)
getCursorKind(cur)
getCursorLanguage(cur)
getCursorLexicalParent(cursor)
getCursorLinkage(cur)
getCursorLocation(arg1)
getCursorReferenced(arg1)
getCursorSemanticParent(cursor)
getCursorUSR(arg1)
getNullCursor()
getSpecializedCursorTemplate(C)
getTemplateCursorKind(C)
hashCursor(arg1)
isCursorDefinition(arg1)
getNumArguments(C)
getNumOverloadedDecls(cursor)
getOverloadedDecl(cursor, index)
getEnumConstantDeclValue(C)
getEnumDeclIntegerType(C)
getTypedefDeclUnderlyingType(C)
isDynamicCall(C)
getFieldDeclBitWidth(C)
getIncludedFile(cursor)
isStatic(C)
isVirtual(C)
getCursorTranslationUnit(cursor)

Arguments

C, cursor, cur, arg1, x	the CXCursor object on which to operate and query
i, index	an integer specifying which element to retrieve. This (probably) uses 0-based counting, i.e. the first argument is numbered 0.
cset	the cursor set object

Author(s)

Duncan Temple Lang

References

libclang http://clang.llvm.org/doxygen/group__CINDEX.html

See Also

clone

Examples

# Two C files treated as two translation units, but within the same clang Index.
# bob.c contains a call to bar() which is defined in bar.c.
# We get the cursor for that call to bar within bob.c and then
# get the declaration of bar in bar.c via getCursorReferenced().
#
idx = createIndex()
bob = createTU(system.file("exampleCode", "bob.c", package = "RCIndex"), idx = idx)
bar = createTU(system.file("exampleCode", "bar.c", package = "RCIndex"), idx = idx)
r = getRoutines(bob)

barCall = getChildren(r$foo)[[2]][[4]][[1]][[1]]
barCall$kind

cur = getCursorReferenced(barCall)
cur
cur$kind

omegahat/RClangSimple documentation built on Aug. 17, 2024, 10:23 a.m.