Class Folder
A folder that was observed on disk during the build process.
For the example folder name of “/usr/home/me”, the path decomposes to:
- “/usr/home” - see
getParentContainer
. - “me” - see
getBaseName
.
To get the full path, use getAbsolutePath
.
Import path
import cpp
Indirect supertypes
Known direct subtypes
Predicates
getAPrimaryQlClass |
Gets the name of a primary CodeQL class to which this element belongs. |
getAbsolutePath |
Gets the absolute, canonical path of this container, using forward slashes as path separator. |
getLocation |
Gets the primary location of this element. |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
Gets a textual representation of the path of this container. |
from Container |