Class File

A file that was observed on disk during the build process.

For the example filename of “/usr/home/me/myprogram.c”, the filename decomposes to:

“/usr/home/me” - see getParentContainer.
“myprogram.c” - see getBaseName.

The base name further decomposes into the stem and extension – see getStem and getExtension. To get the full path, use getAbsolutePath.

Import path

import cpp

Direct supertypes

Indirect supertypes

Known direct subtypes

Predicates

compiledAsC	Holds if this file was compiled as C (at any point).
compiledAsCpp	Holds if this file was compiled as C++ (at any point).
compiledAsMicrosoft	Holds if this file was compiled by a Microsoft compiler (at any point).
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.
getADeclaration	Gets a declaration in this file.
getAPrimaryQlClass	Gets the name of a primary CodeQL class to which this element belongs.
getATopLevelDeclaration	Gets a top-level element declared in this file.
getAnIncludedFile	Gets a file that is directly included from this file (using a pre-processor directive like `#include`).
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 `getExtension`, which gets the remainder of the base name after the last dot character.
getLocation	Gets the primary location of this element.
getMetrics	Gets the metric file.
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”.
usesMacro	Holds if this file uses the given macro.

Inherited predicates

findRootCause	Gets the source of this element: either itself or a macro that expanded to this element.	from Element
getAChildContainer	Gets a file or sub-folder in this container.	from Container
getAFile	Gets a file in this container.	from Container
getAFolder	Gets a sub-folder in this container.	from Container
getAbsolutePath	Gets the absolute, canonical path of this container, using forward slashes as path separator.	from Container
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 `Element` enclosing this one.	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
getFile	Gets the primary file where this element occurs.	from Element
getFile	Gets the file in this container that has the given `baseName`, if any.	from Container
getFolder	Gets the sub-folder in this container that has the given `baseName`, if any.	from Container
getParentContainer	Gets the parent container of this file or folder, if any.	from Container
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
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
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 `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
toString		from Container