CodeQL library for C/C++
codeql/cpp-all 0.12.8-dev (changelog, source)
Search

Class Element

A C/C++ element. This class is the base class for all C/C++ elements, such as functions, classes, expressions, and so on.

Import path

import cpp

Direct supertypes

Indirect supertypes

Known direct subtypes

Predicates

findRootCause

Gets the source of this element: either itself or a macro that expanded to this element.

fromSource

Holds if this element may be from source. This predicate holds for all elements, except for those in the dummy file, whose name is the empty string. The dummy file contains declarations that are built directly into the compiler.

getEnclosingElement

Gets the closest Element enclosing this one.

getFile

Gets the primary file where this element occurs.

getLocation

Gets the primary location of this element.

getParentScope

Gets the parent scope of this Element, if any. A scope is a Type (Class / Enum), a Namespace, a BlockStmt, a Function, or certain kinds of Statement.

isAffectedByMacro

Holds if this element is affected in any way by a macro. All elements that are totally or partially generated by a macro are included, so this is a super-set of isInMacroExpansion.

isFromTemplateInstantiation

Holds if this Element is a part of a template instantiation (but not the template itself).

isFromUninstantiatedTemplate

Holds if this Element is part of a template template (not if it is part of an instantiation of template). This means it is represented in the database purely as syntax and without guarantees on the presence or correctness of type-based operations such as implicit conversions.

isInMacroExpansion

Holds if this element comes from a macro expansion. Only elements that are entirely generated by a macro are included - for elements that partially come from a macro, see isAffectedByMacro.

Inherited predicates

getAPrimaryQlClass

Gets the name of a primary CodeQL class to which this element belongs.

from ElementBase
getPrimaryQlClasses

Gets a comma-separated list of the names of the primary CodeQL classes to which this element belongs.

from ElementBase
toString

Gets a textual representation of this element.

from ElementBase