PrettyPrinter.h revision d1420c6fa788669e49f21e184927c7833881e399
142a509f6a4f71bb805cc4abbb26722a34dffdddeTed Kremenek//===--- PrettyPrinter.h - Classes for aiding with AST printing -*- C++ -*-===// 242a509f6a4f71bb805cc4abbb26722a34dffdddeTed Kremenek// 342a509f6a4f71bb805cc4abbb26722a34dffdddeTed Kremenek// The LLVM Compiler Infrastructure 442a509f6a4f71bb805cc4abbb26722a34dffdddeTed Kremenek// 50bc735ffcfb223c0186419547abaa5c84482663eChris Lattner// This file is distributed under the University of Illinois Open Source 60bc735ffcfb223c0186419547abaa5c84482663eChris Lattner// License. See LICENSE.TXT for details. 742a509f6a4f71bb805cc4abbb26722a34dffdddeTed Kremenek// 842a509f6a4f71bb805cc4abbb26722a34dffdddeTed Kremenek//===----------------------------------------------------------------------===// 942a509f6a4f71bb805cc4abbb26722a34dffdddeTed Kremenek// 1042a509f6a4f71bb805cc4abbb26722a34dffdddeTed Kremenek// This file defines the PrinterHelper interface. 1142a509f6a4f71bb805cc4abbb26722a34dffdddeTed Kremenek// 1242a509f6a4f71bb805cc4abbb26722a34dffdddeTed Kremenek//===----------------------------------------------------------------------===// 1342a509f6a4f71bb805cc4abbb26722a34dffdddeTed Kremenek 1442a509f6a4f71bb805cc4abbb26722a34dffdddeTed Kremenek#ifndef LLVM_CLANG_AST_PRETTY_PRINTER_H 1542a509f6a4f71bb805cc4abbb26722a34dffdddeTed Kremenek#define LLVM_CLANG_AST_PRETTY_PRINTER_H 1642a509f6a4f71bb805cc4abbb26722a34dffdddeTed Kremenek 179313aac61d425f14fa0b82c3dfe1eb2c3626d38cArgyrios Kyrtzidis#include "clang/Basic/LangOptions.h" 18d47d3b0cfeb7e8564ff77f48130fe63282b6d127Chris Lattner#include "clang/Basic/LLVM.h" 197107d360db751aa974285ae2136aed76b6691b86Chandler Carruth 2042a509f6a4f71bb805cc4abbb26722a34dffdddeTed Kremeneknamespace clang { 2142a509f6a4f71bb805cc4abbb26722a34dffdddeTed Kremenek 2242a509f6a4f71bb805cc4abbb26722a34dffdddeTed Kremenekclass Stmt; 23d249e1d1f1498b81314459ceda19d6ff25c278adDouglas Gregorclass TagDecl; 24e4f2142d00fa5fdb580c4e2413da91882d955381Chris Lattnerclass LangOptions; 25d249e1d1f1498b81314459ceda19d6ff25c278adDouglas Gregor 2642a509f6a4f71bb805cc4abbb26722a34dffdddeTed Kremenekclass PrinterHelper { 2742a509f6a4f71bb805cc4abbb26722a34dffdddeTed Kremenekpublic: 2842a509f6a4f71bb805cc4abbb26722a34dffdddeTed Kremenek virtual ~PrinterHelper(); 29d47d3b0cfeb7e8564ff77f48130fe63282b6d127Chris Lattner virtual bool handledStmt(Stmt* E, raw_ostream& OS) = 0; 3042a509f6a4f71bb805cc4abbb26722a34dffdddeTed Kremenek}; 3142a509f6a4f71bb805cc4abbb26722a34dffdddeTed Kremenek 32d249e1d1f1498b81314459ceda19d6ff25c278adDouglas Gregor/// \brief Describes how types, statements, expressions, and 33d249e1d1f1498b81314459ceda19d6ff25c278adDouglas Gregor/// declarations should be printed. 34d249e1d1f1498b81314459ceda19d6ff25c278adDouglas Gregorstruct PrintingPolicy { 35d249e1d1f1498b81314459ceda19d6ff25c278adDouglas Gregor /// \brief Create a default printing policy for C. 361eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump PrintingPolicy(const LangOptions &LO) 37d1420c6fa788669e49f21e184927c7833881e399Richard Smith : LangOpts(LO), Indentation(2), SuppressSpecifiers(false), 380daaf32723ac78549c507c2a68a5300502703673Abramo Bagnara SuppressTagKeyword(false), SuppressTag(false), SuppressScope(false), 3925270b6e6a8416b7532cfe552b41794418ea19b1Douglas Gregor SuppressUnwrittenScope(false), SuppressInitializers(false), 40d1420c6fa788669e49f21e184927c7833881e399Richard Smith ConstantArraySizeAsWritten(false), AnonymousTagLocations(true), 41d1420c6fa788669e49f21e184927c7833881e399Richard Smith SuppressStrongLifetime(false), Bool(LO.Bool), 42d1420c6fa788669e49f21e184927c7833881e399Richard Smith DumpSourceManager(0) { } 43d249e1d1f1498b81314459ceda19d6ff25c278adDouglas Gregor 44e4f2142d00fa5fdb580c4e2413da91882d955381Chris Lattner /// \brief What language we're printing. 458987b2385d9ba63ada66e1344ace79b04d5cb5c3Douglas Gregor LangOptions LangOpts; 46d249e1d1f1498b81314459ceda19d6ff25c278adDouglas Gregor 47d1420c6fa788669e49f21e184927c7833881e399Richard Smith /// \brief The number of spaces to use to indent each line. 48d1420c6fa788669e49f21e184927c7833881e399Richard Smith unsigned Indentation : 8; 49d1420c6fa788669e49f21e184927c7833881e399Richard Smith 5042f42c0dd5cf71fbfc6fa282d03079a902f6e342Eli Friedman /// \brief Whether we should suppress printing of the actual specifiers for 5142f42c0dd5cf71fbfc6fa282d03079a902f6e342Eli Friedman /// the given type or declaration. 52d249e1d1f1498b81314459ceda19d6ff25c278adDouglas Gregor /// 53d249e1d1f1498b81314459ceda19d6ff25c278adDouglas Gregor /// This flag is only used when we are printing declarators beyond 54d249e1d1f1498b81314459ceda19d6ff25c278adDouglas Gregor /// the first declarator within a declaration group. For example, given: 55d249e1d1f1498b81314459ceda19d6ff25c278adDouglas Gregor /// 56d249e1d1f1498b81314459ceda19d6ff25c278adDouglas Gregor /// \code 57d249e1d1f1498b81314459ceda19d6ff25c278adDouglas Gregor /// const int *x, *y; 58d249e1d1f1498b81314459ceda19d6ff25c278adDouglas Gregor /// \endcode 59d249e1d1f1498b81314459ceda19d6ff25c278adDouglas Gregor /// 6042f42c0dd5cf71fbfc6fa282d03079a902f6e342Eli Friedman /// SuppressSpecifiers will be false when printing the 61d249e1d1f1498b81314459ceda19d6ff25c278adDouglas Gregor /// declaration for "x", so that we will print "int *x"; it will be 62d249e1d1f1498b81314459ceda19d6ff25c278adDouglas Gregor /// \c true when we print "y", so that we suppress printing the 63d249e1d1f1498b81314459ceda19d6ff25c278adDouglas Gregor /// "const int" type specifier and instead only print the "*y". 6442f42c0dd5cf71fbfc6fa282d03079a902f6e342Eli Friedman bool SuppressSpecifiers : 1; 6542f42c0dd5cf71fbfc6fa282d03079a902f6e342Eli Friedman 660daaf32723ac78549c507c2a68a5300502703673Abramo Bagnara /// \brief Whether type printing should skip printing the tag keyword. 670daaf32723ac78549c507c2a68a5300502703673Abramo Bagnara /// 680daaf32723ac78549c507c2a68a5300502703673Abramo Bagnara /// This is used when printing the inner type of elaborated types, 690daaf32723ac78549c507c2a68a5300502703673Abramo Bagnara /// (as the tag keyword is part of the elaborated type): 700daaf32723ac78549c507c2a68a5300502703673Abramo Bagnara /// 710daaf32723ac78549c507c2a68a5300502703673Abramo Bagnara /// \code 720daaf32723ac78549c507c2a68a5300502703673Abramo Bagnara /// struct Geometry::Point; 730daaf32723ac78549c507c2a68a5300502703673Abramo Bagnara /// \endcode 740daaf32723ac78549c507c2a68a5300502703673Abramo Bagnara bool SuppressTagKeyword : 1; 750daaf32723ac78549c507c2a68a5300502703673Abramo Bagnara 7642f42c0dd5cf71fbfc6fa282d03079a902f6e342Eli Friedman /// \brief Whether type printing should skip printing the actual tag type. 7742f42c0dd5cf71fbfc6fa282d03079a902f6e342Eli Friedman /// 7842f42c0dd5cf71fbfc6fa282d03079a902f6e342Eli Friedman /// This is used when the caller needs to print a tag definition in front 7942f42c0dd5cf71fbfc6fa282d03079a902f6e342Eli Friedman /// of the type, as in constructs like the following: 8042f42c0dd5cf71fbfc6fa282d03079a902f6e342Eli Friedman /// 8142f42c0dd5cf71fbfc6fa282d03079a902f6e342Eli Friedman /// \code 8242f42c0dd5cf71fbfc6fa282d03079a902f6e342Eli Friedman /// typedef struct { int x, y; } Point; 8342f42c0dd5cf71fbfc6fa282d03079a902f6e342Eli Friedman /// \endcode 8442f42c0dd5cf71fbfc6fa282d03079a902f6e342Eli Friedman bool SuppressTag : 1; 85d249e1d1f1498b81314459ceda19d6ff25c278adDouglas Gregor 862191b20bfb31fc0e22a158f6b4204cd0b7dbd0fdJohn McCall /// \brief Suppresses printing of scope specifiers. 872191b20bfb31fc0e22a158f6b4204cd0b7dbd0fdJohn McCall bool SuppressScope : 1; 882191b20bfb31fc0e22a158f6b4204cd0b7dbd0fdJohn McCall 8925270b6e6a8416b7532cfe552b41794418ea19b1Douglas Gregor /// \brief Suppress printing parts of scope specifiers that don't need 9025270b6e6a8416b7532cfe552b41794418ea19b1Douglas Gregor /// to be written, e.g., for inline or anonymous namespaces. 9125270b6e6a8416b7532cfe552b41794418ea19b1Douglas Gregor bool SuppressUnwrittenScope : 1; 9225270b6e6a8416b7532cfe552b41794418ea19b1Douglas Gregor 93ad762fcdc16b9e4705b12b09d92b8c026212b906Richard Smith /// \brief Suppress printing of variable initializers. 94ad762fcdc16b9e4705b12b09d92b8c026212b906Richard Smith /// 95ad762fcdc16b9e4705b12b09d92b8c026212b906Richard Smith /// This flag is used when printing the loop variable in a for-range 96ad762fcdc16b9e4705b12b09d92b8c026212b906Richard Smith /// statement. For example, given: 97ad762fcdc16b9e4705b12b09d92b8c026212b906Richard Smith /// 98ad762fcdc16b9e4705b12b09d92b8c026212b906Richard Smith /// \code 99ad762fcdc16b9e4705b12b09d92b8c026212b906Richard Smith /// for (auto x : coll) 100ad762fcdc16b9e4705b12b09d92b8c026212b906Richard Smith /// \endcode 101ad762fcdc16b9e4705b12b09d92b8c026212b906Richard Smith /// 102ad762fcdc16b9e4705b12b09d92b8c026212b906Richard Smith /// SuppressInitializers will be true when printing "auto x", so that the 103ad762fcdc16b9e4705b12b09d92b8c026212b906Richard Smith /// internal initializer constructed for x will not be printed. 104ad762fcdc16b9e4705b12b09d92b8c026212b906Richard Smith bool SuppressInitializers : 1; 105ad762fcdc16b9e4705b12b09d92b8c026212b906Richard Smith 1067e7eb3da052a6d80ddf2377cab0384c798f73f75Douglas Gregor /// \brief Whether we should print the sizes of constant array expressions 1077e7eb3da052a6d80ddf2377cab0384c798f73f75Douglas Gregor /// as written in the sources. 1087e7eb3da052a6d80ddf2377cab0384c798f73f75Douglas Gregor /// 1097e7eb3da052a6d80ddf2377cab0384c798f73f75Douglas Gregor /// This flag is determines whether arrays types declared as 1107e7eb3da052a6d80ddf2377cab0384c798f73f75Douglas Gregor /// 1117e7eb3da052a6d80ddf2377cab0384c798f73f75Douglas Gregor /// \code 1127e7eb3da052a6d80ddf2377cab0384c798f73f75Douglas Gregor /// int a[4+10*10]; 1137e7eb3da052a6d80ddf2377cab0384c798f73f75Douglas Gregor /// char a[] = "A string"; 1147e7eb3da052a6d80ddf2377cab0384c798f73f75Douglas Gregor /// \endcode 1157e7eb3da052a6d80ddf2377cab0384c798f73f75Douglas Gregor /// 1167e7eb3da052a6d80ddf2377cab0384c798f73f75Douglas Gregor /// will be printed as written or as follows: 1177e7eb3da052a6d80ddf2377cab0384c798f73f75Douglas Gregor /// 1187e7eb3da052a6d80ddf2377cab0384c798f73f75Douglas Gregor /// \code 1197e7eb3da052a6d80ddf2377cab0384c798f73f75Douglas Gregor /// int a[104]; 1207e7eb3da052a6d80ddf2377cab0384c798f73f75Douglas Gregor /// char a[9] = "A string"; 1217e7eb3da052a6d80ddf2377cab0384c798f73f75Douglas Gregor /// \endcode 1227e7eb3da052a6d80ddf2377cab0384c798f73f75Douglas Gregor bool ConstantArraySizeAsWritten : 1; 12384139d6ef8967cfdb70d37378a7a65cc4827d44dDouglas Gregor 12484139d6ef8967cfdb70d37378a7a65cc4827d44dDouglas Gregor /// \brief When printing an anonymous tag name, also print the location of 12584139d6ef8967cfdb70d37378a7a65cc4827d44dDouglas Gregor /// that entity (e.g., "enum <anonymous at t.h:10:5>"). Otherwise, just 12684139d6ef8967cfdb70d37378a7a65cc4827d44dDouglas Gregor /// prints "<anonymous>" for the name. 12784139d6ef8967cfdb70d37378a7a65cc4827d44dDouglas Gregor bool AnonymousTagLocations : 1; 128f85e193739c953358c865005855253af4f68a497John McCall 129f85e193739c953358c865005855253af4f68a497John McCall /// \brief When true, suppress printing of the __strong lifetime qualifier in 130f85e193739c953358c865005855253af4f68a497John McCall /// ARC. 131f85e193739c953358c865005855253af4f68a497John McCall unsigned SuppressStrongLifetime : 1; 13230c42404202d2e2512e51efc6066bd614cfdb5a4Douglas Gregor 13330c42404202d2e2512e51efc6066bd614cfdb5a4Douglas Gregor /// \brief Whether we can use 'bool' rather than '_Bool', even if the language 13430c42404202d2e2512e51efc6066bd614cfdb5a4Douglas Gregor /// doesn't actually have 'bool' (because, e.g., it is defined as a macro). 13530c42404202d2e2512e51efc6066bd614cfdb5a4Douglas Gregor unsigned Bool : 1; 136d1420c6fa788669e49f21e184927c7833881e399Richard Smith 137d1420c6fa788669e49f21e184927c7833881e399Richard Smith /// \brief If we are "dumping" rather than "pretty-printing", this points to 138d1420c6fa788669e49f21e184927c7833881e399Richard Smith /// a SourceManager which will be used to dump SourceLocations. Dumping 139d1420c6fa788669e49f21e184927c7833881e399Richard Smith /// involves printing the internal details of the AST and pretty-printing 140d1420c6fa788669e49f21e184927c7833881e399Richard Smith /// involves printing something similar to source code. 141d1420c6fa788669e49f21e184927c7833881e399Richard Smith SourceManager *DumpSourceManager; 142d249e1d1f1498b81314459ceda19d6ff25c278adDouglas Gregor}; 143d249e1d1f1498b81314459ceda19d6ff25c278adDouglas Gregor 14442a509f6a4f71bb805cc4abbb26722a34dffdddeTed Kremenek} // end namespace clang 14542a509f6a4f71bb805cc4abbb26722a34dffdddeTed Kremenek 1468467583c2704e7a9691ea56939a029015f0ade0aGabor Greif#endif 147