blob: ecc2bb7b843fef6cc82124f7e0fcf7776471c44b [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 Jasper85c472d2015-09-29 07:53:08 +000016#include "clang/Format/Format.h"
Eric Liu4cfb88a2016-04-25 15:09:22 +000017#include "AffectedRangeManager.h"
Daniel Jasperde0328a2013-08-16 11:20:30 +000018#include "ContinuationIndenter.h"
Krasimir Georgiev9ad83fe2017-10-30 14:01:50 +000019#include "FormatInternal.h"
Martin Probstc4a0dd42016-05-20 11:24:24 +000020#include "FormatTokenLexer.h"
Krasimir Georgiev7cb267a2017-02-27 13:28:36 +000021#include "NamespaceEndCommentsFixer.h"
Martin Probstc4a0dd42016-05-20 11:24:24 +000022#include "SortJavaScriptImports.h"
23#include "TokenAnalyzer.h"
Daniel Jasper7a6d09b2013-01-29 21:01:14 +000024#include "TokenAnnotator.h"
Daniel Jasper0df50932014-12-10 19:00:42 +000025#include "UnwrappedLineFormatter.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000026#include "UnwrappedLineParser.h"
Krasimir Georgievb03877a2017-06-21 12:03:12 +000027#include "UsingDeclarationsSorter.h"
Alexander Kornienkocb45bc12013-04-15 14:28:00 +000028#include "WhitespaceManager.h"
Daniel Jasperec04c0d2013-05-16 10:40:07 +000029#include "clang/Basic/Diagnostic.h"
Benjamin Kramerf3ca26982014-05-10 16:31:55 +000030#include "clang/Basic/DiagnosticOptions.h"
Chandler Carruth44eb4f62013-01-02 10:28:36 +000031#include "clang/Basic/SourceManager.h"
Marianne Mailhot-Sarrasin4988fa12016-04-14 14:47:37 +000032#include "clang/Basic/VirtualFileSystem.h"
Daniel Jasperf7935112012-12-03 18:12:45 +000033#include "clang/Lex/Lexer.h"
Alexander Kornienkoffd6d042013-03-27 11:52:18 +000034#include "llvm/ADT/STLExtras.h"
Manuel Klimek2ef908e2013-02-13 10:46:36 +000035#include "llvm/Support/Allocator.h"
Manuel Klimek24998102013-01-16 14:55:28 +000036#include "llvm/Support/Debug.h"
Edwin Vaned544aa72013-09-30 13:31:48 +000037#include "llvm/Support/Path.h"
Birunthan Mohanathasb001a0b2015-07-03 17:25:16 +000038#include "llvm/Support/Regex.h"
Chandler Carruth5553d0d2014-01-07 11:51:46 +000039#include "llvm/Support/YAMLTraits.h"
Martin Probst081f1762016-06-01 15:19:53 +000040#include <algorithm>
Eric Liu4cfb88a2016-04-25 15:09:22 +000041#include <memory>
Daniel Jasper8b529712012-12-04 13:02:32 +000042#include <string>
43
Chandler Carruth10346662014-04-22 03:17:02 +000044#define DEBUG_TYPE "format-formatter"
45
Alexander Kornienko6d2c88e2013-12-10 10:30:34 +000046using clang::format::FormatStyle;
47
Krasimir Georgiev9ad83fe2017-10-30 14:01:50 +000048LLVM_YAML_IS_SEQUENCE_VECTOR(clang::format::FormatStyle::IncludeCategory);
49LLVM_YAML_IS_SEQUENCE_VECTOR(clang::format::FormatStyle::RawStringFormat);
Daniel Jaspere1e43192014-04-01 12:55:11 +000050
Alexander Kornienkod6538332013-05-07 15:32:14 +000051namespace llvm {
52namespace yaml {
Alexander Kornienko6d2c88e2013-12-10 10:30:34 +000053template <> struct ScalarEnumerationTraits<FormatStyle::LanguageKind> {
54 static void enumeration(IO &IO, FormatStyle::LanguageKind &Value) {
55 IO.enumCase(Value, "Cpp", FormatStyle::LK_Cpp);
Daniel Jasperc58c70e2014-09-15 11:21:46 +000056 IO.enumCase(Value, "Java", FormatStyle::LK_Java);
Alexander Kornienko6d2c88e2013-12-10 10:30:34 +000057 IO.enumCase(Value, "JavaScript", FormatStyle::LK_JavaScript);
Daniel Jasper03a04fe2016-12-12 12:42:29 +000058 IO.enumCase(Value, "ObjC", FormatStyle::LK_ObjC);
Daniel Jasper7052ce62014-01-19 09:04:08 +000059 IO.enumCase(Value, "Proto", FormatStyle::LK_Proto);
Daniel Jasper498f5582015-12-25 08:53:31 +000060 IO.enumCase(Value, "TableGen", FormatStyle::LK_TableGen);
Krasimir Georgiev26b144c2017-07-03 15:05:14 +000061 IO.enumCase(Value, "TextProto", FormatStyle::LK_TextProto);
Alexander Kornienko6d2c88e2013-12-10 10:30:34 +000062 }
63};
64
65template <> struct ScalarEnumerationTraits<FormatStyle::LanguageStandard> {
66 static void enumeration(IO &IO, FormatStyle::LanguageStandard &Value) {
67 IO.enumCase(Value, "Cpp03", FormatStyle::LS_Cpp03);
68 IO.enumCase(Value, "C++03", FormatStyle::LS_Cpp03);
69 IO.enumCase(Value, "Cpp11", FormatStyle::LS_Cpp11);
70 IO.enumCase(Value, "C++11", FormatStyle::LS_Cpp11);
71 IO.enumCase(Value, "Auto", FormatStyle::LS_Auto);
72 }
73};
74
75template <> struct ScalarEnumerationTraits<FormatStyle::UseTabStyle> {
76 static void enumeration(IO &IO, FormatStyle::UseTabStyle &Value) {
77 IO.enumCase(Value, "Never", FormatStyle::UT_Never);
78 IO.enumCase(Value, "false", FormatStyle::UT_Never);
79 IO.enumCase(Value, "Always", FormatStyle::UT_Always);
80 IO.enumCase(Value, "true", FormatStyle::UT_Always);
81 IO.enumCase(Value, "ForIndentation", FormatStyle::UT_ForIndentation);
Marianne Mailhot-Sarrasin51fe2792016-04-14 14:52:26 +000082 IO.enumCase(Value, "ForContinuationAndIndentation",
83 FormatStyle::UT_ForContinuationAndIndentation);
Alexander Kornienko6d2c88e2013-12-10 10:30:34 +000084 }
85};
86
Daniel Jasperabd1f572016-03-02 22:44:03 +000087template <> struct ScalarEnumerationTraits<FormatStyle::JavaScriptQuoteStyle> {
88 static void enumeration(IO &IO, FormatStyle::JavaScriptQuoteStyle &Value) {
89 IO.enumCase(Value, "Leave", FormatStyle::JSQS_Leave);
90 IO.enumCase(Value, "Single", FormatStyle::JSQS_Single);
91 IO.enumCase(Value, "Double", FormatStyle::JSQS_Double);
92 }
93};
94
Daniel Jasperd74cf402014-04-08 12:46:38 +000095template <> struct ScalarEnumerationTraits<FormatStyle::ShortFunctionStyle> {
96 static void enumeration(IO &IO, FormatStyle::ShortFunctionStyle &Value) {
97 IO.enumCase(Value, "None", FormatStyle::SFS_None);
98 IO.enumCase(Value, "false", FormatStyle::SFS_None);
99 IO.enumCase(Value, "All", FormatStyle::SFS_All);
100 IO.enumCase(Value, "true", FormatStyle::SFS_All);
101 IO.enumCase(Value, "Inline", FormatStyle::SFS_Inline);
Francois Ferrandd3f0e3d2017-06-21 13:56:02 +0000102 IO.enumCase(Value, "InlineOnly", FormatStyle::SFS_InlineOnly);
Daniel Jasper9e709352014-11-26 10:43:58 +0000103 IO.enumCase(Value, "Empty", FormatStyle::SFS_Empty);
Daniel Jasperd74cf402014-04-08 12:46:38 +0000104 }
105};
106
Daniel Jasperac043c92014-09-15 11:11:00 +0000107template <> struct ScalarEnumerationTraits<FormatStyle::BinaryOperatorStyle> {
108 static void enumeration(IO &IO, FormatStyle::BinaryOperatorStyle &Value) {
109 IO.enumCase(Value, "All", FormatStyle::BOS_All);
110 IO.enumCase(Value, "true", FormatStyle::BOS_All);
111 IO.enumCase(Value, "None", FormatStyle::BOS_None);
112 IO.enumCase(Value, "false", FormatStyle::BOS_None);
113 IO.enumCase(Value, "NonAssignment", FormatStyle::BOS_NonAssignment);
114 }
115};
116
Alexander Kornienko6d2c88e2013-12-10 10:30:34 +0000117template <> struct ScalarEnumerationTraits<FormatStyle::BraceBreakingStyle> {
118 static void enumeration(IO &IO, FormatStyle::BraceBreakingStyle &Value) {
119 IO.enumCase(Value, "Attach", FormatStyle::BS_Attach);
120 IO.enumCase(Value, "Linux", FormatStyle::BS_Linux);
Birunthan Mohanathas305fa9c2015-07-12 03:13:54 +0000121 IO.enumCase(Value, "Mozilla", FormatStyle::BS_Mozilla);
Alexander Kornienko6d2c88e2013-12-10 10:30:34 +0000122 IO.enumCase(Value, "Stroustrup", FormatStyle::BS_Stroustrup);
123 IO.enumCase(Value, "Allman", FormatStyle::BS_Allman);
Alexander Kornienko3a33f022013-12-12 09:49:52 +0000124 IO.enumCase(Value, "GNU", FormatStyle::BS_GNU);
Roman Kashitsyn291f64f2015-08-10 13:43:19 +0000125 IO.enumCase(Value, "WebKit", FormatStyle::BS_WebKit);
Daniel Jasperc1bc38e2015-09-29 14:57:55 +0000126 IO.enumCase(Value, "Custom", FormatStyle::BS_Custom);
Alexander Kornienko6d2c88e2013-12-10 10:30:34 +0000127 }
128};
129
Manuel Klimek89628f62017-09-20 09:51:03 +0000130template <>
131struct ScalarEnumerationTraits<FormatStyle::BreakConstructorInitializersStyle> {
132 static void
133 enumeration(IO &IO, FormatStyle::BreakConstructorInitializersStyle &Value) {
Francois Ferranda6b6d512017-05-24 11:36:58 +0000134 IO.enumCase(Value, "BeforeColon", FormatStyle::BCIS_BeforeColon);
135 IO.enumCase(Value, "BeforeComma", FormatStyle::BCIS_BeforeComma);
136 IO.enumCase(Value, "AfterColon", FormatStyle::BCIS_AfterColon);
137 }
138};
139
Daniel Jasperc1bc38e2015-09-29 14:57:55 +0000140template <>
Krasimir Georgievad47c902017-08-30 14:34:57 +0000141struct ScalarEnumerationTraits<FormatStyle::PPDirectiveIndentStyle> {
142 static void enumeration(IO &IO, FormatStyle::PPDirectiveIndentStyle &Value) {
143 IO.enumCase(Value, "None", FormatStyle::PPDIS_None);
144 IO.enumCase(Value, "AfterHash", FormatStyle::PPDIS_AfterHash);
145 }
146};
147
148template <>
Zachary Turner448592e2015-12-18 22:20:15 +0000149struct ScalarEnumerationTraits<FormatStyle::ReturnTypeBreakingStyle> {
150 static void enumeration(IO &IO, FormatStyle::ReturnTypeBreakingStyle &Value) {
151 IO.enumCase(Value, "None", FormatStyle::RTBS_None);
152 IO.enumCase(Value, "All", FormatStyle::RTBS_All);
153 IO.enumCase(Value, "TopLevel", FormatStyle::RTBS_TopLevel);
154 IO.enumCase(Value, "TopLevelDefinitions",
155 FormatStyle::RTBS_TopLevelDefinitions);
156 IO.enumCase(Value, "AllDefinitions", FormatStyle::RTBS_AllDefinitions);
157 }
158};
159
160template <>
Daniel Jasperc1bc38e2015-09-29 14:57:55 +0000161struct ScalarEnumerationTraits<FormatStyle::DefinitionReturnTypeBreakingStyle> {
162 static void
163 enumeration(IO &IO, FormatStyle::DefinitionReturnTypeBreakingStyle &Value) {
Birunthan Mohanathasa0388a82015-06-29 15:30:42 +0000164 IO.enumCase(Value, "None", FormatStyle::DRTBS_None);
165 IO.enumCase(Value, "All", FormatStyle::DRTBS_All);
166 IO.enumCase(Value, "TopLevel", FormatStyle::DRTBS_TopLevel);
167
168 // For backward compatibility.
169 IO.enumCase(Value, "false", FormatStyle::DRTBS_None);
170 IO.enumCase(Value, "true", FormatStyle::DRTBS_All);
171 }
172};
173
Alexander Kornienkod6538332013-05-07 15:32:14 +0000174template <>
Alexander Kornienko6d2c88e2013-12-10 10:30:34 +0000175struct ScalarEnumerationTraits<FormatStyle::NamespaceIndentationKind> {
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000176 static void enumeration(IO &IO,
Alexander Kornienko6d2c88e2013-12-10 10:30:34 +0000177 FormatStyle::NamespaceIndentationKind &Value) {
178 IO.enumCase(Value, "None", FormatStyle::NI_None);
179 IO.enumCase(Value, "Inner", FormatStyle::NI_Inner);
180 IO.enumCase(Value, "All", FormatStyle::NI_All);
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000181 }
182};
183
Daniel Jasper6501f7e2015-10-27 12:38:37 +0000184template <> struct ScalarEnumerationTraits<FormatStyle::BracketAlignmentStyle> {
185 static void enumeration(IO &IO, FormatStyle::BracketAlignmentStyle &Value) {
186 IO.enumCase(Value, "Align", FormatStyle::BAS_Align);
187 IO.enumCase(Value, "DontAlign", FormatStyle::BAS_DontAlign);
188 IO.enumCase(Value, "AlwaysBreak", FormatStyle::BAS_AlwaysBreak);
189
190 // For backward compatibility.
191 IO.enumCase(Value, "true", FormatStyle::BAS_Align);
192 IO.enumCase(Value, "false", FormatStyle::BAS_DontAlign);
193 }
194};
195
Manuel Klimek89628f62017-09-20 09:51:03 +0000196template <>
197struct ScalarEnumerationTraits<FormatStyle::EscapedNewlineAlignmentStyle> {
198 static void enumeration(IO &IO,
199 FormatStyle::EscapedNewlineAlignmentStyle &Value) {
Daniel Jasper7fdbb3f2017-05-08 15:08:00 +0000200 IO.enumCase(Value, "DontAlign", FormatStyle::ENAS_DontAlign);
201 IO.enumCase(Value, "Left", FormatStyle::ENAS_Left);
202 IO.enumCase(Value, "Right", FormatStyle::ENAS_Right);
203
204 // For backward compatibility.
205 IO.enumCase(Value, "true", FormatStyle::ENAS_Left);
206 IO.enumCase(Value, "false", FormatStyle::ENAS_Right);
207 }
208};
209
Jacques Pienaarfc275112015-02-18 23:48:37 +0000210template <> struct ScalarEnumerationTraits<FormatStyle::PointerAlignmentStyle> {
211 static void enumeration(IO &IO, FormatStyle::PointerAlignmentStyle &Value) {
Daniel Jasper553d4872014-06-17 12:40:34 +0000212 IO.enumCase(Value, "Middle", FormatStyle::PAS_Middle);
213 IO.enumCase(Value, "Left", FormatStyle::PAS_Left);
214 IO.enumCase(Value, "Right", FormatStyle::PAS_Right);
215
Alp Toker958027b2014-07-14 19:42:55 +0000216 // For backward compatibility.
Daniel Jasper553d4872014-06-17 12:40:34 +0000217 IO.enumCase(Value, "true", FormatStyle::PAS_Left);
218 IO.enumCase(Value, "false", FormatStyle::PAS_Right);
219 }
220};
221
222template <>
Alexander Kornienko6d2c88e2013-12-10 10:30:34 +0000223struct ScalarEnumerationTraits<FormatStyle::SpaceBeforeParensOptions> {
Manuel Klimeka8eb9142013-05-13 12:51:40 +0000224 static void enumeration(IO &IO,
Alexander Kornienko6d2c88e2013-12-10 10:30:34 +0000225 FormatStyle::SpaceBeforeParensOptions &Value) {
226 IO.enumCase(Value, "Never", FormatStyle::SBPO_Never);
Alexander Kornienkofdca83d2013-12-10 10:18:34 +0000227 IO.enumCase(Value, "ControlStatements",
Alexander Kornienko6d2c88e2013-12-10 10:30:34 +0000228 FormatStyle::SBPO_ControlStatements);
229 IO.enumCase(Value, "Always", FormatStyle::SBPO_Always);
Alexander Kornienkofdca83d2013-12-10 10:18:34 +0000230
231 // For backward compatibility.
Alexander Kornienko6d2c88e2013-12-10 10:30:34 +0000232 IO.enumCase(Value, "false", FormatStyle::SBPO_Never);
233 IO.enumCase(Value, "true", FormatStyle::SBPO_ControlStatements);
Alexander Kornienkofdca83d2013-12-10 10:18:34 +0000234 }
235};
236
Alexander Kornienko6d2c88e2013-12-10 10:30:34 +0000237template <> struct MappingTraits<FormatStyle> {
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000238 static void mapping(IO &IO, FormatStyle &Style) {
239 // When reading, read the language first, we need it for getPredefinedStyle.
240 IO.mapOptional("Language", Style.Language);
241
Alexander Kornienko49149672013-05-10 11:56:10 +0000242 if (IO.outputting()) {
Jacques Pienaarfc275112015-02-18 23:48:37 +0000243 StringRef StylesArray[] = {"LLVM", "Google", "Chromium",
244 "Mozilla", "WebKit", "GNU"};
Alexander Kornienko49149672013-05-10 11:56:10 +0000245 ArrayRef<StringRef> Styles(StylesArray);
246 for (size_t i = 0, e = Styles.size(); i < e; ++i) {
247 StringRef StyleName(Styles[i]);
Alexander Kornienko6d2c88e2013-12-10 10:30:34 +0000248 FormatStyle PredefinedStyle;
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000249 if (getPredefinedStyle(StyleName, Style.Language, &PredefinedStyle) &&
Alexander Kornienko006b5c82013-05-19 00:53:30 +0000250 Style == PredefinedStyle) {
Alexander Kornienko49149672013-05-10 11:56:10 +0000251 IO.mapOptional("# BasedOnStyle", StyleName);
252 break;
253 }
254 }
255 } else {
Alexander Kornienkod6538332013-05-07 15:32:14 +0000256 StringRef BasedOnStyle;
257 IO.mapOptional("BasedOnStyle", BasedOnStyle);
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000258 if (!BasedOnStyle.empty()) {
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000259 FormatStyle::LanguageKind OldLanguage = Style.Language;
260 FormatStyle::LanguageKind Language =
261 ((FormatStyle *)IO.getContext())->Language;
262 if (!getPredefinedStyle(BasedOnStyle, Language, &Style)) {
Alexander Kornienko006b5c82013-05-19 00:53:30 +0000263 IO.setError(Twine("Unknown value for BasedOnStyle: ", BasedOnStyle));
264 return;
265 }
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000266 Style.Language = OldLanguage;
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000267 }
Alexander Kornienkod6538332013-05-07 15:32:14 +0000268 }
269
Birunthan Mohanathas50a6f912015-06-28 14:52:34 +0000270 // For backward compatibility.
271 if (!IO.outputting()) {
Daniel Jasper7fdbb3f2017-05-08 15:08:00 +0000272 IO.mapOptional("AlignEscapedNewlinesLeft", Style.AlignEscapedNewlines);
Birunthan Mohanathas50a6f912015-06-28 14:52:34 +0000273 IO.mapOptional("DerivePointerBinding", Style.DerivePointerAlignment);
274 IO.mapOptional("IndentFunctionDeclarationAfterType",
275 Style.IndentWrappedFunctionNames);
276 IO.mapOptional("PointerBindsToType", Style.PointerAlignment);
277 IO.mapOptional("SpaceAfterControlStatementKeyword",
278 Style.SpaceBeforeParens);
279 }
280
Alexander Kornienkod6538332013-05-07 15:32:14 +0000281 IO.mapOptional("AccessModifierOffset", Style.AccessModifierOffset);
Daniel Jasper3aa9a6a2014-11-18 23:55:27 +0000282 IO.mapOptional("AlignAfterOpenBracket", Style.AlignAfterOpenBracket);
Birunthan Mohanathas35cfbd72015-06-28 14:51:17 +0000283 IO.mapOptional("AlignConsecutiveAssignments",
284 Style.AlignConsecutiveAssignments);
Daniel Jaspere12597c2015-10-01 10:06:54 +0000285 IO.mapOptional("AlignConsecutiveDeclarations",
286 Style.AlignConsecutiveDeclarations);
Daniel Jasper7fdbb3f2017-05-08 15:08:00 +0000287 IO.mapOptional("AlignEscapedNewlines", Style.AlignEscapedNewlines);
Daniel Jasper3219e432014-12-02 13:24:51 +0000288 IO.mapOptional("AlignOperands", Style.AlignOperands);
Daniel Jasper552f4a72013-07-31 23:55:15 +0000289 IO.mapOptional("AlignTrailingComments", Style.AlignTrailingComments);
Alexander Kornienkod6538332013-05-07 15:32:14 +0000290 IO.mapOptional("AllowAllParametersOfDeclarationOnNextLine",
291 Style.AllowAllParametersOfDeclarationOnNextLine);
Daniel Jasper17605d32014-05-14 09:33:35 +0000292 IO.mapOptional("AllowShortBlocksOnASingleLine",
293 Style.AllowShortBlocksOnASingleLine);
Daniel Jasperb87899b2014-09-10 13:11:45 +0000294 IO.mapOptional("AllowShortCaseLabelsOnASingleLine",
295 Style.AllowShortCaseLabelsOnASingleLine);
Birunthan Mohanathas35cfbd72015-06-28 14:51:17 +0000296 IO.mapOptional("AllowShortFunctionsOnASingleLine",
297 Style.AllowShortFunctionsOnASingleLine);
Alexander Kornienkod6538332013-05-07 15:32:14 +0000298 IO.mapOptional("AllowShortIfStatementsOnASingleLine",
299 Style.AllowShortIfStatementsOnASingleLine);
Daniel Jasper3a685df2013-05-16 12:12:21 +0000300 IO.mapOptional("AllowShortLoopsOnASingleLine",
301 Style.AllowShortLoopsOnASingleLine);
Daniel Jasperca4ea1c2014-08-05 12:16:31 +0000302 IO.mapOptional("AlwaysBreakAfterDefinitionReturnType",
303 Style.AlwaysBreakAfterDefinitionReturnType);
Zachary Turner448592e2015-12-18 22:20:15 +0000304 IO.mapOptional("AlwaysBreakAfterReturnType",
305 Style.AlwaysBreakAfterReturnType);
306 // If AlwaysBreakAfterDefinitionReturnType was specified but
307 // AlwaysBreakAfterReturnType was not, initialize the latter from the
308 // former for backwards compatibility.
309 if (Style.AlwaysBreakAfterDefinitionReturnType != FormatStyle::DRTBS_None &&
310 Style.AlwaysBreakAfterReturnType == FormatStyle::RTBS_None) {
311 if (Style.AlwaysBreakAfterDefinitionReturnType == FormatStyle::DRTBS_All)
312 Style.AlwaysBreakAfterReturnType = FormatStyle::RTBS_AllDefinitions;
313 else if (Style.AlwaysBreakAfterDefinitionReturnType ==
314 FormatStyle::DRTBS_TopLevel)
315 Style.AlwaysBreakAfterReturnType =
316 FormatStyle::RTBS_TopLevelDefinitions;
317 }
318
Alexander Kornienko58611712013-07-04 12:02:44 +0000319 IO.mapOptional("AlwaysBreakBeforeMultilineStrings",
320 Style.AlwaysBreakBeforeMultilineStrings);
Birunthan Mohanathas35cfbd72015-06-28 14:51:17 +0000321 IO.mapOptional("AlwaysBreakTemplateDeclarations",
322 Style.AlwaysBreakTemplateDeclarations);
323 IO.mapOptional("BinPackArguments", Style.BinPackArguments);
324 IO.mapOptional("BinPackParameters", Style.BinPackParameters);
Daniel Jasperc1bc38e2015-09-29 14:57:55 +0000325 IO.mapOptional("BraceWrapping", Style.BraceWrapping);
Daniel Jaspere33d4af2013-07-26 16:56:36 +0000326 IO.mapOptional("BreakBeforeBinaryOperators",
327 Style.BreakBeforeBinaryOperators);
Birunthan Mohanathas35cfbd72015-06-28 14:51:17 +0000328 IO.mapOptional("BreakBeforeBraces", Style.BreakBeforeBraces);
Francois Ferrande56a8292017-06-14 12:29:47 +0000329 IO.mapOptional("BreakBeforeInheritanceComma",
330 Style.BreakBeforeInheritanceComma);
Daniel Jasper165b29e2013-11-08 00:57:11 +0000331 IO.mapOptional("BreakBeforeTernaryOperators",
332 Style.BreakBeforeTernaryOperators);
Francois Ferranda6b6d512017-05-24 11:36:58 +0000333
334 bool BreakConstructorInitializersBeforeComma = false;
Daniel Jaspere33d4af2013-07-26 16:56:36 +0000335 IO.mapOptional("BreakConstructorInitializersBeforeComma",
Francois Ferranda6b6d512017-05-24 11:36:58 +0000336 BreakConstructorInitializersBeforeComma);
337 IO.mapOptional("BreakConstructorInitializers",
338 Style.BreakConstructorInitializers);
339 // If BreakConstructorInitializersBeforeComma was specified but
340 // BreakConstructorInitializers was not, initialize the latter from the
341 // former for backwards compatibility.
342 if (BreakConstructorInitializersBeforeComma &&
343 Style.BreakConstructorInitializers == FormatStyle::BCIS_BeforeColon)
344 Style.BreakConstructorInitializers = FormatStyle::BCIS_BeforeComma;
345
Daniel Jaspere1a7b762016-02-01 11:21:02 +0000346 IO.mapOptional("BreakAfterJavaFieldAnnotations",
347 Style.BreakAfterJavaFieldAnnotations);
348 IO.mapOptional("BreakStringLiterals", Style.BreakStringLiterals);
Alexander Kornienkod6538332013-05-07 15:32:14 +0000349 IO.mapOptional("ColumnLimit", Style.ColumnLimit);
Birunthan Mohanathas35cfbd72015-06-28 14:51:17 +0000350 IO.mapOptional("CommentPragmas", Style.CommentPragmas);
Francois Ferrande56a8292017-06-14 12:29:47 +0000351 IO.mapOptional("CompactNamespaces", Style.CompactNamespaces);
Alexander Kornienkod6538332013-05-07 15:32:14 +0000352 IO.mapOptional("ConstructorInitializerAllOnOneLineOrOnePerLine",
353 Style.ConstructorInitializerAllOnOneLineOrOnePerLine);
Daniel Jasper50d634b2014-10-28 16:53:38 +0000354 IO.mapOptional("ConstructorInitializerIndentWidth",
355 Style.ConstructorInitializerIndentWidth);
Birunthan Mohanathas35cfbd72015-06-28 14:51:17 +0000356 IO.mapOptional("ContinuationIndentWidth", Style.ContinuationIndentWidth);
357 IO.mapOptional("Cpp11BracedListStyle", Style.Cpp11BracedListStyle);
Daniel Jasper553d4872014-06-17 12:40:34 +0000358 IO.mapOptional("DerivePointerAlignment", Style.DerivePointerAlignment);
Birunthan Mohanathas35cfbd72015-06-28 14:51:17 +0000359 IO.mapOptional("DisableFormat", Style.DisableFormat);
Daniel Jasperb10cbc42013-07-10 14:02:49 +0000360 IO.mapOptional("ExperimentalAutoDetectBinPacking",
361 Style.ExperimentalAutoDetectBinPacking);
Krasimir Georgiev32eaa862017-03-01 15:35:39 +0000362 IO.mapOptional("FixNamespaceComments", Style.FixNamespaceComments);
Birunthan Mohanathas35cfbd72015-06-28 14:51:17 +0000363 IO.mapOptional("ForEachMacros", Style.ForEachMacros);
Daniel Jasper8ce1b8d2015-10-06 11:54:18 +0000364 IO.mapOptional("IncludeCategories", Style.IncludeCategories);
Daniel Jasper9c8ff352016-03-21 14:11:27 +0000365 IO.mapOptional("IncludeIsMainRegex", Style.IncludeIsMainRegex);
Alexander Kornienkod6538332013-05-07 15:32:14 +0000366 IO.mapOptional("IndentCaseLabels", Style.IndentCaseLabels);
Krasimir Georgievad47c902017-08-30 14:34:57 +0000367 IO.mapOptional("IndentPPDirectives", Style.IndentPPDirectives);
Birunthan Mohanathas35cfbd72015-06-28 14:51:17 +0000368 IO.mapOptional("IndentWidth", Style.IndentWidth);
369 IO.mapOptional("IndentWrappedFunctionNames",
370 Style.IndentWrappedFunctionNames);
Martin Probst0cd74ee2016-06-13 16:39:50 +0000371 IO.mapOptional("JavaScriptQuotes", Style.JavaScriptQuotes);
372 IO.mapOptional("JavaScriptWrapImports", Style.JavaScriptWrapImports);
Daniel Jaspera26fc5c2014-03-21 13:43:14 +0000373 IO.mapOptional("KeepEmptyLinesAtTheStartOfBlocks",
374 Style.KeepEmptyLinesAtTheStartOfBlocks);
Birunthan Mohanathasb001a0b2015-07-03 17:25:16 +0000375 IO.mapOptional("MacroBlockBegin", Style.MacroBlockBegin);
376 IO.mapOptional("MacroBlockEnd", Style.MacroBlockEnd);
Birunthan Mohanathas35cfbd72015-06-28 14:51:17 +0000377 IO.mapOptional("MaxEmptyLinesToKeep", Style.MaxEmptyLinesToKeep);
Daniel Jasper65ee3472013-07-31 23:16:02 +0000378 IO.mapOptional("NamespaceIndentation", Style.NamespaceIndentation);
Daniel Jasper50d634b2014-10-28 16:53:38 +0000379 IO.mapOptional("ObjCBlockIndentWidth", Style.ObjCBlockIndentWidth);
Daniel Jaspere9beea22014-01-28 15:20:33 +0000380 IO.mapOptional("ObjCSpaceAfterProperty", Style.ObjCSpaceAfterProperty);
Alexander Kornienkod6538332013-05-07 15:32:14 +0000381 IO.mapOptional("ObjCSpaceBeforeProtocolList",
382 Style.ObjCSpaceBeforeProtocolList);
Manuel Klimek89628f62017-09-20 09:51:03 +0000383 IO.mapOptional("PenaltyBreakAssignment", Style.PenaltyBreakAssignment);
Daniel Jasper33b909c2013-10-25 14:29:37 +0000384 IO.mapOptional("PenaltyBreakBeforeFirstCallParameter",
385 Style.PenaltyBreakBeforeFirstCallParameter);
Alexander Kornienkodd7ece52013-06-07 16:02:52 +0000386 IO.mapOptional("PenaltyBreakComment", Style.PenaltyBreakComment);
Daniel Jasper4e9678f2013-07-11 20:41:21 +0000387 IO.mapOptional("PenaltyBreakFirstLessLess",
388 Style.PenaltyBreakFirstLessLess);
Birunthan Mohanathas35cfbd72015-06-28 14:51:17 +0000389 IO.mapOptional("PenaltyBreakString", Style.PenaltyBreakString);
Alexander Kornienkod6538332013-05-07 15:32:14 +0000390 IO.mapOptional("PenaltyExcessCharacter", Style.PenaltyExcessCharacter);
391 IO.mapOptional("PenaltyReturnTypeOnItsOwnLine",
392 Style.PenaltyReturnTypeOnItsOwnLine);
Daniel Jasper553d4872014-06-17 12:40:34 +0000393 IO.mapOptional("PointerAlignment", Style.PointerAlignment);
Krasimir Georgiev9ad83fe2017-10-30 14:01:50 +0000394 IO.mapOptional("RawStringFormats", Style.RawStringFormats);
Daniel Jaspera0a50392015-12-01 13:28:53 +0000395 IO.mapOptional("ReflowComments", Style.ReflowComments);
396 IO.mapOptional("SortIncludes", Style.SortIncludes);
Krasimir Georgievac16a202017-06-23 11:46:03 +0000397 IO.mapOptional("SortUsingDeclarations", Style.SortUsingDeclarations);
Daniel Jasperdb986eb2014-09-03 07:37:29 +0000398 IO.mapOptional("SpaceAfterCStyleCast", Style.SpaceAfterCStyleCast);
Manuel Klimek89628f62017-09-20 09:51:03 +0000399 IO.mapOptional("SpaceAfterTemplateKeyword",
400 Style.SpaceAfterTemplateKeyword);
Daniel Jasperd94bff32013-09-25 15:15:02 +0000401 IO.mapOptional("SpaceBeforeAssignmentOperators",
402 Style.SpaceBeforeAssignmentOperators);
Birunthan Mohanathas35cfbd72015-06-28 14:51:17 +0000403 IO.mapOptional("SpaceBeforeParens", Style.SpaceBeforeParens);
404 IO.mapOptional("SpaceInEmptyParentheses", Style.SpaceInEmptyParentheses);
405 IO.mapOptional("SpacesBeforeTrailingComments",
406 Style.SpacesBeforeTrailingComments);
407 IO.mapOptional("SpacesInAngles", Style.SpacesInAngles);
408 IO.mapOptional("SpacesInContainerLiterals",
409 Style.SpacesInContainerLiterals);
410 IO.mapOptional("SpacesInCStyleCastParentheses",
411 Style.SpacesInCStyleCastParentheses);
412 IO.mapOptional("SpacesInParentheses", Style.SpacesInParentheses);
413 IO.mapOptional("SpacesInSquareBrackets", Style.SpacesInSquareBrackets);
414 IO.mapOptional("Standard", Style.Standard);
415 IO.mapOptional("TabWidth", Style.TabWidth);
416 IO.mapOptional("UseTab", Style.UseTab);
Alexander Kornienkod6538332013-05-07 15:32:14 +0000417 }
418};
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000419
Daniel Jasperc1bc38e2015-09-29 14:57:55 +0000420template <> struct MappingTraits<FormatStyle::BraceWrappingFlags> {
421 static void mapping(IO &IO, FormatStyle::BraceWrappingFlags &Wrapping) {
422 IO.mapOptional("AfterClass", Wrapping.AfterClass);
423 IO.mapOptional("AfterControlStatement", Wrapping.AfterControlStatement);
424 IO.mapOptional("AfterEnum", Wrapping.AfterEnum);
425 IO.mapOptional("AfterFunction", Wrapping.AfterFunction);
426 IO.mapOptional("AfterNamespace", Wrapping.AfterNamespace);
427 IO.mapOptional("AfterObjCDeclaration", Wrapping.AfterObjCDeclaration);
428 IO.mapOptional("AfterStruct", Wrapping.AfterStruct);
429 IO.mapOptional("AfterUnion", Wrapping.AfterUnion);
Krasimir Georgievd6ce9372017-09-15 11:23:50 +0000430 IO.mapOptional("AfterExternBlock", Wrapping.AfterExternBlock);
Daniel Jasperc1bc38e2015-09-29 14:57:55 +0000431 IO.mapOptional("BeforeCatch", Wrapping.BeforeCatch);
432 IO.mapOptional("BeforeElse", Wrapping.BeforeElse);
433 IO.mapOptional("IndentBraces", Wrapping.IndentBraces);
Francois Ferrandad722562017-06-30 20:25:55 +0000434 IO.mapOptional("SplitEmptyFunction", Wrapping.SplitEmptyFunction);
435 IO.mapOptional("SplitEmptyRecord", Wrapping.SplitEmptyRecord);
436 IO.mapOptional("SplitEmptyNamespace", Wrapping.SplitEmptyNamespace);
Daniel Jasperc1bc38e2015-09-29 14:57:55 +0000437 }
438};
439
Daniel Jasper8ce1b8d2015-10-06 11:54:18 +0000440template <> struct MappingTraits<FormatStyle::IncludeCategory> {
441 static void mapping(IO &IO, FormatStyle::IncludeCategory &Category) {
442 IO.mapOptional("Regex", Category.Regex);
443 IO.mapOptional("Priority", Category.Priority);
444 }
445};
446
Krasimir Georgiev9ad83fe2017-10-30 14:01:50 +0000447template <> struct MappingTraits<FormatStyle::RawStringFormat> {
448 static void mapping(IO &IO, FormatStyle::RawStringFormat &Format) {
449 IO.mapOptional("Delimiter", Format.Delimiter);
450 IO.mapOptional("Language", Format.Language);
451 IO.mapOptional("BasedOnStyle", Format.BasedOnStyle);
452 }
453};
454
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000455// Allows to read vector<FormatStyle> while keeping default values.
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000456// IO.getContext() should contain a pointer to the FormatStyle structure, that
457// will be used to get default values for missing keys.
458// If the first element has no Language specified, it will be treated as the
459// default one for the following elements.
Jacques Pienaarfc275112015-02-18 23:48:37 +0000460template <> struct DocumentListTraits<std::vector<FormatStyle>> {
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000461 static size_t size(IO &IO, std::vector<FormatStyle> &Seq) {
462 return Seq.size();
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000463 }
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000464 static FormatStyle &element(IO &IO, std::vector<FormatStyle> &Seq,
Alexander Kornienko6d2c88e2013-12-10 10:30:34 +0000465 size_t Index) {
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000466 if (Index >= Seq.size()) {
467 assert(Index == Seq.size());
Alexander Kornienko6d2c88e2013-12-10 10:30:34 +0000468 FormatStyle Template;
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000469 if (Seq.size() > 0 && Seq[0].Language == FormatStyle::LK_None) {
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000470 Template = Seq[0];
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000471 } else {
Daniel Jasperb05a81d2014-05-09 13:11:16 +0000472 Template = *((const FormatStyle *)IO.getContext());
Alexander Kornienko6d2c88e2013-12-10 10:30:34 +0000473 Template.Language = FormatStyle::LK_None;
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000474 }
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000475 Seq.resize(Index + 1, Template);
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000476 }
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000477 return Seq[Index];
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000478 }
479};
Daniel Jasperd89ae9d2015-09-23 08:30:47 +0000480} // namespace yaml
481} // namespace llvm
Alexander Kornienkod6538332013-05-07 15:32:14 +0000482
Daniel Jasperf7935112012-12-03 18:12:45 +0000483namespace clang {
484namespace format {
485
Rafael Espindola6d0d89b2014-06-12 03:31:26 +0000486const std::error_category &getParseCategory() {
Rafael Espindolad0136702014-06-12 02:50:04 +0000487 static ParseErrorCategory C;
488 return C;
489}
490std::error_code make_error_code(ParseError e) {
Rafael Espindola6d0d89b2014-06-12 03:31:26 +0000491 return std::error_code(static_cast<int>(e), getParseCategory());
Rafael Espindolad0136702014-06-12 02:50:04 +0000492}
493
Antonio Maiorano3adfb6a2017-01-17 00:12:27 +0000494inline llvm::Error make_string_error(const llvm::Twine &Message) {
495 return llvm::make_error<llvm::StringError>(Message,
496 llvm::inconvertibleErrorCode());
497}
498
Reid Kleckner6432d452016-10-19 23:39:55 +0000499const char *ParseErrorCategory::name() const noexcept {
Rafael Espindolad0136702014-06-12 02:50:04 +0000500 return "clang-format.parse_error";
501}
502
503std::string ParseErrorCategory::message(int EV) const {
504 switch (static_cast<ParseError>(EV)) {
505 case ParseError::Success:
506 return "Success";
507 case ParseError::Error:
508 return "Invalid argument";
509 case ParseError::Unsuitable:
510 return "Unsuitable";
511 }
Saleem Abdulrasoolfbfbaf62014-06-12 19:33:26 +0000512 llvm_unreachable("unexpected parse error");
Rafael Espindolad0136702014-06-12 02:50:04 +0000513}
514
Daniel Jasperc1bc38e2015-09-29 14:57:55 +0000515static FormatStyle expandPresets(const FormatStyle &Style) {
Daniel Jasper55bbe662015-10-07 04:06:10 +0000516 if (Style.BreakBeforeBraces == FormatStyle::BS_Custom)
517 return Style;
Daniel Jasperc1bc38e2015-09-29 14:57:55 +0000518 FormatStyle Expanded = Style;
Manuel Klimek89628f62017-09-20 09:51:03 +0000519 Expanded.BraceWrapping = {false, false, false, false, false,
520 false, false, false, false, false,
521 false, false, true, true, true};
Daniel Jasperc1bc38e2015-09-29 14:57:55 +0000522 switch (Style.BreakBeforeBraces) {
523 case FormatStyle::BS_Linux:
524 Expanded.BraceWrapping.AfterClass = true;
525 Expanded.BraceWrapping.AfterFunction = true;
526 Expanded.BraceWrapping.AfterNamespace = true;
Daniel Jasperc1bc38e2015-09-29 14:57:55 +0000527 break;
528 case FormatStyle::BS_Mozilla:
529 Expanded.BraceWrapping.AfterClass = true;
530 Expanded.BraceWrapping.AfterEnum = true;
531 Expanded.BraceWrapping.AfterFunction = true;
532 Expanded.BraceWrapping.AfterStruct = true;
533 Expanded.BraceWrapping.AfterUnion = true;
Krasimir Georgievd6ce9372017-09-15 11:23:50 +0000534 Expanded.BraceWrapping.AfterExternBlock = true;
Sylvestre Ledru82c9a0e2017-09-13 20:03:29 +0000535 Expanded.BraceWrapping.SplitEmptyFunction = true;
Francois Ferrandad722562017-06-30 20:25:55 +0000536 Expanded.BraceWrapping.SplitEmptyRecord = false;
Daniel Jasperc1bc38e2015-09-29 14:57:55 +0000537 break;
538 case FormatStyle::BS_Stroustrup:
539 Expanded.BraceWrapping.AfterFunction = true;
540 Expanded.BraceWrapping.BeforeCatch = true;
541 Expanded.BraceWrapping.BeforeElse = true;
542 break;
543 case FormatStyle::BS_Allman:
544 Expanded.BraceWrapping.AfterClass = true;
545 Expanded.BraceWrapping.AfterControlStatement = true;
546 Expanded.BraceWrapping.AfterEnum = true;
547 Expanded.BraceWrapping.AfterFunction = true;
548 Expanded.BraceWrapping.AfterNamespace = true;
549 Expanded.BraceWrapping.AfterObjCDeclaration = true;
550 Expanded.BraceWrapping.AfterStruct = true;
Krasimir Georgievd6ce9372017-09-15 11:23:50 +0000551 Expanded.BraceWrapping.AfterExternBlock = true;
Daniel Jasperc1bc38e2015-09-29 14:57:55 +0000552 Expanded.BraceWrapping.BeforeCatch = true;
553 Expanded.BraceWrapping.BeforeElse = true;
554 break;
555 case FormatStyle::BS_GNU:
Manuel Klimek89628f62017-09-20 09:51:03 +0000556 Expanded.BraceWrapping = {true, true, true, true, true, true, true, true,
557 true, true, true, true, true, true, true};
Daniel Jasperc1bc38e2015-09-29 14:57:55 +0000558 break;
559 case FormatStyle::BS_WebKit:
560 Expanded.BraceWrapping.AfterFunction = true;
561 break;
562 default:
563 break;
564 }
565 return Expanded;
566}
567
Daniel Jasperf7935112012-12-03 18:12:45 +0000568FormatStyle getLLVMStyle() {
569 FormatStyle LLVMStyle;
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000570 LLVMStyle.Language = FormatStyle::LK_Cpp;
Daniel Jasperf7935112012-12-03 18:12:45 +0000571 LLVMStyle.AccessModifierOffset = -2;
Daniel Jasper7fdbb3f2017-05-08 15:08:00 +0000572 LLVMStyle.AlignEscapedNewlines = FormatStyle::ENAS_Right;
Daniel Jasper6501f7e2015-10-27 12:38:37 +0000573 LLVMStyle.AlignAfterOpenBracket = FormatStyle::BAS_Align;
Daniel Jasper3219e432014-12-02 13:24:51 +0000574 LLVMStyle.AlignOperands = true;
Daniel Jasper552f4a72013-07-31 23:55:15 +0000575 LLVMStyle.AlignTrailingComments = true;
Daniel Jaspera44991332015-04-29 13:06:49 +0000576 LLVMStyle.AlignConsecutiveAssignments = false;
Daniel Jaspere12597c2015-10-01 10:06:54 +0000577 LLVMStyle.AlignConsecutiveDeclarations = false;
Daniel Jasperf7db4332013-01-29 16:03:49 +0000578 LLVMStyle.AllowAllParametersOfDeclarationOnNextLine = true;
Daniel Jasperd74cf402014-04-08 12:46:38 +0000579 LLVMStyle.AllowShortFunctionsOnASingleLine = FormatStyle::SFS_All;
Daniel Jasper17605d32014-05-14 09:33:35 +0000580 LLVMStyle.AllowShortBlocksOnASingleLine = false;
Daniel Jasperb87899b2014-09-10 13:11:45 +0000581 LLVMStyle.AllowShortCaseLabelsOnASingleLine = false;
Daniel Jasper1b750ed2013-01-14 16:24:39 +0000582 LLVMStyle.AllowShortIfStatementsOnASingleLine = false;
Daniel Jasper3a685df2013-05-16 12:12:21 +0000583 LLVMStyle.AllowShortLoopsOnASingleLine = false;
Zachary Turner448592e2015-12-18 22:20:15 +0000584 LLVMStyle.AlwaysBreakAfterReturnType = FormatStyle::RTBS_None;
Birunthan Mohanathasa0388a82015-06-29 15:30:42 +0000585 LLVMStyle.AlwaysBreakAfterDefinitionReturnType = FormatStyle::DRTBS_None;
Alexander Kornienko58611712013-07-04 12:02:44 +0000586 LLVMStyle.AlwaysBreakBeforeMultilineStrings = false;
Daniel Jaspere33d4af2013-07-26 16:56:36 +0000587 LLVMStyle.AlwaysBreakTemplateDeclarations = false;
Daniel Jasper18210d72014-10-09 09:52:05 +0000588 LLVMStyle.BinPackArguments = true;
Francois Ferrande56a8292017-06-14 12:29:47 +0000589 LLVMStyle.BinPackParameters = true;
Daniel Jasperac043c92014-09-15 11:11:00 +0000590 LLVMStyle.BreakBeforeBinaryOperators = FormatStyle::BOS_None;
Daniel Jasper165b29e2013-11-08 00:57:11 +0000591 LLVMStyle.BreakBeforeTernaryOperators = true;
Daniel Jaspere33d4af2013-07-26 16:56:36 +0000592 LLVMStyle.BreakBeforeBraces = FormatStyle::BS_Attach;
Manuel Klimek89628f62017-09-20 09:51:03 +0000593 LLVMStyle.BraceWrapping = {false, false, false, false, false,
594 false, false, false, false, false,
595 false, false, true, true, true};
Nico Weber2cd92f12015-10-15 16:03:01 +0000596 LLVMStyle.BreakAfterJavaFieldAnnotations = false;
Francois Ferranda6b6d512017-05-24 11:36:58 +0000597 LLVMStyle.BreakConstructorInitializers = FormatStyle::BCIS_BeforeColon;
Andi-Bogdan Postelnicu0ef8ee12017-03-10 15:10:37 +0000598 LLVMStyle.BreakBeforeInheritanceComma = false;
Daniel Jaspere1a7b762016-02-01 11:21:02 +0000599 LLVMStyle.BreakStringLiterals = true;
Alexander Kornienkoc8602662013-05-06 14:11:27 +0000600 LLVMStyle.ColumnLimit = 80;
Daniel Jaspere1e43192014-04-01 12:55:11 +0000601 LLVMStyle.CommentPragmas = "^ IWYU pragma:";
Francois Ferrande56a8292017-06-14 12:29:47 +0000602 LLVMStyle.CompactNamespaces = false;
Alexander Kornienkoc8602662013-05-06 14:11:27 +0000603 LLVMStyle.ConstructorInitializerAllOnOneLineOrOnePerLine = false;
Daniel Jaspercdaffa42013-08-13 10:58:30 +0000604 LLVMStyle.ConstructorInitializerIndentWidth = 4;
Daniel Jaspere1e43192014-04-01 12:55:11 +0000605 LLVMStyle.ContinuationIndentWidth = 4;
Chandler Carruthf8b72662014-03-02 12:37:31 +0000606 LLVMStyle.Cpp11BracedListStyle = true;
Daniel Jasper553d4872014-06-17 12:40:34 +0000607 LLVMStyle.DerivePointerAlignment = false;
Daniel Jasperb10cbc42013-07-10 14:02:49 +0000608 LLVMStyle.ExperimentalAutoDetectBinPacking = false;
Krasimir Georgiev32eaa862017-03-01 15:35:39 +0000609 LLVMStyle.FixNamespaceComments = true;
Daniel Jaspere1e43192014-04-01 12:55:11 +0000610 LLVMStyle.ForEachMacros.push_back("foreach");
611 LLVMStyle.ForEachMacros.push_back("Q_FOREACH");
612 LLVMStyle.ForEachMacros.push_back("BOOST_FOREACH");
Daniel Jasper85c472d2015-09-29 07:53:08 +0000613 LLVMStyle.IncludeCategories = {{"^\"(llvm|llvm-c|clang|clang-c)/", 2},
Chandler Carruthd676ab12017-06-29 23:20:54 +0000614 {"^(<|\"(gtest|gmock|isl|json)/)", 3},
Daniel Jasper85c472d2015-09-29 07:53:08 +0000615 {".*", 1}};
Chandler Carruthd676ab12017-06-29 23:20:54 +0000616 LLVMStyle.IncludeIsMainRegex = "(Test)?$";
Alexander Kornienkoc8602662013-05-06 14:11:27 +0000617 LLVMStyle.IndentCaseLabels = false;
Krasimir Georgievad47c902017-08-30 14:34:57 +0000618 LLVMStyle.IndentPPDirectives = FormatStyle::PPDIS_None;
Daniel Jasperc75e1ef2014-07-09 08:42:42 +0000619 LLVMStyle.IndentWrappedFunctionNames = false;
Daniel Jaspere33d4af2013-07-26 16:56:36 +0000620 LLVMStyle.IndentWidth = 2;
Martin Probstfb2342d2016-06-13 17:50:10 +0000621 LLVMStyle.JavaScriptQuotes = FormatStyle::JSQS_Leave;
622 LLVMStyle.JavaScriptWrapImports = true;
Alexander Kornienkoebb43ca2013-09-05 14:08:34 +0000623 LLVMStyle.TabWidth = 8;
Alexander Kornienkoc8602662013-05-06 14:11:27 +0000624 LLVMStyle.MaxEmptyLinesToKeep = 1;
Daniel Jaspera26fc5c2014-03-21 13:43:14 +0000625 LLVMStyle.KeepEmptyLinesAtTheStartOfBlocks = true;
Daniel Jasper65ee3472013-07-31 23:16:02 +0000626 LLVMStyle.NamespaceIndentation = FormatStyle::NI_None;
Daniel Jasper50d634b2014-10-28 16:53:38 +0000627 LLVMStyle.ObjCBlockIndentWidth = 2;
Daniel Jaspere9beea22014-01-28 15:20:33 +0000628 LLVMStyle.ObjCSpaceAfterProperty = false;
Nico Webera6087752013-01-10 20:12:55 +0000629 LLVMStyle.ObjCSpaceBeforeProtocolList = true;
Daniel Jasper553d4872014-06-17 12:40:34 +0000630 LLVMStyle.PointerAlignment = FormatStyle::PAS_Right;
Alexander Kornienkoc8602662013-05-06 14:11:27 +0000631 LLVMStyle.SpacesBeforeTrailingComments = 1;
Chandler Carruthf8b72662014-03-02 12:37:31 +0000632 LLVMStyle.Standard = FormatStyle::LS_Cpp11;
Alexander Kornienko3c3d09c2013-09-27 16:14:22 +0000633 LLVMStyle.UseTab = FormatStyle::UT_Never;
Krasimir Georgiev9ad83fe2017-10-30 14:01:50 +0000634 LLVMStyle.RawStringFormats = {{"pb", FormatStyle::LK_TextProto, "google"}};
Daniel Jaspera0a50392015-12-01 13:28:53 +0000635 LLVMStyle.ReflowComments = true;
Daniel Jasperb55acad2013-08-20 12:36:34 +0000636 LLVMStyle.SpacesInParentheses = false;
Daniel Jasperad981f82014-08-26 11:41:14 +0000637 LLVMStyle.SpacesInSquareBrackets = false;
Daniel Jasperb55acad2013-08-20 12:36:34 +0000638 LLVMStyle.SpaceInEmptyParentheses = false;
Daniel Jasperb2e10a52014-01-15 15:09:08 +0000639 LLVMStyle.SpacesInContainerLiterals = true;
Daniel Jasperb55acad2013-08-20 12:36:34 +0000640 LLVMStyle.SpacesInCStyleCastParentheses = false;
Daniel Jasperdb986eb2014-09-03 07:37:29 +0000641 LLVMStyle.SpaceAfterCStyleCast = false;
Sylvestre Ledru83bbd572016-08-09 14:24:40 +0000642 LLVMStyle.SpaceAfterTemplateKeyword = true;
Alexander Kornienkofdca83d2013-12-10 10:18:34 +0000643 LLVMStyle.SpaceBeforeParens = FormatStyle::SBPO_ControlStatements;
Daniel Jasperd94bff32013-09-25 15:15:02 +0000644 LLVMStyle.SpaceBeforeAssignmentOperators = true;
Daniel Jasperdd978ae2013-10-29 14:52:02 +0000645 LLVMStyle.SpacesInAngles = false;
Daniel Jasper4e9678f2013-07-11 20:41:21 +0000646
Francois Ferrand9976efa2017-05-22 08:28:17 +0000647 LLVMStyle.PenaltyBreakAssignment = prec::Assignment;
Daniel Jasper19a541e2013-12-19 16:45:34 +0000648 LLVMStyle.PenaltyBreakComment = 300;
Alexander Kornienkofe7a57f2013-12-10 15:42:15 +0000649 LLVMStyle.PenaltyBreakFirstLessLess = 120;
650 LLVMStyle.PenaltyBreakString = 1000;
651 LLVMStyle.PenaltyExcessCharacter = 1000000;
Daniel Jasper4e9678f2013-07-11 20:41:21 +0000652 LLVMStyle.PenaltyReturnTypeOnItsOwnLine = 60;
Daniel Jasper33b909c2013-10-25 14:29:37 +0000653 LLVMStyle.PenaltyBreakBeforeFirstCallParameter = 19;
Daniel Jasper4e9678f2013-07-11 20:41:21 +0000654
Daniel Jasperc64b09a2014-05-22 15:12:22 +0000655 LLVMStyle.DisableFormat = false;
Daniel Jasperda446772015-11-16 12:38:56 +0000656 LLVMStyle.SortIncludes = true;
Krasimir Georgievac16a202017-06-23 11:46:03 +0000657 LLVMStyle.SortUsingDeclarations = true;
Daniel Jasperc64b09a2014-05-22 15:12:22 +0000658
Daniel Jasperf7935112012-12-03 18:12:45 +0000659 return LLVMStyle;
660}
661
Nico Weber514ecc82014-02-02 20:50:45 +0000662FormatStyle getGoogleStyle(FormatStyle::LanguageKind Language) {
Krasimir Georgiev26b144c2017-07-03 15:05:14 +0000663 if (Language == FormatStyle::LK_TextProto) {
664 FormatStyle GoogleStyle = getGoogleStyle(FormatStyle::LK_Proto);
665 GoogleStyle.Language = FormatStyle::LK_TextProto;
666 return GoogleStyle;
667 }
668
Alexander Kornienkofe7a57f2013-12-10 15:42:15 +0000669 FormatStyle GoogleStyle = getLLVMStyle();
Nico Weber514ecc82014-02-02 20:50:45 +0000670 GoogleStyle.Language = Language;
671
Daniel Jasperf7935112012-12-03 18:12:45 +0000672 GoogleStyle.AccessModifierOffset = -1;
Daniel Jasper7fdbb3f2017-05-08 15:08:00 +0000673 GoogleStyle.AlignEscapedNewlines = FormatStyle::ENAS_Left;
Daniel Jasper085a2ed2013-04-24 13:46:00 +0000674 GoogleStyle.AllowShortIfStatementsOnASingleLine = true;
Daniel Jasper5bd0b9e2013-05-23 18:05:18 +0000675 GoogleStyle.AllowShortLoopsOnASingleLine = true;
Alexander Kornienko58611712013-07-04 12:02:44 +0000676 GoogleStyle.AlwaysBreakBeforeMultilineStrings = true;
Daniel Jaspere33d4af2013-07-26 16:56:36 +0000677 GoogleStyle.AlwaysBreakTemplateDeclarations = true;
Alexander Kornienkoc8602662013-05-06 14:11:27 +0000678 GoogleStyle.ConstructorInitializerAllOnOneLineOrOnePerLine = true;
Daniel Jasper553d4872014-06-17 12:40:34 +0000679 GoogleStyle.DerivePointerAlignment = true;
Krasimir Georgieva84e7872017-09-26 14:58:29 +0000680 GoogleStyle.IncludeCategories = {
681 {"^<ext/.*\\.h>", 2}, {"^<.*\\.h>", 1}, {"^<.*", 2}, {".*", 3}};
Daniel Jasper9c8ff352016-03-21 14:11:27 +0000682 GoogleStyle.IncludeIsMainRegex = "([-_](test|unittest))?$";
Alexander Kornienkoc8602662013-05-06 14:11:27 +0000683 GoogleStyle.IndentCaseLabels = true;
Daniel Jaspera26fc5c2014-03-21 13:43:14 +0000684 GoogleStyle.KeepEmptyLinesAtTheStartOfBlocks = false;
Daniel Jaspere9beea22014-01-28 15:20:33 +0000685 GoogleStyle.ObjCSpaceAfterProperty = false;
Nico Webera6087752013-01-10 20:12:55 +0000686 GoogleStyle.ObjCSpaceBeforeProtocolList = false;
Daniel Jasper553d4872014-06-17 12:40:34 +0000687 GoogleStyle.PointerAlignment = FormatStyle::PAS_Left;
Alexander Kornienkoc8602662013-05-06 14:11:27 +0000688 GoogleStyle.SpacesBeforeTrailingComments = 2;
689 GoogleStyle.Standard = FormatStyle::LS_Auto;
Daniel Jasper4e9678f2013-07-11 20:41:21 +0000690
Daniel Jasper4e9678f2013-07-11 20:41:21 +0000691 GoogleStyle.PenaltyReturnTypeOnItsOwnLine = 200;
Daniel Jasper33b909c2013-10-25 14:29:37 +0000692 GoogleStyle.PenaltyBreakBeforeFirstCallParameter = 1;
Daniel Jasper4e9678f2013-07-11 20:41:21 +0000693
Daniel Jasperc58c70e2014-09-15 11:21:46 +0000694 if (Language == FormatStyle::LK_Java) {
Daniel Jasper6501f7e2015-10-27 12:38:37 +0000695 GoogleStyle.AlignAfterOpenBracket = FormatStyle::BAS_DontAlign;
Daniel Jasper3219e432014-12-02 13:24:51 +0000696 GoogleStyle.AlignOperands = false;
Daniel Jasperfd4ed182015-01-04 20:40:45 +0000697 GoogleStyle.AlignTrailingComments = false;
Daniel Jasper9e709352014-11-26 10:43:58 +0000698 GoogleStyle.AllowShortFunctionsOnASingleLine = FormatStyle::SFS_Empty;
Daniel Jasperfd4ed182015-01-04 20:40:45 +0000699 GoogleStyle.AllowShortIfStatementsOnASingleLine = false;
Daniel Jasper1cd3c712015-01-14 12:24:59 +0000700 GoogleStyle.AlwaysBreakBeforeMultilineStrings = false;
Daniel Jasperc58c70e2014-09-15 11:21:46 +0000701 GoogleStyle.BreakBeforeBinaryOperators = FormatStyle::BOS_NonAssignment;
702 GoogleStyle.ColumnLimit = 100;
703 GoogleStyle.SpaceAfterCStyleCast = true;
Daniel Jasper61d81972014-11-14 08:22:46 +0000704 GoogleStyle.SpacesBeforeTrailingComments = 1;
Daniel Jasperc58c70e2014-09-15 11:21:46 +0000705 } else if (Language == FormatStyle::LK_JavaScript) {
Daniel Jasper6501f7e2015-10-27 12:38:37 +0000706 GoogleStyle.AlignAfterOpenBracket = FormatStyle::BAS_AlwaysBreak;
Daniel Jasper41a2bf72015-12-21 13:52:19 +0000707 GoogleStyle.AlignOperands = false;
Daniel Jasper28d8a5a2016-09-07 23:01:13 +0000708 GoogleStyle.AllowShortFunctionsOnASingleLine = FormatStyle::SFS_Empty;
Daniel Jasper6501f7e2015-10-27 12:38:37 +0000709 GoogleStyle.AlwaysBreakBeforeMultilineStrings = false;
Daniel Jaspere551bb72014-11-05 17:22:31 +0000710 GoogleStyle.BreakBeforeTernaryOperators = false;
Martin Probst2083f312017-05-09 12:45:48 +0000711 // taze:, triple slash directives (`/// <...`), @tag followed by { for a lot
712 // of JSDoc tags, and @see, which is commonly followed by overlong URLs.
713 GoogleStyle.CommentPragmas =
714 "(taze:|^/[ \t]*<|(@[A-Za-z_0-9-]+[ \\t]*{)|@see)";
Daniel Jasper8f83a902014-05-09 10:28:58 +0000715 GoogleStyle.MaxEmptyLinesToKeep = 3;
Martin Probstece8c0c2016-06-13 16:41:28 +0000716 GoogleStyle.NamespaceIndentation = FormatStyle::NI_All;
Nico Weber514ecc82014-02-02 20:50:45 +0000717 GoogleStyle.SpacesInContainerLiterals = false;
Daniel Jasperabd1f572016-03-02 22:44:03 +0000718 GoogleStyle.JavaScriptQuotes = FormatStyle::JSQS_Single;
Martin Probst0cd74ee2016-06-13 16:39:50 +0000719 GoogleStyle.JavaScriptWrapImports = false;
Nico Weber514ecc82014-02-02 20:50:45 +0000720 } else if (Language == FormatStyle::LK_Proto) {
Daniel Jasperd74cf402014-04-08 12:46:38 +0000721 GoogleStyle.AllowShortFunctionsOnASingleLine = FormatStyle::SFS_None;
Daniel Jasper783bac62014-04-15 09:54:30 +0000722 GoogleStyle.SpacesInContainerLiterals = false;
Daniel Jasper03a04fe2016-12-12 12:42:29 +0000723 } else if (Language == FormatStyle::LK_ObjC) {
724 GoogleStyle.ColumnLimit = 100;
Nico Weber514ecc82014-02-02 20:50:45 +0000725 }
726
Daniel Jasperf7935112012-12-03 18:12:45 +0000727 return GoogleStyle;
728}
729
Nico Weber514ecc82014-02-02 20:50:45 +0000730FormatStyle getChromiumStyle(FormatStyle::LanguageKind Language) {
731 FormatStyle ChromiumStyle = getGoogleStyle(Language);
Nico Weber450425c2014-11-26 16:43:18 +0000732 if (Language == FormatStyle::LK_Java) {
Daniel Jasperfd4ed182015-01-04 20:40:45 +0000733 ChromiumStyle.AllowShortIfStatementsOnASingleLine = true;
Nico Weber2cd92f12015-10-15 16:03:01 +0000734 ChromiumStyle.BreakAfterJavaFieldAnnotations = true;
Nico Weber450425c2014-11-26 16:43:18 +0000735 ChromiumStyle.ContinuationIndentWidth = 8;
Nico Weber2cd92f12015-10-15 16:03:01 +0000736 ChromiumStyle.IndentWidth = 4;
Nico Weberea649692017-01-04 02:33:36 +0000737 } else if (Language == FormatStyle::LK_JavaScript) {
738 ChromiumStyle.AllowShortIfStatementsOnASingleLine = false;
739 ChromiumStyle.AllowShortLoopsOnASingleLine = false;
Nico Weber450425c2014-11-26 16:43:18 +0000740 } else {
741 ChromiumStyle.AllowAllParametersOfDeclarationOnNextLine = false;
742 ChromiumStyle.AllowShortFunctionsOnASingleLine = FormatStyle::SFS_Inline;
743 ChromiumStyle.AllowShortIfStatementsOnASingleLine = false;
744 ChromiumStyle.AllowShortLoopsOnASingleLine = false;
745 ChromiumStyle.BinPackParameters = false;
746 ChromiumStyle.DerivePointerAlignment = false;
Nico Weber9e2bc302017-01-31 18:42:05 +0000747 if (Language == FormatStyle::LK_ObjC)
748 ChromiumStyle.ColumnLimit = 80;
Nico Weber450425c2014-11-26 16:43:18 +0000749 }
Daniel Jasper1b750ed2013-01-14 16:24:39 +0000750 return ChromiumStyle;
751}
752
Alexander Kornienkoc8602662013-05-06 14:11:27 +0000753FormatStyle getMozillaStyle() {
754 FormatStyle MozillaStyle = getLLVMStyle();
755 MozillaStyle.AllowAllParametersOfDeclarationOnNextLine = false;
Birunthan Mohanathasa0810022015-06-29 15:18:58 +0000756 MozillaStyle.AllowShortFunctionsOnASingleLine = FormatStyle::SFS_Inline;
Manuel Klimek89628f62017-09-20 09:51:03 +0000757 MozillaStyle.AlwaysBreakAfterReturnType = FormatStyle::RTBS_TopLevel;
Birunthan Mohanathasa0388a82015-06-29 15:30:42 +0000758 MozillaStyle.AlwaysBreakAfterDefinitionReturnType =
759 FormatStyle::DRTBS_TopLevel;
Birunthan Mohanathasa0810022015-06-29 15:18:58 +0000760 MozillaStyle.AlwaysBreakTemplateDeclarations = true;
Sylvestre Ledrudcb038d2016-12-14 16:09:29 +0000761 MozillaStyle.BinPackParameters = false;
762 MozillaStyle.BinPackArguments = false;
Birunthan Mohanathas305fa9c2015-07-12 03:13:54 +0000763 MozillaStyle.BreakBeforeBraces = FormatStyle::BS_Mozilla;
Francois Ferranda6b6d512017-05-24 11:36:58 +0000764 MozillaStyle.BreakConstructorInitializers = FormatStyle::BCIS_BeforeComma;
Andi-Bogdan Postelnicu0ef8ee12017-03-10 15:10:37 +0000765 MozillaStyle.BreakBeforeInheritanceComma = true;
Birunthan Mohanathasa0810022015-06-29 15:18:58 +0000766 MozillaStyle.ConstructorInitializerIndentWidth = 2;
767 MozillaStyle.ContinuationIndentWidth = 2;
Chandler Carruthf8b72662014-03-02 12:37:31 +0000768 MozillaStyle.Cpp11BracedListStyle = false;
Krasimir Georgiev32eaa862017-03-01 15:35:39 +0000769 MozillaStyle.FixNamespaceComments = false;
Alexander Kornienkoc8602662013-05-06 14:11:27 +0000770 MozillaStyle.IndentCaseLabels = true;
Daniel Jaspere9beea22014-01-28 15:20:33 +0000771 MozillaStyle.ObjCSpaceAfterProperty = true;
Alexander Kornienkoc8602662013-05-06 14:11:27 +0000772 MozillaStyle.ObjCSpaceBeforeProtocolList = false;
773 MozillaStyle.PenaltyReturnTypeOnItsOwnLine = 200;
Daniel Jasper553d4872014-06-17 12:40:34 +0000774 MozillaStyle.PointerAlignment = FormatStyle::PAS_Left;
Sylvestre Ledru83bbd572016-08-09 14:24:40 +0000775 MozillaStyle.SpaceAfterTemplateKeyword = false;
Alexander Kornienkoc8602662013-05-06 14:11:27 +0000776 return MozillaStyle;
777}
778
Daniel Jasperffefb3d2013-07-24 13:10:59 +0000779FormatStyle getWebKitStyle() {
780 FormatStyle Style = getLLVMStyle();
Daniel Jasper65ee3472013-07-31 23:16:02 +0000781 Style.AccessModifierOffset = -4;
Daniel Jasper6501f7e2015-10-27 12:38:37 +0000782 Style.AlignAfterOpenBracket = FormatStyle::BAS_DontAlign;
Daniel Jasper3219e432014-12-02 13:24:51 +0000783 Style.AlignOperands = false;
Daniel Jasper552f4a72013-07-31 23:55:15 +0000784 Style.AlignTrailingComments = false;
Daniel Jasperac043c92014-09-15 11:11:00 +0000785 Style.BreakBeforeBinaryOperators = FormatStyle::BOS_All;
Roman Kashitsyn291f64f2015-08-10 13:43:19 +0000786 Style.BreakBeforeBraces = FormatStyle::BS_WebKit;
Francois Ferranda6b6d512017-05-24 11:36:58 +0000787 Style.BreakConstructorInitializers = FormatStyle::BCIS_BeforeComma;
Chandler Carruthf8b72662014-03-02 12:37:31 +0000788 Style.Cpp11BracedListStyle = false;
Daniel Jasper65ee3472013-07-31 23:16:02 +0000789 Style.ColumnLimit = 0;
Krasimir Georgiev32eaa862017-03-01 15:35:39 +0000790 Style.FixNamespaceComments = false;
Daniel Jaspere33d4af2013-07-26 16:56:36 +0000791 Style.IndentWidth = 4;
Daniel Jasper65ee3472013-07-31 23:16:02 +0000792 Style.NamespaceIndentation = FormatStyle::NI_Inner;
Daniel Jasper50d634b2014-10-28 16:53:38 +0000793 Style.ObjCBlockIndentWidth = 4;
Daniel Jaspere9beea22014-01-28 15:20:33 +0000794 Style.ObjCSpaceAfterProperty = true;
Daniel Jasper553d4872014-06-17 12:40:34 +0000795 Style.PointerAlignment = FormatStyle::PAS_Left;
Daniel Jasperffefb3d2013-07-24 13:10:59 +0000796 return Style;
797}
798
Alexander Kornienkofe7a57f2013-12-10 15:42:15 +0000799FormatStyle getGNUStyle() {
800 FormatStyle Style = getLLVMStyle();
Birunthan Mohanathasa0388a82015-06-29 15:30:42 +0000801 Style.AlwaysBreakAfterDefinitionReturnType = FormatStyle::DRTBS_All;
Zachary Turner448592e2015-12-18 22:20:15 +0000802 Style.AlwaysBreakAfterReturnType = FormatStyle::RTBS_AllDefinitions;
Daniel Jasperac043c92014-09-15 11:11:00 +0000803 Style.BreakBeforeBinaryOperators = FormatStyle::BOS_All;
Alexander Kornienko3a33f022013-12-12 09:49:52 +0000804 Style.BreakBeforeBraces = FormatStyle::BS_GNU;
Alexander Kornienkofe7a57f2013-12-10 15:42:15 +0000805 Style.BreakBeforeTernaryOperators = true;
Chandler Carruthf8b72662014-03-02 12:37:31 +0000806 Style.Cpp11BracedListStyle = false;
Alexander Kornienkofe7a57f2013-12-10 15:42:15 +0000807 Style.ColumnLimit = 79;
Krasimir Georgiev32eaa862017-03-01 15:35:39 +0000808 Style.FixNamespaceComments = false;
Alexander Kornienkofe7a57f2013-12-10 15:42:15 +0000809 Style.SpaceBeforeParens = FormatStyle::SBPO_Always;
Chandler Carruthf8b72662014-03-02 12:37:31 +0000810 Style.Standard = FormatStyle::LS_Cpp03;
Alexander Kornienkofe7a57f2013-12-10 15:42:15 +0000811 return Style;
812}
813
Daniel Jasperc64b09a2014-05-22 15:12:22 +0000814FormatStyle getNoStyle() {
815 FormatStyle NoStyle = getLLVMStyle();
816 NoStyle.DisableFormat = true;
Daniel Jasperda446772015-11-16 12:38:56 +0000817 NoStyle.SortIncludes = false;
Krasimir Georgievac16a202017-06-23 11:46:03 +0000818 NoStyle.SortUsingDeclarations = false;
Daniel Jasperc64b09a2014-05-22 15:12:22 +0000819 return NoStyle;
820}
821
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000822bool getPredefinedStyle(StringRef Name, FormatStyle::LanguageKind Language,
823 FormatStyle *Style) {
824 if (Name.equals_lower("llvm")) {
Alexander Kornienko006b5c82013-05-19 00:53:30 +0000825 *Style = getLLVMStyle();
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000826 } else if (Name.equals_lower("chromium")) {
Nico Weber514ecc82014-02-02 20:50:45 +0000827 *Style = getChromiumStyle(Language);
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000828 } else if (Name.equals_lower("mozilla")) {
Alexander Kornienko006b5c82013-05-19 00:53:30 +0000829 *Style = getMozillaStyle();
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000830 } else if (Name.equals_lower("google")) {
Nico Weber514ecc82014-02-02 20:50:45 +0000831 *Style = getGoogleStyle(Language);
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000832 } else if (Name.equals_lower("webkit")) {
Daniel Jasperffefb3d2013-07-24 13:10:59 +0000833 *Style = getWebKitStyle();
Alexander Kornienkofe7a57f2013-12-10 15:42:15 +0000834 } else if (Name.equals_lower("gnu")) {
835 *Style = getGNUStyle();
Daniel Jasperc64b09a2014-05-22 15:12:22 +0000836 } else if (Name.equals_lower("none")) {
837 *Style = getNoStyle();
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000838 } else {
Alexander Kornienko006b5c82013-05-19 00:53:30 +0000839 return false;
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000840 }
Alexander Kornienkod6538332013-05-07 15:32:14 +0000841
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000842 Style->Language = Language;
Alexander Kornienko006b5c82013-05-19 00:53:30 +0000843 return true;
Alexander Kornienkod6538332013-05-07 15:32:14 +0000844}
845
Rafael Espindolac0809172014-06-12 14:02:15 +0000846std::error_code parseConfiguration(StringRef Text, FormatStyle *Style) {
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000847 assert(Style);
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000848 FormatStyle::LanguageKind Language = Style->Language;
849 assert(Language != FormatStyle::LK_None);
Alexander Kornienko06e00332013-05-20 15:18:01 +0000850 if (Text.trim().empty())
Rafael Espindolad0136702014-06-12 02:50:04 +0000851 return make_error_code(ParseError::Error);
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000852
853 std::vector<FormatStyle> Styles;
Alexander Kornienkod6538332013-05-07 15:32:14 +0000854 llvm::yaml::Input Input(Text);
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000855 // DocumentListTraits<vector<FormatStyle>> uses the context to get default
856 // values for the fields, keys for which are missing from the configuration.
857 // Mapping also uses the context to get the language to find the correct
858 // base style.
859 Input.setContext(Style);
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000860 Input >> Styles;
861 if (Input.error())
862 return Input.error();
863
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000864 for (unsigned i = 0; i < Styles.size(); ++i) {
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000865 // Ensures that only the first configuration can skip the Language option.
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000866 if (Styles[i].Language == FormatStyle::LK_None && i != 0)
Rafael Espindolad0136702014-06-12 02:50:04 +0000867 return make_error_code(ParseError::Error);
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000868 // Ensure that each language is configured at most once.
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000869 for (unsigned j = 0; j < i; ++j) {
870 if (Styles[i].Language == Styles[j].Language) {
871 DEBUG(llvm::dbgs()
872 << "Duplicate languages in the config file on positions " << j
873 << " and " << i << "\n");
Rafael Espindolad0136702014-06-12 02:50:04 +0000874 return make_error_code(ParseError::Error);
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000875 }
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000876 }
877 }
878 // Look for a suitable configuration starting from the end, so we can
879 // find the configuration for the specific language first, and the default
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000880 // configuration (which can only be at slot 0) after it.
881 for (int i = Styles.size() - 1; i >= 0; --i) {
882 if (Styles[i].Language == Language ||
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000883 Styles[i].Language == FormatStyle::LK_None) {
884 *Style = Styles[i];
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000885 Style->Language = Language;
Rafael Espindolad0136702014-06-12 02:50:04 +0000886 return make_error_code(ParseError::Success);
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000887 }
888 }
Rafael Espindolad0136702014-06-12 02:50:04 +0000889 return make_error_code(ParseError::Unsuitable);
Alexander Kornienkod6538332013-05-07 15:32:14 +0000890}
891
892std::string configurationAsText(const FormatStyle &Style) {
893 std::string Text;
894 llvm::raw_string_ostream Stream(Text);
895 llvm::yaml::Output Output(Stream);
896 // We use the same mapping method for input and output, so we need a non-const
897 // reference here.
Daniel Jasperc1bc38e2015-09-29 14:57:55 +0000898 FormatStyle NonConstStyle = expandPresets(Style);
Alexander Kornienkod6538332013-05-07 15:32:14 +0000899 Output << NonConstStyle;
Alexander Kornienko9a38ec22013-05-13 12:56:35 +0000900 return Stream.str();
Alexander Kornienkod6538332013-05-07 15:32:14 +0000901}
902
Craig Topperaf35e852013-06-30 22:29:28 +0000903namespace {
904
Daniel Jasper496c1992016-09-07 22:48:53 +0000905class JavaScriptRequoter : public TokenAnalyzer {
Eric Liu4cfb88a2016-04-25 15:09:22 +0000906public:
Daniel Jasper496c1992016-09-07 22:48:53 +0000907 JavaScriptRequoter(const Environment &Env, const FormatStyle &Style)
908 : TokenAnalyzer(Env, Style) {}
Eric Liu4cfb88a2016-04-25 15:09:22 +0000909
Krasimir Georgiev9ad83fe2017-10-30 14:01:50 +0000910 std::pair<tooling::Replacements, unsigned>
Eric Liu4cfb88a2016-04-25 15:09:22 +0000911 analyze(TokenAnnotator &Annotator,
912 SmallVectorImpl<AnnotatedLine *> &AnnotatedLines,
Martin Probsta9855af2016-09-02 14:29:48 +0000913 FormatTokenLexer &Tokens) override {
Eric Liu4cfb88a2016-04-25 15:09:22 +0000914 AffectedRangeMgr.computeAffectedLines(AnnotatedLines.begin(),
915 AnnotatedLines.end());
Daniel Jasper496c1992016-09-07 22:48:53 +0000916 tooling::Replacements Result;
917 requoteJSStringLiteral(AnnotatedLines, Result);
Krasimir Georgiev9ad83fe2017-10-30 14:01:50 +0000918 return {Result, 0};
Alexander Kornienko62b85b92013-03-13 14:41:29 +0000919 }
920
921private:
Daniel Jasper496c1992016-09-07 22:48:53 +0000922 // Replaces double/single-quoted string literal as appropriate, re-escaping
923 // the contents in the process.
Daniel Jasper97439922016-03-17 13:03:41 +0000924 void requoteJSStringLiteral(SmallVectorImpl<AnnotatedLine *> &Lines,
Eric Liu4cfb88a2016-04-25 15:09:22 +0000925 tooling::Replacements &Result) {
Daniel Jasper97439922016-03-17 13:03:41 +0000926 for (AnnotatedLine *Line : Lines) {
927 requoteJSStringLiteral(Line->Children, Result);
928 if (!Line->Affected)
929 continue;
930 for (FormatToken *FormatTok = Line->First; FormatTok;
931 FormatTok = FormatTok->Next) {
932 StringRef Input = FormatTok->TokenText;
Martin Probsta1669792016-05-12 11:20:32 +0000933 if (FormatTok->Finalized || !FormatTok->isStringLiteral() ||
Daniel Jasper97439922016-03-17 13:03:41 +0000934 // NB: testing for not starting with a double quote to avoid
Daniel Jasper496c1992016-09-07 22:48:53 +0000935 // breaking `template strings`.
Eric Liu635423e2016-04-28 07:52:03 +0000936 (Style.JavaScriptQuotes == FormatStyle::JSQS_Single &&
Daniel Jasper97439922016-03-17 13:03:41 +0000937 !Input.startswith("\"")) ||
Eric Liu635423e2016-04-28 07:52:03 +0000938 (Style.JavaScriptQuotes == FormatStyle::JSQS_Double &&
Daniel Jasper97439922016-03-17 13:03:41 +0000939 !Input.startswith("\'")))
940 continue;
941
942 // Change start and end quote.
Eric Liu635423e2016-04-28 07:52:03 +0000943 bool IsSingle = Style.JavaScriptQuotes == FormatStyle::JSQS_Single;
Daniel Jasper97439922016-03-17 13:03:41 +0000944 SourceLocation Start = FormatTok->Tok.getLocation();
945 auto Replace = [&](SourceLocation Start, unsigned Length,
946 StringRef ReplacementText) {
Eric Liu40ef2fb2016-08-01 10:16:37 +0000947 auto Err = Result.add(tooling::Replacement(
948 Env.getSourceManager(), Start, Length, ReplacementText));
949 // FIXME: handle error. For now, print error message and skip the
950 // replacement for release version.
Piotr Padlewski1ec383c2016-12-23 11:40:44 +0000951 if (Err) {
Eric Liu40ef2fb2016-08-01 10:16:37 +0000952 llvm::errs() << llvm::toString(std::move(Err)) << "\n";
Piotr Padlewski1ec383c2016-12-23 11:40:44 +0000953 assert(false);
954 }
Daniel Jasper97439922016-03-17 13:03:41 +0000955 };
956 Replace(Start, 1, IsSingle ? "'" : "\"");
957 Replace(FormatTok->Tok.getEndLoc().getLocWithOffset(-1), 1,
958 IsSingle ? "'" : "\"");
959
960 // Escape internal quotes.
Daniel Jasper97439922016-03-17 13:03:41 +0000961 bool Escaped = false;
962 for (size_t i = 1; i < Input.size() - 1; i++) {
963 switch (Input[i]) {
Eric Liu4cfb88a2016-04-25 15:09:22 +0000964 case '\\':
965 if (!Escaped && i + 1 < Input.size() &&
966 ((IsSingle && Input[i + 1] == '"') ||
967 (!IsSingle && Input[i + 1] == '\''))) {
968 // Remove this \, it's escaping a " or ' that no longer needs
969 // escaping
Eric Liu4cfb88a2016-04-25 15:09:22 +0000970 Replace(Start.getLocWithOffset(i), 1, "");
971 continue;
972 }
973 Escaped = !Escaped;
974 break;
975 case '\"':
976 case '\'':
977 if (!Escaped && IsSingle == (Input[i] == '\'')) {
978 // Escape the quote.
979 Replace(Start.getLocWithOffset(i), 0, "\\");
Eric Liu4cfb88a2016-04-25 15:09:22 +0000980 }
981 Escaped = false;
982 break;
983 default:
984 Escaped = false;
985 break;
Daniel Jasper97439922016-03-17 13:03:41 +0000986 }
987 }
Daniel Jasper97439922016-03-17 13:03:41 +0000988 }
989 }
990 }
Daniel Jasper496c1992016-09-07 22:48:53 +0000991};
992
993class Formatter : public TokenAnalyzer {
994public:
995 Formatter(const Environment &Env, const FormatStyle &Style,
Krasimir Georgievbcda54b2017-04-21 14:35:20 +0000996 FormattingAttemptStatus *Status)
997 : TokenAnalyzer(Env, Style), Status(Status) {}
Daniel Jasper496c1992016-09-07 22:48:53 +0000998
Krasimir Georgiev9ad83fe2017-10-30 14:01:50 +0000999 std::pair<tooling::Replacements, unsigned>
Daniel Jasper496c1992016-09-07 22:48:53 +00001000 analyze(TokenAnnotator &Annotator,
1001 SmallVectorImpl<AnnotatedLine *> &AnnotatedLines,
1002 FormatTokenLexer &Tokens) override {
1003 tooling::Replacements Result;
1004 deriveLocalStyle(AnnotatedLines);
1005 AffectedRangeMgr.computeAffectedLines(AnnotatedLines.begin(),
1006 AnnotatedLines.end());
1007 for (unsigned i = 0, e = AnnotatedLines.size(); i != e; ++i) {
1008 Annotator.calculateFormattingInformation(*AnnotatedLines[i]);
1009 }
1010 Annotator.setCommentLineLevels(AnnotatedLines);
1011
1012 WhitespaceManager Whitespaces(
1013 Env.getSourceManager(), Style,
1014 inputUsesCRLF(Env.getSourceManager().getBufferData(Env.getFileID())));
1015 ContinuationIndenter Indenter(Style, Tokens.getKeywords(),
1016 Env.getSourceManager(), Whitespaces, Encoding,
1017 BinPackInconclusiveFunctions);
Krasimir Georgiev9ad83fe2017-10-30 14:01:50 +00001018 unsigned Penalty =
1019 UnwrappedLineFormatter(&Indenter, &Whitespaces, Style,
1020 Tokens.getKeywords(), Env.getSourceManager(),
1021 Status)
1022 .format(AnnotatedLines, /*DryRun=*/false,
1023 /*AdditionalIndent=*/0,
1024 /*FixBadIndentation=*/false,
1025 /*FirstStartColumn=*/Env.getFirstStartColumn(),
1026 /*NextStartColumn=*/Env.getNextStartColumn(),
1027 /*LastStartColumn=*/Env.getLastStartColumn());
Daniel Jasper496c1992016-09-07 22:48:53 +00001028 for (const auto &R : Whitespaces.generateReplacements())
1029 if (Result.add(R))
Krasimir Georgiev9ad83fe2017-10-30 14:01:50 +00001030 return {Result, 0};
1031 return {Result, Penalty};
Daniel Jasper496c1992016-09-07 22:48:53 +00001032 }
1033
1034private:
Alexander Kornienko9e649af2013-09-11 12:25:57 +00001035 static bool inputUsesCRLF(StringRef Text) {
1036 return Text.count('\r') * 2 > Text.count('\n');
1037 }
1038
Daniel Jasper352f0df2015-07-18 16:35:30 +00001039 bool
1040 hasCpp03IncompatibleFormat(const SmallVectorImpl<AnnotatedLine *> &Lines) {
Eric Liu4cfb88a2016-04-25 15:09:22 +00001041 for (const AnnotatedLine *Line : Lines) {
Daniel Jasper352f0df2015-07-18 16:35:30 +00001042 if (hasCpp03IncompatibleFormat(Line->Children))
1043 return true;
1044 for (FormatToken *Tok = Line->First->Next; Tok; Tok = Tok->Next) {
1045 if (Tok->WhitespaceRange.getBegin() == Tok->WhitespaceRange.getEnd()) {
1046 if (Tok->is(tok::coloncolon) && Tok->Previous->is(TT_TemplateOpener))
1047 return true;
1048 if (Tok->is(TT_TemplateCloser) &&
1049 Tok->Previous->is(TT_TemplateCloser))
1050 return true;
1051 }
1052 }
1053 }
1054 return false;
1055 }
1056
1057 int countVariableAlignments(const SmallVectorImpl<AnnotatedLine *> &Lines) {
1058 int AlignmentDiff = 0;
Eric Liu4cfb88a2016-04-25 15:09:22 +00001059 for (const AnnotatedLine *Line : Lines) {
Daniel Jasper352f0df2015-07-18 16:35:30 +00001060 AlignmentDiff += countVariableAlignments(Line->Children);
1061 for (FormatToken *Tok = Line->First; Tok && Tok->Next; Tok = Tok->Next) {
1062 if (!Tok->is(TT_PointerOrReference))
1063 continue;
1064 bool SpaceBefore =
1065 Tok->WhitespaceRange.getBegin() != Tok->WhitespaceRange.getEnd();
1066 bool SpaceAfter = Tok->Next->WhitespaceRange.getBegin() !=
1067 Tok->Next->WhitespaceRange.getEnd();
1068 if (SpaceBefore && !SpaceAfter)
1069 ++AlignmentDiff;
1070 if (!SpaceBefore && SpaceAfter)
1071 --AlignmentDiff;
1072 }
1073 }
1074 return AlignmentDiff;
1075 }
1076
Manuel Klimek71814b42013-10-11 21:25:45 +00001077 void
1078 deriveLocalStyle(const SmallVectorImpl<AnnotatedLine *> &AnnotatedLines) {
Daniel Jasperb10cbc42013-07-10 14:02:49 +00001079 bool HasBinPackedFunction = false;
1080 bool HasOnePerLineFunction = false;
Daniel Jasper7fce3ab2013-02-06 14:22:40 +00001081 for (unsigned i = 0, e = AnnotatedLines.size(); i != e; ++i) {
Daniel Jasper9fe0e8d2013-09-05 09:29:45 +00001082 if (!AnnotatedLines[i]->First->Next)
Daniel Jasper7fce3ab2013-02-06 14:22:40 +00001083 continue;
Daniel Jasper9fe0e8d2013-09-05 09:29:45 +00001084 FormatToken *Tok = AnnotatedLines[i]->First->Next;
Manuel Klimek6e6310e2013-05-29 14:47:47 +00001085 while (Tok->Next) {
Daniel Jasperb10cbc42013-07-10 14:02:49 +00001086 if (Tok->PackingKind == PPK_BinPacked)
1087 HasBinPackedFunction = true;
1088 if (Tok->PackingKind == PPK_OnePerLine)
1089 HasOnePerLineFunction = true;
1090
Manuel Klimek6e6310e2013-05-29 14:47:47 +00001091 Tok = Tok->Next;
Daniel Jasper7fce3ab2013-02-06 14:22:40 +00001092 }
1093 }
Eric Liu635423e2016-04-28 07:52:03 +00001094 if (Style.DerivePointerAlignment)
1095 Style.PointerAlignment = countVariableAlignments(AnnotatedLines) <= 0
1096 ? FormatStyle::PAS_Left
1097 : FormatStyle::PAS_Right;
1098 if (Style.Standard == FormatStyle::LS_Auto)
1099 Style.Standard = hasCpp03IncompatibleFormat(AnnotatedLines)
1100 ? FormatStyle::LS_Cpp11
1101 : FormatStyle::LS_Cpp03;
Daniel Jasperb10cbc42013-07-10 14:02:49 +00001102 BinPackInconclusiveFunctions =
1103 HasBinPackedFunction || !HasOnePerLineFunction;
Daniel Jasper7fce3ab2013-02-06 14:22:40 +00001104 }
1105
Daniel Jasperb10cbc42013-07-10 14:02:49 +00001106 bool BinPackInconclusiveFunctions;
Krasimir Georgievbcda54b2017-04-21 14:35:20 +00001107 FormattingAttemptStatus *Status;
Eric Liu4cfb88a2016-04-25 15:09:22 +00001108};
1109
1110// This class clean up the erroneous/redundant code around the given ranges in
1111// file.
1112class Cleaner : public TokenAnalyzer {
1113public:
Eric Liu635423e2016-04-28 07:52:03 +00001114 Cleaner(const Environment &Env, const FormatStyle &Style)
1115 : TokenAnalyzer(Env, Style),
Eric Liu4cfb88a2016-04-25 15:09:22 +00001116 DeletedTokens(FormatTokenLess(Env.getSourceManager())) {}
1117
1118 // FIXME: eliminate unused parameters.
Krasimir Georgiev9ad83fe2017-10-30 14:01:50 +00001119 std::pair<tooling::Replacements, unsigned>
Eric Liu4cfb88a2016-04-25 15:09:22 +00001120 analyze(TokenAnnotator &Annotator,
1121 SmallVectorImpl<AnnotatedLine *> &AnnotatedLines,
Martin Probsta9855af2016-09-02 14:29:48 +00001122 FormatTokenLexer &Tokens) override {
Eric Liu4cfb88a2016-04-25 15:09:22 +00001123 // FIXME: in the current implementation the granularity of affected range
1124 // is an annotated line. However, this is not sufficient. Furthermore,
1125 // redundant code introduced by replacements does not necessarily
1126 // intercept with ranges of replacements that result in the redundancy.
1127 // To determine if some redundant code is actually introduced by
1128 // replacements(e.g. deletions), we need to come up with a more
1129 // sophisticated way of computing affected ranges.
1130 AffectedRangeMgr.computeAffectedLines(AnnotatedLines.begin(),
1131 AnnotatedLines.end());
1132
1133 checkEmptyNamespace(AnnotatedLines);
1134
Eric Liuce5e4bc2016-05-18 08:02:56 +00001135 for (auto &Line : AnnotatedLines) {
1136 if (Line->Affected) {
1137 cleanupRight(Line->First, tok::comma, tok::comma);
1138 cleanupRight(Line->First, TT_CtorInitializerColon, tok::comma);
Eric Liu2574d152016-09-13 15:02:43 +00001139 cleanupRight(Line->First, tok::l_paren, tok::comma);
1140 cleanupLeft(Line->First, tok::comma, tok::r_paren);
Eric Liuce5e4bc2016-05-18 08:02:56 +00001141 cleanupLeft(Line->First, TT_CtorInitializerComma, tok::l_brace);
1142 cleanupLeft(Line->First, TT_CtorInitializerColon, tok::l_brace);
Malcolm Parsons5d8cdb82016-10-20 14:58:45 +00001143 cleanupLeft(Line->First, TT_CtorInitializerColon, tok::equal);
Eric Liuce5e4bc2016-05-18 08:02:56 +00001144 }
1145 }
1146
Krasimir Georgiev9ad83fe2017-10-30 14:01:50 +00001147 return {generateFixes(), 0};
Eric Liu4cfb88a2016-04-25 15:09:22 +00001148 }
1149
1150private:
1151 bool containsOnlyComments(const AnnotatedLine &Line) {
1152 for (FormatToken *Tok = Line.First; Tok != nullptr; Tok = Tok->Next) {
1153 if (Tok->isNot(tok::comment))
1154 return false;
1155 }
1156 return true;
1157 }
1158
1159 // Iterate through all lines and remove any empty (nested) namespaces.
1160 void checkEmptyNamespace(SmallVectorImpl<AnnotatedLine *> &AnnotatedLines) {
Eric Liu7956c402016-10-05 15:49:01 +00001161 std::set<unsigned> DeletedLines;
Eric Liu4cfb88a2016-04-25 15:09:22 +00001162 for (unsigned i = 0, e = AnnotatedLines.size(); i != e; ++i) {
1163 auto &Line = *AnnotatedLines[i];
1164 if (Line.startsWith(tok::kw_namespace) ||
1165 Line.startsWith(tok::kw_inline, tok::kw_namespace)) {
Eric Liu7956c402016-10-05 15:49:01 +00001166 checkEmptyNamespace(AnnotatedLines, i, i, DeletedLines);
Eric Liu4cfb88a2016-04-25 15:09:22 +00001167 }
1168 }
1169
1170 for (auto Line : DeletedLines) {
1171 FormatToken *Tok = AnnotatedLines[Line]->First;
1172 while (Tok) {
1173 deleteToken(Tok);
1174 Tok = Tok->Next;
1175 }
1176 }
1177 }
1178
1179 // The function checks if the namespace, which starts from \p CurrentLine, and
1180 // its nested namespaces are empty and delete them if they are empty. It also
1181 // sets \p NewLine to the last line checked.
1182 // Returns true if the current namespace is empty.
1183 bool checkEmptyNamespace(SmallVectorImpl<AnnotatedLine *> &AnnotatedLines,
Eric Liu7956c402016-10-05 15:49:01 +00001184 unsigned CurrentLine, unsigned &NewLine,
1185 std::set<unsigned> &DeletedLines) {
Eric Liu4cfb88a2016-04-25 15:09:22 +00001186 unsigned InitLine = CurrentLine, End = AnnotatedLines.size();
Eric Liu635423e2016-04-28 07:52:03 +00001187 if (Style.BraceWrapping.AfterNamespace) {
Eric Liu4cfb88a2016-04-25 15:09:22 +00001188 // If the left brace is in a new line, we should consume it first so that
1189 // it does not make the namespace non-empty.
1190 // FIXME: error handling if there is no left brace.
1191 if (!AnnotatedLines[++CurrentLine]->startsWith(tok::l_brace)) {
1192 NewLine = CurrentLine;
1193 return false;
1194 }
1195 } else if (!AnnotatedLines[CurrentLine]->endsWith(tok::l_brace)) {
1196 return false;
1197 }
1198 while (++CurrentLine < End) {
1199 if (AnnotatedLines[CurrentLine]->startsWith(tok::r_brace))
1200 break;
1201
1202 if (AnnotatedLines[CurrentLine]->startsWith(tok::kw_namespace) ||
1203 AnnotatedLines[CurrentLine]->startsWith(tok::kw_inline,
1204 tok::kw_namespace)) {
Eric Liu7956c402016-10-05 15:49:01 +00001205 if (!checkEmptyNamespace(AnnotatedLines, CurrentLine, NewLine,
1206 DeletedLines))
Eric Liu4cfb88a2016-04-25 15:09:22 +00001207 return false;
1208 CurrentLine = NewLine;
1209 continue;
1210 }
1211
1212 if (containsOnlyComments(*AnnotatedLines[CurrentLine]))
1213 continue;
1214
1215 // If there is anything other than comments or nested namespaces in the
1216 // current namespace, the namespace cannot be empty.
1217 NewLine = CurrentLine;
1218 return false;
1219 }
1220
1221 NewLine = CurrentLine;
1222 if (CurrentLine >= End)
1223 return false;
1224
1225 // Check if the empty namespace is actually affected by changed ranges.
1226 if (!AffectedRangeMgr.affectsCharSourceRange(CharSourceRange::getCharRange(
1227 AnnotatedLines[InitLine]->First->Tok.getLocation(),
1228 AnnotatedLines[CurrentLine]->Last->Tok.getEndLoc())))
1229 return false;
1230
1231 for (unsigned i = InitLine; i <= CurrentLine; ++i) {
1232 DeletedLines.insert(i);
1233 }
1234
1235 return true;
1236 }
1237
Eric Liuce5e4bc2016-05-18 08:02:56 +00001238 // Checks pairs {start, start->next},..., {end->previous, end} and deletes one
1239 // of the token in the pair if the left token has \p LK token kind and the
1240 // right token has \p RK token kind. If \p DeleteLeft is true, the left token
1241 // is deleted on match; otherwise, the right token is deleted.
1242 template <typename LeftKind, typename RightKind>
1243 void cleanupPair(FormatToken *Start, LeftKind LK, RightKind RK,
1244 bool DeleteLeft) {
1245 auto NextNotDeleted = [this](const FormatToken &Tok) -> FormatToken * {
1246 for (auto *Res = Tok.Next; Res; Res = Res->Next)
1247 if (!Res->is(tok::comment) &&
1248 DeletedTokens.find(Res) == DeletedTokens.end())
1249 return Res;
1250 return nullptr;
1251 };
1252 for (auto *Left = Start; Left;) {
1253 auto *Right = NextNotDeleted(*Left);
1254 if (!Right)
1255 break;
1256 if (Left->is(LK) && Right->is(RK)) {
1257 deleteToken(DeleteLeft ? Left : Right);
Eric Liu01426ff2016-09-09 17:50:49 +00001258 for (auto *Tok = Left->Next; Tok && Tok != Right; Tok = Tok->Next)
1259 deleteToken(Tok);
Eric Liuce5e4bc2016-05-18 08:02:56 +00001260 // If the right token is deleted, we should keep the left token
1261 // unchanged and pair it with the new right token.
1262 if (!DeleteLeft)
1263 continue;
1264 }
1265 Left = Right;
1266 }
1267 }
1268
1269 template <typename LeftKind, typename RightKind>
1270 void cleanupLeft(FormatToken *Start, LeftKind LK, RightKind RK) {
1271 cleanupPair(Start, LK, RK, /*DeleteLeft=*/true);
1272 }
1273
1274 template <typename LeftKind, typename RightKind>
1275 void cleanupRight(FormatToken *Start, LeftKind LK, RightKind RK) {
1276 cleanupPair(Start, LK, RK, /*DeleteLeft=*/false);
1277 }
1278
Eric Liu4cfb88a2016-04-25 15:09:22 +00001279 // Delete the given token.
1280 inline void deleteToken(FormatToken *Tok) {
1281 if (Tok)
1282 DeletedTokens.insert(Tok);
1283 }
1284
1285 tooling::Replacements generateFixes() {
1286 tooling::Replacements Fixes;
1287 std::vector<FormatToken *> Tokens;
1288 std::copy(DeletedTokens.begin(), DeletedTokens.end(),
1289 std::back_inserter(Tokens));
1290
1291 // Merge multiple continuous token deletions into one big deletion so that
1292 // the number of replacements can be reduced. This makes computing affected
1293 // ranges more efficient when we run reformat on the changed code.
1294 unsigned Idx = 0;
1295 while (Idx < Tokens.size()) {
1296 unsigned St = Idx, End = Idx;
1297 while ((End + 1) < Tokens.size() &&
1298 Tokens[End]->Next == Tokens[End + 1]) {
1299 End++;
1300 }
1301 auto SR = CharSourceRange::getCharRange(Tokens[St]->Tok.getLocation(),
1302 Tokens[End]->Tok.getEndLoc());
Eric Liu40ef2fb2016-08-01 10:16:37 +00001303 auto Err =
1304 Fixes.add(tooling::Replacement(Env.getSourceManager(), SR, ""));
1305 // FIXME: better error handling. for now just print error message and skip
1306 // for the release version.
Piotr Padlewski1ec383c2016-12-23 11:40:44 +00001307 if (Err) {
Eric Liu40ef2fb2016-08-01 10:16:37 +00001308 llvm::errs() << llvm::toString(std::move(Err)) << "\n";
Piotr Padlewski1ec383c2016-12-23 11:40:44 +00001309 assert(false && "Fixes must not conflict!");
1310 }
Eric Liu4cfb88a2016-04-25 15:09:22 +00001311 Idx = End + 1;
1312 }
1313
1314 return Fixes;
1315 }
1316
1317 // Class for less-than inequality comparason for the set `RedundantTokens`.
1318 // We store tokens in the order they appear in the translation unit so that
1319 // we do not need to sort them in `generateFixes()`.
1320 struct FormatTokenLess {
Eric Liu635423e2016-04-28 07:52:03 +00001321 FormatTokenLess(const SourceManager &SM) : SM(SM) {}
Eric Liu4cfb88a2016-04-25 15:09:22 +00001322
Eric Liu2874ac32016-05-18 08:14:49 +00001323 bool operator()(const FormatToken *LHS, const FormatToken *RHS) const {
Eric Liu4cfb88a2016-04-25 15:09:22 +00001324 return SM.isBeforeInTranslationUnit(LHS->Tok.getLocation(),
1325 RHS->Tok.getLocation());
1326 }
Eric Liu635423e2016-04-28 07:52:03 +00001327 const SourceManager &SM;
Eric Liu4cfb88a2016-04-25 15:09:22 +00001328 };
1329
1330 // Tokens to be deleted.
1331 std::set<FormatToken *, FormatTokenLess> DeletedTokens;
Daniel Jasperf7935112012-12-03 18:12:45 +00001332};
1333
Daniel Jasperd89ae9d2015-09-23 08:30:47 +00001334struct IncludeDirective {
1335 StringRef Filename;
1336 StringRef Text;
1337 unsigned Offset;
Daniel Jasperd2629dc2015-12-16 10:10:16 +00001338 int Category;
Daniel Jasperd89ae9d2015-09-23 08:30:47 +00001339};
1340
Craig Topperaf35e852013-06-30 22:29:28 +00001341} // end anonymous namespace
1342
Daniel Jasperd89ae9d2015-09-23 08:30:47 +00001343// Determines whether 'Ranges' intersects with ('Start', 'End').
1344static bool affectsRange(ArrayRef<tooling::Range> Ranges, unsigned Start,
1345 unsigned End) {
1346 for (auto Range : Ranges) {
1347 if (Range.getOffset() < End &&
1348 Range.getOffset() + Range.getLength() > Start)
1349 return true;
1350 }
1351 return false;
1352}
1353
Eric Liua992afe2016-08-10 09:32:23 +00001354// Returns a pair (Index, OffsetToEOL) describing the position of the cursor
1355// before sorting/deduplicating. Index is the index of the include under the
1356// cursor in the original set of includes. If this include has duplicates, it is
1357// the index of the first of the duplicates as the others are going to be
1358// removed. OffsetToEOL describes the cursor's position relative to the end of
1359// its current line.
1360// If `Cursor` is not on any #include, `Index` will be UINT_MAX.
1361static std::pair<unsigned, unsigned>
1362FindCursorIndex(const SmallVectorImpl<IncludeDirective> &Includes,
1363 const SmallVectorImpl<unsigned> &Indices, unsigned Cursor) {
1364 unsigned CursorIndex = UINT_MAX;
1365 unsigned OffsetToEOL = 0;
1366 for (int i = 0, e = Includes.size(); i != e; ++i) {
1367 unsigned Start = Includes[Indices[i]].Offset;
1368 unsigned End = Start + Includes[Indices[i]].Text.size();
1369 if (!(Cursor >= Start && Cursor < End))
1370 continue;
1371 CursorIndex = Indices[i];
1372 OffsetToEOL = End - Cursor;
1373 // Put the cursor on the only remaining #include among the duplicate
1374 // #includes.
1375 while (--i >= 0 && Includes[CursorIndex].Text == Includes[Indices[i]].Text)
1376 CursorIndex = i;
1377 break;
1378 }
1379 return std::make_pair(CursorIndex, OffsetToEOL);
1380}
1381
1382// Sorts and deduplicate a block of includes given by 'Includes' alphabetically
1383// adding the necessary replacement to 'Replaces'. 'Includes' must be in strict
1384// source order.
1385// #include directives with the same text will be deduplicated, and only the
1386// first #include in the duplicate #includes remains. If the `Cursor` is
1387// provided and put on a deleted #include, it will be moved to the remaining
1388// #include in the duplicate #includes.
Martin Probstc4a0dd42016-05-20 11:24:24 +00001389static void sortCppIncludes(const FormatStyle &Style,
Eric Liua992afe2016-08-10 09:32:23 +00001390 const SmallVectorImpl<IncludeDirective> &Includes,
1391 ArrayRef<tooling::Range> Ranges, StringRef FileName,
1392 tooling::Replacements &Replaces, unsigned *Cursor) {
1393 unsigned IncludesBeginOffset = Includes.front().Offset;
Daniel Jasperd6a00782016-08-30 21:33:41 +00001394 unsigned IncludesEndOffset =
1395 Includes.back().Offset + Includes.back().Text.size();
1396 unsigned IncludesBlockSize = IncludesEndOffset - IncludesBeginOffset;
1397 if (!affectsRange(Ranges, IncludesBeginOffset, IncludesEndOffset))
Daniel Jasperd89ae9d2015-09-23 08:30:47 +00001398 return;
1399 SmallVector<unsigned, 16> Indices;
1400 for (unsigned i = 0, e = Includes.size(); i != e; ++i)
1401 Indices.push_back(i);
Daniel Jasper94a96fc2016-03-03 17:34:14 +00001402 std::stable_sort(
1403 Indices.begin(), Indices.end(), [&](unsigned LHSI, unsigned RHSI) {
1404 return std::tie(Includes[LHSI].Category, Includes[LHSI].Filename) <
1405 std::tie(Includes[RHSI].Category, Includes[RHSI].Filename);
1406 });
Eric Liua992afe2016-08-10 09:32:23 +00001407 // The index of the include on which the cursor will be put after
1408 // sorting/deduplicating.
1409 unsigned CursorIndex;
1410 // The offset from cursor to the end of line.
1411 unsigned CursorToEOLOffset;
1412 if (Cursor)
1413 std::tie(CursorIndex, CursorToEOLOffset) =
1414 FindCursorIndex(Includes, Indices, *Cursor);
1415
1416 // Deduplicate #includes.
1417 Indices.erase(std::unique(Indices.begin(), Indices.end(),
1418 [&](unsigned LHSI, unsigned RHSI) {
1419 return Includes[LHSI].Text == Includes[RHSI].Text;
1420 }),
1421 Indices.end());
Daniel Jasperd89ae9d2015-09-23 08:30:47 +00001422
1423 // If the #includes are out of order, we generate a single replacement fixing
1424 // the entire block. Otherwise, no replacement is generated.
Eric Liua992afe2016-08-10 09:32:23 +00001425 if (Indices.size() == Includes.size() &&
1426 std::is_sorted(Indices.begin(), Indices.end()))
Daniel Jasperd89ae9d2015-09-23 08:30:47 +00001427 return;
1428
Daniel Jasperb68aabf2015-11-23 08:36:35 +00001429 std::string result;
Daniel Jasperb68aabf2015-11-23 08:36:35 +00001430 for (unsigned Index : Indices) {
1431 if (!result.empty())
1432 result += "\n";
1433 result += Includes[Index].Text;
Eric Liua992afe2016-08-10 09:32:23 +00001434 if (Cursor && CursorIndex == Index)
1435 *Cursor = IncludesBeginOffset + result.size() - CursorToEOLOffset;
Daniel Jasperd89ae9d2015-09-23 08:30:47 +00001436 }
1437
Eric Liu40ef2fb2016-08-01 10:16:37 +00001438 auto Err = Replaces.add(tooling::Replacement(
Eric Liua992afe2016-08-10 09:32:23 +00001439 FileName, Includes.front().Offset, IncludesBlockSize, result));
Eric Liu40ef2fb2016-08-01 10:16:37 +00001440 // FIXME: better error handling. For now, just skip the replacement for the
1441 // release version.
Piotr Padlewski1ec383c2016-12-23 11:40:44 +00001442 if (Err) {
Eric Liu40ef2fb2016-08-01 10:16:37 +00001443 llvm::errs() << llvm::toString(std::move(Err)) << "\n";
Piotr Padlewski1ec383c2016-12-23 11:40:44 +00001444 assert(false);
1445 }
Daniel Jasperd89ae9d2015-09-23 08:30:47 +00001446}
1447
Eric Liu659afd52016-05-31 13:34:20 +00001448namespace {
1449
1450// This class manages priorities of #include categories and calculates
1451// priorities for headers.
1452class IncludeCategoryManager {
1453public:
1454 IncludeCategoryManager(const FormatStyle &Style, StringRef FileName)
1455 : Style(Style), FileName(FileName) {
1456 FileStem = llvm::sys::path::stem(FileName);
1457 for (const auto &Category : Style.IncludeCategories)
Chandler Carruthd676ab12017-06-29 23:20:54 +00001458 CategoryRegexs.emplace_back(Category.Regex, llvm::Regex::IgnoreCase);
Eric Liu659afd52016-05-31 13:34:20 +00001459 IsMainFile = FileName.endswith(".c") || FileName.endswith(".cc") ||
1460 FileName.endswith(".cpp") || FileName.endswith(".c++") ||
1461 FileName.endswith(".cxx") || FileName.endswith(".m") ||
1462 FileName.endswith(".mm");
1463 }
1464
1465 // Returns the priority of the category which \p IncludeName belongs to.
1466 // If \p CheckMainHeader is true and \p IncludeName is a main header, returns
1467 // 0. Otherwise, returns the priority of the matching category or INT_MAX.
1468 int getIncludePriority(StringRef IncludeName, bool CheckMainHeader) {
1469 int Ret = INT_MAX;
1470 for (unsigned i = 0, e = CategoryRegexs.size(); i != e; ++i)
1471 if (CategoryRegexs[i].match(IncludeName)) {
1472 Ret = Style.IncludeCategories[i].Priority;
1473 break;
1474 }
1475 if (CheckMainHeader && IsMainFile && Ret > 0 && isMainHeader(IncludeName))
1476 Ret = 0;
1477 return Ret;
1478 }
1479
1480private:
1481 bool isMainHeader(StringRef IncludeName) const {
1482 if (!IncludeName.startswith("\""))
1483 return false;
1484 StringRef HeaderStem =
1485 llvm::sys::path::stem(IncludeName.drop_front(1).drop_back(1));
Chandler Carruthd676ab12017-06-29 23:20:54 +00001486 if (FileStem.startswith(HeaderStem) ||
1487 FileStem.startswith_lower(HeaderStem)) {
Eric Liu659afd52016-05-31 13:34:20 +00001488 llvm::Regex MainIncludeRegex(
Chandler Carruthd676ab12017-06-29 23:20:54 +00001489 (HeaderStem + Style.IncludeIsMainRegex).str(),
1490 llvm::Regex::IgnoreCase);
Eric Liu659afd52016-05-31 13:34:20 +00001491 if (MainIncludeRegex.match(FileStem))
1492 return true;
1493 }
1494 return false;
1495 }
1496
1497 const FormatStyle &Style;
1498 bool IsMainFile;
1499 StringRef FileName;
1500 StringRef FileStem;
1501 SmallVector<llvm::Regex, 4> CategoryRegexs;
1502};
1503
1504const char IncludeRegexPattern[] =
1505 R"(^[\t\ ]*#[\t\ ]*(import|include)[^"<]*(["<][^">]*[">]))";
1506
1507} // anonymous namespace
1508
Martin Probstc4a0dd42016-05-20 11:24:24 +00001509tooling::Replacements sortCppIncludes(const FormatStyle &Style, StringRef Code,
1510 ArrayRef<tooling::Range> Ranges,
1511 StringRef FileName,
1512 tooling::Replacements &Replaces,
1513 unsigned *Cursor) {
Daniel Jasperd89ae9d2015-09-23 08:30:47 +00001514 unsigned Prev = 0;
1515 unsigned SearchFrom = 0;
Eric Liu659afd52016-05-31 13:34:20 +00001516 llvm::Regex IncludeRegex(IncludeRegexPattern);
Daniel Jasperd89ae9d2015-09-23 08:30:47 +00001517 SmallVector<StringRef, 4> Matches;
1518 SmallVector<IncludeDirective, 16> IncludesInBlock;
Daniel Jasper85c472d2015-09-29 07:53:08 +00001519
1520 // In compiled files, consider the first #include to be the main #include of
1521 // the file if it is not a system #include. This ensures that the header
1522 // doesn't have hidden dependencies
1523 // (http://llvm.org/docs/CodingStandards.html#include-style).
1524 //
1525 // FIXME: Do some sanity checking, e.g. edit distance of the base name, to fix
1526 // cases where the first #include is unlikely to be the main header.
Eric Liu659afd52016-05-31 13:34:20 +00001527 IncludeCategoryManager Categories(Style, FileName);
Daniel Jasper32d75fa2015-12-21 13:40:49 +00001528 bool FirstIncludeBlock = true;
Daniel Jaspera252f5d2015-12-21 17:28:24 +00001529 bool MainIncludeFound = false;
Daniel Jasper9b8c7c72015-11-21 09:17:08 +00001530 bool FormattingOff = false;
1531
Daniel Jasperd89ae9d2015-09-23 08:30:47 +00001532 for (;;) {
1533 auto Pos = Code.find('\n', SearchFrom);
1534 StringRef Line =
1535 Code.substr(Prev, (Pos != StringRef::npos ? Pos : Code.size()) - Prev);
Daniel Jasper9b8c7c72015-11-21 09:17:08 +00001536
1537 StringRef Trimmed = Line.trim();
1538 if (Trimmed == "// clang-format off")
1539 FormattingOff = true;
1540 else if (Trimmed == "// clang-format on")
1541 FormattingOff = false;
1542
1543 if (!FormattingOff && !Line.endswith("\\")) {
Daniel Jasperd89ae9d2015-09-23 08:30:47 +00001544 if (IncludeRegex.match(Line, &Matches)) {
Nico Weberff063702015-10-21 17:13:45 +00001545 StringRef IncludeName = Matches[2];
Eric Liu659afd52016-05-31 13:34:20 +00001546 int Category = Categories.getIncludePriority(
1547 IncludeName,
1548 /*CheckMainHeader=*/!MainIncludeFound && FirstIncludeBlock);
1549 if (Category == 0)
1550 MainIncludeFound = true;
Nico Weberff063702015-10-21 17:13:45 +00001551 IncludesInBlock.push_back({IncludeName, Line, Prev, Category});
Daniel Jasperd89ae9d2015-09-23 08:30:47 +00001552 } else if (!IncludesInBlock.empty()) {
Martin Probstc4a0dd42016-05-20 11:24:24 +00001553 sortCppIncludes(Style, IncludesInBlock, Ranges, FileName, Replaces,
1554 Cursor);
Daniel Jasperd89ae9d2015-09-23 08:30:47 +00001555 IncludesInBlock.clear();
Daniel Jasper32d75fa2015-12-21 13:40:49 +00001556 FirstIncludeBlock = false;
Daniel Jasperd89ae9d2015-09-23 08:30:47 +00001557 }
1558 Prev = Pos + 1;
1559 }
1560 if (Pos == StringRef::npos || Pos + 1 == Code.size())
1561 break;
1562 SearchFrom = Pos + 1;
1563 }
1564 if (!IncludesInBlock.empty())
Martin Probstc4a0dd42016-05-20 11:24:24 +00001565 sortCppIncludes(Style, IncludesInBlock, Ranges, FileName, Replaces, Cursor);
1566 return Replaces;
1567}
1568
Martin Probstfa37b182017-01-27 09:09:11 +00001569bool isMpegTS(StringRef Code) {
1570 // MPEG transport streams use the ".ts" file extension. clang-format should
1571 // not attempt to format those. MPEG TS' frame format starts with 0x47 every
1572 // 189 bytes - detect that and return.
1573 return Code.size() > 188 && Code[0] == 0x47 && Code[188] == 0x47;
1574}
1575
Manuel Klimek89628f62017-09-20 09:51:03 +00001576bool isLikelyXml(StringRef Code) { return Code.ltrim().startswith("<"); }
Krasimir Georgieva2e7d0d2017-08-29 13:51:38 +00001577
Martin Probstc4a0dd42016-05-20 11:24:24 +00001578tooling::Replacements sortIncludes(const FormatStyle &Style, StringRef Code,
1579 ArrayRef<tooling::Range> Ranges,
1580 StringRef FileName, unsigned *Cursor) {
1581 tooling::Replacements Replaces;
1582 if (!Style.SortIncludes)
1583 return Replaces;
Krasimir Georgiev86873032017-08-29 13:57:31 +00001584 if (isLikelyXml(Code))
1585 return Replaces;
1586 if (Style.Language == FormatStyle::LanguageKind::LK_JavaScript &&
1587 isMpegTS(Code))
Martin Probstfa37b182017-01-27 09:09:11 +00001588 return Replaces;
Martin Probstc4a0dd42016-05-20 11:24:24 +00001589 if (Style.Language == FormatStyle::LanguageKind::LK_JavaScript)
1590 return sortJavaScriptImports(Style, Code, Ranges, FileName);
1591 sortCppIncludes(Style, Code, Ranges, FileName, Replaces, Cursor);
Daniel Jasperd89ae9d2015-09-23 08:30:47 +00001592 return Replaces;
1593}
1594
Eric Liu4cfb88a2016-04-25 15:09:22 +00001595template <typename T>
Eric Liu4f8d9942016-07-11 13:53:12 +00001596static llvm::Expected<tooling::Replacements>
Eric Liu4cfb88a2016-04-25 15:09:22 +00001597processReplacements(T ProcessFunc, StringRef Code,
1598 const tooling::Replacements &Replaces,
1599 const FormatStyle &Style) {
Manuel Klimekb12e5a52016-03-01 12:37:30 +00001600 if (Replaces.empty())
1601 return tooling::Replacements();
1602
Eric Liu4f8d9942016-07-11 13:53:12 +00001603 auto NewCode = applyAllReplacements(Code, Replaces);
1604 if (!NewCode)
1605 return NewCode.takeError();
Eric Liu40ef2fb2016-08-01 10:16:37 +00001606 std::vector<tooling::Range> ChangedRanges = Replaces.getAffectedRanges();
Manuel Klimekb12e5a52016-03-01 12:37:30 +00001607 StringRef FileName = Replaces.begin()->getFilePath();
Eric Liu4cfb88a2016-04-25 15:09:22 +00001608
Manuel Klimekb12e5a52016-03-01 12:37:30 +00001609 tooling::Replacements FormatReplaces =
Eric Liu4f8d9942016-07-11 13:53:12 +00001610 ProcessFunc(Style, *NewCode, ChangedRanges, FileName);
Manuel Klimekb12e5a52016-03-01 12:37:30 +00001611
Eric Liu40ef2fb2016-08-01 10:16:37 +00001612 return Replaces.merge(FormatReplaces);
Manuel Klimekb12e5a52016-03-01 12:37:30 +00001613}
1614
Eric Liu4f8d9942016-07-11 13:53:12 +00001615llvm::Expected<tooling::Replacements>
1616formatReplacements(StringRef Code, const tooling::Replacements &Replaces,
1617 const FormatStyle &Style) {
Eric Liu4cfb88a2016-04-25 15:09:22 +00001618 // We need to use lambda function here since there are two versions of
Eric Liubaf58c22016-05-18 13:43:48 +00001619 // `sortIncludes`.
1620 auto SortIncludes = [](const FormatStyle &Style, StringRef Code,
1621 std::vector<tooling::Range> Ranges,
1622 StringRef FileName) -> tooling::Replacements {
1623 return sortIncludes(Style, Code, Ranges, FileName);
1624 };
Eric Liu4f8d9942016-07-11 13:53:12 +00001625 auto SortedReplaces =
Eric Liubaf58c22016-05-18 13:43:48 +00001626 processReplacements(SortIncludes, Code, Replaces, Style);
Eric Liu4f8d9942016-07-11 13:53:12 +00001627 if (!SortedReplaces)
1628 return SortedReplaces.takeError();
Eric Liubaf58c22016-05-18 13:43:48 +00001629
1630 // We need to use lambda function here since there are two versions of
Eric Liu4cfb88a2016-04-25 15:09:22 +00001631 // `reformat`.
1632 auto Reformat = [](const FormatStyle &Style, StringRef Code,
1633 std::vector<tooling::Range> Ranges,
1634 StringRef FileName) -> tooling::Replacements {
1635 return reformat(Style, Code, Ranges, FileName);
1636 };
Eric Liu4f8d9942016-07-11 13:53:12 +00001637 return processReplacements(Reformat, Code, *SortedReplaces, Style);
Eric Liu4cfb88a2016-04-25 15:09:22 +00001638}
1639
Eric Liu659afd52016-05-31 13:34:20 +00001640namespace {
1641
1642inline bool isHeaderInsertion(const tooling::Replacement &Replace) {
Eric Liuc0d3a802016-09-23 15:10:56 +00001643 return Replace.getOffset() == UINT_MAX && Replace.getLength() == 0 &&
Eric Liu659afd52016-05-31 13:34:20 +00001644 llvm::Regex(IncludeRegexPattern).match(Replace.getReplacementText());
1645}
1646
Eric Liuc0d3a802016-09-23 15:10:56 +00001647inline bool isHeaderDeletion(const tooling::Replacement &Replace) {
1648 return Replace.getOffset() == UINT_MAX && Replace.getLength() == 1;
1649}
1650
Eric Liu964782a2016-12-02 11:01:43 +00001651// Returns the offset after skipping a sequence of tokens, matched by \p
1652// GetOffsetAfterSequence, from the start of the code.
1653// \p GetOffsetAfterSequence should be a function that matches a sequence of
1654// tokens and returns an offset after the sequence.
1655unsigned getOffsetAfterTokenSequence(
1656 StringRef FileName, StringRef Code, const FormatStyle &Style,
Krasimir Georgiev317c5392017-03-08 09:13:25 +00001657 llvm::function_ref<unsigned(const SourceManager &, Lexer &, Token &)>
1658 GetOffsetAfterSequence) {
Eric Liu964782a2016-12-02 11:01:43 +00001659 std::unique_ptr<Environment> Env =
1660 Environment::CreateVirtualEnvironment(Code, FileName, /*Ranges=*/{});
1661 const SourceManager &SourceMgr = Env->getSourceManager();
1662 Lexer Lex(Env->getFileID(), SourceMgr.getBuffer(Env->getFileID()), SourceMgr,
1663 getFormattingLangOpts(Style));
1664 Token Tok;
1665 // Get the first token.
1666 Lex.LexFromRawLexer(Tok);
Krasimir Georgiev317c5392017-03-08 09:13:25 +00001667 return GetOffsetAfterSequence(SourceMgr, Lex, Tok);
Eric Liu35288322016-06-06 11:00:13 +00001668}
1669
1670// Check if a sequence of tokens is like "#<Name> <raw_identifier>". If it is,
1671// \p Tok will be the token after this directive; otherwise, it can be any token
1672// after the given \p Tok (including \p Tok).
1673bool checkAndConsumeDirectiveWithName(Lexer &Lex, StringRef Name, Token &Tok) {
1674 bool Matched = Tok.is(tok::hash) && !Lex.LexFromRawLexer(Tok) &&
1675 Tok.is(tok::raw_identifier) &&
1676 Tok.getRawIdentifier() == Name && !Lex.LexFromRawLexer(Tok) &&
Eric Liu93459d32016-12-19 10:41:05 +00001677 Tok.is(tok::raw_identifier);
Eric Liu35288322016-06-06 11:00:13 +00001678 if (Matched)
1679 Lex.LexFromRawLexer(Tok);
1680 return Matched;
1681}
1682
Eric Liu964782a2016-12-02 11:01:43 +00001683void skipComments(Lexer &Lex, Token &Tok) {
1684 while (Tok.is(tok::comment))
1685 if (Lex.LexFromRawLexer(Tok))
1686 return;
1687}
1688
1689// Returns the offset after header guard directives and any comments
1690// before/after header guards. If no header guard presents in the code, this
1691// will returns the offset after skipping all comments from the start of the
1692// code.
Eric Liu35288322016-06-06 11:00:13 +00001693unsigned getOffsetAfterHeaderGuardsAndComments(StringRef FileName,
1694 StringRef Code,
Eric Liu43d67b62016-06-11 11:45:08 +00001695 const FormatStyle &Style) {
Eric Liu964782a2016-12-02 11:01:43 +00001696 return getOffsetAfterTokenSequence(
1697 FileName, Code, Style,
1698 [](const SourceManager &SM, Lexer &Lex, Token Tok) {
1699 skipComments(Lex, Tok);
1700 unsigned InitialOffset = SM.getFileOffset(Tok.getLocation());
1701 if (checkAndConsumeDirectiveWithName(Lex, "ifndef", Tok)) {
1702 skipComments(Lex, Tok);
1703 if (checkAndConsumeDirectiveWithName(Lex, "define", Tok))
1704 return SM.getFileOffset(Tok.getLocation());
1705 }
1706 return InitialOffset;
1707 });
1708}
1709
1710// Check if a sequence of tokens is like
1711// "#include ("header.h" | <header.h>)".
1712// If it is, \p Tok will be the token after this directive; otherwise, it can be
1713// any token after the given \p Tok (including \p Tok).
1714bool checkAndConsumeInclusiveDirective(Lexer &Lex, Token &Tok) {
1715 auto Matched = [&]() {
1716 Lex.LexFromRawLexer(Tok);
1717 return true;
1718 };
1719 if (Tok.is(tok::hash) && !Lex.LexFromRawLexer(Tok) &&
1720 Tok.is(tok::raw_identifier) && Tok.getRawIdentifier() == "include") {
1721 if (Lex.LexFromRawLexer(Tok))
1722 return false;
1723 if (Tok.is(tok::string_literal))
1724 return Matched();
1725 if (Tok.is(tok::less)) {
1726 while (!Lex.LexFromRawLexer(Tok) && Tok.isNot(tok::greater)) {
1727 }
1728 if (Tok.is(tok::greater))
1729 return Matched();
1730 }
Eric Liu35288322016-06-06 11:00:13 +00001731 }
Eric Liu964782a2016-12-02 11:01:43 +00001732 return false;
1733}
1734
1735// Returns the offset of the last #include directive after which a new
1736// #include can be inserted. This ignores #include's after the #include block(s)
1737// in the beginning of a file to avoid inserting headers into code sections
1738// where new #include's should not be added by default.
1739// These code sections include:
1740// - raw string literals (containing #include).
1741// - #if blocks.
1742// - Special #include's among declarations (e.g. functions).
1743//
1744// If no #include after which a new #include can be inserted, this returns the
1745// offset after skipping all comments from the start of the code.
1746// Inserting after an #include is not allowed if it comes after code that is not
1747// #include (e.g. pre-processing directive that is not #include, declarations).
1748unsigned getMaxHeaderInsertionOffset(StringRef FileName, StringRef Code,
1749 const FormatStyle &Style) {
1750 return getOffsetAfterTokenSequence(
1751 FileName, Code, Style,
1752 [](const SourceManager &SM, Lexer &Lex, Token Tok) {
1753 skipComments(Lex, Tok);
1754 unsigned MaxOffset = SM.getFileOffset(Tok.getLocation());
1755 while (checkAndConsumeInclusiveDirective(Lex, Tok))
1756 MaxOffset = SM.getFileOffset(Tok.getLocation());
1757 return MaxOffset;
1758 });
Eric Liu35288322016-06-06 11:00:13 +00001759}
1760
Eric Liuc0d3a802016-09-23 15:10:56 +00001761bool isDeletedHeader(llvm::StringRef HeaderName,
Benjamin Kramerebac56e2016-11-24 15:42:29 +00001762 const std::set<llvm::StringRef> &HeadersToDelete) {
1763 return HeadersToDelete.count(HeaderName) ||
1764 HeadersToDelete.count(HeaderName.trim("\"<>"));
Eric Liuc0d3a802016-09-23 15:10:56 +00001765}
1766
Eric Liu659afd52016-05-31 13:34:20 +00001767// FIXME: insert empty lines between newly created blocks.
1768tooling::Replacements
1769fixCppIncludeInsertions(StringRef Code, const tooling::Replacements &Replaces,
1770 const FormatStyle &Style) {
Daniel Jasper1dbc2102017-03-31 13:30:24 +00001771 if (!Style.isCpp())
Eric Liu659afd52016-05-31 13:34:20 +00001772 return Replaces;
1773
1774 tooling::Replacements HeaderInsertions;
Eric Liuc0d3a802016-09-23 15:10:56 +00001775 std::set<llvm::StringRef> HeadersToDelete;
Eric Liu40ef2fb2016-08-01 10:16:37 +00001776 tooling::Replacements Result;
Eric Liu659afd52016-05-31 13:34:20 +00001777 for (const auto &R : Replaces) {
Eric Liu40ef2fb2016-08-01 10:16:37 +00001778 if (isHeaderInsertion(R)) {
1779 // Replacements from \p Replaces must be conflict-free already, so we can
1780 // simply consume the error.
1781 llvm::consumeError(HeaderInsertions.add(R));
Eric Liuc0d3a802016-09-23 15:10:56 +00001782 } else if (isHeaderDeletion(R)) {
1783 HeadersToDelete.insert(R.getReplacementText());
Eric Liu40ef2fb2016-08-01 10:16:37 +00001784 } else if (R.getOffset() == UINT_MAX) {
Eric Liu659afd52016-05-31 13:34:20 +00001785 llvm::errs() << "Insertions other than header #include insertion are "
1786 "not supported! "
1787 << R.getReplacementText() << "\n";
Eric Liu40ef2fb2016-08-01 10:16:37 +00001788 } else {
1789 llvm::consumeError(Result.add(R));
1790 }
Eric Liu659afd52016-05-31 13:34:20 +00001791 }
Eric Liuc0d3a802016-09-23 15:10:56 +00001792 if (HeaderInsertions.empty() && HeadersToDelete.empty())
Eric Liu659afd52016-05-31 13:34:20 +00001793 return Replaces;
Eric Liu659afd52016-05-31 13:34:20 +00001794
1795 llvm::Regex IncludeRegex(IncludeRegexPattern);
1796 llvm::Regex DefineRegex(R"(^[\t\ ]*#[\t\ ]*define[\t\ ]*[^\\]*$)");
1797 SmallVector<StringRef, 4> Matches;
1798
1799 StringRef FileName = Replaces.begin()->getFilePath();
1800 IncludeCategoryManager Categories(Style, FileName);
1801
1802 // Record the offset of the end of the last include in each category.
1803 std::map<int, int> CategoryEndOffsets;
1804 // All possible priorities.
1805 // Add 0 for main header and INT_MAX for headers that are not in any category.
1806 std::set<int> Priorities = {0, INT_MAX};
1807 for (const auto &Category : Style.IncludeCategories)
1808 Priorities.insert(Category.Priority);
1809 int FirstIncludeOffset = -1;
Eric Liu35288322016-06-06 11:00:13 +00001810 // All new headers should be inserted after this offset.
1811 unsigned MinInsertOffset =
1812 getOffsetAfterHeaderGuardsAndComments(FileName, Code, Style);
Eric Liu303baf52016-06-03 12:52:59 +00001813 StringRef TrimmedCode = Code.drop_front(MinInsertOffset);
Eric Liu21d10322016-12-09 11:45:50 +00001814 // Max insertion offset in the original code.
Eric Liu964782a2016-12-02 11:01:43 +00001815 unsigned MaxInsertOffset =
Eric Liu21d10322016-12-09 11:45:50 +00001816 MinInsertOffset +
Eric Liu964782a2016-12-02 11:01:43 +00001817 getMaxHeaderInsertionOffset(FileName, TrimmedCode, Style);
Eric Liu659afd52016-05-31 13:34:20 +00001818 SmallVector<StringRef, 32> Lines;
Eric Liu303baf52016-06-03 12:52:59 +00001819 TrimmedCode.split(Lines, '\n');
Eric Liu35288322016-06-06 11:00:13 +00001820 unsigned Offset = MinInsertOffset;
1821 unsigned NextLineOffset;
Eric Liu3753f912016-06-14 14:09:21 +00001822 std::set<StringRef> ExistingIncludes;
Eric Liu659afd52016-05-31 13:34:20 +00001823 for (auto Line : Lines) {
Eric Liu35288322016-06-06 11:00:13 +00001824 NextLineOffset = std::min(Code.size(), Offset + Line.size() + 1);
Eric Liu659afd52016-05-31 13:34:20 +00001825 if (IncludeRegex.match(Line, &Matches)) {
Eric Liuc0d3a802016-09-23 15:10:56 +00001826 // The header name with quotes or angle brackets.
Eric Liu659afd52016-05-31 13:34:20 +00001827 StringRef IncludeName = Matches[2];
Eric Liu3753f912016-06-14 14:09:21 +00001828 ExistingIncludes.insert(IncludeName);
Eric Liu964782a2016-12-02 11:01:43 +00001829 // Only record the offset of current #include if we can insert after it.
1830 if (Offset <= MaxInsertOffset) {
1831 int Category = Categories.getIncludePriority(
1832 IncludeName, /*CheckMainHeader=*/FirstIncludeOffset < 0);
1833 CategoryEndOffsets[Category] = NextLineOffset;
1834 if (FirstIncludeOffset < 0)
1835 FirstIncludeOffset = Offset;
1836 }
Eric Liuc0d3a802016-09-23 15:10:56 +00001837 if (isDeletedHeader(IncludeName, HeadersToDelete)) {
1838 // If this is the last line without trailing newline, we need to make
1839 // sure we don't delete across the file boundary.
1840 unsigned Length = std::min(Line.size() + 1, Code.size() - Offset);
1841 llvm::Error Err =
1842 Result.add(tooling::Replacement(FileName, Offset, Length, ""));
1843 if (Err) {
1844 // Ignore the deletion on conflict.
1845 llvm::errs() << "Failed to add header deletion replacement for "
1846 << IncludeName << ": " << llvm::toString(std::move(Err))
1847 << "\n";
1848 }
1849 }
Eric Liu659afd52016-05-31 13:34:20 +00001850 }
Eric Liu35288322016-06-06 11:00:13 +00001851 Offset = NextLineOffset;
Eric Liu659afd52016-05-31 13:34:20 +00001852 }
1853
1854 // Populate CategoryEndOfssets:
1855 // - Ensure that CategoryEndOffset[Highest] is always populated.
1856 // - If CategoryEndOffset[Priority] isn't set, use the next higher value that
1857 // is set, up to CategoryEndOffset[Highest].
Eric Liu659afd52016-05-31 13:34:20 +00001858 auto Highest = Priorities.begin();
1859 if (CategoryEndOffsets.find(*Highest) == CategoryEndOffsets.end()) {
1860 if (FirstIncludeOffset >= 0)
1861 CategoryEndOffsets[*Highest] = FirstIncludeOffset;
1862 else
Eric Liu303baf52016-06-03 12:52:59 +00001863 CategoryEndOffsets[*Highest] = MinInsertOffset;
Eric Liu659afd52016-05-31 13:34:20 +00001864 }
1865 // By this point, CategoryEndOffset[Highest] is always set appropriately:
1866 // - to an appropriate location before/after existing #includes, or
1867 // - to right after the header guard, or
1868 // - to the beginning of the file.
1869 for (auto I = ++Priorities.begin(), E = Priorities.end(); I != E; ++I)
1870 if (CategoryEndOffsets.find(*I) == CategoryEndOffsets.end())
1871 CategoryEndOffsets[*I] = CategoryEndOffsets[*std::prev(I)];
1872
Eric Liu11a42372016-10-05 15:42:19 +00001873 bool NeedNewLineAtEnd = !Code.empty() && Code.back() != '\n';
Eric Liu659afd52016-05-31 13:34:20 +00001874 for (const auto &R : HeaderInsertions) {
1875 auto IncludeDirective = R.getReplacementText();
1876 bool Matched = IncludeRegex.match(IncludeDirective, &Matches);
1877 assert(Matched && "Header insertion replacement must have replacement text "
1878 "'#include ...'");
Benjamin Kramer1cb7ee12016-05-31 14:14:42 +00001879 (void)Matched;
Eric Liu659afd52016-05-31 13:34:20 +00001880 auto IncludeName = Matches[2];
Eric Liu3753f912016-06-14 14:09:21 +00001881 if (ExistingIncludes.find(IncludeName) != ExistingIncludes.end()) {
1882 DEBUG(llvm::dbgs() << "Skip adding existing include : " << IncludeName
1883 << "\n");
1884 continue;
1885 }
Eric Liu659afd52016-05-31 13:34:20 +00001886 int Category =
1887 Categories.getIncludePriority(IncludeName, /*CheckMainHeader=*/true);
1888 Offset = CategoryEndOffsets[Category];
1889 std::string NewInclude = !IncludeDirective.endswith("\n")
1890 ? (IncludeDirective + "\n").str()
1891 : IncludeDirective.str();
Eric Liu11a42372016-10-05 15:42:19 +00001892 // When inserting headers at end of the code, also append '\n' to the code
1893 // if it does not end with '\n'.
1894 if (NeedNewLineAtEnd && Offset == Code.size()) {
1895 NewInclude = "\n" + NewInclude;
1896 NeedNewLineAtEnd = false;
1897 }
Eric Liu40ef2fb2016-08-01 10:16:37 +00001898 auto NewReplace = tooling::Replacement(FileName, Offset, 0, NewInclude);
1899 auto Err = Result.add(NewReplace);
1900 if (Err) {
1901 llvm::consumeError(std::move(Err));
Eric Liu11a42372016-10-05 15:42:19 +00001902 unsigned NewOffset = Result.getShiftedCodePosition(Offset);
1903 NewReplace = tooling::Replacement(FileName, NewOffset, 0, NewInclude);
Eric Liu40ef2fb2016-08-01 10:16:37 +00001904 Result = Result.merge(tooling::Replacements(NewReplace));
1905 }
Eric Liu659afd52016-05-31 13:34:20 +00001906 }
1907 return Result;
1908}
1909
1910} // anonymous namespace
1911
Eric Liu4f8d9942016-07-11 13:53:12 +00001912llvm::Expected<tooling::Replacements>
Eric Liu4cfb88a2016-04-25 15:09:22 +00001913cleanupAroundReplacements(StringRef Code, const tooling::Replacements &Replaces,
1914 const FormatStyle &Style) {
1915 // We need to use lambda function here since there are two versions of
1916 // `cleanup`.
1917 auto Cleanup = [](const FormatStyle &Style, StringRef Code,
1918 std::vector<tooling::Range> Ranges,
1919 StringRef FileName) -> tooling::Replacements {
1920 return cleanup(Style, Code, Ranges, FileName);
1921 };
Eric Liu659afd52016-05-31 13:34:20 +00001922 // Make header insertion replacements insert new headers into correct blocks.
1923 tooling::Replacements NewReplaces =
1924 fixCppIncludeInsertions(Code, Replaces, Style);
1925 return processReplacements(Cleanup, Code, NewReplaces, Style);
Eric Liu4cfb88a2016-04-25 15:09:22 +00001926}
1927
Krasimir Georgiev9ad83fe2017-10-30 14:01:50 +00001928namespace internal {
1929std::pair<tooling::Replacements, unsigned>
1930reformat(const FormatStyle &Style, StringRef Code,
1931 ArrayRef<tooling::Range> Ranges, unsigned FirstStartColumn,
1932 unsigned NextStartColumn, unsigned LastStartColumn, StringRef FileName,
1933 FormattingAttemptStatus *Status) {
Eric Liu4cfb88a2016-04-25 15:09:22 +00001934 FormatStyle Expanded = expandPresets(Style);
1935 if (Expanded.DisableFormat)
Krasimir Georgiev9ad83fe2017-10-30 14:01:50 +00001936 return {tooling::Replacements(), 0};
Krasimir Georgiev86873032017-08-29 13:57:31 +00001937 if (isLikelyXml(Code))
Krasimir Georgiev9ad83fe2017-10-30 14:01:50 +00001938 return {tooling::Replacements(), 0};
Krasimir Georgiev86873032017-08-29 13:57:31 +00001939 if (Expanded.Language == FormatStyle::LK_JavaScript && isMpegTS(Code))
Krasimir Georgiev9ad83fe2017-10-30 14:01:50 +00001940 return {tooling::Replacements(), 0};
Daniel Jasper496c1992016-09-07 22:48:53 +00001941
Krasimir Georgiev9ad83fe2017-10-30 14:01:50 +00001942 typedef std::function<std::pair<tooling::Replacements, unsigned>(
1943 const Environment &)>
Krasimir Georgievac16a202017-06-23 11:46:03 +00001944 AnalyzerPass;
1945 SmallVector<AnalyzerPass, 4> Passes;
Krasimir Georgiev32eaa862017-03-01 15:35:39 +00001946
Krasimir Georgievac16a202017-06-23 11:46:03 +00001947 if (Style.Language == FormatStyle::LK_Cpp) {
1948 if (Style.FixNamespaceComments)
1949 Passes.emplace_back([&](const Environment &Env) {
1950 return NamespaceEndCommentsFixer(Env, Expanded).process();
1951 });
1952
1953 if (Style.SortUsingDeclarations)
1954 Passes.emplace_back([&](const Environment &Env) {
1955 return UsingDeclarationsSorter(Env, Expanded).process();
1956 });
Krasimir Georgiev32eaa862017-03-01 15:35:39 +00001957 }
1958
1959 if (Style.Language == FormatStyle::LK_JavaScript &&
Krasimir Georgievac16a202017-06-23 11:46:03 +00001960 Style.JavaScriptQuotes != FormatStyle::JSQS_Leave)
1961 Passes.emplace_back([&](const Environment &Env) {
1962 return JavaScriptRequoter(Env, Expanded).process();
1963 });
1964
1965 Passes.emplace_back([&](const Environment &Env) {
1966 return Formatter(Env, Expanded, Status).process();
1967 });
1968
Krasimir Georgiev9ad83fe2017-10-30 14:01:50 +00001969 std::unique_ptr<Environment> Env = Environment::CreateVirtualEnvironment(
1970 Code, FileName, Ranges, FirstStartColumn, NextStartColumn,
1971 LastStartColumn);
Krasimir Georgievac16a202017-06-23 11:46:03 +00001972 llvm::Optional<std::string> CurrentCode = None;
1973 tooling::Replacements Fixes;
Krasimir Georgiev9ad83fe2017-10-30 14:01:50 +00001974 unsigned Penalty = 0;
Krasimir Georgievac16a202017-06-23 11:46:03 +00001975 for (size_t I = 0, E = Passes.size(); I < E; ++I) {
Krasimir Georgiev9ad83fe2017-10-30 14:01:50 +00001976 std::pair<tooling::Replacements, unsigned> PassFixes = Passes[I](*Env);
Krasimir Georgievac16a202017-06-23 11:46:03 +00001977 auto NewCode = applyAllReplacements(
Krasimir Georgiev9ad83fe2017-10-30 14:01:50 +00001978 CurrentCode ? StringRef(*CurrentCode) : Code, PassFixes.first);
Krasimir Georgievac16a202017-06-23 11:46:03 +00001979 if (NewCode) {
Krasimir Georgiev9ad83fe2017-10-30 14:01:50 +00001980 Fixes = Fixes.merge(PassFixes.first);
1981 Penalty += PassFixes.second;
Krasimir Georgievac16a202017-06-23 11:46:03 +00001982 if (I + 1 < E) {
1983 CurrentCode = std::move(*NewCode);
1984 Env = Environment::CreateVirtualEnvironment(
1985 *CurrentCode, FileName,
Krasimir Georgiev9ad83fe2017-10-30 14:01:50 +00001986 tooling::calculateRangesAfterReplacements(Fixes, Ranges),
1987 FirstStartColumn, NextStartColumn, LastStartColumn);
Krasimir Georgievac16a202017-06-23 11:46:03 +00001988 }
1989 }
Daniel Jasper496c1992016-09-07 22:48:53 +00001990 }
1991
Krasimir Georgiev9ad83fe2017-10-30 14:01:50 +00001992 return {Fixes, Penalty};
1993}
1994} // namespace internal
1995
1996tooling::Replacements reformat(const FormatStyle &Style, StringRef Code,
1997 ArrayRef<tooling::Range> Ranges,
1998 StringRef FileName,
1999 FormattingAttemptStatus *Status) {
2000 return internal::reformat(Style, Code, Ranges,
2001 /*FirstStartColumn=*/0,
2002 /*NextStartColumn=*/0,
2003 /*LastStartColumn=*/0, FileName, Status)
2004 .first;
Eric Liu4cfb88a2016-04-25 15:09:22 +00002005}
2006
Eric Liu4cfb88a2016-04-25 15:09:22 +00002007tooling::Replacements cleanup(const FormatStyle &Style, StringRef Code,
2008 ArrayRef<tooling::Range> Ranges,
2009 StringRef FileName) {
Martin Probst816a9662017-05-29 08:41:11 +00002010 // cleanups only apply to C++ (they mostly concern ctor commas etc.)
2011 if (Style.Language != FormatStyle::LK_Cpp)
2012 return tooling::Replacements();
Eric Liu4cfb88a2016-04-25 15:09:22 +00002013 std::unique_ptr<Environment> Env =
Eric Liu635423e2016-04-28 07:52:03 +00002014 Environment::CreateVirtualEnvironment(Code, FileName, Ranges);
2015 Cleaner Clean(*Env, Style);
Krasimir Georgiev9ad83fe2017-10-30 14:01:50 +00002016 return Clean.process().first;
Daniel Jasperec04c0d2013-05-16 10:40:07 +00002017}
2018
Krasimir Georgievbcda54b2017-04-21 14:35:20 +00002019tooling::Replacements reformat(const FormatStyle &Style, StringRef Code,
2020 ArrayRef<tooling::Range> Ranges,
2021 StringRef FileName, bool *IncompleteFormat) {
2022 FormattingAttemptStatus Status;
2023 auto Result = reformat(Style, Code, Ranges, FileName, &Status);
2024 if (!Status.FormatComplete)
2025 *IncompleteFormat = true;
2026 return Result;
2027}
2028
Krasimir Georgiev7cb267a2017-02-27 13:28:36 +00002029tooling::Replacements fixNamespaceEndComments(const FormatStyle &Style,
2030 StringRef Code,
2031 ArrayRef<tooling::Range> Ranges,
2032 StringRef FileName) {
2033 std::unique_ptr<Environment> Env =
2034 Environment::CreateVirtualEnvironment(Code, FileName, Ranges);
2035 NamespaceEndCommentsFixer Fix(*Env, Style);
Krasimir Georgiev9ad83fe2017-10-30 14:01:50 +00002036 return Fix.process().first;
Krasimir Georgiev7cb267a2017-02-27 13:28:36 +00002037}
2038
Krasimir Georgievb03877a2017-06-21 12:03:12 +00002039tooling::Replacements sortUsingDeclarations(const FormatStyle &Style,
2040 StringRef Code,
2041 ArrayRef<tooling::Range> Ranges,
2042 StringRef FileName) {
2043 std::unique_ptr<Environment> Env =
2044 Environment::CreateVirtualEnvironment(Code, FileName, Ranges);
2045 UsingDeclarationsSorter Sorter(*Env, Style);
Krasimir Georgiev9ad83fe2017-10-30 14:01:50 +00002046 return Sorter.process().first;
Krasimir Georgievb03877a2017-06-21 12:03:12 +00002047}
2048
Daniel Jasper4db69bd2014-09-04 18:23:42 +00002049LangOptions getFormattingLangOpts(const FormatStyle &Style) {
Daniel Jasperc1fa2812013-01-10 13:08:12 +00002050 LangOptions LangOpts;
2051 LangOpts.CPlusPlus = 1;
Daniel Jasper4db69bd2014-09-04 18:23:42 +00002052 LangOpts.CPlusPlus11 = Style.Standard == FormatStyle::LS_Cpp03 ? 0 : 1;
2053 LangOpts.CPlusPlus14 = Style.Standard == FormatStyle::LS_Cpp03 ? 0 : 1;
Nico Weberdc065182017-04-05 18:10:42 +00002054 LangOpts.CPlusPlus1z = Style.Standard == FormatStyle::LS_Cpp03 ? 0 : 1;
Daniel Jasper55213652013-03-22 10:01:29 +00002055 LangOpts.LineComment = 1;
Daniel Jasper1dbc2102017-03-31 13:30:24 +00002056 bool AlternativeOperators = Style.isCpp();
Daniel Jasper30a24062014-11-14 09:02:28 +00002057 LangOpts.CXXOperatorNames = AlternativeOperators ? 1 : 0;
Daniel Jasperc1fa2812013-01-10 13:08:12 +00002058 LangOpts.Bool = 1;
2059 LangOpts.ObjC1 = 1;
2060 LangOpts.ObjC2 = 1;
Eric Liu4cfb88a2016-04-25 15:09:22 +00002061 LangOpts.MicrosoftExt = 1; // To get kw___try, kw___finally.
Saleem Abdulrasoold170c4b2015-10-04 17:51:05 +00002062 LangOpts.DeclSpecKeyword = 1; // To get __declspec.
Daniel Jasperc1fa2812013-01-10 13:08:12 +00002063 return LangOpts;
2064}
2065
Edwin Vaned544aa72013-09-30 13:31:48 +00002066const char *StyleOptionHelpDescription =
2067 "Coding style, currently supports:\n"
2068 " LLVM, Google, Chromium, Mozilla, WebKit.\n"
2069 "Use -style=file to load style configuration from\n"
2070 ".clang-format file located in one of the parent\n"
2071 "directories of the source file (or current\n"
2072 "directory for stdin).\n"
2073 "Use -style=\"{key: value, ...}\" to set specific\n"
2074 "parameters, e.g.:\n"
2075 " -style=\"{BasedOnStyle: llvm, IndentWidth: 8}\"";
2076
Alexander Kornienkoc1637f12013-12-10 11:28:13 +00002077static FormatStyle::LanguageKind getLanguageByFileName(StringRef FileName) {
Daniel Jasper498f5582015-12-25 08:53:31 +00002078 if (FileName.endswith(".java"))
Daniel Jasperc58c70e2014-09-15 11:21:46 +00002079 return FormatStyle::LK_Java;
Daniel Jasper498f5582015-12-25 08:53:31 +00002080 if (FileName.endswith_lower(".js") || FileName.endswith_lower(".ts"))
2081 return FormatStyle::LK_JavaScript; // JavaScript or TypeScript.
Daniel Jasper03a04fe2016-12-12 12:42:29 +00002082 if (FileName.endswith(".m") || FileName.endswith(".mm"))
2083 return FormatStyle::LK_ObjC;
Daniel Jasper498f5582015-12-25 08:53:31 +00002084 if (FileName.endswith_lower(".proto") ||
2085 FileName.endswith_lower(".protodevel"))
Daniel Jasper7052ce62014-01-19 09:04:08 +00002086 return FormatStyle::LK_Proto;
Daniel Jasper498f5582015-12-25 08:53:31 +00002087 if (FileName.endswith_lower(".td"))
2088 return FormatStyle::LK_TableGen;
Alexander Kornienkoc1637f12013-12-10 11:28:13 +00002089 return FormatStyle::LK_Cpp;
Alexander Kornienkocabdd732013-11-29 15:19:43 +00002090}
2091
Antonio Maiorano3adfb6a2017-01-17 00:12:27 +00002092llvm::Expected<FormatStyle> getStyle(StringRef StyleName, StringRef FileName,
Antonio Maiorano7eb75072017-01-20 01:22:42 +00002093 StringRef FallbackStyleName,
2094 StringRef Code, vfs::FileSystem *FS) {
Eric Liu547d8792016-03-24 13:22:42 +00002095 if (!FS) {
2096 FS = vfs::getRealFileSystem().get();
2097 }
Alexander Kornienkoc1637f12013-12-10 11:28:13 +00002098 FormatStyle Style = getLLVMStyle();
2099 Style.Language = getLanguageByFileName(FileName);
Daniel Jasper03a04fe2016-12-12 12:42:29 +00002100
2101 // This is a very crude detection of whether a header contains ObjC code that
2102 // should be improved over time and probably be done on tokens, not one the
2103 // bare content of the file.
2104 if (Style.Language == FormatStyle::LK_Cpp && FileName.endswith(".h") &&
2105 (Code.contains("\n- (") || Code.contains("\n+ (")))
2106 Style.Language = FormatStyle::LK_ObjC;
2107
Antonio Maiorano7eb75072017-01-20 01:22:42 +00002108 FormatStyle FallbackStyle = getNoStyle();
2109 if (!getPredefinedStyle(FallbackStyleName, Style.Language, &FallbackStyle))
2110 return make_string_error("Invalid fallback style \"" + FallbackStyleName);
Edwin Vaned544aa72013-09-30 13:31:48 +00002111
2112 if (StyleName.startswith("{")) {
2113 // Parse YAML/JSON style from the command line.
Antonio Maiorano3adfb6a2017-01-17 00:12:27 +00002114 if (std::error_code ec = parseConfiguration(StyleName, &Style))
2115 return make_string_error("Error parsing -style: " + ec.message());
Edwin Vaned544aa72013-09-30 13:31:48 +00002116 return Style;
2117 }
2118
2119 if (!StyleName.equals_lower("file")) {
Alexander Kornienkoc1637f12013-12-10 11:28:13 +00002120 if (!getPredefinedStyle(StyleName, Style.Language, &Style))
Antonio Maiorano3adfb6a2017-01-17 00:12:27 +00002121 return make_string_error("Invalid value for -style");
Edwin Vaned544aa72013-09-30 13:31:48 +00002122 return Style;
2123 }
2124
Alexander Kornienkoc1637f12013-12-10 11:28:13 +00002125 // Look for .clang-format/_clang-format file in the file's parent directories.
Alexander Kornienkocabdd732013-11-29 15:19:43 +00002126 SmallString<128> UnsuitableConfigFiles;
Edwin Vaned544aa72013-09-30 13:31:48 +00002127 SmallString<128> Path(FileName);
Antonio Maiorano3adfb6a2017-01-17 00:12:27 +00002128 if (std::error_code EC = FS->makeAbsolute(Path))
2129 return make_string_error(EC.message());
Antonio Maiorano34c03762016-12-22 05:10:07 +00002130
Alexander Kornienkoe2e03872013-10-14 00:46:35 +00002131 for (StringRef Directory = Path; !Directory.empty();
Edwin Vaned544aa72013-09-30 13:31:48 +00002132 Directory = llvm::sys::path::parent_path(Directory)) {
Eric Liu547d8792016-03-24 13:22:42 +00002133
2134 auto Status = FS->status(Directory);
2135 if (!Status ||
2136 Status->getType() != llvm::sys::fs::file_type::directory_file) {
Edwin Vaned544aa72013-09-30 13:31:48 +00002137 continue;
Eric Liu547d8792016-03-24 13:22:42 +00002138 }
2139
Edwin Vaned544aa72013-09-30 13:31:48 +00002140 SmallString<128> ConfigFile(Directory);
2141
2142 llvm::sys::path::append(ConfigFile, ".clang-format");
2143 DEBUG(llvm::dbgs() << "Trying " << ConfigFile << "...\n");
Eric Liud4758322016-03-24 13:22:37 +00002144
Eric Liu547d8792016-03-24 13:22:42 +00002145 Status = FS->status(ConfigFile.str());
Antonio Maiorano3adfb6a2017-01-17 00:12:27 +00002146 bool FoundConfigFile =
Eric Liu547d8792016-03-24 13:22:42 +00002147 Status && (Status->getType() == llvm::sys::fs::file_type::regular_file);
Antonio Maiorano3adfb6a2017-01-17 00:12:27 +00002148 if (!FoundConfigFile) {
Edwin Vaned544aa72013-09-30 13:31:48 +00002149 // Try _clang-format too, since dotfiles are not commonly used on Windows.
2150 ConfigFile = Directory;
2151 llvm::sys::path::append(ConfigFile, "_clang-format");
2152 DEBUG(llvm::dbgs() << "Trying " << ConfigFile << "...\n");
Eric Liu547d8792016-03-24 13:22:42 +00002153 Status = FS->status(ConfigFile.str());
Antonio Maiorano3adfb6a2017-01-17 00:12:27 +00002154 FoundConfigFile = Status && (Status->getType() ==
2155 llvm::sys::fs::file_type::regular_file);
Edwin Vaned544aa72013-09-30 13:31:48 +00002156 }
2157
Antonio Maiorano3adfb6a2017-01-17 00:12:27 +00002158 if (FoundConfigFile) {
Rafael Espindola2d2b4202014-07-06 17:43:24 +00002159 llvm::ErrorOr<std::unique_ptr<llvm::MemoryBuffer>> Text =
Eric Liu547d8792016-03-24 13:22:42 +00002160 FS->getBufferForFile(ConfigFile.str());
Antonio Maiorano3adfb6a2017-01-17 00:12:27 +00002161 if (std::error_code EC = Text.getError())
2162 return make_string_error(EC.message());
Rafael Espindola2d2b4202014-07-06 17:43:24 +00002163 if (std::error_code ec =
2164 parseConfiguration(Text.get()->getBuffer(), &Style)) {
Rafael Espindolad0136702014-06-12 02:50:04 +00002165 if (ec == ParseError::Unsuitable) {
Alexander Kornienkocabdd732013-11-29 15:19:43 +00002166 if (!UnsuitableConfigFiles.empty())
2167 UnsuitableConfigFiles.append(", ");
2168 UnsuitableConfigFiles.append(ConfigFile);
Alexander Kornienkobc4ae442013-12-02 15:21:38 +00002169 continue;
Alexander Kornienkocabdd732013-11-29 15:19:43 +00002170 }
Antonio Maiorano3adfb6a2017-01-17 00:12:27 +00002171 return make_string_error("Error reading " + ConfigFile + ": " +
2172 ec.message());
Edwin Vaned544aa72013-09-30 13:31:48 +00002173 }
2174 DEBUG(llvm::dbgs() << "Using configuration file " << ConfigFile << "\n");
2175 return Style;
2176 }
2177 }
Antonio Maiorano3adfb6a2017-01-17 00:12:27 +00002178 if (!UnsuitableConfigFiles.empty())
2179 return make_string_error("Configuration file(s) do(es) not support " +
2180 getLanguageName(Style.Language) + ": " +
2181 UnsuitableConfigFiles);
Antonio Maiorano7eb75072017-01-20 01:22:42 +00002182 return FallbackStyle;
Edwin Vaned544aa72013-09-30 13:31:48 +00002183}
2184
Daniel Jasper8d1832e2013-01-07 13:26:07 +00002185} // namespace format
2186} // namespace clang