Class Include
A C/C++ #include
, #include_next
, or #import
preprocessor
directive. The following example contains four different Include
directives:
#include "header.h"
#include <string>
#include_next <header2.h>
#import <header3.h>
Import path
import cpp
Direct supertypes
Indirect supertypes
Known direct subtypes
Predicates
getAnInclude | A |
getIncludeText | Gets the token which occurs after |
getIncludedFile | Gets the file directly included by this |
provides | Gets a file which might be transitively included by this |
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 |
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 |
getAGuard | Gets a preprocessor branching directive whose condition affects whether this directive is performed. | from PreprocessorDirective |
getAPrimaryQlClass | Gets the name of a primary CodeQL class to which this element belongs. | from ElementBase |
getEnclosingElement | Gets the closest | from Element |
getFile | Gets the primary file where this element occurs. | from Element |
getHead | from PreprocessorDirective | |
getLocation | Gets the primary location of this element. | from PreprocessorDirective |
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 |
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 |