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
- “myprogram.c” - see
The base name further decomposes into the stem and extension – see
getExtension. To get the full path, use
Known direct subtypes
Holds if this file was compiled as C (at any point).
Holds if this file was compiled as C++ (at any point).
Holds if this file was compiled by a Microsoft compiler (at any point).
Holds if this file may be from a library.
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.
Gets a declaration in this file.
Gets the name of a primary CodeQL class to which this element belongs.
Gets a top-level element declared in this file.
Gets the absolute, canonical path of this container, using forward slashes as path separator.
Gets a file that is directly included from this file (using a pre-processor directive like
Gets the remainder of the base name after the first dot character. Note that the name of this predicate is in plural form, unlike
Gets the primary location of this element.
Gets the metric file.
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”.
Gets a textual representation of the path of this container.
Holds if this file uses the given macro.
Gets the source of this element: either itself or a macro that expanded to this element.
Gets a file or sub-folder in this container.
Gets a file in this container.
Gets a sub-folder in this container.
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.
Gets the closest
Gets the extension of this container, that is, the suffix of its base name after the last dot character, if any.
Gets the primary file where this element occurs.
Gets the file in this container that has the given
Gets the sub-folder in this container that has the given
Gets the parent container of this file or folder, if any.
Gets the parent scope of this
Gets a comma-separated list of the names of the primary CodeQL classes to which this element belongs.
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.
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.
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
Holds if this
Holds if this
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