1 //===--- UnwrappedLineFormatter.h - Format C++ code -------------*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
11 /// \brief Implements a combinartorial exploration of all the different
12 /// linebreaks unwrapped lines can be formatted in.
14 //===----------------------------------------------------------------------===//
16 #ifndef LLVM_CLANG_LIB_FORMAT_UNWRAPPEDLINEFORMATTER_H
17 #define LLVM_CLANG_LIB_FORMAT_UNWRAPPEDLINEFORMATTER_H
19 #include "ContinuationIndenter.h"
20 #include "clang/Format/Format.h"
26 class ContinuationIndenter;
27 class WhitespaceManager;
29 class UnwrappedLineFormatter {
31 UnwrappedLineFormatter(ContinuationIndenter *Indenter,
32 WhitespaceManager *Whitespaces,
33 const FormatStyle &Style,
34 const AdditionalKeywords &Keywords,
35 const SourceManager &SourceMgr,
36 FormattingAttemptStatus *Status)
37 : Indenter(Indenter), Whitespaces(Whitespaces), Style(Style),
38 Keywords(Keywords), SourceMgr(SourceMgr), Status(Status) {}
40 /// \brief Format the current block and return the penalty.
41 unsigned format(const SmallVectorImpl<AnnotatedLine *> &Lines,
42 bool DryRun = false, int AdditionalIndent = 0,
43 bool FixBadIndentation = false,
44 unsigned FirstStartColumn = 0,
45 unsigned NextStartColumn = 0,
46 unsigned LastStartColumn = 0);
49 /// \brief Add a new line and the required indent before the first Token
50 /// of the \c UnwrappedLine if there was no structural parsing error.
51 void formatFirstToken(const AnnotatedLine &Line,
52 const AnnotatedLine *PreviousLine, unsigned Indent,
53 unsigned NewlineIndent);
55 /// \brief Returns the column limit for a line, taking into account whether we
56 /// need an escaped newline due to a continued preprocessor directive.
57 unsigned getColumnLimit(bool InPPDirective,
58 const AnnotatedLine *NextLine) const;
60 // Cache to store the penalty of formatting a vector of AnnotatedLines
61 // starting from a specific additional offset. Improves performance if there
62 // are many nested blocks.
63 std::map<std::pair<const SmallVectorImpl<AnnotatedLine *> *, unsigned>,
67 ContinuationIndenter *Indenter;
68 WhitespaceManager *Whitespaces;
69 const FormatStyle &Style;
70 const AdditionalKeywords &Keywords;
71 const SourceManager &SourceMgr;
72 FormattingAttemptStatus *Status;
74 } // end namespace format
75 } // end namespace clang
77 #endif // LLVM_CLANG_LIB_FORMAT_UNWRAPPEDLINEFORMATTER_H