CodeQL library for C/C++
codeql/cpp-all 2.1.1 (changelog, source)
Search

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:

  1. “/usr/home” - see getParentContainer.
  2. “me” - see getBaseName.

To get the full path, use getAbsolutePath.

Import path

import cpp

Direct supertypes

Indirect supertypes

Known direct subtypes

    Predicates

    getAPrimaryQlClass

    Gets the name of a primary CodeQL class to which this element belongs.

    Inherited predicates

    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
    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 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
    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 folder.

    from Folder
    toStringfrom Container