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

Class VariableDeclarationEntry

A particular declaration or definition of a C/C++ variable. For example, in the following code there are six variable declaration entries - two each for a and d, and one each for b and c:

extern int a;
int a;

void myFunction(int b) {
  int c;
}

namespace N {
  extern int d;
  int d = 1;
}

Import path

import cpp

Direct supertypes

Indirect supertypes

Known direct subtypes

Predicates

getAPrimaryQlClass

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

getASpecifier

Gets a specifier associated with this declaration entry.

getDeclaration

Gets the declaration for which this is a declaration entry.

getLocation

Gets the primary location of this element.

getName

Gets the name, if any, used for the variable at this declaration or definition.

getType

Gets the type of the variable which is being declared or defined.

getVariable

Gets the variable which is being declared or defined.

isDefinition

Holds if this is a definition of a variable.

Inherited predicates

findRootCause

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

from 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.

from Element
getCanonicalName

Gets the name associated with the corresponding definition (where available), or the name declared by this entry otherwise.

from DeclarationEntry
getEnclosingElement

Gets the closest Element enclosing this one.

from Element
getFile

Gets the primary file where this element occurs.

from 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.

from Element
getPrimaryQlClasses

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

from ElementBase
getUnspecifiedType

Gets the type associated with this declaration entry after specifiers have been deeply stripped and typedefs have been resolved.

from DeclarationEntry
hasSpecifier

Holds if this declaration entry has a specifier with the given name.

from DeclarationEntry
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.

from Element
isFromTemplateInstantiation

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

from Element
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.

from Element
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.

from Element
toString

Gets a textual representation of this element.

from DeclarationEntry