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

Class ParameterDeclarationEntry

A parameter as described within a particular declaration or definition of a C/C++ function. For example the declaration of a in the following code:

void myFunction(int a) {
  int b;
}

Import path

import cpp

Direct supertypes

Indirect supertypes

Predicates

getAPrimaryQlClass

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

getFunctionDeclarationEntry

Gets the function declaration or definition which this parameter description is part of.

getIndex

Gets the zero-based index of this parameter.

getTypedName

Gets the name of this ParameterDeclarationEntry including it’s type.

toString

Gets a textual representation of this element.

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
getASpecifier

Gets a specifier associated with this declaration entry.

from VariableDeclarationEntry
getCanonicalName

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

from DeclarationEntry
getDeclaration

Gets the declaration for which this is a declaration entry.

from VariableDeclarationEntry
getEnclosingElement

Gets the closest Element enclosing this one.

from Element
getFile

Gets the primary file where this element occurs.

from Element
getLocation

Gets the primary location of this element.

from VariableDeclarationEntry
getName

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

from VariableDeclarationEntry
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
getType

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

from VariableDeclarationEntry
getUnspecifiedType

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

from DeclarationEntry
getVariable

Gets the variable which is being declared or defined.

from VariableDeclarationEntry
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
isDefinition

Holds if this is a definition of a variable.

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

Charpred