blob: da088bf5cbc3116693a2085c0b783c484ca9599f [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);
71 }
72};
73
Alexander Kornienkod6538332013-05-07 15:32:14 +000074template <>
Alexander Kornienko6d2c88e2013-12-10 10:30:34 +000075struct ScalarEnumerationTraits<FormatStyle::NamespaceIndentationKind> {
Alexander Kornienkocabdd732013-11-29 15:19:43 +000076 static void enumeration(IO &IO,
Alexander Kornienko6d2c88e2013-12-10 10:30:34 +000077 FormatStyle::NamespaceIndentationKind &Value) {
78 IO.enumCase(Value, "None", FormatStyle::NI_None);
79 IO.enumCase(Value, "Inner", FormatStyle::NI_Inner);
80 IO.enumCase(Value, "All", FormatStyle::NI_All);
Alexander Kornienkocabdd732013-11-29 15:19:43 +000081 }
82};
83
84template <>
Alexander Kornienko6d2c88e2013-12-10 10:30:34 +000085struct ScalarEnumerationTraits<FormatStyle::SpaceBeforeParensOptions> {
Manuel Klimeka8eb9142013-05-13 12:51:40 +000086 static void enumeration(IO &IO,
Alexander Kornienko6d2c88e2013-12-10 10:30:34 +000087 FormatStyle::SpaceBeforeParensOptions &Value) {
88 IO.enumCase(Value, "Never", FormatStyle::SBPO_Never);
Alexander Kornienkofdca83d2013-12-10 10:18:34 +000089 IO.enumCase(Value, "ControlStatements",
Alexander Kornienko6d2c88e2013-12-10 10:30:34 +000090 FormatStyle::SBPO_ControlStatements);
91 IO.enumCase(Value, "Always", FormatStyle::SBPO_Always);
Alexander Kornienkofdca83d2013-12-10 10:18:34 +000092
93 // For backward compatibility.
Alexander Kornienko6d2c88e2013-12-10 10:30:34 +000094 IO.enumCase(Value, "false", FormatStyle::SBPO_Never);
95 IO.enumCase(Value, "true", FormatStyle::SBPO_ControlStatements);
Alexander Kornienkofdca83d2013-12-10 10:18:34 +000096 }
97};
98
Alexander Kornienko6d2c88e2013-12-10 10:30:34 +000099template <> struct MappingTraits<FormatStyle> {
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000100 static void mapping(IO &IO, FormatStyle &Style) {
101 // When reading, read the language first, we need it for getPredefinedStyle.
102 IO.mapOptional("Language", Style.Language);
103
Alexander Kornienko49149672013-05-10 11:56:10 +0000104 if (IO.outputting()) {
Alexander Kornienkoe3648fb2013-09-02 16:39:23 +0000105 StringRef StylesArray[] = { "LLVM", "Google", "Chromium",
106 "Mozilla", "WebKit" };
Alexander Kornienko49149672013-05-10 11:56:10 +0000107 ArrayRef<StringRef> Styles(StylesArray);
108 for (size_t i = 0, e = Styles.size(); i < e; ++i) {
109 StringRef StyleName(Styles[i]);
Alexander Kornienko6d2c88e2013-12-10 10:30:34 +0000110 FormatStyle PredefinedStyle;
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000111 if (getPredefinedStyle(StyleName, Style.Language, &PredefinedStyle) &&
Alexander Kornienko006b5c82013-05-19 00:53:30 +0000112 Style == PredefinedStyle) {
Alexander Kornienko49149672013-05-10 11:56:10 +0000113 IO.mapOptional("# BasedOnStyle", StyleName);
114 break;
115 }
116 }
117 } else {
Alexander Kornienkod6538332013-05-07 15:32:14 +0000118 StringRef BasedOnStyle;
119 IO.mapOptional("BasedOnStyle", BasedOnStyle);
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000120 if (!BasedOnStyle.empty()) {
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000121 FormatStyle::LanguageKind OldLanguage = Style.Language;
122 FormatStyle::LanguageKind Language =
123 ((FormatStyle *)IO.getContext())->Language;
124 if (!getPredefinedStyle(BasedOnStyle, Language, &Style)) {
Alexander Kornienko006b5c82013-05-19 00:53:30 +0000125 IO.setError(Twine("Unknown value for BasedOnStyle: ", BasedOnStyle));
126 return;
127 }
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000128 Style.Language = OldLanguage;
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000129 }
Alexander Kornienkod6538332013-05-07 15:32:14 +0000130 }
131
132 IO.mapOptional("AccessModifierOffset", Style.AccessModifierOffset);
Daniel Jaspercdaffa42013-08-13 10:58:30 +0000133 IO.mapOptional("ConstructorInitializerIndentWidth",
134 Style.ConstructorInitializerIndentWidth);
Alexander Kornienkod6538332013-05-07 15:32:14 +0000135 IO.mapOptional("AlignEscapedNewlinesLeft", Style.AlignEscapedNewlinesLeft);
Daniel Jasper552f4a72013-07-31 23:55:15 +0000136 IO.mapOptional("AlignTrailingComments", Style.AlignTrailingComments);
Alexander Kornienkod6538332013-05-07 15:32:14 +0000137 IO.mapOptional("AllowAllParametersOfDeclarationOnNextLine",
138 Style.AllowAllParametersOfDeclarationOnNextLine);
139 IO.mapOptional("AllowShortIfStatementsOnASingleLine",
140 Style.AllowShortIfStatementsOnASingleLine);
Daniel Jasper3a685df2013-05-16 12:12:21 +0000141 IO.mapOptional("AllowShortLoopsOnASingleLine",
142 Style.AllowShortLoopsOnASingleLine);
Alexander Kornienko3cfa9732013-11-20 16:33:05 +0000143 IO.mapOptional("AllowShortFunctionsOnASingleLine",
144 Style.AllowShortFunctionsOnASingleLine);
Daniel Jasper61e6bbf2013-05-29 12:07:31 +0000145 IO.mapOptional("AlwaysBreakTemplateDeclarations",
146 Style.AlwaysBreakTemplateDeclarations);
Alexander Kornienko58611712013-07-04 12:02:44 +0000147 IO.mapOptional("AlwaysBreakBeforeMultilineStrings",
148 Style.AlwaysBreakBeforeMultilineStrings);
Daniel Jaspere33d4af2013-07-26 16:56:36 +0000149 IO.mapOptional("BreakBeforeBinaryOperators",
150 Style.BreakBeforeBinaryOperators);
Daniel Jasper165b29e2013-11-08 00:57:11 +0000151 IO.mapOptional("BreakBeforeTernaryOperators",
152 Style.BreakBeforeTernaryOperators);
Daniel Jaspere33d4af2013-07-26 16:56:36 +0000153 IO.mapOptional("BreakConstructorInitializersBeforeComma",
154 Style.BreakConstructorInitializersBeforeComma);
Alexander Kornienkod6538332013-05-07 15:32:14 +0000155 IO.mapOptional("BinPackParameters", Style.BinPackParameters);
156 IO.mapOptional("ColumnLimit", Style.ColumnLimit);
157 IO.mapOptional("ConstructorInitializerAllOnOneLineOrOnePerLine",
158 Style.ConstructorInitializerAllOnOneLineOrOnePerLine);
159 IO.mapOptional("DerivePointerBinding", Style.DerivePointerBinding);
Daniel Jasperb10cbc42013-07-10 14:02:49 +0000160 IO.mapOptional("ExperimentalAutoDetectBinPacking",
161 Style.ExperimentalAutoDetectBinPacking);
Alexander Kornienkod6538332013-05-07 15:32:14 +0000162 IO.mapOptional("IndentCaseLabels", Style.IndentCaseLabels);
163 IO.mapOptional("MaxEmptyLinesToKeep", Style.MaxEmptyLinesToKeep);
Daniel Jasper65ee3472013-07-31 23:16:02 +0000164 IO.mapOptional("NamespaceIndentation", Style.NamespaceIndentation);
Alexander Kornienkod6538332013-05-07 15:32:14 +0000165 IO.mapOptional("ObjCSpaceBeforeProtocolList",
166 Style.ObjCSpaceBeforeProtocolList);
Daniel Jasper33b909c2013-10-25 14:29:37 +0000167 IO.mapOptional("PenaltyBreakBeforeFirstCallParameter",
168 Style.PenaltyBreakBeforeFirstCallParameter);
Alexander Kornienkodd7ece52013-06-07 16:02:52 +0000169 IO.mapOptional("PenaltyBreakComment", Style.PenaltyBreakComment);
170 IO.mapOptional("PenaltyBreakString", Style.PenaltyBreakString);
Daniel Jasper4e9678f2013-07-11 20:41:21 +0000171 IO.mapOptional("PenaltyBreakFirstLessLess",
172 Style.PenaltyBreakFirstLessLess);
Alexander Kornienkod6538332013-05-07 15:32:14 +0000173 IO.mapOptional("PenaltyExcessCharacter", Style.PenaltyExcessCharacter);
174 IO.mapOptional("PenaltyReturnTypeOnItsOwnLine",
175 Style.PenaltyReturnTypeOnItsOwnLine);
176 IO.mapOptional("PointerBindsToType", Style.PointerBindsToType);
177 IO.mapOptional("SpacesBeforeTrailingComments",
178 Style.SpacesBeforeTrailingComments);
Daniel Jasper6ab54682013-07-16 18:22:10 +0000179 IO.mapOptional("Cpp11BracedListStyle", Style.Cpp11BracedListStyle);
Alexander Kornienkod6538332013-05-07 15:32:14 +0000180 IO.mapOptional("Standard", Style.Standard);
Manuel Klimek13b97d82013-05-13 08:42:42 +0000181 IO.mapOptional("IndentWidth", Style.IndentWidth);
Alexander Kornienkoebb43ca2013-09-05 14:08:34 +0000182 IO.mapOptional("TabWidth", Style.TabWidth);
Manuel Klimekb9eae4c2013-05-13 09:22:11 +0000183 IO.mapOptional("UseTab", Style.UseTab);
Manuel Klimeka8eb9142013-05-13 12:51:40 +0000184 IO.mapOptional("BreakBeforeBraces", Style.BreakBeforeBraces);
Manuel Klimek836c2862013-06-21 17:25:42 +0000185 IO.mapOptional("IndentFunctionDeclarationAfterType",
186 Style.IndentFunctionDeclarationAfterType);
Daniel Jasperb55acad2013-08-20 12:36:34 +0000187 IO.mapOptional("SpacesInParentheses", Style.SpacesInParentheses);
Daniel Jasperdd978ae2013-10-29 14:52:02 +0000188 IO.mapOptional("SpacesInAngles", Style.SpacesInAngles);
Daniel Jasperf110e202013-08-21 08:39:01 +0000189 IO.mapOptional("SpaceInEmptyParentheses", Style.SpaceInEmptyParentheses);
Daniel Jasperb55acad2013-08-20 12:36:34 +0000190 IO.mapOptional("SpacesInCStyleCastParentheses",
191 Style.SpacesInCStyleCastParentheses);
Daniel Jasperd94bff32013-09-25 15:15:02 +0000192 IO.mapOptional("SpaceBeforeAssignmentOperators",
193 Style.SpaceBeforeAssignmentOperators);
Daniel Jasper6633ab82013-10-18 10:38:14 +0000194 IO.mapOptional("ContinuationIndentWidth", Style.ContinuationIndentWidth);
Alexander Kornienkofdca83d2013-12-10 10:18:34 +0000195
196 // For backward compatibility.
197 if (!IO.outputting()) {
198 IO.mapOptional("SpaceAfterControlStatementKeyword",
199 Style.SpaceBeforeParens);
200 }
201 IO.mapOptional("SpaceBeforeParens", Style.SpaceBeforeParens);
Alexander Kornienkod6538332013-05-07 15:32:14 +0000202 }
203};
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000204
205// Allows to read vector<FormatStyle> while keeping default values.
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000206// IO.getContext() should contain a pointer to the FormatStyle structure, that
207// will be used to get default values for missing keys.
208// If the first element has no Language specified, it will be treated as the
209// default one for the following elements.
Alexander Kornienko6d2c88e2013-12-10 10:30:34 +0000210template <> struct DocumentListTraits<std::vector<FormatStyle> > {
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000211 static size_t size(IO &IO, std::vector<FormatStyle> &Seq) {
212 return Seq.size();
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000213 }
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000214 static FormatStyle &element(IO &IO, std::vector<FormatStyle> &Seq,
Alexander Kornienko6d2c88e2013-12-10 10:30:34 +0000215 size_t Index) {
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000216 if (Index >= Seq.size()) {
217 assert(Index == Seq.size());
Alexander Kornienko6d2c88e2013-12-10 10:30:34 +0000218 FormatStyle Template;
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000219 if (Seq.size() > 0 && Seq[0].Language == FormatStyle::LK_None) {
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000220 Template = Seq[0];
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000221 } else {
222 Template = *((const FormatStyle*)IO.getContext());
Alexander Kornienko6d2c88e2013-12-10 10:30:34 +0000223 Template.Language = FormatStyle::LK_None;
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000224 }
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000225 Seq.resize(Index + 1, Template);
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000226 }
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000227 return Seq[Index];
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000228 }
229};
Alexander Kornienkod6538332013-05-07 15:32:14 +0000230}
231}
232
Daniel Jasperf7935112012-12-03 18:12:45 +0000233namespace clang {
234namespace format {
235
Daniel Jasper4e9678f2013-07-11 20:41:21 +0000236void setDefaultPenalties(FormatStyle &Style) {
Daniel Jasper2739af32013-08-28 10:03:58 +0000237 Style.PenaltyBreakComment = 60;
Daniel Jasperfa21c072013-07-15 14:33:14 +0000238 Style.PenaltyBreakFirstLessLess = 120;
Daniel Jasper4e9678f2013-07-11 20:41:21 +0000239 Style.PenaltyBreakString = 1000;
240 Style.PenaltyExcessCharacter = 1000000;
241}
242
Daniel Jasperf7935112012-12-03 18:12:45 +0000243FormatStyle getLLVMStyle() {
244 FormatStyle LLVMStyle;
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000245 LLVMStyle.Language = FormatStyle::LK_Cpp;
Daniel Jasperf7935112012-12-03 18:12:45 +0000246 LLVMStyle.AccessModifierOffset = -2;
Alexander Kornienkoc8602662013-05-06 14:11:27 +0000247 LLVMStyle.AlignEscapedNewlinesLeft = false;
Daniel Jasper552f4a72013-07-31 23:55:15 +0000248 LLVMStyle.AlignTrailingComments = true;
Daniel Jasperf7db4332013-01-29 16:03:49 +0000249 LLVMStyle.AllowAllParametersOfDeclarationOnNextLine = true;
Alexander Kornienko3cfa9732013-11-20 16:33:05 +0000250 LLVMStyle.AllowShortFunctionsOnASingleLine = true;
Daniel Jasper1b750ed2013-01-14 16:24:39 +0000251 LLVMStyle.AllowShortIfStatementsOnASingleLine = false;
Daniel Jasper3a685df2013-05-16 12:12:21 +0000252 LLVMStyle.AllowShortLoopsOnASingleLine = false;
Alexander Kornienko58611712013-07-04 12:02:44 +0000253 LLVMStyle.AlwaysBreakBeforeMultilineStrings = false;
Daniel Jaspere33d4af2013-07-26 16:56:36 +0000254 LLVMStyle.AlwaysBreakTemplateDeclarations = false;
Alexander Kornienkoc8602662013-05-06 14:11:27 +0000255 LLVMStyle.BinPackParameters = true;
Daniel Jaspere33d4af2013-07-26 16:56:36 +0000256 LLVMStyle.BreakBeforeBinaryOperators = false;
Daniel Jasper165b29e2013-11-08 00:57:11 +0000257 LLVMStyle.BreakBeforeTernaryOperators = true;
Daniel Jaspere33d4af2013-07-26 16:56:36 +0000258 LLVMStyle.BreakBeforeBraces = FormatStyle::BS_Attach;
259 LLVMStyle.BreakConstructorInitializersBeforeComma = false;
Alexander Kornienkoc8602662013-05-06 14:11:27 +0000260 LLVMStyle.ColumnLimit = 80;
261 LLVMStyle.ConstructorInitializerAllOnOneLineOrOnePerLine = false;
Daniel Jaspercdaffa42013-08-13 10:58:30 +0000262 LLVMStyle.ConstructorInitializerIndentWidth = 4;
Daniel Jaspere33d4af2013-07-26 16:56:36 +0000263 LLVMStyle.Cpp11BracedListStyle = false;
Alexander Kornienkoc8602662013-05-06 14:11:27 +0000264 LLVMStyle.DerivePointerBinding = false;
Daniel Jasperb10cbc42013-07-10 14:02:49 +0000265 LLVMStyle.ExperimentalAutoDetectBinPacking = false;
Alexander Kornienkoc8602662013-05-06 14:11:27 +0000266 LLVMStyle.IndentCaseLabels = false;
Daniel Jaspere33d4af2013-07-26 16:56:36 +0000267 LLVMStyle.IndentFunctionDeclarationAfterType = false;
268 LLVMStyle.IndentWidth = 2;
Alexander Kornienkoebb43ca2013-09-05 14:08:34 +0000269 LLVMStyle.TabWidth = 8;
Alexander Kornienkoc8602662013-05-06 14:11:27 +0000270 LLVMStyle.MaxEmptyLinesToKeep = 1;
Daniel Jasper65ee3472013-07-31 23:16:02 +0000271 LLVMStyle.NamespaceIndentation = FormatStyle::NI_None;
Nico Webera6087752013-01-10 20:12:55 +0000272 LLVMStyle.ObjCSpaceBeforeProtocolList = true;
Alexander Kornienkoc8602662013-05-06 14:11:27 +0000273 LLVMStyle.PointerBindsToType = false;
274 LLVMStyle.SpacesBeforeTrailingComments = 1;
275 LLVMStyle.Standard = FormatStyle::LS_Cpp03;
Alexander Kornienko3c3d09c2013-09-27 16:14:22 +0000276 LLVMStyle.UseTab = FormatStyle::UT_Never;
Daniel Jasperb55acad2013-08-20 12:36:34 +0000277 LLVMStyle.SpacesInParentheses = false;
278 LLVMStyle.SpaceInEmptyParentheses = false;
279 LLVMStyle.SpacesInCStyleCastParentheses = false;
Alexander Kornienkofdca83d2013-12-10 10:18:34 +0000280 LLVMStyle.SpaceBeforeParens = FormatStyle::SBPO_ControlStatements;
Daniel Jasperd94bff32013-09-25 15:15:02 +0000281 LLVMStyle.SpaceBeforeAssignmentOperators = true;
Daniel Jasper6633ab82013-10-18 10:38:14 +0000282 LLVMStyle.ContinuationIndentWidth = 4;
Daniel Jasperdd978ae2013-10-29 14:52:02 +0000283 LLVMStyle.SpacesInAngles = false;
Daniel Jasper4e9678f2013-07-11 20:41:21 +0000284
285 setDefaultPenalties(LLVMStyle);
286 LLVMStyle.PenaltyReturnTypeOnItsOwnLine = 60;
Daniel Jasper33b909c2013-10-25 14:29:37 +0000287 LLVMStyle.PenaltyBreakBeforeFirstCallParameter = 19;
Daniel Jasper4e9678f2013-07-11 20:41:21 +0000288
Daniel Jasperf7935112012-12-03 18:12:45 +0000289 return LLVMStyle;
290}
291
292FormatStyle getGoogleStyle() {
293 FormatStyle GoogleStyle;
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000294 GoogleStyle.Language = FormatStyle::LK_Cpp;
Daniel Jasperf7935112012-12-03 18:12:45 +0000295 GoogleStyle.AccessModifierOffset = -1;
Alexander Kornienkoc8602662013-05-06 14:11:27 +0000296 GoogleStyle.AlignEscapedNewlinesLeft = true;
Daniel Jasper552f4a72013-07-31 23:55:15 +0000297 GoogleStyle.AlignTrailingComments = true;
Daniel Jasperf7db4332013-01-29 16:03:49 +0000298 GoogleStyle.AllowAllParametersOfDeclarationOnNextLine = true;
Alexander Kornienko3cfa9732013-11-20 16:33:05 +0000299 GoogleStyle.AllowShortFunctionsOnASingleLine = true;
Daniel Jasper085a2ed2013-04-24 13:46:00 +0000300 GoogleStyle.AllowShortIfStatementsOnASingleLine = true;
Daniel Jasper5bd0b9e2013-05-23 18:05:18 +0000301 GoogleStyle.AllowShortLoopsOnASingleLine = true;
Alexander Kornienko58611712013-07-04 12:02:44 +0000302 GoogleStyle.AlwaysBreakBeforeMultilineStrings = true;
Daniel Jaspere33d4af2013-07-26 16:56:36 +0000303 GoogleStyle.AlwaysBreakTemplateDeclarations = true;
Alexander Kornienkoc8602662013-05-06 14:11:27 +0000304 GoogleStyle.BinPackParameters = true;
Daniel Jaspere33d4af2013-07-26 16:56:36 +0000305 GoogleStyle.BreakBeforeBinaryOperators = false;
Daniel Jasper165b29e2013-11-08 00:57:11 +0000306 GoogleStyle.BreakBeforeTernaryOperators = true;
Daniel Jaspere33d4af2013-07-26 16:56:36 +0000307 GoogleStyle.BreakBeforeBraces = FormatStyle::BS_Attach;
308 GoogleStyle.BreakConstructorInitializersBeforeComma = false;
Alexander Kornienkoc8602662013-05-06 14:11:27 +0000309 GoogleStyle.ColumnLimit = 80;
310 GoogleStyle.ConstructorInitializerAllOnOneLineOrOnePerLine = true;
Daniel Jaspercdaffa42013-08-13 10:58:30 +0000311 GoogleStyle.ConstructorInitializerIndentWidth = 4;
Daniel Jaspere33d4af2013-07-26 16:56:36 +0000312 GoogleStyle.Cpp11BracedListStyle = true;
Alexander Kornienkoc8602662013-05-06 14:11:27 +0000313 GoogleStyle.DerivePointerBinding = true;
Daniel Jasperb10cbc42013-07-10 14:02:49 +0000314 GoogleStyle.ExperimentalAutoDetectBinPacking = false;
Alexander Kornienkoc8602662013-05-06 14:11:27 +0000315 GoogleStyle.IndentCaseLabels = true;
Daniel Jaspere33d4af2013-07-26 16:56:36 +0000316 GoogleStyle.IndentFunctionDeclarationAfterType = true;
317 GoogleStyle.IndentWidth = 2;
Alexander Kornienkoebb43ca2013-09-05 14:08:34 +0000318 GoogleStyle.TabWidth = 8;
Alexander Kornienkoc8602662013-05-06 14:11:27 +0000319 GoogleStyle.MaxEmptyLinesToKeep = 1;
Daniel Jasper65ee3472013-07-31 23:16:02 +0000320 GoogleStyle.NamespaceIndentation = FormatStyle::NI_None;
Nico Webera6087752013-01-10 20:12:55 +0000321 GoogleStyle.ObjCSpaceBeforeProtocolList = false;
Alexander Kornienkoc8602662013-05-06 14:11:27 +0000322 GoogleStyle.PointerBindsToType = true;
323 GoogleStyle.SpacesBeforeTrailingComments = 2;
324 GoogleStyle.Standard = FormatStyle::LS_Auto;
Alexander Kornienko3c3d09c2013-09-27 16:14:22 +0000325 GoogleStyle.UseTab = FormatStyle::UT_Never;
Daniel Jasperb55acad2013-08-20 12:36:34 +0000326 GoogleStyle.SpacesInParentheses = false;
327 GoogleStyle.SpaceInEmptyParentheses = false;
328 GoogleStyle.SpacesInCStyleCastParentheses = false;
Alexander Kornienkofdca83d2013-12-10 10:18:34 +0000329 GoogleStyle.SpaceBeforeParens = FormatStyle::SBPO_ControlStatements;
Daniel Jasperd94bff32013-09-25 15:15:02 +0000330 GoogleStyle.SpaceBeforeAssignmentOperators = true;
Daniel Jasper6633ab82013-10-18 10:38:14 +0000331 GoogleStyle.ContinuationIndentWidth = 4;
Daniel Jasperdd978ae2013-10-29 14:52:02 +0000332 GoogleStyle.SpacesInAngles = false;
Daniel Jasper4e9678f2013-07-11 20:41:21 +0000333
334 setDefaultPenalties(GoogleStyle);
335 GoogleStyle.PenaltyReturnTypeOnItsOwnLine = 200;
Daniel Jasper33b909c2013-10-25 14:29:37 +0000336 GoogleStyle.PenaltyBreakBeforeFirstCallParameter = 1;
Daniel Jasper4e9678f2013-07-11 20:41:21 +0000337
Daniel Jasperf7935112012-12-03 18:12:45 +0000338 return GoogleStyle;
339}
340
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000341FormatStyle getGoogleJSStyle() {
342 FormatStyle GoogleJSStyle = getGoogleStyle();
343 GoogleJSStyle.Language = FormatStyle::LK_JavaScript;
344 GoogleJSStyle.BreakBeforeTernaryOperators = false;
345 // FIXME: Currently unimplemented:
346 // var arr = [1, 2, 3]; // No space after [ or before ].
347 // var obj = {a: 1, b: 2, c: 3}; // No space after ':'.
348 return GoogleJSStyle;
349}
350
Daniel Jasper1b750ed2013-01-14 16:24:39 +0000351FormatStyle getChromiumStyle() {
352 FormatStyle ChromiumStyle = getGoogleStyle();
Daniel Jasperf7db4332013-01-29 16:03:49 +0000353 ChromiumStyle.AllowAllParametersOfDeclarationOnNextLine = false;
Daniel Jasper085a2ed2013-04-24 13:46:00 +0000354 ChromiumStyle.AllowShortIfStatementsOnASingleLine = false;
Daniel Jasper3a685df2013-05-16 12:12:21 +0000355 ChromiumStyle.AllowShortLoopsOnASingleLine = false;
Daniel Jasper2cf17bf2013-02-27 09:47:53 +0000356 ChromiumStyle.BinPackParameters = false;
Daniel Jasper7fce3ab2013-02-06 14:22:40 +0000357 ChromiumStyle.DerivePointerBinding = false;
Daniel Jaspere33d4af2013-07-26 16:56:36 +0000358 ChromiumStyle.Standard = FormatStyle::LS_Cpp03;
Daniel Jasper1b750ed2013-01-14 16:24:39 +0000359 return ChromiumStyle;
360}
361
Alexander Kornienkoc8602662013-05-06 14:11:27 +0000362FormatStyle getMozillaStyle() {
363 FormatStyle MozillaStyle = getLLVMStyle();
364 MozillaStyle.AllowAllParametersOfDeclarationOnNextLine = false;
365 MozillaStyle.ConstructorInitializerAllOnOneLineOrOnePerLine = true;
366 MozillaStyle.DerivePointerBinding = true;
367 MozillaStyle.IndentCaseLabels = true;
368 MozillaStyle.ObjCSpaceBeforeProtocolList = false;
369 MozillaStyle.PenaltyReturnTypeOnItsOwnLine = 200;
370 MozillaStyle.PointerBindsToType = true;
371 return MozillaStyle;
372}
373
Daniel Jasperffefb3d2013-07-24 13:10:59 +0000374FormatStyle getWebKitStyle() {
375 FormatStyle Style = getLLVMStyle();
Daniel Jasper65ee3472013-07-31 23:16:02 +0000376 Style.AccessModifierOffset = -4;
Daniel Jasper552f4a72013-07-31 23:55:15 +0000377 Style.AlignTrailingComments = false;
Daniel Jaspere33d4af2013-07-26 16:56:36 +0000378 Style.BreakBeforeBinaryOperators = true;
Daniel Jasper65ee3472013-07-31 23:16:02 +0000379 Style.BreakBeforeBraces = FormatStyle::BS_Stroustrup;
Daniel Jaspere33d4af2013-07-26 16:56:36 +0000380 Style.BreakConstructorInitializersBeforeComma = true;
Daniel Jasper65ee3472013-07-31 23:16:02 +0000381 Style.ColumnLimit = 0;
Daniel Jaspere33d4af2013-07-26 16:56:36 +0000382 Style.IndentWidth = 4;
Daniel Jasper65ee3472013-07-31 23:16:02 +0000383 Style.NamespaceIndentation = FormatStyle::NI_Inner;
Daniel Jasperffefb3d2013-07-24 13:10:59 +0000384 Style.PointerBindsToType = true;
385 return Style;
386}
387
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000388bool getPredefinedStyle(StringRef Name, FormatStyle::LanguageKind Language,
389 FormatStyle *Style) {
390 if (Name.equals_lower("llvm")) {
Alexander Kornienko006b5c82013-05-19 00:53:30 +0000391 *Style = getLLVMStyle();
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000392 } else if (Name.equals_lower("chromium")) {
Alexander Kornienko006b5c82013-05-19 00:53:30 +0000393 *Style = getChromiumStyle();
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000394 } else if (Name.equals_lower("mozilla")) {
Alexander Kornienko006b5c82013-05-19 00:53:30 +0000395 *Style = getMozillaStyle();
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000396 } else if (Name.equals_lower("google")) {
397 *Style = Language == FormatStyle::LK_JavaScript ? getGoogleJSStyle()
398 : getGoogleStyle();
399 } else if (Name.equals_lower("webkit")) {
Daniel Jasperffefb3d2013-07-24 13:10:59 +0000400 *Style = getWebKitStyle();
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000401 } else {
Alexander Kornienko006b5c82013-05-19 00:53:30 +0000402 return false;
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000403 }
Alexander Kornienkod6538332013-05-07 15:32:14 +0000404
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000405 Style->Language = Language;
Alexander Kornienko006b5c82013-05-19 00:53:30 +0000406 return true;
Alexander Kornienkod6538332013-05-07 15:32:14 +0000407}
408
409llvm::error_code parseConfiguration(StringRef Text, FormatStyle *Style) {
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000410 assert(Style);
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000411 FormatStyle::LanguageKind Language = Style->Language;
412 assert(Language != FormatStyle::LK_None);
Alexander Kornienko06e00332013-05-20 15:18:01 +0000413 if (Text.trim().empty())
414 return llvm::make_error_code(llvm::errc::invalid_argument);
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000415
416 std::vector<FormatStyle> Styles;
Alexander Kornienkod6538332013-05-07 15:32:14 +0000417 llvm::yaml::Input Input(Text);
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000418 // DocumentListTraits<vector<FormatStyle>> uses the context to get default
419 // values for the fields, keys for which are missing from the configuration.
420 // Mapping also uses the context to get the language to find the correct
421 // base style.
422 Input.setContext(Style);
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000423 Input >> Styles;
424 if (Input.error())
425 return Input.error();
426
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000427 for (unsigned i = 0; i < Styles.size(); ++i) {
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000428 // Ensures that only the first configuration can skip the Language option.
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000429 if (Styles[i].Language == FormatStyle::LK_None && i != 0)
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000430 return llvm::make_error_code(llvm::errc::invalid_argument);
431 // Ensure that each language is configured at most once.
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000432 for (unsigned j = 0; j < i; ++j) {
433 if (Styles[i].Language == Styles[j].Language) {
434 DEBUG(llvm::dbgs()
435 << "Duplicate languages in the config file on positions " << j
436 << " and " << i << "\n");
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000437 return llvm::make_error_code(llvm::errc::invalid_argument);
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000438 }
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000439 }
440 }
441 // Look for a suitable configuration starting from the end, so we can
442 // find the configuration for the specific language first, and the default
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000443 // configuration (which can only be at slot 0) after it.
444 for (int i = Styles.size() - 1; i >= 0; --i) {
445 if (Styles[i].Language == Language ||
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000446 Styles[i].Language == FormatStyle::LK_None) {
447 *Style = Styles[i];
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000448 Style->Language = Language;
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000449 return llvm::make_error_code(llvm::errc::success);
450 }
451 }
452 return llvm::make_error_code(llvm::errc::not_supported);
Alexander Kornienkod6538332013-05-07 15:32:14 +0000453}
454
455std::string configurationAsText(const FormatStyle &Style) {
456 std::string Text;
457 llvm::raw_string_ostream Stream(Text);
458 llvm::yaml::Output Output(Stream);
459 // We use the same mapping method for input and output, so we need a non-const
460 // reference here.
461 FormatStyle NonConstStyle = Style;
462 Output << NonConstStyle;
Alexander Kornienko9a38ec22013-05-13 12:56:35 +0000463 return Stream.str();
Alexander Kornienkod6538332013-05-07 15:32:14 +0000464}
465
Craig Topperaf35e852013-06-30 22:29:28 +0000466namespace {
467
Daniel Jasperde0328a2013-08-16 11:20:30 +0000468class NoColumnLimitFormatter {
469public:
Daniel Jasperf110e202013-08-21 08:39:01 +0000470 NoColumnLimitFormatter(ContinuationIndenter *Indenter) : Indenter(Indenter) {}
Daniel Jasperde0328a2013-08-16 11:20:30 +0000471
472 /// \brief Formats the line starting at \p State, simply keeping all of the
473 /// input's line breaking decisions.
Alexander Kornienko31e95542013-12-04 12:21:08 +0000474 void format(unsigned FirstIndent, const AnnotatedLine *Line,
475 bool LineIsMerged) {
Daniel Jasper1c5d9df2013-09-06 07:54:20 +0000476 LineState State =
477 Indenter->getInitialState(FirstIndent, Line, /*DryRun=*/false);
Daniel Jasperde0328a2013-08-16 11:20:30 +0000478 while (State.NextToken != NULL) {
479 bool Newline =
Alexander Kornienko31e95542013-12-04 12:21:08 +0000480 (!LineIsMerged && Indenter->mustBreak(State)) ||
Daniel Jasperde0328a2013-08-16 11:20:30 +0000481 (Indenter->canBreak(State) && State.NextToken->NewlinesBefore > 0);
482 Indenter->addTokenToState(State, Newline, /*DryRun=*/false);
483 }
484 }
Daniel Jasperf110e202013-08-21 08:39:01 +0000485
Daniel Jasperde0328a2013-08-16 11:20:30 +0000486private:
487 ContinuationIndenter *Indenter;
488};
489
Daniel Jasper56f8b432013-11-06 23:12:09 +0000490class LineJoiner {
491public:
492 LineJoiner(const FormatStyle &Style) : Style(Style) {}
493
494 /// \brief Calculates how many lines can be merged into 1 starting at \p I.
495 unsigned
496 tryFitMultipleLinesInOne(unsigned Indent,
Alexander Kornienko3cfa9732013-11-20 16:33:05 +0000497 SmallVectorImpl<AnnotatedLine *>::const_iterator I,
Daniel Jasper56f8b432013-11-06 23:12:09 +0000498 SmallVectorImpl<AnnotatedLine *>::const_iterator E) {
499 // We can never merge stuff if there are trailing line comments.
500 AnnotatedLine *TheLine = *I;
501 if (TheLine->Last->Type == TT_LineComment)
502 return 0;
503
Alexander Kornienkoecc232d2013-12-04 13:25:26 +0000504 if (Style.ColumnLimit > 0 && Indent > Style.ColumnLimit)
505 return 0;
506
Daniel Jasper98fb6e12013-11-08 17:33:27 +0000507 unsigned Limit =
508 Style.ColumnLimit == 0 ? UINT_MAX : Style.ColumnLimit - Indent;
Daniel Jasper56f8b432013-11-06 23:12:09 +0000509 // If we already exceed the column limit, we set 'Limit' to 0. The different
510 // tryMerge..() functions can then decide whether to still do merging.
511 Limit = TheLine->Last->TotalLength > Limit
512 ? 0
513 : Limit - TheLine->Last->TotalLength;
514
Alexander Kornienkoc3021612013-11-19 14:30:44 +0000515 if (I + 1 == E || I[1]->Type == LT_Invalid)
Daniel Jasper56f8b432013-11-06 23:12:09 +0000516 return 0;
517
Alexander Kornienko3cfa9732013-11-20 16:33:05 +0000518 if (TheLine->Last->Type == TT_FunctionLBrace) {
519 return Style.AllowShortFunctionsOnASingleLine
520 ? tryMergeSimpleBlock(I, E, Limit)
521 : 0;
522 }
Daniel Jasper56f8b432013-11-06 23:12:09 +0000523 if (TheLine->Last->is(tok::l_brace)) {
Alexander Kornienko6d2c88e2013-12-10 10:30:34 +0000524 return Style.BreakBeforeBraces == FormatStyle::BS_Attach
Alexander Kornienko3cfa9732013-11-20 16:33:05 +0000525 ? tryMergeSimpleBlock(I, E, Limit)
526 : 0;
527 }
528 if (I[1]->First->Type == TT_FunctionLBrace &&
529 Style.BreakBeforeBraces != FormatStyle::BS_Attach) {
530 // Reduce the column limit by the number of spaces we need to insert
531 // around braces.
532 Limit = Limit > 3 ? Limit - 3 : 0;
533 unsigned MergedLines = 0;
534 if (Style.AllowShortFunctionsOnASingleLine) {
535 MergedLines = tryMergeSimpleBlock(I + 1, E, Limit);
536 // If we managed to merge the block, count the function header, which is
537 // on a separate line.
538 if (MergedLines > 0)
539 ++MergedLines;
540 }
541 return MergedLines;
542 }
543 if (TheLine->First->is(tok::kw_if)) {
544 return Style.AllowShortIfStatementsOnASingleLine
545 ? tryMergeSimpleControlStatement(I, E, Limit)
546 : 0;
547 }
548 if (TheLine->First->isOneOf(tok::kw_for, tok::kw_while)) {
549 return Style.AllowShortLoopsOnASingleLine
550 ? tryMergeSimpleControlStatement(I, E, Limit)
551 : 0;
552 }
553 if (TheLine->InPPDirective &&
554 (TheLine->First->HasUnescapedNewline || TheLine->First->IsFirst)) {
Daniel Jasper56f8b432013-11-06 23:12:09 +0000555 return tryMergeSimplePPDirective(I, E, Limit);
556 }
557 return 0;
558 }
559
560private:
561 unsigned
Alexander Kornienko3cfa9732013-11-20 16:33:05 +0000562 tryMergeSimplePPDirective(SmallVectorImpl<AnnotatedLine *>::const_iterator I,
Daniel Jasper56f8b432013-11-06 23:12:09 +0000563 SmallVectorImpl<AnnotatedLine *>::const_iterator E,
564 unsigned Limit) {
565 if (Limit == 0)
566 return 0;
Alexander Kornienkoc3021612013-11-19 14:30:44 +0000567 if (!I[1]->InPPDirective || I[1]->First->HasUnescapedNewline)
Daniel Jasper56f8b432013-11-06 23:12:09 +0000568 return 0;
Alexander Kornienkoc3021612013-11-19 14:30:44 +0000569 if (I + 2 != E && I[2]->InPPDirective && !I[2]->First->HasUnescapedNewline)
Daniel Jasper56f8b432013-11-06 23:12:09 +0000570 return 0;
Alexander Kornienkoc3021612013-11-19 14:30:44 +0000571 if (1 + I[1]->Last->TotalLength > Limit)
Daniel Jasper56f8b432013-11-06 23:12:09 +0000572 return 0;
573 return 1;
574 }
575
576 unsigned tryMergeSimpleControlStatement(
Alexander Kornienko3cfa9732013-11-20 16:33:05 +0000577 SmallVectorImpl<AnnotatedLine *>::const_iterator I,
Daniel Jasper56f8b432013-11-06 23:12:09 +0000578 SmallVectorImpl<AnnotatedLine *>::const_iterator E, unsigned Limit) {
579 if (Limit == 0)
580 return 0;
581 if (Style.BreakBeforeBraces == FormatStyle::BS_Allman &&
Alexander Kornienkoc3021612013-11-19 14:30:44 +0000582 I[1]->First->is(tok::l_brace))
Daniel Jasper56f8b432013-11-06 23:12:09 +0000583 return 0;
Alexander Kornienkoc3021612013-11-19 14:30:44 +0000584 if (I[1]->InPPDirective != (*I)->InPPDirective ||
585 (I[1]->InPPDirective && I[1]->First->HasUnescapedNewline))
Daniel Jasper56f8b432013-11-06 23:12:09 +0000586 return 0;
587 AnnotatedLine &Line = **I;
588 if (Line.Last->isNot(tok::r_paren))
589 return 0;
Alexander Kornienkoc3021612013-11-19 14:30:44 +0000590 if (1 + I[1]->Last->TotalLength > Limit)
Daniel Jasper56f8b432013-11-06 23:12:09 +0000591 return 0;
Alexander Kornienkoc3021612013-11-19 14:30:44 +0000592 if (I[1]->First->isOneOf(tok::semi, tok::kw_if, tok::kw_for,
Alexander Kornienko3cfa9732013-11-20 16:33:05 +0000593 tok::kw_while) ||
Alexander Kornienkoc3021612013-11-19 14:30:44 +0000594 I[1]->First->Type == TT_LineComment)
Daniel Jasper56f8b432013-11-06 23:12:09 +0000595 return 0;
596 // Only inline simple if's (no nested if or else).
597 if (I + 2 != E && Line.First->is(tok::kw_if) &&
Alexander Kornienkoc3021612013-11-19 14:30:44 +0000598 I[2]->First->is(tok::kw_else))
Daniel Jasper56f8b432013-11-06 23:12:09 +0000599 return 0;
600 return 1;
601 }
602
603 unsigned
Alexander Kornienko3cfa9732013-11-20 16:33:05 +0000604 tryMergeSimpleBlock(SmallVectorImpl<AnnotatedLine *>::const_iterator I,
Daniel Jasper56f8b432013-11-06 23:12:09 +0000605 SmallVectorImpl<AnnotatedLine *>::const_iterator E,
606 unsigned Limit) {
Daniel Jasper56f8b432013-11-06 23:12:09 +0000607 // First, check that the current line allows merging. This is the case if
608 // we're not in a control flow statement and the last token is an opening
609 // brace.
610 AnnotatedLine &Line = **I;
611 if (Line.First->isOneOf(tok::kw_if, tok::kw_while, tok::kw_do, tok::r_brace,
612 tok::kw_else, tok::kw_try, tok::kw_catch,
613 tok::kw_for,
614 // This gets rid of all ObjC @ keywords and methods.
615 tok::at, tok::minus, tok::plus))
616 return 0;
617
Alexander Kornienkoc3021612013-11-19 14:30:44 +0000618 FormatToken *Tok = I[1]->First;
Daniel Jasper56f8b432013-11-06 23:12:09 +0000619 if (Tok->is(tok::r_brace) && !Tok->MustBreakBefore &&
620 (Tok->getNextNonComment() == NULL ||
621 Tok->getNextNonComment()->is(tok::semi))) {
622 // We merge empty blocks even if the line exceeds the column limit.
623 Tok->SpacesRequiredBefore = 0;
624 Tok->CanBreakBefore = true;
625 return 1;
626 } else if (Limit != 0 && Line.First->isNot(tok::kw_namespace)) {
627 // Check that we still have three lines and they fit into the limit.
Alexander Kornienkoc3021612013-11-19 14:30:44 +0000628 if (I + 2 == E || I[2]->Type == LT_Invalid)
Daniel Jasper56f8b432013-11-06 23:12:09 +0000629 return 0;
630
631 if (!nextTwoLinesFitInto(I, Limit))
632 return 0;
633
634 // Second, check that the next line does not contain any braces - if it
635 // does, readability declines when putting it into a single line.
Alexander Kornienkoc3021612013-11-19 14:30:44 +0000636 if (I[1]->Last->Type == TT_LineComment || Tok->MustBreakBefore)
Daniel Jasper56f8b432013-11-06 23:12:09 +0000637 return 0;
638 do {
639 if (Tok->isOneOf(tok::l_brace, tok::r_brace))
640 return 0;
641 Tok = Tok->Next;
642 } while (Tok != NULL);
643
644 // Last, check that the third line contains a single closing brace.
Alexander Kornienkoc3021612013-11-19 14:30:44 +0000645 Tok = I[2]->First;
Daniel Jasper56f8b432013-11-06 23:12:09 +0000646 if (Tok->getNextNonComment() != NULL || Tok->isNot(tok::r_brace) ||
647 Tok->MustBreakBefore)
648 return 0;
649
650 return 2;
651 }
652 return 0;
653 }
654
655 bool nextTwoLinesFitInto(SmallVectorImpl<AnnotatedLine *>::const_iterator I,
656 unsigned Limit) {
Alexander Kornienkoc3021612013-11-19 14:30:44 +0000657 return 1 + I[1]->Last->TotalLength + 1 + I[2]->Last->TotalLength <= Limit;
Daniel Jasper56f8b432013-11-06 23:12:09 +0000658 }
659
660 const FormatStyle &Style;
661};
662
Daniel Jasperf7935112012-12-03 18:12:45 +0000663class UnwrappedLineFormatter {
664public:
Daniel Jasper5500f612013-11-25 11:08:59 +0000665 UnwrappedLineFormatter(ContinuationIndenter *Indenter,
Daniel Jasper9fe0e8d2013-09-05 09:29:45 +0000666 WhitespaceManager *Whitespaces,
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +0000667 const FormatStyle &Style)
Daniel Jasper5500f612013-11-25 11:08:59 +0000668 : Indenter(Indenter), Whitespaces(Whitespaces), Style(Style),
669 Joiner(Style) {}
Daniel Jasperf7935112012-12-03 18:12:45 +0000670
Daniel Jasper56f8b432013-11-06 23:12:09 +0000671 unsigned format(const SmallVectorImpl<AnnotatedLine *> &Lines, bool DryRun,
Daniel Jasper9c199562013-11-28 15:58:55 +0000672 int AdditionalIndent = 0, bool FixBadIndentation = false) {
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +0000673 assert(!Lines.empty());
674 unsigned Penalty = 0;
675 std::vector<int> IndentForLevel;
676 for (unsigned i = 0, e = Lines[0]->Level; i != e; ++i)
677 IndentForLevel.push_back(Style.IndentWidth * i + AdditionalIndent);
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +0000678 const AnnotatedLine *PreviousLine = NULL;
Daniel Jasper56f8b432013-11-06 23:12:09 +0000679 for (SmallVectorImpl<AnnotatedLine *>::const_iterator I = Lines.begin(),
680 E = Lines.end();
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +0000681 I != E; ++I) {
682 const AnnotatedLine &TheLine = **I;
683 const FormatToken *FirstTok = TheLine.First;
684 int Offset = getIndentOffset(*FirstTok);
685
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +0000686 // Determine indent and try to merge multiple unwrapped lines.
687 while (IndentForLevel.size() <= TheLine.Level)
688 IndentForLevel.push_back(-1);
689 IndentForLevel.resize(TheLine.Level + 1);
690 unsigned Indent = getIndent(IndentForLevel, TheLine.Level);
691 if (static_cast<int>(Indent) + Offset >= 0)
692 Indent += Offset;
Daniel Jasper56f8b432013-11-06 23:12:09 +0000693 unsigned MergedLines = Joiner.tryFitMultipleLinesInOne(Indent, I, E);
Alexander Kornienko31e95542013-12-04 12:21:08 +0000694 if (MergedLines > 0 && Style.ColumnLimit == 0) {
695 // Disallow line merging if there is a break at the start of one of the
696 // input lines.
697 for (unsigned i = 0; i < MergedLines; ++i) {
698 if (I[i + 1]->First->NewlinesBefore > 0)
699 MergedLines = 0;
700 }
701 }
Daniel Jasper56f8b432013-11-06 23:12:09 +0000702 if (!DryRun) {
703 for (unsigned i = 0; i < MergedLines; ++i) {
Alexander Kornienkoc3021612013-11-19 14:30:44 +0000704 join(*I[i], *I[i + 1]);
Daniel Jasper56f8b432013-11-06 23:12:09 +0000705 }
706 }
707 I += MergedLines;
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +0000708
Daniel Jasper9c199562013-11-28 15:58:55 +0000709 unsigned LevelIndent = getIndent(IndentForLevel, TheLine.Level);
710 bool FixIndentation =
711 FixBadIndentation && (LevelIndent != FirstTok->OriginalColumn);
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +0000712 if (TheLine.First->is(tok::eof)) {
Daniel Jasper5500f612013-11-25 11:08:59 +0000713 if (PreviousLine && PreviousLine->Affected && !DryRun) {
714 // Remove the file's trailing whitespace.
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +0000715 unsigned Newlines = std::min(FirstTok->NewlinesBefore, 1u);
716 Whitespaces->replaceWhitespace(*TheLine.First, Newlines,
717 /*IndentLevel=*/0, /*Spaces=*/0,
718 /*TargetColumn=*/0);
719 }
Daniel Jasper9c199562013-11-28 15:58:55 +0000720 } else if (TheLine.Type != LT_Invalid &&
721 (TheLine.Affected || FixIndentation)) {
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +0000722 if (FirstTok->WhitespaceRange.isValid()) {
723 if (!DryRun)
724 formatFirstToken(*TheLine.First, PreviousLine, TheLine.Level,
725 Indent, TheLine.InPPDirective);
726 } else {
727 Indent = LevelIndent = FirstTok->OriginalColumn;
728 }
729
730 // If everything fits on a single line, just put it there.
731 unsigned ColumnLimit = Style.ColumnLimit;
732 if (I + 1 != E) {
Alexander Kornienkoc3021612013-11-19 14:30:44 +0000733 AnnotatedLine *NextLine = I[1];
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +0000734 if (NextLine->InPPDirective && !NextLine->First->HasUnescapedNewline)
735 ColumnLimit = getColumnLimit(TheLine.InPPDirective);
736 }
737
738 if (TheLine.Last->TotalLength + Indent <= ColumnLimit) {
739 LineState State = Indenter->getInitialState(Indent, &TheLine, DryRun);
740 while (State.NextToken != NULL)
741 Indenter->addTokenToState(State, /*Newline=*/false, DryRun);
742 } else if (Style.ColumnLimit == 0) {
Daniel Jasper9c199562013-11-28 15:58:55 +0000743 // FIXME: Implement nested blocks for ColumnLimit = 0.
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +0000744 NoColumnLimitFormatter Formatter(Indenter);
745 if (!DryRun)
Alexander Kornienko31e95542013-12-04 12:21:08 +0000746 Formatter.format(Indent, &TheLine,
747 /*LineIsMerged=*/MergedLines > 0);
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +0000748 } else {
749 Penalty += format(TheLine, Indent, DryRun);
750 }
751
752 IndentForLevel[TheLine.Level] = LevelIndent;
Daniel Jasper9c199562013-11-28 15:58:55 +0000753 } else if (TheLine.ChildrenAffected) {
754 format(TheLine.Children, DryRun);
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +0000755 } else {
756 // Format the first token if necessary, and notify the WhitespaceManager
757 // about the unchanged whitespace.
758 for (FormatToken *Tok = TheLine.First; Tok != NULL; Tok = Tok->Next) {
759 if (Tok == TheLine.First &&
760 (Tok->NewlinesBefore > 0 || Tok->IsFirst)) {
761 unsigned LevelIndent = Tok->OriginalColumn;
762 if (!DryRun) {
Daniel Jasper9c199562013-11-28 15:58:55 +0000763 // Remove trailing whitespace of the previous line.
Daniel Jasper5500f612013-11-25 11:08:59 +0000764 if ((PreviousLine && PreviousLine->Affected) ||
765 TheLine.LeadingEmptyLinesAffected) {
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +0000766 formatFirstToken(*Tok, PreviousLine, TheLine.Level, LevelIndent,
767 TheLine.InPPDirective);
768 } else {
769 Whitespaces->addUntouchableToken(*Tok, TheLine.InPPDirective);
770 }
771 }
772
773 if (static_cast<int>(LevelIndent) - Offset >= 0)
774 LevelIndent -= Offset;
775 if (Tok->isNot(tok::comment))
776 IndentForLevel[TheLine.Level] = LevelIndent;
777 } else if (!DryRun) {
778 Whitespaces->addUntouchableToken(*Tok, TheLine.InPPDirective);
779 }
780 }
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +0000781 }
782 if (!DryRun) {
783 for (FormatToken *Tok = TheLine.First; Tok != NULL; Tok = Tok->Next) {
784 Tok->Finalized = true;
785 }
786 }
787 PreviousLine = *I;
788 }
789 return Penalty;
790 }
791
792private:
793 /// \brief Formats an \c AnnotatedLine and returns the penalty.
Daniel Jasper9fe0e8d2013-09-05 09:29:45 +0000794 ///
795 /// If \p DryRun is \c false, directly applies the changes.
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +0000796 unsigned format(const AnnotatedLine &Line, unsigned FirstIndent,
797 bool DryRun) {
Daniel Jasper1c5d9df2013-09-06 07:54:20 +0000798 LineState State = Indenter->getInitialState(FirstIndent, &Line, DryRun);
Daniel Jasper4b866272013-02-01 11:00:45 +0000799
Daniel Jasperacc33662013-02-08 08:22:00 +0000800 // If the ObjC method declaration does not fit on a line, we should format
801 // it with one arg per line.
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +0000802 if (State.Line->Type == LT_ObjCMethodDecl)
Daniel Jasperacc33662013-02-08 08:22:00 +0000803 State.Stack.back().BreakBeforeParameter = true;
804
Daniel Jasper4b866272013-02-01 11:00:45 +0000805 // Find best solution in solution space.
Daniel Jasper9fe0e8d2013-09-05 09:29:45 +0000806 return analyzeSolutionSpace(State, DryRun);
Daniel Jasperf7935112012-12-03 18:12:45 +0000807 }
808
Manuel Klimek2ef908e2013-02-13 10:46:36 +0000809 /// \brief An edge in the solution space from \c Previous->State to \c State,
810 /// inserting a newline dependent on the \c NewLine.
811 struct StateNode {
812 StateNode(const LineState &State, bool NewLine, StateNode *Previous)
Daniel Jasper12ef4e52013-02-21 21:33:55 +0000813 : State(State), NewLine(NewLine), Previous(Previous) {}
Manuel Klimek2ef908e2013-02-13 10:46:36 +0000814 LineState State;
815 bool NewLine;
816 StateNode *Previous;
817 };
Daniel Jasper4b866272013-02-01 11:00:45 +0000818
Manuel Klimek2ef908e2013-02-13 10:46:36 +0000819 /// \brief A pair of <penalty, count> that is used to prioritize the BFS on.
820 ///
821 /// In case of equal penalties, we want to prefer states that were inserted
822 /// first. During state generation we make sure that we insert states first
823 /// that break the line as late as possible.
824 typedef std::pair<unsigned, unsigned> OrderedPenalty;
825
826 /// \brief An item in the prioritized BFS search queue. The \c StateNode's
827 /// \c State has the given \c OrderedPenalty.
828 typedef std::pair<OrderedPenalty, StateNode *> QueueItem;
829
830 /// \brief The BFS queue type.
831 typedef std::priority_queue<QueueItem, std::vector<QueueItem>,
832 std::greater<QueueItem> > QueueType;
Daniel Jasper4b866272013-02-01 11:00:45 +0000833
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +0000834 /// \brief Get the offset of the line relatively to the level.
835 ///
836 /// For example, 'public:' labels in classes are offset by 1 or 2
837 /// characters to the left from their level.
838 int getIndentOffset(const FormatToken &RootToken) {
839 if (RootToken.isAccessSpecifier(false) || RootToken.isObjCAccessSpecifier())
840 return Style.AccessModifierOffset;
841 return 0;
842 }
843
844 /// \brief Add a new line and the required indent before the first Token
845 /// of the \c UnwrappedLine if there was no structural parsing error.
846 void formatFirstToken(FormatToken &RootToken,
847 const AnnotatedLine *PreviousLine, unsigned IndentLevel,
848 unsigned Indent, bool InPPDirective) {
849 unsigned Newlines =
850 std::min(RootToken.NewlinesBefore, Style.MaxEmptyLinesToKeep + 1);
851 // Remove empty lines before "}" where applicable.
852 if (RootToken.is(tok::r_brace) &&
853 (!RootToken.Next ||
854 (RootToken.Next->is(tok::semi) && !RootToken.Next->Next)))
855 Newlines = std::min(Newlines, 1u);
856 if (Newlines == 0 && !RootToken.IsFirst)
857 Newlines = 1;
858
859 // Insert extra new line before access specifiers.
860 if (PreviousLine && PreviousLine->Last->isOneOf(tok::semi, tok::r_brace) &&
861 RootToken.isAccessSpecifier() && RootToken.NewlinesBefore == 1)
862 ++Newlines;
863
864 // Remove empty lines after access specifiers.
865 if (PreviousLine && PreviousLine->First->isAccessSpecifier())
866 Newlines = std::min(1u, Newlines);
867
Alexander Kornienko3cfa9732013-11-20 16:33:05 +0000868 Whitespaces->replaceWhitespace(RootToken, Newlines, IndentLevel, Indent,
869 Indent, InPPDirective &&
870 !RootToken.HasUnescapedNewline);
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +0000871 }
872
873 /// \brief Get the indent of \p Level from \p IndentForLevel.
874 ///
875 /// \p IndentForLevel must contain the indent for the level \c l
876 /// at \p IndentForLevel[l], or a value < 0 if the indent for
877 /// that level is unknown.
878 unsigned getIndent(const std::vector<int> IndentForLevel, unsigned Level) {
879 if (IndentForLevel[Level] != -1)
880 return IndentForLevel[Level];
881 if (Level == 0)
882 return 0;
883 return getIndent(IndentForLevel, Level - 1) + Style.IndentWidth;
884 }
885
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +0000886 void join(AnnotatedLine &A, const AnnotatedLine &B) {
887 assert(!A.Last->Next);
888 assert(!B.First->Previous);
Daniel Jasper5500f612013-11-25 11:08:59 +0000889 if (B.Affected)
890 A.Affected = true;
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +0000891 A.Last->Next = B.First;
892 B.First->Previous = A.Last;
Daniel Jasper98fb6e12013-11-08 17:33:27 +0000893 B.First->CanBreakBefore = true;
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +0000894 unsigned LengthA = A.Last->TotalLength + B.First->SpacesRequiredBefore;
895 for (FormatToken *Tok = B.First; Tok; Tok = Tok->Next) {
896 Tok->TotalLength += LengthA;
897 A.Last = Tok;
898 }
899 }
900
901 unsigned getColumnLimit(bool InPPDirective) const {
902 // In preprocessor directives reserve two chars for trailing " \"
903 return Style.ColumnLimit - (InPPDirective ? 2 : 0);
904 }
905
Daniel Jasper4b866272013-02-01 11:00:45 +0000906 /// \brief Analyze the entire solution space starting from \p InitialState.
Daniel Jasperf7935112012-12-03 18:12:45 +0000907 ///
Daniel Jasper4b866272013-02-01 11:00:45 +0000908 /// This implements a variant of Dijkstra's algorithm on the graph that spans
909 /// the solution space (\c LineStates are the nodes). The algorithm tries to
910 /// find the shortest path (the one with lowest penalty) from \p InitialState
Daniel Jasper9fe0e8d2013-09-05 09:29:45 +0000911 /// to a state where all tokens are placed. Returns the penalty.
912 ///
913 /// If \p DryRun is \c false, directly applies the changes.
914 unsigned analyzeSolutionSpace(LineState &InitialState, bool DryRun = false) {
Manuel Klimek2ef908e2013-02-13 10:46:36 +0000915 std::set<LineState> Seen;
916
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +0000917 // Increasing count of \c StateNode items we have created. This is used to
918 // create a deterministic order independent of the container.
919 unsigned Count = 0;
920 QueueType Queue;
921
Daniel Jasper4b866272013-02-01 11:00:45 +0000922 // Insert start element into queue.
Daniel Jasper687af3b2013-02-14 14:26:07 +0000923 StateNode *Node =
Manuel Klimek2ef908e2013-02-13 10:46:36 +0000924 new (Allocator.Allocate()) StateNode(InitialState, false, NULL);
925 Queue.push(QueueItem(OrderedPenalty(0, Count), Node));
926 ++Count;
Daniel Jasper4b866272013-02-01 11:00:45 +0000927
Daniel Jasper9fe0e8d2013-09-05 09:29:45 +0000928 unsigned Penalty = 0;
929
Daniel Jasper4b866272013-02-01 11:00:45 +0000930 // While not empty, take first element and follow edges.
931 while (!Queue.empty()) {
Daniel Jasper9fe0e8d2013-09-05 09:29:45 +0000932 Penalty = Queue.top().first.first;
Daniel Jasper687af3b2013-02-14 14:26:07 +0000933 StateNode *Node = Queue.top().second;
Manuel Klimek2ef908e2013-02-13 10:46:36 +0000934 if (Node->State.NextToken == NULL) {
Alexander Kornienko49149672013-05-10 11:56:10 +0000935 DEBUG(llvm::dbgs() << "\n---\nPenalty for line: " << Penalty << "\n");
Daniel Jasper4b866272013-02-01 11:00:45 +0000936 break;
Daniel Jasper3a9370c2013-02-04 07:21:18 +0000937 }
Manuel Klimek2ef908e2013-02-13 10:46:36 +0000938 Queue.pop();
Daniel Jasper4b866272013-02-01 11:00:45 +0000939
Daniel Jasperf8114cf2013-05-22 05:27:42 +0000940 // Cut off the analysis of certain solutions if the analysis gets too
941 // complex. See description of IgnoreStackForComparison.
942 if (Count > 10000)
943 Node->State.IgnoreStackForComparison = true;
944
Manuel Klimek2ef908e2013-02-13 10:46:36 +0000945 if (!Seen.insert(Node->State).second)
946 // State already examined with lower penalty.
947 continue;
Daniel Jasper4b866272013-02-01 11:00:45 +0000948
Manuel Klimek71814b42013-10-11 21:25:45 +0000949 FormatDecision LastFormat = Node->State.NextToken->Decision;
950 if (LastFormat == FD_Unformatted || LastFormat == FD_Continue)
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +0000951 addNextStateToQueue(Penalty, Node, /*NewLine=*/false, &Count, &Queue);
Manuel Klimek71814b42013-10-11 21:25:45 +0000952 if (LastFormat == FD_Unformatted || LastFormat == FD_Break)
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +0000953 addNextStateToQueue(Penalty, Node, /*NewLine=*/true, &Count, &Queue);
Daniel Jasper4b866272013-02-01 11:00:45 +0000954 }
955
Manuel Klimek71814b42013-10-11 21:25:45 +0000956 if (Queue.empty()) {
Daniel Jasper4b866272013-02-01 11:00:45 +0000957 // We were unable to find a solution, do nothing.
958 // FIXME: Add diagnostic?
Manuel Klimek71814b42013-10-11 21:25:45 +0000959 DEBUG(llvm::dbgs() << "Could not find a solution.\n");
Daniel Jasper9fe0e8d2013-09-05 09:29:45 +0000960 return 0;
Manuel Klimek71814b42013-10-11 21:25:45 +0000961 }
Daniel Jasperf7935112012-12-03 18:12:45 +0000962
Daniel Jasper4b866272013-02-01 11:00:45 +0000963 // Reconstruct the solution.
Daniel Jasper9fe0e8d2013-09-05 09:29:45 +0000964 if (!DryRun)
965 reconstructPath(InitialState, Queue.top().second);
966
Alexander Kornienko49149672013-05-10 11:56:10 +0000967 DEBUG(llvm::dbgs() << "Total number of analyzed states: " << Count << "\n");
968 DEBUG(llvm::dbgs() << "---\n");
Daniel Jasper9fe0e8d2013-09-05 09:29:45 +0000969
970 return Penalty;
Manuel Klimek2ef908e2013-02-13 10:46:36 +0000971 }
972
973 void reconstructPath(LineState &State, StateNode *Current) {
Manuel Klimek4c5c28b2013-05-29 15:10:11 +0000974 std::deque<StateNode *> Path;
975 // We do not need a break before the initial token.
976 while (Current->Previous) {
977 Path.push_front(Current);
978 Current = Current->Previous;
979 }
980 for (std::deque<StateNode *>::iterator I = Path.begin(), E = Path.end();
981 I != E; ++I) {
Daniel Jasper9fe0e8d2013-09-05 09:29:45 +0000982 unsigned Penalty = 0;
983 formatChildren(State, (*I)->NewLine, /*DryRun=*/false, Penalty);
984 Penalty += Indenter->addTokenToState(State, (*I)->NewLine, false);
985
Manuel Klimek4c5c28b2013-05-29 15:10:11 +0000986 DEBUG({
987 if ((*I)->NewLine) {
Daniel Jasper8de9ed02013-08-22 15:00:41 +0000988 llvm::dbgs() << "Penalty for placing "
Manuel Klimek4c5c28b2013-05-29 15:10:11 +0000989 << (*I)->Previous->State.NextToken->Tok.getName() << ": "
Daniel Jasper8de9ed02013-08-22 15:00:41 +0000990 << Penalty << "\n";
Manuel Klimek4c5c28b2013-05-29 15:10:11 +0000991 }
992 });
Manuel Klimek4c5c28b2013-05-29 15:10:11 +0000993 }
Daniel Jasper4b866272013-02-01 11:00:45 +0000994 }
995
Manuel Klimekaf491072013-02-13 10:54:19 +0000996 /// \brief Add the following state to the analysis queue \c Queue.
Daniel Jasper4b866272013-02-01 11:00:45 +0000997 ///
Manuel Klimekaf491072013-02-13 10:54:19 +0000998 /// Assume the current state is \p PreviousNode and has been reached with a
Daniel Jasper4b866272013-02-01 11:00:45 +0000999 /// penalty of \p Penalty. Insert a line break if \p NewLine is \c true.
Manuel Klimekaf491072013-02-13 10:54:19 +00001000 void addNextStateToQueue(unsigned Penalty, StateNode *PreviousNode,
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +00001001 bool NewLine, unsigned *Count, QueueType *Queue) {
Daniel Jasperde0328a2013-08-16 11:20:30 +00001002 if (NewLine && !Indenter->canBreak(PreviousNode->State))
Daniel Jasper4b866272013-02-01 11:00:45 +00001003 return;
Daniel Jasperde0328a2013-08-16 11:20:30 +00001004 if (!NewLine && Indenter->mustBreak(PreviousNode->State))
Daniel Jasper4b866272013-02-01 11:00:45 +00001005 return;
Manuel Klimek2ef908e2013-02-13 10:46:36 +00001006
1007 StateNode *Node = new (Allocator.Allocate())
1008 StateNode(PreviousNode->State, NewLine, PreviousNode);
Daniel Jasper9fe0e8d2013-09-05 09:29:45 +00001009 if (!formatChildren(Node->State, NewLine, /*DryRun=*/true, Penalty))
1010 return;
1011
Daniel Jasperde0328a2013-08-16 11:20:30 +00001012 Penalty += Indenter->addTokenToState(Node->State, NewLine, true);
Manuel Klimek2ef908e2013-02-13 10:46:36 +00001013
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +00001014 Queue->push(QueueItem(OrderedPenalty(Penalty, *Count), Node));
1015 ++(*Count);
Daniel Jasper4b866272013-02-01 11:00:45 +00001016 }
Daniel Jasperf7935112012-12-03 18:12:45 +00001017
Daniel Jasperf3a5d002013-09-05 10:48:50 +00001018 /// \brief If the \p State's next token is an r_brace closing a nested block,
1019 /// format the nested block before it.
Daniel Jasper9fe0e8d2013-09-05 09:29:45 +00001020 ///
1021 /// Returns \c true if all children could be placed successfully and adapts
1022 /// \p Penalty as well as \p State. If \p DryRun is false, also directly
1023 /// creates changes using \c Whitespaces.
1024 ///
1025 /// The crucial idea here is that children always get formatted upon
1026 /// encountering the closing brace right after the nested block. Now, if we
1027 /// are currently trying to keep the "}" on the same line (i.e. \p NewLine is
1028 /// \c false), the entire block has to be kept on the same line (which is only
1029 /// possible if it fits on the line, only contains a single statement, etc.
1030 ///
1031 /// If \p NewLine is true, we format the nested block on separate lines, i.e.
1032 /// break after the "{", format all lines with correct indentation and the put
1033 /// the closing "}" on yet another new line.
1034 ///
1035 /// This enables us to keep the simple structure of the
1036 /// \c UnwrappedLineFormatter, where we only have two options for each token:
1037 /// break or don't break.
1038 bool formatChildren(LineState &State, bool NewLine, bool DryRun,
1039 unsigned &Penalty) {
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +00001040 FormatToken &Previous = *State.NextToken->Previous;
Daniel Jasperdcd5da12013-10-20 17:28:32 +00001041 const FormatToken *LBrace = State.NextToken->getPreviousNonComment();
1042 if (!LBrace || LBrace->isNot(tok::l_brace) ||
1043 LBrace->BlockKind != BK_Block || Previous.Children.size() == 0)
Daniel Jasperf3a5d002013-09-05 10:48:50 +00001044 // The previous token does not open a block. Nothing to do. We don't
1045 // assert so that we can simply call this function for all tokens.
Daniel Jasper36c28ce2013-09-06 08:54:24 +00001046 return true;
Daniel Jasper9fe0e8d2013-09-05 09:29:45 +00001047
1048 if (NewLine) {
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +00001049 int AdditionalIndent = State.Stack.back().Indent -
1050 Previous.Children[0]->Level * Style.IndentWidth;
Daniel Jasper9c199562013-11-28 15:58:55 +00001051 Penalty += format(Previous.Children, DryRun, AdditionalIndent,
1052 /*FixBadIndentation=*/true);
Daniel Jasper9fe0e8d2013-09-05 09:29:45 +00001053 return true;
1054 }
1055
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +00001056 // Cannot merge multiple statements into a single line.
Daniel Jasperdcd5da12013-10-20 17:28:32 +00001057 if (Previous.Children.size() > 1)
Alexander Kornienko3cfa9732013-11-20 16:33:05 +00001058 return false;
Daniel Jasper9fe0e8d2013-09-05 09:29:45 +00001059
1060 // We can't put the closing "}" on a line with a trailing comment.
Daniel Jasperdcd5da12013-10-20 17:28:32 +00001061 if (Previous.Children[0]->Last->isTrailingComment())
Daniel Jasper9fe0e8d2013-09-05 09:29:45 +00001062 return false;
1063
1064 if (!DryRun) {
Alexander Kornienko3c3d09c2013-09-27 16:14:22 +00001065 Whitespaces->replaceWhitespace(
Daniel Jasperdcd5da12013-10-20 17:28:32 +00001066 *Previous.Children[0]->First,
Alexander Kornienkoe2e03872013-10-14 00:46:35 +00001067 /*Newlines=*/0, /*IndentLevel=*/0, /*Spaces=*/1,
Alexander Kornienko3c3d09c2013-09-27 16:14:22 +00001068 /*StartOfTokenColumn=*/State.Column, State.Line->InPPDirective);
Daniel Jasper9fe0e8d2013-09-05 09:29:45 +00001069 }
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +00001070 Penalty += format(*Previous.Children[0], State.Column + 1, DryRun);
Daniel Jasper9fe0e8d2013-09-05 09:29:45 +00001071
Daniel Jasperdcd5da12013-10-20 17:28:32 +00001072 State.Column += 1 + Previous.Children[0]->Last->TotalLength;
Daniel Jasper9fe0e8d2013-09-05 09:29:45 +00001073 return true;
1074 }
1075
Daniel Jasperde0328a2013-08-16 11:20:30 +00001076 ContinuationIndenter *Indenter;
Daniel Jasper9fe0e8d2013-09-05 09:29:45 +00001077 WhitespaceManager *Whitespaces;
Daniel Jasperf7935112012-12-03 18:12:45 +00001078 FormatStyle Style;
Daniel Jasper56f8b432013-11-06 23:12:09 +00001079 LineJoiner Joiner;
Manuel Klimekaf491072013-02-13 10:54:19 +00001080
1081 llvm::SpecificBumpPtrAllocator<StateNode> Allocator;
Daniel Jasperf7935112012-12-03 18:12:45 +00001082};
1083
Manuel Klimek15dfe7a2013-05-28 11:55:06 +00001084class FormatTokenLexer {
Alexander Kornienkoe3276842012-12-07 16:15:44 +00001085public:
Manuel Klimek31c85922013-08-29 15:21:40 +00001086 FormatTokenLexer(Lexer &Lex, SourceManager &SourceMgr, FormatStyle &Style,
Alexander Kornienkoffcc0102013-06-05 14:09:10 +00001087 encoding::Encoding Encoding)
Alexander Kornienko393e3082013-11-13 14:04:17 +00001088 : FormatTok(NULL), IsFirstToken(true), GreaterStashed(false), Column(0),
Manuel Klimek31c85922013-08-29 15:21:40 +00001089 TrailingWhitespace(0), Lex(Lex), SourceMgr(SourceMgr), Style(Style),
1090 IdentTable(getFormattingLangOpts()), Encoding(Encoding) {
Alexander Kornienkoe3276842012-12-07 16:15:44 +00001091 Lex.SetKeepWhitespaceMode(true);
1092 }
1093
Manuel Klimek15dfe7a2013-05-28 11:55:06 +00001094 ArrayRef<FormatToken *> lex() {
1095 assert(Tokens.empty());
1096 do {
1097 Tokens.push_back(getNextToken());
Alexander Kornienko9aa62402013-11-21 12:43:57 +00001098 tryMergePreviousTokens();
Manuel Klimek15dfe7a2013-05-28 11:55:06 +00001099 } while (Tokens.back()->Tok.isNot(tok::eof));
1100 return Tokens;
1101 }
1102
1103 IdentifierTable &getIdentTable() { return IdentTable; }
1104
1105private:
Alexander Kornienko9aa62402013-11-21 12:43:57 +00001106 void tryMergePreviousTokens() {
Alexander Kornienkocabdd732013-11-29 15:19:43 +00001107 if (tryMerge_TMacro())
1108 return;
1109
1110 if (Style.Language == FormatStyle::LK_JavaScript) {
1111 static tok::TokenKind JSIdentity[] = { tok::equalequal, tok::equal };
1112 static tok::TokenKind JSNotIdentity[] = { tok::exclaimequal, tok::equal };
1113 static tok::TokenKind JSShiftEqual[] = { tok::greater, tok::greater,
1114 tok::greaterequal };
1115 // FIXME: We probably need to change token type to mimic operator with the
1116 // correct priority.
1117 if (tryMergeTokens(JSIdentity))
1118 return;
1119 if (tryMergeTokens(JSNotIdentity))
1120 return;
1121 if (tryMergeTokens(JSShiftEqual))
1122 return;
1123 }
Alexander Kornienko9aa62402013-11-21 12:43:57 +00001124 }
1125
Alexander Kornienkocabdd732013-11-29 15:19:43 +00001126 bool tryMergeTokens(ArrayRef<tok::TokenKind> Kinds) {
1127 if (Tokens.size() < Kinds.size())
Alexander Kornienko9aa62402013-11-21 12:43:57 +00001128 return false;
Alexander Kornienkocabdd732013-11-29 15:19:43 +00001129
1130 SmallVectorImpl<FormatToken *>::const_iterator First =
1131 Tokens.end() - Kinds.size();
1132 if (!First[0]->is(Kinds[0]))
Alexander Kornienko9aa62402013-11-21 12:43:57 +00001133 return false;
Alexander Kornienkocabdd732013-11-29 15:19:43 +00001134 unsigned AddLength = 0;
1135 for (unsigned i = 1; i < Kinds.size(); ++i) {
1136 if (!First[i]->is(Kinds[i]) || First[i]->WhitespaceRange.getBegin() !=
1137 First[i]->WhitespaceRange.getEnd())
1138 return false;
1139 AddLength += First[i]->TokenText.size();
1140 }
1141 Tokens.resize(Tokens.size() - Kinds.size() + 1);
1142 First[0]->TokenText = StringRef(First[0]->TokenText.data(),
1143 First[0]->TokenText.size() + AddLength);
1144 First[0]->ColumnWidth += AddLength;
Alexander Kornienko9aa62402013-11-21 12:43:57 +00001145 return true;
1146 }
1147
1148 bool tryMerge_TMacro() {
Alexander Kornienko81e32942013-09-16 20:20:49 +00001149 if (Tokens.size() < 4)
Alexander Kornienko9aa62402013-11-21 12:43:57 +00001150 return false;
Alexander Kornienko81e32942013-09-16 20:20:49 +00001151 FormatToken *Last = Tokens.back();
1152 if (!Last->is(tok::r_paren))
Alexander Kornienko9aa62402013-11-21 12:43:57 +00001153 return false;
Alexander Kornienko81e32942013-09-16 20:20:49 +00001154
1155 FormatToken *String = Tokens[Tokens.size() - 2];
1156 if (!String->is(tok::string_literal) || String->IsMultiline)
Alexander Kornienko9aa62402013-11-21 12:43:57 +00001157 return false;
Alexander Kornienko81e32942013-09-16 20:20:49 +00001158
1159 if (!Tokens[Tokens.size() - 3]->is(tok::l_paren))
Alexander Kornienko9aa62402013-11-21 12:43:57 +00001160 return false;
Alexander Kornienko81e32942013-09-16 20:20:49 +00001161
1162 FormatToken *Macro = Tokens[Tokens.size() - 4];
1163 if (Macro->TokenText != "_T")
Alexander Kornienko9aa62402013-11-21 12:43:57 +00001164 return false;
Alexander Kornienko81e32942013-09-16 20:20:49 +00001165
1166 const char *Start = Macro->TokenText.data();
1167 const char *End = Last->TokenText.data() + Last->TokenText.size();
1168 String->TokenText = StringRef(Start, End - Start);
1169 String->IsFirst = Macro->IsFirst;
1170 String->LastNewlineOffset = Macro->LastNewlineOffset;
1171 String->WhitespaceRange = Macro->WhitespaceRange;
1172 String->OriginalColumn = Macro->OriginalColumn;
1173 String->ColumnWidth = encoding::columnWidthWithTabs(
1174 String->TokenText, String->OriginalColumn, Style.TabWidth, Encoding);
1175
1176 Tokens.pop_back();
1177 Tokens.pop_back();
1178 Tokens.pop_back();
1179 Tokens.back() = String;
Alexander Kornienko9aa62402013-11-21 12:43:57 +00001180 return true;
Alexander Kornienko81e32942013-09-16 20:20:49 +00001181 }
1182
Manuel Klimek15dfe7a2013-05-28 11:55:06 +00001183 FormatToken *getNextToken() {
Alexander Kornienkoe3276842012-12-07 16:15:44 +00001184 if (GreaterStashed) {
Manuel Klimek591ab5a2013-05-28 13:42:28 +00001185 // Create a synthesized second '>' token.
Manuel Klimek31c85922013-08-29 15:21:40 +00001186 // FIXME: Increment Column and set OriginalColumn.
Manuel Klimek591ab5a2013-05-28 13:42:28 +00001187 Token Greater = FormatTok->Tok;
1188 FormatTok = new (Allocator.Allocate()) FormatToken;
1189 FormatTok->Tok = Greater;
Manuel Klimek5c24cca2013-05-23 10:56:37 +00001190 SourceLocation GreaterLocation =
Manuel Klimek15dfe7a2013-05-28 11:55:06 +00001191 FormatTok->Tok.getLocation().getLocWithOffset(1);
1192 FormatTok->WhitespaceRange =
1193 SourceRange(GreaterLocation, GreaterLocation);
Alexander Kornienkoee4ca9b2013-06-07 17:45:07 +00001194 FormatTok->TokenText = ">";
Alexander Kornienko39856b72013-09-10 09:38:25 +00001195 FormatTok->ColumnWidth = 1;
Alexander Kornienkoe3276842012-12-07 16:15:44 +00001196 GreaterStashed = false;
1197 return FormatTok;
1198 }
1199
Manuel Klimek15dfe7a2013-05-28 11:55:06 +00001200 FormatTok = new (Allocator.Allocate()) FormatToken;
Daniel Jasper8369aa52013-07-16 20:28:33 +00001201 readRawToken(*FormatTok);
Manuel Klimek9043c742013-05-27 15:23:34 +00001202 SourceLocation WhitespaceStart =
Manuel Klimek15dfe7a2013-05-28 11:55:06 +00001203 FormatTok->Tok.getLocation().getLocWithOffset(-TrailingWhitespace);
Alexander Kornienko393e3082013-11-13 14:04:17 +00001204 FormatTok->IsFirst = IsFirstToken;
1205 IsFirstToken = false;
Alexander Kornienkoe3276842012-12-07 16:15:44 +00001206
1207 // Consume and record whitespace until we find a significant token.
Manuel Klimek9043c742013-05-27 15:23:34 +00001208 unsigned WhitespaceLength = TrailingWhitespace;
Manuel Klimek15dfe7a2013-05-28 11:55:06 +00001209 while (FormatTok->Tok.is(tok::unknown)) {
Manuel Klimek31c85922013-08-29 15:21:40 +00001210 for (int i = 0, e = FormatTok->TokenText.size(); i != e; ++i) {
1211 switch (FormatTok->TokenText[i]) {
1212 case '\n':
1213 ++FormatTok->NewlinesBefore;
1214 // FIXME: This is technically incorrect, as it could also
1215 // be a literal backslash at the end of the line.
Alexander Kornienko9e649af2013-09-11 12:25:57 +00001216 if (i == 0 || (FormatTok->TokenText[i - 1] != '\\' &&
1217 (FormatTok->TokenText[i - 1] != '\r' || i == 1 ||
1218 FormatTok->TokenText[i - 2] != '\\')))
Manuel Klimek31c85922013-08-29 15:21:40 +00001219 FormatTok->HasUnescapedNewline = true;
1220 FormatTok->LastNewlineOffset = WhitespaceLength + i + 1;
1221 Column = 0;
1222 break;
Daniel Jasper877615c2013-10-11 19:45:02 +00001223 case '\r':
1224 case '\f':
1225 case '\v':
1226 Column = 0;
1227 break;
Manuel Klimek31c85922013-08-29 15:21:40 +00001228 case ' ':
1229 ++Column;
1230 break;
1231 case '\t':
Alexander Kornienkoebb43ca2013-09-05 14:08:34 +00001232 Column += Style.TabWidth - Column % Style.TabWidth;
Manuel Klimek31c85922013-08-29 15:21:40 +00001233 break;
Daniel Jasper877615c2013-10-11 19:45:02 +00001234 case '\\':
1235 ++Column;
1236 if (i + 1 == e || (FormatTok->TokenText[i + 1] != '\r' &&
1237 FormatTok->TokenText[i + 1] != '\n'))
1238 FormatTok->Type = TT_ImplicitStringLiteral;
1239 break;
Manuel Klimek31c85922013-08-29 15:21:40 +00001240 default:
Daniel Jasper877615c2013-10-11 19:45:02 +00001241 FormatTok->Type = TT_ImplicitStringLiteral;
Manuel Klimek31c85922013-08-29 15:21:40 +00001242 ++Column;
1243 break;
1244 }
1245 }
1246
Daniel Jasper877615c2013-10-11 19:45:02 +00001247 if (FormatTok->Type == TT_ImplicitStringLiteral)
1248 break;
Manuel Klimek15dfe7a2013-05-28 11:55:06 +00001249 WhitespaceLength += FormatTok->Tok.getLength();
Alexander Kornienkoe3276842012-12-07 16:15:44 +00001250
Daniel Jasper8369aa52013-07-16 20:28:33 +00001251 readRawToken(*FormatTok);
Manuel Klimek1abf7892013-01-04 23:34:14 +00001252 }
Manuel Klimekef920692013-01-07 07:56:50 +00001253
Manuel Klimek1abf7892013-01-04 23:34:14 +00001254 // In case the token starts with escaped newlines, we want to
1255 // take them into account as whitespace - this pattern is quite frequent
1256 // in macro definitions.
Manuel Klimek1abf7892013-01-04 23:34:14 +00001257 // FIXME: Add a more explicit test.
Daniel Jasper8369aa52013-07-16 20:28:33 +00001258 while (FormatTok->TokenText.size() > 1 && FormatTok->TokenText[0] == '\\' &&
1259 FormatTok->TokenText[1] == '\n') {
Manuel Klimek15dfe7a2013-05-28 11:55:06 +00001260 // FIXME: ++FormatTok->NewlinesBefore is missing...
Manuel Klimek5c24cca2013-05-23 10:56:37 +00001261 WhitespaceLength += 2;
Manuel Klimek31c85922013-08-29 15:21:40 +00001262 Column = 0;
Daniel Jasper8369aa52013-07-16 20:28:33 +00001263 FormatTok->TokenText = FormatTok->TokenText.substr(2);
Alexander Kornienkoe3276842012-12-07 16:15:44 +00001264 }
Alexander Kornienko39856b72013-09-10 09:38:25 +00001265
1266 FormatTok->WhitespaceRange = SourceRange(
1267 WhitespaceStart, WhitespaceStart.getLocWithOffset(WhitespaceLength));
1268
Manuel Klimek31c85922013-08-29 15:21:40 +00001269 FormatTok->OriginalColumn = Column;
Alexander Kornienkoe3276842012-12-07 16:15:44 +00001270
Alexander Kornienkoee4ca9b2013-06-07 17:45:07 +00001271 TrailingWhitespace = 0;
1272 if (FormatTok->Tok.is(tok::comment)) {
Manuel Klimek31c85922013-08-29 15:21:40 +00001273 // FIXME: Add the trimmed whitespace to Column.
Daniel Jasper8369aa52013-07-16 20:28:33 +00001274 StringRef UntrimmedText = FormatTok->TokenText;
Alexander Kornienko9ab4a772013-09-06 17:24:54 +00001275 FormatTok->TokenText = FormatTok->TokenText.rtrim(" \t\v\f");
Daniel Jasper8369aa52013-07-16 20:28:33 +00001276 TrailingWhitespace = UntrimmedText.size() - FormatTok->TokenText.size();
Alexander Kornienkoee4ca9b2013-06-07 17:45:07 +00001277 } else if (FormatTok->Tok.is(tok::raw_identifier)) {
Daniel Jasper8369aa52013-07-16 20:28:33 +00001278 IdentifierInfo &Info = IdentTable.get(FormatTok->TokenText);
Manuel Klimek15dfe7a2013-05-28 11:55:06 +00001279 FormatTok->Tok.setIdentifierInfo(&Info);
1280 FormatTok->Tok.setKind(Info.getTokenID());
Alexander Kornienkoee4ca9b2013-06-07 17:45:07 +00001281 } else if (FormatTok->Tok.is(tok::greatergreater)) {
Manuel Klimek15dfe7a2013-05-28 11:55:06 +00001282 FormatTok->Tok.setKind(tok::greater);
Daniel Jasper8369aa52013-07-16 20:28:33 +00001283 FormatTok->TokenText = FormatTok->TokenText.substr(0, 1);
Alexander Kornienkoe3276842012-12-07 16:15:44 +00001284 GreaterStashed = true;
1285 }
1286
Alexander Kornienkoee4ca9b2013-06-07 17:45:07 +00001287 // Now FormatTok is the next non-whitespace token.
Alexander Kornienkoffcc0102013-06-05 14:09:10 +00001288
Alexander Kornienko39856b72013-09-10 09:38:25 +00001289 StringRef Text = FormatTok->TokenText;
1290 size_t FirstNewlinePos = Text.find('\n');
Alexander Kornienko917f9e02013-09-10 12:29:48 +00001291 if (FirstNewlinePos == StringRef::npos) {
1292 // FIXME: ColumnWidth actually depends on the start column, we need to
1293 // take this into account when the token is moved.
1294 FormatTok->ColumnWidth =
1295 encoding::columnWidthWithTabs(Text, Column, Style.TabWidth, Encoding);
1296 Column += FormatTok->ColumnWidth;
1297 } else {
Alexander Kornienko39856b72013-09-10 09:38:25 +00001298 FormatTok->IsMultiline = true;
Alexander Kornienko917f9e02013-09-10 12:29:48 +00001299 // FIXME: ColumnWidth actually depends on the start column, we need to
1300 // take this into account when the token is moved.
1301 FormatTok->ColumnWidth = encoding::columnWidthWithTabs(
1302 Text.substr(0, FirstNewlinePos), Column, Style.TabWidth, Encoding);
1303
Alexander Kornienko39856b72013-09-10 09:38:25 +00001304 // The last line of the token always starts in column 0.
1305 // Thus, the length can be precomputed even in the presence of tabs.
1306 FormatTok->LastLineColumnWidth = encoding::columnWidthWithTabs(
1307 Text.substr(Text.find_last_of('\n') + 1), 0, Style.TabWidth,
1308 Encoding);
Alexander Kornienko917f9e02013-09-10 12:29:48 +00001309 Column = FormatTok->LastLineColumnWidth;
Alexander Kornienko632abb92013-09-02 13:58:14 +00001310 }
Alexander Kornienko39856b72013-09-10 09:38:25 +00001311
Alexander Kornienkoe3276842012-12-07 16:15:44 +00001312 return FormatTok;
1313 }
1314
Manuel Klimek15dfe7a2013-05-28 11:55:06 +00001315 FormatToken *FormatTok;
Alexander Kornienko393e3082013-11-13 14:04:17 +00001316 bool IsFirstToken;
Alexander Kornienkoe3276842012-12-07 16:15:44 +00001317 bool GreaterStashed;
Manuel Klimek31c85922013-08-29 15:21:40 +00001318 unsigned Column;
Manuel Klimek9043c742013-05-27 15:23:34 +00001319 unsigned TrailingWhitespace;
Alexander Kornienkoe3276842012-12-07 16:15:44 +00001320 Lexer &Lex;
1321 SourceManager &SourceMgr;
Manuel Klimek31c85922013-08-29 15:21:40 +00001322 FormatStyle &Style;
Alexander Kornienkoe3276842012-12-07 16:15:44 +00001323 IdentifierTable IdentTable;
Alexander Kornienkoffcc0102013-06-05 14:09:10 +00001324 encoding::Encoding Encoding;
Manuel Klimek15dfe7a2013-05-28 11:55:06 +00001325 llvm::SpecificBumpPtrAllocator<FormatToken> Allocator;
1326 SmallVector<FormatToken *, 16> Tokens;
Alexander Kornienkoe3276842012-12-07 16:15:44 +00001327
Daniel Jasper8369aa52013-07-16 20:28:33 +00001328 void readRawToken(FormatToken &Tok) {
1329 Lex.LexFromRawLexer(Tok.Tok);
1330 Tok.TokenText = StringRef(SourceMgr.getCharacterData(Tok.Tok.getLocation()),
1331 Tok.Tok.getLength());
Daniel Jasper8369aa52013-07-16 20:28:33 +00001332 // For formatting, treat unterminated string literals like normal string
1333 // literals.
1334 if (Tok.is(tok::unknown) && !Tok.TokenText.empty() &&
1335 Tok.TokenText[0] == '"') {
1336 Tok.Tok.setKind(tok::string_literal);
1337 Tok.IsUnterminatedLiteral = true;
1338 }
Alexander Kornienkoe3276842012-12-07 16:15:44 +00001339 }
1340};
1341
Alexander Kornienkocabdd732013-11-29 15:19:43 +00001342static StringRef getLanguageName(FormatStyle::LanguageKind Language) {
1343 switch (Language) {
1344 case FormatStyle::LK_Cpp:
1345 return "C++";
1346 case FormatStyle::LK_JavaScript:
1347 return "JavaScript";
1348 default:
1349 return "Unknown";
1350 }
1351}
1352
Daniel Jasperf7935112012-12-03 18:12:45 +00001353class Formatter : public UnwrappedLineConsumer {
1354public:
Daniel Jasperd2ae41a2013-05-15 08:14:19 +00001355 Formatter(const FormatStyle &Style, Lexer &Lex, SourceManager &SourceMgr,
Daniel Jasperf7935112012-12-03 18:12:45 +00001356 const std::vector<CharSourceRange> &Ranges)
Daniel Jasperd2ae41a2013-05-15 08:14:19 +00001357 : Style(Style), Lex(Lex), SourceMgr(SourceMgr),
Alexander Kornienko9e649af2013-09-11 12:25:57 +00001358 Whitespaces(SourceMgr, Style, inputUsesCRLF(Lex.getBuffer())),
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +00001359 Ranges(Ranges.begin(), Ranges.end()), UnwrappedLines(1),
Manuel Klimek71814b42013-10-11 21:25:45 +00001360 Encoding(encoding::detectEncoding(Lex.getBuffer())) {
Daniel Jasperfa21c072013-07-15 14:33:14 +00001361 DEBUG(llvm::dbgs() << "File encoding: "
1362 << (Encoding == encoding::Encoding_UTF8 ? "UTF8"
1363 : "unknown")
1364 << "\n");
Alexander Kornienkocabdd732013-11-29 15:19:43 +00001365 DEBUG(llvm::dbgs() << "Language: " << getLanguageName(Style.Language)
1366 << "\n");
Alexander Kornienkoffcc0102013-06-05 14:09:10 +00001367 }
Daniel Jasperf7935112012-12-03 18:12:45 +00001368
Alexander Kornienko62b85b92013-03-13 14:41:29 +00001369 tooling::Replacements format() {
Manuel Klimek71814b42013-10-11 21:25:45 +00001370 tooling::Replacements Result;
Manuel Klimek31c85922013-08-29 15:21:40 +00001371 FormatTokenLexer Tokens(Lex, SourceMgr, Style, Encoding);
Manuel Klimek15dfe7a2013-05-28 11:55:06 +00001372
1373 UnwrappedLineParser Parser(Style, Tokens.lex(), *this);
Manuel Klimek1a18c402013-04-12 14:13:36 +00001374 bool StructuralError = Parser.parse();
Manuel Klimek71814b42013-10-11 21:25:45 +00001375 assert(UnwrappedLines.rbegin()->empty());
1376 for (unsigned Run = 0, RunE = UnwrappedLines.size(); Run + 1 != RunE;
1377 ++Run) {
1378 DEBUG(llvm::dbgs() << "Run " << Run << "...\n");
1379 SmallVector<AnnotatedLine *, 16> AnnotatedLines;
1380 for (unsigned i = 0, e = UnwrappedLines[Run].size(); i != e; ++i) {
1381 AnnotatedLines.push_back(new AnnotatedLine(UnwrappedLines[Run][i]));
1382 }
1383 tooling::Replacements RunResult =
1384 format(AnnotatedLines, StructuralError, Tokens);
1385 DEBUG({
1386 llvm::dbgs() << "Replacements for run " << Run << ":\n";
1387 for (tooling::Replacements::iterator I = RunResult.begin(),
1388 E = RunResult.end();
1389 I != E; ++I) {
1390 llvm::dbgs() << I->toString() << "\n";
1391 }
1392 });
1393 for (unsigned i = 0, e = AnnotatedLines.size(); i != e; ++i) {
1394 delete AnnotatedLines[i];
1395 }
1396 Result.insert(RunResult.begin(), RunResult.end());
1397 Whitespaces.reset();
1398 }
1399 return Result;
1400 }
1401
1402 tooling::Replacements format(SmallVectorImpl<AnnotatedLine *> &AnnotatedLines,
1403 bool StructuralError, FormatTokenLexer &Tokens) {
Alexander Kornienkoffcc0102013-06-05 14:09:10 +00001404 TokenAnnotator Annotator(Style, Tokens.getIdentTable().get("in"));
Alexander Kornienko62b85b92013-03-13 14:41:29 +00001405 for (unsigned i = 0, e = AnnotatedLines.size(); i != e; ++i) {
Daniel Jasper9fe0e8d2013-09-05 09:29:45 +00001406 Annotator.annotate(*AnnotatedLines[i]);
Alexander Kornienko62b85b92013-03-13 14:41:29 +00001407 }
Manuel Klimek71814b42013-10-11 21:25:45 +00001408 deriveLocalStyle(AnnotatedLines);
Alexander Kornienko62b85b92013-03-13 14:41:29 +00001409 for (unsigned i = 0, e = AnnotatedLines.size(); i != e; ++i) {
Daniel Jasper9fe0e8d2013-09-05 09:29:45 +00001410 Annotator.calculateFormattingInformation(*AnnotatedLines[i]);
Alexander Kornienko62b85b92013-03-13 14:41:29 +00001411 }
Daniel Jasper5500f612013-11-25 11:08:59 +00001412 computeAffectedLines(AnnotatedLines.begin(), AnnotatedLines.end());
Daniel Jasperb67cc422013-04-09 17:46:55 +00001413
Daniel Jasper1c5d9df2013-09-06 07:54:20 +00001414 Annotator.setCommentLineLevels(AnnotatedLines);
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +00001415 ContinuationIndenter Indenter(Style, SourceMgr, Whitespaces, Encoding,
1416 BinPackInconclusiveFunctions);
Daniel Jasper5500f612013-11-25 11:08:59 +00001417 UnwrappedLineFormatter Formatter(&Indenter, &Whitespaces, Style);
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +00001418 Formatter.format(AnnotatedLines, /*DryRun=*/false);
Alexander Kornienko62b85b92013-03-13 14:41:29 +00001419 return Whitespaces.generateReplacements();
1420 }
1421
1422private:
Daniel Jasper5500f612013-11-25 11:08:59 +00001423 // Determines which lines are affected by the SourceRanges given as input.
Daniel Jasper9c199562013-11-28 15:58:55 +00001424 // Returns \c true if at least one line between I and E or one of their
1425 // children is affected.
Daniel Jasper5500f612013-11-25 11:08:59 +00001426 bool computeAffectedLines(SmallVectorImpl<AnnotatedLine *>::iterator I,
1427 SmallVectorImpl<AnnotatedLine *>::iterator E) {
1428 bool SomeLineAffected = false;
Daniel Jasper38c82402013-11-29 09:27:43 +00001429 const AnnotatedLine *PreviousLine = NULL;
Daniel Jasper5500f612013-11-25 11:08:59 +00001430 while (I != E) {
1431 AnnotatedLine *Line = *I;
1432 Line->LeadingEmptyLinesAffected = affectsLeadingEmptyLines(*Line->First);
1433
1434 // If a line is part of a preprocessor directive, it needs to be formatted
1435 // if any token within the directive is affected.
1436 if (Line->InPPDirective) {
1437 FormatToken *Last = Line->Last;
1438 SmallVectorImpl<AnnotatedLine *>::iterator PPEnd = I + 1;
1439 while (PPEnd != E && !(*PPEnd)->First->HasUnescapedNewline) {
1440 Last = (*PPEnd)->Last;
1441 ++PPEnd;
1442 }
1443
1444 if (affectsTokenRange(*Line->First, *Last,
1445 /*IncludeLeadingNewlines=*/false)) {
1446 SomeLineAffected = true;
1447 markAllAsAffected(I, PPEnd);
1448 }
1449 I = PPEnd;
1450 continue;
1451 }
1452
Daniel Jasper38c82402013-11-29 09:27:43 +00001453 if (nonPPLineAffected(Line, PreviousLine))
Daniel Jasper5500f612013-11-25 11:08:59 +00001454 SomeLineAffected = true;
Daniel Jasper5500f612013-11-25 11:08:59 +00001455
Daniel Jasper38c82402013-11-29 09:27:43 +00001456 PreviousLine = Line;
Daniel Jasper5500f612013-11-25 11:08:59 +00001457 ++I;
1458 }
1459 return SomeLineAffected;
1460 }
1461
Daniel Jasper9c199562013-11-28 15:58:55 +00001462 // Determines whether 'Line' is affected by the SourceRanges given as input.
1463 // Returns \c true if line or one if its children is affected.
Daniel Jasper38c82402013-11-29 09:27:43 +00001464 bool nonPPLineAffected(AnnotatedLine *Line,
1465 const AnnotatedLine *PreviousLine) {
Daniel Jasper9c199562013-11-28 15:58:55 +00001466 bool SomeLineAffected = false;
1467 Line->ChildrenAffected =
1468 computeAffectedLines(Line->Children.begin(), Line->Children.end());
1469 if (Line->ChildrenAffected)
1470 SomeLineAffected = true;
1471
1472 // Stores whether one of the line's tokens is directly affected.
1473 bool SomeTokenAffected = false;
1474 // Stores whether we need to look at the leading newlines of the next token
1475 // in order to determine whether it was affected.
1476 bool IncludeLeadingNewlines = false;
1477
1478 // Stores whether the first child line of any of this line's tokens is
1479 // affected.
1480 bool SomeFirstChildAffected = false;
1481
1482 for (FormatToken *Tok = Line->First; Tok; Tok = Tok->Next) {
1483 // Determine whether 'Tok' was affected.
1484 if (affectsTokenRange(*Tok, *Tok, IncludeLeadingNewlines))
1485 SomeTokenAffected = true;
1486
1487 // Determine whether the first child of 'Tok' was affected.
1488 if (!Tok->Children.empty() && Tok->Children.front()->Affected)
1489 SomeFirstChildAffected = true;
1490
1491 IncludeLeadingNewlines = Tok->Children.empty();
1492 }
1493
1494 // Was this line moved, i.e. has it previously been on the same line as an
1495 // affected line?
Daniel Jasper38c82402013-11-29 09:27:43 +00001496 bool LineMoved = PreviousLine && PreviousLine->Affected &&
1497 Line->First->NewlinesBefore == 0;
Daniel Jasper9c199562013-11-28 15:58:55 +00001498
Daniel Jasper38c82402013-11-29 09:27:43 +00001499 bool IsContinuedComment = Line->First->is(tok::comment) &&
1500 Line->First->Next == NULL &&
1501 Line->First->NewlinesBefore < 2 && PreviousLine &&
Daniel Jasper0e81f1a2013-12-02 09:19:27 +00001502 PreviousLine->Affected &&
Daniel Jasper38c82402013-11-29 09:27:43 +00001503 PreviousLine->Last->is(tok::comment);
1504
1505 if (SomeTokenAffected || SomeFirstChildAffected || LineMoved ||
1506 IsContinuedComment) {
Daniel Jasper9c199562013-11-28 15:58:55 +00001507 Line->Affected = true;
Daniel Jasper9c199562013-11-28 15:58:55 +00001508 SomeLineAffected = true;
Daniel Jasper9c199562013-11-28 15:58:55 +00001509 }
1510 return SomeLineAffected;
1511 }
1512
Daniel Jasper5500f612013-11-25 11:08:59 +00001513 // Marks all lines between I and E as well as all their children as affected.
1514 void markAllAsAffected(SmallVectorImpl<AnnotatedLine *>::iterator I,
1515 SmallVectorImpl<AnnotatedLine *>::iterator E) {
1516 while (I != E) {
1517 (*I)->Affected = true;
1518 markAllAsAffected((*I)->Children.begin(), (*I)->Children.end());
1519 ++I;
1520 }
1521 }
1522
1523 // Returns true if the range from 'First' to 'Last' intersects with one of the
1524 // input ranges.
1525 bool affectsTokenRange(const FormatToken &First, const FormatToken &Last,
1526 bool IncludeLeadingNewlines) {
1527 SourceLocation Start = First.WhitespaceRange.getBegin();
1528 if (!IncludeLeadingNewlines)
1529 Start = Start.getLocWithOffset(First.LastNewlineOffset);
Daniel Jasper5877bf12013-11-25 11:53:05 +00001530 SourceLocation End = Last.getStartOfNonWhitespace();
1531 if (Last.TokenText.size() > 0)
1532 End = End.getLocWithOffset(Last.TokenText.size() - 1);
Daniel Jasper5500f612013-11-25 11:08:59 +00001533 CharSourceRange Range = CharSourceRange::getCharRange(Start, End);
1534 return affectsCharSourceRange(Range);
1535 }
1536
1537 // Returns true if one of the input ranges intersect the leading empty lines
1538 // before 'Tok'.
1539 bool affectsLeadingEmptyLines(const FormatToken &Tok) {
1540 CharSourceRange EmptyLineRange = CharSourceRange::getCharRange(
1541 Tok.WhitespaceRange.getBegin(),
1542 Tok.WhitespaceRange.getBegin().getLocWithOffset(Tok.LastNewlineOffset));
1543 return affectsCharSourceRange(EmptyLineRange);
1544 }
1545
1546 // Returns true if 'Range' intersects with one of the input ranges.
1547 bool affectsCharSourceRange(const CharSourceRange &Range) {
1548 for (SmallVectorImpl<CharSourceRange>::const_iterator I = Ranges.begin(),
1549 E = Ranges.end();
1550 I != E; ++I) {
1551 if (!SourceMgr.isBeforeInTranslationUnit(Range.getEnd(), I->getBegin()) &&
1552 !SourceMgr.isBeforeInTranslationUnit(I->getEnd(), Range.getBegin()))
1553 return true;
1554 }
1555 return false;
1556 }
1557
Alexander Kornienko9e649af2013-09-11 12:25:57 +00001558 static bool inputUsesCRLF(StringRef Text) {
1559 return Text.count('\r') * 2 > Text.count('\n');
1560 }
1561
Manuel Klimek71814b42013-10-11 21:25:45 +00001562 void
1563 deriveLocalStyle(const SmallVectorImpl<AnnotatedLine *> &AnnotatedLines) {
Daniel Jasper7fce3ab2013-02-06 14:22:40 +00001564 unsigned CountBoundToVariable = 0;
1565 unsigned CountBoundToType = 0;
1566 bool HasCpp03IncompatibleFormat = false;
Daniel Jasperb10cbc42013-07-10 14:02:49 +00001567 bool HasBinPackedFunction = false;
1568 bool HasOnePerLineFunction = false;
Daniel Jasper7fce3ab2013-02-06 14:22:40 +00001569 for (unsigned i = 0, e = AnnotatedLines.size(); i != e; ++i) {
Daniel Jasper9fe0e8d2013-09-05 09:29:45 +00001570 if (!AnnotatedLines[i]->First->Next)
Daniel Jasper7fce3ab2013-02-06 14:22:40 +00001571 continue;
Daniel Jasper9fe0e8d2013-09-05 09:29:45 +00001572 FormatToken *Tok = AnnotatedLines[i]->First->Next;
Manuel Klimek6e6310e2013-05-29 14:47:47 +00001573 while (Tok->Next) {
Daniel Jasper7fce3ab2013-02-06 14:22:40 +00001574 if (Tok->Type == TT_PointerOrReference) {
Manuel Klimek6e6310e2013-05-29 14:47:47 +00001575 bool SpacesBefore =
1576 Tok->WhitespaceRange.getBegin() != Tok->WhitespaceRange.getEnd();
1577 bool SpacesAfter = Tok->Next->WhitespaceRange.getBegin() !=
1578 Tok->Next->WhitespaceRange.getEnd();
Daniel Jasper7fce3ab2013-02-06 14:22:40 +00001579 if (SpacesBefore && !SpacesAfter)
1580 ++CountBoundToVariable;
1581 else if (!SpacesBefore && SpacesAfter)
1582 ++CountBoundToType;
1583 }
1584
Daniel Jasperfba84ff2013-10-12 05:16:06 +00001585 if (Tok->WhitespaceRange.getBegin() == Tok->WhitespaceRange.getEnd()) {
1586 if (Tok->is(tok::coloncolon) &&
1587 Tok->Previous->Type == TT_TemplateOpener)
1588 HasCpp03IncompatibleFormat = true;
1589 if (Tok->Type == TT_TemplateCloser &&
1590 Tok->Previous->Type == TT_TemplateCloser)
1591 HasCpp03IncompatibleFormat = true;
1592 }
Daniel Jasperb10cbc42013-07-10 14:02:49 +00001593
1594 if (Tok->PackingKind == PPK_BinPacked)
1595 HasBinPackedFunction = true;
1596 if (Tok->PackingKind == PPK_OnePerLine)
1597 HasOnePerLineFunction = true;
1598
Manuel Klimek6e6310e2013-05-29 14:47:47 +00001599 Tok = Tok->Next;
Daniel Jasper7fce3ab2013-02-06 14:22:40 +00001600 }
1601 }
1602 if (Style.DerivePointerBinding) {
1603 if (CountBoundToType > CountBoundToVariable)
1604 Style.PointerBindsToType = true;
1605 else if (CountBoundToType < CountBoundToVariable)
1606 Style.PointerBindsToType = false;
1607 }
1608 if (Style.Standard == FormatStyle::LS_Auto) {
1609 Style.Standard = HasCpp03IncompatibleFormat ? FormatStyle::LS_Cpp11
1610 : FormatStyle::LS_Cpp03;
1611 }
Daniel Jasperb10cbc42013-07-10 14:02:49 +00001612 BinPackInconclusiveFunctions =
1613 HasBinPackedFunction || !HasOnePerLineFunction;
Daniel Jasper7fce3ab2013-02-06 14:22:40 +00001614 }
1615
Manuel Klimek51bd6ec2013-01-10 19:49:59 +00001616 virtual void consumeUnwrappedLine(const UnwrappedLine &TheLine) {
Manuel Klimek71814b42013-10-11 21:25:45 +00001617 assert(!UnwrappedLines.empty());
1618 UnwrappedLines.back().push_back(TheLine);
1619 }
1620
1621 virtual void finishRun() {
1622 UnwrappedLines.push_back(SmallVector<UnwrappedLine, 16>());
Daniel Jasperf7935112012-12-03 18:12:45 +00001623 }
1624
1625 FormatStyle Style;
1626 Lexer &Lex;
1627 SourceManager &SourceMgr;
Daniel Jasperaa701fa2013-01-18 08:44:07 +00001628 WhitespaceManager Whitespaces;
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +00001629 SmallVector<CharSourceRange, 8> Ranges;
Manuel Klimek71814b42013-10-11 21:25:45 +00001630 SmallVector<SmallVector<UnwrappedLine, 16>, 2> UnwrappedLines;
Alexander Kornienkoffcc0102013-06-05 14:09:10 +00001631
1632 encoding::Encoding Encoding;
Daniel Jasperb10cbc42013-07-10 14:02:49 +00001633 bool BinPackInconclusiveFunctions;
Daniel Jasperf7935112012-12-03 18:12:45 +00001634};
1635
Craig Topperaf35e852013-06-30 22:29:28 +00001636} // end anonymous namespace
1637
Alexander Kornienkocb45bc12013-04-15 14:28:00 +00001638tooling::Replacements reformat(const FormatStyle &Style, Lexer &Lex,
1639 SourceManager &SourceMgr,
Daniel Jasperd2ae41a2013-05-15 08:14:19 +00001640 std::vector<CharSourceRange> Ranges) {
1641 Formatter formatter(Style, Lex, SourceMgr, Ranges);
Daniel Jasperf7935112012-12-03 18:12:45 +00001642 return formatter.format();
1643}
1644
Daniel Jasperec04c0d2013-05-16 10:40:07 +00001645tooling::Replacements reformat(const FormatStyle &Style, StringRef Code,
1646 std::vector<tooling::Range> Ranges,
1647 StringRef FileName) {
1648 FileManager Files((FileSystemOptions()));
1649 DiagnosticsEngine Diagnostics(
1650 IntrusiveRefCntPtr<DiagnosticIDs>(new DiagnosticIDs),
1651 new DiagnosticOptions);
1652 SourceManager SourceMgr(Diagnostics, Files);
1653 llvm::MemoryBuffer *Buf = llvm::MemoryBuffer::getMemBuffer(Code, FileName);
1654 const clang::FileEntry *Entry =
1655 Files.getVirtualFile(FileName, Buf->getBufferSize(), 0);
1656 SourceMgr.overrideFileContents(Entry, Buf);
1657 FileID ID =
1658 SourceMgr.createFileID(Entry, SourceLocation(), clang::SrcMgr::C_User);
Alexander Kornienko1e808872013-06-28 12:51:24 +00001659 Lexer Lex(ID, SourceMgr.getBuffer(ID), SourceMgr,
1660 getFormattingLangOpts(Style.Standard));
Daniel Jasperec04c0d2013-05-16 10:40:07 +00001661 SourceLocation StartOfFile = SourceMgr.getLocForStartOfFile(ID);
1662 std::vector<CharSourceRange> CharRanges;
1663 for (unsigned i = 0, e = Ranges.size(); i != e; ++i) {
1664 SourceLocation Start = StartOfFile.getLocWithOffset(Ranges[i].getOffset());
1665 SourceLocation End = Start.getLocWithOffset(Ranges[i].getLength());
1666 CharRanges.push_back(CharSourceRange::getCharRange(Start, End));
1667 }
1668 return reformat(Style, Lex, SourceMgr, CharRanges);
1669}
1670
Alexander Kornienko1e808872013-06-28 12:51:24 +00001671LangOptions getFormattingLangOpts(FormatStyle::LanguageStandard Standard) {
Daniel Jasperc1fa2812013-01-10 13:08:12 +00001672 LangOptions LangOpts;
1673 LangOpts.CPlusPlus = 1;
Alexander Kornienko1e808872013-06-28 12:51:24 +00001674 LangOpts.CPlusPlus11 = Standard == FormatStyle::LS_Cpp03 ? 0 : 1;
Daniel Jasper55213652013-03-22 10:01:29 +00001675 LangOpts.LineComment = 1;
Daniel Jasperc1fa2812013-01-10 13:08:12 +00001676 LangOpts.Bool = 1;
1677 LangOpts.ObjC1 = 1;
1678 LangOpts.ObjC2 = 1;
1679 return LangOpts;
1680}
1681
Edwin Vaned544aa72013-09-30 13:31:48 +00001682const char *StyleOptionHelpDescription =
1683 "Coding style, currently supports:\n"
1684 " LLVM, Google, Chromium, Mozilla, WebKit.\n"
1685 "Use -style=file to load style configuration from\n"
1686 ".clang-format file located in one of the parent\n"
1687 "directories of the source file (or current\n"
1688 "directory for stdin).\n"
1689 "Use -style=\"{key: value, ...}\" to set specific\n"
1690 "parameters, e.g.:\n"
1691 " -style=\"{BasedOnStyle: llvm, IndentWidth: 8}\"";
1692
Alexander Kornienkoc1637f12013-12-10 11:28:13 +00001693static FormatStyle::LanguageKind getLanguageByFileName(StringRef FileName) {
Alexander Kornienkocabdd732013-11-29 15:19:43 +00001694 if (FileName.endswith_lower(".js")) {
Alexander Kornienkoc1637f12013-12-10 11:28:13 +00001695 return FormatStyle::LK_JavaScript;
Alexander Kornienkocabdd732013-11-29 15:19:43 +00001696 }
Alexander Kornienkoc1637f12013-12-10 11:28:13 +00001697 return FormatStyle::LK_Cpp;
Alexander Kornienkocabdd732013-11-29 15:19:43 +00001698}
1699
Alexander Kornienkobc4ae442013-12-02 15:21:38 +00001700FormatStyle getStyle(StringRef StyleName, StringRef FileName,
1701 StringRef FallbackStyle) {
Alexander Kornienkoc1637f12013-12-10 11:28:13 +00001702 FormatStyle Style = getLLVMStyle();
1703 Style.Language = getLanguageByFileName(FileName);
1704 if (!getPredefinedStyle(FallbackStyle, Style.Language, &Style)) {
Alexander Kornienkobc4ae442013-12-02 15:21:38 +00001705 llvm::errs() << "Invalid fallback style \"" << FallbackStyle
1706 << "\" using LLVM style\n";
Alexander Kornienkoc1637f12013-12-10 11:28:13 +00001707 return Style;
Alexander Kornienkobc4ae442013-12-02 15:21:38 +00001708 }
Edwin Vaned544aa72013-09-30 13:31:48 +00001709
1710 if (StyleName.startswith("{")) {
1711 // Parse YAML/JSON style from the command line.
1712 if (llvm::error_code ec = parseConfiguration(StyleName, &Style)) {
Alexander Kornienkoe2e03872013-10-14 00:46:35 +00001713 llvm::errs() << "Error parsing -style: " << ec.message() << ", using "
1714 << FallbackStyle << " style\n";
Edwin Vaned544aa72013-09-30 13:31:48 +00001715 }
1716 return Style;
1717 }
1718
1719 if (!StyleName.equals_lower("file")) {
Alexander Kornienkoc1637f12013-12-10 11:28:13 +00001720 if (!getPredefinedStyle(StyleName, Style.Language, &Style))
Edwin Vaned544aa72013-09-30 13:31:48 +00001721 llvm::errs() << "Invalid value for -style, using " << FallbackStyle
1722 << " style\n";
1723 return Style;
1724 }
1725
Alexander Kornienkoc1637f12013-12-10 11:28:13 +00001726 // Look for .clang-format/_clang-format file in the file's parent directories.
Alexander Kornienkocabdd732013-11-29 15:19:43 +00001727 SmallString<128> UnsuitableConfigFiles;
Edwin Vaned544aa72013-09-30 13:31:48 +00001728 SmallString<128> Path(FileName);
1729 llvm::sys::fs::make_absolute(Path);
Alexander Kornienkoe2e03872013-10-14 00:46:35 +00001730 for (StringRef Directory = Path; !Directory.empty();
Edwin Vaned544aa72013-09-30 13:31:48 +00001731 Directory = llvm::sys::path::parent_path(Directory)) {
1732 if (!llvm::sys::fs::is_directory(Directory))
1733 continue;
1734 SmallString<128> ConfigFile(Directory);
1735
1736 llvm::sys::path::append(ConfigFile, ".clang-format");
1737 DEBUG(llvm::dbgs() << "Trying " << ConfigFile << "...\n");
1738 bool IsFile = false;
1739 // Ignore errors from is_regular_file: we only need to know if we can read
1740 // the file or not.
1741 llvm::sys::fs::is_regular_file(Twine(ConfigFile), IsFile);
1742
1743 if (!IsFile) {
1744 // Try _clang-format too, since dotfiles are not commonly used on Windows.
1745 ConfigFile = Directory;
1746 llvm::sys::path::append(ConfigFile, "_clang-format");
1747 DEBUG(llvm::dbgs() << "Trying " << ConfigFile << "...\n");
1748 llvm::sys::fs::is_regular_file(Twine(ConfigFile), IsFile);
1749 }
1750
1751 if (IsFile) {
1752 OwningPtr<llvm::MemoryBuffer> Text;
Rafael Espindola1a3605c2013-10-25 19:00:49 +00001753 if (llvm::error_code ec =
1754 llvm::MemoryBuffer::getFile(ConfigFile.c_str(), Text)) {
Edwin Vaned544aa72013-09-30 13:31:48 +00001755 llvm::errs() << ec.message() << "\n";
Alexander Kornienkobc4ae442013-12-02 15:21:38 +00001756 break;
Edwin Vaned544aa72013-09-30 13:31:48 +00001757 }
1758 if (llvm::error_code ec = parseConfiguration(Text->getBuffer(), &Style)) {
Alexander Kornienkocabdd732013-11-29 15:19:43 +00001759 if (ec == llvm::errc::not_supported) {
1760 if (!UnsuitableConfigFiles.empty())
1761 UnsuitableConfigFiles.append(", ");
1762 UnsuitableConfigFiles.append(ConfigFile);
Alexander Kornienkobc4ae442013-12-02 15:21:38 +00001763 continue;
Alexander Kornienkocabdd732013-11-29 15:19:43 +00001764 }
Alexander Kornienkobc4ae442013-12-02 15:21:38 +00001765 llvm::errs() << "Error reading " << ConfigFile << ": " << ec.message()
1766 << "\n";
1767 break;
Edwin Vaned544aa72013-09-30 13:31:48 +00001768 }
1769 DEBUG(llvm::dbgs() << "Using configuration file " << ConfigFile << "\n");
1770 return Style;
1771 }
1772 }
1773 llvm::errs() << "Can't find usable .clang-format, using " << FallbackStyle
1774 << " style\n";
Alexander Kornienkocabdd732013-11-29 15:19:43 +00001775 if (!UnsuitableConfigFiles.empty()) {
1776 llvm::errs() << "Configuration file(s) do(es) not support "
1777 << getLanguageName(Style.Language) << ": "
1778 << UnsuitableConfigFiles << "\n";
1779 }
Edwin Vaned544aa72013-09-30 13:31:48 +00001780 return Style;
1781}
1782
Daniel Jasper8d1832e2013-01-07 13:26:07 +00001783} // namespace format
1784} // namespace clang