clang
10.0.0git
|
Describes how types, statements, expressions, and declarations should be printed. More...
#include "clang/AST/PrettyPrinter.h"
Public Member Functions | |
PrintingPolicy (const LangOptions &LO) | |
Create a default printing policy for the specified language. More... | |
void | adjustForCPlusPlus () |
Adjust this printing policy for cases where it's known that we're printing C++ code (for instance, if AST dumping reaches a C++-only construct). More... | |
Public Attributes | |
unsigned | Indentation: 8 |
The number of spaces to use to indent each line. More... | |
unsigned | SuppressSpecifiers: 1 |
Whether we should suppress printing of the actual specifiers for the given type or declaration. More... | |
unsigned | SuppressTagKeyword: 1 |
Whether type printing should skip printing the tag keyword. More... | |
unsigned | IncludeTagDefinition: 1 |
When true, include the body of a tag definition. More... | |
unsigned | SuppressScope: 1 |
Suppresses printing of scope specifiers. More... | |
unsigned | SuppressUnwrittenScope: 1 |
Suppress printing parts of scope specifiers that don't need to be written, e.g., for inline or anonymous namespaces. More... | |
unsigned | SuppressInitializers: 1 |
Suppress printing of variable initializers. More... | |
unsigned | ConstantArraySizeAsWritten: 1 |
Whether we should print the sizes of constant array expressions as written in the sources. More... | |
unsigned | AnonymousTagLocations: 1 |
When printing an anonymous tag name, also print the location of that entity (e.g., "enum <anonymous at t.h:10:5>"). More... | |
unsigned | SuppressStrongLifetime: 1 |
When true, suppress printing of the __strong lifetime qualifier in ARC. More... | |
unsigned | SuppressLifetimeQualifiers: 1 |
When true, suppress printing of lifetime qualifier in ARC. More... | |
unsigned | SuppressTemplateArgsInCXXConstructors: 1 |
When true, suppresses printing template arguments in names of C++ constructors. More... | |
unsigned | Bool: 1 |
Whether we can use 'bool' rather than '_Bool' (even if the language doesn't actually have 'bool', because, e.g., it is defined as a macro). More... | |
unsigned | Restrict: 1 |
Whether we can use 'restrict' rather than '__restrict'. More... | |
unsigned | Alignof: 1 |
Whether we can use 'alignof' rather than '__alignof'. More... | |
unsigned | UnderscoreAlignof: 1 |
Whether we can use '_Alignof' rather than '__alignof'. More... | |
unsigned | UseVoidForZeroParams: 1 |
Whether we should use '(void)' rather than '()' for a function prototype with zero parameters. More... | |
unsigned | TerseOutput: 1 |
Provide a 'terse' output. More... | |
unsigned | PolishForDeclaration: 1 |
When true, do certain refinement needed for producing proper declaration tag; such as, do not print attributes attached to the declaration. More... | |
unsigned | Half: 1 |
When true, print the half-precision floating-point type as 'half' instead of '__fp16'. More... | |
unsigned | MSWChar: 1 |
When true, print the built-in wchar_t type as __wchar_t. More... | |
unsigned | IncludeNewlines: 1 |
When true, include newlines after statements like "break", etc. More... | |
unsigned | MSVCFormatting: 1 |
Use whitespace and punctuation like MSVC does. More... | |
unsigned | ConstantsAsWritten: 1 |
Whether we should print the constant expressions as written in the sources. More... | |
unsigned | SuppressImplicitBase: 1 |
When true, don't print the implicit 'self' or 'this' expressions. More... | |
unsigned | FullyQualifiedName: 1 |
When true, print the fully qualified name of function declarations. More... | |
unsigned | PrintCanonicalTypes: 1 |
Whether to print types as written or canonically. More... | |
const PrintingCallbacks * | Callbacks = nullptr |
Callbacks to use to allow the behavior of printing to be customized. More... | |
Describes how types, statements, expressions, and declarations should be printed.
This type is intended to be small and suitable for passing by value. It is very frequently copied.
Definition at line 47 of file PrettyPrinter.h.
|
inline |
Create a default printing policy for the specified language.
Definition at line 49 of file PrettyPrinter.h.
References Bool.
|
inline |
Adjust this printing policy for cases where it's known that we're printing C++ code (for instance, if AST dumping reaches a C++-only construct).
This should not be used if a real LangOptions object is available.
Definition at line 69 of file PrettyPrinter.h.
References Bool.
Referenced by clang::DeclarationName::print(), and printCXXConstructorDestructorName().
unsigned clang::PrintingPolicy::Alignof |
Whether we can use 'alignof' rather than '__alignof'.
Definition at line 175 of file PrettyPrinter.h.
Referenced by PrintFloatingLiteral().
unsigned clang::PrintingPolicy::AnonymousTagLocations |
When printing an anonymous tag name, also print the location of that entity (e.g., "enum <anonymous at t.h:10:5>").
Otherwise, just prints "(anonymous)" for the name.
Definition at line 155 of file PrettyPrinter.h.
Referenced by clang::diff::SyntaxTree::Impl::Impl().
unsigned clang::PrintingPolicy::Bool |
Whether we can use 'bool' rather than '_Bool' (even if the language doesn't actually have 'bool', because, e.g., it is defined as a macro).
Definition at line 169 of file PrettyPrinter.h.
Referenced by clang::BuiltinType::getName(), and clang::DeclSpec::getSpecifierName().
const PrintingCallbacks* clang::PrintingPolicy::Callbacks = nullptr |
Callbacks to use to allow the behavior of printing to be customized.
Definition at line 241 of file PrettyPrinter.h.
unsigned clang::PrintingPolicy::ConstantArraySizeAsWritten |
Whether we should print the sizes of constant array expressions as written in the sources.
This flag determines whether array types declared as
will be printed as written or as follows:
Definition at line 150 of file PrettyPrinter.h.
unsigned clang::PrintingPolicy::ConstantsAsWritten |
Whether we should print the constant expressions as written in the sources.
This flag determines whether constants expressions like
will be printed as written or as follows:
Definition at line 228 of file PrettyPrinter.h.
Referenced by printExprAsWritten(), and PrintFloatingLiteral().
unsigned clang::PrintingPolicy::FullyQualifiedName |
When true, print the fully qualified name of function declarations.
This is the opposite of SuppressScope and thus overrules it.
Definition at line 235 of file PrettyPrinter.h.
unsigned clang::PrintingPolicy::Half |
When true, print the half-precision floating-point type as 'half' instead of '__fp16'.
Definition at line 198 of file PrettyPrinter.h.
Referenced by clang::BuiltinType::getName().
unsigned clang::PrintingPolicy::IncludeNewlines |
When true, include newlines after statements like "break", etc.
Definition at line 205 of file PrettyPrinter.h.
Referenced by clang::CFGBlock::FilterEdge().
unsigned clang::PrintingPolicy::IncludeTagDefinition |
When true, include the body of a tag definition.
This is used to place the definition of a struct in the middle of another declaration as with:
Definition at line 112 of file PrettyPrinter.h.
Referenced by clang::getParameterABISpelling(), and clang::Decl::printGroup().
unsigned clang::PrintingPolicy::Indentation |
The number of spaces to use to indent each line.
Definition at line 76 of file PrettyPrinter.h.
unsigned clang::PrintingPolicy::MSVCFormatting |
Use whitespace and punctuation like MSVC does.
In particular, this prints anonymous namespaces as `anonymous namespace' and does not insert spaces after template arguments.
Definition at line 210 of file PrettyPrinter.h.
Referenced by printIntegral().
unsigned clang::PrintingPolicy::MSWChar |
When true, print the built-in wchar_t type as __wchar_t.
For use in Microsoft mode when wchar_t is not available.
Definition at line 202 of file PrettyPrinter.h.
Referenced by clang::BuiltinType::getName(), and clang::DeclSpec::getSpecifierName().
unsigned clang::PrintingPolicy::PolishForDeclaration |
When true, do certain refinement needed for producing proper declaration tag; such as, do not print attributes attached to the declaration.
Definition at line 194 of file PrettyPrinter.h.
unsigned clang::PrintingPolicy::PrintCanonicalTypes |
Whether to print types as written or canonically.
Definition at line 238 of file PrettyPrinter.h.
Referenced by splitAccordingToPolicy().
unsigned clang::PrintingPolicy::Restrict |
Whether we can use 'restrict' rather than '__restrict'.
Definition at line 172 of file PrettyPrinter.h.
unsigned clang::PrintingPolicy::SuppressImplicitBase |
When true, don't print the implicit 'self' or 'this' expressions.
Definition at line 231 of file PrettyPrinter.h.
Referenced by isImplicitSelf(), and isImplicitThis().
unsigned clang::PrintingPolicy::SuppressInitializers |
Suppress printing of variable initializers.
This flag is used when printing the loop variable in a for-range statement. For example, given:
SuppressInitializers will be true when printing "auto x", so that the internal initializer constructed for x will not be printed.
Definition at line 132 of file PrettyPrinter.h.
unsigned clang::PrintingPolicy::SuppressLifetimeQualifiers |
When true, suppress printing of lifetime qualifier in ARC.
Definition at line 161 of file PrettyPrinter.h.
unsigned clang::PrintingPolicy::SuppressScope |
Suppresses printing of scope specifiers.
Definition at line 115 of file PrettyPrinter.h.
Referenced by clang::NestedNameSpecifier::print().
unsigned clang::PrintingPolicy::SuppressSpecifiers |
Whether we should suppress printing of the actual specifiers for the given type or declaration.
This flag is only used when we are printing declarators beyond the first declarator within a declaration group. For example, given:
SuppressSpecifiers will be false when printing the declaration for "x", so that we will print "int *x"; it will be true
when we print "y", so that we suppress printing the "const int" type specifier and instead only print the "*y".
Definition at line 92 of file PrettyPrinter.h.
Referenced by printExplicitSpecifier(), and clang::Decl::printGroup().
unsigned clang::PrintingPolicy::SuppressStrongLifetime |
When true, suppress printing of the __strong lifetime qualifier in ARC.
Definition at line 158 of file PrettyPrinter.h.
Referenced by clang::TemplateArgument::print(), and rewriteToObjCProperty().
unsigned clang::PrintingPolicy::SuppressTagKeyword |
Whether type printing should skip printing the tag keyword.
This is used when printing the inner type of elaborated types, (as the tag keyword is part of the elaborated type):
Definition at line 102 of file PrettyPrinter.h.
unsigned clang::PrintingPolicy::SuppressTemplateArgsInCXXConstructors |
When true, suppresses printing template arguments in names of C++ constructors.
Definition at line 165 of file PrettyPrinter.h.
Referenced by printCXXConstructorDestructorName(), and clang::index::printSymbolName().
unsigned clang::PrintingPolicy::SuppressUnwrittenScope |
Suppress printing parts of scope specifiers that don't need to be written, e.g., for inline or anonymous namespaces.
Definition at line 119 of file PrettyPrinter.h.
unsigned clang::PrintingPolicy::TerseOutput |
Provide a 'terse' output.
For example, in this mode we don't print function bodies, class members, declarations inside namespaces etc. Effectively, this should print only the requested declaration.
Definition at line 189 of file PrettyPrinter.h.
Referenced by clang::LocationContext::dumpStack(), and clang::LocationContext::printJson().
unsigned clang::PrintingPolicy::UnderscoreAlignof |
Whether we can use '_Alignof' rather than '__alignof'.
Definition at line 178 of file PrettyPrinter.h.
Referenced by PrintFloatingLiteral().
unsigned clang::PrintingPolicy::UseVoidForZeroParams |
Whether we should use '(void)' rather than '()' for a function prototype with zero parameters.
Definition at line 182 of file PrettyPrinter.h.