Class MetricFunction

Gets the number of incoming dependencies: functions that call or access this function.

Gets the branching complexity of this function. This is a measure derived from cyclomatic complexity, but it reflects only the branches that make the code difficult to read (as opposed to cyclomatic complexity, which attempts to evaluate how difficult the code is to test).

Gets the ratio of lines of comments to total lines in this function (between 0.0 and 1.0).

Gets the cyclomatic complexity of this function. This is defined as the number of branching statements (if, while, do, for, and non-fallthrough case) plus the number of branching expressions (?, &&, and ||) plus one.

Gets the number of outgoing dependencies: functions that are called or accessed by this function.

Gets the Halstead ‘delivered bugs’ metric for this function. This metric correlates with the complexity of the software, but is known to be an underestimate of bug counts.

Gets the Halstead difficulty value of this function. This is proportional to the number of unique operators, and further proportional to the ratio of total operands to unique operands.

Gets the Halstead implementation effort for this function. This is the product of the volume and difficulty.

Gets the Halstead length of this function. This is the sum of the N1 and N2 Halstead metrics.

Gets the Halstead level of this function. This is the inverse of the difficulty of the function.

Gets the Halstead “N1” metric: this is the total number of operators in this function. Operators are taken to be all operators in expressions (+, *, &, ->, =, …) as well as most statements.

Gets the Halstead “n1” metric: this is the total number of distinct operators in this function. Operators (as in the N1 metric) are all operators in expressions as well as most statements.

Gets the Halstead “N2” metric: this is the total number of operands in this function. An operand is either a variable, constant, type name, or function name.

Gets the Halstead “n2” metric: this is the number of distinct operands in this function. An operand is either a variable, constant, type name, or function name.

Gets the Halstead vocabulary size of this function. This is the sum of the n1 and n2 Halstead metrics.

Gets the Halstead volume of this function. This is the Halstead size multiplied by the log of the Halstead vocabulary. It represents the information content of the function.

Gets the maximum nesting level of complex statements such as if, while in the function. A nesting depth of 2 would mean that there is, for example, an if statement nested in another if statement.

Gets the number of function calls in this function.

Gets the number of lines in this function.

Gets the number of lines of code in this function.

Gets the number of lines of comments in this function.

Gets the number of parameters.

Holds if this function accesses a function or variable or enumerator a.

Holds if this function accesses a function or variable or enumerator a in the Access expression l.

Holds if this function calls the function f.

Holds if this function calls the function f in the FunctionCall expression l.

Holds if a base class base of derived is accessible at this (N4140 11.2/4). When this holds, and derived has only one base subobject of type base, code in this can implicitly convert a pointer to derived into a pointer to base. Conversely, if such a conversion is possible then this predicate holds.

Holds if a non-static member member is accessible at this when named in a class derived that is derived from or equal to the declaring class of member (N4140 11.2/5 and 11.4).

Holds if a hypothetical non-static member of memberClass with access specifier memberAccess is accessible at this when named in a class derived that is derived from or equal to memberClass (N4140 11.2/5 and 11.4).

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

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.

Gets a call to this function.

Gets a child declaration of this function.

Gets a declaration entry corresponding to this declaration. The relationship between Declaration and DeclarationEntry is explained in Declaration.qll.

Gets the location of a FunctionDeclarationEntry corresponding to this declaration.

Gets a node such that the control-flow edge (this, result) may be taken when this expression is false.

Gets a file where this element occurs.

Gets a link target which compiled or referenced this function.

Gets a parameter of this function. There is no result for the implicit this parameter, and there is no ... varargs pseudo-parameter.

Gets a direct predecessor of this control-flow node, if any.

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

Gets a specifier of this function.

Gets a direct successor of this control-flow node, if any.

Gets a template argument used to instantiate this declaration from a template. When called on a template, this will return a template parameter type for both typed and non-typed parameters.

Gets a template argument used to instantiate this declaration from a template. When called on a template, this will return a non-typed template parameter value.

Gets a type that is specified to be thrown by the function.

Gets a node such that the control-flow edge (this, result) may be taken when this expression is true.

Gets a variable that is written-to in this function.

Gets an access of this function.

Gets an attribute of this function.

Gets a non-implicit function declaration entry.

Gets a function that overloads this one.

Gets the BasicBlock containing this control-flow node.

Gets the block that is the function body.

Gets the class of which this function, called memberName, is a member.

Implements ControlFlowNode.getControlFlowScope. The Function is used to represent the exit node of the control flow graph, so it is its own scope.

Gets the class where this member is declared, if it is a member. For templates, both the template itself and all instantiations of the template are considered to have the same declaring class.

Gets the declaration entry corresponding to this declaration that is a definition, if any.

Gets the location of the definition, if any.

Gets a description of this Declaration for display purposes.

Gets the number of parameters of this function, including any implicit this parameter but not including any ... varargs pseudo-parameter.

Gets the nearest enclosing AccessHolder.

Gets the closest Element enclosing this one.

Implements ControlFlowNode.getEnclosingStmt. The Function is used to represent the exit node of the control flow graph, so it has no enclosing statement.

Gets the first node in this function’s control flow graph.

Gets the constant expression that determines whether the function is explicit.

Gets the primary file where this element occurs.

Gets the preferred location of this declaration. (The location of the definition, if possible.)

Gets the metric class. MetricFunction has methods for computing various metrics, such as “number of lines of code” and “number of function calls”.

Gets the name of this declaration.

Gets the innermost namespace which contains this declaration.

Gets the number of template arguments for this declaration.

Gets the nth parameter of this function. There is no result for the implicit this parameter, and there is no ... varargs pseudo-parameter.

Gets a string representing the parameters of this function.

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.

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

Gets the name of the declaration, fully qualified with its namespace and declaring type.

Gets the ith template argument used to instantiate this declaration from a template.

Gets the ith template argument value used to instantiate this declaration from a template. When called on a template, this will return the ith template parameter value if it exists.

Gets the ith type specified to be thrown by the function.

Gets the return type of this function.

Gets the return type of this function after specifiers have been deeply stripped and typedefs have been resolved.

Holds if this function has C linkage, as specified by one of its declaration entries. For example: extern "C" void foo();.

Holds if this declaration is a member of a class/struct/union.

Holds if the declaration has a definition.

Holds if this function has an entry point.

Holds if this function has extraction errors that create an ErrorExpr.

Holds if the function has an exception specification.

Holds if this declaration has the given name in the global namespace.

Holds if this declaration has the given name in the global namespace or the std namespace.

Holds if this declaration has the given name in the global namespace, the std namespace or the bsl namespace. We treat std and bsl as the same in some of our models.

Holds if this declaration has the given name.

Holds if this declaration has a fully-qualified name with a name-space component of namespaceQualifier, no declaring type, and a base name of baseName.

Holds if this declaration has a fully-qualified name with a name-space component of namespaceQualifier, a declaring type of typeQualifier, and a base name of baseName. Template parameters and arguments are stripped from all components. Missing components are "".

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

Holds if this function has a trailing return type.

Holds if this can access private members of class c.

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.

Holds if this function is generated by the compiler.

Holds if this node is the top-level expression of a conditional statement, meaning that this.getATrueSuccessor() or this.getAFalseSuccessor() will have a result.

Holds if this function is declared to be consteval.

Holds if this function is constexpr. Normally, this holds if and only if isDeclaredConstexpr() holds, but in some circumstances they differ. For example, with int f(int i) { return 6; } template <typename T> constexpr int g(T x) { return f(x); } g<int> is declared constexpr, but is not constexpr.

Holds if this function is constructed from f as a result of template instantiation. If so, it originates either from a template function or from a function nested in a template class.

Holds if this function is declared to be constexpr.

Holds if this function is declared with the virtual specifier.

Holds if this function is explicitly defaulted with the = default specifier.

Holds if this function is deleted. This may be because it was explicitly deleted with an = delete definition, or because the compiler was unable to auto-generate a definition for it.

Holds if this function is declared to be explicit.

Holds if this function is declared with the final specifier.

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

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.

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.

Holds if this function is inline.

Holds if this declaration is a member of a class/struct/union.

Holds if this function is defined in several files. This is illegal in C (though possible in some C++ compilers), and likely indicates that several functions that are not linked together have been compiled. An example would be a project with many ‘main’ functions.

Holds if this function is declared with __attribute__((naked)) or __declspec(naked).

Holds if this function has a noexcept exception specification.

Holds if this function has a throw() exception specification.

Holds if this function is declared with the override specifier.

Holds if this function has a prototyped interface.

Holds if this function is side-effect free (conservative approximation).

Holds if this function is a template specialization.

Holds if this declaration is static.

Holds if this declaration is a top-level declaration.

Holds if this function is a varargs function.

Holds if this function is virtual.

Holds if this function may have side-effects; if in doubt, we assume it may.

Gets a textual representation of this element.