CodeQL library for C/C++
codeql/cpp-all 0.13.1 (changelog, source)

Class MacroAccess

A macro access. For example:

#ifdef MACRO1     // this line contains a MacroAccess
  int x = MACRO2; // this line contains a MacroAccess

See also MacroInvocation, which represents only macro accesses that are expanded (such as in the second line of the example above).

Import path

import cpp

Direct supertypes

Indirect supertypes

Known direct subtypes



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


Gets the location of this macro access. For a nested access, where exists(this.getParentInvocation()), this yields a location either inside a #define directive or inside an argument to another macro.


Gets the location of the outermost macro access that triggered this macro access. This is equivalent to calling this.getOutermostMacroAccess().getActualLocation(). For example, the location of the invocation of C in P(C) will be the whole source range starting with P and ending with ).


Gets the macro that is being accessed.


Gets the name of the accessed macro.


Gets the outermost MacroAccess along the chain of getParentInvocation. If this has no parent, the result will be this itself.


Gets the parent macro invocation, if any. For example:


Gets a textual representation of this element.

Inherited predicates


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

from Element

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.

from Element

Gets the closest Element enclosing this one.

from Element

Gets the primary file where this element occurs.

from Element

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.

from Element

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

from ElementBase

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.

from Element

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

from Element

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.

from Element

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.

from Element