blob: 87c2fd70aeee115aa34e924cc1428a67341087ab [file] [log] [blame]
Daniel Jasperf7935112012-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 Jasperf7935112012-12-03 18:12:45 +000014//===----------------------------------------------------------------------===//
15
Manuel Klimek24998102013-01-16 14:55:28 +000016#define DEBUG_TYPE "format-formatter"
17
Daniel Jasperde0328a2013-08-16 11:20:30 +000018#include "ContinuationIndenter.h"
Daniel Jasper7a6d09b2013-01-29 21:01:14 +000019#include "TokenAnnotator.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000020#include "UnwrappedLineParser.h"
Alexander Kornienkocb45bc12013-04-15 14:28:00 +000021#include "WhitespaceManager.h"
Daniel Jasperec04c0d2013-05-16 10:40:07 +000022#include "clang/Basic/Diagnostic.h"
Chandler Carruth44eb4f62013-01-02 10:28:36 +000023#include "clang/Basic/SourceManager.h"
Manuel Klimek24998102013-01-16 14:55:28 +000024#include "clang/Format/Format.h"
Daniel Jasperf7935112012-12-03 18:12:45 +000025#include "clang/Lex/Lexer.h"
Alexander Kornienkoffd6d042013-03-27 11:52:18 +000026#include "llvm/ADT/STLExtras.h"
Manuel Klimek2ef908e2013-02-13 10:46:36 +000027#include "llvm/Support/Allocator.h"
Manuel Klimek24998102013-01-16 14:55:28 +000028#include "llvm/Support/Debug.h"
Alexander Kornienkod6538332013-05-07 15:32:14 +000029#include "llvm/Support/YAMLTraits.h"
Edwin Vaned544aa72013-09-30 13:31:48 +000030#include "llvm/Support/Path.h"
Manuel Klimek2ef908e2013-02-13 10:46:36 +000031#include <queue>
Daniel Jasper8b529712012-12-04 13:02:32 +000032#include <string>
33
Alexander Kornienko6d2c88e2013-12-10 10:30:34 +000034using clang::format::FormatStyle;
35
Alexander Kornienkod6538332013-05-07 15:32:14 +000036namespace llvm {
37namespace yaml {
Alexander Kornienko6d2c88e2013-12-10 10:30:34 +000038template <> struct ScalarEnumerationTraits<FormatStyle::LanguageKind> {
39 static void enumeration(IO &IO, FormatStyle::LanguageKind &Value) {
40 IO.enumCase(Value, "Cpp", FormatStyle::LK_Cpp);
41 IO.enumCase(Value, "JavaScript", FormatStyle::LK_JavaScript);
42 }
43};
44
45template <> struct ScalarEnumerationTraits<FormatStyle::LanguageStandard> {
46 static void enumeration(IO &IO, FormatStyle::LanguageStandard &Value) {
47 IO.enumCase(Value, "Cpp03", FormatStyle::LS_Cpp03);
48 IO.enumCase(Value, "C++03", FormatStyle::LS_Cpp03);
49 IO.enumCase(Value, "Cpp11", FormatStyle::LS_Cpp11);
50 IO.enumCase(Value, "C++11", FormatStyle::LS_Cpp11);
51 IO.enumCase(Value, "Auto", FormatStyle::LS_Auto);
52 }
53};
54
55template <> struct ScalarEnumerationTraits<FormatStyle::UseTabStyle> {
56 static void enumeration(IO &IO, FormatStyle::UseTabStyle &Value) {
57 IO.enumCase(Value, "Never", FormatStyle::UT_Never);
58 IO.enumCase(Value, "false", FormatStyle::UT_Never);
59 IO.enumCase(Value, "Always", FormatStyle::UT_Always);
60 IO.enumCase(Value, "true", FormatStyle::UT_Always);
61 IO.enumCase(Value, "ForIndentation", FormatStyle::UT_ForIndentation);
62 }
63};
64
65template <> struct ScalarEnumerationTraits<FormatStyle::BraceBreakingStyle> {
66 static void enumeration(IO &IO, FormatStyle::BraceBreakingStyle &Value) {
67 IO.enumCase(Value, "Attach", FormatStyle::BS_Attach);
68 IO.enumCase(Value, "Linux", FormatStyle::BS_Linux);
69 IO.enumCase(Value, "Stroustrup", FormatStyle::BS_Stroustrup);
70 IO.enumCase(Value, "Allman", FormatStyle::BS_Allman);
Alexander Kornienko3a33f022013-12-12 09:49:52 +000071 IO.enumCase(Value, "GNU", FormatStyle::BS_GNU);
Alexander Kornienko6d2c88e2013-12-10 10:30:34 +000072 }
73};
74
Alexander Kornienkod6538332013-05-07 15:32:14 +000075template <>
Alexander Kornienko6d2c88e2013-12-10 10:30:34 +000076struct ScalarEnumerationTraits<FormatStyle::NamespaceIndentationKind> {
Alexander Kornienkocabdd732013-11-29 15:19:43 +000077 static void enumeration(IO &IO,
Alexander Kornienko6d2c88e2013-12-10 10:30:34 +000078 FormatStyle::NamespaceIndentationKind &Value) {
79 IO.enumCase(Value, "None", FormatStyle::NI_None);
80 IO.enumCase(Value, "Inner", FormatStyle::NI_Inner);
81 IO.enumCase(Value, "All", FormatStyle::NI_All);
Alexander Kornienkocabdd732013-11-29 15:19:43 +000082 }
83};
84
85template <>
Alexander Kornienko6d2c88e2013-12-10 10:30:34 +000086struct ScalarEnumerationTraits<FormatStyle::SpaceBeforeParensOptions> {
Manuel Klimeka8eb9142013-05-13 12:51:40 +000087 static void enumeration(IO &IO,
Alexander Kornienko6d2c88e2013-12-10 10:30:34 +000088 FormatStyle::SpaceBeforeParensOptions &Value) {
89 IO.enumCase(Value, "Never", FormatStyle::SBPO_Never);
Alexander Kornienkofdca83d2013-12-10 10:18:34 +000090 IO.enumCase(Value, "ControlStatements",
Alexander Kornienko6d2c88e2013-12-10 10:30:34 +000091 FormatStyle::SBPO_ControlStatements);
92 IO.enumCase(Value, "Always", FormatStyle::SBPO_Always);
Alexander Kornienkofdca83d2013-12-10 10:18:34 +000093
94 // For backward compatibility.
Alexander Kornienko6d2c88e2013-12-10 10:30:34 +000095 IO.enumCase(Value, "false", FormatStyle::SBPO_Never);
96 IO.enumCase(Value, "true", FormatStyle::SBPO_ControlStatements);
Alexander Kornienkofdca83d2013-12-10 10:18:34 +000097 }
98};
99
Alexander Kornienko6d2c88e2013-12-10 10:30:34 +0000100template <> struct MappingTraits<FormatStyle> {
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000101 static void mapping(IO &IO, FormatStyle &Style) {
102 // When reading, read the language first, we need it for getPredefinedStyle.
103 IO.mapOptional("Language", Style.Language);
104
Alexander Kornienko49149672013-05-10 11:56:10 +0000105 if (IO.outputting()) {
Alexander Kornienkoe3648fb2013-09-02 16:39:23 +0000106 StringRef StylesArray[] = { "LLVM", "Google", "Chromium",
Alexander Kornienkofe7a57f2013-12-10 15:42:15 +0000107 "Mozilla", "WebKit", "GNU" };
Alexander Kornienko49149672013-05-10 11:56:10 +0000108 ArrayRef<StringRef> Styles(StylesArray);
109 for (size_t i = 0, e = Styles.size(); i < e; ++i) {
110 StringRef StyleName(Styles[i]);
Alexander Kornienko6d2c88e2013-12-10 10:30:34 +0000111 FormatStyle PredefinedStyle;
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000112 if (getPredefinedStyle(StyleName, Style.Language, &PredefinedStyle) &&
Alexander Kornienko006b5c82013-05-19 00:53:30 +0000113 Style == PredefinedStyle) {
Alexander Kornienko49149672013-05-10 11:56:10 +0000114 IO.mapOptional("# BasedOnStyle", StyleName);
115 break;
116 }
117 }
118 } else {
Alexander Kornienkod6538332013-05-07 15:32:14 +0000119 StringRef BasedOnStyle;
120 IO.mapOptional("BasedOnStyle", BasedOnStyle);
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000121 if (!BasedOnStyle.empty()) {
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000122 FormatStyle::LanguageKind OldLanguage = Style.Language;
123 FormatStyle::LanguageKind Language =
124 ((FormatStyle *)IO.getContext())->Language;
125 if (!getPredefinedStyle(BasedOnStyle, Language, &Style)) {
Alexander Kornienko006b5c82013-05-19 00:53:30 +0000126 IO.setError(Twine("Unknown value for BasedOnStyle: ", BasedOnStyle));
127 return;
128 }
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000129 Style.Language = OldLanguage;
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000130 }
Alexander Kornienkod6538332013-05-07 15:32:14 +0000131 }
132
133 IO.mapOptional("AccessModifierOffset", Style.AccessModifierOffset);
Daniel Jaspercdaffa42013-08-13 10:58:30 +0000134 IO.mapOptional("ConstructorInitializerIndentWidth",
135 Style.ConstructorInitializerIndentWidth);
Alexander Kornienkod6538332013-05-07 15:32:14 +0000136 IO.mapOptional("AlignEscapedNewlinesLeft", Style.AlignEscapedNewlinesLeft);
Daniel Jasper552f4a72013-07-31 23:55:15 +0000137 IO.mapOptional("AlignTrailingComments", Style.AlignTrailingComments);
Alexander Kornienkod6538332013-05-07 15:32:14 +0000138 IO.mapOptional("AllowAllParametersOfDeclarationOnNextLine",
139 Style.AllowAllParametersOfDeclarationOnNextLine);
140 IO.mapOptional("AllowShortIfStatementsOnASingleLine",
141 Style.AllowShortIfStatementsOnASingleLine);
Daniel Jasper3a685df2013-05-16 12:12:21 +0000142 IO.mapOptional("AllowShortLoopsOnASingleLine",
143 Style.AllowShortLoopsOnASingleLine);
Alexander Kornienko3cfa9732013-11-20 16:33:05 +0000144 IO.mapOptional("AllowShortFunctionsOnASingleLine",
145 Style.AllowShortFunctionsOnASingleLine);
Daniel Jasper61e6bbf2013-05-29 12:07:31 +0000146 IO.mapOptional("AlwaysBreakTemplateDeclarations",
147 Style.AlwaysBreakTemplateDeclarations);
Alexander Kornienko58611712013-07-04 12:02:44 +0000148 IO.mapOptional("AlwaysBreakBeforeMultilineStrings",
149 Style.AlwaysBreakBeforeMultilineStrings);
Daniel Jaspere33d4af2013-07-26 16:56:36 +0000150 IO.mapOptional("BreakBeforeBinaryOperators",
151 Style.BreakBeforeBinaryOperators);
Daniel Jasper165b29e2013-11-08 00:57:11 +0000152 IO.mapOptional("BreakBeforeTernaryOperators",
153 Style.BreakBeforeTernaryOperators);
Daniel Jaspere33d4af2013-07-26 16:56:36 +0000154 IO.mapOptional("BreakConstructorInitializersBeforeComma",
155 Style.BreakConstructorInitializersBeforeComma);
Alexander Kornienkod6538332013-05-07 15:32:14 +0000156 IO.mapOptional("BinPackParameters", Style.BinPackParameters);
157 IO.mapOptional("ColumnLimit", Style.ColumnLimit);
158 IO.mapOptional("ConstructorInitializerAllOnOneLineOrOnePerLine",
159 Style.ConstructorInitializerAllOnOneLineOrOnePerLine);
160 IO.mapOptional("DerivePointerBinding", Style.DerivePointerBinding);
Daniel Jasperb10cbc42013-07-10 14:02:49 +0000161 IO.mapOptional("ExperimentalAutoDetectBinPacking",
162 Style.ExperimentalAutoDetectBinPacking);
Alexander Kornienkod6538332013-05-07 15:32:14 +0000163 IO.mapOptional("IndentCaseLabels", Style.IndentCaseLabels);
164 IO.mapOptional("MaxEmptyLinesToKeep", Style.MaxEmptyLinesToKeep);
Daniel Jasper65ee3472013-07-31 23:16:02 +0000165 IO.mapOptional("NamespaceIndentation", Style.NamespaceIndentation);
Alexander Kornienkod6538332013-05-07 15:32:14 +0000166 IO.mapOptional("ObjCSpaceBeforeProtocolList",
167 Style.ObjCSpaceBeforeProtocolList);
Daniel Jasper33b909c2013-10-25 14:29:37 +0000168 IO.mapOptional("PenaltyBreakBeforeFirstCallParameter",
169 Style.PenaltyBreakBeforeFirstCallParameter);
Alexander Kornienkodd7ece52013-06-07 16:02:52 +0000170 IO.mapOptional("PenaltyBreakComment", Style.PenaltyBreakComment);
171 IO.mapOptional("PenaltyBreakString", Style.PenaltyBreakString);
Daniel Jasper4e9678f2013-07-11 20:41:21 +0000172 IO.mapOptional("PenaltyBreakFirstLessLess",
173 Style.PenaltyBreakFirstLessLess);
Alexander Kornienkod6538332013-05-07 15:32:14 +0000174 IO.mapOptional("PenaltyExcessCharacter", Style.PenaltyExcessCharacter);
175 IO.mapOptional("PenaltyReturnTypeOnItsOwnLine",
176 Style.PenaltyReturnTypeOnItsOwnLine);
177 IO.mapOptional("PointerBindsToType", Style.PointerBindsToType);
178 IO.mapOptional("SpacesBeforeTrailingComments",
179 Style.SpacesBeforeTrailingComments);
Daniel Jasper6ab54682013-07-16 18:22:10 +0000180 IO.mapOptional("Cpp11BracedListStyle", Style.Cpp11BracedListStyle);
Alexander Kornienkod6538332013-05-07 15:32:14 +0000181 IO.mapOptional("Standard", Style.Standard);
Manuel Klimek13b97d82013-05-13 08:42:42 +0000182 IO.mapOptional("IndentWidth", Style.IndentWidth);
Alexander Kornienkoebb43ca2013-09-05 14:08:34 +0000183 IO.mapOptional("TabWidth", Style.TabWidth);
Manuel Klimekb9eae4c2013-05-13 09:22:11 +0000184 IO.mapOptional("UseTab", Style.UseTab);
Manuel Klimeka8eb9142013-05-13 12:51:40 +0000185 IO.mapOptional("BreakBeforeBraces", Style.BreakBeforeBraces);
Manuel Klimek836c2862013-06-21 17:25:42 +0000186 IO.mapOptional("IndentFunctionDeclarationAfterType",
187 Style.IndentFunctionDeclarationAfterType);
Daniel Jasperb55acad2013-08-20 12:36:34 +0000188 IO.mapOptional("SpacesInParentheses", Style.SpacesInParentheses);
Daniel Jasperdd978ae2013-10-29 14:52:02 +0000189 IO.mapOptional("SpacesInAngles", Style.SpacesInAngles);
Daniel Jasperf110e202013-08-21 08:39:01 +0000190 IO.mapOptional("SpaceInEmptyParentheses", Style.SpaceInEmptyParentheses);
Daniel Jasperb55acad2013-08-20 12:36:34 +0000191 IO.mapOptional("SpacesInCStyleCastParentheses",
192 Style.SpacesInCStyleCastParentheses);
Daniel Jasperd94bff32013-09-25 15:15:02 +0000193 IO.mapOptional("SpaceBeforeAssignmentOperators",
194 Style.SpaceBeforeAssignmentOperators);
Daniel Jasper6633ab82013-10-18 10:38:14 +0000195 IO.mapOptional("ContinuationIndentWidth", Style.ContinuationIndentWidth);
Alexander Kornienkofdca83d2013-12-10 10:18:34 +0000196
197 // For backward compatibility.
198 if (!IO.outputting()) {
199 IO.mapOptional("SpaceAfterControlStatementKeyword",
200 Style.SpaceBeforeParens);
201 }
202 IO.mapOptional("SpaceBeforeParens", Style.SpaceBeforeParens);
Alexander Kornienkod6538332013-05-07 15:32:14 +0000203 }
204};
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000205
206// Allows to read vector<FormatStyle> while keeping default values.
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000207// IO.getContext() should contain a pointer to the FormatStyle structure, that
208// will be used to get default values for missing keys.
209// If the first element has no Language specified, it will be treated as the
210// default one for the following elements.
Alexander Kornienko6d2c88e2013-12-10 10:30:34 +0000211template <> struct DocumentListTraits<std::vector<FormatStyle> > {
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000212 static size_t size(IO &IO, std::vector<FormatStyle> &Seq) {
213 return Seq.size();
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000214 }
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000215 static FormatStyle &element(IO &IO, std::vector<FormatStyle> &Seq,
Alexander Kornienko6d2c88e2013-12-10 10:30:34 +0000216 size_t Index) {
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000217 if (Index >= Seq.size()) {
218 assert(Index == Seq.size());
Alexander Kornienko6d2c88e2013-12-10 10:30:34 +0000219 FormatStyle Template;
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000220 if (Seq.size() > 0 && Seq[0].Language == FormatStyle::LK_None) {
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000221 Template = Seq[0];
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000222 } else {
223 Template = *((const FormatStyle*)IO.getContext());
Alexander Kornienko6d2c88e2013-12-10 10:30:34 +0000224 Template.Language = FormatStyle::LK_None;
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000225 }
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000226 Seq.resize(Index + 1, Template);
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000227 }
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000228 return Seq[Index];
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000229 }
230};
Alexander Kornienkod6538332013-05-07 15:32:14 +0000231}
232}
233
Daniel Jasperf7935112012-12-03 18:12:45 +0000234namespace clang {
235namespace format {
236
Daniel Jasperf7935112012-12-03 18:12:45 +0000237FormatStyle getLLVMStyle() {
238 FormatStyle LLVMStyle;
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000239 LLVMStyle.Language = FormatStyle::LK_Cpp;
Daniel Jasperf7935112012-12-03 18:12:45 +0000240 LLVMStyle.AccessModifierOffset = -2;
Alexander Kornienkoc8602662013-05-06 14:11:27 +0000241 LLVMStyle.AlignEscapedNewlinesLeft = false;
Daniel Jasper552f4a72013-07-31 23:55:15 +0000242 LLVMStyle.AlignTrailingComments = true;
Daniel Jasperf7db4332013-01-29 16:03:49 +0000243 LLVMStyle.AllowAllParametersOfDeclarationOnNextLine = true;
Alexander Kornienko3cfa9732013-11-20 16:33:05 +0000244 LLVMStyle.AllowShortFunctionsOnASingleLine = true;
Daniel Jasper1b750ed2013-01-14 16:24:39 +0000245 LLVMStyle.AllowShortIfStatementsOnASingleLine = false;
Daniel Jasper3a685df2013-05-16 12:12:21 +0000246 LLVMStyle.AllowShortLoopsOnASingleLine = false;
Alexander Kornienko58611712013-07-04 12:02:44 +0000247 LLVMStyle.AlwaysBreakBeforeMultilineStrings = false;
Daniel Jaspere33d4af2013-07-26 16:56:36 +0000248 LLVMStyle.AlwaysBreakTemplateDeclarations = false;
Alexander Kornienkoc8602662013-05-06 14:11:27 +0000249 LLVMStyle.BinPackParameters = true;
Daniel Jaspere33d4af2013-07-26 16:56:36 +0000250 LLVMStyle.BreakBeforeBinaryOperators = false;
Daniel Jasper165b29e2013-11-08 00:57:11 +0000251 LLVMStyle.BreakBeforeTernaryOperators = true;
Daniel Jaspere33d4af2013-07-26 16:56:36 +0000252 LLVMStyle.BreakBeforeBraces = FormatStyle::BS_Attach;
253 LLVMStyle.BreakConstructorInitializersBeforeComma = false;
Alexander Kornienkoc8602662013-05-06 14:11:27 +0000254 LLVMStyle.ColumnLimit = 80;
255 LLVMStyle.ConstructorInitializerAllOnOneLineOrOnePerLine = false;
Daniel Jaspercdaffa42013-08-13 10:58:30 +0000256 LLVMStyle.ConstructorInitializerIndentWidth = 4;
Daniel Jaspere33d4af2013-07-26 16:56:36 +0000257 LLVMStyle.Cpp11BracedListStyle = false;
Alexander Kornienkoc8602662013-05-06 14:11:27 +0000258 LLVMStyle.DerivePointerBinding = false;
Daniel Jasperb10cbc42013-07-10 14:02:49 +0000259 LLVMStyle.ExperimentalAutoDetectBinPacking = false;
Alexander Kornienkoc8602662013-05-06 14:11:27 +0000260 LLVMStyle.IndentCaseLabels = false;
Daniel Jaspere33d4af2013-07-26 16:56:36 +0000261 LLVMStyle.IndentFunctionDeclarationAfterType = false;
262 LLVMStyle.IndentWidth = 2;
Alexander Kornienkoebb43ca2013-09-05 14:08:34 +0000263 LLVMStyle.TabWidth = 8;
Alexander Kornienkoc8602662013-05-06 14:11:27 +0000264 LLVMStyle.MaxEmptyLinesToKeep = 1;
Daniel Jasper65ee3472013-07-31 23:16:02 +0000265 LLVMStyle.NamespaceIndentation = FormatStyle::NI_None;
Nico Webera6087752013-01-10 20:12:55 +0000266 LLVMStyle.ObjCSpaceBeforeProtocolList = true;
Alexander Kornienkoc8602662013-05-06 14:11:27 +0000267 LLVMStyle.PointerBindsToType = false;
268 LLVMStyle.SpacesBeforeTrailingComments = 1;
269 LLVMStyle.Standard = FormatStyle::LS_Cpp03;
Alexander Kornienko3c3d09c2013-09-27 16:14:22 +0000270 LLVMStyle.UseTab = FormatStyle::UT_Never;
Daniel Jasperb55acad2013-08-20 12:36:34 +0000271 LLVMStyle.SpacesInParentheses = false;
272 LLVMStyle.SpaceInEmptyParentheses = false;
273 LLVMStyle.SpacesInCStyleCastParentheses = false;
Alexander Kornienkofdca83d2013-12-10 10:18:34 +0000274 LLVMStyle.SpaceBeforeParens = FormatStyle::SBPO_ControlStatements;
Daniel Jasperd94bff32013-09-25 15:15:02 +0000275 LLVMStyle.SpaceBeforeAssignmentOperators = true;
Daniel Jasper6633ab82013-10-18 10:38:14 +0000276 LLVMStyle.ContinuationIndentWidth = 4;
Daniel Jasperdd978ae2013-10-29 14:52:02 +0000277 LLVMStyle.SpacesInAngles = false;
Daniel Jasper4e9678f2013-07-11 20:41:21 +0000278
Alexander Kornienkofe7a57f2013-12-10 15:42:15 +0000279 LLVMStyle.PenaltyBreakComment = 60;
280 LLVMStyle.PenaltyBreakFirstLessLess = 120;
281 LLVMStyle.PenaltyBreakString = 1000;
282 LLVMStyle.PenaltyExcessCharacter = 1000000;
Daniel Jasper4e9678f2013-07-11 20:41:21 +0000283 LLVMStyle.PenaltyReturnTypeOnItsOwnLine = 60;
Daniel Jasper33b909c2013-10-25 14:29:37 +0000284 LLVMStyle.PenaltyBreakBeforeFirstCallParameter = 19;
Daniel Jasper4e9678f2013-07-11 20:41:21 +0000285
Daniel Jasperf7935112012-12-03 18:12:45 +0000286 return LLVMStyle;
287}
288
289FormatStyle getGoogleStyle() {
Alexander Kornienkofe7a57f2013-12-10 15:42:15 +0000290 FormatStyle GoogleStyle = getLLVMStyle();
Daniel Jasperf7935112012-12-03 18:12:45 +0000291 GoogleStyle.AccessModifierOffset = -1;
Alexander Kornienkoc8602662013-05-06 14:11:27 +0000292 GoogleStyle.AlignEscapedNewlinesLeft = true;
Daniel Jasper085a2ed2013-04-24 13:46:00 +0000293 GoogleStyle.AllowShortIfStatementsOnASingleLine = true;
Daniel Jasper5bd0b9e2013-05-23 18:05:18 +0000294 GoogleStyle.AllowShortLoopsOnASingleLine = true;
Alexander Kornienko58611712013-07-04 12:02:44 +0000295 GoogleStyle.AlwaysBreakBeforeMultilineStrings = true;
Daniel Jaspere33d4af2013-07-26 16:56:36 +0000296 GoogleStyle.AlwaysBreakTemplateDeclarations = true;
Alexander Kornienkoc8602662013-05-06 14:11:27 +0000297 GoogleStyle.ConstructorInitializerAllOnOneLineOrOnePerLine = true;
Daniel Jaspere33d4af2013-07-26 16:56:36 +0000298 GoogleStyle.Cpp11BracedListStyle = true;
Alexander Kornienkoc8602662013-05-06 14:11:27 +0000299 GoogleStyle.DerivePointerBinding = true;
300 GoogleStyle.IndentCaseLabels = true;
Daniel Jaspere33d4af2013-07-26 16:56:36 +0000301 GoogleStyle.IndentFunctionDeclarationAfterType = true;
Nico Webera6087752013-01-10 20:12:55 +0000302 GoogleStyle.ObjCSpaceBeforeProtocolList = false;
Alexander Kornienkoc8602662013-05-06 14:11:27 +0000303 GoogleStyle.PointerBindsToType = true;
304 GoogleStyle.SpacesBeforeTrailingComments = 2;
305 GoogleStyle.Standard = FormatStyle::LS_Auto;
Daniel Jasper4e9678f2013-07-11 20:41:21 +0000306
Daniel Jasper4e9678f2013-07-11 20:41:21 +0000307 GoogleStyle.PenaltyReturnTypeOnItsOwnLine = 200;
Daniel Jasper33b909c2013-10-25 14:29:37 +0000308 GoogleStyle.PenaltyBreakBeforeFirstCallParameter = 1;
Daniel Jasper4e9678f2013-07-11 20:41:21 +0000309
Daniel Jasperf7935112012-12-03 18:12:45 +0000310 return GoogleStyle;
311}
312
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000313FormatStyle getGoogleJSStyle() {
314 FormatStyle GoogleJSStyle = getGoogleStyle();
315 GoogleJSStyle.Language = FormatStyle::LK_JavaScript;
316 GoogleJSStyle.BreakBeforeTernaryOperators = false;
317 // FIXME: Currently unimplemented:
318 // var arr = [1, 2, 3]; // No space after [ or before ].
319 // var obj = {a: 1, b: 2, c: 3}; // No space after ':'.
320 return GoogleJSStyle;
321}
322
Daniel Jasper1b750ed2013-01-14 16:24:39 +0000323FormatStyle getChromiumStyle() {
324 FormatStyle ChromiumStyle = getGoogleStyle();
Daniel Jasperf7db4332013-01-29 16:03:49 +0000325 ChromiumStyle.AllowAllParametersOfDeclarationOnNextLine = false;
Daniel Jasper085a2ed2013-04-24 13:46:00 +0000326 ChromiumStyle.AllowShortIfStatementsOnASingleLine = false;
Daniel Jasper3a685df2013-05-16 12:12:21 +0000327 ChromiumStyle.AllowShortLoopsOnASingleLine = false;
Daniel Jasper2cf17bf2013-02-27 09:47:53 +0000328 ChromiumStyle.BinPackParameters = false;
Daniel Jasper7fce3ab2013-02-06 14:22:40 +0000329 ChromiumStyle.DerivePointerBinding = false;
Daniel Jaspere33d4af2013-07-26 16:56:36 +0000330 ChromiumStyle.Standard = FormatStyle::LS_Cpp03;
Daniel Jasper1b750ed2013-01-14 16:24:39 +0000331 return ChromiumStyle;
332}
333
Alexander Kornienkoc8602662013-05-06 14:11:27 +0000334FormatStyle getMozillaStyle() {
335 FormatStyle MozillaStyle = getLLVMStyle();
336 MozillaStyle.AllowAllParametersOfDeclarationOnNextLine = false;
337 MozillaStyle.ConstructorInitializerAllOnOneLineOrOnePerLine = true;
338 MozillaStyle.DerivePointerBinding = true;
339 MozillaStyle.IndentCaseLabels = true;
340 MozillaStyle.ObjCSpaceBeforeProtocolList = false;
341 MozillaStyle.PenaltyReturnTypeOnItsOwnLine = 200;
342 MozillaStyle.PointerBindsToType = true;
343 return MozillaStyle;
344}
345
Daniel Jasperffefb3d2013-07-24 13:10:59 +0000346FormatStyle getWebKitStyle() {
347 FormatStyle Style = getLLVMStyle();
Daniel Jasper65ee3472013-07-31 23:16:02 +0000348 Style.AccessModifierOffset = -4;
Daniel Jasper552f4a72013-07-31 23:55:15 +0000349 Style.AlignTrailingComments = false;
Daniel Jaspere33d4af2013-07-26 16:56:36 +0000350 Style.BreakBeforeBinaryOperators = true;
Daniel Jasper65ee3472013-07-31 23:16:02 +0000351 Style.BreakBeforeBraces = FormatStyle::BS_Stroustrup;
Daniel Jaspere33d4af2013-07-26 16:56:36 +0000352 Style.BreakConstructorInitializersBeforeComma = true;
Daniel Jasper65ee3472013-07-31 23:16:02 +0000353 Style.ColumnLimit = 0;
Daniel Jaspere33d4af2013-07-26 16:56:36 +0000354 Style.IndentWidth = 4;
Daniel Jasper65ee3472013-07-31 23:16:02 +0000355 Style.NamespaceIndentation = FormatStyle::NI_Inner;
Daniel Jasperffefb3d2013-07-24 13:10:59 +0000356 Style.PointerBindsToType = true;
357 return Style;
358}
359
Alexander Kornienkofe7a57f2013-12-10 15:42:15 +0000360FormatStyle getGNUStyle() {
361 FormatStyle Style = getLLVMStyle();
362 Style.BreakBeforeBinaryOperators = true;
Alexander Kornienko3a33f022013-12-12 09:49:52 +0000363 Style.BreakBeforeBraces = FormatStyle::BS_GNU;
Alexander Kornienkofe7a57f2013-12-10 15:42:15 +0000364 Style.BreakBeforeTernaryOperators = true;
365 Style.ColumnLimit = 79;
Alexander Kornienkofe7a57f2013-12-10 15:42:15 +0000366 Style.SpaceBeforeParens = FormatStyle::SBPO_Always;
367 return Style;
368}
369
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000370bool getPredefinedStyle(StringRef Name, FormatStyle::LanguageKind Language,
371 FormatStyle *Style) {
372 if (Name.equals_lower("llvm")) {
Alexander Kornienko006b5c82013-05-19 00:53:30 +0000373 *Style = getLLVMStyle();
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000374 } else if (Name.equals_lower("chromium")) {
Alexander Kornienko006b5c82013-05-19 00:53:30 +0000375 *Style = getChromiumStyle();
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000376 } else if (Name.equals_lower("mozilla")) {
Alexander Kornienko006b5c82013-05-19 00:53:30 +0000377 *Style = getMozillaStyle();
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000378 } else if (Name.equals_lower("google")) {
379 *Style = Language == FormatStyle::LK_JavaScript ? getGoogleJSStyle()
380 : getGoogleStyle();
381 } else if (Name.equals_lower("webkit")) {
Daniel Jasperffefb3d2013-07-24 13:10:59 +0000382 *Style = getWebKitStyle();
Alexander Kornienkofe7a57f2013-12-10 15:42:15 +0000383 } else if (Name.equals_lower("gnu")) {
384 *Style = getGNUStyle();
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000385 } else {
Alexander Kornienko006b5c82013-05-19 00:53:30 +0000386 return false;
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000387 }
Alexander Kornienkod6538332013-05-07 15:32:14 +0000388
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000389 Style->Language = Language;
Alexander Kornienko006b5c82013-05-19 00:53:30 +0000390 return true;
Alexander Kornienkod6538332013-05-07 15:32:14 +0000391}
392
393llvm::error_code parseConfiguration(StringRef Text, FormatStyle *Style) {
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000394 assert(Style);
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000395 FormatStyle::LanguageKind Language = Style->Language;
396 assert(Language != FormatStyle::LK_None);
Alexander Kornienko06e00332013-05-20 15:18:01 +0000397 if (Text.trim().empty())
398 return llvm::make_error_code(llvm::errc::invalid_argument);
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000399
400 std::vector<FormatStyle> Styles;
Alexander Kornienkod6538332013-05-07 15:32:14 +0000401 llvm::yaml::Input Input(Text);
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000402 // DocumentListTraits<vector<FormatStyle>> uses the context to get default
403 // values for the fields, keys for which are missing from the configuration.
404 // Mapping also uses the context to get the language to find the correct
405 // base style.
406 Input.setContext(Style);
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000407 Input >> Styles;
408 if (Input.error())
409 return Input.error();
410
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000411 for (unsigned i = 0; i < Styles.size(); ++i) {
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000412 // Ensures that only the first configuration can skip the Language option.
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000413 if (Styles[i].Language == FormatStyle::LK_None && i != 0)
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000414 return llvm::make_error_code(llvm::errc::invalid_argument);
415 // Ensure that each language is configured at most once.
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000416 for (unsigned j = 0; j < i; ++j) {
417 if (Styles[i].Language == Styles[j].Language) {
418 DEBUG(llvm::dbgs()
419 << "Duplicate languages in the config file on positions " << j
420 << " and " << i << "\n");
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000421 return llvm::make_error_code(llvm::errc::invalid_argument);
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000422 }
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000423 }
424 }
425 // Look for a suitable configuration starting from the end, so we can
426 // find the configuration for the specific language first, and the default
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000427 // configuration (which can only be at slot 0) after it.
428 for (int i = Styles.size() - 1; i >= 0; --i) {
429 if (Styles[i].Language == Language ||
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000430 Styles[i].Language == FormatStyle::LK_None) {
431 *Style = Styles[i];
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000432 Style->Language = Language;
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000433 return llvm::make_error_code(llvm::errc::success);
434 }
435 }
436 return llvm::make_error_code(llvm::errc::not_supported);
Alexander Kornienkod6538332013-05-07 15:32:14 +0000437}
438
439std::string configurationAsText(const FormatStyle &Style) {
440 std::string Text;
441 llvm::raw_string_ostream Stream(Text);
442 llvm::yaml::Output Output(Stream);
443 // We use the same mapping method for input and output, so we need a non-const
444 // reference here.
445 FormatStyle NonConstStyle = Style;
446 Output << NonConstStyle;
Alexander Kornienko9a38ec22013-05-13 12:56:35 +0000447 return Stream.str();
Alexander Kornienkod6538332013-05-07 15:32:14 +0000448}
449
Craig Topperaf35e852013-06-30 22:29:28 +0000450namespace {
451
Daniel Jasperde0328a2013-08-16 11:20:30 +0000452class NoColumnLimitFormatter {
453public:
Daniel Jasperf110e202013-08-21 08:39:01 +0000454 NoColumnLimitFormatter(ContinuationIndenter *Indenter) : Indenter(Indenter) {}
Daniel Jasperde0328a2013-08-16 11:20:30 +0000455
456 /// \brief Formats the line starting at \p State, simply keeping all of the
457 /// input's line breaking decisions.
Alexander Kornienko31e95542013-12-04 12:21:08 +0000458 void format(unsigned FirstIndent, const AnnotatedLine *Line,
459 bool LineIsMerged) {
Daniel Jasper1c5d9df2013-09-06 07:54:20 +0000460 LineState State =
461 Indenter->getInitialState(FirstIndent, Line, /*DryRun=*/false);
Daniel Jasperde0328a2013-08-16 11:20:30 +0000462 while (State.NextToken != NULL) {
463 bool Newline =
Alexander Kornienko31e95542013-12-04 12:21:08 +0000464 (!LineIsMerged && Indenter->mustBreak(State)) ||
Daniel Jasperde0328a2013-08-16 11:20:30 +0000465 (Indenter->canBreak(State) && State.NextToken->NewlinesBefore > 0);
466 Indenter->addTokenToState(State, Newline, /*DryRun=*/false);
467 }
468 }
Daniel Jasperf110e202013-08-21 08:39:01 +0000469
Daniel Jasperde0328a2013-08-16 11:20:30 +0000470private:
471 ContinuationIndenter *Indenter;
472};
473
Daniel Jasper56f8b432013-11-06 23:12:09 +0000474class LineJoiner {
475public:
476 LineJoiner(const FormatStyle &Style) : Style(Style) {}
477
478 /// \brief Calculates how many lines can be merged into 1 starting at \p I.
479 unsigned
480 tryFitMultipleLinesInOne(unsigned Indent,
Alexander Kornienko3cfa9732013-11-20 16:33:05 +0000481 SmallVectorImpl<AnnotatedLine *>::const_iterator I,
Daniel Jasper56f8b432013-11-06 23:12:09 +0000482 SmallVectorImpl<AnnotatedLine *>::const_iterator E) {
483 // We can never merge stuff if there are trailing line comments.
484 AnnotatedLine *TheLine = *I;
485 if (TheLine->Last->Type == TT_LineComment)
486 return 0;
487
Alexander Kornienkoecc232d2013-12-04 13:25:26 +0000488 if (Style.ColumnLimit > 0 && Indent > Style.ColumnLimit)
489 return 0;
490
Daniel Jasper98fb6e12013-11-08 17:33:27 +0000491 unsigned Limit =
492 Style.ColumnLimit == 0 ? UINT_MAX : Style.ColumnLimit - Indent;
Daniel Jasper56f8b432013-11-06 23:12:09 +0000493 // If we already exceed the column limit, we set 'Limit' to 0. The different
494 // tryMerge..() functions can then decide whether to still do merging.
495 Limit = TheLine->Last->TotalLength > Limit
496 ? 0
497 : Limit - TheLine->Last->TotalLength;
498
Alexander Kornienkoc3021612013-11-19 14:30:44 +0000499 if (I + 1 == E || I[1]->Type == LT_Invalid)
Daniel Jasper56f8b432013-11-06 23:12:09 +0000500 return 0;
501
Alexander Kornienko3cfa9732013-11-20 16:33:05 +0000502 if (TheLine->Last->Type == TT_FunctionLBrace) {
503 return Style.AllowShortFunctionsOnASingleLine
504 ? tryMergeSimpleBlock(I, E, Limit)
505 : 0;
506 }
Daniel Jasper56f8b432013-11-06 23:12:09 +0000507 if (TheLine->Last->is(tok::l_brace)) {
Alexander Kornienko6d2c88e2013-12-10 10:30:34 +0000508 return Style.BreakBeforeBraces == FormatStyle::BS_Attach
Alexander Kornienko3cfa9732013-11-20 16:33:05 +0000509 ? tryMergeSimpleBlock(I, E, Limit)
510 : 0;
511 }
512 if (I[1]->First->Type == TT_FunctionLBrace &&
513 Style.BreakBeforeBraces != FormatStyle::BS_Attach) {
514 // Reduce the column limit by the number of spaces we need to insert
515 // around braces.
516 Limit = Limit > 3 ? Limit - 3 : 0;
517 unsigned MergedLines = 0;
518 if (Style.AllowShortFunctionsOnASingleLine) {
519 MergedLines = tryMergeSimpleBlock(I + 1, E, Limit);
520 // If we managed to merge the block, count the function header, which is
521 // on a separate line.
522 if (MergedLines > 0)
523 ++MergedLines;
524 }
525 return MergedLines;
526 }
527 if (TheLine->First->is(tok::kw_if)) {
528 return Style.AllowShortIfStatementsOnASingleLine
529 ? tryMergeSimpleControlStatement(I, E, Limit)
530 : 0;
531 }
532 if (TheLine->First->isOneOf(tok::kw_for, tok::kw_while)) {
533 return Style.AllowShortLoopsOnASingleLine
534 ? tryMergeSimpleControlStatement(I, E, Limit)
535 : 0;
536 }
537 if (TheLine->InPPDirective &&
538 (TheLine->First->HasUnescapedNewline || TheLine->First->IsFirst)) {
Daniel Jasper56f8b432013-11-06 23:12:09 +0000539 return tryMergeSimplePPDirective(I, E, Limit);
540 }
541 return 0;
542 }
543
544private:
545 unsigned
Alexander Kornienko3cfa9732013-11-20 16:33:05 +0000546 tryMergeSimplePPDirective(SmallVectorImpl<AnnotatedLine *>::const_iterator I,
Daniel Jasper56f8b432013-11-06 23:12:09 +0000547 SmallVectorImpl<AnnotatedLine *>::const_iterator E,
548 unsigned Limit) {
549 if (Limit == 0)
550 return 0;
Alexander Kornienkoc3021612013-11-19 14:30:44 +0000551 if (!I[1]->InPPDirective || I[1]->First->HasUnescapedNewline)
Daniel Jasper56f8b432013-11-06 23:12:09 +0000552 return 0;
Alexander Kornienkoc3021612013-11-19 14:30:44 +0000553 if (I + 2 != E && I[2]->InPPDirective && !I[2]->First->HasUnescapedNewline)
Daniel Jasper56f8b432013-11-06 23:12:09 +0000554 return 0;
Alexander Kornienkoc3021612013-11-19 14:30:44 +0000555 if (1 + I[1]->Last->TotalLength > Limit)
Daniel Jasper56f8b432013-11-06 23:12:09 +0000556 return 0;
557 return 1;
558 }
559
560 unsigned tryMergeSimpleControlStatement(
Alexander Kornienko3cfa9732013-11-20 16:33:05 +0000561 SmallVectorImpl<AnnotatedLine *>::const_iterator I,
Daniel Jasper56f8b432013-11-06 23:12:09 +0000562 SmallVectorImpl<AnnotatedLine *>::const_iterator E, unsigned Limit) {
563 if (Limit == 0)
564 return 0;
Alexander Kornienko3a33f022013-12-12 09:49:52 +0000565 if ((Style.BreakBeforeBraces == FormatStyle::BS_Allman ||
566 Style.BreakBeforeBraces == FormatStyle::BS_GNU) &&
Alexander Kornienkoc3021612013-11-19 14:30:44 +0000567 I[1]->First->is(tok::l_brace))
Daniel Jasper56f8b432013-11-06 23:12:09 +0000568 return 0;
Alexander Kornienkoc3021612013-11-19 14:30:44 +0000569 if (I[1]->InPPDirective != (*I)->InPPDirective ||
570 (I[1]->InPPDirective && I[1]->First->HasUnescapedNewline))
Daniel Jasper56f8b432013-11-06 23:12:09 +0000571 return 0;
572 AnnotatedLine &Line = **I;
573 if (Line.Last->isNot(tok::r_paren))
574 return 0;
Alexander Kornienkoc3021612013-11-19 14:30:44 +0000575 if (1 + I[1]->Last->TotalLength > Limit)
Daniel Jasper56f8b432013-11-06 23:12:09 +0000576 return 0;
Alexander Kornienkoc3021612013-11-19 14:30:44 +0000577 if (I[1]->First->isOneOf(tok::semi, tok::kw_if, tok::kw_for,
Alexander Kornienko3cfa9732013-11-20 16:33:05 +0000578 tok::kw_while) ||
Alexander Kornienkoc3021612013-11-19 14:30:44 +0000579 I[1]->First->Type == TT_LineComment)
Daniel Jasper56f8b432013-11-06 23:12:09 +0000580 return 0;
581 // Only inline simple if's (no nested if or else).
582 if (I + 2 != E && Line.First->is(tok::kw_if) &&
Alexander Kornienkoc3021612013-11-19 14:30:44 +0000583 I[2]->First->is(tok::kw_else))
Daniel Jasper56f8b432013-11-06 23:12:09 +0000584 return 0;
585 return 1;
586 }
587
588 unsigned
Alexander Kornienko3cfa9732013-11-20 16:33:05 +0000589 tryMergeSimpleBlock(SmallVectorImpl<AnnotatedLine *>::const_iterator I,
Daniel Jasper56f8b432013-11-06 23:12:09 +0000590 SmallVectorImpl<AnnotatedLine *>::const_iterator E,
591 unsigned Limit) {
Daniel Jasper56f8b432013-11-06 23:12:09 +0000592 // First, check that the current line allows merging. This is the case if
593 // we're not in a control flow statement and the last token is an opening
594 // brace.
595 AnnotatedLine &Line = **I;
596 if (Line.First->isOneOf(tok::kw_if, tok::kw_while, tok::kw_do, tok::r_brace,
597 tok::kw_else, tok::kw_try, tok::kw_catch,
598 tok::kw_for,
599 // This gets rid of all ObjC @ keywords and methods.
600 tok::at, tok::minus, tok::plus))
601 return 0;
602
Alexander Kornienkoc3021612013-11-19 14:30:44 +0000603 FormatToken *Tok = I[1]->First;
Daniel Jasper56f8b432013-11-06 23:12:09 +0000604 if (Tok->is(tok::r_brace) && !Tok->MustBreakBefore &&
605 (Tok->getNextNonComment() == NULL ||
606 Tok->getNextNonComment()->is(tok::semi))) {
607 // We merge empty blocks even if the line exceeds the column limit.
608 Tok->SpacesRequiredBefore = 0;
609 Tok->CanBreakBefore = true;
610 return 1;
611 } else if (Limit != 0 && Line.First->isNot(tok::kw_namespace)) {
612 // Check that we still have three lines and they fit into the limit.
Alexander Kornienkoc3021612013-11-19 14:30:44 +0000613 if (I + 2 == E || I[2]->Type == LT_Invalid)
Daniel Jasper56f8b432013-11-06 23:12:09 +0000614 return 0;
615
616 if (!nextTwoLinesFitInto(I, Limit))
617 return 0;
618
619 // Second, check that the next line does not contain any braces - if it
620 // does, readability declines when putting it into a single line.
Alexander Kornienkoc3021612013-11-19 14:30:44 +0000621 if (I[1]->Last->Type == TT_LineComment || Tok->MustBreakBefore)
Daniel Jasper56f8b432013-11-06 23:12:09 +0000622 return 0;
623 do {
624 if (Tok->isOneOf(tok::l_brace, tok::r_brace))
625 return 0;
626 Tok = Tok->Next;
627 } while (Tok != NULL);
628
629 // Last, check that the third line contains a single closing brace.
Alexander Kornienkoc3021612013-11-19 14:30:44 +0000630 Tok = I[2]->First;
Daniel Jasper56f8b432013-11-06 23:12:09 +0000631 if (Tok->getNextNonComment() != NULL || Tok->isNot(tok::r_brace) ||
632 Tok->MustBreakBefore)
633 return 0;
634
635 return 2;
636 }
637 return 0;
638 }
639
640 bool nextTwoLinesFitInto(SmallVectorImpl<AnnotatedLine *>::const_iterator I,
641 unsigned Limit) {
Alexander Kornienkoc3021612013-11-19 14:30:44 +0000642 return 1 + I[1]->Last->TotalLength + 1 + I[2]->Last->TotalLength <= Limit;
Daniel Jasper56f8b432013-11-06 23:12:09 +0000643 }
644
645 const FormatStyle &Style;
646};
647
Daniel Jasperf7935112012-12-03 18:12:45 +0000648class UnwrappedLineFormatter {
649public:
Daniel Jasper5500f612013-11-25 11:08:59 +0000650 UnwrappedLineFormatter(ContinuationIndenter *Indenter,
Daniel Jasper9fe0e8d2013-09-05 09:29:45 +0000651 WhitespaceManager *Whitespaces,
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +0000652 const FormatStyle &Style)
Daniel Jasper5500f612013-11-25 11:08:59 +0000653 : Indenter(Indenter), Whitespaces(Whitespaces), Style(Style),
654 Joiner(Style) {}
Daniel Jasperf7935112012-12-03 18:12:45 +0000655
Daniel Jasper56f8b432013-11-06 23:12:09 +0000656 unsigned format(const SmallVectorImpl<AnnotatedLine *> &Lines, bool DryRun,
Daniel Jasper9c199562013-11-28 15:58:55 +0000657 int AdditionalIndent = 0, bool FixBadIndentation = false) {
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +0000658 assert(!Lines.empty());
659 unsigned Penalty = 0;
660 std::vector<int> IndentForLevel;
661 for (unsigned i = 0, e = Lines[0]->Level; i != e; ++i)
662 IndentForLevel.push_back(Style.IndentWidth * i + AdditionalIndent);
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +0000663 const AnnotatedLine *PreviousLine = NULL;
Daniel Jasper56f8b432013-11-06 23:12:09 +0000664 for (SmallVectorImpl<AnnotatedLine *>::const_iterator I = Lines.begin(),
665 E = Lines.end();
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +0000666 I != E; ++I) {
667 const AnnotatedLine &TheLine = **I;
668 const FormatToken *FirstTok = TheLine.First;
669 int Offset = getIndentOffset(*FirstTok);
670
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +0000671 // Determine indent and try to merge multiple unwrapped lines.
672 while (IndentForLevel.size() <= TheLine.Level)
673 IndentForLevel.push_back(-1);
674 IndentForLevel.resize(TheLine.Level + 1);
675 unsigned Indent = getIndent(IndentForLevel, TheLine.Level);
676 if (static_cast<int>(Indent) + Offset >= 0)
677 Indent += Offset;
Daniel Jasper56f8b432013-11-06 23:12:09 +0000678 unsigned MergedLines = Joiner.tryFitMultipleLinesInOne(Indent, I, E);
Alexander Kornienko31e95542013-12-04 12:21:08 +0000679 if (MergedLines > 0 && Style.ColumnLimit == 0) {
680 // Disallow line merging if there is a break at the start of one of the
681 // input lines.
682 for (unsigned i = 0; i < MergedLines; ++i) {
683 if (I[i + 1]->First->NewlinesBefore > 0)
684 MergedLines = 0;
685 }
686 }
Daniel Jasper56f8b432013-11-06 23:12:09 +0000687 if (!DryRun) {
688 for (unsigned i = 0; i < MergedLines; ++i) {
Alexander Kornienkoc3021612013-11-19 14:30:44 +0000689 join(*I[i], *I[i + 1]);
Daniel Jasper56f8b432013-11-06 23:12:09 +0000690 }
691 }
692 I += MergedLines;
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +0000693
Daniel Jasper9c199562013-11-28 15:58:55 +0000694 unsigned LevelIndent = getIndent(IndentForLevel, TheLine.Level);
695 bool FixIndentation =
696 FixBadIndentation && (LevelIndent != FirstTok->OriginalColumn);
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +0000697 if (TheLine.First->is(tok::eof)) {
Daniel Jasper5500f612013-11-25 11:08:59 +0000698 if (PreviousLine && PreviousLine->Affected && !DryRun) {
699 // Remove the file's trailing whitespace.
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +0000700 unsigned Newlines = std::min(FirstTok->NewlinesBefore, 1u);
701 Whitespaces->replaceWhitespace(*TheLine.First, Newlines,
702 /*IndentLevel=*/0, /*Spaces=*/0,
703 /*TargetColumn=*/0);
704 }
Daniel Jasper9c199562013-11-28 15:58:55 +0000705 } else if (TheLine.Type != LT_Invalid &&
706 (TheLine.Affected || FixIndentation)) {
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +0000707 if (FirstTok->WhitespaceRange.isValid()) {
708 if (!DryRun)
709 formatFirstToken(*TheLine.First, PreviousLine, TheLine.Level,
710 Indent, TheLine.InPPDirective);
711 } else {
712 Indent = LevelIndent = FirstTok->OriginalColumn;
713 }
714
715 // If everything fits on a single line, just put it there.
716 unsigned ColumnLimit = Style.ColumnLimit;
717 if (I + 1 != E) {
Alexander Kornienkoc3021612013-11-19 14:30:44 +0000718 AnnotatedLine *NextLine = I[1];
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +0000719 if (NextLine->InPPDirective && !NextLine->First->HasUnescapedNewline)
720 ColumnLimit = getColumnLimit(TheLine.InPPDirective);
721 }
722
723 if (TheLine.Last->TotalLength + Indent <= ColumnLimit) {
724 LineState State = Indenter->getInitialState(Indent, &TheLine, DryRun);
725 while (State.NextToken != NULL)
726 Indenter->addTokenToState(State, /*Newline=*/false, DryRun);
727 } else if (Style.ColumnLimit == 0) {
Daniel Jasper9c199562013-11-28 15:58:55 +0000728 // FIXME: Implement nested blocks for ColumnLimit = 0.
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +0000729 NoColumnLimitFormatter Formatter(Indenter);
730 if (!DryRun)
Alexander Kornienko31e95542013-12-04 12:21:08 +0000731 Formatter.format(Indent, &TheLine,
732 /*LineIsMerged=*/MergedLines > 0);
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +0000733 } else {
734 Penalty += format(TheLine, Indent, DryRun);
735 }
736
737 IndentForLevel[TheLine.Level] = LevelIndent;
Daniel Jasper9c199562013-11-28 15:58:55 +0000738 } else if (TheLine.ChildrenAffected) {
739 format(TheLine.Children, DryRun);
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +0000740 } else {
741 // Format the first token if necessary, and notify the WhitespaceManager
742 // about the unchanged whitespace.
743 for (FormatToken *Tok = TheLine.First; Tok != NULL; Tok = Tok->Next) {
744 if (Tok == TheLine.First &&
745 (Tok->NewlinesBefore > 0 || Tok->IsFirst)) {
746 unsigned LevelIndent = Tok->OriginalColumn;
747 if (!DryRun) {
Daniel Jasper9c199562013-11-28 15:58:55 +0000748 // Remove trailing whitespace of the previous line.
Daniel Jasper5500f612013-11-25 11:08:59 +0000749 if ((PreviousLine && PreviousLine->Affected) ||
750 TheLine.LeadingEmptyLinesAffected) {
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +0000751 formatFirstToken(*Tok, PreviousLine, TheLine.Level, LevelIndent,
752 TheLine.InPPDirective);
753 } else {
754 Whitespaces->addUntouchableToken(*Tok, TheLine.InPPDirective);
755 }
756 }
757
758 if (static_cast<int>(LevelIndent) - Offset >= 0)
759 LevelIndent -= Offset;
760 if (Tok->isNot(tok::comment))
761 IndentForLevel[TheLine.Level] = LevelIndent;
762 } else if (!DryRun) {
763 Whitespaces->addUntouchableToken(*Tok, TheLine.InPPDirective);
764 }
765 }
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +0000766 }
767 if (!DryRun) {
768 for (FormatToken *Tok = TheLine.First; Tok != NULL; Tok = Tok->Next) {
769 Tok->Finalized = true;
770 }
771 }
772 PreviousLine = *I;
773 }
774 return Penalty;
775 }
776
777private:
778 /// \brief Formats an \c AnnotatedLine and returns the penalty.
Daniel Jasper9fe0e8d2013-09-05 09:29:45 +0000779 ///
780 /// If \p DryRun is \c false, directly applies the changes.
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +0000781 unsigned format(const AnnotatedLine &Line, unsigned FirstIndent,
782 bool DryRun) {
Daniel Jasper1c5d9df2013-09-06 07:54:20 +0000783 LineState State = Indenter->getInitialState(FirstIndent, &Line, DryRun);
Daniel Jasper4b866272013-02-01 11:00:45 +0000784
Daniel Jasperacc33662013-02-08 08:22:00 +0000785 // If the ObjC method declaration does not fit on a line, we should format
786 // it with one arg per line.
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +0000787 if (State.Line->Type == LT_ObjCMethodDecl)
Daniel Jasperacc33662013-02-08 08:22:00 +0000788 State.Stack.back().BreakBeforeParameter = true;
789
Daniel Jasper4b866272013-02-01 11:00:45 +0000790 // Find best solution in solution space.
Daniel Jasper9fe0e8d2013-09-05 09:29:45 +0000791 return analyzeSolutionSpace(State, DryRun);
Daniel Jasperf7935112012-12-03 18:12:45 +0000792 }
793
Manuel Klimek2ef908e2013-02-13 10:46:36 +0000794 /// \brief An edge in the solution space from \c Previous->State to \c State,
795 /// inserting a newline dependent on the \c NewLine.
796 struct StateNode {
797 StateNode(const LineState &State, bool NewLine, StateNode *Previous)
Daniel Jasper12ef4e52013-02-21 21:33:55 +0000798 : State(State), NewLine(NewLine), Previous(Previous) {}
Manuel Klimek2ef908e2013-02-13 10:46:36 +0000799 LineState State;
800 bool NewLine;
801 StateNode *Previous;
802 };
Daniel Jasper4b866272013-02-01 11:00:45 +0000803
Manuel Klimek2ef908e2013-02-13 10:46:36 +0000804 /// \brief A pair of <penalty, count> that is used to prioritize the BFS on.
805 ///
806 /// In case of equal penalties, we want to prefer states that were inserted
807 /// first. During state generation we make sure that we insert states first
808 /// that break the line as late as possible.
809 typedef std::pair<unsigned, unsigned> OrderedPenalty;
810
811 /// \brief An item in the prioritized BFS search queue. The \c StateNode's
812 /// \c State has the given \c OrderedPenalty.
813 typedef std::pair<OrderedPenalty, StateNode *> QueueItem;
814
815 /// \brief The BFS queue type.
816 typedef std::priority_queue<QueueItem, std::vector<QueueItem>,
817 std::greater<QueueItem> > QueueType;
Daniel Jasper4b866272013-02-01 11:00:45 +0000818
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +0000819 /// \brief Get the offset of the line relatively to the level.
820 ///
821 /// For example, 'public:' labels in classes are offset by 1 or 2
822 /// characters to the left from their level.
823 int getIndentOffset(const FormatToken &RootToken) {
824 if (RootToken.isAccessSpecifier(false) || RootToken.isObjCAccessSpecifier())
825 return Style.AccessModifierOffset;
826 return 0;
827 }
828
829 /// \brief Add a new line and the required indent before the first Token
830 /// of the \c UnwrappedLine if there was no structural parsing error.
831 void formatFirstToken(FormatToken &RootToken,
832 const AnnotatedLine *PreviousLine, unsigned IndentLevel,
833 unsigned Indent, bool InPPDirective) {
834 unsigned Newlines =
835 std::min(RootToken.NewlinesBefore, Style.MaxEmptyLinesToKeep + 1);
836 // Remove empty lines before "}" where applicable.
837 if (RootToken.is(tok::r_brace) &&
838 (!RootToken.Next ||
839 (RootToken.Next->is(tok::semi) && !RootToken.Next->Next)))
840 Newlines = std::min(Newlines, 1u);
841 if (Newlines == 0 && !RootToken.IsFirst)
842 Newlines = 1;
843
844 // Insert extra new line before access specifiers.
845 if (PreviousLine && PreviousLine->Last->isOneOf(tok::semi, tok::r_brace) &&
846 RootToken.isAccessSpecifier() && RootToken.NewlinesBefore == 1)
847 ++Newlines;
848
849 // Remove empty lines after access specifiers.
850 if (PreviousLine && PreviousLine->First->isAccessSpecifier())
851 Newlines = std::min(1u, Newlines);
852
Alexander Kornienko3cfa9732013-11-20 16:33:05 +0000853 Whitespaces->replaceWhitespace(RootToken, Newlines, IndentLevel, Indent,
854 Indent, InPPDirective &&
855 !RootToken.HasUnescapedNewline);
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +0000856 }
857
858 /// \brief Get the indent of \p Level from \p IndentForLevel.
859 ///
860 /// \p IndentForLevel must contain the indent for the level \c l
861 /// at \p IndentForLevel[l], or a value < 0 if the indent for
862 /// that level is unknown.
863 unsigned getIndent(const std::vector<int> IndentForLevel, unsigned Level) {
864 if (IndentForLevel[Level] != -1)
865 return IndentForLevel[Level];
866 if (Level == 0)
867 return 0;
868 return getIndent(IndentForLevel, Level - 1) + Style.IndentWidth;
869 }
870
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +0000871 void join(AnnotatedLine &A, const AnnotatedLine &B) {
872 assert(!A.Last->Next);
873 assert(!B.First->Previous);
Daniel Jasper5500f612013-11-25 11:08:59 +0000874 if (B.Affected)
875 A.Affected = true;
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +0000876 A.Last->Next = B.First;
877 B.First->Previous = A.Last;
Daniel Jasper98fb6e12013-11-08 17:33:27 +0000878 B.First->CanBreakBefore = true;
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +0000879 unsigned LengthA = A.Last->TotalLength + B.First->SpacesRequiredBefore;
880 for (FormatToken *Tok = B.First; Tok; Tok = Tok->Next) {
881 Tok->TotalLength += LengthA;
882 A.Last = Tok;
883 }
884 }
885
886 unsigned getColumnLimit(bool InPPDirective) const {
887 // In preprocessor directives reserve two chars for trailing " \"
888 return Style.ColumnLimit - (InPPDirective ? 2 : 0);
889 }
890
Daniel Jasper4b866272013-02-01 11:00:45 +0000891 /// \brief Analyze the entire solution space starting from \p InitialState.
Daniel Jasperf7935112012-12-03 18:12:45 +0000892 ///
Daniel Jasper4b866272013-02-01 11:00:45 +0000893 /// This implements a variant of Dijkstra's algorithm on the graph that spans
894 /// the solution space (\c LineStates are the nodes). The algorithm tries to
895 /// find the shortest path (the one with lowest penalty) from \p InitialState
Daniel Jasper9fe0e8d2013-09-05 09:29:45 +0000896 /// to a state where all tokens are placed. Returns the penalty.
897 ///
898 /// If \p DryRun is \c false, directly applies the changes.
899 unsigned analyzeSolutionSpace(LineState &InitialState, bool DryRun = false) {
Manuel Klimek2ef908e2013-02-13 10:46:36 +0000900 std::set<LineState> Seen;
901
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +0000902 // Increasing count of \c StateNode items we have created. This is used to
903 // create a deterministic order independent of the container.
904 unsigned Count = 0;
905 QueueType Queue;
906
Daniel Jasper4b866272013-02-01 11:00:45 +0000907 // Insert start element into queue.
Daniel Jasper687af3b2013-02-14 14:26:07 +0000908 StateNode *Node =
Manuel Klimek2ef908e2013-02-13 10:46:36 +0000909 new (Allocator.Allocate()) StateNode(InitialState, false, NULL);
910 Queue.push(QueueItem(OrderedPenalty(0, Count), Node));
911 ++Count;
Daniel Jasper4b866272013-02-01 11:00:45 +0000912
Daniel Jasper9fe0e8d2013-09-05 09:29:45 +0000913 unsigned Penalty = 0;
914
Daniel Jasper4b866272013-02-01 11:00:45 +0000915 // While not empty, take first element and follow edges.
916 while (!Queue.empty()) {
Daniel Jasper9fe0e8d2013-09-05 09:29:45 +0000917 Penalty = Queue.top().first.first;
Daniel Jasper687af3b2013-02-14 14:26:07 +0000918 StateNode *Node = Queue.top().second;
Manuel Klimek2ef908e2013-02-13 10:46:36 +0000919 if (Node->State.NextToken == NULL) {
Alexander Kornienko49149672013-05-10 11:56:10 +0000920 DEBUG(llvm::dbgs() << "\n---\nPenalty for line: " << Penalty << "\n");
Daniel Jasper4b866272013-02-01 11:00:45 +0000921 break;
Daniel Jasper3a9370c2013-02-04 07:21:18 +0000922 }
Manuel Klimek2ef908e2013-02-13 10:46:36 +0000923 Queue.pop();
Daniel Jasper4b866272013-02-01 11:00:45 +0000924
Daniel Jasperf8114cf2013-05-22 05:27:42 +0000925 // Cut off the analysis of certain solutions if the analysis gets too
926 // complex. See description of IgnoreStackForComparison.
927 if (Count > 10000)
928 Node->State.IgnoreStackForComparison = true;
929
Manuel Klimek2ef908e2013-02-13 10:46:36 +0000930 if (!Seen.insert(Node->State).second)
931 // State already examined with lower penalty.
932 continue;
Daniel Jasper4b866272013-02-01 11:00:45 +0000933
Manuel Klimek71814b42013-10-11 21:25:45 +0000934 FormatDecision LastFormat = Node->State.NextToken->Decision;
935 if (LastFormat == FD_Unformatted || LastFormat == FD_Continue)
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +0000936 addNextStateToQueue(Penalty, Node, /*NewLine=*/false, &Count, &Queue);
Manuel Klimek71814b42013-10-11 21:25:45 +0000937 if (LastFormat == FD_Unformatted || LastFormat == FD_Break)
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +0000938 addNextStateToQueue(Penalty, Node, /*NewLine=*/true, &Count, &Queue);
Daniel Jasper4b866272013-02-01 11:00:45 +0000939 }
940
Manuel Klimek71814b42013-10-11 21:25:45 +0000941 if (Queue.empty()) {
Daniel Jasper4b866272013-02-01 11:00:45 +0000942 // We were unable to find a solution, do nothing.
943 // FIXME: Add diagnostic?
Manuel Klimek71814b42013-10-11 21:25:45 +0000944 DEBUG(llvm::dbgs() << "Could not find a solution.\n");
Daniel Jasper9fe0e8d2013-09-05 09:29:45 +0000945 return 0;
Manuel Klimek71814b42013-10-11 21:25:45 +0000946 }
Daniel Jasperf7935112012-12-03 18:12:45 +0000947
Daniel Jasper4b866272013-02-01 11:00:45 +0000948 // Reconstruct the solution.
Daniel Jasper9fe0e8d2013-09-05 09:29:45 +0000949 if (!DryRun)
950 reconstructPath(InitialState, Queue.top().second);
951
Alexander Kornienko49149672013-05-10 11:56:10 +0000952 DEBUG(llvm::dbgs() << "Total number of analyzed states: " << Count << "\n");
953 DEBUG(llvm::dbgs() << "---\n");
Daniel Jasper9fe0e8d2013-09-05 09:29:45 +0000954
955 return Penalty;
Manuel Klimek2ef908e2013-02-13 10:46:36 +0000956 }
957
958 void reconstructPath(LineState &State, StateNode *Current) {
Manuel Klimek4c5c28b2013-05-29 15:10:11 +0000959 std::deque<StateNode *> Path;
960 // We do not need a break before the initial token.
961 while (Current->Previous) {
962 Path.push_front(Current);
963 Current = Current->Previous;
964 }
965 for (std::deque<StateNode *>::iterator I = Path.begin(), E = Path.end();
966 I != E; ++I) {
Daniel Jasper9fe0e8d2013-09-05 09:29:45 +0000967 unsigned Penalty = 0;
968 formatChildren(State, (*I)->NewLine, /*DryRun=*/false, Penalty);
969 Penalty += Indenter->addTokenToState(State, (*I)->NewLine, false);
970
Manuel Klimek4c5c28b2013-05-29 15:10:11 +0000971 DEBUG({
972 if ((*I)->NewLine) {
Daniel Jasper8de9ed02013-08-22 15:00:41 +0000973 llvm::dbgs() << "Penalty for placing "
Manuel Klimek4c5c28b2013-05-29 15:10:11 +0000974 << (*I)->Previous->State.NextToken->Tok.getName() << ": "
Daniel Jasper8de9ed02013-08-22 15:00:41 +0000975 << Penalty << "\n";
Manuel Klimek4c5c28b2013-05-29 15:10:11 +0000976 }
977 });
Manuel Klimek4c5c28b2013-05-29 15:10:11 +0000978 }
Daniel Jasper4b866272013-02-01 11:00:45 +0000979 }
980
Manuel Klimekaf491072013-02-13 10:54:19 +0000981 /// \brief Add the following state to the analysis queue \c Queue.
Daniel Jasper4b866272013-02-01 11:00:45 +0000982 ///
Manuel Klimekaf491072013-02-13 10:54:19 +0000983 /// Assume the current state is \p PreviousNode and has been reached with a
Daniel Jasper4b866272013-02-01 11:00:45 +0000984 /// penalty of \p Penalty. Insert a line break if \p NewLine is \c true.
Manuel Klimekaf491072013-02-13 10:54:19 +0000985 void addNextStateToQueue(unsigned Penalty, StateNode *PreviousNode,
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +0000986 bool NewLine, unsigned *Count, QueueType *Queue) {
Daniel Jasperde0328a2013-08-16 11:20:30 +0000987 if (NewLine && !Indenter->canBreak(PreviousNode->State))
Daniel Jasper4b866272013-02-01 11:00:45 +0000988 return;
Daniel Jasperde0328a2013-08-16 11:20:30 +0000989 if (!NewLine && Indenter->mustBreak(PreviousNode->State))
Daniel Jasper4b866272013-02-01 11:00:45 +0000990 return;
Manuel Klimek2ef908e2013-02-13 10:46:36 +0000991
992 StateNode *Node = new (Allocator.Allocate())
993 StateNode(PreviousNode->State, NewLine, PreviousNode);
Daniel Jasper9fe0e8d2013-09-05 09:29:45 +0000994 if (!formatChildren(Node->State, NewLine, /*DryRun=*/true, Penalty))
995 return;
996
Daniel Jasperde0328a2013-08-16 11:20:30 +0000997 Penalty += Indenter->addTokenToState(Node->State, NewLine, true);
Manuel Klimek2ef908e2013-02-13 10:46:36 +0000998
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +0000999 Queue->push(QueueItem(OrderedPenalty(Penalty, *Count), Node));
1000 ++(*Count);
Daniel Jasper4b866272013-02-01 11:00:45 +00001001 }
Daniel Jasperf7935112012-12-03 18:12:45 +00001002
Daniel Jasperf3a5d002013-09-05 10:48:50 +00001003 /// \brief If the \p State's next token is an r_brace closing a nested block,
1004 /// format the nested block before it.
Daniel Jasper9fe0e8d2013-09-05 09:29:45 +00001005 ///
1006 /// Returns \c true if all children could be placed successfully and adapts
1007 /// \p Penalty as well as \p State. If \p DryRun is false, also directly
1008 /// creates changes using \c Whitespaces.
1009 ///
1010 /// The crucial idea here is that children always get formatted upon
1011 /// encountering the closing brace right after the nested block. Now, if we
1012 /// are currently trying to keep the "}" on the same line (i.e. \p NewLine is
1013 /// \c false), the entire block has to be kept on the same line (which is only
1014 /// possible if it fits on the line, only contains a single statement, etc.
1015 ///
1016 /// If \p NewLine is true, we format the nested block on separate lines, i.e.
1017 /// break after the "{", format all lines with correct indentation and the put
1018 /// the closing "}" on yet another new line.
1019 ///
1020 /// This enables us to keep the simple structure of the
1021 /// \c UnwrappedLineFormatter, where we only have two options for each token:
1022 /// break or don't break.
1023 bool formatChildren(LineState &State, bool NewLine, bool DryRun,
1024 unsigned &Penalty) {
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +00001025 FormatToken &Previous = *State.NextToken->Previous;
Daniel Jasperdcd5da12013-10-20 17:28:32 +00001026 const FormatToken *LBrace = State.NextToken->getPreviousNonComment();
1027 if (!LBrace || LBrace->isNot(tok::l_brace) ||
1028 LBrace->BlockKind != BK_Block || Previous.Children.size() == 0)
Daniel Jasperf3a5d002013-09-05 10:48:50 +00001029 // The previous token does not open a block. Nothing to do. We don't
1030 // assert so that we can simply call this function for all tokens.
Daniel Jasper36c28ce2013-09-06 08:54:24 +00001031 return true;
Daniel Jasper9fe0e8d2013-09-05 09:29:45 +00001032
1033 if (NewLine) {
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +00001034 int AdditionalIndent = State.Stack.back().Indent -
1035 Previous.Children[0]->Level * Style.IndentWidth;
Daniel Jasper9c199562013-11-28 15:58:55 +00001036 Penalty += format(Previous.Children, DryRun, AdditionalIndent,
1037 /*FixBadIndentation=*/true);
Daniel Jasper9fe0e8d2013-09-05 09:29:45 +00001038 return true;
1039 }
1040
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +00001041 // Cannot merge multiple statements into a single line.
Daniel Jasperdcd5da12013-10-20 17:28:32 +00001042 if (Previous.Children.size() > 1)
Alexander Kornienko3cfa9732013-11-20 16:33:05 +00001043 return false;
Daniel Jasper9fe0e8d2013-09-05 09:29:45 +00001044
1045 // We can't put the closing "}" on a line with a trailing comment.
Daniel Jasperdcd5da12013-10-20 17:28:32 +00001046 if (Previous.Children[0]->Last->isTrailingComment())
Daniel Jasper9fe0e8d2013-09-05 09:29:45 +00001047 return false;
1048
1049 if (!DryRun) {
Alexander Kornienko3c3d09c2013-09-27 16:14:22 +00001050 Whitespaces->replaceWhitespace(
Daniel Jasperdcd5da12013-10-20 17:28:32 +00001051 *Previous.Children[0]->First,
Alexander Kornienkoe2e03872013-10-14 00:46:35 +00001052 /*Newlines=*/0, /*IndentLevel=*/0, /*Spaces=*/1,
Alexander Kornienko3c3d09c2013-09-27 16:14:22 +00001053 /*StartOfTokenColumn=*/State.Column, State.Line->InPPDirective);
Daniel Jasper9fe0e8d2013-09-05 09:29:45 +00001054 }
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +00001055 Penalty += format(*Previous.Children[0], State.Column + 1, DryRun);
Daniel Jasper9fe0e8d2013-09-05 09:29:45 +00001056
Daniel Jasperdcd5da12013-10-20 17:28:32 +00001057 State.Column += 1 + Previous.Children[0]->Last->TotalLength;
Daniel Jasper9fe0e8d2013-09-05 09:29:45 +00001058 return true;
1059 }
1060
Daniel Jasperde0328a2013-08-16 11:20:30 +00001061 ContinuationIndenter *Indenter;
Daniel Jasper9fe0e8d2013-09-05 09:29:45 +00001062 WhitespaceManager *Whitespaces;
Daniel Jasperf7935112012-12-03 18:12:45 +00001063 FormatStyle Style;
Daniel Jasper56f8b432013-11-06 23:12:09 +00001064 LineJoiner Joiner;
Manuel Klimekaf491072013-02-13 10:54:19 +00001065
1066 llvm::SpecificBumpPtrAllocator<StateNode> Allocator;
Daniel Jasperf7935112012-12-03 18:12:45 +00001067};
1068
Manuel Klimek15dfe7a2013-05-28 11:55:06 +00001069class FormatTokenLexer {
Alexander Kornienkoe3276842012-12-07 16:15:44 +00001070public:
Manuel Klimek31c85922013-08-29 15:21:40 +00001071 FormatTokenLexer(Lexer &Lex, SourceManager &SourceMgr, FormatStyle &Style,
Alexander Kornienkoffcc0102013-06-05 14:09:10 +00001072 encoding::Encoding Encoding)
Alexander Kornienko393e3082013-11-13 14:04:17 +00001073 : FormatTok(NULL), IsFirstToken(true), GreaterStashed(false), Column(0),
Manuel Klimek31c85922013-08-29 15:21:40 +00001074 TrailingWhitespace(0), Lex(Lex), SourceMgr(SourceMgr), Style(Style),
1075 IdentTable(getFormattingLangOpts()), Encoding(Encoding) {
Alexander Kornienkoe3276842012-12-07 16:15:44 +00001076 Lex.SetKeepWhitespaceMode(true);
1077 }
1078
Manuel Klimek15dfe7a2013-05-28 11:55:06 +00001079 ArrayRef<FormatToken *> lex() {
1080 assert(Tokens.empty());
1081 do {
1082 Tokens.push_back(getNextToken());
Alexander Kornienko9aa62402013-11-21 12:43:57 +00001083 tryMergePreviousTokens();
Manuel Klimek15dfe7a2013-05-28 11:55:06 +00001084 } while (Tokens.back()->Tok.isNot(tok::eof));
1085 return Tokens;
1086 }
1087
1088 IdentifierTable &getIdentTable() { return IdentTable; }
1089
1090private:
Alexander Kornienko9aa62402013-11-21 12:43:57 +00001091 void tryMergePreviousTokens() {
Alexander Kornienkocabdd732013-11-29 15:19:43 +00001092 if (tryMerge_TMacro())
1093 return;
1094
1095 if (Style.Language == FormatStyle::LK_JavaScript) {
1096 static tok::TokenKind JSIdentity[] = { tok::equalequal, tok::equal };
1097 static tok::TokenKind JSNotIdentity[] = { tok::exclaimequal, tok::equal };
1098 static tok::TokenKind JSShiftEqual[] = { tok::greater, tok::greater,
1099 tok::greaterequal };
1100 // FIXME: We probably need to change token type to mimic operator with the
1101 // correct priority.
1102 if (tryMergeTokens(JSIdentity))
1103 return;
1104 if (tryMergeTokens(JSNotIdentity))
1105 return;
1106 if (tryMergeTokens(JSShiftEqual))
1107 return;
1108 }
Alexander Kornienko9aa62402013-11-21 12:43:57 +00001109 }
1110
Alexander Kornienkocabdd732013-11-29 15:19:43 +00001111 bool tryMergeTokens(ArrayRef<tok::TokenKind> Kinds) {
1112 if (Tokens.size() < Kinds.size())
Alexander Kornienko9aa62402013-11-21 12:43:57 +00001113 return false;
Alexander Kornienkocabdd732013-11-29 15:19:43 +00001114
1115 SmallVectorImpl<FormatToken *>::const_iterator First =
1116 Tokens.end() - Kinds.size();
1117 if (!First[0]->is(Kinds[0]))
Alexander Kornienko9aa62402013-11-21 12:43:57 +00001118 return false;
Alexander Kornienkocabdd732013-11-29 15:19:43 +00001119 unsigned AddLength = 0;
1120 for (unsigned i = 1; i < Kinds.size(); ++i) {
1121 if (!First[i]->is(Kinds[i]) || First[i]->WhitespaceRange.getBegin() !=
1122 First[i]->WhitespaceRange.getEnd())
1123 return false;
1124 AddLength += First[i]->TokenText.size();
1125 }
1126 Tokens.resize(Tokens.size() - Kinds.size() + 1);
1127 First[0]->TokenText = StringRef(First[0]->TokenText.data(),
1128 First[0]->TokenText.size() + AddLength);
1129 First[0]->ColumnWidth += AddLength;
Alexander Kornienko9aa62402013-11-21 12:43:57 +00001130 return true;
1131 }
1132
1133 bool tryMerge_TMacro() {
Alexander Kornienko81e32942013-09-16 20:20:49 +00001134 if (Tokens.size() < 4)
Alexander Kornienko9aa62402013-11-21 12:43:57 +00001135 return false;
Alexander Kornienko81e32942013-09-16 20:20:49 +00001136 FormatToken *Last = Tokens.back();
1137 if (!Last->is(tok::r_paren))
Alexander Kornienko9aa62402013-11-21 12:43:57 +00001138 return false;
Alexander Kornienko81e32942013-09-16 20:20:49 +00001139
1140 FormatToken *String = Tokens[Tokens.size() - 2];
1141 if (!String->is(tok::string_literal) || String->IsMultiline)
Alexander Kornienko9aa62402013-11-21 12:43:57 +00001142 return false;
Alexander Kornienko81e32942013-09-16 20:20:49 +00001143
1144 if (!Tokens[Tokens.size() - 3]->is(tok::l_paren))
Alexander Kornienko9aa62402013-11-21 12:43:57 +00001145 return false;
Alexander Kornienko81e32942013-09-16 20:20:49 +00001146
1147 FormatToken *Macro = Tokens[Tokens.size() - 4];
1148 if (Macro->TokenText != "_T")
Alexander Kornienko9aa62402013-11-21 12:43:57 +00001149 return false;
Alexander Kornienko81e32942013-09-16 20:20:49 +00001150
1151 const char *Start = Macro->TokenText.data();
1152 const char *End = Last->TokenText.data() + Last->TokenText.size();
1153 String->TokenText = StringRef(Start, End - Start);
1154 String->IsFirst = Macro->IsFirst;
1155 String->LastNewlineOffset = Macro->LastNewlineOffset;
1156 String->WhitespaceRange = Macro->WhitespaceRange;
1157 String->OriginalColumn = Macro->OriginalColumn;
1158 String->ColumnWidth = encoding::columnWidthWithTabs(
1159 String->TokenText, String->OriginalColumn, Style.TabWidth, Encoding);
1160
1161 Tokens.pop_back();
1162 Tokens.pop_back();
1163 Tokens.pop_back();
1164 Tokens.back() = String;
Alexander Kornienko9aa62402013-11-21 12:43:57 +00001165 return true;
Alexander Kornienko81e32942013-09-16 20:20:49 +00001166 }
1167
Manuel Klimek15dfe7a2013-05-28 11:55:06 +00001168 FormatToken *getNextToken() {
Alexander Kornienkoe3276842012-12-07 16:15:44 +00001169 if (GreaterStashed) {
Manuel Klimek591ab5a2013-05-28 13:42:28 +00001170 // Create a synthesized second '>' token.
Manuel Klimek31c85922013-08-29 15:21:40 +00001171 // FIXME: Increment Column and set OriginalColumn.
Manuel Klimek591ab5a2013-05-28 13:42:28 +00001172 Token Greater = FormatTok->Tok;
1173 FormatTok = new (Allocator.Allocate()) FormatToken;
1174 FormatTok->Tok = Greater;
Manuel Klimek5c24cca2013-05-23 10:56:37 +00001175 SourceLocation GreaterLocation =
Manuel Klimek15dfe7a2013-05-28 11:55:06 +00001176 FormatTok->Tok.getLocation().getLocWithOffset(1);
1177 FormatTok->WhitespaceRange =
1178 SourceRange(GreaterLocation, GreaterLocation);
Alexander Kornienkoee4ca9b2013-06-07 17:45:07 +00001179 FormatTok->TokenText = ">";
Alexander Kornienko39856b72013-09-10 09:38:25 +00001180 FormatTok->ColumnWidth = 1;
Alexander Kornienkoe3276842012-12-07 16:15:44 +00001181 GreaterStashed = false;
1182 return FormatTok;
1183 }
1184
Manuel Klimek15dfe7a2013-05-28 11:55:06 +00001185 FormatTok = new (Allocator.Allocate()) FormatToken;
Daniel Jasper8369aa52013-07-16 20:28:33 +00001186 readRawToken(*FormatTok);
Manuel Klimek9043c742013-05-27 15:23:34 +00001187 SourceLocation WhitespaceStart =
Manuel Klimek15dfe7a2013-05-28 11:55:06 +00001188 FormatTok->Tok.getLocation().getLocWithOffset(-TrailingWhitespace);
Alexander Kornienko393e3082013-11-13 14:04:17 +00001189 FormatTok->IsFirst = IsFirstToken;
1190 IsFirstToken = false;
Alexander Kornienkoe3276842012-12-07 16:15:44 +00001191
1192 // Consume and record whitespace until we find a significant token.
Manuel Klimek9043c742013-05-27 15:23:34 +00001193 unsigned WhitespaceLength = TrailingWhitespace;
Manuel Klimek15dfe7a2013-05-28 11:55:06 +00001194 while (FormatTok->Tok.is(tok::unknown)) {
Manuel Klimek31c85922013-08-29 15:21:40 +00001195 for (int i = 0, e = FormatTok->TokenText.size(); i != e; ++i) {
1196 switch (FormatTok->TokenText[i]) {
1197 case '\n':
1198 ++FormatTok->NewlinesBefore;
1199 // FIXME: This is technically incorrect, as it could also
1200 // be a literal backslash at the end of the line.
Alexander Kornienko9e649af2013-09-11 12:25:57 +00001201 if (i == 0 || (FormatTok->TokenText[i - 1] != '\\' &&
1202 (FormatTok->TokenText[i - 1] != '\r' || i == 1 ||
1203 FormatTok->TokenText[i - 2] != '\\')))
Manuel Klimek31c85922013-08-29 15:21:40 +00001204 FormatTok->HasUnescapedNewline = true;
1205 FormatTok->LastNewlineOffset = WhitespaceLength + i + 1;
1206 Column = 0;
1207 break;
Daniel Jasper877615c2013-10-11 19:45:02 +00001208 case '\r':
1209 case '\f':
1210 case '\v':
1211 Column = 0;
1212 break;
Manuel Klimek31c85922013-08-29 15:21:40 +00001213 case ' ':
1214 ++Column;
1215 break;
1216 case '\t':
Alexander Kornienkoebb43ca2013-09-05 14:08:34 +00001217 Column += Style.TabWidth - Column % Style.TabWidth;
Manuel Klimek31c85922013-08-29 15:21:40 +00001218 break;
Daniel Jasper877615c2013-10-11 19:45:02 +00001219 case '\\':
1220 ++Column;
1221 if (i + 1 == e || (FormatTok->TokenText[i + 1] != '\r' &&
1222 FormatTok->TokenText[i + 1] != '\n'))
1223 FormatTok->Type = TT_ImplicitStringLiteral;
1224 break;
Manuel Klimek31c85922013-08-29 15:21:40 +00001225 default:
Daniel Jasper877615c2013-10-11 19:45:02 +00001226 FormatTok->Type = TT_ImplicitStringLiteral;
Manuel Klimek31c85922013-08-29 15:21:40 +00001227 ++Column;
1228 break;
1229 }
1230 }
1231
Daniel Jasper877615c2013-10-11 19:45:02 +00001232 if (FormatTok->Type == TT_ImplicitStringLiteral)
1233 break;
Manuel Klimek15dfe7a2013-05-28 11:55:06 +00001234 WhitespaceLength += FormatTok->Tok.getLength();
Alexander Kornienkoe3276842012-12-07 16:15:44 +00001235
Daniel Jasper8369aa52013-07-16 20:28:33 +00001236 readRawToken(*FormatTok);
Manuel Klimek1abf7892013-01-04 23:34:14 +00001237 }
Manuel Klimekef920692013-01-07 07:56:50 +00001238
Manuel Klimek1abf7892013-01-04 23:34:14 +00001239 // In case the token starts with escaped newlines, we want to
1240 // take them into account as whitespace - this pattern is quite frequent
1241 // in macro definitions.
Manuel Klimek1abf7892013-01-04 23:34:14 +00001242 // FIXME: Add a more explicit test.
Daniel Jasper8369aa52013-07-16 20:28:33 +00001243 while (FormatTok->TokenText.size() > 1 && FormatTok->TokenText[0] == '\\' &&
1244 FormatTok->TokenText[1] == '\n') {
Manuel Klimek15dfe7a2013-05-28 11:55:06 +00001245 // FIXME: ++FormatTok->NewlinesBefore is missing...
Manuel Klimek5c24cca2013-05-23 10:56:37 +00001246 WhitespaceLength += 2;
Manuel Klimek31c85922013-08-29 15:21:40 +00001247 Column = 0;
Daniel Jasper8369aa52013-07-16 20:28:33 +00001248 FormatTok->TokenText = FormatTok->TokenText.substr(2);
Alexander Kornienkoe3276842012-12-07 16:15:44 +00001249 }
Alexander Kornienko39856b72013-09-10 09:38:25 +00001250
1251 FormatTok->WhitespaceRange = SourceRange(
1252 WhitespaceStart, WhitespaceStart.getLocWithOffset(WhitespaceLength));
1253
Manuel Klimek31c85922013-08-29 15:21:40 +00001254 FormatTok->OriginalColumn = Column;
Alexander Kornienkoe3276842012-12-07 16:15:44 +00001255
Alexander Kornienkoee4ca9b2013-06-07 17:45:07 +00001256 TrailingWhitespace = 0;
1257 if (FormatTok->Tok.is(tok::comment)) {
Manuel Klimek31c85922013-08-29 15:21:40 +00001258 // FIXME: Add the trimmed whitespace to Column.
Daniel Jasper8369aa52013-07-16 20:28:33 +00001259 StringRef UntrimmedText = FormatTok->TokenText;
Alexander Kornienko9ab4a772013-09-06 17:24:54 +00001260 FormatTok->TokenText = FormatTok->TokenText.rtrim(" \t\v\f");
Daniel Jasper8369aa52013-07-16 20:28:33 +00001261 TrailingWhitespace = UntrimmedText.size() - FormatTok->TokenText.size();
Alexander Kornienkoee4ca9b2013-06-07 17:45:07 +00001262 } else if (FormatTok->Tok.is(tok::raw_identifier)) {
Daniel Jasper8369aa52013-07-16 20:28:33 +00001263 IdentifierInfo &Info = IdentTable.get(FormatTok->TokenText);
Manuel Klimek15dfe7a2013-05-28 11:55:06 +00001264 FormatTok->Tok.setIdentifierInfo(&Info);
1265 FormatTok->Tok.setKind(Info.getTokenID());
Alexander Kornienkoee4ca9b2013-06-07 17:45:07 +00001266 } else if (FormatTok->Tok.is(tok::greatergreater)) {
Manuel Klimek15dfe7a2013-05-28 11:55:06 +00001267 FormatTok->Tok.setKind(tok::greater);
Daniel Jasper8369aa52013-07-16 20:28:33 +00001268 FormatTok->TokenText = FormatTok->TokenText.substr(0, 1);
Alexander Kornienkoe3276842012-12-07 16:15:44 +00001269 GreaterStashed = true;
1270 }
1271
Alexander Kornienkoee4ca9b2013-06-07 17:45:07 +00001272 // Now FormatTok is the next non-whitespace token.
Alexander Kornienkoffcc0102013-06-05 14:09:10 +00001273
Alexander Kornienko39856b72013-09-10 09:38:25 +00001274 StringRef Text = FormatTok->TokenText;
1275 size_t FirstNewlinePos = Text.find('\n');
Alexander Kornienko917f9e02013-09-10 12:29:48 +00001276 if (FirstNewlinePos == StringRef::npos) {
1277 // FIXME: ColumnWidth actually depends on the start column, we need to
1278 // take this into account when the token is moved.
1279 FormatTok->ColumnWidth =
1280 encoding::columnWidthWithTabs(Text, Column, Style.TabWidth, Encoding);
1281 Column += FormatTok->ColumnWidth;
1282 } else {
Alexander Kornienko39856b72013-09-10 09:38:25 +00001283 FormatTok->IsMultiline = true;
Alexander Kornienko917f9e02013-09-10 12:29:48 +00001284 // FIXME: ColumnWidth actually depends on the start column, we need to
1285 // take this into account when the token is moved.
1286 FormatTok->ColumnWidth = encoding::columnWidthWithTabs(
1287 Text.substr(0, FirstNewlinePos), Column, Style.TabWidth, Encoding);
1288
Alexander Kornienko39856b72013-09-10 09:38:25 +00001289 // The last line of the token always starts in column 0.
1290 // Thus, the length can be precomputed even in the presence of tabs.
1291 FormatTok->LastLineColumnWidth = encoding::columnWidthWithTabs(
1292 Text.substr(Text.find_last_of('\n') + 1), 0, Style.TabWidth,
1293 Encoding);
Alexander Kornienko917f9e02013-09-10 12:29:48 +00001294 Column = FormatTok->LastLineColumnWidth;
Alexander Kornienko632abb92013-09-02 13:58:14 +00001295 }
Alexander Kornienko39856b72013-09-10 09:38:25 +00001296
Alexander Kornienkoe3276842012-12-07 16:15:44 +00001297 return FormatTok;
1298 }
1299
Manuel Klimek15dfe7a2013-05-28 11:55:06 +00001300 FormatToken *FormatTok;
Alexander Kornienko393e3082013-11-13 14:04:17 +00001301 bool IsFirstToken;
Alexander Kornienkoe3276842012-12-07 16:15:44 +00001302 bool GreaterStashed;
Manuel Klimek31c85922013-08-29 15:21:40 +00001303 unsigned Column;
Manuel Klimek9043c742013-05-27 15:23:34 +00001304 unsigned TrailingWhitespace;
Alexander Kornienkoe3276842012-12-07 16:15:44 +00001305 Lexer &Lex;
1306 SourceManager &SourceMgr;
Manuel Klimek31c85922013-08-29 15:21:40 +00001307 FormatStyle &Style;
Alexander Kornienkoe3276842012-12-07 16:15:44 +00001308 IdentifierTable IdentTable;
Alexander Kornienkoffcc0102013-06-05 14:09:10 +00001309 encoding::Encoding Encoding;
Manuel Klimek15dfe7a2013-05-28 11:55:06 +00001310 llvm::SpecificBumpPtrAllocator<FormatToken> Allocator;
1311 SmallVector<FormatToken *, 16> Tokens;
Alexander Kornienkoe3276842012-12-07 16:15:44 +00001312
Daniel Jasper8369aa52013-07-16 20:28:33 +00001313 void readRawToken(FormatToken &Tok) {
1314 Lex.LexFromRawLexer(Tok.Tok);
1315 Tok.TokenText = StringRef(SourceMgr.getCharacterData(Tok.Tok.getLocation()),
1316 Tok.Tok.getLength());
Daniel Jasper8369aa52013-07-16 20:28:33 +00001317 // For formatting, treat unterminated string literals like normal string
1318 // literals.
1319 if (Tok.is(tok::unknown) && !Tok.TokenText.empty() &&
1320 Tok.TokenText[0] == '"') {
1321 Tok.Tok.setKind(tok::string_literal);
1322 Tok.IsUnterminatedLiteral = true;
1323 }
Alexander Kornienkoe3276842012-12-07 16:15:44 +00001324 }
1325};
1326
Alexander Kornienkocabdd732013-11-29 15:19:43 +00001327static StringRef getLanguageName(FormatStyle::LanguageKind Language) {
1328 switch (Language) {
1329 case FormatStyle::LK_Cpp:
1330 return "C++";
1331 case FormatStyle::LK_JavaScript:
1332 return "JavaScript";
1333 default:
1334 return "Unknown";
1335 }
1336}
1337
Daniel Jasperf7935112012-12-03 18:12:45 +00001338class Formatter : public UnwrappedLineConsumer {
1339public:
Daniel Jasperd2ae41a2013-05-15 08:14:19 +00001340 Formatter(const FormatStyle &Style, Lexer &Lex, SourceManager &SourceMgr,
Daniel Jasperf7935112012-12-03 18:12:45 +00001341 const std::vector<CharSourceRange> &Ranges)
Daniel Jasperd2ae41a2013-05-15 08:14:19 +00001342 : Style(Style), Lex(Lex), SourceMgr(SourceMgr),
Alexander Kornienko9e649af2013-09-11 12:25:57 +00001343 Whitespaces(SourceMgr, Style, inputUsesCRLF(Lex.getBuffer())),
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +00001344 Ranges(Ranges.begin(), Ranges.end()), UnwrappedLines(1),
Manuel Klimek71814b42013-10-11 21:25:45 +00001345 Encoding(encoding::detectEncoding(Lex.getBuffer())) {
Daniel Jasperfa21c072013-07-15 14:33:14 +00001346 DEBUG(llvm::dbgs() << "File encoding: "
1347 << (Encoding == encoding::Encoding_UTF8 ? "UTF8"
1348 : "unknown")
1349 << "\n");
Alexander Kornienkocabdd732013-11-29 15:19:43 +00001350 DEBUG(llvm::dbgs() << "Language: " << getLanguageName(Style.Language)
1351 << "\n");
Alexander Kornienkoffcc0102013-06-05 14:09:10 +00001352 }
Daniel Jasperf7935112012-12-03 18:12:45 +00001353
Alexander Kornienko62b85b92013-03-13 14:41:29 +00001354 tooling::Replacements format() {
Manuel Klimek71814b42013-10-11 21:25:45 +00001355 tooling::Replacements Result;
Manuel Klimek31c85922013-08-29 15:21:40 +00001356 FormatTokenLexer Tokens(Lex, SourceMgr, Style, Encoding);
Manuel Klimek15dfe7a2013-05-28 11:55:06 +00001357
1358 UnwrappedLineParser Parser(Style, Tokens.lex(), *this);
Manuel Klimek1a18c402013-04-12 14:13:36 +00001359 bool StructuralError = Parser.parse();
Manuel Klimek71814b42013-10-11 21:25:45 +00001360 assert(UnwrappedLines.rbegin()->empty());
1361 for (unsigned Run = 0, RunE = UnwrappedLines.size(); Run + 1 != RunE;
1362 ++Run) {
1363 DEBUG(llvm::dbgs() << "Run " << Run << "...\n");
1364 SmallVector<AnnotatedLine *, 16> AnnotatedLines;
1365 for (unsigned i = 0, e = UnwrappedLines[Run].size(); i != e; ++i) {
1366 AnnotatedLines.push_back(new AnnotatedLine(UnwrappedLines[Run][i]));
1367 }
1368 tooling::Replacements RunResult =
1369 format(AnnotatedLines, StructuralError, Tokens);
1370 DEBUG({
1371 llvm::dbgs() << "Replacements for run " << Run << ":\n";
1372 for (tooling::Replacements::iterator I = RunResult.begin(),
1373 E = RunResult.end();
1374 I != E; ++I) {
1375 llvm::dbgs() << I->toString() << "\n";
1376 }
1377 });
1378 for (unsigned i = 0, e = AnnotatedLines.size(); i != e; ++i) {
1379 delete AnnotatedLines[i];
1380 }
1381 Result.insert(RunResult.begin(), RunResult.end());
1382 Whitespaces.reset();
1383 }
1384 return Result;
1385 }
1386
1387 tooling::Replacements format(SmallVectorImpl<AnnotatedLine *> &AnnotatedLines,
1388 bool StructuralError, FormatTokenLexer &Tokens) {
Alexander Kornienkoffcc0102013-06-05 14:09:10 +00001389 TokenAnnotator Annotator(Style, Tokens.getIdentTable().get("in"));
Alexander Kornienko62b85b92013-03-13 14:41:29 +00001390 for (unsigned i = 0, e = AnnotatedLines.size(); i != e; ++i) {
Daniel Jasper9fe0e8d2013-09-05 09:29:45 +00001391 Annotator.annotate(*AnnotatedLines[i]);
Alexander Kornienko62b85b92013-03-13 14:41:29 +00001392 }
Manuel Klimek71814b42013-10-11 21:25:45 +00001393 deriveLocalStyle(AnnotatedLines);
Alexander Kornienko62b85b92013-03-13 14:41:29 +00001394 for (unsigned i = 0, e = AnnotatedLines.size(); i != e; ++i) {
Daniel Jasper9fe0e8d2013-09-05 09:29:45 +00001395 Annotator.calculateFormattingInformation(*AnnotatedLines[i]);
Alexander Kornienko62b85b92013-03-13 14:41:29 +00001396 }
Daniel Jasper5500f612013-11-25 11:08:59 +00001397 computeAffectedLines(AnnotatedLines.begin(), AnnotatedLines.end());
Daniel Jasperb67cc422013-04-09 17:46:55 +00001398
Daniel Jasper1c5d9df2013-09-06 07:54:20 +00001399 Annotator.setCommentLineLevels(AnnotatedLines);
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +00001400 ContinuationIndenter Indenter(Style, SourceMgr, Whitespaces, Encoding,
1401 BinPackInconclusiveFunctions);
Daniel Jasper5500f612013-11-25 11:08:59 +00001402 UnwrappedLineFormatter Formatter(&Indenter, &Whitespaces, Style);
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +00001403 Formatter.format(AnnotatedLines, /*DryRun=*/false);
Alexander Kornienko62b85b92013-03-13 14:41:29 +00001404 return Whitespaces.generateReplacements();
1405 }
1406
1407private:
Daniel Jasper5500f612013-11-25 11:08:59 +00001408 // Determines which lines are affected by the SourceRanges given as input.
Daniel Jasper9c199562013-11-28 15:58:55 +00001409 // Returns \c true if at least one line between I and E or one of their
1410 // children is affected.
Daniel Jasper5500f612013-11-25 11:08:59 +00001411 bool computeAffectedLines(SmallVectorImpl<AnnotatedLine *>::iterator I,
1412 SmallVectorImpl<AnnotatedLine *>::iterator E) {
1413 bool SomeLineAffected = false;
Daniel Jasper38c82402013-11-29 09:27:43 +00001414 const AnnotatedLine *PreviousLine = NULL;
Daniel Jasper5500f612013-11-25 11:08:59 +00001415 while (I != E) {
1416 AnnotatedLine *Line = *I;
1417 Line->LeadingEmptyLinesAffected = affectsLeadingEmptyLines(*Line->First);
1418
1419 // If a line is part of a preprocessor directive, it needs to be formatted
1420 // if any token within the directive is affected.
1421 if (Line->InPPDirective) {
1422 FormatToken *Last = Line->Last;
1423 SmallVectorImpl<AnnotatedLine *>::iterator PPEnd = I + 1;
1424 while (PPEnd != E && !(*PPEnd)->First->HasUnescapedNewline) {
1425 Last = (*PPEnd)->Last;
1426 ++PPEnd;
1427 }
1428
1429 if (affectsTokenRange(*Line->First, *Last,
1430 /*IncludeLeadingNewlines=*/false)) {
1431 SomeLineAffected = true;
1432 markAllAsAffected(I, PPEnd);
1433 }
1434 I = PPEnd;
1435 continue;
1436 }
1437
Daniel Jasper38c82402013-11-29 09:27:43 +00001438 if (nonPPLineAffected(Line, PreviousLine))
Daniel Jasper5500f612013-11-25 11:08:59 +00001439 SomeLineAffected = true;
Daniel Jasper5500f612013-11-25 11:08:59 +00001440
Daniel Jasper38c82402013-11-29 09:27:43 +00001441 PreviousLine = Line;
Daniel Jasper5500f612013-11-25 11:08:59 +00001442 ++I;
1443 }
1444 return SomeLineAffected;
1445 }
1446
Daniel Jasper9c199562013-11-28 15:58:55 +00001447 // Determines whether 'Line' is affected by the SourceRanges given as input.
1448 // Returns \c true if line or one if its children is affected.
Daniel Jasper38c82402013-11-29 09:27:43 +00001449 bool nonPPLineAffected(AnnotatedLine *Line,
1450 const AnnotatedLine *PreviousLine) {
Daniel Jasper9c199562013-11-28 15:58:55 +00001451 bool SomeLineAffected = false;
1452 Line->ChildrenAffected =
1453 computeAffectedLines(Line->Children.begin(), Line->Children.end());
1454 if (Line->ChildrenAffected)
1455 SomeLineAffected = true;
1456
1457 // Stores whether one of the line's tokens is directly affected.
1458 bool SomeTokenAffected = false;
1459 // Stores whether we need to look at the leading newlines of the next token
1460 // in order to determine whether it was affected.
1461 bool IncludeLeadingNewlines = false;
1462
1463 // Stores whether the first child line of any of this line's tokens is
1464 // affected.
1465 bool SomeFirstChildAffected = false;
1466
1467 for (FormatToken *Tok = Line->First; Tok; Tok = Tok->Next) {
1468 // Determine whether 'Tok' was affected.
1469 if (affectsTokenRange(*Tok, *Tok, IncludeLeadingNewlines))
1470 SomeTokenAffected = true;
1471
1472 // Determine whether the first child of 'Tok' was affected.
1473 if (!Tok->Children.empty() && Tok->Children.front()->Affected)
1474 SomeFirstChildAffected = true;
1475
1476 IncludeLeadingNewlines = Tok->Children.empty();
1477 }
1478
1479 // Was this line moved, i.e. has it previously been on the same line as an
1480 // affected line?
Daniel Jasper38c82402013-11-29 09:27:43 +00001481 bool LineMoved = PreviousLine && PreviousLine->Affected &&
1482 Line->First->NewlinesBefore == 0;
Daniel Jasper9c199562013-11-28 15:58:55 +00001483
Daniel Jasper38c82402013-11-29 09:27:43 +00001484 bool IsContinuedComment = Line->First->is(tok::comment) &&
1485 Line->First->Next == NULL &&
1486 Line->First->NewlinesBefore < 2 && PreviousLine &&
Daniel Jasper0e81f1a2013-12-02 09:19:27 +00001487 PreviousLine->Affected &&
Daniel Jasper38c82402013-11-29 09:27:43 +00001488 PreviousLine->Last->is(tok::comment);
1489
1490 if (SomeTokenAffected || SomeFirstChildAffected || LineMoved ||
1491 IsContinuedComment) {
Daniel Jasper9c199562013-11-28 15:58:55 +00001492 Line->Affected = true;
Daniel Jasper9c199562013-11-28 15:58:55 +00001493 SomeLineAffected = true;
Daniel Jasper9c199562013-11-28 15:58:55 +00001494 }
1495 return SomeLineAffected;
1496 }
1497
Daniel Jasper5500f612013-11-25 11:08:59 +00001498 // Marks all lines between I and E as well as all their children as affected.
1499 void markAllAsAffected(SmallVectorImpl<AnnotatedLine *>::iterator I,
1500 SmallVectorImpl<AnnotatedLine *>::iterator E) {
1501 while (I != E) {
1502 (*I)->Affected = true;
1503 markAllAsAffected((*I)->Children.begin(), (*I)->Children.end());
1504 ++I;
1505 }
1506 }
1507
1508 // Returns true if the range from 'First' to 'Last' intersects with one of the
1509 // input ranges.
1510 bool affectsTokenRange(const FormatToken &First, const FormatToken &Last,
1511 bool IncludeLeadingNewlines) {
1512 SourceLocation Start = First.WhitespaceRange.getBegin();
1513 if (!IncludeLeadingNewlines)
1514 Start = Start.getLocWithOffset(First.LastNewlineOffset);
Daniel Jasper5877bf12013-11-25 11:53:05 +00001515 SourceLocation End = Last.getStartOfNonWhitespace();
1516 if (Last.TokenText.size() > 0)
1517 End = End.getLocWithOffset(Last.TokenText.size() - 1);
Daniel Jasper5500f612013-11-25 11:08:59 +00001518 CharSourceRange Range = CharSourceRange::getCharRange(Start, End);
1519 return affectsCharSourceRange(Range);
1520 }
1521
1522 // Returns true if one of the input ranges intersect the leading empty lines
1523 // before 'Tok'.
1524 bool affectsLeadingEmptyLines(const FormatToken &Tok) {
1525 CharSourceRange EmptyLineRange = CharSourceRange::getCharRange(
1526 Tok.WhitespaceRange.getBegin(),
1527 Tok.WhitespaceRange.getBegin().getLocWithOffset(Tok.LastNewlineOffset));
1528 return affectsCharSourceRange(EmptyLineRange);
1529 }
1530
1531 // Returns true if 'Range' intersects with one of the input ranges.
1532 bool affectsCharSourceRange(const CharSourceRange &Range) {
1533 for (SmallVectorImpl<CharSourceRange>::const_iterator I = Ranges.begin(),
1534 E = Ranges.end();
1535 I != E; ++I) {
1536 if (!SourceMgr.isBeforeInTranslationUnit(Range.getEnd(), I->getBegin()) &&
1537 !SourceMgr.isBeforeInTranslationUnit(I->getEnd(), Range.getBegin()))
1538 return true;
1539 }
1540 return false;
1541 }
1542
Alexander Kornienko9e649af2013-09-11 12:25:57 +00001543 static bool inputUsesCRLF(StringRef Text) {
1544 return Text.count('\r') * 2 > Text.count('\n');
1545 }
1546
Manuel Klimek71814b42013-10-11 21:25:45 +00001547 void
1548 deriveLocalStyle(const SmallVectorImpl<AnnotatedLine *> &AnnotatedLines) {
Daniel Jasper7fce3ab2013-02-06 14:22:40 +00001549 unsigned CountBoundToVariable = 0;
1550 unsigned CountBoundToType = 0;
1551 bool HasCpp03IncompatibleFormat = false;
Daniel Jasperb10cbc42013-07-10 14:02:49 +00001552 bool HasBinPackedFunction = false;
1553 bool HasOnePerLineFunction = false;
Daniel Jasper7fce3ab2013-02-06 14:22:40 +00001554 for (unsigned i = 0, e = AnnotatedLines.size(); i != e; ++i) {
Daniel Jasper9fe0e8d2013-09-05 09:29:45 +00001555 if (!AnnotatedLines[i]->First->Next)
Daniel Jasper7fce3ab2013-02-06 14:22:40 +00001556 continue;
Daniel Jasper9fe0e8d2013-09-05 09:29:45 +00001557 FormatToken *Tok = AnnotatedLines[i]->First->Next;
Manuel Klimek6e6310e2013-05-29 14:47:47 +00001558 while (Tok->Next) {
Daniel Jasper7fce3ab2013-02-06 14:22:40 +00001559 if (Tok->Type == TT_PointerOrReference) {
Manuel Klimek6e6310e2013-05-29 14:47:47 +00001560 bool SpacesBefore =
1561 Tok->WhitespaceRange.getBegin() != Tok->WhitespaceRange.getEnd();
1562 bool SpacesAfter = Tok->Next->WhitespaceRange.getBegin() !=
1563 Tok->Next->WhitespaceRange.getEnd();
Daniel Jasper7fce3ab2013-02-06 14:22:40 +00001564 if (SpacesBefore && !SpacesAfter)
1565 ++CountBoundToVariable;
1566 else if (!SpacesBefore && SpacesAfter)
1567 ++CountBoundToType;
1568 }
1569
Daniel Jasperfba84ff2013-10-12 05:16:06 +00001570 if (Tok->WhitespaceRange.getBegin() == Tok->WhitespaceRange.getEnd()) {
1571 if (Tok->is(tok::coloncolon) &&
1572 Tok->Previous->Type == TT_TemplateOpener)
1573 HasCpp03IncompatibleFormat = true;
1574 if (Tok->Type == TT_TemplateCloser &&
1575 Tok->Previous->Type == TT_TemplateCloser)
1576 HasCpp03IncompatibleFormat = true;
1577 }
Daniel Jasperb10cbc42013-07-10 14:02:49 +00001578
1579 if (Tok->PackingKind == PPK_BinPacked)
1580 HasBinPackedFunction = true;
1581 if (Tok->PackingKind == PPK_OnePerLine)
1582 HasOnePerLineFunction = true;
1583
Manuel Klimek6e6310e2013-05-29 14:47:47 +00001584 Tok = Tok->Next;
Daniel Jasper7fce3ab2013-02-06 14:22:40 +00001585 }
1586 }
1587 if (Style.DerivePointerBinding) {
1588 if (CountBoundToType > CountBoundToVariable)
1589 Style.PointerBindsToType = true;
1590 else if (CountBoundToType < CountBoundToVariable)
1591 Style.PointerBindsToType = false;
1592 }
1593 if (Style.Standard == FormatStyle::LS_Auto) {
1594 Style.Standard = HasCpp03IncompatibleFormat ? FormatStyle::LS_Cpp11
1595 : FormatStyle::LS_Cpp03;
1596 }
Daniel Jasperb10cbc42013-07-10 14:02:49 +00001597 BinPackInconclusiveFunctions =
1598 HasBinPackedFunction || !HasOnePerLineFunction;
Daniel Jasper7fce3ab2013-02-06 14:22:40 +00001599 }
1600
Manuel Klimek51bd6ec2013-01-10 19:49:59 +00001601 virtual void consumeUnwrappedLine(const UnwrappedLine &TheLine) {
Manuel Klimek71814b42013-10-11 21:25:45 +00001602 assert(!UnwrappedLines.empty());
1603 UnwrappedLines.back().push_back(TheLine);
1604 }
1605
1606 virtual void finishRun() {
1607 UnwrappedLines.push_back(SmallVector<UnwrappedLine, 16>());
Daniel Jasperf7935112012-12-03 18:12:45 +00001608 }
1609
1610 FormatStyle Style;
1611 Lexer &Lex;
1612 SourceManager &SourceMgr;
Daniel Jasperaa701fa2013-01-18 08:44:07 +00001613 WhitespaceManager Whitespaces;
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +00001614 SmallVector<CharSourceRange, 8> Ranges;
Manuel Klimek71814b42013-10-11 21:25:45 +00001615 SmallVector<SmallVector<UnwrappedLine, 16>, 2> UnwrappedLines;
Alexander Kornienkoffcc0102013-06-05 14:09:10 +00001616
1617 encoding::Encoding Encoding;
Daniel Jasperb10cbc42013-07-10 14:02:49 +00001618 bool BinPackInconclusiveFunctions;
Daniel Jasperf7935112012-12-03 18:12:45 +00001619};
1620
Craig Topperaf35e852013-06-30 22:29:28 +00001621} // end anonymous namespace
1622
Alexander Kornienkocb45bc12013-04-15 14:28:00 +00001623tooling::Replacements reformat(const FormatStyle &Style, Lexer &Lex,
1624 SourceManager &SourceMgr,
Daniel Jasperd2ae41a2013-05-15 08:14:19 +00001625 std::vector<CharSourceRange> Ranges) {
1626 Formatter formatter(Style, Lex, SourceMgr, Ranges);
Daniel Jasperf7935112012-12-03 18:12:45 +00001627 return formatter.format();
1628}
1629
Daniel Jasperec04c0d2013-05-16 10:40:07 +00001630tooling::Replacements reformat(const FormatStyle &Style, StringRef Code,
1631 std::vector<tooling::Range> Ranges,
1632 StringRef FileName) {
1633 FileManager Files((FileSystemOptions()));
1634 DiagnosticsEngine Diagnostics(
1635 IntrusiveRefCntPtr<DiagnosticIDs>(new DiagnosticIDs),
1636 new DiagnosticOptions);
1637 SourceManager SourceMgr(Diagnostics, Files);
1638 llvm::MemoryBuffer *Buf = llvm::MemoryBuffer::getMemBuffer(Code, FileName);
1639 const clang::FileEntry *Entry =
1640 Files.getVirtualFile(FileName, Buf->getBufferSize(), 0);
1641 SourceMgr.overrideFileContents(Entry, Buf);
1642 FileID ID =
1643 SourceMgr.createFileID(Entry, SourceLocation(), clang::SrcMgr::C_User);
Alexander Kornienko1e808872013-06-28 12:51:24 +00001644 Lexer Lex(ID, SourceMgr.getBuffer(ID), SourceMgr,
1645 getFormattingLangOpts(Style.Standard));
Daniel Jasperec04c0d2013-05-16 10:40:07 +00001646 SourceLocation StartOfFile = SourceMgr.getLocForStartOfFile(ID);
1647 std::vector<CharSourceRange> CharRanges;
1648 for (unsigned i = 0, e = Ranges.size(); i != e; ++i) {
1649 SourceLocation Start = StartOfFile.getLocWithOffset(Ranges[i].getOffset());
1650 SourceLocation End = Start.getLocWithOffset(Ranges[i].getLength());
1651 CharRanges.push_back(CharSourceRange::getCharRange(Start, End));
1652 }
1653 return reformat(Style, Lex, SourceMgr, CharRanges);
1654}
1655
Alexander Kornienko1e808872013-06-28 12:51:24 +00001656LangOptions getFormattingLangOpts(FormatStyle::LanguageStandard Standard) {
Daniel Jasperc1fa2812013-01-10 13:08:12 +00001657 LangOptions LangOpts;
1658 LangOpts.CPlusPlus = 1;
Alexander Kornienko1e808872013-06-28 12:51:24 +00001659 LangOpts.CPlusPlus11 = Standard == FormatStyle::LS_Cpp03 ? 0 : 1;
Daniel Jasper55213652013-03-22 10:01:29 +00001660 LangOpts.LineComment = 1;
Daniel Jasperc1fa2812013-01-10 13:08:12 +00001661 LangOpts.Bool = 1;
1662 LangOpts.ObjC1 = 1;
1663 LangOpts.ObjC2 = 1;
1664 return LangOpts;
1665}
1666
Edwin Vaned544aa72013-09-30 13:31:48 +00001667const char *StyleOptionHelpDescription =
1668 "Coding style, currently supports:\n"
1669 " LLVM, Google, Chromium, Mozilla, WebKit.\n"
1670 "Use -style=file to load style configuration from\n"
1671 ".clang-format file located in one of the parent\n"
1672 "directories of the source file (or current\n"
1673 "directory for stdin).\n"
1674 "Use -style=\"{key: value, ...}\" to set specific\n"
1675 "parameters, e.g.:\n"
1676 " -style=\"{BasedOnStyle: llvm, IndentWidth: 8}\"";
1677
Alexander Kornienkoc1637f12013-12-10 11:28:13 +00001678static FormatStyle::LanguageKind getLanguageByFileName(StringRef FileName) {
Alexander Kornienkocabdd732013-11-29 15:19:43 +00001679 if (FileName.endswith_lower(".js")) {
Alexander Kornienkoc1637f12013-12-10 11:28:13 +00001680 return FormatStyle::LK_JavaScript;
Alexander Kornienkocabdd732013-11-29 15:19:43 +00001681 }
Alexander Kornienkoc1637f12013-12-10 11:28:13 +00001682 return FormatStyle::LK_Cpp;
Alexander Kornienkocabdd732013-11-29 15:19:43 +00001683}
1684
Alexander Kornienkobc4ae442013-12-02 15:21:38 +00001685FormatStyle getStyle(StringRef StyleName, StringRef FileName,
1686 StringRef FallbackStyle) {
Alexander Kornienkoc1637f12013-12-10 11:28:13 +00001687 FormatStyle Style = getLLVMStyle();
1688 Style.Language = getLanguageByFileName(FileName);
1689 if (!getPredefinedStyle(FallbackStyle, Style.Language, &Style)) {
Alexander Kornienkobc4ae442013-12-02 15:21:38 +00001690 llvm::errs() << "Invalid fallback style \"" << FallbackStyle
1691 << "\" using LLVM style\n";
Alexander Kornienkoc1637f12013-12-10 11:28:13 +00001692 return Style;
Alexander Kornienkobc4ae442013-12-02 15:21:38 +00001693 }
Edwin Vaned544aa72013-09-30 13:31:48 +00001694
1695 if (StyleName.startswith("{")) {
1696 // Parse YAML/JSON style from the command line.
1697 if (llvm::error_code ec = parseConfiguration(StyleName, &Style)) {
Alexander Kornienkoe2e03872013-10-14 00:46:35 +00001698 llvm::errs() << "Error parsing -style: " << ec.message() << ", using "
1699 << FallbackStyle << " style\n";
Edwin Vaned544aa72013-09-30 13:31:48 +00001700 }
1701 return Style;
1702 }
1703
1704 if (!StyleName.equals_lower("file")) {
Alexander Kornienkoc1637f12013-12-10 11:28:13 +00001705 if (!getPredefinedStyle(StyleName, Style.Language, &Style))
Edwin Vaned544aa72013-09-30 13:31:48 +00001706 llvm::errs() << "Invalid value for -style, using " << FallbackStyle
1707 << " style\n";
1708 return Style;
1709 }
1710
Alexander Kornienkoc1637f12013-12-10 11:28:13 +00001711 // Look for .clang-format/_clang-format file in the file's parent directories.
Alexander Kornienkocabdd732013-11-29 15:19:43 +00001712 SmallString<128> UnsuitableConfigFiles;
Edwin Vaned544aa72013-09-30 13:31:48 +00001713 SmallString<128> Path(FileName);
1714 llvm::sys::fs::make_absolute(Path);
Alexander Kornienkoe2e03872013-10-14 00:46:35 +00001715 for (StringRef Directory = Path; !Directory.empty();
Edwin Vaned544aa72013-09-30 13:31:48 +00001716 Directory = llvm::sys::path::parent_path(Directory)) {
1717 if (!llvm::sys::fs::is_directory(Directory))
1718 continue;
1719 SmallString<128> ConfigFile(Directory);
1720
1721 llvm::sys::path::append(ConfigFile, ".clang-format");
1722 DEBUG(llvm::dbgs() << "Trying " << ConfigFile << "...\n");
1723 bool IsFile = false;
1724 // Ignore errors from is_regular_file: we only need to know if we can read
1725 // the file or not.
1726 llvm::sys::fs::is_regular_file(Twine(ConfigFile), IsFile);
1727
1728 if (!IsFile) {
1729 // Try _clang-format too, since dotfiles are not commonly used on Windows.
1730 ConfigFile = Directory;
1731 llvm::sys::path::append(ConfigFile, "_clang-format");
1732 DEBUG(llvm::dbgs() << "Trying " << ConfigFile << "...\n");
1733 llvm::sys::fs::is_regular_file(Twine(ConfigFile), IsFile);
1734 }
1735
1736 if (IsFile) {
1737 OwningPtr<llvm::MemoryBuffer> Text;
Rafael Espindola1a3605c2013-10-25 19:00:49 +00001738 if (llvm::error_code ec =
1739 llvm::MemoryBuffer::getFile(ConfigFile.c_str(), Text)) {
Edwin Vaned544aa72013-09-30 13:31:48 +00001740 llvm::errs() << ec.message() << "\n";
Alexander Kornienkobc4ae442013-12-02 15:21:38 +00001741 break;
Edwin Vaned544aa72013-09-30 13:31:48 +00001742 }
1743 if (llvm::error_code ec = parseConfiguration(Text->getBuffer(), &Style)) {
Alexander Kornienkocabdd732013-11-29 15:19:43 +00001744 if (ec == llvm::errc::not_supported) {
1745 if (!UnsuitableConfigFiles.empty())
1746 UnsuitableConfigFiles.append(", ");
1747 UnsuitableConfigFiles.append(ConfigFile);
Alexander Kornienkobc4ae442013-12-02 15:21:38 +00001748 continue;
Alexander Kornienkocabdd732013-11-29 15:19:43 +00001749 }
Alexander Kornienkobc4ae442013-12-02 15:21:38 +00001750 llvm::errs() << "Error reading " << ConfigFile << ": " << ec.message()
1751 << "\n";
1752 break;
Edwin Vaned544aa72013-09-30 13:31:48 +00001753 }
1754 DEBUG(llvm::dbgs() << "Using configuration file " << ConfigFile << "\n");
1755 return Style;
1756 }
1757 }
1758 llvm::errs() << "Can't find usable .clang-format, using " << FallbackStyle
1759 << " style\n";
Alexander Kornienkocabdd732013-11-29 15:19:43 +00001760 if (!UnsuitableConfigFiles.empty()) {
1761 llvm::errs() << "Configuration file(s) do(es) not support "
1762 << getLanguageName(Style.Language) << ": "
1763 << UnsuitableConfigFiles << "\n";
1764 }
Edwin Vaned544aa72013-09-30 13:31:48 +00001765 return Style;
1766}
1767
Daniel Jasper8d1832e2013-01-07 13:26:07 +00001768} // namespace format
1769} // namespace clang