blob: d1a5dc8e6c692c9caf8bb3e449b532c004778b29 [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
Adrian Prantl9fc8faf2018-05-09 01:00:01 +000011/// This file implements functions declared in Format.h. This will be
Daniel Jasperf7935112012-12-03 18:12:45 +000012/// 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"
Eric Liu44564ac2018-06-04 09:04:12 +000034#include "clang/Tooling/Inclusions/HeaderIncludes.h"
Alexander Kornienkoffd6d042013-03-27 11:52:18 +000035#include "llvm/ADT/STLExtras.h"
Ben Hamiltone2e3e672018-01-17 17:33:08 +000036#include "llvm/ADT/StringRef.h"
Manuel Klimek2ef908e2013-02-13 10:46:36 +000037#include "llvm/Support/Allocator.h"
Manuel Klimek24998102013-01-16 14:55:28 +000038#include "llvm/Support/Debug.h"
Edwin Vaned544aa72013-09-30 13:31:48 +000039#include "llvm/Support/Path.h"
Birunthan Mohanathasb001a0b2015-07-03 17:25:16 +000040#include "llvm/Support/Regex.h"
Chandler Carruth5553d0d2014-01-07 11:51:46 +000041#include "llvm/Support/YAMLTraits.h"
Martin Probst081f1762016-06-01 15:19:53 +000042#include <algorithm>
Eric Liu4cfb88a2016-04-25 15:09:22 +000043#include <memory>
Eric Liubf4c41c2018-05-04 17:55:13 +000044#include <mutex>
Daniel Jasper8b529712012-12-04 13:02:32 +000045#include <string>
Eric Liubf4c41c2018-05-04 17:55:13 +000046#include <unordered_map>
Daniel Jasper8b529712012-12-04 13:02:32 +000047
Chandler Carruth10346662014-04-22 03:17:02 +000048#define DEBUG_TYPE "format-formatter"
49
Alexander Kornienko6d2c88e2013-12-10 10:30:34 +000050using clang::format::FormatStyle;
51
NAKAMURA Takumi057a9422017-11-01 04:43:22 +000052LLVM_YAML_IS_SEQUENCE_VECTOR(clang::format::FormatStyle::RawStringFormat)
Daniel Jaspere1e43192014-04-01 12:55:11 +000053
Alexander Kornienkod6538332013-05-07 15:32:14 +000054namespace llvm {
55namespace yaml {
Alexander Kornienko6d2c88e2013-12-10 10:30:34 +000056template <> struct ScalarEnumerationTraits<FormatStyle::LanguageKind> {
57 static void enumeration(IO &IO, FormatStyle::LanguageKind &Value) {
58 IO.enumCase(Value, "Cpp", FormatStyle::LK_Cpp);
Daniel Jasperc58c70e2014-09-15 11:21:46 +000059 IO.enumCase(Value, "Java", FormatStyle::LK_Java);
Alexander Kornienko6d2c88e2013-12-10 10:30:34 +000060 IO.enumCase(Value, "JavaScript", FormatStyle::LK_JavaScript);
Daniel Jasper03a04fe2016-12-12 12:42:29 +000061 IO.enumCase(Value, "ObjC", FormatStyle::LK_ObjC);
Daniel Jasper7052ce62014-01-19 09:04:08 +000062 IO.enumCase(Value, "Proto", FormatStyle::LK_Proto);
Daniel Jasper498f5582015-12-25 08:53:31 +000063 IO.enumCase(Value, "TableGen", FormatStyle::LK_TableGen);
Krasimir Georgiev26b144c2017-07-03 15:05:14 +000064 IO.enumCase(Value, "TextProto", FormatStyle::LK_TextProto);
Alexander Kornienko6d2c88e2013-12-10 10:30:34 +000065 }
66};
67
68template <> struct ScalarEnumerationTraits<FormatStyle::LanguageStandard> {
69 static void enumeration(IO &IO, FormatStyle::LanguageStandard &Value) {
70 IO.enumCase(Value, "Cpp03", FormatStyle::LS_Cpp03);
71 IO.enumCase(Value, "C++03", FormatStyle::LS_Cpp03);
72 IO.enumCase(Value, "Cpp11", FormatStyle::LS_Cpp11);
73 IO.enumCase(Value, "C++11", FormatStyle::LS_Cpp11);
74 IO.enumCase(Value, "Auto", FormatStyle::LS_Auto);
75 }
76};
77
78template <> struct ScalarEnumerationTraits<FormatStyle::UseTabStyle> {
79 static void enumeration(IO &IO, FormatStyle::UseTabStyle &Value) {
80 IO.enumCase(Value, "Never", FormatStyle::UT_Never);
81 IO.enumCase(Value, "false", FormatStyle::UT_Never);
82 IO.enumCase(Value, "Always", FormatStyle::UT_Always);
83 IO.enumCase(Value, "true", FormatStyle::UT_Always);
84 IO.enumCase(Value, "ForIndentation", FormatStyle::UT_ForIndentation);
Marianne Mailhot-Sarrasin51fe2792016-04-14 14:52:26 +000085 IO.enumCase(Value, "ForContinuationAndIndentation",
86 FormatStyle::UT_ForContinuationAndIndentation);
Alexander Kornienko6d2c88e2013-12-10 10:30:34 +000087 }
88};
89
Daniel Jasperabd1f572016-03-02 22:44:03 +000090template <> struct ScalarEnumerationTraits<FormatStyle::JavaScriptQuoteStyle> {
91 static void enumeration(IO &IO, FormatStyle::JavaScriptQuoteStyle &Value) {
92 IO.enumCase(Value, "Leave", FormatStyle::JSQS_Leave);
93 IO.enumCase(Value, "Single", FormatStyle::JSQS_Single);
94 IO.enumCase(Value, "Double", FormatStyle::JSQS_Double);
95 }
96};
97
Daniel Jasperd74cf402014-04-08 12:46:38 +000098template <> struct ScalarEnumerationTraits<FormatStyle::ShortFunctionStyle> {
99 static void enumeration(IO &IO, FormatStyle::ShortFunctionStyle &Value) {
100 IO.enumCase(Value, "None", FormatStyle::SFS_None);
101 IO.enumCase(Value, "false", FormatStyle::SFS_None);
102 IO.enumCase(Value, "All", FormatStyle::SFS_All);
103 IO.enumCase(Value, "true", FormatStyle::SFS_All);
104 IO.enumCase(Value, "Inline", FormatStyle::SFS_Inline);
Francois Ferrandd3f0e3d2017-06-21 13:56:02 +0000105 IO.enumCase(Value, "InlineOnly", FormatStyle::SFS_InlineOnly);
Daniel Jasper9e709352014-11-26 10:43:58 +0000106 IO.enumCase(Value, "Empty", FormatStyle::SFS_Empty);
Daniel Jasperd74cf402014-04-08 12:46:38 +0000107 }
108};
109
Ben Hamilton4dc658c2018-02-02 20:15:14 +0000110template <> struct ScalarEnumerationTraits<FormatStyle::BinPackStyle> {
111 static void enumeration(IO &IO, FormatStyle::BinPackStyle &Value) {
112 IO.enumCase(Value, "Auto", FormatStyle::BPS_Auto);
113 IO.enumCase(Value, "Always", FormatStyle::BPS_Always);
114 IO.enumCase(Value, "Never", FormatStyle::BPS_Never);
115 }
116};
117
Daniel Jasperac043c92014-09-15 11:11:00 +0000118template <> struct ScalarEnumerationTraits<FormatStyle::BinaryOperatorStyle> {
119 static void enumeration(IO &IO, FormatStyle::BinaryOperatorStyle &Value) {
120 IO.enumCase(Value, "All", FormatStyle::BOS_All);
121 IO.enumCase(Value, "true", FormatStyle::BOS_All);
122 IO.enumCase(Value, "None", FormatStyle::BOS_None);
123 IO.enumCase(Value, "false", FormatStyle::BOS_None);
124 IO.enumCase(Value, "NonAssignment", FormatStyle::BOS_NonAssignment);
125 }
126};
127
Alexander Kornienko6d2c88e2013-12-10 10:30:34 +0000128template <> struct ScalarEnumerationTraits<FormatStyle::BraceBreakingStyle> {
129 static void enumeration(IO &IO, FormatStyle::BraceBreakingStyle &Value) {
130 IO.enumCase(Value, "Attach", FormatStyle::BS_Attach);
131 IO.enumCase(Value, "Linux", FormatStyle::BS_Linux);
Birunthan Mohanathas305fa9c2015-07-12 03:13:54 +0000132 IO.enumCase(Value, "Mozilla", FormatStyle::BS_Mozilla);
Alexander Kornienko6d2c88e2013-12-10 10:30:34 +0000133 IO.enumCase(Value, "Stroustrup", FormatStyle::BS_Stroustrup);
134 IO.enumCase(Value, "Allman", FormatStyle::BS_Allman);
Alexander Kornienko3a33f022013-12-12 09:49:52 +0000135 IO.enumCase(Value, "GNU", FormatStyle::BS_GNU);
Roman Kashitsyn291f64f2015-08-10 13:43:19 +0000136 IO.enumCase(Value, "WebKit", FormatStyle::BS_WebKit);
Daniel Jasperc1bc38e2015-09-29 14:57:55 +0000137 IO.enumCase(Value, "Custom", FormatStyle::BS_Custom);
Alexander Kornienko6d2c88e2013-12-10 10:30:34 +0000138 }
139};
140
Manuel Klimek89628f62017-09-20 09:51:03 +0000141template <>
142struct ScalarEnumerationTraits<FormatStyle::BreakConstructorInitializersStyle> {
143 static void
144 enumeration(IO &IO, FormatStyle::BreakConstructorInitializersStyle &Value) {
Francois Ferranda6b6d512017-05-24 11:36:58 +0000145 IO.enumCase(Value, "BeforeColon", FormatStyle::BCIS_BeforeColon);
146 IO.enumCase(Value, "BeforeComma", FormatStyle::BCIS_BeforeComma);
147 IO.enumCase(Value, "AfterColon", FormatStyle::BCIS_AfterColon);
148 }
149};
150
Daniel Jasperc1bc38e2015-09-29 14:57:55 +0000151template <>
Krasimir Georgievad47c902017-08-30 14:34:57 +0000152struct ScalarEnumerationTraits<FormatStyle::PPDirectiveIndentStyle> {
153 static void enumeration(IO &IO, FormatStyle::PPDirectiveIndentStyle &Value) {
154 IO.enumCase(Value, "None", FormatStyle::PPDIS_None);
155 IO.enumCase(Value, "AfterHash", FormatStyle::PPDIS_AfterHash);
156 }
157};
158
159template <>
Zachary Turner448592e2015-12-18 22:20:15 +0000160struct ScalarEnumerationTraits<FormatStyle::ReturnTypeBreakingStyle> {
161 static void enumeration(IO &IO, FormatStyle::ReturnTypeBreakingStyle &Value) {
162 IO.enumCase(Value, "None", FormatStyle::RTBS_None);
163 IO.enumCase(Value, "All", FormatStyle::RTBS_All);
164 IO.enumCase(Value, "TopLevel", FormatStyle::RTBS_TopLevel);
165 IO.enumCase(Value, "TopLevelDefinitions",
166 FormatStyle::RTBS_TopLevelDefinitions);
167 IO.enumCase(Value, "AllDefinitions", FormatStyle::RTBS_AllDefinitions);
168 }
169};
170
171template <>
Francois Ferrand58e6fe52018-05-16 08:25:03 +0000172struct ScalarEnumerationTraits<FormatStyle::BreakTemplateDeclarationsStyle> {
173 static void enumeration(IO &IO, FormatStyle::BreakTemplateDeclarationsStyle &Value) {
174 IO.enumCase(Value, "No", FormatStyle::BTDS_No);
175 IO.enumCase(Value, "MultiLine", FormatStyle::BTDS_MultiLine);
176 IO.enumCase(Value, "Yes", FormatStyle::BTDS_Yes);
177
178 // For backward compatibility.
179 IO.enumCase(Value, "false", FormatStyle::BTDS_MultiLine);
180 IO.enumCase(Value, "true", FormatStyle::BTDS_Yes);
181 }
182};
183
184template <>
Daniel Jasperc1bc38e2015-09-29 14:57:55 +0000185struct ScalarEnumerationTraits<FormatStyle::DefinitionReturnTypeBreakingStyle> {
186 static void
187 enumeration(IO &IO, FormatStyle::DefinitionReturnTypeBreakingStyle &Value) {
Birunthan Mohanathasa0388a82015-06-29 15:30:42 +0000188 IO.enumCase(Value, "None", FormatStyle::DRTBS_None);
189 IO.enumCase(Value, "All", FormatStyle::DRTBS_All);
190 IO.enumCase(Value, "TopLevel", FormatStyle::DRTBS_TopLevel);
191
192 // For backward compatibility.
193 IO.enumCase(Value, "false", FormatStyle::DRTBS_None);
194 IO.enumCase(Value, "true", FormatStyle::DRTBS_All);
195 }
196};
197
Alexander Kornienkod6538332013-05-07 15:32:14 +0000198template <>
Alexander Kornienko6d2c88e2013-12-10 10:30:34 +0000199struct ScalarEnumerationTraits<FormatStyle::NamespaceIndentationKind> {
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000200 static void enumeration(IO &IO,
Alexander Kornienko6d2c88e2013-12-10 10:30:34 +0000201 FormatStyle::NamespaceIndentationKind &Value) {
202 IO.enumCase(Value, "None", FormatStyle::NI_None);
203 IO.enumCase(Value, "Inner", FormatStyle::NI_Inner);
204 IO.enumCase(Value, "All", FormatStyle::NI_All);
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000205 }
206};
207
Daniel Jasper6501f7e2015-10-27 12:38:37 +0000208template <> struct ScalarEnumerationTraits<FormatStyle::BracketAlignmentStyle> {
209 static void enumeration(IO &IO, FormatStyle::BracketAlignmentStyle &Value) {
210 IO.enumCase(Value, "Align", FormatStyle::BAS_Align);
211 IO.enumCase(Value, "DontAlign", FormatStyle::BAS_DontAlign);
212 IO.enumCase(Value, "AlwaysBreak", FormatStyle::BAS_AlwaysBreak);
213
214 // For backward compatibility.
215 IO.enumCase(Value, "true", FormatStyle::BAS_Align);
216 IO.enumCase(Value, "false", FormatStyle::BAS_DontAlign);
217 }
218};
219
Manuel Klimek89628f62017-09-20 09:51:03 +0000220template <>
221struct ScalarEnumerationTraits<FormatStyle::EscapedNewlineAlignmentStyle> {
222 static void enumeration(IO &IO,
223 FormatStyle::EscapedNewlineAlignmentStyle &Value) {
Daniel Jasper7fdbb3f2017-05-08 15:08:00 +0000224 IO.enumCase(Value, "DontAlign", FormatStyle::ENAS_DontAlign);
225 IO.enumCase(Value, "Left", FormatStyle::ENAS_Left);
226 IO.enumCase(Value, "Right", FormatStyle::ENAS_Right);
227
228 // For backward compatibility.
229 IO.enumCase(Value, "true", FormatStyle::ENAS_Left);
230 IO.enumCase(Value, "false", FormatStyle::ENAS_Right);
231 }
232};
233
Jacques Pienaarfc275112015-02-18 23:48:37 +0000234template <> struct ScalarEnumerationTraits<FormatStyle::PointerAlignmentStyle> {
235 static void enumeration(IO &IO, FormatStyle::PointerAlignmentStyle &Value) {
Daniel Jasper553d4872014-06-17 12:40:34 +0000236 IO.enumCase(Value, "Middle", FormatStyle::PAS_Middle);
237 IO.enumCase(Value, "Left", FormatStyle::PAS_Left);
238 IO.enumCase(Value, "Right", FormatStyle::PAS_Right);
239
Alp Toker958027b2014-07-14 19:42:55 +0000240 // For backward compatibility.
Daniel Jasper553d4872014-06-17 12:40:34 +0000241 IO.enumCase(Value, "true", FormatStyle::PAS_Left);
242 IO.enumCase(Value, "false", FormatStyle::PAS_Right);
243 }
244};
245
246template <>
Alexander Kornienko6d2c88e2013-12-10 10:30:34 +0000247struct ScalarEnumerationTraits<FormatStyle::SpaceBeforeParensOptions> {
Manuel Klimeka8eb9142013-05-13 12:51:40 +0000248 static void enumeration(IO &IO,
Alexander Kornienko6d2c88e2013-12-10 10:30:34 +0000249 FormatStyle::SpaceBeforeParensOptions &Value) {
250 IO.enumCase(Value, "Never", FormatStyle::SBPO_Never);
Alexander Kornienkofdca83d2013-12-10 10:18:34 +0000251 IO.enumCase(Value, "ControlStatements",
Alexander Kornienko6d2c88e2013-12-10 10:30:34 +0000252 FormatStyle::SBPO_ControlStatements);
253 IO.enumCase(Value, "Always", FormatStyle::SBPO_Always);
Alexander Kornienkofdca83d2013-12-10 10:18:34 +0000254
255 // For backward compatibility.
Alexander Kornienko6d2c88e2013-12-10 10:30:34 +0000256 IO.enumCase(Value, "false", FormatStyle::SBPO_Never);
257 IO.enumCase(Value, "true", FormatStyle::SBPO_ControlStatements);
Alexander Kornienkofdca83d2013-12-10 10:18:34 +0000258 }
259};
260
Alexander Kornienko6d2c88e2013-12-10 10:30:34 +0000261template <> struct MappingTraits<FormatStyle> {
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000262 static void mapping(IO &IO, FormatStyle &Style) {
263 // When reading, read the language first, we need it for getPredefinedStyle.
264 IO.mapOptional("Language", Style.Language);
265
Alexander Kornienko49149672013-05-10 11:56:10 +0000266 if (IO.outputting()) {
Jacques Pienaarfc275112015-02-18 23:48:37 +0000267 StringRef StylesArray[] = {"LLVM", "Google", "Chromium",
268 "Mozilla", "WebKit", "GNU"};
Alexander Kornienko49149672013-05-10 11:56:10 +0000269 ArrayRef<StringRef> Styles(StylesArray);
270 for (size_t i = 0, e = Styles.size(); i < e; ++i) {
271 StringRef StyleName(Styles[i]);
Alexander Kornienko6d2c88e2013-12-10 10:30:34 +0000272 FormatStyle PredefinedStyle;
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000273 if (getPredefinedStyle(StyleName, Style.Language, &PredefinedStyle) &&
Alexander Kornienko006b5c82013-05-19 00:53:30 +0000274 Style == PredefinedStyle) {
Alexander Kornienko49149672013-05-10 11:56:10 +0000275 IO.mapOptional("# BasedOnStyle", StyleName);
276 break;
277 }
278 }
279 } else {
Alexander Kornienkod6538332013-05-07 15:32:14 +0000280 StringRef BasedOnStyle;
281 IO.mapOptional("BasedOnStyle", BasedOnStyle);
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000282 if (!BasedOnStyle.empty()) {
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000283 FormatStyle::LanguageKind OldLanguage = Style.Language;
284 FormatStyle::LanguageKind Language =
285 ((FormatStyle *)IO.getContext())->Language;
286 if (!getPredefinedStyle(BasedOnStyle, Language, &Style)) {
Alexander Kornienko006b5c82013-05-19 00:53:30 +0000287 IO.setError(Twine("Unknown value for BasedOnStyle: ", BasedOnStyle));
288 return;
289 }
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000290 Style.Language = OldLanguage;
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000291 }
Alexander Kornienkod6538332013-05-07 15:32:14 +0000292 }
293
Birunthan Mohanathas50a6f912015-06-28 14:52:34 +0000294 // For backward compatibility.
295 if (!IO.outputting()) {
Daniel Jasper7fdbb3f2017-05-08 15:08:00 +0000296 IO.mapOptional("AlignEscapedNewlinesLeft", Style.AlignEscapedNewlines);
Birunthan Mohanathas50a6f912015-06-28 14:52:34 +0000297 IO.mapOptional("DerivePointerBinding", Style.DerivePointerAlignment);
298 IO.mapOptional("IndentFunctionDeclarationAfterType",
299 Style.IndentWrappedFunctionNames);
300 IO.mapOptional("PointerBindsToType", Style.PointerAlignment);
301 IO.mapOptional("SpaceAfterControlStatementKeyword",
302 Style.SpaceBeforeParens);
303 }
304
Alexander Kornienkod6538332013-05-07 15:32:14 +0000305 IO.mapOptional("AccessModifierOffset", Style.AccessModifierOffset);
Daniel Jasper3aa9a6a2014-11-18 23:55:27 +0000306 IO.mapOptional("AlignAfterOpenBracket", Style.AlignAfterOpenBracket);
Birunthan Mohanathas35cfbd72015-06-28 14:51:17 +0000307 IO.mapOptional("AlignConsecutiveAssignments",
308 Style.AlignConsecutiveAssignments);
Daniel Jaspere12597c2015-10-01 10:06:54 +0000309 IO.mapOptional("AlignConsecutiveDeclarations",
310 Style.AlignConsecutiveDeclarations);
Daniel Jasper7fdbb3f2017-05-08 15:08:00 +0000311 IO.mapOptional("AlignEscapedNewlines", Style.AlignEscapedNewlines);
Daniel Jasper3219e432014-12-02 13:24:51 +0000312 IO.mapOptional("AlignOperands", Style.AlignOperands);
Daniel Jasper552f4a72013-07-31 23:55:15 +0000313 IO.mapOptional("AlignTrailingComments", Style.AlignTrailingComments);
Alexander Kornienkod6538332013-05-07 15:32:14 +0000314 IO.mapOptional("AllowAllParametersOfDeclarationOnNextLine",
315 Style.AllowAllParametersOfDeclarationOnNextLine);
Daniel Jasper17605d32014-05-14 09:33:35 +0000316 IO.mapOptional("AllowShortBlocksOnASingleLine",
317 Style.AllowShortBlocksOnASingleLine);
Daniel Jasperb87899b2014-09-10 13:11:45 +0000318 IO.mapOptional("AllowShortCaseLabelsOnASingleLine",
319 Style.AllowShortCaseLabelsOnASingleLine);
Birunthan Mohanathas35cfbd72015-06-28 14:51:17 +0000320 IO.mapOptional("AllowShortFunctionsOnASingleLine",
321 Style.AllowShortFunctionsOnASingleLine);
Alexander Kornienkod6538332013-05-07 15:32:14 +0000322 IO.mapOptional("AllowShortIfStatementsOnASingleLine",
323 Style.AllowShortIfStatementsOnASingleLine);
Daniel Jasper3a685df2013-05-16 12:12:21 +0000324 IO.mapOptional("AllowShortLoopsOnASingleLine",
325 Style.AllowShortLoopsOnASingleLine);
Daniel Jasperca4ea1c2014-08-05 12:16:31 +0000326 IO.mapOptional("AlwaysBreakAfterDefinitionReturnType",
327 Style.AlwaysBreakAfterDefinitionReturnType);
Zachary Turner448592e2015-12-18 22:20:15 +0000328 IO.mapOptional("AlwaysBreakAfterReturnType",
329 Style.AlwaysBreakAfterReturnType);
330 // If AlwaysBreakAfterDefinitionReturnType was specified but
331 // AlwaysBreakAfterReturnType was not, initialize the latter from the
332 // former for backwards compatibility.
333 if (Style.AlwaysBreakAfterDefinitionReturnType != FormatStyle::DRTBS_None &&
334 Style.AlwaysBreakAfterReturnType == FormatStyle::RTBS_None) {
335 if (Style.AlwaysBreakAfterDefinitionReturnType == FormatStyle::DRTBS_All)
336 Style.AlwaysBreakAfterReturnType = FormatStyle::RTBS_AllDefinitions;
337 else if (Style.AlwaysBreakAfterDefinitionReturnType ==
338 FormatStyle::DRTBS_TopLevel)
339 Style.AlwaysBreakAfterReturnType =
340 FormatStyle::RTBS_TopLevelDefinitions;
341 }
342
Alexander Kornienko58611712013-07-04 12:02:44 +0000343 IO.mapOptional("AlwaysBreakBeforeMultilineStrings",
344 Style.AlwaysBreakBeforeMultilineStrings);
Birunthan Mohanathas35cfbd72015-06-28 14:51:17 +0000345 IO.mapOptional("AlwaysBreakTemplateDeclarations",
346 Style.AlwaysBreakTemplateDeclarations);
347 IO.mapOptional("BinPackArguments", Style.BinPackArguments);
348 IO.mapOptional("BinPackParameters", Style.BinPackParameters);
Daniel Jasperc1bc38e2015-09-29 14:57:55 +0000349 IO.mapOptional("BraceWrapping", Style.BraceWrapping);
Daniel Jaspere33d4af2013-07-26 16:56:36 +0000350 IO.mapOptional("BreakBeforeBinaryOperators",
351 Style.BreakBeforeBinaryOperators);
Birunthan Mohanathas35cfbd72015-06-28 14:51:17 +0000352 IO.mapOptional("BreakBeforeBraces", Style.BreakBeforeBraces);
Francois Ferrande56a8292017-06-14 12:29:47 +0000353 IO.mapOptional("BreakBeforeInheritanceComma",
354 Style.BreakBeforeInheritanceComma);
Daniel Jasper165b29e2013-11-08 00:57:11 +0000355 IO.mapOptional("BreakBeforeTernaryOperators",
356 Style.BreakBeforeTernaryOperators);
Francois Ferranda6b6d512017-05-24 11:36:58 +0000357
358 bool BreakConstructorInitializersBeforeComma = false;
Daniel Jaspere33d4af2013-07-26 16:56:36 +0000359 IO.mapOptional("BreakConstructorInitializersBeforeComma",
Francois Ferranda6b6d512017-05-24 11:36:58 +0000360 BreakConstructorInitializersBeforeComma);
361 IO.mapOptional("BreakConstructorInitializers",
362 Style.BreakConstructorInitializers);
363 // If BreakConstructorInitializersBeforeComma was specified but
364 // BreakConstructorInitializers was not, initialize the latter from the
365 // former for backwards compatibility.
366 if (BreakConstructorInitializersBeforeComma &&
367 Style.BreakConstructorInitializers == FormatStyle::BCIS_BeforeColon)
368 Style.BreakConstructorInitializers = FormatStyle::BCIS_BeforeComma;
369
Daniel Jaspere1a7b762016-02-01 11:21:02 +0000370 IO.mapOptional("BreakAfterJavaFieldAnnotations",
371 Style.BreakAfterJavaFieldAnnotations);
372 IO.mapOptional("BreakStringLiterals", Style.BreakStringLiterals);
Alexander Kornienkod6538332013-05-07 15:32:14 +0000373 IO.mapOptional("ColumnLimit", Style.ColumnLimit);
Birunthan Mohanathas35cfbd72015-06-28 14:51:17 +0000374 IO.mapOptional("CommentPragmas", Style.CommentPragmas);
Francois Ferrande56a8292017-06-14 12:29:47 +0000375 IO.mapOptional("CompactNamespaces", Style.CompactNamespaces);
Alexander Kornienkod6538332013-05-07 15:32:14 +0000376 IO.mapOptional("ConstructorInitializerAllOnOneLineOrOnePerLine",
377 Style.ConstructorInitializerAllOnOneLineOrOnePerLine);
Daniel Jasper50d634b2014-10-28 16:53:38 +0000378 IO.mapOptional("ConstructorInitializerIndentWidth",
379 Style.ConstructorInitializerIndentWidth);
Birunthan Mohanathas35cfbd72015-06-28 14:51:17 +0000380 IO.mapOptional("ContinuationIndentWidth", Style.ContinuationIndentWidth);
381 IO.mapOptional("Cpp11BracedListStyle", Style.Cpp11BracedListStyle);
Daniel Jasper553d4872014-06-17 12:40:34 +0000382 IO.mapOptional("DerivePointerAlignment", Style.DerivePointerAlignment);
Birunthan Mohanathas35cfbd72015-06-28 14:51:17 +0000383 IO.mapOptional("DisableFormat", Style.DisableFormat);
Daniel Jasperb10cbc42013-07-10 14:02:49 +0000384 IO.mapOptional("ExperimentalAutoDetectBinPacking",
385 Style.ExperimentalAutoDetectBinPacking);
Krasimir Georgiev32eaa862017-03-01 15:35:39 +0000386 IO.mapOptional("FixNamespaceComments", Style.FixNamespaceComments);
Birunthan Mohanathas35cfbd72015-06-28 14:51:17 +0000387 IO.mapOptional("ForEachMacros", Style.ForEachMacros);
Eric Liu9d92c022018-05-14 19:51:33 +0000388 IO.mapOptional("IncludeBlocks", Style.IncludeStyle.IncludeBlocks);
389 IO.mapOptional("IncludeCategories", Style.IncludeStyle.IncludeCategories);
390 IO.mapOptional("IncludeIsMainRegex", Style.IncludeStyle.IncludeIsMainRegex);
Alexander Kornienkod6538332013-05-07 15:32:14 +0000391 IO.mapOptional("IndentCaseLabels", Style.IndentCaseLabels);
Krasimir Georgievad47c902017-08-30 14:34:57 +0000392 IO.mapOptional("IndentPPDirectives", Style.IndentPPDirectives);
Birunthan Mohanathas35cfbd72015-06-28 14:51:17 +0000393 IO.mapOptional("IndentWidth", Style.IndentWidth);
394 IO.mapOptional("IndentWrappedFunctionNames",
395 Style.IndentWrappedFunctionNames);
Martin Probst0cd74ee2016-06-13 16:39:50 +0000396 IO.mapOptional("JavaScriptQuotes", Style.JavaScriptQuotes);
397 IO.mapOptional("JavaScriptWrapImports", Style.JavaScriptWrapImports);
Daniel Jaspera26fc5c2014-03-21 13:43:14 +0000398 IO.mapOptional("KeepEmptyLinesAtTheStartOfBlocks",
399 Style.KeepEmptyLinesAtTheStartOfBlocks);
Birunthan Mohanathasb001a0b2015-07-03 17:25:16 +0000400 IO.mapOptional("MacroBlockBegin", Style.MacroBlockBegin);
401 IO.mapOptional("MacroBlockEnd", Style.MacroBlockEnd);
Birunthan Mohanathas35cfbd72015-06-28 14:51:17 +0000402 IO.mapOptional("MaxEmptyLinesToKeep", Style.MaxEmptyLinesToKeep);
Daniel Jasper65ee3472013-07-31 23:16:02 +0000403 IO.mapOptional("NamespaceIndentation", Style.NamespaceIndentation);
Ben Hamilton4dc658c2018-02-02 20:15:14 +0000404 IO.mapOptional("ObjCBinPackProtocolList", Style.ObjCBinPackProtocolList);
Daniel Jasper50d634b2014-10-28 16:53:38 +0000405 IO.mapOptional("ObjCBlockIndentWidth", Style.ObjCBlockIndentWidth);
Daniel Jaspere9beea22014-01-28 15:20:33 +0000406 IO.mapOptional("ObjCSpaceAfterProperty", Style.ObjCSpaceAfterProperty);
Alexander Kornienkod6538332013-05-07 15:32:14 +0000407 IO.mapOptional("ObjCSpaceBeforeProtocolList",
408 Style.ObjCSpaceBeforeProtocolList);
Manuel Klimek89628f62017-09-20 09:51:03 +0000409 IO.mapOptional("PenaltyBreakAssignment", Style.PenaltyBreakAssignment);
Daniel Jasper33b909c2013-10-25 14:29:37 +0000410 IO.mapOptional("PenaltyBreakBeforeFirstCallParameter",
411 Style.PenaltyBreakBeforeFirstCallParameter);
Alexander Kornienkodd7ece52013-06-07 16:02:52 +0000412 IO.mapOptional("PenaltyBreakComment", Style.PenaltyBreakComment);
Daniel Jasper4e9678f2013-07-11 20:41:21 +0000413 IO.mapOptional("PenaltyBreakFirstLessLess",
414 Style.PenaltyBreakFirstLessLess);
Birunthan Mohanathas35cfbd72015-06-28 14:51:17 +0000415 IO.mapOptional("PenaltyBreakString", Style.PenaltyBreakString);
Francois Ferrand58e6fe52018-05-16 08:25:03 +0000416 IO.mapOptional("PenaltyBreakTemplateDeclaration",
417 Style.PenaltyBreakTemplateDeclaration);
Alexander Kornienkod6538332013-05-07 15:32:14 +0000418 IO.mapOptional("PenaltyExcessCharacter", Style.PenaltyExcessCharacter);
419 IO.mapOptional("PenaltyReturnTypeOnItsOwnLine",
420 Style.PenaltyReturnTypeOnItsOwnLine);
Daniel Jasper553d4872014-06-17 12:40:34 +0000421 IO.mapOptional("PointerAlignment", Style.PointerAlignment);
Krasimir Georgiev9ad83fe2017-10-30 14:01:50 +0000422 IO.mapOptional("RawStringFormats", Style.RawStringFormats);
Daniel Jaspera0a50392015-12-01 13:28:53 +0000423 IO.mapOptional("ReflowComments", Style.ReflowComments);
424 IO.mapOptional("SortIncludes", Style.SortIncludes);
Krasimir Georgievac16a202017-06-23 11:46:03 +0000425 IO.mapOptional("SortUsingDeclarations", Style.SortUsingDeclarations);
Daniel Jasperdb986eb2014-09-03 07:37:29 +0000426 IO.mapOptional("SpaceAfterCStyleCast", Style.SpaceAfterCStyleCast);
Manuel Klimek89628f62017-09-20 09:51:03 +0000427 IO.mapOptional("SpaceAfterTemplateKeyword",
428 Style.SpaceAfterTemplateKeyword);
Daniel Jasperd94bff32013-09-25 15:15:02 +0000429 IO.mapOptional("SpaceBeforeAssignmentOperators",
430 Style.SpaceBeforeAssignmentOperators);
Francois Ferrand2a9ea782018-03-01 10:09:13 +0000431 IO.mapOptional("SpaceBeforeCtorInitializerColon",
432 Style.SpaceBeforeCtorInitializerColon);
433 IO.mapOptional("SpaceBeforeInheritanceColon",
434 Style.SpaceBeforeInheritanceColon);
Birunthan Mohanathas35cfbd72015-06-28 14:51:17 +0000435 IO.mapOptional("SpaceBeforeParens", Style.SpaceBeforeParens);
Francois Ferrand2a9ea782018-03-01 10:09:13 +0000436 IO.mapOptional("SpaceBeforeRangeBasedForLoopColon",
437 Style.SpaceBeforeRangeBasedForLoopColon);
Birunthan Mohanathas35cfbd72015-06-28 14:51:17 +0000438 IO.mapOptional("SpaceInEmptyParentheses", Style.SpaceInEmptyParentheses);
439 IO.mapOptional("SpacesBeforeTrailingComments",
440 Style.SpacesBeforeTrailingComments);
441 IO.mapOptional("SpacesInAngles", Style.SpacesInAngles);
442 IO.mapOptional("SpacesInContainerLiterals",
443 Style.SpacesInContainerLiterals);
444 IO.mapOptional("SpacesInCStyleCastParentheses",
445 Style.SpacesInCStyleCastParentheses);
446 IO.mapOptional("SpacesInParentheses", Style.SpacesInParentheses);
447 IO.mapOptional("SpacesInSquareBrackets", Style.SpacesInSquareBrackets);
448 IO.mapOptional("Standard", Style.Standard);
449 IO.mapOptional("TabWidth", Style.TabWidth);
450 IO.mapOptional("UseTab", Style.UseTab);
Alexander Kornienkod6538332013-05-07 15:32:14 +0000451 }
452};
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000453
Daniel Jasperc1bc38e2015-09-29 14:57:55 +0000454template <> struct MappingTraits<FormatStyle::BraceWrappingFlags> {
455 static void mapping(IO &IO, FormatStyle::BraceWrappingFlags &Wrapping) {
456 IO.mapOptional("AfterClass", Wrapping.AfterClass);
457 IO.mapOptional("AfterControlStatement", Wrapping.AfterControlStatement);
458 IO.mapOptional("AfterEnum", Wrapping.AfterEnum);
459 IO.mapOptional("AfterFunction", Wrapping.AfterFunction);
460 IO.mapOptional("AfterNamespace", Wrapping.AfterNamespace);
461 IO.mapOptional("AfterObjCDeclaration", Wrapping.AfterObjCDeclaration);
462 IO.mapOptional("AfterStruct", Wrapping.AfterStruct);
463 IO.mapOptional("AfterUnion", Wrapping.AfterUnion);
Krasimir Georgievd6ce9372017-09-15 11:23:50 +0000464 IO.mapOptional("AfterExternBlock", Wrapping.AfterExternBlock);
Daniel Jasperc1bc38e2015-09-29 14:57:55 +0000465 IO.mapOptional("BeforeCatch", Wrapping.BeforeCatch);
466 IO.mapOptional("BeforeElse", Wrapping.BeforeElse);
467 IO.mapOptional("IndentBraces", Wrapping.IndentBraces);
Francois Ferrandad722562017-06-30 20:25:55 +0000468 IO.mapOptional("SplitEmptyFunction", Wrapping.SplitEmptyFunction);
469 IO.mapOptional("SplitEmptyRecord", Wrapping.SplitEmptyRecord);
470 IO.mapOptional("SplitEmptyNamespace", Wrapping.SplitEmptyNamespace);
Daniel Jasperc1bc38e2015-09-29 14:57:55 +0000471 }
472};
473
Krasimir Georgiev9ad83fe2017-10-30 14:01:50 +0000474template <> struct MappingTraits<FormatStyle::RawStringFormat> {
475 static void mapping(IO &IO, FormatStyle::RawStringFormat &Format) {
Krasimir Georgiev9ad83fe2017-10-30 14:01:50 +0000476 IO.mapOptional("Language", Format.Language);
Krasimir Georgiev4527f132018-01-17 12:24:59 +0000477 IO.mapOptional("Delimiters", Format.Delimiters);
Krasimir Georgiev2537e222018-01-17 16:17:26 +0000478 IO.mapOptional("EnclosingFunctions", Format.EnclosingFunctions);
Krasimir Georgiev412ed092018-01-19 16:18:47 +0000479 IO.mapOptional("CanonicalDelimiter", Format.CanonicalDelimiter);
Krasimir Georgiev9ad83fe2017-10-30 14:01:50 +0000480 IO.mapOptional("BasedOnStyle", Format.BasedOnStyle);
481 }
482};
483
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000484// Allows to read vector<FormatStyle> while keeping default values.
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000485// IO.getContext() should contain a pointer to the FormatStyle structure, that
486// will be used to get default values for missing keys.
487// If the first element has no Language specified, it will be treated as the
488// default one for the following elements.
Jacques Pienaarfc275112015-02-18 23:48:37 +0000489template <> struct DocumentListTraits<std::vector<FormatStyle>> {
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000490 static size_t size(IO &IO, std::vector<FormatStyle> &Seq) {
491 return Seq.size();
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000492 }
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000493 static FormatStyle &element(IO &IO, std::vector<FormatStyle> &Seq,
Alexander Kornienko6d2c88e2013-12-10 10:30:34 +0000494 size_t Index) {
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000495 if (Index >= Seq.size()) {
496 assert(Index == Seq.size());
Alexander Kornienko6d2c88e2013-12-10 10:30:34 +0000497 FormatStyle Template;
Krasimir Georgiev1696bb62017-11-09 15:12:17 +0000498 if (!Seq.empty() && Seq[0].Language == FormatStyle::LK_None) {
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000499 Template = Seq[0];
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000500 } else {
Daniel Jasperb05a81d2014-05-09 13:11:16 +0000501 Template = *((const FormatStyle *)IO.getContext());
Alexander Kornienko6d2c88e2013-12-10 10:30:34 +0000502 Template.Language = FormatStyle::LK_None;
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000503 }
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000504 Seq.resize(Index + 1, Template);
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000505 }
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000506 return Seq[Index];
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000507 }
508};
Daniel Jasperd89ae9d2015-09-23 08:30:47 +0000509} // namespace yaml
510} // namespace llvm
Alexander Kornienkod6538332013-05-07 15:32:14 +0000511
Daniel Jasperf7935112012-12-03 18:12:45 +0000512namespace clang {
513namespace format {
514
Rafael Espindola6d0d89b2014-06-12 03:31:26 +0000515const std::error_category &getParseCategory() {
Benjamin Kramerf76861c2018-03-20 21:52:19 +0000516 static const ParseErrorCategory C{};
Rafael Espindolad0136702014-06-12 02:50:04 +0000517 return C;
518}
519std::error_code make_error_code(ParseError e) {
Rafael Espindola6d0d89b2014-06-12 03:31:26 +0000520 return std::error_code(static_cast<int>(e), getParseCategory());
Rafael Espindolad0136702014-06-12 02:50:04 +0000521}
522
Antonio Maiorano3adfb6a2017-01-17 00:12:27 +0000523inline llvm::Error make_string_error(const llvm::Twine &Message) {
524 return llvm::make_error<llvm::StringError>(Message,
525 llvm::inconvertibleErrorCode());
526}
527
Reid Kleckner6432d452016-10-19 23:39:55 +0000528const char *ParseErrorCategory::name() const noexcept {
Rafael Espindolad0136702014-06-12 02:50:04 +0000529 return "clang-format.parse_error";
530}
531
532std::string ParseErrorCategory::message(int EV) const {
533 switch (static_cast<ParseError>(EV)) {
534 case ParseError::Success:
535 return "Success";
536 case ParseError::Error:
537 return "Invalid argument";
538 case ParseError::Unsuitable:
539 return "Unsuitable";
540 }
Saleem Abdulrasoolfbfbaf62014-06-12 19:33:26 +0000541 llvm_unreachable("unexpected parse error");
Rafael Espindolad0136702014-06-12 02:50:04 +0000542}
543
Daniel Jasperc1bc38e2015-09-29 14:57:55 +0000544static FormatStyle expandPresets(const FormatStyle &Style) {
Daniel Jasper55bbe662015-10-07 04:06:10 +0000545 if (Style.BreakBeforeBraces == FormatStyle::BS_Custom)
546 return Style;
Daniel Jasperc1bc38e2015-09-29 14:57:55 +0000547 FormatStyle Expanded = Style;
Manuel Klimek89628f62017-09-20 09:51:03 +0000548 Expanded.BraceWrapping = {false, false, false, false, false,
549 false, false, false, false, false,
550 false, false, true, true, true};
Daniel Jasperc1bc38e2015-09-29 14:57:55 +0000551 switch (Style.BreakBeforeBraces) {
552 case FormatStyle::BS_Linux:
553 Expanded.BraceWrapping.AfterClass = true;
554 Expanded.BraceWrapping.AfterFunction = true;
555 Expanded.BraceWrapping.AfterNamespace = true;
Daniel Jasperc1bc38e2015-09-29 14:57:55 +0000556 break;
557 case FormatStyle::BS_Mozilla:
558 Expanded.BraceWrapping.AfterClass = true;
559 Expanded.BraceWrapping.AfterEnum = true;
560 Expanded.BraceWrapping.AfterFunction = true;
561 Expanded.BraceWrapping.AfterStruct = true;
562 Expanded.BraceWrapping.AfterUnion = true;
Krasimir Georgievd6ce9372017-09-15 11:23:50 +0000563 Expanded.BraceWrapping.AfterExternBlock = true;
Sylvestre Ledru82c9a0e2017-09-13 20:03:29 +0000564 Expanded.BraceWrapping.SplitEmptyFunction = true;
Francois Ferrandad722562017-06-30 20:25:55 +0000565 Expanded.BraceWrapping.SplitEmptyRecord = false;
Daniel Jasperc1bc38e2015-09-29 14:57:55 +0000566 break;
567 case FormatStyle::BS_Stroustrup:
568 Expanded.BraceWrapping.AfterFunction = true;
569 Expanded.BraceWrapping.BeforeCatch = true;
570 Expanded.BraceWrapping.BeforeElse = true;
571 break;
572 case FormatStyle::BS_Allman:
573 Expanded.BraceWrapping.AfterClass = true;
574 Expanded.BraceWrapping.AfterControlStatement = true;
575 Expanded.BraceWrapping.AfterEnum = true;
576 Expanded.BraceWrapping.AfterFunction = true;
577 Expanded.BraceWrapping.AfterNamespace = true;
578 Expanded.BraceWrapping.AfterObjCDeclaration = true;
579 Expanded.BraceWrapping.AfterStruct = true;
Krasimir Georgievd6ce9372017-09-15 11:23:50 +0000580 Expanded.BraceWrapping.AfterExternBlock = true;
Daniel Jasperc1bc38e2015-09-29 14:57:55 +0000581 Expanded.BraceWrapping.BeforeCatch = true;
582 Expanded.BraceWrapping.BeforeElse = true;
583 break;
584 case FormatStyle::BS_GNU:
Manuel Klimek89628f62017-09-20 09:51:03 +0000585 Expanded.BraceWrapping = {true, true, true, true, true, true, true, true,
586 true, true, true, true, true, true, true};
Daniel Jasperc1bc38e2015-09-29 14:57:55 +0000587 break;
588 case FormatStyle::BS_WebKit:
589 Expanded.BraceWrapping.AfterFunction = true;
590 break;
591 default:
592 break;
593 }
594 return Expanded;
595}
596
Daniel Jasperf7935112012-12-03 18:12:45 +0000597FormatStyle getLLVMStyle() {
598 FormatStyle LLVMStyle;
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000599 LLVMStyle.Language = FormatStyle::LK_Cpp;
Daniel Jasperf7935112012-12-03 18:12:45 +0000600 LLVMStyle.AccessModifierOffset = -2;
Daniel Jasper7fdbb3f2017-05-08 15:08:00 +0000601 LLVMStyle.AlignEscapedNewlines = FormatStyle::ENAS_Right;
Daniel Jasper6501f7e2015-10-27 12:38:37 +0000602 LLVMStyle.AlignAfterOpenBracket = FormatStyle::BAS_Align;
Daniel Jasper3219e432014-12-02 13:24:51 +0000603 LLVMStyle.AlignOperands = true;
Daniel Jasper552f4a72013-07-31 23:55:15 +0000604 LLVMStyle.AlignTrailingComments = true;
Daniel Jaspera44991332015-04-29 13:06:49 +0000605 LLVMStyle.AlignConsecutiveAssignments = false;
Daniel Jaspere12597c2015-10-01 10:06:54 +0000606 LLVMStyle.AlignConsecutiveDeclarations = false;
Daniel Jasperf7db4332013-01-29 16:03:49 +0000607 LLVMStyle.AllowAllParametersOfDeclarationOnNextLine = true;
Daniel Jasperd74cf402014-04-08 12:46:38 +0000608 LLVMStyle.AllowShortFunctionsOnASingleLine = FormatStyle::SFS_All;
Daniel Jasper17605d32014-05-14 09:33:35 +0000609 LLVMStyle.AllowShortBlocksOnASingleLine = false;
Daniel Jasperb87899b2014-09-10 13:11:45 +0000610 LLVMStyle.AllowShortCaseLabelsOnASingleLine = false;
Daniel Jasper1b750ed2013-01-14 16:24:39 +0000611 LLVMStyle.AllowShortIfStatementsOnASingleLine = false;
Daniel Jasper3a685df2013-05-16 12:12:21 +0000612 LLVMStyle.AllowShortLoopsOnASingleLine = false;
Zachary Turner448592e2015-12-18 22:20:15 +0000613 LLVMStyle.AlwaysBreakAfterReturnType = FormatStyle::RTBS_None;
Birunthan Mohanathasa0388a82015-06-29 15:30:42 +0000614 LLVMStyle.AlwaysBreakAfterDefinitionReturnType = FormatStyle::DRTBS_None;
Alexander Kornienko58611712013-07-04 12:02:44 +0000615 LLVMStyle.AlwaysBreakBeforeMultilineStrings = false;
Francois Ferrand58e6fe52018-05-16 08:25:03 +0000616 LLVMStyle.AlwaysBreakTemplateDeclarations = FormatStyle::BTDS_MultiLine;
Daniel Jasper18210d72014-10-09 09:52:05 +0000617 LLVMStyle.BinPackArguments = true;
Francois Ferrande56a8292017-06-14 12:29:47 +0000618 LLVMStyle.BinPackParameters = true;
Daniel Jasperac043c92014-09-15 11:11:00 +0000619 LLVMStyle.BreakBeforeBinaryOperators = FormatStyle::BOS_None;
Daniel Jasper165b29e2013-11-08 00:57:11 +0000620 LLVMStyle.BreakBeforeTernaryOperators = true;
Daniel Jaspere33d4af2013-07-26 16:56:36 +0000621 LLVMStyle.BreakBeforeBraces = FormatStyle::BS_Attach;
Manuel Klimek89628f62017-09-20 09:51:03 +0000622 LLVMStyle.BraceWrapping = {false, false, false, false, false,
623 false, false, false, false, false,
624 false, false, true, true, true};
Nico Weber2cd92f12015-10-15 16:03:01 +0000625 LLVMStyle.BreakAfterJavaFieldAnnotations = false;
Francois Ferranda6b6d512017-05-24 11:36:58 +0000626 LLVMStyle.BreakConstructorInitializers = FormatStyle::BCIS_BeforeColon;
Andi-Bogdan Postelnicu0ef8ee12017-03-10 15:10:37 +0000627 LLVMStyle.BreakBeforeInheritanceComma = false;
Daniel Jaspere1a7b762016-02-01 11:21:02 +0000628 LLVMStyle.BreakStringLiterals = true;
Alexander Kornienkoc8602662013-05-06 14:11:27 +0000629 LLVMStyle.ColumnLimit = 80;
Daniel Jaspere1e43192014-04-01 12:55:11 +0000630 LLVMStyle.CommentPragmas = "^ IWYU pragma:";
Francois Ferrande56a8292017-06-14 12:29:47 +0000631 LLVMStyle.CompactNamespaces = false;
Alexander Kornienkoc8602662013-05-06 14:11:27 +0000632 LLVMStyle.ConstructorInitializerAllOnOneLineOrOnePerLine = false;
Daniel Jaspercdaffa42013-08-13 10:58:30 +0000633 LLVMStyle.ConstructorInitializerIndentWidth = 4;
Daniel Jaspere1e43192014-04-01 12:55:11 +0000634 LLVMStyle.ContinuationIndentWidth = 4;
Chandler Carruthf8b72662014-03-02 12:37:31 +0000635 LLVMStyle.Cpp11BracedListStyle = true;
Daniel Jasper553d4872014-06-17 12:40:34 +0000636 LLVMStyle.DerivePointerAlignment = false;
Daniel Jasperb10cbc42013-07-10 14:02:49 +0000637 LLVMStyle.ExperimentalAutoDetectBinPacking = false;
Krasimir Georgiev32eaa862017-03-01 15:35:39 +0000638 LLVMStyle.FixNamespaceComments = true;
Daniel Jaspere1e43192014-04-01 12:55:11 +0000639 LLVMStyle.ForEachMacros.push_back("foreach");
640 LLVMStyle.ForEachMacros.push_back("Q_FOREACH");
641 LLVMStyle.ForEachMacros.push_back("BOOST_FOREACH");
Eric Liu9d92c022018-05-14 19:51:33 +0000642 LLVMStyle.IncludeStyle.IncludeCategories = {
643 {"^\"(llvm|llvm-c|clang|clang-c)/", 2},
644 {"^(<|\"(gtest|gmock|isl|json)/)", 3},
645 {".*", 1}};
646 LLVMStyle.IncludeStyle.IncludeIsMainRegex = "(Test)?$";
647 LLVMStyle.IncludeStyle.IncludeBlocks = tooling::IncludeStyle::IBS_Preserve;
Alexander Kornienkoc8602662013-05-06 14:11:27 +0000648 LLVMStyle.IndentCaseLabels = false;
Krasimir Georgievad47c902017-08-30 14:34:57 +0000649 LLVMStyle.IndentPPDirectives = FormatStyle::PPDIS_None;
Daniel Jasperc75e1ef2014-07-09 08:42:42 +0000650 LLVMStyle.IndentWrappedFunctionNames = false;
Daniel Jaspere33d4af2013-07-26 16:56:36 +0000651 LLVMStyle.IndentWidth = 2;
Martin Probstfb2342d2016-06-13 17:50:10 +0000652 LLVMStyle.JavaScriptQuotes = FormatStyle::JSQS_Leave;
653 LLVMStyle.JavaScriptWrapImports = true;
Alexander Kornienkoebb43ca2013-09-05 14:08:34 +0000654 LLVMStyle.TabWidth = 8;
Alexander Kornienkoc8602662013-05-06 14:11:27 +0000655 LLVMStyle.MaxEmptyLinesToKeep = 1;
Daniel Jaspera26fc5c2014-03-21 13:43:14 +0000656 LLVMStyle.KeepEmptyLinesAtTheStartOfBlocks = true;
Daniel Jasper65ee3472013-07-31 23:16:02 +0000657 LLVMStyle.NamespaceIndentation = FormatStyle::NI_None;
Ben Hamilton4dc658c2018-02-02 20:15:14 +0000658 LLVMStyle.ObjCBinPackProtocolList = FormatStyle::BPS_Auto;
Daniel Jasper50d634b2014-10-28 16:53:38 +0000659 LLVMStyle.ObjCBlockIndentWidth = 2;
Daniel Jaspere9beea22014-01-28 15:20:33 +0000660 LLVMStyle.ObjCSpaceAfterProperty = false;
Nico Webera6087752013-01-10 20:12:55 +0000661 LLVMStyle.ObjCSpaceBeforeProtocolList = true;
Daniel Jasper553d4872014-06-17 12:40:34 +0000662 LLVMStyle.PointerAlignment = FormatStyle::PAS_Right;
Alexander Kornienkoc8602662013-05-06 14:11:27 +0000663 LLVMStyle.SpacesBeforeTrailingComments = 1;
Chandler Carruthf8b72662014-03-02 12:37:31 +0000664 LLVMStyle.Standard = FormatStyle::LS_Cpp11;
Alexander Kornienko3c3d09c2013-09-27 16:14:22 +0000665 LLVMStyle.UseTab = FormatStyle::UT_Never;
Daniel Jaspera0a50392015-12-01 13:28:53 +0000666 LLVMStyle.ReflowComments = true;
Daniel Jasperb55acad2013-08-20 12:36:34 +0000667 LLVMStyle.SpacesInParentheses = false;
Daniel Jasperad981f82014-08-26 11:41:14 +0000668 LLVMStyle.SpacesInSquareBrackets = false;
Daniel Jasperb55acad2013-08-20 12:36:34 +0000669 LLVMStyle.SpaceInEmptyParentheses = false;
Daniel Jasperb2e10a52014-01-15 15:09:08 +0000670 LLVMStyle.SpacesInContainerLiterals = true;
Daniel Jasperb55acad2013-08-20 12:36:34 +0000671 LLVMStyle.SpacesInCStyleCastParentheses = false;
Daniel Jasperdb986eb2014-09-03 07:37:29 +0000672 LLVMStyle.SpaceAfterCStyleCast = false;
Sylvestre Ledru83bbd572016-08-09 14:24:40 +0000673 LLVMStyle.SpaceAfterTemplateKeyword = true;
Francois Ferrand2a9ea782018-03-01 10:09:13 +0000674 LLVMStyle.SpaceBeforeCtorInitializerColon = true;
675 LLVMStyle.SpaceBeforeInheritanceColon = true;
Alexander Kornienkofdca83d2013-12-10 10:18:34 +0000676 LLVMStyle.SpaceBeforeParens = FormatStyle::SBPO_ControlStatements;
Francois Ferrand2a9ea782018-03-01 10:09:13 +0000677 LLVMStyle.SpaceBeforeRangeBasedForLoopColon = true;
Daniel Jasperd94bff32013-09-25 15:15:02 +0000678 LLVMStyle.SpaceBeforeAssignmentOperators = true;
Daniel Jasperdd978ae2013-10-29 14:52:02 +0000679 LLVMStyle.SpacesInAngles = false;
Daniel Jasper4e9678f2013-07-11 20:41:21 +0000680
Francois Ferrand9976efa2017-05-22 08:28:17 +0000681 LLVMStyle.PenaltyBreakAssignment = prec::Assignment;
Daniel Jasper19a541e2013-12-19 16:45:34 +0000682 LLVMStyle.PenaltyBreakComment = 300;
Alexander Kornienkofe7a57f2013-12-10 15:42:15 +0000683 LLVMStyle.PenaltyBreakFirstLessLess = 120;
684 LLVMStyle.PenaltyBreakString = 1000;
685 LLVMStyle.PenaltyExcessCharacter = 1000000;
Daniel Jasper4e9678f2013-07-11 20:41:21 +0000686 LLVMStyle.PenaltyReturnTypeOnItsOwnLine = 60;
Daniel Jasper33b909c2013-10-25 14:29:37 +0000687 LLVMStyle.PenaltyBreakBeforeFirstCallParameter = 19;
Francois Ferrand58e6fe52018-05-16 08:25:03 +0000688 LLVMStyle.PenaltyBreakTemplateDeclaration = prec::Relational;
Daniel Jasper4e9678f2013-07-11 20:41:21 +0000689
Daniel Jasperc64b09a2014-05-22 15:12:22 +0000690 LLVMStyle.DisableFormat = false;
Daniel Jasperda446772015-11-16 12:38:56 +0000691 LLVMStyle.SortIncludes = true;
Krasimir Georgievac16a202017-06-23 11:46:03 +0000692 LLVMStyle.SortUsingDeclarations = true;
Daniel Jasperc64b09a2014-05-22 15:12:22 +0000693
Daniel Jasperf7935112012-12-03 18:12:45 +0000694 return LLVMStyle;
695}
696
Nico Weber514ecc82014-02-02 20:50:45 +0000697FormatStyle getGoogleStyle(FormatStyle::LanguageKind Language) {
Krasimir Georgiev26b144c2017-07-03 15:05:14 +0000698 if (Language == FormatStyle::LK_TextProto) {
699 FormatStyle GoogleStyle = getGoogleStyle(FormatStyle::LK_Proto);
700 GoogleStyle.Language = FormatStyle::LK_TextProto;
Krasimir Georgieveda222e2018-01-24 11:18:39 +0000701
Krasimir Georgiev26b144c2017-07-03 15:05:14 +0000702 return GoogleStyle;
703 }
704
Alexander Kornienkofe7a57f2013-12-10 15:42:15 +0000705 FormatStyle GoogleStyle = getLLVMStyle();
Nico Weber514ecc82014-02-02 20:50:45 +0000706 GoogleStyle.Language = Language;
707
Daniel Jasperf7935112012-12-03 18:12:45 +0000708 GoogleStyle.AccessModifierOffset = -1;
Daniel Jasper7fdbb3f2017-05-08 15:08:00 +0000709 GoogleStyle.AlignEscapedNewlines = FormatStyle::ENAS_Left;
Daniel Jasper085a2ed2013-04-24 13:46:00 +0000710 GoogleStyle.AllowShortIfStatementsOnASingleLine = true;
Daniel Jasper5bd0b9e2013-05-23 18:05:18 +0000711 GoogleStyle.AllowShortLoopsOnASingleLine = true;
Alexander Kornienko58611712013-07-04 12:02:44 +0000712 GoogleStyle.AlwaysBreakBeforeMultilineStrings = true;
Francois Ferrand58e6fe52018-05-16 08:25:03 +0000713 GoogleStyle.AlwaysBreakTemplateDeclarations = FormatStyle::BTDS_Yes;
Alexander Kornienkoc8602662013-05-06 14:11:27 +0000714 GoogleStyle.ConstructorInitializerAllOnOneLineOrOnePerLine = true;
Daniel Jasper553d4872014-06-17 12:40:34 +0000715 GoogleStyle.DerivePointerAlignment = true;
Eric Liu9d92c022018-05-14 19:51:33 +0000716 GoogleStyle.IncludeStyle.IncludeCategories = {
Krasimir Georgieva84e7872017-09-26 14:58:29 +0000717 {"^<ext/.*\\.h>", 2}, {"^<.*\\.h>", 1}, {"^<.*", 2}, {".*", 3}};
Eric Liu9d92c022018-05-14 19:51:33 +0000718 GoogleStyle.IncludeStyle.IncludeIsMainRegex = "([-_](test|unittest))?$";
Alexander Kornienkoc8602662013-05-06 14:11:27 +0000719 GoogleStyle.IndentCaseLabels = true;
Daniel Jaspera26fc5c2014-03-21 13:43:14 +0000720 GoogleStyle.KeepEmptyLinesAtTheStartOfBlocks = false;
Ben Hamilton3a47fdd2018-02-08 01:49:10 +0000721 GoogleStyle.ObjCBinPackProtocolList = FormatStyle::BPS_Never;
Daniel Jaspere9beea22014-01-28 15:20:33 +0000722 GoogleStyle.ObjCSpaceAfterProperty = false;
Ben Hamiltonf84f1182018-01-18 18:37:16 +0000723 GoogleStyle.ObjCSpaceBeforeProtocolList = true;
Daniel Jasper553d4872014-06-17 12:40:34 +0000724 GoogleStyle.PointerAlignment = FormatStyle::PAS_Left;
Krasimir Georgiev5559cc32018-04-25 14:56:19 +0000725 GoogleStyle.RawStringFormats = {
Krasimir Georgiev4527f132018-01-17 12:24:59 +0000726 {
Krasimir Georgiev5559cc32018-04-25 14:56:19 +0000727 FormatStyle::LK_Cpp,
728 /*Delimiters=*/
729 {
730 "cc",
731 "CC",
732 "cpp",
733 "Cpp",
734 "CPP",
735 "c++",
736 "C++",
737 },
738 /*EnclosingFunctionNames=*/
739 {},
740 /*CanonicalDelimiter=*/"",
741 /*BasedOnStyle=*/"google",
Krasimir Georgiev4527f132018-01-17 12:24:59 +0000742 },
Krasimir Georgiev5559cc32018-04-25 14:56:19 +0000743 {
744 FormatStyle::LK_TextProto,
745 /*Delimiters=*/
746 {
747 "pb",
748 "PB",
749 "proto",
750 "PROTO",
751 },
752 /*EnclosingFunctionNames=*/
753 {},
754 /*CanonicalDelimiter=*/"",
755 /*BasedOnStyle=*/"google",
756 },
757 };
Alexander Kornienkoc8602662013-05-06 14:11:27 +0000758 GoogleStyle.SpacesBeforeTrailingComments = 2;
759 GoogleStyle.Standard = FormatStyle::LS_Auto;
Daniel Jasper4e9678f2013-07-11 20:41:21 +0000760
Daniel Jasper4e9678f2013-07-11 20:41:21 +0000761 GoogleStyle.PenaltyReturnTypeOnItsOwnLine = 200;
Daniel Jasper33b909c2013-10-25 14:29:37 +0000762 GoogleStyle.PenaltyBreakBeforeFirstCallParameter = 1;
Daniel Jasper4e9678f2013-07-11 20:41:21 +0000763
Daniel Jasperc58c70e2014-09-15 11:21:46 +0000764 if (Language == FormatStyle::LK_Java) {
Daniel Jasper6501f7e2015-10-27 12:38:37 +0000765 GoogleStyle.AlignAfterOpenBracket = FormatStyle::BAS_DontAlign;
Daniel Jasper3219e432014-12-02 13:24:51 +0000766 GoogleStyle.AlignOperands = false;
Daniel Jasperfd4ed182015-01-04 20:40:45 +0000767 GoogleStyle.AlignTrailingComments = false;
Daniel Jasper9e709352014-11-26 10:43:58 +0000768 GoogleStyle.AllowShortFunctionsOnASingleLine = FormatStyle::SFS_Empty;
Daniel Jasperfd4ed182015-01-04 20:40:45 +0000769 GoogleStyle.AllowShortIfStatementsOnASingleLine = false;
Daniel Jasper1cd3c712015-01-14 12:24:59 +0000770 GoogleStyle.AlwaysBreakBeforeMultilineStrings = false;
Daniel Jasperc58c70e2014-09-15 11:21:46 +0000771 GoogleStyle.BreakBeforeBinaryOperators = FormatStyle::BOS_NonAssignment;
772 GoogleStyle.ColumnLimit = 100;
773 GoogleStyle.SpaceAfterCStyleCast = true;
Daniel Jasper61d81972014-11-14 08:22:46 +0000774 GoogleStyle.SpacesBeforeTrailingComments = 1;
Daniel Jasperc58c70e2014-09-15 11:21:46 +0000775 } else if (Language == FormatStyle::LK_JavaScript) {
Daniel Jasper6501f7e2015-10-27 12:38:37 +0000776 GoogleStyle.AlignAfterOpenBracket = FormatStyle::BAS_AlwaysBreak;
Daniel Jasper41a2bf72015-12-21 13:52:19 +0000777 GoogleStyle.AlignOperands = false;
Daniel Jasper28d8a5a2016-09-07 23:01:13 +0000778 GoogleStyle.AllowShortFunctionsOnASingleLine = FormatStyle::SFS_Empty;
Daniel Jasper6501f7e2015-10-27 12:38:37 +0000779 GoogleStyle.AlwaysBreakBeforeMultilineStrings = false;
Daniel Jaspere551bb72014-11-05 17:22:31 +0000780 GoogleStyle.BreakBeforeTernaryOperators = false;
Martin Probst2083f312017-05-09 12:45:48 +0000781 // taze:, triple slash directives (`/// <...`), @tag followed by { for a lot
782 // of JSDoc tags, and @see, which is commonly followed by overlong URLs.
783 GoogleStyle.CommentPragmas =
784 "(taze:|^/[ \t]*<|(@[A-Za-z_0-9-]+[ \\t]*{)|@see)";
Daniel Jasper8f83a902014-05-09 10:28:58 +0000785 GoogleStyle.MaxEmptyLinesToKeep = 3;
Martin Probstece8c0c2016-06-13 16:41:28 +0000786 GoogleStyle.NamespaceIndentation = FormatStyle::NI_All;
Nico Weber514ecc82014-02-02 20:50:45 +0000787 GoogleStyle.SpacesInContainerLiterals = false;
Daniel Jasperabd1f572016-03-02 22:44:03 +0000788 GoogleStyle.JavaScriptQuotes = FormatStyle::JSQS_Single;
Martin Probst0cd74ee2016-06-13 16:39:50 +0000789 GoogleStyle.JavaScriptWrapImports = false;
Nico Weber514ecc82014-02-02 20:50:45 +0000790 } else if (Language == FormatStyle::LK_Proto) {
Daniel Jasperd74cf402014-04-08 12:46:38 +0000791 GoogleStyle.AllowShortFunctionsOnASingleLine = FormatStyle::SFS_None;
Daniel Jasper9c95dfe2018-03-12 10:32:18 +0000792 GoogleStyle.AlwaysBreakBeforeMultilineStrings = false;
Daniel Jasper783bac62014-04-15 09:54:30 +0000793 GoogleStyle.SpacesInContainerLiterals = false;
Krasimir Georgievc2091802018-01-31 10:14:10 +0000794 GoogleStyle.Cpp11BracedListStyle = false;
Krasimir Georgiev374e6de2018-02-08 10:47:12 +0000795 // This affects protocol buffer options specifications and text protos.
796 // Text protos are currently mostly formatted inside C++ raw string literals
797 // and often the current breaking behavior of string literals is not
798 // beneficial there. Investigate turning this on once proper string reflow
799 // has been implemented.
800 GoogleStyle.BreakStringLiterals = false;
Daniel Jasper03a04fe2016-12-12 12:42:29 +0000801 } else if (Language == FormatStyle::LK_ObjC) {
802 GoogleStyle.ColumnLimit = 100;
Nico Weber514ecc82014-02-02 20:50:45 +0000803 }
804
Daniel Jasperf7935112012-12-03 18:12:45 +0000805 return GoogleStyle;
806}
807
Nico Weber514ecc82014-02-02 20:50:45 +0000808FormatStyle getChromiumStyle(FormatStyle::LanguageKind Language) {
809 FormatStyle ChromiumStyle = getGoogleStyle(Language);
Nico Weber450425c2014-11-26 16:43:18 +0000810 if (Language == FormatStyle::LK_Java) {
Daniel Jasperfd4ed182015-01-04 20:40:45 +0000811 ChromiumStyle.AllowShortIfStatementsOnASingleLine = true;
Nico Weber2cd92f12015-10-15 16:03:01 +0000812 ChromiumStyle.BreakAfterJavaFieldAnnotations = true;
Nico Weber450425c2014-11-26 16:43:18 +0000813 ChromiumStyle.ContinuationIndentWidth = 8;
Nico Weber2cd92f12015-10-15 16:03:01 +0000814 ChromiumStyle.IndentWidth = 4;
Nico Weberea649692017-01-04 02:33:36 +0000815 } else if (Language == FormatStyle::LK_JavaScript) {
816 ChromiumStyle.AllowShortIfStatementsOnASingleLine = false;
817 ChromiumStyle.AllowShortLoopsOnASingleLine = false;
Nico Weber450425c2014-11-26 16:43:18 +0000818 } else {
819 ChromiumStyle.AllowAllParametersOfDeclarationOnNextLine = false;
820 ChromiumStyle.AllowShortFunctionsOnASingleLine = FormatStyle::SFS_Inline;
821 ChromiumStyle.AllowShortIfStatementsOnASingleLine = false;
822 ChromiumStyle.AllowShortLoopsOnASingleLine = false;
823 ChromiumStyle.BinPackParameters = false;
824 ChromiumStyle.DerivePointerAlignment = false;
Nico Weber9e2bc302017-01-31 18:42:05 +0000825 if (Language == FormatStyle::LK_ObjC)
826 ChromiumStyle.ColumnLimit = 80;
Nico Weber450425c2014-11-26 16:43:18 +0000827 }
Daniel Jasper1b750ed2013-01-14 16:24:39 +0000828 return ChromiumStyle;
829}
830
Alexander Kornienkoc8602662013-05-06 14:11:27 +0000831FormatStyle getMozillaStyle() {
832 FormatStyle MozillaStyle = getLLVMStyle();
833 MozillaStyle.AllowAllParametersOfDeclarationOnNextLine = false;
Birunthan Mohanathasa0810022015-06-29 15:18:58 +0000834 MozillaStyle.AllowShortFunctionsOnASingleLine = FormatStyle::SFS_Inline;
Manuel Klimek89628f62017-09-20 09:51:03 +0000835 MozillaStyle.AlwaysBreakAfterReturnType = FormatStyle::RTBS_TopLevel;
Birunthan Mohanathasa0388a82015-06-29 15:30:42 +0000836 MozillaStyle.AlwaysBreakAfterDefinitionReturnType =
837 FormatStyle::DRTBS_TopLevel;
Francois Ferrand58e6fe52018-05-16 08:25:03 +0000838 MozillaStyle.AlwaysBreakTemplateDeclarations = FormatStyle::BTDS_Yes;
Sylvestre Ledrudcb038d2016-12-14 16:09:29 +0000839 MozillaStyle.BinPackParameters = false;
840 MozillaStyle.BinPackArguments = false;
Birunthan Mohanathas305fa9c2015-07-12 03:13:54 +0000841 MozillaStyle.BreakBeforeBraces = FormatStyle::BS_Mozilla;
Francois Ferranda6b6d512017-05-24 11:36:58 +0000842 MozillaStyle.BreakConstructorInitializers = FormatStyle::BCIS_BeforeComma;
Andi-Bogdan Postelnicu0ef8ee12017-03-10 15:10:37 +0000843 MozillaStyle.BreakBeforeInheritanceComma = true;
Birunthan Mohanathasa0810022015-06-29 15:18:58 +0000844 MozillaStyle.ConstructorInitializerIndentWidth = 2;
845 MozillaStyle.ContinuationIndentWidth = 2;
Chandler Carruthf8b72662014-03-02 12:37:31 +0000846 MozillaStyle.Cpp11BracedListStyle = false;
Krasimir Georgiev32eaa862017-03-01 15:35:39 +0000847 MozillaStyle.FixNamespaceComments = false;
Alexander Kornienkoc8602662013-05-06 14:11:27 +0000848 MozillaStyle.IndentCaseLabels = true;
Daniel Jaspere9beea22014-01-28 15:20:33 +0000849 MozillaStyle.ObjCSpaceAfterProperty = true;
Alexander Kornienkoc8602662013-05-06 14:11:27 +0000850 MozillaStyle.ObjCSpaceBeforeProtocolList = false;
851 MozillaStyle.PenaltyReturnTypeOnItsOwnLine = 200;
Daniel Jasper553d4872014-06-17 12:40:34 +0000852 MozillaStyle.PointerAlignment = FormatStyle::PAS_Left;
Sylvestre Ledru83bbd572016-08-09 14:24:40 +0000853 MozillaStyle.SpaceAfterTemplateKeyword = false;
Alexander Kornienkoc8602662013-05-06 14:11:27 +0000854 return MozillaStyle;
855}
856
Daniel Jasperffefb3d2013-07-24 13:10:59 +0000857FormatStyle getWebKitStyle() {
858 FormatStyle Style = getLLVMStyle();
Daniel Jasper65ee3472013-07-31 23:16:02 +0000859 Style.AccessModifierOffset = -4;
Daniel Jasper6501f7e2015-10-27 12:38:37 +0000860 Style.AlignAfterOpenBracket = FormatStyle::BAS_DontAlign;
Daniel Jasper3219e432014-12-02 13:24:51 +0000861 Style.AlignOperands = false;
Daniel Jasper552f4a72013-07-31 23:55:15 +0000862 Style.AlignTrailingComments = false;
Daniel Jasperac043c92014-09-15 11:11:00 +0000863 Style.BreakBeforeBinaryOperators = FormatStyle::BOS_All;
Roman Kashitsyn291f64f2015-08-10 13:43:19 +0000864 Style.BreakBeforeBraces = FormatStyle::BS_WebKit;
Francois Ferranda6b6d512017-05-24 11:36:58 +0000865 Style.BreakConstructorInitializers = FormatStyle::BCIS_BeforeComma;
Chandler Carruthf8b72662014-03-02 12:37:31 +0000866 Style.Cpp11BracedListStyle = false;
Daniel Jasper65ee3472013-07-31 23:16:02 +0000867 Style.ColumnLimit = 0;
Krasimir Georgiev32eaa862017-03-01 15:35:39 +0000868 Style.FixNamespaceComments = false;
Daniel Jaspere33d4af2013-07-26 16:56:36 +0000869 Style.IndentWidth = 4;
Daniel Jasper65ee3472013-07-31 23:16:02 +0000870 Style.NamespaceIndentation = FormatStyle::NI_Inner;
Daniel Jasper50d634b2014-10-28 16:53:38 +0000871 Style.ObjCBlockIndentWidth = 4;
Daniel Jaspere9beea22014-01-28 15:20:33 +0000872 Style.ObjCSpaceAfterProperty = true;
Daniel Jasper553d4872014-06-17 12:40:34 +0000873 Style.PointerAlignment = FormatStyle::PAS_Left;
Daniel Jasperffefb3d2013-07-24 13:10:59 +0000874 return Style;
875}
876
Alexander Kornienkofe7a57f2013-12-10 15:42:15 +0000877FormatStyle getGNUStyle() {
878 FormatStyle Style = getLLVMStyle();
Birunthan Mohanathasa0388a82015-06-29 15:30:42 +0000879 Style.AlwaysBreakAfterDefinitionReturnType = FormatStyle::DRTBS_All;
Zachary Turner448592e2015-12-18 22:20:15 +0000880 Style.AlwaysBreakAfterReturnType = FormatStyle::RTBS_AllDefinitions;
Daniel Jasperac043c92014-09-15 11:11:00 +0000881 Style.BreakBeforeBinaryOperators = FormatStyle::BOS_All;
Alexander Kornienko3a33f022013-12-12 09:49:52 +0000882 Style.BreakBeforeBraces = FormatStyle::BS_GNU;
Alexander Kornienkofe7a57f2013-12-10 15:42:15 +0000883 Style.BreakBeforeTernaryOperators = true;
Chandler Carruthf8b72662014-03-02 12:37:31 +0000884 Style.Cpp11BracedListStyle = false;
Alexander Kornienkofe7a57f2013-12-10 15:42:15 +0000885 Style.ColumnLimit = 79;
Krasimir Georgiev32eaa862017-03-01 15:35:39 +0000886 Style.FixNamespaceComments = false;
Alexander Kornienkofe7a57f2013-12-10 15:42:15 +0000887 Style.SpaceBeforeParens = FormatStyle::SBPO_Always;
Chandler Carruthf8b72662014-03-02 12:37:31 +0000888 Style.Standard = FormatStyle::LS_Cpp03;
Alexander Kornienkofe7a57f2013-12-10 15:42:15 +0000889 return Style;
890}
891
Daniel Jasperc64b09a2014-05-22 15:12:22 +0000892FormatStyle getNoStyle() {
893 FormatStyle NoStyle = getLLVMStyle();
894 NoStyle.DisableFormat = true;
Daniel Jasperda446772015-11-16 12:38:56 +0000895 NoStyle.SortIncludes = false;
Krasimir Georgievac16a202017-06-23 11:46:03 +0000896 NoStyle.SortUsingDeclarations = false;
Daniel Jasperc64b09a2014-05-22 15:12:22 +0000897 return NoStyle;
898}
899
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000900bool getPredefinedStyle(StringRef Name, FormatStyle::LanguageKind Language,
901 FormatStyle *Style) {
902 if (Name.equals_lower("llvm")) {
Alexander Kornienko006b5c82013-05-19 00:53:30 +0000903 *Style = getLLVMStyle();
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000904 } else if (Name.equals_lower("chromium")) {
Nico Weber514ecc82014-02-02 20:50:45 +0000905 *Style = getChromiumStyle(Language);
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000906 } else if (Name.equals_lower("mozilla")) {
Alexander Kornienko006b5c82013-05-19 00:53:30 +0000907 *Style = getMozillaStyle();
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000908 } else if (Name.equals_lower("google")) {
Nico Weber514ecc82014-02-02 20:50:45 +0000909 *Style = getGoogleStyle(Language);
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000910 } else if (Name.equals_lower("webkit")) {
Daniel Jasperffefb3d2013-07-24 13:10:59 +0000911 *Style = getWebKitStyle();
Alexander Kornienkofe7a57f2013-12-10 15:42:15 +0000912 } else if (Name.equals_lower("gnu")) {
913 *Style = getGNUStyle();
Daniel Jasperc64b09a2014-05-22 15:12:22 +0000914 } else if (Name.equals_lower("none")) {
915 *Style = getNoStyle();
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000916 } else {
Alexander Kornienko006b5c82013-05-19 00:53:30 +0000917 return false;
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000918 }
Alexander Kornienkod6538332013-05-07 15:32:14 +0000919
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000920 Style->Language = Language;
Alexander Kornienko006b5c82013-05-19 00:53:30 +0000921 return true;
Alexander Kornienkod6538332013-05-07 15:32:14 +0000922}
923
Rafael Espindolac0809172014-06-12 14:02:15 +0000924std::error_code parseConfiguration(StringRef Text, FormatStyle *Style) {
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000925 assert(Style);
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000926 FormatStyle::LanguageKind Language = Style->Language;
927 assert(Language != FormatStyle::LK_None);
Alexander Kornienko06e00332013-05-20 15:18:01 +0000928 if (Text.trim().empty())
Rafael Espindolad0136702014-06-12 02:50:04 +0000929 return make_error_code(ParseError::Error);
Krasimir Georgiev54076fe2018-01-15 12:06:16 +0000930 Style->StyleSet.Clear();
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000931 std::vector<FormatStyle> Styles;
Alexander Kornienkod6538332013-05-07 15:32:14 +0000932 llvm::yaml::Input Input(Text);
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000933 // DocumentListTraits<vector<FormatStyle>> uses the context to get default
934 // values for the fields, keys for which are missing from the configuration.
935 // Mapping also uses the context to get the language to find the correct
936 // base style.
937 Input.setContext(Style);
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000938 Input >> Styles;
939 if (Input.error())
940 return Input.error();
941
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000942 for (unsigned i = 0; i < Styles.size(); ++i) {
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000943 // Ensures that only the first configuration can skip the Language option.
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000944 if (Styles[i].Language == FormatStyle::LK_None && i != 0)
Rafael Espindolad0136702014-06-12 02:50:04 +0000945 return make_error_code(ParseError::Error);
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000946 // Ensure that each language is configured at most once.
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000947 for (unsigned j = 0; j < i; ++j) {
948 if (Styles[i].Language == Styles[j].Language) {
Nicola Zaghen3538b392018-05-15 13:30:56 +0000949 LLVM_DEBUG(llvm::dbgs()
950 << "Duplicate languages in the config file on positions "
951 << j << " and " << i << "\n");
Rafael Espindolad0136702014-06-12 02:50:04 +0000952 return make_error_code(ParseError::Error);
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000953 }
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000954 }
955 }
956 // Look for a suitable configuration starting from the end, so we can
957 // find the configuration for the specific language first, and the default
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000958 // configuration (which can only be at slot 0) after it.
Krasimir Georgiev54076fe2018-01-15 12:06:16 +0000959 FormatStyle::FormatStyleSet StyleSet;
960 bool LanguageFound = false;
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000961 for (int i = Styles.size() - 1; i >= 0; --i) {
Krasimir Georgiev54076fe2018-01-15 12:06:16 +0000962 if (Styles[i].Language != FormatStyle::LK_None)
963 StyleSet.Add(Styles[i]);
964 if (Styles[i].Language == Language)
965 LanguageFound = true;
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000966 }
Krasimir Georgiev54076fe2018-01-15 12:06:16 +0000967 if (!LanguageFound) {
968 if (Styles.empty() || Styles[0].Language != FormatStyle::LK_None)
969 return make_error_code(ParseError::Unsuitable);
970 FormatStyle DefaultStyle = Styles[0];
971 DefaultStyle.Language = Language;
972 StyleSet.Add(std::move(DefaultStyle));
973 }
974 *Style = *StyleSet.Get(Language);
975 return make_error_code(ParseError::Success);
Alexander Kornienkod6538332013-05-07 15:32:14 +0000976}
977
978std::string configurationAsText(const FormatStyle &Style) {
979 std::string Text;
980 llvm::raw_string_ostream Stream(Text);
981 llvm::yaml::Output Output(Stream);
982 // We use the same mapping method for input and output, so we need a non-const
983 // reference here.
Daniel Jasperc1bc38e2015-09-29 14:57:55 +0000984 FormatStyle NonConstStyle = expandPresets(Style);
Alexander Kornienkod6538332013-05-07 15:32:14 +0000985 Output << NonConstStyle;
Alexander Kornienko9a38ec22013-05-13 12:56:35 +0000986 return Stream.str();
Alexander Kornienkod6538332013-05-07 15:32:14 +0000987}
988
Krasimir Georgiev54076fe2018-01-15 12:06:16 +0000989llvm::Optional<FormatStyle>
990FormatStyle::FormatStyleSet::Get(FormatStyle::LanguageKind Language) const {
991 if (!Styles)
992 return None;
993 auto It = Styles->find(Language);
994 if (It == Styles->end())
995 return None;
996 FormatStyle Style = It->second;
997 Style.StyleSet = *this;
998 return Style;
999}
1000
1001void FormatStyle::FormatStyleSet::Add(FormatStyle Style) {
1002 assert(Style.Language != LK_None &&
1003 "Cannot add a style for LK_None to a StyleSet");
1004 assert(
1005 !Style.StyleSet.Styles &&
1006 "Cannot add a style associated with an existing StyleSet to a StyleSet");
1007 if (!Styles)
1008 Styles = std::make_shared<MapType>();
1009 (*Styles)[Style.Language] = std::move(Style);
1010}
1011
1012void FormatStyle::FormatStyleSet::Clear() {
1013 Styles.reset();
1014}
1015
1016llvm::Optional<FormatStyle>
1017FormatStyle::GetLanguageStyle(FormatStyle::LanguageKind Language) const {
1018 return StyleSet.Get(Language);
1019}
1020
Craig Topperaf35e852013-06-30 22:29:28 +00001021namespace {
1022
Daniel Jasper496c1992016-09-07 22:48:53 +00001023class JavaScriptRequoter : public TokenAnalyzer {
Eric Liu4cfb88a2016-04-25 15:09:22 +00001024public:
Daniel Jasper496c1992016-09-07 22:48:53 +00001025 JavaScriptRequoter(const Environment &Env, const FormatStyle &Style)
1026 : TokenAnalyzer(Env, Style) {}
Eric Liu4cfb88a2016-04-25 15:09:22 +00001027
Krasimir Georgiev9ad83fe2017-10-30 14:01:50 +00001028 std::pair<tooling::Replacements, unsigned>
Eric Liu4cfb88a2016-04-25 15:09:22 +00001029 analyze(TokenAnnotator &Annotator,
1030 SmallVectorImpl<AnnotatedLine *> &AnnotatedLines,
Martin Probsta9855af2016-09-02 14:29:48 +00001031 FormatTokenLexer &Tokens) override {
Manuel Klimek0dddcf72018-04-23 09:34:26 +00001032 AffectedRangeMgr.computeAffectedLines(AnnotatedLines);
Daniel Jasper496c1992016-09-07 22:48:53 +00001033 tooling::Replacements Result;
1034 requoteJSStringLiteral(AnnotatedLines, Result);
Krasimir Georgiev9ad83fe2017-10-30 14:01:50 +00001035 return {Result, 0};
Alexander Kornienko62b85b92013-03-13 14:41:29 +00001036 }
1037
1038private:
Daniel Jasper496c1992016-09-07 22:48:53 +00001039 // Replaces double/single-quoted string literal as appropriate, re-escaping
1040 // the contents in the process.
Daniel Jasper97439922016-03-17 13:03:41 +00001041 void requoteJSStringLiteral(SmallVectorImpl<AnnotatedLine *> &Lines,
Eric Liu4cfb88a2016-04-25 15:09:22 +00001042 tooling::Replacements &Result) {
Daniel Jasper97439922016-03-17 13:03:41 +00001043 for (AnnotatedLine *Line : Lines) {
1044 requoteJSStringLiteral(Line->Children, Result);
1045 if (!Line->Affected)
1046 continue;
1047 for (FormatToken *FormatTok = Line->First; FormatTok;
1048 FormatTok = FormatTok->Next) {
1049 StringRef Input = FormatTok->TokenText;
Martin Probsta1669792016-05-12 11:20:32 +00001050 if (FormatTok->Finalized || !FormatTok->isStringLiteral() ||
Daniel Jasper97439922016-03-17 13:03:41 +00001051 // NB: testing for not starting with a double quote to avoid
Daniel Jasper496c1992016-09-07 22:48:53 +00001052 // breaking `template strings`.
Eric Liu635423e2016-04-28 07:52:03 +00001053 (Style.JavaScriptQuotes == FormatStyle::JSQS_Single &&
Daniel Jasper97439922016-03-17 13:03:41 +00001054 !Input.startswith("\"")) ||
Eric Liu635423e2016-04-28 07:52:03 +00001055 (Style.JavaScriptQuotes == FormatStyle::JSQS_Double &&
Daniel Jasper97439922016-03-17 13:03:41 +00001056 !Input.startswith("\'")))
1057 continue;
1058
1059 // Change start and end quote.
Eric Liu635423e2016-04-28 07:52:03 +00001060 bool IsSingle = Style.JavaScriptQuotes == FormatStyle::JSQS_Single;
Daniel Jasper97439922016-03-17 13:03:41 +00001061 SourceLocation Start = FormatTok->Tok.getLocation();
1062 auto Replace = [&](SourceLocation Start, unsigned Length,
1063 StringRef ReplacementText) {
Eric Liu40ef2fb2016-08-01 10:16:37 +00001064 auto Err = Result.add(tooling::Replacement(
1065 Env.getSourceManager(), Start, Length, ReplacementText));
1066 // FIXME: handle error. For now, print error message and skip the
1067 // replacement for release version.
Piotr Padlewski1ec383c2016-12-23 11:40:44 +00001068 if (Err) {
Eric Liu40ef2fb2016-08-01 10:16:37 +00001069 llvm::errs() << llvm::toString(std::move(Err)) << "\n";
Piotr Padlewski1ec383c2016-12-23 11:40:44 +00001070 assert(false);
1071 }
Daniel Jasper97439922016-03-17 13:03:41 +00001072 };
1073 Replace(Start, 1, IsSingle ? "'" : "\"");
1074 Replace(FormatTok->Tok.getEndLoc().getLocWithOffset(-1), 1,
1075 IsSingle ? "'" : "\"");
1076
1077 // Escape internal quotes.
Daniel Jasper97439922016-03-17 13:03:41 +00001078 bool Escaped = false;
1079 for (size_t i = 1; i < Input.size() - 1; i++) {
1080 switch (Input[i]) {
Eric Liu4cfb88a2016-04-25 15:09:22 +00001081 case '\\':
1082 if (!Escaped && i + 1 < Input.size() &&
1083 ((IsSingle && Input[i + 1] == '"') ||
1084 (!IsSingle && Input[i + 1] == '\''))) {
1085 // Remove this \, it's escaping a " or ' that no longer needs
1086 // escaping
Eric Liu4cfb88a2016-04-25 15:09:22 +00001087 Replace(Start.getLocWithOffset(i), 1, "");
1088 continue;
1089 }
1090 Escaped = !Escaped;
1091 break;
1092 case '\"':
1093 case '\'':
1094 if (!Escaped && IsSingle == (Input[i] == '\'')) {
1095 // Escape the quote.
1096 Replace(Start.getLocWithOffset(i), 0, "\\");
Eric Liu4cfb88a2016-04-25 15:09:22 +00001097 }
1098 Escaped = false;
1099 break;
1100 default:
1101 Escaped = false;
1102 break;
Daniel Jasper97439922016-03-17 13:03:41 +00001103 }
1104 }
Daniel Jasper97439922016-03-17 13:03:41 +00001105 }
1106 }
1107 }
Daniel Jasper496c1992016-09-07 22:48:53 +00001108};
1109
1110class Formatter : public TokenAnalyzer {
1111public:
1112 Formatter(const Environment &Env, const FormatStyle &Style,
Krasimir Georgievbcda54b2017-04-21 14:35:20 +00001113 FormattingAttemptStatus *Status)
1114 : TokenAnalyzer(Env, Style), Status(Status) {}
Daniel Jasper496c1992016-09-07 22:48:53 +00001115
Krasimir Georgiev9ad83fe2017-10-30 14:01:50 +00001116 std::pair<tooling::Replacements, unsigned>
Daniel Jasper496c1992016-09-07 22:48:53 +00001117 analyze(TokenAnnotator &Annotator,
1118 SmallVectorImpl<AnnotatedLine *> &AnnotatedLines,
1119 FormatTokenLexer &Tokens) override {
1120 tooling::Replacements Result;
1121 deriveLocalStyle(AnnotatedLines);
Manuel Klimek0dddcf72018-04-23 09:34:26 +00001122 AffectedRangeMgr.computeAffectedLines(AnnotatedLines);
Daniel Jasper496c1992016-09-07 22:48:53 +00001123 for (unsigned i = 0, e = AnnotatedLines.size(); i != e; ++i) {
1124 Annotator.calculateFormattingInformation(*AnnotatedLines[i]);
1125 }
1126 Annotator.setCommentLineLevels(AnnotatedLines);
1127
1128 WhitespaceManager Whitespaces(
1129 Env.getSourceManager(), Style,
1130 inputUsesCRLF(Env.getSourceManager().getBufferData(Env.getFileID())));
1131 ContinuationIndenter Indenter(Style, Tokens.getKeywords(),
1132 Env.getSourceManager(), Whitespaces, Encoding,
1133 BinPackInconclusiveFunctions);
Krasimir Georgiev9ad83fe2017-10-30 14:01:50 +00001134 unsigned Penalty =
1135 UnwrappedLineFormatter(&Indenter, &Whitespaces, Style,
1136 Tokens.getKeywords(), Env.getSourceManager(),
1137 Status)
1138 .format(AnnotatedLines, /*DryRun=*/false,
1139 /*AdditionalIndent=*/0,
1140 /*FixBadIndentation=*/false,
1141 /*FirstStartColumn=*/Env.getFirstStartColumn(),
1142 /*NextStartColumn=*/Env.getNextStartColumn(),
1143 /*LastStartColumn=*/Env.getLastStartColumn());
Daniel Jasper496c1992016-09-07 22:48:53 +00001144 for (const auto &R : Whitespaces.generateReplacements())
1145 if (Result.add(R))
Krasimir Georgieve56e9a42017-10-30 14:30:14 +00001146 return std::make_pair(Result, 0);
1147 return std::make_pair(Result, Penalty);
Daniel Jasper496c1992016-09-07 22:48:53 +00001148 }
1149
1150private:
Alexander Kornienko9e649af2013-09-11 12:25:57 +00001151 static bool inputUsesCRLF(StringRef Text) {
1152 return Text.count('\r') * 2 > Text.count('\n');
1153 }
1154
Daniel Jasper352f0df2015-07-18 16:35:30 +00001155 bool
1156 hasCpp03IncompatibleFormat(const SmallVectorImpl<AnnotatedLine *> &Lines) {
Eric Liu4cfb88a2016-04-25 15:09:22 +00001157 for (const AnnotatedLine *Line : Lines) {
Daniel Jasper352f0df2015-07-18 16:35:30 +00001158 if (hasCpp03IncompatibleFormat(Line->Children))
1159 return true;
1160 for (FormatToken *Tok = Line->First->Next; Tok; Tok = Tok->Next) {
1161 if (Tok->WhitespaceRange.getBegin() == Tok->WhitespaceRange.getEnd()) {
1162 if (Tok->is(tok::coloncolon) && Tok->Previous->is(TT_TemplateOpener))
1163 return true;
1164 if (Tok->is(TT_TemplateCloser) &&
1165 Tok->Previous->is(TT_TemplateCloser))
1166 return true;
1167 }
1168 }
1169 }
1170 return false;
1171 }
1172
1173 int countVariableAlignments(const SmallVectorImpl<AnnotatedLine *> &Lines) {
1174 int AlignmentDiff = 0;
Eric Liu4cfb88a2016-04-25 15:09:22 +00001175 for (const AnnotatedLine *Line : Lines) {
Daniel Jasper352f0df2015-07-18 16:35:30 +00001176 AlignmentDiff += countVariableAlignments(Line->Children);
1177 for (FormatToken *Tok = Line->First; Tok && Tok->Next; Tok = Tok->Next) {
1178 if (!Tok->is(TT_PointerOrReference))
1179 continue;
1180 bool SpaceBefore =
1181 Tok->WhitespaceRange.getBegin() != Tok->WhitespaceRange.getEnd();
1182 bool SpaceAfter = Tok->Next->WhitespaceRange.getBegin() !=
1183 Tok->Next->WhitespaceRange.getEnd();
1184 if (SpaceBefore && !SpaceAfter)
1185 ++AlignmentDiff;
1186 if (!SpaceBefore && SpaceAfter)
1187 --AlignmentDiff;
1188 }
1189 }
1190 return AlignmentDiff;
1191 }
1192
Manuel Klimek71814b42013-10-11 21:25:45 +00001193 void
1194 deriveLocalStyle(const SmallVectorImpl<AnnotatedLine *> &AnnotatedLines) {
Daniel Jasperb10cbc42013-07-10 14:02:49 +00001195 bool HasBinPackedFunction = false;
1196 bool HasOnePerLineFunction = false;
Daniel Jasper7fce3ab2013-02-06 14:22:40 +00001197 for (unsigned i = 0, e = AnnotatedLines.size(); i != e; ++i) {
Daniel Jasper9fe0e8d2013-09-05 09:29:45 +00001198 if (!AnnotatedLines[i]->First->Next)
Daniel Jasper7fce3ab2013-02-06 14:22:40 +00001199 continue;
Daniel Jasper9fe0e8d2013-09-05 09:29:45 +00001200 FormatToken *Tok = AnnotatedLines[i]->First->Next;
Manuel Klimek6e6310e2013-05-29 14:47:47 +00001201 while (Tok->Next) {
Daniel Jasperb10cbc42013-07-10 14:02:49 +00001202 if (Tok->PackingKind == PPK_BinPacked)
1203 HasBinPackedFunction = true;
1204 if (Tok->PackingKind == PPK_OnePerLine)
1205 HasOnePerLineFunction = true;
1206
Manuel Klimek6e6310e2013-05-29 14:47:47 +00001207 Tok = Tok->Next;
Daniel Jasper7fce3ab2013-02-06 14:22:40 +00001208 }
1209 }
Eric Liu635423e2016-04-28 07:52:03 +00001210 if (Style.DerivePointerAlignment)
1211 Style.PointerAlignment = countVariableAlignments(AnnotatedLines) <= 0
1212 ? FormatStyle::PAS_Left
1213 : FormatStyle::PAS_Right;
1214 if (Style.Standard == FormatStyle::LS_Auto)
1215 Style.Standard = hasCpp03IncompatibleFormat(AnnotatedLines)
1216 ? FormatStyle::LS_Cpp11
1217 : FormatStyle::LS_Cpp03;
Daniel Jasperb10cbc42013-07-10 14:02:49 +00001218 BinPackInconclusiveFunctions =
1219 HasBinPackedFunction || !HasOnePerLineFunction;
Daniel Jasper7fce3ab2013-02-06 14:22:40 +00001220 }
1221
Daniel Jasperb10cbc42013-07-10 14:02:49 +00001222 bool BinPackInconclusiveFunctions;
Krasimir Georgievbcda54b2017-04-21 14:35:20 +00001223 FormattingAttemptStatus *Status;
Eric Liu4cfb88a2016-04-25 15:09:22 +00001224};
1225
1226// This class clean up the erroneous/redundant code around the given ranges in
1227// file.
1228class Cleaner : public TokenAnalyzer {
1229public:
Eric Liu635423e2016-04-28 07:52:03 +00001230 Cleaner(const Environment &Env, const FormatStyle &Style)
1231 : TokenAnalyzer(Env, Style),
Eric Liu4cfb88a2016-04-25 15:09:22 +00001232 DeletedTokens(FormatTokenLess(Env.getSourceManager())) {}
1233
1234 // FIXME: eliminate unused parameters.
Krasimir Georgiev9ad83fe2017-10-30 14:01:50 +00001235 std::pair<tooling::Replacements, unsigned>
Eric Liu4cfb88a2016-04-25 15:09:22 +00001236 analyze(TokenAnnotator &Annotator,
1237 SmallVectorImpl<AnnotatedLine *> &AnnotatedLines,
Martin Probsta9855af2016-09-02 14:29:48 +00001238 FormatTokenLexer &Tokens) override {
Eric Liu4cfb88a2016-04-25 15:09:22 +00001239 // FIXME: in the current implementation the granularity of affected range
1240 // is an annotated line. However, this is not sufficient. Furthermore,
1241 // redundant code introduced by replacements does not necessarily
1242 // intercept with ranges of replacements that result in the redundancy.
1243 // To determine if some redundant code is actually introduced by
1244 // replacements(e.g. deletions), we need to come up with a more
1245 // sophisticated way of computing affected ranges.
Manuel Klimek0dddcf72018-04-23 09:34:26 +00001246 AffectedRangeMgr.computeAffectedLines(AnnotatedLines);
Eric Liu4cfb88a2016-04-25 15:09:22 +00001247
1248 checkEmptyNamespace(AnnotatedLines);
1249
Eric Liuce5e4bc2016-05-18 08:02:56 +00001250 for (auto &Line : AnnotatedLines) {
1251 if (Line->Affected) {
1252 cleanupRight(Line->First, tok::comma, tok::comma);
1253 cleanupRight(Line->First, TT_CtorInitializerColon, tok::comma);
Eric Liu2574d152016-09-13 15:02:43 +00001254 cleanupRight(Line->First, tok::l_paren, tok::comma);
1255 cleanupLeft(Line->First, tok::comma, tok::r_paren);
Eric Liuce5e4bc2016-05-18 08:02:56 +00001256 cleanupLeft(Line->First, TT_CtorInitializerComma, tok::l_brace);
1257 cleanupLeft(Line->First, TT_CtorInitializerColon, tok::l_brace);
Malcolm Parsons5d8cdb82016-10-20 14:58:45 +00001258 cleanupLeft(Line->First, TT_CtorInitializerColon, tok::equal);
Eric Liuce5e4bc2016-05-18 08:02:56 +00001259 }
1260 }
1261
Krasimir Georgiev9ad83fe2017-10-30 14:01:50 +00001262 return {generateFixes(), 0};
Eric Liu4cfb88a2016-04-25 15:09:22 +00001263 }
1264
1265private:
1266 bool containsOnlyComments(const AnnotatedLine &Line) {
1267 for (FormatToken *Tok = Line.First; Tok != nullptr; Tok = Tok->Next) {
1268 if (Tok->isNot(tok::comment))
1269 return false;
1270 }
1271 return true;
1272 }
1273
1274 // Iterate through all lines and remove any empty (nested) namespaces.
1275 void checkEmptyNamespace(SmallVectorImpl<AnnotatedLine *> &AnnotatedLines) {
Eric Liu7956c402016-10-05 15:49:01 +00001276 std::set<unsigned> DeletedLines;
Eric Liu4cfb88a2016-04-25 15:09:22 +00001277 for (unsigned i = 0, e = AnnotatedLines.size(); i != e; ++i) {
1278 auto &Line = *AnnotatedLines[i];
1279 if (Line.startsWith(tok::kw_namespace) ||
1280 Line.startsWith(tok::kw_inline, tok::kw_namespace)) {
Eric Liu7956c402016-10-05 15:49:01 +00001281 checkEmptyNamespace(AnnotatedLines, i, i, DeletedLines);
Eric Liu4cfb88a2016-04-25 15:09:22 +00001282 }
1283 }
1284
1285 for (auto Line : DeletedLines) {
1286 FormatToken *Tok = AnnotatedLines[Line]->First;
1287 while (Tok) {
1288 deleteToken(Tok);
1289 Tok = Tok->Next;
1290 }
1291 }
1292 }
1293
1294 // The function checks if the namespace, which starts from \p CurrentLine, and
1295 // its nested namespaces are empty and delete them if they are empty. It also
1296 // sets \p NewLine to the last line checked.
1297 // Returns true if the current namespace is empty.
1298 bool checkEmptyNamespace(SmallVectorImpl<AnnotatedLine *> &AnnotatedLines,
Eric Liu7956c402016-10-05 15:49:01 +00001299 unsigned CurrentLine, unsigned &NewLine,
1300 std::set<unsigned> &DeletedLines) {
Eric Liu4cfb88a2016-04-25 15:09:22 +00001301 unsigned InitLine = CurrentLine, End = AnnotatedLines.size();
Eric Liu635423e2016-04-28 07:52:03 +00001302 if (Style.BraceWrapping.AfterNamespace) {
Eric Liu4cfb88a2016-04-25 15:09:22 +00001303 // If the left brace is in a new line, we should consume it first so that
1304 // it does not make the namespace non-empty.
1305 // FIXME: error handling if there is no left brace.
1306 if (!AnnotatedLines[++CurrentLine]->startsWith(tok::l_brace)) {
1307 NewLine = CurrentLine;
1308 return false;
1309 }
1310 } else if (!AnnotatedLines[CurrentLine]->endsWith(tok::l_brace)) {
1311 return false;
1312 }
1313 while (++CurrentLine < End) {
1314 if (AnnotatedLines[CurrentLine]->startsWith(tok::r_brace))
1315 break;
1316
1317 if (AnnotatedLines[CurrentLine]->startsWith(tok::kw_namespace) ||
1318 AnnotatedLines[CurrentLine]->startsWith(tok::kw_inline,
1319 tok::kw_namespace)) {
Eric Liu7956c402016-10-05 15:49:01 +00001320 if (!checkEmptyNamespace(AnnotatedLines, CurrentLine, NewLine,
1321 DeletedLines))
Eric Liu4cfb88a2016-04-25 15:09:22 +00001322 return false;
1323 CurrentLine = NewLine;
1324 continue;
1325 }
1326
1327 if (containsOnlyComments(*AnnotatedLines[CurrentLine]))
1328 continue;
1329
1330 // If there is anything other than comments or nested namespaces in the
1331 // current namespace, the namespace cannot be empty.
1332 NewLine = CurrentLine;
1333 return false;
1334 }
1335
1336 NewLine = CurrentLine;
1337 if (CurrentLine >= End)
1338 return false;
1339
1340 // Check if the empty namespace is actually affected by changed ranges.
1341 if (!AffectedRangeMgr.affectsCharSourceRange(CharSourceRange::getCharRange(
1342 AnnotatedLines[InitLine]->First->Tok.getLocation(),
1343 AnnotatedLines[CurrentLine]->Last->Tok.getEndLoc())))
1344 return false;
1345
1346 for (unsigned i = InitLine; i <= CurrentLine; ++i) {
1347 DeletedLines.insert(i);
1348 }
1349
1350 return true;
1351 }
1352
Eric Liuce5e4bc2016-05-18 08:02:56 +00001353 // Checks pairs {start, start->next},..., {end->previous, end} and deletes one
1354 // of the token in the pair if the left token has \p LK token kind and the
1355 // right token has \p RK token kind. If \p DeleteLeft is true, the left token
1356 // is deleted on match; otherwise, the right token is deleted.
1357 template <typename LeftKind, typename RightKind>
1358 void cleanupPair(FormatToken *Start, LeftKind LK, RightKind RK,
1359 bool DeleteLeft) {
1360 auto NextNotDeleted = [this](const FormatToken &Tok) -> FormatToken * {
1361 for (auto *Res = Tok.Next; Res; Res = Res->Next)
1362 if (!Res->is(tok::comment) &&
1363 DeletedTokens.find(Res) == DeletedTokens.end())
1364 return Res;
1365 return nullptr;
1366 };
1367 for (auto *Left = Start; Left;) {
1368 auto *Right = NextNotDeleted(*Left);
1369 if (!Right)
1370 break;
1371 if (Left->is(LK) && Right->is(RK)) {
1372 deleteToken(DeleteLeft ? Left : Right);
Eric Liu01426ff2016-09-09 17:50:49 +00001373 for (auto *Tok = Left->Next; Tok && Tok != Right; Tok = Tok->Next)
1374 deleteToken(Tok);
Eric Liuce5e4bc2016-05-18 08:02:56 +00001375 // If the right token is deleted, we should keep the left token
1376 // unchanged and pair it with the new right token.
1377 if (!DeleteLeft)
1378 continue;
1379 }
1380 Left = Right;
1381 }
1382 }
1383
1384 template <typename LeftKind, typename RightKind>
1385 void cleanupLeft(FormatToken *Start, LeftKind LK, RightKind RK) {
1386 cleanupPair(Start, LK, RK, /*DeleteLeft=*/true);
1387 }
1388
1389 template <typename LeftKind, typename RightKind>
1390 void cleanupRight(FormatToken *Start, LeftKind LK, RightKind RK) {
1391 cleanupPair(Start, LK, RK, /*DeleteLeft=*/false);
1392 }
1393
Eric Liu4cfb88a2016-04-25 15:09:22 +00001394 // Delete the given token.
1395 inline void deleteToken(FormatToken *Tok) {
1396 if (Tok)
1397 DeletedTokens.insert(Tok);
1398 }
1399
1400 tooling::Replacements generateFixes() {
1401 tooling::Replacements Fixes;
1402 std::vector<FormatToken *> Tokens;
1403 std::copy(DeletedTokens.begin(), DeletedTokens.end(),
1404 std::back_inserter(Tokens));
1405
1406 // Merge multiple continuous token deletions into one big deletion so that
1407 // the number of replacements can be reduced. This makes computing affected
1408 // ranges more efficient when we run reformat on the changed code.
1409 unsigned Idx = 0;
1410 while (Idx < Tokens.size()) {
1411 unsigned St = Idx, End = Idx;
1412 while ((End + 1) < Tokens.size() &&
1413 Tokens[End]->Next == Tokens[End + 1]) {
1414 End++;
1415 }
1416 auto SR = CharSourceRange::getCharRange(Tokens[St]->Tok.getLocation(),
1417 Tokens[End]->Tok.getEndLoc());
Eric Liu40ef2fb2016-08-01 10:16:37 +00001418 auto Err =
1419 Fixes.add(tooling::Replacement(Env.getSourceManager(), SR, ""));
1420 // FIXME: better error handling. for now just print error message and skip
1421 // for the release version.
Piotr Padlewski1ec383c2016-12-23 11:40:44 +00001422 if (Err) {
Eric Liu40ef2fb2016-08-01 10:16:37 +00001423 llvm::errs() << llvm::toString(std::move(Err)) << "\n";
Piotr Padlewski1ec383c2016-12-23 11:40:44 +00001424 assert(false && "Fixes must not conflict!");
1425 }
Eric Liu4cfb88a2016-04-25 15:09:22 +00001426 Idx = End + 1;
1427 }
1428
1429 return Fixes;
1430 }
1431
1432 // Class for less-than inequality comparason for the set `RedundantTokens`.
1433 // We store tokens in the order they appear in the translation unit so that
1434 // we do not need to sort them in `generateFixes()`.
1435 struct FormatTokenLess {
Eric Liu635423e2016-04-28 07:52:03 +00001436 FormatTokenLess(const SourceManager &SM) : SM(SM) {}
Eric Liu4cfb88a2016-04-25 15:09:22 +00001437
Eric Liu2874ac32016-05-18 08:14:49 +00001438 bool operator()(const FormatToken *LHS, const FormatToken *RHS) const {
Eric Liu4cfb88a2016-04-25 15:09:22 +00001439 return SM.isBeforeInTranslationUnit(LHS->Tok.getLocation(),
1440 RHS->Tok.getLocation());
1441 }
Eric Liu635423e2016-04-28 07:52:03 +00001442 const SourceManager &SM;
Eric Liu4cfb88a2016-04-25 15:09:22 +00001443 };
1444
1445 // Tokens to be deleted.
1446 std::set<FormatToken *, FormatTokenLess> DeletedTokens;
Daniel Jasperf7935112012-12-03 18:12:45 +00001447};
1448
Ben Hamiltone2e3e672018-01-17 17:33:08 +00001449class ObjCHeaderStyleGuesser : public TokenAnalyzer {
1450public:
1451 ObjCHeaderStyleGuesser(const Environment &Env, const FormatStyle &Style)
1452 : TokenAnalyzer(Env, Style), IsObjC(false) {}
1453
1454 std::pair<tooling::Replacements, unsigned>
1455 analyze(TokenAnnotator &Annotator,
1456 SmallVectorImpl<AnnotatedLine *> &AnnotatedLines,
1457 FormatTokenLexer &Tokens) override {
1458 assert(Style.Language == FormatStyle::LK_Cpp);
1459 IsObjC = guessIsObjC(AnnotatedLines, Tokens.getKeywords());
1460 tooling::Replacements Result;
1461 return {Result, 0};
1462 }
1463
1464 bool isObjC() { return IsObjC; }
1465
1466private:
1467 static bool guessIsObjC(const SmallVectorImpl<AnnotatedLine *> &AnnotatedLines,
1468 const AdditionalKeywords &Keywords) {
Krasimir Georgiev8e216782018-01-17 20:01:02 +00001469 // Keep this array sorted, since we are binary searching over it.
1470 static constexpr llvm::StringLiteral FoundationIdentifiers[] = {
Ben Hamiltone2e3e672018-01-17 17:33:08 +00001471 "CGFloat",
Ben Hamilton19c782d2018-03-22 03:25:22 +00001472 "CGPoint",
1473 "CGPointMake",
1474 "CGPointZero",
1475 "CGRect",
1476 "CGRectEdge",
1477 "CGRectInfinite",
1478 "CGRectMake",
1479 "CGRectNull",
1480 "CGRectZero",
1481 "CGSize",
1482 "CGSizeMake",
1483 "CGVector",
1484 "CGVectorMake",
Ben Hamiltone2e3e672018-01-17 17:33:08 +00001485 "NSAffineTransform",
1486 "NSArray",
1487 "NSAttributedString",
Ben Hamiltonb1a79192018-04-12 15:11:53 +00001488 "NSBlockOperation",
Jacek Olesiakce4f0af2018-02-15 08:47:56 +00001489 "NSBundle",
Ben Hamiltone2e3e672018-01-17 17:33:08 +00001490 "NSCache",
Jacek Olesiakce4f0af2018-02-15 08:47:56 +00001491 "NSCalendar",
Ben Hamiltone2e3e672018-01-17 17:33:08 +00001492 "NSCharacterSet",
1493 "NSCountedSet",
1494 "NSData",
1495 "NSDataDetector",
1496 "NSDecimal",
1497 "NSDecimalNumber",
1498 "NSDictionary",
1499 "NSEdgeInsets",
1500 "NSHashTable",
1501 "NSIndexPath",
1502 "NSIndexSet",
1503 "NSInteger",
Ben Hamiltonb1a79192018-04-12 15:11:53 +00001504 "NSInvocationOperation",
Ben Hamiltone2e3e672018-01-17 17:33:08 +00001505 "NSLocale",
1506 "NSMapTable",
1507 "NSMutableArray",
1508 "NSMutableAttributedString",
1509 "NSMutableCharacterSet",
1510 "NSMutableData",
1511 "NSMutableDictionary",
1512 "NSMutableIndexSet",
1513 "NSMutableOrderedSet",
1514 "NSMutableSet",
1515 "NSMutableString",
1516 "NSNumber",
1517 "NSNumberFormatter",
Jacek Olesiakce4f0af2018-02-15 08:47:56 +00001518 "NSObject",
Ben Hamiltonb1a79192018-04-12 15:11:53 +00001519 "NSOperation",
1520 "NSOperationQueue",
1521 "NSOperationQueuePriority",
Ben Hamiltone2e3e672018-01-17 17:33:08 +00001522 "NSOrderedSet",
1523 "NSPoint",
1524 "NSPointerArray",
Ben Hamiltonb1a79192018-04-12 15:11:53 +00001525 "NSQualityOfService",
Ben Hamiltone2e3e672018-01-17 17:33:08 +00001526 "NSRange",
1527 "NSRect",
1528 "NSRegularExpression",
1529 "NSSet",
1530 "NSSize",
1531 "NSString",
Jacek Olesiakce4f0af2018-02-15 08:47:56 +00001532 "NSTimeZone",
Ben Hamiltone2e3e672018-01-17 17:33:08 +00001533 "NSUInteger",
1534 "NSURL",
1535 "NSURLComponents",
1536 "NSURLQueryItem",
1537 "NSUUID",
Jacek Olesiakce4f0af2018-02-15 08:47:56 +00001538 "NSValue",
Ben Hamilton19c782d2018-03-22 03:25:22 +00001539 "UIImage",
1540 "UIView",
Ben Hamiltone2e3e672018-01-17 17:33:08 +00001541 };
1542
Ben Hamiltonea7a27b2018-03-27 15:01:21 +00001543 for (auto Line : AnnotatedLines) {
1544 for (const FormatToken *FormatTok = Line->First; FormatTok;
Ben Hamiltone2e3e672018-01-17 17:33:08 +00001545 FormatTok = FormatTok->Next) {
Jacek Olesiakce4f0af2018-02-15 08:47:56 +00001546 if ((FormatTok->Previous && FormatTok->Previous->is(tok::at) &&
Ben Hamiltonb1a79192018-04-12 15:11:53 +00001547 (FormatTok->Tok.getObjCKeywordID() != tok::objc_not_keyword ||
Ben Hamiltone2e3e672018-01-17 17:33:08 +00001548 FormatTok->isOneOf(tok::numeric_constant, tok::l_square,
1549 tok::l_brace))) ||
1550 (FormatTok->Tok.isAnyIdentifier() &&
Krasimir Georgiev8e216782018-01-17 20:01:02 +00001551 std::binary_search(std::begin(FoundationIdentifiers),
1552 std::end(FoundationIdentifiers),
1553 FormatTok->TokenText)) ||
Ben Hamiltone2e3e672018-01-17 17:33:08 +00001554 FormatTok->is(TT_ObjCStringLiteral) ||
1555 FormatTok->isOneOf(Keywords.kw_NS_ENUM, Keywords.kw_NS_OPTIONS,
1556 TT_ObjCBlockLBrace, TT_ObjCBlockLParen,
1557 TT_ObjCDecl, TT_ObjCForIn, TT_ObjCMethodExpr,
1558 TT_ObjCMethodSpecifier, TT_ObjCProperty)) {
1559 return true;
1560 }
Ben Hamiltonea7a27b2018-03-27 15:01:21 +00001561 if (guessIsObjC(Line->Children, Keywords))
Ben Hamilton6432afe2018-03-22 17:37:19 +00001562 return true;
1563 }
Ben Hamiltone2e3e672018-01-17 17:33:08 +00001564 }
1565 return false;
1566 }
1567
1568 bool IsObjC;
1569};
1570
Daniel Jasperd89ae9d2015-09-23 08:30:47 +00001571struct IncludeDirective {
1572 StringRef Filename;
1573 StringRef Text;
1574 unsigned Offset;
Daniel Jasperd2629dc2015-12-16 10:10:16 +00001575 int Category;
Daniel Jasperd89ae9d2015-09-23 08:30:47 +00001576};
1577
Craig Topperaf35e852013-06-30 22:29:28 +00001578} // end anonymous namespace
1579
Daniel Jasperd89ae9d2015-09-23 08:30:47 +00001580// Determines whether 'Ranges' intersects with ('Start', 'End').
1581static bool affectsRange(ArrayRef<tooling::Range> Ranges, unsigned Start,
1582 unsigned End) {
1583 for (auto Range : Ranges) {
1584 if (Range.getOffset() < End &&
1585 Range.getOffset() + Range.getLength() > Start)
1586 return true;
1587 }
1588 return false;
1589}
1590
Eric Liua992afe2016-08-10 09:32:23 +00001591// Returns a pair (Index, OffsetToEOL) describing the position of the cursor
1592// before sorting/deduplicating. Index is the index of the include under the
1593// cursor in the original set of includes. If this include has duplicates, it is
1594// the index of the first of the duplicates as the others are going to be
1595// removed. OffsetToEOL describes the cursor's position relative to the end of
1596// its current line.
1597// If `Cursor` is not on any #include, `Index` will be UINT_MAX.
1598static std::pair<unsigned, unsigned>
1599FindCursorIndex(const SmallVectorImpl<IncludeDirective> &Includes,
1600 const SmallVectorImpl<unsigned> &Indices, unsigned Cursor) {
1601 unsigned CursorIndex = UINT_MAX;
1602 unsigned OffsetToEOL = 0;
1603 for (int i = 0, e = Includes.size(); i != e; ++i) {
1604 unsigned Start = Includes[Indices[i]].Offset;
1605 unsigned End = Start + Includes[Indices[i]].Text.size();
1606 if (!(Cursor >= Start && Cursor < End))
1607 continue;
1608 CursorIndex = Indices[i];
1609 OffsetToEOL = End - Cursor;
1610 // Put the cursor on the only remaining #include among the duplicate
1611 // #includes.
1612 while (--i >= 0 && Includes[CursorIndex].Text == Includes[Indices[i]].Text)
1613 CursorIndex = i;
1614 break;
1615 }
1616 return std::make_pair(CursorIndex, OffsetToEOL);
1617}
1618
1619// Sorts and deduplicate a block of includes given by 'Includes' alphabetically
1620// adding the necessary replacement to 'Replaces'. 'Includes' must be in strict
1621// source order.
1622// #include directives with the same text will be deduplicated, and only the
1623// first #include in the duplicate #includes remains. If the `Cursor` is
1624// provided and put on a deleted #include, it will be moved to the remaining
1625// #include in the duplicate #includes.
Martin Probstc4a0dd42016-05-20 11:24:24 +00001626static void sortCppIncludes(const FormatStyle &Style,
Eric Liua992afe2016-08-10 09:32:23 +00001627 const SmallVectorImpl<IncludeDirective> &Includes,
1628 ArrayRef<tooling::Range> Ranges, StringRef FileName,
1629 tooling::Replacements &Replaces, unsigned *Cursor) {
1630 unsigned IncludesBeginOffset = Includes.front().Offset;
Daniel Jasperd6a00782016-08-30 21:33:41 +00001631 unsigned IncludesEndOffset =
1632 Includes.back().Offset + Includes.back().Text.size();
1633 unsigned IncludesBlockSize = IncludesEndOffset - IncludesBeginOffset;
1634 if (!affectsRange(Ranges, IncludesBeginOffset, IncludesEndOffset))
Daniel Jasperd89ae9d2015-09-23 08:30:47 +00001635 return;
1636 SmallVector<unsigned, 16> Indices;
1637 for (unsigned i = 0, e = Includes.size(); i != e; ++i)
1638 Indices.push_back(i);
Daniel Jasper94a96fc2016-03-03 17:34:14 +00001639 std::stable_sort(
1640 Indices.begin(), Indices.end(), [&](unsigned LHSI, unsigned RHSI) {
1641 return std::tie(Includes[LHSI].Category, Includes[LHSI].Filename) <
1642 std::tie(Includes[RHSI].Category, Includes[RHSI].Filename);
1643 });
Eric Liua992afe2016-08-10 09:32:23 +00001644 // The index of the include on which the cursor will be put after
1645 // sorting/deduplicating.
1646 unsigned CursorIndex;
1647 // The offset from cursor to the end of line.
1648 unsigned CursorToEOLOffset;
1649 if (Cursor)
1650 std::tie(CursorIndex, CursorToEOLOffset) =
1651 FindCursorIndex(Includes, Indices, *Cursor);
1652
1653 // Deduplicate #includes.
1654 Indices.erase(std::unique(Indices.begin(), Indices.end(),
1655 [&](unsigned LHSI, unsigned RHSI) {
1656 return Includes[LHSI].Text == Includes[RHSI].Text;
1657 }),
1658 Indices.end());
Daniel Jasperd89ae9d2015-09-23 08:30:47 +00001659
Krasimir Georgiev4c2c9c32017-11-27 13:23:45 +00001660 int CurrentCategory = Includes.front().Category;
1661
Daniel Jasperd89ae9d2015-09-23 08:30:47 +00001662 // If the #includes are out of order, we generate a single replacement fixing
1663 // the entire block. Otherwise, no replacement is generated.
Eric Liua992afe2016-08-10 09:32:23 +00001664 if (Indices.size() == Includes.size() &&
Krasimir Georgiev4c2c9c32017-11-27 13:23:45 +00001665 std::is_sorted(Indices.begin(), Indices.end()) &&
Eric Liu9d92c022018-05-14 19:51:33 +00001666 Style.IncludeStyle.IncludeBlocks == tooling::IncludeStyle::IBS_Preserve)
Daniel Jasperd89ae9d2015-09-23 08:30:47 +00001667 return;
1668
Daniel Jasperb68aabf2015-11-23 08:36:35 +00001669 std::string result;
Daniel Jasperb68aabf2015-11-23 08:36:35 +00001670 for (unsigned Index : Indices) {
Krasimir Georgiev4c2c9c32017-11-27 13:23:45 +00001671 if (!result.empty()) {
Daniel Jasperb68aabf2015-11-23 08:36:35 +00001672 result += "\n";
Eric Liu9d92c022018-05-14 19:51:33 +00001673 if (Style.IncludeStyle.IncludeBlocks ==
1674 tooling::IncludeStyle::IBS_Regroup &&
Krasimir Georgiev4c2c9c32017-11-27 13:23:45 +00001675 CurrentCategory != Includes[Index].Category)
1676 result += "\n";
1677 }
Daniel Jasperb68aabf2015-11-23 08:36:35 +00001678 result += Includes[Index].Text;
Eric Liua992afe2016-08-10 09:32:23 +00001679 if (Cursor && CursorIndex == Index)
1680 *Cursor = IncludesBeginOffset + result.size() - CursorToEOLOffset;
Krasimir Georgiev4c2c9c32017-11-27 13:23:45 +00001681 CurrentCategory = Includes[Index].Category;
Daniel Jasperd89ae9d2015-09-23 08:30:47 +00001682 }
1683
Eric Liu40ef2fb2016-08-01 10:16:37 +00001684 auto Err = Replaces.add(tooling::Replacement(
Eric Liua992afe2016-08-10 09:32:23 +00001685 FileName, Includes.front().Offset, IncludesBlockSize, result));
Eric Liu40ef2fb2016-08-01 10:16:37 +00001686 // FIXME: better error handling. For now, just skip the replacement for the
1687 // release version.
Piotr Padlewski1ec383c2016-12-23 11:40:44 +00001688 if (Err) {
Eric Liu40ef2fb2016-08-01 10:16:37 +00001689 llvm::errs() << llvm::toString(std::move(Err)) << "\n";
Piotr Padlewski1ec383c2016-12-23 11:40:44 +00001690 assert(false);
1691 }
Daniel Jasperd89ae9d2015-09-23 08:30:47 +00001692}
1693
Eric Liu659afd52016-05-31 13:34:20 +00001694namespace {
1695
Eric Liu659afd52016-05-31 13:34:20 +00001696const char IncludeRegexPattern[] =
1697 R"(^[\t\ ]*#[\t\ ]*(import|include)[^"<]*(["<][^">]*[">]))";
1698
1699} // anonymous namespace
1700
Martin Probstc4a0dd42016-05-20 11:24:24 +00001701tooling::Replacements sortCppIncludes(const FormatStyle &Style, StringRef Code,
1702 ArrayRef<tooling::Range> Ranges,
1703 StringRef FileName,
1704 tooling::Replacements &Replaces,
1705 unsigned *Cursor) {
Daniel Jasperd89ae9d2015-09-23 08:30:47 +00001706 unsigned Prev = 0;
1707 unsigned SearchFrom = 0;
Eric Liu659afd52016-05-31 13:34:20 +00001708 llvm::Regex IncludeRegex(IncludeRegexPattern);
Daniel Jasperd89ae9d2015-09-23 08:30:47 +00001709 SmallVector<StringRef, 4> Matches;
1710 SmallVector<IncludeDirective, 16> IncludesInBlock;
Daniel Jasper85c472d2015-09-29 07:53:08 +00001711
1712 // In compiled files, consider the first #include to be the main #include of
1713 // the file if it is not a system #include. This ensures that the header
1714 // doesn't have hidden dependencies
1715 // (http://llvm.org/docs/CodingStandards.html#include-style).
1716 //
1717 // FIXME: Do some sanity checking, e.g. edit distance of the base name, to fix
1718 // cases where the first #include is unlikely to be the main header.
Eric Liu7129e632018-05-14 20:17:53 +00001719 tooling::IncludeCategoryManager Categories(Style.IncludeStyle, FileName);
Daniel Jasper32d75fa2015-12-21 13:40:49 +00001720 bool FirstIncludeBlock = true;
Daniel Jaspera252f5d2015-12-21 17:28:24 +00001721 bool MainIncludeFound = false;
Daniel Jasper9b8c7c72015-11-21 09:17:08 +00001722 bool FormattingOff = false;
1723
Daniel Jasperd89ae9d2015-09-23 08:30:47 +00001724 for (;;) {
1725 auto Pos = Code.find('\n', SearchFrom);
1726 StringRef Line =
1727 Code.substr(Prev, (Pos != StringRef::npos ? Pos : Code.size()) - Prev);
Daniel Jasper9b8c7c72015-11-21 09:17:08 +00001728
1729 StringRef Trimmed = Line.trim();
1730 if (Trimmed == "// clang-format off")
1731 FormattingOff = true;
1732 else if (Trimmed == "// clang-format on")
1733 FormattingOff = false;
1734
Krasimir Georgiev4c2c9c32017-11-27 13:23:45 +00001735 const bool EmptyLineSkipped =
Eric Liu9d92c022018-05-14 19:51:33 +00001736 Trimmed.empty() &&
1737 (Style.IncludeStyle.IncludeBlocks == tooling::IncludeStyle::IBS_Merge ||
1738 Style.IncludeStyle.IncludeBlocks ==
1739 tooling::IncludeStyle::IBS_Regroup);
Krasimir Georgiev4c2c9c32017-11-27 13:23:45 +00001740
Daniel Jasper9b8c7c72015-11-21 09:17:08 +00001741 if (!FormattingOff && !Line.endswith("\\")) {
Daniel Jasperd89ae9d2015-09-23 08:30:47 +00001742 if (IncludeRegex.match(Line, &Matches)) {
Nico Weberff063702015-10-21 17:13:45 +00001743 StringRef IncludeName = Matches[2];
Eric Liu659afd52016-05-31 13:34:20 +00001744 int Category = Categories.getIncludePriority(
1745 IncludeName,
1746 /*CheckMainHeader=*/!MainIncludeFound && FirstIncludeBlock);
1747 if (Category == 0)
1748 MainIncludeFound = true;
Nico Weberff063702015-10-21 17:13:45 +00001749 IncludesInBlock.push_back({IncludeName, Line, Prev, Category});
Krasimir Georgiev4c2c9c32017-11-27 13:23:45 +00001750 } else if (!IncludesInBlock.empty() && !EmptyLineSkipped) {
Martin Probstc4a0dd42016-05-20 11:24:24 +00001751 sortCppIncludes(Style, IncludesInBlock, Ranges, FileName, Replaces,
1752 Cursor);
Daniel Jasperd89ae9d2015-09-23 08:30:47 +00001753 IncludesInBlock.clear();
Daniel Jasper32d75fa2015-12-21 13:40:49 +00001754 FirstIncludeBlock = false;
Daniel Jasperd89ae9d2015-09-23 08:30:47 +00001755 }
1756 Prev = Pos + 1;
1757 }
1758 if (Pos == StringRef::npos || Pos + 1 == Code.size())
1759 break;
1760 SearchFrom = Pos + 1;
1761 }
1762 if (!IncludesInBlock.empty())
Martin Probstc4a0dd42016-05-20 11:24:24 +00001763 sortCppIncludes(Style, IncludesInBlock, Ranges, FileName, Replaces, Cursor);
1764 return Replaces;
1765}
1766
Martin Probstfa37b182017-01-27 09:09:11 +00001767bool isMpegTS(StringRef Code) {
1768 // MPEG transport streams use the ".ts" file extension. clang-format should
1769 // not attempt to format those. MPEG TS' frame format starts with 0x47 every
1770 // 189 bytes - detect that and return.
1771 return Code.size() > 188 && Code[0] == 0x47 && Code[188] == 0x47;
1772}
1773
Manuel Klimek89628f62017-09-20 09:51:03 +00001774bool isLikelyXml(StringRef Code) { return Code.ltrim().startswith("<"); }
Krasimir Georgieva2e7d0d2017-08-29 13:51:38 +00001775
Martin Probstc4a0dd42016-05-20 11:24:24 +00001776tooling::Replacements sortIncludes(const FormatStyle &Style, StringRef Code,
1777 ArrayRef<tooling::Range> Ranges,
1778 StringRef FileName, unsigned *Cursor) {
1779 tooling::Replacements Replaces;
1780 if (!Style.SortIncludes)
1781 return Replaces;
Krasimir Georgiev86873032017-08-29 13:57:31 +00001782 if (isLikelyXml(Code))
1783 return Replaces;
1784 if (Style.Language == FormatStyle::LanguageKind::LK_JavaScript &&
1785 isMpegTS(Code))
Martin Probstfa37b182017-01-27 09:09:11 +00001786 return Replaces;
Martin Probstc4a0dd42016-05-20 11:24:24 +00001787 if (Style.Language == FormatStyle::LanguageKind::LK_JavaScript)
1788 return sortJavaScriptImports(Style, Code, Ranges, FileName);
1789 sortCppIncludes(Style, Code, Ranges, FileName, Replaces, Cursor);
Daniel Jasperd89ae9d2015-09-23 08:30:47 +00001790 return Replaces;
1791}
1792
Eric Liu4cfb88a2016-04-25 15:09:22 +00001793template <typename T>
Eric Liu4f8d9942016-07-11 13:53:12 +00001794static llvm::Expected<tooling::Replacements>
Eric Liu4cfb88a2016-04-25 15:09:22 +00001795processReplacements(T ProcessFunc, StringRef Code,
1796 const tooling::Replacements &Replaces,
1797 const FormatStyle &Style) {
Manuel Klimekb12e5a52016-03-01 12:37:30 +00001798 if (Replaces.empty())
1799 return tooling::Replacements();
1800
Eric Liu4f8d9942016-07-11 13:53:12 +00001801 auto NewCode = applyAllReplacements(Code, Replaces);
1802 if (!NewCode)
1803 return NewCode.takeError();
Eric Liu40ef2fb2016-08-01 10:16:37 +00001804 std::vector<tooling::Range> ChangedRanges = Replaces.getAffectedRanges();
Manuel Klimekb12e5a52016-03-01 12:37:30 +00001805 StringRef FileName = Replaces.begin()->getFilePath();
Eric Liu4cfb88a2016-04-25 15:09:22 +00001806
Manuel Klimekb12e5a52016-03-01 12:37:30 +00001807 tooling::Replacements FormatReplaces =
Eric Liu4f8d9942016-07-11 13:53:12 +00001808 ProcessFunc(Style, *NewCode, ChangedRanges, FileName);
Manuel Klimekb12e5a52016-03-01 12:37:30 +00001809
Eric Liu40ef2fb2016-08-01 10:16:37 +00001810 return Replaces.merge(FormatReplaces);
Manuel Klimekb12e5a52016-03-01 12:37:30 +00001811}
1812
Eric Liu4f8d9942016-07-11 13:53:12 +00001813llvm::Expected<tooling::Replacements>
1814formatReplacements(StringRef Code, const tooling::Replacements &Replaces,
1815 const FormatStyle &Style) {
Eric Liu4cfb88a2016-04-25 15:09:22 +00001816 // We need to use lambda function here since there are two versions of
Eric Liubaf58c22016-05-18 13:43:48 +00001817 // `sortIncludes`.
1818 auto SortIncludes = [](const FormatStyle &Style, StringRef Code,
1819 std::vector<tooling::Range> Ranges,
1820 StringRef FileName) -> tooling::Replacements {
1821 return sortIncludes(Style, Code, Ranges, FileName);
1822 };
Eric Liu4f8d9942016-07-11 13:53:12 +00001823 auto SortedReplaces =
Eric Liubaf58c22016-05-18 13:43:48 +00001824 processReplacements(SortIncludes, Code, Replaces, Style);
Eric Liu4f8d9942016-07-11 13:53:12 +00001825 if (!SortedReplaces)
1826 return SortedReplaces.takeError();
Eric Liubaf58c22016-05-18 13:43:48 +00001827
1828 // We need to use lambda function here since there are two versions of
Eric Liu4cfb88a2016-04-25 15:09:22 +00001829 // `reformat`.
1830 auto Reformat = [](const FormatStyle &Style, StringRef Code,
1831 std::vector<tooling::Range> Ranges,
1832 StringRef FileName) -> tooling::Replacements {
1833 return reformat(Style, Code, Ranges, FileName);
1834 };
Eric Liu4f8d9942016-07-11 13:53:12 +00001835 return processReplacements(Reformat, Code, *SortedReplaces, Style);
Eric Liu4cfb88a2016-04-25 15:09:22 +00001836}
1837
Eric Liu659afd52016-05-31 13:34:20 +00001838namespace {
1839
1840inline bool isHeaderInsertion(const tooling::Replacement &Replace) {
Eric Liuc0d3a802016-09-23 15:10:56 +00001841 return Replace.getOffset() == UINT_MAX && Replace.getLength() == 0 &&
Eric Liu659afd52016-05-31 13:34:20 +00001842 llvm::Regex(IncludeRegexPattern).match(Replace.getReplacementText());
1843}
1844
Eric Liuc0d3a802016-09-23 15:10:56 +00001845inline bool isHeaderDeletion(const tooling::Replacement &Replace) {
1846 return Replace.getOffset() == UINT_MAX && Replace.getLength() == 1;
1847}
1848
Eric Liu659afd52016-05-31 13:34:20 +00001849// FIXME: insert empty lines between newly created blocks.
1850tooling::Replacements
1851fixCppIncludeInsertions(StringRef Code, const tooling::Replacements &Replaces,
1852 const FormatStyle &Style) {
Daniel Jasper1dbc2102017-03-31 13:30:24 +00001853 if (!Style.isCpp())
Eric Liu659afd52016-05-31 13:34:20 +00001854 return Replaces;
1855
1856 tooling::Replacements HeaderInsertions;
Eric Liuc0d3a802016-09-23 15:10:56 +00001857 std::set<llvm::StringRef> HeadersToDelete;
Eric Liu40ef2fb2016-08-01 10:16:37 +00001858 tooling::Replacements Result;
Eric Liu659afd52016-05-31 13:34:20 +00001859 for (const auto &R : Replaces) {
Eric Liu40ef2fb2016-08-01 10:16:37 +00001860 if (isHeaderInsertion(R)) {
1861 // Replacements from \p Replaces must be conflict-free already, so we can
1862 // simply consume the error.
1863 llvm::consumeError(HeaderInsertions.add(R));
Eric Liuc0d3a802016-09-23 15:10:56 +00001864 } else if (isHeaderDeletion(R)) {
1865 HeadersToDelete.insert(R.getReplacementText());
Eric Liu40ef2fb2016-08-01 10:16:37 +00001866 } else if (R.getOffset() == UINT_MAX) {
Eric Liu659afd52016-05-31 13:34:20 +00001867 llvm::errs() << "Insertions other than header #include insertion are "
1868 "not supported! "
1869 << R.getReplacementText() << "\n";
Eric Liu40ef2fb2016-08-01 10:16:37 +00001870 } else {
1871 llvm::consumeError(Result.add(R));
1872 }
Eric Liu659afd52016-05-31 13:34:20 +00001873 }
Eric Liuc0d3a802016-09-23 15:10:56 +00001874 if (HeaderInsertions.empty() && HeadersToDelete.empty())
Eric Liu659afd52016-05-31 13:34:20 +00001875 return Replaces;
Eric Liu659afd52016-05-31 13:34:20 +00001876
Eric Liu659afd52016-05-31 13:34:20 +00001877
1878 StringRef FileName = Replaces.begin()->getFilePath();
Eric Liu7129e632018-05-14 20:17:53 +00001879 tooling::HeaderIncludes Includes(FileName, Code, Style.IncludeStyle);
Eric Liu659afd52016-05-31 13:34:20 +00001880
Eric Liubf4c41c2018-05-04 17:55:13 +00001881 for (const auto &Header : HeadersToDelete) {
1882 tooling::Replacements Replaces =
Eric Liu7129e632018-05-14 20:17:53 +00001883 Includes.remove(Header.trim("\"<>"), Header.startswith("<"));
Eric Liubf4c41c2018-05-04 17:55:13 +00001884 for (const auto &R : Replaces) {
1885 auto Err = Result.add(R);
1886 if (Err) {
1887 // Ignore the deletion on conflict.
1888 llvm::errs() << "Failed to add header deletion replacement for "
1889 << Header << ": " << llvm::toString(std::move(Err))
1890 << "\n";
Eric Liuc0d3a802016-09-23 15:10:56 +00001891 }
Eric Liu659afd52016-05-31 13:34:20 +00001892 }
Eric Liu659afd52016-05-31 13:34:20 +00001893 }
1894
Eric Liubf4c41c2018-05-04 17:55:13 +00001895 llvm::Regex IncludeRegex = llvm::Regex(IncludeRegexPattern);
1896 llvm::SmallVector<StringRef, 4> Matches;
Eric Liu659afd52016-05-31 13:34:20 +00001897 for (const auto &R : HeaderInsertions) {
1898 auto IncludeDirective = R.getReplacementText();
1899 bool Matched = IncludeRegex.match(IncludeDirective, &Matches);
1900 assert(Matched && "Header insertion replacement must have replacement text "
1901 "'#include ...'");
Benjamin Kramer1cb7ee12016-05-31 14:14:42 +00001902 (void)Matched;
Eric Liu659afd52016-05-31 13:34:20 +00001903 auto IncludeName = Matches[2];
Eric Liubf4c41c2018-05-04 17:55:13 +00001904 auto Replace =
Eric Liu7129e632018-05-14 20:17:53 +00001905 Includes.insert(IncludeName.trim("\"<>"), IncludeName.startswith("<"));
Eric Liubf4c41c2018-05-04 17:55:13 +00001906 if (Replace) {
1907 auto Err = Result.add(*Replace);
1908 if (Err) {
1909 llvm::consumeError(std::move(Err));
1910 unsigned NewOffset = Result.getShiftedCodePosition(Replace->getOffset());
1911 auto Shifted = tooling::Replacement(FileName, NewOffset, 0,
1912 Replace->getReplacementText());
1913 Result = Result.merge(tooling::Replacements(Shifted));
1914 }
Eric Liu40ef2fb2016-08-01 10:16:37 +00001915 }
Eric Liu659afd52016-05-31 13:34:20 +00001916 }
1917 return Result;
1918}
1919
1920} // anonymous namespace
1921
Eric Liu4f8d9942016-07-11 13:53:12 +00001922llvm::Expected<tooling::Replacements>
Eric Liu4cfb88a2016-04-25 15:09:22 +00001923cleanupAroundReplacements(StringRef Code, const tooling::Replacements &Replaces,
1924 const FormatStyle &Style) {
1925 // We need to use lambda function here since there are two versions of
1926 // `cleanup`.
1927 auto Cleanup = [](const FormatStyle &Style, StringRef Code,
1928 std::vector<tooling::Range> Ranges,
1929 StringRef FileName) -> tooling::Replacements {
1930 return cleanup(Style, Code, Ranges, FileName);
1931 };
Eric Liu659afd52016-05-31 13:34:20 +00001932 // Make header insertion replacements insert new headers into correct blocks.
1933 tooling::Replacements NewReplaces =
1934 fixCppIncludeInsertions(Code, Replaces, Style);
1935 return processReplacements(Cleanup, Code, NewReplaces, Style);
Eric Liu4cfb88a2016-04-25 15:09:22 +00001936}
1937
Krasimir Georgiev9ad83fe2017-10-30 14:01:50 +00001938namespace internal {
1939std::pair<tooling::Replacements, unsigned>
1940reformat(const FormatStyle &Style, StringRef Code,
1941 ArrayRef<tooling::Range> Ranges, unsigned FirstStartColumn,
1942 unsigned NextStartColumn, unsigned LastStartColumn, StringRef FileName,
1943 FormattingAttemptStatus *Status) {
Eric Liu4cfb88a2016-04-25 15:09:22 +00001944 FormatStyle Expanded = expandPresets(Style);
1945 if (Expanded.DisableFormat)
Krasimir Georgiev9ad83fe2017-10-30 14:01:50 +00001946 return {tooling::Replacements(), 0};
Krasimir Georgiev86873032017-08-29 13:57:31 +00001947 if (isLikelyXml(Code))
Krasimir Georgiev9ad83fe2017-10-30 14:01:50 +00001948 return {tooling::Replacements(), 0};
Krasimir Georgiev86873032017-08-29 13:57:31 +00001949 if (Expanded.Language == FormatStyle::LK_JavaScript && isMpegTS(Code))
Krasimir Georgiev9ad83fe2017-10-30 14:01:50 +00001950 return {tooling::Replacements(), 0};
Daniel Jasper496c1992016-09-07 22:48:53 +00001951
Krasimir Georgiev9ad83fe2017-10-30 14:01:50 +00001952 typedef std::function<std::pair<tooling::Replacements, unsigned>(
1953 const Environment &)>
Krasimir Georgievac16a202017-06-23 11:46:03 +00001954 AnalyzerPass;
1955 SmallVector<AnalyzerPass, 4> Passes;
Krasimir Georgiev32eaa862017-03-01 15:35:39 +00001956
Krasimir Georgievac16a202017-06-23 11:46:03 +00001957 if (Style.Language == FormatStyle::LK_Cpp) {
1958 if (Style.FixNamespaceComments)
1959 Passes.emplace_back([&](const Environment &Env) {
1960 return NamespaceEndCommentsFixer(Env, Expanded).process();
1961 });
1962
1963 if (Style.SortUsingDeclarations)
1964 Passes.emplace_back([&](const Environment &Env) {
1965 return UsingDeclarationsSorter(Env, Expanded).process();
1966 });
Krasimir Georgiev32eaa862017-03-01 15:35:39 +00001967 }
1968
1969 if (Style.Language == FormatStyle::LK_JavaScript &&
Krasimir Georgievac16a202017-06-23 11:46:03 +00001970 Style.JavaScriptQuotes != FormatStyle::JSQS_Leave)
1971 Passes.emplace_back([&](const Environment &Env) {
1972 return JavaScriptRequoter(Env, Expanded).process();
1973 });
1974
1975 Passes.emplace_back([&](const Environment &Env) {
1976 return Formatter(Env, Expanded, Status).process();
1977 });
1978
Eric Liu2e538082018-05-09 21:35:52 +00001979 auto Env =
1980 llvm::make_unique<Environment>(Code, FileName, Ranges, FirstStartColumn,
1981 NextStartColumn, LastStartColumn);
Krasimir Georgievac16a202017-06-23 11:46:03 +00001982 llvm::Optional<std::string> CurrentCode = None;
1983 tooling::Replacements Fixes;
Krasimir Georgiev9ad83fe2017-10-30 14:01:50 +00001984 unsigned Penalty = 0;
Krasimir Georgievac16a202017-06-23 11:46:03 +00001985 for (size_t I = 0, E = Passes.size(); I < E; ++I) {
Krasimir Georgiev9ad83fe2017-10-30 14:01:50 +00001986 std::pair<tooling::Replacements, unsigned> PassFixes = Passes[I](*Env);
Krasimir Georgievac16a202017-06-23 11:46:03 +00001987 auto NewCode = applyAllReplacements(
Krasimir Georgiev9ad83fe2017-10-30 14:01:50 +00001988 CurrentCode ? StringRef(*CurrentCode) : Code, PassFixes.first);
Krasimir Georgievac16a202017-06-23 11:46:03 +00001989 if (NewCode) {
Krasimir Georgiev9ad83fe2017-10-30 14:01:50 +00001990 Fixes = Fixes.merge(PassFixes.first);
1991 Penalty += PassFixes.second;
Krasimir Georgievac16a202017-06-23 11:46:03 +00001992 if (I + 1 < E) {
1993 CurrentCode = std::move(*NewCode);
Eric Liu2e538082018-05-09 21:35:52 +00001994 Env = llvm::make_unique<Environment>(
Krasimir Georgievac16a202017-06-23 11:46:03 +00001995 *CurrentCode, FileName,
Krasimir Georgiev9ad83fe2017-10-30 14:01:50 +00001996 tooling::calculateRangesAfterReplacements(Fixes, Ranges),
1997 FirstStartColumn, NextStartColumn, LastStartColumn);
Krasimir Georgievac16a202017-06-23 11:46:03 +00001998 }
1999 }
Daniel Jasper496c1992016-09-07 22:48:53 +00002000 }
2001
Krasimir Georgiev9ad83fe2017-10-30 14:01:50 +00002002 return {Fixes, Penalty};
2003}
2004} // namespace internal
2005
2006tooling::Replacements reformat(const FormatStyle &Style, StringRef Code,
2007 ArrayRef<tooling::Range> Ranges,
2008 StringRef FileName,
2009 FormattingAttemptStatus *Status) {
2010 return internal::reformat(Style, Code, Ranges,
2011 /*FirstStartColumn=*/0,
2012 /*NextStartColumn=*/0,
2013 /*LastStartColumn=*/0, FileName, Status)
2014 .first;
Eric Liu4cfb88a2016-04-25 15:09:22 +00002015}
2016
Eric Liu4cfb88a2016-04-25 15:09:22 +00002017tooling::Replacements cleanup(const FormatStyle &Style, StringRef Code,
2018 ArrayRef<tooling::Range> Ranges,
2019 StringRef FileName) {
Martin Probst816a9662017-05-29 08:41:11 +00002020 // cleanups only apply to C++ (they mostly concern ctor commas etc.)
2021 if (Style.Language != FormatStyle::LK_Cpp)
2022 return tooling::Replacements();
Eric Liu2e538082018-05-09 21:35:52 +00002023 return Cleaner(Environment(Code, FileName, Ranges), Style).process().first;
Daniel Jasperec04c0d2013-05-16 10:40:07 +00002024}
2025
Krasimir Georgievbcda54b2017-04-21 14:35:20 +00002026tooling::Replacements reformat(const FormatStyle &Style, StringRef Code,
2027 ArrayRef<tooling::Range> Ranges,
2028 StringRef FileName, bool *IncompleteFormat) {
2029 FormattingAttemptStatus Status;
2030 auto Result = reformat(Style, Code, Ranges, FileName, &Status);
2031 if (!Status.FormatComplete)
2032 *IncompleteFormat = true;
2033 return Result;
2034}
2035
Krasimir Georgiev7cb267a2017-02-27 13:28:36 +00002036tooling::Replacements fixNamespaceEndComments(const FormatStyle &Style,
2037 StringRef Code,
2038 ArrayRef<tooling::Range> Ranges,
2039 StringRef FileName) {
Eric Liu2e538082018-05-09 21:35:52 +00002040 return NamespaceEndCommentsFixer(Environment(Code, FileName, Ranges), Style)
2041 .process()
2042 .first;
Krasimir Georgiev7cb267a2017-02-27 13:28:36 +00002043}
2044
Krasimir Georgievb03877a2017-06-21 12:03:12 +00002045tooling::Replacements sortUsingDeclarations(const FormatStyle &Style,
2046 StringRef Code,
2047 ArrayRef<tooling::Range> Ranges,
2048 StringRef FileName) {
Eric Liu2e538082018-05-09 21:35:52 +00002049 return UsingDeclarationsSorter(Environment(Code, FileName, Ranges), Style)
2050 .process()
2051 .first;
Krasimir Georgievb03877a2017-06-21 12:03:12 +00002052}
2053
Daniel Jasper4db69bd2014-09-04 18:23:42 +00002054LangOptions getFormattingLangOpts(const FormatStyle &Style) {
Daniel Jasperc1fa2812013-01-10 13:08:12 +00002055 LangOptions LangOpts;
2056 LangOpts.CPlusPlus = 1;
Daniel Jasper4db69bd2014-09-04 18:23:42 +00002057 LangOpts.CPlusPlus11 = Style.Standard == FormatStyle::LS_Cpp03 ? 0 : 1;
2058 LangOpts.CPlusPlus14 = Style.Standard == FormatStyle::LS_Cpp03 ? 0 : 1;
Aaron Ballmanc351fba2017-12-04 20:27:34 +00002059 LangOpts.CPlusPlus17 = Style.Standard == FormatStyle::LS_Cpp03 ? 0 : 1;
Richard Smithc70f1d62017-12-14 15:16:18 +00002060 LangOpts.CPlusPlus2a = Style.Standard == FormatStyle::LS_Cpp03 ? 0 : 1;
Daniel Jasper55213652013-03-22 10:01:29 +00002061 LangOpts.LineComment = 1;
Daniel Jasper1dbc2102017-03-31 13:30:24 +00002062 bool AlternativeOperators = Style.isCpp();
Daniel Jasper30a24062014-11-14 09:02:28 +00002063 LangOpts.CXXOperatorNames = AlternativeOperators ? 1 : 0;
Daniel Jasperc1fa2812013-01-10 13:08:12 +00002064 LangOpts.Bool = 1;
2065 LangOpts.ObjC1 = 1;
2066 LangOpts.ObjC2 = 1;
Eric Liu4cfb88a2016-04-25 15:09:22 +00002067 LangOpts.MicrosoftExt = 1; // To get kw___try, kw___finally.
Saleem Abdulrasoold170c4b2015-10-04 17:51:05 +00002068 LangOpts.DeclSpecKeyword = 1; // To get __declspec.
Daniel Jasperc1fa2812013-01-10 13:08:12 +00002069 return LangOpts;
2070}
2071
Edwin Vaned544aa72013-09-30 13:31:48 +00002072const char *StyleOptionHelpDescription =
2073 "Coding style, currently supports:\n"
2074 " LLVM, Google, Chromium, Mozilla, WebKit.\n"
2075 "Use -style=file to load style configuration from\n"
2076 ".clang-format file located in one of the parent\n"
2077 "directories of the source file (or current\n"
2078 "directory for stdin).\n"
2079 "Use -style=\"{key: value, ...}\" to set specific\n"
2080 "parameters, e.g.:\n"
2081 " -style=\"{BasedOnStyle: llvm, IndentWidth: 8}\"";
2082
Alexander Kornienkoc1637f12013-12-10 11:28:13 +00002083static FormatStyle::LanguageKind getLanguageByFileName(StringRef FileName) {
Daniel Jasper498f5582015-12-25 08:53:31 +00002084 if (FileName.endswith(".java"))
Daniel Jasperc58c70e2014-09-15 11:21:46 +00002085 return FormatStyle::LK_Java;
Daniel Jasper498f5582015-12-25 08:53:31 +00002086 if (FileName.endswith_lower(".js") || FileName.endswith_lower(".ts"))
2087 return FormatStyle::LK_JavaScript; // JavaScript or TypeScript.
Daniel Jasper03a04fe2016-12-12 12:42:29 +00002088 if (FileName.endswith(".m") || FileName.endswith(".mm"))
2089 return FormatStyle::LK_ObjC;
Daniel Jasper498f5582015-12-25 08:53:31 +00002090 if (FileName.endswith_lower(".proto") ||
2091 FileName.endswith_lower(".protodevel"))
Daniel Jasper7052ce62014-01-19 09:04:08 +00002092 return FormatStyle::LK_Proto;
Krasimir Georgiev66496652017-11-17 15:10:49 +00002093 if (FileName.endswith_lower(".textpb") ||
2094 FileName.endswith_lower(".pb.txt") ||
2095 FileName.endswith_lower(".textproto") ||
2096 FileName.endswith_lower(".asciipb"))
2097 return FormatStyle::LK_TextProto;
Daniel Jasper498f5582015-12-25 08:53:31 +00002098 if (FileName.endswith_lower(".td"))
2099 return FormatStyle::LK_TableGen;
Alexander Kornienkoc1637f12013-12-10 11:28:13 +00002100 return FormatStyle::LK_Cpp;
Alexander Kornienkocabdd732013-11-29 15:19:43 +00002101}
2102
Ben Hamilton3b345c32018-02-21 15:54:31 +00002103FormatStyle::LanguageKind guessLanguage(StringRef FileName, StringRef Code) {
Ben Hamilton6e066352018-02-27 15:56:40 +00002104 const auto GuessedLanguage = getLanguageByFileName(FileName);
2105 if (GuessedLanguage == FormatStyle::LK_Cpp) {
Ben Hamilton07e58362018-02-21 21:27:27 +00002106 auto Extension = llvm::sys::path::extension(FileName);
Ben Hamilton3b345c32018-02-21 15:54:31 +00002107 // If there's no file extension (or it's .h), we need to check the contents
2108 // of the code to see if it contains Objective-C.
Ben Hamilton07e58362018-02-21 21:27:27 +00002109 if (Extension.empty() || Extension == ".h") {
2110 auto NonEmptyFileName = FileName.empty() ? "guess.h" : FileName;
Eric Liu2e538082018-05-09 21:35:52 +00002111 Environment Env(Code, NonEmptyFileName, /*Ranges=*/{});
2112 ObjCHeaderStyleGuesser Guesser(Env, getLLVMStyle());
Ben Hamilton3b345c32018-02-21 15:54:31 +00002113 Guesser.process();
Ben Hamilton6e066352018-02-27 15:56:40 +00002114 if (Guesser.isObjC())
2115 return FormatStyle::LK_ObjC;
Ben Hamilton3b345c32018-02-21 15:54:31 +00002116 }
2117 }
Ben Hamilton6e066352018-02-27 15:56:40 +00002118 return GuessedLanguage;
Ben Hamilton3b345c32018-02-21 15:54:31 +00002119}
2120
Antonio Maiorano3adfb6a2017-01-17 00:12:27 +00002121llvm::Expected<FormatStyle> getStyle(StringRef StyleName, StringRef FileName,
Antonio Maiorano7eb75072017-01-20 01:22:42 +00002122 StringRef FallbackStyleName,
2123 StringRef Code, vfs::FileSystem *FS) {
Eric Liu547d8792016-03-24 13:22:42 +00002124 if (!FS) {
2125 FS = vfs::getRealFileSystem().get();
2126 }
Alexander Kornienkoc1637f12013-12-10 11:28:13 +00002127 FormatStyle Style = getLLVMStyle();
Ben Hamilton3b345c32018-02-21 15:54:31 +00002128 Style.Language = guessLanguage(FileName, Code);
Daniel Jasper03a04fe2016-12-12 12:42:29 +00002129
Antonio Maiorano7eb75072017-01-20 01:22:42 +00002130 FormatStyle FallbackStyle = getNoStyle();
2131 if (!getPredefinedStyle(FallbackStyleName, Style.Language, &FallbackStyle))
2132 return make_string_error("Invalid fallback style \"" + FallbackStyleName);
Edwin Vaned544aa72013-09-30 13:31:48 +00002133
2134 if (StyleName.startswith("{")) {
2135 // Parse YAML/JSON style from the command line.
Antonio Maiorano3adfb6a2017-01-17 00:12:27 +00002136 if (std::error_code ec = parseConfiguration(StyleName, &Style))
2137 return make_string_error("Error parsing -style: " + ec.message());
Edwin Vaned544aa72013-09-30 13:31:48 +00002138 return Style;
2139 }
2140
2141 if (!StyleName.equals_lower("file")) {
Alexander Kornienkoc1637f12013-12-10 11:28:13 +00002142 if (!getPredefinedStyle(StyleName, Style.Language, &Style))
Antonio Maiorano3adfb6a2017-01-17 00:12:27 +00002143 return make_string_error("Invalid value for -style");
Edwin Vaned544aa72013-09-30 13:31:48 +00002144 return Style;
2145 }
2146
Alexander Kornienkoc1637f12013-12-10 11:28:13 +00002147 // Look for .clang-format/_clang-format file in the file's parent directories.
Alexander Kornienkocabdd732013-11-29 15:19:43 +00002148 SmallString<128> UnsuitableConfigFiles;
Edwin Vaned544aa72013-09-30 13:31:48 +00002149 SmallString<128> Path(FileName);
Antonio Maiorano3adfb6a2017-01-17 00:12:27 +00002150 if (std::error_code EC = FS->makeAbsolute(Path))
2151 return make_string_error(EC.message());
Antonio Maiorano34c03762016-12-22 05:10:07 +00002152
Alexander Kornienkoe2e03872013-10-14 00:46:35 +00002153 for (StringRef Directory = Path; !Directory.empty();
Edwin Vaned544aa72013-09-30 13:31:48 +00002154 Directory = llvm::sys::path::parent_path(Directory)) {
Eric Liu547d8792016-03-24 13:22:42 +00002155
2156 auto Status = FS->status(Directory);
2157 if (!Status ||
2158 Status->getType() != llvm::sys::fs::file_type::directory_file) {
Edwin Vaned544aa72013-09-30 13:31:48 +00002159 continue;
Eric Liu547d8792016-03-24 13:22:42 +00002160 }
2161
Edwin Vaned544aa72013-09-30 13:31:48 +00002162 SmallString<128> ConfigFile(Directory);
2163
2164 llvm::sys::path::append(ConfigFile, ".clang-format");
Nicola Zaghen3538b392018-05-15 13:30:56 +00002165 LLVM_DEBUG(llvm::dbgs() << "Trying " << ConfigFile << "...\n");
Eric Liud4758322016-03-24 13:22:37 +00002166
Eric Liu547d8792016-03-24 13:22:42 +00002167 Status = FS->status(ConfigFile.str());
Antonio Maiorano3adfb6a2017-01-17 00:12:27 +00002168 bool FoundConfigFile =
Eric Liu547d8792016-03-24 13:22:42 +00002169 Status && (Status->getType() == llvm::sys::fs::file_type::regular_file);
Antonio Maiorano3adfb6a2017-01-17 00:12:27 +00002170 if (!FoundConfigFile) {
Edwin Vaned544aa72013-09-30 13:31:48 +00002171 // Try _clang-format too, since dotfiles are not commonly used on Windows.
2172 ConfigFile = Directory;
2173 llvm::sys::path::append(ConfigFile, "_clang-format");
Nicola Zaghen3538b392018-05-15 13:30:56 +00002174 LLVM_DEBUG(llvm::dbgs() << "Trying " << ConfigFile << "...\n");
Eric Liu547d8792016-03-24 13:22:42 +00002175 Status = FS->status(ConfigFile.str());
Antonio Maiorano3adfb6a2017-01-17 00:12:27 +00002176 FoundConfigFile = Status && (Status->getType() ==
2177 llvm::sys::fs::file_type::regular_file);
Edwin Vaned544aa72013-09-30 13:31:48 +00002178 }
2179
Antonio Maiorano3adfb6a2017-01-17 00:12:27 +00002180 if (FoundConfigFile) {
Rafael Espindola2d2b4202014-07-06 17:43:24 +00002181 llvm::ErrorOr<std::unique_ptr<llvm::MemoryBuffer>> Text =
Eric Liu547d8792016-03-24 13:22:42 +00002182 FS->getBufferForFile(ConfigFile.str());
Antonio Maiorano3adfb6a2017-01-17 00:12:27 +00002183 if (std::error_code EC = Text.getError())
2184 return make_string_error(EC.message());
Rafael Espindola2d2b4202014-07-06 17:43:24 +00002185 if (std::error_code ec =
2186 parseConfiguration(Text.get()->getBuffer(), &Style)) {
Rafael Espindolad0136702014-06-12 02:50:04 +00002187 if (ec == ParseError::Unsuitable) {
Alexander Kornienkocabdd732013-11-29 15:19:43 +00002188 if (!UnsuitableConfigFiles.empty())
2189 UnsuitableConfigFiles.append(", ");
2190 UnsuitableConfigFiles.append(ConfigFile);
Alexander Kornienkobc4ae442013-12-02 15:21:38 +00002191 continue;
Alexander Kornienkocabdd732013-11-29 15:19:43 +00002192 }
Antonio Maiorano3adfb6a2017-01-17 00:12:27 +00002193 return make_string_error("Error reading " + ConfigFile + ": " +
2194 ec.message());
Edwin Vaned544aa72013-09-30 13:31:48 +00002195 }
Nicola Zaghen3538b392018-05-15 13:30:56 +00002196 LLVM_DEBUG(llvm::dbgs()
2197 << "Using configuration file " << ConfigFile << "\n");
Edwin Vaned544aa72013-09-30 13:31:48 +00002198 return Style;
2199 }
2200 }
Antonio Maiorano3adfb6a2017-01-17 00:12:27 +00002201 if (!UnsuitableConfigFiles.empty())
2202 return make_string_error("Configuration file(s) do(es) not support " +
2203 getLanguageName(Style.Language) + ": " +
2204 UnsuitableConfigFiles);
Antonio Maiorano7eb75072017-01-20 01:22:42 +00002205 return FallbackStyle;
Edwin Vaned544aa72013-09-30 13:31:48 +00002206}
2207
Daniel Jasper8d1832e2013-01-07 13:26:07 +00002208} // namespace format
2209} // namespace clang