Class MetricFile
A wrapper that provides metrics for a C/C++ file.
Import path
import cpp
Direct supertypes
Predicates
getAFileDependency | Gets a file dependency of this file. |
getAfferentCoupling | Gets the number of incoming file dependencies. |
getEfferentCoupling | Gets the number of outgoing file dependencies. |
getHalsteadDeliveredBugs | Gets the Halstead ‘delivered bugs’ metric for this file. This metric correlates with the complexity of the software, but is known to be an underestimate of bug counts. |
getHalsteadDifficulty | Gets the Halstead difficulty value of this file. This is proportional to the number of unique operators, and further proportional to the ratio of total operands to unique operands. |
getHalsteadEffort | Gets the Halstead implementation effort for this file. This is the product of the volume and difficulty. |
getHalsteadLength | Gets the Halstead length of this file. This is the sum of the N1 and N2 Halstead metrics. |
getHalsteadLevel | Gets the Halstead level of this file. This is the inverse of the difficulty of the file. |
getHalsteadN1 | Gets the Halstead “N1” metric for this file. This is the total number of operators in the file. Operators are taken to be all operators in expressions ( |
getHalsteadN1Distinct | Gets the Halstead “n1” metric: this is the total number of distinct operators in this file. Operators are defined as in the “N1” metric ( |
getHalsteadN2 | Gets the Halstead “N2” metric for this file: this is the total number of operands. An operand is either a variable, constant, type name, class name, or function name. |
getHalsteadN2Distinct | Gets the Halstead “n2” metric: this is the number of distinct operands in this file. An operand is either a variable, constant, type name, or function name. |
getHalsteadVocabulary | Gets the Halstead vocabulary size of this file. This is the sum of the n1 and n2 Halstead metrics. |
getHalsteadVolume | Gets the Halstead volume of this file. This is the Halstead size multiplied by the log of the Halstead vocabulary. It represents the information content of the file. |
getNumberOfClasses | Gets the number of classes defined in this file. |
getNumberOfLines | Gets the number of lines in this file. |
getNumberOfLinesOfCode | Gets the number of lines of code in this file. |
getNumberOfLinesOfComments | Gets the number of lines of comments in this file. |
getNumberOfTopLevelFunctions | Gets the number of functions defined in this file. |
getNumberOfUserTypes | Gets the number of user-defined types defined in this file. |
Inherited predicates
compiledAsC | Holds if this file was compiled as C (at any point). | from File |
compiledAsCpp | Holds if this file was compiled as C++ (at any point). | from File |
compiledAsMicrosoft | Holds if this file was compiled by a Microsoft compiler (at any point). | from File |
findRootCause | Gets the source of this element: either itself or a macro that expanded to this element. | from Element |
fromSource | Holds if this file may be from source. This predicate holds for all files except the dummy file, whose name is the empty string, which contains declarations that are built into the compiler. | from File |
getAChildContainer | Gets a file or sub-folder in this container. | from Container |
getADeclaration | Gets a declaration in this file. | from File |
getAFile | Gets a file in this container. | from Container |
getAFolder | Gets a sub-folder in this container. | from Container |
getAPrimaryQlClass | Gets the name of a primary CodeQL class to which this element belongs. | from File |
getATopLevelDeclaration | Gets a top-level element declared in this file. | from File |
getAbsolutePath | Gets the absolute, canonical path of this container, using forward slashes as path separator. | from Container |
getAnIncludedFile | Gets a file that is directly included from this file (using a pre-processor directive like | from File |
getBaseName | Gets the base name of this container including extension, that is, the last segment of its absolute path, or the empty string if it has no segments. | from Container |
getEnclosingElement | Gets the closest | from Element |
getExtension | Gets the extension of this container, that is, the suffix of its base name after the last dot character, if any. | from Container |
getExtensions | Gets the remainder of the base name after the first dot character. Note that the name of this predicate is in plural form, unlike | from File |
getFile | Gets the primary file where this element occurs. | from Element |
getFile | Gets the file in this container that has the given | from Container |
getFolder | Gets the sub-folder in this container that has the given | from Container |
getLocation | Gets the primary location of this element. | from File |
getMetrics | Gets the metric file. | from File |
getParentContainer | Gets the parent container of this file or folder, if any. | from Container |
getParentScope | Gets the parent scope of this | from Element |
getPrimaryQlClasses | Gets a comma-separated list of the names of the primary CodeQL classes to which this element belongs. | from ElementBase |
getRelativePath | Gets the relative path of this file or folder from the root folder of the analyzed source location. The relative path of the root folder itself is the empty string. | from Container |
getShortName | Gets the short name of this file, that is, the prefix of its base name up to (but not including) the first dot character if there is one, or the entire base name if there is not. For example, if the full name is “/path/to/filename.a.bcd” then the short name is “filename”. | from File |
getStem | Gets the stem of this container, that is, the prefix of its base name up to (but not including) the last dot character if there is one, or the entire base name if there is not. | from Container |
getURL | Gets the URL of this file. | from File |
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 |
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 |
toString | from Container | |
usesMacro | Holds if this file uses the given macro. | from File |