blob: 1e7996e31ae6909e60af8fa2f0b28f1e5fd8b207 [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
Daniel Jasperde0328a2013-08-16 11:20:30 +000016#include "ContinuationIndenter.h"
Daniel Jasper7a6d09b2013-01-29 21:01:14 +000017#include "TokenAnnotator.h"
Daniel Jasper0df50932014-12-10 19:00:42 +000018#include "UnwrappedLineFormatter.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000019#include "UnwrappedLineParser.h"
Alexander Kornienkocb45bc12013-04-15 14:28:00 +000020#include "WhitespaceManager.h"
Daniel Jasperec04c0d2013-05-16 10:40:07 +000021#include "clang/Basic/Diagnostic.h"
Benjamin Kramerf3ca26982014-05-10 16:31:55 +000022#include "clang/Basic/DiagnosticOptions.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"
Birunthan Mohanathasb001a0b2015-07-03 17:25:16 +000030#include "llvm/Support/Regex.h"
Chandler Carruth5553d0d2014-01-07 11:51:46 +000031#include "llvm/Support/YAMLTraits.h"
Manuel Klimek2ef908e2013-02-13 10:46:36 +000032#include <queue>
Daniel Jasper8b529712012-12-04 13:02:32 +000033#include <string>
34
Chandler Carruth10346662014-04-22 03:17:02 +000035#define DEBUG_TYPE "format-formatter"
36
Alexander Kornienko6d2c88e2013-12-10 10:30:34 +000037using clang::format::FormatStyle;
38
Daniel Jaspere1e43192014-04-01 12:55:11 +000039LLVM_YAML_IS_FLOW_SEQUENCE_VECTOR(std::string)
40
Alexander Kornienkod6538332013-05-07 15:32:14 +000041namespace llvm {
42namespace yaml {
Alexander Kornienko6d2c88e2013-12-10 10:30:34 +000043template <> struct ScalarEnumerationTraits<FormatStyle::LanguageKind> {
44 static void enumeration(IO &IO, FormatStyle::LanguageKind &Value) {
45 IO.enumCase(Value, "Cpp", FormatStyle::LK_Cpp);
Daniel Jasperc58c70e2014-09-15 11:21:46 +000046 IO.enumCase(Value, "Java", FormatStyle::LK_Java);
Alexander Kornienko6d2c88e2013-12-10 10:30:34 +000047 IO.enumCase(Value, "JavaScript", FormatStyle::LK_JavaScript);
Daniel Jasper7052ce62014-01-19 09:04:08 +000048 IO.enumCase(Value, "Proto", FormatStyle::LK_Proto);
Alexander Kornienko6d2c88e2013-12-10 10:30:34 +000049 }
50};
51
52template <> struct ScalarEnumerationTraits<FormatStyle::LanguageStandard> {
53 static void enumeration(IO &IO, FormatStyle::LanguageStandard &Value) {
54 IO.enumCase(Value, "Cpp03", FormatStyle::LS_Cpp03);
55 IO.enumCase(Value, "C++03", FormatStyle::LS_Cpp03);
56 IO.enumCase(Value, "Cpp11", FormatStyle::LS_Cpp11);
57 IO.enumCase(Value, "C++11", FormatStyle::LS_Cpp11);
58 IO.enumCase(Value, "Auto", FormatStyle::LS_Auto);
59 }
60};
61
62template <> struct ScalarEnumerationTraits<FormatStyle::UseTabStyle> {
63 static void enumeration(IO &IO, FormatStyle::UseTabStyle &Value) {
64 IO.enumCase(Value, "Never", FormatStyle::UT_Never);
65 IO.enumCase(Value, "false", FormatStyle::UT_Never);
66 IO.enumCase(Value, "Always", FormatStyle::UT_Always);
67 IO.enumCase(Value, "true", FormatStyle::UT_Always);
68 IO.enumCase(Value, "ForIndentation", FormatStyle::UT_ForIndentation);
69 }
70};
71
Daniel Jasperd74cf402014-04-08 12:46:38 +000072template <> struct ScalarEnumerationTraits<FormatStyle::ShortFunctionStyle> {
73 static void enumeration(IO &IO, FormatStyle::ShortFunctionStyle &Value) {
74 IO.enumCase(Value, "None", FormatStyle::SFS_None);
75 IO.enumCase(Value, "false", FormatStyle::SFS_None);
76 IO.enumCase(Value, "All", FormatStyle::SFS_All);
77 IO.enumCase(Value, "true", FormatStyle::SFS_All);
78 IO.enumCase(Value, "Inline", FormatStyle::SFS_Inline);
Daniel Jasper9e709352014-11-26 10:43:58 +000079 IO.enumCase(Value, "Empty", FormatStyle::SFS_Empty);
Daniel Jasperd74cf402014-04-08 12:46:38 +000080 }
81};
82
Daniel Jasperac043c92014-09-15 11:11:00 +000083template <> struct ScalarEnumerationTraits<FormatStyle::BinaryOperatorStyle> {
84 static void enumeration(IO &IO, FormatStyle::BinaryOperatorStyle &Value) {
85 IO.enumCase(Value, "All", FormatStyle::BOS_All);
86 IO.enumCase(Value, "true", FormatStyle::BOS_All);
87 IO.enumCase(Value, "None", FormatStyle::BOS_None);
88 IO.enumCase(Value, "false", FormatStyle::BOS_None);
89 IO.enumCase(Value, "NonAssignment", FormatStyle::BOS_NonAssignment);
90 }
91};
92
Alexander Kornienko6d2c88e2013-12-10 10:30:34 +000093template <> struct ScalarEnumerationTraits<FormatStyle::BraceBreakingStyle> {
94 static void enumeration(IO &IO, FormatStyle::BraceBreakingStyle &Value) {
95 IO.enumCase(Value, "Attach", FormatStyle::BS_Attach);
96 IO.enumCase(Value, "Linux", FormatStyle::BS_Linux);
97 IO.enumCase(Value, "Stroustrup", FormatStyle::BS_Stroustrup);
98 IO.enumCase(Value, "Allman", FormatStyle::BS_Allman);
Alexander Kornienko3a33f022013-12-12 09:49:52 +000099 IO.enumCase(Value, "GNU", FormatStyle::BS_GNU);
Alexander Kornienko6d2c88e2013-12-10 10:30:34 +0000100 }
101};
102
Birunthan Mohanathasa0388a82015-06-29 15:30:42 +0000103template <> struct ScalarEnumerationTraits<FormatStyle::DefinitionReturnTypeBreakingStyle> {
104 static void enumeration(IO &IO, FormatStyle::DefinitionReturnTypeBreakingStyle &Value) {
105 IO.enumCase(Value, "None", FormatStyle::DRTBS_None);
106 IO.enumCase(Value, "All", FormatStyle::DRTBS_All);
107 IO.enumCase(Value, "TopLevel", FormatStyle::DRTBS_TopLevel);
108
109 // For backward compatibility.
110 IO.enumCase(Value, "false", FormatStyle::DRTBS_None);
111 IO.enumCase(Value, "true", FormatStyle::DRTBS_All);
112 }
113};
114
Alexander Kornienkod6538332013-05-07 15:32:14 +0000115template <>
Alexander Kornienko6d2c88e2013-12-10 10:30:34 +0000116struct ScalarEnumerationTraits<FormatStyle::NamespaceIndentationKind> {
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000117 static void enumeration(IO &IO,
Alexander Kornienko6d2c88e2013-12-10 10:30:34 +0000118 FormatStyle::NamespaceIndentationKind &Value) {
119 IO.enumCase(Value, "None", FormatStyle::NI_None);
120 IO.enumCase(Value, "Inner", FormatStyle::NI_Inner);
121 IO.enumCase(Value, "All", FormatStyle::NI_All);
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000122 }
123};
124
Jacques Pienaarfc275112015-02-18 23:48:37 +0000125template <> struct ScalarEnumerationTraits<FormatStyle::PointerAlignmentStyle> {
126 static void enumeration(IO &IO, FormatStyle::PointerAlignmentStyle &Value) {
Daniel Jasper553d4872014-06-17 12:40:34 +0000127 IO.enumCase(Value, "Middle", FormatStyle::PAS_Middle);
128 IO.enumCase(Value, "Left", FormatStyle::PAS_Left);
129 IO.enumCase(Value, "Right", FormatStyle::PAS_Right);
130
Alp Toker958027b2014-07-14 19:42:55 +0000131 // For backward compatibility.
Daniel Jasper553d4872014-06-17 12:40:34 +0000132 IO.enumCase(Value, "true", FormatStyle::PAS_Left);
133 IO.enumCase(Value, "false", FormatStyle::PAS_Right);
134 }
135};
136
137template <>
Alexander Kornienko6d2c88e2013-12-10 10:30:34 +0000138struct ScalarEnumerationTraits<FormatStyle::SpaceBeforeParensOptions> {
Manuel Klimeka8eb9142013-05-13 12:51:40 +0000139 static void enumeration(IO &IO,
Alexander Kornienko6d2c88e2013-12-10 10:30:34 +0000140 FormatStyle::SpaceBeforeParensOptions &Value) {
141 IO.enumCase(Value, "Never", FormatStyle::SBPO_Never);
Alexander Kornienkofdca83d2013-12-10 10:18:34 +0000142 IO.enumCase(Value, "ControlStatements",
Alexander Kornienko6d2c88e2013-12-10 10:30:34 +0000143 FormatStyle::SBPO_ControlStatements);
144 IO.enumCase(Value, "Always", FormatStyle::SBPO_Always);
Alexander Kornienkofdca83d2013-12-10 10:18:34 +0000145
146 // For backward compatibility.
Alexander Kornienko6d2c88e2013-12-10 10:30:34 +0000147 IO.enumCase(Value, "false", FormatStyle::SBPO_Never);
148 IO.enumCase(Value, "true", FormatStyle::SBPO_ControlStatements);
Alexander Kornienkofdca83d2013-12-10 10:18:34 +0000149 }
150};
151
Alexander Kornienko6d2c88e2013-12-10 10:30:34 +0000152template <> struct MappingTraits<FormatStyle> {
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000153 static void mapping(IO &IO, FormatStyle &Style) {
154 // When reading, read the language first, we need it for getPredefinedStyle.
155 IO.mapOptional("Language", Style.Language);
156
Alexander Kornienko49149672013-05-10 11:56:10 +0000157 if (IO.outputting()) {
Jacques Pienaarfc275112015-02-18 23:48:37 +0000158 StringRef StylesArray[] = {"LLVM", "Google", "Chromium",
159 "Mozilla", "WebKit", "GNU"};
Alexander Kornienko49149672013-05-10 11:56:10 +0000160 ArrayRef<StringRef> Styles(StylesArray);
161 for (size_t i = 0, e = Styles.size(); i < e; ++i) {
162 StringRef StyleName(Styles[i]);
Alexander Kornienko6d2c88e2013-12-10 10:30:34 +0000163 FormatStyle PredefinedStyle;
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000164 if (getPredefinedStyle(StyleName, Style.Language, &PredefinedStyle) &&
Alexander Kornienko006b5c82013-05-19 00:53:30 +0000165 Style == PredefinedStyle) {
Alexander Kornienko49149672013-05-10 11:56:10 +0000166 IO.mapOptional("# BasedOnStyle", StyleName);
167 break;
168 }
169 }
170 } else {
Alexander Kornienkod6538332013-05-07 15:32:14 +0000171 StringRef BasedOnStyle;
172 IO.mapOptional("BasedOnStyle", BasedOnStyle);
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000173 if (!BasedOnStyle.empty()) {
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000174 FormatStyle::LanguageKind OldLanguage = Style.Language;
175 FormatStyle::LanguageKind Language =
176 ((FormatStyle *)IO.getContext())->Language;
177 if (!getPredefinedStyle(BasedOnStyle, Language, &Style)) {
Alexander Kornienko006b5c82013-05-19 00:53:30 +0000178 IO.setError(Twine("Unknown value for BasedOnStyle: ", BasedOnStyle));
179 return;
180 }
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000181 Style.Language = OldLanguage;
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000182 }
Alexander Kornienkod6538332013-05-07 15:32:14 +0000183 }
184
Birunthan Mohanathas50a6f912015-06-28 14:52:34 +0000185 // For backward compatibility.
186 if (!IO.outputting()) {
187 IO.mapOptional("DerivePointerBinding", Style.DerivePointerAlignment);
188 IO.mapOptional("IndentFunctionDeclarationAfterType",
189 Style.IndentWrappedFunctionNames);
190 IO.mapOptional("PointerBindsToType", Style.PointerAlignment);
191 IO.mapOptional("SpaceAfterControlStatementKeyword",
192 Style.SpaceBeforeParens);
193 }
194
Alexander Kornienkod6538332013-05-07 15:32:14 +0000195 IO.mapOptional("AccessModifierOffset", Style.AccessModifierOffset);
Daniel Jasper3aa9a6a2014-11-18 23:55:27 +0000196 IO.mapOptional("AlignAfterOpenBracket", Style.AlignAfterOpenBracket);
Birunthan Mohanathas35cfbd72015-06-28 14:51:17 +0000197 IO.mapOptional("AlignConsecutiveAssignments",
198 Style.AlignConsecutiveAssignments);
Alexander Kornienkod6538332013-05-07 15:32:14 +0000199 IO.mapOptional("AlignEscapedNewlinesLeft", Style.AlignEscapedNewlinesLeft);
Daniel Jasper3219e432014-12-02 13:24:51 +0000200 IO.mapOptional("AlignOperands", Style.AlignOperands);
Daniel Jasper552f4a72013-07-31 23:55:15 +0000201 IO.mapOptional("AlignTrailingComments", Style.AlignTrailingComments);
Alexander Kornienkod6538332013-05-07 15:32:14 +0000202 IO.mapOptional("AllowAllParametersOfDeclarationOnNextLine",
203 Style.AllowAllParametersOfDeclarationOnNextLine);
Daniel Jasper17605d32014-05-14 09:33:35 +0000204 IO.mapOptional("AllowShortBlocksOnASingleLine",
205 Style.AllowShortBlocksOnASingleLine);
Daniel Jasperb87899b2014-09-10 13:11:45 +0000206 IO.mapOptional("AllowShortCaseLabelsOnASingleLine",
207 Style.AllowShortCaseLabelsOnASingleLine);
Birunthan Mohanathas35cfbd72015-06-28 14:51:17 +0000208 IO.mapOptional("AllowShortFunctionsOnASingleLine",
209 Style.AllowShortFunctionsOnASingleLine);
Alexander Kornienkod6538332013-05-07 15:32:14 +0000210 IO.mapOptional("AllowShortIfStatementsOnASingleLine",
211 Style.AllowShortIfStatementsOnASingleLine);
Daniel Jasper3a685df2013-05-16 12:12:21 +0000212 IO.mapOptional("AllowShortLoopsOnASingleLine",
213 Style.AllowShortLoopsOnASingleLine);
Daniel Jasperca4ea1c2014-08-05 12:16:31 +0000214 IO.mapOptional("AlwaysBreakAfterDefinitionReturnType",
215 Style.AlwaysBreakAfterDefinitionReturnType);
Alexander Kornienko58611712013-07-04 12:02:44 +0000216 IO.mapOptional("AlwaysBreakBeforeMultilineStrings",
217 Style.AlwaysBreakBeforeMultilineStrings);
Birunthan Mohanathas35cfbd72015-06-28 14:51:17 +0000218 IO.mapOptional("AlwaysBreakTemplateDeclarations",
219 Style.AlwaysBreakTemplateDeclarations);
220 IO.mapOptional("BinPackArguments", Style.BinPackArguments);
221 IO.mapOptional("BinPackParameters", Style.BinPackParameters);
Daniel Jaspere33d4af2013-07-26 16:56:36 +0000222 IO.mapOptional("BreakBeforeBinaryOperators",
223 Style.BreakBeforeBinaryOperators);
Birunthan Mohanathas35cfbd72015-06-28 14:51:17 +0000224 IO.mapOptional("BreakBeforeBraces", Style.BreakBeforeBraces);
Daniel Jasper165b29e2013-11-08 00:57:11 +0000225 IO.mapOptional("BreakBeforeTernaryOperators",
226 Style.BreakBeforeTernaryOperators);
Daniel Jaspere33d4af2013-07-26 16:56:36 +0000227 IO.mapOptional("BreakConstructorInitializersBeforeComma",
228 Style.BreakConstructorInitializersBeforeComma);
Alexander Kornienkod6538332013-05-07 15:32:14 +0000229 IO.mapOptional("ColumnLimit", Style.ColumnLimit);
Birunthan Mohanathas35cfbd72015-06-28 14:51:17 +0000230 IO.mapOptional("CommentPragmas", Style.CommentPragmas);
Alexander Kornienkod6538332013-05-07 15:32:14 +0000231 IO.mapOptional("ConstructorInitializerAllOnOneLineOrOnePerLine",
232 Style.ConstructorInitializerAllOnOneLineOrOnePerLine);
Daniel Jasper50d634b2014-10-28 16:53:38 +0000233 IO.mapOptional("ConstructorInitializerIndentWidth",
234 Style.ConstructorInitializerIndentWidth);
Birunthan Mohanathas35cfbd72015-06-28 14:51:17 +0000235 IO.mapOptional("ContinuationIndentWidth", Style.ContinuationIndentWidth);
236 IO.mapOptional("Cpp11BracedListStyle", Style.Cpp11BracedListStyle);
Daniel Jasper553d4872014-06-17 12:40:34 +0000237 IO.mapOptional("DerivePointerAlignment", Style.DerivePointerAlignment);
Birunthan Mohanathas35cfbd72015-06-28 14:51:17 +0000238 IO.mapOptional("DisableFormat", Style.DisableFormat);
Daniel Jasperb10cbc42013-07-10 14:02:49 +0000239 IO.mapOptional("ExperimentalAutoDetectBinPacking",
240 Style.ExperimentalAutoDetectBinPacking);
Birunthan Mohanathas35cfbd72015-06-28 14:51:17 +0000241 IO.mapOptional("ForEachMacros", Style.ForEachMacros);
Alexander Kornienkod6538332013-05-07 15:32:14 +0000242 IO.mapOptional("IndentCaseLabels", Style.IndentCaseLabels);
Birunthan Mohanathas35cfbd72015-06-28 14:51:17 +0000243 IO.mapOptional("IndentWidth", Style.IndentWidth);
244 IO.mapOptional("IndentWrappedFunctionNames",
245 Style.IndentWrappedFunctionNames);
Daniel Jaspera26fc5c2014-03-21 13:43:14 +0000246 IO.mapOptional("KeepEmptyLinesAtTheStartOfBlocks",
247 Style.KeepEmptyLinesAtTheStartOfBlocks);
Birunthan Mohanathasb001a0b2015-07-03 17:25:16 +0000248 IO.mapOptional("MacroBlockBegin", Style.MacroBlockBegin);
249 IO.mapOptional("MacroBlockEnd", Style.MacroBlockEnd);
Birunthan Mohanathas35cfbd72015-06-28 14:51:17 +0000250 IO.mapOptional("MaxEmptyLinesToKeep", Style.MaxEmptyLinesToKeep);
Daniel Jasper65ee3472013-07-31 23:16:02 +0000251 IO.mapOptional("NamespaceIndentation", Style.NamespaceIndentation);
Daniel Jasper50d634b2014-10-28 16:53:38 +0000252 IO.mapOptional("ObjCBlockIndentWidth", Style.ObjCBlockIndentWidth);
Daniel Jaspere9beea22014-01-28 15:20:33 +0000253 IO.mapOptional("ObjCSpaceAfterProperty", Style.ObjCSpaceAfterProperty);
Alexander Kornienkod6538332013-05-07 15:32:14 +0000254 IO.mapOptional("ObjCSpaceBeforeProtocolList",
255 Style.ObjCSpaceBeforeProtocolList);
Daniel Jasper33b909c2013-10-25 14:29:37 +0000256 IO.mapOptional("PenaltyBreakBeforeFirstCallParameter",
257 Style.PenaltyBreakBeforeFirstCallParameter);
Alexander Kornienkodd7ece52013-06-07 16:02:52 +0000258 IO.mapOptional("PenaltyBreakComment", Style.PenaltyBreakComment);
Daniel Jasper4e9678f2013-07-11 20:41:21 +0000259 IO.mapOptional("PenaltyBreakFirstLessLess",
260 Style.PenaltyBreakFirstLessLess);
Birunthan Mohanathas35cfbd72015-06-28 14:51:17 +0000261 IO.mapOptional("PenaltyBreakString", Style.PenaltyBreakString);
Alexander Kornienkod6538332013-05-07 15:32:14 +0000262 IO.mapOptional("PenaltyExcessCharacter", Style.PenaltyExcessCharacter);
263 IO.mapOptional("PenaltyReturnTypeOnItsOwnLine",
264 Style.PenaltyReturnTypeOnItsOwnLine);
Daniel Jasper553d4872014-06-17 12:40:34 +0000265 IO.mapOptional("PointerAlignment", Style.PointerAlignment);
Daniel Jasperdb986eb2014-09-03 07:37:29 +0000266 IO.mapOptional("SpaceAfterCStyleCast", Style.SpaceAfterCStyleCast);
Daniel Jasperd94bff32013-09-25 15:15:02 +0000267 IO.mapOptional("SpaceBeforeAssignmentOperators",
268 Style.SpaceBeforeAssignmentOperators);
Birunthan Mohanathas35cfbd72015-06-28 14:51:17 +0000269 IO.mapOptional("SpaceBeforeParens", Style.SpaceBeforeParens);
270 IO.mapOptional("SpaceInEmptyParentheses", Style.SpaceInEmptyParentheses);
271 IO.mapOptional("SpacesBeforeTrailingComments",
272 Style.SpacesBeforeTrailingComments);
273 IO.mapOptional("SpacesInAngles", Style.SpacesInAngles);
274 IO.mapOptional("SpacesInContainerLiterals",
275 Style.SpacesInContainerLiterals);
276 IO.mapOptional("SpacesInCStyleCastParentheses",
277 Style.SpacesInCStyleCastParentheses);
278 IO.mapOptional("SpacesInParentheses", Style.SpacesInParentheses);
279 IO.mapOptional("SpacesInSquareBrackets", Style.SpacesInSquareBrackets);
280 IO.mapOptional("Standard", Style.Standard);
281 IO.mapOptional("TabWidth", Style.TabWidth);
282 IO.mapOptional("UseTab", Style.UseTab);
Alexander Kornienkod6538332013-05-07 15:32:14 +0000283 }
284};
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000285
286// Allows to read vector<FormatStyle> while keeping default values.
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000287// IO.getContext() should contain a pointer to the FormatStyle structure, that
288// will be used to get default values for missing keys.
289// If the first element has no Language specified, it will be treated as the
290// default one for the following elements.
Jacques Pienaarfc275112015-02-18 23:48:37 +0000291template <> struct DocumentListTraits<std::vector<FormatStyle>> {
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000292 static size_t size(IO &IO, std::vector<FormatStyle> &Seq) {
293 return Seq.size();
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000294 }
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000295 static FormatStyle &element(IO &IO, std::vector<FormatStyle> &Seq,
Alexander Kornienko6d2c88e2013-12-10 10:30:34 +0000296 size_t Index) {
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000297 if (Index >= Seq.size()) {
298 assert(Index == Seq.size());
Alexander Kornienko6d2c88e2013-12-10 10:30:34 +0000299 FormatStyle Template;
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000300 if (Seq.size() > 0 && Seq[0].Language == FormatStyle::LK_None) {
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000301 Template = Seq[0];
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000302 } else {
Daniel Jasperb05a81d2014-05-09 13:11:16 +0000303 Template = *((const FormatStyle *)IO.getContext());
Alexander Kornienko6d2c88e2013-12-10 10:30:34 +0000304 Template.Language = FormatStyle::LK_None;
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000305 }
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000306 Seq.resize(Index + 1, Template);
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000307 }
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000308 return Seq[Index];
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000309 }
310};
Alexander Kornienkoab9db512015-06-22 23:07:51 +0000311}
312}
Alexander Kornienkod6538332013-05-07 15:32:14 +0000313
Daniel Jasperf7935112012-12-03 18:12:45 +0000314namespace clang {
315namespace format {
316
Rafael Espindola6d0d89b2014-06-12 03:31:26 +0000317const std::error_category &getParseCategory() {
Rafael Espindolad0136702014-06-12 02:50:04 +0000318 static ParseErrorCategory C;
319 return C;
320}
321std::error_code make_error_code(ParseError e) {
Rafael Espindola6d0d89b2014-06-12 03:31:26 +0000322 return std::error_code(static_cast<int>(e), getParseCategory());
Rafael Espindolad0136702014-06-12 02:50:04 +0000323}
324
325const char *ParseErrorCategory::name() const LLVM_NOEXCEPT {
326 return "clang-format.parse_error";
327}
328
329std::string ParseErrorCategory::message(int EV) const {
330 switch (static_cast<ParseError>(EV)) {
331 case ParseError::Success:
332 return "Success";
333 case ParseError::Error:
334 return "Invalid argument";
335 case ParseError::Unsuitable:
336 return "Unsuitable";
337 }
Saleem Abdulrasoolfbfbaf62014-06-12 19:33:26 +0000338 llvm_unreachable("unexpected parse error");
Rafael Espindolad0136702014-06-12 02:50:04 +0000339}
340
Daniel Jasperf7935112012-12-03 18:12:45 +0000341FormatStyle getLLVMStyle() {
342 FormatStyle LLVMStyle;
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000343 LLVMStyle.Language = FormatStyle::LK_Cpp;
Daniel Jasperf7935112012-12-03 18:12:45 +0000344 LLVMStyle.AccessModifierOffset = -2;
Alexander Kornienkoc8602662013-05-06 14:11:27 +0000345 LLVMStyle.AlignEscapedNewlinesLeft = false;
Daniel Jasper3aa9a6a2014-11-18 23:55:27 +0000346 LLVMStyle.AlignAfterOpenBracket = true;
Daniel Jasper3219e432014-12-02 13:24:51 +0000347 LLVMStyle.AlignOperands = true;
Daniel Jasper552f4a72013-07-31 23:55:15 +0000348 LLVMStyle.AlignTrailingComments = true;
Daniel Jaspera44991332015-04-29 13:06:49 +0000349 LLVMStyle.AlignConsecutiveAssignments = false;
Daniel Jasperf7db4332013-01-29 16:03:49 +0000350 LLVMStyle.AllowAllParametersOfDeclarationOnNextLine = true;
Daniel Jasperd74cf402014-04-08 12:46:38 +0000351 LLVMStyle.AllowShortFunctionsOnASingleLine = FormatStyle::SFS_All;
Daniel Jasper17605d32014-05-14 09:33:35 +0000352 LLVMStyle.AllowShortBlocksOnASingleLine = false;
Daniel Jasperb87899b2014-09-10 13:11:45 +0000353 LLVMStyle.AllowShortCaseLabelsOnASingleLine = false;
Daniel Jasper1b750ed2013-01-14 16:24:39 +0000354 LLVMStyle.AllowShortIfStatementsOnASingleLine = false;
Daniel Jasper3a685df2013-05-16 12:12:21 +0000355 LLVMStyle.AllowShortLoopsOnASingleLine = false;
Birunthan Mohanathasa0388a82015-06-29 15:30:42 +0000356 LLVMStyle.AlwaysBreakAfterDefinitionReturnType = FormatStyle::DRTBS_None;
Alexander Kornienko58611712013-07-04 12:02:44 +0000357 LLVMStyle.AlwaysBreakBeforeMultilineStrings = false;
Daniel Jaspere33d4af2013-07-26 16:56:36 +0000358 LLVMStyle.AlwaysBreakTemplateDeclarations = false;
Alexander Kornienkoc8602662013-05-06 14:11:27 +0000359 LLVMStyle.BinPackParameters = true;
Daniel Jasper18210d72014-10-09 09:52:05 +0000360 LLVMStyle.BinPackArguments = true;
Daniel Jasperac043c92014-09-15 11:11:00 +0000361 LLVMStyle.BreakBeforeBinaryOperators = FormatStyle::BOS_None;
Daniel Jasper165b29e2013-11-08 00:57:11 +0000362 LLVMStyle.BreakBeforeTernaryOperators = true;
Daniel Jaspere33d4af2013-07-26 16:56:36 +0000363 LLVMStyle.BreakBeforeBraces = FormatStyle::BS_Attach;
364 LLVMStyle.BreakConstructorInitializersBeforeComma = false;
Alexander Kornienkoc8602662013-05-06 14:11:27 +0000365 LLVMStyle.ColumnLimit = 80;
Daniel Jaspere1e43192014-04-01 12:55:11 +0000366 LLVMStyle.CommentPragmas = "^ IWYU pragma:";
Alexander Kornienkoc8602662013-05-06 14:11:27 +0000367 LLVMStyle.ConstructorInitializerAllOnOneLineOrOnePerLine = false;
Daniel Jaspercdaffa42013-08-13 10:58:30 +0000368 LLVMStyle.ConstructorInitializerIndentWidth = 4;
Daniel Jaspere1e43192014-04-01 12:55:11 +0000369 LLVMStyle.ContinuationIndentWidth = 4;
Chandler Carruthf8b72662014-03-02 12:37:31 +0000370 LLVMStyle.Cpp11BracedListStyle = true;
Daniel Jasper553d4872014-06-17 12:40:34 +0000371 LLVMStyle.DerivePointerAlignment = false;
Daniel Jasperb10cbc42013-07-10 14:02:49 +0000372 LLVMStyle.ExperimentalAutoDetectBinPacking = false;
Daniel Jaspere1e43192014-04-01 12:55:11 +0000373 LLVMStyle.ForEachMacros.push_back("foreach");
374 LLVMStyle.ForEachMacros.push_back("Q_FOREACH");
375 LLVMStyle.ForEachMacros.push_back("BOOST_FOREACH");
Alexander Kornienkoc8602662013-05-06 14:11:27 +0000376 LLVMStyle.IndentCaseLabels = false;
Daniel Jasperc75e1ef2014-07-09 08:42:42 +0000377 LLVMStyle.IndentWrappedFunctionNames = false;
Daniel Jaspere33d4af2013-07-26 16:56:36 +0000378 LLVMStyle.IndentWidth = 2;
Alexander Kornienkoebb43ca2013-09-05 14:08:34 +0000379 LLVMStyle.TabWidth = 8;
Alexander Kornienkoc8602662013-05-06 14:11:27 +0000380 LLVMStyle.MaxEmptyLinesToKeep = 1;
Daniel Jaspera26fc5c2014-03-21 13:43:14 +0000381 LLVMStyle.KeepEmptyLinesAtTheStartOfBlocks = true;
Daniel Jasper65ee3472013-07-31 23:16:02 +0000382 LLVMStyle.NamespaceIndentation = FormatStyle::NI_None;
Daniel Jasper50d634b2014-10-28 16:53:38 +0000383 LLVMStyle.ObjCBlockIndentWidth = 2;
Daniel Jaspere9beea22014-01-28 15:20:33 +0000384 LLVMStyle.ObjCSpaceAfterProperty = false;
Nico Webera6087752013-01-10 20:12:55 +0000385 LLVMStyle.ObjCSpaceBeforeProtocolList = true;
Daniel Jasper553d4872014-06-17 12:40:34 +0000386 LLVMStyle.PointerAlignment = FormatStyle::PAS_Right;
Alexander Kornienkoc8602662013-05-06 14:11:27 +0000387 LLVMStyle.SpacesBeforeTrailingComments = 1;
Chandler Carruthf8b72662014-03-02 12:37:31 +0000388 LLVMStyle.Standard = FormatStyle::LS_Cpp11;
Alexander Kornienko3c3d09c2013-09-27 16:14:22 +0000389 LLVMStyle.UseTab = FormatStyle::UT_Never;
Daniel Jasperb55acad2013-08-20 12:36:34 +0000390 LLVMStyle.SpacesInParentheses = false;
Daniel Jasperad981f82014-08-26 11:41:14 +0000391 LLVMStyle.SpacesInSquareBrackets = false;
Daniel Jasperb55acad2013-08-20 12:36:34 +0000392 LLVMStyle.SpaceInEmptyParentheses = false;
Daniel Jasperb2e10a52014-01-15 15:09:08 +0000393 LLVMStyle.SpacesInContainerLiterals = true;
Daniel Jasperb55acad2013-08-20 12:36:34 +0000394 LLVMStyle.SpacesInCStyleCastParentheses = false;
Daniel Jasperdb986eb2014-09-03 07:37:29 +0000395 LLVMStyle.SpaceAfterCStyleCast = false;
Alexander Kornienkofdca83d2013-12-10 10:18:34 +0000396 LLVMStyle.SpaceBeforeParens = FormatStyle::SBPO_ControlStatements;
Daniel Jasperd94bff32013-09-25 15:15:02 +0000397 LLVMStyle.SpaceBeforeAssignmentOperators = true;
Daniel Jasperdd978ae2013-10-29 14:52:02 +0000398 LLVMStyle.SpacesInAngles = false;
Daniel Jasper4e9678f2013-07-11 20:41:21 +0000399
Daniel Jasper19a541e2013-12-19 16:45:34 +0000400 LLVMStyle.PenaltyBreakComment = 300;
Alexander Kornienkofe7a57f2013-12-10 15:42:15 +0000401 LLVMStyle.PenaltyBreakFirstLessLess = 120;
402 LLVMStyle.PenaltyBreakString = 1000;
403 LLVMStyle.PenaltyExcessCharacter = 1000000;
Daniel Jasper4e9678f2013-07-11 20:41:21 +0000404 LLVMStyle.PenaltyReturnTypeOnItsOwnLine = 60;
Daniel Jasper33b909c2013-10-25 14:29:37 +0000405 LLVMStyle.PenaltyBreakBeforeFirstCallParameter = 19;
Daniel Jasper4e9678f2013-07-11 20:41:21 +0000406
Daniel Jasperc64b09a2014-05-22 15:12:22 +0000407 LLVMStyle.DisableFormat = false;
408
Daniel Jasperf7935112012-12-03 18:12:45 +0000409 return LLVMStyle;
410}
411
Nico Weber514ecc82014-02-02 20:50:45 +0000412FormatStyle getGoogleStyle(FormatStyle::LanguageKind Language) {
Alexander Kornienkofe7a57f2013-12-10 15:42:15 +0000413 FormatStyle GoogleStyle = getLLVMStyle();
Nico Weber514ecc82014-02-02 20:50:45 +0000414 GoogleStyle.Language = Language;
415
Daniel Jasperf7935112012-12-03 18:12:45 +0000416 GoogleStyle.AccessModifierOffset = -1;
Alexander Kornienkoc8602662013-05-06 14:11:27 +0000417 GoogleStyle.AlignEscapedNewlinesLeft = true;
Daniel Jasper085a2ed2013-04-24 13:46:00 +0000418 GoogleStyle.AllowShortIfStatementsOnASingleLine = true;
Daniel Jasper5bd0b9e2013-05-23 18:05:18 +0000419 GoogleStyle.AllowShortLoopsOnASingleLine = true;
Alexander Kornienko58611712013-07-04 12:02:44 +0000420 GoogleStyle.AlwaysBreakBeforeMultilineStrings = true;
Daniel Jaspere33d4af2013-07-26 16:56:36 +0000421 GoogleStyle.AlwaysBreakTemplateDeclarations = true;
Alexander Kornienkoc8602662013-05-06 14:11:27 +0000422 GoogleStyle.ConstructorInitializerAllOnOneLineOrOnePerLine = true;
Daniel Jasper553d4872014-06-17 12:40:34 +0000423 GoogleStyle.DerivePointerAlignment = true;
Alexander Kornienkoc8602662013-05-06 14:11:27 +0000424 GoogleStyle.IndentCaseLabels = true;
Daniel Jaspera26fc5c2014-03-21 13:43:14 +0000425 GoogleStyle.KeepEmptyLinesAtTheStartOfBlocks = false;
Daniel Jaspere9beea22014-01-28 15:20:33 +0000426 GoogleStyle.ObjCSpaceAfterProperty = false;
Nico Webera6087752013-01-10 20:12:55 +0000427 GoogleStyle.ObjCSpaceBeforeProtocolList = false;
Daniel Jasper553d4872014-06-17 12:40:34 +0000428 GoogleStyle.PointerAlignment = FormatStyle::PAS_Left;
Alexander Kornienkoc8602662013-05-06 14:11:27 +0000429 GoogleStyle.SpacesBeforeTrailingComments = 2;
430 GoogleStyle.Standard = FormatStyle::LS_Auto;
Daniel Jasper4e9678f2013-07-11 20:41:21 +0000431
Daniel Jasper4e9678f2013-07-11 20:41:21 +0000432 GoogleStyle.PenaltyReturnTypeOnItsOwnLine = 200;
Daniel Jasper33b909c2013-10-25 14:29:37 +0000433 GoogleStyle.PenaltyBreakBeforeFirstCallParameter = 1;
Daniel Jasper4e9678f2013-07-11 20:41:21 +0000434
Daniel Jasperc58c70e2014-09-15 11:21:46 +0000435 if (Language == FormatStyle::LK_Java) {
Daniel Jasper3aa9a6a2014-11-18 23:55:27 +0000436 GoogleStyle.AlignAfterOpenBracket = false;
Daniel Jasper3219e432014-12-02 13:24:51 +0000437 GoogleStyle.AlignOperands = false;
Daniel Jasperfd4ed182015-01-04 20:40:45 +0000438 GoogleStyle.AlignTrailingComments = false;
Daniel Jasper9e709352014-11-26 10:43:58 +0000439 GoogleStyle.AllowShortFunctionsOnASingleLine = FormatStyle::SFS_Empty;
Daniel Jasperfd4ed182015-01-04 20:40:45 +0000440 GoogleStyle.AllowShortIfStatementsOnASingleLine = false;
Daniel Jasper1cd3c712015-01-14 12:24:59 +0000441 GoogleStyle.AlwaysBreakBeforeMultilineStrings = false;
Daniel Jasperc58c70e2014-09-15 11:21:46 +0000442 GoogleStyle.BreakBeforeBinaryOperators = FormatStyle::BOS_NonAssignment;
443 GoogleStyle.ColumnLimit = 100;
444 GoogleStyle.SpaceAfterCStyleCast = true;
Daniel Jasper61d81972014-11-14 08:22:46 +0000445 GoogleStyle.SpacesBeforeTrailingComments = 1;
Daniel Jasperc58c70e2014-09-15 11:21:46 +0000446 } else if (Language == FormatStyle::LK_JavaScript) {
Daniel Jaspere551bb72014-11-05 17:22:31 +0000447 GoogleStyle.BreakBeforeTernaryOperators = false;
Daniel Jasper8f83a902014-05-09 10:28:58 +0000448 GoogleStyle.MaxEmptyLinesToKeep = 3;
Nico Weber514ecc82014-02-02 20:50:45 +0000449 GoogleStyle.SpacesInContainerLiterals = false;
Daniel Jasper67f8ad22014-09-30 17:57:06 +0000450 GoogleStyle.AllowShortFunctionsOnASingleLine = FormatStyle::SFS_Inline;
Daniel Jasper1cd3c712015-01-14 12:24:59 +0000451 GoogleStyle.AlwaysBreakBeforeMultilineStrings = false;
Nico Weber514ecc82014-02-02 20:50:45 +0000452 } else if (Language == FormatStyle::LK_Proto) {
Daniel Jasperd74cf402014-04-08 12:46:38 +0000453 GoogleStyle.AllowShortFunctionsOnASingleLine = FormatStyle::SFS_None;
Daniel Jasper783bac62014-04-15 09:54:30 +0000454 GoogleStyle.SpacesInContainerLiterals = false;
Nico Weber514ecc82014-02-02 20:50:45 +0000455 }
456
Daniel Jasperf7935112012-12-03 18:12:45 +0000457 return GoogleStyle;
458}
459
Nico Weber514ecc82014-02-02 20:50:45 +0000460FormatStyle getChromiumStyle(FormatStyle::LanguageKind Language) {
461 FormatStyle ChromiumStyle = getGoogleStyle(Language);
Nico Weber450425c2014-11-26 16:43:18 +0000462 if (Language == FormatStyle::LK_Java) {
Daniel Jasperfd4ed182015-01-04 20:40:45 +0000463 ChromiumStyle.AllowShortIfStatementsOnASingleLine = true;
Nico Weber450425c2014-11-26 16:43:18 +0000464 ChromiumStyle.IndentWidth = 4;
465 ChromiumStyle.ContinuationIndentWidth = 8;
466 } else {
467 ChromiumStyle.AllowAllParametersOfDeclarationOnNextLine = false;
468 ChromiumStyle.AllowShortFunctionsOnASingleLine = FormatStyle::SFS_Inline;
469 ChromiumStyle.AllowShortIfStatementsOnASingleLine = false;
470 ChromiumStyle.AllowShortLoopsOnASingleLine = false;
471 ChromiumStyle.BinPackParameters = false;
472 ChromiumStyle.DerivePointerAlignment = false;
473 }
Birunthan Mohanathasb001a0b2015-07-03 17:25:16 +0000474 ChromiumStyle.MacroBlockBegin = "^IPC_BEGIN_MESSAGE_MAP$";
475 ChromiumStyle.MacroBlockBegin = "^IPC_END_MESSAGE_MAP$";
Daniel Jasper1b750ed2013-01-14 16:24:39 +0000476 return ChromiumStyle;
477}
478
Alexander Kornienkoc8602662013-05-06 14:11:27 +0000479FormatStyle getMozillaStyle() {
480 FormatStyle MozillaStyle = getLLVMStyle();
481 MozillaStyle.AllowAllParametersOfDeclarationOnNextLine = false;
Birunthan Mohanathasa0810022015-06-29 15:18:58 +0000482 MozillaStyle.AllowShortFunctionsOnASingleLine = FormatStyle::SFS_Inline;
Birunthan Mohanathasa0388a82015-06-29 15:30:42 +0000483 MozillaStyle.AlwaysBreakAfterDefinitionReturnType =
484 FormatStyle::DRTBS_TopLevel;
Birunthan Mohanathasa0810022015-06-29 15:18:58 +0000485 MozillaStyle.AlwaysBreakTemplateDeclarations = true;
486 MozillaStyle.BreakConstructorInitializersBeforeComma = true;
487 MozillaStyle.ConstructorInitializerIndentWidth = 2;
488 MozillaStyle.ContinuationIndentWidth = 2;
Chandler Carruthf8b72662014-03-02 12:37:31 +0000489 MozillaStyle.Cpp11BracedListStyle = false;
Alexander Kornienkoc8602662013-05-06 14:11:27 +0000490 MozillaStyle.IndentCaseLabels = true;
Daniel Jaspere9beea22014-01-28 15:20:33 +0000491 MozillaStyle.ObjCSpaceAfterProperty = true;
Alexander Kornienkoc8602662013-05-06 14:11:27 +0000492 MozillaStyle.ObjCSpaceBeforeProtocolList = false;
493 MozillaStyle.PenaltyReturnTypeOnItsOwnLine = 200;
Daniel Jasper553d4872014-06-17 12:40:34 +0000494 MozillaStyle.PointerAlignment = FormatStyle::PAS_Left;
Alexander Kornienkoc8602662013-05-06 14:11:27 +0000495 return MozillaStyle;
496}
497
Daniel Jasperffefb3d2013-07-24 13:10:59 +0000498FormatStyle getWebKitStyle() {
499 FormatStyle Style = getLLVMStyle();
Daniel Jasper65ee3472013-07-31 23:16:02 +0000500 Style.AccessModifierOffset = -4;
Daniel Jasper3aa9a6a2014-11-18 23:55:27 +0000501 Style.AlignAfterOpenBracket = false;
Daniel Jasper3219e432014-12-02 13:24:51 +0000502 Style.AlignOperands = false;
Daniel Jasper552f4a72013-07-31 23:55:15 +0000503 Style.AlignTrailingComments = false;
Daniel Jasperac043c92014-09-15 11:11:00 +0000504 Style.BreakBeforeBinaryOperators = FormatStyle::BOS_All;
Daniel Jasper65ee3472013-07-31 23:16:02 +0000505 Style.BreakBeforeBraces = FormatStyle::BS_Stroustrup;
Daniel Jaspere33d4af2013-07-26 16:56:36 +0000506 Style.BreakConstructorInitializersBeforeComma = true;
Chandler Carruthf8b72662014-03-02 12:37:31 +0000507 Style.Cpp11BracedListStyle = false;
Daniel Jasper65ee3472013-07-31 23:16:02 +0000508 Style.ColumnLimit = 0;
Daniel Jaspere33d4af2013-07-26 16:56:36 +0000509 Style.IndentWidth = 4;
Daniel Jasper65ee3472013-07-31 23:16:02 +0000510 Style.NamespaceIndentation = FormatStyle::NI_Inner;
Daniel Jasper50d634b2014-10-28 16:53:38 +0000511 Style.ObjCBlockIndentWidth = 4;
Daniel Jaspere9beea22014-01-28 15:20:33 +0000512 Style.ObjCSpaceAfterProperty = true;
Daniel Jasper553d4872014-06-17 12:40:34 +0000513 Style.PointerAlignment = FormatStyle::PAS_Left;
Chandler Carruthf8b72662014-03-02 12:37:31 +0000514 Style.Standard = FormatStyle::LS_Cpp03;
Daniel Jasperffefb3d2013-07-24 13:10:59 +0000515 return Style;
516}
517
Alexander Kornienkofe7a57f2013-12-10 15:42:15 +0000518FormatStyle getGNUStyle() {
519 FormatStyle Style = getLLVMStyle();
Birunthan Mohanathasa0388a82015-06-29 15:30:42 +0000520 Style.AlwaysBreakAfterDefinitionReturnType = FormatStyle::DRTBS_All;
Daniel Jasperac043c92014-09-15 11:11:00 +0000521 Style.BreakBeforeBinaryOperators = FormatStyle::BOS_All;
Alexander Kornienko3a33f022013-12-12 09:49:52 +0000522 Style.BreakBeforeBraces = FormatStyle::BS_GNU;
Alexander Kornienkofe7a57f2013-12-10 15:42:15 +0000523 Style.BreakBeforeTernaryOperators = true;
Chandler Carruthf8b72662014-03-02 12:37:31 +0000524 Style.Cpp11BracedListStyle = false;
Alexander Kornienkofe7a57f2013-12-10 15:42:15 +0000525 Style.ColumnLimit = 79;
Alexander Kornienkofe7a57f2013-12-10 15:42:15 +0000526 Style.SpaceBeforeParens = FormatStyle::SBPO_Always;
Chandler Carruthf8b72662014-03-02 12:37:31 +0000527 Style.Standard = FormatStyle::LS_Cpp03;
Alexander Kornienkofe7a57f2013-12-10 15:42:15 +0000528 return Style;
529}
530
Daniel Jasperc64b09a2014-05-22 15:12:22 +0000531FormatStyle getNoStyle() {
532 FormatStyle NoStyle = getLLVMStyle();
533 NoStyle.DisableFormat = true;
534 return NoStyle;
535}
536
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000537bool getPredefinedStyle(StringRef Name, FormatStyle::LanguageKind Language,
538 FormatStyle *Style) {
539 if (Name.equals_lower("llvm")) {
Alexander Kornienko006b5c82013-05-19 00:53:30 +0000540 *Style = getLLVMStyle();
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000541 } else if (Name.equals_lower("chromium")) {
Nico Weber514ecc82014-02-02 20:50:45 +0000542 *Style = getChromiumStyle(Language);
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000543 } else if (Name.equals_lower("mozilla")) {
Alexander Kornienko006b5c82013-05-19 00:53:30 +0000544 *Style = getMozillaStyle();
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000545 } else if (Name.equals_lower("google")) {
Nico Weber514ecc82014-02-02 20:50:45 +0000546 *Style = getGoogleStyle(Language);
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000547 } else if (Name.equals_lower("webkit")) {
Daniel Jasperffefb3d2013-07-24 13:10:59 +0000548 *Style = getWebKitStyle();
Alexander Kornienkofe7a57f2013-12-10 15:42:15 +0000549 } else if (Name.equals_lower("gnu")) {
550 *Style = getGNUStyle();
Daniel Jasperc64b09a2014-05-22 15:12:22 +0000551 } else if (Name.equals_lower("none")) {
552 *Style = getNoStyle();
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000553 } else {
Alexander Kornienko006b5c82013-05-19 00:53:30 +0000554 return false;
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000555 }
Alexander Kornienkod6538332013-05-07 15:32:14 +0000556
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000557 Style->Language = Language;
Alexander Kornienko006b5c82013-05-19 00:53:30 +0000558 return true;
Alexander Kornienkod6538332013-05-07 15:32:14 +0000559}
560
Rafael Espindolac0809172014-06-12 14:02:15 +0000561std::error_code parseConfiguration(StringRef Text, FormatStyle *Style) {
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000562 assert(Style);
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000563 FormatStyle::LanguageKind Language = Style->Language;
564 assert(Language != FormatStyle::LK_None);
Alexander Kornienko06e00332013-05-20 15:18:01 +0000565 if (Text.trim().empty())
Rafael Espindolad0136702014-06-12 02:50:04 +0000566 return make_error_code(ParseError::Error);
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000567
568 std::vector<FormatStyle> Styles;
Alexander Kornienkod6538332013-05-07 15:32:14 +0000569 llvm::yaml::Input Input(Text);
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000570 // DocumentListTraits<vector<FormatStyle>> uses the context to get default
571 // values for the fields, keys for which are missing from the configuration.
572 // Mapping also uses the context to get the language to find the correct
573 // base style.
574 Input.setContext(Style);
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000575 Input >> Styles;
576 if (Input.error())
577 return Input.error();
578
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000579 for (unsigned i = 0; i < Styles.size(); ++i) {
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000580 // Ensures that only the first configuration can skip the Language option.
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000581 if (Styles[i].Language == FormatStyle::LK_None && i != 0)
Rafael Espindolad0136702014-06-12 02:50:04 +0000582 return make_error_code(ParseError::Error);
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000583 // Ensure that each language is configured at most once.
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000584 for (unsigned j = 0; j < i; ++j) {
585 if (Styles[i].Language == Styles[j].Language) {
586 DEBUG(llvm::dbgs()
587 << "Duplicate languages in the config file on positions " << j
588 << " and " << i << "\n");
Rafael Espindolad0136702014-06-12 02:50:04 +0000589 return make_error_code(ParseError::Error);
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000590 }
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000591 }
592 }
593 // Look for a suitable configuration starting from the end, so we can
594 // find the configuration for the specific language first, and the default
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000595 // configuration (which can only be at slot 0) after it.
596 for (int i = Styles.size() - 1; i >= 0; --i) {
597 if (Styles[i].Language == Language ||
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000598 Styles[i].Language == FormatStyle::LK_None) {
599 *Style = Styles[i];
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000600 Style->Language = Language;
Rafael Espindolad0136702014-06-12 02:50:04 +0000601 return make_error_code(ParseError::Success);
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000602 }
603 }
Rafael Espindolad0136702014-06-12 02:50:04 +0000604 return make_error_code(ParseError::Unsuitable);
Alexander Kornienkod6538332013-05-07 15:32:14 +0000605}
606
607std::string configurationAsText(const FormatStyle &Style) {
608 std::string Text;
609 llvm::raw_string_ostream Stream(Text);
610 llvm::yaml::Output Output(Stream);
611 // We use the same mapping method for input and output, so we need a non-const
612 // reference here.
613 FormatStyle NonConstStyle = Style;
614 Output << NonConstStyle;
Alexander Kornienko9a38ec22013-05-13 12:56:35 +0000615 return Stream.str();
Alexander Kornienkod6538332013-05-07 15:32:14 +0000616}
617
Craig Topperaf35e852013-06-30 22:29:28 +0000618namespace {
619
Manuel Klimek15dfe7a2013-05-28 11:55:06 +0000620class FormatTokenLexer {
Alexander Kornienkoe3276842012-12-07 16:15:44 +0000621public:
Daniel Jasper23376252014-09-09 14:37:39 +0000622 FormatTokenLexer(SourceManager &SourceMgr, FileID ID, FormatStyle &Style,
Alexander Kornienkoffcc0102013-06-05 14:09:10 +0000623 encoding::Encoding Encoding)
Craig Topper2145bc02014-05-09 08:15:10 +0000624 : FormatTok(nullptr), IsFirstToken(true), GreaterStashed(false),
Jacques Pienaarfc275112015-02-18 23:48:37 +0000625 LessStashed(false), Column(0), TrailingWhitespace(0),
626 SourceMgr(SourceMgr), ID(ID), Style(Style),
627 IdentTable(getFormattingLangOpts(Style)), Keywords(IdentTable),
Birunthan Mohanathasb001a0b2015-07-03 17:25:16 +0000628 Encoding(Encoding), FirstInLineIndex(0), FormattingDisabled(false),
629 MacroBlockBeginRegex(Style.MacroBlockBegin),
630 MacroBlockEndRegex(Style.MacroBlockEnd) {
Daniel Jasper23376252014-09-09 14:37:39 +0000631 Lex.reset(new Lexer(ID, SourceMgr.getBuffer(ID), SourceMgr,
632 getFormattingLangOpts(Style)));
633 Lex->SetKeepWhitespaceMode(true);
Daniel Jaspere1e43192014-04-01 12:55:11 +0000634
Daniel Jasperb05a81d2014-05-09 13:11:16 +0000635 for (const std::string &ForEachMacro : Style.ForEachMacros)
Daniel Jaspere1e43192014-04-01 12:55:11 +0000636 ForEachMacros.push_back(&IdentTable.get(ForEachMacro));
637 std::sort(ForEachMacros.begin(), ForEachMacros.end());
Alexander Kornienkoe3276842012-12-07 16:15:44 +0000638 }
639
Manuel Klimek15dfe7a2013-05-28 11:55:06 +0000640 ArrayRef<FormatToken *> lex() {
641 assert(Tokens.empty());
Manuel Klimek68b03042014-04-14 09:14:11 +0000642 assert(FirstInLineIndex == 0);
Manuel Klimek15dfe7a2013-05-28 11:55:06 +0000643 do {
644 Tokens.push_back(getNextToken());
Alexander Kornienko9aa62402013-11-21 12:43:57 +0000645 tryMergePreviousTokens();
Daniel Jaspera0ef4f32015-02-20 13:47:38 +0000646 if (Tokens.back()->NewlinesBefore > 0 || Tokens.back()->IsMultiline)
Manuel Klimek68b03042014-04-14 09:14:11 +0000647 FirstInLineIndex = Tokens.size() - 1;
Manuel Klimek15dfe7a2013-05-28 11:55:06 +0000648 } while (Tokens.back()->Tok.isNot(tok::eof));
649 return Tokens;
650 }
651
Daniel Jasperd0ec0d62014-11-04 12:41:02 +0000652 const AdditionalKeywords &getKeywords() { return Keywords; }
Manuel Klimek15dfe7a2013-05-28 11:55:06 +0000653
654private:
Alexander Kornienko9aa62402013-11-21 12:43:57 +0000655 void tryMergePreviousTokens() {
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000656 if (tryMerge_TMacro())
657 return;
Manuel Klimek68b03042014-04-14 09:14:11 +0000658 if (tryMergeConflictMarkers())
659 return;
Jacques Pienaarfc275112015-02-18 23:48:37 +0000660 if (tryMergeLessLess())
661 return;
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000662
663 if (Style.Language == FormatStyle::LK_JavaScript) {
Daniel Jasperf9ae3122014-05-08 07:01:45 +0000664 if (tryMergeJSRegexLiteral())
665 return;
Daniel Jasper23376252014-09-09 14:37:39 +0000666 if (tryMergeEscapeSequence())
667 return;
Daniel Jaspera0ef4f32015-02-20 13:47:38 +0000668 if (tryMergeTemplateString())
669 return;
Daniel Jasperf9ae3122014-05-08 07:01:45 +0000670
Benjamin Kramer28b45ce2015-03-08 16:06:46 +0000671 static const tok::TokenKind JSIdentity[] = {tok::equalequal, tok::equal};
672 static const tok::TokenKind JSNotIdentity[] = {tok::exclaimequal,
673 tok::equal};
674 static const tok::TokenKind JSShiftEqual[] = {tok::greater, tok::greater,
675 tok::greaterequal};
676 static const tok::TokenKind JSRightArrow[] = {tok::equal, tok::greater};
Manuel Klimek79e06082015-05-21 12:23:34 +0000677 // FIXME: Investigate what token type gives the correct operator priority.
678 if (tryMergeTokens(JSIdentity, TT_BinaryOperator))
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000679 return;
Manuel Klimek79e06082015-05-21 12:23:34 +0000680 if (tryMergeTokens(JSNotIdentity, TT_BinaryOperator))
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000681 return;
Manuel Klimek79e06082015-05-21 12:23:34 +0000682 if (tryMergeTokens(JSShiftEqual, TT_BinaryOperator))
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000683 return;
Manuel Klimek79e06082015-05-21 12:23:34 +0000684 if (tryMergeTokens(JSRightArrow, TT_JsFatArrow))
Daniel Jasper78214392014-05-19 07:27:02 +0000685 return;
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000686 }
Alexander Kornienko9aa62402013-11-21 12:43:57 +0000687 }
688
Jacques Pienaarfc275112015-02-18 23:48:37 +0000689 bool tryMergeLessLess() {
690 // Merge X,less,less,Y into X,lessless,Y unless X or Y is less.
Jacques Pienaar68a7dbf2015-02-20 21:09:01 +0000691 if (Tokens.size() < 3)
692 return false;
Jacques Pienaarfc275112015-02-18 23:48:37 +0000693
Jacques Pienaar68a7dbf2015-02-20 21:09:01 +0000694 bool FourthTokenIsLess = false;
695 if (Tokens.size() > 3)
696 FourthTokenIsLess = (Tokens.end() - 4)[0]->is(tok::less);
Jacques Pienaarfc275112015-02-18 23:48:37 +0000697
Jacques Pienaar68a7dbf2015-02-20 21:09:01 +0000698 auto First = Tokens.end() - 3;
699 if (First[2]->is(tok::less) || First[1]->isNot(tok::less) ||
700 First[0]->isNot(tok::less) || FourthTokenIsLess)
Jacques Pienaarfc275112015-02-18 23:48:37 +0000701 return false;
702
703 // Only merge if there currently is no whitespace between the two "<".
Jacques Pienaar68a7dbf2015-02-20 21:09:01 +0000704 if (First[1]->WhitespaceRange.getBegin() !=
705 First[1]->WhitespaceRange.getEnd())
Jacques Pienaarfc275112015-02-18 23:48:37 +0000706 return false;
707
Jacques Pienaar68a7dbf2015-02-20 21:09:01 +0000708 First[0]->Tok.setKind(tok::lessless);
709 First[0]->TokenText = "<<";
710 First[0]->ColumnWidth += 1;
Jacques Pienaarfc275112015-02-18 23:48:37 +0000711 Tokens.erase(Tokens.end() - 2);
712 return true;
713 }
714
Manuel Klimek79e06082015-05-21 12:23:34 +0000715 bool tryMergeTokens(ArrayRef<tok::TokenKind> Kinds, TokenType NewType) {
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000716 if (Tokens.size() < Kinds.size())
Alexander Kornienko9aa62402013-11-21 12:43:57 +0000717 return false;
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000718
719 SmallVectorImpl<FormatToken *>::const_iterator First =
720 Tokens.end() - Kinds.size();
721 if (!First[0]->is(Kinds[0]))
Alexander Kornienko9aa62402013-11-21 12:43:57 +0000722 return false;
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000723 unsigned AddLength = 0;
724 for (unsigned i = 1; i < Kinds.size(); ++i) {
Jacques Pienaarfc275112015-02-18 23:48:37 +0000725 if (!First[i]->is(Kinds[i]) ||
726 First[i]->WhitespaceRange.getBegin() !=
727 First[i]->WhitespaceRange.getEnd())
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000728 return false;
729 AddLength += First[i]->TokenText.size();
730 }
731 Tokens.resize(Tokens.size() - Kinds.size() + 1);
732 First[0]->TokenText = StringRef(First[0]->TokenText.data(),
733 First[0]->TokenText.size() + AddLength);
734 First[0]->ColumnWidth += AddLength;
Manuel Klimek79e06082015-05-21 12:23:34 +0000735 First[0]->Type = NewType;
Alexander Kornienko9aa62402013-11-21 12:43:57 +0000736 return true;
737 }
738
Daniel Jasperfb4333b2014-05-12 11:29:50 +0000739 // Tries to merge an escape sequence, i.e. a "\\" and the following
Alp Tokerc3f36af2014-05-15 01:35:53 +0000740 // character. Use e.g. inside JavaScript regex literals.
Daniel Jasperfb4333b2014-05-12 11:29:50 +0000741 bool tryMergeEscapeSequence() {
742 if (Tokens.size() < 2)
743 return false;
744 FormatToken *Previous = Tokens[Tokens.size() - 2];
Daniel Jasper49a9a282014-10-29 16:51:38 +0000745 if (Previous->isNot(tok::unknown) || Previous->TokenText != "\\")
Daniel Jasperfb4333b2014-05-12 11:29:50 +0000746 return false;
Daniel Jasper49a9a282014-10-29 16:51:38 +0000747 ++Previous->ColumnWidth;
Daniel Jasperfb4333b2014-05-12 11:29:50 +0000748 StringRef Text = Previous->TokenText;
Daniel Jasper49a9a282014-10-29 16:51:38 +0000749 Previous->TokenText = StringRef(Text.data(), Text.size() + 1);
750 resetLexer(SourceMgr.getFileOffset(Tokens.back()->Tok.getLocation()) + 1);
Daniel Jasperfb4333b2014-05-12 11:29:50 +0000751 Tokens.resize(Tokens.size() - 1);
Daniel Jasper49a9a282014-10-29 16:51:38 +0000752 Column = Previous->OriginalColumn + Previous->ColumnWidth;
Daniel Jasperfb4333b2014-05-12 11:29:50 +0000753 return true;
754 }
755
Daniel Jasperf9ae3122014-05-08 07:01:45 +0000756 // Try to determine whether the current token ends a JavaScript regex literal.
757 // We heuristically assume that this is a regex literal if we find two
758 // unescaped slashes on a line and the token before the first slash is one of
Daniel Jasperf7405c12014-05-08 07:45:18 +0000759 // "(;,{}![:?", a binary operator or 'return', as those cannot be followed by
760 // a division.
Daniel Jasperf9ae3122014-05-08 07:01:45 +0000761 bool tryMergeJSRegexLiteral() {
Daniel Jasper23376252014-09-09 14:37:39 +0000762 if (Tokens.size() < 2)
763 return false;
Daniel Jasper6b8d26c2015-06-24 16:01:02 +0000764
765 // If this is a string literal with a slash inside, compute the slash's
766 // offset and try to find the beginning of the regex literal.
767 // Also look at tok::unknown, as it can be an unterminated char literal.
768 size_t SlashInStringPos = StringRef::npos;
769 if (Tokens.back()->isOneOf(tok::string_literal, tok::char_constant,
770 tok::unknown)) {
771 // Start search from position 1 as otherwise, this is an unknown token
772 // for an unterminated /*-comment which is handled elsewhere.
773 SlashInStringPos = Tokens.back()->TokenText.find('/', 1);
774 if (SlashInStringPos == StringRef::npos)
775 return false;
776 }
777
Daniel Jasper23376252014-09-09 14:37:39 +0000778 // If a regex literal ends in "\//", this gets represented by an unknown
779 // token "\" and a comment.
780 bool MightEndWithEscapedSlash =
781 Tokens.back()->is(tok::comment) &&
782 Tokens.back()->TokenText.startswith("//") &&
783 Tokens[Tokens.size() - 2]->TokenText == "\\";
Daniel Jasper6b8d26c2015-06-24 16:01:02 +0000784 if (!MightEndWithEscapedSlash && SlashInStringPos == StringRef::npos &&
Daniel Jasper23376252014-09-09 14:37:39 +0000785 (Tokens.back()->isNot(tok::slash) ||
786 (Tokens[Tokens.size() - 2]->is(tok::unknown) &&
787 Tokens[Tokens.size() - 2]->TokenText == "\\")))
Daniel Jasperf9ae3122014-05-08 07:01:45 +0000788 return false;
Daniel Jasper6b8d26c2015-06-24 16:01:02 +0000789
Daniel Jasperb05a81d2014-05-09 13:11:16 +0000790 unsigned TokenCount = 0;
Daniel Jasperb05a81d2014-05-09 13:11:16 +0000791 for (auto I = Tokens.rbegin() + 1, E = Tokens.rend(); I != E; ++I) {
792 ++TokenCount;
Daniel Jasperf7372152015-07-02 14:14:04 +0000793 auto Prev = I + 1;
794 while (Prev != E && Prev[0]->is(tok::comment))
795 ++Prev;
Daniel Jasperc553ae12015-07-02 13:20:45 +0000796 if (I[0]->isOneOf(tok::slash, tok::slashequal) &&
Daniel Jasperf7372152015-07-02 14:14:04 +0000797 (Prev == E ||
798 ((Prev[0]->isOneOf(tok::l_paren, tok::semi, tok::l_brace,
799 tok::r_brace, tok::exclaim, tok::l_square,
800 tok::colon, tok::comma, tok::question,
801 tok::kw_return) ||
802 Prev[0]->isBinaryOperator())))) {
Daniel Jasper6b8d26c2015-06-24 16:01:02 +0000803 unsigned LastColumn = Tokens.back()->OriginalColumn;
804 SourceLocation Loc = Tokens.back()->Tok.getLocation();
Daniel Jasper23376252014-09-09 14:37:39 +0000805 if (MightEndWithEscapedSlash) {
Daniel Jasper23376252014-09-09 14:37:39 +0000806 // This regex literal ends in '\//'. Skip past the '//' of the last
807 // token and re-start lexing from there.
Daniel Jasper49a9a282014-10-29 16:51:38 +0000808 resetLexer(SourceMgr.getFileOffset(Loc) + 2);
Daniel Jasper6b8d26c2015-06-24 16:01:02 +0000809 } else if (SlashInStringPos != StringRef::npos) {
810 // This regex literal ends in a string_literal with a slash inside.
811 // Calculate end column and reset lexer appropriately.
812 resetLexer(SourceMgr.getFileOffset(Loc) + SlashInStringPos + 1);
813 LastColumn += SlashInStringPos;
Daniel Jasper23376252014-09-09 14:37:39 +0000814 }
Daniel Jasperb05a81d2014-05-09 13:11:16 +0000815 Tokens.resize(Tokens.size() - TokenCount);
816 Tokens.back()->Tok.setKind(tok::unknown);
817 Tokens.back()->Type = TT_RegexLiteral;
Daniel Jasperf1446202015-07-02 15:00:44 +0000818 // Treat regex literals like other string_literals.
819 Tokens.back()->Tok.setKind(tok::string_literal);
Daniel Jasperb05a81d2014-05-09 13:11:16 +0000820 Tokens.back()->ColumnWidth += LastColumn - I[0]->OriginalColumn;
821 return true;
822 }
823
824 // There can't be a newline inside a regex literal.
825 if (I[0]->NewlinesBefore > 0)
826 return false;
827 }
828 return false;
Daniel Jasperf9ae3122014-05-08 07:01:45 +0000829 }
830
Daniel Jaspera0ef4f32015-02-20 13:47:38 +0000831 bool tryMergeTemplateString() {
832 if (Tokens.size() < 2)
833 return false;
834
835 FormatToken *EndBacktick = Tokens.back();
Daniel Jasperf69b9222015-05-02 08:05:38 +0000836 // Backticks get lexed as tok::unknown tokens. If a template string contains
Daniel Jasper0d6ac272015-04-16 08:20:51 +0000837 // a comment start, it gets lexed as a tok::comment, or tok::unknown if
838 // unterminated.
Daniel Jasper2ebb0c52015-06-14 07:16:57 +0000839 if (!EndBacktick->isOneOf(tok::comment, tok::string_literal,
840 tok::char_constant, tok::unknown))
Daniel Jasper0d6ac272015-04-16 08:20:51 +0000841 return false;
842 size_t CommentBacktickPos = EndBacktick->TokenText.find('`');
843 // Unknown token that's not actually a backtick, or a comment that doesn't
844 // contain a backtick.
845 if (CommentBacktickPos == StringRef::npos)
Daniel Jaspera0ef4f32015-02-20 13:47:38 +0000846 return false;
847
848 unsigned TokenCount = 0;
849 bool IsMultiline = false;
Daniel Jasperf69b9222015-05-02 08:05:38 +0000850 unsigned EndColumnInFirstLine =
851 EndBacktick->OriginalColumn + EndBacktick->ColumnWidth;
Daniel Jaspera0ef4f32015-02-20 13:47:38 +0000852 for (auto I = Tokens.rbegin() + 1, E = Tokens.rend(); I != E; I++) {
853 ++TokenCount;
Daniel Jasper553a5b02015-07-02 13:08:28 +0000854 if (I[0]->IsMultiline)
Daniel Jaspera0ef4f32015-02-20 13:47:38 +0000855 IsMultiline = true;
856
857 // If there was a preceding template string, this must be the start of a
858 // template string, not the end.
859 if (I[0]->is(TT_TemplateString))
860 return false;
861
862 if (I[0]->isNot(tok::unknown) || I[0]->TokenText != "`") {
863 // Keep track of the rhs offset of the last token to wrap across lines -
864 // its the rhs offset of the first line of the template string, used to
865 // determine its width.
866 if (I[0]->IsMultiline)
867 EndColumnInFirstLine = I[0]->OriginalColumn + I[0]->ColumnWidth;
868 // If the token has newlines, the token before it (if it exists) is the
869 // rhs end of the previous line.
Daniel Jasper553a5b02015-07-02 13:08:28 +0000870 if (I[0]->NewlinesBefore > 0 && (I + 1 != E)) {
Daniel Jaspera0ef4f32015-02-20 13:47:38 +0000871 EndColumnInFirstLine = I[1]->OriginalColumn + I[1]->ColumnWidth;
Daniel Jasper553a5b02015-07-02 13:08:28 +0000872 IsMultiline = true;
873 }
Daniel Jaspera0ef4f32015-02-20 13:47:38 +0000874 continue;
875 }
876
877 Tokens.resize(Tokens.size() - TokenCount);
878 Tokens.back()->Type = TT_TemplateString;
Daniel Jasper0d6ac272015-04-16 08:20:51 +0000879 const char *EndOffset =
880 EndBacktick->TokenText.data() + 1 + CommentBacktickPos;
881 if (CommentBacktickPos != 0) {
882 // If the backtick was not the first character (e.g. in a comment),
883 // re-lex after the backtick position.
884 SourceLocation Loc = EndBacktick->Tok.getLocation();
885 resetLexer(SourceMgr.getFileOffset(Loc) + CommentBacktickPos + 1);
886 }
Daniel Jaspera0ef4f32015-02-20 13:47:38 +0000887 Tokens.back()->TokenText =
888 StringRef(Tokens.back()->TokenText.data(),
889 EndOffset - Tokens.back()->TokenText.data());
Daniel Jasperf69b9222015-05-02 08:05:38 +0000890
891 unsigned EndOriginalColumn = EndBacktick->OriginalColumn;
892 if (EndOriginalColumn == 0) {
893 SourceLocation Loc = EndBacktick->Tok.getLocation();
894 EndOriginalColumn = SourceMgr.getSpellingColumnNumber(Loc);
895 }
896 // If the ` is further down within the token (e.g. in a comment).
897 EndOriginalColumn += CommentBacktickPos;
898
Daniel Jaspera0ef4f32015-02-20 13:47:38 +0000899 if (IsMultiline) {
900 // ColumnWidth is from backtick to last token in line.
901 // LastLineColumnWidth is 0 to backtick.
902 // x = `some content
903 // until here`;
904 Tokens.back()->ColumnWidth =
905 EndColumnInFirstLine - Tokens.back()->OriginalColumn;
Daniel Jasper553a5b02015-07-02 13:08:28 +0000906 // +1 for the ` itself.
907 Tokens.back()->LastLineColumnWidth = EndOriginalColumn + 1;
Daniel Jaspera0ef4f32015-02-20 13:47:38 +0000908 Tokens.back()->IsMultiline = true;
909 } else {
910 // Token simply spans from start to end, +1 for the ` itself.
911 Tokens.back()->ColumnWidth =
Daniel Jasperf69b9222015-05-02 08:05:38 +0000912 EndOriginalColumn - Tokens.back()->OriginalColumn + 1;
Daniel Jaspera0ef4f32015-02-20 13:47:38 +0000913 }
914 return true;
915 }
916 return false;
917 }
918
Alexander Kornienko9aa62402013-11-21 12:43:57 +0000919 bool tryMerge_TMacro() {
Alexander Kornienko81e32942013-09-16 20:20:49 +0000920 if (Tokens.size() < 4)
Alexander Kornienko9aa62402013-11-21 12:43:57 +0000921 return false;
Alexander Kornienko81e32942013-09-16 20:20:49 +0000922 FormatToken *Last = Tokens.back();
923 if (!Last->is(tok::r_paren))
Alexander Kornienko9aa62402013-11-21 12:43:57 +0000924 return false;
Alexander Kornienko81e32942013-09-16 20:20:49 +0000925
926 FormatToken *String = Tokens[Tokens.size() - 2];
927 if (!String->is(tok::string_literal) || String->IsMultiline)
Alexander Kornienko9aa62402013-11-21 12:43:57 +0000928 return false;
Alexander Kornienko81e32942013-09-16 20:20:49 +0000929
930 if (!Tokens[Tokens.size() - 3]->is(tok::l_paren))
Alexander Kornienko9aa62402013-11-21 12:43:57 +0000931 return false;
Alexander Kornienko81e32942013-09-16 20:20:49 +0000932
933 FormatToken *Macro = Tokens[Tokens.size() - 4];
934 if (Macro->TokenText != "_T")
Alexander Kornienko9aa62402013-11-21 12:43:57 +0000935 return false;
Alexander Kornienko81e32942013-09-16 20:20:49 +0000936
937 const char *Start = Macro->TokenText.data();
938 const char *End = Last->TokenText.data() + Last->TokenText.size();
939 String->TokenText = StringRef(Start, End - Start);
940 String->IsFirst = Macro->IsFirst;
941 String->LastNewlineOffset = Macro->LastNewlineOffset;
942 String->WhitespaceRange = Macro->WhitespaceRange;
943 String->OriginalColumn = Macro->OriginalColumn;
944 String->ColumnWidth = encoding::columnWidthWithTabs(
945 String->TokenText, String->OriginalColumn, Style.TabWidth, Encoding);
Daniel Jaspere99c72f2015-03-26 14:47:35 +0000946 String->NewlinesBefore = Macro->NewlinesBefore;
947 String->HasUnescapedNewline = Macro->HasUnescapedNewline;
Alexander Kornienko81e32942013-09-16 20:20:49 +0000948
949 Tokens.pop_back();
950 Tokens.pop_back();
951 Tokens.pop_back();
952 Tokens.back() = String;
Alexander Kornienko9aa62402013-11-21 12:43:57 +0000953 return true;
Alexander Kornienko81e32942013-09-16 20:20:49 +0000954 }
955
Manuel Klimek68b03042014-04-14 09:14:11 +0000956 bool tryMergeConflictMarkers() {
957 if (Tokens.back()->NewlinesBefore == 0 && Tokens.back()->isNot(tok::eof))
958 return false;
959
960 // Conflict lines look like:
961 // <marker> <text from the vcs>
962 // For example:
963 // >>>>>>> /file/in/file/system at revision 1234
964 //
965 // We merge all tokens in a line that starts with a conflict marker
966 // into a single token with a special token type that the unwrapped line
967 // parser will use to correctly rebuild the underlying code.
968
969 FileID ID;
970 // Get the position of the first token in the line.
971 unsigned FirstInLineOffset;
972 std::tie(ID, FirstInLineOffset) = SourceMgr.getDecomposedLoc(
973 Tokens[FirstInLineIndex]->getStartOfNonWhitespace());
974 StringRef Buffer = SourceMgr.getBuffer(ID)->getBuffer();
975 // Calculate the offset of the start of the current line.
976 auto LineOffset = Buffer.rfind('\n', FirstInLineOffset);
977 if (LineOffset == StringRef::npos) {
978 LineOffset = 0;
979 } else {
980 ++LineOffset;
981 }
982
983 auto FirstSpace = Buffer.find_first_of(" \n", LineOffset);
984 StringRef LineStart;
985 if (FirstSpace == StringRef::npos) {
986 LineStart = Buffer.substr(LineOffset);
987 } else {
988 LineStart = Buffer.substr(LineOffset, FirstSpace - LineOffset);
989 }
990
991 TokenType Type = TT_Unknown;
992 if (LineStart == "<<<<<<<" || LineStart == ">>>>") {
993 Type = TT_ConflictStart;
994 } else if (LineStart == "|||||||" || LineStart == "=======" ||
995 LineStart == "====") {
996 Type = TT_ConflictAlternative;
997 } else if (LineStart == ">>>>>>>" || LineStart == "<<<<") {
998 Type = TT_ConflictEnd;
999 }
1000
1001 if (Type != TT_Unknown) {
1002 FormatToken *Next = Tokens.back();
1003
1004 Tokens.resize(FirstInLineIndex + 1);
1005 // We do not need to build a complete token here, as we will skip it
1006 // during parsing anyway (as we must not touch whitespace around conflict
1007 // markers).
1008 Tokens.back()->Type = Type;
1009 Tokens.back()->Tok.setKind(tok::kw___unknown_anytype);
1010
1011 Tokens.push_back(Next);
1012 return true;
1013 }
1014
1015 return false;
1016 }
1017
Jacques Pienaarfc275112015-02-18 23:48:37 +00001018 FormatToken *getStashedToken() {
1019 // Create a synthesized second '>' or '<' token.
1020 Token Tok = FormatTok->Tok;
1021 StringRef TokenText = FormatTok->TokenText;
1022
1023 unsigned OriginalColumn = FormatTok->OriginalColumn;
1024 FormatTok = new (Allocator.Allocate()) FormatToken;
1025 FormatTok->Tok = Tok;
1026 SourceLocation TokLocation =
Jacques Pienaar411b2512015-02-24 23:23:24 +00001027 FormatTok->Tok.getLocation().getLocWithOffset(Tok.getLength() - 1);
1028 FormatTok->Tok.setLocation(TokLocation);
Jacques Pienaarfc275112015-02-18 23:48:37 +00001029 FormatTok->WhitespaceRange = SourceRange(TokLocation, TokLocation);
1030 FormatTok->TokenText = TokenText;
1031 FormatTok->ColumnWidth = 1;
Jacques Pienaar411b2512015-02-24 23:23:24 +00001032 FormatTok->OriginalColumn = OriginalColumn + 1;
1033
Jacques Pienaarfc275112015-02-18 23:48:37 +00001034 return FormatTok;
1035 }
1036
Manuel Klimek15dfe7a2013-05-28 11:55:06 +00001037 FormatToken *getNextToken() {
Alexander Kornienkoe3276842012-12-07 16:15:44 +00001038 if (GreaterStashed) {
Alexander Kornienkoe3276842012-12-07 16:15:44 +00001039 GreaterStashed = false;
Jacques Pienaarfc275112015-02-18 23:48:37 +00001040 return getStashedToken();
1041 }
1042 if (LessStashed) {
1043 LessStashed = false;
1044 return getStashedToken();
Alexander Kornienkoe3276842012-12-07 16:15:44 +00001045 }
1046
Manuel Klimek15dfe7a2013-05-28 11:55:06 +00001047 FormatTok = new (Allocator.Allocate()) FormatToken;
Daniel Jasper8369aa52013-07-16 20:28:33 +00001048 readRawToken(*FormatTok);
Manuel Klimek9043c742013-05-27 15:23:34 +00001049 SourceLocation WhitespaceStart =
Manuel Klimek15dfe7a2013-05-28 11:55:06 +00001050 FormatTok->Tok.getLocation().getLocWithOffset(-TrailingWhitespace);
Alexander Kornienko393e3082013-11-13 14:04:17 +00001051 FormatTok->IsFirst = IsFirstToken;
1052 IsFirstToken = false;
Alexander Kornienkoe3276842012-12-07 16:15:44 +00001053
1054 // Consume and record whitespace until we find a significant token.
Manuel Klimek9043c742013-05-27 15:23:34 +00001055 unsigned WhitespaceLength = TrailingWhitespace;
Manuel Klimek15dfe7a2013-05-28 11:55:06 +00001056 while (FormatTok->Tok.is(tok::unknown)) {
Daniel Jaspere2408e32015-05-06 11:16:43 +00001057 StringRef Text = FormatTok->TokenText;
1058 auto EscapesNewline = [&](int pos) {
1059 // A '\r' here is just part of '\r\n'. Skip it.
1060 if (pos >= 0 && Text[pos] == '\r')
1061 --pos;
1062 // See whether there is an odd number of '\' before this.
1063 unsigned count = 0;
1064 for (; pos >= 0; --pos, ++count)
Daniel Jasperf0fd1c62015-05-10 08:00:25 +00001065 if (Text[pos] != '\\')
Daniel Jaspere2408e32015-05-06 11:16:43 +00001066 break;
1067 return count & 1;
1068 };
Daniel Jaspera0ef4f32015-02-20 13:47:38 +00001069 // FIXME: This miscounts tok:unknown tokens that are not just
1070 // whitespace, e.g. a '`' character.
Daniel Jaspere2408e32015-05-06 11:16:43 +00001071 for (int i = 0, e = Text.size(); i != e; ++i) {
1072 switch (Text[i]) {
Manuel Klimek31c85922013-08-29 15:21:40 +00001073 case '\n':
1074 ++FormatTok->NewlinesBefore;
Daniel Jaspere2408e32015-05-06 11:16:43 +00001075 FormatTok->HasUnescapedNewline = !EscapesNewline(i - 1);
Manuel Klimek31c85922013-08-29 15:21:40 +00001076 FormatTok->LastNewlineOffset = WhitespaceLength + i + 1;
1077 Column = 0;
1078 break;
Daniel Jasper877615c2013-10-11 19:45:02 +00001079 case '\r':
Daniel Jasper30029c62015-02-05 11:05:31 +00001080 FormatTok->LastNewlineOffset = WhitespaceLength + i + 1;
1081 Column = 0;
1082 break;
Daniel Jasper877615c2013-10-11 19:45:02 +00001083 case '\f':
1084 case '\v':
1085 Column = 0;
1086 break;
Manuel Klimek31c85922013-08-29 15:21:40 +00001087 case ' ':
1088 ++Column;
1089 break;
1090 case '\t':
Alexander Kornienkoebb43ca2013-09-05 14:08:34 +00001091 Column += Style.TabWidth - Column % Style.TabWidth;
Manuel Klimek31c85922013-08-29 15:21:40 +00001092 break;
Daniel Jasper877615c2013-10-11 19:45:02 +00001093 case '\\':
Daniel Jaspere2408e32015-05-06 11:16:43 +00001094 if (i + 1 == e || (Text[i + 1] != '\r' && Text[i + 1] != '\n'))
Daniel Jasper877615c2013-10-11 19:45:02 +00001095 FormatTok->Type = TT_ImplicitStringLiteral;
1096 break;
Manuel Klimek31c85922013-08-29 15:21:40 +00001097 default:
Daniel Jasper877615c2013-10-11 19:45:02 +00001098 FormatTok->Type = TT_ImplicitStringLiteral;
Manuel Klimek31c85922013-08-29 15:21:40 +00001099 break;
1100 }
1101 }
1102
Daniel Jaspera98b7b02014-11-25 10:05:17 +00001103 if (FormatTok->is(TT_ImplicitStringLiteral))
Daniel Jasper877615c2013-10-11 19:45:02 +00001104 break;
Manuel Klimek15dfe7a2013-05-28 11:55:06 +00001105 WhitespaceLength += FormatTok->Tok.getLength();
Alexander Kornienkoe3276842012-12-07 16:15:44 +00001106
Daniel Jasper8369aa52013-07-16 20:28:33 +00001107 readRawToken(*FormatTok);
Manuel Klimek1abf7892013-01-04 23:34:14 +00001108 }
Manuel Klimekef920692013-01-07 07:56:50 +00001109
Manuel Klimek1abf7892013-01-04 23:34:14 +00001110 // In case the token starts with escaped newlines, we want to
1111 // take them into account as whitespace - this pattern is quite frequent
1112 // in macro definitions.
Manuel Klimek1abf7892013-01-04 23:34:14 +00001113 // FIXME: Add a more explicit test.
Daniel Jasper8369aa52013-07-16 20:28:33 +00001114 while (FormatTok->TokenText.size() > 1 && FormatTok->TokenText[0] == '\\' &&
1115 FormatTok->TokenText[1] == '\n') {
Manuel Klimek1fcbe672014-04-11 12:27:47 +00001116 ++FormatTok->NewlinesBefore;
Manuel Klimek5c24cca2013-05-23 10:56:37 +00001117 WhitespaceLength += 2;
Daniel Jaspere2408e32015-05-06 11:16:43 +00001118 FormatTok->LastNewlineOffset = 2;
Manuel Klimek31c85922013-08-29 15:21:40 +00001119 Column = 0;
Daniel Jasper8369aa52013-07-16 20:28:33 +00001120 FormatTok->TokenText = FormatTok->TokenText.substr(2);
Alexander Kornienkoe3276842012-12-07 16:15:44 +00001121 }
Alexander Kornienko39856b72013-09-10 09:38:25 +00001122
1123 FormatTok->WhitespaceRange = SourceRange(
1124 WhitespaceStart, WhitespaceStart.getLocWithOffset(WhitespaceLength));
1125
Manuel Klimek31c85922013-08-29 15:21:40 +00001126 FormatTok->OriginalColumn = Column;
Alexander Kornienkoe3276842012-12-07 16:15:44 +00001127
Alexander Kornienkoee4ca9b2013-06-07 17:45:07 +00001128 TrailingWhitespace = 0;
1129 if (FormatTok->Tok.is(tok::comment)) {
Manuel Klimek31c85922013-08-29 15:21:40 +00001130 // FIXME: Add the trimmed whitespace to Column.
Daniel Jasper8369aa52013-07-16 20:28:33 +00001131 StringRef UntrimmedText = FormatTok->TokenText;
Alexander Kornienko9ab4a772013-09-06 17:24:54 +00001132 FormatTok->TokenText = FormatTok->TokenText.rtrim(" \t\v\f");
Daniel Jasper8369aa52013-07-16 20:28:33 +00001133 TrailingWhitespace = UntrimmedText.size() - FormatTok->TokenText.size();
Alexander Kornienkoee4ca9b2013-06-07 17:45:07 +00001134 } else if (FormatTok->Tok.is(tok::raw_identifier)) {
Daniel Jasper8369aa52013-07-16 20:28:33 +00001135 IdentifierInfo &Info = IdentTable.get(FormatTok->TokenText);
Manuel Klimek15dfe7a2013-05-28 11:55:06 +00001136 FormatTok->Tok.setIdentifierInfo(&Info);
1137 FormatTok->Tok.setKind(Info.getTokenID());
Daniel Jasperfe2cf662014-11-19 14:11:11 +00001138 if (Style.Language == FormatStyle::LK_Java &&
1139 FormatTok->isOneOf(tok::kw_struct, tok::kw_union, tok::kw_delete)) {
1140 FormatTok->Tok.setKind(tok::identifier);
1141 FormatTok->Tok.setIdentifierInfo(nullptr);
1142 }
Alexander Kornienkoee4ca9b2013-06-07 17:45:07 +00001143 } else if (FormatTok->Tok.is(tok::greatergreater)) {
Manuel Klimek15dfe7a2013-05-28 11:55:06 +00001144 FormatTok->Tok.setKind(tok::greater);
Daniel Jasper8369aa52013-07-16 20:28:33 +00001145 FormatTok->TokenText = FormatTok->TokenText.substr(0, 1);
Alexander Kornienkoe3276842012-12-07 16:15:44 +00001146 GreaterStashed = true;
Jacques Pienaarfc275112015-02-18 23:48:37 +00001147 } else if (FormatTok->Tok.is(tok::lessless)) {
1148 FormatTok->Tok.setKind(tok::less);
1149 FormatTok->TokenText = FormatTok->TokenText.substr(0, 1);
1150 LessStashed = true;
Alexander Kornienkoe3276842012-12-07 16:15:44 +00001151 }
1152
Alexander Kornienkoee4ca9b2013-06-07 17:45:07 +00001153 // Now FormatTok is the next non-whitespace token.
Alexander Kornienkoffcc0102013-06-05 14:09:10 +00001154
Alexander Kornienko39856b72013-09-10 09:38:25 +00001155 StringRef Text = FormatTok->TokenText;
1156 size_t FirstNewlinePos = Text.find('\n');
Alexander Kornienko917f9e02013-09-10 12:29:48 +00001157 if (FirstNewlinePos == StringRef::npos) {
1158 // FIXME: ColumnWidth actually depends on the start column, we need to
1159 // take this into account when the token is moved.
1160 FormatTok->ColumnWidth =
1161 encoding::columnWidthWithTabs(Text, Column, Style.TabWidth, Encoding);
1162 Column += FormatTok->ColumnWidth;
1163 } else {
Alexander Kornienko39856b72013-09-10 09:38:25 +00001164 FormatTok->IsMultiline = true;
Alexander Kornienko917f9e02013-09-10 12:29:48 +00001165 // FIXME: ColumnWidth actually depends on the start column, we need to
1166 // take this into account when the token is moved.
1167 FormatTok->ColumnWidth = encoding::columnWidthWithTabs(
1168 Text.substr(0, FirstNewlinePos), Column, Style.TabWidth, Encoding);
1169
Alexander Kornienko39856b72013-09-10 09:38:25 +00001170 // The last line of the token always starts in column 0.
1171 // Thus, the length can be precomputed even in the presence of tabs.
1172 FormatTok->LastLineColumnWidth = encoding::columnWidthWithTabs(
1173 Text.substr(Text.find_last_of('\n') + 1), 0, Style.TabWidth,
1174 Encoding);
Alexander Kornienko917f9e02013-09-10 12:29:48 +00001175 Column = FormatTok->LastLineColumnWidth;
Alexander Kornienko632abb92013-09-02 13:58:14 +00001176 }
Alexander Kornienko39856b72013-09-10 09:38:25 +00001177
Birunthan Mohanathasb001a0b2015-07-03 17:25:16 +00001178 if (Style.Language == FormatStyle::LK_Cpp) {
1179 if (!(Tokens.size() > 0 && Tokens.back()->Tok.getIdentifierInfo() &&
1180 Tokens.back()->Tok.getIdentifierInfo()->getPPKeywordID() ==
1181 tok::pp_define) &&
1182 std::find(ForEachMacros.begin(), ForEachMacros.end(),
1183 FormatTok->Tok.getIdentifierInfo()) != ForEachMacros.end()) {
1184 FormatTok->Type = TT_ForEachMacro;
1185 } else if (FormatTok->is(tok::identifier)) {
1186 if (MacroBlockBeginRegex.match(Text)) {
1187 FormatTok->Type = TT_MacroBlockBegin;
1188 } else if (MacroBlockEndRegex.match(Text)) {
1189 FormatTok->Type = TT_MacroBlockEnd;
1190 }
1191 }
1192 }
Daniel Jaspere1e43192014-04-01 12:55:11 +00001193
Alexander Kornienkoe3276842012-12-07 16:15:44 +00001194 return FormatTok;
1195 }
1196
Manuel Klimek15dfe7a2013-05-28 11:55:06 +00001197 FormatToken *FormatTok;
Alexander Kornienko393e3082013-11-13 14:04:17 +00001198 bool IsFirstToken;
Jacques Pienaarfc275112015-02-18 23:48:37 +00001199 bool GreaterStashed, LessStashed;
Manuel Klimek31c85922013-08-29 15:21:40 +00001200 unsigned Column;
Manuel Klimek9043c742013-05-27 15:23:34 +00001201 unsigned TrailingWhitespace;
Daniel Jasper23376252014-09-09 14:37:39 +00001202 std::unique_ptr<Lexer> Lex;
Alexander Kornienkoe3276842012-12-07 16:15:44 +00001203 SourceManager &SourceMgr;
Daniel Jasper23376252014-09-09 14:37:39 +00001204 FileID ID;
Manuel Klimek31c85922013-08-29 15:21:40 +00001205 FormatStyle &Style;
Alexander Kornienkoe3276842012-12-07 16:15:44 +00001206 IdentifierTable IdentTable;
Daniel Jasperd0ec0d62014-11-04 12:41:02 +00001207 AdditionalKeywords Keywords;
Alexander Kornienkoffcc0102013-06-05 14:09:10 +00001208 encoding::Encoding Encoding;
Manuel Klimek15dfe7a2013-05-28 11:55:06 +00001209 llvm::SpecificBumpPtrAllocator<FormatToken> Allocator;
Manuel Klimek68b03042014-04-14 09:14:11 +00001210 // Index (in 'Tokens') of the last token that starts a new line.
1211 unsigned FirstInLineIndex;
Manuel Klimek15dfe7a2013-05-28 11:55:06 +00001212 SmallVector<FormatToken *, 16> Tokens;
Daniel Jasperb05a81d2014-05-09 13:11:16 +00001213 SmallVector<IdentifierInfo *, 8> ForEachMacros;
Alexander Kornienkoe3276842012-12-07 16:15:44 +00001214
NAKAMURA Takumi7160c4d2014-08-06 16:53:13 +00001215 bool FormattingDisabled;
Daniel Jasper471894432014-08-06 13:40:26 +00001216
Birunthan Mohanathasb001a0b2015-07-03 17:25:16 +00001217 llvm::Regex MacroBlockBeginRegex;
1218 llvm::Regex MacroBlockEndRegex;
1219
Daniel Jasper8369aa52013-07-16 20:28:33 +00001220 void readRawToken(FormatToken &Tok) {
Daniel Jasper23376252014-09-09 14:37:39 +00001221 Lex->LexFromRawLexer(Tok.Tok);
Daniel Jasper8369aa52013-07-16 20:28:33 +00001222 Tok.TokenText = StringRef(SourceMgr.getCharacterData(Tok.Tok.getLocation()),
1223 Tok.Tok.getLength());
Daniel Jasper8369aa52013-07-16 20:28:33 +00001224 // For formatting, treat unterminated string literals like normal string
1225 // literals.
Daniel Jasper86fee2f2014-01-31 12:49:42 +00001226 if (Tok.is(tok::unknown)) {
1227 if (!Tok.TokenText.empty() && Tok.TokenText[0] == '"') {
1228 Tok.Tok.setKind(tok::string_literal);
1229 Tok.IsUnterminatedLiteral = true;
1230 } else if (Style.Language == FormatStyle::LK_JavaScript &&
1231 Tok.TokenText == "''") {
1232 Tok.Tok.setKind(tok::char_constant);
1233 }
Daniel Jasper8369aa52013-07-16 20:28:33 +00001234 }
Roman Kashitsyn650ecb52014-09-11 14:47:20 +00001235
1236 if (Tok.is(tok::comment) && (Tok.TokenText == "// clang-format on" ||
1237 Tok.TokenText == "/* clang-format on */")) {
Daniel Jasper471894432014-08-06 13:40:26 +00001238 FormattingDisabled = false;
Roman Kashitsyn650ecb52014-09-11 14:47:20 +00001239 }
1240
Daniel Jasper471894432014-08-06 13:40:26 +00001241 Tok.Finalized = FormattingDisabled;
Roman Kashitsyn650ecb52014-09-11 14:47:20 +00001242
1243 if (Tok.is(tok::comment) && (Tok.TokenText == "// clang-format off" ||
1244 Tok.TokenText == "/* clang-format off */")) {
Daniel Jasper471894432014-08-06 13:40:26 +00001245 FormattingDisabled = true;
Roman Kashitsyn650ecb52014-09-11 14:47:20 +00001246 }
Alexander Kornienkoe3276842012-12-07 16:15:44 +00001247 }
Daniel Jasper49a9a282014-10-29 16:51:38 +00001248
1249 void resetLexer(unsigned Offset) {
1250 StringRef Buffer = SourceMgr.getBufferData(ID);
1251 Lex.reset(new Lexer(SourceMgr.getLocForStartOfFile(ID),
1252 getFormattingLangOpts(Style), Buffer.begin(),
1253 Buffer.begin() + Offset, Buffer.end()));
1254 Lex->SetKeepWhitespaceMode(true);
Daniel Jasper55c384e2015-07-02 14:01:34 +00001255 TrailingWhitespace = 0;
Daniel Jasper49a9a282014-10-29 16:51:38 +00001256 }
Alexander Kornienkoe3276842012-12-07 16:15:44 +00001257};
1258
Alexander Kornienkocabdd732013-11-29 15:19:43 +00001259static StringRef getLanguageName(FormatStyle::LanguageKind Language) {
1260 switch (Language) {
1261 case FormatStyle::LK_Cpp:
1262 return "C++";
Daniel Jasperc58c70e2014-09-15 11:21:46 +00001263 case FormatStyle::LK_Java:
1264 return "Java";
Alexander Kornienkocabdd732013-11-29 15:19:43 +00001265 case FormatStyle::LK_JavaScript:
1266 return "JavaScript";
Daniel Jasper7052ce62014-01-19 09:04:08 +00001267 case FormatStyle::LK_Proto:
1268 return "Proto";
Alexander Kornienkocabdd732013-11-29 15:19:43 +00001269 default:
1270 return "Unknown";
1271 }
1272}
1273
Daniel Jasperf7935112012-12-03 18:12:45 +00001274class Formatter : public UnwrappedLineConsumer {
1275public:
Daniel Jasper23376252014-09-09 14:37:39 +00001276 Formatter(const FormatStyle &Style, SourceManager &SourceMgr, FileID ID,
Benjamin Kramerd0eed3a2014-10-03 18:52:48 +00001277 ArrayRef<CharSourceRange> Ranges)
Daniel Jasper23376252014-09-09 14:37:39 +00001278 : Style(Style), ID(ID), SourceMgr(SourceMgr),
1279 Whitespaces(SourceMgr, Style,
1280 inputUsesCRLF(SourceMgr.getBufferData(ID))),
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +00001281 Ranges(Ranges.begin(), Ranges.end()), UnwrappedLines(1),
Daniel Jasper23376252014-09-09 14:37:39 +00001282 Encoding(encoding::detectEncoding(SourceMgr.getBufferData(ID))) {
Daniel Jasperfa21c072013-07-15 14:33:14 +00001283 DEBUG(llvm::dbgs() << "File encoding: "
1284 << (Encoding == encoding::Encoding_UTF8 ? "UTF8"
1285 : "unknown")
1286 << "\n");
Alexander Kornienkocabdd732013-11-29 15:19:43 +00001287 DEBUG(llvm::dbgs() << "Language: " << getLanguageName(Style.Language)
1288 << "\n");
Alexander Kornienkoffcc0102013-06-05 14:09:10 +00001289 }
Daniel Jasperf7935112012-12-03 18:12:45 +00001290
Manuel Klimekec5c3db2015-05-07 12:26:30 +00001291 tooling::Replacements format(bool *IncompleteFormat) {
Manuel Klimek71814b42013-10-11 21:25:45 +00001292 tooling::Replacements Result;
Daniel Jasper23376252014-09-09 14:37:39 +00001293 FormatTokenLexer Tokens(SourceMgr, ID, Style, Encoding);
Manuel Klimek15dfe7a2013-05-28 11:55:06 +00001294
Daniel Jasperd0ec0d62014-11-04 12:41:02 +00001295 UnwrappedLineParser Parser(Style, Tokens.getKeywords(), Tokens.lex(),
1296 *this);
Manuel Klimek20e0af62015-05-06 11:56:29 +00001297 Parser.parse();
Manuel Klimek71814b42013-10-11 21:25:45 +00001298 assert(UnwrappedLines.rbegin()->empty());
1299 for (unsigned Run = 0, RunE = UnwrappedLines.size(); Run + 1 != RunE;
1300 ++Run) {
1301 DEBUG(llvm::dbgs() << "Run " << Run << "...\n");
1302 SmallVector<AnnotatedLine *, 16> AnnotatedLines;
1303 for (unsigned i = 0, e = UnwrappedLines[Run].size(); i != e; ++i) {
1304 AnnotatedLines.push_back(new AnnotatedLine(UnwrappedLines[Run][i]));
1305 }
Manuel Klimekec5c3db2015-05-07 12:26:30 +00001306 tooling::Replacements RunResult =
1307 format(AnnotatedLines, Tokens, IncompleteFormat);
Manuel Klimek71814b42013-10-11 21:25:45 +00001308 DEBUG({
1309 llvm::dbgs() << "Replacements for run " << Run << ":\n";
1310 for (tooling::Replacements::iterator I = RunResult.begin(),
1311 E = RunResult.end();
1312 I != E; ++I) {
1313 llvm::dbgs() << I->toString() << "\n";
1314 }
1315 });
1316 for (unsigned i = 0, e = AnnotatedLines.size(); i != e; ++i) {
1317 delete AnnotatedLines[i];
1318 }
1319 Result.insert(RunResult.begin(), RunResult.end());
1320 Whitespaces.reset();
1321 }
1322 return Result;
1323 }
1324
1325 tooling::Replacements format(SmallVectorImpl<AnnotatedLine *> &AnnotatedLines,
Daniel Jaspere6fcf7d2015-06-17 13:08:06 +00001326 FormatTokenLexer &Tokens,
1327 bool *IncompleteFormat) {
Daniel Jasperd0ec0d62014-11-04 12:41:02 +00001328 TokenAnnotator Annotator(Style, Tokens.getKeywords());
Alexander Kornienko62b85b92013-03-13 14:41:29 +00001329 for (unsigned i = 0, e = AnnotatedLines.size(); i != e; ++i) {
Daniel Jasper9fe0e8d2013-09-05 09:29:45 +00001330 Annotator.annotate(*AnnotatedLines[i]);
Alexander Kornienko62b85b92013-03-13 14:41:29 +00001331 }
Manuel Klimek71814b42013-10-11 21:25:45 +00001332 deriveLocalStyle(AnnotatedLines);
Alexander Kornienko62b85b92013-03-13 14:41:29 +00001333 for (unsigned i = 0, e = AnnotatedLines.size(); i != e; ++i) {
Daniel Jasper9fe0e8d2013-09-05 09:29:45 +00001334 Annotator.calculateFormattingInformation(*AnnotatedLines[i]);
Alexander Kornienko62b85b92013-03-13 14:41:29 +00001335 }
Daniel Jasper5500f612013-11-25 11:08:59 +00001336 computeAffectedLines(AnnotatedLines.begin(), AnnotatedLines.end());
Daniel Jasperb67cc422013-04-09 17:46:55 +00001337
Daniel Jasper1c5d9df2013-09-06 07:54:20 +00001338 Annotator.setCommentLineLevels(AnnotatedLines);
Daniel Jasperd0ec0d62014-11-04 12:41:02 +00001339 ContinuationIndenter Indenter(Style, Tokens.getKeywords(), SourceMgr,
1340 Whitespaces, Encoding,
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +00001341 BinPackInconclusiveFunctions);
Manuel Klimekd3585db2015-05-11 08:21:35 +00001342 UnwrappedLineFormatter(&Indenter, &Whitespaces, Style, Tokens.getKeywords(),
1343 IncompleteFormat)
1344 .format(AnnotatedLines);
Alexander Kornienko62b85b92013-03-13 14:41:29 +00001345 return Whitespaces.generateReplacements();
1346 }
1347
1348private:
Daniel Jasper5500f612013-11-25 11:08:59 +00001349 // Determines which lines are affected by the SourceRanges given as input.
Daniel Jasper9c199562013-11-28 15:58:55 +00001350 // Returns \c true if at least one line between I and E or one of their
1351 // children is affected.
Daniel Jasper5500f612013-11-25 11:08:59 +00001352 bool computeAffectedLines(SmallVectorImpl<AnnotatedLine *>::iterator I,
1353 SmallVectorImpl<AnnotatedLine *>::iterator E) {
1354 bool SomeLineAffected = false;
Craig Topper2145bc02014-05-09 08:15:10 +00001355 const AnnotatedLine *PreviousLine = nullptr;
Daniel Jasper5500f612013-11-25 11:08:59 +00001356 while (I != E) {
1357 AnnotatedLine *Line = *I;
1358 Line->LeadingEmptyLinesAffected = affectsLeadingEmptyLines(*Line->First);
1359
1360 // If a line is part of a preprocessor directive, it needs to be formatted
1361 // if any token within the directive is affected.
1362 if (Line->InPPDirective) {
1363 FormatToken *Last = Line->Last;
1364 SmallVectorImpl<AnnotatedLine *>::iterator PPEnd = I + 1;
1365 while (PPEnd != E && !(*PPEnd)->First->HasUnescapedNewline) {
1366 Last = (*PPEnd)->Last;
1367 ++PPEnd;
1368 }
1369
1370 if (affectsTokenRange(*Line->First, *Last,
1371 /*IncludeLeadingNewlines=*/false)) {
1372 SomeLineAffected = true;
1373 markAllAsAffected(I, PPEnd);
1374 }
1375 I = PPEnd;
1376 continue;
1377 }
1378
Daniel Jasper38c82402013-11-29 09:27:43 +00001379 if (nonPPLineAffected(Line, PreviousLine))
Daniel Jasper5500f612013-11-25 11:08:59 +00001380 SomeLineAffected = true;
Daniel Jasper5500f612013-11-25 11:08:59 +00001381
Daniel Jasper38c82402013-11-29 09:27:43 +00001382 PreviousLine = Line;
Daniel Jasper5500f612013-11-25 11:08:59 +00001383 ++I;
1384 }
1385 return SomeLineAffected;
1386 }
1387
Daniel Jasper9c199562013-11-28 15:58:55 +00001388 // Determines whether 'Line' is affected by the SourceRanges given as input.
1389 // Returns \c true if line or one if its children is affected.
Daniel Jasper38c82402013-11-29 09:27:43 +00001390 bool nonPPLineAffected(AnnotatedLine *Line,
1391 const AnnotatedLine *PreviousLine) {
Daniel Jasper9c199562013-11-28 15:58:55 +00001392 bool SomeLineAffected = false;
1393 Line->ChildrenAffected =
1394 computeAffectedLines(Line->Children.begin(), Line->Children.end());
1395 if (Line->ChildrenAffected)
1396 SomeLineAffected = true;
1397
1398 // Stores whether one of the line's tokens is directly affected.
1399 bool SomeTokenAffected = false;
1400 // Stores whether we need to look at the leading newlines of the next token
1401 // in order to determine whether it was affected.
1402 bool IncludeLeadingNewlines = false;
1403
1404 // Stores whether the first child line of any of this line's tokens is
1405 // affected.
1406 bool SomeFirstChildAffected = false;
1407
1408 for (FormatToken *Tok = Line->First; Tok; Tok = Tok->Next) {
1409 // Determine whether 'Tok' was affected.
1410 if (affectsTokenRange(*Tok, *Tok, IncludeLeadingNewlines))
1411 SomeTokenAffected = true;
1412
1413 // Determine whether the first child of 'Tok' was affected.
1414 if (!Tok->Children.empty() && Tok->Children.front()->Affected)
1415 SomeFirstChildAffected = true;
1416
1417 IncludeLeadingNewlines = Tok->Children.empty();
1418 }
1419
1420 // Was this line moved, i.e. has it previously been on the same line as an
1421 // affected line?
Daniel Jasper38c82402013-11-29 09:27:43 +00001422 bool LineMoved = PreviousLine && PreviousLine->Affected &&
1423 Line->First->NewlinesBefore == 0;
Daniel Jasper9c199562013-11-28 15:58:55 +00001424
Daniel Jasperb05a81d2014-05-09 13:11:16 +00001425 bool IsContinuedComment =
1426 Line->First->is(tok::comment) && Line->First->Next == nullptr &&
1427 Line->First->NewlinesBefore < 2 && PreviousLine &&
1428 PreviousLine->Affected && PreviousLine->Last->is(tok::comment);
Daniel Jasper38c82402013-11-29 09:27:43 +00001429
1430 if (SomeTokenAffected || SomeFirstChildAffected || LineMoved ||
1431 IsContinuedComment) {
Daniel Jasper9c199562013-11-28 15:58:55 +00001432 Line->Affected = true;
Daniel Jasper9c199562013-11-28 15:58:55 +00001433 SomeLineAffected = true;
Daniel Jasper9c199562013-11-28 15:58:55 +00001434 }
1435 return SomeLineAffected;
1436 }
1437
Daniel Jasper5500f612013-11-25 11:08:59 +00001438 // Marks all lines between I and E as well as all their children as affected.
1439 void markAllAsAffected(SmallVectorImpl<AnnotatedLine *>::iterator I,
1440 SmallVectorImpl<AnnotatedLine *>::iterator E) {
1441 while (I != E) {
1442 (*I)->Affected = true;
1443 markAllAsAffected((*I)->Children.begin(), (*I)->Children.end());
1444 ++I;
1445 }
1446 }
1447
1448 // Returns true if the range from 'First' to 'Last' intersects with one of the
1449 // input ranges.
1450 bool affectsTokenRange(const FormatToken &First, const FormatToken &Last,
1451 bool IncludeLeadingNewlines) {
1452 SourceLocation Start = First.WhitespaceRange.getBegin();
1453 if (!IncludeLeadingNewlines)
1454 Start = Start.getLocWithOffset(First.LastNewlineOffset);
Daniel Jasper5877bf12013-11-25 11:53:05 +00001455 SourceLocation End = Last.getStartOfNonWhitespace();
Daniel Jasperac29eac2014-10-29 23:40:50 +00001456 End = End.getLocWithOffset(Last.TokenText.size());
Daniel Jasper5500f612013-11-25 11:08:59 +00001457 CharSourceRange Range = CharSourceRange::getCharRange(Start, End);
1458 return affectsCharSourceRange(Range);
1459 }
1460
1461 // Returns true if one of the input ranges intersect the leading empty lines
1462 // before 'Tok'.
1463 bool affectsLeadingEmptyLines(const FormatToken &Tok) {
1464 CharSourceRange EmptyLineRange = CharSourceRange::getCharRange(
1465 Tok.WhitespaceRange.getBegin(),
1466 Tok.WhitespaceRange.getBegin().getLocWithOffset(Tok.LastNewlineOffset));
1467 return affectsCharSourceRange(EmptyLineRange);
1468 }
1469
1470 // Returns true if 'Range' intersects with one of the input ranges.
1471 bool affectsCharSourceRange(const CharSourceRange &Range) {
1472 for (SmallVectorImpl<CharSourceRange>::const_iterator I = Ranges.begin(),
1473 E = Ranges.end();
1474 I != E; ++I) {
1475 if (!SourceMgr.isBeforeInTranslationUnit(Range.getEnd(), I->getBegin()) &&
1476 !SourceMgr.isBeforeInTranslationUnit(I->getEnd(), Range.getBegin()))
1477 return true;
1478 }
1479 return false;
1480 }
1481
Alexander Kornienko9e649af2013-09-11 12:25:57 +00001482 static bool inputUsesCRLF(StringRef Text) {
1483 return Text.count('\r') * 2 > Text.count('\n');
1484 }
1485
Manuel Klimek71814b42013-10-11 21:25:45 +00001486 void
1487 deriveLocalStyle(const SmallVectorImpl<AnnotatedLine *> &AnnotatedLines) {
Daniel Jasper7fce3ab2013-02-06 14:22:40 +00001488 unsigned CountBoundToVariable = 0;
1489 unsigned CountBoundToType = 0;
1490 bool HasCpp03IncompatibleFormat = false;
Daniel Jasperb10cbc42013-07-10 14:02:49 +00001491 bool HasBinPackedFunction = false;
1492 bool HasOnePerLineFunction = false;
Daniel Jasper7fce3ab2013-02-06 14:22:40 +00001493 for (unsigned i = 0, e = AnnotatedLines.size(); i != e; ++i) {
Daniel Jasper9fe0e8d2013-09-05 09:29:45 +00001494 if (!AnnotatedLines[i]->First->Next)
Daniel Jasper7fce3ab2013-02-06 14:22:40 +00001495 continue;
Daniel Jasper9fe0e8d2013-09-05 09:29:45 +00001496 FormatToken *Tok = AnnotatedLines[i]->First->Next;
Manuel Klimek6e6310e2013-05-29 14:47:47 +00001497 while (Tok->Next) {
Daniel Jaspera98b7b02014-11-25 10:05:17 +00001498 if (Tok->is(TT_PointerOrReference)) {
Manuel Klimek6e6310e2013-05-29 14:47:47 +00001499 bool SpacesBefore =
1500 Tok->WhitespaceRange.getBegin() != Tok->WhitespaceRange.getEnd();
1501 bool SpacesAfter = Tok->Next->WhitespaceRange.getBegin() !=
1502 Tok->Next->WhitespaceRange.getEnd();
Daniel Jasper7fce3ab2013-02-06 14:22:40 +00001503 if (SpacesBefore && !SpacesAfter)
1504 ++CountBoundToVariable;
1505 else if (!SpacesBefore && SpacesAfter)
1506 ++CountBoundToType;
1507 }
1508
Daniel Jasperfba84ff2013-10-12 05:16:06 +00001509 if (Tok->WhitespaceRange.getBegin() == Tok->WhitespaceRange.getEnd()) {
Daniel Jaspera98b7b02014-11-25 10:05:17 +00001510 if (Tok->is(tok::coloncolon) && Tok->Previous->is(TT_TemplateOpener))
Daniel Jasperfba84ff2013-10-12 05:16:06 +00001511 HasCpp03IncompatibleFormat = true;
Daniel Jaspera98b7b02014-11-25 10:05:17 +00001512 if (Tok->is(TT_TemplateCloser) &&
1513 Tok->Previous->is(TT_TemplateCloser))
Daniel Jasperfba84ff2013-10-12 05:16:06 +00001514 HasCpp03IncompatibleFormat = true;
1515 }
Daniel Jasperb10cbc42013-07-10 14:02:49 +00001516
1517 if (Tok->PackingKind == PPK_BinPacked)
1518 HasBinPackedFunction = true;
1519 if (Tok->PackingKind == PPK_OnePerLine)
1520 HasOnePerLineFunction = true;
1521
Manuel Klimek6e6310e2013-05-29 14:47:47 +00001522 Tok = Tok->Next;
Daniel Jasper7fce3ab2013-02-06 14:22:40 +00001523 }
1524 }
Daniel Jasper553d4872014-06-17 12:40:34 +00001525 if (Style.DerivePointerAlignment) {
Daniel Jasper7fce3ab2013-02-06 14:22:40 +00001526 if (CountBoundToType > CountBoundToVariable)
Daniel Jasper553d4872014-06-17 12:40:34 +00001527 Style.PointerAlignment = FormatStyle::PAS_Left;
Daniel Jasper7fce3ab2013-02-06 14:22:40 +00001528 else if (CountBoundToType < CountBoundToVariable)
Daniel Jasper553d4872014-06-17 12:40:34 +00001529 Style.PointerAlignment = FormatStyle::PAS_Right;
Daniel Jasper7fce3ab2013-02-06 14:22:40 +00001530 }
1531 if (Style.Standard == FormatStyle::LS_Auto) {
1532 Style.Standard = HasCpp03IncompatibleFormat ? FormatStyle::LS_Cpp11
1533 : FormatStyle::LS_Cpp03;
1534 }
Daniel Jasperb10cbc42013-07-10 14:02:49 +00001535 BinPackInconclusiveFunctions =
1536 HasBinPackedFunction || !HasOnePerLineFunction;
Daniel Jasper7fce3ab2013-02-06 14:22:40 +00001537 }
1538
Craig Topperfb6b25b2014-03-15 04:29:04 +00001539 void consumeUnwrappedLine(const UnwrappedLine &TheLine) override {
Manuel Klimek71814b42013-10-11 21:25:45 +00001540 assert(!UnwrappedLines.empty());
1541 UnwrappedLines.back().push_back(TheLine);
1542 }
1543
Craig Topperfb6b25b2014-03-15 04:29:04 +00001544 void finishRun() override {
Manuel Klimek71814b42013-10-11 21:25:45 +00001545 UnwrappedLines.push_back(SmallVector<UnwrappedLine, 16>());
Daniel Jasperf7935112012-12-03 18:12:45 +00001546 }
1547
1548 FormatStyle Style;
Daniel Jasper23376252014-09-09 14:37:39 +00001549 FileID ID;
Daniel Jasperf7935112012-12-03 18:12:45 +00001550 SourceManager &SourceMgr;
Daniel Jasperaa701fa2013-01-18 08:44:07 +00001551 WhitespaceManager Whitespaces;
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +00001552 SmallVector<CharSourceRange, 8> Ranges;
Manuel Klimek71814b42013-10-11 21:25:45 +00001553 SmallVector<SmallVector<UnwrappedLine, 16>, 2> UnwrappedLines;
Alexander Kornienkoffcc0102013-06-05 14:09:10 +00001554
1555 encoding::Encoding Encoding;
Daniel Jasperb10cbc42013-07-10 14:02:49 +00001556 bool BinPackInconclusiveFunctions;
Daniel Jasperf7935112012-12-03 18:12:45 +00001557};
1558
Craig Topperaf35e852013-06-30 22:29:28 +00001559} // end anonymous namespace
1560
Daniel Jasper23376252014-09-09 14:37:39 +00001561tooling::Replacements reformat(const FormatStyle &Style,
1562 SourceManager &SourceMgr, FileID ID,
Manuel Klimekec5c3db2015-05-07 12:26:30 +00001563 ArrayRef<CharSourceRange> Ranges,
1564 bool *IncompleteFormat) {
Daniel Jasper23376252014-09-09 14:37:39 +00001565 if (Style.DisableFormat)
1566 return tooling::Replacements();
1567 Formatter formatter(Style, SourceMgr, ID, Ranges);
Manuel Klimekec5c3db2015-05-07 12:26:30 +00001568 return formatter.format(IncompleteFormat);
Daniel Jasperf7935112012-12-03 18:12:45 +00001569}
1570
Daniel Jasperec04c0d2013-05-16 10:40:07 +00001571tooling::Replacements reformat(const FormatStyle &Style, StringRef Code,
Benjamin Kramerd0eed3a2014-10-03 18:52:48 +00001572 ArrayRef<tooling::Range> Ranges,
Daniel Jaspere6fcf7d2015-06-17 13:08:06 +00001573 StringRef FileName, bool *IncompleteFormat) {
Daniel Jasper23376252014-09-09 14:37:39 +00001574 if (Style.DisableFormat)
1575 return tooling::Replacements();
1576
Daniel Jasperec04c0d2013-05-16 10:40:07 +00001577 FileManager Files((FileSystemOptions()));
1578 DiagnosticsEngine Diagnostics(
1579 IntrusiveRefCntPtr<DiagnosticIDs>(new DiagnosticIDs),
1580 new DiagnosticOptions);
1581 SourceManager SourceMgr(Diagnostics, Files);
Rafael Espindolad87f8d72014-08-27 20:03:29 +00001582 std::unique_ptr<llvm::MemoryBuffer> Buf =
1583 llvm::MemoryBuffer::getMemBuffer(Code, FileName);
Daniel Jasperec04c0d2013-05-16 10:40:07 +00001584 const clang::FileEntry *Entry =
1585 Files.getVirtualFile(FileName, Buf->getBufferSize(), 0);
David Blaikie49cc3182014-08-27 20:54:45 +00001586 SourceMgr.overrideFileContents(Entry, std::move(Buf));
Daniel Jasperec04c0d2013-05-16 10:40:07 +00001587 FileID ID =
1588 SourceMgr.createFileID(Entry, SourceLocation(), clang::SrcMgr::C_User);
Daniel Jasperec04c0d2013-05-16 10:40:07 +00001589 SourceLocation StartOfFile = SourceMgr.getLocForStartOfFile(ID);
1590 std::vector<CharSourceRange> CharRanges;
Benjamin Kramerd0eed3a2014-10-03 18:52:48 +00001591 for (const tooling::Range &Range : Ranges) {
1592 SourceLocation Start = StartOfFile.getLocWithOffset(Range.getOffset());
1593 SourceLocation End = Start.getLocWithOffset(Range.getLength());
Daniel Jasperec04c0d2013-05-16 10:40:07 +00001594 CharRanges.push_back(CharSourceRange::getCharRange(Start, End));
1595 }
Manuel Klimekec5c3db2015-05-07 12:26:30 +00001596 return reformat(Style, SourceMgr, ID, CharRanges, IncompleteFormat);
Daniel Jasperec04c0d2013-05-16 10:40:07 +00001597}
1598
Daniel Jasper4db69bd2014-09-04 18:23:42 +00001599LangOptions getFormattingLangOpts(const FormatStyle &Style) {
Daniel Jasperc1fa2812013-01-10 13:08:12 +00001600 LangOptions LangOpts;
1601 LangOpts.CPlusPlus = 1;
Daniel Jasper4db69bd2014-09-04 18:23:42 +00001602 LangOpts.CPlusPlus11 = Style.Standard == FormatStyle::LS_Cpp03 ? 0 : 1;
1603 LangOpts.CPlusPlus14 = Style.Standard == FormatStyle::LS_Cpp03 ? 0 : 1;
Daniel Jasper55213652013-03-22 10:01:29 +00001604 LangOpts.LineComment = 1;
Daniel Jasper1662bfe2015-04-03 21:15:46 +00001605 bool AlternativeOperators = Style.Language == FormatStyle::LK_Cpp;
Daniel Jasper30a24062014-11-14 09:02:28 +00001606 LangOpts.CXXOperatorNames = AlternativeOperators ? 1 : 0;
Daniel Jasperc1fa2812013-01-10 13:08:12 +00001607 LangOpts.Bool = 1;
1608 LangOpts.ObjC1 = 1;
1609 LangOpts.ObjC2 = 1;
Nico Weberfac23712015-02-04 15:26:27 +00001610 LangOpts.MicrosoftExt = 1; // To get kw___try, kw___finally.
Daniel Jasperc1fa2812013-01-10 13:08:12 +00001611 return LangOpts;
1612}
1613
Edwin Vaned544aa72013-09-30 13:31:48 +00001614const char *StyleOptionHelpDescription =
1615 "Coding style, currently supports:\n"
1616 " LLVM, Google, Chromium, Mozilla, WebKit.\n"
1617 "Use -style=file to load style configuration from\n"
1618 ".clang-format file located in one of the parent\n"
1619 "directories of the source file (or current\n"
1620 "directory for stdin).\n"
1621 "Use -style=\"{key: value, ...}\" to set specific\n"
1622 "parameters, e.g.:\n"
1623 " -style=\"{BasedOnStyle: llvm, IndentWidth: 8}\"";
1624
Alexander Kornienkoc1637f12013-12-10 11:28:13 +00001625static FormatStyle::LanguageKind getLanguageByFileName(StringRef FileName) {
Daniel Jasperc58c70e2014-09-15 11:21:46 +00001626 if (FileName.endswith(".java")) {
1627 return FormatStyle::LK_Java;
Daniel Jasper8c68a642015-03-11 14:58:38 +00001628 } else if (FileName.endswith_lower(".js") || FileName.endswith_lower(".ts")) {
1629 // JavaScript or TypeScript.
Alexander Kornienkoc1637f12013-12-10 11:28:13 +00001630 return FormatStyle::LK_JavaScript;
Daniel Jasper7052ce62014-01-19 09:04:08 +00001631 } else if (FileName.endswith_lower(".proto") ||
1632 FileName.endswith_lower(".protodevel")) {
1633 return FormatStyle::LK_Proto;
Alexander Kornienkocabdd732013-11-29 15:19:43 +00001634 }
Alexander Kornienkoc1637f12013-12-10 11:28:13 +00001635 return FormatStyle::LK_Cpp;
Alexander Kornienkocabdd732013-11-29 15:19:43 +00001636}
1637
Alexander Kornienkobc4ae442013-12-02 15:21:38 +00001638FormatStyle getStyle(StringRef StyleName, StringRef FileName,
1639 StringRef FallbackStyle) {
Alexander Kornienkoc1637f12013-12-10 11:28:13 +00001640 FormatStyle Style = getLLVMStyle();
1641 Style.Language = getLanguageByFileName(FileName);
1642 if (!getPredefinedStyle(FallbackStyle, Style.Language, &Style)) {
Alexander Kornienkobc4ae442013-12-02 15:21:38 +00001643 llvm::errs() << "Invalid fallback style \"" << FallbackStyle
1644 << "\" using LLVM style\n";
Alexander Kornienkoc1637f12013-12-10 11:28:13 +00001645 return Style;
Alexander Kornienkobc4ae442013-12-02 15:21:38 +00001646 }
Edwin Vaned544aa72013-09-30 13:31:48 +00001647
1648 if (StyleName.startswith("{")) {
1649 // Parse YAML/JSON style from the command line.
Rafael Espindolac0809172014-06-12 14:02:15 +00001650 if (std::error_code ec = parseConfiguration(StyleName, &Style)) {
Alexander Kornienkoe2e03872013-10-14 00:46:35 +00001651 llvm::errs() << "Error parsing -style: " << ec.message() << ", using "
1652 << FallbackStyle << " style\n";
Edwin Vaned544aa72013-09-30 13:31:48 +00001653 }
1654 return Style;
1655 }
1656
1657 if (!StyleName.equals_lower("file")) {
Alexander Kornienkoc1637f12013-12-10 11:28:13 +00001658 if (!getPredefinedStyle(StyleName, Style.Language, &Style))
Edwin Vaned544aa72013-09-30 13:31:48 +00001659 llvm::errs() << "Invalid value for -style, using " << FallbackStyle
1660 << " style\n";
1661 return Style;
1662 }
1663
Alexander Kornienkoc1637f12013-12-10 11:28:13 +00001664 // Look for .clang-format/_clang-format file in the file's parent directories.
Alexander Kornienkocabdd732013-11-29 15:19:43 +00001665 SmallString<128> UnsuitableConfigFiles;
Edwin Vaned544aa72013-09-30 13:31:48 +00001666 SmallString<128> Path(FileName);
1667 llvm::sys::fs::make_absolute(Path);
Alexander Kornienkoe2e03872013-10-14 00:46:35 +00001668 for (StringRef Directory = Path; !Directory.empty();
Edwin Vaned544aa72013-09-30 13:31:48 +00001669 Directory = llvm::sys::path::parent_path(Directory)) {
1670 if (!llvm::sys::fs::is_directory(Directory))
1671 continue;
1672 SmallString<128> ConfigFile(Directory);
1673
1674 llvm::sys::path::append(ConfigFile, ".clang-format");
1675 DEBUG(llvm::dbgs() << "Trying " << ConfigFile << "...\n");
1676 bool IsFile = false;
1677 // Ignore errors from is_regular_file: we only need to know if we can read
1678 // the file or not.
1679 llvm::sys::fs::is_regular_file(Twine(ConfigFile), IsFile);
1680
1681 if (!IsFile) {
1682 // Try _clang-format too, since dotfiles are not commonly used on Windows.
1683 ConfigFile = Directory;
1684 llvm::sys::path::append(ConfigFile, "_clang-format");
1685 DEBUG(llvm::dbgs() << "Trying " << ConfigFile << "...\n");
1686 llvm::sys::fs::is_regular_file(Twine(ConfigFile), IsFile);
1687 }
1688
1689 if (IsFile) {
Rafael Espindola2d2b4202014-07-06 17:43:24 +00001690 llvm::ErrorOr<std::unique_ptr<llvm::MemoryBuffer>> Text =
1691 llvm::MemoryBuffer::getFile(ConfigFile.c_str());
1692 if (std::error_code EC = Text.getError()) {
1693 llvm::errs() << EC.message() << "\n";
Alexander Kornienkobc4ae442013-12-02 15:21:38 +00001694 break;
Edwin Vaned544aa72013-09-30 13:31:48 +00001695 }
Rafael Espindola2d2b4202014-07-06 17:43:24 +00001696 if (std::error_code ec =
1697 parseConfiguration(Text.get()->getBuffer(), &Style)) {
Rafael Espindolad0136702014-06-12 02:50:04 +00001698 if (ec == ParseError::Unsuitable) {
Alexander Kornienkocabdd732013-11-29 15:19:43 +00001699 if (!UnsuitableConfigFiles.empty())
1700 UnsuitableConfigFiles.append(", ");
1701 UnsuitableConfigFiles.append(ConfigFile);
Alexander Kornienkobc4ae442013-12-02 15:21:38 +00001702 continue;
Alexander Kornienkocabdd732013-11-29 15:19:43 +00001703 }
Alexander Kornienkobc4ae442013-12-02 15:21:38 +00001704 llvm::errs() << "Error reading " << ConfigFile << ": " << ec.message()
1705 << "\n";
1706 break;
Edwin Vaned544aa72013-09-30 13:31:48 +00001707 }
1708 DEBUG(llvm::dbgs() << "Using configuration file " << ConfigFile << "\n");
1709 return Style;
1710 }
1711 }
Alexander Kornienkocabdd732013-11-29 15:19:43 +00001712 if (!UnsuitableConfigFiles.empty()) {
1713 llvm::errs() << "Configuration file(s) do(es) not support "
1714 << getLanguageName(Style.Language) << ": "
1715 << UnsuitableConfigFiles << "\n";
1716 }
Edwin Vaned544aa72013-09-30 13:31:48 +00001717 return Style;
1718}
1719
Daniel Jasper8d1832e2013-01-07 13:26:07 +00001720} // namespace format
1721} // namespace clang