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

Class Namespace

A C++ namespace. For example the (single) namespace A in the following code:

namespace A
{
  // ...
}

// ...

namespace A
{
  // ...
}

Note that namespaces are somewhat nebulous entities, as they do not in general have a single well-defined location in the source code. The related notion of a NamespaceDeclarationEntry is rather more concrete, and should be used when a location is required. For example, the std:: namespace is particularly nebulous, as parts of it are defined across a wide range of headers. As a more extreme example, the global namespace is never explicitly declared, but might correspond to a large proportion of the source code.

Import path

import cpp

Direct supertypes

Indirect supertypes

Known direct subtypes

Predicates

fromSource

Holds if this namespace may be from source.

getAChildNamespace

Gets a child namespace of this namespace.

getADeclaration

Gets a child declaration of this namespace.

getADeclarationEntry

Gets a declaration of (part of) this namespace.

getAFile

Gets a file which declares (part of) this namespace.

getFriendlyName

Gets a version of the QualifiedName that is more suitable for display purposes.

getLocation

Gets the location of the namespace. Most namespaces do not have a single well-defined source location, so a dummy location is returned, unless the namespace has exactly one declaration entry.

getMetrics

Gets the metric namespace.

getName

Gets the simple name of this namespace.

getParentNamespace

Gets the parent namespace, if any.

getQualifiedName

Gets the qualified name of this namespace. For example: a::b.

hasName

Holds if this element is named name.

isAnonymous

Holds if this namespace is anonymous.

isInline

Holds if the namespace is inline.

toString

Gets a textual representation of this element.

Inherited predicates

findRootCause

Gets the source of this element: either itself or a macro that expanded to this element.

from Element
getANameQualifier

Gets a name qualifier for which this is the qualifying namespace or user-defined type. For example: class X is the NameQualifyingElement and X:: is the NameQualifier.

from NameQualifyingElement
getAPrimaryQlClass

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

from ElementBase
getEnclosingElement

Gets the closest Element enclosing this one.

from Element
getFile

Gets the primary file where this element occurs.

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