blob: 31442b5124d40ac96f32a27d32bd1553e959eb9d [file] [log] [blame]
Daniel Jasperf7935112012-12-03 18:12:45 +00001//===--- Format.cpp - Format C++ code -------------------------------------===//
2//
Chandler Carruth2946cd72019-01-19 08:50:56 +00003// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
Daniel Jasperf7935112012-12-03 18:12:45 +00006//
7//===----------------------------------------------------------------------===//
8///
9/// \file
Adrian Prantl9fc8faf2018-05-09 01:00:01 +000010/// This file implements functions declared in Format.h. This will be
Daniel Jasperf7935112012-12-03 18:12:45 +000011/// split into separate files as we go.
12///
Daniel Jasperf7935112012-12-03 18:12:45 +000013//===----------------------------------------------------------------------===//
14
Daniel Jasper85c472d2015-09-29 07:53:08 +000015#include "clang/Format/Format.h"
Eric Liu4cfb88a2016-04-25 15:09:22 +000016#include "AffectedRangeManager.h"
Daniel Jasperde0328a2013-08-16 11:20:30 +000017#include "ContinuationIndenter.h"
Krasimir Georgiev9ad83fe2017-10-30 14:01:50 +000018#include "FormatInternal.h"
Martin Probstc4a0dd42016-05-20 11:24:24 +000019#include "FormatTokenLexer.h"
Krasimir Georgiev7cb267a2017-02-27 13:28:36 +000020#include "NamespaceEndCommentsFixer.h"
Martin Probstc4a0dd42016-05-20 11:24:24 +000021#include "SortJavaScriptImports.h"
22#include "TokenAnalyzer.h"
Daniel Jasper7a6d09b2013-01-29 21:01:14 +000023#include "TokenAnnotator.h"
Daniel Jasper0df50932014-12-10 19:00:42 +000024#include "UnwrappedLineFormatter.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000025#include "UnwrappedLineParser.h"
Krasimir Georgievb03877a2017-06-21 12:03:12 +000026#include "UsingDeclarationsSorter.h"
Alexander Kornienkocb45bc12013-04-15 14:28:00 +000027#include "WhitespaceManager.h"
Daniel Jasperec04c0d2013-05-16 10:40:07 +000028#include "clang/Basic/Diagnostic.h"
Benjamin Kramerf3ca26982014-05-10 16:31:55 +000029#include "clang/Basic/DiagnosticOptions.h"
Chandler Carruth44eb4f62013-01-02 10:28:36 +000030#include "clang/Basic/SourceManager.h"
Daniel Jasperf7935112012-12-03 18:12:45 +000031#include "clang/Lex/Lexer.h"
Eric Liu44564ac2018-06-04 09:04:12 +000032#include "clang/Tooling/Inclusions/HeaderIncludes.h"
Alexander Kornienkoffd6d042013-03-27 11:52:18 +000033#include "llvm/ADT/STLExtras.h"
Ben Hamiltone2e3e672018-01-17 17:33:08 +000034#include "llvm/ADT/StringRef.h"
Manuel Klimek2ef908e2013-02-13 10:46:36 +000035#include "llvm/Support/Allocator.h"
Manuel Klimek24998102013-01-16 14:55:28 +000036#include "llvm/Support/Debug.h"
Edwin Vaned544aa72013-09-30 13:31:48 +000037#include "llvm/Support/Path.h"
Birunthan Mohanathasb001a0b2015-07-03 17:25:16 +000038#include "llvm/Support/Regex.h"
Jonas Devliegherefc514902018-10-10 13:27:25 +000039#include "llvm/Support/VirtualFileSystem.h"
Chandler Carruth5553d0d2014-01-07 11:51:46 +000040#include "llvm/Support/YAMLTraits.h"
Martin Probst081f1762016-06-01 15:19:53 +000041#include <algorithm>
Eric Liu4cfb88a2016-04-25 15:09:22 +000042#include <memory>
Eric Liubf4c41c2018-05-04 17:55:13 +000043#include <mutex>
Daniel Jasper8b529712012-12-04 13:02:32 +000044#include <string>
Eric Liubf4c41c2018-05-04 17:55:13 +000045#include <unordered_map>
Daniel Jasper8b529712012-12-04 13:02:32 +000046
Chandler Carruth10346662014-04-22 03:17:02 +000047#define DEBUG_TYPE "format-formatter"
48
Alexander Kornienko6d2c88e2013-12-10 10:30:34 +000049using clang::format::FormatStyle;
50
NAKAMURA Takumi057a9422017-11-01 04:43:22 +000051LLVM_YAML_IS_SEQUENCE_VECTOR(clang::format::FormatStyle::RawStringFormat)
Daniel Jaspere1e43192014-04-01 12:55:11 +000052
Alexander Kornienkod6538332013-05-07 15:32:14 +000053namespace llvm {
54namespace yaml {
Alexander Kornienko6d2c88e2013-12-10 10:30:34 +000055template <> struct ScalarEnumerationTraits<FormatStyle::LanguageKind> {
56 static void enumeration(IO &IO, FormatStyle::LanguageKind &Value) {
57 IO.enumCase(Value, "Cpp", FormatStyle::LK_Cpp);
Daniel Jasperc58c70e2014-09-15 11:21:46 +000058 IO.enumCase(Value, "Java", FormatStyle::LK_Java);
Alexander Kornienko6d2c88e2013-12-10 10:30:34 +000059 IO.enumCase(Value, "JavaScript", FormatStyle::LK_JavaScript);
Daniel Jasper03a04fe2016-12-12 12:42:29 +000060 IO.enumCase(Value, "ObjC", FormatStyle::LK_ObjC);
Daniel Jasper7052ce62014-01-19 09:04:08 +000061 IO.enumCase(Value, "Proto", FormatStyle::LK_Proto);
Daniel Jasper498f5582015-12-25 08:53:31 +000062 IO.enumCase(Value, "TableGen", FormatStyle::LK_TableGen);
Krasimir Georgiev26b144c2017-07-03 15:05:14 +000063 IO.enumCase(Value, "TextProto", FormatStyle::LK_TextProto);
Paul Hoadcbb726d2019-03-21 13:09:22 +000064 IO.enumCase(Value, "CSharp", FormatStyle::LK_CSharp);
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
Paul Hoad15000a12019-03-13 08:26:39 +0000110template <> struct ScalarEnumerationTraits<FormatStyle::ShortIfStyle> {
111 static void enumeration(IO &IO, FormatStyle::ShortIfStyle &Value) {
112 IO.enumCase(Value, "Never", FormatStyle::SIS_Never);
113 IO.enumCase(Value, "Always", FormatStyle::SIS_Always);
114 IO.enumCase(Value, "WithoutElse", FormatStyle::SIS_WithoutElse);
115
116 // For backward compatibility.
117 IO.enumCase(Value, "false", FormatStyle::SIS_Never);
118 IO.enumCase(Value, "true", FormatStyle::SIS_WithoutElse);
119 }
120};
121
Ronald Wamplera83e2db2019-03-26 20:18:14 +0000122template <> struct ScalarEnumerationTraits<FormatStyle::ShortLambdaStyle> {
123 static void enumeration(IO &IO, FormatStyle::ShortLambdaStyle &Value) {
124 IO.enumCase(Value, "None", FormatStyle::SLS_None);
125 IO.enumCase(Value, "false", FormatStyle::SLS_None);
126 IO.enumCase(Value, "Empty", FormatStyle::SLS_Empty);
127 IO.enumCase(Value, "Inline", FormatStyle::SLS_Inline);
128 IO.enumCase(Value, "All", FormatStyle::SLS_All);
129 IO.enumCase(Value, "true", FormatStyle::SLS_All);
130 }
131};
132
Ben Hamilton4dc658c2018-02-02 20:15:14 +0000133template <> struct ScalarEnumerationTraits<FormatStyle::BinPackStyle> {
134 static void enumeration(IO &IO, FormatStyle::BinPackStyle &Value) {
135 IO.enumCase(Value, "Auto", FormatStyle::BPS_Auto);
136 IO.enumCase(Value, "Always", FormatStyle::BPS_Always);
137 IO.enumCase(Value, "Never", FormatStyle::BPS_Never);
138 }
139};
140
Daniel Jasperac043c92014-09-15 11:11:00 +0000141template <> struct ScalarEnumerationTraits<FormatStyle::BinaryOperatorStyle> {
142 static void enumeration(IO &IO, FormatStyle::BinaryOperatorStyle &Value) {
143 IO.enumCase(Value, "All", FormatStyle::BOS_All);
144 IO.enumCase(Value, "true", FormatStyle::BOS_All);
145 IO.enumCase(Value, "None", FormatStyle::BOS_None);
146 IO.enumCase(Value, "false", FormatStyle::BOS_None);
147 IO.enumCase(Value, "NonAssignment", FormatStyle::BOS_NonAssignment);
148 }
149};
150
Alexander Kornienko6d2c88e2013-12-10 10:30:34 +0000151template <> struct ScalarEnumerationTraits<FormatStyle::BraceBreakingStyle> {
152 static void enumeration(IO &IO, FormatStyle::BraceBreakingStyle &Value) {
153 IO.enumCase(Value, "Attach", FormatStyle::BS_Attach);
154 IO.enumCase(Value, "Linux", FormatStyle::BS_Linux);
Birunthan Mohanathas305fa9c2015-07-12 03:13:54 +0000155 IO.enumCase(Value, "Mozilla", FormatStyle::BS_Mozilla);
Alexander Kornienko6d2c88e2013-12-10 10:30:34 +0000156 IO.enumCase(Value, "Stroustrup", FormatStyle::BS_Stroustrup);
157 IO.enumCase(Value, "Allman", FormatStyle::BS_Allman);
Alexander Kornienko3a33f022013-12-12 09:49:52 +0000158 IO.enumCase(Value, "GNU", FormatStyle::BS_GNU);
Roman Kashitsyn291f64f2015-08-10 13:43:19 +0000159 IO.enumCase(Value, "WebKit", FormatStyle::BS_WebKit);
Daniel Jasperc1bc38e2015-09-29 14:57:55 +0000160 IO.enumCase(Value, "Custom", FormatStyle::BS_Custom);
Alexander Kornienko6d2c88e2013-12-10 10:30:34 +0000161 }
162};
163
Manuel Klimek89628f62017-09-20 09:51:03 +0000164template <>
165struct ScalarEnumerationTraits<FormatStyle::BreakConstructorInitializersStyle> {
166 static void
167 enumeration(IO &IO, FormatStyle::BreakConstructorInitializersStyle &Value) {
Francois Ferranda6b6d512017-05-24 11:36:58 +0000168 IO.enumCase(Value, "BeforeColon", FormatStyle::BCIS_BeforeColon);
169 IO.enumCase(Value, "BeforeComma", FormatStyle::BCIS_BeforeComma);
170 IO.enumCase(Value, "AfterColon", FormatStyle::BCIS_AfterColon);
171 }
172};
173
Daniel Jasperc1bc38e2015-09-29 14:57:55 +0000174template <>
Francois Ferrand6bb103f2018-06-11 14:41:26 +0000175struct ScalarEnumerationTraits<FormatStyle::BreakInheritanceListStyle> {
Paul Hoad5bcf99b2019-03-01 09:09:54 +0000176 static void enumeration(IO &IO,
177 FormatStyle::BreakInheritanceListStyle &Value) {
Francois Ferrand6bb103f2018-06-11 14:41:26 +0000178 IO.enumCase(Value, "BeforeColon", FormatStyle::BILS_BeforeColon);
179 IO.enumCase(Value, "BeforeComma", FormatStyle::BILS_BeforeComma);
180 IO.enumCase(Value, "AfterColon", FormatStyle::BILS_AfterColon);
181 }
182};
183
184template <>
Krasimir Georgievad47c902017-08-30 14:34:57 +0000185struct ScalarEnumerationTraits<FormatStyle::PPDirectiveIndentStyle> {
186 static void enumeration(IO &IO, FormatStyle::PPDirectiveIndentStyle &Value) {
187 IO.enumCase(Value, "None", FormatStyle::PPDIS_None);
188 IO.enumCase(Value, "AfterHash", FormatStyle::PPDIS_AfterHash);
Paul Hoad701a0d72019-03-20 20:49:43 +0000189 IO.enumCase(Value, "BeforeHash", FormatStyle::PPDIS_BeforeHash);
Krasimir Georgievad47c902017-08-30 14:34:57 +0000190 }
191};
192
193template <>
Zachary Turner448592e2015-12-18 22:20:15 +0000194struct ScalarEnumerationTraits<FormatStyle::ReturnTypeBreakingStyle> {
195 static void enumeration(IO &IO, FormatStyle::ReturnTypeBreakingStyle &Value) {
196 IO.enumCase(Value, "None", FormatStyle::RTBS_None);
197 IO.enumCase(Value, "All", FormatStyle::RTBS_All);
198 IO.enumCase(Value, "TopLevel", FormatStyle::RTBS_TopLevel);
199 IO.enumCase(Value, "TopLevelDefinitions",
200 FormatStyle::RTBS_TopLevelDefinitions);
201 IO.enumCase(Value, "AllDefinitions", FormatStyle::RTBS_AllDefinitions);
202 }
203};
204
205template <>
Francois Ferrand58e6fe52018-05-16 08:25:03 +0000206struct ScalarEnumerationTraits<FormatStyle::BreakTemplateDeclarationsStyle> {
Paul Hoad5bcf99b2019-03-01 09:09:54 +0000207 static void enumeration(IO &IO,
208 FormatStyle::BreakTemplateDeclarationsStyle &Value) {
Francois Ferrand58e6fe52018-05-16 08:25:03 +0000209 IO.enumCase(Value, "No", FormatStyle::BTDS_No);
210 IO.enumCase(Value, "MultiLine", FormatStyle::BTDS_MultiLine);
211 IO.enumCase(Value, "Yes", FormatStyle::BTDS_Yes);
212
213 // For backward compatibility.
214 IO.enumCase(Value, "false", FormatStyle::BTDS_MultiLine);
215 IO.enumCase(Value, "true", FormatStyle::BTDS_Yes);
216 }
217};
218
219template <>
Daniel Jasperc1bc38e2015-09-29 14:57:55 +0000220struct ScalarEnumerationTraits<FormatStyle::DefinitionReturnTypeBreakingStyle> {
221 static void
222 enumeration(IO &IO, FormatStyle::DefinitionReturnTypeBreakingStyle &Value) {
Birunthan Mohanathasa0388a82015-06-29 15:30:42 +0000223 IO.enumCase(Value, "None", FormatStyle::DRTBS_None);
224 IO.enumCase(Value, "All", FormatStyle::DRTBS_All);
225 IO.enumCase(Value, "TopLevel", FormatStyle::DRTBS_TopLevel);
226
227 // For backward compatibility.
228 IO.enumCase(Value, "false", FormatStyle::DRTBS_None);
229 IO.enumCase(Value, "true", FormatStyle::DRTBS_All);
230 }
231};
232
Alexander Kornienkod6538332013-05-07 15:32:14 +0000233template <>
Alexander Kornienko6d2c88e2013-12-10 10:30:34 +0000234struct ScalarEnumerationTraits<FormatStyle::NamespaceIndentationKind> {
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000235 static void enumeration(IO &IO,
Alexander Kornienko6d2c88e2013-12-10 10:30:34 +0000236 FormatStyle::NamespaceIndentationKind &Value) {
237 IO.enumCase(Value, "None", FormatStyle::NI_None);
238 IO.enumCase(Value, "Inner", FormatStyle::NI_Inner);
239 IO.enumCase(Value, "All", FormatStyle::NI_All);
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000240 }
241};
242
Daniel Jasper6501f7e2015-10-27 12:38:37 +0000243template <> struct ScalarEnumerationTraits<FormatStyle::BracketAlignmentStyle> {
244 static void enumeration(IO &IO, FormatStyle::BracketAlignmentStyle &Value) {
245 IO.enumCase(Value, "Align", FormatStyle::BAS_Align);
246 IO.enumCase(Value, "DontAlign", FormatStyle::BAS_DontAlign);
247 IO.enumCase(Value, "AlwaysBreak", FormatStyle::BAS_AlwaysBreak);
248
249 // For backward compatibility.
250 IO.enumCase(Value, "true", FormatStyle::BAS_Align);
251 IO.enumCase(Value, "false", FormatStyle::BAS_DontAlign);
252 }
253};
254
Manuel Klimek89628f62017-09-20 09:51:03 +0000255template <>
256struct ScalarEnumerationTraits<FormatStyle::EscapedNewlineAlignmentStyle> {
257 static void enumeration(IO &IO,
258 FormatStyle::EscapedNewlineAlignmentStyle &Value) {
Daniel Jasper7fdbb3f2017-05-08 15:08:00 +0000259 IO.enumCase(Value, "DontAlign", FormatStyle::ENAS_DontAlign);
260 IO.enumCase(Value, "Left", FormatStyle::ENAS_Left);
261 IO.enumCase(Value, "Right", FormatStyle::ENAS_Right);
262
263 // For backward compatibility.
264 IO.enumCase(Value, "true", FormatStyle::ENAS_Left);
265 IO.enumCase(Value, "false", FormatStyle::ENAS_Right);
266 }
267};
268
Jacques Pienaarfc275112015-02-18 23:48:37 +0000269template <> struct ScalarEnumerationTraits<FormatStyle::PointerAlignmentStyle> {
270 static void enumeration(IO &IO, FormatStyle::PointerAlignmentStyle &Value) {
Daniel Jasper553d4872014-06-17 12:40:34 +0000271 IO.enumCase(Value, "Middle", FormatStyle::PAS_Middle);
272 IO.enumCase(Value, "Left", FormatStyle::PAS_Left);
273 IO.enumCase(Value, "Right", FormatStyle::PAS_Right);
274
Alp Toker958027b2014-07-14 19:42:55 +0000275 // For backward compatibility.
Daniel Jasper553d4872014-06-17 12:40:34 +0000276 IO.enumCase(Value, "true", FormatStyle::PAS_Left);
277 IO.enumCase(Value, "false", FormatStyle::PAS_Right);
278 }
279};
280
281template <>
Alexander Kornienko6d2c88e2013-12-10 10:30:34 +0000282struct ScalarEnumerationTraits<FormatStyle::SpaceBeforeParensOptions> {
Manuel Klimeka8eb9142013-05-13 12:51:40 +0000283 static void enumeration(IO &IO,
Alexander Kornienko6d2c88e2013-12-10 10:30:34 +0000284 FormatStyle::SpaceBeforeParensOptions &Value) {
285 IO.enumCase(Value, "Never", FormatStyle::SBPO_Never);
Alexander Kornienkofdca83d2013-12-10 10:18:34 +0000286 IO.enumCase(Value, "ControlStatements",
Alexander Kornienko6d2c88e2013-12-10 10:30:34 +0000287 FormatStyle::SBPO_ControlStatements);
Reuben Thomas08a940d2019-03-30 12:32:35 +0000288 IO.enumCase(Value, "NonEmptyParentheses",
289 FormatStyle::SBPO_NonEmptyParentheses);
Alexander Kornienko6d2c88e2013-12-10 10:30:34 +0000290 IO.enumCase(Value, "Always", FormatStyle::SBPO_Always);
Alexander Kornienkofdca83d2013-12-10 10:18:34 +0000291
292 // For backward compatibility.
Alexander Kornienko6d2c88e2013-12-10 10:30:34 +0000293 IO.enumCase(Value, "false", FormatStyle::SBPO_Never);
294 IO.enumCase(Value, "true", FormatStyle::SBPO_ControlStatements);
Alexander Kornienkofdca83d2013-12-10 10:18:34 +0000295 }
296};
297
Alexander Kornienko6d2c88e2013-12-10 10:30:34 +0000298template <> struct MappingTraits<FormatStyle> {
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000299 static void mapping(IO &IO, FormatStyle &Style) {
300 // When reading, read the language first, we need it for getPredefinedStyle.
301 IO.mapOptional("Language", Style.Language);
302
Alexander Kornienko49149672013-05-10 11:56:10 +0000303 if (IO.outputting()) {
Paul Hoadcbb726d2019-03-21 13:09:22 +0000304 StringRef StylesArray[] = {"LLVM", "Google", "Chromium", "Mozilla",
305 "WebKit", "GNU", "Microsoft"};
Alexander Kornienko49149672013-05-10 11:56:10 +0000306 ArrayRef<StringRef> Styles(StylesArray);
307 for (size_t i = 0, e = Styles.size(); i < e; ++i) {
308 StringRef StyleName(Styles[i]);
Alexander Kornienko6d2c88e2013-12-10 10:30:34 +0000309 FormatStyle PredefinedStyle;
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000310 if (getPredefinedStyle(StyleName, Style.Language, &PredefinedStyle) &&
Alexander Kornienko006b5c82013-05-19 00:53:30 +0000311 Style == PredefinedStyle) {
Alexander Kornienko49149672013-05-10 11:56:10 +0000312 IO.mapOptional("# BasedOnStyle", StyleName);
313 break;
314 }
315 }
316 } else {
Alexander Kornienkod6538332013-05-07 15:32:14 +0000317 StringRef BasedOnStyle;
318 IO.mapOptional("BasedOnStyle", BasedOnStyle);
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000319 if (!BasedOnStyle.empty()) {
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000320 FormatStyle::LanguageKind OldLanguage = Style.Language;
321 FormatStyle::LanguageKind Language =
322 ((FormatStyle *)IO.getContext())->Language;
323 if (!getPredefinedStyle(BasedOnStyle, Language, &Style)) {
Alexander Kornienko006b5c82013-05-19 00:53:30 +0000324 IO.setError(Twine("Unknown value for BasedOnStyle: ", BasedOnStyle));
325 return;
326 }
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000327 Style.Language = OldLanguage;
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000328 }
Alexander Kornienkod6538332013-05-07 15:32:14 +0000329 }
330
Birunthan Mohanathas50a6f912015-06-28 14:52:34 +0000331 // For backward compatibility.
332 if (!IO.outputting()) {
Daniel Jasper7fdbb3f2017-05-08 15:08:00 +0000333 IO.mapOptional("AlignEscapedNewlinesLeft", Style.AlignEscapedNewlines);
Birunthan Mohanathas50a6f912015-06-28 14:52:34 +0000334 IO.mapOptional("DerivePointerBinding", Style.DerivePointerAlignment);
335 IO.mapOptional("IndentFunctionDeclarationAfterType",
336 Style.IndentWrappedFunctionNames);
337 IO.mapOptional("PointerBindsToType", Style.PointerAlignment);
338 IO.mapOptional("SpaceAfterControlStatementKeyword",
339 Style.SpaceBeforeParens);
340 }
341
Alexander Kornienkod6538332013-05-07 15:32:14 +0000342 IO.mapOptional("AccessModifierOffset", Style.AccessModifierOffset);
Daniel Jasper3aa9a6a2014-11-18 23:55:27 +0000343 IO.mapOptional("AlignAfterOpenBracket", Style.AlignAfterOpenBracket);
Birunthan Mohanathas35cfbd72015-06-28 14:51:17 +0000344 IO.mapOptional("AlignConsecutiveAssignments",
345 Style.AlignConsecutiveAssignments);
Daniel Jaspere12597c2015-10-01 10:06:54 +0000346 IO.mapOptional("AlignConsecutiveDeclarations",
347 Style.AlignConsecutiveDeclarations);
Daniel Jasper7fdbb3f2017-05-08 15:08:00 +0000348 IO.mapOptional("AlignEscapedNewlines", Style.AlignEscapedNewlines);
Daniel Jasper3219e432014-12-02 13:24:51 +0000349 IO.mapOptional("AlignOperands", Style.AlignOperands);
Daniel Jasper552f4a72013-07-31 23:55:15 +0000350 IO.mapOptional("AlignTrailingComments", Style.AlignTrailingComments);
Paul Hoadc6deae42019-03-23 14:37:58 +0000351 IO.mapOptional("AllowAllArgumentsOnNextLine",
352 Style.AllowAllArgumentsOnNextLine);
353 IO.mapOptional("AllowAllConstructorInitializersOnNextLine",
354 Style.AllowAllConstructorInitializersOnNextLine);
Alexander Kornienkod6538332013-05-07 15:32:14 +0000355 IO.mapOptional("AllowAllParametersOfDeclarationOnNextLine",
356 Style.AllowAllParametersOfDeclarationOnNextLine);
Daniel Jasper17605d32014-05-14 09:33:35 +0000357 IO.mapOptional("AllowShortBlocksOnASingleLine",
358 Style.AllowShortBlocksOnASingleLine);
Daniel Jasperb87899b2014-09-10 13:11:45 +0000359 IO.mapOptional("AllowShortCaseLabelsOnASingleLine",
360 Style.AllowShortCaseLabelsOnASingleLine);
Birunthan Mohanathas35cfbd72015-06-28 14:51:17 +0000361 IO.mapOptional("AllowShortFunctionsOnASingleLine",
362 Style.AllowShortFunctionsOnASingleLine);
Ronald Wamplera83e2db2019-03-26 20:18:14 +0000363 IO.mapOptional("AllowShortLambdasOnASingleLine",
364 Style.AllowShortLambdasOnASingleLine);
Alexander Kornienkod6538332013-05-07 15:32:14 +0000365 IO.mapOptional("AllowShortIfStatementsOnASingleLine",
366 Style.AllowShortIfStatementsOnASingleLine);
Daniel Jasper3a685df2013-05-16 12:12:21 +0000367 IO.mapOptional("AllowShortLoopsOnASingleLine",
368 Style.AllowShortLoopsOnASingleLine);
Daniel Jasperca4ea1c2014-08-05 12:16:31 +0000369 IO.mapOptional("AlwaysBreakAfterDefinitionReturnType",
370 Style.AlwaysBreakAfterDefinitionReturnType);
Zachary Turner448592e2015-12-18 22:20:15 +0000371 IO.mapOptional("AlwaysBreakAfterReturnType",
372 Style.AlwaysBreakAfterReturnType);
Paul Hoadc6deae42019-03-23 14:37:58 +0000373
Zachary Turner448592e2015-12-18 22:20:15 +0000374 // If AlwaysBreakAfterDefinitionReturnType was specified but
375 // AlwaysBreakAfterReturnType was not, initialize the latter from the
376 // former for backwards compatibility.
377 if (Style.AlwaysBreakAfterDefinitionReturnType != FormatStyle::DRTBS_None &&
378 Style.AlwaysBreakAfterReturnType == FormatStyle::RTBS_None) {
379 if (Style.AlwaysBreakAfterDefinitionReturnType == FormatStyle::DRTBS_All)
380 Style.AlwaysBreakAfterReturnType = FormatStyle::RTBS_AllDefinitions;
381 else if (Style.AlwaysBreakAfterDefinitionReturnType ==
382 FormatStyle::DRTBS_TopLevel)
383 Style.AlwaysBreakAfterReturnType =
384 FormatStyle::RTBS_TopLevelDefinitions;
385 }
386
Alexander Kornienko58611712013-07-04 12:02:44 +0000387 IO.mapOptional("AlwaysBreakBeforeMultilineStrings",
388 Style.AlwaysBreakBeforeMultilineStrings);
Birunthan Mohanathas35cfbd72015-06-28 14:51:17 +0000389 IO.mapOptional("AlwaysBreakTemplateDeclarations",
390 Style.AlwaysBreakTemplateDeclarations);
391 IO.mapOptional("BinPackArguments", Style.BinPackArguments);
392 IO.mapOptional("BinPackParameters", Style.BinPackParameters);
Daniel Jasperc1bc38e2015-09-29 14:57:55 +0000393 IO.mapOptional("BraceWrapping", Style.BraceWrapping);
Daniel Jaspere33d4af2013-07-26 16:56:36 +0000394 IO.mapOptional("BreakBeforeBinaryOperators",
395 Style.BreakBeforeBinaryOperators);
Birunthan Mohanathas35cfbd72015-06-28 14:51:17 +0000396 IO.mapOptional("BreakBeforeBraces", Style.BreakBeforeBraces);
Francois Ferrand6bb103f2018-06-11 14:41:26 +0000397
398 bool BreakBeforeInheritanceComma = false;
Paul Hoad5bcf99b2019-03-01 09:09:54 +0000399 IO.mapOptional("BreakBeforeInheritanceComma", BreakBeforeInheritanceComma);
400 IO.mapOptional("BreakInheritanceList", Style.BreakInheritanceList);
Francois Ferrand6bb103f2018-06-11 14:41:26 +0000401 // If BreakBeforeInheritanceComma was specified but
402 // BreakInheritance was not, initialize the latter from the
403 // former for backwards compatibility.
404 if (BreakBeforeInheritanceComma &&
405 Style.BreakInheritanceList == FormatStyle::BILS_BeforeColon)
406 Style.BreakInheritanceList = FormatStyle::BILS_BeforeComma;
407
Daniel Jasper165b29e2013-11-08 00:57:11 +0000408 IO.mapOptional("BreakBeforeTernaryOperators",
409 Style.BreakBeforeTernaryOperators);
Francois Ferranda6b6d512017-05-24 11:36:58 +0000410
411 bool BreakConstructorInitializersBeforeComma = false;
Daniel Jaspere33d4af2013-07-26 16:56:36 +0000412 IO.mapOptional("BreakConstructorInitializersBeforeComma",
Francois Ferranda6b6d512017-05-24 11:36:58 +0000413 BreakConstructorInitializersBeforeComma);
414 IO.mapOptional("BreakConstructorInitializers",
415 Style.BreakConstructorInitializers);
416 // If BreakConstructorInitializersBeforeComma was specified but
417 // BreakConstructorInitializers was not, initialize the latter from the
418 // former for backwards compatibility.
419 if (BreakConstructorInitializersBeforeComma &&
420 Style.BreakConstructorInitializers == FormatStyle::BCIS_BeforeColon)
421 Style.BreakConstructorInitializers = FormatStyle::BCIS_BeforeComma;
422
Daniel Jaspere1a7b762016-02-01 11:21:02 +0000423 IO.mapOptional("BreakAfterJavaFieldAnnotations",
424 Style.BreakAfterJavaFieldAnnotations);
425 IO.mapOptional("BreakStringLiterals", Style.BreakStringLiterals);
Alexander Kornienkod6538332013-05-07 15:32:14 +0000426 IO.mapOptional("ColumnLimit", Style.ColumnLimit);
Birunthan Mohanathas35cfbd72015-06-28 14:51:17 +0000427 IO.mapOptional("CommentPragmas", Style.CommentPragmas);
Francois Ferrande56a8292017-06-14 12:29:47 +0000428 IO.mapOptional("CompactNamespaces", Style.CompactNamespaces);
Alexander Kornienkod6538332013-05-07 15:32:14 +0000429 IO.mapOptional("ConstructorInitializerAllOnOneLineOrOnePerLine",
430 Style.ConstructorInitializerAllOnOneLineOrOnePerLine);
Daniel Jasper50d634b2014-10-28 16:53:38 +0000431 IO.mapOptional("ConstructorInitializerIndentWidth",
432 Style.ConstructorInitializerIndentWidth);
Birunthan Mohanathas35cfbd72015-06-28 14:51:17 +0000433 IO.mapOptional("ContinuationIndentWidth", Style.ContinuationIndentWidth);
434 IO.mapOptional("Cpp11BracedListStyle", Style.Cpp11BracedListStyle);
Daniel Jasper553d4872014-06-17 12:40:34 +0000435 IO.mapOptional("DerivePointerAlignment", Style.DerivePointerAlignment);
Birunthan Mohanathas35cfbd72015-06-28 14:51:17 +0000436 IO.mapOptional("DisableFormat", Style.DisableFormat);
Daniel Jasperb10cbc42013-07-10 14:02:49 +0000437 IO.mapOptional("ExperimentalAutoDetectBinPacking",
438 Style.ExperimentalAutoDetectBinPacking);
Krasimir Georgiev32eaa862017-03-01 15:35:39 +0000439 IO.mapOptional("FixNamespaceComments", Style.FixNamespaceComments);
Birunthan Mohanathas35cfbd72015-06-28 14:51:17 +0000440 IO.mapOptional("ForEachMacros", Style.ForEachMacros);
Eric Liu9d92c022018-05-14 19:51:33 +0000441 IO.mapOptional("IncludeBlocks", Style.IncludeStyle.IncludeBlocks);
442 IO.mapOptional("IncludeCategories", Style.IncludeStyle.IncludeCategories);
443 IO.mapOptional("IncludeIsMainRegex", Style.IncludeStyle.IncludeIsMainRegex);
Alexander Kornienkod6538332013-05-07 15:32:14 +0000444 IO.mapOptional("IndentCaseLabels", Style.IndentCaseLabels);
Krasimir Georgievad47c902017-08-30 14:34:57 +0000445 IO.mapOptional("IndentPPDirectives", Style.IndentPPDirectives);
Birunthan Mohanathas35cfbd72015-06-28 14:51:17 +0000446 IO.mapOptional("IndentWidth", Style.IndentWidth);
447 IO.mapOptional("IndentWrappedFunctionNames",
448 Style.IndentWrappedFunctionNames);
Krasimir Georgiev7e91b032018-10-05 17:19:26 +0000449 IO.mapOptional("JavaImportGroups", Style.JavaImportGroups);
Martin Probst0cd74ee2016-06-13 16:39:50 +0000450 IO.mapOptional("JavaScriptQuotes", Style.JavaScriptQuotes);
451 IO.mapOptional("JavaScriptWrapImports", Style.JavaScriptWrapImports);
Daniel Jaspera26fc5c2014-03-21 13:43:14 +0000452 IO.mapOptional("KeepEmptyLinesAtTheStartOfBlocks",
453 Style.KeepEmptyLinesAtTheStartOfBlocks);
Birunthan Mohanathasb001a0b2015-07-03 17:25:16 +0000454 IO.mapOptional("MacroBlockBegin", Style.MacroBlockBegin);
455 IO.mapOptional("MacroBlockEnd", Style.MacroBlockEnd);
Birunthan Mohanathas35cfbd72015-06-28 14:51:17 +0000456 IO.mapOptional("MaxEmptyLinesToKeep", Style.MaxEmptyLinesToKeep);
Daniel Jasper65ee3472013-07-31 23:16:02 +0000457 IO.mapOptional("NamespaceIndentation", Style.NamespaceIndentation);
Francois Ferrande8a301f2019-06-06 20:06:23 +0000458 IO.mapOptional("NamespaceMacros", Style.NamespaceMacros);
Ben Hamilton4dc658c2018-02-02 20:15:14 +0000459 IO.mapOptional("ObjCBinPackProtocolList", Style.ObjCBinPackProtocolList);
Daniel Jasper50d634b2014-10-28 16:53:38 +0000460 IO.mapOptional("ObjCBlockIndentWidth", Style.ObjCBlockIndentWidth);
Daniel Jaspere9beea22014-01-28 15:20:33 +0000461 IO.mapOptional("ObjCSpaceAfterProperty", Style.ObjCSpaceAfterProperty);
Alexander Kornienkod6538332013-05-07 15:32:14 +0000462 IO.mapOptional("ObjCSpaceBeforeProtocolList",
463 Style.ObjCSpaceBeforeProtocolList);
Manuel Klimek89628f62017-09-20 09:51:03 +0000464 IO.mapOptional("PenaltyBreakAssignment", Style.PenaltyBreakAssignment);
Daniel Jasper33b909c2013-10-25 14:29:37 +0000465 IO.mapOptional("PenaltyBreakBeforeFirstCallParameter",
466 Style.PenaltyBreakBeforeFirstCallParameter);
Alexander Kornienkodd7ece52013-06-07 16:02:52 +0000467 IO.mapOptional("PenaltyBreakComment", Style.PenaltyBreakComment);
Daniel Jasper4e9678f2013-07-11 20:41:21 +0000468 IO.mapOptional("PenaltyBreakFirstLessLess",
469 Style.PenaltyBreakFirstLessLess);
Birunthan Mohanathas35cfbd72015-06-28 14:51:17 +0000470 IO.mapOptional("PenaltyBreakString", Style.PenaltyBreakString);
Francois Ferrand58e6fe52018-05-16 08:25:03 +0000471 IO.mapOptional("PenaltyBreakTemplateDeclaration",
472 Style.PenaltyBreakTemplateDeclaration);
Alexander Kornienkod6538332013-05-07 15:32:14 +0000473 IO.mapOptional("PenaltyExcessCharacter", Style.PenaltyExcessCharacter);
474 IO.mapOptional("PenaltyReturnTypeOnItsOwnLine",
475 Style.PenaltyReturnTypeOnItsOwnLine);
Daniel Jasper553d4872014-06-17 12:40:34 +0000476 IO.mapOptional("PointerAlignment", Style.PointerAlignment);
Krasimir Georgiev9ad83fe2017-10-30 14:01:50 +0000477 IO.mapOptional("RawStringFormats", Style.RawStringFormats);
Daniel Jaspera0a50392015-12-01 13:28:53 +0000478 IO.mapOptional("ReflowComments", Style.ReflowComments);
479 IO.mapOptional("SortIncludes", Style.SortIncludes);
Krasimir Georgievac16a202017-06-23 11:46:03 +0000480 IO.mapOptional("SortUsingDeclarations", Style.SortUsingDeclarations);
Daniel Jasperdb986eb2014-09-03 07:37:29 +0000481 IO.mapOptional("SpaceAfterCStyleCast", Style.SpaceAfterCStyleCast);
Reuben Thomas91f60b42019-04-08 12:54:48 +0000482 IO.mapOptional("SpaceAfterLogicalNot", Style.SpaceAfterLogicalNot);
Manuel Klimek89628f62017-09-20 09:51:03 +0000483 IO.mapOptional("SpaceAfterTemplateKeyword",
484 Style.SpaceAfterTemplateKeyword);
Daniel Jasperd94bff32013-09-25 15:15:02 +0000485 IO.mapOptional("SpaceBeforeAssignmentOperators",
486 Style.SpaceBeforeAssignmentOperators);
Hans Wennborgbfc34062018-06-14 08:01:09 +0000487 IO.mapOptional("SpaceBeforeCpp11BracedList",
488 Style.SpaceBeforeCpp11BracedList);
Francois Ferrand2a9ea782018-03-01 10:09:13 +0000489 IO.mapOptional("SpaceBeforeCtorInitializerColon",
490 Style.SpaceBeforeCtorInitializerColon);
491 IO.mapOptional("SpaceBeforeInheritanceColon",
492 Style.SpaceBeforeInheritanceColon);
Birunthan Mohanathas35cfbd72015-06-28 14:51:17 +0000493 IO.mapOptional("SpaceBeforeParens", Style.SpaceBeforeParens);
Francois Ferrand2a9ea782018-03-01 10:09:13 +0000494 IO.mapOptional("SpaceBeforeRangeBasedForLoopColon",
495 Style.SpaceBeforeRangeBasedForLoopColon);
Birunthan Mohanathas35cfbd72015-06-28 14:51:17 +0000496 IO.mapOptional("SpaceInEmptyParentheses", Style.SpaceInEmptyParentheses);
497 IO.mapOptional("SpacesBeforeTrailingComments",
498 Style.SpacesBeforeTrailingComments);
499 IO.mapOptional("SpacesInAngles", Style.SpacesInAngles);
500 IO.mapOptional("SpacesInContainerLiterals",
501 Style.SpacesInContainerLiterals);
502 IO.mapOptional("SpacesInCStyleCastParentheses",
503 Style.SpacesInCStyleCastParentheses);
504 IO.mapOptional("SpacesInParentheses", Style.SpacesInParentheses);
505 IO.mapOptional("SpacesInSquareBrackets", Style.SpacesInSquareBrackets);
506 IO.mapOptional("Standard", Style.Standard);
Francois Ferrand6f40e212018-10-02 16:37:51 +0000507 IO.mapOptional("StatementMacros", Style.StatementMacros);
Birunthan Mohanathas35cfbd72015-06-28 14:51:17 +0000508 IO.mapOptional("TabWidth", Style.TabWidth);
Francois Ferrandc5227a12019-05-29 16:30:47 +0000509 IO.mapOptional("TypenameMacros", Style.TypenameMacros);
Birunthan Mohanathas35cfbd72015-06-28 14:51:17 +0000510 IO.mapOptional("UseTab", Style.UseTab);
Alexander Kornienkod6538332013-05-07 15:32:14 +0000511 }
512};
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000513
Daniel Jasperc1bc38e2015-09-29 14:57:55 +0000514template <> struct MappingTraits<FormatStyle::BraceWrappingFlags> {
515 static void mapping(IO &IO, FormatStyle::BraceWrappingFlags &Wrapping) {
Owen Pan806d5742019-04-08 23:36:25 +0000516 IO.mapOptional("AfterCaseLabel", Wrapping.AfterCaseLabel);
Daniel Jasperc1bc38e2015-09-29 14:57:55 +0000517 IO.mapOptional("AfterClass", Wrapping.AfterClass);
518 IO.mapOptional("AfterControlStatement", Wrapping.AfterControlStatement);
519 IO.mapOptional("AfterEnum", Wrapping.AfterEnum);
520 IO.mapOptional("AfterFunction", Wrapping.AfterFunction);
521 IO.mapOptional("AfterNamespace", Wrapping.AfterNamespace);
522 IO.mapOptional("AfterObjCDeclaration", Wrapping.AfterObjCDeclaration);
523 IO.mapOptional("AfterStruct", Wrapping.AfterStruct);
524 IO.mapOptional("AfterUnion", Wrapping.AfterUnion);
Krasimir Georgievd6ce9372017-09-15 11:23:50 +0000525 IO.mapOptional("AfterExternBlock", Wrapping.AfterExternBlock);
Daniel Jasperc1bc38e2015-09-29 14:57:55 +0000526 IO.mapOptional("BeforeCatch", Wrapping.BeforeCatch);
527 IO.mapOptional("BeforeElse", Wrapping.BeforeElse);
528 IO.mapOptional("IndentBraces", Wrapping.IndentBraces);
Francois Ferrandad722562017-06-30 20:25:55 +0000529 IO.mapOptional("SplitEmptyFunction", Wrapping.SplitEmptyFunction);
530 IO.mapOptional("SplitEmptyRecord", Wrapping.SplitEmptyRecord);
531 IO.mapOptional("SplitEmptyNamespace", Wrapping.SplitEmptyNamespace);
Daniel Jasperc1bc38e2015-09-29 14:57:55 +0000532 }
533};
534
Krasimir Georgiev9ad83fe2017-10-30 14:01:50 +0000535template <> struct MappingTraits<FormatStyle::RawStringFormat> {
536 static void mapping(IO &IO, FormatStyle::RawStringFormat &Format) {
Krasimir Georgiev9ad83fe2017-10-30 14:01:50 +0000537 IO.mapOptional("Language", Format.Language);
Krasimir Georgiev4527f132018-01-17 12:24:59 +0000538 IO.mapOptional("Delimiters", Format.Delimiters);
Krasimir Georgiev2537e222018-01-17 16:17:26 +0000539 IO.mapOptional("EnclosingFunctions", Format.EnclosingFunctions);
Krasimir Georgiev412ed092018-01-19 16:18:47 +0000540 IO.mapOptional("CanonicalDelimiter", Format.CanonicalDelimiter);
Krasimir Georgiev9ad83fe2017-10-30 14:01:50 +0000541 IO.mapOptional("BasedOnStyle", Format.BasedOnStyle);
542 }
543};
544
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000545// Allows to read vector<FormatStyle> while keeping default values.
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000546// IO.getContext() should contain a pointer to the FormatStyle structure, that
547// will be used to get default values for missing keys.
548// If the first element has no Language specified, it will be treated as the
549// default one for the following elements.
Jacques Pienaarfc275112015-02-18 23:48:37 +0000550template <> struct DocumentListTraits<std::vector<FormatStyle>> {
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000551 static size_t size(IO &IO, std::vector<FormatStyle> &Seq) {
552 return Seq.size();
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000553 }
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000554 static FormatStyle &element(IO &IO, std::vector<FormatStyle> &Seq,
Alexander Kornienko6d2c88e2013-12-10 10:30:34 +0000555 size_t Index) {
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000556 if (Index >= Seq.size()) {
557 assert(Index == Seq.size());
Alexander Kornienko6d2c88e2013-12-10 10:30:34 +0000558 FormatStyle Template;
Krasimir Georgiev1696bb62017-11-09 15:12:17 +0000559 if (!Seq.empty() && Seq[0].Language == FormatStyle::LK_None) {
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000560 Template = Seq[0];
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000561 } else {
Daniel Jasperb05a81d2014-05-09 13:11:16 +0000562 Template = *((const FormatStyle *)IO.getContext());
Alexander Kornienko6d2c88e2013-12-10 10:30:34 +0000563 Template.Language = FormatStyle::LK_None;
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000564 }
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000565 Seq.resize(Index + 1, Template);
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000566 }
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000567 return Seq[Index];
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000568 }
569};
Daniel Jasperd89ae9d2015-09-23 08:30:47 +0000570} // namespace yaml
571} // namespace llvm
Alexander Kornienkod6538332013-05-07 15:32:14 +0000572
Daniel Jasperf7935112012-12-03 18:12:45 +0000573namespace clang {
574namespace format {
575
Rafael Espindola6d0d89b2014-06-12 03:31:26 +0000576const std::error_category &getParseCategory() {
Benjamin Kramerf76861c2018-03-20 21:52:19 +0000577 static const ParseErrorCategory C{};
Rafael Espindolad0136702014-06-12 02:50:04 +0000578 return C;
579}
580std::error_code make_error_code(ParseError e) {
Rafael Espindola6d0d89b2014-06-12 03:31:26 +0000581 return std::error_code(static_cast<int>(e), getParseCategory());
Rafael Espindolad0136702014-06-12 02:50:04 +0000582}
583
Antonio Maiorano3adfb6a2017-01-17 00:12:27 +0000584inline llvm::Error make_string_error(const llvm::Twine &Message) {
585 return llvm::make_error<llvm::StringError>(Message,
586 llvm::inconvertibleErrorCode());
587}
588
Reid Kleckner6432d452016-10-19 23:39:55 +0000589const char *ParseErrorCategory::name() const noexcept {
Rafael Espindolad0136702014-06-12 02:50:04 +0000590 return "clang-format.parse_error";
591}
592
593std::string ParseErrorCategory::message(int EV) const {
594 switch (static_cast<ParseError>(EV)) {
595 case ParseError::Success:
596 return "Success";
597 case ParseError::Error:
598 return "Invalid argument";
599 case ParseError::Unsuitable:
600 return "Unsuitable";
601 }
Saleem Abdulrasoolfbfbaf62014-06-12 19:33:26 +0000602 llvm_unreachable("unexpected parse error");
Rafael Espindolad0136702014-06-12 02:50:04 +0000603}
604
Daniel Jasperc1bc38e2015-09-29 14:57:55 +0000605static FormatStyle expandPresets(const FormatStyle &Style) {
Daniel Jasper55bbe662015-10-07 04:06:10 +0000606 if (Style.BreakBeforeBraces == FormatStyle::BS_Custom)
607 return Style;
Daniel Jasperc1bc38e2015-09-29 14:57:55 +0000608 FormatStyle Expanded = Style;
Owen Pan806d5742019-04-08 23:36:25 +0000609 Expanded.BraceWrapping = {false, false, false, false, false, false,
Manuel Klimek89628f62017-09-20 09:51:03 +0000610 false, false, false, false, false,
611 false, false, true, true, true};
Daniel Jasperc1bc38e2015-09-29 14:57:55 +0000612 switch (Style.BreakBeforeBraces) {
613 case FormatStyle::BS_Linux:
614 Expanded.BraceWrapping.AfterClass = true;
615 Expanded.BraceWrapping.AfterFunction = true;
616 Expanded.BraceWrapping.AfterNamespace = true;
Daniel Jasperc1bc38e2015-09-29 14:57:55 +0000617 break;
618 case FormatStyle::BS_Mozilla:
619 Expanded.BraceWrapping.AfterClass = true;
620 Expanded.BraceWrapping.AfterEnum = true;
621 Expanded.BraceWrapping.AfterFunction = true;
622 Expanded.BraceWrapping.AfterStruct = true;
623 Expanded.BraceWrapping.AfterUnion = true;
Krasimir Georgievd6ce9372017-09-15 11:23:50 +0000624 Expanded.BraceWrapping.AfterExternBlock = true;
Sylvestre Ledru82c9a0e2017-09-13 20:03:29 +0000625 Expanded.BraceWrapping.SplitEmptyFunction = true;
Francois Ferrandad722562017-06-30 20:25:55 +0000626 Expanded.BraceWrapping.SplitEmptyRecord = false;
Daniel Jasperc1bc38e2015-09-29 14:57:55 +0000627 break;
628 case FormatStyle::BS_Stroustrup:
629 Expanded.BraceWrapping.AfterFunction = true;
630 Expanded.BraceWrapping.BeforeCatch = true;
631 Expanded.BraceWrapping.BeforeElse = true;
632 break;
633 case FormatStyle::BS_Allman:
Owen Pan806d5742019-04-08 23:36:25 +0000634 Expanded.BraceWrapping.AfterCaseLabel = true;
Daniel Jasperc1bc38e2015-09-29 14:57:55 +0000635 Expanded.BraceWrapping.AfterClass = true;
636 Expanded.BraceWrapping.AfterControlStatement = true;
637 Expanded.BraceWrapping.AfterEnum = true;
638 Expanded.BraceWrapping.AfterFunction = true;
639 Expanded.BraceWrapping.AfterNamespace = true;
640 Expanded.BraceWrapping.AfterObjCDeclaration = true;
641 Expanded.BraceWrapping.AfterStruct = true;
Krasimir Georgievd6ce9372017-09-15 11:23:50 +0000642 Expanded.BraceWrapping.AfterExternBlock = true;
Daniel Jasperc1bc38e2015-09-29 14:57:55 +0000643 Expanded.BraceWrapping.BeforeCatch = true;
644 Expanded.BraceWrapping.BeforeElse = true;
645 break;
646 case FormatStyle::BS_GNU:
Manuel Klimek89628f62017-09-20 09:51:03 +0000647 Expanded.BraceWrapping = {true, true, true, true, true, true, true, true,
Owen Pan806d5742019-04-08 23:36:25 +0000648 true, true, true, true, true, true, true, true};
Daniel Jasperc1bc38e2015-09-29 14:57:55 +0000649 break;
650 case FormatStyle::BS_WebKit:
651 Expanded.BraceWrapping.AfterFunction = true;
652 break;
653 default:
654 break;
655 }
656 return Expanded;
657}
658
Jordan Rupprecht8bd97e72019-02-28 19:16:45 +0000659FormatStyle getLLVMStyle(FormatStyle::LanguageKind Language) {
Daniel Jasperf7935112012-12-03 18:12:45 +0000660 FormatStyle LLVMStyle;
Jordan Rupprecht8bd97e72019-02-28 19:16:45 +0000661 LLVMStyle.Language = Language;
Daniel Jasperf7935112012-12-03 18:12:45 +0000662 LLVMStyle.AccessModifierOffset = -2;
Daniel Jasper7fdbb3f2017-05-08 15:08:00 +0000663 LLVMStyle.AlignEscapedNewlines = FormatStyle::ENAS_Right;
Daniel Jasper6501f7e2015-10-27 12:38:37 +0000664 LLVMStyle.AlignAfterOpenBracket = FormatStyle::BAS_Align;
Daniel Jasper3219e432014-12-02 13:24:51 +0000665 LLVMStyle.AlignOperands = true;
Daniel Jasper552f4a72013-07-31 23:55:15 +0000666 LLVMStyle.AlignTrailingComments = true;
Daniel Jaspera44991332015-04-29 13:06:49 +0000667 LLVMStyle.AlignConsecutiveAssignments = false;
Daniel Jaspere12597c2015-10-01 10:06:54 +0000668 LLVMStyle.AlignConsecutiveDeclarations = false;
Paul Hoadc6deae42019-03-23 14:37:58 +0000669 LLVMStyle.AllowAllArgumentsOnNextLine = true;
670 LLVMStyle.AllowAllConstructorInitializersOnNextLine = true;
Daniel Jasperf7db4332013-01-29 16:03:49 +0000671 LLVMStyle.AllowAllParametersOfDeclarationOnNextLine = true;
Daniel Jasperd74cf402014-04-08 12:46:38 +0000672 LLVMStyle.AllowShortFunctionsOnASingleLine = FormatStyle::SFS_All;
Daniel Jasper17605d32014-05-14 09:33:35 +0000673 LLVMStyle.AllowShortBlocksOnASingleLine = false;
Daniel Jasperb87899b2014-09-10 13:11:45 +0000674 LLVMStyle.AllowShortCaseLabelsOnASingleLine = false;
Paul Hoad15000a12019-03-13 08:26:39 +0000675 LLVMStyle.AllowShortIfStatementsOnASingleLine = FormatStyle::SIS_Never;
Ronald Wamplera83e2db2019-03-26 20:18:14 +0000676 LLVMStyle.AllowShortLambdasOnASingleLine = FormatStyle::SLS_All;
Daniel Jasper3a685df2013-05-16 12:12:21 +0000677 LLVMStyle.AllowShortLoopsOnASingleLine = false;
Zachary Turner448592e2015-12-18 22:20:15 +0000678 LLVMStyle.AlwaysBreakAfterReturnType = FormatStyle::RTBS_None;
Birunthan Mohanathasa0388a82015-06-29 15:30:42 +0000679 LLVMStyle.AlwaysBreakAfterDefinitionReturnType = FormatStyle::DRTBS_None;
Alexander Kornienko58611712013-07-04 12:02:44 +0000680 LLVMStyle.AlwaysBreakBeforeMultilineStrings = false;
Francois Ferrand58e6fe52018-05-16 08:25:03 +0000681 LLVMStyle.AlwaysBreakTemplateDeclarations = FormatStyle::BTDS_MultiLine;
Daniel Jasper18210d72014-10-09 09:52:05 +0000682 LLVMStyle.BinPackArguments = true;
Francois Ferrande56a8292017-06-14 12:29:47 +0000683 LLVMStyle.BinPackParameters = true;
Daniel Jasperac043c92014-09-15 11:11:00 +0000684 LLVMStyle.BreakBeforeBinaryOperators = FormatStyle::BOS_None;
Daniel Jasper165b29e2013-11-08 00:57:11 +0000685 LLVMStyle.BreakBeforeTernaryOperators = true;
Daniel Jaspere33d4af2013-07-26 16:56:36 +0000686 LLVMStyle.BreakBeforeBraces = FormatStyle::BS_Attach;
Owen Pan806d5742019-04-08 23:36:25 +0000687 LLVMStyle.BraceWrapping = {false, false, false, false, false, false,
Manuel Klimek89628f62017-09-20 09:51:03 +0000688 false, false, false, false, false,
689 false, false, true, true, true};
Nico Weber2cd92f12015-10-15 16:03:01 +0000690 LLVMStyle.BreakAfterJavaFieldAnnotations = false;
Francois Ferranda6b6d512017-05-24 11:36:58 +0000691 LLVMStyle.BreakConstructorInitializers = FormatStyle::BCIS_BeforeColon;
Francois Ferrand6bb103f2018-06-11 14:41:26 +0000692 LLVMStyle.BreakInheritanceList = FormatStyle::BILS_BeforeColon;
Daniel Jaspere1a7b762016-02-01 11:21:02 +0000693 LLVMStyle.BreakStringLiterals = true;
Alexander Kornienkoc8602662013-05-06 14:11:27 +0000694 LLVMStyle.ColumnLimit = 80;
Daniel Jaspere1e43192014-04-01 12:55:11 +0000695 LLVMStyle.CommentPragmas = "^ IWYU pragma:";
Francois Ferrande56a8292017-06-14 12:29:47 +0000696 LLVMStyle.CompactNamespaces = false;
Alexander Kornienkoc8602662013-05-06 14:11:27 +0000697 LLVMStyle.ConstructorInitializerAllOnOneLineOrOnePerLine = false;
Daniel Jaspercdaffa42013-08-13 10:58:30 +0000698 LLVMStyle.ConstructorInitializerIndentWidth = 4;
Daniel Jaspere1e43192014-04-01 12:55:11 +0000699 LLVMStyle.ContinuationIndentWidth = 4;
Chandler Carruthf8b72662014-03-02 12:37:31 +0000700 LLVMStyle.Cpp11BracedListStyle = true;
Daniel Jasper553d4872014-06-17 12:40:34 +0000701 LLVMStyle.DerivePointerAlignment = false;
Daniel Jasperb10cbc42013-07-10 14:02:49 +0000702 LLVMStyle.ExperimentalAutoDetectBinPacking = false;
Krasimir Georgiev32eaa862017-03-01 15:35:39 +0000703 LLVMStyle.FixNamespaceComments = true;
Daniel Jaspere1e43192014-04-01 12:55:11 +0000704 LLVMStyle.ForEachMacros.push_back("foreach");
705 LLVMStyle.ForEachMacros.push_back("Q_FOREACH");
706 LLVMStyle.ForEachMacros.push_back("BOOST_FOREACH");
Eric Liu9d92c022018-05-14 19:51:33 +0000707 LLVMStyle.IncludeStyle.IncludeCategories = {
708 {"^\"(llvm|llvm-c|clang|clang-c)/", 2},
709 {"^(<|\"(gtest|gmock|isl|json)/)", 3},
710 {".*", 1}};
711 LLVMStyle.IncludeStyle.IncludeIsMainRegex = "(Test)?$";
712 LLVMStyle.IncludeStyle.IncludeBlocks = tooling::IncludeStyle::IBS_Preserve;
Alexander Kornienkoc8602662013-05-06 14:11:27 +0000713 LLVMStyle.IndentCaseLabels = false;
Krasimir Georgievad47c902017-08-30 14:34:57 +0000714 LLVMStyle.IndentPPDirectives = FormatStyle::PPDIS_None;
Daniel Jasperc75e1ef2014-07-09 08:42:42 +0000715 LLVMStyle.IndentWrappedFunctionNames = false;
Daniel Jaspere33d4af2013-07-26 16:56:36 +0000716 LLVMStyle.IndentWidth = 2;
Martin Probstfb2342d2016-06-13 17:50:10 +0000717 LLVMStyle.JavaScriptQuotes = FormatStyle::JSQS_Leave;
718 LLVMStyle.JavaScriptWrapImports = true;
Alexander Kornienkoebb43ca2013-09-05 14:08:34 +0000719 LLVMStyle.TabWidth = 8;
Alexander Kornienkoc8602662013-05-06 14:11:27 +0000720 LLVMStyle.MaxEmptyLinesToKeep = 1;
Daniel Jaspera26fc5c2014-03-21 13:43:14 +0000721 LLVMStyle.KeepEmptyLinesAtTheStartOfBlocks = true;
Daniel Jasper65ee3472013-07-31 23:16:02 +0000722 LLVMStyle.NamespaceIndentation = FormatStyle::NI_None;
Ben Hamilton4dc658c2018-02-02 20:15:14 +0000723 LLVMStyle.ObjCBinPackProtocolList = FormatStyle::BPS_Auto;
Daniel Jasper50d634b2014-10-28 16:53:38 +0000724 LLVMStyle.ObjCBlockIndentWidth = 2;
Daniel Jaspere9beea22014-01-28 15:20:33 +0000725 LLVMStyle.ObjCSpaceAfterProperty = false;
Nico Webera6087752013-01-10 20:12:55 +0000726 LLVMStyle.ObjCSpaceBeforeProtocolList = true;
Daniel Jasper553d4872014-06-17 12:40:34 +0000727 LLVMStyle.PointerAlignment = FormatStyle::PAS_Right;
Alexander Kornienkoc8602662013-05-06 14:11:27 +0000728 LLVMStyle.SpacesBeforeTrailingComments = 1;
Chandler Carruthf8b72662014-03-02 12:37:31 +0000729 LLVMStyle.Standard = FormatStyle::LS_Cpp11;
Alexander Kornienko3c3d09c2013-09-27 16:14:22 +0000730 LLVMStyle.UseTab = FormatStyle::UT_Never;
Daniel Jaspera0a50392015-12-01 13:28:53 +0000731 LLVMStyle.ReflowComments = true;
Daniel Jasperb55acad2013-08-20 12:36:34 +0000732 LLVMStyle.SpacesInParentheses = false;
Daniel Jasperad981f82014-08-26 11:41:14 +0000733 LLVMStyle.SpacesInSquareBrackets = false;
Daniel Jasperb55acad2013-08-20 12:36:34 +0000734 LLVMStyle.SpaceInEmptyParentheses = false;
Daniel Jasperb2e10a52014-01-15 15:09:08 +0000735 LLVMStyle.SpacesInContainerLiterals = true;
Daniel Jasperb55acad2013-08-20 12:36:34 +0000736 LLVMStyle.SpacesInCStyleCastParentheses = false;
Daniel Jasperdb986eb2014-09-03 07:37:29 +0000737 LLVMStyle.SpaceAfterCStyleCast = false;
Reuben Thomas91f60b42019-04-08 12:54:48 +0000738 LLVMStyle.SpaceAfterLogicalNot = false;
Sylvestre Ledru83bbd572016-08-09 14:24:40 +0000739 LLVMStyle.SpaceAfterTemplateKeyword = true;
Francois Ferrand2a9ea782018-03-01 10:09:13 +0000740 LLVMStyle.SpaceBeforeCtorInitializerColon = true;
741 LLVMStyle.SpaceBeforeInheritanceColon = true;
Alexander Kornienkofdca83d2013-12-10 10:18:34 +0000742 LLVMStyle.SpaceBeforeParens = FormatStyle::SBPO_ControlStatements;
Francois Ferrand2a9ea782018-03-01 10:09:13 +0000743 LLVMStyle.SpaceBeforeRangeBasedForLoopColon = true;
Daniel Jasperd94bff32013-09-25 15:15:02 +0000744 LLVMStyle.SpaceBeforeAssignmentOperators = true;
Hans Wennborgbfc34062018-06-14 08:01:09 +0000745 LLVMStyle.SpaceBeforeCpp11BracedList = false;
Daniel Jasperdd978ae2013-10-29 14:52:02 +0000746 LLVMStyle.SpacesInAngles = false;
Daniel Jasper4e9678f2013-07-11 20:41:21 +0000747
Francois Ferrand9976efa2017-05-22 08:28:17 +0000748 LLVMStyle.PenaltyBreakAssignment = prec::Assignment;
Daniel Jasper19a541e2013-12-19 16:45:34 +0000749 LLVMStyle.PenaltyBreakComment = 300;
Alexander Kornienkofe7a57f2013-12-10 15:42:15 +0000750 LLVMStyle.PenaltyBreakFirstLessLess = 120;
751 LLVMStyle.PenaltyBreakString = 1000;
752 LLVMStyle.PenaltyExcessCharacter = 1000000;
Daniel Jasper4e9678f2013-07-11 20:41:21 +0000753 LLVMStyle.PenaltyReturnTypeOnItsOwnLine = 60;
Daniel Jasper33b909c2013-10-25 14:29:37 +0000754 LLVMStyle.PenaltyBreakBeforeFirstCallParameter = 19;
Francois Ferrand58e6fe52018-05-16 08:25:03 +0000755 LLVMStyle.PenaltyBreakTemplateDeclaration = prec::Relational;
Daniel Jasper4e9678f2013-07-11 20:41:21 +0000756
Daniel Jasperc64b09a2014-05-22 15:12:22 +0000757 LLVMStyle.DisableFormat = false;
Daniel Jasperda446772015-11-16 12:38:56 +0000758 LLVMStyle.SortIncludes = true;
Krasimir Georgievac16a202017-06-23 11:46:03 +0000759 LLVMStyle.SortUsingDeclarations = true;
Francois Ferrand6f40e212018-10-02 16:37:51 +0000760 LLVMStyle.StatementMacros.push_back("Q_UNUSED");
761 LLVMStyle.StatementMacros.push_back("QT_REQUIRE_VERSION");
Daniel Jasperc64b09a2014-05-22 15:12:22 +0000762
Jordan Rupprecht7f514162019-03-01 00:12:18 +0000763 // Defaults that differ when not C++.
764 if (Language == FormatStyle::LK_TableGen) {
765 LLVMStyle.SpacesInContainerLiterals = false;
766 }
767
Daniel Jasperf7935112012-12-03 18:12:45 +0000768 return LLVMStyle;
769}
770
Nico Weber514ecc82014-02-02 20:50:45 +0000771FormatStyle getGoogleStyle(FormatStyle::LanguageKind Language) {
Krasimir Georgiev26b144c2017-07-03 15:05:14 +0000772 if (Language == FormatStyle::LK_TextProto) {
773 FormatStyle GoogleStyle = getGoogleStyle(FormatStyle::LK_Proto);
774 GoogleStyle.Language = FormatStyle::LK_TextProto;
Krasimir Georgieveda222e2018-01-24 11:18:39 +0000775
Krasimir Georgiev26b144c2017-07-03 15:05:14 +0000776 return GoogleStyle;
777 }
778
Jordan Rupprecht8bd97e72019-02-28 19:16:45 +0000779 FormatStyle GoogleStyle = getLLVMStyle(Language);
Nico Weber514ecc82014-02-02 20:50:45 +0000780
Daniel Jasperf7935112012-12-03 18:12:45 +0000781 GoogleStyle.AccessModifierOffset = -1;
Daniel Jasper7fdbb3f2017-05-08 15:08:00 +0000782 GoogleStyle.AlignEscapedNewlines = FormatStyle::ENAS_Left;
Paul Hoad15000a12019-03-13 08:26:39 +0000783 GoogleStyle.AllowShortIfStatementsOnASingleLine =
784 FormatStyle::SIS_WithoutElse;
Daniel Jasper5bd0b9e2013-05-23 18:05:18 +0000785 GoogleStyle.AllowShortLoopsOnASingleLine = true;
Alexander Kornienko58611712013-07-04 12:02:44 +0000786 GoogleStyle.AlwaysBreakBeforeMultilineStrings = true;
Francois Ferrand58e6fe52018-05-16 08:25:03 +0000787 GoogleStyle.AlwaysBreakTemplateDeclarations = FormatStyle::BTDS_Yes;
Alexander Kornienkoc8602662013-05-06 14:11:27 +0000788 GoogleStyle.ConstructorInitializerAllOnOneLineOrOnePerLine = true;
Daniel Jasper553d4872014-06-17 12:40:34 +0000789 GoogleStyle.DerivePointerAlignment = true;
Eric Liu9d92c022018-05-14 19:51:33 +0000790 GoogleStyle.IncludeStyle.IncludeCategories = {
Krasimir Georgieva84e7872017-09-26 14:58:29 +0000791 {"^<ext/.*\\.h>", 2}, {"^<.*\\.h>", 1}, {"^<.*", 2}, {".*", 3}};
Eric Liu9d92c022018-05-14 19:51:33 +0000792 GoogleStyle.IncludeStyle.IncludeIsMainRegex = "([-_](test|unittest))?$";
Eric Liu0f4d5f82019-04-03 09:25:16 +0000793 GoogleStyle.IncludeStyle.IncludeBlocks = tooling::IncludeStyle::IBS_Regroup;
Alexander Kornienkoc8602662013-05-06 14:11:27 +0000794 GoogleStyle.IndentCaseLabels = true;
Daniel Jaspera26fc5c2014-03-21 13:43:14 +0000795 GoogleStyle.KeepEmptyLinesAtTheStartOfBlocks = false;
Ben Hamilton3a47fdd2018-02-08 01:49:10 +0000796 GoogleStyle.ObjCBinPackProtocolList = FormatStyle::BPS_Never;
Daniel Jaspere9beea22014-01-28 15:20:33 +0000797 GoogleStyle.ObjCSpaceAfterProperty = false;
Ben Hamiltonf84f1182018-01-18 18:37:16 +0000798 GoogleStyle.ObjCSpaceBeforeProtocolList = true;
Daniel Jasper553d4872014-06-17 12:40:34 +0000799 GoogleStyle.PointerAlignment = FormatStyle::PAS_Left;
Krasimir Georgiev5559cc32018-04-25 14:56:19 +0000800 GoogleStyle.RawStringFormats = {
Krasimir Georgiev4527f132018-01-17 12:24:59 +0000801 {
Krasimir Georgiev5559cc32018-04-25 14:56:19 +0000802 FormatStyle::LK_Cpp,
803 /*Delimiters=*/
804 {
805 "cc",
806 "CC",
807 "cpp",
808 "Cpp",
809 "CPP",
810 "c++",
811 "C++",
812 },
813 /*EnclosingFunctionNames=*/
814 {},
815 /*CanonicalDelimiter=*/"",
816 /*BasedOnStyle=*/"google",
Krasimir Georgiev4527f132018-01-17 12:24:59 +0000817 },
Krasimir Georgiev5559cc32018-04-25 14:56:19 +0000818 {
819 FormatStyle::LK_TextProto,
820 /*Delimiters=*/
821 {
822 "pb",
823 "PB",
824 "proto",
825 "PROTO",
826 },
827 /*EnclosingFunctionNames=*/
Krasimir Georgiev42948e32018-06-26 12:00:14 +0000828 {
Krasimir Georgiev42948e32018-06-26 12:00:14 +0000829 "EqualsProto",
Krasimir Georgiev61f46f22018-06-29 14:25:25 +0000830 "EquivToProto",
Krasimir Georgievce0b8d62018-08-01 12:35:23 +0000831 "PARSE_PARTIAL_TEXT_PROTO",
Krasimir Georgiev61f46f22018-06-29 14:25:25 +0000832 "PARSE_TEST_PROTO",
833 "PARSE_TEXT_PROTO",
834 "ParseTextOrDie",
Krasimir Georgievce0b8d62018-08-01 12:35:23 +0000835 "ParseTextProtoOrDie",
Krasimir Georgiev42948e32018-06-26 12:00:14 +0000836 },
Krasimir Georgiev5559cc32018-04-25 14:56:19 +0000837 /*CanonicalDelimiter=*/"",
838 /*BasedOnStyle=*/"google",
839 },
840 };
Alexander Kornienkoc8602662013-05-06 14:11:27 +0000841 GoogleStyle.SpacesBeforeTrailingComments = 2;
842 GoogleStyle.Standard = FormatStyle::LS_Auto;
Daniel Jasper4e9678f2013-07-11 20:41:21 +0000843
Daniel Jasper4e9678f2013-07-11 20:41:21 +0000844 GoogleStyle.PenaltyReturnTypeOnItsOwnLine = 200;
Daniel Jasper33b909c2013-10-25 14:29:37 +0000845 GoogleStyle.PenaltyBreakBeforeFirstCallParameter = 1;
Daniel Jasper4e9678f2013-07-11 20:41:21 +0000846
Daniel Jasperc58c70e2014-09-15 11:21:46 +0000847 if (Language == FormatStyle::LK_Java) {
Daniel Jasper6501f7e2015-10-27 12:38:37 +0000848 GoogleStyle.AlignAfterOpenBracket = FormatStyle::BAS_DontAlign;
Daniel Jasper3219e432014-12-02 13:24:51 +0000849 GoogleStyle.AlignOperands = false;
Daniel Jasperfd4ed182015-01-04 20:40:45 +0000850 GoogleStyle.AlignTrailingComments = false;
Daniel Jasper9e709352014-11-26 10:43:58 +0000851 GoogleStyle.AllowShortFunctionsOnASingleLine = FormatStyle::SFS_Empty;
Paul Hoad15000a12019-03-13 08:26:39 +0000852 GoogleStyle.AllowShortIfStatementsOnASingleLine = FormatStyle::SIS_Never;
Daniel Jasper1cd3c712015-01-14 12:24:59 +0000853 GoogleStyle.AlwaysBreakBeforeMultilineStrings = false;
Daniel Jasperc58c70e2014-09-15 11:21:46 +0000854 GoogleStyle.BreakBeforeBinaryOperators = FormatStyle::BOS_NonAssignment;
855 GoogleStyle.ColumnLimit = 100;
856 GoogleStyle.SpaceAfterCStyleCast = true;
Daniel Jasper61d81972014-11-14 08:22:46 +0000857 GoogleStyle.SpacesBeforeTrailingComments = 1;
Daniel Jasperc58c70e2014-09-15 11:21:46 +0000858 } else if (Language == FormatStyle::LK_JavaScript) {
Daniel Jasper6501f7e2015-10-27 12:38:37 +0000859 GoogleStyle.AlignAfterOpenBracket = FormatStyle::BAS_AlwaysBreak;
Daniel Jasper41a2bf72015-12-21 13:52:19 +0000860 GoogleStyle.AlignOperands = false;
Daniel Jasper28d8a5a2016-09-07 23:01:13 +0000861 GoogleStyle.AllowShortFunctionsOnASingleLine = FormatStyle::SFS_Empty;
Daniel Jasper6501f7e2015-10-27 12:38:37 +0000862 GoogleStyle.AlwaysBreakBeforeMultilineStrings = false;
Daniel Jaspere551bb72014-11-05 17:22:31 +0000863 GoogleStyle.BreakBeforeTernaryOperators = false;
Krasimir Georgiev6a5c95b2018-07-30 08:45:45 +0000864 // taze:, triple slash directives (`/// <...`), @see, which is commonly
865 // followed by overlong URLs.
866 GoogleStyle.CommentPragmas = "(taze:|^/[ \t]*<|@see)";
Daniel Jasper8f83a902014-05-09 10:28:58 +0000867 GoogleStyle.MaxEmptyLinesToKeep = 3;
Martin Probstece8c0c2016-06-13 16:41:28 +0000868 GoogleStyle.NamespaceIndentation = FormatStyle::NI_All;
Nico Weber514ecc82014-02-02 20:50:45 +0000869 GoogleStyle.SpacesInContainerLiterals = false;
Daniel Jasperabd1f572016-03-02 22:44:03 +0000870 GoogleStyle.JavaScriptQuotes = FormatStyle::JSQS_Single;
Martin Probst0cd74ee2016-06-13 16:39:50 +0000871 GoogleStyle.JavaScriptWrapImports = false;
Nico Weber514ecc82014-02-02 20:50:45 +0000872 } else if (Language == FormatStyle::LK_Proto) {
Daniel Jasper67e65212018-08-15 19:07:55 +0000873 GoogleStyle.AllowShortFunctionsOnASingleLine = FormatStyle::SFS_Empty;
Daniel Jasper9c95dfe2018-03-12 10:32:18 +0000874 GoogleStyle.AlwaysBreakBeforeMultilineStrings = false;
Daniel Jasper783bac62014-04-15 09:54:30 +0000875 GoogleStyle.SpacesInContainerLiterals = false;
Krasimir Georgievc2091802018-01-31 10:14:10 +0000876 GoogleStyle.Cpp11BracedListStyle = false;
Krasimir Georgiev374e6de2018-02-08 10:47:12 +0000877 // This affects protocol buffer options specifications and text protos.
878 // Text protos are currently mostly formatted inside C++ raw string literals
879 // and often the current breaking behavior of string literals is not
880 // beneficial there. Investigate turning this on once proper string reflow
881 // has been implemented.
882 GoogleStyle.BreakStringLiterals = false;
Daniel Jasper03a04fe2016-12-12 12:42:29 +0000883 } else if (Language == FormatStyle::LK_ObjC) {
Ben Hamilton1ab722e2018-06-14 17:30:10 +0000884 GoogleStyle.AlwaysBreakBeforeMultilineStrings = false;
Daniel Jasper03a04fe2016-12-12 12:42:29 +0000885 GoogleStyle.ColumnLimit = 100;
Krasimir Georgiev00e7ae92019-04-04 14:04:26 +0000886 // "Regroup" doesn't work well for ObjC yet (main header heuristic,
887 // relationship between ObjC standard library headers and other heades,
888 // #imports, etc.)
889 GoogleStyle.IncludeStyle.IncludeBlocks =
890 tooling::IncludeStyle::IBS_Preserve;
Nico Weber514ecc82014-02-02 20:50:45 +0000891 }
892
Daniel Jasperf7935112012-12-03 18:12:45 +0000893 return GoogleStyle;
894}
895
Nico Weber514ecc82014-02-02 20:50:45 +0000896FormatStyle getChromiumStyle(FormatStyle::LanguageKind Language) {
897 FormatStyle ChromiumStyle = getGoogleStyle(Language);
Nico Weber450425c2014-11-26 16:43:18 +0000898 if (Language == FormatStyle::LK_Java) {
Paul Hoad15000a12019-03-13 08:26:39 +0000899 ChromiumStyle.AllowShortIfStatementsOnASingleLine =
900 FormatStyle::SIS_WithoutElse;
Nico Weber2cd92f12015-10-15 16:03:01 +0000901 ChromiumStyle.BreakAfterJavaFieldAnnotations = true;
Nico Weber450425c2014-11-26 16:43:18 +0000902 ChromiumStyle.ContinuationIndentWidth = 8;
Nico Weber2cd92f12015-10-15 16:03:01 +0000903 ChromiumStyle.IndentWidth = 4;
Krasimir Georgiev7e91b032018-10-05 17:19:26 +0000904 // See styleguide for import groups:
905 // https://chromium.googlesource.com/chromium/src/+/master/styleguide/java/java.md#Import-Order
906 ChromiumStyle.JavaImportGroups = {
Nico Weberffff4922019-04-04 14:19:45 +0000907 "android",
908 "androidx",
909 "com",
910 "dalvik",
911 "junit",
912 "org",
913 "com.google.android.apps.chrome",
914 "org.chromium",
915 "java",
916 "javax",
Krasimir Georgiev7e91b032018-10-05 17:19:26 +0000917 };
918 ChromiumStyle.SortIncludes = true;
Nico Weberea649692017-01-04 02:33:36 +0000919 } else if (Language == FormatStyle::LK_JavaScript) {
Paul Hoad15000a12019-03-13 08:26:39 +0000920 ChromiumStyle.AllowShortIfStatementsOnASingleLine = FormatStyle::SIS_Never;
Nico Weberea649692017-01-04 02:33:36 +0000921 ChromiumStyle.AllowShortLoopsOnASingleLine = false;
Nico Weber450425c2014-11-26 16:43:18 +0000922 } else {
923 ChromiumStyle.AllowAllParametersOfDeclarationOnNextLine = false;
924 ChromiumStyle.AllowShortFunctionsOnASingleLine = FormatStyle::SFS_Inline;
Paul Hoad15000a12019-03-13 08:26:39 +0000925 ChromiumStyle.AllowShortIfStatementsOnASingleLine = FormatStyle::SIS_Never;
Nico Weber450425c2014-11-26 16:43:18 +0000926 ChromiumStyle.AllowShortLoopsOnASingleLine = false;
927 ChromiumStyle.BinPackParameters = false;
928 ChromiumStyle.DerivePointerAlignment = false;
Nico Weber9e2bc302017-01-31 18:42:05 +0000929 if (Language == FormatStyle::LK_ObjC)
930 ChromiumStyle.ColumnLimit = 80;
Nico Weber450425c2014-11-26 16:43:18 +0000931 }
Daniel Jasper1b750ed2013-01-14 16:24:39 +0000932 return ChromiumStyle;
933}
934
Alexander Kornienkoc8602662013-05-06 14:11:27 +0000935FormatStyle getMozillaStyle() {
936 FormatStyle MozillaStyle = getLLVMStyle();
937 MozillaStyle.AllowAllParametersOfDeclarationOnNextLine = false;
Birunthan Mohanathasa0810022015-06-29 15:18:58 +0000938 MozillaStyle.AllowShortFunctionsOnASingleLine = FormatStyle::SFS_Inline;
Manuel Klimek89628f62017-09-20 09:51:03 +0000939 MozillaStyle.AlwaysBreakAfterReturnType = FormatStyle::RTBS_TopLevel;
Birunthan Mohanathasa0388a82015-06-29 15:30:42 +0000940 MozillaStyle.AlwaysBreakAfterDefinitionReturnType =
941 FormatStyle::DRTBS_TopLevel;
Francois Ferrand58e6fe52018-05-16 08:25:03 +0000942 MozillaStyle.AlwaysBreakTemplateDeclarations = FormatStyle::BTDS_Yes;
Sylvestre Ledrudcb038d2016-12-14 16:09:29 +0000943 MozillaStyle.BinPackParameters = false;
944 MozillaStyle.BinPackArguments = false;
Birunthan Mohanathas305fa9c2015-07-12 03:13:54 +0000945 MozillaStyle.BreakBeforeBraces = FormatStyle::BS_Mozilla;
Francois Ferranda6b6d512017-05-24 11:36:58 +0000946 MozillaStyle.BreakConstructorInitializers = FormatStyle::BCIS_BeforeComma;
Francois Ferrand6bb103f2018-06-11 14:41:26 +0000947 MozillaStyle.BreakInheritanceList = FormatStyle::BILS_BeforeComma;
Birunthan Mohanathasa0810022015-06-29 15:18:58 +0000948 MozillaStyle.ConstructorInitializerIndentWidth = 2;
949 MozillaStyle.ContinuationIndentWidth = 2;
Chandler Carruthf8b72662014-03-02 12:37:31 +0000950 MozillaStyle.Cpp11BracedListStyle = false;
Krasimir Georgiev32eaa862017-03-01 15:35:39 +0000951 MozillaStyle.FixNamespaceComments = false;
Alexander Kornienkoc8602662013-05-06 14:11:27 +0000952 MozillaStyle.IndentCaseLabels = true;
Daniel Jaspere9beea22014-01-28 15:20:33 +0000953 MozillaStyle.ObjCSpaceAfterProperty = true;
Alexander Kornienkoc8602662013-05-06 14:11:27 +0000954 MozillaStyle.ObjCSpaceBeforeProtocolList = false;
955 MozillaStyle.PenaltyReturnTypeOnItsOwnLine = 200;
Daniel Jasper553d4872014-06-17 12:40:34 +0000956 MozillaStyle.PointerAlignment = FormatStyle::PAS_Left;
Sylvestre Ledru83bbd572016-08-09 14:24:40 +0000957 MozillaStyle.SpaceAfterTemplateKeyword = false;
Alexander Kornienkoc8602662013-05-06 14:11:27 +0000958 return MozillaStyle;
959}
960
Daniel Jasperffefb3d2013-07-24 13:10:59 +0000961FormatStyle getWebKitStyle() {
962 FormatStyle Style = getLLVMStyle();
Daniel Jasper65ee3472013-07-31 23:16:02 +0000963 Style.AccessModifierOffset = -4;
Daniel Jasper6501f7e2015-10-27 12:38:37 +0000964 Style.AlignAfterOpenBracket = FormatStyle::BAS_DontAlign;
Daniel Jasper3219e432014-12-02 13:24:51 +0000965 Style.AlignOperands = false;
Daniel Jasper552f4a72013-07-31 23:55:15 +0000966 Style.AlignTrailingComments = false;
Daniel Jasperac043c92014-09-15 11:11:00 +0000967 Style.BreakBeforeBinaryOperators = FormatStyle::BOS_All;
Roman Kashitsyn291f64f2015-08-10 13:43:19 +0000968 Style.BreakBeforeBraces = FormatStyle::BS_WebKit;
Francois Ferranda6b6d512017-05-24 11:36:58 +0000969 Style.BreakConstructorInitializers = FormatStyle::BCIS_BeforeComma;
Chandler Carruthf8b72662014-03-02 12:37:31 +0000970 Style.Cpp11BracedListStyle = false;
Daniel Jasper65ee3472013-07-31 23:16:02 +0000971 Style.ColumnLimit = 0;
Krasimir Georgiev32eaa862017-03-01 15:35:39 +0000972 Style.FixNamespaceComments = false;
Daniel Jaspere33d4af2013-07-26 16:56:36 +0000973 Style.IndentWidth = 4;
Daniel Jasper65ee3472013-07-31 23:16:02 +0000974 Style.NamespaceIndentation = FormatStyle::NI_Inner;
Daniel Jasper50d634b2014-10-28 16:53:38 +0000975 Style.ObjCBlockIndentWidth = 4;
Daniel Jaspere9beea22014-01-28 15:20:33 +0000976 Style.ObjCSpaceAfterProperty = true;
Daniel Jasper553d4872014-06-17 12:40:34 +0000977 Style.PointerAlignment = FormatStyle::PAS_Left;
Hans Wennborgbfc34062018-06-14 08:01:09 +0000978 Style.SpaceBeforeCpp11BracedList = true;
Daniel Jasperffefb3d2013-07-24 13:10:59 +0000979 return Style;
980}
981
Alexander Kornienkofe7a57f2013-12-10 15:42:15 +0000982FormatStyle getGNUStyle() {
983 FormatStyle Style = getLLVMStyle();
Birunthan Mohanathasa0388a82015-06-29 15:30:42 +0000984 Style.AlwaysBreakAfterDefinitionReturnType = FormatStyle::DRTBS_All;
Zachary Turner448592e2015-12-18 22:20:15 +0000985 Style.AlwaysBreakAfterReturnType = FormatStyle::RTBS_AllDefinitions;
Daniel Jasperac043c92014-09-15 11:11:00 +0000986 Style.BreakBeforeBinaryOperators = FormatStyle::BOS_All;
Alexander Kornienko3a33f022013-12-12 09:49:52 +0000987 Style.BreakBeforeBraces = FormatStyle::BS_GNU;
Alexander Kornienkofe7a57f2013-12-10 15:42:15 +0000988 Style.BreakBeforeTernaryOperators = true;
Chandler Carruthf8b72662014-03-02 12:37:31 +0000989 Style.Cpp11BracedListStyle = false;
Alexander Kornienkofe7a57f2013-12-10 15:42:15 +0000990 Style.ColumnLimit = 79;
Krasimir Georgiev32eaa862017-03-01 15:35:39 +0000991 Style.FixNamespaceComments = false;
Alexander Kornienkofe7a57f2013-12-10 15:42:15 +0000992 Style.SpaceBeforeParens = FormatStyle::SBPO_Always;
Chandler Carruthf8b72662014-03-02 12:37:31 +0000993 Style.Standard = FormatStyle::LS_Cpp03;
Alexander Kornienkofe7a57f2013-12-10 15:42:15 +0000994 return Style;
995}
996
Paul Hoadcbb726d2019-03-21 13:09:22 +0000997FormatStyle getMicrosoftStyle(FormatStyle::LanguageKind Language) {
998 FormatStyle Style = getLLVMStyle();
999 Style.ColumnLimit = 120;
1000 Style.TabWidth = 4;
1001 Style.IndentWidth = 4;
1002 Style.UseTab = FormatStyle::UT_Never;
1003 Style.BreakBeforeBraces = FormatStyle::BS_Custom;
1004 Style.BraceWrapping.AfterClass = true;
1005 Style.BraceWrapping.AfterControlStatement = true;
1006 Style.BraceWrapping.AfterEnum = true;
1007 Style.BraceWrapping.AfterFunction = true;
1008 Style.BraceWrapping.AfterNamespace = true;
1009 Style.BraceWrapping.AfterObjCDeclaration = true;
1010 Style.BraceWrapping.AfterStruct = true;
1011 Style.BraceWrapping.AfterExternBlock = true;
1012 Style.BraceWrapping.BeforeCatch = true;
1013 Style.BraceWrapping.BeforeElse = true;
1014 Style.PenaltyReturnTypeOnItsOwnLine = 1000;
1015 Style.AllowShortFunctionsOnASingleLine = FormatStyle::SFS_None;
1016 Style.AllowShortBlocksOnASingleLine = false;
1017 Style.AllowShortCaseLabelsOnASingleLine = false;
1018 Style.AllowShortIfStatementsOnASingleLine = FormatStyle::SIS_Never;
1019 Style.AllowShortLoopsOnASingleLine = false;
1020 return Style;
1021}
1022
Daniel Jasperc64b09a2014-05-22 15:12:22 +00001023FormatStyle getNoStyle() {
1024 FormatStyle NoStyle = getLLVMStyle();
1025 NoStyle.DisableFormat = true;
Daniel Jasperda446772015-11-16 12:38:56 +00001026 NoStyle.SortIncludes = false;
Krasimir Georgievac16a202017-06-23 11:46:03 +00001027 NoStyle.SortUsingDeclarations = false;
Daniel Jasperc64b09a2014-05-22 15:12:22 +00001028 return NoStyle;
1029}
1030
Alexander Kornienkoc1637f12013-12-10 11:28:13 +00001031bool getPredefinedStyle(StringRef Name, FormatStyle::LanguageKind Language,
1032 FormatStyle *Style) {
1033 if (Name.equals_lower("llvm")) {
Jordan Rupprecht55881d52019-03-13 21:13:01 +00001034 *Style = getLLVMStyle(Language);
Alexander Kornienkoc1637f12013-12-10 11:28:13 +00001035 } else if (Name.equals_lower("chromium")) {
Nico Weber514ecc82014-02-02 20:50:45 +00001036 *Style = getChromiumStyle(Language);
Alexander Kornienkoc1637f12013-12-10 11:28:13 +00001037 } else if (Name.equals_lower("mozilla")) {
Alexander Kornienko006b5c82013-05-19 00:53:30 +00001038 *Style = getMozillaStyle();
Alexander Kornienkoc1637f12013-12-10 11:28:13 +00001039 } else if (Name.equals_lower("google")) {
Nico Weber514ecc82014-02-02 20:50:45 +00001040 *Style = getGoogleStyle(Language);
Alexander Kornienkoc1637f12013-12-10 11:28:13 +00001041 } else if (Name.equals_lower("webkit")) {
Daniel Jasperffefb3d2013-07-24 13:10:59 +00001042 *Style = getWebKitStyle();
Alexander Kornienkofe7a57f2013-12-10 15:42:15 +00001043 } else if (Name.equals_lower("gnu")) {
1044 *Style = getGNUStyle();
Paul Hoadcbb726d2019-03-21 13:09:22 +00001045 } else if (Name.equals_lower("microsoft")) {
1046 *Style = getMicrosoftStyle(Language);
Daniel Jasperc64b09a2014-05-22 15:12:22 +00001047 } else if (Name.equals_lower("none")) {
1048 *Style = getNoStyle();
Alexander Kornienkoc1637f12013-12-10 11:28:13 +00001049 } else {
Alexander Kornienko006b5c82013-05-19 00:53:30 +00001050 return false;
Alexander Kornienkoc1637f12013-12-10 11:28:13 +00001051 }
Alexander Kornienkod6538332013-05-07 15:32:14 +00001052
Alexander Kornienkoc1637f12013-12-10 11:28:13 +00001053 Style->Language = Language;
Alexander Kornienko006b5c82013-05-19 00:53:30 +00001054 return true;
Alexander Kornienkod6538332013-05-07 15:32:14 +00001055}
1056
Rafael Espindolac0809172014-06-12 14:02:15 +00001057std::error_code parseConfiguration(StringRef Text, FormatStyle *Style) {
Alexander Kornienkocabdd732013-11-29 15:19:43 +00001058 assert(Style);
Alexander Kornienkoc1637f12013-12-10 11:28:13 +00001059 FormatStyle::LanguageKind Language = Style->Language;
1060 assert(Language != FormatStyle::LK_None);
Alexander Kornienko06e00332013-05-20 15:18:01 +00001061 if (Text.trim().empty())
Rafael Espindolad0136702014-06-12 02:50:04 +00001062 return make_error_code(ParseError::Error);
Krasimir Georgiev54076fe2018-01-15 12:06:16 +00001063 Style->StyleSet.Clear();
Alexander Kornienkocabdd732013-11-29 15:19:43 +00001064 std::vector<FormatStyle> Styles;
Alexander Kornienkod6538332013-05-07 15:32:14 +00001065 llvm::yaml::Input Input(Text);
Alexander Kornienkoc1637f12013-12-10 11:28:13 +00001066 // DocumentListTraits<vector<FormatStyle>> uses the context to get default
1067 // values for the fields, keys for which are missing from the configuration.
1068 // Mapping also uses the context to get the language to find the correct
1069 // base style.
1070 Input.setContext(Style);
Alexander Kornienkocabdd732013-11-29 15:19:43 +00001071 Input >> Styles;
1072 if (Input.error())
1073 return Input.error();
1074
Alexander Kornienkoc1637f12013-12-10 11:28:13 +00001075 for (unsigned i = 0; i < Styles.size(); ++i) {
Alexander Kornienkocabdd732013-11-29 15:19:43 +00001076 // Ensures that only the first configuration can skip the Language option.
Alexander Kornienkoc1637f12013-12-10 11:28:13 +00001077 if (Styles[i].Language == FormatStyle::LK_None && i != 0)
Rafael Espindolad0136702014-06-12 02:50:04 +00001078 return make_error_code(ParseError::Error);
Alexander Kornienkocabdd732013-11-29 15:19:43 +00001079 // Ensure that each language is configured at most once.
Alexander Kornienkoc1637f12013-12-10 11:28:13 +00001080 for (unsigned j = 0; j < i; ++j) {
1081 if (Styles[i].Language == Styles[j].Language) {
Nicola Zaghen3538b392018-05-15 13:30:56 +00001082 LLVM_DEBUG(llvm::dbgs()
1083 << "Duplicate languages in the config file on positions "
1084 << j << " and " << i << "\n");
Rafael Espindolad0136702014-06-12 02:50:04 +00001085 return make_error_code(ParseError::Error);
Alexander Kornienkoc1637f12013-12-10 11:28:13 +00001086 }
Alexander Kornienkocabdd732013-11-29 15:19:43 +00001087 }
1088 }
1089 // Look for a suitable configuration starting from the end, so we can
1090 // find the configuration for the specific language first, and the default
Alexander Kornienkoc1637f12013-12-10 11:28:13 +00001091 // configuration (which can only be at slot 0) after it.
Krasimir Georgiev54076fe2018-01-15 12:06:16 +00001092 FormatStyle::FormatStyleSet StyleSet;
1093 bool LanguageFound = false;
Alexander Kornienkoc1637f12013-12-10 11:28:13 +00001094 for (int i = Styles.size() - 1; i >= 0; --i) {
Krasimir Georgiev54076fe2018-01-15 12:06:16 +00001095 if (Styles[i].Language != FormatStyle::LK_None)
1096 StyleSet.Add(Styles[i]);
1097 if (Styles[i].Language == Language)
1098 LanguageFound = true;
Alexander Kornienkocabdd732013-11-29 15:19:43 +00001099 }
Krasimir Georgiev54076fe2018-01-15 12:06:16 +00001100 if (!LanguageFound) {
1101 if (Styles.empty() || Styles[0].Language != FormatStyle::LK_None)
1102 return make_error_code(ParseError::Unsuitable);
1103 FormatStyle DefaultStyle = Styles[0];
1104 DefaultStyle.Language = Language;
1105 StyleSet.Add(std::move(DefaultStyle));
1106 }
1107 *Style = *StyleSet.Get(Language);
1108 return make_error_code(ParseError::Success);
Alexander Kornienkod6538332013-05-07 15:32:14 +00001109}
1110
1111std::string configurationAsText(const FormatStyle &Style) {
1112 std::string Text;
1113 llvm::raw_string_ostream Stream(Text);
1114 llvm::yaml::Output Output(Stream);
1115 // We use the same mapping method for input and output, so we need a non-const
1116 // reference here.
Daniel Jasperc1bc38e2015-09-29 14:57:55 +00001117 FormatStyle NonConstStyle = expandPresets(Style);
Alexander Kornienkod6538332013-05-07 15:32:14 +00001118 Output << NonConstStyle;
Alexander Kornienko9a38ec22013-05-13 12:56:35 +00001119 return Stream.str();
Alexander Kornienkod6538332013-05-07 15:32:14 +00001120}
1121
Krasimir Georgiev54076fe2018-01-15 12:06:16 +00001122llvm::Optional<FormatStyle>
1123FormatStyle::FormatStyleSet::Get(FormatStyle::LanguageKind Language) const {
1124 if (!Styles)
1125 return None;
1126 auto It = Styles->find(Language);
1127 if (It == Styles->end())
1128 return None;
1129 FormatStyle Style = It->second;
1130 Style.StyleSet = *this;
1131 return Style;
1132}
1133
1134void FormatStyle::FormatStyleSet::Add(FormatStyle Style) {
1135 assert(Style.Language != LK_None &&
1136 "Cannot add a style for LK_None to a StyleSet");
1137 assert(
1138 !Style.StyleSet.Styles &&
1139 "Cannot add a style associated with an existing StyleSet to a StyleSet");
1140 if (!Styles)
1141 Styles = std::make_shared<MapType>();
1142 (*Styles)[Style.Language] = std::move(Style);
1143}
1144
Paul Hoad5bcf99b2019-03-01 09:09:54 +00001145void FormatStyle::FormatStyleSet::Clear() { Styles.reset(); }
Krasimir Georgiev54076fe2018-01-15 12:06:16 +00001146
1147llvm::Optional<FormatStyle>
1148FormatStyle::GetLanguageStyle(FormatStyle::LanguageKind Language) const {
1149 return StyleSet.Get(Language);
1150}
1151
Craig Topperaf35e852013-06-30 22:29:28 +00001152namespace {
1153
Daniel Jasper496c1992016-09-07 22:48:53 +00001154class JavaScriptRequoter : public TokenAnalyzer {
Eric Liu4cfb88a2016-04-25 15:09:22 +00001155public:
Daniel Jasper496c1992016-09-07 22:48:53 +00001156 JavaScriptRequoter(const Environment &Env, const FormatStyle &Style)
1157 : TokenAnalyzer(Env, Style) {}
Eric Liu4cfb88a2016-04-25 15:09:22 +00001158
Krasimir Georgiev9ad83fe2017-10-30 14:01:50 +00001159 std::pair<tooling::Replacements, unsigned>
Eric Liu4cfb88a2016-04-25 15:09:22 +00001160 analyze(TokenAnnotator &Annotator,
1161 SmallVectorImpl<AnnotatedLine *> &AnnotatedLines,
Martin Probsta9855af2016-09-02 14:29:48 +00001162 FormatTokenLexer &Tokens) override {
Manuel Klimek0dddcf72018-04-23 09:34:26 +00001163 AffectedRangeMgr.computeAffectedLines(AnnotatedLines);
Daniel Jasper496c1992016-09-07 22:48:53 +00001164 tooling::Replacements Result;
1165 requoteJSStringLiteral(AnnotatedLines, Result);
Krasimir Georgiev9ad83fe2017-10-30 14:01:50 +00001166 return {Result, 0};
Alexander Kornienko62b85b92013-03-13 14:41:29 +00001167 }
1168
1169private:
Daniel Jasper496c1992016-09-07 22:48:53 +00001170 // Replaces double/single-quoted string literal as appropriate, re-escaping
1171 // the contents in the process.
Daniel Jasper97439922016-03-17 13:03:41 +00001172 void requoteJSStringLiteral(SmallVectorImpl<AnnotatedLine *> &Lines,
Eric Liu4cfb88a2016-04-25 15:09:22 +00001173 tooling::Replacements &Result) {
Daniel Jasper97439922016-03-17 13:03:41 +00001174 for (AnnotatedLine *Line : Lines) {
1175 requoteJSStringLiteral(Line->Children, Result);
1176 if (!Line->Affected)
1177 continue;
1178 for (FormatToken *FormatTok = Line->First; FormatTok;
1179 FormatTok = FormatTok->Next) {
1180 StringRef Input = FormatTok->TokenText;
Martin Probsta1669792016-05-12 11:20:32 +00001181 if (FormatTok->Finalized || !FormatTok->isStringLiteral() ||
Daniel Jasper97439922016-03-17 13:03:41 +00001182 // NB: testing for not starting with a double quote to avoid
Daniel Jasper496c1992016-09-07 22:48:53 +00001183 // breaking `template strings`.
Eric Liu635423e2016-04-28 07:52:03 +00001184 (Style.JavaScriptQuotes == FormatStyle::JSQS_Single &&
Daniel Jasper97439922016-03-17 13:03:41 +00001185 !Input.startswith("\"")) ||
Eric Liu635423e2016-04-28 07:52:03 +00001186 (Style.JavaScriptQuotes == FormatStyle::JSQS_Double &&
Daniel Jasper97439922016-03-17 13:03:41 +00001187 !Input.startswith("\'")))
1188 continue;
1189
1190 // Change start and end quote.
Eric Liu635423e2016-04-28 07:52:03 +00001191 bool IsSingle = Style.JavaScriptQuotes == FormatStyle::JSQS_Single;
Daniel Jasper97439922016-03-17 13:03:41 +00001192 SourceLocation Start = FormatTok->Tok.getLocation();
1193 auto Replace = [&](SourceLocation Start, unsigned Length,
1194 StringRef ReplacementText) {
Eric Liu40ef2fb2016-08-01 10:16:37 +00001195 auto Err = Result.add(tooling::Replacement(
1196 Env.getSourceManager(), Start, Length, ReplacementText));
1197 // FIXME: handle error. For now, print error message and skip the
1198 // replacement for release version.
Piotr Padlewski1ec383c2016-12-23 11:40:44 +00001199 if (Err) {
Eric Liu40ef2fb2016-08-01 10:16:37 +00001200 llvm::errs() << llvm::toString(std::move(Err)) << "\n";
Piotr Padlewski1ec383c2016-12-23 11:40:44 +00001201 assert(false);
1202 }
Daniel Jasper97439922016-03-17 13:03:41 +00001203 };
1204 Replace(Start, 1, IsSingle ? "'" : "\"");
1205 Replace(FormatTok->Tok.getEndLoc().getLocWithOffset(-1), 1,
1206 IsSingle ? "'" : "\"");
1207
1208 // Escape internal quotes.
Daniel Jasper97439922016-03-17 13:03:41 +00001209 bool Escaped = false;
1210 for (size_t i = 1; i < Input.size() - 1; i++) {
1211 switch (Input[i]) {
Eric Liu4cfb88a2016-04-25 15:09:22 +00001212 case '\\':
1213 if (!Escaped && i + 1 < Input.size() &&
1214 ((IsSingle && Input[i + 1] == '"') ||
1215 (!IsSingle && Input[i + 1] == '\''))) {
1216 // Remove this \, it's escaping a " or ' that no longer needs
1217 // escaping
Eric Liu4cfb88a2016-04-25 15:09:22 +00001218 Replace(Start.getLocWithOffset(i), 1, "");
1219 continue;
1220 }
1221 Escaped = !Escaped;
1222 break;
1223 case '\"':
1224 case '\'':
1225 if (!Escaped && IsSingle == (Input[i] == '\'')) {
1226 // Escape the quote.
1227 Replace(Start.getLocWithOffset(i), 0, "\\");
Eric Liu4cfb88a2016-04-25 15:09:22 +00001228 }
1229 Escaped = false;
1230 break;
1231 default:
1232 Escaped = false;
1233 break;
Daniel Jasper97439922016-03-17 13:03:41 +00001234 }
1235 }
Daniel Jasper97439922016-03-17 13:03:41 +00001236 }
1237 }
1238 }
Daniel Jasper496c1992016-09-07 22:48:53 +00001239};
1240
1241class Formatter : public TokenAnalyzer {
1242public:
1243 Formatter(const Environment &Env, const FormatStyle &Style,
Krasimir Georgievbcda54b2017-04-21 14:35:20 +00001244 FormattingAttemptStatus *Status)
1245 : TokenAnalyzer(Env, Style), Status(Status) {}
Daniel Jasper496c1992016-09-07 22:48:53 +00001246
Krasimir Georgiev9ad83fe2017-10-30 14:01:50 +00001247 std::pair<tooling::Replacements, unsigned>
Daniel Jasper496c1992016-09-07 22:48:53 +00001248 analyze(TokenAnnotator &Annotator,
1249 SmallVectorImpl<AnnotatedLine *> &AnnotatedLines,
1250 FormatTokenLexer &Tokens) override {
1251 tooling::Replacements Result;
1252 deriveLocalStyle(AnnotatedLines);
Manuel Klimek0dddcf72018-04-23 09:34:26 +00001253 AffectedRangeMgr.computeAffectedLines(AnnotatedLines);
Daniel Jasper496c1992016-09-07 22:48:53 +00001254 for (unsigned i = 0, e = AnnotatedLines.size(); i != e; ++i) {
1255 Annotator.calculateFormattingInformation(*AnnotatedLines[i]);
1256 }
1257 Annotator.setCommentLineLevels(AnnotatedLines);
1258
1259 WhitespaceManager Whitespaces(
1260 Env.getSourceManager(), Style,
1261 inputUsesCRLF(Env.getSourceManager().getBufferData(Env.getFileID())));
1262 ContinuationIndenter Indenter(Style, Tokens.getKeywords(),
1263 Env.getSourceManager(), Whitespaces, Encoding,
1264 BinPackInconclusiveFunctions);
Krasimir Georgiev9ad83fe2017-10-30 14:01:50 +00001265 unsigned Penalty =
1266 UnwrappedLineFormatter(&Indenter, &Whitespaces, Style,
1267 Tokens.getKeywords(), Env.getSourceManager(),
1268 Status)
1269 .format(AnnotatedLines, /*DryRun=*/false,
1270 /*AdditionalIndent=*/0,
1271 /*FixBadIndentation=*/false,
1272 /*FirstStartColumn=*/Env.getFirstStartColumn(),
1273 /*NextStartColumn=*/Env.getNextStartColumn(),
1274 /*LastStartColumn=*/Env.getLastStartColumn());
Daniel Jasper496c1992016-09-07 22:48:53 +00001275 for (const auto &R : Whitespaces.generateReplacements())
1276 if (Result.add(R))
Krasimir Georgieve56e9a42017-10-30 14:30:14 +00001277 return std::make_pair(Result, 0);
1278 return std::make_pair(Result, Penalty);
Daniel Jasper496c1992016-09-07 22:48:53 +00001279 }
1280
1281private:
Alexander Kornienko9e649af2013-09-11 12:25:57 +00001282 static bool inputUsesCRLF(StringRef Text) {
1283 return Text.count('\r') * 2 > Text.count('\n');
1284 }
1285
Daniel Jasper352f0df2015-07-18 16:35:30 +00001286 bool
1287 hasCpp03IncompatibleFormat(const SmallVectorImpl<AnnotatedLine *> &Lines) {
Eric Liu4cfb88a2016-04-25 15:09:22 +00001288 for (const AnnotatedLine *Line : Lines) {
Daniel Jasper352f0df2015-07-18 16:35:30 +00001289 if (hasCpp03IncompatibleFormat(Line->Children))
1290 return true;
1291 for (FormatToken *Tok = Line->First->Next; Tok; Tok = Tok->Next) {
1292 if (Tok->WhitespaceRange.getBegin() == Tok->WhitespaceRange.getEnd()) {
1293 if (Tok->is(tok::coloncolon) && Tok->Previous->is(TT_TemplateOpener))
1294 return true;
1295 if (Tok->is(TT_TemplateCloser) &&
1296 Tok->Previous->is(TT_TemplateCloser))
1297 return true;
1298 }
1299 }
1300 }
1301 return false;
1302 }
1303
1304 int countVariableAlignments(const SmallVectorImpl<AnnotatedLine *> &Lines) {
1305 int AlignmentDiff = 0;
Eric Liu4cfb88a2016-04-25 15:09:22 +00001306 for (const AnnotatedLine *Line : Lines) {
Daniel Jasper352f0df2015-07-18 16:35:30 +00001307 AlignmentDiff += countVariableAlignments(Line->Children);
1308 for (FormatToken *Tok = Line->First; Tok && Tok->Next; Tok = Tok->Next) {
1309 if (!Tok->is(TT_PointerOrReference))
1310 continue;
1311 bool SpaceBefore =
1312 Tok->WhitespaceRange.getBegin() != Tok->WhitespaceRange.getEnd();
1313 bool SpaceAfter = Tok->Next->WhitespaceRange.getBegin() !=
1314 Tok->Next->WhitespaceRange.getEnd();
1315 if (SpaceBefore && !SpaceAfter)
1316 ++AlignmentDiff;
1317 if (!SpaceBefore && SpaceAfter)
1318 --AlignmentDiff;
1319 }
1320 }
1321 return AlignmentDiff;
1322 }
1323
Manuel Klimek71814b42013-10-11 21:25:45 +00001324 void
1325 deriveLocalStyle(const SmallVectorImpl<AnnotatedLine *> &AnnotatedLines) {
Daniel Jasperb10cbc42013-07-10 14:02:49 +00001326 bool HasBinPackedFunction = false;
1327 bool HasOnePerLineFunction = false;
Daniel Jasper7fce3ab2013-02-06 14:22:40 +00001328 for (unsigned i = 0, e = AnnotatedLines.size(); i != e; ++i) {
Daniel Jasper9fe0e8d2013-09-05 09:29:45 +00001329 if (!AnnotatedLines[i]->First->Next)
Daniel Jasper7fce3ab2013-02-06 14:22:40 +00001330 continue;
Daniel Jasper9fe0e8d2013-09-05 09:29:45 +00001331 FormatToken *Tok = AnnotatedLines[i]->First->Next;
Manuel Klimek6e6310e2013-05-29 14:47:47 +00001332 while (Tok->Next) {
Daniel Jasperb10cbc42013-07-10 14:02:49 +00001333 if (Tok->PackingKind == PPK_BinPacked)
1334 HasBinPackedFunction = true;
1335 if (Tok->PackingKind == PPK_OnePerLine)
1336 HasOnePerLineFunction = true;
1337
Manuel Klimek6e6310e2013-05-29 14:47:47 +00001338 Tok = Tok->Next;
Daniel Jasper7fce3ab2013-02-06 14:22:40 +00001339 }
1340 }
Eric Liu635423e2016-04-28 07:52:03 +00001341 if (Style.DerivePointerAlignment)
1342 Style.PointerAlignment = countVariableAlignments(AnnotatedLines) <= 0
1343 ? FormatStyle::PAS_Left
1344 : FormatStyle::PAS_Right;
1345 if (Style.Standard == FormatStyle::LS_Auto)
1346 Style.Standard = hasCpp03IncompatibleFormat(AnnotatedLines)
1347 ? FormatStyle::LS_Cpp11
1348 : FormatStyle::LS_Cpp03;
Daniel Jasperb10cbc42013-07-10 14:02:49 +00001349 BinPackInconclusiveFunctions =
1350 HasBinPackedFunction || !HasOnePerLineFunction;
Daniel Jasper7fce3ab2013-02-06 14:22:40 +00001351 }
1352
Daniel Jasperb10cbc42013-07-10 14:02:49 +00001353 bool BinPackInconclusiveFunctions;
Krasimir Georgievbcda54b2017-04-21 14:35:20 +00001354 FormattingAttemptStatus *Status;
Eric Liu4cfb88a2016-04-25 15:09:22 +00001355};
1356
1357// This class clean up the erroneous/redundant code around the given ranges in
1358// file.
1359class Cleaner : public TokenAnalyzer {
1360public:
Eric Liu635423e2016-04-28 07:52:03 +00001361 Cleaner(const Environment &Env, const FormatStyle &Style)
1362 : TokenAnalyzer(Env, Style),
Eric Liu4cfb88a2016-04-25 15:09:22 +00001363 DeletedTokens(FormatTokenLess(Env.getSourceManager())) {}
1364
1365 // FIXME: eliminate unused parameters.
Krasimir Georgiev9ad83fe2017-10-30 14:01:50 +00001366 std::pair<tooling::Replacements, unsigned>
Eric Liu4cfb88a2016-04-25 15:09:22 +00001367 analyze(TokenAnnotator &Annotator,
1368 SmallVectorImpl<AnnotatedLine *> &AnnotatedLines,
Martin Probsta9855af2016-09-02 14:29:48 +00001369 FormatTokenLexer &Tokens) override {
Eric Liu4cfb88a2016-04-25 15:09:22 +00001370 // FIXME: in the current implementation the granularity of affected range
1371 // is an annotated line. However, this is not sufficient. Furthermore,
1372 // redundant code introduced by replacements does not necessarily
1373 // intercept with ranges of replacements that result in the redundancy.
1374 // To determine if some redundant code is actually introduced by
1375 // replacements(e.g. deletions), we need to come up with a more
1376 // sophisticated way of computing affected ranges.
Manuel Klimek0dddcf72018-04-23 09:34:26 +00001377 AffectedRangeMgr.computeAffectedLines(AnnotatedLines);
Eric Liu4cfb88a2016-04-25 15:09:22 +00001378
1379 checkEmptyNamespace(AnnotatedLines);
1380
Eric Liuce5e4bc2016-05-18 08:02:56 +00001381 for (auto &Line : AnnotatedLines) {
1382 if (Line->Affected) {
1383 cleanupRight(Line->First, tok::comma, tok::comma);
1384 cleanupRight(Line->First, TT_CtorInitializerColon, tok::comma);
Eric Liu2574d152016-09-13 15:02:43 +00001385 cleanupRight(Line->First, tok::l_paren, tok::comma);
1386 cleanupLeft(Line->First, tok::comma, tok::r_paren);
Eric Liuce5e4bc2016-05-18 08:02:56 +00001387 cleanupLeft(Line->First, TT_CtorInitializerComma, tok::l_brace);
1388 cleanupLeft(Line->First, TT_CtorInitializerColon, tok::l_brace);
Malcolm Parsons5d8cdb82016-10-20 14:58:45 +00001389 cleanupLeft(Line->First, TT_CtorInitializerColon, tok::equal);
Eric Liuce5e4bc2016-05-18 08:02:56 +00001390 }
1391 }
1392
Krasimir Georgiev9ad83fe2017-10-30 14:01:50 +00001393 return {generateFixes(), 0};
Eric Liu4cfb88a2016-04-25 15:09:22 +00001394 }
1395
1396private:
1397 bool containsOnlyComments(const AnnotatedLine &Line) {
1398 for (FormatToken *Tok = Line.First; Tok != nullptr; Tok = Tok->Next) {
1399 if (Tok->isNot(tok::comment))
1400 return false;
1401 }
1402 return true;
1403 }
1404
1405 // Iterate through all lines and remove any empty (nested) namespaces.
1406 void checkEmptyNamespace(SmallVectorImpl<AnnotatedLine *> &AnnotatedLines) {
Eric Liu7956c402016-10-05 15:49:01 +00001407 std::set<unsigned> DeletedLines;
Eric Liu4cfb88a2016-04-25 15:09:22 +00001408 for (unsigned i = 0, e = AnnotatedLines.size(); i != e; ++i) {
1409 auto &Line = *AnnotatedLines[i];
Sam McCall6f3778c2018-09-05 07:44:02 +00001410 if (Line.startsWithNamespace()) {
Eric Liu7956c402016-10-05 15:49:01 +00001411 checkEmptyNamespace(AnnotatedLines, i, i, DeletedLines);
Eric Liu4cfb88a2016-04-25 15:09:22 +00001412 }
1413 }
1414
1415 for (auto Line : DeletedLines) {
1416 FormatToken *Tok = AnnotatedLines[Line]->First;
1417 while (Tok) {
1418 deleteToken(Tok);
1419 Tok = Tok->Next;
1420 }
1421 }
1422 }
1423
1424 // The function checks if the namespace, which starts from \p CurrentLine, and
1425 // its nested namespaces are empty and delete them if they are empty. It also
1426 // sets \p NewLine to the last line checked.
1427 // Returns true if the current namespace is empty.
1428 bool checkEmptyNamespace(SmallVectorImpl<AnnotatedLine *> &AnnotatedLines,
Eric Liu7956c402016-10-05 15:49:01 +00001429 unsigned CurrentLine, unsigned &NewLine,
1430 std::set<unsigned> &DeletedLines) {
Eric Liu4cfb88a2016-04-25 15:09:22 +00001431 unsigned InitLine = CurrentLine, End = AnnotatedLines.size();
Eric Liu635423e2016-04-28 07:52:03 +00001432 if (Style.BraceWrapping.AfterNamespace) {
Eric Liu4cfb88a2016-04-25 15:09:22 +00001433 // If the left brace is in a new line, we should consume it first so that
1434 // it does not make the namespace non-empty.
1435 // FIXME: error handling if there is no left brace.
1436 if (!AnnotatedLines[++CurrentLine]->startsWith(tok::l_brace)) {
1437 NewLine = CurrentLine;
1438 return false;
1439 }
1440 } else if (!AnnotatedLines[CurrentLine]->endsWith(tok::l_brace)) {
1441 return false;
1442 }
1443 while (++CurrentLine < End) {
1444 if (AnnotatedLines[CurrentLine]->startsWith(tok::r_brace))
1445 break;
1446
Sam McCall6f3778c2018-09-05 07:44:02 +00001447 if (AnnotatedLines[CurrentLine]->startsWithNamespace()) {
Eric Liu7956c402016-10-05 15:49:01 +00001448 if (!checkEmptyNamespace(AnnotatedLines, CurrentLine, NewLine,
1449 DeletedLines))
Eric Liu4cfb88a2016-04-25 15:09:22 +00001450 return false;
1451 CurrentLine = NewLine;
1452 continue;
1453 }
1454
1455 if (containsOnlyComments(*AnnotatedLines[CurrentLine]))
1456 continue;
1457
1458 // If there is anything other than comments or nested namespaces in the
1459 // current namespace, the namespace cannot be empty.
1460 NewLine = CurrentLine;
1461 return false;
1462 }
1463
1464 NewLine = CurrentLine;
1465 if (CurrentLine >= End)
1466 return false;
1467
1468 // Check if the empty namespace is actually affected by changed ranges.
1469 if (!AffectedRangeMgr.affectsCharSourceRange(CharSourceRange::getCharRange(
1470 AnnotatedLines[InitLine]->First->Tok.getLocation(),
1471 AnnotatedLines[CurrentLine]->Last->Tok.getEndLoc())))
1472 return false;
1473
1474 for (unsigned i = InitLine; i <= CurrentLine; ++i) {
1475 DeletedLines.insert(i);
1476 }
1477
1478 return true;
1479 }
1480
Eric Liuce5e4bc2016-05-18 08:02:56 +00001481 // Checks pairs {start, start->next},..., {end->previous, end} and deletes one
1482 // of the token in the pair if the left token has \p LK token kind and the
1483 // right token has \p RK token kind. If \p DeleteLeft is true, the left token
1484 // is deleted on match; otherwise, the right token is deleted.
1485 template <typename LeftKind, typename RightKind>
1486 void cleanupPair(FormatToken *Start, LeftKind LK, RightKind RK,
1487 bool DeleteLeft) {
1488 auto NextNotDeleted = [this](const FormatToken &Tok) -> FormatToken * {
1489 for (auto *Res = Tok.Next; Res; Res = Res->Next)
1490 if (!Res->is(tok::comment) &&
1491 DeletedTokens.find(Res) == DeletedTokens.end())
1492 return Res;
1493 return nullptr;
1494 };
1495 for (auto *Left = Start; Left;) {
1496 auto *Right = NextNotDeleted(*Left);
1497 if (!Right)
1498 break;
1499 if (Left->is(LK) && Right->is(RK)) {
1500 deleteToken(DeleteLeft ? Left : Right);
Eric Liu01426ff2016-09-09 17:50:49 +00001501 for (auto *Tok = Left->Next; Tok && Tok != Right; Tok = Tok->Next)
1502 deleteToken(Tok);
Eric Liuce5e4bc2016-05-18 08:02:56 +00001503 // If the right token is deleted, we should keep the left token
1504 // unchanged and pair it with the new right token.
1505 if (!DeleteLeft)
1506 continue;
1507 }
1508 Left = Right;
1509 }
1510 }
1511
1512 template <typename LeftKind, typename RightKind>
1513 void cleanupLeft(FormatToken *Start, LeftKind LK, RightKind RK) {
1514 cleanupPair(Start, LK, RK, /*DeleteLeft=*/true);
1515 }
1516
1517 template <typename LeftKind, typename RightKind>
1518 void cleanupRight(FormatToken *Start, LeftKind LK, RightKind RK) {
1519 cleanupPair(Start, LK, RK, /*DeleteLeft=*/false);
1520 }
1521
Eric Liu4cfb88a2016-04-25 15:09:22 +00001522 // Delete the given token.
1523 inline void deleteToken(FormatToken *Tok) {
1524 if (Tok)
1525 DeletedTokens.insert(Tok);
1526 }
1527
1528 tooling::Replacements generateFixes() {
1529 tooling::Replacements Fixes;
1530 std::vector<FormatToken *> Tokens;
1531 std::copy(DeletedTokens.begin(), DeletedTokens.end(),
1532 std::back_inserter(Tokens));
1533
1534 // Merge multiple continuous token deletions into one big deletion so that
1535 // the number of replacements can be reduced. This makes computing affected
1536 // ranges more efficient when we run reformat on the changed code.
1537 unsigned Idx = 0;
1538 while (Idx < Tokens.size()) {
1539 unsigned St = Idx, End = Idx;
1540 while ((End + 1) < Tokens.size() &&
1541 Tokens[End]->Next == Tokens[End + 1]) {
1542 End++;
1543 }
1544 auto SR = CharSourceRange::getCharRange(Tokens[St]->Tok.getLocation(),
1545 Tokens[End]->Tok.getEndLoc());
Eric Liu40ef2fb2016-08-01 10:16:37 +00001546 auto Err =
1547 Fixes.add(tooling::Replacement(Env.getSourceManager(), SR, ""));
1548 // FIXME: better error handling. for now just print error message and skip
1549 // for the release version.
Piotr Padlewski1ec383c2016-12-23 11:40:44 +00001550 if (Err) {
Eric Liu40ef2fb2016-08-01 10:16:37 +00001551 llvm::errs() << llvm::toString(std::move(Err)) << "\n";
Piotr Padlewski1ec383c2016-12-23 11:40:44 +00001552 assert(false && "Fixes must not conflict!");
1553 }
Eric Liu4cfb88a2016-04-25 15:09:22 +00001554 Idx = End + 1;
1555 }
1556
1557 return Fixes;
1558 }
1559
1560 // Class for less-than inequality comparason for the set `RedundantTokens`.
1561 // We store tokens in the order they appear in the translation unit so that
1562 // we do not need to sort them in `generateFixes()`.
1563 struct FormatTokenLess {
Eric Liu635423e2016-04-28 07:52:03 +00001564 FormatTokenLess(const SourceManager &SM) : SM(SM) {}
Eric Liu4cfb88a2016-04-25 15:09:22 +00001565
Eric Liu2874ac32016-05-18 08:14:49 +00001566 bool operator()(const FormatToken *LHS, const FormatToken *RHS) const {
Eric Liu4cfb88a2016-04-25 15:09:22 +00001567 return SM.isBeforeInTranslationUnit(LHS->Tok.getLocation(),
1568 RHS->Tok.getLocation());
1569 }
Eric Liu635423e2016-04-28 07:52:03 +00001570 const SourceManager &SM;
Eric Liu4cfb88a2016-04-25 15:09:22 +00001571 };
1572
1573 // Tokens to be deleted.
1574 std::set<FormatToken *, FormatTokenLess> DeletedTokens;
Daniel Jasperf7935112012-12-03 18:12:45 +00001575};
1576
Ben Hamiltone2e3e672018-01-17 17:33:08 +00001577class ObjCHeaderStyleGuesser : public TokenAnalyzer {
1578public:
1579 ObjCHeaderStyleGuesser(const Environment &Env, const FormatStyle &Style)
1580 : TokenAnalyzer(Env, Style), IsObjC(false) {}
1581
1582 std::pair<tooling::Replacements, unsigned>
1583 analyze(TokenAnnotator &Annotator,
1584 SmallVectorImpl<AnnotatedLine *> &AnnotatedLines,
1585 FormatTokenLexer &Tokens) override {
1586 assert(Style.Language == FormatStyle::LK_Cpp);
Ben Hamilton0675e872018-11-05 16:59:33 +00001587 IsObjC = guessIsObjC(Env.getSourceManager(), AnnotatedLines,
1588 Tokens.getKeywords());
Ben Hamiltone2e3e672018-01-17 17:33:08 +00001589 tooling::Replacements Result;
1590 return {Result, 0};
1591 }
1592
1593 bool isObjC() { return IsObjC; }
1594
1595private:
Ben Hamilton0675e872018-11-05 16:59:33 +00001596 static bool
1597 guessIsObjC(const SourceManager &SourceManager,
1598 const SmallVectorImpl<AnnotatedLine *> &AnnotatedLines,
1599 const AdditionalKeywords &Keywords) {
Krasimir Georgiev8e216782018-01-17 20:01:02 +00001600 // Keep this array sorted, since we are binary searching over it.
1601 static constexpr llvm::StringLiteral FoundationIdentifiers[] = {
Ben Hamiltone2e3e672018-01-17 17:33:08 +00001602 "CGFloat",
Ben Hamilton19c782d2018-03-22 03:25:22 +00001603 "CGPoint",
1604 "CGPointMake",
1605 "CGPointZero",
1606 "CGRect",
1607 "CGRectEdge",
1608 "CGRectInfinite",
1609 "CGRectMake",
1610 "CGRectNull",
1611 "CGRectZero",
1612 "CGSize",
1613 "CGSizeMake",
1614 "CGVector",
1615 "CGVectorMake",
Ben Hamiltone2e3e672018-01-17 17:33:08 +00001616 "NSAffineTransform",
1617 "NSArray",
1618 "NSAttributedString",
Ben Hamiltonb1a79192018-04-12 15:11:53 +00001619 "NSBlockOperation",
Jacek Olesiakce4f0af2018-02-15 08:47:56 +00001620 "NSBundle",
Ben Hamiltone2e3e672018-01-17 17:33:08 +00001621 "NSCache",
Jacek Olesiakce4f0af2018-02-15 08:47:56 +00001622 "NSCalendar",
Ben Hamiltone2e3e672018-01-17 17:33:08 +00001623 "NSCharacterSet",
1624 "NSCountedSet",
1625 "NSData",
1626 "NSDataDetector",
1627 "NSDecimal",
1628 "NSDecimalNumber",
1629 "NSDictionary",
1630 "NSEdgeInsets",
1631 "NSHashTable",
1632 "NSIndexPath",
1633 "NSIndexSet",
1634 "NSInteger",
Ben Hamiltonb1a79192018-04-12 15:11:53 +00001635 "NSInvocationOperation",
Ben Hamiltone2e3e672018-01-17 17:33:08 +00001636 "NSLocale",
1637 "NSMapTable",
1638 "NSMutableArray",
1639 "NSMutableAttributedString",
1640 "NSMutableCharacterSet",
1641 "NSMutableData",
1642 "NSMutableDictionary",
1643 "NSMutableIndexSet",
1644 "NSMutableOrderedSet",
1645 "NSMutableSet",
1646 "NSMutableString",
1647 "NSNumber",
1648 "NSNumberFormatter",
Jacek Olesiakce4f0af2018-02-15 08:47:56 +00001649 "NSObject",
Ben Hamiltonb1a79192018-04-12 15:11:53 +00001650 "NSOperation",
1651 "NSOperationQueue",
1652 "NSOperationQueuePriority",
Ben Hamiltone2e3e672018-01-17 17:33:08 +00001653 "NSOrderedSet",
1654 "NSPoint",
1655 "NSPointerArray",
Ben Hamiltonb1a79192018-04-12 15:11:53 +00001656 "NSQualityOfService",
Ben Hamiltone2e3e672018-01-17 17:33:08 +00001657 "NSRange",
1658 "NSRect",
1659 "NSRegularExpression",
1660 "NSSet",
1661 "NSSize",
1662 "NSString",
Jacek Olesiakce4f0af2018-02-15 08:47:56 +00001663 "NSTimeZone",
Ben Hamiltone2e3e672018-01-17 17:33:08 +00001664 "NSUInteger",
1665 "NSURL",
1666 "NSURLComponents",
1667 "NSURLQueryItem",
1668 "NSUUID",
Jacek Olesiakce4f0af2018-02-15 08:47:56 +00001669 "NSValue",
Ben Hamilton19c782d2018-03-22 03:25:22 +00001670 "UIImage",
1671 "UIView",
Ben Hamiltone2e3e672018-01-17 17:33:08 +00001672 };
1673
Ben Hamiltonea7a27b2018-03-27 15:01:21 +00001674 for (auto Line : AnnotatedLines) {
1675 for (const FormatToken *FormatTok = Line->First; FormatTok;
Ben Hamiltone2e3e672018-01-17 17:33:08 +00001676 FormatTok = FormatTok->Next) {
Jacek Olesiakce4f0af2018-02-15 08:47:56 +00001677 if ((FormatTok->Previous && FormatTok->Previous->is(tok::at) &&
Ben Hamiltonb1a79192018-04-12 15:11:53 +00001678 (FormatTok->Tok.getObjCKeywordID() != tok::objc_not_keyword ||
Ben Hamiltone2e3e672018-01-17 17:33:08 +00001679 FormatTok->isOneOf(tok::numeric_constant, tok::l_square,
1680 tok::l_brace))) ||
1681 (FormatTok->Tok.isAnyIdentifier() &&
Krasimir Georgiev8e216782018-01-17 20:01:02 +00001682 std::binary_search(std::begin(FoundationIdentifiers),
1683 std::end(FoundationIdentifiers),
1684 FormatTok->TokenText)) ||
Ben Hamiltone2e3e672018-01-17 17:33:08 +00001685 FormatTok->is(TT_ObjCStringLiteral) ||
1686 FormatTok->isOneOf(Keywords.kw_NS_ENUM, Keywords.kw_NS_OPTIONS,
1687 TT_ObjCBlockLBrace, TT_ObjCBlockLParen,
1688 TT_ObjCDecl, TT_ObjCForIn, TT_ObjCMethodExpr,
1689 TT_ObjCMethodSpecifier, TT_ObjCProperty)) {
Ben Hamilton0675e872018-11-05 16:59:33 +00001690 LLVM_DEBUG(llvm::dbgs()
1691 << "Detected ObjC at location "
1692 << FormatTok->Tok.getLocation().printToString(
1693 SourceManager)
1694 << " token: " << FormatTok->TokenText << " token type: "
1695 << getTokenTypeName(FormatTok->Type) << "\n");
Ben Hamiltone2e3e672018-01-17 17:33:08 +00001696 return true;
1697 }
Ben Hamilton0675e872018-11-05 16:59:33 +00001698 if (guessIsObjC(SourceManager, Line->Children, Keywords))
Ben Hamilton6432afe2018-03-22 17:37:19 +00001699 return true;
1700 }
Ben Hamiltone2e3e672018-01-17 17:33:08 +00001701 }
1702 return false;
1703 }
1704
1705 bool IsObjC;
1706};
1707
Daniel Jasperd89ae9d2015-09-23 08:30:47 +00001708struct IncludeDirective {
1709 StringRef Filename;
1710 StringRef Text;
1711 unsigned Offset;
Daniel Jasperd2629dc2015-12-16 10:10:16 +00001712 int Category;
Daniel Jasperd89ae9d2015-09-23 08:30:47 +00001713};
1714
Krasimir Georgiev7e91b032018-10-05 17:19:26 +00001715struct JavaImportDirective {
1716 StringRef Identifier;
1717 StringRef Text;
1718 unsigned Offset;
1719 std::vector<StringRef> AssociatedCommentLines;
1720 bool IsStatic;
1721};
1722
Craig Topperaf35e852013-06-30 22:29:28 +00001723} // end anonymous namespace
1724
Daniel Jasperd89ae9d2015-09-23 08:30:47 +00001725// Determines whether 'Ranges' intersects with ('Start', 'End').
1726static bool affectsRange(ArrayRef<tooling::Range> Ranges, unsigned Start,
1727 unsigned End) {
1728 for (auto Range : Ranges) {
1729 if (Range.getOffset() < End &&
1730 Range.getOffset() + Range.getLength() > Start)
1731 return true;
1732 }
1733 return false;
1734}
1735
Eric Liua992afe2016-08-10 09:32:23 +00001736// Returns a pair (Index, OffsetToEOL) describing the position of the cursor
1737// before sorting/deduplicating. Index is the index of the include under the
1738// cursor in the original set of includes. If this include has duplicates, it is
1739// the index of the first of the duplicates as the others are going to be
1740// removed. OffsetToEOL describes the cursor's position relative to the end of
1741// its current line.
1742// If `Cursor` is not on any #include, `Index` will be UINT_MAX.
1743static std::pair<unsigned, unsigned>
1744FindCursorIndex(const SmallVectorImpl<IncludeDirective> &Includes,
1745 const SmallVectorImpl<unsigned> &Indices, unsigned Cursor) {
1746 unsigned CursorIndex = UINT_MAX;
1747 unsigned OffsetToEOL = 0;
1748 for (int i = 0, e = Includes.size(); i != e; ++i) {
1749 unsigned Start = Includes[Indices[i]].Offset;
1750 unsigned End = Start + Includes[Indices[i]].Text.size();
1751 if (!(Cursor >= Start && Cursor < End))
1752 continue;
1753 CursorIndex = Indices[i];
1754 OffsetToEOL = End - Cursor;
1755 // Put the cursor on the only remaining #include among the duplicate
1756 // #includes.
1757 while (--i >= 0 && Includes[CursorIndex].Text == Includes[Indices[i]].Text)
1758 CursorIndex = i;
1759 break;
1760 }
1761 return std::make_pair(CursorIndex, OffsetToEOL);
1762}
1763
1764// Sorts and deduplicate a block of includes given by 'Includes' alphabetically
1765// adding the necessary replacement to 'Replaces'. 'Includes' must be in strict
1766// source order.
1767// #include directives with the same text will be deduplicated, and only the
1768// first #include in the duplicate #includes remains. If the `Cursor` is
1769// provided and put on a deleted #include, it will be moved to the remaining
1770// #include in the duplicate #includes.
Martin Probstc4a0dd42016-05-20 11:24:24 +00001771static void sortCppIncludes(const FormatStyle &Style,
Eric Liua992afe2016-08-10 09:32:23 +00001772 const SmallVectorImpl<IncludeDirective> &Includes,
1773 ArrayRef<tooling::Range> Ranges, StringRef FileName,
Krasimir Georgiev925bb202019-04-03 15:16:04 +00001774 StringRef Code,
Eric Liua992afe2016-08-10 09:32:23 +00001775 tooling::Replacements &Replaces, unsigned *Cursor) {
1776 unsigned IncludesBeginOffset = Includes.front().Offset;
Daniel Jasperd6a00782016-08-30 21:33:41 +00001777 unsigned IncludesEndOffset =
1778 Includes.back().Offset + Includes.back().Text.size();
1779 unsigned IncludesBlockSize = IncludesEndOffset - IncludesBeginOffset;
1780 if (!affectsRange(Ranges, IncludesBeginOffset, IncludesEndOffset))
Daniel Jasperd89ae9d2015-09-23 08:30:47 +00001781 return;
1782 SmallVector<unsigned, 16> Indices;
1783 for (unsigned i = 0, e = Includes.size(); i != e; ++i)
1784 Indices.push_back(i);
Fangrui Song899d1392019-04-24 14:43:05 +00001785 llvm::stable_sort(Indices, [&](unsigned LHSI, unsigned RHSI) {
1786 return std::tie(Includes[LHSI].Category, Includes[LHSI].Filename) <
1787 std::tie(Includes[RHSI].Category, Includes[RHSI].Filename);
1788 });
Eric Liua992afe2016-08-10 09:32:23 +00001789 // The index of the include on which the cursor will be put after
1790 // sorting/deduplicating.
1791 unsigned CursorIndex;
1792 // The offset from cursor to the end of line.
1793 unsigned CursorToEOLOffset;
1794 if (Cursor)
1795 std::tie(CursorIndex, CursorToEOLOffset) =
1796 FindCursorIndex(Includes, Indices, *Cursor);
1797
1798 // Deduplicate #includes.
1799 Indices.erase(std::unique(Indices.begin(), Indices.end(),
1800 [&](unsigned LHSI, unsigned RHSI) {
1801 return Includes[LHSI].Text == Includes[RHSI].Text;
1802 }),
1803 Indices.end());
Daniel Jasperd89ae9d2015-09-23 08:30:47 +00001804
Krasimir Georgiev4c2c9c32017-11-27 13:23:45 +00001805 int CurrentCategory = Includes.front().Category;
1806
Daniel Jasperd89ae9d2015-09-23 08:30:47 +00001807 // If the #includes are out of order, we generate a single replacement fixing
1808 // the entire block. Otherwise, no replacement is generated.
Krasimir Georgiev925bb202019-04-03 15:16:04 +00001809 // In case Style.IncldueStyle.IncludeBlocks != IBS_Preserve, this check is not
1810 // enough as additional newlines might be added or removed across #include
1811 // blocks. This we handle below by generating the updated #imclude blocks and
1812 // comparing it to the original.
Eric Liua992afe2016-08-10 09:32:23 +00001813 if (Indices.size() == Includes.size() &&
Krasimir Georgiev4c2c9c32017-11-27 13:23:45 +00001814 std::is_sorted(Indices.begin(), Indices.end()) &&
Eric Liu9d92c022018-05-14 19:51:33 +00001815 Style.IncludeStyle.IncludeBlocks == tooling::IncludeStyle::IBS_Preserve)
Daniel Jasperd89ae9d2015-09-23 08:30:47 +00001816 return;
1817
Daniel Jasperb68aabf2015-11-23 08:36:35 +00001818 std::string result;
Daniel Jasperb68aabf2015-11-23 08:36:35 +00001819 for (unsigned Index : Indices) {
Krasimir Georgiev4c2c9c32017-11-27 13:23:45 +00001820 if (!result.empty()) {
Daniel Jasperb68aabf2015-11-23 08:36:35 +00001821 result += "\n";
Eric Liu9d92c022018-05-14 19:51:33 +00001822 if (Style.IncludeStyle.IncludeBlocks ==
1823 tooling::IncludeStyle::IBS_Regroup &&
Krasimir Georgiev4c2c9c32017-11-27 13:23:45 +00001824 CurrentCategory != Includes[Index].Category)
1825 result += "\n";
1826 }
Daniel Jasperb68aabf2015-11-23 08:36:35 +00001827 result += Includes[Index].Text;
Eric Liua992afe2016-08-10 09:32:23 +00001828 if (Cursor && CursorIndex == Index)
1829 *Cursor = IncludesBeginOffset + result.size() - CursorToEOLOffset;
Krasimir Georgiev4c2c9c32017-11-27 13:23:45 +00001830 CurrentCategory = Includes[Index].Category;
Daniel Jasperd89ae9d2015-09-23 08:30:47 +00001831 }
1832
Krasimir Georgiev925bb202019-04-03 15:16:04 +00001833 // If the #includes are out of order, we generate a single replacement fixing
1834 // the entire range of blocks. Otherwise, no replacement is generated.
1835 if (result == Code.substr(IncludesBeginOffset, IncludesBlockSize))
1836 return;
1837
Eric Liu40ef2fb2016-08-01 10:16:37 +00001838 auto Err = Replaces.add(tooling::Replacement(
Eric Liua992afe2016-08-10 09:32:23 +00001839 FileName, Includes.front().Offset, IncludesBlockSize, result));
Eric Liu40ef2fb2016-08-01 10:16:37 +00001840 // FIXME: better error handling. For now, just skip the replacement for the
1841 // release version.
Piotr Padlewski1ec383c2016-12-23 11:40:44 +00001842 if (Err) {
Eric Liu40ef2fb2016-08-01 10:16:37 +00001843 llvm::errs() << llvm::toString(std::move(Err)) << "\n";
Piotr Padlewski1ec383c2016-12-23 11:40:44 +00001844 assert(false);
1845 }
Daniel Jasperd89ae9d2015-09-23 08:30:47 +00001846}
1847
Eric Liu659afd52016-05-31 13:34:20 +00001848namespace {
1849
Krasimir Georgiev7e91b032018-10-05 17:19:26 +00001850const char CppIncludeRegexPattern[] =
Eric Liu659afd52016-05-31 13:34:20 +00001851 R"(^[\t\ ]*#[\t\ ]*(import|include)[^"<]*(["<][^">]*[">]))";
1852
1853} // anonymous namespace
1854
Martin Probstc4a0dd42016-05-20 11:24:24 +00001855tooling::Replacements sortCppIncludes(const FormatStyle &Style, StringRef Code,
1856 ArrayRef<tooling::Range> Ranges,
1857 StringRef FileName,
1858 tooling::Replacements &Replaces,
1859 unsigned *Cursor) {
Daniel Jasperd89ae9d2015-09-23 08:30:47 +00001860 unsigned Prev = 0;
1861 unsigned SearchFrom = 0;
Krasimir Georgiev7e91b032018-10-05 17:19:26 +00001862 llvm::Regex IncludeRegex(CppIncludeRegexPattern);
Daniel Jasperd89ae9d2015-09-23 08:30:47 +00001863 SmallVector<StringRef, 4> Matches;
1864 SmallVector<IncludeDirective, 16> IncludesInBlock;
Daniel Jasper85c472d2015-09-29 07:53:08 +00001865
1866 // In compiled files, consider the first #include to be the main #include of
1867 // the file if it is not a system #include. This ensures that the header
1868 // doesn't have hidden dependencies
1869 // (http://llvm.org/docs/CodingStandards.html#include-style).
1870 //
1871 // FIXME: Do some sanity checking, e.g. edit distance of the base name, to fix
1872 // cases where the first #include is unlikely to be the main header.
Eric Liu7129e632018-05-14 20:17:53 +00001873 tooling::IncludeCategoryManager Categories(Style.IncludeStyle, FileName);
Daniel Jasper32d75fa2015-12-21 13:40:49 +00001874 bool FirstIncludeBlock = true;
Daniel Jaspera252f5d2015-12-21 17:28:24 +00001875 bool MainIncludeFound = false;
Daniel Jasper9b8c7c72015-11-21 09:17:08 +00001876 bool FormattingOff = false;
1877
Daniel Jasperd89ae9d2015-09-23 08:30:47 +00001878 for (;;) {
1879 auto Pos = Code.find('\n', SearchFrom);
1880 StringRef Line =
1881 Code.substr(Prev, (Pos != StringRef::npos ? Pos : Code.size()) - Prev);
Daniel Jasper9b8c7c72015-11-21 09:17:08 +00001882
1883 StringRef Trimmed = Line.trim();
Paul Hoad9b468c02019-03-02 09:08:51 +00001884 if (Trimmed == "// clang-format off" || Trimmed == "/* clang-format off */")
Daniel Jasper9b8c7c72015-11-21 09:17:08 +00001885 FormattingOff = true;
Paul Hoad9b468c02019-03-02 09:08:51 +00001886 else if (Trimmed == "// clang-format on" ||
1887 Trimmed == "/* clang-format on */")
Daniel Jasper9b8c7c72015-11-21 09:17:08 +00001888 FormattingOff = false;
1889
Krasimir Georgiev4c2c9c32017-11-27 13:23:45 +00001890 const bool EmptyLineSkipped =
Eric Liu9d92c022018-05-14 19:51:33 +00001891 Trimmed.empty() &&
1892 (Style.IncludeStyle.IncludeBlocks == tooling::IncludeStyle::IBS_Merge ||
1893 Style.IncludeStyle.IncludeBlocks ==
1894 tooling::IncludeStyle::IBS_Regroup);
Krasimir Georgiev4c2c9c32017-11-27 13:23:45 +00001895
Daniel Jasper9b8c7c72015-11-21 09:17:08 +00001896 if (!FormattingOff && !Line.endswith("\\")) {
Daniel Jasperd89ae9d2015-09-23 08:30:47 +00001897 if (IncludeRegex.match(Line, &Matches)) {
Nico Weberff063702015-10-21 17:13:45 +00001898 StringRef IncludeName = Matches[2];
Eric Liu659afd52016-05-31 13:34:20 +00001899 int Category = Categories.getIncludePriority(
1900 IncludeName,
1901 /*CheckMainHeader=*/!MainIncludeFound && FirstIncludeBlock);
1902 if (Category == 0)
1903 MainIncludeFound = true;
Nico Weberff063702015-10-21 17:13:45 +00001904 IncludesInBlock.push_back({IncludeName, Line, Prev, Category});
Krasimir Georgiev4c2c9c32017-11-27 13:23:45 +00001905 } else if (!IncludesInBlock.empty() && !EmptyLineSkipped) {
Krasimir Georgiev925bb202019-04-03 15:16:04 +00001906 sortCppIncludes(Style, IncludesInBlock, Ranges, FileName, Code,
1907 Replaces, Cursor);
Daniel Jasperd89ae9d2015-09-23 08:30:47 +00001908 IncludesInBlock.clear();
Daniel Jasper32d75fa2015-12-21 13:40:49 +00001909 FirstIncludeBlock = false;
Daniel Jasperd89ae9d2015-09-23 08:30:47 +00001910 }
1911 Prev = Pos + 1;
1912 }
1913 if (Pos == StringRef::npos || Pos + 1 == Code.size())
1914 break;
1915 SearchFrom = Pos + 1;
1916 }
Krasimir Georgiev925bb202019-04-03 15:16:04 +00001917 if (!IncludesInBlock.empty()) {
1918 sortCppIncludes(Style, IncludesInBlock, Ranges, FileName, Code, Replaces,
1919 Cursor);
1920 }
Martin Probstc4a0dd42016-05-20 11:24:24 +00001921 return Replaces;
1922}
1923
Krasimir Georgiev7e91b032018-10-05 17:19:26 +00001924// Returns group number to use as a first order sort on imports. Gives UINT_MAX
1925// if the import does not match any given groups.
1926static unsigned findJavaImportGroup(const FormatStyle &Style,
1927 StringRef ImportIdentifier) {
1928 unsigned LongestMatchIndex = UINT_MAX;
1929 unsigned LongestMatchLength = 0;
1930 for (unsigned I = 0; I < Style.JavaImportGroups.size(); I++) {
1931 std::string GroupPrefix = Style.JavaImportGroups[I];
1932 if (ImportIdentifier.startswith(GroupPrefix) &&
1933 GroupPrefix.length() > LongestMatchLength) {
1934 LongestMatchIndex = I;
1935 LongestMatchLength = GroupPrefix.length();
1936 }
1937 }
1938 return LongestMatchIndex;
1939}
1940
1941// Sorts and deduplicates a block of includes given by 'Imports' based on
1942// JavaImportGroups, then adding the necessary replacement to 'Replaces'.
1943// Import declarations with the same text will be deduplicated. Between each
1944// import group, a newline is inserted, and within each import group, a
1945// lexicographic sort based on ASCII value is performed.
1946static void sortJavaImports(const FormatStyle &Style,
1947 const SmallVectorImpl<JavaImportDirective> &Imports,
1948 ArrayRef<tooling::Range> Ranges, StringRef FileName,
Paul Hoad5bcf99b2019-03-01 09:09:54 +00001949 StringRef Code, tooling::Replacements &Replaces) {
Krasimir Georgiev7e91b032018-10-05 17:19:26 +00001950 unsigned ImportsBeginOffset = Imports.front().Offset;
1951 unsigned ImportsEndOffset =
1952 Imports.back().Offset + Imports.back().Text.size();
1953 unsigned ImportsBlockSize = ImportsEndOffset - ImportsBeginOffset;
1954 if (!affectsRange(Ranges, ImportsBeginOffset, ImportsEndOffset))
1955 return;
1956 SmallVector<unsigned, 16> Indices;
1957 SmallVector<unsigned, 16> JavaImportGroups;
1958 for (unsigned i = 0, e = Imports.size(); i != e; ++i) {
1959 Indices.push_back(i);
1960 JavaImportGroups.push_back(
1961 findJavaImportGroup(Style, Imports[i].Identifier));
1962 }
Mandeep Singh Grangd36da8a2019-01-18 18:45:26 +00001963 llvm::sort(Indices, [&](unsigned LHSI, unsigned RHSI) {
Krasimir Georgiev777bb822019-02-20 11:44:21 +00001964 // Negating IsStatic to push static imports above non-static imports.
1965 return std::make_tuple(!Imports[LHSI].IsStatic, JavaImportGroups[LHSI],
1966 Imports[LHSI].Identifier) <
1967 std::make_tuple(!Imports[RHSI].IsStatic, JavaImportGroups[RHSI],
1968 Imports[RHSI].Identifier);
1969 });
Krasimir Georgiev7e91b032018-10-05 17:19:26 +00001970
1971 // Deduplicate imports.
1972 Indices.erase(std::unique(Indices.begin(), Indices.end(),
1973 [&](unsigned LHSI, unsigned RHSI) {
1974 return Imports[LHSI].Text == Imports[RHSI].Text;
1975 }),
1976 Indices.end());
1977
1978 bool CurrentIsStatic = Imports[Indices.front()].IsStatic;
1979 unsigned CurrentImportGroup = JavaImportGroups[Indices.front()];
1980
1981 std::string result;
1982 for (unsigned Index : Indices) {
1983 if (!result.empty()) {
1984 result += "\n";
1985 if (CurrentIsStatic != Imports[Index].IsStatic ||
1986 CurrentImportGroup != JavaImportGroups[Index])
1987 result += "\n";
1988 }
1989 for (StringRef CommentLine : Imports[Index].AssociatedCommentLines) {
1990 result += CommentLine;
1991 result += "\n";
1992 }
1993 result += Imports[Index].Text;
1994 CurrentIsStatic = Imports[Index].IsStatic;
1995 CurrentImportGroup = JavaImportGroups[Index];
1996 }
1997
Krasimir Georgiev777bb822019-02-20 11:44:21 +00001998 // If the imports are out of order, we generate a single replacement fixing
1999 // the entire block. Otherwise, no replacement is generated.
2000 if (result == Code.substr(Imports.front().Offset, ImportsBlockSize))
2001 return;
2002
Krasimir Georgiev7e91b032018-10-05 17:19:26 +00002003 auto Err = Replaces.add(tooling::Replacement(FileName, Imports.front().Offset,
2004 ImportsBlockSize, result));
2005 // FIXME: better error handling. For now, just skip the replacement for the
2006 // release version.
2007 if (Err) {
2008 llvm::errs() << llvm::toString(std::move(Err)) << "\n";
2009 assert(false);
2010 }
2011}
2012
2013namespace {
2014
2015const char JavaImportRegexPattern[] =
Paul Hoad88335c22019-03-30 13:05:40 +00002016 "^[\t ]*import[\t ]+(static[\t ]*)?([^\t ]*)[\t ]*;";
Krasimir Georgiev7e91b032018-10-05 17:19:26 +00002017
2018} // anonymous namespace
2019
2020tooling::Replacements sortJavaImports(const FormatStyle &Style, StringRef Code,
2021 ArrayRef<tooling::Range> Ranges,
2022 StringRef FileName,
2023 tooling::Replacements &Replaces) {
2024 unsigned Prev = 0;
2025 unsigned SearchFrom = 0;
2026 llvm::Regex ImportRegex(JavaImportRegexPattern);
2027 SmallVector<StringRef, 4> Matches;
2028 SmallVector<JavaImportDirective, 16> ImportsInBlock;
2029 std::vector<StringRef> AssociatedCommentLines;
2030
2031 bool FormattingOff = false;
2032
2033 for (;;) {
2034 auto Pos = Code.find('\n', SearchFrom);
2035 StringRef Line =
2036 Code.substr(Prev, (Pos != StringRef::npos ? Pos : Code.size()) - Prev);
2037
2038 StringRef Trimmed = Line.trim();
2039 if (Trimmed == "// clang-format off")
2040 FormattingOff = true;
2041 else if (Trimmed == "// clang-format on")
2042 FormattingOff = false;
2043
2044 if (ImportRegex.match(Line, &Matches)) {
2045 if (FormattingOff) {
2046 // If at least one import line has formatting turned off, turn off
2047 // formatting entirely.
2048 return Replaces;
2049 }
2050 StringRef Static = Matches[1];
2051 StringRef Identifier = Matches[2];
2052 bool IsStatic = false;
2053 if (Static.contains("static")) {
2054 IsStatic = true;
2055 }
Paul Hoad5bcf99b2019-03-01 09:09:54 +00002056 ImportsInBlock.push_back(
2057 {Identifier, Line, Prev, AssociatedCommentLines, IsStatic});
Krasimir Georgiev7e91b032018-10-05 17:19:26 +00002058 AssociatedCommentLines.clear();
2059 } else if (Trimmed.size() > 0 && !ImportsInBlock.empty()) {
2060 // Associating comments within the imports with the nearest import below
2061 AssociatedCommentLines.push_back(Line);
2062 }
2063 Prev = Pos + 1;
2064 if (Pos == StringRef::npos || Pos + 1 == Code.size())
2065 break;
2066 SearchFrom = Pos + 1;
2067 }
2068 if (!ImportsInBlock.empty())
Krasimir Georgiev777bb822019-02-20 11:44:21 +00002069 sortJavaImports(Style, ImportsInBlock, Ranges, FileName, Code, Replaces);
Krasimir Georgiev7e91b032018-10-05 17:19:26 +00002070 return Replaces;
2071}
2072
Martin Probstfa37b182017-01-27 09:09:11 +00002073bool isMpegTS(StringRef Code) {
2074 // MPEG transport streams use the ".ts" file extension. clang-format should
2075 // not attempt to format those. MPEG TS' frame format starts with 0x47 every
2076 // 189 bytes - detect that and return.
2077 return Code.size() > 188 && Code[0] == 0x47 && Code[188] == 0x47;
2078}
2079
Manuel Klimek89628f62017-09-20 09:51:03 +00002080bool isLikelyXml(StringRef Code) { return Code.ltrim().startswith("<"); }
Krasimir Georgieva2e7d0d2017-08-29 13:51:38 +00002081
Martin Probstc4a0dd42016-05-20 11:24:24 +00002082tooling::Replacements sortIncludes(const FormatStyle &Style, StringRef Code,
2083 ArrayRef<tooling::Range> Ranges,
2084 StringRef FileName, unsigned *Cursor) {
2085 tooling::Replacements Replaces;
2086 if (!Style.SortIncludes)
2087 return Replaces;
Krasimir Georgiev86873032017-08-29 13:57:31 +00002088 if (isLikelyXml(Code))
2089 return Replaces;
2090 if (Style.Language == FormatStyle::LanguageKind::LK_JavaScript &&
2091 isMpegTS(Code))
Martin Probstfa37b182017-01-27 09:09:11 +00002092 return Replaces;
Martin Probstc4a0dd42016-05-20 11:24:24 +00002093 if (Style.Language == FormatStyle::LanguageKind::LK_JavaScript)
2094 return sortJavaScriptImports(Style, Code, Ranges, FileName);
Krasimir Georgiev7e91b032018-10-05 17:19:26 +00002095 if (Style.Language == FormatStyle::LanguageKind::LK_Java)
2096 return sortJavaImports(Style, Code, Ranges, FileName, Replaces);
Martin Probstc4a0dd42016-05-20 11:24:24 +00002097 sortCppIncludes(Style, Code, Ranges, FileName, Replaces, Cursor);
Daniel Jasperd89ae9d2015-09-23 08:30:47 +00002098 return Replaces;
2099}
2100
Eric Liu4cfb88a2016-04-25 15:09:22 +00002101template <typename T>
Eric Liu4f8d9942016-07-11 13:53:12 +00002102static llvm::Expected<tooling::Replacements>
Eric Liu4cfb88a2016-04-25 15:09:22 +00002103processReplacements(T ProcessFunc, StringRef Code,
2104 const tooling::Replacements &Replaces,
2105 const FormatStyle &Style) {
Manuel Klimekb12e5a52016-03-01 12:37:30 +00002106 if (Replaces.empty())
2107 return tooling::Replacements();
2108
Eric Liu4f8d9942016-07-11 13:53:12 +00002109 auto NewCode = applyAllReplacements(Code, Replaces);
2110 if (!NewCode)
2111 return NewCode.takeError();
Eric Liu40ef2fb2016-08-01 10:16:37 +00002112 std::vector<tooling::Range> ChangedRanges = Replaces.getAffectedRanges();
Manuel Klimekb12e5a52016-03-01 12:37:30 +00002113 StringRef FileName = Replaces.begin()->getFilePath();
Eric Liu4cfb88a2016-04-25 15:09:22 +00002114
Manuel Klimekb12e5a52016-03-01 12:37:30 +00002115 tooling::Replacements FormatReplaces =
Eric Liu4f8d9942016-07-11 13:53:12 +00002116 ProcessFunc(Style, *NewCode, ChangedRanges, FileName);
Manuel Klimekb12e5a52016-03-01 12:37:30 +00002117
Eric Liu40ef2fb2016-08-01 10:16:37 +00002118 return Replaces.merge(FormatReplaces);
Manuel Klimekb12e5a52016-03-01 12:37:30 +00002119}
2120
Eric Liu4f8d9942016-07-11 13:53:12 +00002121llvm::Expected<tooling::Replacements>
2122formatReplacements(StringRef Code, const tooling::Replacements &Replaces,
2123 const FormatStyle &Style) {
Eric Liu4cfb88a2016-04-25 15:09:22 +00002124 // We need to use lambda function here since there are two versions of
Eric Liubaf58c22016-05-18 13:43:48 +00002125 // `sortIncludes`.
2126 auto SortIncludes = [](const FormatStyle &Style, StringRef Code,
2127 std::vector<tooling::Range> Ranges,
2128 StringRef FileName) -> tooling::Replacements {
2129 return sortIncludes(Style, Code, Ranges, FileName);
2130 };
Eric Liu4f8d9942016-07-11 13:53:12 +00002131 auto SortedReplaces =
Eric Liubaf58c22016-05-18 13:43:48 +00002132 processReplacements(SortIncludes, Code, Replaces, Style);
Eric Liu4f8d9942016-07-11 13:53:12 +00002133 if (!SortedReplaces)
2134 return SortedReplaces.takeError();
Eric Liubaf58c22016-05-18 13:43:48 +00002135
2136 // We need to use lambda function here since there are two versions of
Eric Liu4cfb88a2016-04-25 15:09:22 +00002137 // `reformat`.
2138 auto Reformat = [](const FormatStyle &Style, StringRef Code,
2139 std::vector<tooling::Range> Ranges,
2140 StringRef FileName) -> tooling::Replacements {
2141 return reformat(Style, Code, Ranges, FileName);
2142 };
Eric Liu4f8d9942016-07-11 13:53:12 +00002143 return processReplacements(Reformat, Code, *SortedReplaces, Style);
Eric Liu4cfb88a2016-04-25 15:09:22 +00002144}
2145
Eric Liu659afd52016-05-31 13:34:20 +00002146namespace {
2147
2148inline bool isHeaderInsertion(const tooling::Replacement &Replace) {
Eric Liuc0d3a802016-09-23 15:10:56 +00002149 return Replace.getOffset() == UINT_MAX && Replace.getLength() == 0 &&
Krasimir Georgiev7e91b032018-10-05 17:19:26 +00002150 llvm::Regex(CppIncludeRegexPattern)
2151 .match(Replace.getReplacementText());
Eric Liu659afd52016-05-31 13:34:20 +00002152}
2153
Eric Liuc0d3a802016-09-23 15:10:56 +00002154inline bool isHeaderDeletion(const tooling::Replacement &Replace) {
2155 return Replace.getOffset() == UINT_MAX && Replace.getLength() == 1;
2156}
2157
Eric Liu659afd52016-05-31 13:34:20 +00002158// FIXME: insert empty lines between newly created blocks.
2159tooling::Replacements
2160fixCppIncludeInsertions(StringRef Code, const tooling::Replacements &Replaces,
2161 const FormatStyle &Style) {
Daniel Jasper1dbc2102017-03-31 13:30:24 +00002162 if (!Style.isCpp())
Eric Liu659afd52016-05-31 13:34:20 +00002163 return Replaces;
2164
2165 tooling::Replacements HeaderInsertions;
Eric Liuc0d3a802016-09-23 15:10:56 +00002166 std::set<llvm::StringRef> HeadersToDelete;
Eric Liu40ef2fb2016-08-01 10:16:37 +00002167 tooling::Replacements Result;
Eric Liu659afd52016-05-31 13:34:20 +00002168 for (const auto &R : Replaces) {
Eric Liu40ef2fb2016-08-01 10:16:37 +00002169 if (isHeaderInsertion(R)) {
2170 // Replacements from \p Replaces must be conflict-free already, so we can
2171 // simply consume the error.
2172 llvm::consumeError(HeaderInsertions.add(R));
Eric Liuc0d3a802016-09-23 15:10:56 +00002173 } else if (isHeaderDeletion(R)) {
2174 HeadersToDelete.insert(R.getReplacementText());
Eric Liu40ef2fb2016-08-01 10:16:37 +00002175 } else if (R.getOffset() == UINT_MAX) {
Eric Liu659afd52016-05-31 13:34:20 +00002176 llvm::errs() << "Insertions other than header #include insertion are "
2177 "not supported! "
2178 << R.getReplacementText() << "\n";
Eric Liu40ef2fb2016-08-01 10:16:37 +00002179 } else {
2180 llvm::consumeError(Result.add(R));
2181 }
Eric Liu659afd52016-05-31 13:34:20 +00002182 }
Eric Liuc0d3a802016-09-23 15:10:56 +00002183 if (HeaderInsertions.empty() && HeadersToDelete.empty())
Eric Liu659afd52016-05-31 13:34:20 +00002184 return Replaces;
Eric Liu659afd52016-05-31 13:34:20 +00002185
Eric Liu659afd52016-05-31 13:34:20 +00002186 StringRef FileName = Replaces.begin()->getFilePath();
Eric Liu7129e632018-05-14 20:17:53 +00002187 tooling::HeaderIncludes Includes(FileName, Code, Style.IncludeStyle);
Eric Liu659afd52016-05-31 13:34:20 +00002188
Eric Liubf4c41c2018-05-04 17:55:13 +00002189 for (const auto &Header : HeadersToDelete) {
2190 tooling::Replacements Replaces =
Eric Liu7129e632018-05-14 20:17:53 +00002191 Includes.remove(Header.trim("\"<>"), Header.startswith("<"));
Eric Liubf4c41c2018-05-04 17:55:13 +00002192 for (const auto &R : Replaces) {
2193 auto Err = Result.add(R);
2194 if (Err) {
2195 // Ignore the deletion on conflict.
2196 llvm::errs() << "Failed to add header deletion replacement for "
2197 << Header << ": " << llvm::toString(std::move(Err))
2198 << "\n";
Eric Liuc0d3a802016-09-23 15:10:56 +00002199 }
Eric Liu659afd52016-05-31 13:34:20 +00002200 }
Eric Liu659afd52016-05-31 13:34:20 +00002201 }
2202
Krasimir Georgiev7e91b032018-10-05 17:19:26 +00002203 llvm::Regex IncludeRegex = llvm::Regex(CppIncludeRegexPattern);
Eric Liubf4c41c2018-05-04 17:55:13 +00002204 llvm::SmallVector<StringRef, 4> Matches;
Eric Liu659afd52016-05-31 13:34:20 +00002205 for (const auto &R : HeaderInsertions) {
2206 auto IncludeDirective = R.getReplacementText();
2207 bool Matched = IncludeRegex.match(IncludeDirective, &Matches);
2208 assert(Matched && "Header insertion replacement must have replacement text "
2209 "'#include ...'");
Benjamin Kramer1cb7ee12016-05-31 14:14:42 +00002210 (void)Matched;
Eric Liu659afd52016-05-31 13:34:20 +00002211 auto IncludeName = Matches[2];
Eric Liubf4c41c2018-05-04 17:55:13 +00002212 auto Replace =
Eric Liu7129e632018-05-14 20:17:53 +00002213 Includes.insert(IncludeName.trim("\"<>"), IncludeName.startswith("<"));
Eric Liubf4c41c2018-05-04 17:55:13 +00002214 if (Replace) {
2215 auto Err = Result.add(*Replace);
2216 if (Err) {
2217 llvm::consumeError(std::move(Err));
Paul Hoad5bcf99b2019-03-01 09:09:54 +00002218 unsigned NewOffset =
2219 Result.getShiftedCodePosition(Replace->getOffset());
Eric Liubf4c41c2018-05-04 17:55:13 +00002220 auto Shifted = tooling::Replacement(FileName, NewOffset, 0,
2221 Replace->getReplacementText());
2222 Result = Result.merge(tooling::Replacements(Shifted));
2223 }
Eric Liu40ef2fb2016-08-01 10:16:37 +00002224 }
Eric Liu659afd52016-05-31 13:34:20 +00002225 }
2226 return Result;
2227}
2228
2229} // anonymous namespace
2230
Eric Liu4f8d9942016-07-11 13:53:12 +00002231llvm::Expected<tooling::Replacements>
Eric Liu4cfb88a2016-04-25 15:09:22 +00002232cleanupAroundReplacements(StringRef Code, const tooling::Replacements &Replaces,
2233 const FormatStyle &Style) {
2234 // We need to use lambda function here since there are two versions of
2235 // `cleanup`.
2236 auto Cleanup = [](const FormatStyle &Style, StringRef Code,
2237 std::vector<tooling::Range> Ranges,
2238 StringRef FileName) -> tooling::Replacements {
2239 return cleanup(Style, Code, Ranges, FileName);
2240 };
Eric Liu659afd52016-05-31 13:34:20 +00002241 // Make header insertion replacements insert new headers into correct blocks.
2242 tooling::Replacements NewReplaces =
2243 fixCppIncludeInsertions(Code, Replaces, Style);
2244 return processReplacements(Cleanup, Code, NewReplaces, Style);
Eric Liu4cfb88a2016-04-25 15:09:22 +00002245}
2246
Krasimir Georgiev9ad83fe2017-10-30 14:01:50 +00002247namespace internal {
2248std::pair<tooling::Replacements, unsigned>
2249reformat(const FormatStyle &Style, StringRef Code,
2250 ArrayRef<tooling::Range> Ranges, unsigned FirstStartColumn,
2251 unsigned NextStartColumn, unsigned LastStartColumn, StringRef FileName,
2252 FormattingAttemptStatus *Status) {
Eric Liu4cfb88a2016-04-25 15:09:22 +00002253 FormatStyle Expanded = expandPresets(Style);
2254 if (Expanded.DisableFormat)
Krasimir Georgiev9ad83fe2017-10-30 14:01:50 +00002255 return {tooling::Replacements(), 0};
Krasimir Georgiev86873032017-08-29 13:57:31 +00002256 if (isLikelyXml(Code))
Krasimir Georgiev9ad83fe2017-10-30 14:01:50 +00002257 return {tooling::Replacements(), 0};
Krasimir Georgiev86873032017-08-29 13:57:31 +00002258 if (Expanded.Language == FormatStyle::LK_JavaScript && isMpegTS(Code))
Krasimir Georgiev9ad83fe2017-10-30 14:01:50 +00002259 return {tooling::Replacements(), 0};
Daniel Jasper496c1992016-09-07 22:48:53 +00002260
Krasimir Georgiev9ad83fe2017-10-30 14:01:50 +00002261 typedef std::function<std::pair<tooling::Replacements, unsigned>(
2262 const Environment &)>
Krasimir Georgievac16a202017-06-23 11:46:03 +00002263 AnalyzerPass;
2264 SmallVector<AnalyzerPass, 4> Passes;
Krasimir Georgiev32eaa862017-03-01 15:35:39 +00002265
Krasimir Georgievac16a202017-06-23 11:46:03 +00002266 if (Style.Language == FormatStyle::LK_Cpp) {
2267 if (Style.FixNamespaceComments)
2268 Passes.emplace_back([&](const Environment &Env) {
2269 return NamespaceEndCommentsFixer(Env, Expanded).process();
2270 });
2271
2272 if (Style.SortUsingDeclarations)
2273 Passes.emplace_back([&](const Environment &Env) {
2274 return UsingDeclarationsSorter(Env, Expanded).process();
2275 });
Krasimir Georgiev32eaa862017-03-01 15:35:39 +00002276 }
2277
2278 if (Style.Language == FormatStyle::LK_JavaScript &&
Krasimir Georgievac16a202017-06-23 11:46:03 +00002279 Style.JavaScriptQuotes != FormatStyle::JSQS_Leave)
2280 Passes.emplace_back([&](const Environment &Env) {
2281 return JavaScriptRequoter(Env, Expanded).process();
2282 });
2283
2284 Passes.emplace_back([&](const Environment &Env) {
2285 return Formatter(Env, Expanded, Status).process();
2286 });
2287
Eric Liu2e538082018-05-09 21:35:52 +00002288 auto Env =
2289 llvm::make_unique<Environment>(Code, FileName, Ranges, FirstStartColumn,
2290 NextStartColumn, LastStartColumn);
Krasimir Georgievac16a202017-06-23 11:46:03 +00002291 llvm::Optional<std::string> CurrentCode = None;
2292 tooling::Replacements Fixes;
Krasimir Georgiev9ad83fe2017-10-30 14:01:50 +00002293 unsigned Penalty = 0;
Krasimir Georgievac16a202017-06-23 11:46:03 +00002294 for (size_t I = 0, E = Passes.size(); I < E; ++I) {
Krasimir Georgiev9ad83fe2017-10-30 14:01:50 +00002295 std::pair<tooling::Replacements, unsigned> PassFixes = Passes[I](*Env);
Krasimir Georgievac16a202017-06-23 11:46:03 +00002296 auto NewCode = applyAllReplacements(
Krasimir Georgiev9ad83fe2017-10-30 14:01:50 +00002297 CurrentCode ? StringRef(*CurrentCode) : Code, PassFixes.first);
Krasimir Georgievac16a202017-06-23 11:46:03 +00002298 if (NewCode) {
Krasimir Georgiev9ad83fe2017-10-30 14:01:50 +00002299 Fixes = Fixes.merge(PassFixes.first);
2300 Penalty += PassFixes.second;
Krasimir Georgievac16a202017-06-23 11:46:03 +00002301 if (I + 1 < E) {
2302 CurrentCode = std::move(*NewCode);
Eric Liu2e538082018-05-09 21:35:52 +00002303 Env = llvm::make_unique<Environment>(
Krasimir Georgievac16a202017-06-23 11:46:03 +00002304 *CurrentCode, FileName,
Krasimir Georgiev9ad83fe2017-10-30 14:01:50 +00002305 tooling::calculateRangesAfterReplacements(Fixes, Ranges),
2306 FirstStartColumn, NextStartColumn, LastStartColumn);
Krasimir Georgievac16a202017-06-23 11:46:03 +00002307 }
2308 }
Daniel Jasper496c1992016-09-07 22:48:53 +00002309 }
2310
Krasimir Georgiev9ad83fe2017-10-30 14:01:50 +00002311 return {Fixes, Penalty};
2312}
2313} // namespace internal
2314
2315tooling::Replacements reformat(const FormatStyle &Style, StringRef Code,
2316 ArrayRef<tooling::Range> Ranges,
2317 StringRef FileName,
2318 FormattingAttemptStatus *Status) {
2319 return internal::reformat(Style, Code, Ranges,
2320 /*FirstStartColumn=*/0,
2321 /*NextStartColumn=*/0,
2322 /*LastStartColumn=*/0, FileName, Status)
2323 .first;
Eric Liu4cfb88a2016-04-25 15:09:22 +00002324}
2325
Eric Liu4cfb88a2016-04-25 15:09:22 +00002326tooling::Replacements cleanup(const FormatStyle &Style, StringRef Code,
2327 ArrayRef<tooling::Range> Ranges,
2328 StringRef FileName) {
Martin Probst816a9662017-05-29 08:41:11 +00002329 // cleanups only apply to C++ (they mostly concern ctor commas etc.)
2330 if (Style.Language != FormatStyle::LK_Cpp)
2331 return tooling::Replacements();
Eric Liu2e538082018-05-09 21:35:52 +00002332 return Cleaner(Environment(Code, FileName, Ranges), Style).process().first;
Daniel Jasperec04c0d2013-05-16 10:40:07 +00002333}
2334
Krasimir Georgievbcda54b2017-04-21 14:35:20 +00002335tooling::Replacements reformat(const FormatStyle &Style, StringRef Code,
2336 ArrayRef<tooling::Range> Ranges,
2337 StringRef FileName, bool *IncompleteFormat) {
2338 FormattingAttemptStatus Status;
2339 auto Result = reformat(Style, Code, Ranges, FileName, &Status);
2340 if (!Status.FormatComplete)
2341 *IncompleteFormat = true;
2342 return Result;
2343}
2344
Krasimir Georgiev7cb267a2017-02-27 13:28:36 +00002345tooling::Replacements fixNamespaceEndComments(const FormatStyle &Style,
2346 StringRef Code,
2347 ArrayRef<tooling::Range> Ranges,
2348 StringRef FileName) {
Eric Liu2e538082018-05-09 21:35:52 +00002349 return NamespaceEndCommentsFixer(Environment(Code, FileName, Ranges), Style)
2350 .process()
2351 .first;
Krasimir Georgiev7cb267a2017-02-27 13:28:36 +00002352}
2353
Krasimir Georgievb03877a2017-06-21 12:03:12 +00002354tooling::Replacements sortUsingDeclarations(const FormatStyle &Style,
2355 StringRef Code,
2356 ArrayRef<tooling::Range> Ranges,
2357 StringRef FileName) {
Eric Liu2e538082018-05-09 21:35:52 +00002358 return UsingDeclarationsSorter(Environment(Code, FileName, Ranges), Style)
2359 .process()
2360 .first;
Krasimir Georgievb03877a2017-06-21 12:03:12 +00002361}
2362
Daniel Jasper4db69bd2014-09-04 18:23:42 +00002363LangOptions getFormattingLangOpts(const FormatStyle &Style) {
Daniel Jasperc1fa2812013-01-10 13:08:12 +00002364 LangOptions LangOpts;
2365 LangOpts.CPlusPlus = 1;
Daniel Jasper4db69bd2014-09-04 18:23:42 +00002366 LangOpts.CPlusPlus11 = Style.Standard == FormatStyle::LS_Cpp03 ? 0 : 1;
2367 LangOpts.CPlusPlus14 = Style.Standard == FormatStyle::LS_Cpp03 ? 0 : 1;
Aaron Ballmanc351fba2017-12-04 20:27:34 +00002368 LangOpts.CPlusPlus17 = Style.Standard == FormatStyle::LS_Cpp03 ? 0 : 1;
Richard Smithc70f1d62017-12-14 15:16:18 +00002369 LangOpts.CPlusPlus2a = Style.Standard == FormatStyle::LS_Cpp03 ? 0 : 1;
Daniel Jasper55213652013-03-22 10:01:29 +00002370 LangOpts.LineComment = 1;
Daniel Jasper1dbc2102017-03-31 13:30:24 +00002371 bool AlternativeOperators = Style.isCpp();
Daniel Jasper30a24062014-11-14 09:02:28 +00002372 LangOpts.CXXOperatorNames = AlternativeOperators ? 1 : 0;
Daniel Jasperc1fa2812013-01-10 13:08:12 +00002373 LangOpts.Bool = 1;
Erik Pilkingtonfa983902018-10-30 20:31:30 +00002374 LangOpts.ObjC = 1;
Eric Liu4cfb88a2016-04-25 15:09:22 +00002375 LangOpts.MicrosoftExt = 1; // To get kw___try, kw___finally.
Saleem Abdulrasoold170c4b2015-10-04 17:51:05 +00002376 LangOpts.DeclSpecKeyword = 1; // To get __declspec.
Daniel Jasperc1fa2812013-01-10 13:08:12 +00002377 return LangOpts;
2378}
2379
Edwin Vaned544aa72013-09-30 13:31:48 +00002380const char *StyleOptionHelpDescription =
2381 "Coding style, currently supports:\n"
2382 " LLVM, Google, Chromium, Mozilla, WebKit.\n"
2383 "Use -style=file to load style configuration from\n"
2384 ".clang-format file located in one of the parent\n"
2385 "directories of the source file (or current\n"
2386 "directory for stdin).\n"
2387 "Use -style=\"{key: value, ...}\" to set specific\n"
2388 "parameters, e.g.:\n"
2389 " -style=\"{BasedOnStyle: llvm, IndentWidth: 8}\"";
2390
Alexander Kornienkoc1637f12013-12-10 11:28:13 +00002391static FormatStyle::LanguageKind getLanguageByFileName(StringRef FileName) {
Daniel Jasper498f5582015-12-25 08:53:31 +00002392 if (FileName.endswith(".java"))
Daniel Jasperc58c70e2014-09-15 11:21:46 +00002393 return FormatStyle::LK_Java;
Daniel Jasper498f5582015-12-25 08:53:31 +00002394 if (FileName.endswith_lower(".js") || FileName.endswith_lower(".ts"))
2395 return FormatStyle::LK_JavaScript; // JavaScript or TypeScript.
Daniel Jasper03a04fe2016-12-12 12:42:29 +00002396 if (FileName.endswith(".m") || FileName.endswith(".mm"))
2397 return FormatStyle::LK_ObjC;
Daniel Jasper498f5582015-12-25 08:53:31 +00002398 if (FileName.endswith_lower(".proto") ||
2399 FileName.endswith_lower(".protodevel"))
Daniel Jasper7052ce62014-01-19 09:04:08 +00002400 return FormatStyle::LK_Proto;
Krasimir Georgiev66496652017-11-17 15:10:49 +00002401 if (FileName.endswith_lower(".textpb") ||
2402 FileName.endswith_lower(".pb.txt") ||
2403 FileName.endswith_lower(".textproto") ||
2404 FileName.endswith_lower(".asciipb"))
2405 return FormatStyle::LK_TextProto;
Daniel Jasper498f5582015-12-25 08:53:31 +00002406 if (FileName.endswith_lower(".td"))
2407 return FormatStyle::LK_TableGen;
Paul Hoadcbb726d2019-03-21 13:09:22 +00002408 if (FileName.endswith_lower(".cs"))
2409 return FormatStyle::LK_CSharp;
Alexander Kornienkoc1637f12013-12-10 11:28:13 +00002410 return FormatStyle::LK_Cpp;
Alexander Kornienkocabdd732013-11-29 15:19:43 +00002411}
2412
Ben Hamilton3b345c32018-02-21 15:54:31 +00002413FormatStyle::LanguageKind guessLanguage(StringRef FileName, StringRef Code) {
Ben Hamilton6e066352018-02-27 15:56:40 +00002414 const auto GuessedLanguage = getLanguageByFileName(FileName);
2415 if (GuessedLanguage == FormatStyle::LK_Cpp) {
Ben Hamilton07e58362018-02-21 21:27:27 +00002416 auto Extension = llvm::sys::path::extension(FileName);
Ben Hamilton3b345c32018-02-21 15:54:31 +00002417 // If there's no file extension (or it's .h), we need to check the contents
2418 // of the code to see if it contains Objective-C.
Ben Hamilton07e58362018-02-21 21:27:27 +00002419 if (Extension.empty() || Extension == ".h") {
2420 auto NonEmptyFileName = FileName.empty() ? "guess.h" : FileName;
Eric Liu2e538082018-05-09 21:35:52 +00002421 Environment Env(Code, NonEmptyFileName, /*Ranges=*/{});
2422 ObjCHeaderStyleGuesser Guesser(Env, getLLVMStyle());
Ben Hamilton3b345c32018-02-21 15:54:31 +00002423 Guesser.process();
Ben Hamilton6e066352018-02-27 15:56:40 +00002424 if (Guesser.isObjC())
2425 return FormatStyle::LK_ObjC;
Ben Hamilton3b345c32018-02-21 15:54:31 +00002426 }
2427 }
Ben Hamilton6e066352018-02-27 15:56:40 +00002428 return GuessedLanguage;
Ben Hamilton3b345c32018-02-21 15:54:31 +00002429}
2430
Eric Liub4adc912018-06-25 16:29:19 +00002431const char *DefaultFormatStyle = "file";
2432
2433const char *DefaultFallbackStyle = "LLVM";
2434
Antonio Maiorano3adfb6a2017-01-17 00:12:27 +00002435llvm::Expected<FormatStyle> getStyle(StringRef StyleName, StringRef FileName,
Antonio Maiorano7eb75072017-01-20 01:22:42 +00002436 StringRef FallbackStyleName,
Jonas Devliegherefc514902018-10-10 13:27:25 +00002437 StringRef Code,
2438 llvm::vfs::FileSystem *FS) {
Eric Liu547d8792016-03-24 13:22:42 +00002439 if (!FS) {
Jonas Devliegherefc514902018-10-10 13:27:25 +00002440 FS = llvm::vfs::getRealFileSystem().get();
Eric Liu547d8792016-03-24 13:22:42 +00002441 }
Jordan Rupprecht8bd97e72019-02-28 19:16:45 +00002442 FormatStyle Style = getLLVMStyle(guessLanguage(FileName, Code));
Daniel Jasper03a04fe2016-12-12 12:42:29 +00002443
Antonio Maiorano7eb75072017-01-20 01:22:42 +00002444 FormatStyle FallbackStyle = getNoStyle();
2445 if (!getPredefinedStyle(FallbackStyleName, Style.Language, &FallbackStyle))
2446 return make_string_error("Invalid fallback style \"" + FallbackStyleName);
Edwin Vaned544aa72013-09-30 13:31:48 +00002447
2448 if (StyleName.startswith("{")) {
2449 // Parse YAML/JSON style from the command line.
Antonio Maiorano3adfb6a2017-01-17 00:12:27 +00002450 if (std::error_code ec = parseConfiguration(StyleName, &Style))
2451 return make_string_error("Error parsing -style: " + ec.message());
Edwin Vaned544aa72013-09-30 13:31:48 +00002452 return Style;
2453 }
2454
2455 if (!StyleName.equals_lower("file")) {
Alexander Kornienkoc1637f12013-12-10 11:28:13 +00002456 if (!getPredefinedStyle(StyleName, Style.Language, &Style))
Antonio Maiorano3adfb6a2017-01-17 00:12:27 +00002457 return make_string_error("Invalid value for -style");
Edwin Vaned544aa72013-09-30 13:31:48 +00002458 return Style;
2459 }
2460
Alexander Kornienkoc1637f12013-12-10 11:28:13 +00002461 // Look for .clang-format/_clang-format file in the file's parent directories.
Alexander Kornienkocabdd732013-11-29 15:19:43 +00002462 SmallString<128> UnsuitableConfigFiles;
Edwin Vaned544aa72013-09-30 13:31:48 +00002463 SmallString<128> Path(FileName);
Antonio Maiorano3adfb6a2017-01-17 00:12:27 +00002464 if (std::error_code EC = FS->makeAbsolute(Path))
2465 return make_string_error(EC.message());
Antonio Maiorano34c03762016-12-22 05:10:07 +00002466
Alexander Kornienkoe2e03872013-10-14 00:46:35 +00002467 for (StringRef Directory = Path; !Directory.empty();
Edwin Vaned544aa72013-09-30 13:31:48 +00002468 Directory = llvm::sys::path::parent_path(Directory)) {
Eric Liu547d8792016-03-24 13:22:42 +00002469
2470 auto Status = FS->status(Directory);
2471 if (!Status ||
2472 Status->getType() != llvm::sys::fs::file_type::directory_file) {
Edwin Vaned544aa72013-09-30 13:31:48 +00002473 continue;
Eric Liu547d8792016-03-24 13:22:42 +00002474 }
2475
Edwin Vaned544aa72013-09-30 13:31:48 +00002476 SmallString<128> ConfigFile(Directory);
2477
2478 llvm::sys::path::append(ConfigFile, ".clang-format");
Nicola Zaghen3538b392018-05-15 13:30:56 +00002479 LLVM_DEBUG(llvm::dbgs() << "Trying " << ConfigFile << "...\n");
Eric Liud4758322016-03-24 13:22:37 +00002480
Eric Liu547d8792016-03-24 13:22:42 +00002481 Status = FS->status(ConfigFile.str());
Antonio Maiorano3adfb6a2017-01-17 00:12:27 +00002482 bool FoundConfigFile =
Eric Liu547d8792016-03-24 13:22:42 +00002483 Status && (Status->getType() == llvm::sys::fs::file_type::regular_file);
Antonio Maiorano3adfb6a2017-01-17 00:12:27 +00002484 if (!FoundConfigFile) {
Edwin Vaned544aa72013-09-30 13:31:48 +00002485 // Try _clang-format too, since dotfiles are not commonly used on Windows.
2486 ConfigFile = Directory;
2487 llvm::sys::path::append(ConfigFile, "_clang-format");
Nicola Zaghen3538b392018-05-15 13:30:56 +00002488 LLVM_DEBUG(llvm::dbgs() << "Trying " << ConfigFile << "...\n");
Eric Liu547d8792016-03-24 13:22:42 +00002489 Status = FS->status(ConfigFile.str());
Antonio Maiorano3adfb6a2017-01-17 00:12:27 +00002490 FoundConfigFile = Status && (Status->getType() ==
2491 llvm::sys::fs::file_type::regular_file);
Edwin Vaned544aa72013-09-30 13:31:48 +00002492 }
2493
Antonio Maiorano3adfb6a2017-01-17 00:12:27 +00002494 if (FoundConfigFile) {
Rafael Espindola2d2b4202014-07-06 17:43:24 +00002495 llvm::ErrorOr<std::unique_ptr<llvm::MemoryBuffer>> Text =
Eric Liu547d8792016-03-24 13:22:42 +00002496 FS->getBufferForFile(ConfigFile.str());
Antonio Maiorano3adfb6a2017-01-17 00:12:27 +00002497 if (std::error_code EC = Text.getError())
2498 return make_string_error(EC.message());
Rafael Espindola2d2b4202014-07-06 17:43:24 +00002499 if (std::error_code ec =
2500 parseConfiguration(Text.get()->getBuffer(), &Style)) {
Rafael Espindolad0136702014-06-12 02:50:04 +00002501 if (ec == ParseError::Unsuitable) {
Alexander Kornienkocabdd732013-11-29 15:19:43 +00002502 if (!UnsuitableConfigFiles.empty())
2503 UnsuitableConfigFiles.append(", ");
2504 UnsuitableConfigFiles.append(ConfigFile);
Alexander Kornienkobc4ae442013-12-02 15:21:38 +00002505 continue;
Alexander Kornienkocabdd732013-11-29 15:19:43 +00002506 }
Antonio Maiorano3adfb6a2017-01-17 00:12:27 +00002507 return make_string_error("Error reading " + ConfigFile + ": " +
2508 ec.message());
Edwin Vaned544aa72013-09-30 13:31:48 +00002509 }
Nicola Zaghen3538b392018-05-15 13:30:56 +00002510 LLVM_DEBUG(llvm::dbgs()
2511 << "Using configuration file " << ConfigFile << "\n");
Edwin Vaned544aa72013-09-30 13:31:48 +00002512 return Style;
2513 }
2514 }
Antonio Maiorano3adfb6a2017-01-17 00:12:27 +00002515 if (!UnsuitableConfigFiles.empty())
2516 return make_string_error("Configuration file(s) do(es) not support " +
2517 getLanguageName(Style.Language) + ": " +
2518 UnsuitableConfigFiles);
Antonio Maiorano7eb75072017-01-20 01:22:42 +00002519 return FallbackStyle;
Edwin Vaned544aa72013-09-30 13:31:48 +00002520}
2521
Daniel Jasper8d1832e2013-01-07 13:26:07 +00002522} // namespace format
2523} // namespace clang