blob: a69570a15714d8b878ca735a2119b992a2013806 [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"
Edwin Vaned544aa72013-09-30 13:31:48 +000029#include "llvm/Support/Path.h"
Chandler Carruth5553d0d2014-01-07 11:51:46 +000030#include "llvm/Support/YAMLTraits.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 Jasperb2e10a52014-01-15 15:09:08 +0000193 IO.mapOptional("SpacesInContainerLiterals",
194 Style.SpacesInContainerLiterals);
Daniel Jasperd94bff32013-09-25 15:15:02 +0000195 IO.mapOptional("SpaceBeforeAssignmentOperators",
196 Style.SpaceBeforeAssignmentOperators);
Daniel Jasper6633ab82013-10-18 10:38:14 +0000197 IO.mapOptional("ContinuationIndentWidth", Style.ContinuationIndentWidth);
Alexander Kornienkoce9161a2014-01-02 15:13:14 +0000198 IO.mapOptional("CommentPragmas", Style.CommentPragmas);
Alexander Kornienkofdca83d2013-12-10 10:18:34 +0000199
200 // For backward compatibility.
201 if (!IO.outputting()) {
202 IO.mapOptional("SpaceAfterControlStatementKeyword",
203 Style.SpaceBeforeParens);
204 }
205 IO.mapOptional("SpaceBeforeParens", Style.SpaceBeforeParens);
Alexander Kornienkod6538332013-05-07 15:32:14 +0000206 }
207};
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000208
209// Allows to read vector<FormatStyle> while keeping default values.
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000210// IO.getContext() should contain a pointer to the FormatStyle structure, that
211// will be used to get default values for missing keys.
212// If the first element has no Language specified, it will be treated as the
213// default one for the following elements.
Alexander Kornienko6d2c88e2013-12-10 10:30:34 +0000214template <> struct DocumentListTraits<std::vector<FormatStyle> > {
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000215 static size_t size(IO &IO, std::vector<FormatStyle> &Seq) {
216 return Seq.size();
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000217 }
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000218 static FormatStyle &element(IO &IO, std::vector<FormatStyle> &Seq,
Alexander Kornienko6d2c88e2013-12-10 10:30:34 +0000219 size_t Index) {
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000220 if (Index >= Seq.size()) {
221 assert(Index == Seq.size());
Alexander Kornienko6d2c88e2013-12-10 10:30:34 +0000222 FormatStyle Template;
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000223 if (Seq.size() > 0 && Seq[0].Language == FormatStyle::LK_None) {
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000224 Template = Seq[0];
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000225 } else {
226 Template = *((const FormatStyle*)IO.getContext());
Alexander Kornienko6d2c88e2013-12-10 10:30:34 +0000227 Template.Language = FormatStyle::LK_None;
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000228 }
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000229 Seq.resize(Index + 1, Template);
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000230 }
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000231 return Seq[Index];
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000232 }
233};
Alexander Kornienkod6538332013-05-07 15:32:14 +0000234}
235}
236
Daniel Jasperf7935112012-12-03 18:12:45 +0000237namespace clang {
238namespace format {
239
Daniel Jasperf7935112012-12-03 18:12:45 +0000240FormatStyle getLLVMStyle() {
241 FormatStyle LLVMStyle;
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000242 LLVMStyle.Language = FormatStyle::LK_Cpp;
Daniel Jasperf7935112012-12-03 18:12:45 +0000243 LLVMStyle.AccessModifierOffset = -2;
Alexander Kornienkoc8602662013-05-06 14:11:27 +0000244 LLVMStyle.AlignEscapedNewlinesLeft = false;
Daniel Jasper552f4a72013-07-31 23:55:15 +0000245 LLVMStyle.AlignTrailingComments = true;
Daniel Jasperf7db4332013-01-29 16:03:49 +0000246 LLVMStyle.AllowAllParametersOfDeclarationOnNextLine = true;
Alexander Kornienko3cfa9732013-11-20 16:33:05 +0000247 LLVMStyle.AllowShortFunctionsOnASingleLine = true;
Daniel Jasper1b750ed2013-01-14 16:24:39 +0000248 LLVMStyle.AllowShortIfStatementsOnASingleLine = false;
Daniel Jasper3a685df2013-05-16 12:12:21 +0000249 LLVMStyle.AllowShortLoopsOnASingleLine = false;
Alexander Kornienko58611712013-07-04 12:02:44 +0000250 LLVMStyle.AlwaysBreakBeforeMultilineStrings = false;
Daniel Jaspere33d4af2013-07-26 16:56:36 +0000251 LLVMStyle.AlwaysBreakTemplateDeclarations = false;
Alexander Kornienkoc8602662013-05-06 14:11:27 +0000252 LLVMStyle.BinPackParameters = true;
Daniel Jaspere33d4af2013-07-26 16:56:36 +0000253 LLVMStyle.BreakBeforeBinaryOperators = false;
Daniel Jasper165b29e2013-11-08 00:57:11 +0000254 LLVMStyle.BreakBeforeTernaryOperators = true;
Daniel Jaspere33d4af2013-07-26 16:56:36 +0000255 LLVMStyle.BreakBeforeBraces = FormatStyle::BS_Attach;
256 LLVMStyle.BreakConstructorInitializersBeforeComma = false;
Alexander Kornienkoc8602662013-05-06 14:11:27 +0000257 LLVMStyle.ColumnLimit = 80;
258 LLVMStyle.ConstructorInitializerAllOnOneLineOrOnePerLine = false;
Daniel Jaspercdaffa42013-08-13 10:58:30 +0000259 LLVMStyle.ConstructorInitializerIndentWidth = 4;
Daniel Jaspere33d4af2013-07-26 16:56:36 +0000260 LLVMStyle.Cpp11BracedListStyle = false;
Alexander Kornienkoc8602662013-05-06 14:11:27 +0000261 LLVMStyle.DerivePointerBinding = false;
Daniel Jasperb10cbc42013-07-10 14:02:49 +0000262 LLVMStyle.ExperimentalAutoDetectBinPacking = false;
Alexander Kornienkoc8602662013-05-06 14:11:27 +0000263 LLVMStyle.IndentCaseLabels = false;
Daniel Jaspere33d4af2013-07-26 16:56:36 +0000264 LLVMStyle.IndentFunctionDeclarationAfterType = false;
265 LLVMStyle.IndentWidth = 2;
Alexander Kornienkoebb43ca2013-09-05 14:08:34 +0000266 LLVMStyle.TabWidth = 8;
Alexander Kornienkoc8602662013-05-06 14:11:27 +0000267 LLVMStyle.MaxEmptyLinesToKeep = 1;
Daniel Jasper65ee3472013-07-31 23:16:02 +0000268 LLVMStyle.NamespaceIndentation = FormatStyle::NI_None;
Nico Webera6087752013-01-10 20:12:55 +0000269 LLVMStyle.ObjCSpaceBeforeProtocolList = true;
Alexander Kornienkoc8602662013-05-06 14:11:27 +0000270 LLVMStyle.PointerBindsToType = false;
271 LLVMStyle.SpacesBeforeTrailingComments = 1;
272 LLVMStyle.Standard = FormatStyle::LS_Cpp03;
Alexander Kornienko3c3d09c2013-09-27 16:14:22 +0000273 LLVMStyle.UseTab = FormatStyle::UT_Never;
Daniel Jasperb55acad2013-08-20 12:36:34 +0000274 LLVMStyle.SpacesInParentheses = false;
275 LLVMStyle.SpaceInEmptyParentheses = false;
Daniel Jasperb2e10a52014-01-15 15:09:08 +0000276 LLVMStyle.SpacesInContainerLiterals = true;
Daniel Jasperb55acad2013-08-20 12:36:34 +0000277 LLVMStyle.SpacesInCStyleCastParentheses = false;
Alexander Kornienkofdca83d2013-12-10 10:18:34 +0000278 LLVMStyle.SpaceBeforeParens = FormatStyle::SBPO_ControlStatements;
Daniel Jasperd94bff32013-09-25 15:15:02 +0000279 LLVMStyle.SpaceBeforeAssignmentOperators = true;
Daniel Jasper6633ab82013-10-18 10:38:14 +0000280 LLVMStyle.ContinuationIndentWidth = 4;
Daniel Jasperdd978ae2013-10-29 14:52:02 +0000281 LLVMStyle.SpacesInAngles = false;
Alexander Kornienkoce9161a2014-01-02 15:13:14 +0000282 LLVMStyle.CommentPragmas = "^ IWYU pragma:";
Daniel Jasper4e9678f2013-07-11 20:41:21 +0000283
Daniel Jasper19a541e2013-12-19 16:45:34 +0000284 LLVMStyle.PenaltyBreakComment = 300;
Alexander Kornienkofe7a57f2013-12-10 15:42:15 +0000285 LLVMStyle.PenaltyBreakFirstLessLess = 120;
286 LLVMStyle.PenaltyBreakString = 1000;
287 LLVMStyle.PenaltyExcessCharacter = 1000000;
Daniel Jasper4e9678f2013-07-11 20:41:21 +0000288 LLVMStyle.PenaltyReturnTypeOnItsOwnLine = 60;
Daniel Jasper33b909c2013-10-25 14:29:37 +0000289 LLVMStyle.PenaltyBreakBeforeFirstCallParameter = 19;
Daniel Jasper4e9678f2013-07-11 20:41:21 +0000290
Daniel Jasperf7935112012-12-03 18:12:45 +0000291 return LLVMStyle;
292}
293
294FormatStyle getGoogleStyle() {
Alexander Kornienkofe7a57f2013-12-10 15:42:15 +0000295 FormatStyle GoogleStyle = getLLVMStyle();
Daniel Jasperf7935112012-12-03 18:12:45 +0000296 GoogleStyle.AccessModifierOffset = -1;
Alexander Kornienkoc8602662013-05-06 14:11:27 +0000297 GoogleStyle.AlignEscapedNewlinesLeft = true;
Daniel Jasper085a2ed2013-04-24 13:46:00 +0000298 GoogleStyle.AllowShortIfStatementsOnASingleLine = true;
Daniel Jasper5bd0b9e2013-05-23 18:05:18 +0000299 GoogleStyle.AllowShortLoopsOnASingleLine = true;
Alexander Kornienko58611712013-07-04 12:02:44 +0000300 GoogleStyle.AlwaysBreakBeforeMultilineStrings = true;
Daniel Jaspere33d4af2013-07-26 16:56:36 +0000301 GoogleStyle.AlwaysBreakTemplateDeclarations = true;
Alexander Kornienkoc8602662013-05-06 14:11:27 +0000302 GoogleStyle.ConstructorInitializerAllOnOneLineOrOnePerLine = true;
Daniel Jaspere33d4af2013-07-26 16:56:36 +0000303 GoogleStyle.Cpp11BracedListStyle = true;
Alexander Kornienkoc8602662013-05-06 14:11:27 +0000304 GoogleStyle.DerivePointerBinding = true;
305 GoogleStyle.IndentCaseLabels = true;
Daniel Jaspere33d4af2013-07-26 16:56:36 +0000306 GoogleStyle.IndentFunctionDeclarationAfterType = true;
Nico Webera6087752013-01-10 20:12:55 +0000307 GoogleStyle.ObjCSpaceBeforeProtocolList = false;
Alexander Kornienkoc8602662013-05-06 14:11:27 +0000308 GoogleStyle.PointerBindsToType = true;
309 GoogleStyle.SpacesBeforeTrailingComments = 2;
310 GoogleStyle.Standard = FormatStyle::LS_Auto;
Daniel Jasper4e9678f2013-07-11 20:41:21 +0000311
Daniel Jasper4e9678f2013-07-11 20:41:21 +0000312 GoogleStyle.PenaltyReturnTypeOnItsOwnLine = 200;
Daniel Jasper33b909c2013-10-25 14:29:37 +0000313 GoogleStyle.PenaltyBreakBeforeFirstCallParameter = 1;
Daniel Jasper4e9678f2013-07-11 20:41:21 +0000314
Daniel Jasperf7935112012-12-03 18:12:45 +0000315 return GoogleStyle;
316}
317
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000318FormatStyle getGoogleJSStyle() {
319 FormatStyle GoogleJSStyle = getGoogleStyle();
320 GoogleJSStyle.Language = FormatStyle::LK_JavaScript;
321 GoogleJSStyle.BreakBeforeTernaryOperators = false;
Daniel Jasperb2e10a52014-01-15 15:09:08 +0000322 GoogleJSStyle.SpacesInContainerLiterals = false;
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000323 return GoogleJSStyle;
324}
325
Daniel Jasper1b750ed2013-01-14 16:24:39 +0000326FormatStyle getChromiumStyle() {
327 FormatStyle ChromiumStyle = getGoogleStyle();
Daniel Jasperf7db4332013-01-29 16:03:49 +0000328 ChromiumStyle.AllowAllParametersOfDeclarationOnNextLine = false;
Daniel Jasper085a2ed2013-04-24 13:46:00 +0000329 ChromiumStyle.AllowShortIfStatementsOnASingleLine = false;
Daniel Jasper3a685df2013-05-16 12:12:21 +0000330 ChromiumStyle.AllowShortLoopsOnASingleLine = false;
Daniel Jasper2cf17bf2013-02-27 09:47:53 +0000331 ChromiumStyle.BinPackParameters = false;
Daniel Jasper7fce3ab2013-02-06 14:22:40 +0000332 ChromiumStyle.DerivePointerBinding = false;
Daniel Jaspere33d4af2013-07-26 16:56:36 +0000333 ChromiumStyle.Standard = FormatStyle::LS_Cpp03;
Daniel Jasper1b750ed2013-01-14 16:24:39 +0000334 return ChromiumStyle;
335}
336
Alexander Kornienkoc8602662013-05-06 14:11:27 +0000337FormatStyle getMozillaStyle() {
338 FormatStyle MozillaStyle = getLLVMStyle();
339 MozillaStyle.AllowAllParametersOfDeclarationOnNextLine = false;
340 MozillaStyle.ConstructorInitializerAllOnOneLineOrOnePerLine = true;
341 MozillaStyle.DerivePointerBinding = true;
342 MozillaStyle.IndentCaseLabels = true;
343 MozillaStyle.ObjCSpaceBeforeProtocolList = false;
344 MozillaStyle.PenaltyReturnTypeOnItsOwnLine = 200;
345 MozillaStyle.PointerBindsToType = true;
346 return MozillaStyle;
347}
348
Daniel Jasperffefb3d2013-07-24 13:10:59 +0000349FormatStyle getWebKitStyle() {
350 FormatStyle Style = getLLVMStyle();
Daniel Jasper65ee3472013-07-31 23:16:02 +0000351 Style.AccessModifierOffset = -4;
Daniel Jasper552f4a72013-07-31 23:55:15 +0000352 Style.AlignTrailingComments = false;
Daniel Jaspere33d4af2013-07-26 16:56:36 +0000353 Style.BreakBeforeBinaryOperators = true;
Daniel Jasper65ee3472013-07-31 23:16:02 +0000354 Style.BreakBeforeBraces = FormatStyle::BS_Stroustrup;
Daniel Jaspere33d4af2013-07-26 16:56:36 +0000355 Style.BreakConstructorInitializersBeforeComma = true;
Daniel Jasper65ee3472013-07-31 23:16:02 +0000356 Style.ColumnLimit = 0;
Daniel Jaspere33d4af2013-07-26 16:56:36 +0000357 Style.IndentWidth = 4;
Daniel Jasper65ee3472013-07-31 23:16:02 +0000358 Style.NamespaceIndentation = FormatStyle::NI_Inner;
Daniel Jasperffefb3d2013-07-24 13:10:59 +0000359 Style.PointerBindsToType = true;
360 return Style;
361}
362
Alexander Kornienkofe7a57f2013-12-10 15:42:15 +0000363FormatStyle getGNUStyle() {
364 FormatStyle Style = getLLVMStyle();
365 Style.BreakBeforeBinaryOperators = true;
Alexander Kornienko3a33f022013-12-12 09:49:52 +0000366 Style.BreakBeforeBraces = FormatStyle::BS_GNU;
Alexander Kornienkofe7a57f2013-12-10 15:42:15 +0000367 Style.BreakBeforeTernaryOperators = true;
368 Style.ColumnLimit = 79;
Alexander Kornienkofe7a57f2013-12-10 15:42:15 +0000369 Style.SpaceBeforeParens = FormatStyle::SBPO_Always;
370 return Style;
371}
372
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000373bool getPredefinedStyle(StringRef Name, FormatStyle::LanguageKind Language,
374 FormatStyle *Style) {
375 if (Name.equals_lower("llvm")) {
Alexander Kornienko006b5c82013-05-19 00:53:30 +0000376 *Style = getLLVMStyle();
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000377 } else if (Name.equals_lower("chromium")) {
Alexander Kornienko006b5c82013-05-19 00:53:30 +0000378 *Style = getChromiumStyle();
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000379 } else if (Name.equals_lower("mozilla")) {
Alexander Kornienko006b5c82013-05-19 00:53:30 +0000380 *Style = getMozillaStyle();
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000381 } else if (Name.equals_lower("google")) {
382 *Style = Language == FormatStyle::LK_JavaScript ? getGoogleJSStyle()
383 : getGoogleStyle();
384 } else if (Name.equals_lower("webkit")) {
Daniel Jasperffefb3d2013-07-24 13:10:59 +0000385 *Style = getWebKitStyle();
Alexander Kornienkofe7a57f2013-12-10 15:42:15 +0000386 } else if (Name.equals_lower("gnu")) {
387 *Style = getGNUStyle();
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000388 } else {
Alexander Kornienko006b5c82013-05-19 00:53:30 +0000389 return false;
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000390 }
Alexander Kornienkod6538332013-05-07 15:32:14 +0000391
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000392 Style->Language = Language;
Alexander Kornienko006b5c82013-05-19 00:53:30 +0000393 return true;
Alexander Kornienkod6538332013-05-07 15:32:14 +0000394}
395
396llvm::error_code parseConfiguration(StringRef Text, FormatStyle *Style) {
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000397 assert(Style);
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000398 FormatStyle::LanguageKind Language = Style->Language;
399 assert(Language != FormatStyle::LK_None);
Alexander Kornienko06e00332013-05-20 15:18:01 +0000400 if (Text.trim().empty())
401 return llvm::make_error_code(llvm::errc::invalid_argument);
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000402
403 std::vector<FormatStyle> Styles;
Alexander Kornienkod6538332013-05-07 15:32:14 +0000404 llvm::yaml::Input Input(Text);
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000405 // DocumentListTraits<vector<FormatStyle>> uses the context to get default
406 // values for the fields, keys for which are missing from the configuration.
407 // Mapping also uses the context to get the language to find the correct
408 // base style.
409 Input.setContext(Style);
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000410 Input >> Styles;
411 if (Input.error())
412 return Input.error();
413
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000414 for (unsigned i = 0; i < Styles.size(); ++i) {
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000415 // Ensures that only the first configuration can skip the Language option.
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000416 if (Styles[i].Language == FormatStyle::LK_None && i != 0)
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000417 return llvm::make_error_code(llvm::errc::invalid_argument);
418 // Ensure that each language is configured at most once.
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000419 for (unsigned j = 0; j < i; ++j) {
420 if (Styles[i].Language == Styles[j].Language) {
421 DEBUG(llvm::dbgs()
422 << "Duplicate languages in the config file on positions " << j
423 << " and " << i << "\n");
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000424 return llvm::make_error_code(llvm::errc::invalid_argument);
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000425 }
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000426 }
427 }
428 // Look for a suitable configuration starting from the end, so we can
429 // find the configuration for the specific language first, and the default
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000430 // configuration (which can only be at slot 0) after it.
431 for (int i = Styles.size() - 1; i >= 0; --i) {
432 if (Styles[i].Language == Language ||
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000433 Styles[i].Language == FormatStyle::LK_None) {
434 *Style = Styles[i];
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000435 Style->Language = Language;
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000436 return llvm::make_error_code(llvm::errc::success);
437 }
438 }
439 return llvm::make_error_code(llvm::errc::not_supported);
Alexander Kornienkod6538332013-05-07 15:32:14 +0000440}
441
442std::string configurationAsText(const FormatStyle &Style) {
443 std::string Text;
444 llvm::raw_string_ostream Stream(Text);
445 llvm::yaml::Output Output(Stream);
446 // We use the same mapping method for input and output, so we need a non-const
447 // reference here.
448 FormatStyle NonConstStyle = Style;
449 Output << NonConstStyle;
Alexander Kornienko9a38ec22013-05-13 12:56:35 +0000450 return Stream.str();
Alexander Kornienkod6538332013-05-07 15:32:14 +0000451}
452
Craig Topperaf35e852013-06-30 22:29:28 +0000453namespace {
454
Daniel Jasperde0328a2013-08-16 11:20:30 +0000455class NoColumnLimitFormatter {
456public:
Daniel Jasperf110e202013-08-21 08:39:01 +0000457 NoColumnLimitFormatter(ContinuationIndenter *Indenter) : Indenter(Indenter) {}
Daniel Jasperde0328a2013-08-16 11:20:30 +0000458
459 /// \brief Formats the line starting at \p State, simply keeping all of the
460 /// input's line breaking decisions.
Alexander Kornienkoa594ba82013-12-16 14:35:51 +0000461 void format(unsigned FirstIndent, const AnnotatedLine *Line) {
Daniel Jasper1c5d9df2013-09-06 07:54:20 +0000462 LineState State =
463 Indenter->getInitialState(FirstIndent, Line, /*DryRun=*/false);
Daniel Jasperde0328a2013-08-16 11:20:30 +0000464 while (State.NextToken != NULL) {
465 bool Newline =
Alexander Kornienkoa594ba82013-12-16 14:35:51 +0000466 Indenter->mustBreak(State) ||
Daniel Jasperde0328a2013-08-16 11:20:30 +0000467 (Indenter->canBreak(State) && State.NextToken->NewlinesBefore > 0);
468 Indenter->addTokenToState(State, Newline, /*DryRun=*/false);
469 }
470 }
Daniel Jasperf110e202013-08-21 08:39:01 +0000471
Daniel Jasperde0328a2013-08-16 11:20:30 +0000472private:
473 ContinuationIndenter *Indenter;
474};
475
Daniel Jasper56f8b432013-11-06 23:12:09 +0000476class LineJoiner {
477public:
478 LineJoiner(const FormatStyle &Style) : Style(Style) {}
479
480 /// \brief Calculates how many lines can be merged into 1 starting at \p I.
481 unsigned
482 tryFitMultipleLinesInOne(unsigned Indent,
Alexander Kornienko3cfa9732013-11-20 16:33:05 +0000483 SmallVectorImpl<AnnotatedLine *>::const_iterator I,
Daniel Jasper56f8b432013-11-06 23:12:09 +0000484 SmallVectorImpl<AnnotatedLine *>::const_iterator E) {
485 // We can never merge stuff if there are trailing line comments.
Daniel Jasper234379f2013-12-24 13:31:25 +0000486 const AnnotatedLine *TheLine = *I;
Daniel Jasper56f8b432013-11-06 23:12:09 +0000487 if (TheLine->Last->Type == TT_LineComment)
488 return 0;
489
Alexander Kornienkoecc232d2013-12-04 13:25:26 +0000490 if (Style.ColumnLimit > 0 && Indent > Style.ColumnLimit)
491 return 0;
492
Daniel Jasper98fb6e12013-11-08 17:33:27 +0000493 unsigned Limit =
494 Style.ColumnLimit == 0 ? UINT_MAX : Style.ColumnLimit - Indent;
Daniel Jasper56f8b432013-11-06 23:12:09 +0000495 // If we already exceed the column limit, we set 'Limit' to 0. The different
496 // tryMerge..() functions can then decide whether to still do merging.
497 Limit = TheLine->Last->TotalLength > Limit
498 ? 0
499 : Limit - TheLine->Last->TotalLength;
500
Alexander Kornienkoc3021612013-11-19 14:30:44 +0000501 if (I + 1 == E || I[1]->Type == LT_Invalid)
Daniel Jasper56f8b432013-11-06 23:12:09 +0000502 return 0;
503
Daniel Jasper234379f2013-12-24 13:31:25 +0000504 if (TheLine->Last->Type == TT_FunctionLBrace &&
505 TheLine->First != TheLine->Last) {
Alexander Kornienko3cfa9732013-11-20 16:33:05 +0000506 return Style.AllowShortFunctionsOnASingleLine
507 ? tryMergeSimpleBlock(I, E, Limit)
508 : 0;
509 }
Daniel Jasper56f8b432013-11-06 23:12:09 +0000510 if (TheLine->Last->is(tok::l_brace)) {
Alexander Kornienko6d2c88e2013-12-10 10:30:34 +0000511 return Style.BreakBeforeBraces == FormatStyle::BS_Attach
Alexander Kornienko3cfa9732013-11-20 16:33:05 +0000512 ? tryMergeSimpleBlock(I, E, Limit)
513 : 0;
514 }
515 if (I[1]->First->Type == TT_FunctionLBrace &&
516 Style.BreakBeforeBraces != FormatStyle::BS_Attach) {
Alp Tokerba5b4dc2013-12-30 02:06:29 +0000517 // Check for Limit <= 2 to account for the " {".
Daniel Jasper234379f2013-12-24 13:31:25 +0000518 if (Limit <= 2 || (Style.ColumnLimit == 0 && containsMustBreak(TheLine)))
519 return 0;
520 Limit -= 2;
521
Alexander Kornienko3cfa9732013-11-20 16:33:05 +0000522 unsigned MergedLines = 0;
523 if (Style.AllowShortFunctionsOnASingleLine) {
524 MergedLines = tryMergeSimpleBlock(I + 1, E, Limit);
525 // If we managed to merge the block, count the function header, which is
526 // on a separate line.
527 if (MergedLines > 0)
528 ++MergedLines;
529 }
530 return MergedLines;
531 }
532 if (TheLine->First->is(tok::kw_if)) {
533 return Style.AllowShortIfStatementsOnASingleLine
534 ? tryMergeSimpleControlStatement(I, E, Limit)
535 : 0;
536 }
537 if (TheLine->First->isOneOf(tok::kw_for, tok::kw_while)) {
538 return Style.AllowShortLoopsOnASingleLine
539 ? tryMergeSimpleControlStatement(I, E, Limit)
540 : 0;
541 }
542 if (TheLine->InPPDirective &&
543 (TheLine->First->HasUnescapedNewline || TheLine->First->IsFirst)) {
Daniel Jasper56f8b432013-11-06 23:12:09 +0000544 return tryMergeSimplePPDirective(I, E, Limit);
545 }
546 return 0;
547 }
548
549private:
550 unsigned
Alexander Kornienko3cfa9732013-11-20 16:33:05 +0000551 tryMergeSimplePPDirective(SmallVectorImpl<AnnotatedLine *>::const_iterator I,
Daniel Jasper56f8b432013-11-06 23:12:09 +0000552 SmallVectorImpl<AnnotatedLine *>::const_iterator E,
553 unsigned Limit) {
554 if (Limit == 0)
555 return 0;
Alexander Kornienkoc3021612013-11-19 14:30:44 +0000556 if (!I[1]->InPPDirective || I[1]->First->HasUnescapedNewline)
Daniel Jasper56f8b432013-11-06 23:12:09 +0000557 return 0;
Alexander Kornienkoc3021612013-11-19 14:30:44 +0000558 if (I + 2 != E && I[2]->InPPDirective && !I[2]->First->HasUnescapedNewline)
Daniel Jasper56f8b432013-11-06 23:12:09 +0000559 return 0;
Alexander Kornienkoc3021612013-11-19 14:30:44 +0000560 if (1 + I[1]->Last->TotalLength > Limit)
Daniel Jasper56f8b432013-11-06 23:12:09 +0000561 return 0;
562 return 1;
563 }
564
565 unsigned tryMergeSimpleControlStatement(
Alexander Kornienko3cfa9732013-11-20 16:33:05 +0000566 SmallVectorImpl<AnnotatedLine *>::const_iterator I,
Daniel Jasper56f8b432013-11-06 23:12:09 +0000567 SmallVectorImpl<AnnotatedLine *>::const_iterator E, unsigned Limit) {
568 if (Limit == 0)
569 return 0;
Alexander Kornienko3a33f022013-12-12 09:49:52 +0000570 if ((Style.BreakBeforeBraces == FormatStyle::BS_Allman ||
571 Style.BreakBeforeBraces == FormatStyle::BS_GNU) &&
Alexander Kornienkoc3021612013-11-19 14:30:44 +0000572 I[1]->First->is(tok::l_brace))
Daniel Jasper56f8b432013-11-06 23:12:09 +0000573 return 0;
Alexander Kornienkoc3021612013-11-19 14:30:44 +0000574 if (I[1]->InPPDirective != (*I)->InPPDirective ||
575 (I[1]->InPPDirective && I[1]->First->HasUnescapedNewline))
Daniel Jasper56f8b432013-11-06 23:12:09 +0000576 return 0;
577 AnnotatedLine &Line = **I;
578 if (Line.Last->isNot(tok::r_paren))
579 return 0;
Alexander Kornienkoc3021612013-11-19 14:30:44 +0000580 if (1 + I[1]->Last->TotalLength > Limit)
Daniel Jasper56f8b432013-11-06 23:12:09 +0000581 return 0;
Alexander Kornienkoc3021612013-11-19 14:30:44 +0000582 if (I[1]->First->isOneOf(tok::semi, tok::kw_if, tok::kw_for,
Alexander Kornienko3cfa9732013-11-20 16:33:05 +0000583 tok::kw_while) ||
Alexander Kornienkoc3021612013-11-19 14:30:44 +0000584 I[1]->First->Type == TT_LineComment)
Daniel Jasper56f8b432013-11-06 23:12:09 +0000585 return 0;
586 // Only inline simple if's (no nested if or else).
587 if (I + 2 != E && Line.First->is(tok::kw_if) &&
Alexander Kornienkoc3021612013-11-19 14:30:44 +0000588 I[2]->First->is(tok::kw_else))
Daniel Jasper56f8b432013-11-06 23:12:09 +0000589 return 0;
590 return 1;
591 }
592
593 unsigned
Alexander Kornienko3cfa9732013-11-20 16:33:05 +0000594 tryMergeSimpleBlock(SmallVectorImpl<AnnotatedLine *>::const_iterator I,
Daniel Jasper56f8b432013-11-06 23:12:09 +0000595 SmallVectorImpl<AnnotatedLine *>::const_iterator E,
596 unsigned Limit) {
Daniel Jasper56f8b432013-11-06 23:12:09 +0000597 // First, check that the current line allows merging. This is the case if
598 // we're not in a control flow statement and the last token is an opening
599 // brace.
600 AnnotatedLine &Line = **I;
601 if (Line.First->isOneOf(tok::kw_if, tok::kw_while, tok::kw_do, tok::r_brace,
602 tok::kw_else, tok::kw_try, tok::kw_catch,
603 tok::kw_for,
604 // This gets rid of all ObjC @ keywords and methods.
605 tok::at, tok::minus, tok::plus))
606 return 0;
607
Alexander Kornienkoc3021612013-11-19 14:30:44 +0000608 FormatToken *Tok = I[1]->First;
Daniel Jasper56f8b432013-11-06 23:12:09 +0000609 if (Tok->is(tok::r_brace) && !Tok->MustBreakBefore &&
610 (Tok->getNextNonComment() == NULL ||
611 Tok->getNextNonComment()->is(tok::semi))) {
612 // We merge empty blocks even if the line exceeds the column limit.
613 Tok->SpacesRequiredBefore = 0;
614 Tok->CanBreakBefore = true;
615 return 1;
616 } else if (Limit != 0 && Line.First->isNot(tok::kw_namespace)) {
617 // Check that we still have three lines and they fit into the limit.
Alexander Kornienkoc3021612013-11-19 14:30:44 +0000618 if (I + 2 == E || I[2]->Type == LT_Invalid)
Daniel Jasper56f8b432013-11-06 23:12:09 +0000619 return 0;
620
621 if (!nextTwoLinesFitInto(I, Limit))
622 return 0;
623
624 // Second, check that the next line does not contain any braces - if it
625 // does, readability declines when putting it into a single line.
Alexander Kornienkoc3021612013-11-19 14:30:44 +0000626 if (I[1]->Last->Type == TT_LineComment || Tok->MustBreakBefore)
Daniel Jasper56f8b432013-11-06 23:12:09 +0000627 return 0;
628 do {
629 if (Tok->isOneOf(tok::l_brace, tok::r_brace))
630 return 0;
631 Tok = Tok->Next;
632 } while (Tok != NULL);
633
634 // Last, check that the third line contains a single closing brace.
Alexander Kornienkoc3021612013-11-19 14:30:44 +0000635 Tok = I[2]->First;
Daniel Jasper56f8b432013-11-06 23:12:09 +0000636 if (Tok->getNextNonComment() != NULL || Tok->isNot(tok::r_brace) ||
637 Tok->MustBreakBefore)
638 return 0;
639
640 return 2;
641 }
642 return 0;
643 }
644
645 bool nextTwoLinesFitInto(SmallVectorImpl<AnnotatedLine *>::const_iterator I,
646 unsigned Limit) {
Alexander Kornienkoc3021612013-11-19 14:30:44 +0000647 return 1 + I[1]->Last->TotalLength + 1 + I[2]->Last->TotalLength <= Limit;
Daniel Jasper56f8b432013-11-06 23:12:09 +0000648 }
649
Daniel Jasper234379f2013-12-24 13:31:25 +0000650 bool containsMustBreak(const AnnotatedLine *Line) {
651 for (const FormatToken *Tok = Line->First; Tok; Tok = Tok->Next) {
652 if (Tok->MustBreakBefore)
653 return true;
654 }
655 return false;
656 }
657
Daniel Jasper56f8b432013-11-06 23:12:09 +0000658 const FormatStyle &Style;
659};
660
Daniel Jasperf7935112012-12-03 18:12:45 +0000661class UnwrappedLineFormatter {
662public:
Daniel Jasper5500f612013-11-25 11:08:59 +0000663 UnwrappedLineFormatter(ContinuationIndenter *Indenter,
Daniel Jasper9fe0e8d2013-09-05 09:29:45 +0000664 WhitespaceManager *Whitespaces,
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +0000665 const FormatStyle &Style)
Daniel Jasper5500f612013-11-25 11:08:59 +0000666 : Indenter(Indenter), Whitespaces(Whitespaces), Style(Style),
667 Joiner(Style) {}
Daniel Jasperf7935112012-12-03 18:12:45 +0000668
Daniel Jasper56f8b432013-11-06 23:12:09 +0000669 unsigned format(const SmallVectorImpl<AnnotatedLine *> &Lines, bool DryRun,
Daniel Jasper9c199562013-11-28 15:58:55 +0000670 int AdditionalIndent = 0, bool FixBadIndentation = false) {
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +0000671 assert(!Lines.empty());
672 unsigned Penalty = 0;
673 std::vector<int> IndentForLevel;
674 for (unsigned i = 0, e = Lines[0]->Level; i != e; ++i)
675 IndentForLevel.push_back(Style.IndentWidth * i + AdditionalIndent);
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +0000676 const AnnotatedLine *PreviousLine = NULL;
Daniel Jasper56f8b432013-11-06 23:12:09 +0000677 for (SmallVectorImpl<AnnotatedLine *>::const_iterator I = Lines.begin(),
678 E = Lines.end();
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +0000679 I != E; ++I) {
680 const AnnotatedLine &TheLine = **I;
681 const FormatToken *FirstTok = TheLine.First;
682 int Offset = getIndentOffset(*FirstTok);
683
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +0000684 // Determine indent and try to merge multiple unwrapped lines.
Daniel Jasperbad63ae2013-12-17 12:38:55 +0000685 unsigned Indent;
686 if (TheLine.InPPDirective) {
687 Indent = TheLine.Level * Style.IndentWidth;
688 } else {
689 while (IndentForLevel.size() <= TheLine.Level)
690 IndentForLevel.push_back(-1);
691 IndentForLevel.resize(TheLine.Level + 1);
692 Indent = getIndent(IndentForLevel, TheLine.Level);
693 }
694 unsigned LevelIndent = Indent;
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +0000695 if (static_cast<int>(Indent) + Offset >= 0)
696 Indent += Offset;
Daniel Jasperbad63ae2013-12-17 12:38:55 +0000697
698 // Merge multiple lines if possible.
Daniel Jasper56f8b432013-11-06 23:12:09 +0000699 unsigned MergedLines = Joiner.tryFitMultipleLinesInOne(Indent, I, E);
Alexander Kornienko31e95542013-12-04 12:21:08 +0000700 if (MergedLines > 0 && Style.ColumnLimit == 0) {
701 // Disallow line merging if there is a break at the start of one of the
702 // input lines.
703 for (unsigned i = 0; i < MergedLines; ++i) {
704 if (I[i + 1]->First->NewlinesBefore > 0)
705 MergedLines = 0;
706 }
707 }
Daniel Jasper56f8b432013-11-06 23:12:09 +0000708 if (!DryRun) {
709 for (unsigned i = 0; i < MergedLines; ++i) {
Alexander Kornienkoc3021612013-11-19 14:30:44 +0000710 join(*I[i], *I[i + 1]);
Daniel Jasper56f8b432013-11-06 23:12:09 +0000711 }
712 }
713 I += MergedLines;
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +0000714
Daniel Jasper9c199562013-11-28 15:58:55 +0000715 bool FixIndentation =
716 FixBadIndentation && (LevelIndent != FirstTok->OriginalColumn);
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +0000717 if (TheLine.First->is(tok::eof)) {
Daniel Jasper5500f612013-11-25 11:08:59 +0000718 if (PreviousLine && PreviousLine->Affected && !DryRun) {
719 // Remove the file's trailing whitespace.
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +0000720 unsigned Newlines = std::min(FirstTok->NewlinesBefore, 1u);
721 Whitespaces->replaceWhitespace(*TheLine.First, Newlines,
722 /*IndentLevel=*/0, /*Spaces=*/0,
723 /*TargetColumn=*/0);
724 }
Daniel Jasper9c199562013-11-28 15:58:55 +0000725 } else if (TheLine.Type != LT_Invalid &&
726 (TheLine.Affected || FixIndentation)) {
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +0000727 if (FirstTok->WhitespaceRange.isValid()) {
728 if (!DryRun)
729 formatFirstToken(*TheLine.First, PreviousLine, TheLine.Level,
730 Indent, TheLine.InPPDirective);
731 } else {
732 Indent = LevelIndent = FirstTok->OriginalColumn;
733 }
734
735 // If everything fits on a single line, just put it there.
736 unsigned ColumnLimit = Style.ColumnLimit;
737 if (I + 1 != E) {
Alexander Kornienkoc3021612013-11-19 14:30:44 +0000738 AnnotatedLine *NextLine = I[1];
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +0000739 if (NextLine->InPPDirective && !NextLine->First->HasUnescapedNewline)
740 ColumnLimit = getColumnLimit(TheLine.InPPDirective);
741 }
742
743 if (TheLine.Last->TotalLength + Indent <= ColumnLimit) {
744 LineState State = Indenter->getInitialState(Indent, &TheLine, DryRun);
745 while (State.NextToken != NULL)
746 Indenter->addTokenToState(State, /*Newline=*/false, DryRun);
747 } else if (Style.ColumnLimit == 0) {
Daniel Jasper9c199562013-11-28 15:58:55 +0000748 // FIXME: Implement nested blocks for ColumnLimit = 0.
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +0000749 NoColumnLimitFormatter Formatter(Indenter);
750 if (!DryRun)
Alexander Kornienkoa594ba82013-12-16 14:35:51 +0000751 Formatter.format(Indent, &TheLine);
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +0000752 } else {
753 Penalty += format(TheLine, Indent, DryRun);
754 }
755
Daniel Jasperbad63ae2013-12-17 12:38:55 +0000756 if (!TheLine.InPPDirective)
757 IndentForLevel[TheLine.Level] = LevelIndent;
Daniel Jasper9c199562013-11-28 15:58:55 +0000758 } else if (TheLine.ChildrenAffected) {
759 format(TheLine.Children, DryRun);
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +0000760 } else {
761 // Format the first token if necessary, and notify the WhitespaceManager
762 // about the unchanged whitespace.
763 for (FormatToken *Tok = TheLine.First; Tok != NULL; Tok = Tok->Next) {
764 if (Tok == TheLine.First &&
765 (Tok->NewlinesBefore > 0 || Tok->IsFirst)) {
766 unsigned LevelIndent = Tok->OriginalColumn;
767 if (!DryRun) {
Daniel Jasper9c199562013-11-28 15:58:55 +0000768 // Remove trailing whitespace of the previous line.
Daniel Jasper5500f612013-11-25 11:08:59 +0000769 if ((PreviousLine && PreviousLine->Affected) ||
770 TheLine.LeadingEmptyLinesAffected) {
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +0000771 formatFirstToken(*Tok, PreviousLine, TheLine.Level, LevelIndent,
772 TheLine.InPPDirective);
773 } else {
774 Whitespaces->addUntouchableToken(*Tok, TheLine.InPPDirective);
775 }
776 }
777
778 if (static_cast<int>(LevelIndent) - Offset >= 0)
779 LevelIndent -= Offset;
Daniel Jasperbad63ae2013-12-17 12:38:55 +0000780 if (Tok->isNot(tok::comment) && !TheLine.InPPDirective)
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +0000781 IndentForLevel[TheLine.Level] = LevelIndent;
782 } else if (!DryRun) {
783 Whitespaces->addUntouchableToken(*Tok, TheLine.InPPDirective);
784 }
785 }
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +0000786 }
787 if (!DryRun) {
788 for (FormatToken *Tok = TheLine.First; Tok != NULL; Tok = Tok->Next) {
789 Tok->Finalized = true;
790 }
791 }
792 PreviousLine = *I;
793 }
794 return Penalty;
795 }
796
797private:
798 /// \brief Formats an \c AnnotatedLine and returns the penalty.
Daniel Jasper9fe0e8d2013-09-05 09:29:45 +0000799 ///
800 /// If \p DryRun is \c false, directly applies the changes.
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +0000801 unsigned format(const AnnotatedLine &Line, unsigned FirstIndent,
802 bool DryRun) {
Daniel Jasper1c5d9df2013-09-06 07:54:20 +0000803 LineState State = Indenter->getInitialState(FirstIndent, &Line, DryRun);
Daniel Jasper4b866272013-02-01 11:00:45 +0000804
Daniel Jasperacc33662013-02-08 08:22:00 +0000805 // If the ObjC method declaration does not fit on a line, we should format
806 // it with one arg per line.
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +0000807 if (State.Line->Type == LT_ObjCMethodDecl)
Daniel Jasperacc33662013-02-08 08:22:00 +0000808 State.Stack.back().BreakBeforeParameter = true;
809
Daniel Jasper4b866272013-02-01 11:00:45 +0000810 // Find best solution in solution space.
Daniel Jasper9fe0e8d2013-09-05 09:29:45 +0000811 return analyzeSolutionSpace(State, DryRun);
Daniel Jasperf7935112012-12-03 18:12:45 +0000812 }
813
Manuel Klimek2ef908e2013-02-13 10:46:36 +0000814 /// \brief An edge in the solution space from \c Previous->State to \c State,
815 /// inserting a newline dependent on the \c NewLine.
816 struct StateNode {
817 StateNode(const LineState &State, bool NewLine, StateNode *Previous)
Daniel Jasper12ef4e52013-02-21 21:33:55 +0000818 : State(State), NewLine(NewLine), Previous(Previous) {}
Manuel Klimek2ef908e2013-02-13 10:46:36 +0000819 LineState State;
820 bool NewLine;
821 StateNode *Previous;
822 };
Daniel Jasper4b866272013-02-01 11:00:45 +0000823
Manuel Klimek2ef908e2013-02-13 10:46:36 +0000824 /// \brief A pair of <penalty, count> that is used to prioritize the BFS on.
825 ///
826 /// In case of equal penalties, we want to prefer states that were inserted
827 /// first. During state generation we make sure that we insert states first
828 /// that break the line as late as possible.
829 typedef std::pair<unsigned, unsigned> OrderedPenalty;
830
831 /// \brief An item in the prioritized BFS search queue. The \c StateNode's
832 /// \c State has the given \c OrderedPenalty.
833 typedef std::pair<OrderedPenalty, StateNode *> QueueItem;
834
835 /// \brief The BFS queue type.
836 typedef std::priority_queue<QueueItem, std::vector<QueueItem>,
837 std::greater<QueueItem> > QueueType;
Daniel Jasper4b866272013-02-01 11:00:45 +0000838
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +0000839 /// \brief Get the offset of the line relatively to the level.
840 ///
841 /// For example, 'public:' labels in classes are offset by 1 or 2
842 /// characters to the left from their level.
843 int getIndentOffset(const FormatToken &RootToken) {
844 if (RootToken.isAccessSpecifier(false) || RootToken.isObjCAccessSpecifier())
845 return Style.AccessModifierOffset;
846 return 0;
847 }
848
849 /// \brief Add a new line and the required indent before the first Token
850 /// of the \c UnwrappedLine if there was no structural parsing error.
851 void formatFirstToken(FormatToken &RootToken,
852 const AnnotatedLine *PreviousLine, unsigned IndentLevel,
853 unsigned Indent, bool InPPDirective) {
854 unsigned Newlines =
855 std::min(RootToken.NewlinesBefore, Style.MaxEmptyLinesToKeep + 1);
856 // Remove empty lines before "}" where applicable.
857 if (RootToken.is(tok::r_brace) &&
858 (!RootToken.Next ||
859 (RootToken.Next->is(tok::semi) && !RootToken.Next->Next)))
860 Newlines = std::min(Newlines, 1u);
861 if (Newlines == 0 && !RootToken.IsFirst)
862 Newlines = 1;
863
864 // Insert extra new line before access specifiers.
865 if (PreviousLine && PreviousLine->Last->isOneOf(tok::semi, tok::r_brace) &&
866 RootToken.isAccessSpecifier() && RootToken.NewlinesBefore == 1)
867 ++Newlines;
868
869 // Remove empty lines after access specifiers.
870 if (PreviousLine && PreviousLine->First->isAccessSpecifier())
871 Newlines = std::min(1u, Newlines);
872
Alexander Kornienko3cfa9732013-11-20 16:33:05 +0000873 Whitespaces->replaceWhitespace(RootToken, Newlines, IndentLevel, Indent,
874 Indent, InPPDirective &&
875 !RootToken.HasUnescapedNewline);
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +0000876 }
877
878 /// \brief Get the indent of \p Level from \p IndentForLevel.
879 ///
880 /// \p IndentForLevel must contain the indent for the level \c l
881 /// at \p IndentForLevel[l], or a value < 0 if the indent for
882 /// that level is unknown.
883 unsigned getIndent(const std::vector<int> IndentForLevel, unsigned Level) {
884 if (IndentForLevel[Level] != -1)
885 return IndentForLevel[Level];
886 if (Level == 0)
887 return 0;
888 return getIndent(IndentForLevel, Level - 1) + Style.IndentWidth;
889 }
890
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +0000891 void join(AnnotatedLine &A, const AnnotatedLine &B) {
892 assert(!A.Last->Next);
893 assert(!B.First->Previous);
Daniel Jasper5500f612013-11-25 11:08:59 +0000894 if (B.Affected)
895 A.Affected = true;
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +0000896 A.Last->Next = B.First;
897 B.First->Previous = A.Last;
Daniel Jasper98fb6e12013-11-08 17:33:27 +0000898 B.First->CanBreakBefore = true;
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +0000899 unsigned LengthA = A.Last->TotalLength + B.First->SpacesRequiredBefore;
900 for (FormatToken *Tok = B.First; Tok; Tok = Tok->Next) {
901 Tok->TotalLength += LengthA;
902 A.Last = Tok;
903 }
904 }
905
906 unsigned getColumnLimit(bool InPPDirective) const {
907 // In preprocessor directives reserve two chars for trailing " \"
908 return Style.ColumnLimit - (InPPDirective ? 2 : 0);
909 }
910
Daniel Jasper4b866272013-02-01 11:00:45 +0000911 /// \brief Analyze the entire solution space starting from \p InitialState.
Daniel Jasperf7935112012-12-03 18:12:45 +0000912 ///
Daniel Jasper4b866272013-02-01 11:00:45 +0000913 /// This implements a variant of Dijkstra's algorithm on the graph that spans
914 /// the solution space (\c LineStates are the nodes). The algorithm tries to
915 /// find the shortest path (the one with lowest penalty) from \p InitialState
Daniel Jasper9fe0e8d2013-09-05 09:29:45 +0000916 /// to a state where all tokens are placed. Returns the penalty.
917 ///
918 /// If \p DryRun is \c false, directly applies the changes.
919 unsigned analyzeSolutionSpace(LineState &InitialState, bool DryRun = false) {
Manuel Klimek2ef908e2013-02-13 10:46:36 +0000920 std::set<LineState> Seen;
921
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +0000922 // Increasing count of \c StateNode items we have created. This is used to
923 // create a deterministic order independent of the container.
924 unsigned Count = 0;
925 QueueType Queue;
926
Daniel Jasper4b866272013-02-01 11:00:45 +0000927 // Insert start element into queue.
Daniel Jasper687af3b2013-02-14 14:26:07 +0000928 StateNode *Node =
Manuel Klimek2ef908e2013-02-13 10:46:36 +0000929 new (Allocator.Allocate()) StateNode(InitialState, false, NULL);
930 Queue.push(QueueItem(OrderedPenalty(0, Count), Node));
931 ++Count;
Daniel Jasper4b866272013-02-01 11:00:45 +0000932
Daniel Jasper9fe0e8d2013-09-05 09:29:45 +0000933 unsigned Penalty = 0;
934
Daniel Jasper4b866272013-02-01 11:00:45 +0000935 // While not empty, take first element and follow edges.
936 while (!Queue.empty()) {
Daniel Jasper9fe0e8d2013-09-05 09:29:45 +0000937 Penalty = Queue.top().first.first;
Daniel Jasper687af3b2013-02-14 14:26:07 +0000938 StateNode *Node = Queue.top().second;
Manuel Klimek2ef908e2013-02-13 10:46:36 +0000939 if (Node->State.NextToken == NULL) {
Alexander Kornienko49149672013-05-10 11:56:10 +0000940 DEBUG(llvm::dbgs() << "\n---\nPenalty for line: " << Penalty << "\n");
Daniel Jasper4b866272013-02-01 11:00:45 +0000941 break;
Daniel Jasper3a9370c2013-02-04 07:21:18 +0000942 }
Manuel Klimek2ef908e2013-02-13 10:46:36 +0000943 Queue.pop();
Daniel Jasper4b866272013-02-01 11:00:45 +0000944
Daniel Jasperf8114cf2013-05-22 05:27:42 +0000945 // Cut off the analysis of certain solutions if the analysis gets too
946 // complex. See description of IgnoreStackForComparison.
947 if (Count > 10000)
948 Node->State.IgnoreStackForComparison = true;
949
Manuel Klimek2ef908e2013-02-13 10:46:36 +0000950 if (!Seen.insert(Node->State).second)
951 // State already examined with lower penalty.
952 continue;
Daniel Jasper4b866272013-02-01 11:00:45 +0000953
Manuel Klimek71814b42013-10-11 21:25:45 +0000954 FormatDecision LastFormat = Node->State.NextToken->Decision;
955 if (LastFormat == FD_Unformatted || LastFormat == FD_Continue)
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +0000956 addNextStateToQueue(Penalty, Node, /*NewLine=*/false, &Count, &Queue);
Manuel Klimek71814b42013-10-11 21:25:45 +0000957 if (LastFormat == FD_Unformatted || LastFormat == FD_Break)
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +0000958 addNextStateToQueue(Penalty, Node, /*NewLine=*/true, &Count, &Queue);
Daniel Jasper4b866272013-02-01 11:00:45 +0000959 }
960
Manuel Klimek71814b42013-10-11 21:25:45 +0000961 if (Queue.empty()) {
Daniel Jasper4b866272013-02-01 11:00:45 +0000962 // We were unable to find a solution, do nothing.
963 // FIXME: Add diagnostic?
Manuel Klimek71814b42013-10-11 21:25:45 +0000964 DEBUG(llvm::dbgs() << "Could not find a solution.\n");
Daniel Jasper9fe0e8d2013-09-05 09:29:45 +0000965 return 0;
Manuel Klimek71814b42013-10-11 21:25:45 +0000966 }
Daniel Jasperf7935112012-12-03 18:12:45 +0000967
Daniel Jasper4b866272013-02-01 11:00:45 +0000968 // Reconstruct the solution.
Daniel Jasper9fe0e8d2013-09-05 09:29:45 +0000969 if (!DryRun)
970 reconstructPath(InitialState, Queue.top().second);
971
Alexander Kornienko49149672013-05-10 11:56:10 +0000972 DEBUG(llvm::dbgs() << "Total number of analyzed states: " << Count << "\n");
973 DEBUG(llvm::dbgs() << "---\n");
Daniel Jasper9fe0e8d2013-09-05 09:29:45 +0000974
975 return Penalty;
Manuel Klimek2ef908e2013-02-13 10:46:36 +0000976 }
977
978 void reconstructPath(LineState &State, StateNode *Current) {
Manuel Klimek4c5c28b2013-05-29 15:10:11 +0000979 std::deque<StateNode *> Path;
980 // We do not need a break before the initial token.
981 while (Current->Previous) {
982 Path.push_front(Current);
983 Current = Current->Previous;
984 }
985 for (std::deque<StateNode *>::iterator I = Path.begin(), E = Path.end();
986 I != E; ++I) {
Daniel Jasper9fe0e8d2013-09-05 09:29:45 +0000987 unsigned Penalty = 0;
988 formatChildren(State, (*I)->NewLine, /*DryRun=*/false, Penalty);
989 Penalty += Indenter->addTokenToState(State, (*I)->NewLine, false);
990
Manuel Klimek4c5c28b2013-05-29 15:10:11 +0000991 DEBUG({
992 if ((*I)->NewLine) {
Daniel Jasper8de9ed02013-08-22 15:00:41 +0000993 llvm::dbgs() << "Penalty for placing "
Manuel Klimek4c5c28b2013-05-29 15:10:11 +0000994 << (*I)->Previous->State.NextToken->Tok.getName() << ": "
Daniel Jasper8de9ed02013-08-22 15:00:41 +0000995 << Penalty << "\n";
Manuel Klimek4c5c28b2013-05-29 15:10:11 +0000996 }
997 });
Manuel Klimek4c5c28b2013-05-29 15:10:11 +0000998 }
Daniel Jasper4b866272013-02-01 11:00:45 +0000999 }
1000
Manuel Klimekaf491072013-02-13 10:54:19 +00001001 /// \brief Add the following state to the analysis queue \c Queue.
Daniel Jasper4b866272013-02-01 11:00:45 +00001002 ///
Manuel Klimekaf491072013-02-13 10:54:19 +00001003 /// Assume the current state is \p PreviousNode and has been reached with a
Daniel Jasper4b866272013-02-01 11:00:45 +00001004 /// penalty of \p Penalty. Insert a line break if \p NewLine is \c true.
Manuel Klimekaf491072013-02-13 10:54:19 +00001005 void addNextStateToQueue(unsigned Penalty, StateNode *PreviousNode,
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +00001006 bool NewLine, unsigned *Count, QueueType *Queue) {
Daniel Jasperde0328a2013-08-16 11:20:30 +00001007 if (NewLine && !Indenter->canBreak(PreviousNode->State))
Daniel Jasper4b866272013-02-01 11:00:45 +00001008 return;
Daniel Jasperde0328a2013-08-16 11:20:30 +00001009 if (!NewLine && Indenter->mustBreak(PreviousNode->State))
Daniel Jasper4b866272013-02-01 11:00:45 +00001010 return;
Manuel Klimek2ef908e2013-02-13 10:46:36 +00001011
1012 StateNode *Node = new (Allocator.Allocate())
1013 StateNode(PreviousNode->State, NewLine, PreviousNode);
Daniel Jasper9fe0e8d2013-09-05 09:29:45 +00001014 if (!formatChildren(Node->State, NewLine, /*DryRun=*/true, Penalty))
1015 return;
1016
Daniel Jasperde0328a2013-08-16 11:20:30 +00001017 Penalty += Indenter->addTokenToState(Node->State, NewLine, true);
Manuel Klimek2ef908e2013-02-13 10:46:36 +00001018
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +00001019 Queue->push(QueueItem(OrderedPenalty(Penalty, *Count), Node));
1020 ++(*Count);
Daniel Jasper4b866272013-02-01 11:00:45 +00001021 }
Daniel Jasperf7935112012-12-03 18:12:45 +00001022
Daniel Jasperf3a5d002013-09-05 10:48:50 +00001023 /// \brief If the \p State's next token is an r_brace closing a nested block,
1024 /// format the nested block before it.
Daniel Jasper9fe0e8d2013-09-05 09:29:45 +00001025 ///
1026 /// Returns \c true if all children could be placed successfully and adapts
1027 /// \p Penalty as well as \p State. If \p DryRun is false, also directly
1028 /// creates changes using \c Whitespaces.
1029 ///
1030 /// The crucial idea here is that children always get formatted upon
1031 /// encountering the closing brace right after the nested block. Now, if we
1032 /// are currently trying to keep the "}" on the same line (i.e. \p NewLine is
1033 /// \c false), the entire block has to be kept on the same line (which is only
1034 /// possible if it fits on the line, only contains a single statement, etc.
1035 ///
1036 /// If \p NewLine is true, we format the nested block on separate lines, i.e.
1037 /// break after the "{", format all lines with correct indentation and the put
1038 /// the closing "}" on yet another new line.
1039 ///
1040 /// This enables us to keep the simple structure of the
1041 /// \c UnwrappedLineFormatter, where we only have two options for each token:
1042 /// break or don't break.
1043 bool formatChildren(LineState &State, bool NewLine, bool DryRun,
1044 unsigned &Penalty) {
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +00001045 FormatToken &Previous = *State.NextToken->Previous;
Daniel Jasperdcd5da12013-10-20 17:28:32 +00001046 const FormatToken *LBrace = State.NextToken->getPreviousNonComment();
1047 if (!LBrace || LBrace->isNot(tok::l_brace) ||
1048 LBrace->BlockKind != BK_Block || Previous.Children.size() == 0)
Daniel Jasperf3a5d002013-09-05 10:48:50 +00001049 // The previous token does not open a block. Nothing to do. We don't
1050 // assert so that we can simply call this function for all tokens.
Daniel Jasper36c28ce2013-09-06 08:54:24 +00001051 return true;
Daniel Jasper9fe0e8d2013-09-05 09:29:45 +00001052
1053 if (NewLine) {
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +00001054 int AdditionalIndent = State.Stack.back().Indent -
1055 Previous.Children[0]->Level * Style.IndentWidth;
Daniel Jasper9c199562013-11-28 15:58:55 +00001056 Penalty += format(Previous.Children, DryRun, AdditionalIndent,
1057 /*FixBadIndentation=*/true);
Daniel Jasper9fe0e8d2013-09-05 09:29:45 +00001058 return true;
1059 }
1060
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +00001061 // Cannot merge multiple statements into a single line.
Daniel Jasperdcd5da12013-10-20 17:28:32 +00001062 if (Previous.Children.size() > 1)
Alexander Kornienko3cfa9732013-11-20 16:33:05 +00001063 return false;
Daniel Jasper9fe0e8d2013-09-05 09:29:45 +00001064
1065 // We can't put the closing "}" on a line with a trailing comment.
Daniel Jasperdcd5da12013-10-20 17:28:32 +00001066 if (Previous.Children[0]->Last->isTrailingComment())
Daniel Jasper9fe0e8d2013-09-05 09:29:45 +00001067 return false;
1068
1069 if (!DryRun) {
Alexander Kornienko3c3d09c2013-09-27 16:14:22 +00001070 Whitespaces->replaceWhitespace(
Daniel Jasperdcd5da12013-10-20 17:28:32 +00001071 *Previous.Children[0]->First,
Alexander Kornienkoe2e03872013-10-14 00:46:35 +00001072 /*Newlines=*/0, /*IndentLevel=*/0, /*Spaces=*/1,
Alexander Kornienko3c3d09c2013-09-27 16:14:22 +00001073 /*StartOfTokenColumn=*/State.Column, State.Line->InPPDirective);
Daniel Jasper9fe0e8d2013-09-05 09:29:45 +00001074 }
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +00001075 Penalty += format(*Previous.Children[0], State.Column + 1, DryRun);
Daniel Jasper9fe0e8d2013-09-05 09:29:45 +00001076
Daniel Jasperdcd5da12013-10-20 17:28:32 +00001077 State.Column += 1 + Previous.Children[0]->Last->TotalLength;
Daniel Jasper9fe0e8d2013-09-05 09:29:45 +00001078 return true;
1079 }
1080
Daniel Jasperde0328a2013-08-16 11:20:30 +00001081 ContinuationIndenter *Indenter;
Daniel Jasper9fe0e8d2013-09-05 09:29:45 +00001082 WhitespaceManager *Whitespaces;
Daniel Jasperf7935112012-12-03 18:12:45 +00001083 FormatStyle Style;
Daniel Jasper56f8b432013-11-06 23:12:09 +00001084 LineJoiner Joiner;
Manuel Klimekaf491072013-02-13 10:54:19 +00001085
1086 llvm::SpecificBumpPtrAllocator<StateNode> Allocator;
Daniel Jasperf7935112012-12-03 18:12:45 +00001087};
1088
Manuel Klimek15dfe7a2013-05-28 11:55:06 +00001089class FormatTokenLexer {
Alexander Kornienkoe3276842012-12-07 16:15:44 +00001090public:
Manuel Klimek31c85922013-08-29 15:21:40 +00001091 FormatTokenLexer(Lexer &Lex, SourceManager &SourceMgr, FormatStyle &Style,
Alexander Kornienkoffcc0102013-06-05 14:09:10 +00001092 encoding::Encoding Encoding)
Alexander Kornienko393e3082013-11-13 14:04:17 +00001093 : FormatTok(NULL), IsFirstToken(true), GreaterStashed(false), Column(0),
Manuel Klimek31c85922013-08-29 15:21:40 +00001094 TrailingWhitespace(0), Lex(Lex), SourceMgr(SourceMgr), Style(Style),
1095 IdentTable(getFormattingLangOpts()), Encoding(Encoding) {
Alexander Kornienkoe3276842012-12-07 16:15:44 +00001096 Lex.SetKeepWhitespaceMode(true);
1097 }
1098
Manuel Klimek15dfe7a2013-05-28 11:55:06 +00001099 ArrayRef<FormatToken *> lex() {
1100 assert(Tokens.empty());
1101 do {
1102 Tokens.push_back(getNextToken());
Alexander Kornienko9aa62402013-11-21 12:43:57 +00001103 tryMergePreviousTokens();
Manuel Klimek15dfe7a2013-05-28 11:55:06 +00001104 } while (Tokens.back()->Tok.isNot(tok::eof));
1105 return Tokens;
1106 }
1107
1108 IdentifierTable &getIdentTable() { return IdentTable; }
1109
1110private:
Alexander Kornienko9aa62402013-11-21 12:43:57 +00001111 void tryMergePreviousTokens() {
Alexander Kornienkocabdd732013-11-29 15:19:43 +00001112 if (tryMerge_TMacro())
1113 return;
1114
1115 if (Style.Language == FormatStyle::LK_JavaScript) {
1116 static tok::TokenKind JSIdentity[] = { tok::equalequal, tok::equal };
1117 static tok::TokenKind JSNotIdentity[] = { tok::exclaimequal, tok::equal };
1118 static tok::TokenKind JSShiftEqual[] = { tok::greater, tok::greater,
1119 tok::greaterequal };
1120 // FIXME: We probably need to change token type to mimic operator with the
1121 // correct priority.
1122 if (tryMergeTokens(JSIdentity))
1123 return;
1124 if (tryMergeTokens(JSNotIdentity))
1125 return;
1126 if (tryMergeTokens(JSShiftEqual))
1127 return;
1128 }
Alexander Kornienko9aa62402013-11-21 12:43:57 +00001129 }
1130
Alexander Kornienkocabdd732013-11-29 15:19:43 +00001131 bool tryMergeTokens(ArrayRef<tok::TokenKind> Kinds) {
1132 if (Tokens.size() < Kinds.size())
Alexander Kornienko9aa62402013-11-21 12:43:57 +00001133 return false;
Alexander Kornienkocabdd732013-11-29 15:19:43 +00001134
1135 SmallVectorImpl<FormatToken *>::const_iterator First =
1136 Tokens.end() - Kinds.size();
1137 if (!First[0]->is(Kinds[0]))
Alexander Kornienko9aa62402013-11-21 12:43:57 +00001138 return false;
Alexander Kornienkocabdd732013-11-29 15:19:43 +00001139 unsigned AddLength = 0;
1140 for (unsigned i = 1; i < Kinds.size(); ++i) {
1141 if (!First[i]->is(Kinds[i]) || First[i]->WhitespaceRange.getBegin() !=
1142 First[i]->WhitespaceRange.getEnd())
1143 return false;
1144 AddLength += First[i]->TokenText.size();
1145 }
1146 Tokens.resize(Tokens.size() - Kinds.size() + 1);
1147 First[0]->TokenText = StringRef(First[0]->TokenText.data(),
1148 First[0]->TokenText.size() + AddLength);
1149 First[0]->ColumnWidth += AddLength;
Alexander Kornienko9aa62402013-11-21 12:43:57 +00001150 return true;
1151 }
1152
1153 bool tryMerge_TMacro() {
Alexander Kornienko81e32942013-09-16 20:20:49 +00001154 if (Tokens.size() < 4)
Alexander Kornienko9aa62402013-11-21 12:43:57 +00001155 return false;
Alexander Kornienko81e32942013-09-16 20:20:49 +00001156 FormatToken *Last = Tokens.back();
1157 if (!Last->is(tok::r_paren))
Alexander Kornienko9aa62402013-11-21 12:43:57 +00001158 return false;
Alexander Kornienko81e32942013-09-16 20:20:49 +00001159
1160 FormatToken *String = Tokens[Tokens.size() - 2];
1161 if (!String->is(tok::string_literal) || String->IsMultiline)
Alexander Kornienko9aa62402013-11-21 12:43:57 +00001162 return false;
Alexander Kornienko81e32942013-09-16 20:20:49 +00001163
1164 if (!Tokens[Tokens.size() - 3]->is(tok::l_paren))
Alexander Kornienko9aa62402013-11-21 12:43:57 +00001165 return false;
Alexander Kornienko81e32942013-09-16 20:20:49 +00001166
1167 FormatToken *Macro = Tokens[Tokens.size() - 4];
1168 if (Macro->TokenText != "_T")
Alexander Kornienko9aa62402013-11-21 12:43:57 +00001169 return false;
Alexander Kornienko81e32942013-09-16 20:20:49 +00001170
1171 const char *Start = Macro->TokenText.data();
1172 const char *End = Last->TokenText.data() + Last->TokenText.size();
1173 String->TokenText = StringRef(Start, End - Start);
1174 String->IsFirst = Macro->IsFirst;
1175 String->LastNewlineOffset = Macro->LastNewlineOffset;
1176 String->WhitespaceRange = Macro->WhitespaceRange;
1177 String->OriginalColumn = Macro->OriginalColumn;
1178 String->ColumnWidth = encoding::columnWidthWithTabs(
1179 String->TokenText, String->OriginalColumn, Style.TabWidth, Encoding);
1180
1181 Tokens.pop_back();
1182 Tokens.pop_back();
1183 Tokens.pop_back();
1184 Tokens.back() = String;
Alexander Kornienko9aa62402013-11-21 12:43:57 +00001185 return true;
Alexander Kornienko81e32942013-09-16 20:20:49 +00001186 }
1187
Manuel Klimek15dfe7a2013-05-28 11:55:06 +00001188 FormatToken *getNextToken() {
Alexander Kornienkoe3276842012-12-07 16:15:44 +00001189 if (GreaterStashed) {
Manuel Klimek591ab5a2013-05-28 13:42:28 +00001190 // Create a synthesized second '>' token.
Manuel Klimek31c85922013-08-29 15:21:40 +00001191 // FIXME: Increment Column and set OriginalColumn.
Manuel Klimek591ab5a2013-05-28 13:42:28 +00001192 Token Greater = FormatTok->Tok;
1193 FormatTok = new (Allocator.Allocate()) FormatToken;
1194 FormatTok->Tok = Greater;
Manuel Klimek5c24cca2013-05-23 10:56:37 +00001195 SourceLocation GreaterLocation =
Manuel Klimek15dfe7a2013-05-28 11:55:06 +00001196 FormatTok->Tok.getLocation().getLocWithOffset(1);
1197 FormatTok->WhitespaceRange =
1198 SourceRange(GreaterLocation, GreaterLocation);
Alexander Kornienkoee4ca9b2013-06-07 17:45:07 +00001199 FormatTok->TokenText = ">";
Alexander Kornienko39856b72013-09-10 09:38:25 +00001200 FormatTok->ColumnWidth = 1;
Alexander Kornienkoe3276842012-12-07 16:15:44 +00001201 GreaterStashed = false;
1202 return FormatTok;
1203 }
1204
Manuel Klimek15dfe7a2013-05-28 11:55:06 +00001205 FormatTok = new (Allocator.Allocate()) FormatToken;
Daniel Jasper8369aa52013-07-16 20:28:33 +00001206 readRawToken(*FormatTok);
Manuel Klimek9043c742013-05-27 15:23:34 +00001207 SourceLocation WhitespaceStart =
Manuel Klimek15dfe7a2013-05-28 11:55:06 +00001208 FormatTok->Tok.getLocation().getLocWithOffset(-TrailingWhitespace);
Alexander Kornienko393e3082013-11-13 14:04:17 +00001209 FormatTok->IsFirst = IsFirstToken;
1210 IsFirstToken = false;
Alexander Kornienkoe3276842012-12-07 16:15:44 +00001211
1212 // Consume and record whitespace until we find a significant token.
Manuel Klimek9043c742013-05-27 15:23:34 +00001213 unsigned WhitespaceLength = TrailingWhitespace;
Manuel Klimek15dfe7a2013-05-28 11:55:06 +00001214 while (FormatTok->Tok.is(tok::unknown)) {
Manuel Klimek31c85922013-08-29 15:21:40 +00001215 for (int i = 0, e = FormatTok->TokenText.size(); i != e; ++i) {
1216 switch (FormatTok->TokenText[i]) {
1217 case '\n':
1218 ++FormatTok->NewlinesBefore;
1219 // FIXME: This is technically incorrect, as it could also
1220 // be a literal backslash at the end of the line.
Alexander Kornienko9e649af2013-09-11 12:25:57 +00001221 if (i == 0 || (FormatTok->TokenText[i - 1] != '\\' &&
1222 (FormatTok->TokenText[i - 1] != '\r' || i == 1 ||
1223 FormatTok->TokenText[i - 2] != '\\')))
Manuel Klimek31c85922013-08-29 15:21:40 +00001224 FormatTok->HasUnescapedNewline = true;
1225 FormatTok->LastNewlineOffset = WhitespaceLength + i + 1;
1226 Column = 0;
1227 break;
Daniel Jasper877615c2013-10-11 19:45:02 +00001228 case '\r':
1229 case '\f':
1230 case '\v':
1231 Column = 0;
1232 break;
Manuel Klimek31c85922013-08-29 15:21:40 +00001233 case ' ':
1234 ++Column;
1235 break;
1236 case '\t':
Alexander Kornienkoebb43ca2013-09-05 14:08:34 +00001237 Column += Style.TabWidth - Column % Style.TabWidth;
Manuel Klimek31c85922013-08-29 15:21:40 +00001238 break;
Daniel Jasper877615c2013-10-11 19:45:02 +00001239 case '\\':
1240 ++Column;
1241 if (i + 1 == e || (FormatTok->TokenText[i + 1] != '\r' &&
1242 FormatTok->TokenText[i + 1] != '\n'))
1243 FormatTok->Type = TT_ImplicitStringLiteral;
1244 break;
Manuel Klimek31c85922013-08-29 15:21:40 +00001245 default:
Daniel Jasper877615c2013-10-11 19:45:02 +00001246 FormatTok->Type = TT_ImplicitStringLiteral;
Manuel Klimek31c85922013-08-29 15:21:40 +00001247 ++Column;
1248 break;
1249 }
1250 }
1251
Daniel Jasper877615c2013-10-11 19:45:02 +00001252 if (FormatTok->Type == TT_ImplicitStringLiteral)
1253 break;
Manuel Klimek15dfe7a2013-05-28 11:55:06 +00001254 WhitespaceLength += FormatTok->Tok.getLength();
Alexander Kornienkoe3276842012-12-07 16:15:44 +00001255
Daniel Jasper8369aa52013-07-16 20:28:33 +00001256 readRawToken(*FormatTok);
Manuel Klimek1abf7892013-01-04 23:34:14 +00001257 }
Manuel Klimekef920692013-01-07 07:56:50 +00001258
Manuel Klimek1abf7892013-01-04 23:34:14 +00001259 // In case the token starts with escaped newlines, we want to
1260 // take them into account as whitespace - this pattern is quite frequent
1261 // in macro definitions.
Manuel Klimek1abf7892013-01-04 23:34:14 +00001262 // FIXME: Add a more explicit test.
Daniel Jasper8369aa52013-07-16 20:28:33 +00001263 while (FormatTok->TokenText.size() > 1 && FormatTok->TokenText[0] == '\\' &&
1264 FormatTok->TokenText[1] == '\n') {
Manuel Klimek15dfe7a2013-05-28 11:55:06 +00001265 // FIXME: ++FormatTok->NewlinesBefore is missing...
Manuel Klimek5c24cca2013-05-23 10:56:37 +00001266 WhitespaceLength += 2;
Manuel Klimek31c85922013-08-29 15:21:40 +00001267 Column = 0;
Daniel Jasper8369aa52013-07-16 20:28:33 +00001268 FormatTok->TokenText = FormatTok->TokenText.substr(2);
Alexander Kornienkoe3276842012-12-07 16:15:44 +00001269 }
Alexander Kornienko39856b72013-09-10 09:38:25 +00001270
1271 FormatTok->WhitespaceRange = SourceRange(
1272 WhitespaceStart, WhitespaceStart.getLocWithOffset(WhitespaceLength));
1273
Manuel Klimek31c85922013-08-29 15:21:40 +00001274 FormatTok->OriginalColumn = Column;
Alexander Kornienkoe3276842012-12-07 16:15:44 +00001275
Alexander Kornienkoee4ca9b2013-06-07 17:45:07 +00001276 TrailingWhitespace = 0;
1277 if (FormatTok->Tok.is(tok::comment)) {
Manuel Klimek31c85922013-08-29 15:21:40 +00001278 // FIXME: Add the trimmed whitespace to Column.
Daniel Jasper8369aa52013-07-16 20:28:33 +00001279 StringRef UntrimmedText = FormatTok->TokenText;
Alexander Kornienko9ab4a772013-09-06 17:24:54 +00001280 FormatTok->TokenText = FormatTok->TokenText.rtrim(" \t\v\f");
Daniel Jasper8369aa52013-07-16 20:28:33 +00001281 TrailingWhitespace = UntrimmedText.size() - FormatTok->TokenText.size();
Alexander Kornienkoee4ca9b2013-06-07 17:45:07 +00001282 } else if (FormatTok->Tok.is(tok::raw_identifier)) {
Daniel Jasper8369aa52013-07-16 20:28:33 +00001283 IdentifierInfo &Info = IdentTable.get(FormatTok->TokenText);
Manuel Klimek15dfe7a2013-05-28 11:55:06 +00001284 FormatTok->Tok.setIdentifierInfo(&Info);
1285 FormatTok->Tok.setKind(Info.getTokenID());
Alexander Kornienkoee4ca9b2013-06-07 17:45:07 +00001286 } else if (FormatTok->Tok.is(tok::greatergreater)) {
Manuel Klimek15dfe7a2013-05-28 11:55:06 +00001287 FormatTok->Tok.setKind(tok::greater);
Daniel Jasper8369aa52013-07-16 20:28:33 +00001288 FormatTok->TokenText = FormatTok->TokenText.substr(0, 1);
Alexander Kornienkoe3276842012-12-07 16:15:44 +00001289 GreaterStashed = true;
1290 }
1291
Alexander Kornienkoee4ca9b2013-06-07 17:45:07 +00001292 // Now FormatTok is the next non-whitespace token.
Alexander Kornienkoffcc0102013-06-05 14:09:10 +00001293
Alexander Kornienko39856b72013-09-10 09:38:25 +00001294 StringRef Text = FormatTok->TokenText;
1295 size_t FirstNewlinePos = Text.find('\n');
Alexander Kornienko917f9e02013-09-10 12:29:48 +00001296 if (FirstNewlinePos == StringRef::npos) {
1297 // FIXME: ColumnWidth actually depends on the start column, we need to
1298 // take this into account when the token is moved.
1299 FormatTok->ColumnWidth =
1300 encoding::columnWidthWithTabs(Text, Column, Style.TabWidth, Encoding);
1301 Column += FormatTok->ColumnWidth;
1302 } else {
Alexander Kornienko39856b72013-09-10 09:38:25 +00001303 FormatTok->IsMultiline = true;
Alexander Kornienko917f9e02013-09-10 12:29:48 +00001304 // FIXME: ColumnWidth actually depends on the start column, we need to
1305 // take this into account when the token is moved.
1306 FormatTok->ColumnWidth = encoding::columnWidthWithTabs(
1307 Text.substr(0, FirstNewlinePos), Column, Style.TabWidth, Encoding);
1308
Alexander Kornienko39856b72013-09-10 09:38:25 +00001309 // The last line of the token always starts in column 0.
1310 // Thus, the length can be precomputed even in the presence of tabs.
1311 FormatTok->LastLineColumnWidth = encoding::columnWidthWithTabs(
1312 Text.substr(Text.find_last_of('\n') + 1), 0, Style.TabWidth,
1313 Encoding);
Alexander Kornienko917f9e02013-09-10 12:29:48 +00001314 Column = FormatTok->LastLineColumnWidth;
Alexander Kornienko632abb92013-09-02 13:58:14 +00001315 }
Alexander Kornienko39856b72013-09-10 09:38:25 +00001316
Alexander Kornienkoe3276842012-12-07 16:15:44 +00001317 return FormatTok;
1318 }
1319
Manuel Klimek15dfe7a2013-05-28 11:55:06 +00001320 FormatToken *FormatTok;
Alexander Kornienko393e3082013-11-13 14:04:17 +00001321 bool IsFirstToken;
Alexander Kornienkoe3276842012-12-07 16:15:44 +00001322 bool GreaterStashed;
Manuel Klimek31c85922013-08-29 15:21:40 +00001323 unsigned Column;
Manuel Klimek9043c742013-05-27 15:23:34 +00001324 unsigned TrailingWhitespace;
Alexander Kornienkoe3276842012-12-07 16:15:44 +00001325 Lexer &Lex;
1326 SourceManager &SourceMgr;
Manuel Klimek31c85922013-08-29 15:21:40 +00001327 FormatStyle &Style;
Alexander Kornienkoe3276842012-12-07 16:15:44 +00001328 IdentifierTable IdentTable;
Alexander Kornienkoffcc0102013-06-05 14:09:10 +00001329 encoding::Encoding Encoding;
Manuel Klimek15dfe7a2013-05-28 11:55:06 +00001330 llvm::SpecificBumpPtrAllocator<FormatToken> Allocator;
1331 SmallVector<FormatToken *, 16> Tokens;
Alexander Kornienkoe3276842012-12-07 16:15:44 +00001332
Daniel Jasper8369aa52013-07-16 20:28:33 +00001333 void readRawToken(FormatToken &Tok) {
1334 Lex.LexFromRawLexer(Tok.Tok);
1335 Tok.TokenText = StringRef(SourceMgr.getCharacterData(Tok.Tok.getLocation()),
1336 Tok.Tok.getLength());
Daniel Jasper8369aa52013-07-16 20:28:33 +00001337 // For formatting, treat unterminated string literals like normal string
1338 // literals.
1339 if (Tok.is(tok::unknown) && !Tok.TokenText.empty() &&
1340 Tok.TokenText[0] == '"') {
1341 Tok.Tok.setKind(tok::string_literal);
1342 Tok.IsUnterminatedLiteral = true;
1343 }
Alexander Kornienkoe3276842012-12-07 16:15:44 +00001344 }
1345};
1346
Alexander Kornienkocabdd732013-11-29 15:19:43 +00001347static StringRef getLanguageName(FormatStyle::LanguageKind Language) {
1348 switch (Language) {
1349 case FormatStyle::LK_Cpp:
1350 return "C++";
1351 case FormatStyle::LK_JavaScript:
1352 return "JavaScript";
1353 default:
1354 return "Unknown";
1355 }
1356}
1357
Daniel Jasperf7935112012-12-03 18:12:45 +00001358class Formatter : public UnwrappedLineConsumer {
1359public:
Daniel Jasperd2ae41a2013-05-15 08:14:19 +00001360 Formatter(const FormatStyle &Style, Lexer &Lex, SourceManager &SourceMgr,
Daniel Jasperf7935112012-12-03 18:12:45 +00001361 const std::vector<CharSourceRange> &Ranges)
Daniel Jasperd2ae41a2013-05-15 08:14:19 +00001362 : Style(Style), Lex(Lex), SourceMgr(SourceMgr),
Alexander Kornienko9e649af2013-09-11 12:25:57 +00001363 Whitespaces(SourceMgr, Style, inputUsesCRLF(Lex.getBuffer())),
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +00001364 Ranges(Ranges.begin(), Ranges.end()), UnwrappedLines(1),
Manuel Klimek71814b42013-10-11 21:25:45 +00001365 Encoding(encoding::detectEncoding(Lex.getBuffer())) {
Daniel Jasperfa21c072013-07-15 14:33:14 +00001366 DEBUG(llvm::dbgs() << "File encoding: "
1367 << (Encoding == encoding::Encoding_UTF8 ? "UTF8"
1368 : "unknown")
1369 << "\n");
Alexander Kornienkocabdd732013-11-29 15:19:43 +00001370 DEBUG(llvm::dbgs() << "Language: " << getLanguageName(Style.Language)
1371 << "\n");
Alexander Kornienkoffcc0102013-06-05 14:09:10 +00001372 }
Daniel Jasperf7935112012-12-03 18:12:45 +00001373
Alexander Kornienko62b85b92013-03-13 14:41:29 +00001374 tooling::Replacements format() {
Manuel Klimek71814b42013-10-11 21:25:45 +00001375 tooling::Replacements Result;
Manuel Klimek31c85922013-08-29 15:21:40 +00001376 FormatTokenLexer Tokens(Lex, SourceMgr, Style, Encoding);
Manuel Klimek15dfe7a2013-05-28 11:55:06 +00001377
1378 UnwrappedLineParser Parser(Style, Tokens.lex(), *this);
Manuel Klimek1a18c402013-04-12 14:13:36 +00001379 bool StructuralError = Parser.parse();
Manuel Klimek71814b42013-10-11 21:25:45 +00001380 assert(UnwrappedLines.rbegin()->empty());
1381 for (unsigned Run = 0, RunE = UnwrappedLines.size(); Run + 1 != RunE;
1382 ++Run) {
1383 DEBUG(llvm::dbgs() << "Run " << Run << "...\n");
1384 SmallVector<AnnotatedLine *, 16> AnnotatedLines;
1385 for (unsigned i = 0, e = UnwrappedLines[Run].size(); i != e; ++i) {
1386 AnnotatedLines.push_back(new AnnotatedLine(UnwrappedLines[Run][i]));
1387 }
1388 tooling::Replacements RunResult =
1389 format(AnnotatedLines, StructuralError, Tokens);
1390 DEBUG({
1391 llvm::dbgs() << "Replacements for run " << Run << ":\n";
1392 for (tooling::Replacements::iterator I = RunResult.begin(),
1393 E = RunResult.end();
1394 I != E; ++I) {
1395 llvm::dbgs() << I->toString() << "\n";
1396 }
1397 });
1398 for (unsigned i = 0, e = AnnotatedLines.size(); i != e; ++i) {
1399 delete AnnotatedLines[i];
1400 }
1401 Result.insert(RunResult.begin(), RunResult.end());
1402 Whitespaces.reset();
1403 }
1404 return Result;
1405 }
1406
1407 tooling::Replacements format(SmallVectorImpl<AnnotatedLine *> &AnnotatedLines,
1408 bool StructuralError, FormatTokenLexer &Tokens) {
Alexander Kornienkoffcc0102013-06-05 14:09:10 +00001409 TokenAnnotator Annotator(Style, Tokens.getIdentTable().get("in"));
Alexander Kornienko62b85b92013-03-13 14:41:29 +00001410 for (unsigned i = 0, e = AnnotatedLines.size(); i != e; ++i) {
Daniel Jasper9fe0e8d2013-09-05 09:29:45 +00001411 Annotator.annotate(*AnnotatedLines[i]);
Alexander Kornienko62b85b92013-03-13 14:41:29 +00001412 }
Manuel Klimek71814b42013-10-11 21:25:45 +00001413 deriveLocalStyle(AnnotatedLines);
Alexander Kornienko62b85b92013-03-13 14:41:29 +00001414 for (unsigned i = 0, e = AnnotatedLines.size(); i != e; ++i) {
Daniel Jasper9fe0e8d2013-09-05 09:29:45 +00001415 Annotator.calculateFormattingInformation(*AnnotatedLines[i]);
Alexander Kornienko62b85b92013-03-13 14:41:29 +00001416 }
Daniel Jasper5500f612013-11-25 11:08:59 +00001417 computeAffectedLines(AnnotatedLines.begin(), AnnotatedLines.end());
Daniel Jasperb67cc422013-04-09 17:46:55 +00001418
Daniel Jasper1c5d9df2013-09-06 07:54:20 +00001419 Annotator.setCommentLineLevels(AnnotatedLines);
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +00001420 ContinuationIndenter Indenter(Style, SourceMgr, Whitespaces, Encoding,
1421 BinPackInconclusiveFunctions);
Daniel Jasper5500f612013-11-25 11:08:59 +00001422 UnwrappedLineFormatter Formatter(&Indenter, &Whitespaces, Style);
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +00001423 Formatter.format(AnnotatedLines, /*DryRun=*/false);
Alexander Kornienko62b85b92013-03-13 14:41:29 +00001424 return Whitespaces.generateReplacements();
1425 }
1426
1427private:
Daniel Jasper5500f612013-11-25 11:08:59 +00001428 // Determines which lines are affected by the SourceRanges given as input.
Daniel Jasper9c199562013-11-28 15:58:55 +00001429 // Returns \c true if at least one line between I and E or one of their
1430 // children is affected.
Daniel Jasper5500f612013-11-25 11:08:59 +00001431 bool computeAffectedLines(SmallVectorImpl<AnnotatedLine *>::iterator I,
1432 SmallVectorImpl<AnnotatedLine *>::iterator E) {
1433 bool SomeLineAffected = false;
Daniel Jasper38c82402013-11-29 09:27:43 +00001434 const AnnotatedLine *PreviousLine = NULL;
Daniel Jasper5500f612013-11-25 11:08:59 +00001435 while (I != E) {
1436 AnnotatedLine *Line = *I;
1437 Line->LeadingEmptyLinesAffected = affectsLeadingEmptyLines(*Line->First);
1438
1439 // If a line is part of a preprocessor directive, it needs to be formatted
1440 // if any token within the directive is affected.
1441 if (Line->InPPDirective) {
1442 FormatToken *Last = Line->Last;
1443 SmallVectorImpl<AnnotatedLine *>::iterator PPEnd = I + 1;
1444 while (PPEnd != E && !(*PPEnd)->First->HasUnescapedNewline) {
1445 Last = (*PPEnd)->Last;
1446 ++PPEnd;
1447 }
1448
1449 if (affectsTokenRange(*Line->First, *Last,
1450 /*IncludeLeadingNewlines=*/false)) {
1451 SomeLineAffected = true;
1452 markAllAsAffected(I, PPEnd);
1453 }
1454 I = PPEnd;
1455 continue;
1456 }
1457
Daniel Jasper38c82402013-11-29 09:27:43 +00001458 if (nonPPLineAffected(Line, PreviousLine))
Daniel Jasper5500f612013-11-25 11:08:59 +00001459 SomeLineAffected = true;
Daniel Jasper5500f612013-11-25 11:08:59 +00001460
Daniel Jasper38c82402013-11-29 09:27:43 +00001461 PreviousLine = Line;
Daniel Jasper5500f612013-11-25 11:08:59 +00001462 ++I;
1463 }
1464 return SomeLineAffected;
1465 }
1466
Daniel Jasper9c199562013-11-28 15:58:55 +00001467 // Determines whether 'Line' is affected by the SourceRanges given as input.
1468 // Returns \c true if line or one if its children is affected.
Daniel Jasper38c82402013-11-29 09:27:43 +00001469 bool nonPPLineAffected(AnnotatedLine *Line,
1470 const AnnotatedLine *PreviousLine) {
Daniel Jasper9c199562013-11-28 15:58:55 +00001471 bool SomeLineAffected = false;
1472 Line->ChildrenAffected =
1473 computeAffectedLines(Line->Children.begin(), Line->Children.end());
1474 if (Line->ChildrenAffected)
1475 SomeLineAffected = true;
1476
1477 // Stores whether one of the line's tokens is directly affected.
1478 bool SomeTokenAffected = false;
1479 // Stores whether we need to look at the leading newlines of the next token
1480 // in order to determine whether it was affected.
1481 bool IncludeLeadingNewlines = false;
1482
1483 // Stores whether the first child line of any of this line's tokens is
1484 // affected.
1485 bool SomeFirstChildAffected = false;
1486
1487 for (FormatToken *Tok = Line->First; Tok; Tok = Tok->Next) {
1488 // Determine whether 'Tok' was affected.
1489 if (affectsTokenRange(*Tok, *Tok, IncludeLeadingNewlines))
1490 SomeTokenAffected = true;
1491
1492 // Determine whether the first child of 'Tok' was affected.
1493 if (!Tok->Children.empty() && Tok->Children.front()->Affected)
1494 SomeFirstChildAffected = true;
1495
1496 IncludeLeadingNewlines = Tok->Children.empty();
1497 }
1498
1499 // Was this line moved, i.e. has it previously been on the same line as an
1500 // affected line?
Daniel Jasper38c82402013-11-29 09:27:43 +00001501 bool LineMoved = PreviousLine && PreviousLine->Affected &&
1502 Line->First->NewlinesBefore == 0;
Daniel Jasper9c199562013-11-28 15:58:55 +00001503
Daniel Jasper38c82402013-11-29 09:27:43 +00001504 bool IsContinuedComment = Line->First->is(tok::comment) &&
1505 Line->First->Next == NULL &&
1506 Line->First->NewlinesBefore < 2 && PreviousLine &&
Daniel Jasper0e81f1a2013-12-02 09:19:27 +00001507 PreviousLine->Affected &&
Daniel Jasper38c82402013-11-29 09:27:43 +00001508 PreviousLine->Last->is(tok::comment);
1509
1510 if (SomeTokenAffected || SomeFirstChildAffected || LineMoved ||
1511 IsContinuedComment) {
Daniel Jasper9c199562013-11-28 15:58:55 +00001512 Line->Affected = true;
Daniel Jasper9c199562013-11-28 15:58:55 +00001513 SomeLineAffected = true;
Daniel Jasper9c199562013-11-28 15:58:55 +00001514 }
1515 return SomeLineAffected;
1516 }
1517
Daniel Jasper5500f612013-11-25 11:08:59 +00001518 // Marks all lines between I and E as well as all their children as affected.
1519 void markAllAsAffected(SmallVectorImpl<AnnotatedLine *>::iterator I,
1520 SmallVectorImpl<AnnotatedLine *>::iterator E) {
1521 while (I != E) {
1522 (*I)->Affected = true;
1523 markAllAsAffected((*I)->Children.begin(), (*I)->Children.end());
1524 ++I;
1525 }
1526 }
1527
1528 // Returns true if the range from 'First' to 'Last' intersects with one of the
1529 // input ranges.
1530 bool affectsTokenRange(const FormatToken &First, const FormatToken &Last,
1531 bool IncludeLeadingNewlines) {
1532 SourceLocation Start = First.WhitespaceRange.getBegin();
1533 if (!IncludeLeadingNewlines)
1534 Start = Start.getLocWithOffset(First.LastNewlineOffset);
Daniel Jasper5877bf12013-11-25 11:53:05 +00001535 SourceLocation End = Last.getStartOfNonWhitespace();
1536 if (Last.TokenText.size() > 0)
1537 End = End.getLocWithOffset(Last.TokenText.size() - 1);
Daniel Jasper5500f612013-11-25 11:08:59 +00001538 CharSourceRange Range = CharSourceRange::getCharRange(Start, End);
1539 return affectsCharSourceRange(Range);
1540 }
1541
1542 // Returns true if one of the input ranges intersect the leading empty lines
1543 // before 'Tok'.
1544 bool affectsLeadingEmptyLines(const FormatToken &Tok) {
1545 CharSourceRange EmptyLineRange = CharSourceRange::getCharRange(
1546 Tok.WhitespaceRange.getBegin(),
1547 Tok.WhitespaceRange.getBegin().getLocWithOffset(Tok.LastNewlineOffset));
1548 return affectsCharSourceRange(EmptyLineRange);
1549 }
1550
1551 // Returns true if 'Range' intersects with one of the input ranges.
1552 bool affectsCharSourceRange(const CharSourceRange &Range) {
1553 for (SmallVectorImpl<CharSourceRange>::const_iterator I = Ranges.begin(),
1554 E = Ranges.end();
1555 I != E; ++I) {
1556 if (!SourceMgr.isBeforeInTranslationUnit(Range.getEnd(), I->getBegin()) &&
1557 !SourceMgr.isBeforeInTranslationUnit(I->getEnd(), Range.getBegin()))
1558 return true;
1559 }
1560 return false;
1561 }
1562
Alexander Kornienko9e649af2013-09-11 12:25:57 +00001563 static bool inputUsesCRLF(StringRef Text) {
1564 return Text.count('\r') * 2 > Text.count('\n');
1565 }
1566
Manuel Klimek71814b42013-10-11 21:25:45 +00001567 void
1568 deriveLocalStyle(const SmallVectorImpl<AnnotatedLine *> &AnnotatedLines) {
Daniel Jasper7fce3ab2013-02-06 14:22:40 +00001569 unsigned CountBoundToVariable = 0;
1570 unsigned CountBoundToType = 0;
1571 bool HasCpp03IncompatibleFormat = false;
Daniel Jasperb10cbc42013-07-10 14:02:49 +00001572 bool HasBinPackedFunction = false;
1573 bool HasOnePerLineFunction = false;
Daniel Jasper7fce3ab2013-02-06 14:22:40 +00001574 for (unsigned i = 0, e = AnnotatedLines.size(); i != e; ++i) {
Daniel Jasper9fe0e8d2013-09-05 09:29:45 +00001575 if (!AnnotatedLines[i]->First->Next)
Daniel Jasper7fce3ab2013-02-06 14:22:40 +00001576 continue;
Daniel Jasper9fe0e8d2013-09-05 09:29:45 +00001577 FormatToken *Tok = AnnotatedLines[i]->First->Next;
Manuel Klimek6e6310e2013-05-29 14:47:47 +00001578 while (Tok->Next) {
Daniel Jasper7fce3ab2013-02-06 14:22:40 +00001579 if (Tok->Type == TT_PointerOrReference) {
Manuel Klimek6e6310e2013-05-29 14:47:47 +00001580 bool SpacesBefore =
1581 Tok->WhitespaceRange.getBegin() != Tok->WhitespaceRange.getEnd();
1582 bool SpacesAfter = Tok->Next->WhitespaceRange.getBegin() !=
1583 Tok->Next->WhitespaceRange.getEnd();
Daniel Jasper7fce3ab2013-02-06 14:22:40 +00001584 if (SpacesBefore && !SpacesAfter)
1585 ++CountBoundToVariable;
1586 else if (!SpacesBefore && SpacesAfter)
1587 ++CountBoundToType;
1588 }
1589
Daniel Jasperfba84ff2013-10-12 05:16:06 +00001590 if (Tok->WhitespaceRange.getBegin() == Tok->WhitespaceRange.getEnd()) {
1591 if (Tok->is(tok::coloncolon) &&
1592 Tok->Previous->Type == TT_TemplateOpener)
1593 HasCpp03IncompatibleFormat = true;
1594 if (Tok->Type == TT_TemplateCloser &&
1595 Tok->Previous->Type == TT_TemplateCloser)
1596 HasCpp03IncompatibleFormat = true;
1597 }
Daniel Jasperb10cbc42013-07-10 14:02:49 +00001598
1599 if (Tok->PackingKind == PPK_BinPacked)
1600 HasBinPackedFunction = true;
1601 if (Tok->PackingKind == PPK_OnePerLine)
1602 HasOnePerLineFunction = true;
1603
Manuel Klimek6e6310e2013-05-29 14:47:47 +00001604 Tok = Tok->Next;
Daniel Jasper7fce3ab2013-02-06 14:22:40 +00001605 }
1606 }
1607 if (Style.DerivePointerBinding) {
1608 if (CountBoundToType > CountBoundToVariable)
1609 Style.PointerBindsToType = true;
1610 else if (CountBoundToType < CountBoundToVariable)
1611 Style.PointerBindsToType = false;
1612 }
1613 if (Style.Standard == FormatStyle::LS_Auto) {
1614 Style.Standard = HasCpp03IncompatibleFormat ? FormatStyle::LS_Cpp11
1615 : FormatStyle::LS_Cpp03;
1616 }
Daniel Jasperb10cbc42013-07-10 14:02:49 +00001617 BinPackInconclusiveFunctions =
1618 HasBinPackedFunction || !HasOnePerLineFunction;
Daniel Jasper7fce3ab2013-02-06 14:22:40 +00001619 }
1620
Manuel Klimek51bd6ec2013-01-10 19:49:59 +00001621 virtual void consumeUnwrappedLine(const UnwrappedLine &TheLine) {
Manuel Klimek71814b42013-10-11 21:25:45 +00001622 assert(!UnwrappedLines.empty());
1623 UnwrappedLines.back().push_back(TheLine);
1624 }
1625
1626 virtual void finishRun() {
1627 UnwrappedLines.push_back(SmallVector<UnwrappedLine, 16>());
Daniel Jasperf7935112012-12-03 18:12:45 +00001628 }
1629
1630 FormatStyle Style;
1631 Lexer &Lex;
1632 SourceManager &SourceMgr;
Daniel Jasperaa701fa2013-01-18 08:44:07 +00001633 WhitespaceManager Whitespaces;
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +00001634 SmallVector<CharSourceRange, 8> Ranges;
Manuel Klimek71814b42013-10-11 21:25:45 +00001635 SmallVector<SmallVector<UnwrappedLine, 16>, 2> UnwrappedLines;
Alexander Kornienkoffcc0102013-06-05 14:09:10 +00001636
1637 encoding::Encoding Encoding;
Daniel Jasperb10cbc42013-07-10 14:02:49 +00001638 bool BinPackInconclusiveFunctions;
Daniel Jasperf7935112012-12-03 18:12:45 +00001639};
1640
Craig Topperaf35e852013-06-30 22:29:28 +00001641} // end anonymous namespace
1642
Alexander Kornienkocb45bc12013-04-15 14:28:00 +00001643tooling::Replacements reformat(const FormatStyle &Style, Lexer &Lex,
1644 SourceManager &SourceMgr,
Daniel Jasperd2ae41a2013-05-15 08:14:19 +00001645 std::vector<CharSourceRange> Ranges) {
1646 Formatter formatter(Style, Lex, SourceMgr, Ranges);
Daniel Jasperf7935112012-12-03 18:12:45 +00001647 return formatter.format();
1648}
1649
Daniel Jasperec04c0d2013-05-16 10:40:07 +00001650tooling::Replacements reformat(const FormatStyle &Style, StringRef Code,
1651 std::vector<tooling::Range> Ranges,
1652 StringRef FileName) {
1653 FileManager Files((FileSystemOptions()));
1654 DiagnosticsEngine Diagnostics(
1655 IntrusiveRefCntPtr<DiagnosticIDs>(new DiagnosticIDs),
1656 new DiagnosticOptions);
1657 SourceManager SourceMgr(Diagnostics, Files);
1658 llvm::MemoryBuffer *Buf = llvm::MemoryBuffer::getMemBuffer(Code, FileName);
1659 const clang::FileEntry *Entry =
1660 Files.getVirtualFile(FileName, Buf->getBufferSize(), 0);
1661 SourceMgr.overrideFileContents(Entry, Buf);
1662 FileID ID =
1663 SourceMgr.createFileID(Entry, SourceLocation(), clang::SrcMgr::C_User);
Alexander Kornienko1e808872013-06-28 12:51:24 +00001664 Lexer Lex(ID, SourceMgr.getBuffer(ID), SourceMgr,
1665 getFormattingLangOpts(Style.Standard));
Daniel Jasperec04c0d2013-05-16 10:40:07 +00001666 SourceLocation StartOfFile = SourceMgr.getLocForStartOfFile(ID);
1667 std::vector<CharSourceRange> CharRanges;
1668 for (unsigned i = 0, e = Ranges.size(); i != e; ++i) {
1669 SourceLocation Start = StartOfFile.getLocWithOffset(Ranges[i].getOffset());
1670 SourceLocation End = Start.getLocWithOffset(Ranges[i].getLength());
1671 CharRanges.push_back(CharSourceRange::getCharRange(Start, End));
1672 }
1673 return reformat(Style, Lex, SourceMgr, CharRanges);
1674}
1675
Alexander Kornienko1e808872013-06-28 12:51:24 +00001676LangOptions getFormattingLangOpts(FormatStyle::LanguageStandard Standard) {
Daniel Jasperc1fa2812013-01-10 13:08:12 +00001677 LangOptions LangOpts;
1678 LangOpts.CPlusPlus = 1;
Alexander Kornienko1e808872013-06-28 12:51:24 +00001679 LangOpts.CPlusPlus11 = Standard == FormatStyle::LS_Cpp03 ? 0 : 1;
Daniel Jasper55213652013-03-22 10:01:29 +00001680 LangOpts.LineComment = 1;
Daniel Jasperc1fa2812013-01-10 13:08:12 +00001681 LangOpts.Bool = 1;
1682 LangOpts.ObjC1 = 1;
1683 LangOpts.ObjC2 = 1;
1684 return LangOpts;
1685}
1686
Edwin Vaned544aa72013-09-30 13:31:48 +00001687const char *StyleOptionHelpDescription =
1688 "Coding style, currently supports:\n"
1689 " LLVM, Google, Chromium, Mozilla, WebKit.\n"
1690 "Use -style=file to load style configuration from\n"
1691 ".clang-format file located in one of the parent\n"
1692 "directories of the source file (or current\n"
1693 "directory for stdin).\n"
1694 "Use -style=\"{key: value, ...}\" to set specific\n"
1695 "parameters, e.g.:\n"
1696 " -style=\"{BasedOnStyle: llvm, IndentWidth: 8}\"";
1697
Alexander Kornienkoc1637f12013-12-10 11:28:13 +00001698static FormatStyle::LanguageKind getLanguageByFileName(StringRef FileName) {
Alexander Kornienkocabdd732013-11-29 15:19:43 +00001699 if (FileName.endswith_lower(".js")) {
Alexander Kornienkoc1637f12013-12-10 11:28:13 +00001700 return FormatStyle::LK_JavaScript;
Alexander Kornienkocabdd732013-11-29 15:19:43 +00001701 }
Alexander Kornienkoc1637f12013-12-10 11:28:13 +00001702 return FormatStyle::LK_Cpp;
Alexander Kornienkocabdd732013-11-29 15:19:43 +00001703}
1704
Alexander Kornienkobc4ae442013-12-02 15:21:38 +00001705FormatStyle getStyle(StringRef StyleName, StringRef FileName,
1706 StringRef FallbackStyle) {
Alexander Kornienkoc1637f12013-12-10 11:28:13 +00001707 FormatStyle Style = getLLVMStyle();
1708 Style.Language = getLanguageByFileName(FileName);
1709 if (!getPredefinedStyle(FallbackStyle, Style.Language, &Style)) {
Alexander Kornienkobc4ae442013-12-02 15:21:38 +00001710 llvm::errs() << "Invalid fallback style \"" << FallbackStyle
1711 << "\" using LLVM style\n";
Alexander Kornienkoc1637f12013-12-10 11:28:13 +00001712 return Style;
Alexander Kornienkobc4ae442013-12-02 15:21:38 +00001713 }
Edwin Vaned544aa72013-09-30 13:31:48 +00001714
1715 if (StyleName.startswith("{")) {
1716 // Parse YAML/JSON style from the command line.
1717 if (llvm::error_code ec = parseConfiguration(StyleName, &Style)) {
Alexander Kornienkoe2e03872013-10-14 00:46:35 +00001718 llvm::errs() << "Error parsing -style: " << ec.message() << ", using "
1719 << FallbackStyle << " style\n";
Edwin Vaned544aa72013-09-30 13:31:48 +00001720 }
1721 return Style;
1722 }
1723
1724 if (!StyleName.equals_lower("file")) {
Alexander Kornienkoc1637f12013-12-10 11:28:13 +00001725 if (!getPredefinedStyle(StyleName, Style.Language, &Style))
Edwin Vaned544aa72013-09-30 13:31:48 +00001726 llvm::errs() << "Invalid value for -style, using " << FallbackStyle
1727 << " style\n";
1728 return Style;
1729 }
1730
Alexander Kornienkoc1637f12013-12-10 11:28:13 +00001731 // Look for .clang-format/_clang-format file in the file's parent directories.
Alexander Kornienkocabdd732013-11-29 15:19:43 +00001732 SmallString<128> UnsuitableConfigFiles;
Edwin Vaned544aa72013-09-30 13:31:48 +00001733 SmallString<128> Path(FileName);
1734 llvm::sys::fs::make_absolute(Path);
Alexander Kornienkoe2e03872013-10-14 00:46:35 +00001735 for (StringRef Directory = Path; !Directory.empty();
Edwin Vaned544aa72013-09-30 13:31:48 +00001736 Directory = llvm::sys::path::parent_path(Directory)) {
1737 if (!llvm::sys::fs::is_directory(Directory))
1738 continue;
1739 SmallString<128> ConfigFile(Directory);
1740
1741 llvm::sys::path::append(ConfigFile, ".clang-format");
1742 DEBUG(llvm::dbgs() << "Trying " << ConfigFile << "...\n");
1743 bool IsFile = false;
1744 // Ignore errors from is_regular_file: we only need to know if we can read
1745 // the file or not.
1746 llvm::sys::fs::is_regular_file(Twine(ConfigFile), IsFile);
1747
1748 if (!IsFile) {
1749 // Try _clang-format too, since dotfiles are not commonly used on Windows.
1750 ConfigFile = Directory;
1751 llvm::sys::path::append(ConfigFile, "_clang-format");
1752 DEBUG(llvm::dbgs() << "Trying " << ConfigFile << "...\n");
1753 llvm::sys::fs::is_regular_file(Twine(ConfigFile), IsFile);
1754 }
1755
1756 if (IsFile) {
1757 OwningPtr<llvm::MemoryBuffer> Text;
Rafael Espindola1a3605c2013-10-25 19:00:49 +00001758 if (llvm::error_code ec =
1759 llvm::MemoryBuffer::getFile(ConfigFile.c_str(), Text)) {
Edwin Vaned544aa72013-09-30 13:31:48 +00001760 llvm::errs() << ec.message() << "\n";
Alexander Kornienkobc4ae442013-12-02 15:21:38 +00001761 break;
Edwin Vaned544aa72013-09-30 13:31:48 +00001762 }
1763 if (llvm::error_code ec = parseConfiguration(Text->getBuffer(), &Style)) {
Alexander Kornienkocabdd732013-11-29 15:19:43 +00001764 if (ec == llvm::errc::not_supported) {
1765 if (!UnsuitableConfigFiles.empty())
1766 UnsuitableConfigFiles.append(", ");
1767 UnsuitableConfigFiles.append(ConfigFile);
Alexander Kornienkobc4ae442013-12-02 15:21:38 +00001768 continue;
Alexander Kornienkocabdd732013-11-29 15:19:43 +00001769 }
Alexander Kornienkobc4ae442013-12-02 15:21:38 +00001770 llvm::errs() << "Error reading " << ConfigFile << ": " << ec.message()
1771 << "\n";
1772 break;
Edwin Vaned544aa72013-09-30 13:31:48 +00001773 }
1774 DEBUG(llvm::dbgs() << "Using configuration file " << ConfigFile << "\n");
1775 return Style;
1776 }
1777 }
1778 llvm::errs() << "Can't find usable .clang-format, using " << FallbackStyle
1779 << " style\n";
Alexander Kornienkocabdd732013-11-29 15:19:43 +00001780 if (!UnsuitableConfigFiles.empty()) {
1781 llvm::errs() << "Configuration file(s) do(es) not support "
1782 << getLanguageName(Style.Language) << ": "
1783 << UnsuitableConfigFiles << "\n";
1784 }
Edwin Vaned544aa72013-09-30 13:31:48 +00001785 return Style;
1786}
1787
Daniel Jasper8d1832e2013-01-07 13:26:07 +00001788} // namespace format
1789} // namespace clang