blob: b6b726cfb21558fa79046d060a73394ff9bb2fec [file] [log] [blame]
Daniel Jasperbac016b2012-12-03 18:12:45 +00001//===--- Format.cpp - Format C++ code -------------------------------------===//
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/// \file
11/// \brief This file implements functions declared in Format.h. This will be
12/// split into separate files as we go.
13///
Daniel Jasperbac016b2012-12-03 18:12:45 +000014//===----------------------------------------------------------------------===//
15
Manuel Klimekca547db2013-01-16 14:55:28 +000016#define DEBUG_TYPE "format-formatter"
17
Alexander Kornienko70ce7882013-04-15 14:28:00 +000018#include "BreakableToken.h"
Daniel Jasper32d28ee2013-01-29 21:01:14 +000019#include "TokenAnnotator.h"
Chandler Carruth55fc8732012-12-04 09:13:33 +000020#include "UnwrappedLineParser.h"
Alexander Kornienko70ce7882013-04-15 14:28:00 +000021#include "WhitespaceManager.h"
Daniel Jasper8a999452013-05-16 10:40:07 +000022#include "clang/Basic/Diagnostic.h"
Daniel Jasper675d2e32012-12-21 10:20:02 +000023#include "clang/Basic/OperatorPrecedence.h"
Chandler Carruthb99083e2013-01-02 10:28:36 +000024#include "clang/Basic/SourceManager.h"
Manuel Klimekca547db2013-01-16 14:55:28 +000025#include "clang/Format/Format.h"
Daniel Jasperbac016b2012-12-03 18:12:45 +000026#include "clang/Lex/Lexer.h"
Alexander Kornienko5262dd92013-03-27 11:52:18 +000027#include "llvm/ADT/STLExtras.h"
Manuel Klimek32a2fd72013-02-13 10:46:36 +000028#include "llvm/Support/Allocator.h"
Manuel Klimekca547db2013-01-16 14:55:28 +000029#include "llvm/Support/Debug.h"
Alexander Kornienkod71ec162013-05-07 15:32:14 +000030#include "llvm/Support/YAMLTraits.h"
Manuel Klimek32a2fd72013-02-13 10:46:36 +000031#include <queue>
Daniel Jasper8822d3a2012-12-04 13:02:32 +000032#include <string>
33
Alexander Kornienkod71ec162013-05-07 15:32:14 +000034namespace llvm {
35namespace yaml {
36template <>
37struct ScalarEnumerationTraits<clang::format::FormatStyle::LanguageStandard> {
Manuel Klimek44135b82013-05-13 12:51:40 +000038 static void enumeration(IO &IO,
39 clang::format::FormatStyle::LanguageStandard &Value) {
40 IO.enumCase(Value, "C++03", clang::format::FormatStyle::LS_Cpp03);
41 IO.enumCase(Value, "C++11", clang::format::FormatStyle::LS_Cpp11);
42 IO.enumCase(Value, "Auto", clang::format::FormatStyle::LS_Auto);
43 }
44};
45
Daniel Jasper1fb8d882013-05-14 09:30:02 +000046template <>
Manuel Klimek44135b82013-05-13 12:51:40 +000047struct ScalarEnumerationTraits<clang::format::FormatStyle::BraceBreakingStyle> {
48 static void
49 enumeration(IO &IO, clang::format::FormatStyle::BraceBreakingStyle &Value) {
50 IO.enumCase(Value, "Attach", clang::format::FormatStyle::BS_Attach);
51 IO.enumCase(Value, "Linux", clang::format::FormatStyle::BS_Linux);
52 IO.enumCase(Value, "Stroustrup", clang::format::FormatStyle::BS_Stroustrup);
Alexander Kornienkod71ec162013-05-07 15:32:14 +000053 }
54};
55
56template <> struct MappingTraits<clang::format::FormatStyle> {
57 static void mapping(llvm::yaml::IO &IO, clang::format::FormatStyle &Style) {
Alexander Kornienkodd256312013-05-10 11:56:10 +000058 if (IO.outputting()) {
59 StringRef StylesArray[] = { "LLVM", "Google", "Chromium", "Mozilla" };
60 ArrayRef<StringRef> Styles(StylesArray);
61 for (size_t i = 0, e = Styles.size(); i < e; ++i) {
62 StringRef StyleName(Styles[i]);
Alexander Kornienko885f87b2013-05-19 00:53:30 +000063 clang::format::FormatStyle PredefinedStyle;
64 if (clang::format::getPredefinedStyle(StyleName, &PredefinedStyle) &&
65 Style == PredefinedStyle) {
Alexander Kornienkodd256312013-05-10 11:56:10 +000066 IO.mapOptional("# BasedOnStyle", StyleName);
67 break;
68 }
69 }
70 } else {
Alexander Kornienkod71ec162013-05-07 15:32:14 +000071 StringRef BasedOnStyle;
72 IO.mapOptional("BasedOnStyle", BasedOnStyle);
Alexander Kornienkod71ec162013-05-07 15:32:14 +000073 if (!BasedOnStyle.empty())
Alexander Kornienko885f87b2013-05-19 00:53:30 +000074 if (!clang::format::getPredefinedStyle(BasedOnStyle, &Style)) {
75 IO.setError(Twine("Unknown value for BasedOnStyle: ", BasedOnStyle));
76 return;
77 }
Alexander Kornienkod71ec162013-05-07 15:32:14 +000078 }
79
80 IO.mapOptional("AccessModifierOffset", Style.AccessModifierOffset);
81 IO.mapOptional("AlignEscapedNewlinesLeft", Style.AlignEscapedNewlinesLeft);
82 IO.mapOptional("AllowAllParametersOfDeclarationOnNextLine",
83 Style.AllowAllParametersOfDeclarationOnNextLine);
84 IO.mapOptional("AllowShortIfStatementsOnASingleLine",
85 Style.AllowShortIfStatementsOnASingleLine);
Daniel Jasperf11bbb92013-05-16 12:12:21 +000086 IO.mapOptional("AllowShortLoopsOnASingleLine",
87 Style.AllowShortLoopsOnASingleLine);
Daniel Jasperbbc87762013-05-29 12:07:31 +000088 IO.mapOptional("AlwaysBreakTemplateDeclarations",
89 Style.AlwaysBreakTemplateDeclarations);
Alexander Kornienko56312022013-07-04 12:02:44 +000090 IO.mapOptional("AlwaysBreakBeforeMultilineStrings",
91 Style.AlwaysBreakBeforeMultilineStrings);
Alexander Kornienkod71ec162013-05-07 15:32:14 +000092 IO.mapOptional("BinPackParameters", Style.BinPackParameters);
93 IO.mapOptional("ColumnLimit", Style.ColumnLimit);
94 IO.mapOptional("ConstructorInitializerAllOnOneLineOrOnePerLine",
95 Style.ConstructorInitializerAllOnOneLineOrOnePerLine);
96 IO.mapOptional("DerivePointerBinding", Style.DerivePointerBinding);
97 IO.mapOptional("IndentCaseLabels", Style.IndentCaseLabels);
98 IO.mapOptional("MaxEmptyLinesToKeep", Style.MaxEmptyLinesToKeep);
99 IO.mapOptional("ObjCSpaceBeforeProtocolList",
100 Style.ObjCSpaceBeforeProtocolList);
Alexander Kornienko2785b9a2013-06-07 16:02:52 +0000101 IO.mapOptional("PenaltyBreakComment", Style.PenaltyBreakComment);
102 IO.mapOptional("PenaltyBreakString", Style.PenaltyBreakString);
Alexander Kornienkod71ec162013-05-07 15:32:14 +0000103 IO.mapOptional("PenaltyExcessCharacter", Style.PenaltyExcessCharacter);
104 IO.mapOptional("PenaltyReturnTypeOnItsOwnLine",
105 Style.PenaltyReturnTypeOnItsOwnLine);
106 IO.mapOptional("PointerBindsToType", Style.PointerBindsToType);
107 IO.mapOptional("SpacesBeforeTrailingComments",
108 Style.SpacesBeforeTrailingComments);
Daniel Jasper1bee0732013-05-23 18:05:18 +0000109 IO.mapOptional("SpacesInBracedLists", Style.SpacesInBracedLists);
Alexander Kornienkod71ec162013-05-07 15:32:14 +0000110 IO.mapOptional("Standard", Style.Standard);
Manuel Klimek07a64ec2013-05-13 08:42:42 +0000111 IO.mapOptional("IndentWidth", Style.IndentWidth);
Manuel Klimek7c9a93e2013-05-13 09:22:11 +0000112 IO.mapOptional("UseTab", Style.UseTab);
Manuel Klimek44135b82013-05-13 12:51:40 +0000113 IO.mapOptional("BreakBeforeBraces", Style.BreakBeforeBraces);
Manuel Klimeka9a7f102013-06-21 17:25:42 +0000114 IO.mapOptional("IndentFunctionDeclarationAfterType",
115 Style.IndentFunctionDeclarationAfterType);
Alexander Kornienkod71ec162013-05-07 15:32:14 +0000116 }
117};
118}
119}
120
Daniel Jasperbac016b2012-12-03 18:12:45 +0000121namespace clang {
122namespace format {
123
Daniel Jasperbac016b2012-12-03 18:12:45 +0000124FormatStyle getLLVMStyle() {
125 FormatStyle LLVMStyle;
Daniel Jasperbac016b2012-12-03 18:12:45 +0000126 LLVMStyle.AccessModifierOffset = -2;
Alexander Kornienkofb594862013-05-06 14:11:27 +0000127 LLVMStyle.AlignEscapedNewlinesLeft = false;
Daniel Jasperf1579602013-01-29 16:03:49 +0000128 LLVMStyle.AllowAllParametersOfDeclarationOnNextLine = true;
Daniel Jasper6f5bb2c2013-01-14 16:24:39 +0000129 LLVMStyle.AllowShortIfStatementsOnASingleLine = false;
Daniel Jasperf11bbb92013-05-16 12:12:21 +0000130 LLVMStyle.AllowShortLoopsOnASingleLine = false;
Daniel Jasperbbc87762013-05-29 12:07:31 +0000131 LLVMStyle.AlwaysBreakTemplateDeclarations = false;
Alexander Kornienko56312022013-07-04 12:02:44 +0000132 LLVMStyle.AlwaysBreakBeforeMultilineStrings = false;
Alexander Kornienkofb594862013-05-06 14:11:27 +0000133 LLVMStyle.BinPackParameters = true;
134 LLVMStyle.ColumnLimit = 80;
135 LLVMStyle.ConstructorInitializerAllOnOneLineOrOnePerLine = false;
136 LLVMStyle.DerivePointerBinding = false;
137 LLVMStyle.IndentCaseLabels = false;
138 LLVMStyle.MaxEmptyLinesToKeep = 1;
Nico Weber5f500df2013-01-10 20:12:55 +0000139 LLVMStyle.ObjCSpaceBeforeProtocolList = true;
Alexander Kornienko2785b9a2013-06-07 16:02:52 +0000140 LLVMStyle.PenaltyBreakComment = 45;
141 LLVMStyle.PenaltyBreakString = 1000;
Daniel Jasper01786732013-02-04 07:21:18 +0000142 LLVMStyle.PenaltyExcessCharacter = 1000000;
Daniel Jasper88cc5622013-07-08 14:25:23 +0000143 LLVMStyle.PenaltyReturnTypeOnItsOwnLine = 60;
Alexander Kornienkofb594862013-05-06 14:11:27 +0000144 LLVMStyle.PointerBindsToType = false;
145 LLVMStyle.SpacesBeforeTrailingComments = 1;
Daniel Jasper2424eef2013-05-23 10:15:45 +0000146 LLVMStyle.SpacesInBracedLists = true;
Alexander Kornienkofb594862013-05-06 14:11:27 +0000147 LLVMStyle.Standard = FormatStyle::LS_Cpp03;
Manuel Klimek07a64ec2013-05-13 08:42:42 +0000148 LLVMStyle.IndentWidth = 2;
Manuel Klimek7c9a93e2013-05-13 09:22:11 +0000149 LLVMStyle.UseTab = false;
Manuel Klimek44135b82013-05-13 12:51:40 +0000150 LLVMStyle.BreakBeforeBraces = FormatStyle::BS_Attach;
Manuel Klimeka9a7f102013-06-21 17:25:42 +0000151 LLVMStyle.IndentFunctionDeclarationAfterType = false;
Daniel Jasperbac016b2012-12-03 18:12:45 +0000152 return LLVMStyle;
153}
154
155FormatStyle getGoogleStyle() {
156 FormatStyle GoogleStyle;
Daniel Jasperbac016b2012-12-03 18:12:45 +0000157 GoogleStyle.AccessModifierOffset = -1;
Alexander Kornienkofb594862013-05-06 14:11:27 +0000158 GoogleStyle.AlignEscapedNewlinesLeft = true;
Daniel Jasperf1579602013-01-29 16:03:49 +0000159 GoogleStyle.AllowAllParametersOfDeclarationOnNextLine = true;
Daniel Jasper94d6ad72013-04-24 13:46:00 +0000160 GoogleStyle.AllowShortIfStatementsOnASingleLine = true;
Daniel Jasper1bee0732013-05-23 18:05:18 +0000161 GoogleStyle.AllowShortLoopsOnASingleLine = true;
Daniel Jasperbbc87762013-05-29 12:07:31 +0000162 GoogleStyle.AlwaysBreakTemplateDeclarations = true;
Alexander Kornienko56312022013-07-04 12:02:44 +0000163 GoogleStyle.AlwaysBreakBeforeMultilineStrings = true;
Alexander Kornienkofb594862013-05-06 14:11:27 +0000164 GoogleStyle.BinPackParameters = true;
165 GoogleStyle.ColumnLimit = 80;
166 GoogleStyle.ConstructorInitializerAllOnOneLineOrOnePerLine = true;
167 GoogleStyle.DerivePointerBinding = true;
168 GoogleStyle.IndentCaseLabels = true;
169 GoogleStyle.MaxEmptyLinesToKeep = 1;
Nico Weber5f500df2013-01-10 20:12:55 +0000170 GoogleStyle.ObjCSpaceBeforeProtocolList = false;
Alexander Kornienko2785b9a2013-06-07 16:02:52 +0000171 GoogleStyle.PenaltyBreakComment = 45;
172 GoogleStyle.PenaltyBreakString = 1000;
Daniel Jasper01786732013-02-04 07:21:18 +0000173 GoogleStyle.PenaltyExcessCharacter = 1000000;
Daniel Jasper1407bee2013-04-11 14:29:13 +0000174 GoogleStyle.PenaltyReturnTypeOnItsOwnLine = 200;
Alexander Kornienkofb594862013-05-06 14:11:27 +0000175 GoogleStyle.PointerBindsToType = true;
176 GoogleStyle.SpacesBeforeTrailingComments = 2;
Daniel Jasper2424eef2013-05-23 10:15:45 +0000177 GoogleStyle.SpacesInBracedLists = false;
Alexander Kornienkofb594862013-05-06 14:11:27 +0000178 GoogleStyle.Standard = FormatStyle::LS_Auto;
Manuel Klimek07a64ec2013-05-13 08:42:42 +0000179 GoogleStyle.IndentWidth = 2;
Manuel Klimek7c9a93e2013-05-13 09:22:11 +0000180 GoogleStyle.UseTab = false;
Manuel Klimek44135b82013-05-13 12:51:40 +0000181 GoogleStyle.BreakBeforeBraces = FormatStyle::BS_Attach;
Manuel Klimeka9a7f102013-06-21 17:25:42 +0000182 GoogleStyle.IndentFunctionDeclarationAfterType = true;
Daniel Jasperbac016b2012-12-03 18:12:45 +0000183 return GoogleStyle;
184}
185
Daniel Jasper6f5bb2c2013-01-14 16:24:39 +0000186FormatStyle getChromiumStyle() {
187 FormatStyle ChromiumStyle = getGoogleStyle();
Daniel Jasperf1579602013-01-29 16:03:49 +0000188 ChromiumStyle.AllowAllParametersOfDeclarationOnNextLine = false;
Daniel Jasper94d6ad72013-04-24 13:46:00 +0000189 ChromiumStyle.AllowShortIfStatementsOnASingleLine = false;
Daniel Jasperf11bbb92013-05-16 12:12:21 +0000190 ChromiumStyle.AllowShortLoopsOnASingleLine = false;
Daniel Jasperfaab0d32013-02-27 09:47:53 +0000191 ChromiumStyle.BinPackParameters = false;
Daniel Jasper8ff690a2013-02-06 14:22:40 +0000192 ChromiumStyle.Standard = FormatStyle::LS_Cpp03;
193 ChromiumStyle.DerivePointerBinding = false;
Daniel Jasper6f5bb2c2013-01-14 16:24:39 +0000194 return ChromiumStyle;
195}
196
Alexander Kornienkofb594862013-05-06 14:11:27 +0000197FormatStyle getMozillaStyle() {
198 FormatStyle MozillaStyle = getLLVMStyle();
199 MozillaStyle.AllowAllParametersOfDeclarationOnNextLine = false;
200 MozillaStyle.ConstructorInitializerAllOnOneLineOrOnePerLine = true;
201 MozillaStyle.DerivePointerBinding = true;
202 MozillaStyle.IndentCaseLabels = true;
203 MozillaStyle.ObjCSpaceBeforeProtocolList = false;
204 MozillaStyle.PenaltyReturnTypeOnItsOwnLine = 200;
205 MozillaStyle.PointerBindsToType = true;
206 return MozillaStyle;
207}
208
Alexander Kornienko885f87b2013-05-19 00:53:30 +0000209bool getPredefinedStyle(StringRef Name, FormatStyle *Style) {
Alexander Kornienkod71ec162013-05-07 15:32:14 +0000210 if (Name.equals_lower("llvm"))
Alexander Kornienko885f87b2013-05-19 00:53:30 +0000211 *Style = getLLVMStyle();
212 else if (Name.equals_lower("chromium"))
213 *Style = getChromiumStyle();
214 else if (Name.equals_lower("mozilla"))
215 *Style = getMozillaStyle();
216 else if (Name.equals_lower("google"))
217 *Style = getGoogleStyle();
218 else
219 return false;
Alexander Kornienkod71ec162013-05-07 15:32:14 +0000220
Alexander Kornienko885f87b2013-05-19 00:53:30 +0000221 return true;
Alexander Kornienkod71ec162013-05-07 15:32:14 +0000222}
223
224llvm::error_code parseConfiguration(StringRef Text, FormatStyle *Style) {
Alexander Kornienko107db3c2013-05-20 15:18:01 +0000225 if (Text.trim().empty())
226 return llvm::make_error_code(llvm::errc::invalid_argument);
Alexander Kornienkod71ec162013-05-07 15:32:14 +0000227 llvm::yaml::Input Input(Text);
228 Input >> *Style;
229 return Input.error();
230}
231
232std::string configurationAsText(const FormatStyle &Style) {
233 std::string Text;
234 llvm::raw_string_ostream Stream(Text);
235 llvm::yaml::Output Output(Stream);
236 // We use the same mapping method for input and output, so we need a non-const
237 // reference here.
238 FormatStyle NonConstStyle = Style;
239 Output << NonConstStyle;
Alexander Kornienko2b6acb62013-05-13 12:56:35 +0000240 return Stream.str();
Alexander Kornienkod71ec162013-05-07 15:32:14 +0000241}
242
Daniel Jasperce3d1a62013-02-08 08:22:00 +0000243// Returns the length of everything up to the first possible line break after
244// the ), ], } or > matching \c Tok.
Manuel Klimekb3987012013-05-29 14:47:47 +0000245static unsigned getLengthToMatchingParen(const FormatToken &Tok) {
Daniel Jasperce3d1a62013-02-08 08:22:00 +0000246 if (Tok.MatchingParen == NULL)
247 return 0;
Manuel Klimekb3987012013-05-29 14:47:47 +0000248 FormatToken *End = Tok.MatchingParen;
249 while (End->Next && !End->Next->CanBreakBefore) {
250 End = End->Next;
Daniel Jasperce3d1a62013-02-08 08:22:00 +0000251 }
252 return End->TotalLength - Tok.TotalLength + 1;
253}
254
Craig Topper83f81d72013-06-30 22:29:28 +0000255namespace {
256
Daniel Jasperbac016b2012-12-03 18:12:45 +0000257class UnwrappedLineFormatter {
258public:
Manuel Klimek94fc6f12013-01-10 19:17:33 +0000259 UnwrappedLineFormatter(const FormatStyle &Style, SourceManager &SourceMgr,
Daniel Jasper995e8202013-01-14 13:08:07 +0000260 const AnnotatedLine &Line, unsigned FirstIndent,
Manuel Klimekb3987012013-05-29 14:47:47 +0000261 const FormatToken *RootToken,
Alexander Kornienko00895102013-06-05 14:09:10 +0000262 WhitespaceManager &Whitespaces,
263 encoding::Encoding Encoding)
Daniel Jasper1321eb52012-12-18 21:05:13 +0000264 : Style(Style), SourceMgr(SourceMgr), Line(Line),
Daniel Jasperdcc2a622013-01-18 08:44:07 +0000265 FirstIndent(FirstIndent), RootToken(RootToken),
Alexander Kornienko00895102013-06-05 14:09:10 +0000266 Whitespaces(Whitespaces), Count(0), Encoding(Encoding) {}
Daniel Jasperbac016b2012-12-03 18:12:45 +0000267
Manuel Klimekd4397b92013-01-04 23:34:14 +0000268 /// \brief Formats an \c UnwrappedLine.
Manuel Klimeke573c3f2013-05-22 12:51:29 +0000269 void format(const AnnotatedLine *NextLine) {
Daniel Jasper3b5943f2012-12-06 09:56:08 +0000270 // Initialize state dependent on indent.
Daniel Jasper604eb4c2013-01-11 10:22:12 +0000271 LineState State;
Manuel Klimek3f8c7f32013-01-10 18:45:26 +0000272 State.Column = FirstIndent;
Manuel Klimekb3987012013-05-29 14:47:47 +0000273 State.NextToken = RootToken;
Daniel Jasper2a409b62013-07-08 14:34:09 +0000274 State.Stack.push_back(ParenState(FirstIndent, FirstIndent,
275 /*AvoidBinPacking=*/false,
276 /*NoLineBreak=*/false));
Daniel Jaspera324a0e2012-12-21 14:37:20 +0000277 State.LineContainsContinuedForLoopSection = false;
Daniel Jasper29f123b2013-02-08 15:28:42 +0000278 State.ParenLevel = 0;
Manuel Klimekb56b6d12013-02-20 15:25:48 +0000279 State.StartOfStringLiteral = 0;
Daniel Jaspercf5767d2013-02-18 11:05:07 +0000280 State.StartOfLineLevel = State.ParenLevel;
Daniel Jasper07ca5472013-07-05 09:14:35 +0000281 State.LowestLevelOnLine = State.ParenLevel;
Daniel Jasper54b4e442013-05-22 05:27:42 +0000282 State.IgnoreStackForComparison = false;
Daniel Jasper3b5943f2012-12-06 09:56:08 +0000283
284 // The first token has already been indented and thus consumed.
Nico Weber27268772013-06-26 00:30:14 +0000285 moveStateToNextToken(State, /*DryRun=*/false);
Daniel Jasperbac016b2012-12-03 18:12:45 +0000286
Daniel Jasper68ef0df2013-02-01 11:00:45 +0000287 // If everything fits on a single line, just put it there.
Daniel Jaspera4d46212013-02-28 11:05:57 +0000288 unsigned ColumnLimit = Style.ColumnLimit;
289 if (NextLine && NextLine->InPPDirective &&
Manuel Klimekb3987012013-05-29 14:47:47 +0000290 !NextLine->First->HasUnescapedNewline)
Daniel Jaspera4d46212013-02-28 11:05:57 +0000291 ColumnLimit = getColumnLimit();
292 if (Line.Last->TotalLength <= ColumnLimit - FirstIndent) {
Daniel Jasper68ef0df2013-02-01 11:00:45 +0000293 while (State.NextToken != NULL) {
Daniel Jasper1321eb52012-12-18 21:05:13 +0000294 addTokenToState(false, false, State);
Daniel Jasper1321eb52012-12-18 21:05:13 +0000295 }
Daniel Jasperbac016b2012-12-03 18:12:45 +0000296 }
Daniel Jasper68ef0df2013-02-01 11:00:45 +0000297
Daniel Jasperce3d1a62013-02-08 08:22:00 +0000298 // If the ObjC method declaration does not fit on a line, we should format
299 // it with one arg per line.
300 if (Line.Type == LT_ObjCMethodDecl)
301 State.Stack.back().BreakBeforeParameter = true;
302
Daniel Jasper68ef0df2013-02-01 11:00:45 +0000303 // Find best solution in solution space.
Manuel Klimeke573c3f2013-05-22 12:51:29 +0000304 analyzeSolutionSpace(State);
Daniel Jasperbac016b2012-12-03 18:12:45 +0000305 }
306
307private:
Manuel Klimekb3987012013-05-29 14:47:47 +0000308 void DebugTokenState(const FormatToken &FormatTok) {
309 const Token &Tok = FormatTok.Tok;
Alexander Kornienkodd256312013-05-10 11:56:10 +0000310 llvm::dbgs() << StringRef(SourceMgr.getCharacterData(Tok.getLocation()),
Daniel Jasper1a1ce832013-01-29 11:27:30 +0000311 Tok.getLength());
Alexander Kornienkodd256312013-05-10 11:56:10 +0000312 llvm::dbgs();
Manuel Klimekca547db2013-01-16 14:55:28 +0000313 }
314
Daniel Jasper604eb4c2013-01-11 10:22:12 +0000315 struct ParenState {
Daniel Jasperd399bff2013-02-05 09:41:21 +0000316 ParenState(unsigned Indent, unsigned LastSpace, bool AvoidBinPacking,
Daniel Jasper001bf4e2013-04-22 07:59:53 +0000317 bool NoLineBreak)
Daniel Jasper29f123b2013-02-08 15:28:42 +0000318 : Indent(Indent), LastSpace(LastSpace), FirstLessLess(0),
319 BreakBeforeClosingBrace(false), QuestionColumn(0),
Daniel Jasperce3d1a62013-02-08 08:22:00 +0000320 AvoidBinPacking(AvoidBinPacking), BreakBeforeParameter(false),
Daniel Jasper001bf4e2013-04-22 07:59:53 +0000321 NoLineBreak(NoLineBreak), ColonPos(0), StartOfFunctionCall(0),
322 NestedNameSpecifierContinuation(0), CallContinuation(0),
Daniel Jasper88cc5622013-07-08 14:25:23 +0000323 VariablePos(0), ContainsLineBreak(false) {}
Daniel Jaspera4974cf2012-12-24 16:43:00 +0000324
Daniel Jasperbac016b2012-12-03 18:12:45 +0000325 /// \brief The position to which a specific parenthesis level needs to be
326 /// indented.
Daniel Jasper604eb4c2013-01-11 10:22:12 +0000327 unsigned Indent;
Daniel Jasperbac016b2012-12-03 18:12:45 +0000328
Daniel Jasper3b5943f2012-12-06 09:56:08 +0000329 /// \brief The position of the last space on each level.
330 ///
331 /// Used e.g. to break like:
332 /// functionCall(Parameter, otherCall(
333 /// OtherParameter));
Daniel Jasper604eb4c2013-01-11 10:22:12 +0000334 unsigned LastSpace;
Daniel Jasperbac016b2012-12-03 18:12:45 +0000335
Daniel Jasper3b5943f2012-12-06 09:56:08 +0000336 /// \brief The position the first "<<" operator encountered on each level.
337 ///
338 /// Used to align "<<" operators. 0 if no such operator has been encountered
339 /// on a level.
Daniel Jasper604eb4c2013-01-11 10:22:12 +0000340 unsigned FirstLessLess;
Daniel Jasper3b5943f2012-12-06 09:56:08 +0000341
Manuel Klimekc8c8a472013-01-10 15:58:26 +0000342 /// \brief Whether a newline needs to be inserted before the block's closing
343 /// brace.
344 ///
345 /// We only want to insert a newline before the closing brace if there also
346 /// was a newline after the beginning left brace.
Daniel Jasper604eb4c2013-01-11 10:22:12 +0000347 bool BreakBeforeClosingBrace;
348
Daniel Jasperbfe6fd42013-01-28 12:45:14 +0000349 /// \brief The column of a \c ? in a conditional expression;
350 unsigned QuestionColumn;
351
Daniel Jasperf343cab2013-01-31 14:59:26 +0000352 /// \brief Avoid bin packing, i.e. multiple parameters/elements on multiple
353 /// lines, in this context.
354 bool AvoidBinPacking;
355
356 /// \brief Break after the next comma (or all the commas in this context if
357 /// \c AvoidBinPacking is \c true).
Daniel Jasperce3d1a62013-02-08 08:22:00 +0000358 bool BreakBeforeParameter;
Daniel Jasperf343cab2013-01-31 14:59:26 +0000359
Daniel Jasper001bf4e2013-04-22 07:59:53 +0000360 /// \brief Line breaking in this context would break a formatting rule.
361 bool NoLineBreak;
Daniel Jasper7e9bf8c2013-01-11 11:37:55 +0000362
Daniel Jasper63d7ced2013-02-05 10:07:47 +0000363 /// \brief The position of the colon in an ObjC method declaration/call.
364 unsigned ColonPos;
Daniel Jasperc4615b72013-02-20 12:56:39 +0000365
Daniel Jasper24849712013-03-01 16:48:32 +0000366 /// \brief The start of the most recent function in a builder-type call.
367 unsigned StartOfFunctionCall;
368
Daniel Jasper37911302013-04-02 14:33:13 +0000369 /// \brief If a nested name specifier was broken over multiple lines, this
370 /// contains the start column of the second line. Otherwise 0.
371 unsigned NestedNameSpecifierContinuation;
372
373 /// \brief If a call expression was broken over multiple lines, this
374 /// contains the start column of the second line. Otherwise 0.
375 unsigned CallContinuation;
376
Daniel Jasper8ed9f2b2013-04-03 13:36:17 +0000377 /// \brief The column of the first variable name in a variable declaration.
378 ///
379 /// Used to align further variables if necessary.
380 unsigned VariablePos;
381
Daniel Jasper88cc5622013-07-08 14:25:23 +0000382 /// \brief \c true if this \c ParenState already contains a line-break.
Daniel Jasperc3df5ff2013-05-13 09:19:24 +0000383 ///
Daniel Jasper88cc5622013-07-08 14:25:23 +0000384 /// The first line break in a certain \c ParenState causes extra penalty so
385 /// that clang-format prefers similar breaks, i.e. breaks in the same
386 /// parenthesis.
387 bool ContainsLineBreak;
Daniel Jasperc3df5ff2013-05-13 09:19:24 +0000388
Daniel Jasper604eb4c2013-01-11 10:22:12 +0000389 bool operator<(const ParenState &Other) const {
390 if (Indent != Other.Indent)
Daniel Jasper7d19bc22013-01-11 14:23:32 +0000391 return Indent < Other.Indent;
Daniel Jasper604eb4c2013-01-11 10:22:12 +0000392 if (LastSpace != Other.LastSpace)
393 return LastSpace < Other.LastSpace;
394 if (FirstLessLess != Other.FirstLessLess)
395 return FirstLessLess < Other.FirstLessLess;
Daniel Jasper7e9bf8c2013-01-11 11:37:55 +0000396 if (BreakBeforeClosingBrace != Other.BreakBeforeClosingBrace)
397 return BreakBeforeClosingBrace;
Daniel Jasperbfe6fd42013-01-28 12:45:14 +0000398 if (QuestionColumn != Other.QuestionColumn)
399 return QuestionColumn < Other.QuestionColumn;
Daniel Jasperf343cab2013-01-31 14:59:26 +0000400 if (AvoidBinPacking != Other.AvoidBinPacking)
401 return AvoidBinPacking;
Daniel Jasperce3d1a62013-02-08 08:22:00 +0000402 if (BreakBeforeParameter != Other.BreakBeforeParameter)
403 return BreakBeforeParameter;
Daniel Jasper001bf4e2013-04-22 07:59:53 +0000404 if (NoLineBreak != Other.NoLineBreak)
405 return NoLineBreak;
Daniel Jasper63d7ced2013-02-05 10:07:47 +0000406 if (ColonPos != Other.ColonPos)
407 return ColonPos < Other.ColonPos;
Daniel Jasper24849712013-03-01 16:48:32 +0000408 if (StartOfFunctionCall != Other.StartOfFunctionCall)
409 return StartOfFunctionCall < Other.StartOfFunctionCall;
Daniel Jasper37911302013-04-02 14:33:13 +0000410 if (CallContinuation != Other.CallContinuation)
411 return CallContinuation < Other.CallContinuation;
Daniel Jasper8ed9f2b2013-04-03 13:36:17 +0000412 if (VariablePos != Other.VariablePos)
413 return VariablePos < Other.VariablePos;
Daniel Jasper88cc5622013-07-08 14:25:23 +0000414 if (ContainsLineBreak != Other.ContainsLineBreak)
415 return ContainsLineBreak < Other.ContainsLineBreak;
Daniel Jasperb3123142013-01-12 07:36:22 +0000416 return false;
Daniel Jasper604eb4c2013-01-11 10:22:12 +0000417 }
418 };
419
420 /// \brief The current state when indenting a unwrapped line.
421 ///
422 /// As the indenting tries different combinations this is copied by value.
423 struct LineState {
424 /// \brief The number of used columns in the current line.
425 unsigned Column;
426
427 /// \brief The token that needs to be next formatted.
Manuel Klimekb3987012013-05-29 14:47:47 +0000428 const FormatToken *NextToken;
Daniel Jasper604eb4c2013-01-11 10:22:12 +0000429
Daniel Jaspera324a0e2012-12-21 14:37:20 +0000430 /// \brief \c true if this line contains a continued for-loop section.
431 bool LineContainsContinuedForLoopSection;
432
Daniel Jasper29f123b2013-02-08 15:28:42 +0000433 /// \brief The level of nesting inside (), [], <> and {}.
434 unsigned ParenLevel;
435
Daniel Jaspercf5767d2013-02-18 11:05:07 +0000436 /// \brief The \c ParenLevel at the start of this line.
437 unsigned StartOfLineLevel;
438
Daniel Jasper07ca5472013-07-05 09:14:35 +0000439 /// \brief The lowest \c ParenLevel on the current line.
440 unsigned LowestLevelOnLine;
Daniel Jasper259a0382013-05-27 11:50:16 +0000441
Manuel Klimekb56b6d12013-02-20 15:25:48 +0000442 /// \brief The start column of the string literal, if we're in a string
443 /// literal sequence, 0 otherwise.
444 unsigned StartOfStringLiteral;
445
Daniel Jasper604eb4c2013-01-11 10:22:12 +0000446 /// \brief A stack keeping track of properties applying to parenthesis
447 /// levels.
448 std::vector<ParenState> Stack;
449
Daniel Jasper54b4e442013-05-22 05:27:42 +0000450 /// \brief Ignore the stack of \c ParenStates for state comparison.
451 ///
452 /// In long and deeply nested unwrapped lines, the current algorithm can
453 /// be insufficient for finding the best formatting with a reasonable amount
454 /// of time and memory. Setting this flag will effectively lead to the
455 /// algorithm not analyzing some combinations. However, these combinations
456 /// rarely contain the optimal solution: In short, accepting a higher
457 /// penalty early would need to lead to different values in the \c
458 /// ParenState stack (in an otherwise identical state) and these different
459 /// values would need to lead to a significant amount of avoided penalty
460 /// later.
461 ///
462 /// FIXME: Come up with a better algorithm instead.
463 bool IgnoreStackForComparison;
464
Daniel Jasper604eb4c2013-01-11 10:22:12 +0000465 /// \brief Comparison operator to be able to used \c LineState in \c map.
466 bool operator<(const LineState &Other) const {
Daniel Jasperd7896702013-02-19 09:28:55 +0000467 if (NextToken != Other.NextToken)
468 return NextToken < Other.NextToken;
469 if (Column != Other.Column)
470 return Column < Other.Column;
Daniel Jasperd7896702013-02-19 09:28:55 +0000471 if (LineContainsContinuedForLoopSection !=
Alexander Kornienko70ce7882013-04-15 14:28:00 +0000472 Other.LineContainsContinuedForLoopSection)
Daniel Jaspera324a0e2012-12-21 14:37:20 +0000473 return LineContainsContinuedForLoopSection;
Daniel Jasperd7896702013-02-19 09:28:55 +0000474 if (ParenLevel != Other.ParenLevel)
475 return ParenLevel < Other.ParenLevel;
476 if (StartOfLineLevel != Other.StartOfLineLevel)
477 return StartOfLineLevel < Other.StartOfLineLevel;
Daniel Jasper07ca5472013-07-05 09:14:35 +0000478 if (LowestLevelOnLine != Other.LowestLevelOnLine)
479 return LowestLevelOnLine < Other.LowestLevelOnLine;
Manuel Klimekb56b6d12013-02-20 15:25:48 +0000480 if (StartOfStringLiteral != Other.StartOfStringLiteral)
481 return StartOfStringLiteral < Other.StartOfStringLiteral;
Daniel Jasper54b4e442013-05-22 05:27:42 +0000482 if (IgnoreStackForComparison || Other.IgnoreStackForComparison)
483 return false;
Daniel Jasperd7896702013-02-19 09:28:55 +0000484 return Stack < Other.Stack;
Daniel Jasperbac016b2012-12-03 18:12:45 +0000485 }
486 };
487
Daniel Jasper20409152012-12-04 14:54:30 +0000488 /// \brief Appends the next token to \p State and updates information
489 /// necessary for indentation.
490 ///
Nico Weber1907c572013-06-26 02:42:46 +0000491 /// Puts the token on the current line if \p Newline is \c false and adds a
Daniel Jasper20409152012-12-04 14:54:30 +0000492 /// line break and necessary indentation otherwise.
493 ///
494 /// If \p DryRun is \c false, also creates and stores the required
495 /// \c Replacement.
Manuel Klimek8092a942013-02-20 10:15:13 +0000496 unsigned addTokenToState(bool Newline, bool DryRun, LineState &State) {
Manuel Klimekb3987012013-05-29 14:47:47 +0000497 const FormatToken &Current = *State.NextToken;
498 const FormatToken &Previous = *State.NextToken->Previous;
Daniel Jasperbac016b2012-12-03 18:12:45 +0000499
Daniel Jasper92f9faf2013-03-20 15:58:10 +0000500 if (State.Stack.size() == 0 || Current.Type == TT_ImplicitStringLiteral) {
Manuel Klimekad3094b2013-05-23 10:56:37 +0000501 // FIXME: Is this correct?
Manuel Klimekb3987012013-05-29 14:47:47 +0000502 int WhitespaceLength = SourceMgr.getSpellingColumnNumber(
503 State.NextToken->WhitespaceRange.getEnd()) -
504 SourceMgr.getSpellingColumnNumber(
505 State.NextToken->WhitespaceRange.getBegin());
Alexander Kornienko00895102013-06-05 14:09:10 +0000506 State.Column += WhitespaceLength + State.NextToken->CodePointCount;
Manuel Klimekb3987012013-05-29 14:47:47 +0000507 State.NextToken = State.NextToken->Next;
Manuel Klimek8092a942013-02-20 10:15:13 +0000508 return 0;
Daniel Jasper68ef0df2013-02-01 11:00:45 +0000509 }
510
Daniel Jasper3776ef32013-04-03 07:21:51 +0000511 // If we are continuing an expression, we want to indent an extra 4 spaces.
512 unsigned ContinuationIndent =
Daniel Jasper37911302013-04-02 14:33:13 +0000513 std::max(State.Stack.back().LastSpace, State.Stack.back().Indent) + 4;
Daniel Jasperbac016b2012-12-03 18:12:45 +0000514 if (Newline) {
Daniel Jasper88cc5622013-07-08 14:25:23 +0000515 State.Stack.back().ContainsLineBreak = true;
Manuel Klimekbb42bf12013-01-10 11:52:21 +0000516 if (Current.is(tok::r_brace)) {
Daniel Jasper0de1c4d2013-07-09 09:06:29 +0000517 if (Current.BlockKind == BK_BracedInit)
518 State.Column = State.Stack[State.Stack.size() - 2].LastSpace;
519 else
520 State.Column = Line.Level * Style.IndentWidth;
Daniel Jasper9c837d02013-01-09 07:06:56 +0000521 } else if (Current.is(tok::string_literal) &&
Manuel Klimekb56b6d12013-02-20 15:25:48 +0000522 State.StartOfStringLiteral != 0) {
523 State.Column = State.StartOfStringLiteral;
Daniel Jasper66d19bd2013-02-18 11:59:17 +0000524 State.Stack.back().BreakBeforeParameter = true;
Daniel Jasper9c837d02013-01-09 07:06:56 +0000525 } else if (Current.is(tok::lessless) &&
Daniel Jasper29f123b2013-02-08 15:28:42 +0000526 State.Stack.back().FirstLessLess != 0) {
527 State.Column = State.Stack.back().FirstLessLess;
Daniel Jasper5ad390d2013-05-28 11:30:49 +0000528 } else if (Current.isOneOf(tok::period, tok::arrow) &&
529 Current.Type != TT_DesignatedInitializerPeriod) {
Daniel Jasper3776ef32013-04-03 07:21:51 +0000530 if (State.Stack.back().CallContinuation == 0) {
531 State.Column = ContinuationIndent;
Daniel Jasper37911302013-04-02 14:33:13 +0000532 State.Stack.back().CallContinuation = State.Column;
Daniel Jasper3776ef32013-04-03 07:21:51 +0000533 } else {
534 State.Column = State.Stack.back().CallContinuation;
535 }
Daniel Jasperbfe6fd42013-01-28 12:45:14 +0000536 } else if (Current.Type == TT_ConditionalExpr) {
537 State.Column = State.Stack.back().QuestionColumn;
Daniel Jasper8ed9f2b2013-04-03 13:36:17 +0000538 } else if (Previous.is(tok::comma) &&
539 State.Stack.back().VariablePos != 0) {
540 State.Column = State.Stack.back().VariablePos;
Daniel Jasper3c08a812013-02-24 18:54:32 +0000541 } else if (Previous.ClosesTemplateDeclaration ||
Daniel Jasper6561f6a2013-07-09 07:43:55 +0000542 ((Current.Type == TT_StartOfName ||
543 Current.is(tok::kw_operator)) &&
544 State.ParenLevel == 0 &&
Manuel Klimeka9a7f102013-06-21 17:25:42 +0000545 (!Style.IndentFunctionDeclarationAfterType ||
546 Line.StartsDefinition))) {
Daniel Jasper37911302013-04-02 14:33:13 +0000547 State.Column = State.Stack.back().Indent;
Daniel Jasper63d7ced2013-02-05 10:07:47 +0000548 } else if (Current.Type == TT_ObjCSelectorName) {
Alexander Kornienko00895102013-06-05 14:09:10 +0000549 if (State.Stack.back().ColonPos > Current.CodePointCount) {
550 State.Column = State.Stack.back().ColonPos - Current.CodePointCount;
Daniel Jasper63d7ced2013-02-05 10:07:47 +0000551 } else {
552 State.Column = State.Stack.back().Indent;
Alexander Kornienko00895102013-06-05 14:09:10 +0000553 State.Stack.back().ColonPos = State.Column + Current.CodePointCount;
Daniel Jasper63d7ced2013-02-05 10:07:47 +0000554 }
Daniel Jasperb2f063a2013-05-08 10:00:18 +0000555 } else if (Current.Type == TT_StartOfName ||
556 Previous.isOneOf(tok::coloncolon, tok::equal) ||
Daniel Jasper37911302013-04-02 14:33:13 +0000557 Previous.Type == TT_ObjCMethodExpr) {
Daniel Jasper3776ef32013-04-03 07:21:51 +0000558 State.Column = ContinuationIndent;
Daniel Jaspera324a0e2012-12-21 14:37:20 +0000559 } else {
Daniel Jasper29f123b2013-02-08 15:28:42 +0000560 State.Column = State.Stack.back().Indent;
Daniel Jasper3776ef32013-04-03 07:21:51 +0000561 // Ensure that we fall back to indenting 4 spaces instead of just
562 // flushing continuations left.
Daniel Jasper37911302013-04-02 14:33:13 +0000563 if (State.Column == FirstIndent)
564 State.Column += 4;
Daniel Jaspera324a0e2012-12-21 14:37:20 +0000565 }
566
Daniel Jasper7878a7b2013-02-15 11:07:25 +0000567 if (Current.is(tok::question))
Daniel Jasper237d4c12013-02-23 21:01:55 +0000568 State.Stack.back().BreakBeforeParameter = true;
Daniel Jasper11e13802013-05-08 14:12:04 +0000569 if ((Previous.isOneOf(tok::comma, tok::semi) &&
570 !State.Stack.back().AvoidBinPacking) ||
571 Previous.Type == TT_BinaryOperator)
Daniel Jasperce3d1a62013-02-08 08:22:00 +0000572 State.Stack.back().BreakBeforeParameter = false;
Daniel Jasper33f4b902013-05-15 09:35:08 +0000573 if (Previous.Type == TT_TemplateCloser && State.ParenLevel == 0)
574 State.Stack.back().BreakBeforeParameter = false;
Daniel Jasperf343cab2013-01-31 14:59:26 +0000575
Manuel Klimek060143e2013-01-02 18:33:23 +0000576 if (!DryRun) {
Daniel Jasper1ef81d52013-02-26 13:10:34 +0000577 unsigned NewLines = 1;
Alexander Kornienkoe3f11972013-06-12 19:04:12 +0000578 if (Current.is(tok::comment))
Manuel Klimekb3987012013-05-29 14:47:47 +0000579 NewLines = std::max(
580 NewLines,
581 std::min(Current.NewlinesBefore, Style.MaxEmptyLinesToKeep + 1));
Manuel Klimeke573c3f2013-05-22 12:51:29 +0000582 Whitespaces.replaceWhitespace(Current, NewLines, State.Column,
583 State.Column, Line.InPPDirective);
Manuel Klimek060143e2013-01-02 18:33:23 +0000584 }
Daniel Jasperbac016b2012-12-03 18:12:45 +0000585
Daniel Jasper29f123b2013-02-08 15:28:42 +0000586 State.Stack.back().LastSpace = State.Column;
Daniel Jasper5ad390d2013-05-28 11:30:49 +0000587 if (Current.isOneOf(tok::arrow, tok::period) &&
588 Current.Type != TT_DesignatedInitializerPeriod)
Alexander Kornienko00895102013-06-05 14:09:10 +0000589 State.Stack.back().LastSpace += Current.CodePointCount;
Daniel Jaspercf5767d2013-02-18 11:05:07 +0000590 State.StartOfLineLevel = State.ParenLevel;
Daniel Jasper07ca5472013-07-05 09:14:35 +0000591 State.LowestLevelOnLine = State.ParenLevel;
Daniel Jasper237d4c12013-02-23 21:01:55 +0000592
593 // Any break on this level means that the parent level has been broken
594 // and we need to avoid bin packing there.
595 for (unsigned i = 0, e = State.Stack.size() - 1; i != e; ++i) {
596 State.Stack[i].BreakBeforeParameter = true;
597 }
Alexander Kornienko0bdc6432013-07-04 14:47:51 +0000598 const FormatToken *TokenBefore = Current.getPreviousNonComment();
Daniel Jasper01218ff2013-04-15 22:36:37 +0000599 if (TokenBefore && !TokenBefore->isOneOf(tok::comma, tok::semi) &&
Daniel Jasper33f4b902013-05-15 09:35:08 +0000600 TokenBefore->Type != TT_TemplateCloser &&
Daniel Jasper11e13802013-05-08 14:12:04 +0000601 TokenBefore->Type != TT_BinaryOperator && !TokenBefore->opensScope())
Daniel Jasperfaab0d32013-02-27 09:47:53 +0000602 State.Stack.back().BreakBeforeParameter = true;
603
Daniel Jasper237d4c12013-02-23 21:01:55 +0000604 // If we break after {, we should also break before the corresponding }.
605 if (Previous.is(tok::l_brace))
606 State.Stack.back().BreakBeforeClosingBrace = true;
607
608 if (State.Stack.back().AvoidBinPacking) {
609 // If we are breaking after '(', '{', '<', this is not bin packing
610 // unless AllowAllParametersOfDeclarationOnNextLine is false.
Daniel Jasperd741f022013-05-14 20:39:56 +0000611 if (!(Previous.isOneOf(tok::l_paren, tok::l_brace) ||
612 Previous.Type == TT_BinaryOperator) ||
Daniel Jasper237d4c12013-02-23 21:01:55 +0000613 (!Style.AllowAllParametersOfDeclarationOnNextLine &&
614 Line.MustBeDeclaration))
615 State.Stack.back().BreakBeforeParameter = true;
616 }
Daniel Jasperbac016b2012-12-03 18:12:45 +0000617 } else {
Daniel Jasper9c3e71a2013-02-25 15:59:54 +0000618 if (Current.is(tok::equal) &&
Manuel Klimekb3987012013-05-29 14:47:47 +0000619 (RootToken->is(tok::kw_for) || State.ParenLevel == 0) &&
Daniel Jasperadc0f092013-04-05 09:38:50 +0000620 State.Stack.back().VariablePos == 0) {
621 State.Stack.back().VariablePos = State.Column;
622 // Move over * and & if they are bound to the variable name.
Manuel Klimekb3987012013-05-29 14:47:47 +0000623 const FormatToken *Tok = &Previous;
Alexander Kornienko00895102013-06-05 14:09:10 +0000624 while (Tok && State.Stack.back().VariablePos >= Tok->CodePointCount) {
625 State.Stack.back().VariablePos -= Tok->CodePointCount;
Daniel Jasperadc0f092013-04-05 09:38:50 +0000626 if (Tok->SpacesRequiredBefore != 0)
627 break;
Manuel Klimekb3987012013-05-29 14:47:47 +0000628 Tok = Tok->Previous;
Daniel Jasperadc0f092013-04-05 09:38:50 +0000629 }
Daniel Jasper8ed9f2b2013-04-03 13:36:17 +0000630 if (Previous.PartOfMultiVariableDeclStmt)
631 State.Stack.back().LastSpace = State.Stack.back().VariablePos;
632 }
Daniel Jaspera324a0e2012-12-21 14:37:20 +0000633
Daniel Jasper729a7432013-02-11 12:36:37 +0000634 unsigned Spaces = State.NextToken->SpacesRequiredBefore;
Daniel Jasper20409152012-12-04 14:54:30 +0000635
Daniel Jasperbac016b2012-12-03 18:12:45 +0000636 if (!DryRun)
Manuel Klimeke573c3f2013-05-22 12:51:29 +0000637 Whitespaces.replaceWhitespace(Current, 0, Spaces,
638 State.Column + Spaces);
Daniel Jasper20409152012-12-04 14:54:30 +0000639
Daniel Jasper63d7ced2013-02-05 10:07:47 +0000640 if (Current.Type == TT_ObjCSelectorName &&
641 State.Stack.back().ColonPos == 0) {
642 if (State.Stack.back().Indent + Current.LongestObjCSelectorName >
Alexander Kornienko00895102013-06-05 14:09:10 +0000643 State.Column + Spaces + Current.CodePointCount)
Daniel Jasper63d7ced2013-02-05 10:07:47 +0000644 State.Stack.back().ColonPos =
645 State.Stack.back().Indent + Current.LongestObjCSelectorName;
646 else
647 State.Stack.back().ColonPos =
Alexander Kornienko00895102013-06-05 14:09:10 +0000648 State.Column + Spaces + Current.CodePointCount;
Daniel Jasper63d7ced2013-02-05 10:07:47 +0000649 }
650
Daniel Jasperac3223e2013-04-10 09:49:49 +0000651 if (Previous.opensScope() && Previous.Type != TT_ObjCMethodExpr &&
Daniel Jasperbf71ba22013-04-08 20:33:42 +0000652 Current.Type != TT_LineComment)
Daniel Jasper29f123b2013-02-08 15:28:42 +0000653 State.Stack.back().Indent = State.Column + Spaces;
Daniel Jasper001bf4e2013-04-22 07:59:53 +0000654 if (Previous.is(tok::comma) && !Current.isTrailingComment() &&
655 State.Stack.back().AvoidBinPacking)
656 State.Stack.back().NoLineBreak = true;
Daniel Jasper0df6acd2013-01-16 14:59:02 +0000657
Daniel Jasper3b5943f2012-12-06 09:56:08 +0000658 State.Column += Spaces;
Daniel Jasper8ed9f2b2013-04-03 13:36:17 +0000659 if (Current.is(tok::l_paren) && Previous.isOneOf(tok::kw_if, tok::kw_for))
Daniel Jaspere438bac2013-01-23 20:41:06 +0000660 // Treat the condition inside an if as if it was a second function
661 // parameter, i.e. let nested calls have an indent of 4.
662 State.Stack.back().LastSpace = State.Column + 1; // 1 is length of "(".
Daniel Jasperf9955d32013-03-20 12:37:50 +0000663 else if (Previous.is(tok::comma))
Daniel Jaspere438bac2013-01-23 20:41:06 +0000664 State.Stack.back().LastSpace = State.Column;
Daniel Jasperbfe6fd42013-01-28 12:45:14 +0000665 else if ((Previous.Type == TT_BinaryOperator ||
Daniel Jasper02b771e2013-01-28 13:31:35 +0000666 Previous.Type == TT_ConditionalExpr ||
667 Previous.Type == TT_CtorInitializerColon) &&
Manuel Klimekb3987012013-05-29 14:47:47 +0000668 !(Previous.getPrecedence() == prec::Assignment &&
Daniel Jasper512843a2013-05-27 12:45:09 +0000669 Current.FakeLParens.empty()))
670 // Always indent relative to the RHS of the expression unless this is a
671 // simple assignment without binary expression on the RHS.
Daniel Jasperae8699b2013-01-28 09:35:24 +0000672 State.Stack.back().LastSpace = State.Column;
Daniel Jasper6cabab42013-02-14 08:42:54 +0000673 else if (Previous.Type == TT_InheritanceColon)
674 State.Stack.back().Indent = State.Column;
Daniel Jasperb1491792013-07-09 11:57:27 +0000675 else if (Previous.opensScope()) {
676 // If a function has multiple parameters (including a single parameter
Daniel Jasper2ca37412013-07-09 14:36:48 +0000677 // that is a binary expression) or a trailing call, indent all
Daniel Jasperb1491792013-07-09 11:57:27 +0000678 // parameters from the opening parenthesis. This avoids confusing
679 // indents like:
680 // OuterFunction(InnerFunctionCall(
681 // ParameterToInnerFunction),
682 // SecondParameterToOuterFunction);
683 bool HasMultipleParameters = !Current.FakeLParens.empty();
684 bool HasTrailingCall = false;
685 if (Previous.MatchingParen) {
686 const FormatToken *Next = Previous.MatchingParen->getNextNonComment();
687 if (Next && Next->isOneOf(tok::period, tok::arrow))
688 HasTrailingCall = true;
689 }
690 if (HasMultipleParameters || HasTrailingCall)
691 State.Stack.back().LastSpace = State.Column;
692 }
Daniel Jasperbac016b2012-12-03 18:12:45 +0000693 }
Daniel Jasper0df6acd2013-01-16 14:59:02 +0000694
Manuel Klimek8092a942013-02-20 10:15:13 +0000695 return moveStateToNextToken(State, DryRun);
Daniel Jasper20409152012-12-04 14:54:30 +0000696 }
Daniel Jasperbac016b2012-12-03 18:12:45 +0000697
Daniel Jasper20409152012-12-04 14:54:30 +0000698 /// \brief Mark the next token as consumed in \p State and modify its stacks
699 /// accordingly.
Manuel Klimek8092a942013-02-20 10:15:13 +0000700 unsigned moveStateToNextToken(LineState &State, bool DryRun) {
Manuel Klimekb3987012013-05-29 14:47:47 +0000701 const FormatToken &Current = *State.NextToken;
Daniel Jasper604eb4c2013-01-11 10:22:12 +0000702 assert(State.Stack.size());
Daniel Jasper3b5943f2012-12-06 09:56:08 +0000703
Daniel Jasper6cabab42013-02-14 08:42:54 +0000704 if (Current.Type == TT_InheritanceColon)
705 State.Stack.back().AvoidBinPacking = true;
Daniel Jasper604eb4c2013-01-11 10:22:12 +0000706 if (Current.is(tok::lessless) && State.Stack.back().FirstLessLess == 0)
707 State.Stack.back().FirstLessLess = State.Column;
Daniel Jasperbfe6fd42013-01-28 12:45:14 +0000708 if (Current.is(tok::question))
709 State.Stack.back().QuestionColumn = State.Column;
Daniel Jasper07ca5472013-07-05 09:14:35 +0000710 if (!Current.opensScope() && !Current.closesScope())
711 State.LowestLevelOnLine =
712 std::min(State.LowestLevelOnLine, State.ParenLevel);
713 if (Current.isOneOf(tok::period, tok::arrow) &&
714 Line.Type == LT_BuilderTypeCall && State.ParenLevel == 0)
715 State.Stack.back().StartOfFunctionCall =
716 Current.LastInChainOfCalls ? 0
717 : State.Column + Current.CodePointCount;
Daniel Jasper7d812812013-02-21 15:00:29 +0000718 if (Current.Type == TT_CtorInitializerColon) {
Manuel Klimek07a64ec2013-05-13 08:42:42 +0000719 // Indent 2 from the column, so:
720 // SomeClass::SomeClass()
721 // : First(...), ...
722 // Next(...)
723 // ^ line up here.
Daniel Jasperbf71ba22013-04-08 20:33:42 +0000724 State.Stack.back().Indent = State.Column + 2;
Daniel Jasper7d812812013-02-21 15:00:29 +0000725 if (Style.ConstructorInitializerAllOnOneLineOrOnePerLine)
726 State.Stack.back().AvoidBinPacking = true;
727 State.Stack.back().BreakBeforeParameter = false;
Daniel Jasperf343cab2013-01-31 14:59:26 +0000728 }
Daniel Jasper3776ef32013-04-03 07:21:51 +0000729
Daniel Jasperbf71ba22013-04-08 20:33:42 +0000730 // If return returns a binary expression, align after it.
731 if (Current.is(tok::kw_return) && !Current.FakeLParens.empty())
732 State.Stack.back().LastSpace = State.Column + 7;
733
Daniel Jasper3776ef32013-04-03 07:21:51 +0000734 // In ObjC method declaration we align on the ":" of parameters, but we need
735 // to ensure that we indent parameters on subsequent lines by at least 4.
Daniel Jasper37911302013-04-02 14:33:13 +0000736 if (Current.Type == TT_ObjCMethodSpecifier)
737 State.Stack.back().Indent += 4;
Daniel Jasper3b5943f2012-12-06 09:56:08 +0000738
Daniel Jasper29f123b2013-02-08 15:28:42 +0000739 // Insert scopes created by fake parenthesis.
Alexander Kornienko0bdc6432013-07-04 14:47:51 +0000740 const FormatToken *Previous = Current.getPreviousNonComment();
Daniel Jasperbf71ba22013-04-08 20:33:42 +0000741 // Don't add extra indentation for the first fake parenthesis after
742 // 'return', assignements or opening <({[. The indentation for these cases
743 // is special cased.
744 bool SkipFirstExtraIndent =
745 Current.is(tok::kw_return) ||
Daniel Jasperac3223e2013-04-10 09:49:49 +0000746 (Previous && (Previous->opensScope() ||
Manuel Klimekb3987012013-05-29 14:47:47 +0000747 Previous->getPrecedence() == prec::Assignment));
Craig Topper163fbf82013-07-08 03:55:09 +0000748 for (SmallVectorImpl<prec::Level>::const_reverse_iterator
Daniel Jasperbf71ba22013-04-08 20:33:42 +0000749 I = Current.FakeLParens.rbegin(),
750 E = Current.FakeLParens.rend();
751 I != E; ++I) {
Daniel Jasper29f123b2013-02-08 15:28:42 +0000752 ParenState NewParenState = State.Stack.back();
Daniel Jasper88cc5622013-07-08 14:25:23 +0000753 NewParenState.ContainsLineBreak = false;
Daniel Jasperbf71ba22013-04-08 20:33:42 +0000754 NewParenState.Indent =
755 std::max(std::max(State.Column, NewParenState.Indent),
756 State.Stack.back().LastSpace);
757
758 // Always indent conditional expressions. Never indent expression where
759 // the 'operator' is ',', ';' or an assignment (i.e. *I <=
760 // prec::Assignment) as those have different indentation rules. Indent
761 // other expression, unless the indentation needs to be skipped.
762 if (*I == prec::Conditional ||
763 (!SkipFirstExtraIndent && *I > prec::Assignment))
764 NewParenState.Indent += 4;
Daniel Jasperac3223e2013-04-10 09:49:49 +0000765 if (Previous && !Previous->opensScope())
Daniel Jasperbf71ba22013-04-08 20:33:42 +0000766 NewParenState.BreakBeforeParameter = false;
Daniel Jasper29f123b2013-02-08 15:28:42 +0000767 State.Stack.push_back(NewParenState);
Daniel Jasperbf71ba22013-04-08 20:33:42 +0000768 SkipFirstExtraIndent = false;
Daniel Jasper29f123b2013-02-08 15:28:42 +0000769 }
770
Daniel Jaspercf225b62012-12-24 13:43:52 +0000771 // If we encounter an opening (, [, { or <, we add a level to our stacks to
Daniel Jasper20409152012-12-04 14:54:30 +0000772 // prepare for the following tokens.
Daniel Jasperac3223e2013-04-10 09:49:49 +0000773 if (Current.opensScope()) {
Daniel Jasper604eb4c2013-01-11 10:22:12 +0000774 unsigned NewIndent;
Daniel Jasperc3df5ff2013-05-13 09:19:24 +0000775 unsigned LastSpace = State.Stack.back().LastSpace;
Daniel Jasperf343cab2013-01-31 14:59:26 +0000776 bool AvoidBinPacking;
Manuel Klimek2851c162013-01-10 14:36:46 +0000777 if (Current.is(tok::l_brace)) {
Daniel Jasperc3df5ff2013-05-13 09:19:24 +0000778 NewIndent = Style.IndentWidth + LastSpace;
Alexander Kornienko0bdc6432013-07-04 14:47:51 +0000779 const FormatToken *NextNoComment = Current.getNextNonComment();
Daniel Jasper5ad390d2013-05-28 11:30:49 +0000780 AvoidBinPacking = NextNoComment &&
781 NextNoComment->Type == TT_DesignatedInitializerPeriod;
Manuel Klimek2851c162013-01-10 14:36:46 +0000782 } else {
Daniel Jasperc3df5ff2013-05-13 09:19:24 +0000783 NewIndent =
784 4 + std::max(LastSpace, State.Stack.back().StartOfFunctionCall);
Daniel Jasper001bf4e2013-04-22 07:59:53 +0000785 AvoidBinPacking = !Style.BinPackParameters;
Manuel Klimek2851c162013-01-10 14:36:46 +0000786 }
Daniel Jasperfca24bc2013-04-25 13:31:51 +0000787
Daniel Jasperc3df5ff2013-05-13 09:19:24 +0000788 State.Stack.push_back(ParenState(NewIndent, LastSpace, AvoidBinPacking,
789 State.Stack.back().NoLineBreak));
Daniel Jasper29f123b2013-02-08 15:28:42 +0000790 ++State.ParenLevel;
Daniel Jasper20409152012-12-04 14:54:30 +0000791 }
792
Daniel Jasperce3d1a62013-02-08 08:22:00 +0000793 // If this '[' opens an ObjC call, determine whether all parameters fit into
794 // one line and put one per line if they don't.
795 if (Current.is(tok::l_square) && Current.Type == TT_ObjCMethodExpr &&
796 Current.MatchingParen != NULL) {
797 if (getLengthToMatchingParen(Current) + State.Column > getColumnLimit())
798 State.Stack.back().BreakBeforeParameter = true;
799 }
800
Daniel Jaspercf225b62012-12-24 13:43:52 +0000801 // If we encounter a closing ), ], } or >, we can remove a level from our
Daniel Jasper20409152012-12-04 14:54:30 +0000802 // stacks.
Alexander Kornienkoe74de282013-03-13 14:41:29 +0000803 if (Current.isOneOf(tok::r_paren, tok::r_square) ||
Manuel Klimekb3987012013-05-29 14:47:47 +0000804 (Current.is(tok::r_brace) && State.NextToken != RootToken) ||
Daniel Jasper26f7e782013-01-08 14:56:18 +0000805 State.NextToken->Type == TT_TemplateCloser) {
Daniel Jasper604eb4c2013-01-11 10:22:12 +0000806 State.Stack.pop_back();
Daniel Jasper29f123b2013-02-08 15:28:42 +0000807 --State.ParenLevel;
808 }
809
810 // Remove scopes created by fake parenthesis.
811 for (unsigned i = 0, e = Current.FakeRParens; i != e; ++i) {
Daniel Jasperabfc9c12013-04-04 19:31:00 +0000812 unsigned VariablePos = State.Stack.back().VariablePos;
Daniel Jasper29f123b2013-02-08 15:28:42 +0000813 State.Stack.pop_back();
Daniel Jasperabfc9c12013-04-04 19:31:00 +0000814 State.Stack.back().VariablePos = VariablePos;
Daniel Jasperbac016b2012-12-03 18:12:45 +0000815 }
Manuel Klimek2851c162013-01-10 14:36:46 +0000816
Daniel Jasper27c7f542013-05-13 20:50:15 +0000817 if (Current.is(tok::string_literal) && State.StartOfStringLiteral == 0) {
Manuel Klimekb56b6d12013-02-20 15:25:48 +0000818 State.StartOfStringLiteral = State.Column;
Daniel Jasper27c7f542013-05-13 20:50:15 +0000819 } else if (!Current.isOneOf(tok::comment, tok::identifier, tok::hash,
820 tok::string_literal)) {
Daniel Jasper9a2f8d02013-05-16 04:26:02 +0000821 State.StartOfStringLiteral = 0;
Manuel Klimekb56b6d12013-02-20 15:25:48 +0000822 }
823
Alexander Kornienko00895102013-06-05 14:09:10 +0000824 State.Column += Current.CodePointCount;
Manuel Klimek8092a942013-02-20 10:15:13 +0000825
Manuel Klimekb3987012013-05-29 14:47:47 +0000826 State.NextToken = State.NextToken->Next;
Manuel Klimek2851c162013-01-10 14:36:46 +0000827
Manuel Klimek8092a942013-02-20 10:15:13 +0000828 return breakProtrudingToken(Current, State, DryRun);
829 }
830
831 /// \brief If the current token sticks out over the end of the line, break
832 /// it if possible.
Manuel Klimek2a9805d2013-05-14 09:04:24 +0000833 ///
834 /// \returns An extra penalty if a token was broken, otherwise 0.
835 ///
Alexander Kornienkod446f732013-07-01 13:42:42 +0000836 /// The returned penalty will cover the cost of the additional line breaks and
837 /// column limit violation in all lines except for the last one. The penalty
838 /// for the column limit violation in the last line (and in single line
839 /// tokens) is handled in \c addNextStateToQueue.
Manuel Klimekb3987012013-05-29 14:47:47 +0000840 unsigned breakProtrudingToken(const FormatToken &Current, LineState &State,
Manuel Klimeke573c3f2013-05-22 12:51:29 +0000841 bool DryRun) {
Alexander Kornienko70ce7882013-04-15 14:28:00 +0000842 llvm::OwningPtr<BreakableToken> Token;
Alexander Kornienko00895102013-06-05 14:09:10 +0000843 unsigned StartColumn = State.Column - Current.CodePointCount;
Manuel Klimekdcb3f2a2013-05-28 13:42:28 +0000844 unsigned OriginalStartColumn =
Manuel Klimekb3987012013-05-29 14:47:47 +0000845 SourceMgr.getSpellingColumnNumber(Current.getStartOfNonWhitespace()) -
Manuel Klimekdcb3f2a2013-05-28 13:42:28 +0000846 1;
Manuel Klimekde008c02013-05-27 15:23:34 +0000847
Daniel Jasper5d5b4242013-05-16 12:59:13 +0000848 if (Current.is(tok::string_literal) &&
849 Current.Type != TT_ImplicitStringLiteral) {
Alexander Kornienko70ce7882013-04-15 14:28:00 +0000850 // Only break up default narrow strings.
Alexander Kornienko16a0ec62013-06-14 11:46:10 +0000851 if (!Current.TokenText.startswith("\""))
Alexander Kornienko70ce7882013-04-15 14:28:00 +0000852 return 0;
853
Alexander Kornienko16a0ec62013-06-14 11:46:10 +0000854 Token.reset(new BreakableStringLiteral(Current, StartColumn,
855 Line.InPPDirective, Encoding));
Alexander Kornienko70ce7882013-04-15 14:28:00 +0000856 } else if (Current.Type == TT_BlockComment) {
Alexander Kornienko16a0ec62013-06-14 11:46:10 +0000857 Token.reset(new BreakableBlockComment(
Alexander Kornienko00895102013-06-05 14:09:10 +0000858 Style, Current, StartColumn, OriginalStartColumn, !Current.Previous,
Alexander Kornienko16a0ec62013-06-14 11:46:10 +0000859 Line.InPPDirective, Encoding));
Daniel Jasper7ff96ed2013-05-06 10:24:51 +0000860 } else if (Current.Type == TT_LineComment &&
Manuel Klimekb3987012013-05-29 14:47:47 +0000861 (Current.Previous == NULL ||
862 Current.Previous->Type != TT_ImplicitStringLiteral)) {
Alexander Kornienko16a0ec62013-06-14 11:46:10 +0000863 Token.reset(new BreakableLineComment(Current, StartColumn,
864 Line.InPPDirective, Encoding));
Alexander Kornienko70ce7882013-04-15 14:28:00 +0000865 } else {
Manuel Klimeke573c3f2013-05-22 12:51:29 +0000866 return 0;
Alexander Kornienko70ce7882013-04-15 14:28:00 +0000867 }
Alexander Kornienko16a0ec62013-06-14 11:46:10 +0000868 if (Current.UnbreakableTailLength >= getColumnLimit())
Manuel Klimek2a9805d2013-05-14 09:04:24 +0000869 return 0;
Alexander Kornienko70ce7882013-04-15 14:28:00 +0000870
Alexander Kornienkoc36c5c22013-06-19 19:50:11 +0000871 unsigned RemainingSpace = getColumnLimit() - Current.UnbreakableTailLength;
Alexander Kornienko70ce7882013-04-15 14:28:00 +0000872 bool BreakInserted = false;
873 unsigned Penalty = 0;
Alexander Kornienkoc36c5c22013-06-19 19:50:11 +0000874 unsigned RemainingTokenColumns = 0;
Manuel Klimekde008c02013-05-27 15:23:34 +0000875 for (unsigned LineIndex = 0, EndIndex = Token->getLineCount();
876 LineIndex != EndIndex; ++LineIndex) {
Alexander Kornienko16a0ec62013-06-14 11:46:10 +0000877 if (!DryRun)
878 Token->replaceWhitespaceBefore(LineIndex, Whitespaces);
Alexander Kornienko70ce7882013-04-15 14:28:00 +0000879 unsigned TailOffset = 0;
Alexander Kornienkoc36c5c22013-06-19 19:50:11 +0000880 RemainingTokenColumns = Token->getLineLengthAfterSplit(
Alexander Kornienko2785b9a2013-06-07 16:02:52 +0000881 LineIndex, TailOffset, StringRef::npos);
Alexander Kornienko00895102013-06-05 14:09:10 +0000882 while (RemainingTokenColumns > RemainingSpace) {
Alexander Kornienko70ce7882013-04-15 14:28:00 +0000883 BreakableToken::Split Split =
Manuel Klimeke573c3f2013-05-22 12:51:29 +0000884 Token->getSplit(LineIndex, TailOffset, getColumnLimit());
Alexander Kornienkod446f732013-07-01 13:42:42 +0000885 if (Split.first == StringRef::npos) {
886 // The last line's penalty is handled in addNextStateToQueue().
887 if (LineIndex < EndIndex - 1)
888 Penalty += Style.PenaltyExcessCharacter *
889 (RemainingTokenColumns - RemainingSpace);
Alexander Kornienko70ce7882013-04-15 14:28:00 +0000890 break;
Alexander Kornienkod446f732013-07-01 13:42:42 +0000891 }
Alexander Kornienko70ce7882013-04-15 14:28:00 +0000892 assert(Split.first != 0);
Alexander Kornienko00895102013-06-05 14:09:10 +0000893 unsigned NewRemainingTokenColumns = Token->getLineLengthAfterSplit(
Alexander Kornienko2785b9a2013-06-07 16:02:52 +0000894 LineIndex, TailOffset + Split.first + Split.second,
895 StringRef::npos);
Alexander Kornienko00895102013-06-05 14:09:10 +0000896 assert(NewRemainingTokenColumns < RemainingTokenColumns);
Alexander Kornienko16a0ec62013-06-14 11:46:10 +0000897 if (!DryRun)
898 Token->insertBreak(LineIndex, TailOffset, Split, Whitespaces);
Alexander Kornienko2785b9a2013-06-07 16:02:52 +0000899 Penalty += Current.is(tok::string_literal) ? Style.PenaltyBreakString
900 : Style.PenaltyBreakComment;
901 unsigned ColumnsUsed =
902 Token->getLineLengthAfterSplit(LineIndex, TailOffset, Split.first);
903 if (ColumnsUsed > getColumnLimit()) {
904 Penalty +=
905 Style.PenaltyExcessCharacter * (ColumnsUsed - getColumnLimit());
906 }
Alexander Kornienko70ce7882013-04-15 14:28:00 +0000907 TailOffset += Split.first + Split.second;
Alexander Kornienko00895102013-06-05 14:09:10 +0000908 RemainingTokenColumns = NewRemainingTokenColumns;
Alexander Kornienko70ce7882013-04-15 14:28:00 +0000909 BreakInserted = true;
Manuel Klimek8092a942013-02-20 10:15:13 +0000910 }
Alexander Kornienko70ce7882013-04-15 14:28:00 +0000911 }
912
Alexander Kornienkoc36c5c22013-06-19 19:50:11 +0000913 State.Column = RemainingTokenColumns;
914
Alexander Kornienko70ce7882013-04-15 14:28:00 +0000915 if (BreakInserted) {
Alexander Kornienko22d0e292013-06-17 12:59:44 +0000916 // If we break the token inside a parameter list, we need to break before
917 // the next parameter on all levels, so that the next parameter is clearly
918 // visible. Line comments already introduce a break.
919 if (Current.Type != TT_LineComment) {
920 for (unsigned i = 0, e = State.Stack.size(); i != e; ++i)
921 State.Stack[i].BreakBeforeParameter = true;
922 }
923
Alexander Kornienko70ce7882013-04-15 14:28:00 +0000924 State.Stack.back().LastSpace = StartColumn;
Manuel Klimek8092a942013-02-20 10:15:13 +0000925 }
Manuel Klimek8092a942013-02-20 10:15:13 +0000926 return Penalty;
927 }
928
Daniel Jasperceb99ab2013-01-09 10:16:05 +0000929 unsigned getColumnLimit() {
Alexander Kornienko70ce7882013-04-15 14:28:00 +0000930 // In preprocessor directives reserve two chars for trailing " \"
931 return Style.ColumnLimit - (Line.InPPDirective ? 2 : 0);
Daniel Jasperceb99ab2013-01-09 10:16:05 +0000932 }
933
Manuel Klimek32a2fd72013-02-13 10:46:36 +0000934 /// \brief An edge in the solution space from \c Previous->State to \c State,
935 /// inserting a newline dependent on the \c NewLine.
936 struct StateNode {
937 StateNode(const LineState &State, bool NewLine, StateNode *Previous)
Daniel Jasperf11a7052013-02-21 21:33:55 +0000938 : State(State), NewLine(NewLine), Previous(Previous) {}
Manuel Klimek32a2fd72013-02-13 10:46:36 +0000939 LineState State;
940 bool NewLine;
941 StateNode *Previous;
942 };
Daniel Jasper68ef0df2013-02-01 11:00:45 +0000943
Manuel Klimek32a2fd72013-02-13 10:46:36 +0000944 /// \brief A pair of <penalty, count> that is used to prioritize the BFS on.
945 ///
946 /// In case of equal penalties, we want to prefer states that were inserted
947 /// first. During state generation we make sure that we insert states first
948 /// that break the line as late as possible.
949 typedef std::pair<unsigned, unsigned> OrderedPenalty;
950
951 /// \brief An item in the prioritized BFS search queue. The \c StateNode's
952 /// \c State has the given \c OrderedPenalty.
953 typedef std::pair<OrderedPenalty, StateNode *> QueueItem;
954
955 /// \brief The BFS queue type.
956 typedef std::priority_queue<QueueItem, std::vector<QueueItem>,
957 std::greater<QueueItem> > QueueType;
Daniel Jasper68ef0df2013-02-01 11:00:45 +0000958
959 /// \brief Analyze the entire solution space starting from \p InitialState.
Daniel Jasperbac016b2012-12-03 18:12:45 +0000960 ///
Daniel Jasper68ef0df2013-02-01 11:00:45 +0000961 /// This implements a variant of Dijkstra's algorithm on the graph that spans
962 /// the solution space (\c LineStates are the nodes). The algorithm tries to
963 /// find the shortest path (the one with lowest penalty) from \p InitialState
964 /// to a state where all tokens are placed.
Manuel Klimeke573c3f2013-05-22 12:51:29 +0000965 void analyzeSolutionSpace(LineState &InitialState) {
Manuel Klimek32a2fd72013-02-13 10:46:36 +0000966 std::set<LineState> Seen;
967
Daniel Jasper68ef0df2013-02-01 11:00:45 +0000968 // Insert start element into queue.
Daniel Jasperfc759082013-02-14 14:26:07 +0000969 StateNode *Node =
Manuel Klimek32a2fd72013-02-13 10:46:36 +0000970 new (Allocator.Allocate()) StateNode(InitialState, false, NULL);
971 Queue.push(QueueItem(OrderedPenalty(0, Count), Node));
972 ++Count;
Daniel Jasper68ef0df2013-02-01 11:00:45 +0000973
974 // While not empty, take first element and follow edges.
975 while (!Queue.empty()) {
Manuel Klimek32a2fd72013-02-13 10:46:36 +0000976 unsigned Penalty = Queue.top().first.first;
Daniel Jasperfc759082013-02-14 14:26:07 +0000977 StateNode *Node = Queue.top().second;
Manuel Klimek32a2fd72013-02-13 10:46:36 +0000978 if (Node->State.NextToken == NULL) {
Alexander Kornienkodd256312013-05-10 11:56:10 +0000979 DEBUG(llvm::dbgs() << "\n---\nPenalty for line: " << Penalty << "\n");
Daniel Jasper68ef0df2013-02-01 11:00:45 +0000980 break;
Daniel Jasper01786732013-02-04 07:21:18 +0000981 }
Manuel Klimek32a2fd72013-02-13 10:46:36 +0000982 Queue.pop();
Daniel Jasper68ef0df2013-02-01 11:00:45 +0000983
Daniel Jasper54b4e442013-05-22 05:27:42 +0000984 // Cut off the analysis of certain solutions if the analysis gets too
985 // complex. See description of IgnoreStackForComparison.
986 if (Count > 10000)
987 Node->State.IgnoreStackForComparison = true;
988
Manuel Klimek32a2fd72013-02-13 10:46:36 +0000989 if (!Seen.insert(Node->State).second)
990 // State already examined with lower penalty.
991 continue;
Daniel Jasper68ef0df2013-02-01 11:00:45 +0000992
Nico Weber27268772013-06-26 00:30:14 +0000993 addNextStateToQueue(Penalty, Node, /*NewLine=*/false);
994 addNextStateToQueue(Penalty, Node, /*NewLine=*/true);
Daniel Jasper68ef0df2013-02-01 11:00:45 +0000995 }
996
997 if (Queue.empty())
998 // We were unable to find a solution, do nothing.
999 // FIXME: Add diagnostic?
Manuel Klimeke573c3f2013-05-22 12:51:29 +00001000 return;
Daniel Jasperbac016b2012-12-03 18:12:45 +00001001
Daniel Jasper68ef0df2013-02-01 11:00:45 +00001002 // Reconstruct the solution.
Manuel Klimek32a2fd72013-02-13 10:46:36 +00001003 reconstructPath(InitialState, Queue.top().second);
Alexander Kornienkodd256312013-05-10 11:56:10 +00001004 DEBUG(llvm::dbgs() << "Total number of analyzed states: " << Count << "\n");
1005 DEBUG(llvm::dbgs() << "---\n");
Manuel Klimek32a2fd72013-02-13 10:46:36 +00001006 }
1007
1008 void reconstructPath(LineState &State, StateNode *Current) {
Manuel Klimek9c333b92013-05-29 15:10:11 +00001009 std::deque<StateNode *> Path;
1010 // We do not need a break before the initial token.
1011 while (Current->Previous) {
1012 Path.push_front(Current);
1013 Current = Current->Previous;
1014 }
1015 for (std::deque<StateNode *>::iterator I = Path.begin(), E = Path.end();
1016 I != E; ++I) {
1017 DEBUG({
1018 if ((*I)->NewLine) {
1019 llvm::dbgs() << "Penalty for splitting before "
1020 << (*I)->Previous->State.NextToken->Tok.getName() << ": "
1021 << (*I)->Previous->State.NextToken->SplitPenalty << "\n";
1022 }
1023 });
1024 addTokenToState((*I)->NewLine, false, State);
1025 }
Daniel Jasper68ef0df2013-02-01 11:00:45 +00001026 }
1027
Manuel Klimek62a48fb2013-02-13 10:54:19 +00001028 /// \brief Add the following state to the analysis queue \c Queue.
Daniel Jasper68ef0df2013-02-01 11:00:45 +00001029 ///
Manuel Klimek62a48fb2013-02-13 10:54:19 +00001030 /// Assume the current state is \p PreviousNode and has been reached with a
Daniel Jasper68ef0df2013-02-01 11:00:45 +00001031 /// penalty of \p Penalty. Insert a line break if \p NewLine is \c true.
Manuel Klimek62a48fb2013-02-13 10:54:19 +00001032 void addNextStateToQueue(unsigned Penalty, StateNode *PreviousNode,
1033 bool NewLine) {
Manuel Klimek32a2fd72013-02-13 10:46:36 +00001034 if (NewLine && !canBreak(PreviousNode->State))
Daniel Jasper68ef0df2013-02-01 11:00:45 +00001035 return;
Manuel Klimek32a2fd72013-02-13 10:46:36 +00001036 if (!NewLine && mustBreak(PreviousNode->State))
Daniel Jasper68ef0df2013-02-01 11:00:45 +00001037 return;
Daniel Jasper88cc5622013-07-08 14:25:23 +00001038 if (NewLine) {
1039 if (!PreviousNode->State.Stack.back().ContainsLineBreak)
1040 Penalty += 15;
Manuel Klimek32a2fd72013-02-13 10:46:36 +00001041 Penalty += PreviousNode->State.NextToken->SplitPenalty;
Daniel Jasper88cc5622013-07-08 14:25:23 +00001042 }
Manuel Klimek32a2fd72013-02-13 10:46:36 +00001043
1044 StateNode *Node = new (Allocator.Allocate())
1045 StateNode(PreviousNode->State, NewLine, PreviousNode);
Manuel Klimek8092a942013-02-20 10:15:13 +00001046 Penalty += addTokenToState(NewLine, true, Node->State);
Manuel Klimek32a2fd72013-02-13 10:46:36 +00001047 if (Node->State.Column > getColumnLimit()) {
1048 unsigned ExcessCharacters = Node->State.Column - getColumnLimit();
Daniel Jasper01786732013-02-04 07:21:18 +00001049 Penalty += Style.PenaltyExcessCharacter * ExcessCharacters;
Daniel Jasperceb99ab2013-01-09 10:16:05 +00001050 }
Manuel Klimek32a2fd72013-02-13 10:46:36 +00001051
1052 Queue.push(QueueItem(OrderedPenalty(Penalty, Count), Node));
1053 ++Count;
Daniel Jasper68ef0df2013-02-01 11:00:45 +00001054 }
Daniel Jasperbac016b2012-12-03 18:12:45 +00001055
Daniel Jasper68ef0df2013-02-01 11:00:45 +00001056 /// \brief Returns \c true, if a line break after \p State is allowed.
1057 bool canBreak(const LineState &State) {
Manuel Klimekb3987012013-05-29 14:47:47 +00001058 const FormatToken &Current = *State.NextToken;
1059 const FormatToken &Previous = *Current.Previous;
1060 assert(&Previous == Current.Previous);
Daniel Jasper399914b2013-05-17 09:35:01 +00001061 if (!Current.CanBreakBefore &&
1062 !(Current.is(tok::r_brace) &&
Daniel Jasper68ef0df2013-02-01 11:00:45 +00001063 State.Stack.back().BreakBeforeClosingBrace))
1064 return false;
Daniel Jasper399914b2013-05-17 09:35:01 +00001065 // The opening "{" of a braced list has to be on the same line as the first
1066 // element if it is nested in another braced init list or function call.
1067 if (!Current.MustBreakBefore && Previous.is(tok::l_brace) &&
Manuel Klimekb3987012013-05-29 14:47:47 +00001068 Previous.Previous &&
1069 Previous.Previous->isOneOf(tok::l_brace, tok::l_paren, tok::comma))
Daniel Jasper399914b2013-05-17 09:35:01 +00001070 return false;
Daniel Jasper259a0382013-05-27 11:50:16 +00001071 // This prevents breaks like:
1072 // ...
1073 // SomeParameter, OtherParameter).DoSomething(
1074 // ...
1075 // As they hide "DoSomething" and are generally bad for readability.
Daniel Jasper07ca5472013-07-05 09:14:35 +00001076 if (Previous.opensScope() &&
1077 State.LowestLevelOnLine < State.StartOfLineLevel)
Daniel Jasper259a0382013-05-27 11:50:16 +00001078 return false;
Daniel Jasper001bf4e2013-04-22 07:59:53 +00001079 return !State.Stack.back().NoLineBreak;
Daniel Jasper68ef0df2013-02-01 11:00:45 +00001080 }
Daniel Jasperbac016b2012-12-03 18:12:45 +00001081
Daniel Jasper68ef0df2013-02-01 11:00:45 +00001082 /// \brief Returns \c true, if a line break after \p State is mandatory.
1083 bool mustBreak(const LineState &State) {
Manuel Klimekb3987012013-05-29 14:47:47 +00001084 const FormatToken &Current = *State.NextToken;
1085 const FormatToken &Previous = *Current.Previous;
Daniel Jasper11e13802013-05-08 14:12:04 +00001086 if (Current.MustBreakBefore || Current.Type == TT_InlineASMColon)
Daniel Jasper68ef0df2013-02-01 11:00:45 +00001087 return true;
Daniel Jasper11e13802013-05-08 14:12:04 +00001088 if (Current.is(tok::r_brace) && State.Stack.back().BreakBeforeClosingBrace)
Daniel Jasper68ef0df2013-02-01 11:00:45 +00001089 return true;
Daniel Jasper11e13802013-05-08 14:12:04 +00001090 if (Previous.is(tok::semi) && State.LineContainsContinuedForLoopSection)
Daniel Jasper68ef0df2013-02-01 11:00:45 +00001091 return true;
Daniel Jasper11e13802013-05-08 14:12:04 +00001092 if ((Previous.isOneOf(tok::comma, tok::semi) || Current.is(tok::question) ||
1093 Current.Type == TT_ConditionalExpr) &&
Daniel Jasperce3d1a62013-02-08 08:22:00 +00001094 State.Stack.back().BreakBeforeParameter &&
Daniel Jasper11e13802013-05-08 14:12:04 +00001095 !Current.isTrailingComment() &&
1096 !Current.isOneOf(tok::r_paren, tok::r_brace))
Daniel Jasper68ef0df2013-02-01 11:00:45 +00001097 return true;
Daniel Jasper11e13802013-05-08 14:12:04 +00001098
1099 // If we need to break somewhere inside the LHS of a binary expression, we
Daniel Jasper6df7a2d2013-07-03 10:34:47 +00001100 // should also break after the operator. Otherwise, the formatting would
1101 // hide the operator precedence, e.g. in:
1102 // if (aaaaaaaaaaaaaa ==
1103 // bbbbbbbbbbbbbb && c) {..
1104 // For comparisons, we only apply this rule, if the LHS is a binary
1105 // expression itself as otherwise, the line breaks seem superfluous.
1106 // We need special cases for ">>" which we have split into two ">" while
1107 // lexing in order to make template parsing easier.
1108 bool IsComparison = (Previous.getPrecedence() == prec::Relational ||
1109 Previous.getPrecedence() == prec::Equality) &&
1110 Previous.Previous &&
1111 Previous.Previous->Type != TT_BinaryOperator; // For >>.
1112 bool LHSIsBinaryExpr =
1113 Previous.Previous && Previous.Previous->FakeRParens > 0;
Daniel Jasper11e13802013-05-08 14:12:04 +00001114 if (Previous.Type == TT_BinaryOperator &&
Daniel Jasper6df7a2d2013-07-03 10:34:47 +00001115 (!IsComparison || LHSIsBinaryExpr) &&
1116 Current.Type != TT_BinaryOperator && // For >>.
Daniel Jasper5ef8aac2013-06-03 08:42:05 +00001117 !Current.isTrailingComment() &&
Daniel Jasper11e13802013-05-08 14:12:04 +00001118 !Previous.isOneOf(tok::lessless, tok::question) &&
Manuel Klimekb3987012013-05-29 14:47:47 +00001119 Previous.getPrecedence() != prec::Assignment &&
Daniel Jasperce3d1a62013-02-08 08:22:00 +00001120 State.Stack.back().BreakBeforeParameter)
Daniel Jasper63d7ced2013-02-05 10:07:47 +00001121 return true;
Daniel Jasper11e13802013-05-08 14:12:04 +00001122
1123 // FIXME: Comparing LongestObjCSelectorName to 0 is a hacky way of finding
1124 // out whether it is the first parameter. Clean this up.
1125 if (Current.Type == TT_ObjCSelectorName &&
1126 Current.LongestObjCSelectorName == 0 &&
1127 State.Stack.back().BreakBeforeParameter)
Daniel Jasper68ef0df2013-02-01 11:00:45 +00001128 return true;
Daniel Jasper11e13802013-05-08 14:12:04 +00001129 if ((Current.Type == TT_CtorInitializerColon ||
1130 (Previous.ClosesTemplateDeclaration && State.ParenLevel == 0)))
Daniel Jasper923ebef2013-03-14 13:45:21 +00001131 return true;
Daniel Jasper11e13802013-05-08 14:12:04 +00001132
Daniel Jasper6561f6a2013-07-09 07:43:55 +00001133 if ((Current.Type == TT_StartOfName || Current.is(tok::kw_operator)) &&
1134 Line.MightBeFunctionDecl && State.Stack.back().BreakBeforeParameter &&
1135 State.ParenLevel == 0)
Daniel Jasper33f4b902013-05-15 09:35:08 +00001136 return true;
Daniel Jasper68ef0df2013-02-01 11:00:45 +00001137 return false;
Daniel Jasperbac016b2012-12-03 18:12:45 +00001138 }
1139
Daniel Jasper3af59ce2013-03-15 14:57:30 +00001140 // Returns the total number of columns required for the remaining tokens.
1141 unsigned getRemainingLength(const LineState &State) {
Manuel Klimekb3987012013-05-29 14:47:47 +00001142 if (State.NextToken && State.NextToken->Previous)
1143 return Line.Last->TotalLength - State.NextToken->Previous->TotalLength;
Daniel Jasper3af59ce2013-03-15 14:57:30 +00001144 return 0;
1145 }
1146
Daniel Jasperbac016b2012-12-03 18:12:45 +00001147 FormatStyle Style;
1148 SourceManager &SourceMgr;
Daniel Jasper995e8202013-01-14 13:08:07 +00001149 const AnnotatedLine &Line;
Manuel Klimek3f8c7f32013-01-10 18:45:26 +00001150 const unsigned FirstIndent;
Manuel Klimekb3987012013-05-29 14:47:47 +00001151 const FormatToken *RootToken;
Daniel Jasperdcc2a622013-01-18 08:44:07 +00001152 WhitespaceManager &Whitespaces;
Manuel Klimek62a48fb2013-02-13 10:54:19 +00001153
1154 llvm::SpecificBumpPtrAllocator<StateNode> Allocator;
1155 QueueType Queue;
1156 // Increasing count of \c StateNode items we have created. This is used
1157 // to create a deterministic order independent of the container.
1158 unsigned Count;
Alexander Kornienko00895102013-06-05 14:09:10 +00001159 encoding::Encoding Encoding;
Daniel Jasperbac016b2012-12-03 18:12:45 +00001160};
1161
Manuel Klimek96e888b2013-05-28 11:55:06 +00001162class FormatTokenLexer {
Alexander Kornienko469a21b2012-12-07 16:15:44 +00001163public:
Alexander Kornienko00895102013-06-05 14:09:10 +00001164 FormatTokenLexer(Lexer &Lex, SourceManager &SourceMgr,
1165 encoding::Encoding Encoding)
Manuel Klimek96e888b2013-05-28 11:55:06 +00001166 : FormatTok(NULL), GreaterStashed(false), TrailingWhitespace(0), Lex(Lex),
Alexander Kornienko00895102013-06-05 14:09:10 +00001167 SourceMgr(SourceMgr), IdentTable(Lex.getLangOpts()),
1168 Encoding(Encoding) {
Alexander Kornienko469a21b2012-12-07 16:15:44 +00001169 Lex.SetKeepWhitespaceMode(true);
1170 }
1171
Manuel Klimek96e888b2013-05-28 11:55:06 +00001172 ArrayRef<FormatToken *> lex() {
1173 assert(Tokens.empty());
1174 do {
1175 Tokens.push_back(getNextToken());
1176 } while (Tokens.back()->Tok.isNot(tok::eof));
1177 return Tokens;
1178 }
1179
1180 IdentifierTable &getIdentTable() { return IdentTable; }
1181
1182private:
1183 FormatToken *getNextToken() {
Alexander Kornienko469a21b2012-12-07 16:15:44 +00001184 if (GreaterStashed) {
Manuel Klimekdcb3f2a2013-05-28 13:42:28 +00001185 // Create a synthesized second '>' token.
1186 Token Greater = FormatTok->Tok;
1187 FormatTok = new (Allocator.Allocate()) FormatToken;
1188 FormatTok->Tok = Greater;
Manuel Klimekad3094b2013-05-23 10:56:37 +00001189 SourceLocation GreaterLocation =
Manuel Klimek96e888b2013-05-28 11:55:06 +00001190 FormatTok->Tok.getLocation().getLocWithOffset(1);
1191 FormatTok->WhitespaceRange =
1192 SourceRange(GreaterLocation, GreaterLocation);
Alexander Kornienko54e6c9d2013-06-07 17:45:07 +00001193 FormatTok->TokenText = ">";
Alexander Kornienko00895102013-06-05 14:09:10 +00001194 FormatTok->CodePointCount = 1;
Alexander Kornienko469a21b2012-12-07 16:15:44 +00001195 GreaterStashed = false;
1196 return FormatTok;
1197 }
1198
Manuel Klimek96e888b2013-05-28 11:55:06 +00001199 FormatTok = new (Allocator.Allocate()) FormatToken;
1200 Lex.LexFromRawLexer(FormatTok->Tok);
1201 StringRef Text = rawTokenText(FormatTok->Tok);
Manuel Klimekde008c02013-05-27 15:23:34 +00001202 SourceLocation WhitespaceStart =
Manuel Klimek96e888b2013-05-28 11:55:06 +00001203 FormatTok->Tok.getLocation().getLocWithOffset(-TrailingWhitespace);
Manuel Klimekad3094b2013-05-23 10:56:37 +00001204 if (SourceMgr.getFileOffset(WhitespaceStart) == 0)
Manuel Klimek96e888b2013-05-28 11:55:06 +00001205 FormatTok->IsFirst = true;
Alexander Kornienko469a21b2012-12-07 16:15:44 +00001206
1207 // Consume and record whitespace until we find a significant token.
Manuel Klimekde008c02013-05-27 15:23:34 +00001208 unsigned WhitespaceLength = TrailingWhitespace;
Manuel Klimek96e888b2013-05-28 11:55:06 +00001209 while (FormatTok->Tok.is(tok::unknown)) {
Manuel Klimeka28fc062013-02-11 12:33:24 +00001210 unsigned Newlines = Text.count('\n');
Daniel Jasper1eee6c42013-03-04 13:43:19 +00001211 if (Newlines > 0)
Manuel Klimek96e888b2013-05-28 11:55:06 +00001212 FormatTok->LastNewlineOffset = WhitespaceLength + Text.rfind('\n') + 1;
Manuel Klimek96e888b2013-05-28 11:55:06 +00001213 FormatTok->NewlinesBefore += Newlines;
Alexander Kornienko54e6c9d2013-06-07 17:45:07 +00001214 unsigned EscapedNewlines = Text.count("\\\n");
Manuel Klimek96e888b2013-05-28 11:55:06 +00001215 FormatTok->HasUnescapedNewline |= EscapedNewlines != Newlines;
1216 WhitespaceLength += FormatTok->Tok.getLength();
Alexander Kornienko469a21b2012-12-07 16:15:44 +00001217
Manuel Klimek96e888b2013-05-28 11:55:06 +00001218 Lex.LexFromRawLexer(FormatTok->Tok);
1219 Text = rawTokenText(FormatTok->Tok);
Manuel Klimekd4397b92013-01-04 23:34:14 +00001220 }
Manuel Klimek95419382013-01-07 07:56:50 +00001221
Manuel Klimekd4397b92013-01-04 23:34:14 +00001222 // In case the token starts with escaped newlines, we want to
1223 // take them into account as whitespace - this pattern is quite frequent
1224 // in macro definitions.
1225 // FIXME: What do we want to do with other escaped spaces, and escaped
1226 // spaces or newlines in the middle of tokens?
1227 // FIXME: Add a more explicit test.
Alexander Kornienko54e6c9d2013-06-07 17:45:07 +00001228 while (Text.size() > 1 && Text[0] == '\\' && Text[1] == '\n') {
Manuel Klimek96e888b2013-05-28 11:55:06 +00001229 // FIXME: ++FormatTok->NewlinesBefore is missing...
Manuel Klimekad3094b2013-05-23 10:56:37 +00001230 WhitespaceLength += 2;
Alexander Kornienko54e6c9d2013-06-07 17:45:07 +00001231 Text = Text.substr(2);
Alexander Kornienko469a21b2012-12-07 16:15:44 +00001232 }
1233
Alexander Kornienko54e6c9d2013-06-07 17:45:07 +00001234 TrailingWhitespace = 0;
1235 if (FormatTok->Tok.is(tok::comment)) {
1236 StringRef UntrimmedText = Text;
1237 Text = Text.rtrim();
1238 TrailingWhitespace = UntrimmedText.size() - Text.size();
1239 } else if (FormatTok->Tok.is(tok::raw_identifier)) {
Manuel Klimekd4397b92013-01-04 23:34:14 +00001240 IdentifierInfo &Info = IdentTable.get(Text);
Manuel Klimek96e888b2013-05-28 11:55:06 +00001241 FormatTok->Tok.setIdentifierInfo(&Info);
1242 FormatTok->Tok.setKind(Info.getTokenID());
Alexander Kornienko54e6c9d2013-06-07 17:45:07 +00001243 } else if (FormatTok->Tok.is(tok::greatergreater)) {
Manuel Klimek96e888b2013-05-28 11:55:06 +00001244 FormatTok->Tok.setKind(tok::greater);
Alexander Kornienko54e6c9d2013-06-07 17:45:07 +00001245 Text = Text.substr(0, 1);
Alexander Kornienko469a21b2012-12-07 16:15:44 +00001246 GreaterStashed = true;
1247 }
1248
Alexander Kornienko54e6c9d2013-06-07 17:45:07 +00001249 // Now FormatTok is the next non-whitespace token.
1250 FormatTok->TokenText = Text;
1251 FormatTok->CodePointCount = encoding::getCodePointCount(Text, Encoding);
Alexander Kornienko00895102013-06-05 14:09:10 +00001252
Manuel Klimek96e888b2013-05-28 11:55:06 +00001253 FormatTok->WhitespaceRange = SourceRange(
Manuel Klimekad3094b2013-05-23 10:56:37 +00001254 WhitespaceStart, WhitespaceStart.getLocWithOffset(WhitespaceLength));
Alexander Kornienko469a21b2012-12-07 16:15:44 +00001255 return FormatTok;
1256 }
1257
Manuel Klimek96e888b2013-05-28 11:55:06 +00001258 FormatToken *FormatTok;
Alexander Kornienko469a21b2012-12-07 16:15:44 +00001259 bool GreaterStashed;
Manuel Klimekde008c02013-05-27 15:23:34 +00001260 unsigned TrailingWhitespace;
Alexander Kornienko469a21b2012-12-07 16:15:44 +00001261 Lexer &Lex;
1262 SourceManager &SourceMgr;
1263 IdentifierTable IdentTable;
Alexander Kornienko00895102013-06-05 14:09:10 +00001264 encoding::Encoding Encoding;
Manuel Klimek96e888b2013-05-28 11:55:06 +00001265 llvm::SpecificBumpPtrAllocator<FormatToken> Allocator;
1266 SmallVector<FormatToken *, 16> Tokens;
Alexander Kornienko469a21b2012-12-07 16:15:44 +00001267
1268 /// Returns the text of \c FormatTok.
Manuel Klimek95419382013-01-07 07:56:50 +00001269 StringRef rawTokenText(Token &Tok) {
Alexander Kornienko469a21b2012-12-07 16:15:44 +00001270 return StringRef(SourceMgr.getCharacterData(Tok.getLocation()),
1271 Tok.getLength());
1272 }
1273};
1274
Daniel Jasperbac016b2012-12-03 18:12:45 +00001275class Formatter : public UnwrappedLineConsumer {
1276public:
Daniel Jaspercaf42a32013-05-15 08:14:19 +00001277 Formatter(const FormatStyle &Style, Lexer &Lex, SourceManager &SourceMgr,
Daniel Jasperbac016b2012-12-03 18:12:45 +00001278 const std::vector<CharSourceRange> &Ranges)
Daniel Jaspercaf42a32013-05-15 08:14:19 +00001279 : Style(Style), Lex(Lex), SourceMgr(SourceMgr),
Alexander Kornienko00895102013-06-05 14:09:10 +00001280 Whitespaces(SourceMgr, Style), Ranges(Ranges),
1281 Encoding(encoding::detectEncoding(Lex.getBuffer())) {
1282 DEBUG(llvm::dbgs()
1283 << "File encoding: "
1284 << (Encoding == encoding::Encoding_UTF8 ? "UTF8" : "unknown")
1285 << "\n");
1286 }
Daniel Jasperbac016b2012-12-03 18:12:45 +00001287
Daniel Jasper7d19bc22013-01-11 14:23:32 +00001288 virtual ~Formatter() {}
Daniel Jasperaccb0b02012-12-04 21:05:31 +00001289
Alexander Kornienkoe74de282013-03-13 14:41:29 +00001290 tooling::Replacements format() {
Alexander Kornienko00895102013-06-05 14:09:10 +00001291 FormatTokenLexer Tokens(Lex, SourceMgr, Encoding);
Manuel Klimek96e888b2013-05-28 11:55:06 +00001292
1293 UnwrappedLineParser Parser(Style, Tokens.lex(), *this);
Manuel Klimek67d080d2013-04-12 14:13:36 +00001294 bool StructuralError = Parser.parse();
Alexander Kornienko00895102013-06-05 14:09:10 +00001295 TokenAnnotator Annotator(Style, Tokens.getIdentTable().get("in"));
Alexander Kornienkoe74de282013-03-13 14:41:29 +00001296 for (unsigned i = 0, e = AnnotatedLines.size(); i != e; ++i) {
1297 Annotator.annotate(AnnotatedLines[i]);
1298 }
1299 deriveLocalStyle();
1300 for (unsigned i = 0, e = AnnotatedLines.size(); i != e; ++i) {
1301 Annotator.calculateFormattingInformation(AnnotatedLines[i]);
1302 }
Daniel Jasper5999f762013-04-09 17:46:55 +00001303
1304 // Adapt level to the next line if this is a comment.
1305 // FIXME: Can/should this be done in the UnwrappedLineParser?
Alexander Kornienko0bdc6432013-07-04 14:47:51 +00001306 const AnnotatedLine *NextNonCommentLine = NULL;
Daniel Jasper5999f762013-04-09 17:46:55 +00001307 for (unsigned i = AnnotatedLines.size() - 1; i > 0; --i) {
Alexander Kornienko0bdc6432013-07-04 14:47:51 +00001308 if (NextNonCommentLine && AnnotatedLines[i].First->is(tok::comment) &&
Manuel Klimekb3987012013-05-29 14:47:47 +00001309 !AnnotatedLines[i].First->Next)
Alexander Kornienko0bdc6432013-07-04 14:47:51 +00001310 AnnotatedLines[i].Level = NextNonCommentLine->Level;
Daniel Jasper5999f762013-04-09 17:46:55 +00001311 else
Daniel Jasper2a409b62013-07-08 14:34:09 +00001312 NextNonCommentLine = AnnotatedLines[i].First->isNot(tok::r_brace)
1313 ? &AnnotatedLines[i]
1314 : NULL;
Daniel Jasper5999f762013-04-09 17:46:55 +00001315 }
1316
Alexander Kornienkoe74de282013-03-13 14:41:29 +00001317 std::vector<int> IndentForLevel;
1318 bool PreviousLineWasTouched = false;
Manuel Klimekb3987012013-05-29 14:47:47 +00001319 const FormatToken *PreviousLineLastToken = 0;
Daniel Jasper89b3a7f2013-05-10 13:00:49 +00001320 bool FormatPPDirective = false;
Alexander Kornienkoe74de282013-03-13 14:41:29 +00001321 for (std::vector<AnnotatedLine>::iterator I = AnnotatedLines.begin(),
1322 E = AnnotatedLines.end();
1323 I != E; ++I) {
1324 const AnnotatedLine &TheLine = *I;
Manuel Klimekb3987012013-05-29 14:47:47 +00001325 const FormatToken *FirstTok = TheLine.First;
1326 int Offset = getIndentOffset(*TheLine.First);
Daniel Jasper89b3a7f2013-05-10 13:00:49 +00001327
1328 // Check whether this line is part of a formatted preprocessor directive.
Manuel Klimekdcb3f2a2013-05-28 13:42:28 +00001329 if (FirstTok->HasUnescapedNewline)
Daniel Jasper89b3a7f2013-05-10 13:00:49 +00001330 FormatPPDirective = false;
1331 if (!FormatPPDirective && TheLine.InPPDirective &&
1332 (touchesLine(TheLine) || touchesPPDirective(I + 1, E)))
1333 FormatPPDirective = true;
1334
Daniel Jasper1fb8d882013-05-14 09:30:02 +00001335 // Determine indent and try to merge multiple unwrapped lines.
Alexander Kornienkoe74de282013-03-13 14:41:29 +00001336 while (IndentForLevel.size() <= TheLine.Level)
1337 IndentForLevel.push_back(-1);
1338 IndentForLevel.resize(TheLine.Level + 1);
Daniel Jasper1fb8d882013-05-14 09:30:02 +00001339 unsigned Indent = getIndent(IndentForLevel, TheLine.Level);
1340 if (static_cast<int>(Indent) + Offset >= 0)
1341 Indent += Offset;
1342 tryFitMultipleLinesInOne(Indent, I, E);
1343
Manuel Klimekdcb3f2a2013-05-28 13:42:28 +00001344 bool WasMoved = PreviousLineWasTouched && FirstTok->NewlinesBefore == 0;
Manuel Klimekb3987012013-05-29 14:47:47 +00001345 if (TheLine.First->is(tok::eof)) {
Alexander Kornienkoe74de282013-03-13 14:41:29 +00001346 if (PreviousLineWasTouched) {
Manuel Klimekdcb3f2a2013-05-28 13:42:28 +00001347 unsigned NewLines = std::min(FirstTok->NewlinesBefore, 1u);
Manuel Klimekb3987012013-05-29 14:47:47 +00001348 Whitespaces.replaceWhitespace(*TheLine.First, NewLines, /*Indent*/ 0,
Manuel Klimeke573c3f2013-05-22 12:51:29 +00001349 /*TargetColumn*/ 0);
Alexander Kornienkoe74de282013-03-13 14:41:29 +00001350 }
1351 } else if (TheLine.Type != LT_Invalid &&
Daniel Jasper89b3a7f2013-05-10 13:00:49 +00001352 (WasMoved || FormatPPDirective || touchesLine(TheLine))) {
Alexander Kornienkoe74de282013-03-13 14:41:29 +00001353 unsigned LevelIndent = getIndent(IndentForLevel, TheLine.Level);
Manuel Klimekdcb3f2a2013-05-28 13:42:28 +00001354 if (FirstTok->WhitespaceRange.isValid() &&
Manuel Klimek67d080d2013-04-12 14:13:36 +00001355 // Insert a break even if there is a structural error in case where
1356 // we break apart a line consisting of multiple unwrapped lines.
Manuel Klimekdcb3f2a2013-05-28 13:42:28 +00001357 (FirstTok->NewlinesBefore == 0 || !StructuralError)) {
Manuel Klimekb3987012013-05-29 14:47:47 +00001358 formatFirstToken(*TheLine.First, PreviousLineLastToken, Indent,
Manuel Klimeke573c3f2013-05-22 12:51:29 +00001359 TheLine.InPPDirective);
Manuel Klimek67d080d2013-04-12 14:13:36 +00001360 } else {
1361 Indent = LevelIndent =
Manuel Klimekdcb3f2a2013-05-28 13:42:28 +00001362 SourceMgr.getSpellingColumnNumber(FirstTok->Tok.getLocation()) -
1363 1;
Alexander Kornienkoe74de282013-03-13 14:41:29 +00001364 }
Alexander Kornienkoe74de282013-03-13 14:41:29 +00001365 UnwrappedLineFormatter Formatter(Style, SourceMgr, TheLine, Indent,
Alexander Kornienko00895102013-06-05 14:09:10 +00001366 TheLine.First, Whitespaces, Encoding);
Manuel Klimeke573c3f2013-05-22 12:51:29 +00001367 Formatter.format(I + 1 != E ? &*(I + 1) : NULL);
Alexander Kornienkoe74de282013-03-13 14:41:29 +00001368 IndentForLevel[TheLine.Level] = LevelIndent;
1369 PreviousLineWasTouched = true;
1370 } else {
Manuel Klimeke573c3f2013-05-22 12:51:29 +00001371 // Format the first token if necessary, and notify the WhitespaceManager
1372 // about the unchanged whitespace.
Manuel Klimekb3987012013-05-29 14:47:47 +00001373 for (const FormatToken *Tok = TheLine.First; Tok != NULL;
1374 Tok = Tok->Next) {
1375 if (Tok == TheLine.First &&
1376 (Tok->NewlinesBefore > 0 || Tok->IsFirst)) {
1377 unsigned LevelIndent =
1378 SourceMgr.getSpellingColumnNumber(Tok->Tok.getLocation()) - 1;
Manuel Klimeke573c3f2013-05-22 12:51:29 +00001379 // Remove trailing whitespace of the previous line if it was
1380 // touched.
1381 if (PreviousLineWasTouched || touchesEmptyLineBefore(TheLine)) {
1382 formatFirstToken(*Tok, PreviousLineLastToken, LevelIndent,
1383 TheLine.InPPDirective);
1384 } else {
Manuel Klimekb3987012013-05-29 14:47:47 +00001385 Whitespaces.addUntouchableToken(*Tok, TheLine.InPPDirective);
Manuel Klimeke573c3f2013-05-22 12:51:29 +00001386 }
Daniel Jasper1fb8d882013-05-14 09:30:02 +00001387
Manuel Klimeke573c3f2013-05-22 12:51:29 +00001388 if (static_cast<int>(LevelIndent) - Offset >= 0)
1389 LevelIndent -= Offset;
1390 if (Tok->isNot(tok::comment))
1391 IndentForLevel[TheLine.Level] = LevelIndent;
1392 } else {
Manuel Klimekb3987012013-05-29 14:47:47 +00001393 Whitespaces.addUntouchableToken(*Tok, TheLine.InPPDirective);
Manuel Klimeke573c3f2013-05-22 12:51:29 +00001394 }
Alexander Kornienkoe74de282013-03-13 14:41:29 +00001395 }
1396 // If we did not reformat this unwrapped line, the column at the end of
1397 // the last token is unchanged - thus, we can calculate the end of the
1398 // last token.
Alexander Kornienkoe74de282013-03-13 14:41:29 +00001399 PreviousLineWasTouched = false;
1400 }
Alexander Kornienko94b748f2013-03-27 17:08:02 +00001401 PreviousLineLastToken = I->Last;
Alexander Kornienkoe74de282013-03-13 14:41:29 +00001402 }
1403 return Whitespaces.generateReplacements();
1404 }
1405
1406private:
Daniel Jasper8ff690a2013-02-06 14:22:40 +00001407 void deriveLocalStyle() {
1408 unsigned CountBoundToVariable = 0;
1409 unsigned CountBoundToType = 0;
1410 bool HasCpp03IncompatibleFormat = false;
1411 for (unsigned i = 0, e = AnnotatedLines.size(); i != e; ++i) {
Manuel Klimekb3987012013-05-29 14:47:47 +00001412 if (!AnnotatedLines[i].First->Next)
Daniel Jasper8ff690a2013-02-06 14:22:40 +00001413 continue;
Manuel Klimekb3987012013-05-29 14:47:47 +00001414 FormatToken *Tok = AnnotatedLines[i].First->Next;
1415 while (Tok->Next) {
Daniel Jasper8ff690a2013-02-06 14:22:40 +00001416 if (Tok->Type == TT_PointerOrReference) {
Manuel Klimekb3987012013-05-29 14:47:47 +00001417 bool SpacesBefore =
1418 Tok->WhitespaceRange.getBegin() != Tok->WhitespaceRange.getEnd();
1419 bool SpacesAfter = Tok->Next->WhitespaceRange.getBegin() !=
1420 Tok->Next->WhitespaceRange.getEnd();
Daniel Jasper8ff690a2013-02-06 14:22:40 +00001421 if (SpacesBefore && !SpacesAfter)
1422 ++CountBoundToVariable;
1423 else if (!SpacesBefore && SpacesAfter)
1424 ++CountBoundToType;
1425 }
1426
Daniel Jasper29f123b2013-02-08 15:28:42 +00001427 if (Tok->Type == TT_TemplateCloser &&
Manuel Klimekb3987012013-05-29 14:47:47 +00001428 Tok->Previous->Type == TT_TemplateCloser &&
1429 Tok->WhitespaceRange.getBegin() == Tok->WhitespaceRange.getEnd())
Daniel Jasper8ff690a2013-02-06 14:22:40 +00001430 HasCpp03IncompatibleFormat = true;
Manuel Klimekb3987012013-05-29 14:47:47 +00001431 Tok = Tok->Next;
Daniel Jasper8ff690a2013-02-06 14:22:40 +00001432 }
1433 }
1434 if (Style.DerivePointerBinding) {
1435 if (CountBoundToType > CountBoundToVariable)
1436 Style.PointerBindsToType = true;
1437 else if (CountBoundToType < CountBoundToVariable)
1438 Style.PointerBindsToType = false;
1439 }
1440 if (Style.Standard == FormatStyle::LS_Auto) {
1441 Style.Standard = HasCpp03IncompatibleFormat ? FormatStyle::LS_Cpp11
1442 : FormatStyle::LS_Cpp03;
1443 }
1444 }
1445
Manuel Klimek547d5db2013-02-08 17:38:27 +00001446 /// \brief Get the indent of \p Level from \p IndentForLevel.
1447 ///
1448 /// \p IndentForLevel must contain the indent for the level \c l
1449 /// at \p IndentForLevel[l], or a value < 0 if the indent for
1450 /// that level is unknown.
Daniel Jasperfc759082013-02-14 14:26:07 +00001451 unsigned getIndent(const std::vector<int> IndentForLevel, unsigned Level) {
Manuel Klimek547d5db2013-02-08 17:38:27 +00001452 if (IndentForLevel[Level] != -1)
1453 return IndentForLevel[Level];
Manuel Klimek52635ff2013-02-08 19:53:32 +00001454 if (Level == 0)
1455 return 0;
Manuel Klimek07a64ec2013-05-13 08:42:42 +00001456 return getIndent(IndentForLevel, Level - 1) + Style.IndentWidth;
Manuel Klimek547d5db2013-02-08 17:38:27 +00001457 }
1458
1459 /// \brief Get the offset of the line relatively to the level.
1460 ///
1461 /// For example, 'public:' labels in classes are offset by 1 or 2
1462 /// characters to the left from their level.
Manuel Klimekb3987012013-05-29 14:47:47 +00001463 int getIndentOffset(const FormatToken &RootToken) {
Alexander Kornienko94b748f2013-03-27 17:08:02 +00001464 if (RootToken.isAccessSpecifier(false) || RootToken.isObjCAccessSpecifier())
Manuel Klimek547d5db2013-02-08 17:38:27 +00001465 return Style.AccessModifierOffset;
1466 return 0;
1467 }
1468
Manuel Klimek517e8942013-01-11 17:54:10 +00001469 /// \brief Tries to merge lines into one.
1470 ///
1471 /// This will change \c Line and \c AnnotatedLine to contain the merged line,
1472 /// if possible; note that \c I will be incremented when lines are merged.
Daniel Jasper3f8cdbf2013-01-16 10:41:46 +00001473 void tryFitMultipleLinesInOne(unsigned Indent,
Daniel Jasper995e8202013-01-14 13:08:07 +00001474 std::vector<AnnotatedLine>::iterator &I,
1475 std::vector<AnnotatedLine>::iterator E) {
Daniel Jasper3f8cdbf2013-01-16 10:41:46 +00001476 // We can never merge stuff if there are trailing line comments.
1477 if (I->Last->Type == TT_LineComment)
1478 return;
1479
Daniel Jaspera4d46212013-02-28 11:05:57 +00001480 unsigned Limit = Style.ColumnLimit - Indent;
Daniel Jasperf11a7052013-02-21 21:33:55 +00001481 // If we already exceed the column limit, we set 'Limit' to 0. The different
1482 // tryMerge..() functions can then decide whether to still do merging.
1483 Limit = I->Last->TotalLength > Limit ? 0 : Limit - I->Last->TotalLength;
Daniel Jasper55b08e72013-01-16 07:02:34 +00001484
Daniel Jasper9c8c40e2013-01-21 14:18:28 +00001485 if (I + 1 == E || (I + 1)->Type == LT_Invalid)
Daniel Jasper3f8cdbf2013-01-16 10:41:46 +00001486 return;
Manuel Klimek517e8942013-01-11 17:54:10 +00001487
Daniel Jasper5be59ba2013-05-15 14:09:55 +00001488 if (I->Last->is(tok::l_brace)) {
Daniel Jasperfeb18f52013-01-14 14:14:23 +00001489 tryMergeSimpleBlock(I, E, Limit);
Daniel Jasperf11bbb92013-05-16 12:12:21 +00001490 } else if (Style.AllowShortIfStatementsOnASingleLine &&
Manuel Klimekb3987012013-05-29 14:47:47 +00001491 I->First->is(tok::kw_if)) {
Daniel Jasperf11bbb92013-05-16 12:12:21 +00001492 tryMergeSimpleControlStatement(I, E, Limit);
1493 } else if (Style.AllowShortLoopsOnASingleLine &&
Manuel Klimekb3987012013-05-29 14:47:47 +00001494 I->First->isOneOf(tok::kw_for, tok::kw_while)) {
Daniel Jasperf11bbb92013-05-16 12:12:21 +00001495 tryMergeSimpleControlStatement(I, E, Limit);
Manuel Klimekb3987012013-05-29 14:47:47 +00001496 } else if (I->InPPDirective &&
1497 (I->First->HasUnescapedNewline || I->First->IsFirst)) {
Daniel Jaspere0b15ea2013-01-14 15:40:57 +00001498 tryMergeSimplePPDirective(I, E, Limit);
Daniel Jasperfeb18f52013-01-14 14:14:23 +00001499 }
Daniel Jasperfeb18f52013-01-14 14:14:23 +00001500 }
1501
Daniel Jaspere0b15ea2013-01-14 15:40:57 +00001502 void tryMergeSimplePPDirective(std::vector<AnnotatedLine>::iterator &I,
1503 std::vector<AnnotatedLine>::iterator E,
1504 unsigned Limit) {
Daniel Jasperf11a7052013-02-21 21:33:55 +00001505 if (Limit == 0)
1506 return;
Daniel Jaspere0b15ea2013-01-14 15:40:57 +00001507 AnnotatedLine &Line = *I;
Manuel Klimekb3987012013-05-29 14:47:47 +00001508 if (!(I + 1)->InPPDirective || (I + 1)->First->HasUnescapedNewline)
Daniel Jasper2b9c10b2013-01-14 15:52:06 +00001509 return;
Daniel Jaspere0b15ea2013-01-14 15:40:57 +00001510 if (I + 2 != E && (I + 2)->InPPDirective &&
Manuel Klimekb3987012013-05-29 14:47:47 +00001511 !(I + 2)->First->HasUnescapedNewline)
Daniel Jaspere0b15ea2013-01-14 15:40:57 +00001512 return;
Manuel Klimek2f1ac412013-01-21 16:42:44 +00001513 if (1 + (I + 1)->Last->TotalLength > Limit)
Daniel Jasper3f8cdbf2013-01-16 10:41:46 +00001514 return;
Daniel Jaspere0b15ea2013-01-14 15:40:57 +00001515 join(Line, *(++I));
1516 }
1517
Daniel Jasperf11bbb92013-05-16 12:12:21 +00001518 void tryMergeSimpleControlStatement(std::vector<AnnotatedLine>::iterator &I,
1519 std::vector<AnnotatedLine>::iterator E,
1520 unsigned Limit) {
Daniel Jasperf11a7052013-02-21 21:33:55 +00001521 if (Limit == 0)
1522 return;
Manuel Klimek4c128122013-01-18 14:46:43 +00001523 if ((I + 1)->InPPDirective != I->InPPDirective ||
Manuel Klimekb3987012013-05-29 14:47:47 +00001524 ((I + 1)->InPPDirective && (I + 1)->First->HasUnescapedNewline))
Manuel Klimek4c128122013-01-18 14:46:43 +00001525 return;
Daniel Jasperfeb18f52013-01-14 14:14:23 +00001526 AnnotatedLine &Line = *I;
Daniel Jasper55b08e72013-01-16 07:02:34 +00001527 if (Line.Last->isNot(tok::r_paren))
1528 return;
Manuel Klimek2f1ac412013-01-21 16:42:44 +00001529 if (1 + (I + 1)->Last->TotalLength > Limit)
Daniel Jasperfeb18f52013-01-14 14:14:23 +00001530 return;
Manuel Klimekb3987012013-05-29 14:47:47 +00001531 if ((I + 1)->First->isOneOf(tok::semi, tok::kw_if, tok::kw_for,
1532 tok::kw_while) ||
1533 (I + 1)->First->Type == TT_LineComment)
Daniel Jasperfeb18f52013-01-14 14:14:23 +00001534 return;
1535 // Only inline simple if's (no nested if or else).
Manuel Klimekb3987012013-05-29 14:47:47 +00001536 if (I + 2 != E && Line.First->is(tok::kw_if) &&
1537 (I + 2)->First->is(tok::kw_else))
Daniel Jasperfeb18f52013-01-14 14:14:23 +00001538 return;
1539 join(Line, *(++I));
1540 }
1541
1542 void tryMergeSimpleBlock(std::vector<AnnotatedLine>::iterator &I,
Daniel Jasper1a1ce832013-01-29 11:27:30 +00001543 std::vector<AnnotatedLine>::iterator E,
1544 unsigned Limit) {
Daniel Jasper5be59ba2013-05-15 14:09:55 +00001545 // No merging if the brace already is on the next line.
1546 if (Style.BreakBeforeBraces != FormatStyle::BS_Attach)
1547 return;
1548
Manuel Klimek517e8942013-01-11 17:54:10 +00001549 // First, check that the current line allows merging. This is the case if
1550 // we're not in a control flow statement and the last token is an opening
1551 // brace.
Daniel Jasperfeb18f52013-01-14 14:14:23 +00001552 AnnotatedLine &Line = *I;
Manuel Klimekb3987012013-05-29 14:47:47 +00001553 if (Line.First->isOneOf(tok::kw_if, tok::kw_while, tok::kw_do, tok::r_brace,
1554 tok::kw_else, tok::kw_try, tok::kw_catch,
Daniel Jasper8893b8a2013-05-31 14:56:20 +00001555 tok::kw_for,
Manuel Klimekb3987012013-05-29 14:47:47 +00001556 // This gets rid of all ObjC @ keywords and methods.
1557 tok::at, tok::minus, tok::plus))
Daniel Jasperfeb18f52013-01-14 14:14:23 +00001558 return;
Manuel Klimek517e8942013-01-11 17:54:10 +00001559
Manuel Klimekb3987012013-05-29 14:47:47 +00001560 FormatToken *Tok = (I + 1)->First;
Daniel Jasper8893b8a2013-05-31 14:56:20 +00001561 if (Tok->is(tok::r_brace) && !Tok->MustBreakBefore &&
Alexander Kornienko0bdc6432013-07-04 14:47:51 +00001562 (Tok->getNextNonComment() == NULL ||
1563 Tok->getNextNonComment()->is(tok::semi))) {
Daniel Jasperf11a7052013-02-21 21:33:55 +00001564 // We merge empty blocks even if the line exceeds the column limit.
Daniel Jasper729a7432013-02-11 12:36:37 +00001565 Tok->SpacesRequiredBefore = 0;
Daniel Jasperf11a7052013-02-21 21:33:55 +00001566 Tok->CanBreakBefore = true;
Manuel Klimek2f1ac412013-01-21 16:42:44 +00001567 join(Line, *(I + 1));
1568 I += 1;
Daniel Jasper8893b8a2013-05-31 14:56:20 +00001569 } else if (Limit != 0 && Line.First->isNot(tok::kw_namespace)) {
Manuel Klimek2f1ac412013-01-21 16:42:44 +00001570 // Check that we still have three lines and they fit into the limit.
1571 if (I + 2 == E || (I + 2)->Type == LT_Invalid ||
1572 !nextTwoLinesFitInto(I, Limit))
Daniel Jasperfeb18f52013-01-14 14:14:23 +00001573 return;
Manuel Klimek517e8942013-01-11 17:54:10 +00001574
Manuel Klimek2f1ac412013-01-21 16:42:44 +00001575 // Second, check that the next line does not contain any braces - if it
1576 // does, readability declines when putting it into a single line.
1577 if ((I + 1)->Last->Type == TT_LineComment || Tok->MustBreakBefore)
1578 return;
1579 do {
Alexander Kornienkoe74de282013-03-13 14:41:29 +00001580 if (Tok->isOneOf(tok::l_brace, tok::r_brace))
Manuel Klimek2f1ac412013-01-21 16:42:44 +00001581 return;
Manuel Klimekb3987012013-05-29 14:47:47 +00001582 Tok = Tok->Next;
Manuel Klimek2f1ac412013-01-21 16:42:44 +00001583 } while (Tok != NULL);
Manuel Klimek517e8942013-01-11 17:54:10 +00001584
Manuel Klimek2f1ac412013-01-21 16:42:44 +00001585 // Last, check that the third line contains a single closing brace.
Manuel Klimekb3987012013-05-29 14:47:47 +00001586 Tok = (I + 2)->First;
Alexander Kornienko0bdc6432013-07-04 14:47:51 +00001587 if (Tok->getNextNonComment() != NULL || Tok->isNot(tok::r_brace) ||
Manuel Klimek2f1ac412013-01-21 16:42:44 +00001588 Tok->MustBreakBefore)
1589 return;
1590
1591 join(Line, *(I + 1));
1592 join(Line, *(I + 2));
1593 I += 2;
Manuel Klimek517e8942013-01-11 17:54:10 +00001594 }
Daniel Jasperfeb18f52013-01-14 14:14:23 +00001595 }
1596
1597 bool nextTwoLinesFitInto(std::vector<AnnotatedLine>::iterator I,
1598 unsigned Limit) {
Manuel Klimek2f1ac412013-01-21 16:42:44 +00001599 return 1 + (I + 1)->Last->TotalLength + 1 + (I + 2)->Last->TotalLength <=
1600 Limit;
Manuel Klimek517e8942013-01-11 17:54:10 +00001601 }
1602
Daniel Jasper995e8202013-01-14 13:08:07 +00001603 void join(AnnotatedLine &A, const AnnotatedLine &B) {
Manuel Klimekb3987012013-05-29 14:47:47 +00001604 assert(!A.Last->Next);
1605 assert(!B.First->Previous);
1606 A.Last->Next = B.First;
1607 B.First->Previous = A.Last;
1608 unsigned LengthA = A.Last->TotalLength + B.First->SpacesRequiredBefore;
1609 for (FormatToken *Tok = B.First; Tok; Tok = Tok->Next) {
1610 Tok->TotalLength += LengthA;
1611 A.Last = Tok;
Daniel Jasper995e8202013-01-14 13:08:07 +00001612 }
Manuel Klimekf9ea2ed2013-01-10 19:49:59 +00001613 }
1614
Daniel Jasper6f21a982013-03-13 07:49:51 +00001615 bool touchesRanges(const CharSourceRange &Range) {
Daniel Jasperf3023542013-03-07 20:50:00 +00001616 for (unsigned i = 0, e = Ranges.size(); i != e; ++i) {
1617 if (!SourceMgr.isBeforeInTranslationUnit(Range.getEnd(),
1618 Ranges[i].getBegin()) &&
1619 !SourceMgr.isBeforeInTranslationUnit(Ranges[i].getEnd(),
1620 Range.getBegin()))
1621 return true;
1622 }
1623 return false;
1624 }
1625
1626 bool touchesLine(const AnnotatedLine &TheLine) {
Manuel Klimekb3987012013-05-29 14:47:47 +00001627 const FormatToken *First = TheLine.First;
1628 const FormatToken *Last = TheLine.Last;
Daniel Jasper84f5ddf2013-05-14 10:31:09 +00001629 CharSourceRange LineRange = CharSourceRange::getCharRange(
Manuel Klimekad3094b2013-05-23 10:56:37 +00001630 First->WhitespaceRange.getBegin().getLocWithOffset(
1631 First->LastNewlineOffset),
Alexander Kornienko54e6c9d2013-06-07 17:45:07 +00001632 Last->Tok.getLocation().getLocWithOffset(Last->TokenText.size() - 1));
Daniel Jasperf3023542013-03-07 20:50:00 +00001633 return touchesRanges(LineRange);
1634 }
1635
Daniel Jasper89b3a7f2013-05-10 13:00:49 +00001636 bool touchesPPDirective(std::vector<AnnotatedLine>::iterator I,
1637 std::vector<AnnotatedLine>::iterator E) {
1638 for (; I != E; ++I) {
Manuel Klimekb3987012013-05-29 14:47:47 +00001639 if (I->First->HasUnescapedNewline)
Daniel Jasper89b3a7f2013-05-10 13:00:49 +00001640 return false;
1641 if (touchesLine(*I))
1642 return true;
1643 }
1644 return false;
1645 }
1646
Daniel Jasperf3023542013-03-07 20:50:00 +00001647 bool touchesEmptyLineBefore(const AnnotatedLine &TheLine) {
Manuel Klimekb3987012013-05-29 14:47:47 +00001648 const FormatToken *First = TheLine.First;
Daniel Jasperf3023542013-03-07 20:50:00 +00001649 CharSourceRange LineRange = CharSourceRange::getCharRange(
Manuel Klimekad3094b2013-05-23 10:56:37 +00001650 First->WhitespaceRange.getBegin(),
1651 First->WhitespaceRange.getBegin().getLocWithOffset(
1652 First->LastNewlineOffset));
Daniel Jasperf3023542013-03-07 20:50:00 +00001653 return touchesRanges(LineRange);
Manuel Klimekf9ea2ed2013-01-10 19:49:59 +00001654 }
1655
1656 virtual void consumeUnwrappedLine(const UnwrappedLine &TheLine) {
Daniel Jaspercbb6c412013-01-16 09:10:19 +00001657 AnnotatedLines.push_back(AnnotatedLine(TheLine));
Daniel Jasperbac016b2012-12-03 18:12:45 +00001658 }
1659
Manuel Klimek3f8c7f32013-01-10 18:45:26 +00001660 /// \brief Add a new line and the required indent before the first Token
1661 /// of the \c UnwrappedLine if there was no structural parsing error.
1662 /// Returns the indent level of the \c UnwrappedLine.
Manuel Klimekb3987012013-05-29 14:47:47 +00001663 void formatFirstToken(const FormatToken &RootToken,
1664 const FormatToken *PreviousToken, unsigned Indent,
Manuel Klimeke573c3f2013-05-22 12:51:29 +00001665 bool InPPDirective) {
Daniel Jasper1a1ce832013-01-29 11:27:30 +00001666 unsigned Newlines =
Manuel Klimekb3987012013-05-29 14:47:47 +00001667 std::min(RootToken.NewlinesBefore, Style.MaxEmptyLinesToKeep + 1);
Daniel Jasper15f33f02013-06-03 16:16:41 +00001668 // Remove empty lines before "}" where applicable.
1669 if (RootToken.is(tok::r_brace) &&
1670 (!RootToken.Next ||
1671 (RootToken.Next->is(tok::semi) && !RootToken.Next->Next)))
1672 Newlines = std::min(Newlines, 1u);
Manuel Klimekb3987012013-05-29 14:47:47 +00001673 if (Newlines == 0 && !RootToken.IsFirst)
Manuel Klimek3f8c7f32013-01-10 18:45:26 +00001674 Newlines = 1;
Manuel Klimek3f8c7f32013-01-10 18:45:26 +00001675
Manuel Klimeke573c3f2013-05-22 12:51:29 +00001676 // Insert extra new line before access specifiers.
1677 if (PreviousToken && PreviousToken->isOneOf(tok::semi, tok::r_brace) &&
Manuel Klimekb3987012013-05-29 14:47:47 +00001678 RootToken.isAccessSpecifier() && RootToken.NewlinesBefore == 1)
Manuel Klimeke573c3f2013-05-22 12:51:29 +00001679 ++Newlines;
Alexander Kornienko94b748f2013-03-27 17:08:02 +00001680
Manuel Klimekb3987012013-05-29 14:47:47 +00001681 Whitespaces.replaceWhitespace(
1682 RootToken, Newlines, Indent, Indent,
1683 InPPDirective && !RootToken.HasUnescapedNewline);
Manuel Klimek3f8c7f32013-01-10 18:45:26 +00001684 }
1685
Daniel Jasperbac016b2012-12-03 18:12:45 +00001686 FormatStyle Style;
1687 Lexer &Lex;
1688 SourceManager &SourceMgr;
Daniel Jasperdcc2a622013-01-18 08:44:07 +00001689 WhitespaceManager Whitespaces;
Daniel Jasperbac016b2012-12-03 18:12:45 +00001690 std::vector<CharSourceRange> Ranges;
Daniel Jasper995e8202013-01-14 13:08:07 +00001691 std::vector<AnnotatedLine> AnnotatedLines;
Alexander Kornienko00895102013-06-05 14:09:10 +00001692
1693 encoding::Encoding Encoding;
Daniel Jasperbac016b2012-12-03 18:12:45 +00001694};
1695
Craig Topper83f81d72013-06-30 22:29:28 +00001696} // end anonymous namespace
1697
Alexander Kornienko70ce7882013-04-15 14:28:00 +00001698tooling::Replacements reformat(const FormatStyle &Style, Lexer &Lex,
1699 SourceManager &SourceMgr,
Daniel Jaspercaf42a32013-05-15 08:14:19 +00001700 std::vector<CharSourceRange> Ranges) {
1701 Formatter formatter(Style, Lex, SourceMgr, Ranges);
Daniel Jasperbac016b2012-12-03 18:12:45 +00001702 return formatter.format();
1703}
1704
Daniel Jasper8a999452013-05-16 10:40:07 +00001705tooling::Replacements reformat(const FormatStyle &Style, StringRef Code,
1706 std::vector<tooling::Range> Ranges,
1707 StringRef FileName) {
1708 FileManager Files((FileSystemOptions()));
1709 DiagnosticsEngine Diagnostics(
1710 IntrusiveRefCntPtr<DiagnosticIDs>(new DiagnosticIDs),
1711 new DiagnosticOptions);
1712 SourceManager SourceMgr(Diagnostics, Files);
1713 llvm::MemoryBuffer *Buf = llvm::MemoryBuffer::getMemBuffer(Code, FileName);
1714 const clang::FileEntry *Entry =
1715 Files.getVirtualFile(FileName, Buf->getBufferSize(), 0);
1716 SourceMgr.overrideFileContents(Entry, Buf);
1717 FileID ID =
1718 SourceMgr.createFileID(Entry, SourceLocation(), clang::SrcMgr::C_User);
Alexander Kornienkoa1753f42013-06-28 12:51:24 +00001719 Lexer Lex(ID, SourceMgr.getBuffer(ID), SourceMgr,
1720 getFormattingLangOpts(Style.Standard));
Daniel Jasper8a999452013-05-16 10:40:07 +00001721 SourceLocation StartOfFile = SourceMgr.getLocForStartOfFile(ID);
1722 std::vector<CharSourceRange> CharRanges;
1723 for (unsigned i = 0, e = Ranges.size(); i != e; ++i) {
1724 SourceLocation Start = StartOfFile.getLocWithOffset(Ranges[i].getOffset());
1725 SourceLocation End = Start.getLocWithOffset(Ranges[i].getLength());
1726 CharRanges.push_back(CharSourceRange::getCharRange(Start, End));
1727 }
1728 return reformat(Style, Lex, SourceMgr, CharRanges);
1729}
1730
Alexander Kornienkoa1753f42013-06-28 12:51:24 +00001731LangOptions getFormattingLangOpts(FormatStyle::LanguageStandard Standard) {
Daniel Jasper46ef8522013-01-10 13:08:12 +00001732 LangOptions LangOpts;
1733 LangOpts.CPlusPlus = 1;
Alexander Kornienkoa1753f42013-06-28 12:51:24 +00001734 LangOpts.CPlusPlus11 = Standard == FormatStyle::LS_Cpp03 ? 0 : 1;
Daniel Jasperb64eca02013-03-22 10:01:29 +00001735 LangOpts.LineComment = 1;
Daniel Jasper46ef8522013-01-10 13:08:12 +00001736 LangOpts.Bool = 1;
1737 LangOpts.ObjC1 = 1;
1738 LangOpts.ObjC2 = 1;
1739 return LangOpts;
1740}
1741
Daniel Jaspercd162382013-01-07 13:26:07 +00001742} // namespace format
1743} // namespace clang