1//===--- PrettyPrinter.h - Classes for aiding with AST printing -*- C++ -*-===//
2//
3//                     The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
9//
10//  This file defines the PrinterHelper interface.
11//
12//===----------------------------------------------------------------------===//
13
14#ifndef LLVM_CLANG_AST_PRETTY_PRINTER_H
15#define LLVM_CLANG_AST_PRETTY_PRINTER_H
16
17#include "clang/Basic/LangOptions.h"
18#include "clang/Basic/LLVM.h"
19
20namespace clang {
21
22class Stmt;
23class TagDecl;
24class LangOptions;
25
26class PrinterHelper {
27public:
28  virtual ~PrinterHelper();
29  virtual bool handledStmt(Stmt* E, raw_ostream& OS) = 0;
30};
31
32/// \brief Describes how types, statements, expressions, and
33/// declarations should be printed.
34struct PrintingPolicy {
35  /// \brief Create a default printing policy for C.
36  PrintingPolicy(const LangOptions &LO)
37    : Indentation(2), LangOpts(LO), SuppressSpecifiers(false),
38      SuppressTagKeyword(false), SuppressTag(false), SuppressScope(false),
39      SuppressInitializers(false),
40      Dump(false), ConstantArraySizeAsWritten(false),
41      AnonymousTagLocations(true), SuppressStrongLifetime(false),
42      Bool(LO.Bool) { }
43
44  /// \brief The number of spaces to use to indent each line.
45  unsigned Indentation : 8;
46
47  /// \brief What language we're printing.
48  LangOptions LangOpts;
49
50  /// \brief Whether we should suppress printing of the actual specifiers for
51  /// the given type or declaration.
52  ///
53  /// This flag is only used when we are printing declarators beyond
54  /// the first declarator within a declaration group. For example, given:
55  ///
56  /// \code
57  /// const int *x, *y;
58  /// \endcode
59  ///
60  /// SuppressSpecifiers will be false when printing the
61  /// declaration for "x", so that we will print "int *x"; it will be
62  /// \c true when we print "y", so that we suppress printing the
63  /// "const int" type specifier and instead only print the "*y".
64  bool SuppressSpecifiers : 1;
65
66  /// \brief Whether type printing should skip printing the tag keyword.
67  ///
68  /// This is used when printing the inner type of elaborated types,
69  /// (as the tag keyword is part of the elaborated type):
70  ///
71  /// \code
72  /// struct Geometry::Point;
73  /// \endcode
74  bool SuppressTagKeyword : 1;
75
76  /// \brief Whether type printing should skip printing the actual tag type.
77  ///
78  /// This is used when the caller needs to print a tag definition in front
79  /// of the type, as in constructs like the following:
80  ///
81  /// \code
82  /// typedef struct { int x, y; } Point;
83  /// \endcode
84  bool SuppressTag : 1;
85
86  /// \brief Suppresses printing of scope specifiers.
87  bool SuppressScope : 1;
88
89  /// \brief Suppress printing of variable initializers.
90  ///
91  /// This flag is used when printing the loop variable in a for-range
92  /// statement. For example, given:
93  ///
94  /// \code
95  /// for (auto x : coll)
96  /// \endcode
97  ///
98  /// SuppressInitializers will be true when printing "auto x", so that the
99  /// internal initializer constructed for x will not be printed.
100  bool SuppressInitializers : 1;
101
102  /// \brief True when we are "dumping" rather than "pretty-printing",
103  /// where dumping involves printing the internal details of the AST
104  /// and pretty-printing involves printing something similar to
105  /// source code.
106  bool Dump : 1;
107
108  /// \brief Whether we should print the sizes of constant array expressions
109  /// as written in the sources.
110  ///
111  /// This flag is determines whether arrays types declared as
112  ///
113  /// \code
114  /// int a[4+10*10];
115  /// char a[] = "A string";
116  /// \endcode
117  ///
118  /// will be printed as written or as follows:
119  ///
120  /// \code
121  /// int a[104];
122  /// char a[9] = "A string";
123  /// \endcode
124  bool ConstantArraySizeAsWritten : 1;
125
126  /// \brief When printing an anonymous tag name, also print the location of
127  /// that entity (e.g., "enum <anonymous at t.h:10:5>"). Otherwise, just
128  /// prints "<anonymous>" for the name.
129  bool AnonymousTagLocations : 1;
130
131  /// \brief When true, suppress printing of the __strong lifetime qualifier in
132  /// ARC.
133  unsigned SuppressStrongLifetime : 1;
134
135  /// \brief Whether we can use 'bool' rather than '_Bool', even if the language
136  /// doesn't actually have 'bool' (because, e.g., it is defined as a macro).
137  unsigned Bool : 1;
138};
139
140} // end namespace clang
141
142#endif
143