contrib/llvm/tools/clang/include/clang/AST/PrettyPrinter.h

   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
  20 namespace clang {
  21
  22 class Stmt;
  23 class TagDecl;
  24 class LangOptions;
  25
  26 class PrinterHelper {
  27 public:
  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.
  34 struct 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       SuppressUnwrittenScope(false), 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 parts of scope specifiers that don't need
  90   /// to be written, e.g., for inline or anonymous namespaces.
  91   bool SuppressUnwrittenScope : 1;
  92
  93   /// \brief Suppress printing of variable initializers.
  94   ///
  95   /// This flag is used when printing the loop variable in a for-range
  96   /// statement. For example, given:
  97   ///
  98   /// \code
  99   /// for (auto x : coll)
 100   /// \endcode
 101   ///
 102   /// SuppressInitializers will be true when printing "auto x", so that the
 103   /// internal initializer constructed for x will not be printed.
 104   bool SuppressInitializers : 1;
 105
 106   /// \brief True when we are "dumping" rather than "pretty-printing",
 107   /// where dumping involves printing the internal details of the AST
 108   /// and pretty-printing involves printing something similar to
 109   /// source code.
 110   bool Dump : 1;
 111
 112   /// \brief Whether we should print the sizes of constant array expressions
 113   /// as written in the sources.
 114   ///
 115   /// This flag is determines whether arrays types declared as
 116   ///
 117   /// \code
 118   /// int a[4+10*10];
 119   /// char a[] = "A string";
 120   /// \endcode
 121   ///
 122   /// will be printed as written or as follows:
 123   ///
 124   /// \code
 125   /// int a[104];
 126   /// char a[9] = "A string";
 127   /// \endcode
 128   bool ConstantArraySizeAsWritten : 1;
 129
 130   /// \brief When printing an anonymous tag name, also print the location of
 131   /// that entity (e.g., "enum <anonymous at t.h:10:5>"). Otherwise, just
 132   /// prints "<anonymous>" for the name.
 133   bool AnonymousTagLocations : 1;
 134
 135   /// \brief When true, suppress printing of the __strong lifetime qualifier in
 136   /// ARC.
 137   unsigned SuppressStrongLifetime : 1;
 138
 139   /// \brief Whether we can use 'bool' rather than '_Bool', even if the language
 140   /// doesn't actually have 'bool' (because, e.g., it is defined as a macro).
 141   unsigned Bool : 1;
 142 };
 143
 144 } // end namespace clang
 145
 146 #endif