Class FunctionReferenceType

A C++ reference to a function.

int(& reference)(const void *element1, const void *element2);

Import path

import cpp

Direct supertypes

FunctionPointerIshType

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.
getAPrimaryQlClass	Gets the name of a primary CodeQL class to which this element belongs.
getPointerIndirectionLevel	Gets the pointer indirection level of this type.

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
getAParameterType	the type of an argument of this function pointer type	from FunctionPointerIshType
getASpecifier	Gets a specifier of this type, recursively looking through `typedef` and `decltype`. For example, in the context of `typedef const int *restrict t`, the type `volatile t` has specifiers `volatile` and `restrict` but not `const` since the `const` is attached to the type being pointed to rather than the pointer itself.	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
getBaseType	Gets the base type of this derived type.	from DerivedType
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 Type
getName	Gets the name of this type.	from DerivedType
getNumberOfParameters	the number of arguments of this function pointer type	from FunctionPointerIshType
getParameterType	the type of the ith argument of this function pointer type	from FunctionPointerIshType
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
getReturnType	the return type of this function pointer type	from FunctionPointerIshType
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 `name`.	from Type
hasSpecifier	Holds if this declaration has a specifier called `name`, recursively looking through `typedef` and `decltype`. For example, in the context of `typedef const int *restrict t`, the type `volatile t` has specifiers `volatile` and `restrict` but not `const` since the `const` is attached to the type being pointed to rather than the pointer itself.	from Type
internal_getAnAdditionalSpecifier	Internal – should be `protected` when QL supports such a flag. Subtypes override this to recursively get specifiers that are not attached directly to this `@type` in the database but arise through type aliases such as `typedef` and `decltype`.	from Type
involvesReference	Holds if this type involves a reference.	from DerivedType
involvesTemplateParameter	Holds if this type involves a template parameter.	from FunctionPointerIshType
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
isConst	Holds if this type is const.	from Type
isDeeplyConst	Holds if this type is constant and only contains constant types. For instance, a `char const` is a constant type, but not deeply constant, because while the pointer can’t be modified the character can. The type `const char const*` is a deeply constant type though - both the pointer and what it points to are immutable.	from Type
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, `const char const` is deeply constant and deeply constant below, but `const char ` is only deeply constant below (the pointer can be changed, but not the underlying char). `char *const` is neither (it is just `const`).	from FunctionPointerIshType
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
isVolatile	Holds if this type is volatile.	from Type
refersTo	Holds if this type refers to type `t` (by default, a type always refers to itself).	from Type
refersToDirectly	Holds if this type refers to type `t` directly.	from DerivedType
resolveTypedefs	Gets this type with any typedefs resolved. For example, given `typedef C T`, this would resolve `const T&` to `const C&`. Note that this will only work if the resolved type actually appears on its own elsewhere in the program.	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 `typedef const C& T`, `stripType` returns `C`.	from DerivedType
toString	Gets a textual representation of this element.	from DerivedType

Charpred

FunctionReferenceType