blob: 7eb7a2c9c888f66a08191253f8743b5bdc16f5c1 [file] [log] [blame]
Daniel Jasperf7935112012-12-03 18:12:45 +00001//===--- Format.cpp - Format C++ code -------------------------------------===//
2//
3// The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
9///
10/// \file
11/// \brief This file implements functions declared in Format.h. This will be
12/// split into separate files as we go.
13///
Daniel Jasperf7935112012-12-03 18:12:45 +000014//===----------------------------------------------------------------------===//
15
Manuel Klimek24998102013-01-16 14:55:28 +000016#define DEBUG_TYPE "format-formatter"
17
Daniel Jasperde0328a2013-08-16 11:20:30 +000018#include "ContinuationIndenter.h"
Daniel Jasper7a6d09b2013-01-29 21:01:14 +000019#include "TokenAnnotator.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000020#include "UnwrappedLineParser.h"
Alexander Kornienkocb45bc12013-04-15 14:28:00 +000021#include "WhitespaceManager.h"
Daniel Jasperec04c0d2013-05-16 10:40:07 +000022#include "clang/Basic/Diagnostic.h"
Chandler Carruth44eb4f62013-01-02 10:28:36 +000023#include "clang/Basic/SourceManager.h"
Manuel Klimek24998102013-01-16 14:55:28 +000024#include "clang/Format/Format.h"
Daniel Jasperf7935112012-12-03 18:12:45 +000025#include "clang/Lex/Lexer.h"
Alexander Kornienkoffd6d042013-03-27 11:52:18 +000026#include "llvm/ADT/STLExtras.h"
Manuel Klimek2ef908e2013-02-13 10:46:36 +000027#include "llvm/Support/Allocator.h"
Manuel Klimek24998102013-01-16 14:55:28 +000028#include "llvm/Support/Debug.h"
Alexander Kornienkod6538332013-05-07 15:32:14 +000029#include "llvm/Support/YAMLTraits.h"
Edwin Vaned544aa72013-09-30 13:31:48 +000030#include "llvm/Support/Path.h"
Manuel Klimek2ef908e2013-02-13 10:46:36 +000031#include <queue>
Daniel Jasper8b529712012-12-04 13:02:32 +000032#include <string>
33
Alexander Kornienko6d2c88e2013-12-10 10:30:34 +000034using clang::format::FormatStyle;
35
Alexander Kornienkod6538332013-05-07 15:32:14 +000036namespace llvm {
37namespace yaml {
Alexander Kornienko6d2c88e2013-12-10 10:30:34 +000038template <> struct ScalarEnumerationTraits<FormatStyle::LanguageKind> {
39 static void enumeration(IO &IO, FormatStyle::LanguageKind &Value) {
40 IO.enumCase(Value, "Cpp", FormatStyle::LK_Cpp);
41 IO.enumCase(Value, "JavaScript", FormatStyle::LK_JavaScript);
42 }
43};
44
45template <> struct ScalarEnumerationTraits<FormatStyle::LanguageStandard> {
46 static void enumeration(IO &IO, FormatStyle::LanguageStandard &Value) {
47 IO.enumCase(Value, "Cpp03", FormatStyle::LS_Cpp03);
48 IO.enumCase(Value, "C++03", FormatStyle::LS_Cpp03);
49 IO.enumCase(Value, "Cpp11", FormatStyle::LS_Cpp11);
50 IO.enumCase(Value, "C++11", FormatStyle::LS_Cpp11);
51 IO.enumCase(Value, "Auto", FormatStyle::LS_Auto);
52 }
53};
54
55template <> struct ScalarEnumerationTraits<FormatStyle::UseTabStyle> {
56 static void enumeration(IO &IO, FormatStyle::UseTabStyle &Value) {
57 IO.enumCase(Value, "Never", FormatStyle::UT_Never);
58 IO.enumCase(Value, "false", FormatStyle::UT_Never);
59 IO.enumCase(Value, "Always", FormatStyle::UT_Always);
60 IO.enumCase(Value, "true", FormatStyle::UT_Always);
61 IO.enumCase(Value, "ForIndentation", FormatStyle::UT_ForIndentation);
62 }
63};
64
65template <> struct ScalarEnumerationTraits<FormatStyle::BraceBreakingStyle> {
66 static void enumeration(IO &IO, FormatStyle::BraceBreakingStyle &Value) {
67 IO.enumCase(Value, "Attach", FormatStyle::BS_Attach);
68 IO.enumCase(Value, "Linux", FormatStyle::BS_Linux);
69 IO.enumCase(Value, "Stroustrup", FormatStyle::BS_Stroustrup);
70 IO.enumCase(Value, "Allman", FormatStyle::BS_Allman);
Alexander Kornienko3a33f022013-12-12 09:49:52 +000071 IO.enumCase(Value, "GNU", FormatStyle::BS_GNU);
Alexander Kornienko6d2c88e2013-12-10 10:30:34 +000072 }
73};
74
Alexander Kornienkod6538332013-05-07 15:32:14 +000075template <>
Alexander Kornienko6d2c88e2013-12-10 10:30:34 +000076struct ScalarEnumerationTraits<FormatStyle::NamespaceIndentationKind> {
Alexander Kornienkocabdd732013-11-29 15:19:43 +000077 static void enumeration(IO &IO,
Alexander Kornienko6d2c88e2013-12-10 10:30:34 +000078 FormatStyle::NamespaceIndentationKind &Value) {
79 IO.enumCase(Value, "None", FormatStyle::NI_None);
80 IO.enumCase(Value, "Inner", FormatStyle::NI_Inner);
81 IO.enumCase(Value, "All", FormatStyle::NI_All);
Alexander Kornienkocabdd732013-11-29 15:19:43 +000082 }
83};
84
85template <>
Alexander Kornienko6d2c88e2013-12-10 10:30:34 +000086struct ScalarEnumerationTraits<FormatStyle::SpaceBeforeParensOptions> {
Manuel Klimeka8eb9142013-05-13 12:51:40 +000087 static void enumeration(IO &IO,
Alexander Kornienko6d2c88e2013-12-10 10:30:34 +000088 FormatStyle::SpaceBeforeParensOptions &Value) {
89 IO.enumCase(Value, "Never", FormatStyle::SBPO_Never);
Alexander Kornienkofdca83d2013-12-10 10:18:34 +000090 IO.enumCase(Value, "ControlStatements",
Alexander Kornienko6d2c88e2013-12-10 10:30:34 +000091 FormatStyle::SBPO_ControlStatements);
92 IO.enumCase(Value, "Always", FormatStyle::SBPO_Always);
Alexander Kornienkofdca83d2013-12-10 10:18:34 +000093
94 // For backward compatibility.
Alexander Kornienko6d2c88e2013-12-10 10:30:34 +000095 IO.enumCase(Value, "false", FormatStyle::SBPO_Never);
96 IO.enumCase(Value, "true", FormatStyle::SBPO_ControlStatements);
Alexander Kornienkofdca83d2013-12-10 10:18:34 +000097 }
98};
99
Alexander Kornienko6d2c88e2013-12-10 10:30:34 +0000100template <> struct MappingTraits<FormatStyle> {
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000101 static void mapping(IO &IO, FormatStyle &Style) {
102 // When reading, read the language first, we need it for getPredefinedStyle.
103 IO.mapOptional("Language", Style.Language);
104
Alexander Kornienko49149672013-05-10 11:56:10 +0000105 if (IO.outputting()) {
Alexander Kornienkoe3648fb2013-09-02 16:39:23 +0000106 StringRef StylesArray[] = { "LLVM", "Google", "Chromium",
Alexander Kornienkofe7a57f2013-12-10 15:42:15 +0000107 "Mozilla", "WebKit", "GNU" };
Alexander Kornienko49149672013-05-10 11:56:10 +0000108 ArrayRef<StringRef> Styles(StylesArray);
109 for (size_t i = 0, e = Styles.size(); i < e; ++i) {
110 StringRef StyleName(Styles[i]);
Alexander Kornienko6d2c88e2013-12-10 10:30:34 +0000111 FormatStyle PredefinedStyle;
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000112 if (getPredefinedStyle(StyleName, Style.Language, &PredefinedStyle) &&
Alexander Kornienko006b5c82013-05-19 00:53:30 +0000113 Style == PredefinedStyle) {
Alexander Kornienko49149672013-05-10 11:56:10 +0000114 IO.mapOptional("# BasedOnStyle", StyleName);
115 break;
116 }
117 }
118 } else {
Alexander Kornienkod6538332013-05-07 15:32:14 +0000119 StringRef BasedOnStyle;
120 IO.mapOptional("BasedOnStyle", BasedOnStyle);
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000121 if (!BasedOnStyle.empty()) {
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000122 FormatStyle::LanguageKind OldLanguage = Style.Language;
123 FormatStyle::LanguageKind Language =
124 ((FormatStyle *)IO.getContext())->Language;
125 if (!getPredefinedStyle(BasedOnStyle, Language, &Style)) {
Alexander Kornienko006b5c82013-05-19 00:53:30 +0000126 IO.setError(Twine("Unknown value for BasedOnStyle: ", BasedOnStyle));
127 return;
128 }
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000129 Style.Language = OldLanguage;
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000130 }
Alexander Kornienkod6538332013-05-07 15:32:14 +0000131 }
132
133 IO.mapOptional("AccessModifierOffset", Style.AccessModifierOffset);
Daniel Jaspercdaffa42013-08-13 10:58:30 +0000134 IO.mapOptional("ConstructorInitializerIndentWidth",
135 Style.ConstructorInitializerIndentWidth);
Alexander Kornienkod6538332013-05-07 15:32:14 +0000136 IO.mapOptional("AlignEscapedNewlinesLeft", Style.AlignEscapedNewlinesLeft);
Daniel Jasper552f4a72013-07-31 23:55:15 +0000137 IO.mapOptional("AlignTrailingComments", Style.AlignTrailingComments);
Alexander Kornienkod6538332013-05-07 15:32:14 +0000138 IO.mapOptional("AllowAllParametersOfDeclarationOnNextLine",
139 Style.AllowAllParametersOfDeclarationOnNextLine);
140 IO.mapOptional("AllowShortIfStatementsOnASingleLine",
141 Style.AllowShortIfStatementsOnASingleLine);
Daniel Jasper3a685df2013-05-16 12:12:21 +0000142 IO.mapOptional("AllowShortLoopsOnASingleLine",
143 Style.AllowShortLoopsOnASingleLine);
Alexander Kornienko3cfa9732013-11-20 16:33:05 +0000144 IO.mapOptional("AllowShortFunctionsOnASingleLine",
145 Style.AllowShortFunctionsOnASingleLine);
Daniel Jasper61e6bbf2013-05-29 12:07:31 +0000146 IO.mapOptional("AlwaysBreakTemplateDeclarations",
147 Style.AlwaysBreakTemplateDeclarations);
Alexander Kornienko58611712013-07-04 12:02:44 +0000148 IO.mapOptional("AlwaysBreakBeforeMultilineStrings",
149 Style.AlwaysBreakBeforeMultilineStrings);
Daniel Jaspere33d4af2013-07-26 16:56:36 +0000150 IO.mapOptional("BreakBeforeBinaryOperators",
151 Style.BreakBeforeBinaryOperators);
Daniel Jasper165b29e2013-11-08 00:57:11 +0000152 IO.mapOptional("BreakBeforeTernaryOperators",
153 Style.BreakBeforeTernaryOperators);
Daniel Jaspere33d4af2013-07-26 16:56:36 +0000154 IO.mapOptional("BreakConstructorInitializersBeforeComma",
155 Style.BreakConstructorInitializersBeforeComma);
Alexander Kornienkod6538332013-05-07 15:32:14 +0000156 IO.mapOptional("BinPackParameters", Style.BinPackParameters);
157 IO.mapOptional("ColumnLimit", Style.ColumnLimit);
158 IO.mapOptional("ConstructorInitializerAllOnOneLineOrOnePerLine",
159 Style.ConstructorInitializerAllOnOneLineOrOnePerLine);
160 IO.mapOptional("DerivePointerBinding", Style.DerivePointerBinding);
Daniel Jasperb10cbc42013-07-10 14:02:49 +0000161 IO.mapOptional("ExperimentalAutoDetectBinPacking",
162 Style.ExperimentalAutoDetectBinPacking);
Alexander Kornienkod6538332013-05-07 15:32:14 +0000163 IO.mapOptional("IndentCaseLabels", Style.IndentCaseLabels);
164 IO.mapOptional("MaxEmptyLinesToKeep", Style.MaxEmptyLinesToKeep);
Daniel Jasper65ee3472013-07-31 23:16:02 +0000165 IO.mapOptional("NamespaceIndentation", Style.NamespaceIndentation);
Alexander Kornienkod6538332013-05-07 15:32:14 +0000166 IO.mapOptional("ObjCSpaceBeforeProtocolList",
167 Style.ObjCSpaceBeforeProtocolList);
Daniel Jasper33b909c2013-10-25 14:29:37 +0000168 IO.mapOptional("PenaltyBreakBeforeFirstCallParameter",
169 Style.PenaltyBreakBeforeFirstCallParameter);
Alexander Kornienkodd7ece52013-06-07 16:02:52 +0000170 IO.mapOptional("PenaltyBreakComment", Style.PenaltyBreakComment);
171 IO.mapOptional("PenaltyBreakString", Style.PenaltyBreakString);
Daniel Jasper4e9678f2013-07-11 20:41:21 +0000172 IO.mapOptional("PenaltyBreakFirstLessLess",
173 Style.PenaltyBreakFirstLessLess);
Alexander Kornienkod6538332013-05-07 15:32:14 +0000174 IO.mapOptional("PenaltyExcessCharacter", Style.PenaltyExcessCharacter);
175 IO.mapOptional("PenaltyReturnTypeOnItsOwnLine",
176 Style.PenaltyReturnTypeOnItsOwnLine);
177 IO.mapOptional("PointerBindsToType", Style.PointerBindsToType);
178 IO.mapOptional("SpacesBeforeTrailingComments",
179 Style.SpacesBeforeTrailingComments);
Daniel Jasper6ab54682013-07-16 18:22:10 +0000180 IO.mapOptional("Cpp11BracedListStyle", Style.Cpp11BracedListStyle);
Alexander Kornienkod6538332013-05-07 15:32:14 +0000181 IO.mapOptional("Standard", Style.Standard);
Manuel Klimek13b97d82013-05-13 08:42:42 +0000182 IO.mapOptional("IndentWidth", Style.IndentWidth);
Alexander Kornienkoebb43ca2013-09-05 14:08:34 +0000183 IO.mapOptional("TabWidth", Style.TabWidth);
Manuel Klimekb9eae4c2013-05-13 09:22:11 +0000184 IO.mapOptional("UseTab", Style.UseTab);
Manuel Klimeka8eb9142013-05-13 12:51:40 +0000185 IO.mapOptional("BreakBeforeBraces", Style.BreakBeforeBraces);
Manuel Klimek836c2862013-06-21 17:25:42 +0000186 IO.mapOptional("IndentFunctionDeclarationAfterType",
187 Style.IndentFunctionDeclarationAfterType);
Daniel Jasperb55acad2013-08-20 12:36:34 +0000188 IO.mapOptional("SpacesInParentheses", Style.SpacesInParentheses);
Daniel Jasperdd978ae2013-10-29 14:52:02 +0000189 IO.mapOptional("SpacesInAngles", Style.SpacesInAngles);
Daniel Jasperf110e202013-08-21 08:39:01 +0000190 IO.mapOptional("SpaceInEmptyParentheses", Style.SpaceInEmptyParentheses);
Daniel Jasperb55acad2013-08-20 12:36:34 +0000191 IO.mapOptional("SpacesInCStyleCastParentheses",
192 Style.SpacesInCStyleCastParentheses);
Daniel Jasperd94bff32013-09-25 15:15:02 +0000193 IO.mapOptional("SpaceBeforeAssignmentOperators",
194 Style.SpaceBeforeAssignmentOperators);
Daniel Jasper6633ab82013-10-18 10:38:14 +0000195 IO.mapOptional("ContinuationIndentWidth", Style.ContinuationIndentWidth);
Alexander Kornienkofdca83d2013-12-10 10:18:34 +0000196
197 // For backward compatibility.
198 if (!IO.outputting()) {
199 IO.mapOptional("SpaceAfterControlStatementKeyword",
200 Style.SpaceBeforeParens);
201 }
202 IO.mapOptional("SpaceBeforeParens", Style.SpaceBeforeParens);
Alexander Kornienkod6538332013-05-07 15:32:14 +0000203 }
204};
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000205
206// Allows to read vector<FormatStyle> while keeping default values.
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000207// IO.getContext() should contain a pointer to the FormatStyle structure, that
208// will be used to get default values for missing keys.
209// If the first element has no Language specified, it will be treated as the
210// default one for the following elements.
Alexander Kornienko6d2c88e2013-12-10 10:30:34 +0000211template <> struct DocumentListTraits<std::vector<FormatStyle> > {
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000212 static size_t size(IO &IO, std::vector<FormatStyle> &Seq) {
213 return Seq.size();
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000214 }
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000215 static FormatStyle &element(IO &IO, std::vector<FormatStyle> &Seq,
Alexander Kornienko6d2c88e2013-12-10 10:30:34 +0000216 size_t Index) {
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000217 if (Index >= Seq.size()) {
218 assert(Index == Seq.size());
Alexander Kornienko6d2c88e2013-12-10 10:30:34 +0000219 FormatStyle Template;
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000220 if (Seq.size() > 0 && Seq[0].Language == FormatStyle::LK_None) {
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000221 Template = Seq[0];
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000222 } else {
223 Template = *((const FormatStyle*)IO.getContext());
Alexander Kornienko6d2c88e2013-12-10 10:30:34 +0000224 Template.Language = FormatStyle::LK_None;
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000225 }
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000226 Seq.resize(Index + 1, Template);
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000227 }
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000228 return Seq[Index];
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000229 }
230};
Alexander Kornienkod6538332013-05-07 15:32:14 +0000231}
232}
233
Daniel Jasperf7935112012-12-03 18:12:45 +0000234namespace clang {
235namespace format {
236
Daniel Jasperf7935112012-12-03 18:12:45 +0000237FormatStyle getLLVMStyle() {
238 FormatStyle LLVMStyle;
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000239 LLVMStyle.Language = FormatStyle::LK_Cpp;
Daniel Jasperf7935112012-12-03 18:12:45 +0000240 LLVMStyle.AccessModifierOffset = -2;
Alexander Kornienkoc8602662013-05-06 14:11:27 +0000241 LLVMStyle.AlignEscapedNewlinesLeft = false;
Daniel Jasper552f4a72013-07-31 23:55:15 +0000242 LLVMStyle.AlignTrailingComments = true;
Daniel Jasperf7db4332013-01-29 16:03:49 +0000243 LLVMStyle.AllowAllParametersOfDeclarationOnNextLine = true;
Alexander Kornienko3cfa9732013-11-20 16:33:05 +0000244 LLVMStyle.AllowShortFunctionsOnASingleLine = true;
Daniel Jasper1b750ed2013-01-14 16:24:39 +0000245 LLVMStyle.AllowShortIfStatementsOnASingleLine = false;
Daniel Jasper3a685df2013-05-16 12:12:21 +0000246 LLVMStyle.AllowShortLoopsOnASingleLine = false;
Alexander Kornienko58611712013-07-04 12:02:44 +0000247 LLVMStyle.AlwaysBreakBeforeMultilineStrings = false;
Daniel Jaspere33d4af2013-07-26 16:56:36 +0000248 LLVMStyle.AlwaysBreakTemplateDeclarations = false;
Alexander Kornienkoc8602662013-05-06 14:11:27 +0000249 LLVMStyle.BinPackParameters = true;
Daniel Jaspere33d4af2013-07-26 16:56:36 +0000250 LLVMStyle.BreakBeforeBinaryOperators = false;
Daniel Jasper165b29e2013-11-08 00:57:11 +0000251 LLVMStyle.BreakBeforeTernaryOperators = true;
Daniel Jaspere33d4af2013-07-26 16:56:36 +0000252 LLVMStyle.BreakBeforeBraces = FormatStyle::BS_Attach;
253 LLVMStyle.BreakConstructorInitializersBeforeComma = false;
Alexander Kornienkoc8602662013-05-06 14:11:27 +0000254 LLVMStyle.ColumnLimit = 80;
255 LLVMStyle.ConstructorInitializerAllOnOneLineOrOnePerLine = false;
Daniel Jaspercdaffa42013-08-13 10:58:30 +0000256 LLVMStyle.ConstructorInitializerIndentWidth = 4;
Daniel Jaspere33d4af2013-07-26 16:56:36 +0000257 LLVMStyle.Cpp11BracedListStyle = false;
Alexander Kornienkoc8602662013-05-06 14:11:27 +0000258 LLVMStyle.DerivePointerBinding = false;
Daniel Jasperb10cbc42013-07-10 14:02:49 +0000259 LLVMStyle.ExperimentalAutoDetectBinPacking = false;
Alexander Kornienkoc8602662013-05-06 14:11:27 +0000260 LLVMStyle.IndentCaseLabels = false;
Daniel Jaspere33d4af2013-07-26 16:56:36 +0000261 LLVMStyle.IndentFunctionDeclarationAfterType = false;
262 LLVMStyle.IndentWidth = 2;
Alexander Kornienkoebb43ca2013-09-05 14:08:34 +0000263 LLVMStyle.TabWidth = 8;
Alexander Kornienkoc8602662013-05-06 14:11:27 +0000264 LLVMStyle.MaxEmptyLinesToKeep = 1;
Daniel Jasper65ee3472013-07-31 23:16:02 +0000265 LLVMStyle.NamespaceIndentation = FormatStyle::NI_None;
Nico Webera6087752013-01-10 20:12:55 +0000266 LLVMStyle.ObjCSpaceBeforeProtocolList = true;
Alexander Kornienkoc8602662013-05-06 14:11:27 +0000267 LLVMStyle.PointerBindsToType = false;
268 LLVMStyle.SpacesBeforeTrailingComments = 1;
269 LLVMStyle.Standard = FormatStyle::LS_Cpp03;
Alexander Kornienko3c3d09c2013-09-27 16:14:22 +0000270 LLVMStyle.UseTab = FormatStyle::UT_Never;
Daniel Jasperb55acad2013-08-20 12:36:34 +0000271 LLVMStyle.SpacesInParentheses = false;
272 LLVMStyle.SpaceInEmptyParentheses = false;
273 LLVMStyle.SpacesInCStyleCastParentheses = false;
Alexander Kornienkofdca83d2013-12-10 10:18:34 +0000274 LLVMStyle.SpaceBeforeParens = FormatStyle::SBPO_ControlStatements;
Daniel Jasperd94bff32013-09-25 15:15:02 +0000275 LLVMStyle.SpaceBeforeAssignmentOperators = true;
Daniel Jasper6633ab82013-10-18 10:38:14 +0000276 LLVMStyle.ContinuationIndentWidth = 4;
Daniel Jasperdd978ae2013-10-29 14:52:02 +0000277 LLVMStyle.SpacesInAngles = false;
Daniel Jasper4e9678f2013-07-11 20:41:21 +0000278
Daniel Jasper19a541e2013-12-19 16:45:34 +0000279 LLVMStyle.PenaltyBreakComment = 300;
Alexander Kornienkofe7a57f2013-12-10 15:42:15 +0000280 LLVMStyle.PenaltyBreakFirstLessLess = 120;
281 LLVMStyle.PenaltyBreakString = 1000;
282 LLVMStyle.PenaltyExcessCharacter = 1000000;
Daniel Jasper4e9678f2013-07-11 20:41:21 +0000283 LLVMStyle.PenaltyReturnTypeOnItsOwnLine = 60;
Daniel Jasper33b909c2013-10-25 14:29:37 +0000284 LLVMStyle.PenaltyBreakBeforeFirstCallParameter = 19;
Daniel Jasper4e9678f2013-07-11 20:41:21 +0000285
Daniel Jasperf7935112012-12-03 18:12:45 +0000286 return LLVMStyle;
287}
288
289FormatStyle getGoogleStyle() {
Alexander Kornienkofe7a57f2013-12-10 15:42:15 +0000290 FormatStyle GoogleStyle = getLLVMStyle();
Daniel Jasperf7935112012-12-03 18:12:45 +0000291 GoogleStyle.AccessModifierOffset = -1;
Alexander Kornienkoc8602662013-05-06 14:11:27 +0000292 GoogleStyle.AlignEscapedNewlinesLeft = true;
Daniel Jasper085a2ed2013-04-24 13:46:00 +0000293 GoogleStyle.AllowShortIfStatementsOnASingleLine = true;
Daniel Jasper5bd0b9e2013-05-23 18:05:18 +0000294 GoogleStyle.AllowShortLoopsOnASingleLine = true;
Alexander Kornienko58611712013-07-04 12:02:44 +0000295 GoogleStyle.AlwaysBreakBeforeMultilineStrings = true;
Daniel Jaspere33d4af2013-07-26 16:56:36 +0000296 GoogleStyle.AlwaysBreakTemplateDeclarations = true;
Alexander Kornienkoc8602662013-05-06 14:11:27 +0000297 GoogleStyle.ConstructorInitializerAllOnOneLineOrOnePerLine = true;
Daniel Jaspere33d4af2013-07-26 16:56:36 +0000298 GoogleStyle.Cpp11BracedListStyle = true;
Alexander Kornienkoc8602662013-05-06 14:11:27 +0000299 GoogleStyle.DerivePointerBinding = true;
300 GoogleStyle.IndentCaseLabels = true;
Daniel Jaspere33d4af2013-07-26 16:56:36 +0000301 GoogleStyle.IndentFunctionDeclarationAfterType = true;
Nico Webera6087752013-01-10 20:12:55 +0000302 GoogleStyle.ObjCSpaceBeforeProtocolList = false;
Alexander Kornienkoc8602662013-05-06 14:11:27 +0000303 GoogleStyle.PointerBindsToType = true;
304 GoogleStyle.SpacesBeforeTrailingComments = 2;
305 GoogleStyle.Standard = FormatStyle::LS_Auto;
Daniel Jasper4e9678f2013-07-11 20:41:21 +0000306
Daniel Jasper4e9678f2013-07-11 20:41:21 +0000307 GoogleStyle.PenaltyReturnTypeOnItsOwnLine = 200;
Daniel Jasper33b909c2013-10-25 14:29:37 +0000308 GoogleStyle.PenaltyBreakBeforeFirstCallParameter = 1;
Daniel Jasper4e9678f2013-07-11 20:41:21 +0000309
Daniel Jasperf7935112012-12-03 18:12:45 +0000310 return GoogleStyle;
311}
312
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000313FormatStyle getGoogleJSStyle() {
314 FormatStyle GoogleJSStyle = getGoogleStyle();
315 GoogleJSStyle.Language = FormatStyle::LK_JavaScript;
316 GoogleJSStyle.BreakBeforeTernaryOperators = false;
317 // FIXME: Currently unimplemented:
318 // var arr = [1, 2, 3]; // No space after [ or before ].
319 // var obj = {a: 1, b: 2, c: 3}; // No space after ':'.
320 return GoogleJSStyle;
321}
322
Daniel Jasper1b750ed2013-01-14 16:24:39 +0000323FormatStyle getChromiumStyle() {
324 FormatStyle ChromiumStyle = getGoogleStyle();
Daniel Jasperf7db4332013-01-29 16:03:49 +0000325 ChromiumStyle.AllowAllParametersOfDeclarationOnNextLine = false;
Daniel Jasper085a2ed2013-04-24 13:46:00 +0000326 ChromiumStyle.AllowShortIfStatementsOnASingleLine = false;
Daniel Jasper3a685df2013-05-16 12:12:21 +0000327 ChromiumStyle.AllowShortLoopsOnASingleLine = false;
Daniel Jasper2cf17bf2013-02-27 09:47:53 +0000328 ChromiumStyle.BinPackParameters = false;
Daniel Jasper7fce3ab2013-02-06 14:22:40 +0000329 ChromiumStyle.DerivePointerBinding = false;
Daniel Jaspere33d4af2013-07-26 16:56:36 +0000330 ChromiumStyle.Standard = FormatStyle::LS_Cpp03;
Daniel Jasper1b750ed2013-01-14 16:24:39 +0000331 return ChromiumStyle;
332}
333
Alexander Kornienkoc8602662013-05-06 14:11:27 +0000334FormatStyle getMozillaStyle() {
335 FormatStyle MozillaStyle = getLLVMStyle();
336 MozillaStyle.AllowAllParametersOfDeclarationOnNextLine = false;
337 MozillaStyle.ConstructorInitializerAllOnOneLineOrOnePerLine = true;
338 MozillaStyle.DerivePointerBinding = true;
339 MozillaStyle.IndentCaseLabels = true;
340 MozillaStyle.ObjCSpaceBeforeProtocolList = false;
341 MozillaStyle.PenaltyReturnTypeOnItsOwnLine = 200;
342 MozillaStyle.PointerBindsToType = true;
343 return MozillaStyle;
344}
345
Daniel Jasperffefb3d2013-07-24 13:10:59 +0000346FormatStyle getWebKitStyle() {
347 FormatStyle Style = getLLVMStyle();
Daniel Jasper65ee3472013-07-31 23:16:02 +0000348 Style.AccessModifierOffset = -4;
Daniel Jasper552f4a72013-07-31 23:55:15 +0000349 Style.AlignTrailingComments = false;
Daniel Jaspere33d4af2013-07-26 16:56:36 +0000350 Style.BreakBeforeBinaryOperators = true;
Daniel Jasper65ee3472013-07-31 23:16:02 +0000351 Style.BreakBeforeBraces = FormatStyle::BS_Stroustrup;
Daniel Jaspere33d4af2013-07-26 16:56:36 +0000352 Style.BreakConstructorInitializersBeforeComma = true;
Daniel Jasper65ee3472013-07-31 23:16:02 +0000353 Style.ColumnLimit = 0;
Daniel Jaspere33d4af2013-07-26 16:56:36 +0000354 Style.IndentWidth = 4;
Daniel Jasper65ee3472013-07-31 23:16:02 +0000355 Style.NamespaceIndentation = FormatStyle::NI_Inner;
Daniel Jasperffefb3d2013-07-24 13:10:59 +0000356 Style.PointerBindsToType = true;
357 return Style;
358}
359
Alexander Kornienkofe7a57f2013-12-10 15:42:15 +0000360FormatStyle getGNUStyle() {
361 FormatStyle Style = getLLVMStyle();
362 Style.BreakBeforeBinaryOperators = true;
Alexander Kornienko3a33f022013-12-12 09:49:52 +0000363 Style.BreakBeforeBraces = FormatStyle::BS_GNU;
Alexander Kornienkofe7a57f2013-12-10 15:42:15 +0000364 Style.BreakBeforeTernaryOperators = true;
365 Style.ColumnLimit = 79;
Alexander Kornienkofe7a57f2013-12-10 15:42:15 +0000366 Style.SpaceBeforeParens = FormatStyle::SBPO_Always;
367 return Style;
368}
369
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000370bool getPredefinedStyle(StringRef Name, FormatStyle::LanguageKind Language,
371 FormatStyle *Style) {
372 if (Name.equals_lower("llvm")) {
Alexander Kornienko006b5c82013-05-19 00:53:30 +0000373 *Style = getLLVMStyle();
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000374 } else if (Name.equals_lower("chromium")) {
Alexander Kornienko006b5c82013-05-19 00:53:30 +0000375 *Style = getChromiumStyle();
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000376 } else if (Name.equals_lower("mozilla")) {
Alexander Kornienko006b5c82013-05-19 00:53:30 +0000377 *Style = getMozillaStyle();
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000378 } else if (Name.equals_lower("google")) {
379 *Style = Language == FormatStyle::LK_JavaScript ? getGoogleJSStyle()
380 : getGoogleStyle();
381 } else if (Name.equals_lower("webkit")) {
Daniel Jasperffefb3d2013-07-24 13:10:59 +0000382 *Style = getWebKitStyle();
Alexander Kornienkofe7a57f2013-12-10 15:42:15 +0000383 } else if (Name.equals_lower("gnu")) {
384 *Style = getGNUStyle();
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000385 } else {
Alexander Kornienko006b5c82013-05-19 00:53:30 +0000386 return false;
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000387 }
Alexander Kornienkod6538332013-05-07 15:32:14 +0000388
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000389 Style->Language = Language;
Alexander Kornienko006b5c82013-05-19 00:53:30 +0000390 return true;
Alexander Kornienkod6538332013-05-07 15:32:14 +0000391}
392
393llvm::error_code parseConfiguration(StringRef Text, FormatStyle *Style) {
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000394 assert(Style);
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000395 FormatStyle::LanguageKind Language = Style->Language;
396 assert(Language != FormatStyle::LK_None);
Alexander Kornienko06e00332013-05-20 15:18:01 +0000397 if (Text.trim().empty())
398 return llvm::make_error_code(llvm::errc::invalid_argument);
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000399
400 std::vector<FormatStyle> Styles;
Alexander Kornienkod6538332013-05-07 15:32:14 +0000401 llvm::yaml::Input Input(Text);
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000402 // DocumentListTraits<vector<FormatStyle>> uses the context to get default
403 // values for the fields, keys for which are missing from the configuration.
404 // Mapping also uses the context to get the language to find the correct
405 // base style.
406 Input.setContext(Style);
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000407 Input >> Styles;
408 if (Input.error())
409 return Input.error();
410
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000411 for (unsigned i = 0; i < Styles.size(); ++i) {
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000412 // Ensures that only the first configuration can skip the Language option.
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000413 if (Styles[i].Language == FormatStyle::LK_None && i != 0)
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000414 return llvm::make_error_code(llvm::errc::invalid_argument);
415 // Ensure that each language is configured at most once.
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000416 for (unsigned j = 0; j < i; ++j) {
417 if (Styles[i].Language == Styles[j].Language) {
418 DEBUG(llvm::dbgs()
419 << "Duplicate languages in the config file on positions " << j
420 << " and " << i << "\n");
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000421 return llvm::make_error_code(llvm::errc::invalid_argument);
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000422 }
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000423 }
424 }
425 // Look for a suitable configuration starting from the end, so we can
426 // find the configuration for the specific language first, and the default
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000427 // configuration (which can only be at slot 0) after it.
428 for (int i = Styles.size() - 1; i >= 0; --i) {
429 if (Styles[i].Language == Language ||
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000430 Styles[i].Language == FormatStyle::LK_None) {
431 *Style = Styles[i];
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000432 Style->Language = Language;
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000433 return llvm::make_error_code(llvm::errc::success);
434 }
435 }
436 return llvm::make_error_code(llvm::errc::not_supported);
Alexander Kornienkod6538332013-05-07 15:32:14 +0000437}
438
439std::string configurationAsText(const FormatStyle &Style) {
440 std::string Text;
441 llvm::raw_string_ostream Stream(Text);
442 llvm::yaml::Output Output(Stream);
443 // We use the same mapping method for input and output, so we need a non-const
444 // reference here.
445 FormatStyle NonConstStyle = Style;
446 Output << NonConstStyle;
Alexander Kornienko9a38ec22013-05-13 12:56:35 +0000447 return Stream.str();
Alexander Kornienkod6538332013-05-07 15:32:14 +0000448}
449
Craig Topperaf35e852013-06-30 22:29:28 +0000450namespace {
451
Daniel Jasperde0328a2013-08-16 11:20:30 +0000452class NoColumnLimitFormatter {
453public:
Daniel Jasperf110e202013-08-21 08:39:01 +0000454 NoColumnLimitFormatter(ContinuationIndenter *Indenter) : Indenter(Indenter) {}
Daniel Jasperde0328a2013-08-16 11:20:30 +0000455
456 /// \brief Formats the line starting at \p State, simply keeping all of the
457 /// input's line breaking decisions.
Alexander Kornienkoa594ba82013-12-16 14:35:51 +0000458 void format(unsigned FirstIndent, const AnnotatedLine *Line) {
Daniel Jasper1c5d9df2013-09-06 07:54:20 +0000459 LineState State =
460 Indenter->getInitialState(FirstIndent, Line, /*DryRun=*/false);
Daniel Jasperde0328a2013-08-16 11:20:30 +0000461 while (State.NextToken != NULL) {
462 bool Newline =
Alexander Kornienkoa594ba82013-12-16 14:35:51 +0000463 Indenter->mustBreak(State) ||
Daniel Jasperde0328a2013-08-16 11:20:30 +0000464 (Indenter->canBreak(State) && State.NextToken->NewlinesBefore > 0);
465 Indenter->addTokenToState(State, Newline, /*DryRun=*/false);
466 }
467 }
Daniel Jasperf110e202013-08-21 08:39:01 +0000468
Daniel Jasperde0328a2013-08-16 11:20:30 +0000469private:
470 ContinuationIndenter *Indenter;
471};
472
Daniel Jasper56f8b432013-11-06 23:12:09 +0000473class LineJoiner {
474public:
475 LineJoiner(const FormatStyle &Style) : Style(Style) {}
476
477 /// \brief Calculates how many lines can be merged into 1 starting at \p I.
478 unsigned
479 tryFitMultipleLinesInOne(unsigned Indent,
Alexander Kornienko3cfa9732013-11-20 16:33:05 +0000480 SmallVectorImpl<AnnotatedLine *>::const_iterator I,
Daniel Jasper56f8b432013-11-06 23:12:09 +0000481 SmallVectorImpl<AnnotatedLine *>::const_iterator E) {
482 // We can never merge stuff if there are trailing line comments.
Daniel Jasper234379f2013-12-24 13:31:25 +0000483 const AnnotatedLine *TheLine = *I;
Daniel Jasper56f8b432013-11-06 23:12:09 +0000484 if (TheLine->Last->Type == TT_LineComment)
485 return 0;
486
Alexander Kornienkoecc232d2013-12-04 13:25:26 +0000487 if (Style.ColumnLimit > 0 && Indent > Style.ColumnLimit)
488 return 0;
489
Daniel Jasper98fb6e12013-11-08 17:33:27 +0000490 unsigned Limit =
491 Style.ColumnLimit == 0 ? UINT_MAX : Style.ColumnLimit - Indent;
Daniel Jasper56f8b432013-11-06 23:12:09 +0000492 // If we already exceed the column limit, we set 'Limit' to 0. The different
493 // tryMerge..() functions can then decide whether to still do merging.
494 Limit = TheLine->Last->TotalLength > Limit
495 ? 0
496 : Limit - TheLine->Last->TotalLength;
497
Alexander Kornienkoc3021612013-11-19 14:30:44 +0000498 if (I + 1 == E || I[1]->Type == LT_Invalid)
Daniel Jasper56f8b432013-11-06 23:12:09 +0000499 return 0;
500
Daniel Jasper234379f2013-12-24 13:31:25 +0000501 if (TheLine->Last->Type == TT_FunctionLBrace &&
502 TheLine->First != TheLine->Last) {
Alexander Kornienko3cfa9732013-11-20 16:33:05 +0000503 return Style.AllowShortFunctionsOnASingleLine
504 ? tryMergeSimpleBlock(I, E, Limit)
505 : 0;
506 }
Daniel Jasper56f8b432013-11-06 23:12:09 +0000507 if (TheLine->Last->is(tok::l_brace)) {
Alexander Kornienko6d2c88e2013-12-10 10:30:34 +0000508 return Style.BreakBeforeBraces == FormatStyle::BS_Attach
Alexander Kornienko3cfa9732013-11-20 16:33:05 +0000509 ? tryMergeSimpleBlock(I, E, Limit)
510 : 0;
511 }
512 if (I[1]->First->Type == TT_FunctionLBrace &&
513 Style.BreakBeforeBraces != FormatStyle::BS_Attach) {
Alp Tokerba5b4dc2013-12-30 02:06:29 +0000514 // Check for Limit <= 2 to account for the " {".
Daniel Jasper234379f2013-12-24 13:31:25 +0000515 if (Limit <= 2 || (Style.ColumnLimit == 0 && containsMustBreak(TheLine)))
516 return 0;
517 Limit -= 2;
518
Alexander Kornienko3cfa9732013-11-20 16:33:05 +0000519 unsigned MergedLines = 0;
520 if (Style.AllowShortFunctionsOnASingleLine) {
521 MergedLines = tryMergeSimpleBlock(I + 1, E, Limit);
522 // If we managed to merge the block, count the function header, which is
523 // on a separate line.
524 if (MergedLines > 0)
525 ++MergedLines;
526 }
527 return MergedLines;
528 }
529 if (TheLine->First->is(tok::kw_if)) {
530 return Style.AllowShortIfStatementsOnASingleLine
531 ? tryMergeSimpleControlStatement(I, E, Limit)
532 : 0;
533 }
534 if (TheLine->First->isOneOf(tok::kw_for, tok::kw_while)) {
535 return Style.AllowShortLoopsOnASingleLine
536 ? tryMergeSimpleControlStatement(I, E, Limit)
537 : 0;
538 }
539 if (TheLine->InPPDirective &&
540 (TheLine->First->HasUnescapedNewline || TheLine->First->IsFirst)) {
Daniel Jasper56f8b432013-11-06 23:12:09 +0000541 return tryMergeSimplePPDirective(I, E, Limit);
542 }
543 return 0;
544 }
545
546private:
547 unsigned
Alexander Kornienko3cfa9732013-11-20 16:33:05 +0000548 tryMergeSimplePPDirective(SmallVectorImpl<AnnotatedLine *>::const_iterator I,
Daniel Jasper56f8b432013-11-06 23:12:09 +0000549 SmallVectorImpl<AnnotatedLine *>::const_iterator E,
550 unsigned Limit) {
551 if (Limit == 0)
552 return 0;
Alexander Kornienkoc3021612013-11-19 14:30:44 +0000553 if (!I[1]->InPPDirective || I[1]->First->HasUnescapedNewline)
Daniel Jasper56f8b432013-11-06 23:12:09 +0000554 return 0;
Alexander Kornienkoc3021612013-11-19 14:30:44 +0000555 if (I + 2 != E && I[2]->InPPDirective && !I[2]->First->HasUnescapedNewline)
Daniel Jasper56f8b432013-11-06 23:12:09 +0000556 return 0;
Alexander Kornienkoc3021612013-11-19 14:30:44 +0000557 if (1 + I[1]->Last->TotalLength > Limit)
Daniel Jasper56f8b432013-11-06 23:12:09 +0000558 return 0;
559 return 1;
560 }
561
562 unsigned tryMergeSimpleControlStatement(
Alexander Kornienko3cfa9732013-11-20 16:33:05 +0000563 SmallVectorImpl<AnnotatedLine *>::const_iterator I,
Daniel Jasper56f8b432013-11-06 23:12:09 +0000564 SmallVectorImpl<AnnotatedLine *>::const_iterator E, unsigned Limit) {
565 if (Limit == 0)
566 return 0;
Alexander Kornienko3a33f022013-12-12 09:49:52 +0000567 if ((Style.BreakBeforeBraces == FormatStyle::BS_Allman ||
568 Style.BreakBeforeBraces == FormatStyle::BS_GNU) &&
Alexander Kornienkoc3021612013-11-19 14:30:44 +0000569 I[1]->First->is(tok::l_brace))
Daniel Jasper56f8b432013-11-06 23:12:09 +0000570 return 0;
Alexander Kornienkoc3021612013-11-19 14:30:44 +0000571 if (I[1]->InPPDirective != (*I)->InPPDirective ||
572 (I[1]->InPPDirective && I[1]->First->HasUnescapedNewline))
Daniel Jasper56f8b432013-11-06 23:12:09 +0000573 return 0;
574 AnnotatedLine &Line = **I;
575 if (Line.Last->isNot(tok::r_paren))
576 return 0;
Alexander Kornienkoc3021612013-11-19 14:30:44 +0000577 if (1 + I[1]->Last->TotalLength > Limit)
Daniel Jasper56f8b432013-11-06 23:12:09 +0000578 return 0;
Alexander Kornienkoc3021612013-11-19 14:30:44 +0000579 if (I[1]->First->isOneOf(tok::semi, tok::kw_if, tok::kw_for,
Alexander Kornienko3cfa9732013-11-20 16:33:05 +0000580 tok::kw_while) ||
Alexander Kornienkoc3021612013-11-19 14:30:44 +0000581 I[1]->First->Type == TT_LineComment)
Daniel Jasper56f8b432013-11-06 23:12:09 +0000582 return 0;
583 // Only inline simple if's (no nested if or else).
584 if (I + 2 != E && Line.First->is(tok::kw_if) &&
Alexander Kornienkoc3021612013-11-19 14:30:44 +0000585 I[2]->First->is(tok::kw_else))
Daniel Jasper56f8b432013-11-06 23:12:09 +0000586 return 0;
587 return 1;
588 }
589
590 unsigned
Alexander Kornienko3cfa9732013-11-20 16:33:05 +0000591 tryMergeSimpleBlock(SmallVectorImpl<AnnotatedLine *>::const_iterator I,
Daniel Jasper56f8b432013-11-06 23:12:09 +0000592 SmallVectorImpl<AnnotatedLine *>::const_iterator E,
593 unsigned Limit) {
Daniel Jasper56f8b432013-11-06 23:12:09 +0000594 // First, check that the current line allows merging. This is the case if
595 // we're not in a control flow statement and the last token is an opening
596 // brace.
597 AnnotatedLine &Line = **I;
598 if (Line.First->isOneOf(tok::kw_if, tok::kw_while, tok::kw_do, tok::r_brace,
599 tok::kw_else, tok::kw_try, tok::kw_catch,
600 tok::kw_for,
601 // This gets rid of all ObjC @ keywords and methods.
602 tok::at, tok::minus, tok::plus))
603 return 0;
604
Alexander Kornienkoc3021612013-11-19 14:30:44 +0000605 FormatToken *Tok = I[1]->First;
Daniel Jasper56f8b432013-11-06 23:12:09 +0000606 if (Tok->is(tok::r_brace) && !Tok->MustBreakBefore &&
607 (Tok->getNextNonComment() == NULL ||
608 Tok->getNextNonComment()->is(tok::semi))) {
609 // We merge empty blocks even if the line exceeds the column limit.
610 Tok->SpacesRequiredBefore = 0;
611 Tok->CanBreakBefore = true;
612 return 1;
613 } else if (Limit != 0 && Line.First->isNot(tok::kw_namespace)) {
614 // Check that we still have three lines and they fit into the limit.
Alexander Kornienkoc3021612013-11-19 14:30:44 +0000615 if (I + 2 == E || I[2]->Type == LT_Invalid)
Daniel Jasper56f8b432013-11-06 23:12:09 +0000616 return 0;
617
618 if (!nextTwoLinesFitInto(I, Limit))
619 return 0;
620
621 // Second, check that the next line does not contain any braces - if it
622 // does, readability declines when putting it into a single line.
Alexander Kornienkoc3021612013-11-19 14:30:44 +0000623 if (I[1]->Last->Type == TT_LineComment || Tok->MustBreakBefore)
Daniel Jasper56f8b432013-11-06 23:12:09 +0000624 return 0;
625 do {
626 if (Tok->isOneOf(tok::l_brace, tok::r_brace))
627 return 0;
628 Tok = Tok->Next;
629 } while (Tok != NULL);
630
631 // Last, check that the third line contains a single closing brace.
Alexander Kornienkoc3021612013-11-19 14:30:44 +0000632 Tok = I[2]->First;
Daniel Jasper56f8b432013-11-06 23:12:09 +0000633 if (Tok->getNextNonComment() != NULL || Tok->isNot(tok::r_brace) ||
634 Tok->MustBreakBefore)
635 return 0;
636
637 return 2;
638 }
639 return 0;
640 }
641
642 bool nextTwoLinesFitInto(SmallVectorImpl<AnnotatedLine *>::const_iterator I,
643 unsigned Limit) {
Alexander Kornienkoc3021612013-11-19 14:30:44 +0000644 return 1 + I[1]->Last->TotalLength + 1 + I[2]->Last->TotalLength <= Limit;
Daniel Jasper56f8b432013-11-06 23:12:09 +0000645 }
646
Daniel Jasper234379f2013-12-24 13:31:25 +0000647 bool containsMustBreak(const AnnotatedLine *Line) {
648 for (const FormatToken *Tok = Line->First; Tok; Tok = Tok->Next) {
649 if (Tok->MustBreakBefore)
650 return true;
651 }
652 return false;
653 }
654
Daniel Jasper56f8b432013-11-06 23:12:09 +0000655 const FormatStyle &Style;
656};
657
Daniel Jasperf7935112012-12-03 18:12:45 +0000658class UnwrappedLineFormatter {
659public:
Daniel Jasper5500f612013-11-25 11:08:59 +0000660 UnwrappedLineFormatter(ContinuationIndenter *Indenter,
Daniel Jasper9fe0e8d2013-09-05 09:29:45 +0000661 WhitespaceManager *Whitespaces,
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +0000662 const FormatStyle &Style)
Daniel Jasper5500f612013-11-25 11:08:59 +0000663 : Indenter(Indenter), Whitespaces(Whitespaces), Style(Style),
664 Joiner(Style) {}
Daniel Jasperf7935112012-12-03 18:12:45 +0000665
Daniel Jasper56f8b432013-11-06 23:12:09 +0000666 unsigned format(const SmallVectorImpl<AnnotatedLine *> &Lines, bool DryRun,
Daniel Jasper9c199562013-11-28 15:58:55 +0000667 int AdditionalIndent = 0, bool FixBadIndentation = false) {
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +0000668 assert(!Lines.empty());
669 unsigned Penalty = 0;
670 std::vector<int> IndentForLevel;
671 for (unsigned i = 0, e = Lines[0]->Level; i != e; ++i)
672 IndentForLevel.push_back(Style.IndentWidth * i + AdditionalIndent);
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +0000673 const AnnotatedLine *PreviousLine = NULL;
Daniel Jasper56f8b432013-11-06 23:12:09 +0000674 for (SmallVectorImpl<AnnotatedLine *>::const_iterator I = Lines.begin(),
675 E = Lines.end();
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +0000676 I != E; ++I) {
677 const AnnotatedLine &TheLine = **I;
678 const FormatToken *FirstTok = TheLine.First;
679 int Offset = getIndentOffset(*FirstTok);
680
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +0000681 // Determine indent and try to merge multiple unwrapped lines.
Daniel Jasperbad63ae2013-12-17 12:38:55 +0000682 unsigned Indent;
683 if (TheLine.InPPDirective) {
684 Indent = TheLine.Level * Style.IndentWidth;
685 } else {
686 while (IndentForLevel.size() <= TheLine.Level)
687 IndentForLevel.push_back(-1);
688 IndentForLevel.resize(TheLine.Level + 1);
689 Indent = getIndent(IndentForLevel, TheLine.Level);
690 }
691 unsigned LevelIndent = Indent;
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +0000692 if (static_cast<int>(Indent) + Offset >= 0)
693 Indent += Offset;
Daniel Jasperbad63ae2013-12-17 12:38:55 +0000694
695 // Merge multiple lines if possible.
Daniel Jasper56f8b432013-11-06 23:12:09 +0000696 unsigned MergedLines = Joiner.tryFitMultipleLinesInOne(Indent, I, E);
Alexander Kornienko31e95542013-12-04 12:21:08 +0000697 if (MergedLines > 0 && Style.ColumnLimit == 0) {
698 // Disallow line merging if there is a break at the start of one of the
699 // input lines.
700 for (unsigned i = 0; i < MergedLines; ++i) {
701 if (I[i + 1]->First->NewlinesBefore > 0)
702 MergedLines = 0;
703 }
704 }
Daniel Jasper56f8b432013-11-06 23:12:09 +0000705 if (!DryRun) {
706 for (unsigned i = 0; i < MergedLines; ++i) {
Alexander Kornienkoc3021612013-11-19 14:30:44 +0000707 join(*I[i], *I[i + 1]);
Daniel Jasper56f8b432013-11-06 23:12:09 +0000708 }
709 }
710 I += MergedLines;
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +0000711
Daniel Jasper9c199562013-11-28 15:58:55 +0000712 bool FixIndentation =
713 FixBadIndentation && (LevelIndent != FirstTok->OriginalColumn);
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +0000714 if (TheLine.First->is(tok::eof)) {
Daniel Jasper5500f612013-11-25 11:08:59 +0000715 if (PreviousLine && PreviousLine->Affected && !DryRun) {
716 // Remove the file's trailing whitespace.
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +0000717 unsigned Newlines = std::min(FirstTok->NewlinesBefore, 1u);
718 Whitespaces->replaceWhitespace(*TheLine.First, Newlines,
719 /*IndentLevel=*/0, /*Spaces=*/0,
720 /*TargetColumn=*/0);
721 }
Daniel Jasper9c199562013-11-28 15:58:55 +0000722 } else if (TheLine.Type != LT_Invalid &&
723 (TheLine.Affected || FixIndentation)) {
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +0000724 if (FirstTok->WhitespaceRange.isValid()) {
725 if (!DryRun)
726 formatFirstToken(*TheLine.First, PreviousLine, TheLine.Level,
727 Indent, TheLine.InPPDirective);
728 } else {
729 Indent = LevelIndent = FirstTok->OriginalColumn;
730 }
731
732 // If everything fits on a single line, just put it there.
733 unsigned ColumnLimit = Style.ColumnLimit;
734 if (I + 1 != E) {
Alexander Kornienkoc3021612013-11-19 14:30:44 +0000735 AnnotatedLine *NextLine = I[1];
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +0000736 if (NextLine->InPPDirective && !NextLine->First->HasUnescapedNewline)
737 ColumnLimit = getColumnLimit(TheLine.InPPDirective);
738 }
739
740 if (TheLine.Last->TotalLength + Indent <= ColumnLimit) {
741 LineState State = Indenter->getInitialState(Indent, &TheLine, DryRun);
742 while (State.NextToken != NULL)
743 Indenter->addTokenToState(State, /*Newline=*/false, DryRun);
744 } else if (Style.ColumnLimit == 0) {
Daniel Jasper9c199562013-11-28 15:58:55 +0000745 // FIXME: Implement nested blocks for ColumnLimit = 0.
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +0000746 NoColumnLimitFormatter Formatter(Indenter);
747 if (!DryRun)
Alexander Kornienkoa594ba82013-12-16 14:35:51 +0000748 Formatter.format(Indent, &TheLine);
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +0000749 } else {
750 Penalty += format(TheLine, Indent, DryRun);
751 }
752
Daniel Jasperbad63ae2013-12-17 12:38:55 +0000753 if (!TheLine.InPPDirective)
754 IndentForLevel[TheLine.Level] = LevelIndent;
Daniel Jasper9c199562013-11-28 15:58:55 +0000755 } else if (TheLine.ChildrenAffected) {
756 format(TheLine.Children, DryRun);
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +0000757 } else {
758 // Format the first token if necessary, and notify the WhitespaceManager
759 // about the unchanged whitespace.
760 for (FormatToken *Tok = TheLine.First; Tok != NULL; Tok = Tok->Next) {
761 if (Tok == TheLine.First &&
762 (Tok->NewlinesBefore > 0 || Tok->IsFirst)) {
763 unsigned LevelIndent = Tok->OriginalColumn;
764 if (!DryRun) {
Daniel Jasper9c199562013-11-28 15:58:55 +0000765 // Remove trailing whitespace of the previous line.
Daniel Jasper5500f612013-11-25 11:08:59 +0000766 if ((PreviousLine && PreviousLine->Affected) ||
767 TheLine.LeadingEmptyLinesAffected) {
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +0000768 formatFirstToken(*Tok, PreviousLine, TheLine.Level, LevelIndent,
769 TheLine.InPPDirective);
770 } else {
771 Whitespaces->addUntouchableToken(*Tok, TheLine.InPPDirective);
772 }
773 }
774
775 if (static_cast<int>(LevelIndent) - Offset >= 0)
776 LevelIndent -= Offset;
Daniel Jasperbad63ae2013-12-17 12:38:55 +0000777 if (Tok->isNot(tok::comment) && !TheLine.InPPDirective)
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +0000778 IndentForLevel[TheLine.Level] = LevelIndent;
779 } else if (!DryRun) {
780 Whitespaces->addUntouchableToken(*Tok, TheLine.InPPDirective);
781 }
782 }
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +0000783 }
784 if (!DryRun) {
785 for (FormatToken *Tok = TheLine.First; Tok != NULL; Tok = Tok->Next) {
786 Tok->Finalized = true;
787 }
788 }
789 PreviousLine = *I;
790 }
791 return Penalty;
792 }
793
794private:
795 /// \brief Formats an \c AnnotatedLine and returns the penalty.
Daniel Jasper9fe0e8d2013-09-05 09:29:45 +0000796 ///
797 /// If \p DryRun is \c false, directly applies the changes.
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +0000798 unsigned format(const AnnotatedLine &Line, unsigned FirstIndent,
799 bool DryRun) {
Daniel Jasper1c5d9df2013-09-06 07:54:20 +0000800 LineState State = Indenter->getInitialState(FirstIndent, &Line, DryRun);
Daniel Jasper4b866272013-02-01 11:00:45 +0000801
Daniel Jasperacc33662013-02-08 08:22:00 +0000802 // If the ObjC method declaration does not fit on a line, we should format
803 // it with one arg per line.
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +0000804 if (State.Line->Type == LT_ObjCMethodDecl)
Daniel Jasperacc33662013-02-08 08:22:00 +0000805 State.Stack.back().BreakBeforeParameter = true;
806
Daniel Jasper4b866272013-02-01 11:00:45 +0000807 // Find best solution in solution space.
Daniel Jasper9fe0e8d2013-09-05 09:29:45 +0000808 return analyzeSolutionSpace(State, DryRun);
Daniel Jasperf7935112012-12-03 18:12:45 +0000809 }
810
Manuel Klimek2ef908e2013-02-13 10:46:36 +0000811 /// \brief An edge in the solution space from \c Previous->State to \c State,
812 /// inserting a newline dependent on the \c NewLine.
813 struct StateNode {
814 StateNode(const LineState &State, bool NewLine, StateNode *Previous)
Daniel Jasper12ef4e52013-02-21 21:33:55 +0000815 : State(State), NewLine(NewLine), Previous(Previous) {}
Manuel Klimek2ef908e2013-02-13 10:46:36 +0000816 LineState State;
817 bool NewLine;
818 StateNode *Previous;
819 };
Daniel Jasper4b866272013-02-01 11:00:45 +0000820
Manuel Klimek2ef908e2013-02-13 10:46:36 +0000821 /// \brief A pair of <penalty, count> that is used to prioritize the BFS on.
822 ///
823 /// In case of equal penalties, we want to prefer states that were inserted
824 /// first. During state generation we make sure that we insert states first
825 /// that break the line as late as possible.
826 typedef std::pair<unsigned, unsigned> OrderedPenalty;
827
828 /// \brief An item in the prioritized BFS search queue. The \c StateNode's
829 /// \c State has the given \c OrderedPenalty.
830 typedef std::pair<OrderedPenalty, StateNode *> QueueItem;
831
832 /// \brief The BFS queue type.
833 typedef std::priority_queue<QueueItem, std::vector<QueueItem>,
834 std::greater<QueueItem> > QueueType;
Daniel Jasper4b866272013-02-01 11:00:45 +0000835
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +0000836 /// \brief Get the offset of the line relatively to the level.
837 ///
838 /// For example, 'public:' labels in classes are offset by 1 or 2
839 /// characters to the left from their level.
840 int getIndentOffset(const FormatToken &RootToken) {
841 if (RootToken.isAccessSpecifier(false) || RootToken.isObjCAccessSpecifier())
842 return Style.AccessModifierOffset;
843 return 0;
844 }
845
846 /// \brief Add a new line and the required indent before the first Token
847 /// of the \c UnwrappedLine if there was no structural parsing error.
848 void formatFirstToken(FormatToken &RootToken,
849 const AnnotatedLine *PreviousLine, unsigned IndentLevel,
850 unsigned Indent, bool InPPDirective) {
851 unsigned Newlines =
852 std::min(RootToken.NewlinesBefore, Style.MaxEmptyLinesToKeep + 1);
853 // Remove empty lines before "}" where applicable.
854 if (RootToken.is(tok::r_brace) &&
855 (!RootToken.Next ||
856 (RootToken.Next->is(tok::semi) && !RootToken.Next->Next)))
857 Newlines = std::min(Newlines, 1u);
858 if (Newlines == 0 && !RootToken.IsFirst)
859 Newlines = 1;
860
861 // Insert extra new line before access specifiers.
862 if (PreviousLine && PreviousLine->Last->isOneOf(tok::semi, tok::r_brace) &&
863 RootToken.isAccessSpecifier() && RootToken.NewlinesBefore == 1)
864 ++Newlines;
865
866 // Remove empty lines after access specifiers.
867 if (PreviousLine && PreviousLine->First->isAccessSpecifier())
868 Newlines = std::min(1u, Newlines);
869
Alexander Kornienko3cfa9732013-11-20 16:33:05 +0000870 Whitespaces->replaceWhitespace(RootToken, Newlines, IndentLevel, Indent,
871 Indent, InPPDirective &&
872 !RootToken.HasUnescapedNewline);
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +0000873 }
874
875 /// \brief Get the indent of \p Level from \p IndentForLevel.
876 ///
877 /// \p IndentForLevel must contain the indent for the level \c l
878 /// at \p IndentForLevel[l], or a value < 0 if the indent for
879 /// that level is unknown.
880 unsigned getIndent(const std::vector<int> IndentForLevel, unsigned Level) {
881 if (IndentForLevel[Level] != -1)
882 return IndentForLevel[Level];
883 if (Level == 0)
884 return 0;
885 return getIndent(IndentForLevel, Level - 1) + Style.IndentWidth;
886 }
887
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +0000888 void join(AnnotatedLine &A, const AnnotatedLine &B) {
889 assert(!A.Last->Next);
890 assert(!B.First->Previous);
Daniel Jasper5500f612013-11-25 11:08:59 +0000891 if (B.Affected)
892 A.Affected = true;
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +0000893 A.Last->Next = B.First;
894 B.First->Previous = A.Last;
Daniel Jasper98fb6e12013-11-08 17:33:27 +0000895 B.First->CanBreakBefore = true;
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +0000896 unsigned LengthA = A.Last->TotalLength + B.First->SpacesRequiredBefore;
897 for (FormatToken *Tok = B.First; Tok; Tok = Tok->Next) {
898 Tok->TotalLength += LengthA;
899 A.Last = Tok;
900 }
901 }
902
903 unsigned getColumnLimit(bool InPPDirective) const {
904 // In preprocessor directives reserve two chars for trailing " \"
905 return Style.ColumnLimit - (InPPDirective ? 2 : 0);
906 }
907
Daniel Jasper4b866272013-02-01 11:00:45 +0000908 /// \brief Analyze the entire solution space starting from \p InitialState.
Daniel Jasperf7935112012-12-03 18:12:45 +0000909 ///
Daniel Jasper4b866272013-02-01 11:00:45 +0000910 /// This implements a variant of Dijkstra's algorithm on the graph that spans
911 /// the solution space (\c LineStates are the nodes). The algorithm tries to
912 /// find the shortest path (the one with lowest penalty) from \p InitialState
Daniel Jasper9fe0e8d2013-09-05 09:29:45 +0000913 /// to a state where all tokens are placed. Returns the penalty.
914 ///
915 /// If \p DryRun is \c false, directly applies the changes.
916 unsigned analyzeSolutionSpace(LineState &InitialState, bool DryRun = false) {
Manuel Klimek2ef908e2013-02-13 10:46:36 +0000917 std::set<LineState> Seen;
918
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +0000919 // Increasing count of \c StateNode items we have created. This is used to
920 // create a deterministic order independent of the container.
921 unsigned Count = 0;
922 QueueType Queue;
923
Daniel Jasper4b866272013-02-01 11:00:45 +0000924 // Insert start element into queue.
Daniel Jasper687af3b2013-02-14 14:26:07 +0000925 StateNode *Node =
Manuel Klimek2ef908e2013-02-13 10:46:36 +0000926 new (Allocator.Allocate()) StateNode(InitialState, false, NULL);
927 Queue.push(QueueItem(OrderedPenalty(0, Count), Node));
928 ++Count;
Daniel Jasper4b866272013-02-01 11:00:45 +0000929
Daniel Jasper9fe0e8d2013-09-05 09:29:45 +0000930 unsigned Penalty = 0;
931
Daniel Jasper4b866272013-02-01 11:00:45 +0000932 // While not empty, take first element and follow edges.
933 while (!Queue.empty()) {
Daniel Jasper9fe0e8d2013-09-05 09:29:45 +0000934 Penalty = Queue.top().first.first;
Daniel Jasper687af3b2013-02-14 14:26:07 +0000935 StateNode *Node = Queue.top().second;
Manuel Klimek2ef908e2013-02-13 10:46:36 +0000936 if (Node->State.NextToken == NULL) {
Alexander Kornienko49149672013-05-10 11:56:10 +0000937 DEBUG(llvm::dbgs() << "\n---\nPenalty for line: " << Penalty << "\n");
Daniel Jasper4b866272013-02-01 11:00:45 +0000938 break;
Daniel Jasper3a9370c2013-02-04 07:21:18 +0000939 }
Manuel Klimek2ef908e2013-02-13 10:46:36 +0000940 Queue.pop();
Daniel Jasper4b866272013-02-01 11:00:45 +0000941
Daniel Jasperf8114cf2013-05-22 05:27:42 +0000942 // Cut off the analysis of certain solutions if the analysis gets too
943 // complex. See description of IgnoreStackForComparison.
944 if (Count > 10000)
945 Node->State.IgnoreStackForComparison = true;
946
Manuel Klimek2ef908e2013-02-13 10:46:36 +0000947 if (!Seen.insert(Node->State).second)
948 // State already examined with lower penalty.
949 continue;
Daniel Jasper4b866272013-02-01 11:00:45 +0000950
Manuel Klimek71814b42013-10-11 21:25:45 +0000951 FormatDecision LastFormat = Node->State.NextToken->Decision;
952 if (LastFormat == FD_Unformatted || LastFormat == FD_Continue)
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +0000953 addNextStateToQueue(Penalty, Node, /*NewLine=*/false, &Count, &Queue);
Manuel Klimek71814b42013-10-11 21:25:45 +0000954 if (LastFormat == FD_Unformatted || LastFormat == FD_Break)
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +0000955 addNextStateToQueue(Penalty, Node, /*NewLine=*/true, &Count, &Queue);
Daniel Jasper4b866272013-02-01 11:00:45 +0000956 }
957
Manuel Klimek71814b42013-10-11 21:25:45 +0000958 if (Queue.empty()) {
Daniel Jasper4b866272013-02-01 11:00:45 +0000959 // We were unable to find a solution, do nothing.
960 // FIXME: Add diagnostic?
Manuel Klimek71814b42013-10-11 21:25:45 +0000961 DEBUG(llvm::dbgs() << "Could not find a solution.\n");
Daniel Jasper9fe0e8d2013-09-05 09:29:45 +0000962 return 0;
Manuel Klimek71814b42013-10-11 21:25:45 +0000963 }
Daniel Jasperf7935112012-12-03 18:12:45 +0000964
Daniel Jasper4b866272013-02-01 11:00:45 +0000965 // Reconstruct the solution.
Daniel Jasper9fe0e8d2013-09-05 09:29:45 +0000966 if (!DryRun)
967 reconstructPath(InitialState, Queue.top().second);
968
Alexander Kornienko49149672013-05-10 11:56:10 +0000969 DEBUG(llvm::dbgs() << "Total number of analyzed states: " << Count << "\n");
970 DEBUG(llvm::dbgs() << "---\n");
Daniel Jasper9fe0e8d2013-09-05 09:29:45 +0000971
972 return Penalty;
Manuel Klimek2ef908e2013-02-13 10:46:36 +0000973 }
974
975 void reconstructPath(LineState &State, StateNode *Current) {
Manuel Klimek4c5c28b2013-05-29 15:10:11 +0000976 std::deque<StateNode *> Path;
977 // We do not need a break before the initial token.
978 while (Current->Previous) {
979 Path.push_front(Current);
980 Current = Current->Previous;
981 }
982 for (std::deque<StateNode *>::iterator I = Path.begin(), E = Path.end();
983 I != E; ++I) {
Daniel Jasper9fe0e8d2013-09-05 09:29:45 +0000984 unsigned Penalty = 0;
985 formatChildren(State, (*I)->NewLine, /*DryRun=*/false, Penalty);
986 Penalty += Indenter->addTokenToState(State, (*I)->NewLine, false);
987
Manuel Klimek4c5c28b2013-05-29 15:10:11 +0000988 DEBUG({
989 if ((*I)->NewLine) {
Daniel Jasper8de9ed02013-08-22 15:00:41 +0000990 llvm::dbgs() << "Penalty for placing "
Manuel Klimek4c5c28b2013-05-29 15:10:11 +0000991 << (*I)->Previous->State.NextToken->Tok.getName() << ": "
Daniel Jasper8de9ed02013-08-22 15:00:41 +0000992 << Penalty << "\n";
Manuel Klimek4c5c28b2013-05-29 15:10:11 +0000993 }
994 });
Manuel Klimek4c5c28b2013-05-29 15:10:11 +0000995 }
Daniel Jasper4b866272013-02-01 11:00:45 +0000996 }
997
Manuel Klimekaf491072013-02-13 10:54:19 +0000998 /// \brief Add the following state to the analysis queue \c Queue.
Daniel Jasper4b866272013-02-01 11:00:45 +0000999 ///
Manuel Klimekaf491072013-02-13 10:54:19 +00001000 /// Assume the current state is \p PreviousNode and has been reached with a
Daniel Jasper4b866272013-02-01 11:00:45 +00001001 /// penalty of \p Penalty. Insert a line break if \p NewLine is \c true.
Manuel Klimekaf491072013-02-13 10:54:19 +00001002 void addNextStateToQueue(unsigned Penalty, StateNode *PreviousNode,
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +00001003 bool NewLine, unsigned *Count, QueueType *Queue) {
Daniel Jasperde0328a2013-08-16 11:20:30 +00001004 if (NewLine && !Indenter->canBreak(PreviousNode->State))
Daniel Jasper4b866272013-02-01 11:00:45 +00001005 return;
Daniel Jasperde0328a2013-08-16 11:20:30 +00001006 if (!NewLine && Indenter->mustBreak(PreviousNode->State))
Daniel Jasper4b866272013-02-01 11:00:45 +00001007 return;
Manuel Klimek2ef908e2013-02-13 10:46:36 +00001008
1009 StateNode *Node = new (Allocator.Allocate())
1010 StateNode(PreviousNode->State, NewLine, PreviousNode);
Daniel Jasper9fe0e8d2013-09-05 09:29:45 +00001011 if (!formatChildren(Node->State, NewLine, /*DryRun=*/true, Penalty))
1012 return;
1013
Daniel Jasperde0328a2013-08-16 11:20:30 +00001014 Penalty += Indenter->addTokenToState(Node->State, NewLine, true);
Manuel Klimek2ef908e2013-02-13 10:46:36 +00001015
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +00001016 Queue->push(QueueItem(OrderedPenalty(Penalty, *Count), Node));
1017 ++(*Count);
Daniel Jasper4b866272013-02-01 11:00:45 +00001018 }
Daniel Jasperf7935112012-12-03 18:12:45 +00001019
Daniel Jasperf3a5d002013-09-05 10:48:50 +00001020 /// \brief If the \p State's next token is an r_brace closing a nested block,
1021 /// format the nested block before it.
Daniel Jasper9fe0e8d2013-09-05 09:29:45 +00001022 ///
1023 /// Returns \c true if all children could be placed successfully and adapts
1024 /// \p Penalty as well as \p State. If \p DryRun is false, also directly
1025 /// creates changes using \c Whitespaces.
1026 ///
1027 /// The crucial idea here is that children always get formatted upon
1028 /// encountering the closing brace right after the nested block. Now, if we
1029 /// are currently trying to keep the "}" on the same line (i.e. \p NewLine is
1030 /// \c false), the entire block has to be kept on the same line (which is only
1031 /// possible if it fits on the line, only contains a single statement, etc.
1032 ///
1033 /// If \p NewLine is true, we format the nested block on separate lines, i.e.
1034 /// break after the "{", format all lines with correct indentation and the put
1035 /// the closing "}" on yet another new line.
1036 ///
1037 /// This enables us to keep the simple structure of the
1038 /// \c UnwrappedLineFormatter, where we only have two options for each token:
1039 /// break or don't break.
1040 bool formatChildren(LineState &State, bool NewLine, bool DryRun,
1041 unsigned &Penalty) {
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +00001042 FormatToken &Previous = *State.NextToken->Previous;
Daniel Jasperdcd5da12013-10-20 17:28:32 +00001043 const FormatToken *LBrace = State.NextToken->getPreviousNonComment();
1044 if (!LBrace || LBrace->isNot(tok::l_brace) ||
1045 LBrace->BlockKind != BK_Block || Previous.Children.size() == 0)
Daniel Jasperf3a5d002013-09-05 10:48:50 +00001046 // The previous token does not open a block. Nothing to do. We don't
1047 // assert so that we can simply call this function for all tokens.
Daniel Jasper36c28ce2013-09-06 08:54:24 +00001048 return true;
Daniel Jasper9fe0e8d2013-09-05 09:29:45 +00001049
1050 if (NewLine) {
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +00001051 int AdditionalIndent = State.Stack.back().Indent -
1052 Previous.Children[0]->Level * Style.IndentWidth;
Daniel Jasper9c199562013-11-28 15:58:55 +00001053 Penalty += format(Previous.Children, DryRun, AdditionalIndent,
1054 /*FixBadIndentation=*/true);
Daniel Jasper9fe0e8d2013-09-05 09:29:45 +00001055 return true;
1056 }
1057
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +00001058 // Cannot merge multiple statements into a single line.
Daniel Jasperdcd5da12013-10-20 17:28:32 +00001059 if (Previous.Children.size() > 1)
Alexander Kornienko3cfa9732013-11-20 16:33:05 +00001060 return false;
Daniel Jasper9fe0e8d2013-09-05 09:29:45 +00001061
1062 // We can't put the closing "}" on a line with a trailing comment.
Daniel Jasperdcd5da12013-10-20 17:28:32 +00001063 if (Previous.Children[0]->Last->isTrailingComment())
Daniel Jasper9fe0e8d2013-09-05 09:29:45 +00001064 return false;
1065
1066 if (!DryRun) {
Alexander Kornienko3c3d09c2013-09-27 16:14:22 +00001067 Whitespaces->replaceWhitespace(
Daniel Jasperdcd5da12013-10-20 17:28:32 +00001068 *Previous.Children[0]->First,
Alexander Kornienkoe2e03872013-10-14 00:46:35 +00001069 /*Newlines=*/0, /*IndentLevel=*/0, /*Spaces=*/1,
Alexander Kornienko3c3d09c2013-09-27 16:14:22 +00001070 /*StartOfTokenColumn=*/State.Column, State.Line->InPPDirective);
Daniel Jasper9fe0e8d2013-09-05 09:29:45 +00001071 }
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +00001072 Penalty += format(*Previous.Children[0], State.Column + 1, DryRun);
Daniel Jasper9fe0e8d2013-09-05 09:29:45 +00001073
Daniel Jasperdcd5da12013-10-20 17:28:32 +00001074 State.Column += 1 + Previous.Children[0]->Last->TotalLength;
Daniel Jasper9fe0e8d2013-09-05 09:29:45 +00001075 return true;
1076 }
1077
Daniel Jasperde0328a2013-08-16 11:20:30 +00001078 ContinuationIndenter *Indenter;
Daniel Jasper9fe0e8d2013-09-05 09:29:45 +00001079 WhitespaceManager *Whitespaces;
Daniel Jasperf7935112012-12-03 18:12:45 +00001080 FormatStyle Style;
Daniel Jasper56f8b432013-11-06 23:12:09 +00001081 LineJoiner Joiner;
Manuel Klimekaf491072013-02-13 10:54:19 +00001082
1083 llvm::SpecificBumpPtrAllocator<StateNode> Allocator;
Daniel Jasperf7935112012-12-03 18:12:45 +00001084};
1085
Manuel Klimek15dfe7a2013-05-28 11:55:06 +00001086class FormatTokenLexer {
Alexander Kornienkoe3276842012-12-07 16:15:44 +00001087public:
Manuel Klimek31c85922013-08-29 15:21:40 +00001088 FormatTokenLexer(Lexer &Lex, SourceManager &SourceMgr, FormatStyle &Style,
Alexander Kornienkoffcc0102013-06-05 14:09:10 +00001089 encoding::Encoding Encoding)
Alexander Kornienko393e3082013-11-13 14:04:17 +00001090 : FormatTok(NULL), IsFirstToken(true), GreaterStashed(false), Column(0),
Manuel Klimek31c85922013-08-29 15:21:40 +00001091 TrailingWhitespace(0), Lex(Lex), SourceMgr(SourceMgr), Style(Style),
1092 IdentTable(getFormattingLangOpts()), Encoding(Encoding) {
Alexander Kornienkoe3276842012-12-07 16:15:44 +00001093 Lex.SetKeepWhitespaceMode(true);
1094 }
1095
Manuel Klimek15dfe7a2013-05-28 11:55:06 +00001096 ArrayRef<FormatToken *> lex() {
1097 assert(Tokens.empty());
1098 do {
1099 Tokens.push_back(getNextToken());
Alexander Kornienko9aa62402013-11-21 12:43:57 +00001100 tryMergePreviousTokens();
Manuel Klimek15dfe7a2013-05-28 11:55:06 +00001101 } while (Tokens.back()->Tok.isNot(tok::eof));
1102 return Tokens;
1103 }
1104
1105 IdentifierTable &getIdentTable() { return IdentTable; }
1106
1107private:
Alexander Kornienko9aa62402013-11-21 12:43:57 +00001108 void tryMergePreviousTokens() {
Alexander Kornienkocabdd732013-11-29 15:19:43 +00001109 if (tryMerge_TMacro())
1110 return;
1111
1112 if (Style.Language == FormatStyle::LK_JavaScript) {
1113 static tok::TokenKind JSIdentity[] = { tok::equalequal, tok::equal };
1114 static tok::TokenKind JSNotIdentity[] = { tok::exclaimequal, tok::equal };
1115 static tok::TokenKind JSShiftEqual[] = { tok::greater, tok::greater,
1116 tok::greaterequal };
1117 // FIXME: We probably need to change token type to mimic operator with the
1118 // correct priority.
1119 if (tryMergeTokens(JSIdentity))
1120 return;
1121 if (tryMergeTokens(JSNotIdentity))
1122 return;
1123 if (tryMergeTokens(JSShiftEqual))
1124 return;
1125 }
Alexander Kornienko9aa62402013-11-21 12:43:57 +00001126 }
1127
Alexander Kornienkocabdd732013-11-29 15:19:43 +00001128 bool tryMergeTokens(ArrayRef<tok::TokenKind> Kinds) {
1129 if (Tokens.size() < Kinds.size())
Alexander Kornienko9aa62402013-11-21 12:43:57 +00001130 return false;
Alexander Kornienkocabdd732013-11-29 15:19:43 +00001131
1132 SmallVectorImpl<FormatToken *>::const_iterator First =
1133 Tokens.end() - Kinds.size();
1134 if (!First[0]->is(Kinds[0]))
Alexander Kornienko9aa62402013-11-21 12:43:57 +00001135 return false;
Alexander Kornienkocabdd732013-11-29 15:19:43 +00001136 unsigned AddLength = 0;
1137 for (unsigned i = 1; i < Kinds.size(); ++i) {
1138 if (!First[i]->is(Kinds[i]) || First[i]->WhitespaceRange.getBegin() !=
1139 First[i]->WhitespaceRange.getEnd())
1140 return false;
1141 AddLength += First[i]->TokenText.size();
1142 }
1143 Tokens.resize(Tokens.size() - Kinds.size() + 1);
1144 First[0]->TokenText = StringRef(First[0]->TokenText.data(),
1145 First[0]->TokenText.size() + AddLength);
1146 First[0]->ColumnWidth += AddLength;
Alexander Kornienko9aa62402013-11-21 12:43:57 +00001147 return true;
1148 }
1149
1150 bool tryMerge_TMacro() {
Alexander Kornienko81e32942013-09-16 20:20:49 +00001151 if (Tokens.size() < 4)
Alexander Kornienko9aa62402013-11-21 12:43:57 +00001152 return false;
Alexander Kornienko81e32942013-09-16 20:20:49 +00001153 FormatToken *Last = Tokens.back();
1154 if (!Last->is(tok::r_paren))
Alexander Kornienko9aa62402013-11-21 12:43:57 +00001155 return false;
Alexander Kornienko81e32942013-09-16 20:20:49 +00001156
1157 FormatToken *String = Tokens[Tokens.size() - 2];
1158 if (!String->is(tok::string_literal) || String->IsMultiline)
Alexander Kornienko9aa62402013-11-21 12:43:57 +00001159 return false;
Alexander Kornienko81e32942013-09-16 20:20:49 +00001160
1161 if (!Tokens[Tokens.size() - 3]->is(tok::l_paren))
Alexander Kornienko9aa62402013-11-21 12:43:57 +00001162 return false;
Alexander Kornienko81e32942013-09-16 20:20:49 +00001163
1164 FormatToken *Macro = Tokens[Tokens.size() - 4];
1165 if (Macro->TokenText != "_T")
Alexander Kornienko9aa62402013-11-21 12:43:57 +00001166 return false;
Alexander Kornienko81e32942013-09-16 20:20:49 +00001167
1168 const char *Start = Macro->TokenText.data();
1169 const char *End = Last->TokenText.data() + Last->TokenText.size();
1170 String->TokenText = StringRef(Start, End - Start);
1171 String->IsFirst = Macro->IsFirst;
1172 String->LastNewlineOffset = Macro->LastNewlineOffset;
1173 String->WhitespaceRange = Macro->WhitespaceRange;
1174 String->OriginalColumn = Macro->OriginalColumn;
1175 String->ColumnWidth = encoding::columnWidthWithTabs(
1176 String->TokenText, String->OriginalColumn, Style.TabWidth, Encoding);
1177
1178 Tokens.pop_back();
1179 Tokens.pop_back();
1180 Tokens.pop_back();
1181 Tokens.back() = String;
Alexander Kornienko9aa62402013-11-21 12:43:57 +00001182 return true;
Alexander Kornienko81e32942013-09-16 20:20:49 +00001183 }
1184
Manuel Klimek15dfe7a2013-05-28 11:55:06 +00001185 FormatToken *getNextToken() {
Alexander Kornienkoe3276842012-12-07 16:15:44 +00001186 if (GreaterStashed) {
Manuel Klimek591ab5a2013-05-28 13:42:28 +00001187 // Create a synthesized second '>' token.
Manuel Klimek31c85922013-08-29 15:21:40 +00001188 // FIXME: Increment Column and set OriginalColumn.
Manuel Klimek591ab5a2013-05-28 13:42:28 +00001189 Token Greater = FormatTok->Tok;
1190 FormatTok = new (Allocator.Allocate()) FormatToken;
1191 FormatTok->Tok = Greater;
Manuel Klimek5c24cca2013-05-23 10:56:37 +00001192 SourceLocation GreaterLocation =
Manuel Klimek15dfe7a2013-05-28 11:55:06 +00001193 FormatTok->Tok.getLocation().getLocWithOffset(1);
1194 FormatTok->WhitespaceRange =
1195 SourceRange(GreaterLocation, GreaterLocation);
Alexander Kornienkoee4ca9b2013-06-07 17:45:07 +00001196 FormatTok->TokenText = ">";
Alexander Kornienko39856b72013-09-10 09:38:25 +00001197 FormatTok->ColumnWidth = 1;
Alexander Kornienkoe3276842012-12-07 16:15:44 +00001198 GreaterStashed = false;
1199 return FormatTok;
1200 }
1201
Manuel Klimek15dfe7a2013-05-28 11:55:06 +00001202 FormatTok = new (Allocator.Allocate()) FormatToken;
Daniel Jasper8369aa52013-07-16 20:28:33 +00001203 readRawToken(*FormatTok);
Manuel Klimek9043c742013-05-27 15:23:34 +00001204 SourceLocation WhitespaceStart =
Manuel Klimek15dfe7a2013-05-28 11:55:06 +00001205 FormatTok->Tok.getLocation().getLocWithOffset(-TrailingWhitespace);
Alexander Kornienko393e3082013-11-13 14:04:17 +00001206 FormatTok->IsFirst = IsFirstToken;
1207 IsFirstToken = false;
Alexander Kornienkoe3276842012-12-07 16:15:44 +00001208
1209 // Consume and record whitespace until we find a significant token.
Manuel Klimek9043c742013-05-27 15:23:34 +00001210 unsigned WhitespaceLength = TrailingWhitespace;
Manuel Klimek15dfe7a2013-05-28 11:55:06 +00001211 while (FormatTok->Tok.is(tok::unknown)) {
Manuel Klimek31c85922013-08-29 15:21:40 +00001212 for (int i = 0, e = FormatTok->TokenText.size(); i != e; ++i) {
1213 switch (FormatTok->TokenText[i]) {
1214 case '\n':
1215 ++FormatTok->NewlinesBefore;
1216 // FIXME: This is technically incorrect, as it could also
1217 // be a literal backslash at the end of the line.
Alexander Kornienko9e649af2013-09-11 12:25:57 +00001218 if (i == 0 || (FormatTok->TokenText[i - 1] != '\\' &&
1219 (FormatTok->TokenText[i - 1] != '\r' || i == 1 ||
1220 FormatTok->TokenText[i - 2] != '\\')))
Manuel Klimek31c85922013-08-29 15:21:40 +00001221 FormatTok->HasUnescapedNewline = true;
1222 FormatTok->LastNewlineOffset = WhitespaceLength + i + 1;
1223 Column = 0;
1224 break;
Daniel Jasper877615c2013-10-11 19:45:02 +00001225 case '\r':
1226 case '\f':
1227 case '\v':
1228 Column = 0;
1229 break;
Manuel Klimek31c85922013-08-29 15:21:40 +00001230 case ' ':
1231 ++Column;
1232 break;
1233 case '\t':
Alexander Kornienkoebb43ca2013-09-05 14:08:34 +00001234 Column += Style.TabWidth - Column % Style.TabWidth;
Manuel Klimek31c85922013-08-29 15:21:40 +00001235 break;
Daniel Jasper877615c2013-10-11 19:45:02 +00001236 case '\\':
1237 ++Column;
1238 if (i + 1 == e || (FormatTok->TokenText[i + 1] != '\r' &&
1239 FormatTok->TokenText[i + 1] != '\n'))
1240 FormatTok->Type = TT_ImplicitStringLiteral;
1241 break;
Manuel Klimek31c85922013-08-29 15:21:40 +00001242 default:
Daniel Jasper877615c2013-10-11 19:45:02 +00001243 FormatTok->Type = TT_ImplicitStringLiteral;
Manuel Klimek31c85922013-08-29 15:21:40 +00001244 ++Column;
1245 break;
1246 }
1247 }
1248
Daniel Jasper877615c2013-10-11 19:45:02 +00001249 if (FormatTok->Type == TT_ImplicitStringLiteral)
1250 break;
Manuel Klimek15dfe7a2013-05-28 11:55:06 +00001251 WhitespaceLength += FormatTok->Tok.getLength();
Alexander Kornienkoe3276842012-12-07 16:15:44 +00001252
Daniel Jasper8369aa52013-07-16 20:28:33 +00001253 readRawToken(*FormatTok);
Manuel Klimek1abf7892013-01-04 23:34:14 +00001254 }
Manuel Klimekef920692013-01-07 07:56:50 +00001255
Manuel Klimek1abf7892013-01-04 23:34:14 +00001256 // In case the token starts with escaped newlines, we want to
1257 // take them into account as whitespace - this pattern is quite frequent
1258 // in macro definitions.
Manuel Klimek1abf7892013-01-04 23:34:14 +00001259 // FIXME: Add a more explicit test.
Daniel Jasper8369aa52013-07-16 20:28:33 +00001260 while (FormatTok->TokenText.size() > 1 && FormatTok->TokenText[0] == '\\' &&
1261 FormatTok->TokenText[1] == '\n') {
Manuel Klimek15dfe7a2013-05-28 11:55:06 +00001262 // FIXME: ++FormatTok->NewlinesBefore is missing...
Manuel Klimek5c24cca2013-05-23 10:56:37 +00001263 WhitespaceLength += 2;
Manuel Klimek31c85922013-08-29 15:21:40 +00001264 Column = 0;
Daniel Jasper8369aa52013-07-16 20:28:33 +00001265 FormatTok->TokenText = FormatTok->TokenText.substr(2);
Alexander Kornienkoe3276842012-12-07 16:15:44 +00001266 }
Alexander Kornienko39856b72013-09-10 09:38:25 +00001267
1268 FormatTok->WhitespaceRange = SourceRange(
1269 WhitespaceStart, WhitespaceStart.getLocWithOffset(WhitespaceLength));
1270
Manuel Klimek31c85922013-08-29 15:21:40 +00001271 FormatTok->OriginalColumn = Column;
Alexander Kornienkoe3276842012-12-07 16:15:44 +00001272
Alexander Kornienkoee4ca9b2013-06-07 17:45:07 +00001273 TrailingWhitespace = 0;
1274 if (FormatTok->Tok.is(tok::comment)) {
Manuel Klimek31c85922013-08-29 15:21:40 +00001275 // FIXME: Add the trimmed whitespace to Column.
Daniel Jasper8369aa52013-07-16 20:28:33 +00001276 StringRef UntrimmedText = FormatTok->TokenText;
Alexander Kornienko9ab4a772013-09-06 17:24:54 +00001277 FormatTok->TokenText = FormatTok->TokenText.rtrim(" \t\v\f");
Daniel Jasper8369aa52013-07-16 20:28:33 +00001278 TrailingWhitespace = UntrimmedText.size() - FormatTok->TokenText.size();
Alexander Kornienkoee4ca9b2013-06-07 17:45:07 +00001279 } else if (FormatTok->Tok.is(tok::raw_identifier)) {
Daniel Jasper8369aa52013-07-16 20:28:33 +00001280 IdentifierInfo &Info = IdentTable.get(FormatTok->TokenText);
Manuel Klimek15dfe7a2013-05-28 11:55:06 +00001281 FormatTok->Tok.setIdentifierInfo(&Info);
1282 FormatTok->Tok.setKind(Info.getTokenID());
Alexander Kornienkoee4ca9b2013-06-07 17:45:07 +00001283 } else if (FormatTok->Tok.is(tok::greatergreater)) {
Manuel Klimek15dfe7a2013-05-28 11:55:06 +00001284 FormatTok->Tok.setKind(tok::greater);
Daniel Jasper8369aa52013-07-16 20:28:33 +00001285 FormatTok->TokenText = FormatTok->TokenText.substr(0, 1);
Alexander Kornienkoe3276842012-12-07 16:15:44 +00001286 GreaterStashed = true;
1287 }
1288
Alexander Kornienkoee4ca9b2013-06-07 17:45:07 +00001289 // Now FormatTok is the next non-whitespace token.
Alexander Kornienkoffcc0102013-06-05 14:09:10 +00001290
Alexander Kornienko39856b72013-09-10 09:38:25 +00001291 StringRef Text = FormatTok->TokenText;
1292 size_t FirstNewlinePos = Text.find('\n');
Alexander Kornienko917f9e02013-09-10 12:29:48 +00001293 if (FirstNewlinePos == StringRef::npos) {
1294 // FIXME: ColumnWidth actually depends on the start column, we need to
1295 // take this into account when the token is moved.
1296 FormatTok->ColumnWidth =
1297 encoding::columnWidthWithTabs(Text, Column, Style.TabWidth, Encoding);
1298 Column += FormatTok->ColumnWidth;
1299 } else {
Alexander Kornienko39856b72013-09-10 09:38:25 +00001300 FormatTok->IsMultiline = true;
Alexander Kornienko917f9e02013-09-10 12:29:48 +00001301 // FIXME: ColumnWidth actually depends on the start column, we need to
1302 // take this into account when the token is moved.
1303 FormatTok->ColumnWidth = encoding::columnWidthWithTabs(
1304 Text.substr(0, FirstNewlinePos), Column, Style.TabWidth, Encoding);
1305
Alexander Kornienko39856b72013-09-10 09:38:25 +00001306 // The last line of the token always starts in column 0.
1307 // Thus, the length can be precomputed even in the presence of tabs.
1308 FormatTok->LastLineColumnWidth = encoding::columnWidthWithTabs(
1309 Text.substr(Text.find_last_of('\n') + 1), 0, Style.TabWidth,
1310 Encoding);
Alexander Kornienko917f9e02013-09-10 12:29:48 +00001311 Column = FormatTok->LastLineColumnWidth;
Alexander Kornienko632abb92013-09-02 13:58:14 +00001312 }
Alexander Kornienko39856b72013-09-10 09:38:25 +00001313
Alexander Kornienkoe3276842012-12-07 16:15:44 +00001314 return FormatTok;
1315 }
1316
Manuel Klimek15dfe7a2013-05-28 11:55:06 +00001317 FormatToken *FormatTok;
Alexander Kornienko393e3082013-11-13 14:04:17 +00001318 bool IsFirstToken;
Alexander Kornienkoe3276842012-12-07 16:15:44 +00001319 bool GreaterStashed;
Manuel Klimek31c85922013-08-29 15:21:40 +00001320 unsigned Column;
Manuel Klimek9043c742013-05-27 15:23:34 +00001321 unsigned TrailingWhitespace;
Alexander Kornienkoe3276842012-12-07 16:15:44 +00001322 Lexer &Lex;
1323 SourceManager &SourceMgr;
Manuel Klimek31c85922013-08-29 15:21:40 +00001324 FormatStyle &Style;
Alexander Kornienkoe3276842012-12-07 16:15:44 +00001325 IdentifierTable IdentTable;
Alexander Kornienkoffcc0102013-06-05 14:09:10 +00001326 encoding::Encoding Encoding;
Manuel Klimek15dfe7a2013-05-28 11:55:06 +00001327 llvm::SpecificBumpPtrAllocator<FormatToken> Allocator;
1328 SmallVector<FormatToken *, 16> Tokens;
Alexander Kornienkoe3276842012-12-07 16:15:44 +00001329
Daniel Jasper8369aa52013-07-16 20:28:33 +00001330 void readRawToken(FormatToken &Tok) {
1331 Lex.LexFromRawLexer(Tok.Tok);
1332 Tok.TokenText = StringRef(SourceMgr.getCharacterData(Tok.Tok.getLocation()),
1333 Tok.Tok.getLength());
Daniel Jasper8369aa52013-07-16 20:28:33 +00001334 // For formatting, treat unterminated string literals like normal string
1335 // literals.
1336 if (Tok.is(tok::unknown) && !Tok.TokenText.empty() &&
1337 Tok.TokenText[0] == '"') {
1338 Tok.Tok.setKind(tok::string_literal);
1339 Tok.IsUnterminatedLiteral = true;
1340 }
Alexander Kornienkoe3276842012-12-07 16:15:44 +00001341 }
1342};
1343
Alexander Kornienkocabdd732013-11-29 15:19:43 +00001344static StringRef getLanguageName(FormatStyle::LanguageKind Language) {
1345 switch (Language) {
1346 case FormatStyle::LK_Cpp:
1347 return "C++";
1348 case FormatStyle::LK_JavaScript:
1349 return "JavaScript";
1350 default:
1351 return "Unknown";
1352 }
1353}
1354
Daniel Jasperf7935112012-12-03 18:12:45 +00001355class Formatter : public UnwrappedLineConsumer {
1356public:
Daniel Jasperd2ae41a2013-05-15 08:14:19 +00001357 Formatter(const FormatStyle &Style, Lexer &Lex, SourceManager &SourceMgr,
Daniel Jasperf7935112012-12-03 18:12:45 +00001358 const std::vector<CharSourceRange> &Ranges)
Daniel Jasperd2ae41a2013-05-15 08:14:19 +00001359 : Style(Style), Lex(Lex), SourceMgr(SourceMgr),
Alexander Kornienko9e649af2013-09-11 12:25:57 +00001360 Whitespaces(SourceMgr, Style, inputUsesCRLF(Lex.getBuffer())),
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +00001361 Ranges(Ranges.begin(), Ranges.end()), UnwrappedLines(1),
Manuel Klimek71814b42013-10-11 21:25:45 +00001362 Encoding(encoding::detectEncoding(Lex.getBuffer())) {
Daniel Jasperfa21c072013-07-15 14:33:14 +00001363 DEBUG(llvm::dbgs() << "File encoding: "
1364 << (Encoding == encoding::Encoding_UTF8 ? "UTF8"
1365 : "unknown")
1366 << "\n");
Alexander Kornienkocabdd732013-11-29 15:19:43 +00001367 DEBUG(llvm::dbgs() << "Language: " << getLanguageName(Style.Language)
1368 << "\n");
Alexander Kornienkoffcc0102013-06-05 14:09:10 +00001369 }
Daniel Jasperf7935112012-12-03 18:12:45 +00001370
Alexander Kornienko62b85b92013-03-13 14:41:29 +00001371 tooling::Replacements format() {
Manuel Klimek71814b42013-10-11 21:25:45 +00001372 tooling::Replacements Result;
Manuel Klimek31c85922013-08-29 15:21:40 +00001373 FormatTokenLexer Tokens(Lex, SourceMgr, Style, Encoding);
Manuel Klimek15dfe7a2013-05-28 11:55:06 +00001374
1375 UnwrappedLineParser Parser(Style, Tokens.lex(), *this);
Manuel Klimek1a18c402013-04-12 14:13:36 +00001376 bool StructuralError = Parser.parse();
Manuel Klimek71814b42013-10-11 21:25:45 +00001377 assert(UnwrappedLines.rbegin()->empty());
1378 for (unsigned Run = 0, RunE = UnwrappedLines.size(); Run + 1 != RunE;
1379 ++Run) {
1380 DEBUG(llvm::dbgs() << "Run " << Run << "...\n");
1381 SmallVector<AnnotatedLine *, 16> AnnotatedLines;
1382 for (unsigned i = 0, e = UnwrappedLines[Run].size(); i != e; ++i) {
1383 AnnotatedLines.push_back(new AnnotatedLine(UnwrappedLines[Run][i]));
1384 }
1385 tooling::Replacements RunResult =
1386 format(AnnotatedLines, StructuralError, Tokens);
1387 DEBUG({
1388 llvm::dbgs() << "Replacements for run " << Run << ":\n";
1389 for (tooling::Replacements::iterator I = RunResult.begin(),
1390 E = RunResult.end();
1391 I != E; ++I) {
1392 llvm::dbgs() << I->toString() << "\n";
1393 }
1394 });
1395 for (unsigned i = 0, e = AnnotatedLines.size(); i != e; ++i) {
1396 delete AnnotatedLines[i];
1397 }
1398 Result.insert(RunResult.begin(), RunResult.end());
1399 Whitespaces.reset();
1400 }
1401 return Result;
1402 }
1403
1404 tooling::Replacements format(SmallVectorImpl<AnnotatedLine *> &AnnotatedLines,
1405 bool StructuralError, FormatTokenLexer &Tokens) {
Alexander Kornienkoffcc0102013-06-05 14:09:10 +00001406 TokenAnnotator Annotator(Style, Tokens.getIdentTable().get("in"));
Alexander Kornienko62b85b92013-03-13 14:41:29 +00001407 for (unsigned i = 0, e = AnnotatedLines.size(); i != e; ++i) {
Daniel Jasper9fe0e8d2013-09-05 09:29:45 +00001408 Annotator.annotate(*AnnotatedLines[i]);
Alexander Kornienko62b85b92013-03-13 14:41:29 +00001409 }
Manuel Klimek71814b42013-10-11 21:25:45 +00001410 deriveLocalStyle(AnnotatedLines);
Alexander Kornienko62b85b92013-03-13 14:41:29 +00001411 for (unsigned i = 0, e = AnnotatedLines.size(); i != e; ++i) {
Daniel Jasper9fe0e8d2013-09-05 09:29:45 +00001412 Annotator.calculateFormattingInformation(*AnnotatedLines[i]);
Alexander Kornienko62b85b92013-03-13 14:41:29 +00001413 }
Daniel Jasper5500f612013-11-25 11:08:59 +00001414 computeAffectedLines(AnnotatedLines.begin(), AnnotatedLines.end());
Daniel Jasperb67cc422013-04-09 17:46:55 +00001415
Daniel Jasper1c5d9df2013-09-06 07:54:20 +00001416 Annotator.setCommentLineLevels(AnnotatedLines);
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +00001417 ContinuationIndenter Indenter(Style, SourceMgr, Whitespaces, Encoding,
1418 BinPackInconclusiveFunctions);
Daniel Jasper5500f612013-11-25 11:08:59 +00001419 UnwrappedLineFormatter Formatter(&Indenter, &Whitespaces, Style);
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +00001420 Formatter.format(AnnotatedLines, /*DryRun=*/false);
Alexander Kornienko62b85b92013-03-13 14:41:29 +00001421 return Whitespaces.generateReplacements();
1422 }
1423
1424private:
Daniel Jasper5500f612013-11-25 11:08:59 +00001425 // Determines which lines are affected by the SourceRanges given as input.
Daniel Jasper9c199562013-11-28 15:58:55 +00001426 // Returns \c true if at least one line between I and E or one of their
1427 // children is affected.
Daniel Jasper5500f612013-11-25 11:08:59 +00001428 bool computeAffectedLines(SmallVectorImpl<AnnotatedLine *>::iterator I,
1429 SmallVectorImpl<AnnotatedLine *>::iterator E) {
1430 bool SomeLineAffected = false;
Daniel Jasper38c82402013-11-29 09:27:43 +00001431 const AnnotatedLine *PreviousLine = NULL;
Daniel Jasper5500f612013-11-25 11:08:59 +00001432 while (I != E) {
1433 AnnotatedLine *Line = *I;
1434 Line->LeadingEmptyLinesAffected = affectsLeadingEmptyLines(*Line->First);
1435
1436 // If a line is part of a preprocessor directive, it needs to be formatted
1437 // if any token within the directive is affected.
1438 if (Line->InPPDirective) {
1439 FormatToken *Last = Line->Last;
1440 SmallVectorImpl<AnnotatedLine *>::iterator PPEnd = I + 1;
1441 while (PPEnd != E && !(*PPEnd)->First->HasUnescapedNewline) {
1442 Last = (*PPEnd)->Last;
1443 ++PPEnd;
1444 }
1445
1446 if (affectsTokenRange(*Line->First, *Last,
1447 /*IncludeLeadingNewlines=*/false)) {
1448 SomeLineAffected = true;
1449 markAllAsAffected(I, PPEnd);
1450 }
1451 I = PPEnd;
1452 continue;
1453 }
1454
Daniel Jasper38c82402013-11-29 09:27:43 +00001455 if (nonPPLineAffected(Line, PreviousLine))
Daniel Jasper5500f612013-11-25 11:08:59 +00001456 SomeLineAffected = true;
Daniel Jasper5500f612013-11-25 11:08:59 +00001457
Daniel Jasper38c82402013-11-29 09:27:43 +00001458 PreviousLine = Line;
Daniel Jasper5500f612013-11-25 11:08:59 +00001459 ++I;
1460 }
1461 return SomeLineAffected;
1462 }
1463
Daniel Jasper9c199562013-11-28 15:58:55 +00001464 // Determines whether 'Line' is affected by the SourceRanges given as input.
1465 // Returns \c true if line or one if its children is affected.
Daniel Jasper38c82402013-11-29 09:27:43 +00001466 bool nonPPLineAffected(AnnotatedLine *Line,
1467 const AnnotatedLine *PreviousLine) {
Daniel Jasper9c199562013-11-28 15:58:55 +00001468 bool SomeLineAffected = false;
1469 Line->ChildrenAffected =
1470 computeAffectedLines(Line->Children.begin(), Line->Children.end());
1471 if (Line->ChildrenAffected)
1472 SomeLineAffected = true;
1473
1474 // Stores whether one of the line's tokens is directly affected.
1475 bool SomeTokenAffected = false;
1476 // Stores whether we need to look at the leading newlines of the next token
1477 // in order to determine whether it was affected.
1478 bool IncludeLeadingNewlines = false;
1479
1480 // Stores whether the first child line of any of this line's tokens is
1481 // affected.
1482 bool SomeFirstChildAffected = false;
1483
1484 for (FormatToken *Tok = Line->First; Tok; Tok = Tok->Next) {
1485 // Determine whether 'Tok' was affected.
1486 if (affectsTokenRange(*Tok, *Tok, IncludeLeadingNewlines))
1487 SomeTokenAffected = true;
1488
1489 // Determine whether the first child of 'Tok' was affected.
1490 if (!Tok->Children.empty() && Tok->Children.front()->Affected)
1491 SomeFirstChildAffected = true;
1492
1493 IncludeLeadingNewlines = Tok->Children.empty();
1494 }
1495
1496 // Was this line moved, i.e. has it previously been on the same line as an
1497 // affected line?
Daniel Jasper38c82402013-11-29 09:27:43 +00001498 bool LineMoved = PreviousLine && PreviousLine->Affected &&
1499 Line->First->NewlinesBefore == 0;
Daniel Jasper9c199562013-11-28 15:58:55 +00001500
Daniel Jasper38c82402013-11-29 09:27:43 +00001501 bool IsContinuedComment = Line->First->is(tok::comment) &&
1502 Line->First->Next == NULL &&
1503 Line->First->NewlinesBefore < 2 && PreviousLine &&
Daniel Jasper0e81f1a2013-12-02 09:19:27 +00001504 PreviousLine->Affected &&
Daniel Jasper38c82402013-11-29 09:27:43 +00001505 PreviousLine->Last->is(tok::comment);
1506
1507 if (SomeTokenAffected || SomeFirstChildAffected || LineMoved ||
1508 IsContinuedComment) {
Daniel Jasper9c199562013-11-28 15:58:55 +00001509 Line->Affected = true;
Daniel Jasper9c199562013-11-28 15:58:55 +00001510 SomeLineAffected = true;
Daniel Jasper9c199562013-11-28 15:58:55 +00001511 }
1512 return SomeLineAffected;
1513 }
1514
Daniel Jasper5500f612013-11-25 11:08:59 +00001515 // Marks all lines between I and E as well as all their children as affected.
1516 void markAllAsAffected(SmallVectorImpl<AnnotatedLine *>::iterator I,
1517 SmallVectorImpl<AnnotatedLine *>::iterator E) {
1518 while (I != E) {
1519 (*I)->Affected = true;
1520 markAllAsAffected((*I)->Children.begin(), (*I)->Children.end());
1521 ++I;
1522 }
1523 }
1524
1525 // Returns true if the range from 'First' to 'Last' intersects with one of the
1526 // input ranges.
1527 bool affectsTokenRange(const FormatToken &First, const FormatToken &Last,
1528 bool IncludeLeadingNewlines) {
1529 SourceLocation Start = First.WhitespaceRange.getBegin();
1530 if (!IncludeLeadingNewlines)
1531 Start = Start.getLocWithOffset(First.LastNewlineOffset);
Daniel Jasper5877bf12013-11-25 11:53:05 +00001532 SourceLocation End = Last.getStartOfNonWhitespace();
1533 if (Last.TokenText.size() > 0)
1534 End = End.getLocWithOffset(Last.TokenText.size() - 1);
Daniel Jasper5500f612013-11-25 11:08:59 +00001535 CharSourceRange Range = CharSourceRange::getCharRange(Start, End);
1536 return affectsCharSourceRange(Range);
1537 }
1538
1539 // Returns true if one of the input ranges intersect the leading empty lines
1540 // before 'Tok'.
1541 bool affectsLeadingEmptyLines(const FormatToken &Tok) {
1542 CharSourceRange EmptyLineRange = CharSourceRange::getCharRange(
1543 Tok.WhitespaceRange.getBegin(),
1544 Tok.WhitespaceRange.getBegin().getLocWithOffset(Tok.LastNewlineOffset));
1545 return affectsCharSourceRange(EmptyLineRange);
1546 }
1547
1548 // Returns true if 'Range' intersects with one of the input ranges.
1549 bool affectsCharSourceRange(const CharSourceRange &Range) {
1550 for (SmallVectorImpl<CharSourceRange>::const_iterator I = Ranges.begin(),
1551 E = Ranges.end();
1552 I != E; ++I) {
1553 if (!SourceMgr.isBeforeInTranslationUnit(Range.getEnd(), I->getBegin()) &&
1554 !SourceMgr.isBeforeInTranslationUnit(I->getEnd(), Range.getBegin()))
1555 return true;
1556 }
1557 return false;
1558 }
1559
Alexander Kornienko9e649af2013-09-11 12:25:57 +00001560 static bool inputUsesCRLF(StringRef Text) {
1561 return Text.count('\r') * 2 > Text.count('\n');
1562 }
1563
Manuel Klimek71814b42013-10-11 21:25:45 +00001564 void
1565 deriveLocalStyle(const SmallVectorImpl<AnnotatedLine *> &AnnotatedLines) {
Daniel Jasper7fce3ab2013-02-06 14:22:40 +00001566 unsigned CountBoundToVariable = 0;
1567 unsigned CountBoundToType = 0;
1568 bool HasCpp03IncompatibleFormat = false;
Daniel Jasperb10cbc42013-07-10 14:02:49 +00001569 bool HasBinPackedFunction = false;
1570 bool HasOnePerLineFunction = false;
Daniel Jasper7fce3ab2013-02-06 14:22:40 +00001571 for (unsigned i = 0, e = AnnotatedLines.size(); i != e; ++i) {
Daniel Jasper9fe0e8d2013-09-05 09:29:45 +00001572 if (!AnnotatedLines[i]->First->Next)
Daniel Jasper7fce3ab2013-02-06 14:22:40 +00001573 continue;
Daniel Jasper9fe0e8d2013-09-05 09:29:45 +00001574 FormatToken *Tok = AnnotatedLines[i]->First->Next;
Manuel Klimek6e6310e2013-05-29 14:47:47 +00001575 while (Tok->Next) {
Daniel Jasper7fce3ab2013-02-06 14:22:40 +00001576 if (Tok->Type == TT_PointerOrReference) {
Manuel Klimek6e6310e2013-05-29 14:47:47 +00001577 bool SpacesBefore =
1578 Tok->WhitespaceRange.getBegin() != Tok->WhitespaceRange.getEnd();
1579 bool SpacesAfter = Tok->Next->WhitespaceRange.getBegin() !=
1580 Tok->Next->WhitespaceRange.getEnd();
Daniel Jasper7fce3ab2013-02-06 14:22:40 +00001581 if (SpacesBefore && !SpacesAfter)
1582 ++CountBoundToVariable;
1583 else if (!SpacesBefore && SpacesAfter)
1584 ++CountBoundToType;
1585 }
1586
Daniel Jasperfba84ff2013-10-12 05:16:06 +00001587 if (Tok->WhitespaceRange.getBegin() == Tok->WhitespaceRange.getEnd()) {
1588 if (Tok->is(tok::coloncolon) &&
1589 Tok->Previous->Type == TT_TemplateOpener)
1590 HasCpp03IncompatibleFormat = true;
1591 if (Tok->Type == TT_TemplateCloser &&
1592 Tok->Previous->Type == TT_TemplateCloser)
1593 HasCpp03IncompatibleFormat = true;
1594 }
Daniel Jasperb10cbc42013-07-10 14:02:49 +00001595
1596 if (Tok->PackingKind == PPK_BinPacked)
1597 HasBinPackedFunction = true;
1598 if (Tok->PackingKind == PPK_OnePerLine)
1599 HasOnePerLineFunction = true;
1600
Manuel Klimek6e6310e2013-05-29 14:47:47 +00001601 Tok = Tok->Next;
Daniel Jasper7fce3ab2013-02-06 14:22:40 +00001602 }
1603 }
1604 if (Style.DerivePointerBinding) {
1605 if (CountBoundToType > CountBoundToVariable)
1606 Style.PointerBindsToType = true;
1607 else if (CountBoundToType < CountBoundToVariable)
1608 Style.PointerBindsToType = false;
1609 }
1610 if (Style.Standard == FormatStyle::LS_Auto) {
1611 Style.Standard = HasCpp03IncompatibleFormat ? FormatStyle::LS_Cpp11
1612 : FormatStyle::LS_Cpp03;
1613 }
Daniel Jasperb10cbc42013-07-10 14:02:49 +00001614 BinPackInconclusiveFunctions =
1615 HasBinPackedFunction || !HasOnePerLineFunction;
Daniel Jasper7fce3ab2013-02-06 14:22:40 +00001616 }
1617
Manuel Klimek51bd6ec2013-01-10 19:49:59 +00001618 virtual void consumeUnwrappedLine(const UnwrappedLine &TheLine) {
Manuel Klimek71814b42013-10-11 21:25:45 +00001619 assert(!UnwrappedLines.empty());
1620 UnwrappedLines.back().push_back(TheLine);
1621 }
1622
1623 virtual void finishRun() {
1624 UnwrappedLines.push_back(SmallVector<UnwrappedLine, 16>());
Daniel Jasperf7935112012-12-03 18:12:45 +00001625 }
1626
1627 FormatStyle Style;
1628 Lexer &Lex;
1629 SourceManager &SourceMgr;
Daniel Jasperaa701fa2013-01-18 08:44:07 +00001630 WhitespaceManager Whitespaces;
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +00001631 SmallVector<CharSourceRange, 8> Ranges;
Manuel Klimek71814b42013-10-11 21:25:45 +00001632 SmallVector<SmallVector<UnwrappedLine, 16>, 2> UnwrappedLines;
Alexander Kornienkoffcc0102013-06-05 14:09:10 +00001633
1634 encoding::Encoding Encoding;
Daniel Jasperb10cbc42013-07-10 14:02:49 +00001635 bool BinPackInconclusiveFunctions;
Daniel Jasperf7935112012-12-03 18:12:45 +00001636};
1637
Craig Topperaf35e852013-06-30 22:29:28 +00001638} // end anonymous namespace
1639
Alexander Kornienkocb45bc12013-04-15 14:28:00 +00001640tooling::Replacements reformat(const FormatStyle &Style, Lexer &Lex,
1641 SourceManager &SourceMgr,
Daniel Jasperd2ae41a2013-05-15 08:14:19 +00001642 std::vector<CharSourceRange> Ranges) {
1643 Formatter formatter(Style, Lex, SourceMgr, Ranges);
Daniel Jasperf7935112012-12-03 18:12:45 +00001644 return formatter.format();
1645}
1646
Daniel Jasperec04c0d2013-05-16 10:40:07 +00001647tooling::Replacements reformat(const FormatStyle &Style, StringRef Code,
1648 std::vector<tooling::Range> Ranges,
1649 StringRef FileName) {
1650 FileManager Files((FileSystemOptions()));
1651 DiagnosticsEngine Diagnostics(
1652 IntrusiveRefCntPtr<DiagnosticIDs>(new DiagnosticIDs),
1653 new DiagnosticOptions);
1654 SourceManager SourceMgr(Diagnostics, Files);
1655 llvm::MemoryBuffer *Buf = llvm::MemoryBuffer::getMemBuffer(Code, FileName);
1656 const clang::FileEntry *Entry =
1657 Files.getVirtualFile(FileName, Buf->getBufferSize(), 0);
1658 SourceMgr.overrideFileContents(Entry, Buf);
1659 FileID ID =
1660 SourceMgr.createFileID(Entry, SourceLocation(), clang::SrcMgr::C_User);
Alexander Kornienko1e808872013-06-28 12:51:24 +00001661 Lexer Lex(ID, SourceMgr.getBuffer(ID), SourceMgr,
1662 getFormattingLangOpts(Style.Standard));
Daniel Jasperec04c0d2013-05-16 10:40:07 +00001663 SourceLocation StartOfFile = SourceMgr.getLocForStartOfFile(ID);
1664 std::vector<CharSourceRange> CharRanges;
1665 for (unsigned i = 0, e = Ranges.size(); i != e; ++i) {
1666 SourceLocation Start = StartOfFile.getLocWithOffset(Ranges[i].getOffset());
1667 SourceLocation End = Start.getLocWithOffset(Ranges[i].getLength());
1668 CharRanges.push_back(CharSourceRange::getCharRange(Start, End));
1669 }
1670 return reformat(Style, Lex, SourceMgr, CharRanges);
1671}
1672
Alexander Kornienko1e808872013-06-28 12:51:24 +00001673LangOptions getFormattingLangOpts(FormatStyle::LanguageStandard Standard) {
Daniel Jasperc1fa2812013-01-10 13:08:12 +00001674 LangOptions LangOpts;
1675 LangOpts.CPlusPlus = 1;
Alexander Kornienko1e808872013-06-28 12:51:24 +00001676 LangOpts.CPlusPlus11 = Standard == FormatStyle::LS_Cpp03 ? 0 : 1;
Daniel Jasper55213652013-03-22 10:01:29 +00001677 LangOpts.LineComment = 1;
Daniel Jasperc1fa2812013-01-10 13:08:12 +00001678 LangOpts.Bool = 1;
1679 LangOpts.ObjC1 = 1;
1680 LangOpts.ObjC2 = 1;
1681 return LangOpts;
1682}
1683
Edwin Vaned544aa72013-09-30 13:31:48 +00001684const char *StyleOptionHelpDescription =
1685 "Coding style, currently supports:\n"
1686 " LLVM, Google, Chromium, Mozilla, WebKit.\n"
1687 "Use -style=file to load style configuration from\n"
1688 ".clang-format file located in one of the parent\n"
1689 "directories of the source file (or current\n"
1690 "directory for stdin).\n"
1691 "Use -style=\"{key: value, ...}\" to set specific\n"
1692 "parameters, e.g.:\n"
1693 " -style=\"{BasedOnStyle: llvm, IndentWidth: 8}\"";
1694
Alexander Kornienkoc1637f12013-12-10 11:28:13 +00001695static FormatStyle::LanguageKind getLanguageByFileName(StringRef FileName) {
Alexander Kornienkocabdd732013-11-29 15:19:43 +00001696 if (FileName.endswith_lower(".js")) {
Alexander Kornienkoc1637f12013-12-10 11:28:13 +00001697 return FormatStyle::LK_JavaScript;
Alexander Kornienkocabdd732013-11-29 15:19:43 +00001698 }
Alexander Kornienkoc1637f12013-12-10 11:28:13 +00001699 return FormatStyle::LK_Cpp;
Alexander Kornienkocabdd732013-11-29 15:19:43 +00001700}
1701
Alexander Kornienkobc4ae442013-12-02 15:21:38 +00001702FormatStyle getStyle(StringRef StyleName, StringRef FileName,
1703 StringRef FallbackStyle) {
Alexander Kornienkoc1637f12013-12-10 11:28:13 +00001704 FormatStyle Style = getLLVMStyle();
1705 Style.Language = getLanguageByFileName(FileName);
1706 if (!getPredefinedStyle(FallbackStyle, Style.Language, &Style)) {
Alexander Kornienkobc4ae442013-12-02 15:21:38 +00001707 llvm::errs() << "Invalid fallback style \"" << FallbackStyle
1708 << "\" using LLVM style\n";
Alexander Kornienkoc1637f12013-12-10 11:28:13 +00001709 return Style;
Alexander Kornienkobc4ae442013-12-02 15:21:38 +00001710 }
Edwin Vaned544aa72013-09-30 13:31:48 +00001711
1712 if (StyleName.startswith("{")) {
1713 // Parse YAML/JSON style from the command line.
1714 if (llvm::error_code ec = parseConfiguration(StyleName, &Style)) {
Alexander Kornienkoe2e03872013-10-14 00:46:35 +00001715 llvm::errs() << "Error parsing -style: " << ec.message() << ", using "
1716 << FallbackStyle << " style\n";
Edwin Vaned544aa72013-09-30 13:31:48 +00001717 }
1718 return Style;
1719 }
1720
1721 if (!StyleName.equals_lower("file")) {
Alexander Kornienkoc1637f12013-12-10 11:28:13 +00001722 if (!getPredefinedStyle(StyleName, Style.Language, &Style))
Edwin Vaned544aa72013-09-30 13:31:48 +00001723 llvm::errs() << "Invalid value for -style, using " << FallbackStyle
1724 << " style\n";
1725 return Style;
1726 }
1727
Alexander Kornienkoc1637f12013-12-10 11:28:13 +00001728 // Look for .clang-format/_clang-format file in the file's parent directories.
Alexander Kornienkocabdd732013-11-29 15:19:43 +00001729 SmallString<128> UnsuitableConfigFiles;
Edwin Vaned544aa72013-09-30 13:31:48 +00001730 SmallString<128> Path(FileName);
1731 llvm::sys::fs::make_absolute(Path);
Alexander Kornienkoe2e03872013-10-14 00:46:35 +00001732 for (StringRef Directory = Path; !Directory.empty();
Edwin Vaned544aa72013-09-30 13:31:48 +00001733 Directory = llvm::sys::path::parent_path(Directory)) {
1734 if (!llvm::sys::fs::is_directory(Directory))
1735 continue;
1736 SmallString<128> ConfigFile(Directory);
1737
1738 llvm::sys::path::append(ConfigFile, ".clang-format");
1739 DEBUG(llvm::dbgs() << "Trying " << ConfigFile << "...\n");
1740 bool IsFile = false;
1741 // Ignore errors from is_regular_file: we only need to know if we can read
1742 // the file or not.
1743 llvm::sys::fs::is_regular_file(Twine(ConfigFile), IsFile);
1744
1745 if (!IsFile) {
1746 // Try _clang-format too, since dotfiles are not commonly used on Windows.
1747 ConfigFile = Directory;
1748 llvm::sys::path::append(ConfigFile, "_clang-format");
1749 DEBUG(llvm::dbgs() << "Trying " << ConfigFile << "...\n");
1750 llvm::sys::fs::is_regular_file(Twine(ConfigFile), IsFile);
1751 }
1752
1753 if (IsFile) {
1754 OwningPtr<llvm::MemoryBuffer> Text;
Rafael Espindola1a3605c2013-10-25 19:00:49 +00001755 if (llvm::error_code ec =
1756 llvm::MemoryBuffer::getFile(ConfigFile.c_str(), Text)) {
Edwin Vaned544aa72013-09-30 13:31:48 +00001757 llvm::errs() << ec.message() << "\n";
Alexander Kornienkobc4ae442013-12-02 15:21:38 +00001758 break;
Edwin Vaned544aa72013-09-30 13:31:48 +00001759 }
1760 if (llvm::error_code ec = parseConfiguration(Text->getBuffer(), &Style)) {
Alexander Kornienkocabdd732013-11-29 15:19:43 +00001761 if (ec == llvm::errc::not_supported) {
1762 if (!UnsuitableConfigFiles.empty())
1763 UnsuitableConfigFiles.append(", ");
1764 UnsuitableConfigFiles.append(ConfigFile);
Alexander Kornienkobc4ae442013-12-02 15:21:38 +00001765 continue;
Alexander Kornienkocabdd732013-11-29 15:19:43 +00001766 }
Alexander Kornienkobc4ae442013-12-02 15:21:38 +00001767 llvm::errs() << "Error reading " << ConfigFile << ": " << ec.message()
1768 << "\n";
1769 break;
Edwin Vaned544aa72013-09-30 13:31:48 +00001770 }
1771 DEBUG(llvm::dbgs() << "Using configuration file " << ConfigFile << "\n");
1772 return Style;
1773 }
1774 }
1775 llvm::errs() << "Can't find usable .clang-format, using " << FallbackStyle
1776 << " style\n";
Alexander Kornienkocabdd732013-11-29 15:19:43 +00001777 if (!UnsuitableConfigFiles.empty()) {
1778 llvm::errs() << "Configuration file(s) do(es) not support "
1779 << getLanguageName(Style.Language) << ": "
1780 << UnsuitableConfigFiles << "\n";
1781 }
Edwin Vaned544aa72013-09-30 13:31:48 +00001782 return Style;
1783}
1784
Daniel Jasper8d1832e2013-01-07 13:26:07 +00001785} // namespace format
1786} // namespace clang