blob: 68abf1cdb6065adce904c5e020c60fdb7a7b7690 [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);
Daniel Jasper7052ce62014-01-19 09:04:08 +000042 IO.enumCase(Value, "Proto", FormatStyle::LK_Proto);
Alexander Kornienko6d2c88e2013-12-10 10:30:34 +000043 }
44};
45
46template <> struct ScalarEnumerationTraits<FormatStyle::LanguageStandard> {
47 static void enumeration(IO &IO, FormatStyle::LanguageStandard &Value) {
48 IO.enumCase(Value, "Cpp03", FormatStyle::LS_Cpp03);
49 IO.enumCase(Value, "C++03", FormatStyle::LS_Cpp03);
50 IO.enumCase(Value, "Cpp11", FormatStyle::LS_Cpp11);
51 IO.enumCase(Value, "C++11", FormatStyle::LS_Cpp11);
52 IO.enumCase(Value, "Auto", FormatStyle::LS_Auto);
53 }
54};
55
56template <> struct ScalarEnumerationTraits<FormatStyle::UseTabStyle> {
57 static void enumeration(IO &IO, FormatStyle::UseTabStyle &Value) {
58 IO.enumCase(Value, "Never", FormatStyle::UT_Never);
59 IO.enumCase(Value, "false", FormatStyle::UT_Never);
60 IO.enumCase(Value, "Always", FormatStyle::UT_Always);
61 IO.enumCase(Value, "true", FormatStyle::UT_Always);
62 IO.enumCase(Value, "ForIndentation", FormatStyle::UT_ForIndentation);
63 }
64};
65
66template <> struct ScalarEnumerationTraits<FormatStyle::BraceBreakingStyle> {
67 static void enumeration(IO &IO, FormatStyle::BraceBreakingStyle &Value) {
68 IO.enumCase(Value, "Attach", FormatStyle::BS_Attach);
69 IO.enumCase(Value, "Linux", FormatStyle::BS_Linux);
70 IO.enumCase(Value, "Stroustrup", FormatStyle::BS_Stroustrup);
71 IO.enumCase(Value, "Allman", FormatStyle::BS_Allman);
Alexander Kornienko3a33f022013-12-12 09:49:52 +000072 IO.enumCase(Value, "GNU", FormatStyle::BS_GNU);
Alexander Kornienko6d2c88e2013-12-10 10:30:34 +000073 }
74};
75
Alexander Kornienkod6538332013-05-07 15:32:14 +000076template <>
Alexander Kornienko6d2c88e2013-12-10 10:30:34 +000077struct ScalarEnumerationTraits<FormatStyle::NamespaceIndentationKind> {
Alexander Kornienkocabdd732013-11-29 15:19:43 +000078 static void enumeration(IO &IO,
Alexander Kornienko6d2c88e2013-12-10 10:30:34 +000079 FormatStyle::NamespaceIndentationKind &Value) {
80 IO.enumCase(Value, "None", FormatStyle::NI_None);
81 IO.enumCase(Value, "Inner", FormatStyle::NI_Inner);
82 IO.enumCase(Value, "All", FormatStyle::NI_All);
Alexander Kornienkocabdd732013-11-29 15:19:43 +000083 }
84};
85
86template <>
Alexander Kornienko6d2c88e2013-12-10 10:30:34 +000087struct ScalarEnumerationTraits<FormatStyle::SpaceBeforeParensOptions> {
Manuel Klimeka8eb9142013-05-13 12:51:40 +000088 static void enumeration(IO &IO,
Alexander Kornienko6d2c88e2013-12-10 10:30:34 +000089 FormatStyle::SpaceBeforeParensOptions &Value) {
90 IO.enumCase(Value, "Never", FormatStyle::SBPO_Never);
Alexander Kornienkofdca83d2013-12-10 10:18:34 +000091 IO.enumCase(Value, "ControlStatements",
Alexander Kornienko6d2c88e2013-12-10 10:30:34 +000092 FormatStyle::SBPO_ControlStatements);
93 IO.enumCase(Value, "Always", FormatStyle::SBPO_Always);
Alexander Kornienkofdca83d2013-12-10 10:18:34 +000094
95 // For backward compatibility.
Alexander Kornienko6d2c88e2013-12-10 10:30:34 +000096 IO.enumCase(Value, "false", FormatStyle::SBPO_Never);
97 IO.enumCase(Value, "true", FormatStyle::SBPO_ControlStatements);
Alexander Kornienkofdca83d2013-12-10 10:18:34 +000098 }
99};
100
Alexander Kornienko6d2c88e2013-12-10 10:30:34 +0000101template <> struct MappingTraits<FormatStyle> {
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000102 static void mapping(IO &IO, FormatStyle &Style) {
103 // When reading, read the language first, we need it for getPredefinedStyle.
104 IO.mapOptional("Language", Style.Language);
105
Alexander Kornienko49149672013-05-10 11:56:10 +0000106 if (IO.outputting()) {
Alexander Kornienkoe3648fb2013-09-02 16:39:23 +0000107 StringRef StylesArray[] = { "LLVM", "Google", "Chromium",
Alexander Kornienkofe7a57f2013-12-10 15:42:15 +0000108 "Mozilla", "WebKit", "GNU" };
Alexander Kornienko49149672013-05-10 11:56:10 +0000109 ArrayRef<StringRef> Styles(StylesArray);
110 for (size_t i = 0, e = Styles.size(); i < e; ++i) {
111 StringRef StyleName(Styles[i]);
Alexander Kornienko6d2c88e2013-12-10 10:30:34 +0000112 FormatStyle PredefinedStyle;
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000113 if (getPredefinedStyle(StyleName, Style.Language, &PredefinedStyle) &&
Alexander Kornienko006b5c82013-05-19 00:53:30 +0000114 Style == PredefinedStyle) {
Alexander Kornienko49149672013-05-10 11:56:10 +0000115 IO.mapOptional("# BasedOnStyle", StyleName);
116 break;
117 }
118 }
119 } else {
Alexander Kornienkod6538332013-05-07 15:32:14 +0000120 StringRef BasedOnStyle;
121 IO.mapOptional("BasedOnStyle", BasedOnStyle);
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000122 if (!BasedOnStyle.empty()) {
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000123 FormatStyle::LanguageKind OldLanguage = Style.Language;
124 FormatStyle::LanguageKind Language =
125 ((FormatStyle *)IO.getContext())->Language;
126 if (!getPredefinedStyle(BasedOnStyle, Language, &Style)) {
Alexander Kornienko006b5c82013-05-19 00:53:30 +0000127 IO.setError(Twine("Unknown value for BasedOnStyle: ", BasedOnStyle));
128 return;
129 }
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000130 Style.Language = OldLanguage;
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000131 }
Alexander Kornienkod6538332013-05-07 15:32:14 +0000132 }
133
134 IO.mapOptional("AccessModifierOffset", Style.AccessModifierOffset);
Daniel Jaspercdaffa42013-08-13 10:58:30 +0000135 IO.mapOptional("ConstructorInitializerIndentWidth",
136 Style.ConstructorInitializerIndentWidth);
Alexander Kornienkod6538332013-05-07 15:32:14 +0000137 IO.mapOptional("AlignEscapedNewlinesLeft", Style.AlignEscapedNewlinesLeft);
Daniel Jasper552f4a72013-07-31 23:55:15 +0000138 IO.mapOptional("AlignTrailingComments", Style.AlignTrailingComments);
Alexander Kornienkod6538332013-05-07 15:32:14 +0000139 IO.mapOptional("AllowAllParametersOfDeclarationOnNextLine",
140 Style.AllowAllParametersOfDeclarationOnNextLine);
141 IO.mapOptional("AllowShortIfStatementsOnASingleLine",
142 Style.AllowShortIfStatementsOnASingleLine);
Daniel Jasper3a685df2013-05-16 12:12:21 +0000143 IO.mapOptional("AllowShortLoopsOnASingleLine",
144 Style.AllowShortLoopsOnASingleLine);
Alexander Kornienko3cfa9732013-11-20 16:33:05 +0000145 IO.mapOptional("AllowShortFunctionsOnASingleLine",
146 Style.AllowShortFunctionsOnASingleLine);
Daniel Jasper61e6bbf2013-05-29 12:07:31 +0000147 IO.mapOptional("AlwaysBreakTemplateDeclarations",
148 Style.AlwaysBreakTemplateDeclarations);
Alexander Kornienko58611712013-07-04 12:02:44 +0000149 IO.mapOptional("AlwaysBreakBeforeMultilineStrings",
150 Style.AlwaysBreakBeforeMultilineStrings);
Daniel Jaspere33d4af2013-07-26 16:56:36 +0000151 IO.mapOptional("BreakBeforeBinaryOperators",
152 Style.BreakBeforeBinaryOperators);
Daniel Jasper165b29e2013-11-08 00:57:11 +0000153 IO.mapOptional("BreakBeforeTernaryOperators",
154 Style.BreakBeforeTernaryOperators);
Daniel Jaspere33d4af2013-07-26 16:56:36 +0000155 IO.mapOptional("BreakConstructorInitializersBeforeComma",
156 Style.BreakConstructorInitializersBeforeComma);
Alexander Kornienkod6538332013-05-07 15:32:14 +0000157 IO.mapOptional("BinPackParameters", Style.BinPackParameters);
158 IO.mapOptional("ColumnLimit", Style.ColumnLimit);
159 IO.mapOptional("ConstructorInitializerAllOnOneLineOrOnePerLine",
160 Style.ConstructorInitializerAllOnOneLineOrOnePerLine);
161 IO.mapOptional("DerivePointerBinding", Style.DerivePointerBinding);
Daniel Jasperb10cbc42013-07-10 14:02:49 +0000162 IO.mapOptional("ExperimentalAutoDetectBinPacking",
163 Style.ExperimentalAutoDetectBinPacking);
Alexander Kornienkod6538332013-05-07 15:32:14 +0000164 IO.mapOptional("IndentCaseLabels", Style.IndentCaseLabels);
165 IO.mapOptional("MaxEmptyLinesToKeep", Style.MaxEmptyLinesToKeep);
Daniel Jasper65ee3472013-07-31 23:16:02 +0000166 IO.mapOptional("NamespaceIndentation", Style.NamespaceIndentation);
Daniel Jaspere9beea22014-01-28 15:20:33 +0000167 IO.mapOptional("ObjCSpaceAfterProperty", Style.ObjCSpaceAfterProperty);
Alexander Kornienkod6538332013-05-07 15:32:14 +0000168 IO.mapOptional("ObjCSpaceBeforeProtocolList",
169 Style.ObjCSpaceBeforeProtocolList);
Daniel Jasper33b909c2013-10-25 14:29:37 +0000170 IO.mapOptional("PenaltyBreakBeforeFirstCallParameter",
171 Style.PenaltyBreakBeforeFirstCallParameter);
Alexander Kornienkodd7ece52013-06-07 16:02:52 +0000172 IO.mapOptional("PenaltyBreakComment", Style.PenaltyBreakComment);
173 IO.mapOptional("PenaltyBreakString", Style.PenaltyBreakString);
Daniel Jasper4e9678f2013-07-11 20:41:21 +0000174 IO.mapOptional("PenaltyBreakFirstLessLess",
175 Style.PenaltyBreakFirstLessLess);
Alexander Kornienkod6538332013-05-07 15:32:14 +0000176 IO.mapOptional("PenaltyExcessCharacter", Style.PenaltyExcessCharacter);
177 IO.mapOptional("PenaltyReturnTypeOnItsOwnLine",
178 Style.PenaltyReturnTypeOnItsOwnLine);
179 IO.mapOptional("PointerBindsToType", Style.PointerBindsToType);
180 IO.mapOptional("SpacesBeforeTrailingComments",
181 Style.SpacesBeforeTrailingComments);
Daniel Jasper6ab54682013-07-16 18:22:10 +0000182 IO.mapOptional("Cpp11BracedListStyle", Style.Cpp11BracedListStyle);
Alexander Kornienkod6538332013-05-07 15:32:14 +0000183 IO.mapOptional("Standard", Style.Standard);
Manuel Klimek13b97d82013-05-13 08:42:42 +0000184 IO.mapOptional("IndentWidth", Style.IndentWidth);
Alexander Kornienkoebb43ca2013-09-05 14:08:34 +0000185 IO.mapOptional("TabWidth", Style.TabWidth);
Manuel Klimekb9eae4c2013-05-13 09:22:11 +0000186 IO.mapOptional("UseTab", Style.UseTab);
Manuel Klimeka8eb9142013-05-13 12:51:40 +0000187 IO.mapOptional("BreakBeforeBraces", Style.BreakBeforeBraces);
Manuel Klimek836c2862013-06-21 17:25:42 +0000188 IO.mapOptional("IndentFunctionDeclarationAfterType",
189 Style.IndentFunctionDeclarationAfterType);
Daniel Jasperb55acad2013-08-20 12:36:34 +0000190 IO.mapOptional("SpacesInParentheses", Style.SpacesInParentheses);
Daniel Jasperdd978ae2013-10-29 14:52:02 +0000191 IO.mapOptional("SpacesInAngles", Style.SpacesInAngles);
Daniel Jasperf110e202013-08-21 08:39:01 +0000192 IO.mapOptional("SpaceInEmptyParentheses", Style.SpaceInEmptyParentheses);
Daniel Jasperb55acad2013-08-20 12:36:34 +0000193 IO.mapOptional("SpacesInCStyleCastParentheses",
194 Style.SpacesInCStyleCastParentheses);
Daniel Jasperb2e10a52014-01-15 15:09:08 +0000195 IO.mapOptional("SpacesInContainerLiterals",
196 Style.SpacesInContainerLiterals);
Daniel Jasperd94bff32013-09-25 15:15:02 +0000197 IO.mapOptional("SpaceBeforeAssignmentOperators",
198 Style.SpaceBeforeAssignmentOperators);
Daniel Jasper6633ab82013-10-18 10:38:14 +0000199 IO.mapOptional("ContinuationIndentWidth", Style.ContinuationIndentWidth);
Alexander Kornienkoce9161a2014-01-02 15:13:14 +0000200 IO.mapOptional("CommentPragmas", Style.CommentPragmas);
Alexander Kornienkofdca83d2013-12-10 10:18:34 +0000201
202 // For backward compatibility.
203 if (!IO.outputting()) {
204 IO.mapOptional("SpaceAfterControlStatementKeyword",
205 Style.SpaceBeforeParens);
206 }
207 IO.mapOptional("SpaceBeforeParens", Style.SpaceBeforeParens);
Alexander Kornienkod6538332013-05-07 15:32:14 +0000208 }
209};
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000210
211// Allows to read vector<FormatStyle> while keeping default values.
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000212// IO.getContext() should contain a pointer to the FormatStyle structure, that
213// will be used to get default values for missing keys.
214// If the first element has no Language specified, it will be treated as the
215// default one for the following elements.
Alexander Kornienko6d2c88e2013-12-10 10:30:34 +0000216template <> struct DocumentListTraits<std::vector<FormatStyle> > {
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000217 static size_t size(IO &IO, std::vector<FormatStyle> &Seq) {
218 return Seq.size();
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000219 }
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000220 static FormatStyle &element(IO &IO, std::vector<FormatStyle> &Seq,
Alexander Kornienko6d2c88e2013-12-10 10:30:34 +0000221 size_t Index) {
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000222 if (Index >= Seq.size()) {
223 assert(Index == Seq.size());
Alexander Kornienko6d2c88e2013-12-10 10:30:34 +0000224 FormatStyle Template;
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000225 if (Seq.size() > 0 && Seq[0].Language == FormatStyle::LK_None) {
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000226 Template = Seq[0];
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000227 } else {
228 Template = *((const FormatStyle*)IO.getContext());
Alexander Kornienko6d2c88e2013-12-10 10:30:34 +0000229 Template.Language = FormatStyle::LK_None;
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000230 }
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000231 Seq.resize(Index + 1, Template);
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000232 }
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000233 return Seq[Index];
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000234 }
235};
Alexander Kornienkod6538332013-05-07 15:32:14 +0000236}
237}
238
Daniel Jasperf7935112012-12-03 18:12:45 +0000239namespace clang {
240namespace format {
241
Daniel Jasperf7935112012-12-03 18:12:45 +0000242FormatStyle getLLVMStyle() {
243 FormatStyle LLVMStyle;
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000244 LLVMStyle.Language = FormatStyle::LK_Cpp;
Daniel Jasperf7935112012-12-03 18:12:45 +0000245 LLVMStyle.AccessModifierOffset = -2;
Alexander Kornienkoc8602662013-05-06 14:11:27 +0000246 LLVMStyle.AlignEscapedNewlinesLeft = false;
Daniel Jasper552f4a72013-07-31 23:55:15 +0000247 LLVMStyle.AlignTrailingComments = true;
Daniel Jasperf7db4332013-01-29 16:03:49 +0000248 LLVMStyle.AllowAllParametersOfDeclarationOnNextLine = true;
Alexander Kornienko3cfa9732013-11-20 16:33:05 +0000249 LLVMStyle.AllowShortFunctionsOnASingleLine = true;
Daniel Jasper1b750ed2013-01-14 16:24:39 +0000250 LLVMStyle.AllowShortIfStatementsOnASingleLine = false;
Daniel Jasper3a685df2013-05-16 12:12:21 +0000251 LLVMStyle.AllowShortLoopsOnASingleLine = false;
Alexander Kornienko58611712013-07-04 12:02:44 +0000252 LLVMStyle.AlwaysBreakBeforeMultilineStrings = false;
Daniel Jaspere33d4af2013-07-26 16:56:36 +0000253 LLVMStyle.AlwaysBreakTemplateDeclarations = false;
Alexander Kornienkoc8602662013-05-06 14:11:27 +0000254 LLVMStyle.BinPackParameters = true;
Daniel Jaspere33d4af2013-07-26 16:56:36 +0000255 LLVMStyle.BreakBeforeBinaryOperators = false;
Daniel Jasper165b29e2013-11-08 00:57:11 +0000256 LLVMStyle.BreakBeforeTernaryOperators = true;
Daniel Jaspere33d4af2013-07-26 16:56:36 +0000257 LLVMStyle.BreakBeforeBraces = FormatStyle::BS_Attach;
258 LLVMStyle.BreakConstructorInitializersBeforeComma = false;
Alexander Kornienkoc8602662013-05-06 14:11:27 +0000259 LLVMStyle.ColumnLimit = 80;
260 LLVMStyle.ConstructorInitializerAllOnOneLineOrOnePerLine = false;
Daniel Jaspercdaffa42013-08-13 10:58:30 +0000261 LLVMStyle.ConstructorInitializerIndentWidth = 4;
Daniel Jaspere33d4af2013-07-26 16:56:36 +0000262 LLVMStyle.Cpp11BracedListStyle = false;
Alexander Kornienkoc8602662013-05-06 14:11:27 +0000263 LLVMStyle.DerivePointerBinding = false;
Daniel Jasperb10cbc42013-07-10 14:02:49 +0000264 LLVMStyle.ExperimentalAutoDetectBinPacking = false;
Alexander Kornienkoc8602662013-05-06 14:11:27 +0000265 LLVMStyle.IndentCaseLabels = false;
Daniel Jaspere33d4af2013-07-26 16:56:36 +0000266 LLVMStyle.IndentFunctionDeclarationAfterType = false;
267 LLVMStyle.IndentWidth = 2;
Alexander Kornienkoebb43ca2013-09-05 14:08:34 +0000268 LLVMStyle.TabWidth = 8;
Alexander Kornienkoc8602662013-05-06 14:11:27 +0000269 LLVMStyle.MaxEmptyLinesToKeep = 1;
Daniel Jasper65ee3472013-07-31 23:16:02 +0000270 LLVMStyle.NamespaceIndentation = FormatStyle::NI_None;
Daniel Jaspere9beea22014-01-28 15:20:33 +0000271 LLVMStyle.ObjCSpaceAfterProperty = false;
Nico Webera6087752013-01-10 20:12:55 +0000272 LLVMStyle.ObjCSpaceBeforeProtocolList = true;
Alexander Kornienkoc8602662013-05-06 14:11:27 +0000273 LLVMStyle.PointerBindsToType = false;
274 LLVMStyle.SpacesBeforeTrailingComments = 1;
275 LLVMStyle.Standard = FormatStyle::LS_Cpp03;
Alexander Kornienko3c3d09c2013-09-27 16:14:22 +0000276 LLVMStyle.UseTab = FormatStyle::UT_Never;
Daniel Jasperb55acad2013-08-20 12:36:34 +0000277 LLVMStyle.SpacesInParentheses = false;
278 LLVMStyle.SpaceInEmptyParentheses = false;
Daniel Jasperb2e10a52014-01-15 15:09:08 +0000279 LLVMStyle.SpacesInContainerLiterals = true;
Daniel Jasperb55acad2013-08-20 12:36:34 +0000280 LLVMStyle.SpacesInCStyleCastParentheses = false;
Alexander Kornienkofdca83d2013-12-10 10:18:34 +0000281 LLVMStyle.SpaceBeforeParens = FormatStyle::SBPO_ControlStatements;
Daniel Jasperd94bff32013-09-25 15:15:02 +0000282 LLVMStyle.SpaceBeforeAssignmentOperators = true;
Daniel Jasper6633ab82013-10-18 10:38:14 +0000283 LLVMStyle.ContinuationIndentWidth = 4;
Daniel Jasperdd978ae2013-10-29 14:52:02 +0000284 LLVMStyle.SpacesInAngles = false;
Alexander Kornienkoce9161a2014-01-02 15:13:14 +0000285 LLVMStyle.CommentPragmas = "^ IWYU pragma:";
Daniel Jasper4e9678f2013-07-11 20:41:21 +0000286
Daniel Jasper19a541e2013-12-19 16:45:34 +0000287 LLVMStyle.PenaltyBreakComment = 300;
Alexander Kornienkofe7a57f2013-12-10 15:42:15 +0000288 LLVMStyle.PenaltyBreakFirstLessLess = 120;
289 LLVMStyle.PenaltyBreakString = 1000;
290 LLVMStyle.PenaltyExcessCharacter = 1000000;
Daniel Jasper4e9678f2013-07-11 20:41:21 +0000291 LLVMStyle.PenaltyReturnTypeOnItsOwnLine = 60;
Daniel Jasper33b909c2013-10-25 14:29:37 +0000292 LLVMStyle.PenaltyBreakBeforeFirstCallParameter = 19;
Daniel Jasper4e9678f2013-07-11 20:41:21 +0000293
Daniel Jasperf7935112012-12-03 18:12:45 +0000294 return LLVMStyle;
295}
296
Nico Weber514ecc82014-02-02 20:50:45 +0000297FormatStyle getGoogleStyle(FormatStyle::LanguageKind Language) {
Alexander Kornienkofe7a57f2013-12-10 15:42:15 +0000298 FormatStyle GoogleStyle = getLLVMStyle();
Nico Weber514ecc82014-02-02 20:50:45 +0000299 GoogleStyle.Language = Language;
300
Daniel Jasperf7935112012-12-03 18:12:45 +0000301 GoogleStyle.AccessModifierOffset = -1;
Alexander Kornienkoc8602662013-05-06 14:11:27 +0000302 GoogleStyle.AlignEscapedNewlinesLeft = true;
Daniel Jasper085a2ed2013-04-24 13:46:00 +0000303 GoogleStyle.AllowShortIfStatementsOnASingleLine = true;
Daniel Jasper5bd0b9e2013-05-23 18:05:18 +0000304 GoogleStyle.AllowShortLoopsOnASingleLine = true;
Alexander Kornienko58611712013-07-04 12:02:44 +0000305 GoogleStyle.AlwaysBreakBeforeMultilineStrings = true;
Daniel Jaspere33d4af2013-07-26 16:56:36 +0000306 GoogleStyle.AlwaysBreakTemplateDeclarations = true;
Alexander Kornienkoc8602662013-05-06 14:11:27 +0000307 GoogleStyle.ConstructorInitializerAllOnOneLineOrOnePerLine = true;
Daniel Jaspere33d4af2013-07-26 16:56:36 +0000308 GoogleStyle.Cpp11BracedListStyle = true;
Alexander Kornienkoc8602662013-05-06 14:11:27 +0000309 GoogleStyle.DerivePointerBinding = true;
310 GoogleStyle.IndentCaseLabels = true;
Daniel Jaspere33d4af2013-07-26 16:56:36 +0000311 GoogleStyle.IndentFunctionDeclarationAfterType = true;
Daniel Jaspere9beea22014-01-28 15:20:33 +0000312 GoogleStyle.ObjCSpaceAfterProperty = false;
Nico Webera6087752013-01-10 20:12:55 +0000313 GoogleStyle.ObjCSpaceBeforeProtocolList = false;
Alexander Kornienkoc8602662013-05-06 14:11:27 +0000314 GoogleStyle.PointerBindsToType = true;
315 GoogleStyle.SpacesBeforeTrailingComments = 2;
316 GoogleStyle.Standard = FormatStyle::LS_Auto;
Daniel Jasper4e9678f2013-07-11 20:41:21 +0000317
Daniel Jasper4e9678f2013-07-11 20:41:21 +0000318 GoogleStyle.PenaltyReturnTypeOnItsOwnLine = 200;
Daniel Jasper33b909c2013-10-25 14:29:37 +0000319 GoogleStyle.PenaltyBreakBeforeFirstCallParameter = 1;
Daniel Jasper4e9678f2013-07-11 20:41:21 +0000320
Nico Weber514ecc82014-02-02 20:50:45 +0000321 if (Language == FormatStyle::LK_JavaScript) {
322 GoogleStyle.BreakBeforeTernaryOperators = false;
323 GoogleStyle.MaxEmptyLinesToKeep = 2;
324 GoogleStyle.SpacesInContainerLiterals = false;
325 } else if (Language == FormatStyle::LK_Proto) {
326 GoogleStyle.AllowShortFunctionsOnASingleLine = false;
327 }
328
Daniel Jasperf7935112012-12-03 18:12:45 +0000329 return GoogleStyle;
330}
331
Nico Weber514ecc82014-02-02 20:50:45 +0000332FormatStyle getChromiumStyle(FormatStyle::LanguageKind Language) {
333 FormatStyle ChromiumStyle = getGoogleStyle(Language);
Daniel Jasperf7db4332013-01-29 16:03:49 +0000334 ChromiumStyle.AllowAllParametersOfDeclarationOnNextLine = false;
Daniel Jasper085a2ed2013-04-24 13:46:00 +0000335 ChromiumStyle.AllowShortIfStatementsOnASingleLine = false;
Daniel Jasper3a685df2013-05-16 12:12:21 +0000336 ChromiumStyle.AllowShortLoopsOnASingleLine = false;
Daniel Jasper2cf17bf2013-02-27 09:47:53 +0000337 ChromiumStyle.BinPackParameters = false;
Daniel Jasper7fce3ab2013-02-06 14:22:40 +0000338 ChromiumStyle.DerivePointerBinding = false;
Daniel Jaspere33d4af2013-07-26 16:56:36 +0000339 ChromiumStyle.Standard = FormatStyle::LS_Cpp03;
Daniel Jasper1b750ed2013-01-14 16:24:39 +0000340 return ChromiumStyle;
341}
342
Alexander Kornienkoc8602662013-05-06 14:11:27 +0000343FormatStyle getMozillaStyle() {
344 FormatStyle MozillaStyle = getLLVMStyle();
345 MozillaStyle.AllowAllParametersOfDeclarationOnNextLine = false;
346 MozillaStyle.ConstructorInitializerAllOnOneLineOrOnePerLine = true;
347 MozillaStyle.DerivePointerBinding = true;
348 MozillaStyle.IndentCaseLabels = true;
Daniel Jaspere9beea22014-01-28 15:20:33 +0000349 MozillaStyle.ObjCSpaceAfterProperty = true;
Alexander Kornienkoc8602662013-05-06 14:11:27 +0000350 MozillaStyle.ObjCSpaceBeforeProtocolList = false;
351 MozillaStyle.PenaltyReturnTypeOnItsOwnLine = 200;
352 MozillaStyle.PointerBindsToType = true;
353 return MozillaStyle;
354}
355
Daniel Jasperffefb3d2013-07-24 13:10:59 +0000356FormatStyle getWebKitStyle() {
357 FormatStyle Style = getLLVMStyle();
Daniel Jasper65ee3472013-07-31 23:16:02 +0000358 Style.AccessModifierOffset = -4;
Daniel Jasper552f4a72013-07-31 23:55:15 +0000359 Style.AlignTrailingComments = false;
Daniel Jaspere33d4af2013-07-26 16:56:36 +0000360 Style.BreakBeforeBinaryOperators = true;
Daniel Jasper65ee3472013-07-31 23:16:02 +0000361 Style.BreakBeforeBraces = FormatStyle::BS_Stroustrup;
Daniel Jaspere33d4af2013-07-26 16:56:36 +0000362 Style.BreakConstructorInitializersBeforeComma = true;
Daniel Jasper65ee3472013-07-31 23:16:02 +0000363 Style.ColumnLimit = 0;
Daniel Jaspere33d4af2013-07-26 16:56:36 +0000364 Style.IndentWidth = 4;
Daniel Jasper65ee3472013-07-31 23:16:02 +0000365 Style.NamespaceIndentation = FormatStyle::NI_Inner;
Daniel Jaspere9beea22014-01-28 15:20:33 +0000366 Style.ObjCSpaceAfterProperty = true;
Daniel Jasperffefb3d2013-07-24 13:10:59 +0000367 Style.PointerBindsToType = true;
368 return Style;
369}
370
Alexander Kornienkofe7a57f2013-12-10 15:42:15 +0000371FormatStyle getGNUStyle() {
372 FormatStyle Style = getLLVMStyle();
373 Style.BreakBeforeBinaryOperators = true;
Alexander Kornienko3a33f022013-12-12 09:49:52 +0000374 Style.BreakBeforeBraces = FormatStyle::BS_GNU;
Alexander Kornienkofe7a57f2013-12-10 15:42:15 +0000375 Style.BreakBeforeTernaryOperators = true;
376 Style.ColumnLimit = 79;
Alexander Kornienkofe7a57f2013-12-10 15:42:15 +0000377 Style.SpaceBeforeParens = FormatStyle::SBPO_Always;
378 return Style;
379}
380
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000381bool getPredefinedStyle(StringRef Name, FormatStyle::LanguageKind Language,
382 FormatStyle *Style) {
383 if (Name.equals_lower("llvm")) {
Alexander Kornienko006b5c82013-05-19 00:53:30 +0000384 *Style = getLLVMStyle();
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000385 } else if (Name.equals_lower("chromium")) {
Nico Weber514ecc82014-02-02 20:50:45 +0000386 *Style = getChromiumStyle(Language);
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000387 } else if (Name.equals_lower("mozilla")) {
Alexander Kornienko006b5c82013-05-19 00:53:30 +0000388 *Style = getMozillaStyle();
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000389 } else if (Name.equals_lower("google")) {
Nico Weber514ecc82014-02-02 20:50:45 +0000390 *Style = getGoogleStyle(Language);
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000391 } else if (Name.equals_lower("webkit")) {
Daniel Jasperffefb3d2013-07-24 13:10:59 +0000392 *Style = getWebKitStyle();
Alexander Kornienkofe7a57f2013-12-10 15:42:15 +0000393 } else if (Name.equals_lower("gnu")) {
394 *Style = getGNUStyle();
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000395 } else {
Alexander Kornienko006b5c82013-05-19 00:53:30 +0000396 return false;
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000397 }
Alexander Kornienkod6538332013-05-07 15:32:14 +0000398
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000399 Style->Language = Language;
Alexander Kornienko006b5c82013-05-19 00:53:30 +0000400 return true;
Alexander Kornienkod6538332013-05-07 15:32:14 +0000401}
402
403llvm::error_code parseConfiguration(StringRef Text, FormatStyle *Style) {
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000404 assert(Style);
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000405 FormatStyle::LanguageKind Language = Style->Language;
406 assert(Language != FormatStyle::LK_None);
Alexander Kornienko06e00332013-05-20 15:18:01 +0000407 if (Text.trim().empty())
408 return llvm::make_error_code(llvm::errc::invalid_argument);
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000409
410 std::vector<FormatStyle> Styles;
Alexander Kornienkod6538332013-05-07 15:32:14 +0000411 llvm::yaml::Input Input(Text);
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000412 // DocumentListTraits<vector<FormatStyle>> uses the context to get default
413 // values for the fields, keys for which are missing from the configuration.
414 // Mapping also uses the context to get the language to find the correct
415 // base style.
416 Input.setContext(Style);
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000417 Input >> Styles;
418 if (Input.error())
419 return Input.error();
420
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000421 for (unsigned i = 0; i < Styles.size(); ++i) {
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000422 // Ensures that only the first configuration can skip the Language option.
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000423 if (Styles[i].Language == FormatStyle::LK_None && i != 0)
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000424 return llvm::make_error_code(llvm::errc::invalid_argument);
425 // Ensure that each language is configured at most once.
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000426 for (unsigned j = 0; j < i; ++j) {
427 if (Styles[i].Language == Styles[j].Language) {
428 DEBUG(llvm::dbgs()
429 << "Duplicate languages in the config file on positions " << j
430 << " and " << i << "\n");
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000431 return llvm::make_error_code(llvm::errc::invalid_argument);
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000432 }
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000433 }
434 }
435 // Look for a suitable configuration starting from the end, so we can
436 // find the configuration for the specific language first, and the default
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000437 // configuration (which can only be at slot 0) after it.
438 for (int i = Styles.size() - 1; i >= 0; --i) {
439 if (Styles[i].Language == Language ||
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000440 Styles[i].Language == FormatStyle::LK_None) {
441 *Style = Styles[i];
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000442 Style->Language = Language;
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000443 return llvm::make_error_code(llvm::errc::success);
444 }
445 }
446 return llvm::make_error_code(llvm::errc::not_supported);
Alexander Kornienkod6538332013-05-07 15:32:14 +0000447}
448
449std::string configurationAsText(const FormatStyle &Style) {
450 std::string Text;
451 llvm::raw_string_ostream Stream(Text);
452 llvm::yaml::Output Output(Stream);
453 // We use the same mapping method for input and output, so we need a non-const
454 // reference here.
455 FormatStyle NonConstStyle = Style;
456 Output << NonConstStyle;
Alexander Kornienko9a38ec22013-05-13 12:56:35 +0000457 return Stream.str();
Alexander Kornienkod6538332013-05-07 15:32:14 +0000458}
459
Craig Topperaf35e852013-06-30 22:29:28 +0000460namespace {
461
Daniel Jasperde0328a2013-08-16 11:20:30 +0000462class NoColumnLimitFormatter {
463public:
Daniel Jasperf110e202013-08-21 08:39:01 +0000464 NoColumnLimitFormatter(ContinuationIndenter *Indenter) : Indenter(Indenter) {}
Daniel Jasperde0328a2013-08-16 11:20:30 +0000465
466 /// \brief Formats the line starting at \p State, simply keeping all of the
467 /// input's line breaking decisions.
Alexander Kornienkoa594ba82013-12-16 14:35:51 +0000468 void format(unsigned FirstIndent, const AnnotatedLine *Line) {
Daniel Jasper1c5d9df2013-09-06 07:54:20 +0000469 LineState State =
470 Indenter->getInitialState(FirstIndent, Line, /*DryRun=*/false);
Daniel Jasperde0328a2013-08-16 11:20:30 +0000471 while (State.NextToken != NULL) {
472 bool Newline =
Alexander Kornienkoa594ba82013-12-16 14:35:51 +0000473 Indenter->mustBreak(State) ||
Daniel Jasperde0328a2013-08-16 11:20:30 +0000474 (Indenter->canBreak(State) && State.NextToken->NewlinesBefore > 0);
475 Indenter->addTokenToState(State, Newline, /*DryRun=*/false);
476 }
477 }
Daniel Jasperf110e202013-08-21 08:39:01 +0000478
Daniel Jasperde0328a2013-08-16 11:20:30 +0000479private:
480 ContinuationIndenter *Indenter;
481};
482
Daniel Jasper56f8b432013-11-06 23:12:09 +0000483class LineJoiner {
484public:
485 LineJoiner(const FormatStyle &Style) : Style(Style) {}
486
487 /// \brief Calculates how many lines can be merged into 1 starting at \p I.
488 unsigned
489 tryFitMultipleLinesInOne(unsigned Indent,
Alexander Kornienko3cfa9732013-11-20 16:33:05 +0000490 SmallVectorImpl<AnnotatedLine *>::const_iterator I,
Daniel Jasper56f8b432013-11-06 23:12:09 +0000491 SmallVectorImpl<AnnotatedLine *>::const_iterator E) {
492 // We can never merge stuff if there are trailing line comments.
Daniel Jasper234379f2013-12-24 13:31:25 +0000493 const AnnotatedLine *TheLine = *I;
Daniel Jasper56f8b432013-11-06 23:12:09 +0000494 if (TheLine->Last->Type == TT_LineComment)
495 return 0;
496
Alexander Kornienkoecc232d2013-12-04 13:25:26 +0000497 if (Style.ColumnLimit > 0 && Indent > Style.ColumnLimit)
498 return 0;
499
Daniel Jasper98fb6e12013-11-08 17:33:27 +0000500 unsigned Limit =
501 Style.ColumnLimit == 0 ? UINT_MAX : Style.ColumnLimit - Indent;
Daniel Jasper56f8b432013-11-06 23:12:09 +0000502 // If we already exceed the column limit, we set 'Limit' to 0. The different
503 // tryMerge..() functions can then decide whether to still do merging.
504 Limit = TheLine->Last->TotalLength > Limit
505 ? 0
506 : Limit - TheLine->Last->TotalLength;
507
Alexander Kornienkoc3021612013-11-19 14:30:44 +0000508 if (I + 1 == E || I[1]->Type == LT_Invalid)
Daniel Jasper56f8b432013-11-06 23:12:09 +0000509 return 0;
510
Daniel Jasper234379f2013-12-24 13:31:25 +0000511 if (TheLine->Last->Type == TT_FunctionLBrace &&
512 TheLine->First != TheLine->Last) {
Alexander Kornienko3cfa9732013-11-20 16:33:05 +0000513 return Style.AllowShortFunctionsOnASingleLine
514 ? tryMergeSimpleBlock(I, E, Limit)
515 : 0;
516 }
Daniel Jasper56f8b432013-11-06 23:12:09 +0000517 if (TheLine->Last->is(tok::l_brace)) {
Alexander Kornienko6d2c88e2013-12-10 10:30:34 +0000518 return Style.BreakBeforeBraces == FormatStyle::BS_Attach
Alexander Kornienko3cfa9732013-11-20 16:33:05 +0000519 ? tryMergeSimpleBlock(I, E, Limit)
520 : 0;
521 }
522 if (I[1]->First->Type == TT_FunctionLBrace &&
523 Style.BreakBeforeBraces != FormatStyle::BS_Attach) {
Alp Tokerba5b4dc2013-12-30 02:06:29 +0000524 // Check for Limit <= 2 to account for the " {".
Daniel Jasper234379f2013-12-24 13:31:25 +0000525 if (Limit <= 2 || (Style.ColumnLimit == 0 && containsMustBreak(TheLine)))
526 return 0;
527 Limit -= 2;
528
Alexander Kornienko3cfa9732013-11-20 16:33:05 +0000529 unsigned MergedLines = 0;
530 if (Style.AllowShortFunctionsOnASingleLine) {
531 MergedLines = tryMergeSimpleBlock(I + 1, E, Limit);
532 // If we managed to merge the block, count the function header, which is
533 // on a separate line.
534 if (MergedLines > 0)
535 ++MergedLines;
536 }
537 return MergedLines;
538 }
539 if (TheLine->First->is(tok::kw_if)) {
540 return Style.AllowShortIfStatementsOnASingleLine
541 ? tryMergeSimpleControlStatement(I, E, Limit)
542 : 0;
543 }
544 if (TheLine->First->isOneOf(tok::kw_for, tok::kw_while)) {
545 return Style.AllowShortLoopsOnASingleLine
546 ? tryMergeSimpleControlStatement(I, E, Limit)
547 : 0;
548 }
549 if (TheLine->InPPDirective &&
550 (TheLine->First->HasUnescapedNewline || TheLine->First->IsFirst)) {
Daniel Jasper56f8b432013-11-06 23:12:09 +0000551 return tryMergeSimplePPDirective(I, E, Limit);
552 }
553 return 0;
554 }
555
556private:
557 unsigned
Alexander Kornienko3cfa9732013-11-20 16:33:05 +0000558 tryMergeSimplePPDirective(SmallVectorImpl<AnnotatedLine *>::const_iterator I,
Daniel Jasper56f8b432013-11-06 23:12:09 +0000559 SmallVectorImpl<AnnotatedLine *>::const_iterator E,
560 unsigned Limit) {
561 if (Limit == 0)
562 return 0;
Alexander Kornienkoc3021612013-11-19 14:30:44 +0000563 if (!I[1]->InPPDirective || I[1]->First->HasUnescapedNewline)
Daniel Jasper56f8b432013-11-06 23:12:09 +0000564 return 0;
Alexander Kornienkoc3021612013-11-19 14:30:44 +0000565 if (I + 2 != E && I[2]->InPPDirective && !I[2]->First->HasUnescapedNewline)
Daniel Jasper56f8b432013-11-06 23:12:09 +0000566 return 0;
Alexander Kornienkoc3021612013-11-19 14:30:44 +0000567 if (1 + I[1]->Last->TotalLength > Limit)
Daniel Jasper56f8b432013-11-06 23:12:09 +0000568 return 0;
569 return 1;
570 }
571
572 unsigned tryMergeSimpleControlStatement(
Alexander Kornienko3cfa9732013-11-20 16:33:05 +0000573 SmallVectorImpl<AnnotatedLine *>::const_iterator I,
Daniel Jasper56f8b432013-11-06 23:12:09 +0000574 SmallVectorImpl<AnnotatedLine *>::const_iterator E, unsigned Limit) {
575 if (Limit == 0)
576 return 0;
Alexander Kornienko3a33f022013-12-12 09:49:52 +0000577 if ((Style.BreakBeforeBraces == FormatStyle::BS_Allman ||
578 Style.BreakBeforeBraces == FormatStyle::BS_GNU) &&
Alexander Kornienkoc3021612013-11-19 14:30:44 +0000579 I[1]->First->is(tok::l_brace))
Daniel Jasper56f8b432013-11-06 23:12:09 +0000580 return 0;
Alexander Kornienkoc3021612013-11-19 14:30:44 +0000581 if (I[1]->InPPDirective != (*I)->InPPDirective ||
582 (I[1]->InPPDirective && I[1]->First->HasUnescapedNewline))
Daniel Jasper56f8b432013-11-06 23:12:09 +0000583 return 0;
584 AnnotatedLine &Line = **I;
585 if (Line.Last->isNot(tok::r_paren))
586 return 0;
Alexander Kornienkoc3021612013-11-19 14:30:44 +0000587 if (1 + I[1]->Last->TotalLength > Limit)
Daniel Jasper56f8b432013-11-06 23:12:09 +0000588 return 0;
Alexander Kornienkoc3021612013-11-19 14:30:44 +0000589 if (I[1]->First->isOneOf(tok::semi, tok::kw_if, tok::kw_for,
Alexander Kornienko3cfa9732013-11-20 16:33:05 +0000590 tok::kw_while) ||
Alexander Kornienkoc3021612013-11-19 14:30:44 +0000591 I[1]->First->Type == TT_LineComment)
Daniel Jasper56f8b432013-11-06 23:12:09 +0000592 return 0;
593 // Only inline simple if's (no nested if or else).
594 if (I + 2 != E && Line.First->is(tok::kw_if) &&
Alexander Kornienkoc3021612013-11-19 14:30:44 +0000595 I[2]->First->is(tok::kw_else))
Daniel Jasper56f8b432013-11-06 23:12:09 +0000596 return 0;
597 return 1;
598 }
599
600 unsigned
Alexander Kornienko3cfa9732013-11-20 16:33:05 +0000601 tryMergeSimpleBlock(SmallVectorImpl<AnnotatedLine *>::const_iterator I,
Daniel Jasper56f8b432013-11-06 23:12:09 +0000602 SmallVectorImpl<AnnotatedLine *>::const_iterator E,
603 unsigned Limit) {
Daniel Jasper56f8b432013-11-06 23:12:09 +0000604 // First, check that the current line allows merging. This is the case if
605 // we're not in a control flow statement and the last token is an opening
606 // brace.
607 AnnotatedLine &Line = **I;
608 if (Line.First->isOneOf(tok::kw_if, tok::kw_while, tok::kw_do, tok::r_brace,
609 tok::kw_else, tok::kw_try, tok::kw_catch,
610 tok::kw_for,
611 // This gets rid of all ObjC @ keywords and methods.
612 tok::at, tok::minus, tok::plus))
613 return 0;
614
Alexander Kornienkoc3021612013-11-19 14:30:44 +0000615 FormatToken *Tok = I[1]->First;
Daniel Jasper56f8b432013-11-06 23:12:09 +0000616 if (Tok->is(tok::r_brace) && !Tok->MustBreakBefore &&
617 (Tok->getNextNonComment() == NULL ||
618 Tok->getNextNonComment()->is(tok::semi))) {
619 // We merge empty blocks even if the line exceeds the column limit.
620 Tok->SpacesRequiredBefore = 0;
621 Tok->CanBreakBefore = true;
622 return 1;
623 } else if (Limit != 0 && Line.First->isNot(tok::kw_namespace)) {
624 // Check that we still have three lines and they fit into the limit.
Alexander Kornienkoc3021612013-11-19 14:30:44 +0000625 if (I + 2 == E || I[2]->Type == LT_Invalid)
Daniel Jasper56f8b432013-11-06 23:12:09 +0000626 return 0;
627
628 if (!nextTwoLinesFitInto(I, Limit))
629 return 0;
630
631 // Second, check that the next line does not contain any braces - if it
632 // does, readability declines when putting it into a single line.
Alexander Kornienkoc3021612013-11-19 14:30:44 +0000633 if (I[1]->Last->Type == TT_LineComment || Tok->MustBreakBefore)
Daniel Jasper56f8b432013-11-06 23:12:09 +0000634 return 0;
635 do {
636 if (Tok->isOneOf(tok::l_brace, tok::r_brace))
637 return 0;
638 Tok = Tok->Next;
639 } while (Tok != NULL);
640
641 // Last, check that the third line contains a single closing brace.
Alexander Kornienkoc3021612013-11-19 14:30:44 +0000642 Tok = I[2]->First;
Daniel Jasper56f8b432013-11-06 23:12:09 +0000643 if (Tok->getNextNonComment() != NULL || Tok->isNot(tok::r_brace) ||
644 Tok->MustBreakBefore)
645 return 0;
646
647 return 2;
648 }
649 return 0;
650 }
651
652 bool nextTwoLinesFitInto(SmallVectorImpl<AnnotatedLine *>::const_iterator I,
653 unsigned Limit) {
Alexander Kornienkoc3021612013-11-19 14:30:44 +0000654 return 1 + I[1]->Last->TotalLength + 1 + I[2]->Last->TotalLength <= Limit;
Daniel Jasper56f8b432013-11-06 23:12:09 +0000655 }
656
Daniel Jasper234379f2013-12-24 13:31:25 +0000657 bool containsMustBreak(const AnnotatedLine *Line) {
658 for (const FormatToken *Tok = Line->First; Tok; Tok = Tok->Next) {
659 if (Tok->MustBreakBefore)
660 return true;
661 }
662 return false;
663 }
664
Daniel Jasper56f8b432013-11-06 23:12:09 +0000665 const FormatStyle &Style;
666};
667
Daniel Jasperf7935112012-12-03 18:12:45 +0000668class UnwrappedLineFormatter {
669public:
Daniel Jasper5500f612013-11-25 11:08:59 +0000670 UnwrappedLineFormatter(ContinuationIndenter *Indenter,
Daniel Jasper9fe0e8d2013-09-05 09:29:45 +0000671 WhitespaceManager *Whitespaces,
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +0000672 const FormatStyle &Style)
Daniel Jasper5500f612013-11-25 11:08:59 +0000673 : Indenter(Indenter), Whitespaces(Whitespaces), Style(Style),
674 Joiner(Style) {}
Daniel Jasperf7935112012-12-03 18:12:45 +0000675
Daniel Jasper56f8b432013-11-06 23:12:09 +0000676 unsigned format(const SmallVectorImpl<AnnotatedLine *> &Lines, bool DryRun,
Daniel Jasper9c199562013-11-28 15:58:55 +0000677 int AdditionalIndent = 0, bool FixBadIndentation = false) {
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +0000678 assert(!Lines.empty());
679 unsigned Penalty = 0;
680 std::vector<int> IndentForLevel;
681 for (unsigned i = 0, e = Lines[0]->Level; i != e; ++i)
682 IndentForLevel.push_back(Style.IndentWidth * i + AdditionalIndent);
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +0000683 const AnnotatedLine *PreviousLine = NULL;
Daniel Jasper56f8b432013-11-06 23:12:09 +0000684 for (SmallVectorImpl<AnnotatedLine *>::const_iterator I = Lines.begin(),
685 E = Lines.end();
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +0000686 I != E; ++I) {
687 const AnnotatedLine &TheLine = **I;
688 const FormatToken *FirstTok = TheLine.First;
689 int Offset = getIndentOffset(*FirstTok);
690
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +0000691 // Determine indent and try to merge multiple unwrapped lines.
Daniel Jasperbad63ae2013-12-17 12:38:55 +0000692 unsigned Indent;
693 if (TheLine.InPPDirective) {
694 Indent = TheLine.Level * Style.IndentWidth;
695 } else {
696 while (IndentForLevel.size() <= TheLine.Level)
697 IndentForLevel.push_back(-1);
698 IndentForLevel.resize(TheLine.Level + 1);
699 Indent = getIndent(IndentForLevel, TheLine.Level);
700 }
701 unsigned LevelIndent = Indent;
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +0000702 if (static_cast<int>(Indent) + Offset >= 0)
703 Indent += Offset;
Daniel Jasperbad63ae2013-12-17 12:38:55 +0000704
705 // Merge multiple lines if possible.
Daniel Jasper56f8b432013-11-06 23:12:09 +0000706 unsigned MergedLines = Joiner.tryFitMultipleLinesInOne(Indent, I, E);
Alexander Kornienko31e95542013-12-04 12:21:08 +0000707 if (MergedLines > 0 && Style.ColumnLimit == 0) {
708 // Disallow line merging if there is a break at the start of one of the
709 // input lines.
710 for (unsigned i = 0; i < MergedLines; ++i) {
711 if (I[i + 1]->First->NewlinesBefore > 0)
712 MergedLines = 0;
713 }
714 }
Daniel Jasper56f8b432013-11-06 23:12:09 +0000715 if (!DryRun) {
716 for (unsigned i = 0; i < MergedLines; ++i) {
Alexander Kornienkoc3021612013-11-19 14:30:44 +0000717 join(*I[i], *I[i + 1]);
Daniel Jasper56f8b432013-11-06 23:12:09 +0000718 }
719 }
720 I += MergedLines;
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +0000721
Daniel Jasper9c199562013-11-28 15:58:55 +0000722 bool FixIndentation =
723 FixBadIndentation && (LevelIndent != FirstTok->OriginalColumn);
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +0000724 if (TheLine.First->is(tok::eof)) {
Daniel Jasper5500f612013-11-25 11:08:59 +0000725 if (PreviousLine && PreviousLine->Affected && !DryRun) {
726 // Remove the file's trailing whitespace.
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +0000727 unsigned Newlines = std::min(FirstTok->NewlinesBefore, 1u);
728 Whitespaces->replaceWhitespace(*TheLine.First, Newlines,
729 /*IndentLevel=*/0, /*Spaces=*/0,
730 /*TargetColumn=*/0);
731 }
Daniel Jasper9c199562013-11-28 15:58:55 +0000732 } else if (TheLine.Type != LT_Invalid &&
733 (TheLine.Affected || FixIndentation)) {
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +0000734 if (FirstTok->WhitespaceRange.isValid()) {
735 if (!DryRun)
736 formatFirstToken(*TheLine.First, PreviousLine, TheLine.Level,
737 Indent, TheLine.InPPDirective);
738 } else {
739 Indent = LevelIndent = FirstTok->OriginalColumn;
740 }
741
742 // If everything fits on a single line, just put it there.
743 unsigned ColumnLimit = Style.ColumnLimit;
744 if (I + 1 != E) {
Alexander Kornienkoc3021612013-11-19 14:30:44 +0000745 AnnotatedLine *NextLine = I[1];
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +0000746 if (NextLine->InPPDirective && !NextLine->First->HasUnescapedNewline)
747 ColumnLimit = getColumnLimit(TheLine.InPPDirective);
748 }
749
750 if (TheLine.Last->TotalLength + Indent <= ColumnLimit) {
751 LineState State = Indenter->getInitialState(Indent, &TheLine, DryRun);
752 while (State.NextToken != NULL)
753 Indenter->addTokenToState(State, /*Newline=*/false, DryRun);
754 } else if (Style.ColumnLimit == 0) {
Daniel Jasper9c199562013-11-28 15:58:55 +0000755 // FIXME: Implement nested blocks for ColumnLimit = 0.
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +0000756 NoColumnLimitFormatter Formatter(Indenter);
757 if (!DryRun)
Alexander Kornienkoa594ba82013-12-16 14:35:51 +0000758 Formatter.format(Indent, &TheLine);
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +0000759 } else {
760 Penalty += format(TheLine, Indent, DryRun);
761 }
762
Daniel Jasperbad63ae2013-12-17 12:38:55 +0000763 if (!TheLine.InPPDirective)
764 IndentForLevel[TheLine.Level] = LevelIndent;
Daniel Jasper9c199562013-11-28 15:58:55 +0000765 } else if (TheLine.ChildrenAffected) {
766 format(TheLine.Children, DryRun);
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +0000767 } else {
768 // Format the first token if necessary, and notify the WhitespaceManager
769 // about the unchanged whitespace.
770 for (FormatToken *Tok = TheLine.First; Tok != NULL; Tok = Tok->Next) {
771 if (Tok == TheLine.First &&
772 (Tok->NewlinesBefore > 0 || Tok->IsFirst)) {
773 unsigned LevelIndent = Tok->OriginalColumn;
774 if (!DryRun) {
Daniel Jasper9c199562013-11-28 15:58:55 +0000775 // Remove trailing whitespace of the previous line.
Daniel Jasper5500f612013-11-25 11:08:59 +0000776 if ((PreviousLine && PreviousLine->Affected) ||
777 TheLine.LeadingEmptyLinesAffected) {
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +0000778 formatFirstToken(*Tok, PreviousLine, TheLine.Level, LevelIndent,
779 TheLine.InPPDirective);
780 } else {
781 Whitespaces->addUntouchableToken(*Tok, TheLine.InPPDirective);
782 }
783 }
784
785 if (static_cast<int>(LevelIndent) - Offset >= 0)
786 LevelIndent -= Offset;
Daniel Jasperbad63ae2013-12-17 12:38:55 +0000787 if (Tok->isNot(tok::comment) && !TheLine.InPPDirective)
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +0000788 IndentForLevel[TheLine.Level] = LevelIndent;
789 } else if (!DryRun) {
790 Whitespaces->addUntouchableToken(*Tok, TheLine.InPPDirective);
791 }
792 }
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +0000793 }
794 if (!DryRun) {
795 for (FormatToken *Tok = TheLine.First; Tok != NULL; Tok = Tok->Next) {
796 Tok->Finalized = true;
797 }
798 }
799 PreviousLine = *I;
800 }
801 return Penalty;
802 }
803
804private:
805 /// \brief Formats an \c AnnotatedLine and returns the penalty.
Daniel Jasper9fe0e8d2013-09-05 09:29:45 +0000806 ///
807 /// If \p DryRun is \c false, directly applies the changes.
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +0000808 unsigned format(const AnnotatedLine &Line, unsigned FirstIndent,
809 bool DryRun) {
Daniel Jasper1c5d9df2013-09-06 07:54:20 +0000810 LineState State = Indenter->getInitialState(FirstIndent, &Line, DryRun);
Daniel Jasper4b866272013-02-01 11:00:45 +0000811
Daniel Jasperacc33662013-02-08 08:22:00 +0000812 // If the ObjC method declaration does not fit on a line, we should format
813 // it with one arg per line.
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +0000814 if (State.Line->Type == LT_ObjCMethodDecl)
Daniel Jasperacc33662013-02-08 08:22:00 +0000815 State.Stack.back().BreakBeforeParameter = true;
816
Daniel Jasper4b866272013-02-01 11:00:45 +0000817 // Find best solution in solution space.
Daniel Jasper9fe0e8d2013-09-05 09:29:45 +0000818 return analyzeSolutionSpace(State, DryRun);
Daniel Jasperf7935112012-12-03 18:12:45 +0000819 }
820
Manuel Klimek2ef908e2013-02-13 10:46:36 +0000821 /// \brief An edge in the solution space from \c Previous->State to \c State,
822 /// inserting a newline dependent on the \c NewLine.
823 struct StateNode {
824 StateNode(const LineState &State, bool NewLine, StateNode *Previous)
Daniel Jasper12ef4e52013-02-21 21:33:55 +0000825 : State(State), NewLine(NewLine), Previous(Previous) {}
Manuel Klimek2ef908e2013-02-13 10:46:36 +0000826 LineState State;
827 bool NewLine;
828 StateNode *Previous;
829 };
Daniel Jasper4b866272013-02-01 11:00:45 +0000830
Manuel Klimek2ef908e2013-02-13 10:46:36 +0000831 /// \brief A pair of <penalty, count> that is used to prioritize the BFS on.
832 ///
833 /// In case of equal penalties, we want to prefer states that were inserted
834 /// first. During state generation we make sure that we insert states first
835 /// that break the line as late as possible.
836 typedef std::pair<unsigned, unsigned> OrderedPenalty;
837
838 /// \brief An item in the prioritized BFS search queue. The \c StateNode's
839 /// \c State has the given \c OrderedPenalty.
840 typedef std::pair<OrderedPenalty, StateNode *> QueueItem;
841
842 /// \brief The BFS queue type.
843 typedef std::priority_queue<QueueItem, std::vector<QueueItem>,
844 std::greater<QueueItem> > QueueType;
Daniel Jasper4b866272013-02-01 11:00:45 +0000845
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +0000846 /// \brief Get the offset of the line relatively to the level.
847 ///
848 /// For example, 'public:' labels in classes are offset by 1 or 2
849 /// characters to the left from their level.
850 int getIndentOffset(const FormatToken &RootToken) {
851 if (RootToken.isAccessSpecifier(false) || RootToken.isObjCAccessSpecifier())
852 return Style.AccessModifierOffset;
853 return 0;
854 }
855
856 /// \brief Add a new line and the required indent before the first Token
857 /// of the \c UnwrappedLine if there was no structural parsing error.
858 void formatFirstToken(FormatToken &RootToken,
859 const AnnotatedLine *PreviousLine, unsigned IndentLevel,
860 unsigned Indent, bool InPPDirective) {
861 unsigned Newlines =
862 std::min(RootToken.NewlinesBefore, Style.MaxEmptyLinesToKeep + 1);
863 // Remove empty lines before "}" where applicable.
864 if (RootToken.is(tok::r_brace) &&
865 (!RootToken.Next ||
866 (RootToken.Next->is(tok::semi) && !RootToken.Next->Next)))
867 Newlines = std::min(Newlines, 1u);
868 if (Newlines == 0 && !RootToken.IsFirst)
869 Newlines = 1;
870
871 // Insert extra new line before access specifiers.
872 if (PreviousLine && PreviousLine->Last->isOneOf(tok::semi, tok::r_brace) &&
873 RootToken.isAccessSpecifier() && RootToken.NewlinesBefore == 1)
874 ++Newlines;
875
876 // Remove empty lines after access specifiers.
877 if (PreviousLine && PreviousLine->First->isAccessSpecifier())
878 Newlines = std::min(1u, Newlines);
879
Alexander Kornienko3cfa9732013-11-20 16:33:05 +0000880 Whitespaces->replaceWhitespace(RootToken, Newlines, IndentLevel, Indent,
881 Indent, InPPDirective &&
882 !RootToken.HasUnescapedNewline);
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +0000883 }
884
885 /// \brief Get the indent of \p Level from \p IndentForLevel.
886 ///
887 /// \p IndentForLevel must contain the indent for the level \c l
888 /// at \p IndentForLevel[l], or a value < 0 if the indent for
889 /// that level is unknown.
890 unsigned getIndent(const std::vector<int> IndentForLevel, unsigned Level) {
891 if (IndentForLevel[Level] != -1)
892 return IndentForLevel[Level];
893 if (Level == 0)
894 return 0;
895 return getIndent(IndentForLevel, Level - 1) + Style.IndentWidth;
896 }
897
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +0000898 void join(AnnotatedLine &A, const AnnotatedLine &B) {
899 assert(!A.Last->Next);
900 assert(!B.First->Previous);
Daniel Jasper5500f612013-11-25 11:08:59 +0000901 if (B.Affected)
902 A.Affected = true;
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +0000903 A.Last->Next = B.First;
904 B.First->Previous = A.Last;
Daniel Jasper98fb6e12013-11-08 17:33:27 +0000905 B.First->CanBreakBefore = true;
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +0000906 unsigned LengthA = A.Last->TotalLength + B.First->SpacesRequiredBefore;
907 for (FormatToken *Tok = B.First; Tok; Tok = Tok->Next) {
908 Tok->TotalLength += LengthA;
909 A.Last = Tok;
910 }
911 }
912
913 unsigned getColumnLimit(bool InPPDirective) const {
914 // In preprocessor directives reserve two chars for trailing " \"
915 return Style.ColumnLimit - (InPPDirective ? 2 : 0);
916 }
917
Daniel Jasper4b866272013-02-01 11:00:45 +0000918 /// \brief Analyze the entire solution space starting from \p InitialState.
Daniel Jasperf7935112012-12-03 18:12:45 +0000919 ///
Daniel Jasper4b866272013-02-01 11:00:45 +0000920 /// This implements a variant of Dijkstra's algorithm on the graph that spans
921 /// the solution space (\c LineStates are the nodes). The algorithm tries to
922 /// find the shortest path (the one with lowest penalty) from \p InitialState
Daniel Jasper9fe0e8d2013-09-05 09:29:45 +0000923 /// to a state where all tokens are placed. Returns the penalty.
924 ///
925 /// If \p DryRun is \c false, directly applies the changes.
926 unsigned analyzeSolutionSpace(LineState &InitialState, bool DryRun = false) {
Manuel Klimek2ef908e2013-02-13 10:46:36 +0000927 std::set<LineState> Seen;
928
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +0000929 // Increasing count of \c StateNode items we have created. This is used to
930 // create a deterministic order independent of the container.
931 unsigned Count = 0;
932 QueueType Queue;
933
Daniel Jasper4b866272013-02-01 11:00:45 +0000934 // Insert start element into queue.
Daniel Jasper687af3b2013-02-14 14:26:07 +0000935 StateNode *Node =
Manuel Klimek2ef908e2013-02-13 10:46:36 +0000936 new (Allocator.Allocate()) StateNode(InitialState, false, NULL);
937 Queue.push(QueueItem(OrderedPenalty(0, Count), Node));
938 ++Count;
Daniel Jasper4b866272013-02-01 11:00:45 +0000939
Daniel Jasper9fe0e8d2013-09-05 09:29:45 +0000940 unsigned Penalty = 0;
941
Daniel Jasper4b866272013-02-01 11:00:45 +0000942 // While not empty, take first element and follow edges.
943 while (!Queue.empty()) {
Daniel Jasper9fe0e8d2013-09-05 09:29:45 +0000944 Penalty = Queue.top().first.first;
Daniel Jasper687af3b2013-02-14 14:26:07 +0000945 StateNode *Node = Queue.top().second;
Manuel Klimek2ef908e2013-02-13 10:46:36 +0000946 if (Node->State.NextToken == NULL) {
Alexander Kornienko49149672013-05-10 11:56:10 +0000947 DEBUG(llvm::dbgs() << "\n---\nPenalty for line: " << Penalty << "\n");
Daniel Jasper4b866272013-02-01 11:00:45 +0000948 break;
Daniel Jasper3a9370c2013-02-04 07:21:18 +0000949 }
Manuel Klimek2ef908e2013-02-13 10:46:36 +0000950 Queue.pop();
Daniel Jasper4b866272013-02-01 11:00:45 +0000951
Daniel Jasperf8114cf2013-05-22 05:27:42 +0000952 // Cut off the analysis of certain solutions if the analysis gets too
953 // complex. See description of IgnoreStackForComparison.
954 if (Count > 10000)
955 Node->State.IgnoreStackForComparison = true;
956
Manuel Klimek2ef908e2013-02-13 10:46:36 +0000957 if (!Seen.insert(Node->State).second)
958 // State already examined with lower penalty.
959 continue;
Daniel Jasper4b866272013-02-01 11:00:45 +0000960
Manuel Klimek71814b42013-10-11 21:25:45 +0000961 FormatDecision LastFormat = Node->State.NextToken->Decision;
962 if (LastFormat == FD_Unformatted || LastFormat == FD_Continue)
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +0000963 addNextStateToQueue(Penalty, Node, /*NewLine=*/false, &Count, &Queue);
Manuel Klimek71814b42013-10-11 21:25:45 +0000964 if (LastFormat == FD_Unformatted || LastFormat == FD_Break)
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +0000965 addNextStateToQueue(Penalty, Node, /*NewLine=*/true, &Count, &Queue);
Daniel Jasper4b866272013-02-01 11:00:45 +0000966 }
967
Manuel Klimek71814b42013-10-11 21:25:45 +0000968 if (Queue.empty()) {
Daniel Jasper4b866272013-02-01 11:00:45 +0000969 // We were unable to find a solution, do nothing.
970 // FIXME: Add diagnostic?
Manuel Klimek71814b42013-10-11 21:25:45 +0000971 DEBUG(llvm::dbgs() << "Could not find a solution.\n");
Daniel Jasper9fe0e8d2013-09-05 09:29:45 +0000972 return 0;
Manuel Klimek71814b42013-10-11 21:25:45 +0000973 }
Daniel Jasperf7935112012-12-03 18:12:45 +0000974
Daniel Jasper4b866272013-02-01 11:00:45 +0000975 // Reconstruct the solution.
Daniel Jasper9fe0e8d2013-09-05 09:29:45 +0000976 if (!DryRun)
977 reconstructPath(InitialState, Queue.top().second);
978
Alexander Kornienko49149672013-05-10 11:56:10 +0000979 DEBUG(llvm::dbgs() << "Total number of analyzed states: " << Count << "\n");
980 DEBUG(llvm::dbgs() << "---\n");
Daniel Jasper9fe0e8d2013-09-05 09:29:45 +0000981
982 return Penalty;
Manuel Klimek2ef908e2013-02-13 10:46:36 +0000983 }
984
985 void reconstructPath(LineState &State, StateNode *Current) {
Manuel Klimek4c5c28b2013-05-29 15:10:11 +0000986 std::deque<StateNode *> Path;
987 // We do not need a break before the initial token.
988 while (Current->Previous) {
989 Path.push_front(Current);
990 Current = Current->Previous;
991 }
992 for (std::deque<StateNode *>::iterator I = Path.begin(), E = Path.end();
993 I != E; ++I) {
Daniel Jasper9fe0e8d2013-09-05 09:29:45 +0000994 unsigned Penalty = 0;
995 formatChildren(State, (*I)->NewLine, /*DryRun=*/false, Penalty);
996 Penalty += Indenter->addTokenToState(State, (*I)->NewLine, false);
997
Manuel Klimek4c5c28b2013-05-29 15:10:11 +0000998 DEBUG({
999 if ((*I)->NewLine) {
Daniel Jasper8de9ed02013-08-22 15:00:41 +00001000 llvm::dbgs() << "Penalty for placing "
Manuel Klimek4c5c28b2013-05-29 15:10:11 +00001001 << (*I)->Previous->State.NextToken->Tok.getName() << ": "
Daniel Jasper8de9ed02013-08-22 15:00:41 +00001002 << Penalty << "\n";
Manuel Klimek4c5c28b2013-05-29 15:10:11 +00001003 }
1004 });
Manuel Klimek4c5c28b2013-05-29 15:10:11 +00001005 }
Daniel Jasper4b866272013-02-01 11:00:45 +00001006 }
1007
Manuel Klimekaf491072013-02-13 10:54:19 +00001008 /// \brief Add the following state to the analysis queue \c Queue.
Daniel Jasper4b866272013-02-01 11:00:45 +00001009 ///
Manuel Klimekaf491072013-02-13 10:54:19 +00001010 /// Assume the current state is \p PreviousNode and has been reached with a
Daniel Jasper4b866272013-02-01 11:00:45 +00001011 /// penalty of \p Penalty. Insert a line break if \p NewLine is \c true.
Manuel Klimekaf491072013-02-13 10:54:19 +00001012 void addNextStateToQueue(unsigned Penalty, StateNode *PreviousNode,
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +00001013 bool NewLine, unsigned *Count, QueueType *Queue) {
Daniel Jasperde0328a2013-08-16 11:20:30 +00001014 if (NewLine && !Indenter->canBreak(PreviousNode->State))
Daniel Jasper4b866272013-02-01 11:00:45 +00001015 return;
Daniel Jasperde0328a2013-08-16 11:20:30 +00001016 if (!NewLine && Indenter->mustBreak(PreviousNode->State))
Daniel Jasper4b866272013-02-01 11:00:45 +00001017 return;
Manuel Klimek2ef908e2013-02-13 10:46:36 +00001018
1019 StateNode *Node = new (Allocator.Allocate())
1020 StateNode(PreviousNode->State, NewLine, PreviousNode);
Daniel Jasper9fe0e8d2013-09-05 09:29:45 +00001021 if (!formatChildren(Node->State, NewLine, /*DryRun=*/true, Penalty))
1022 return;
1023
Daniel Jasperde0328a2013-08-16 11:20:30 +00001024 Penalty += Indenter->addTokenToState(Node->State, NewLine, true);
Manuel Klimek2ef908e2013-02-13 10:46:36 +00001025
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +00001026 Queue->push(QueueItem(OrderedPenalty(Penalty, *Count), Node));
1027 ++(*Count);
Daniel Jasper4b866272013-02-01 11:00:45 +00001028 }
Daniel Jasperf7935112012-12-03 18:12:45 +00001029
Daniel Jasperf3a5d002013-09-05 10:48:50 +00001030 /// \brief If the \p State's next token is an r_brace closing a nested block,
1031 /// format the nested block before it.
Daniel Jasper9fe0e8d2013-09-05 09:29:45 +00001032 ///
1033 /// Returns \c true if all children could be placed successfully and adapts
1034 /// \p Penalty as well as \p State. If \p DryRun is false, also directly
1035 /// creates changes using \c Whitespaces.
1036 ///
1037 /// The crucial idea here is that children always get formatted upon
1038 /// encountering the closing brace right after the nested block. Now, if we
1039 /// are currently trying to keep the "}" on the same line (i.e. \p NewLine is
1040 /// \c false), the entire block has to be kept on the same line (which is only
1041 /// possible if it fits on the line, only contains a single statement, etc.
1042 ///
1043 /// If \p NewLine is true, we format the nested block on separate lines, i.e.
1044 /// break after the "{", format all lines with correct indentation and the put
1045 /// the closing "}" on yet another new line.
1046 ///
1047 /// This enables us to keep the simple structure of the
1048 /// \c UnwrappedLineFormatter, where we only have two options for each token:
1049 /// break or don't break.
1050 bool formatChildren(LineState &State, bool NewLine, bool DryRun,
1051 unsigned &Penalty) {
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +00001052 FormatToken &Previous = *State.NextToken->Previous;
Daniel Jasperdcd5da12013-10-20 17:28:32 +00001053 const FormatToken *LBrace = State.NextToken->getPreviousNonComment();
1054 if (!LBrace || LBrace->isNot(tok::l_brace) ||
1055 LBrace->BlockKind != BK_Block || Previous.Children.size() == 0)
Daniel Jasperf3a5d002013-09-05 10:48:50 +00001056 // The previous token does not open a block. Nothing to do. We don't
1057 // assert so that we can simply call this function for all tokens.
Daniel Jasper36c28ce2013-09-06 08:54:24 +00001058 return true;
Daniel Jasper9fe0e8d2013-09-05 09:29:45 +00001059
1060 if (NewLine) {
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +00001061 int AdditionalIndent = State.Stack.back().Indent -
1062 Previous.Children[0]->Level * Style.IndentWidth;
Daniel Jasper9c199562013-11-28 15:58:55 +00001063 Penalty += format(Previous.Children, DryRun, AdditionalIndent,
1064 /*FixBadIndentation=*/true);
Daniel Jasper9fe0e8d2013-09-05 09:29:45 +00001065 return true;
1066 }
1067
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +00001068 // Cannot merge multiple statements into a single line.
Daniel Jasperdcd5da12013-10-20 17:28:32 +00001069 if (Previous.Children.size() > 1)
Alexander Kornienko3cfa9732013-11-20 16:33:05 +00001070 return false;
Daniel Jasper9fe0e8d2013-09-05 09:29:45 +00001071
1072 // We can't put the closing "}" on a line with a trailing comment.
Daniel Jasperdcd5da12013-10-20 17:28:32 +00001073 if (Previous.Children[0]->Last->isTrailingComment())
Daniel Jasper9fe0e8d2013-09-05 09:29:45 +00001074 return false;
1075
1076 if (!DryRun) {
Alexander Kornienko3c3d09c2013-09-27 16:14:22 +00001077 Whitespaces->replaceWhitespace(
Daniel Jasperdcd5da12013-10-20 17:28:32 +00001078 *Previous.Children[0]->First,
Alexander Kornienkoe2e03872013-10-14 00:46:35 +00001079 /*Newlines=*/0, /*IndentLevel=*/0, /*Spaces=*/1,
Alexander Kornienko3c3d09c2013-09-27 16:14:22 +00001080 /*StartOfTokenColumn=*/State.Column, State.Line->InPPDirective);
Daniel Jasper9fe0e8d2013-09-05 09:29:45 +00001081 }
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +00001082 Penalty += format(*Previous.Children[0], State.Column + 1, DryRun);
Daniel Jasper9fe0e8d2013-09-05 09:29:45 +00001083
Daniel Jasperdcd5da12013-10-20 17:28:32 +00001084 State.Column += 1 + Previous.Children[0]->Last->TotalLength;
Daniel Jasper9fe0e8d2013-09-05 09:29:45 +00001085 return true;
1086 }
1087
Daniel Jasperde0328a2013-08-16 11:20:30 +00001088 ContinuationIndenter *Indenter;
Daniel Jasper9fe0e8d2013-09-05 09:29:45 +00001089 WhitespaceManager *Whitespaces;
Daniel Jasperf7935112012-12-03 18:12:45 +00001090 FormatStyle Style;
Daniel Jasper56f8b432013-11-06 23:12:09 +00001091 LineJoiner Joiner;
Manuel Klimekaf491072013-02-13 10:54:19 +00001092
1093 llvm::SpecificBumpPtrAllocator<StateNode> Allocator;
Daniel Jasperf7935112012-12-03 18:12:45 +00001094};
1095
Manuel Klimek15dfe7a2013-05-28 11:55:06 +00001096class FormatTokenLexer {
Alexander Kornienkoe3276842012-12-07 16:15:44 +00001097public:
Manuel Klimek31c85922013-08-29 15:21:40 +00001098 FormatTokenLexer(Lexer &Lex, SourceManager &SourceMgr, FormatStyle &Style,
Alexander Kornienkoffcc0102013-06-05 14:09:10 +00001099 encoding::Encoding Encoding)
Alexander Kornienko393e3082013-11-13 14:04:17 +00001100 : FormatTok(NULL), IsFirstToken(true), GreaterStashed(false), Column(0),
Manuel Klimek31c85922013-08-29 15:21:40 +00001101 TrailingWhitespace(0), Lex(Lex), SourceMgr(SourceMgr), Style(Style),
1102 IdentTable(getFormattingLangOpts()), Encoding(Encoding) {
Alexander Kornienkoe3276842012-12-07 16:15:44 +00001103 Lex.SetKeepWhitespaceMode(true);
1104 }
1105
Manuel Klimek15dfe7a2013-05-28 11:55:06 +00001106 ArrayRef<FormatToken *> lex() {
1107 assert(Tokens.empty());
1108 do {
1109 Tokens.push_back(getNextToken());
Alexander Kornienko9aa62402013-11-21 12:43:57 +00001110 tryMergePreviousTokens();
Manuel Klimek15dfe7a2013-05-28 11:55:06 +00001111 } while (Tokens.back()->Tok.isNot(tok::eof));
1112 return Tokens;
1113 }
1114
1115 IdentifierTable &getIdentTable() { return IdentTable; }
1116
1117private:
Alexander Kornienko9aa62402013-11-21 12:43:57 +00001118 void tryMergePreviousTokens() {
Alexander Kornienkocabdd732013-11-29 15:19:43 +00001119 if (tryMerge_TMacro())
1120 return;
1121
1122 if (Style.Language == FormatStyle::LK_JavaScript) {
1123 static tok::TokenKind JSIdentity[] = { tok::equalequal, tok::equal };
1124 static tok::TokenKind JSNotIdentity[] = { tok::exclaimequal, tok::equal };
1125 static tok::TokenKind JSShiftEqual[] = { tok::greater, tok::greater,
1126 tok::greaterequal };
1127 // FIXME: We probably need to change token type to mimic operator with the
1128 // correct priority.
1129 if (tryMergeTokens(JSIdentity))
1130 return;
1131 if (tryMergeTokens(JSNotIdentity))
1132 return;
1133 if (tryMergeTokens(JSShiftEqual))
1134 return;
1135 }
Alexander Kornienko9aa62402013-11-21 12:43:57 +00001136 }
1137
Alexander Kornienkocabdd732013-11-29 15:19:43 +00001138 bool tryMergeTokens(ArrayRef<tok::TokenKind> Kinds) {
1139 if (Tokens.size() < Kinds.size())
Alexander Kornienko9aa62402013-11-21 12:43:57 +00001140 return false;
Alexander Kornienkocabdd732013-11-29 15:19:43 +00001141
1142 SmallVectorImpl<FormatToken *>::const_iterator First =
1143 Tokens.end() - Kinds.size();
1144 if (!First[0]->is(Kinds[0]))
Alexander Kornienko9aa62402013-11-21 12:43:57 +00001145 return false;
Alexander Kornienkocabdd732013-11-29 15:19:43 +00001146 unsigned AddLength = 0;
1147 for (unsigned i = 1; i < Kinds.size(); ++i) {
1148 if (!First[i]->is(Kinds[i]) || First[i]->WhitespaceRange.getBegin() !=
1149 First[i]->WhitespaceRange.getEnd())
1150 return false;
1151 AddLength += First[i]->TokenText.size();
1152 }
1153 Tokens.resize(Tokens.size() - Kinds.size() + 1);
1154 First[0]->TokenText = StringRef(First[0]->TokenText.data(),
1155 First[0]->TokenText.size() + AddLength);
1156 First[0]->ColumnWidth += AddLength;
Alexander Kornienko9aa62402013-11-21 12:43:57 +00001157 return true;
1158 }
1159
1160 bool tryMerge_TMacro() {
Alexander Kornienko81e32942013-09-16 20:20:49 +00001161 if (Tokens.size() < 4)
Alexander Kornienko9aa62402013-11-21 12:43:57 +00001162 return false;
Alexander Kornienko81e32942013-09-16 20:20:49 +00001163 FormatToken *Last = Tokens.back();
1164 if (!Last->is(tok::r_paren))
Alexander Kornienko9aa62402013-11-21 12:43:57 +00001165 return false;
Alexander Kornienko81e32942013-09-16 20:20:49 +00001166
1167 FormatToken *String = Tokens[Tokens.size() - 2];
1168 if (!String->is(tok::string_literal) || String->IsMultiline)
Alexander Kornienko9aa62402013-11-21 12:43:57 +00001169 return false;
Alexander Kornienko81e32942013-09-16 20:20:49 +00001170
1171 if (!Tokens[Tokens.size() - 3]->is(tok::l_paren))
Alexander Kornienko9aa62402013-11-21 12:43:57 +00001172 return false;
Alexander Kornienko81e32942013-09-16 20:20:49 +00001173
1174 FormatToken *Macro = Tokens[Tokens.size() - 4];
1175 if (Macro->TokenText != "_T")
Alexander Kornienko9aa62402013-11-21 12:43:57 +00001176 return false;
Alexander Kornienko81e32942013-09-16 20:20:49 +00001177
1178 const char *Start = Macro->TokenText.data();
1179 const char *End = Last->TokenText.data() + Last->TokenText.size();
1180 String->TokenText = StringRef(Start, End - Start);
1181 String->IsFirst = Macro->IsFirst;
1182 String->LastNewlineOffset = Macro->LastNewlineOffset;
1183 String->WhitespaceRange = Macro->WhitespaceRange;
1184 String->OriginalColumn = Macro->OriginalColumn;
1185 String->ColumnWidth = encoding::columnWidthWithTabs(
1186 String->TokenText, String->OriginalColumn, Style.TabWidth, Encoding);
1187
1188 Tokens.pop_back();
1189 Tokens.pop_back();
1190 Tokens.pop_back();
1191 Tokens.back() = String;
Alexander Kornienko9aa62402013-11-21 12:43:57 +00001192 return true;
Alexander Kornienko81e32942013-09-16 20:20:49 +00001193 }
1194
Manuel Klimek15dfe7a2013-05-28 11:55:06 +00001195 FormatToken *getNextToken() {
Alexander Kornienkoe3276842012-12-07 16:15:44 +00001196 if (GreaterStashed) {
Manuel Klimek591ab5a2013-05-28 13:42:28 +00001197 // Create a synthesized second '>' token.
Manuel Klimek31c85922013-08-29 15:21:40 +00001198 // FIXME: Increment Column and set OriginalColumn.
Manuel Klimek591ab5a2013-05-28 13:42:28 +00001199 Token Greater = FormatTok->Tok;
1200 FormatTok = new (Allocator.Allocate()) FormatToken;
1201 FormatTok->Tok = Greater;
Manuel Klimek5c24cca2013-05-23 10:56:37 +00001202 SourceLocation GreaterLocation =
Manuel Klimek15dfe7a2013-05-28 11:55:06 +00001203 FormatTok->Tok.getLocation().getLocWithOffset(1);
1204 FormatTok->WhitespaceRange =
1205 SourceRange(GreaterLocation, GreaterLocation);
Alexander Kornienkoee4ca9b2013-06-07 17:45:07 +00001206 FormatTok->TokenText = ">";
Alexander Kornienko39856b72013-09-10 09:38:25 +00001207 FormatTok->ColumnWidth = 1;
Alexander Kornienkoe3276842012-12-07 16:15:44 +00001208 GreaterStashed = false;
1209 return FormatTok;
1210 }
1211
Manuel Klimek15dfe7a2013-05-28 11:55:06 +00001212 FormatTok = new (Allocator.Allocate()) FormatToken;
Daniel Jasper8369aa52013-07-16 20:28:33 +00001213 readRawToken(*FormatTok);
Manuel Klimek9043c742013-05-27 15:23:34 +00001214 SourceLocation WhitespaceStart =
Manuel Klimek15dfe7a2013-05-28 11:55:06 +00001215 FormatTok->Tok.getLocation().getLocWithOffset(-TrailingWhitespace);
Alexander Kornienko393e3082013-11-13 14:04:17 +00001216 FormatTok->IsFirst = IsFirstToken;
1217 IsFirstToken = false;
Alexander Kornienkoe3276842012-12-07 16:15:44 +00001218
1219 // Consume and record whitespace until we find a significant token.
Manuel Klimek9043c742013-05-27 15:23:34 +00001220 unsigned WhitespaceLength = TrailingWhitespace;
Manuel Klimek15dfe7a2013-05-28 11:55:06 +00001221 while (FormatTok->Tok.is(tok::unknown)) {
Manuel Klimek31c85922013-08-29 15:21:40 +00001222 for (int i = 0, e = FormatTok->TokenText.size(); i != e; ++i) {
1223 switch (FormatTok->TokenText[i]) {
1224 case '\n':
1225 ++FormatTok->NewlinesBefore;
1226 // FIXME: This is technically incorrect, as it could also
1227 // be a literal backslash at the end of the line.
Alexander Kornienko9e649af2013-09-11 12:25:57 +00001228 if (i == 0 || (FormatTok->TokenText[i - 1] != '\\' &&
1229 (FormatTok->TokenText[i - 1] != '\r' || i == 1 ||
1230 FormatTok->TokenText[i - 2] != '\\')))
Manuel Klimek31c85922013-08-29 15:21:40 +00001231 FormatTok->HasUnescapedNewline = true;
1232 FormatTok->LastNewlineOffset = WhitespaceLength + i + 1;
1233 Column = 0;
1234 break;
Daniel Jasper877615c2013-10-11 19:45:02 +00001235 case '\r':
1236 case '\f':
1237 case '\v':
1238 Column = 0;
1239 break;
Manuel Klimek31c85922013-08-29 15:21:40 +00001240 case ' ':
1241 ++Column;
1242 break;
1243 case '\t':
Alexander Kornienkoebb43ca2013-09-05 14:08:34 +00001244 Column += Style.TabWidth - Column % Style.TabWidth;
Manuel Klimek31c85922013-08-29 15:21:40 +00001245 break;
Daniel Jasper877615c2013-10-11 19:45:02 +00001246 case '\\':
1247 ++Column;
1248 if (i + 1 == e || (FormatTok->TokenText[i + 1] != '\r' &&
1249 FormatTok->TokenText[i + 1] != '\n'))
1250 FormatTok->Type = TT_ImplicitStringLiteral;
1251 break;
Manuel Klimek31c85922013-08-29 15:21:40 +00001252 default:
Daniel Jasper877615c2013-10-11 19:45:02 +00001253 FormatTok->Type = TT_ImplicitStringLiteral;
Manuel Klimek31c85922013-08-29 15:21:40 +00001254 ++Column;
1255 break;
1256 }
1257 }
1258
Daniel Jasper877615c2013-10-11 19:45:02 +00001259 if (FormatTok->Type == TT_ImplicitStringLiteral)
1260 break;
Manuel Klimek15dfe7a2013-05-28 11:55:06 +00001261 WhitespaceLength += FormatTok->Tok.getLength();
Alexander Kornienkoe3276842012-12-07 16:15:44 +00001262
Daniel Jasper8369aa52013-07-16 20:28:33 +00001263 readRawToken(*FormatTok);
Manuel Klimek1abf7892013-01-04 23:34:14 +00001264 }
Manuel Klimekef920692013-01-07 07:56:50 +00001265
Manuel Klimek1abf7892013-01-04 23:34:14 +00001266 // In case the token starts with escaped newlines, we want to
1267 // take them into account as whitespace - this pattern is quite frequent
1268 // in macro definitions.
Manuel Klimek1abf7892013-01-04 23:34:14 +00001269 // FIXME: Add a more explicit test.
Daniel Jasper8369aa52013-07-16 20:28:33 +00001270 while (FormatTok->TokenText.size() > 1 && FormatTok->TokenText[0] == '\\' &&
1271 FormatTok->TokenText[1] == '\n') {
Manuel Klimek15dfe7a2013-05-28 11:55:06 +00001272 // FIXME: ++FormatTok->NewlinesBefore is missing...
Manuel Klimek5c24cca2013-05-23 10:56:37 +00001273 WhitespaceLength += 2;
Manuel Klimek31c85922013-08-29 15:21:40 +00001274 Column = 0;
Daniel Jasper8369aa52013-07-16 20:28:33 +00001275 FormatTok->TokenText = FormatTok->TokenText.substr(2);
Alexander Kornienkoe3276842012-12-07 16:15:44 +00001276 }
Alexander Kornienko39856b72013-09-10 09:38:25 +00001277
1278 FormatTok->WhitespaceRange = SourceRange(
1279 WhitespaceStart, WhitespaceStart.getLocWithOffset(WhitespaceLength));
1280
Manuel Klimek31c85922013-08-29 15:21:40 +00001281 FormatTok->OriginalColumn = Column;
Alexander Kornienkoe3276842012-12-07 16:15:44 +00001282
Alexander Kornienkoee4ca9b2013-06-07 17:45:07 +00001283 TrailingWhitespace = 0;
1284 if (FormatTok->Tok.is(tok::comment)) {
Manuel Klimek31c85922013-08-29 15:21:40 +00001285 // FIXME: Add the trimmed whitespace to Column.
Daniel Jasper8369aa52013-07-16 20:28:33 +00001286 StringRef UntrimmedText = FormatTok->TokenText;
Alexander Kornienko9ab4a772013-09-06 17:24:54 +00001287 FormatTok->TokenText = FormatTok->TokenText.rtrim(" \t\v\f");
Daniel Jasper8369aa52013-07-16 20:28:33 +00001288 TrailingWhitespace = UntrimmedText.size() - FormatTok->TokenText.size();
Alexander Kornienkoee4ca9b2013-06-07 17:45:07 +00001289 } else if (FormatTok->Tok.is(tok::raw_identifier)) {
Daniel Jasper8369aa52013-07-16 20:28:33 +00001290 IdentifierInfo &Info = IdentTable.get(FormatTok->TokenText);
Manuel Klimek15dfe7a2013-05-28 11:55:06 +00001291 FormatTok->Tok.setIdentifierInfo(&Info);
1292 FormatTok->Tok.setKind(Info.getTokenID());
Alexander Kornienkoee4ca9b2013-06-07 17:45:07 +00001293 } else if (FormatTok->Tok.is(tok::greatergreater)) {
Manuel Klimek15dfe7a2013-05-28 11:55:06 +00001294 FormatTok->Tok.setKind(tok::greater);
Daniel Jasper8369aa52013-07-16 20:28:33 +00001295 FormatTok->TokenText = FormatTok->TokenText.substr(0, 1);
Alexander Kornienkoe3276842012-12-07 16:15:44 +00001296 GreaterStashed = true;
1297 }
1298
Alexander Kornienkoee4ca9b2013-06-07 17:45:07 +00001299 // Now FormatTok is the next non-whitespace token.
Alexander Kornienkoffcc0102013-06-05 14:09:10 +00001300
Alexander Kornienko39856b72013-09-10 09:38:25 +00001301 StringRef Text = FormatTok->TokenText;
1302 size_t FirstNewlinePos = Text.find('\n');
Alexander Kornienko917f9e02013-09-10 12:29:48 +00001303 if (FirstNewlinePos == StringRef::npos) {
1304 // FIXME: ColumnWidth actually depends on the start column, we need to
1305 // take this into account when the token is moved.
1306 FormatTok->ColumnWidth =
1307 encoding::columnWidthWithTabs(Text, Column, Style.TabWidth, Encoding);
1308 Column += FormatTok->ColumnWidth;
1309 } else {
Alexander Kornienko39856b72013-09-10 09:38:25 +00001310 FormatTok->IsMultiline = true;
Alexander Kornienko917f9e02013-09-10 12:29:48 +00001311 // FIXME: ColumnWidth actually depends on the start column, we need to
1312 // take this into account when the token is moved.
1313 FormatTok->ColumnWidth = encoding::columnWidthWithTabs(
1314 Text.substr(0, FirstNewlinePos), Column, Style.TabWidth, Encoding);
1315
Alexander Kornienko39856b72013-09-10 09:38:25 +00001316 // The last line of the token always starts in column 0.
1317 // Thus, the length can be precomputed even in the presence of tabs.
1318 FormatTok->LastLineColumnWidth = encoding::columnWidthWithTabs(
1319 Text.substr(Text.find_last_of('\n') + 1), 0, Style.TabWidth,
1320 Encoding);
Alexander Kornienko917f9e02013-09-10 12:29:48 +00001321 Column = FormatTok->LastLineColumnWidth;
Alexander Kornienko632abb92013-09-02 13:58:14 +00001322 }
Alexander Kornienko39856b72013-09-10 09:38:25 +00001323
Alexander Kornienkoe3276842012-12-07 16:15:44 +00001324 return FormatTok;
1325 }
1326
Manuel Klimek15dfe7a2013-05-28 11:55:06 +00001327 FormatToken *FormatTok;
Alexander Kornienko393e3082013-11-13 14:04:17 +00001328 bool IsFirstToken;
Alexander Kornienkoe3276842012-12-07 16:15:44 +00001329 bool GreaterStashed;
Manuel Klimek31c85922013-08-29 15:21:40 +00001330 unsigned Column;
Manuel Klimek9043c742013-05-27 15:23:34 +00001331 unsigned TrailingWhitespace;
Alexander Kornienkoe3276842012-12-07 16:15:44 +00001332 Lexer &Lex;
1333 SourceManager &SourceMgr;
Manuel Klimek31c85922013-08-29 15:21:40 +00001334 FormatStyle &Style;
Alexander Kornienkoe3276842012-12-07 16:15:44 +00001335 IdentifierTable IdentTable;
Alexander Kornienkoffcc0102013-06-05 14:09:10 +00001336 encoding::Encoding Encoding;
Manuel Klimek15dfe7a2013-05-28 11:55:06 +00001337 llvm::SpecificBumpPtrAllocator<FormatToken> Allocator;
1338 SmallVector<FormatToken *, 16> Tokens;
Alexander Kornienkoe3276842012-12-07 16:15:44 +00001339
Daniel Jasper8369aa52013-07-16 20:28:33 +00001340 void readRawToken(FormatToken &Tok) {
1341 Lex.LexFromRawLexer(Tok.Tok);
1342 Tok.TokenText = StringRef(SourceMgr.getCharacterData(Tok.Tok.getLocation()),
1343 Tok.Tok.getLength());
Daniel Jasper8369aa52013-07-16 20:28:33 +00001344 // For formatting, treat unterminated string literals like normal string
1345 // literals.
Daniel Jasper86fee2f2014-01-31 12:49:42 +00001346 if (Tok.is(tok::unknown)) {
1347 if (!Tok.TokenText.empty() && Tok.TokenText[0] == '"') {
1348 Tok.Tok.setKind(tok::string_literal);
1349 Tok.IsUnterminatedLiteral = true;
1350 } else if (Style.Language == FormatStyle::LK_JavaScript &&
1351 Tok.TokenText == "''") {
1352 Tok.Tok.setKind(tok::char_constant);
1353 }
Daniel Jasper8369aa52013-07-16 20:28:33 +00001354 }
Alexander Kornienkoe3276842012-12-07 16:15:44 +00001355 }
1356};
1357
Alexander Kornienkocabdd732013-11-29 15:19:43 +00001358static StringRef getLanguageName(FormatStyle::LanguageKind Language) {
1359 switch (Language) {
1360 case FormatStyle::LK_Cpp:
1361 return "C++";
1362 case FormatStyle::LK_JavaScript:
1363 return "JavaScript";
Daniel Jasper7052ce62014-01-19 09:04:08 +00001364 case FormatStyle::LK_Proto:
1365 return "Proto";
Alexander Kornienkocabdd732013-11-29 15:19:43 +00001366 default:
1367 return "Unknown";
1368 }
1369}
1370
Daniel Jasperf7935112012-12-03 18:12:45 +00001371class Formatter : public UnwrappedLineConsumer {
1372public:
Daniel Jasperd2ae41a2013-05-15 08:14:19 +00001373 Formatter(const FormatStyle &Style, Lexer &Lex, SourceManager &SourceMgr,
Daniel Jasperf7935112012-12-03 18:12:45 +00001374 const std::vector<CharSourceRange> &Ranges)
Daniel Jasperd2ae41a2013-05-15 08:14:19 +00001375 : Style(Style), Lex(Lex), SourceMgr(SourceMgr),
Alexander Kornienko9e649af2013-09-11 12:25:57 +00001376 Whitespaces(SourceMgr, Style, inputUsesCRLF(Lex.getBuffer())),
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +00001377 Ranges(Ranges.begin(), Ranges.end()), UnwrappedLines(1),
Manuel Klimek71814b42013-10-11 21:25:45 +00001378 Encoding(encoding::detectEncoding(Lex.getBuffer())) {
Daniel Jasperfa21c072013-07-15 14:33:14 +00001379 DEBUG(llvm::dbgs() << "File encoding: "
1380 << (Encoding == encoding::Encoding_UTF8 ? "UTF8"
1381 : "unknown")
1382 << "\n");
Alexander Kornienkocabdd732013-11-29 15:19:43 +00001383 DEBUG(llvm::dbgs() << "Language: " << getLanguageName(Style.Language)
1384 << "\n");
Alexander Kornienkoffcc0102013-06-05 14:09:10 +00001385 }
Daniel Jasperf7935112012-12-03 18:12:45 +00001386
Alexander Kornienko62b85b92013-03-13 14:41:29 +00001387 tooling::Replacements format() {
Manuel Klimek71814b42013-10-11 21:25:45 +00001388 tooling::Replacements Result;
Manuel Klimek31c85922013-08-29 15:21:40 +00001389 FormatTokenLexer Tokens(Lex, SourceMgr, Style, Encoding);
Manuel Klimek15dfe7a2013-05-28 11:55:06 +00001390
1391 UnwrappedLineParser Parser(Style, Tokens.lex(), *this);
Manuel Klimek1a18c402013-04-12 14:13:36 +00001392 bool StructuralError = Parser.parse();
Manuel Klimek71814b42013-10-11 21:25:45 +00001393 assert(UnwrappedLines.rbegin()->empty());
1394 for (unsigned Run = 0, RunE = UnwrappedLines.size(); Run + 1 != RunE;
1395 ++Run) {
1396 DEBUG(llvm::dbgs() << "Run " << Run << "...\n");
1397 SmallVector<AnnotatedLine *, 16> AnnotatedLines;
1398 for (unsigned i = 0, e = UnwrappedLines[Run].size(); i != e; ++i) {
1399 AnnotatedLines.push_back(new AnnotatedLine(UnwrappedLines[Run][i]));
1400 }
1401 tooling::Replacements RunResult =
1402 format(AnnotatedLines, StructuralError, Tokens);
1403 DEBUG({
1404 llvm::dbgs() << "Replacements for run " << Run << ":\n";
1405 for (tooling::Replacements::iterator I = RunResult.begin(),
1406 E = RunResult.end();
1407 I != E; ++I) {
1408 llvm::dbgs() << I->toString() << "\n";
1409 }
1410 });
1411 for (unsigned i = 0, e = AnnotatedLines.size(); i != e; ++i) {
1412 delete AnnotatedLines[i];
1413 }
1414 Result.insert(RunResult.begin(), RunResult.end());
1415 Whitespaces.reset();
1416 }
1417 return Result;
1418 }
1419
1420 tooling::Replacements format(SmallVectorImpl<AnnotatedLine *> &AnnotatedLines,
1421 bool StructuralError, FormatTokenLexer &Tokens) {
Alexander Kornienkoffcc0102013-06-05 14:09:10 +00001422 TokenAnnotator Annotator(Style, Tokens.getIdentTable().get("in"));
Alexander Kornienko62b85b92013-03-13 14:41:29 +00001423 for (unsigned i = 0, e = AnnotatedLines.size(); i != e; ++i) {
Daniel Jasper9fe0e8d2013-09-05 09:29:45 +00001424 Annotator.annotate(*AnnotatedLines[i]);
Alexander Kornienko62b85b92013-03-13 14:41:29 +00001425 }
Manuel Klimek71814b42013-10-11 21:25:45 +00001426 deriveLocalStyle(AnnotatedLines);
Alexander Kornienko62b85b92013-03-13 14:41:29 +00001427 for (unsigned i = 0, e = AnnotatedLines.size(); i != e; ++i) {
Daniel Jasper9fe0e8d2013-09-05 09:29:45 +00001428 Annotator.calculateFormattingInformation(*AnnotatedLines[i]);
Alexander Kornienko62b85b92013-03-13 14:41:29 +00001429 }
Daniel Jasper5500f612013-11-25 11:08:59 +00001430 computeAffectedLines(AnnotatedLines.begin(), AnnotatedLines.end());
Daniel Jasperb67cc422013-04-09 17:46:55 +00001431
Daniel Jasper1c5d9df2013-09-06 07:54:20 +00001432 Annotator.setCommentLineLevels(AnnotatedLines);
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +00001433 ContinuationIndenter Indenter(Style, SourceMgr, Whitespaces, Encoding,
1434 BinPackInconclusiveFunctions);
Daniel Jasper5500f612013-11-25 11:08:59 +00001435 UnwrappedLineFormatter Formatter(&Indenter, &Whitespaces, Style);
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +00001436 Formatter.format(AnnotatedLines, /*DryRun=*/false);
Alexander Kornienko62b85b92013-03-13 14:41:29 +00001437 return Whitespaces.generateReplacements();
1438 }
1439
1440private:
Daniel Jasper5500f612013-11-25 11:08:59 +00001441 // Determines which lines are affected by the SourceRanges given as input.
Daniel Jasper9c199562013-11-28 15:58:55 +00001442 // Returns \c true if at least one line between I and E or one of their
1443 // children is affected.
Daniel Jasper5500f612013-11-25 11:08:59 +00001444 bool computeAffectedLines(SmallVectorImpl<AnnotatedLine *>::iterator I,
1445 SmallVectorImpl<AnnotatedLine *>::iterator E) {
1446 bool SomeLineAffected = false;
Daniel Jasper38c82402013-11-29 09:27:43 +00001447 const AnnotatedLine *PreviousLine = NULL;
Daniel Jasper5500f612013-11-25 11:08:59 +00001448 while (I != E) {
1449 AnnotatedLine *Line = *I;
1450 Line->LeadingEmptyLinesAffected = affectsLeadingEmptyLines(*Line->First);
1451
1452 // If a line is part of a preprocessor directive, it needs to be formatted
1453 // if any token within the directive is affected.
1454 if (Line->InPPDirective) {
1455 FormatToken *Last = Line->Last;
1456 SmallVectorImpl<AnnotatedLine *>::iterator PPEnd = I + 1;
1457 while (PPEnd != E && !(*PPEnd)->First->HasUnescapedNewline) {
1458 Last = (*PPEnd)->Last;
1459 ++PPEnd;
1460 }
1461
1462 if (affectsTokenRange(*Line->First, *Last,
1463 /*IncludeLeadingNewlines=*/false)) {
1464 SomeLineAffected = true;
1465 markAllAsAffected(I, PPEnd);
1466 }
1467 I = PPEnd;
1468 continue;
1469 }
1470
Daniel Jasper38c82402013-11-29 09:27:43 +00001471 if (nonPPLineAffected(Line, PreviousLine))
Daniel Jasper5500f612013-11-25 11:08:59 +00001472 SomeLineAffected = true;
Daniel Jasper5500f612013-11-25 11:08:59 +00001473
Daniel Jasper38c82402013-11-29 09:27:43 +00001474 PreviousLine = Line;
Daniel Jasper5500f612013-11-25 11:08:59 +00001475 ++I;
1476 }
1477 return SomeLineAffected;
1478 }
1479
Daniel Jasper9c199562013-11-28 15:58:55 +00001480 // Determines whether 'Line' is affected by the SourceRanges given as input.
1481 // Returns \c true if line or one if its children is affected.
Daniel Jasper38c82402013-11-29 09:27:43 +00001482 bool nonPPLineAffected(AnnotatedLine *Line,
1483 const AnnotatedLine *PreviousLine) {
Daniel Jasper9c199562013-11-28 15:58:55 +00001484 bool SomeLineAffected = false;
1485 Line->ChildrenAffected =
1486 computeAffectedLines(Line->Children.begin(), Line->Children.end());
1487 if (Line->ChildrenAffected)
1488 SomeLineAffected = true;
1489
1490 // Stores whether one of the line's tokens is directly affected.
1491 bool SomeTokenAffected = false;
1492 // Stores whether we need to look at the leading newlines of the next token
1493 // in order to determine whether it was affected.
1494 bool IncludeLeadingNewlines = false;
1495
1496 // Stores whether the first child line of any of this line's tokens is
1497 // affected.
1498 bool SomeFirstChildAffected = false;
1499
1500 for (FormatToken *Tok = Line->First; Tok; Tok = Tok->Next) {
1501 // Determine whether 'Tok' was affected.
1502 if (affectsTokenRange(*Tok, *Tok, IncludeLeadingNewlines))
1503 SomeTokenAffected = true;
1504
1505 // Determine whether the first child of 'Tok' was affected.
1506 if (!Tok->Children.empty() && Tok->Children.front()->Affected)
1507 SomeFirstChildAffected = true;
1508
1509 IncludeLeadingNewlines = Tok->Children.empty();
1510 }
1511
1512 // Was this line moved, i.e. has it previously been on the same line as an
1513 // affected line?
Daniel Jasper38c82402013-11-29 09:27:43 +00001514 bool LineMoved = PreviousLine && PreviousLine->Affected &&
1515 Line->First->NewlinesBefore == 0;
Daniel Jasper9c199562013-11-28 15:58:55 +00001516
Daniel Jasper38c82402013-11-29 09:27:43 +00001517 bool IsContinuedComment = Line->First->is(tok::comment) &&
1518 Line->First->Next == NULL &&
1519 Line->First->NewlinesBefore < 2 && PreviousLine &&
Daniel Jasper0e81f1a2013-12-02 09:19:27 +00001520 PreviousLine->Affected &&
Daniel Jasper38c82402013-11-29 09:27:43 +00001521 PreviousLine->Last->is(tok::comment);
1522
1523 if (SomeTokenAffected || SomeFirstChildAffected || LineMoved ||
1524 IsContinuedComment) {
Daniel Jasper9c199562013-11-28 15:58:55 +00001525 Line->Affected = true;
Daniel Jasper9c199562013-11-28 15:58:55 +00001526 SomeLineAffected = true;
Daniel Jasper9c199562013-11-28 15:58:55 +00001527 }
1528 return SomeLineAffected;
1529 }
1530
Daniel Jasper5500f612013-11-25 11:08:59 +00001531 // Marks all lines between I and E as well as all their children as affected.
1532 void markAllAsAffected(SmallVectorImpl<AnnotatedLine *>::iterator I,
1533 SmallVectorImpl<AnnotatedLine *>::iterator E) {
1534 while (I != E) {
1535 (*I)->Affected = true;
1536 markAllAsAffected((*I)->Children.begin(), (*I)->Children.end());
1537 ++I;
1538 }
1539 }
1540
1541 // Returns true if the range from 'First' to 'Last' intersects with one of the
1542 // input ranges.
1543 bool affectsTokenRange(const FormatToken &First, const FormatToken &Last,
1544 bool IncludeLeadingNewlines) {
1545 SourceLocation Start = First.WhitespaceRange.getBegin();
1546 if (!IncludeLeadingNewlines)
1547 Start = Start.getLocWithOffset(First.LastNewlineOffset);
Daniel Jasper5877bf12013-11-25 11:53:05 +00001548 SourceLocation End = Last.getStartOfNonWhitespace();
1549 if (Last.TokenText.size() > 0)
1550 End = End.getLocWithOffset(Last.TokenText.size() - 1);
Daniel Jasper5500f612013-11-25 11:08:59 +00001551 CharSourceRange Range = CharSourceRange::getCharRange(Start, End);
1552 return affectsCharSourceRange(Range);
1553 }
1554
1555 // Returns true if one of the input ranges intersect the leading empty lines
1556 // before 'Tok'.
1557 bool affectsLeadingEmptyLines(const FormatToken &Tok) {
1558 CharSourceRange EmptyLineRange = CharSourceRange::getCharRange(
1559 Tok.WhitespaceRange.getBegin(),
1560 Tok.WhitespaceRange.getBegin().getLocWithOffset(Tok.LastNewlineOffset));
1561 return affectsCharSourceRange(EmptyLineRange);
1562 }
1563
1564 // Returns true if 'Range' intersects with one of the input ranges.
1565 bool affectsCharSourceRange(const CharSourceRange &Range) {
1566 for (SmallVectorImpl<CharSourceRange>::const_iterator I = Ranges.begin(),
1567 E = Ranges.end();
1568 I != E; ++I) {
1569 if (!SourceMgr.isBeforeInTranslationUnit(Range.getEnd(), I->getBegin()) &&
1570 !SourceMgr.isBeforeInTranslationUnit(I->getEnd(), Range.getBegin()))
1571 return true;
1572 }
1573 return false;
1574 }
1575
Alexander Kornienko9e649af2013-09-11 12:25:57 +00001576 static bool inputUsesCRLF(StringRef Text) {
1577 return Text.count('\r') * 2 > Text.count('\n');
1578 }
1579
Manuel Klimek71814b42013-10-11 21:25:45 +00001580 void
1581 deriveLocalStyle(const SmallVectorImpl<AnnotatedLine *> &AnnotatedLines) {
Daniel Jasper7fce3ab2013-02-06 14:22:40 +00001582 unsigned CountBoundToVariable = 0;
1583 unsigned CountBoundToType = 0;
1584 bool HasCpp03IncompatibleFormat = false;
Daniel Jasperb10cbc42013-07-10 14:02:49 +00001585 bool HasBinPackedFunction = false;
1586 bool HasOnePerLineFunction = false;
Daniel Jasper7fce3ab2013-02-06 14:22:40 +00001587 for (unsigned i = 0, e = AnnotatedLines.size(); i != e; ++i) {
Daniel Jasper9fe0e8d2013-09-05 09:29:45 +00001588 if (!AnnotatedLines[i]->First->Next)
Daniel Jasper7fce3ab2013-02-06 14:22:40 +00001589 continue;
Daniel Jasper9fe0e8d2013-09-05 09:29:45 +00001590 FormatToken *Tok = AnnotatedLines[i]->First->Next;
Manuel Klimek6e6310e2013-05-29 14:47:47 +00001591 while (Tok->Next) {
Daniel Jasper7fce3ab2013-02-06 14:22:40 +00001592 if (Tok->Type == TT_PointerOrReference) {
Manuel Klimek6e6310e2013-05-29 14:47:47 +00001593 bool SpacesBefore =
1594 Tok->WhitespaceRange.getBegin() != Tok->WhitespaceRange.getEnd();
1595 bool SpacesAfter = Tok->Next->WhitespaceRange.getBegin() !=
1596 Tok->Next->WhitespaceRange.getEnd();
Daniel Jasper7fce3ab2013-02-06 14:22:40 +00001597 if (SpacesBefore && !SpacesAfter)
1598 ++CountBoundToVariable;
1599 else if (!SpacesBefore && SpacesAfter)
1600 ++CountBoundToType;
1601 }
1602
Daniel Jasperfba84ff2013-10-12 05:16:06 +00001603 if (Tok->WhitespaceRange.getBegin() == Tok->WhitespaceRange.getEnd()) {
1604 if (Tok->is(tok::coloncolon) &&
1605 Tok->Previous->Type == TT_TemplateOpener)
1606 HasCpp03IncompatibleFormat = true;
1607 if (Tok->Type == TT_TemplateCloser &&
1608 Tok->Previous->Type == TT_TemplateCloser)
1609 HasCpp03IncompatibleFormat = true;
1610 }
Daniel Jasperb10cbc42013-07-10 14:02:49 +00001611
1612 if (Tok->PackingKind == PPK_BinPacked)
1613 HasBinPackedFunction = true;
1614 if (Tok->PackingKind == PPK_OnePerLine)
1615 HasOnePerLineFunction = true;
1616
Manuel Klimek6e6310e2013-05-29 14:47:47 +00001617 Tok = Tok->Next;
Daniel Jasper7fce3ab2013-02-06 14:22:40 +00001618 }
1619 }
1620 if (Style.DerivePointerBinding) {
1621 if (CountBoundToType > CountBoundToVariable)
1622 Style.PointerBindsToType = true;
1623 else if (CountBoundToType < CountBoundToVariable)
1624 Style.PointerBindsToType = false;
1625 }
1626 if (Style.Standard == FormatStyle::LS_Auto) {
1627 Style.Standard = HasCpp03IncompatibleFormat ? FormatStyle::LS_Cpp11
1628 : FormatStyle::LS_Cpp03;
1629 }
Daniel Jasperb10cbc42013-07-10 14:02:49 +00001630 BinPackInconclusiveFunctions =
1631 HasBinPackedFunction || !HasOnePerLineFunction;
Daniel Jasper7fce3ab2013-02-06 14:22:40 +00001632 }
1633
Manuel Klimek51bd6ec2013-01-10 19:49:59 +00001634 virtual void consumeUnwrappedLine(const UnwrappedLine &TheLine) {
Manuel Klimek71814b42013-10-11 21:25:45 +00001635 assert(!UnwrappedLines.empty());
1636 UnwrappedLines.back().push_back(TheLine);
1637 }
1638
1639 virtual void finishRun() {
1640 UnwrappedLines.push_back(SmallVector<UnwrappedLine, 16>());
Daniel Jasperf7935112012-12-03 18:12:45 +00001641 }
1642
1643 FormatStyle Style;
1644 Lexer &Lex;
1645 SourceManager &SourceMgr;
Daniel Jasperaa701fa2013-01-18 08:44:07 +00001646 WhitespaceManager Whitespaces;
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +00001647 SmallVector<CharSourceRange, 8> Ranges;
Manuel Klimek71814b42013-10-11 21:25:45 +00001648 SmallVector<SmallVector<UnwrappedLine, 16>, 2> UnwrappedLines;
Alexander Kornienkoffcc0102013-06-05 14:09:10 +00001649
1650 encoding::Encoding Encoding;
Daniel Jasperb10cbc42013-07-10 14:02:49 +00001651 bool BinPackInconclusiveFunctions;
Daniel Jasperf7935112012-12-03 18:12:45 +00001652};
1653
Craig Topperaf35e852013-06-30 22:29:28 +00001654} // end anonymous namespace
1655
Alexander Kornienkocb45bc12013-04-15 14:28:00 +00001656tooling::Replacements reformat(const FormatStyle &Style, Lexer &Lex,
1657 SourceManager &SourceMgr,
Daniel Jasperd2ae41a2013-05-15 08:14:19 +00001658 std::vector<CharSourceRange> Ranges) {
1659 Formatter formatter(Style, Lex, SourceMgr, Ranges);
Daniel Jasperf7935112012-12-03 18:12:45 +00001660 return formatter.format();
1661}
1662
Daniel Jasperec04c0d2013-05-16 10:40:07 +00001663tooling::Replacements reformat(const FormatStyle &Style, StringRef Code,
1664 std::vector<tooling::Range> Ranges,
1665 StringRef FileName) {
1666 FileManager Files((FileSystemOptions()));
1667 DiagnosticsEngine Diagnostics(
1668 IntrusiveRefCntPtr<DiagnosticIDs>(new DiagnosticIDs),
1669 new DiagnosticOptions);
1670 SourceManager SourceMgr(Diagnostics, Files);
1671 llvm::MemoryBuffer *Buf = llvm::MemoryBuffer::getMemBuffer(Code, FileName);
1672 const clang::FileEntry *Entry =
1673 Files.getVirtualFile(FileName, Buf->getBufferSize(), 0);
1674 SourceMgr.overrideFileContents(Entry, Buf);
1675 FileID ID =
1676 SourceMgr.createFileID(Entry, SourceLocation(), clang::SrcMgr::C_User);
Alexander Kornienko1e808872013-06-28 12:51:24 +00001677 Lexer Lex(ID, SourceMgr.getBuffer(ID), SourceMgr,
1678 getFormattingLangOpts(Style.Standard));
Daniel Jasperec04c0d2013-05-16 10:40:07 +00001679 SourceLocation StartOfFile = SourceMgr.getLocForStartOfFile(ID);
1680 std::vector<CharSourceRange> CharRanges;
1681 for (unsigned i = 0, e = Ranges.size(); i != e; ++i) {
1682 SourceLocation Start = StartOfFile.getLocWithOffset(Ranges[i].getOffset());
1683 SourceLocation End = Start.getLocWithOffset(Ranges[i].getLength());
1684 CharRanges.push_back(CharSourceRange::getCharRange(Start, End));
1685 }
1686 return reformat(Style, Lex, SourceMgr, CharRanges);
1687}
1688
Alexander Kornienko1e808872013-06-28 12:51:24 +00001689LangOptions getFormattingLangOpts(FormatStyle::LanguageStandard Standard) {
Daniel Jasperc1fa2812013-01-10 13:08:12 +00001690 LangOptions LangOpts;
1691 LangOpts.CPlusPlus = 1;
Alexander Kornienko1e808872013-06-28 12:51:24 +00001692 LangOpts.CPlusPlus11 = Standard == FormatStyle::LS_Cpp03 ? 0 : 1;
Daniel Jasper55213652013-03-22 10:01:29 +00001693 LangOpts.LineComment = 1;
Daniel Jasperc1fa2812013-01-10 13:08:12 +00001694 LangOpts.Bool = 1;
1695 LangOpts.ObjC1 = 1;
1696 LangOpts.ObjC2 = 1;
1697 return LangOpts;
1698}
1699
Edwin Vaned544aa72013-09-30 13:31:48 +00001700const char *StyleOptionHelpDescription =
1701 "Coding style, currently supports:\n"
1702 " LLVM, Google, Chromium, Mozilla, WebKit.\n"
1703 "Use -style=file to load style configuration from\n"
1704 ".clang-format file located in one of the parent\n"
1705 "directories of the source file (or current\n"
1706 "directory for stdin).\n"
1707 "Use -style=\"{key: value, ...}\" to set specific\n"
1708 "parameters, e.g.:\n"
1709 " -style=\"{BasedOnStyle: llvm, IndentWidth: 8}\"";
1710
Alexander Kornienkoc1637f12013-12-10 11:28:13 +00001711static FormatStyle::LanguageKind getLanguageByFileName(StringRef FileName) {
Alexander Kornienkocabdd732013-11-29 15:19:43 +00001712 if (FileName.endswith_lower(".js")) {
Alexander Kornienkoc1637f12013-12-10 11:28:13 +00001713 return FormatStyle::LK_JavaScript;
Daniel Jasper7052ce62014-01-19 09:04:08 +00001714 } else if (FileName.endswith_lower(".proto") ||
1715 FileName.endswith_lower(".protodevel")) {
1716 return FormatStyle::LK_Proto;
Alexander Kornienkocabdd732013-11-29 15:19:43 +00001717 }
Alexander Kornienkoc1637f12013-12-10 11:28:13 +00001718 return FormatStyle::LK_Cpp;
Alexander Kornienkocabdd732013-11-29 15:19:43 +00001719}
1720
Alexander Kornienkobc4ae442013-12-02 15:21:38 +00001721FormatStyle getStyle(StringRef StyleName, StringRef FileName,
1722 StringRef FallbackStyle) {
Alexander Kornienkoc1637f12013-12-10 11:28:13 +00001723 FormatStyle Style = getLLVMStyle();
1724 Style.Language = getLanguageByFileName(FileName);
1725 if (!getPredefinedStyle(FallbackStyle, Style.Language, &Style)) {
Alexander Kornienkobc4ae442013-12-02 15:21:38 +00001726 llvm::errs() << "Invalid fallback style \"" << FallbackStyle
1727 << "\" using LLVM style\n";
Alexander Kornienkoc1637f12013-12-10 11:28:13 +00001728 return Style;
Alexander Kornienkobc4ae442013-12-02 15:21:38 +00001729 }
Edwin Vaned544aa72013-09-30 13:31:48 +00001730
1731 if (StyleName.startswith("{")) {
1732 // Parse YAML/JSON style from the command line.
1733 if (llvm::error_code ec = parseConfiguration(StyleName, &Style)) {
Alexander Kornienkoe2e03872013-10-14 00:46:35 +00001734 llvm::errs() << "Error parsing -style: " << ec.message() << ", using "
1735 << FallbackStyle << " style\n";
Edwin Vaned544aa72013-09-30 13:31:48 +00001736 }
1737 return Style;
1738 }
1739
1740 if (!StyleName.equals_lower("file")) {
Alexander Kornienkoc1637f12013-12-10 11:28:13 +00001741 if (!getPredefinedStyle(StyleName, Style.Language, &Style))
Edwin Vaned544aa72013-09-30 13:31:48 +00001742 llvm::errs() << "Invalid value for -style, using " << FallbackStyle
1743 << " style\n";
1744 return Style;
1745 }
1746
Alexander Kornienkoc1637f12013-12-10 11:28:13 +00001747 // Look for .clang-format/_clang-format file in the file's parent directories.
Alexander Kornienkocabdd732013-11-29 15:19:43 +00001748 SmallString<128> UnsuitableConfigFiles;
Edwin Vaned544aa72013-09-30 13:31:48 +00001749 SmallString<128> Path(FileName);
1750 llvm::sys::fs::make_absolute(Path);
Alexander Kornienkoe2e03872013-10-14 00:46:35 +00001751 for (StringRef Directory = Path; !Directory.empty();
Edwin Vaned544aa72013-09-30 13:31:48 +00001752 Directory = llvm::sys::path::parent_path(Directory)) {
1753 if (!llvm::sys::fs::is_directory(Directory))
1754 continue;
1755 SmallString<128> ConfigFile(Directory);
1756
1757 llvm::sys::path::append(ConfigFile, ".clang-format");
1758 DEBUG(llvm::dbgs() << "Trying " << ConfigFile << "...\n");
1759 bool IsFile = false;
1760 // Ignore errors from is_regular_file: we only need to know if we can read
1761 // the file or not.
1762 llvm::sys::fs::is_regular_file(Twine(ConfigFile), IsFile);
1763
1764 if (!IsFile) {
1765 // Try _clang-format too, since dotfiles are not commonly used on Windows.
1766 ConfigFile = Directory;
1767 llvm::sys::path::append(ConfigFile, "_clang-format");
1768 DEBUG(llvm::dbgs() << "Trying " << ConfigFile << "...\n");
1769 llvm::sys::fs::is_regular_file(Twine(ConfigFile), IsFile);
1770 }
1771
1772 if (IsFile) {
1773 OwningPtr<llvm::MemoryBuffer> Text;
Rafael Espindola1a3605c2013-10-25 19:00:49 +00001774 if (llvm::error_code ec =
1775 llvm::MemoryBuffer::getFile(ConfigFile.c_str(), Text)) {
Edwin Vaned544aa72013-09-30 13:31:48 +00001776 llvm::errs() << ec.message() << "\n";
Alexander Kornienkobc4ae442013-12-02 15:21:38 +00001777 break;
Edwin Vaned544aa72013-09-30 13:31:48 +00001778 }
1779 if (llvm::error_code ec = parseConfiguration(Text->getBuffer(), &Style)) {
Alexander Kornienkocabdd732013-11-29 15:19:43 +00001780 if (ec == llvm::errc::not_supported) {
1781 if (!UnsuitableConfigFiles.empty())
1782 UnsuitableConfigFiles.append(", ");
1783 UnsuitableConfigFiles.append(ConfigFile);
Alexander Kornienkobc4ae442013-12-02 15:21:38 +00001784 continue;
Alexander Kornienkocabdd732013-11-29 15:19:43 +00001785 }
Alexander Kornienkobc4ae442013-12-02 15:21:38 +00001786 llvm::errs() << "Error reading " << ConfigFile << ": " << ec.message()
1787 << "\n";
1788 break;
Edwin Vaned544aa72013-09-30 13:31:48 +00001789 }
1790 DEBUG(llvm::dbgs() << "Using configuration file " << ConfigFile << "\n");
1791 return Style;
1792 }
1793 }
1794 llvm::errs() << "Can't find usable .clang-format, using " << FallbackStyle
1795 << " style\n";
Alexander Kornienkocabdd732013-11-29 15:19:43 +00001796 if (!UnsuitableConfigFiles.empty()) {
1797 llvm::errs() << "Configuration file(s) do(es) not support "
1798 << getLanguageName(Style.Language) << ": "
1799 << UnsuitableConfigFiles << "\n";
1800 }
Edwin Vaned544aa72013-09-30 13:31:48 +00001801 return Style;
1802}
1803
Daniel Jasper8d1832e2013-01-07 13:26:07 +00001804} // namespace format
1805} // namespace clang