annotate clang/lib/Format/UnwrappedLineFormatter.h @ 176:de4ac79aef9d

...
author Shinji KONO <kono@ie.u-ryukyu.ac.jp>
date Mon, 25 May 2020 17:13:11 +0900
parents 1d019706d866
children 5f17cb93ff66
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
150
anatofuz
parents:
diff changeset
1 //===--- UnwrappedLineFormatter.h - Format C++ code -------------*- C++ -*-===//
anatofuz
parents:
diff changeset
2 //
anatofuz
parents:
diff changeset
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
anatofuz
parents:
diff changeset
4 // See https://llvm.org/LICENSE.txt for license information.
anatofuz
parents:
diff changeset
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
anatofuz
parents:
diff changeset
6 //
anatofuz
parents:
diff changeset
7 //===----------------------------------------------------------------------===//
anatofuz
parents:
diff changeset
8 ///
anatofuz
parents:
diff changeset
9 /// \file
anatofuz
parents:
diff changeset
10 /// Implements a combinartorial exploration of all the different
anatofuz
parents:
diff changeset
11 /// linebreaks unwrapped lines can be formatted in.
anatofuz
parents:
diff changeset
12 ///
anatofuz
parents:
diff changeset
13 //===----------------------------------------------------------------------===//
anatofuz
parents:
diff changeset
14
anatofuz
parents:
diff changeset
15 #ifndef LLVM_CLANG_LIB_FORMAT_UNWRAPPEDLINEFORMATTER_H
anatofuz
parents:
diff changeset
16 #define LLVM_CLANG_LIB_FORMAT_UNWRAPPEDLINEFORMATTER_H
anatofuz
parents:
diff changeset
17
anatofuz
parents:
diff changeset
18 #include "ContinuationIndenter.h"
anatofuz
parents:
diff changeset
19 #include "clang/Format/Format.h"
anatofuz
parents:
diff changeset
20 #include <map>
anatofuz
parents:
diff changeset
21
anatofuz
parents:
diff changeset
22 namespace clang {
anatofuz
parents:
diff changeset
23 namespace format {
anatofuz
parents:
diff changeset
24
anatofuz
parents:
diff changeset
25 class ContinuationIndenter;
anatofuz
parents:
diff changeset
26 class WhitespaceManager;
anatofuz
parents:
diff changeset
27
anatofuz
parents:
diff changeset
28 class UnwrappedLineFormatter {
anatofuz
parents:
diff changeset
29 public:
anatofuz
parents:
diff changeset
30 UnwrappedLineFormatter(ContinuationIndenter *Indenter,
anatofuz
parents:
diff changeset
31 WhitespaceManager *Whitespaces,
anatofuz
parents:
diff changeset
32 const FormatStyle &Style,
anatofuz
parents:
diff changeset
33 const AdditionalKeywords &Keywords,
anatofuz
parents:
diff changeset
34 const SourceManager &SourceMgr,
anatofuz
parents:
diff changeset
35 FormattingAttemptStatus *Status)
anatofuz
parents:
diff changeset
36 : Indenter(Indenter), Whitespaces(Whitespaces), Style(Style),
anatofuz
parents:
diff changeset
37 Keywords(Keywords), SourceMgr(SourceMgr), Status(Status) {}
anatofuz
parents:
diff changeset
38
anatofuz
parents:
diff changeset
39 /// Format the current block and return the penalty.
anatofuz
parents:
diff changeset
40 unsigned format(const SmallVectorImpl<AnnotatedLine *> &Lines,
anatofuz
parents:
diff changeset
41 bool DryRun = false, int AdditionalIndent = 0,
anatofuz
parents:
diff changeset
42 bool FixBadIndentation = false, unsigned FirstStartColumn = 0,
anatofuz
parents:
diff changeset
43 unsigned NextStartColumn = 0, unsigned LastStartColumn = 0);
anatofuz
parents:
diff changeset
44
anatofuz
parents:
diff changeset
45 private:
anatofuz
parents:
diff changeset
46 /// Add a new line and the required indent before the first Token
anatofuz
parents:
diff changeset
47 /// of the \c UnwrappedLine if there was no structural parsing error.
anatofuz
parents:
diff changeset
48 void formatFirstToken(const AnnotatedLine &Line,
anatofuz
parents:
diff changeset
49 const AnnotatedLine *PreviousLine,
anatofuz
parents:
diff changeset
50 const SmallVectorImpl<AnnotatedLine *> &Lines,
anatofuz
parents:
diff changeset
51 unsigned Indent, unsigned NewlineIndent);
anatofuz
parents:
diff changeset
52
anatofuz
parents:
diff changeset
53 /// Returns the column limit for a line, taking into account whether we
anatofuz
parents:
diff changeset
54 /// need an escaped newline due to a continued preprocessor directive.
anatofuz
parents:
diff changeset
55 unsigned getColumnLimit(bool InPPDirective,
anatofuz
parents:
diff changeset
56 const AnnotatedLine *NextLine) const;
anatofuz
parents:
diff changeset
57
anatofuz
parents:
diff changeset
58 // Cache to store the penalty of formatting a vector of AnnotatedLines
anatofuz
parents:
diff changeset
59 // starting from a specific additional offset. Improves performance if there
anatofuz
parents:
diff changeset
60 // are many nested blocks.
anatofuz
parents:
diff changeset
61 std::map<std::pair<const SmallVectorImpl<AnnotatedLine *> *, unsigned>,
anatofuz
parents:
diff changeset
62 unsigned>
anatofuz
parents:
diff changeset
63 PenaltyCache;
anatofuz
parents:
diff changeset
64
anatofuz
parents:
diff changeset
65 ContinuationIndenter *Indenter;
anatofuz
parents:
diff changeset
66 WhitespaceManager *Whitespaces;
anatofuz
parents:
diff changeset
67 const FormatStyle &Style;
anatofuz
parents:
diff changeset
68 const AdditionalKeywords &Keywords;
anatofuz
parents:
diff changeset
69 const SourceManager &SourceMgr;
anatofuz
parents:
diff changeset
70 FormattingAttemptStatus *Status;
anatofuz
parents:
diff changeset
71 };
anatofuz
parents:
diff changeset
72 } // end namespace format
anatofuz
parents:
diff changeset
73 } // end namespace clang
anatofuz
parents:
diff changeset
74
anatofuz
parents:
diff changeset
75 #endif // LLVM_CLANG_LIB_FORMAT_UNWRAPPEDLINEFORMATTER_H