Class RoutineType
A C/C++ routine type. Conceptually, this is what results from stripping
away the pointer from a function pointer type. It can also occur in C++
code, for example the base type of myRoutineType
in the following code:
using myRoutineType = int(int);
myRoutineType *fp = 0;
Import path
import cpp
Direct supertypes
Indirect supertypes
Known direct subtypes
Predicates
explain | Gets a detailed string representation explaining the AST of this type (with all specifiers and nested constructs such as pointers). This is intended to help debug queries and is a very expensive operation; not to be used in production queries. |
getAParameterType | Gets the type of a parameter to this routine. |
getAPrimaryQlClass | Gets the name of a primary CodeQL class to which this element belongs. |
getName | Gets the name of this type. |
getParameterType | Gets the type of the |
getReturnType | Gets the return type of this routine. |
hasCLinkage | Holds if this function type has “C” language linkage. |
involvesTemplateParameter | Holds if this type involves a template parameter. |
isDeeplyConst | Holds if this type is constant and only contains constant types. For instance, a |
isDeeplyConstBelow | Holds if this type is constant and only contains constant types, excluding the type itself. It is implied by Type.isDeeplyConst() and is just used to implement that predicate. For example, |
refersToDirectly | Holds if this type refers to type |
toString | a printable representation of this named 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 of this type, recursively looking through | from Type |
getATypeNameUse | Gets as many places as possible where this type is used by name in the source after macros have been replaced (in particular, therefore, this will find type name uses caused by macros). Note that all type name uses within instantiations are currently excluded - this is too draconian in the absence of indexing prototype instantiations of functions, and is likely to improve in the future. At present, the method takes the conservative approach of giving valid type name uses, but not necessarily all type name uses. | from Type |
getAlignment | Gets the alignment of this type in bytes. | from Type |
getAnAttribute | Gets an attribute of this type. | from Type |
getEnclosingElement | Gets the closest | from Element |
getFile | Gets the primary file where this element occurs. | from Element |
getLocation | Gets the primary location of this element. | from Type |
getParentScope | Gets the parent scope of this | from Element |
getPointerIndirectionLevel | Gets the pointer indirection level of this type. | from Type |
getPrimaryQlClasses | Gets a comma-separated list of the names of the primary CodeQL classes to which this element belongs. | from ElementBase |
getSize | Gets the size of this type in bytes. | from Type |
getUnderlyingType | Gets this type after typedefs have been resolved. | from Type |
getUnspecifiedType | Gets this type after specifiers have been deeply stripped and typedefs have been resolved. | from Type |
hasName | Holds if this type is called | from Type |
hasSpecifier | Holds if this declaration has a specifier called | from Type |
internal_getAnAdditionalSpecifier | Internal – should be | from Type |
involvesReference | Holds if this type involves a reference. | from Type |
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 | from Element |
isConst | Holds if this type is const. | from Type |
isFromTemplateInstantiation | Holds if this | from Element |
isFromUninstantiatedTemplate | Holds if this | 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 | from Element |
isVolatile | Holds if this type is volatile. | from Type |
refersTo | Holds if this type refers to type | from Type |
resolveTypedefs | Gets this type with any typedefs resolved. For example, given | from Type |
stripTopLevelSpecifiers | Gets this type after any top-level specifiers and typedefs have been stripped. | from Type |
stripType | Gets the type stripped of pointers, references and cv-qualifiers, and resolving typedefs. For example, given | from Type |