Class XMLFile

An XML file.

Import path

import cpp

Direct supertypes

Indirect supertypes

Predicates

getADTD

Gets a DTD associated with this XML file.

getARootElement

Gets a top-most element in an XML file.

getEncoding

Gets the encoding of this XML file.

getFile

Gets the XML file itself.

getFolder

DEPRECATED: Use getParentContainer().getAbsolutePath() instead.

getName

Gets the name of this XML file.

getPath

DEPRECATED: Use getAbsolutePath() instead.

toString

Gets a printable representation of this XML file.

Inherited predicates

allCharactersString

Gets the result of appending all the character sequences of this XML parent from left to right, separated by a space.

from XMLParent
charsSetUpTo

DEPRECATED: Internal.

from XMLParent
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
fromLibrary

Holds if this file may be from a library.

from File
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
getACharactersSet

Gets a character sequence that is a child of this XML parent.

from XMLParent
getAChild

Gets a child element of this XML parent.

from XMLParent
getAChild

Gets a child element of this XML parent with the given name.

from XMLParent
getAChildContainer

Gets a file or sub-folder in this container.

from Container
getAComment

Gets a comment that is a child of this XML parent.

from XMLParent
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 File
getAnIncludedFile

Gets a file that is directly included from this file (using a pre-processor directive like #include).

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
getCanonicalQLClass

DEPRECATED: use getAPrimaryQlClass instead.

from ElementBase
getChild

Gets the child element at a specified index of this XML parent.

from XMLParent
getDepth

Gets the depth in the tree. (Overridden in XMLElement.)

from XMLParent
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
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.

from File
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
getLocation

Gets the primary location of this element.

from File
getMetrics

Gets the metric file.

from File
getNumberOfCharacterSets

Gets the number of places in the body of this XML parent where text occurs.

from XMLParent
getNumberOfChildren

Gets the number of child XML elements of this XML parent.

from XMLParent
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 Block, a Function, or certain kinds of Statement.

from Element
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
getTextValue

Gets the text value contained in this XML parent.

from XMLParent
getURL

DEPRECATED: Use getLocation instead. 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
usesMacro

Holds if this file uses the given macro.

from File

Charpred