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

Class ClassDerivation

A class derivation, for example the public B in the following code:

class D : public B {
  ...
};

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 (for example public) applied to the derivation.

getBaseClass

Gets the class/struct from which we are actually deriving, resolving a typedef if necessary. For example, the base class in the following code would be B:

getBaseType

Gets the type from which we are deriving, without resolving any typedef. For example, the base type in the following code would be T:

getByteOffset

Gets the byte offset of the base class subobject relative to the start of the derived class object. Only holds for non-virtual bases, since the offset of a virtual base class is not a constant. Does not hold if the derived class is an uninstantiated template. See Class.getVirtualBaseClassByteOffset for offsets of virtual base classes.

getDerivedClass

Gets the class/struct that is doing the deriving. For example, the derived class in the following code would be D:

getIndex

Gets the index of the derivation in the derivation list for the derived class/struct (indexed from 0). For example, the index of the derivation of B2 in the following code would be 1: struct D : B1, B2 { ... };

getLocation

Gets the location of the derivation.

hasSpecifier

Holds if the derivation has specifier s.

isVirtual

Holds if the derivation is for a virtual base class.

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