blob: 9575699cf82f49214f9218c482704aa6c1ed4280 [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);
Alexander Kornienko6d2c88e2013-12-10 10:30:34 +000064 }
65};
66
67template <> struct ScalarEnumerationTraits<FormatStyle::LanguageStandard> {
68 static void enumeration(IO &IO, FormatStyle::LanguageStandard &Value) {
69 IO.enumCase(Value, "Cpp03", FormatStyle::LS_Cpp03);
70 IO.enumCase(Value, "C++03", FormatStyle::LS_Cpp03);
71 IO.enumCase(Value, "Cpp11", FormatStyle::LS_Cpp11);
72 IO.enumCase(Value, "C++11", FormatStyle::LS_Cpp11);
73 IO.enumCase(Value, "Auto", FormatStyle::LS_Auto);
74 }
75};
76
77template <> struct ScalarEnumerationTraits<FormatStyle::UseTabStyle> {
78 static void enumeration(IO &IO, FormatStyle::UseTabStyle &Value) {
79 IO.enumCase(Value, "Never", FormatStyle::UT_Never);
80 IO.enumCase(Value, "false", FormatStyle::UT_Never);
81 IO.enumCase(Value, "Always", FormatStyle::UT_Always);
82 IO.enumCase(Value, "true", FormatStyle::UT_Always);
83 IO.enumCase(Value, "ForIndentation", FormatStyle::UT_ForIndentation);
Marianne Mailhot-Sarrasin51fe2792016-04-14 14:52:26 +000084 IO.enumCase(Value, "ForContinuationAndIndentation",
85 FormatStyle::UT_ForContinuationAndIndentation);
Alexander Kornienko6d2c88e2013-12-10 10:30:34 +000086 }
87};
88
Daniel Jasperabd1f572016-03-02 22:44:03 +000089template <> struct ScalarEnumerationTraits<FormatStyle::JavaScriptQuoteStyle> {
90 static void enumeration(IO &IO, FormatStyle::JavaScriptQuoteStyle &Value) {
91 IO.enumCase(Value, "Leave", FormatStyle::JSQS_Leave);
92 IO.enumCase(Value, "Single", FormatStyle::JSQS_Single);
93 IO.enumCase(Value, "Double", FormatStyle::JSQS_Double);
94 }
95};
96
Daniel Jasperd74cf402014-04-08 12:46:38 +000097template <> struct ScalarEnumerationTraits<FormatStyle::ShortFunctionStyle> {
98 static void enumeration(IO &IO, FormatStyle::ShortFunctionStyle &Value) {
99 IO.enumCase(Value, "None", FormatStyle::SFS_None);
100 IO.enumCase(Value, "false", FormatStyle::SFS_None);
101 IO.enumCase(Value, "All", FormatStyle::SFS_All);
102 IO.enumCase(Value, "true", FormatStyle::SFS_All);
103 IO.enumCase(Value, "Inline", FormatStyle::SFS_Inline);
Francois Ferrandd3f0e3d2017-06-21 13:56:02 +0000104 IO.enumCase(Value, "InlineOnly", FormatStyle::SFS_InlineOnly);
Daniel Jasper9e709352014-11-26 10:43:58 +0000105 IO.enumCase(Value, "Empty", FormatStyle::SFS_Empty);
Daniel Jasperd74cf402014-04-08 12:46:38 +0000106 }
107};
108
Ben Hamilton4dc658c2018-02-02 20:15:14 +0000109template <> struct ScalarEnumerationTraits<FormatStyle::BinPackStyle> {
110 static void enumeration(IO &IO, FormatStyle::BinPackStyle &Value) {
111 IO.enumCase(Value, "Auto", FormatStyle::BPS_Auto);
112 IO.enumCase(Value, "Always", FormatStyle::BPS_Always);
113 IO.enumCase(Value, "Never", FormatStyle::BPS_Never);
114 }
115};
116
Daniel Jasperac043c92014-09-15 11:11:00 +0000117template <> struct ScalarEnumerationTraits<FormatStyle::BinaryOperatorStyle> {
118 static void enumeration(IO &IO, FormatStyle::BinaryOperatorStyle &Value) {
119 IO.enumCase(Value, "All", FormatStyle::BOS_All);
120 IO.enumCase(Value, "true", FormatStyle::BOS_All);
121 IO.enumCase(Value, "None", FormatStyle::BOS_None);
122 IO.enumCase(Value, "false", FormatStyle::BOS_None);
123 IO.enumCase(Value, "NonAssignment", FormatStyle::BOS_NonAssignment);
124 }
125};
126
Alexander Kornienko6d2c88e2013-12-10 10:30:34 +0000127template <> struct ScalarEnumerationTraits<FormatStyle::BraceBreakingStyle> {
128 static void enumeration(IO &IO, FormatStyle::BraceBreakingStyle &Value) {
129 IO.enumCase(Value, "Attach", FormatStyle::BS_Attach);
130 IO.enumCase(Value, "Linux", FormatStyle::BS_Linux);
Birunthan Mohanathas305fa9c2015-07-12 03:13:54 +0000131 IO.enumCase(Value, "Mozilla", FormatStyle::BS_Mozilla);
Alexander Kornienko6d2c88e2013-12-10 10:30:34 +0000132 IO.enumCase(Value, "Stroustrup", FormatStyle::BS_Stroustrup);
133 IO.enumCase(Value, "Allman", FormatStyle::BS_Allman);
Alexander Kornienko3a33f022013-12-12 09:49:52 +0000134 IO.enumCase(Value, "GNU", FormatStyle::BS_GNU);
Roman Kashitsyn291f64f2015-08-10 13:43:19 +0000135 IO.enumCase(Value, "WebKit", FormatStyle::BS_WebKit);
Daniel Jasperc1bc38e2015-09-29 14:57:55 +0000136 IO.enumCase(Value, "Custom", FormatStyle::BS_Custom);
Alexander Kornienko6d2c88e2013-12-10 10:30:34 +0000137 }
138};
139
Manuel Klimek89628f62017-09-20 09:51:03 +0000140template <>
141struct ScalarEnumerationTraits<FormatStyle::BreakConstructorInitializersStyle> {
142 static void
143 enumeration(IO &IO, FormatStyle::BreakConstructorInitializersStyle &Value) {
Francois Ferranda6b6d512017-05-24 11:36:58 +0000144 IO.enumCase(Value, "BeforeColon", FormatStyle::BCIS_BeforeColon);
145 IO.enumCase(Value, "BeforeComma", FormatStyle::BCIS_BeforeComma);
146 IO.enumCase(Value, "AfterColon", FormatStyle::BCIS_AfterColon);
147 }
148};
149
Daniel Jasperc1bc38e2015-09-29 14:57:55 +0000150template <>
Francois Ferrand6bb103f2018-06-11 14:41:26 +0000151struct ScalarEnumerationTraits<FormatStyle::BreakInheritanceListStyle> {
152 static void
153 enumeration(IO &IO, FormatStyle::BreakInheritanceListStyle &Value) {
154 IO.enumCase(Value, "BeforeColon", FormatStyle::BILS_BeforeColon);
155 IO.enumCase(Value, "BeforeComma", FormatStyle::BILS_BeforeComma);
156 IO.enumCase(Value, "AfterColon", FormatStyle::BILS_AfterColon);
157 }
158};
159
160template <>
Krasimir Georgievad47c902017-08-30 14:34:57 +0000161struct ScalarEnumerationTraits<FormatStyle::PPDirectiveIndentStyle> {
162 static void enumeration(IO &IO, FormatStyle::PPDirectiveIndentStyle &Value) {
163 IO.enumCase(Value, "None", FormatStyle::PPDIS_None);
164 IO.enumCase(Value, "AfterHash", FormatStyle::PPDIS_AfterHash);
165 }
166};
167
168template <>
Zachary Turner448592e2015-12-18 22:20:15 +0000169struct ScalarEnumerationTraits<FormatStyle::ReturnTypeBreakingStyle> {
170 static void enumeration(IO &IO, FormatStyle::ReturnTypeBreakingStyle &Value) {
171 IO.enumCase(Value, "None", FormatStyle::RTBS_None);
172 IO.enumCase(Value, "All", FormatStyle::RTBS_All);
173 IO.enumCase(Value, "TopLevel", FormatStyle::RTBS_TopLevel);
174 IO.enumCase(Value, "TopLevelDefinitions",
175 FormatStyle::RTBS_TopLevelDefinitions);
176 IO.enumCase(Value, "AllDefinitions", FormatStyle::RTBS_AllDefinitions);
177 }
178};
179
180template <>
Francois Ferrand58e6fe52018-05-16 08:25:03 +0000181struct ScalarEnumerationTraits<FormatStyle::BreakTemplateDeclarationsStyle> {
182 static void enumeration(IO &IO, FormatStyle::BreakTemplateDeclarationsStyle &Value) {
183 IO.enumCase(Value, "No", FormatStyle::BTDS_No);
184 IO.enumCase(Value, "MultiLine", FormatStyle::BTDS_MultiLine);
185 IO.enumCase(Value, "Yes", FormatStyle::BTDS_Yes);
186
187 // For backward compatibility.
188 IO.enumCase(Value, "false", FormatStyle::BTDS_MultiLine);
189 IO.enumCase(Value, "true", FormatStyle::BTDS_Yes);
190 }
191};
192
193template <>
Daniel Jasperc1bc38e2015-09-29 14:57:55 +0000194struct ScalarEnumerationTraits<FormatStyle::DefinitionReturnTypeBreakingStyle> {
195 static void
196 enumeration(IO &IO, FormatStyle::DefinitionReturnTypeBreakingStyle &Value) {
Birunthan Mohanathasa0388a82015-06-29 15:30:42 +0000197 IO.enumCase(Value, "None", FormatStyle::DRTBS_None);
198 IO.enumCase(Value, "All", FormatStyle::DRTBS_All);
199 IO.enumCase(Value, "TopLevel", FormatStyle::DRTBS_TopLevel);
200
201 // For backward compatibility.
202 IO.enumCase(Value, "false", FormatStyle::DRTBS_None);
203 IO.enumCase(Value, "true", FormatStyle::DRTBS_All);
204 }
205};
206
Alexander Kornienkod6538332013-05-07 15:32:14 +0000207template <>
Alexander Kornienko6d2c88e2013-12-10 10:30:34 +0000208struct ScalarEnumerationTraits<FormatStyle::NamespaceIndentationKind> {
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000209 static void enumeration(IO &IO,
Alexander Kornienko6d2c88e2013-12-10 10:30:34 +0000210 FormatStyle::NamespaceIndentationKind &Value) {
211 IO.enumCase(Value, "None", FormatStyle::NI_None);
212 IO.enumCase(Value, "Inner", FormatStyle::NI_Inner);
213 IO.enumCase(Value, "All", FormatStyle::NI_All);
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000214 }
215};
216
Daniel Jasper6501f7e2015-10-27 12:38:37 +0000217template <> struct ScalarEnumerationTraits<FormatStyle::BracketAlignmentStyle> {
218 static void enumeration(IO &IO, FormatStyle::BracketAlignmentStyle &Value) {
219 IO.enumCase(Value, "Align", FormatStyle::BAS_Align);
220 IO.enumCase(Value, "DontAlign", FormatStyle::BAS_DontAlign);
221 IO.enumCase(Value, "AlwaysBreak", FormatStyle::BAS_AlwaysBreak);
222
223 // For backward compatibility.
224 IO.enumCase(Value, "true", FormatStyle::BAS_Align);
225 IO.enumCase(Value, "false", FormatStyle::BAS_DontAlign);
226 }
227};
228
Manuel Klimek89628f62017-09-20 09:51:03 +0000229template <>
230struct ScalarEnumerationTraits<FormatStyle::EscapedNewlineAlignmentStyle> {
231 static void enumeration(IO &IO,
232 FormatStyle::EscapedNewlineAlignmentStyle &Value) {
Daniel Jasper7fdbb3f2017-05-08 15:08:00 +0000233 IO.enumCase(Value, "DontAlign", FormatStyle::ENAS_DontAlign);
234 IO.enumCase(Value, "Left", FormatStyle::ENAS_Left);
235 IO.enumCase(Value, "Right", FormatStyle::ENAS_Right);
236
237 // For backward compatibility.
238 IO.enumCase(Value, "true", FormatStyle::ENAS_Left);
239 IO.enumCase(Value, "false", FormatStyle::ENAS_Right);
240 }
241};
242
Jacques Pienaarfc275112015-02-18 23:48:37 +0000243template <> struct ScalarEnumerationTraits<FormatStyle::PointerAlignmentStyle> {
244 static void enumeration(IO &IO, FormatStyle::PointerAlignmentStyle &Value) {
Daniel Jasper553d4872014-06-17 12:40:34 +0000245 IO.enumCase(Value, "Middle", FormatStyle::PAS_Middle);
246 IO.enumCase(Value, "Left", FormatStyle::PAS_Left);
247 IO.enumCase(Value, "Right", FormatStyle::PAS_Right);
248
Alp Toker958027b2014-07-14 19:42:55 +0000249 // For backward compatibility.
Daniel Jasper553d4872014-06-17 12:40:34 +0000250 IO.enumCase(Value, "true", FormatStyle::PAS_Left);
251 IO.enumCase(Value, "false", FormatStyle::PAS_Right);
252 }
253};
254
255template <>
Alexander Kornienko6d2c88e2013-12-10 10:30:34 +0000256struct ScalarEnumerationTraits<FormatStyle::SpaceBeforeParensOptions> {
Manuel Klimeka8eb9142013-05-13 12:51:40 +0000257 static void enumeration(IO &IO,
Alexander Kornienko6d2c88e2013-12-10 10:30:34 +0000258 FormatStyle::SpaceBeforeParensOptions &Value) {
259 IO.enumCase(Value, "Never", FormatStyle::SBPO_Never);
Alexander Kornienkofdca83d2013-12-10 10:18:34 +0000260 IO.enumCase(Value, "ControlStatements",
Alexander Kornienko6d2c88e2013-12-10 10:30:34 +0000261 FormatStyle::SBPO_ControlStatements);
262 IO.enumCase(Value, "Always", FormatStyle::SBPO_Always);
Alexander Kornienkofdca83d2013-12-10 10:18:34 +0000263
264 // For backward compatibility.
Alexander Kornienko6d2c88e2013-12-10 10:30:34 +0000265 IO.enumCase(Value, "false", FormatStyle::SBPO_Never);
266 IO.enumCase(Value, "true", FormatStyle::SBPO_ControlStatements);
Alexander Kornienkofdca83d2013-12-10 10:18:34 +0000267 }
268};
269
Alexander Kornienko6d2c88e2013-12-10 10:30:34 +0000270template <> struct MappingTraits<FormatStyle> {
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000271 static void mapping(IO &IO, FormatStyle &Style) {
272 // When reading, read the language first, we need it for getPredefinedStyle.
273 IO.mapOptional("Language", Style.Language);
274
Alexander Kornienko49149672013-05-10 11:56:10 +0000275 if (IO.outputting()) {
Jacques Pienaarfc275112015-02-18 23:48:37 +0000276 StringRef StylesArray[] = {"LLVM", "Google", "Chromium",
277 "Mozilla", "WebKit", "GNU"};
Alexander Kornienko49149672013-05-10 11:56:10 +0000278 ArrayRef<StringRef> Styles(StylesArray);
279 for (size_t i = 0, e = Styles.size(); i < e; ++i) {
280 StringRef StyleName(Styles[i]);
Alexander Kornienko6d2c88e2013-12-10 10:30:34 +0000281 FormatStyle PredefinedStyle;
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000282 if (getPredefinedStyle(StyleName, Style.Language, &PredefinedStyle) &&
Alexander Kornienko006b5c82013-05-19 00:53:30 +0000283 Style == PredefinedStyle) {
Alexander Kornienko49149672013-05-10 11:56:10 +0000284 IO.mapOptional("# BasedOnStyle", StyleName);
285 break;
286 }
287 }
288 } else {
Alexander Kornienkod6538332013-05-07 15:32:14 +0000289 StringRef BasedOnStyle;
290 IO.mapOptional("BasedOnStyle", BasedOnStyle);
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000291 if (!BasedOnStyle.empty()) {
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000292 FormatStyle::LanguageKind OldLanguage = Style.Language;
293 FormatStyle::LanguageKind Language =
294 ((FormatStyle *)IO.getContext())->Language;
295 if (!getPredefinedStyle(BasedOnStyle, Language, &Style)) {
Alexander Kornienko006b5c82013-05-19 00:53:30 +0000296 IO.setError(Twine("Unknown value for BasedOnStyle: ", BasedOnStyle));
297 return;
298 }
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000299 Style.Language = OldLanguage;
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000300 }
Alexander Kornienkod6538332013-05-07 15:32:14 +0000301 }
302
Birunthan Mohanathas50a6f912015-06-28 14:52:34 +0000303 // For backward compatibility.
304 if (!IO.outputting()) {
Daniel Jasper7fdbb3f2017-05-08 15:08:00 +0000305 IO.mapOptional("AlignEscapedNewlinesLeft", Style.AlignEscapedNewlines);
Birunthan Mohanathas50a6f912015-06-28 14:52:34 +0000306 IO.mapOptional("DerivePointerBinding", Style.DerivePointerAlignment);
307 IO.mapOptional("IndentFunctionDeclarationAfterType",
308 Style.IndentWrappedFunctionNames);
309 IO.mapOptional("PointerBindsToType", Style.PointerAlignment);
310 IO.mapOptional("SpaceAfterControlStatementKeyword",
311 Style.SpaceBeforeParens);
312 }
313
Alexander Kornienkod6538332013-05-07 15:32:14 +0000314 IO.mapOptional("AccessModifierOffset", Style.AccessModifierOffset);
Daniel Jasper3aa9a6a2014-11-18 23:55:27 +0000315 IO.mapOptional("AlignAfterOpenBracket", Style.AlignAfterOpenBracket);
Birunthan Mohanathas35cfbd72015-06-28 14:51:17 +0000316 IO.mapOptional("AlignConsecutiveAssignments",
317 Style.AlignConsecutiveAssignments);
Daniel Jaspere12597c2015-10-01 10:06:54 +0000318 IO.mapOptional("AlignConsecutiveDeclarations",
319 Style.AlignConsecutiveDeclarations);
Daniel Jasper7fdbb3f2017-05-08 15:08:00 +0000320 IO.mapOptional("AlignEscapedNewlines", Style.AlignEscapedNewlines);
Daniel Jasper3219e432014-12-02 13:24:51 +0000321 IO.mapOptional("AlignOperands", Style.AlignOperands);
Daniel Jasper552f4a72013-07-31 23:55:15 +0000322 IO.mapOptional("AlignTrailingComments", Style.AlignTrailingComments);
Alexander Kornienkod6538332013-05-07 15:32:14 +0000323 IO.mapOptional("AllowAllParametersOfDeclarationOnNextLine",
324 Style.AllowAllParametersOfDeclarationOnNextLine);
Daniel Jasper17605d32014-05-14 09:33:35 +0000325 IO.mapOptional("AllowShortBlocksOnASingleLine",
326 Style.AllowShortBlocksOnASingleLine);
Daniel Jasperb87899b2014-09-10 13:11:45 +0000327 IO.mapOptional("AllowShortCaseLabelsOnASingleLine",
328 Style.AllowShortCaseLabelsOnASingleLine);
Birunthan Mohanathas35cfbd72015-06-28 14:51:17 +0000329 IO.mapOptional("AllowShortFunctionsOnASingleLine",
330 Style.AllowShortFunctionsOnASingleLine);
Alexander Kornienkod6538332013-05-07 15:32:14 +0000331 IO.mapOptional("AllowShortIfStatementsOnASingleLine",
332 Style.AllowShortIfStatementsOnASingleLine);
Daniel Jasper3a685df2013-05-16 12:12:21 +0000333 IO.mapOptional("AllowShortLoopsOnASingleLine",
334 Style.AllowShortLoopsOnASingleLine);
Daniel Jasperca4ea1c2014-08-05 12:16:31 +0000335 IO.mapOptional("AlwaysBreakAfterDefinitionReturnType",
336 Style.AlwaysBreakAfterDefinitionReturnType);
Zachary Turner448592e2015-12-18 22:20:15 +0000337 IO.mapOptional("AlwaysBreakAfterReturnType",
338 Style.AlwaysBreakAfterReturnType);
339 // If AlwaysBreakAfterDefinitionReturnType was specified but
340 // AlwaysBreakAfterReturnType was not, initialize the latter from the
341 // former for backwards compatibility.
342 if (Style.AlwaysBreakAfterDefinitionReturnType != FormatStyle::DRTBS_None &&
343 Style.AlwaysBreakAfterReturnType == FormatStyle::RTBS_None) {
344 if (Style.AlwaysBreakAfterDefinitionReturnType == FormatStyle::DRTBS_All)
345 Style.AlwaysBreakAfterReturnType = FormatStyle::RTBS_AllDefinitions;
346 else if (Style.AlwaysBreakAfterDefinitionReturnType ==
347 FormatStyle::DRTBS_TopLevel)
348 Style.AlwaysBreakAfterReturnType =
349 FormatStyle::RTBS_TopLevelDefinitions;
350 }
351
Alexander Kornienko58611712013-07-04 12:02:44 +0000352 IO.mapOptional("AlwaysBreakBeforeMultilineStrings",
353 Style.AlwaysBreakBeforeMultilineStrings);
Birunthan Mohanathas35cfbd72015-06-28 14:51:17 +0000354 IO.mapOptional("AlwaysBreakTemplateDeclarations",
355 Style.AlwaysBreakTemplateDeclarations);
356 IO.mapOptional("BinPackArguments", Style.BinPackArguments);
357 IO.mapOptional("BinPackParameters", Style.BinPackParameters);
Daniel Jasperc1bc38e2015-09-29 14:57:55 +0000358 IO.mapOptional("BraceWrapping", Style.BraceWrapping);
Daniel Jaspere33d4af2013-07-26 16:56:36 +0000359 IO.mapOptional("BreakBeforeBinaryOperators",
360 Style.BreakBeforeBinaryOperators);
Birunthan Mohanathas35cfbd72015-06-28 14:51:17 +0000361 IO.mapOptional("BreakBeforeBraces", Style.BreakBeforeBraces);
Francois Ferrand6bb103f2018-06-11 14:41:26 +0000362
363 bool BreakBeforeInheritanceComma = false;
Francois Ferrande56a8292017-06-14 12:29:47 +0000364 IO.mapOptional("BreakBeforeInheritanceComma",
Francois Ferrand6bb103f2018-06-11 14:41:26 +0000365 BreakBeforeInheritanceComma);
366 IO.mapOptional("BreakInheritanceList",
367 Style.BreakInheritanceList);
368 // If BreakBeforeInheritanceComma was specified but
369 // BreakInheritance was not, initialize the latter from the
370 // former for backwards compatibility.
371 if (BreakBeforeInheritanceComma &&
372 Style.BreakInheritanceList == FormatStyle::BILS_BeforeColon)
373 Style.BreakInheritanceList = FormatStyle::BILS_BeforeComma;
374
Daniel Jasper165b29e2013-11-08 00:57:11 +0000375 IO.mapOptional("BreakBeforeTernaryOperators",
376 Style.BreakBeforeTernaryOperators);
Francois Ferranda6b6d512017-05-24 11:36:58 +0000377
378 bool BreakConstructorInitializersBeforeComma = false;
Daniel Jaspere33d4af2013-07-26 16:56:36 +0000379 IO.mapOptional("BreakConstructorInitializersBeforeComma",
Francois Ferranda6b6d512017-05-24 11:36:58 +0000380 BreakConstructorInitializersBeforeComma);
381 IO.mapOptional("BreakConstructorInitializers",
382 Style.BreakConstructorInitializers);
383 // If BreakConstructorInitializersBeforeComma was specified but
384 // BreakConstructorInitializers was not, initialize the latter from the
385 // former for backwards compatibility.
386 if (BreakConstructorInitializersBeforeComma &&
387 Style.BreakConstructorInitializers == FormatStyle::BCIS_BeforeColon)
388 Style.BreakConstructorInitializers = FormatStyle::BCIS_BeforeComma;
389
Daniel Jaspere1a7b762016-02-01 11:21:02 +0000390 IO.mapOptional("BreakAfterJavaFieldAnnotations",
391 Style.BreakAfterJavaFieldAnnotations);
392 IO.mapOptional("BreakStringLiterals", Style.BreakStringLiterals);
Alexander Kornienkod6538332013-05-07 15:32:14 +0000393 IO.mapOptional("ColumnLimit", Style.ColumnLimit);
Birunthan Mohanathas35cfbd72015-06-28 14:51:17 +0000394 IO.mapOptional("CommentPragmas", Style.CommentPragmas);
Francois Ferrande56a8292017-06-14 12:29:47 +0000395 IO.mapOptional("CompactNamespaces", Style.CompactNamespaces);
Alexander Kornienkod6538332013-05-07 15:32:14 +0000396 IO.mapOptional("ConstructorInitializerAllOnOneLineOrOnePerLine",
397 Style.ConstructorInitializerAllOnOneLineOrOnePerLine);
Daniel Jasper50d634b2014-10-28 16:53:38 +0000398 IO.mapOptional("ConstructorInitializerIndentWidth",
399 Style.ConstructorInitializerIndentWidth);
Birunthan Mohanathas35cfbd72015-06-28 14:51:17 +0000400 IO.mapOptional("ContinuationIndentWidth", Style.ContinuationIndentWidth);
401 IO.mapOptional("Cpp11BracedListStyle", Style.Cpp11BracedListStyle);
Daniel Jasper553d4872014-06-17 12:40:34 +0000402 IO.mapOptional("DerivePointerAlignment", Style.DerivePointerAlignment);
Birunthan Mohanathas35cfbd72015-06-28 14:51:17 +0000403 IO.mapOptional("DisableFormat", Style.DisableFormat);
Daniel Jasperb10cbc42013-07-10 14:02:49 +0000404 IO.mapOptional("ExperimentalAutoDetectBinPacking",
405 Style.ExperimentalAutoDetectBinPacking);
Krasimir Georgiev32eaa862017-03-01 15:35:39 +0000406 IO.mapOptional("FixNamespaceComments", Style.FixNamespaceComments);
Birunthan Mohanathas35cfbd72015-06-28 14:51:17 +0000407 IO.mapOptional("ForEachMacros", Style.ForEachMacros);
Eric Liu9d92c022018-05-14 19:51:33 +0000408 IO.mapOptional("IncludeBlocks", Style.IncludeStyle.IncludeBlocks);
409 IO.mapOptional("IncludeCategories", Style.IncludeStyle.IncludeCategories);
410 IO.mapOptional("IncludeIsMainRegex", Style.IncludeStyle.IncludeIsMainRegex);
Alexander Kornienkod6538332013-05-07 15:32:14 +0000411 IO.mapOptional("IndentCaseLabels", Style.IndentCaseLabels);
Krasimir Georgievad47c902017-08-30 14:34:57 +0000412 IO.mapOptional("IndentPPDirectives", Style.IndentPPDirectives);
Birunthan Mohanathas35cfbd72015-06-28 14:51:17 +0000413 IO.mapOptional("IndentWidth", Style.IndentWidth);
414 IO.mapOptional("IndentWrappedFunctionNames",
415 Style.IndentWrappedFunctionNames);
Krasimir Georgiev7e91b032018-10-05 17:19:26 +0000416 IO.mapOptional("JavaImportGroups", Style.JavaImportGroups);
Martin Probst0cd74ee2016-06-13 16:39:50 +0000417 IO.mapOptional("JavaScriptQuotes", Style.JavaScriptQuotes);
418 IO.mapOptional("JavaScriptWrapImports", Style.JavaScriptWrapImports);
Daniel Jaspera26fc5c2014-03-21 13:43:14 +0000419 IO.mapOptional("KeepEmptyLinesAtTheStartOfBlocks",
420 Style.KeepEmptyLinesAtTheStartOfBlocks);
Birunthan Mohanathasb001a0b2015-07-03 17:25:16 +0000421 IO.mapOptional("MacroBlockBegin", Style.MacroBlockBegin);
422 IO.mapOptional("MacroBlockEnd", Style.MacroBlockEnd);
Birunthan Mohanathas35cfbd72015-06-28 14:51:17 +0000423 IO.mapOptional("MaxEmptyLinesToKeep", Style.MaxEmptyLinesToKeep);
Daniel Jasper65ee3472013-07-31 23:16:02 +0000424 IO.mapOptional("NamespaceIndentation", Style.NamespaceIndentation);
Ben Hamilton4dc658c2018-02-02 20:15:14 +0000425 IO.mapOptional("ObjCBinPackProtocolList", Style.ObjCBinPackProtocolList);
Daniel Jasper50d634b2014-10-28 16:53:38 +0000426 IO.mapOptional("ObjCBlockIndentWidth", Style.ObjCBlockIndentWidth);
Daniel Jaspere9beea22014-01-28 15:20:33 +0000427 IO.mapOptional("ObjCSpaceAfterProperty", Style.ObjCSpaceAfterProperty);
Alexander Kornienkod6538332013-05-07 15:32:14 +0000428 IO.mapOptional("ObjCSpaceBeforeProtocolList",
429 Style.ObjCSpaceBeforeProtocolList);
Manuel Klimek89628f62017-09-20 09:51:03 +0000430 IO.mapOptional("PenaltyBreakAssignment", Style.PenaltyBreakAssignment);
Daniel Jasper33b909c2013-10-25 14:29:37 +0000431 IO.mapOptional("PenaltyBreakBeforeFirstCallParameter",
432 Style.PenaltyBreakBeforeFirstCallParameter);
Alexander Kornienkodd7ece52013-06-07 16:02:52 +0000433 IO.mapOptional("PenaltyBreakComment", Style.PenaltyBreakComment);
Daniel Jasper4e9678f2013-07-11 20:41:21 +0000434 IO.mapOptional("PenaltyBreakFirstLessLess",
435 Style.PenaltyBreakFirstLessLess);
Birunthan Mohanathas35cfbd72015-06-28 14:51:17 +0000436 IO.mapOptional("PenaltyBreakString", Style.PenaltyBreakString);
Francois Ferrand58e6fe52018-05-16 08:25:03 +0000437 IO.mapOptional("PenaltyBreakTemplateDeclaration",
438 Style.PenaltyBreakTemplateDeclaration);
Alexander Kornienkod6538332013-05-07 15:32:14 +0000439 IO.mapOptional("PenaltyExcessCharacter", Style.PenaltyExcessCharacter);
440 IO.mapOptional("PenaltyReturnTypeOnItsOwnLine",
441 Style.PenaltyReturnTypeOnItsOwnLine);
Daniel Jasper553d4872014-06-17 12:40:34 +0000442 IO.mapOptional("PointerAlignment", Style.PointerAlignment);
Krasimir Georgiev9ad83fe2017-10-30 14:01:50 +0000443 IO.mapOptional("RawStringFormats", Style.RawStringFormats);
Daniel Jaspera0a50392015-12-01 13:28:53 +0000444 IO.mapOptional("ReflowComments", Style.ReflowComments);
445 IO.mapOptional("SortIncludes", Style.SortIncludes);
Krasimir Georgievac16a202017-06-23 11:46:03 +0000446 IO.mapOptional("SortUsingDeclarations", Style.SortUsingDeclarations);
Daniel Jasperdb986eb2014-09-03 07:37:29 +0000447 IO.mapOptional("SpaceAfterCStyleCast", Style.SpaceAfterCStyleCast);
Manuel Klimek89628f62017-09-20 09:51:03 +0000448 IO.mapOptional("SpaceAfterTemplateKeyword",
449 Style.SpaceAfterTemplateKeyword);
Daniel Jasperd94bff32013-09-25 15:15:02 +0000450 IO.mapOptional("SpaceBeforeAssignmentOperators",
451 Style.SpaceBeforeAssignmentOperators);
Hans Wennborgbfc34062018-06-14 08:01:09 +0000452 IO.mapOptional("SpaceBeforeCpp11BracedList",
453 Style.SpaceBeforeCpp11BracedList);
Francois Ferrand2a9ea782018-03-01 10:09:13 +0000454 IO.mapOptional("SpaceBeforeCtorInitializerColon",
455 Style.SpaceBeforeCtorInitializerColon);
456 IO.mapOptional("SpaceBeforeInheritanceColon",
457 Style.SpaceBeforeInheritanceColon);
Birunthan Mohanathas35cfbd72015-06-28 14:51:17 +0000458 IO.mapOptional("SpaceBeforeParens", Style.SpaceBeforeParens);
Francois Ferrand2a9ea782018-03-01 10:09:13 +0000459 IO.mapOptional("SpaceBeforeRangeBasedForLoopColon",
460 Style.SpaceBeforeRangeBasedForLoopColon);
Birunthan Mohanathas35cfbd72015-06-28 14:51:17 +0000461 IO.mapOptional("SpaceInEmptyParentheses", Style.SpaceInEmptyParentheses);
462 IO.mapOptional("SpacesBeforeTrailingComments",
463 Style.SpacesBeforeTrailingComments);
464 IO.mapOptional("SpacesInAngles", Style.SpacesInAngles);
465 IO.mapOptional("SpacesInContainerLiterals",
466 Style.SpacesInContainerLiterals);
467 IO.mapOptional("SpacesInCStyleCastParentheses",
468 Style.SpacesInCStyleCastParentheses);
469 IO.mapOptional("SpacesInParentheses", Style.SpacesInParentheses);
470 IO.mapOptional("SpacesInSquareBrackets", Style.SpacesInSquareBrackets);
471 IO.mapOptional("Standard", Style.Standard);
Francois Ferrand6f40e212018-10-02 16:37:51 +0000472 IO.mapOptional("StatementMacros", Style.StatementMacros);
Birunthan Mohanathas35cfbd72015-06-28 14:51:17 +0000473 IO.mapOptional("TabWidth", Style.TabWidth);
474 IO.mapOptional("UseTab", Style.UseTab);
Alexander Kornienkod6538332013-05-07 15:32:14 +0000475 }
476};
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000477
Daniel Jasperc1bc38e2015-09-29 14:57:55 +0000478template <> struct MappingTraits<FormatStyle::BraceWrappingFlags> {
479 static void mapping(IO &IO, FormatStyle::BraceWrappingFlags &Wrapping) {
480 IO.mapOptional("AfterClass", Wrapping.AfterClass);
481 IO.mapOptional("AfterControlStatement", Wrapping.AfterControlStatement);
482 IO.mapOptional("AfterEnum", Wrapping.AfterEnum);
483 IO.mapOptional("AfterFunction", Wrapping.AfterFunction);
484 IO.mapOptional("AfterNamespace", Wrapping.AfterNamespace);
485 IO.mapOptional("AfterObjCDeclaration", Wrapping.AfterObjCDeclaration);
486 IO.mapOptional("AfterStruct", Wrapping.AfterStruct);
487 IO.mapOptional("AfterUnion", Wrapping.AfterUnion);
Krasimir Georgievd6ce9372017-09-15 11:23:50 +0000488 IO.mapOptional("AfterExternBlock", Wrapping.AfterExternBlock);
Daniel Jasperc1bc38e2015-09-29 14:57:55 +0000489 IO.mapOptional("BeforeCatch", Wrapping.BeforeCatch);
490 IO.mapOptional("BeforeElse", Wrapping.BeforeElse);
491 IO.mapOptional("IndentBraces", Wrapping.IndentBraces);
Francois Ferrandad722562017-06-30 20:25:55 +0000492 IO.mapOptional("SplitEmptyFunction", Wrapping.SplitEmptyFunction);
493 IO.mapOptional("SplitEmptyRecord", Wrapping.SplitEmptyRecord);
494 IO.mapOptional("SplitEmptyNamespace", Wrapping.SplitEmptyNamespace);
Daniel Jasperc1bc38e2015-09-29 14:57:55 +0000495 }
496};
497
Krasimir Georgiev9ad83fe2017-10-30 14:01:50 +0000498template <> struct MappingTraits<FormatStyle::RawStringFormat> {
499 static void mapping(IO &IO, FormatStyle::RawStringFormat &Format) {
Krasimir Georgiev9ad83fe2017-10-30 14:01:50 +0000500 IO.mapOptional("Language", Format.Language);
Krasimir Georgiev4527f132018-01-17 12:24:59 +0000501 IO.mapOptional("Delimiters", Format.Delimiters);
Krasimir Georgiev2537e222018-01-17 16:17:26 +0000502 IO.mapOptional("EnclosingFunctions", Format.EnclosingFunctions);
Krasimir Georgiev412ed092018-01-19 16:18:47 +0000503 IO.mapOptional("CanonicalDelimiter", Format.CanonicalDelimiter);
Krasimir Georgiev9ad83fe2017-10-30 14:01:50 +0000504 IO.mapOptional("BasedOnStyle", Format.BasedOnStyle);
505 }
506};
507
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000508// Allows to read vector<FormatStyle> while keeping default values.
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000509// IO.getContext() should contain a pointer to the FormatStyle structure, that
510// will be used to get default values for missing keys.
511// If the first element has no Language specified, it will be treated as the
512// default one for the following elements.
Jacques Pienaarfc275112015-02-18 23:48:37 +0000513template <> struct DocumentListTraits<std::vector<FormatStyle>> {
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000514 static size_t size(IO &IO, std::vector<FormatStyle> &Seq) {
515 return Seq.size();
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000516 }
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000517 static FormatStyle &element(IO &IO, std::vector<FormatStyle> &Seq,
Alexander Kornienko6d2c88e2013-12-10 10:30:34 +0000518 size_t Index) {
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000519 if (Index >= Seq.size()) {
520 assert(Index == Seq.size());
Alexander Kornienko6d2c88e2013-12-10 10:30:34 +0000521 FormatStyle Template;
Krasimir Georgiev1696bb62017-11-09 15:12:17 +0000522 if (!Seq.empty() && Seq[0].Language == FormatStyle::LK_None) {
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000523 Template = Seq[0];
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000524 } else {
Daniel Jasperb05a81d2014-05-09 13:11:16 +0000525 Template = *((const FormatStyle *)IO.getContext());
Alexander Kornienko6d2c88e2013-12-10 10:30:34 +0000526 Template.Language = FormatStyle::LK_None;
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000527 }
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000528 Seq.resize(Index + 1, Template);
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000529 }
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000530 return Seq[Index];
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000531 }
532};
Daniel Jasperd89ae9d2015-09-23 08:30:47 +0000533} // namespace yaml
534} // namespace llvm
Alexander Kornienkod6538332013-05-07 15:32:14 +0000535
Daniel Jasperf7935112012-12-03 18:12:45 +0000536namespace clang {
537namespace format {
538
Rafael Espindola6d0d89b2014-06-12 03:31:26 +0000539const std::error_category &getParseCategory() {
Benjamin Kramerf76861c2018-03-20 21:52:19 +0000540 static const ParseErrorCategory C{};
Rafael Espindolad0136702014-06-12 02:50:04 +0000541 return C;
542}
543std::error_code make_error_code(ParseError e) {
Rafael Espindola6d0d89b2014-06-12 03:31:26 +0000544 return std::error_code(static_cast<int>(e), getParseCategory());
Rafael Espindolad0136702014-06-12 02:50:04 +0000545}
546
Antonio Maiorano3adfb6a2017-01-17 00:12:27 +0000547inline llvm::Error make_string_error(const llvm::Twine &Message) {
548 return llvm::make_error<llvm::StringError>(Message,
549 llvm::inconvertibleErrorCode());
550}
551
Reid Kleckner6432d452016-10-19 23:39:55 +0000552const char *ParseErrorCategory::name() const noexcept {
Rafael Espindolad0136702014-06-12 02:50:04 +0000553 return "clang-format.parse_error";
554}
555
556std::string ParseErrorCategory::message(int EV) const {
557 switch (static_cast<ParseError>(EV)) {
558 case ParseError::Success:
559 return "Success";
560 case ParseError::Error:
561 return "Invalid argument";
562 case ParseError::Unsuitable:
563 return "Unsuitable";
564 }
Saleem Abdulrasoolfbfbaf62014-06-12 19:33:26 +0000565 llvm_unreachable("unexpected parse error");
Rafael Espindolad0136702014-06-12 02:50:04 +0000566}
567
Daniel Jasperc1bc38e2015-09-29 14:57:55 +0000568static FormatStyle expandPresets(const FormatStyle &Style) {
Daniel Jasper55bbe662015-10-07 04:06:10 +0000569 if (Style.BreakBeforeBraces == FormatStyle::BS_Custom)
570 return Style;
Daniel Jasperc1bc38e2015-09-29 14:57:55 +0000571 FormatStyle Expanded = Style;
Manuel Klimek89628f62017-09-20 09:51:03 +0000572 Expanded.BraceWrapping = {false, false, false, false, false,
573 false, false, false, false, false,
574 false, false, true, true, true};
Daniel Jasperc1bc38e2015-09-29 14:57:55 +0000575 switch (Style.BreakBeforeBraces) {
576 case FormatStyle::BS_Linux:
577 Expanded.BraceWrapping.AfterClass = true;
578 Expanded.BraceWrapping.AfterFunction = true;
579 Expanded.BraceWrapping.AfterNamespace = true;
Daniel Jasperc1bc38e2015-09-29 14:57:55 +0000580 break;
581 case FormatStyle::BS_Mozilla:
582 Expanded.BraceWrapping.AfterClass = true;
583 Expanded.BraceWrapping.AfterEnum = true;
584 Expanded.BraceWrapping.AfterFunction = true;
585 Expanded.BraceWrapping.AfterStruct = true;
586 Expanded.BraceWrapping.AfterUnion = true;
Krasimir Georgievd6ce9372017-09-15 11:23:50 +0000587 Expanded.BraceWrapping.AfterExternBlock = true;
Sylvestre Ledru82c9a0e2017-09-13 20:03:29 +0000588 Expanded.BraceWrapping.SplitEmptyFunction = true;
Francois Ferrandad722562017-06-30 20:25:55 +0000589 Expanded.BraceWrapping.SplitEmptyRecord = false;
Daniel Jasperc1bc38e2015-09-29 14:57:55 +0000590 break;
591 case FormatStyle::BS_Stroustrup:
592 Expanded.BraceWrapping.AfterFunction = true;
593 Expanded.BraceWrapping.BeforeCatch = true;
594 Expanded.BraceWrapping.BeforeElse = true;
595 break;
596 case FormatStyle::BS_Allman:
597 Expanded.BraceWrapping.AfterClass = true;
598 Expanded.BraceWrapping.AfterControlStatement = true;
599 Expanded.BraceWrapping.AfterEnum = true;
600 Expanded.BraceWrapping.AfterFunction = true;
601 Expanded.BraceWrapping.AfterNamespace = true;
602 Expanded.BraceWrapping.AfterObjCDeclaration = true;
603 Expanded.BraceWrapping.AfterStruct = true;
Krasimir Georgievd6ce9372017-09-15 11:23:50 +0000604 Expanded.BraceWrapping.AfterExternBlock = true;
Daniel Jasperc1bc38e2015-09-29 14:57:55 +0000605 Expanded.BraceWrapping.BeforeCatch = true;
606 Expanded.BraceWrapping.BeforeElse = true;
607 break;
608 case FormatStyle::BS_GNU:
Manuel Klimek89628f62017-09-20 09:51:03 +0000609 Expanded.BraceWrapping = {true, true, true, true, true, true, true, true,
610 true, true, true, true, true, true, true};
Daniel Jasperc1bc38e2015-09-29 14:57:55 +0000611 break;
612 case FormatStyle::BS_WebKit:
613 Expanded.BraceWrapping.AfterFunction = true;
614 break;
615 default:
616 break;
617 }
618 return Expanded;
619}
620
Daniel Jasperf7935112012-12-03 18:12:45 +0000621FormatStyle getLLVMStyle() {
622 FormatStyle LLVMStyle;
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000623 LLVMStyle.Language = FormatStyle::LK_Cpp;
Daniel Jasperf7935112012-12-03 18:12:45 +0000624 LLVMStyle.AccessModifierOffset = -2;
Daniel Jasper7fdbb3f2017-05-08 15:08:00 +0000625 LLVMStyle.AlignEscapedNewlines = FormatStyle::ENAS_Right;
Daniel Jasper6501f7e2015-10-27 12:38:37 +0000626 LLVMStyle.AlignAfterOpenBracket = FormatStyle::BAS_Align;
Daniel Jasper3219e432014-12-02 13:24:51 +0000627 LLVMStyle.AlignOperands = true;
Daniel Jasper552f4a72013-07-31 23:55:15 +0000628 LLVMStyle.AlignTrailingComments = true;
Daniel Jaspera44991332015-04-29 13:06:49 +0000629 LLVMStyle.AlignConsecutiveAssignments = false;
Daniel Jaspere12597c2015-10-01 10:06:54 +0000630 LLVMStyle.AlignConsecutiveDeclarations = false;
Daniel Jasperf7db4332013-01-29 16:03:49 +0000631 LLVMStyle.AllowAllParametersOfDeclarationOnNextLine = true;
Daniel Jasperd74cf402014-04-08 12:46:38 +0000632 LLVMStyle.AllowShortFunctionsOnASingleLine = FormatStyle::SFS_All;
Daniel Jasper17605d32014-05-14 09:33:35 +0000633 LLVMStyle.AllowShortBlocksOnASingleLine = false;
Daniel Jasperb87899b2014-09-10 13:11:45 +0000634 LLVMStyle.AllowShortCaseLabelsOnASingleLine = false;
Daniel Jasper1b750ed2013-01-14 16:24:39 +0000635 LLVMStyle.AllowShortIfStatementsOnASingleLine = false;
Daniel Jasper3a685df2013-05-16 12:12:21 +0000636 LLVMStyle.AllowShortLoopsOnASingleLine = false;
Zachary Turner448592e2015-12-18 22:20:15 +0000637 LLVMStyle.AlwaysBreakAfterReturnType = FormatStyle::RTBS_None;
Birunthan Mohanathasa0388a82015-06-29 15:30:42 +0000638 LLVMStyle.AlwaysBreakAfterDefinitionReturnType = FormatStyle::DRTBS_None;
Alexander Kornienko58611712013-07-04 12:02:44 +0000639 LLVMStyle.AlwaysBreakBeforeMultilineStrings = false;
Francois Ferrand58e6fe52018-05-16 08:25:03 +0000640 LLVMStyle.AlwaysBreakTemplateDeclarations = FormatStyle::BTDS_MultiLine;
Daniel Jasper18210d72014-10-09 09:52:05 +0000641 LLVMStyle.BinPackArguments = true;
Francois Ferrande56a8292017-06-14 12:29:47 +0000642 LLVMStyle.BinPackParameters = true;
Daniel Jasperac043c92014-09-15 11:11:00 +0000643 LLVMStyle.BreakBeforeBinaryOperators = FormatStyle::BOS_None;
Daniel Jasper165b29e2013-11-08 00:57:11 +0000644 LLVMStyle.BreakBeforeTernaryOperators = true;
Daniel Jaspere33d4af2013-07-26 16:56:36 +0000645 LLVMStyle.BreakBeforeBraces = FormatStyle::BS_Attach;
Manuel Klimek89628f62017-09-20 09:51:03 +0000646 LLVMStyle.BraceWrapping = {false, false, false, false, false,
647 false, false, false, false, false,
648 false, false, true, true, true};
Nico Weber2cd92f12015-10-15 16:03:01 +0000649 LLVMStyle.BreakAfterJavaFieldAnnotations = false;
Francois Ferranda6b6d512017-05-24 11:36:58 +0000650 LLVMStyle.BreakConstructorInitializers = FormatStyle::BCIS_BeforeColon;
Francois Ferrand6bb103f2018-06-11 14:41:26 +0000651 LLVMStyle.BreakInheritanceList = FormatStyle::BILS_BeforeColon;
Daniel Jaspere1a7b762016-02-01 11:21:02 +0000652 LLVMStyle.BreakStringLiterals = true;
Alexander Kornienkoc8602662013-05-06 14:11:27 +0000653 LLVMStyle.ColumnLimit = 80;
Daniel Jaspere1e43192014-04-01 12:55:11 +0000654 LLVMStyle.CommentPragmas = "^ IWYU pragma:";
Francois Ferrande56a8292017-06-14 12:29:47 +0000655 LLVMStyle.CompactNamespaces = false;
Alexander Kornienkoc8602662013-05-06 14:11:27 +0000656 LLVMStyle.ConstructorInitializerAllOnOneLineOrOnePerLine = false;
Daniel Jaspercdaffa42013-08-13 10:58:30 +0000657 LLVMStyle.ConstructorInitializerIndentWidth = 4;
Daniel Jaspere1e43192014-04-01 12:55:11 +0000658 LLVMStyle.ContinuationIndentWidth = 4;
Chandler Carruthf8b72662014-03-02 12:37:31 +0000659 LLVMStyle.Cpp11BracedListStyle = true;
Daniel Jasper553d4872014-06-17 12:40:34 +0000660 LLVMStyle.DerivePointerAlignment = false;
Daniel Jasperb10cbc42013-07-10 14:02:49 +0000661 LLVMStyle.ExperimentalAutoDetectBinPacking = false;
Krasimir Georgiev32eaa862017-03-01 15:35:39 +0000662 LLVMStyle.FixNamespaceComments = true;
Daniel Jaspere1e43192014-04-01 12:55:11 +0000663 LLVMStyle.ForEachMacros.push_back("foreach");
664 LLVMStyle.ForEachMacros.push_back("Q_FOREACH");
665 LLVMStyle.ForEachMacros.push_back("BOOST_FOREACH");
Eric Liu9d92c022018-05-14 19:51:33 +0000666 LLVMStyle.IncludeStyle.IncludeCategories = {
667 {"^\"(llvm|llvm-c|clang|clang-c)/", 2},
668 {"^(<|\"(gtest|gmock|isl|json)/)", 3},
669 {".*", 1}};
670 LLVMStyle.IncludeStyle.IncludeIsMainRegex = "(Test)?$";
671 LLVMStyle.IncludeStyle.IncludeBlocks = tooling::IncludeStyle::IBS_Preserve;
Alexander Kornienkoc8602662013-05-06 14:11:27 +0000672 LLVMStyle.IndentCaseLabels = false;
Krasimir Georgievad47c902017-08-30 14:34:57 +0000673 LLVMStyle.IndentPPDirectives = FormatStyle::PPDIS_None;
Daniel Jasperc75e1ef2014-07-09 08:42:42 +0000674 LLVMStyle.IndentWrappedFunctionNames = false;
Daniel Jaspere33d4af2013-07-26 16:56:36 +0000675 LLVMStyle.IndentWidth = 2;
Martin Probstfb2342d2016-06-13 17:50:10 +0000676 LLVMStyle.JavaScriptQuotes = FormatStyle::JSQS_Leave;
677 LLVMStyle.JavaScriptWrapImports = true;
Alexander Kornienkoebb43ca2013-09-05 14:08:34 +0000678 LLVMStyle.TabWidth = 8;
Alexander Kornienkoc8602662013-05-06 14:11:27 +0000679 LLVMStyle.MaxEmptyLinesToKeep = 1;
Daniel Jaspera26fc5c2014-03-21 13:43:14 +0000680 LLVMStyle.KeepEmptyLinesAtTheStartOfBlocks = true;
Daniel Jasper65ee3472013-07-31 23:16:02 +0000681 LLVMStyle.NamespaceIndentation = FormatStyle::NI_None;
Ben Hamilton4dc658c2018-02-02 20:15:14 +0000682 LLVMStyle.ObjCBinPackProtocolList = FormatStyle::BPS_Auto;
Daniel Jasper50d634b2014-10-28 16:53:38 +0000683 LLVMStyle.ObjCBlockIndentWidth = 2;
Daniel Jaspere9beea22014-01-28 15:20:33 +0000684 LLVMStyle.ObjCSpaceAfterProperty = false;
Nico Webera6087752013-01-10 20:12:55 +0000685 LLVMStyle.ObjCSpaceBeforeProtocolList = true;
Daniel Jasper553d4872014-06-17 12:40:34 +0000686 LLVMStyle.PointerAlignment = FormatStyle::PAS_Right;
Alexander Kornienkoc8602662013-05-06 14:11:27 +0000687 LLVMStyle.SpacesBeforeTrailingComments = 1;
Chandler Carruthf8b72662014-03-02 12:37:31 +0000688 LLVMStyle.Standard = FormatStyle::LS_Cpp11;
Alexander Kornienko3c3d09c2013-09-27 16:14:22 +0000689 LLVMStyle.UseTab = FormatStyle::UT_Never;
Daniel Jaspera0a50392015-12-01 13:28:53 +0000690 LLVMStyle.ReflowComments = true;
Daniel Jasperb55acad2013-08-20 12:36:34 +0000691 LLVMStyle.SpacesInParentheses = false;
Daniel Jasperad981f82014-08-26 11:41:14 +0000692 LLVMStyle.SpacesInSquareBrackets = false;
Daniel Jasperb55acad2013-08-20 12:36:34 +0000693 LLVMStyle.SpaceInEmptyParentheses = false;
Daniel Jasperb2e10a52014-01-15 15:09:08 +0000694 LLVMStyle.SpacesInContainerLiterals = true;
Daniel Jasperb55acad2013-08-20 12:36:34 +0000695 LLVMStyle.SpacesInCStyleCastParentheses = false;
Daniel Jasperdb986eb2014-09-03 07:37:29 +0000696 LLVMStyle.SpaceAfterCStyleCast = false;
Sylvestre Ledru83bbd572016-08-09 14:24:40 +0000697 LLVMStyle.SpaceAfterTemplateKeyword = true;
Francois Ferrand2a9ea782018-03-01 10:09:13 +0000698 LLVMStyle.SpaceBeforeCtorInitializerColon = true;
699 LLVMStyle.SpaceBeforeInheritanceColon = true;
Alexander Kornienkofdca83d2013-12-10 10:18:34 +0000700 LLVMStyle.SpaceBeforeParens = FormatStyle::SBPO_ControlStatements;
Francois Ferrand2a9ea782018-03-01 10:09:13 +0000701 LLVMStyle.SpaceBeforeRangeBasedForLoopColon = true;
Daniel Jasperd94bff32013-09-25 15:15:02 +0000702 LLVMStyle.SpaceBeforeAssignmentOperators = true;
Hans Wennborgbfc34062018-06-14 08:01:09 +0000703 LLVMStyle.SpaceBeforeCpp11BracedList = false;
Daniel Jasperdd978ae2013-10-29 14:52:02 +0000704 LLVMStyle.SpacesInAngles = false;
Daniel Jasper4e9678f2013-07-11 20:41:21 +0000705
Francois Ferrand9976efa2017-05-22 08:28:17 +0000706 LLVMStyle.PenaltyBreakAssignment = prec::Assignment;
Daniel Jasper19a541e2013-12-19 16:45:34 +0000707 LLVMStyle.PenaltyBreakComment = 300;
Alexander Kornienkofe7a57f2013-12-10 15:42:15 +0000708 LLVMStyle.PenaltyBreakFirstLessLess = 120;
709 LLVMStyle.PenaltyBreakString = 1000;
710 LLVMStyle.PenaltyExcessCharacter = 1000000;
Daniel Jasper4e9678f2013-07-11 20:41:21 +0000711 LLVMStyle.PenaltyReturnTypeOnItsOwnLine = 60;
Daniel Jasper33b909c2013-10-25 14:29:37 +0000712 LLVMStyle.PenaltyBreakBeforeFirstCallParameter = 19;
Francois Ferrand58e6fe52018-05-16 08:25:03 +0000713 LLVMStyle.PenaltyBreakTemplateDeclaration = prec::Relational;
Daniel Jasper4e9678f2013-07-11 20:41:21 +0000714
Daniel Jasperc64b09a2014-05-22 15:12:22 +0000715 LLVMStyle.DisableFormat = false;
Daniel Jasperda446772015-11-16 12:38:56 +0000716 LLVMStyle.SortIncludes = true;
Krasimir Georgievac16a202017-06-23 11:46:03 +0000717 LLVMStyle.SortUsingDeclarations = true;
Francois Ferrand6f40e212018-10-02 16:37:51 +0000718 LLVMStyle.StatementMacros.push_back("Q_UNUSED");
719 LLVMStyle.StatementMacros.push_back("QT_REQUIRE_VERSION");
Daniel Jasperc64b09a2014-05-22 15:12:22 +0000720
Daniel Jasperf7935112012-12-03 18:12:45 +0000721 return LLVMStyle;
722}
723
Nico Weber514ecc82014-02-02 20:50:45 +0000724FormatStyle getGoogleStyle(FormatStyle::LanguageKind Language) {
Krasimir Georgiev26b144c2017-07-03 15:05:14 +0000725 if (Language == FormatStyle::LK_TextProto) {
726 FormatStyle GoogleStyle = getGoogleStyle(FormatStyle::LK_Proto);
727 GoogleStyle.Language = FormatStyle::LK_TextProto;
Krasimir Georgieveda222e2018-01-24 11:18:39 +0000728
Krasimir Georgiev26b144c2017-07-03 15:05:14 +0000729 return GoogleStyle;
730 }
731
Alexander Kornienkofe7a57f2013-12-10 15:42:15 +0000732 FormatStyle GoogleStyle = getLLVMStyle();
Nico Weber514ecc82014-02-02 20:50:45 +0000733 GoogleStyle.Language = Language;
734
Daniel Jasperf7935112012-12-03 18:12:45 +0000735 GoogleStyle.AccessModifierOffset = -1;
Daniel Jasper7fdbb3f2017-05-08 15:08:00 +0000736 GoogleStyle.AlignEscapedNewlines = FormatStyle::ENAS_Left;
Daniel Jasper085a2ed2013-04-24 13:46:00 +0000737 GoogleStyle.AllowShortIfStatementsOnASingleLine = true;
Daniel Jasper5bd0b9e2013-05-23 18:05:18 +0000738 GoogleStyle.AllowShortLoopsOnASingleLine = true;
Alexander Kornienko58611712013-07-04 12:02:44 +0000739 GoogleStyle.AlwaysBreakBeforeMultilineStrings = true;
Francois Ferrand58e6fe52018-05-16 08:25:03 +0000740 GoogleStyle.AlwaysBreakTemplateDeclarations = FormatStyle::BTDS_Yes;
Alexander Kornienkoc8602662013-05-06 14:11:27 +0000741 GoogleStyle.ConstructorInitializerAllOnOneLineOrOnePerLine = true;
Daniel Jasper553d4872014-06-17 12:40:34 +0000742 GoogleStyle.DerivePointerAlignment = true;
Eric Liu9d92c022018-05-14 19:51:33 +0000743 GoogleStyle.IncludeStyle.IncludeCategories = {
Krasimir Georgieva84e7872017-09-26 14:58:29 +0000744 {"^<ext/.*\\.h>", 2}, {"^<.*\\.h>", 1}, {"^<.*", 2}, {".*", 3}};
Eric Liu9d92c022018-05-14 19:51:33 +0000745 GoogleStyle.IncludeStyle.IncludeIsMainRegex = "([-_](test|unittest))?$";
Alexander Kornienkoc8602662013-05-06 14:11:27 +0000746 GoogleStyle.IndentCaseLabels = true;
Daniel Jaspera26fc5c2014-03-21 13:43:14 +0000747 GoogleStyle.KeepEmptyLinesAtTheStartOfBlocks = false;
Ben Hamilton3a47fdd2018-02-08 01:49:10 +0000748 GoogleStyle.ObjCBinPackProtocolList = FormatStyle::BPS_Never;
Daniel Jaspere9beea22014-01-28 15:20:33 +0000749 GoogleStyle.ObjCSpaceAfterProperty = false;
Ben Hamiltonf84f1182018-01-18 18:37:16 +0000750 GoogleStyle.ObjCSpaceBeforeProtocolList = true;
Daniel Jasper553d4872014-06-17 12:40:34 +0000751 GoogleStyle.PointerAlignment = FormatStyle::PAS_Left;
Krasimir Georgiev5559cc32018-04-25 14:56:19 +0000752 GoogleStyle.RawStringFormats = {
Krasimir Georgiev4527f132018-01-17 12:24:59 +0000753 {
Krasimir Georgiev5559cc32018-04-25 14:56:19 +0000754 FormatStyle::LK_Cpp,
755 /*Delimiters=*/
756 {
757 "cc",
758 "CC",
759 "cpp",
760 "Cpp",
761 "CPP",
762 "c++",
763 "C++",
764 },
765 /*EnclosingFunctionNames=*/
766 {},
767 /*CanonicalDelimiter=*/"",
768 /*BasedOnStyle=*/"google",
Krasimir Georgiev4527f132018-01-17 12:24:59 +0000769 },
Krasimir Georgiev5559cc32018-04-25 14:56:19 +0000770 {
771 FormatStyle::LK_TextProto,
772 /*Delimiters=*/
773 {
774 "pb",
775 "PB",
776 "proto",
777 "PROTO",
778 },
779 /*EnclosingFunctionNames=*/
Krasimir Georgiev42948e32018-06-26 12:00:14 +0000780 {
Krasimir Georgiev42948e32018-06-26 12:00:14 +0000781 "EqualsProto",
Krasimir Georgiev61f46f22018-06-29 14:25:25 +0000782 "EquivToProto",
Krasimir Georgievce0b8d62018-08-01 12:35:23 +0000783 "PARSE_PARTIAL_TEXT_PROTO",
Krasimir Georgiev61f46f22018-06-29 14:25:25 +0000784 "PARSE_TEST_PROTO",
785 "PARSE_TEXT_PROTO",
786 "ParseTextOrDie",
Krasimir Georgievce0b8d62018-08-01 12:35:23 +0000787 "ParseTextProtoOrDie",
Krasimir Georgiev42948e32018-06-26 12:00:14 +0000788 },
Krasimir Georgiev5559cc32018-04-25 14:56:19 +0000789 /*CanonicalDelimiter=*/"",
790 /*BasedOnStyle=*/"google",
791 },
792 };
Alexander Kornienkoc8602662013-05-06 14:11:27 +0000793 GoogleStyle.SpacesBeforeTrailingComments = 2;
794 GoogleStyle.Standard = FormatStyle::LS_Auto;
Daniel Jasper4e9678f2013-07-11 20:41:21 +0000795
Daniel Jasper4e9678f2013-07-11 20:41:21 +0000796 GoogleStyle.PenaltyReturnTypeOnItsOwnLine = 200;
Daniel Jasper33b909c2013-10-25 14:29:37 +0000797 GoogleStyle.PenaltyBreakBeforeFirstCallParameter = 1;
Daniel Jasper4e9678f2013-07-11 20:41:21 +0000798
Daniel Jasperc58c70e2014-09-15 11:21:46 +0000799 if (Language == FormatStyle::LK_Java) {
Daniel Jasper6501f7e2015-10-27 12:38:37 +0000800 GoogleStyle.AlignAfterOpenBracket = FormatStyle::BAS_DontAlign;
Daniel Jasper3219e432014-12-02 13:24:51 +0000801 GoogleStyle.AlignOperands = false;
Daniel Jasperfd4ed182015-01-04 20:40:45 +0000802 GoogleStyle.AlignTrailingComments = false;
Daniel Jasper9e709352014-11-26 10:43:58 +0000803 GoogleStyle.AllowShortFunctionsOnASingleLine = FormatStyle::SFS_Empty;
Daniel Jasperfd4ed182015-01-04 20:40:45 +0000804 GoogleStyle.AllowShortIfStatementsOnASingleLine = false;
Daniel Jasper1cd3c712015-01-14 12:24:59 +0000805 GoogleStyle.AlwaysBreakBeforeMultilineStrings = false;
Daniel Jasperc58c70e2014-09-15 11:21:46 +0000806 GoogleStyle.BreakBeforeBinaryOperators = FormatStyle::BOS_NonAssignment;
807 GoogleStyle.ColumnLimit = 100;
808 GoogleStyle.SpaceAfterCStyleCast = true;
Daniel Jasper61d81972014-11-14 08:22:46 +0000809 GoogleStyle.SpacesBeforeTrailingComments = 1;
Daniel Jasperc58c70e2014-09-15 11:21:46 +0000810 } else if (Language == FormatStyle::LK_JavaScript) {
Daniel Jasper6501f7e2015-10-27 12:38:37 +0000811 GoogleStyle.AlignAfterOpenBracket = FormatStyle::BAS_AlwaysBreak;
Daniel Jasper41a2bf72015-12-21 13:52:19 +0000812 GoogleStyle.AlignOperands = false;
Daniel Jasper28d8a5a2016-09-07 23:01:13 +0000813 GoogleStyle.AllowShortFunctionsOnASingleLine = FormatStyle::SFS_Empty;
Daniel Jasper6501f7e2015-10-27 12:38:37 +0000814 GoogleStyle.AlwaysBreakBeforeMultilineStrings = false;
Daniel Jaspere551bb72014-11-05 17:22:31 +0000815 GoogleStyle.BreakBeforeTernaryOperators = false;
Krasimir Georgiev6a5c95b2018-07-30 08:45:45 +0000816 // taze:, triple slash directives (`/// <...`), @see, which is commonly
817 // followed by overlong URLs.
818 GoogleStyle.CommentPragmas = "(taze:|^/[ \t]*<|@see)";
Daniel Jasper8f83a902014-05-09 10:28:58 +0000819 GoogleStyle.MaxEmptyLinesToKeep = 3;
Martin Probstece8c0c2016-06-13 16:41:28 +0000820 GoogleStyle.NamespaceIndentation = FormatStyle::NI_All;
Nico Weber514ecc82014-02-02 20:50:45 +0000821 GoogleStyle.SpacesInContainerLiterals = false;
Daniel Jasperabd1f572016-03-02 22:44:03 +0000822 GoogleStyle.JavaScriptQuotes = FormatStyle::JSQS_Single;
Martin Probst0cd74ee2016-06-13 16:39:50 +0000823 GoogleStyle.JavaScriptWrapImports = false;
Nico Weber514ecc82014-02-02 20:50:45 +0000824 } else if (Language == FormatStyle::LK_Proto) {
Daniel Jasper67e65212018-08-15 19:07:55 +0000825 GoogleStyle.AllowShortFunctionsOnASingleLine = FormatStyle::SFS_Empty;
Daniel Jasper9c95dfe2018-03-12 10:32:18 +0000826 GoogleStyle.AlwaysBreakBeforeMultilineStrings = false;
Daniel Jasper783bac62014-04-15 09:54:30 +0000827 GoogleStyle.SpacesInContainerLiterals = false;
Krasimir Georgievc2091802018-01-31 10:14:10 +0000828 GoogleStyle.Cpp11BracedListStyle = false;
Krasimir Georgiev374e6de2018-02-08 10:47:12 +0000829 // This affects protocol buffer options specifications and text protos.
830 // Text protos are currently mostly formatted inside C++ raw string literals
831 // and often the current breaking behavior of string literals is not
832 // beneficial there. Investigate turning this on once proper string reflow
833 // has been implemented.
834 GoogleStyle.BreakStringLiterals = false;
Daniel Jasper03a04fe2016-12-12 12:42:29 +0000835 } else if (Language == FormatStyle::LK_ObjC) {
Ben Hamilton1ab722e2018-06-14 17:30:10 +0000836 GoogleStyle.AlwaysBreakBeforeMultilineStrings = false;
Daniel Jasper03a04fe2016-12-12 12:42:29 +0000837 GoogleStyle.ColumnLimit = 100;
Nico Weber514ecc82014-02-02 20:50:45 +0000838 }
839
Daniel Jasperf7935112012-12-03 18:12:45 +0000840 return GoogleStyle;
841}
842
Nico Weber514ecc82014-02-02 20:50:45 +0000843FormatStyle getChromiumStyle(FormatStyle::LanguageKind Language) {
844 FormatStyle ChromiumStyle = getGoogleStyle(Language);
Nico Weber450425c2014-11-26 16:43:18 +0000845 if (Language == FormatStyle::LK_Java) {
Daniel Jasperfd4ed182015-01-04 20:40:45 +0000846 ChromiumStyle.AllowShortIfStatementsOnASingleLine = true;
Nico Weber2cd92f12015-10-15 16:03:01 +0000847 ChromiumStyle.BreakAfterJavaFieldAnnotations = true;
Nico Weber450425c2014-11-26 16:43:18 +0000848 ChromiumStyle.ContinuationIndentWidth = 8;
Nico Weber2cd92f12015-10-15 16:03:01 +0000849 ChromiumStyle.IndentWidth = 4;
Krasimir Georgiev7e91b032018-10-05 17:19:26 +0000850 // See styleguide for import groups:
851 // https://chromium.googlesource.com/chromium/src/+/master/styleguide/java/java.md#Import-Order
852 ChromiumStyle.JavaImportGroups = {
853 "android",
854 "com",
855 "dalvik",
856 "junit",
857 "org",
858 "com.google.android.apps.chrome",
859 "org.chromium",
860 "java",
861 "javax",
862 };
863 ChromiumStyle.SortIncludes = true;
Nico Weberea649692017-01-04 02:33:36 +0000864 } else if (Language == FormatStyle::LK_JavaScript) {
865 ChromiumStyle.AllowShortIfStatementsOnASingleLine = false;
866 ChromiumStyle.AllowShortLoopsOnASingleLine = false;
Nico Weber450425c2014-11-26 16:43:18 +0000867 } else {
868 ChromiumStyle.AllowAllParametersOfDeclarationOnNextLine = false;
869 ChromiumStyle.AllowShortFunctionsOnASingleLine = FormatStyle::SFS_Inline;
870 ChromiumStyle.AllowShortIfStatementsOnASingleLine = false;
871 ChromiumStyle.AllowShortLoopsOnASingleLine = false;
872 ChromiumStyle.BinPackParameters = false;
873 ChromiumStyle.DerivePointerAlignment = false;
Nico Weber9e2bc302017-01-31 18:42:05 +0000874 if (Language == FormatStyle::LK_ObjC)
875 ChromiumStyle.ColumnLimit = 80;
Nico Weber450425c2014-11-26 16:43:18 +0000876 }
Daniel Jasper1b750ed2013-01-14 16:24:39 +0000877 return ChromiumStyle;
878}
879
Alexander Kornienkoc8602662013-05-06 14:11:27 +0000880FormatStyle getMozillaStyle() {
881 FormatStyle MozillaStyle = getLLVMStyle();
882 MozillaStyle.AllowAllParametersOfDeclarationOnNextLine = false;
Birunthan Mohanathasa0810022015-06-29 15:18:58 +0000883 MozillaStyle.AllowShortFunctionsOnASingleLine = FormatStyle::SFS_Inline;
Manuel Klimek89628f62017-09-20 09:51:03 +0000884 MozillaStyle.AlwaysBreakAfterReturnType = FormatStyle::RTBS_TopLevel;
Birunthan Mohanathasa0388a82015-06-29 15:30:42 +0000885 MozillaStyle.AlwaysBreakAfterDefinitionReturnType =
886 FormatStyle::DRTBS_TopLevel;
Francois Ferrand58e6fe52018-05-16 08:25:03 +0000887 MozillaStyle.AlwaysBreakTemplateDeclarations = FormatStyle::BTDS_Yes;
Sylvestre Ledrudcb038d2016-12-14 16:09:29 +0000888 MozillaStyle.BinPackParameters = false;
889 MozillaStyle.BinPackArguments = false;
Birunthan Mohanathas305fa9c2015-07-12 03:13:54 +0000890 MozillaStyle.BreakBeforeBraces = FormatStyle::BS_Mozilla;
Francois Ferranda6b6d512017-05-24 11:36:58 +0000891 MozillaStyle.BreakConstructorInitializers = FormatStyle::BCIS_BeforeComma;
Francois Ferrand6bb103f2018-06-11 14:41:26 +0000892 MozillaStyle.BreakInheritanceList = FormatStyle::BILS_BeforeComma;
Birunthan Mohanathasa0810022015-06-29 15:18:58 +0000893 MozillaStyle.ConstructorInitializerIndentWidth = 2;
894 MozillaStyle.ContinuationIndentWidth = 2;
Chandler Carruthf8b72662014-03-02 12:37:31 +0000895 MozillaStyle.Cpp11BracedListStyle = false;
Krasimir Georgiev32eaa862017-03-01 15:35:39 +0000896 MozillaStyle.FixNamespaceComments = false;
Alexander Kornienkoc8602662013-05-06 14:11:27 +0000897 MozillaStyle.IndentCaseLabels = true;
Daniel Jaspere9beea22014-01-28 15:20:33 +0000898 MozillaStyle.ObjCSpaceAfterProperty = true;
Alexander Kornienkoc8602662013-05-06 14:11:27 +0000899 MozillaStyle.ObjCSpaceBeforeProtocolList = false;
900 MozillaStyle.PenaltyReturnTypeOnItsOwnLine = 200;
Daniel Jasper553d4872014-06-17 12:40:34 +0000901 MozillaStyle.PointerAlignment = FormatStyle::PAS_Left;
Sylvestre Ledru83bbd572016-08-09 14:24:40 +0000902 MozillaStyle.SpaceAfterTemplateKeyword = false;
Alexander Kornienkoc8602662013-05-06 14:11:27 +0000903 return MozillaStyle;
904}
905
Daniel Jasperffefb3d2013-07-24 13:10:59 +0000906FormatStyle getWebKitStyle() {
907 FormatStyle Style = getLLVMStyle();
Daniel Jasper65ee3472013-07-31 23:16:02 +0000908 Style.AccessModifierOffset = -4;
Daniel Jasper6501f7e2015-10-27 12:38:37 +0000909 Style.AlignAfterOpenBracket = FormatStyle::BAS_DontAlign;
Daniel Jasper3219e432014-12-02 13:24:51 +0000910 Style.AlignOperands = false;
Daniel Jasper552f4a72013-07-31 23:55:15 +0000911 Style.AlignTrailingComments = false;
Daniel Jasperac043c92014-09-15 11:11:00 +0000912 Style.BreakBeforeBinaryOperators = FormatStyle::BOS_All;
Roman Kashitsyn291f64f2015-08-10 13:43:19 +0000913 Style.BreakBeforeBraces = FormatStyle::BS_WebKit;
Francois Ferranda6b6d512017-05-24 11:36:58 +0000914 Style.BreakConstructorInitializers = FormatStyle::BCIS_BeforeComma;
Chandler Carruthf8b72662014-03-02 12:37:31 +0000915 Style.Cpp11BracedListStyle = false;
Daniel Jasper65ee3472013-07-31 23:16:02 +0000916 Style.ColumnLimit = 0;
Krasimir Georgiev32eaa862017-03-01 15:35:39 +0000917 Style.FixNamespaceComments = false;
Daniel Jaspere33d4af2013-07-26 16:56:36 +0000918 Style.IndentWidth = 4;
Daniel Jasper65ee3472013-07-31 23:16:02 +0000919 Style.NamespaceIndentation = FormatStyle::NI_Inner;
Daniel Jasper50d634b2014-10-28 16:53:38 +0000920 Style.ObjCBlockIndentWidth = 4;
Daniel Jaspere9beea22014-01-28 15:20:33 +0000921 Style.ObjCSpaceAfterProperty = true;
Daniel Jasper553d4872014-06-17 12:40:34 +0000922 Style.PointerAlignment = FormatStyle::PAS_Left;
Hans Wennborgbfc34062018-06-14 08:01:09 +0000923 Style.SpaceBeforeCpp11BracedList = true;
Daniel Jasperffefb3d2013-07-24 13:10:59 +0000924 return Style;
925}
926
Alexander Kornienkofe7a57f2013-12-10 15:42:15 +0000927FormatStyle getGNUStyle() {
928 FormatStyle Style = getLLVMStyle();
Birunthan Mohanathasa0388a82015-06-29 15:30:42 +0000929 Style.AlwaysBreakAfterDefinitionReturnType = FormatStyle::DRTBS_All;
Zachary Turner448592e2015-12-18 22:20:15 +0000930 Style.AlwaysBreakAfterReturnType = FormatStyle::RTBS_AllDefinitions;
Daniel Jasperac043c92014-09-15 11:11:00 +0000931 Style.BreakBeforeBinaryOperators = FormatStyle::BOS_All;
Alexander Kornienko3a33f022013-12-12 09:49:52 +0000932 Style.BreakBeforeBraces = FormatStyle::BS_GNU;
Alexander Kornienkofe7a57f2013-12-10 15:42:15 +0000933 Style.BreakBeforeTernaryOperators = true;
Chandler Carruthf8b72662014-03-02 12:37:31 +0000934 Style.Cpp11BracedListStyle = false;
Alexander Kornienkofe7a57f2013-12-10 15:42:15 +0000935 Style.ColumnLimit = 79;
Krasimir Georgiev32eaa862017-03-01 15:35:39 +0000936 Style.FixNamespaceComments = false;
Alexander Kornienkofe7a57f2013-12-10 15:42:15 +0000937 Style.SpaceBeforeParens = FormatStyle::SBPO_Always;
Chandler Carruthf8b72662014-03-02 12:37:31 +0000938 Style.Standard = FormatStyle::LS_Cpp03;
Alexander Kornienkofe7a57f2013-12-10 15:42:15 +0000939 return Style;
940}
941
Daniel Jasperc64b09a2014-05-22 15:12:22 +0000942FormatStyle getNoStyle() {
943 FormatStyle NoStyle = getLLVMStyle();
944 NoStyle.DisableFormat = true;
Daniel Jasperda446772015-11-16 12:38:56 +0000945 NoStyle.SortIncludes = false;
Krasimir Georgievac16a202017-06-23 11:46:03 +0000946 NoStyle.SortUsingDeclarations = false;
Daniel Jasperc64b09a2014-05-22 15:12:22 +0000947 return NoStyle;
948}
949
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000950bool getPredefinedStyle(StringRef Name, FormatStyle::LanguageKind Language,
951 FormatStyle *Style) {
952 if (Name.equals_lower("llvm")) {
Alexander Kornienko006b5c82013-05-19 00:53:30 +0000953 *Style = getLLVMStyle();
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000954 } else if (Name.equals_lower("chromium")) {
Nico Weber514ecc82014-02-02 20:50:45 +0000955 *Style = getChromiumStyle(Language);
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000956 } else if (Name.equals_lower("mozilla")) {
Alexander Kornienko006b5c82013-05-19 00:53:30 +0000957 *Style = getMozillaStyle();
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000958 } else if (Name.equals_lower("google")) {
Nico Weber514ecc82014-02-02 20:50:45 +0000959 *Style = getGoogleStyle(Language);
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000960 } else if (Name.equals_lower("webkit")) {
Daniel Jasperffefb3d2013-07-24 13:10:59 +0000961 *Style = getWebKitStyle();
Alexander Kornienkofe7a57f2013-12-10 15:42:15 +0000962 } else if (Name.equals_lower("gnu")) {
963 *Style = getGNUStyle();
Daniel Jasperc64b09a2014-05-22 15:12:22 +0000964 } else if (Name.equals_lower("none")) {
965 *Style = getNoStyle();
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000966 } else {
Alexander Kornienko006b5c82013-05-19 00:53:30 +0000967 return false;
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000968 }
Alexander Kornienkod6538332013-05-07 15:32:14 +0000969
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000970 Style->Language = Language;
Alexander Kornienko006b5c82013-05-19 00:53:30 +0000971 return true;
Alexander Kornienkod6538332013-05-07 15:32:14 +0000972}
973
Rafael Espindolac0809172014-06-12 14:02:15 +0000974std::error_code parseConfiguration(StringRef Text, FormatStyle *Style) {
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000975 assert(Style);
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000976 FormatStyle::LanguageKind Language = Style->Language;
977 assert(Language != FormatStyle::LK_None);
Alexander Kornienko06e00332013-05-20 15:18:01 +0000978 if (Text.trim().empty())
Rafael Espindolad0136702014-06-12 02:50:04 +0000979 return make_error_code(ParseError::Error);
Krasimir Georgiev54076fe2018-01-15 12:06:16 +0000980 Style->StyleSet.Clear();
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000981 std::vector<FormatStyle> Styles;
Alexander Kornienkod6538332013-05-07 15:32:14 +0000982 llvm::yaml::Input Input(Text);
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000983 // DocumentListTraits<vector<FormatStyle>> uses the context to get default
984 // values for the fields, keys for which are missing from the configuration.
985 // Mapping also uses the context to get the language to find the correct
986 // base style.
987 Input.setContext(Style);
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000988 Input >> Styles;
989 if (Input.error())
990 return Input.error();
991
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000992 for (unsigned i = 0; i < Styles.size(); ++i) {
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000993 // Ensures that only the first configuration can skip the Language option.
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000994 if (Styles[i].Language == FormatStyle::LK_None && i != 0)
Rafael Espindolad0136702014-06-12 02:50:04 +0000995 return make_error_code(ParseError::Error);
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000996 // Ensure that each language is configured at most once.
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000997 for (unsigned j = 0; j < i; ++j) {
998 if (Styles[i].Language == Styles[j].Language) {
Nicola Zaghen3538b392018-05-15 13:30:56 +0000999 LLVM_DEBUG(llvm::dbgs()
1000 << "Duplicate languages in the config file on positions "
1001 << j << " and " << i << "\n");
Rafael Espindolad0136702014-06-12 02:50:04 +00001002 return make_error_code(ParseError::Error);
Alexander Kornienkoc1637f12013-12-10 11:28:13 +00001003 }
Alexander Kornienkocabdd732013-11-29 15:19:43 +00001004 }
1005 }
1006 // Look for a suitable configuration starting from the end, so we can
1007 // find the configuration for the specific language first, and the default
Alexander Kornienkoc1637f12013-12-10 11:28:13 +00001008 // configuration (which can only be at slot 0) after it.
Krasimir Georgiev54076fe2018-01-15 12:06:16 +00001009 FormatStyle::FormatStyleSet StyleSet;
1010 bool LanguageFound = false;
Alexander Kornienkoc1637f12013-12-10 11:28:13 +00001011 for (int i = Styles.size() - 1; i >= 0; --i) {
Krasimir Georgiev54076fe2018-01-15 12:06:16 +00001012 if (Styles[i].Language != FormatStyle::LK_None)
1013 StyleSet.Add(Styles[i]);
1014 if (Styles[i].Language == Language)
1015 LanguageFound = true;
Alexander Kornienkocabdd732013-11-29 15:19:43 +00001016 }
Krasimir Georgiev54076fe2018-01-15 12:06:16 +00001017 if (!LanguageFound) {
1018 if (Styles.empty() || Styles[0].Language != FormatStyle::LK_None)
1019 return make_error_code(ParseError::Unsuitable);
1020 FormatStyle DefaultStyle = Styles[0];
1021 DefaultStyle.Language = Language;
1022 StyleSet.Add(std::move(DefaultStyle));
1023 }
1024 *Style = *StyleSet.Get(Language);
1025 return make_error_code(ParseError::Success);
Alexander Kornienkod6538332013-05-07 15:32:14 +00001026}
1027
1028std::string configurationAsText(const FormatStyle &Style) {
1029 std::string Text;
1030 llvm::raw_string_ostream Stream(Text);
1031 llvm::yaml::Output Output(Stream);
1032 // We use the same mapping method for input and output, so we need a non-const
1033 // reference here.
Daniel Jasperc1bc38e2015-09-29 14:57:55 +00001034 FormatStyle NonConstStyle = expandPresets(Style);
Alexander Kornienkod6538332013-05-07 15:32:14 +00001035 Output << NonConstStyle;
Alexander Kornienko9a38ec22013-05-13 12:56:35 +00001036 return Stream.str();
Alexander Kornienkod6538332013-05-07 15:32:14 +00001037}
1038
Krasimir Georgiev54076fe2018-01-15 12:06:16 +00001039llvm::Optional<FormatStyle>
1040FormatStyle::FormatStyleSet::Get(FormatStyle::LanguageKind Language) const {
1041 if (!Styles)
1042 return None;
1043 auto It = Styles->find(Language);
1044 if (It == Styles->end())
1045 return None;
1046 FormatStyle Style = It->second;
1047 Style.StyleSet = *this;
1048 return Style;
1049}
1050
1051void FormatStyle::FormatStyleSet::Add(FormatStyle Style) {
1052 assert(Style.Language != LK_None &&
1053 "Cannot add a style for LK_None to a StyleSet");
1054 assert(
1055 !Style.StyleSet.Styles &&
1056 "Cannot add a style associated with an existing StyleSet to a StyleSet");
1057 if (!Styles)
1058 Styles = std::make_shared<MapType>();
1059 (*Styles)[Style.Language] = std::move(Style);
1060}
1061
1062void FormatStyle::FormatStyleSet::Clear() {
1063 Styles.reset();
1064}
1065
1066llvm::Optional<FormatStyle>
1067FormatStyle::GetLanguageStyle(FormatStyle::LanguageKind Language) const {
1068 return StyleSet.Get(Language);
1069}
1070
Craig Topperaf35e852013-06-30 22:29:28 +00001071namespace {
1072
Daniel Jasper496c1992016-09-07 22:48:53 +00001073class JavaScriptRequoter : public TokenAnalyzer {
Eric Liu4cfb88a2016-04-25 15:09:22 +00001074public:
Daniel Jasper496c1992016-09-07 22:48:53 +00001075 JavaScriptRequoter(const Environment &Env, const FormatStyle &Style)
1076 : TokenAnalyzer(Env, Style) {}
Eric Liu4cfb88a2016-04-25 15:09:22 +00001077
Krasimir Georgiev9ad83fe2017-10-30 14:01:50 +00001078 std::pair<tooling::Replacements, unsigned>
Eric Liu4cfb88a2016-04-25 15:09:22 +00001079 analyze(TokenAnnotator &Annotator,
1080 SmallVectorImpl<AnnotatedLine *> &AnnotatedLines,
Martin Probsta9855af2016-09-02 14:29:48 +00001081 FormatTokenLexer &Tokens) override {
Manuel Klimek0dddcf72018-04-23 09:34:26 +00001082 AffectedRangeMgr.computeAffectedLines(AnnotatedLines);
Daniel Jasper496c1992016-09-07 22:48:53 +00001083 tooling::Replacements Result;
1084 requoteJSStringLiteral(AnnotatedLines, Result);
Krasimir Georgiev9ad83fe2017-10-30 14:01:50 +00001085 return {Result, 0};
Alexander Kornienko62b85b92013-03-13 14:41:29 +00001086 }
1087
1088private:
Daniel Jasper496c1992016-09-07 22:48:53 +00001089 // Replaces double/single-quoted string literal as appropriate, re-escaping
1090 // the contents in the process.
Daniel Jasper97439922016-03-17 13:03:41 +00001091 void requoteJSStringLiteral(SmallVectorImpl<AnnotatedLine *> &Lines,
Eric Liu4cfb88a2016-04-25 15:09:22 +00001092 tooling::Replacements &Result) {
Daniel Jasper97439922016-03-17 13:03:41 +00001093 for (AnnotatedLine *Line : Lines) {
1094 requoteJSStringLiteral(Line->Children, Result);
1095 if (!Line->Affected)
1096 continue;
1097 for (FormatToken *FormatTok = Line->First; FormatTok;
1098 FormatTok = FormatTok->Next) {
1099 StringRef Input = FormatTok->TokenText;
Martin Probsta1669792016-05-12 11:20:32 +00001100 if (FormatTok->Finalized || !FormatTok->isStringLiteral() ||
Daniel Jasper97439922016-03-17 13:03:41 +00001101 // NB: testing for not starting with a double quote to avoid
Daniel Jasper496c1992016-09-07 22:48:53 +00001102 // breaking `template strings`.
Eric Liu635423e2016-04-28 07:52:03 +00001103 (Style.JavaScriptQuotes == FormatStyle::JSQS_Single &&
Daniel Jasper97439922016-03-17 13:03:41 +00001104 !Input.startswith("\"")) ||
Eric Liu635423e2016-04-28 07:52:03 +00001105 (Style.JavaScriptQuotes == FormatStyle::JSQS_Double &&
Daniel Jasper97439922016-03-17 13:03:41 +00001106 !Input.startswith("\'")))
1107 continue;
1108
1109 // Change start and end quote.
Eric Liu635423e2016-04-28 07:52:03 +00001110 bool IsSingle = Style.JavaScriptQuotes == FormatStyle::JSQS_Single;
Daniel Jasper97439922016-03-17 13:03:41 +00001111 SourceLocation Start = FormatTok->Tok.getLocation();
1112 auto Replace = [&](SourceLocation Start, unsigned Length,
1113 StringRef ReplacementText) {
Eric Liu40ef2fb2016-08-01 10:16:37 +00001114 auto Err = Result.add(tooling::Replacement(
1115 Env.getSourceManager(), Start, Length, ReplacementText));
1116 // FIXME: handle error. For now, print error message and skip the
1117 // replacement for release version.
Piotr Padlewski1ec383c2016-12-23 11:40:44 +00001118 if (Err) {
Eric Liu40ef2fb2016-08-01 10:16:37 +00001119 llvm::errs() << llvm::toString(std::move(Err)) << "\n";
Piotr Padlewski1ec383c2016-12-23 11:40:44 +00001120 assert(false);
1121 }
Daniel Jasper97439922016-03-17 13:03:41 +00001122 };
1123 Replace(Start, 1, IsSingle ? "'" : "\"");
1124 Replace(FormatTok->Tok.getEndLoc().getLocWithOffset(-1), 1,
1125 IsSingle ? "'" : "\"");
1126
1127 // Escape internal quotes.
Daniel Jasper97439922016-03-17 13:03:41 +00001128 bool Escaped = false;
1129 for (size_t i = 1; i < Input.size() - 1; i++) {
1130 switch (Input[i]) {
Eric Liu4cfb88a2016-04-25 15:09:22 +00001131 case '\\':
1132 if (!Escaped && i + 1 < Input.size() &&
1133 ((IsSingle && Input[i + 1] == '"') ||
1134 (!IsSingle && Input[i + 1] == '\''))) {
1135 // Remove this \, it's escaping a " or ' that no longer needs
1136 // escaping
Eric Liu4cfb88a2016-04-25 15:09:22 +00001137 Replace(Start.getLocWithOffset(i), 1, "");
1138 continue;
1139 }
1140 Escaped = !Escaped;
1141 break;
1142 case '\"':
1143 case '\'':
1144 if (!Escaped && IsSingle == (Input[i] == '\'')) {
1145 // Escape the quote.
1146 Replace(Start.getLocWithOffset(i), 0, "\\");
Eric Liu4cfb88a2016-04-25 15:09:22 +00001147 }
1148 Escaped = false;
1149 break;
1150 default:
1151 Escaped = false;
1152 break;
Daniel Jasper97439922016-03-17 13:03:41 +00001153 }
1154 }
Daniel Jasper97439922016-03-17 13:03:41 +00001155 }
1156 }
1157 }
Daniel Jasper496c1992016-09-07 22:48:53 +00001158};
1159
1160class Formatter : public TokenAnalyzer {
1161public:
1162 Formatter(const Environment &Env, const FormatStyle &Style,
Krasimir Georgievbcda54b2017-04-21 14:35:20 +00001163 FormattingAttemptStatus *Status)
1164 : TokenAnalyzer(Env, Style), Status(Status) {}
Daniel Jasper496c1992016-09-07 22:48:53 +00001165
Krasimir Georgiev9ad83fe2017-10-30 14:01:50 +00001166 std::pair<tooling::Replacements, unsigned>
Daniel Jasper496c1992016-09-07 22:48:53 +00001167 analyze(TokenAnnotator &Annotator,
1168 SmallVectorImpl<AnnotatedLine *> &AnnotatedLines,
1169 FormatTokenLexer &Tokens) override {
1170 tooling::Replacements Result;
1171 deriveLocalStyle(AnnotatedLines);
Manuel Klimek0dddcf72018-04-23 09:34:26 +00001172 AffectedRangeMgr.computeAffectedLines(AnnotatedLines);
Daniel Jasper496c1992016-09-07 22:48:53 +00001173 for (unsigned i = 0, e = AnnotatedLines.size(); i != e; ++i) {
1174 Annotator.calculateFormattingInformation(*AnnotatedLines[i]);
1175 }
1176 Annotator.setCommentLineLevels(AnnotatedLines);
1177
1178 WhitespaceManager Whitespaces(
1179 Env.getSourceManager(), Style,
1180 inputUsesCRLF(Env.getSourceManager().getBufferData(Env.getFileID())));
1181 ContinuationIndenter Indenter(Style, Tokens.getKeywords(),
1182 Env.getSourceManager(), Whitespaces, Encoding,
1183 BinPackInconclusiveFunctions);
Krasimir Georgiev9ad83fe2017-10-30 14:01:50 +00001184 unsigned Penalty =
1185 UnwrappedLineFormatter(&Indenter, &Whitespaces, Style,
1186 Tokens.getKeywords(), Env.getSourceManager(),
1187 Status)
1188 .format(AnnotatedLines, /*DryRun=*/false,
1189 /*AdditionalIndent=*/0,
1190 /*FixBadIndentation=*/false,
1191 /*FirstStartColumn=*/Env.getFirstStartColumn(),
1192 /*NextStartColumn=*/Env.getNextStartColumn(),
1193 /*LastStartColumn=*/Env.getLastStartColumn());
Daniel Jasper496c1992016-09-07 22:48:53 +00001194 for (const auto &R : Whitespaces.generateReplacements())
1195 if (Result.add(R))
Krasimir Georgieve56e9a42017-10-30 14:30:14 +00001196 return std::make_pair(Result, 0);
1197 return std::make_pair(Result, Penalty);
Daniel Jasper496c1992016-09-07 22:48:53 +00001198 }
1199
1200private:
Alexander Kornienko9e649af2013-09-11 12:25:57 +00001201 static bool inputUsesCRLF(StringRef Text) {
1202 return Text.count('\r') * 2 > Text.count('\n');
1203 }
1204
Daniel Jasper352f0df2015-07-18 16:35:30 +00001205 bool
1206 hasCpp03IncompatibleFormat(const SmallVectorImpl<AnnotatedLine *> &Lines) {
Eric Liu4cfb88a2016-04-25 15:09:22 +00001207 for (const AnnotatedLine *Line : Lines) {
Daniel Jasper352f0df2015-07-18 16:35:30 +00001208 if (hasCpp03IncompatibleFormat(Line->Children))
1209 return true;
1210 for (FormatToken *Tok = Line->First->Next; Tok; Tok = Tok->Next) {
1211 if (Tok->WhitespaceRange.getBegin() == Tok->WhitespaceRange.getEnd()) {
1212 if (Tok->is(tok::coloncolon) && Tok->Previous->is(TT_TemplateOpener))
1213 return true;
1214 if (Tok->is(TT_TemplateCloser) &&
1215 Tok->Previous->is(TT_TemplateCloser))
1216 return true;
1217 }
1218 }
1219 }
1220 return false;
1221 }
1222
1223 int countVariableAlignments(const SmallVectorImpl<AnnotatedLine *> &Lines) {
1224 int AlignmentDiff = 0;
Eric Liu4cfb88a2016-04-25 15:09:22 +00001225 for (const AnnotatedLine *Line : Lines) {
Daniel Jasper352f0df2015-07-18 16:35:30 +00001226 AlignmentDiff += countVariableAlignments(Line->Children);
1227 for (FormatToken *Tok = Line->First; Tok && Tok->Next; Tok = Tok->Next) {
1228 if (!Tok->is(TT_PointerOrReference))
1229 continue;
1230 bool SpaceBefore =
1231 Tok->WhitespaceRange.getBegin() != Tok->WhitespaceRange.getEnd();
1232 bool SpaceAfter = Tok->Next->WhitespaceRange.getBegin() !=
1233 Tok->Next->WhitespaceRange.getEnd();
1234 if (SpaceBefore && !SpaceAfter)
1235 ++AlignmentDiff;
1236 if (!SpaceBefore && SpaceAfter)
1237 --AlignmentDiff;
1238 }
1239 }
1240 return AlignmentDiff;
1241 }
1242
Manuel Klimek71814b42013-10-11 21:25:45 +00001243 void
1244 deriveLocalStyle(const SmallVectorImpl<AnnotatedLine *> &AnnotatedLines) {
Daniel Jasperb10cbc42013-07-10 14:02:49 +00001245 bool HasBinPackedFunction = false;
1246 bool HasOnePerLineFunction = false;
Daniel Jasper7fce3ab2013-02-06 14:22:40 +00001247 for (unsigned i = 0, e = AnnotatedLines.size(); i != e; ++i) {
Daniel Jasper9fe0e8d2013-09-05 09:29:45 +00001248 if (!AnnotatedLines[i]->First->Next)
Daniel Jasper7fce3ab2013-02-06 14:22:40 +00001249 continue;
Daniel Jasper9fe0e8d2013-09-05 09:29:45 +00001250 FormatToken *Tok = AnnotatedLines[i]->First->Next;
Manuel Klimek6e6310e2013-05-29 14:47:47 +00001251 while (Tok->Next) {
Daniel Jasperb10cbc42013-07-10 14:02:49 +00001252 if (Tok->PackingKind == PPK_BinPacked)
1253 HasBinPackedFunction = true;
1254 if (Tok->PackingKind == PPK_OnePerLine)
1255 HasOnePerLineFunction = true;
1256
Manuel Klimek6e6310e2013-05-29 14:47:47 +00001257 Tok = Tok->Next;
Daniel Jasper7fce3ab2013-02-06 14:22:40 +00001258 }
1259 }
Eric Liu635423e2016-04-28 07:52:03 +00001260 if (Style.DerivePointerAlignment)
1261 Style.PointerAlignment = countVariableAlignments(AnnotatedLines) <= 0
1262 ? FormatStyle::PAS_Left
1263 : FormatStyle::PAS_Right;
1264 if (Style.Standard == FormatStyle::LS_Auto)
1265 Style.Standard = hasCpp03IncompatibleFormat(AnnotatedLines)
1266 ? FormatStyle::LS_Cpp11
1267 : FormatStyle::LS_Cpp03;
Daniel Jasperb10cbc42013-07-10 14:02:49 +00001268 BinPackInconclusiveFunctions =
1269 HasBinPackedFunction || !HasOnePerLineFunction;
Daniel Jasper7fce3ab2013-02-06 14:22:40 +00001270 }
1271
Daniel Jasperb10cbc42013-07-10 14:02:49 +00001272 bool BinPackInconclusiveFunctions;
Krasimir Georgievbcda54b2017-04-21 14:35:20 +00001273 FormattingAttemptStatus *Status;
Eric Liu4cfb88a2016-04-25 15:09:22 +00001274};
1275
1276// This class clean up the erroneous/redundant code around the given ranges in
1277// file.
1278class Cleaner : public TokenAnalyzer {
1279public:
Eric Liu635423e2016-04-28 07:52:03 +00001280 Cleaner(const Environment &Env, const FormatStyle &Style)
1281 : TokenAnalyzer(Env, Style),
Eric Liu4cfb88a2016-04-25 15:09:22 +00001282 DeletedTokens(FormatTokenLess(Env.getSourceManager())) {}
1283
1284 // FIXME: eliminate unused parameters.
Krasimir Georgiev9ad83fe2017-10-30 14:01:50 +00001285 std::pair<tooling::Replacements, unsigned>
Eric Liu4cfb88a2016-04-25 15:09:22 +00001286 analyze(TokenAnnotator &Annotator,
1287 SmallVectorImpl<AnnotatedLine *> &AnnotatedLines,
Martin Probsta9855af2016-09-02 14:29:48 +00001288 FormatTokenLexer &Tokens) override {
Eric Liu4cfb88a2016-04-25 15:09:22 +00001289 // FIXME: in the current implementation the granularity of affected range
1290 // is an annotated line. However, this is not sufficient. Furthermore,
1291 // redundant code introduced by replacements does not necessarily
1292 // intercept with ranges of replacements that result in the redundancy.
1293 // To determine if some redundant code is actually introduced by
1294 // replacements(e.g. deletions), we need to come up with a more
1295 // sophisticated way of computing affected ranges.
Manuel Klimek0dddcf72018-04-23 09:34:26 +00001296 AffectedRangeMgr.computeAffectedLines(AnnotatedLines);
Eric Liu4cfb88a2016-04-25 15:09:22 +00001297
1298 checkEmptyNamespace(AnnotatedLines);
1299
Eric Liuce5e4bc2016-05-18 08:02:56 +00001300 for (auto &Line : AnnotatedLines) {
1301 if (Line->Affected) {
1302 cleanupRight(Line->First, tok::comma, tok::comma);
1303 cleanupRight(Line->First, TT_CtorInitializerColon, tok::comma);
Eric Liu2574d152016-09-13 15:02:43 +00001304 cleanupRight(Line->First, tok::l_paren, tok::comma);
1305 cleanupLeft(Line->First, tok::comma, tok::r_paren);
Eric Liuce5e4bc2016-05-18 08:02:56 +00001306 cleanupLeft(Line->First, TT_CtorInitializerComma, tok::l_brace);
1307 cleanupLeft(Line->First, TT_CtorInitializerColon, tok::l_brace);
Malcolm Parsons5d8cdb82016-10-20 14:58:45 +00001308 cleanupLeft(Line->First, TT_CtorInitializerColon, tok::equal);
Eric Liuce5e4bc2016-05-18 08:02:56 +00001309 }
1310 }
1311
Krasimir Georgiev9ad83fe2017-10-30 14:01:50 +00001312 return {generateFixes(), 0};
Eric Liu4cfb88a2016-04-25 15:09:22 +00001313 }
1314
1315private:
1316 bool containsOnlyComments(const AnnotatedLine &Line) {
1317 for (FormatToken *Tok = Line.First; Tok != nullptr; Tok = Tok->Next) {
1318 if (Tok->isNot(tok::comment))
1319 return false;
1320 }
1321 return true;
1322 }
1323
1324 // Iterate through all lines and remove any empty (nested) namespaces.
1325 void checkEmptyNamespace(SmallVectorImpl<AnnotatedLine *> &AnnotatedLines) {
Eric Liu7956c402016-10-05 15:49:01 +00001326 std::set<unsigned> DeletedLines;
Eric Liu4cfb88a2016-04-25 15:09:22 +00001327 for (unsigned i = 0, e = AnnotatedLines.size(); i != e; ++i) {
1328 auto &Line = *AnnotatedLines[i];
Sam McCall6f3778c2018-09-05 07:44:02 +00001329 if (Line.startsWithNamespace()) {
Eric Liu7956c402016-10-05 15:49:01 +00001330 checkEmptyNamespace(AnnotatedLines, i, i, DeletedLines);
Eric Liu4cfb88a2016-04-25 15:09:22 +00001331 }
1332 }
1333
1334 for (auto Line : DeletedLines) {
1335 FormatToken *Tok = AnnotatedLines[Line]->First;
1336 while (Tok) {
1337 deleteToken(Tok);
1338 Tok = Tok->Next;
1339 }
1340 }
1341 }
1342
1343 // The function checks if the namespace, which starts from \p CurrentLine, and
1344 // its nested namespaces are empty and delete them if they are empty. It also
1345 // sets \p NewLine to the last line checked.
1346 // Returns true if the current namespace is empty.
1347 bool checkEmptyNamespace(SmallVectorImpl<AnnotatedLine *> &AnnotatedLines,
Eric Liu7956c402016-10-05 15:49:01 +00001348 unsigned CurrentLine, unsigned &NewLine,
1349 std::set<unsigned> &DeletedLines) {
Eric Liu4cfb88a2016-04-25 15:09:22 +00001350 unsigned InitLine = CurrentLine, End = AnnotatedLines.size();
Eric Liu635423e2016-04-28 07:52:03 +00001351 if (Style.BraceWrapping.AfterNamespace) {
Eric Liu4cfb88a2016-04-25 15:09:22 +00001352 // If the left brace is in a new line, we should consume it first so that
1353 // it does not make the namespace non-empty.
1354 // FIXME: error handling if there is no left brace.
1355 if (!AnnotatedLines[++CurrentLine]->startsWith(tok::l_brace)) {
1356 NewLine = CurrentLine;
1357 return false;
1358 }
1359 } else if (!AnnotatedLines[CurrentLine]->endsWith(tok::l_brace)) {
1360 return false;
1361 }
1362 while (++CurrentLine < End) {
1363 if (AnnotatedLines[CurrentLine]->startsWith(tok::r_brace))
1364 break;
1365
Sam McCall6f3778c2018-09-05 07:44:02 +00001366 if (AnnotatedLines[CurrentLine]->startsWithNamespace()) {
Eric Liu7956c402016-10-05 15:49:01 +00001367 if (!checkEmptyNamespace(AnnotatedLines, CurrentLine, NewLine,
1368 DeletedLines))
Eric Liu4cfb88a2016-04-25 15:09:22 +00001369 return false;
1370 CurrentLine = NewLine;
1371 continue;
1372 }
1373
1374 if (containsOnlyComments(*AnnotatedLines[CurrentLine]))
1375 continue;
1376
1377 // If there is anything other than comments or nested namespaces in the
1378 // current namespace, the namespace cannot be empty.
1379 NewLine = CurrentLine;
1380 return false;
1381 }
1382
1383 NewLine = CurrentLine;
1384 if (CurrentLine >= End)
1385 return false;
1386
1387 // Check if the empty namespace is actually affected by changed ranges.
1388 if (!AffectedRangeMgr.affectsCharSourceRange(CharSourceRange::getCharRange(
1389 AnnotatedLines[InitLine]->First->Tok.getLocation(),
1390 AnnotatedLines[CurrentLine]->Last->Tok.getEndLoc())))
1391 return false;
1392
1393 for (unsigned i = InitLine; i <= CurrentLine; ++i) {
1394 DeletedLines.insert(i);
1395 }
1396
1397 return true;
1398 }
1399
Eric Liuce5e4bc2016-05-18 08:02:56 +00001400 // Checks pairs {start, start->next},..., {end->previous, end} and deletes one
1401 // of the token in the pair if the left token has \p LK token kind and the
1402 // right token has \p RK token kind. If \p DeleteLeft is true, the left token
1403 // is deleted on match; otherwise, the right token is deleted.
1404 template <typename LeftKind, typename RightKind>
1405 void cleanupPair(FormatToken *Start, LeftKind LK, RightKind RK,
1406 bool DeleteLeft) {
1407 auto NextNotDeleted = [this](const FormatToken &Tok) -> FormatToken * {
1408 for (auto *Res = Tok.Next; Res; Res = Res->Next)
1409 if (!Res->is(tok::comment) &&
1410 DeletedTokens.find(Res) == DeletedTokens.end())
1411 return Res;
1412 return nullptr;
1413 };
1414 for (auto *Left = Start; Left;) {
1415 auto *Right = NextNotDeleted(*Left);
1416 if (!Right)
1417 break;
1418 if (Left->is(LK) && Right->is(RK)) {
1419 deleteToken(DeleteLeft ? Left : Right);
Eric Liu01426ff2016-09-09 17:50:49 +00001420 for (auto *Tok = Left->Next; Tok && Tok != Right; Tok = Tok->Next)
1421 deleteToken(Tok);
Eric Liuce5e4bc2016-05-18 08:02:56 +00001422 // If the right token is deleted, we should keep the left token
1423 // unchanged and pair it with the new right token.
1424 if (!DeleteLeft)
1425 continue;
1426 }
1427 Left = Right;
1428 }
1429 }
1430
1431 template <typename LeftKind, typename RightKind>
1432 void cleanupLeft(FormatToken *Start, LeftKind LK, RightKind RK) {
1433 cleanupPair(Start, LK, RK, /*DeleteLeft=*/true);
1434 }
1435
1436 template <typename LeftKind, typename RightKind>
1437 void cleanupRight(FormatToken *Start, LeftKind LK, RightKind RK) {
1438 cleanupPair(Start, LK, RK, /*DeleteLeft=*/false);
1439 }
1440
Eric Liu4cfb88a2016-04-25 15:09:22 +00001441 // Delete the given token.
1442 inline void deleteToken(FormatToken *Tok) {
1443 if (Tok)
1444 DeletedTokens.insert(Tok);
1445 }
1446
1447 tooling::Replacements generateFixes() {
1448 tooling::Replacements Fixes;
1449 std::vector<FormatToken *> Tokens;
1450 std::copy(DeletedTokens.begin(), DeletedTokens.end(),
1451 std::back_inserter(Tokens));
1452
1453 // Merge multiple continuous token deletions into one big deletion so that
1454 // the number of replacements can be reduced. This makes computing affected
1455 // ranges more efficient when we run reformat on the changed code.
1456 unsigned Idx = 0;
1457 while (Idx < Tokens.size()) {
1458 unsigned St = Idx, End = Idx;
1459 while ((End + 1) < Tokens.size() &&
1460 Tokens[End]->Next == Tokens[End + 1]) {
1461 End++;
1462 }
1463 auto SR = CharSourceRange::getCharRange(Tokens[St]->Tok.getLocation(),
1464 Tokens[End]->Tok.getEndLoc());
Eric Liu40ef2fb2016-08-01 10:16:37 +00001465 auto Err =
1466 Fixes.add(tooling::Replacement(Env.getSourceManager(), SR, ""));
1467 // FIXME: better error handling. for now just print error message and skip
1468 // for the release version.
Piotr Padlewski1ec383c2016-12-23 11:40:44 +00001469 if (Err) {
Eric Liu40ef2fb2016-08-01 10:16:37 +00001470 llvm::errs() << llvm::toString(std::move(Err)) << "\n";
Piotr Padlewski1ec383c2016-12-23 11:40:44 +00001471 assert(false && "Fixes must not conflict!");
1472 }
Eric Liu4cfb88a2016-04-25 15:09:22 +00001473 Idx = End + 1;
1474 }
1475
1476 return Fixes;
1477 }
1478
1479 // Class for less-than inequality comparason for the set `RedundantTokens`.
1480 // We store tokens in the order they appear in the translation unit so that
1481 // we do not need to sort them in `generateFixes()`.
1482 struct FormatTokenLess {
Eric Liu635423e2016-04-28 07:52:03 +00001483 FormatTokenLess(const SourceManager &SM) : SM(SM) {}
Eric Liu4cfb88a2016-04-25 15:09:22 +00001484
Eric Liu2874ac32016-05-18 08:14:49 +00001485 bool operator()(const FormatToken *LHS, const FormatToken *RHS) const {
Eric Liu4cfb88a2016-04-25 15:09:22 +00001486 return SM.isBeforeInTranslationUnit(LHS->Tok.getLocation(),
1487 RHS->Tok.getLocation());
1488 }
Eric Liu635423e2016-04-28 07:52:03 +00001489 const SourceManager &SM;
Eric Liu4cfb88a2016-04-25 15:09:22 +00001490 };
1491
1492 // Tokens to be deleted.
1493 std::set<FormatToken *, FormatTokenLess> DeletedTokens;
Daniel Jasperf7935112012-12-03 18:12:45 +00001494};
1495
Ben Hamiltone2e3e672018-01-17 17:33:08 +00001496class ObjCHeaderStyleGuesser : public TokenAnalyzer {
1497public:
1498 ObjCHeaderStyleGuesser(const Environment &Env, const FormatStyle &Style)
1499 : TokenAnalyzer(Env, Style), IsObjC(false) {}
1500
1501 std::pair<tooling::Replacements, unsigned>
1502 analyze(TokenAnnotator &Annotator,
1503 SmallVectorImpl<AnnotatedLine *> &AnnotatedLines,
1504 FormatTokenLexer &Tokens) override {
1505 assert(Style.Language == FormatStyle::LK_Cpp);
Ben Hamilton0675e872018-11-05 16:59:33 +00001506 IsObjC = guessIsObjC(Env.getSourceManager(), AnnotatedLines,
1507 Tokens.getKeywords());
Ben Hamiltone2e3e672018-01-17 17:33:08 +00001508 tooling::Replacements Result;
1509 return {Result, 0};
1510 }
1511
1512 bool isObjC() { return IsObjC; }
1513
1514private:
Ben Hamilton0675e872018-11-05 16:59:33 +00001515 static bool
1516 guessIsObjC(const SourceManager &SourceManager,
1517 const SmallVectorImpl<AnnotatedLine *> &AnnotatedLines,
1518 const AdditionalKeywords &Keywords) {
Krasimir Georgiev8e216782018-01-17 20:01:02 +00001519 // Keep this array sorted, since we are binary searching over it.
1520 static constexpr llvm::StringLiteral FoundationIdentifiers[] = {
Ben Hamiltone2e3e672018-01-17 17:33:08 +00001521 "CGFloat",
Ben Hamilton19c782d2018-03-22 03:25:22 +00001522 "CGPoint",
1523 "CGPointMake",
1524 "CGPointZero",
1525 "CGRect",
1526 "CGRectEdge",
1527 "CGRectInfinite",
1528 "CGRectMake",
1529 "CGRectNull",
1530 "CGRectZero",
1531 "CGSize",
1532 "CGSizeMake",
1533 "CGVector",
1534 "CGVectorMake",
Ben Hamiltone2e3e672018-01-17 17:33:08 +00001535 "NSAffineTransform",
1536 "NSArray",
1537 "NSAttributedString",
Ben Hamiltonb1a79192018-04-12 15:11:53 +00001538 "NSBlockOperation",
Jacek Olesiakce4f0af2018-02-15 08:47:56 +00001539 "NSBundle",
Ben Hamiltone2e3e672018-01-17 17:33:08 +00001540 "NSCache",
Jacek Olesiakce4f0af2018-02-15 08:47:56 +00001541 "NSCalendar",
Ben Hamiltone2e3e672018-01-17 17:33:08 +00001542 "NSCharacterSet",
1543 "NSCountedSet",
1544 "NSData",
1545 "NSDataDetector",
1546 "NSDecimal",
1547 "NSDecimalNumber",
1548 "NSDictionary",
1549 "NSEdgeInsets",
1550 "NSHashTable",
1551 "NSIndexPath",
1552 "NSIndexSet",
1553 "NSInteger",
Ben Hamiltonb1a79192018-04-12 15:11:53 +00001554 "NSInvocationOperation",
Ben Hamiltone2e3e672018-01-17 17:33:08 +00001555 "NSLocale",
1556 "NSMapTable",
1557 "NSMutableArray",
1558 "NSMutableAttributedString",
1559 "NSMutableCharacterSet",
1560 "NSMutableData",
1561 "NSMutableDictionary",
1562 "NSMutableIndexSet",
1563 "NSMutableOrderedSet",
1564 "NSMutableSet",
1565 "NSMutableString",
1566 "NSNumber",
1567 "NSNumberFormatter",
Jacek Olesiakce4f0af2018-02-15 08:47:56 +00001568 "NSObject",
Ben Hamiltonb1a79192018-04-12 15:11:53 +00001569 "NSOperation",
1570 "NSOperationQueue",
1571 "NSOperationQueuePriority",
Ben Hamiltone2e3e672018-01-17 17:33:08 +00001572 "NSOrderedSet",
1573 "NSPoint",
1574 "NSPointerArray",
Ben Hamiltonb1a79192018-04-12 15:11:53 +00001575 "NSQualityOfService",
Ben Hamiltone2e3e672018-01-17 17:33:08 +00001576 "NSRange",
1577 "NSRect",
1578 "NSRegularExpression",
1579 "NSSet",
1580 "NSSize",
1581 "NSString",
Jacek Olesiakce4f0af2018-02-15 08:47:56 +00001582 "NSTimeZone",
Ben Hamiltone2e3e672018-01-17 17:33:08 +00001583 "NSUInteger",
1584 "NSURL",
1585 "NSURLComponents",
1586 "NSURLQueryItem",
1587 "NSUUID",
Jacek Olesiakce4f0af2018-02-15 08:47:56 +00001588 "NSValue",
Ben Hamilton19c782d2018-03-22 03:25:22 +00001589 "UIImage",
1590 "UIView",
Ben Hamiltone2e3e672018-01-17 17:33:08 +00001591 };
1592
Ben Hamiltonea7a27b2018-03-27 15:01:21 +00001593 for (auto Line : AnnotatedLines) {
1594 for (const FormatToken *FormatTok = Line->First; FormatTok;
Ben Hamiltone2e3e672018-01-17 17:33:08 +00001595 FormatTok = FormatTok->Next) {
Jacek Olesiakce4f0af2018-02-15 08:47:56 +00001596 if ((FormatTok->Previous && FormatTok->Previous->is(tok::at) &&
Ben Hamiltonb1a79192018-04-12 15:11:53 +00001597 (FormatTok->Tok.getObjCKeywordID() != tok::objc_not_keyword ||
Ben Hamiltone2e3e672018-01-17 17:33:08 +00001598 FormatTok->isOneOf(tok::numeric_constant, tok::l_square,
1599 tok::l_brace))) ||
1600 (FormatTok->Tok.isAnyIdentifier() &&
Krasimir Georgiev8e216782018-01-17 20:01:02 +00001601 std::binary_search(std::begin(FoundationIdentifiers),
1602 std::end(FoundationIdentifiers),
1603 FormatTok->TokenText)) ||
Ben Hamiltone2e3e672018-01-17 17:33:08 +00001604 FormatTok->is(TT_ObjCStringLiteral) ||
1605 FormatTok->isOneOf(Keywords.kw_NS_ENUM, Keywords.kw_NS_OPTIONS,
1606 TT_ObjCBlockLBrace, TT_ObjCBlockLParen,
1607 TT_ObjCDecl, TT_ObjCForIn, TT_ObjCMethodExpr,
1608 TT_ObjCMethodSpecifier, TT_ObjCProperty)) {
Ben Hamilton0675e872018-11-05 16:59:33 +00001609 LLVM_DEBUG(llvm::dbgs()
1610 << "Detected ObjC at location "
1611 << FormatTok->Tok.getLocation().printToString(
1612 SourceManager)
1613 << " token: " << FormatTok->TokenText << " token type: "
1614 << getTokenTypeName(FormatTok->Type) << "\n");
Ben Hamiltone2e3e672018-01-17 17:33:08 +00001615 return true;
1616 }
Ben Hamilton0675e872018-11-05 16:59:33 +00001617 if (guessIsObjC(SourceManager, Line->Children, Keywords))
Ben Hamilton6432afe2018-03-22 17:37:19 +00001618 return true;
1619 }
Ben Hamiltone2e3e672018-01-17 17:33:08 +00001620 }
1621 return false;
1622 }
1623
1624 bool IsObjC;
1625};
1626
Daniel Jasperd89ae9d2015-09-23 08:30:47 +00001627struct IncludeDirective {
1628 StringRef Filename;
1629 StringRef Text;
1630 unsigned Offset;
Daniel Jasperd2629dc2015-12-16 10:10:16 +00001631 int Category;
Daniel Jasperd89ae9d2015-09-23 08:30:47 +00001632};
1633
Krasimir Georgiev7e91b032018-10-05 17:19:26 +00001634struct JavaImportDirective {
1635 StringRef Identifier;
1636 StringRef Text;
1637 unsigned Offset;
1638 std::vector<StringRef> AssociatedCommentLines;
1639 bool IsStatic;
1640};
1641
Craig Topperaf35e852013-06-30 22:29:28 +00001642} // end anonymous namespace
1643
Daniel Jasperd89ae9d2015-09-23 08:30:47 +00001644// Determines whether 'Ranges' intersects with ('Start', 'End').
1645static bool affectsRange(ArrayRef<tooling::Range> Ranges, unsigned Start,
1646 unsigned End) {
1647 for (auto Range : Ranges) {
1648 if (Range.getOffset() < End &&
1649 Range.getOffset() + Range.getLength() > Start)
1650 return true;
1651 }
1652 return false;
1653}
1654
Eric Liua992afe2016-08-10 09:32:23 +00001655// Returns a pair (Index, OffsetToEOL) describing the position of the cursor
1656// before sorting/deduplicating. Index is the index of the include under the
1657// cursor in the original set of includes. If this include has duplicates, it is
1658// the index of the first of the duplicates as the others are going to be
1659// removed. OffsetToEOL describes the cursor's position relative to the end of
1660// its current line.
1661// If `Cursor` is not on any #include, `Index` will be UINT_MAX.
1662static std::pair<unsigned, unsigned>
1663FindCursorIndex(const SmallVectorImpl<IncludeDirective> &Includes,
1664 const SmallVectorImpl<unsigned> &Indices, unsigned Cursor) {
1665 unsigned CursorIndex = UINT_MAX;
1666 unsigned OffsetToEOL = 0;
1667 for (int i = 0, e = Includes.size(); i != e; ++i) {
1668 unsigned Start = Includes[Indices[i]].Offset;
1669 unsigned End = Start + Includes[Indices[i]].Text.size();
1670 if (!(Cursor >= Start && Cursor < End))
1671 continue;
1672 CursorIndex = Indices[i];
1673 OffsetToEOL = End - Cursor;
1674 // Put the cursor on the only remaining #include among the duplicate
1675 // #includes.
1676 while (--i >= 0 && Includes[CursorIndex].Text == Includes[Indices[i]].Text)
1677 CursorIndex = i;
1678 break;
1679 }
1680 return std::make_pair(CursorIndex, OffsetToEOL);
1681}
1682
1683// Sorts and deduplicate a block of includes given by 'Includes' alphabetically
1684// adding the necessary replacement to 'Replaces'. 'Includes' must be in strict
1685// source order.
1686// #include directives with the same text will be deduplicated, and only the
1687// first #include in the duplicate #includes remains. If the `Cursor` is
1688// provided and put on a deleted #include, it will be moved to the remaining
1689// #include in the duplicate #includes.
Martin Probstc4a0dd42016-05-20 11:24:24 +00001690static void sortCppIncludes(const FormatStyle &Style,
Eric Liua992afe2016-08-10 09:32:23 +00001691 const SmallVectorImpl<IncludeDirective> &Includes,
1692 ArrayRef<tooling::Range> Ranges, StringRef FileName,
1693 tooling::Replacements &Replaces, unsigned *Cursor) {
1694 unsigned IncludesBeginOffset = Includes.front().Offset;
Daniel Jasperd6a00782016-08-30 21:33:41 +00001695 unsigned IncludesEndOffset =
1696 Includes.back().Offset + Includes.back().Text.size();
1697 unsigned IncludesBlockSize = IncludesEndOffset - IncludesBeginOffset;
1698 if (!affectsRange(Ranges, IncludesBeginOffset, IncludesEndOffset))
Daniel Jasperd89ae9d2015-09-23 08:30:47 +00001699 return;
1700 SmallVector<unsigned, 16> Indices;
1701 for (unsigned i = 0, e = Includes.size(); i != e; ++i)
1702 Indices.push_back(i);
Daniel Jasper94a96fc2016-03-03 17:34:14 +00001703 std::stable_sort(
1704 Indices.begin(), Indices.end(), [&](unsigned LHSI, unsigned RHSI) {
1705 return std::tie(Includes[LHSI].Category, Includes[LHSI].Filename) <
1706 std::tie(Includes[RHSI].Category, Includes[RHSI].Filename);
1707 });
Eric Liua992afe2016-08-10 09:32:23 +00001708 // The index of the include on which the cursor will be put after
1709 // sorting/deduplicating.
1710 unsigned CursorIndex;
1711 // The offset from cursor to the end of line.
1712 unsigned CursorToEOLOffset;
1713 if (Cursor)
1714 std::tie(CursorIndex, CursorToEOLOffset) =
1715 FindCursorIndex(Includes, Indices, *Cursor);
1716
1717 // Deduplicate #includes.
1718 Indices.erase(std::unique(Indices.begin(), Indices.end(),
1719 [&](unsigned LHSI, unsigned RHSI) {
1720 return Includes[LHSI].Text == Includes[RHSI].Text;
1721 }),
1722 Indices.end());
Daniel Jasperd89ae9d2015-09-23 08:30:47 +00001723
Krasimir Georgiev4c2c9c32017-11-27 13:23:45 +00001724 int CurrentCategory = Includes.front().Category;
1725
Daniel Jasperd89ae9d2015-09-23 08:30:47 +00001726 // If the #includes are out of order, we generate a single replacement fixing
1727 // the entire block. Otherwise, no replacement is generated.
Eric Liua992afe2016-08-10 09:32:23 +00001728 if (Indices.size() == Includes.size() &&
Krasimir Georgiev4c2c9c32017-11-27 13:23:45 +00001729 std::is_sorted(Indices.begin(), Indices.end()) &&
Eric Liu9d92c022018-05-14 19:51:33 +00001730 Style.IncludeStyle.IncludeBlocks == tooling::IncludeStyle::IBS_Preserve)
Daniel Jasperd89ae9d2015-09-23 08:30:47 +00001731 return;
1732
Daniel Jasperb68aabf2015-11-23 08:36:35 +00001733 std::string result;
Daniel Jasperb68aabf2015-11-23 08:36:35 +00001734 for (unsigned Index : Indices) {
Krasimir Georgiev4c2c9c32017-11-27 13:23:45 +00001735 if (!result.empty()) {
Daniel Jasperb68aabf2015-11-23 08:36:35 +00001736 result += "\n";
Eric Liu9d92c022018-05-14 19:51:33 +00001737 if (Style.IncludeStyle.IncludeBlocks ==
1738 tooling::IncludeStyle::IBS_Regroup &&
Krasimir Georgiev4c2c9c32017-11-27 13:23:45 +00001739 CurrentCategory != Includes[Index].Category)
1740 result += "\n";
1741 }
Daniel Jasperb68aabf2015-11-23 08:36:35 +00001742 result += Includes[Index].Text;
Eric Liua992afe2016-08-10 09:32:23 +00001743 if (Cursor && CursorIndex == Index)
1744 *Cursor = IncludesBeginOffset + result.size() - CursorToEOLOffset;
Krasimir Georgiev4c2c9c32017-11-27 13:23:45 +00001745 CurrentCategory = Includes[Index].Category;
Daniel Jasperd89ae9d2015-09-23 08:30:47 +00001746 }
1747
Eric Liu40ef2fb2016-08-01 10:16:37 +00001748 auto Err = Replaces.add(tooling::Replacement(
Eric Liua992afe2016-08-10 09:32:23 +00001749 FileName, Includes.front().Offset, IncludesBlockSize, result));
Eric Liu40ef2fb2016-08-01 10:16:37 +00001750 // FIXME: better error handling. For now, just skip the replacement for the
1751 // release version.
Piotr Padlewski1ec383c2016-12-23 11:40:44 +00001752 if (Err) {
Eric Liu40ef2fb2016-08-01 10:16:37 +00001753 llvm::errs() << llvm::toString(std::move(Err)) << "\n";
Piotr Padlewski1ec383c2016-12-23 11:40:44 +00001754 assert(false);
1755 }
Daniel Jasperd89ae9d2015-09-23 08:30:47 +00001756}
1757
Eric Liu659afd52016-05-31 13:34:20 +00001758namespace {
1759
Krasimir Georgiev7e91b032018-10-05 17:19:26 +00001760const char CppIncludeRegexPattern[] =
Eric Liu659afd52016-05-31 13:34:20 +00001761 R"(^[\t\ ]*#[\t\ ]*(import|include)[^"<]*(["<][^">]*[">]))";
1762
1763} // anonymous namespace
1764
Martin Probstc4a0dd42016-05-20 11:24:24 +00001765tooling::Replacements sortCppIncludes(const FormatStyle &Style, StringRef Code,
1766 ArrayRef<tooling::Range> Ranges,
1767 StringRef FileName,
1768 tooling::Replacements &Replaces,
1769 unsigned *Cursor) {
Daniel Jasperd89ae9d2015-09-23 08:30:47 +00001770 unsigned Prev = 0;
1771 unsigned SearchFrom = 0;
Krasimir Georgiev7e91b032018-10-05 17:19:26 +00001772 llvm::Regex IncludeRegex(CppIncludeRegexPattern);
Daniel Jasperd89ae9d2015-09-23 08:30:47 +00001773 SmallVector<StringRef, 4> Matches;
1774 SmallVector<IncludeDirective, 16> IncludesInBlock;
Daniel Jasper85c472d2015-09-29 07:53:08 +00001775
1776 // In compiled files, consider the first #include to be the main #include of
1777 // the file if it is not a system #include. This ensures that the header
1778 // doesn't have hidden dependencies
1779 // (http://llvm.org/docs/CodingStandards.html#include-style).
1780 //
1781 // FIXME: Do some sanity checking, e.g. edit distance of the base name, to fix
1782 // cases where the first #include is unlikely to be the main header.
Eric Liu7129e632018-05-14 20:17:53 +00001783 tooling::IncludeCategoryManager Categories(Style.IncludeStyle, FileName);
Daniel Jasper32d75fa2015-12-21 13:40:49 +00001784 bool FirstIncludeBlock = true;
Daniel Jaspera252f5d2015-12-21 17:28:24 +00001785 bool MainIncludeFound = false;
Daniel Jasper9b8c7c72015-11-21 09:17:08 +00001786 bool FormattingOff = false;
1787
Daniel Jasperd89ae9d2015-09-23 08:30:47 +00001788 for (;;) {
1789 auto Pos = Code.find('\n', SearchFrom);
1790 StringRef Line =
1791 Code.substr(Prev, (Pos != StringRef::npos ? Pos : Code.size()) - Prev);
Daniel Jasper9b8c7c72015-11-21 09:17:08 +00001792
1793 StringRef Trimmed = Line.trim();
1794 if (Trimmed == "// clang-format off")
1795 FormattingOff = true;
1796 else if (Trimmed == "// clang-format on")
1797 FormattingOff = false;
1798
Krasimir Georgiev4c2c9c32017-11-27 13:23:45 +00001799 const bool EmptyLineSkipped =
Eric Liu9d92c022018-05-14 19:51:33 +00001800 Trimmed.empty() &&
1801 (Style.IncludeStyle.IncludeBlocks == tooling::IncludeStyle::IBS_Merge ||
1802 Style.IncludeStyle.IncludeBlocks ==
1803 tooling::IncludeStyle::IBS_Regroup);
Krasimir Georgiev4c2c9c32017-11-27 13:23:45 +00001804
Daniel Jasper9b8c7c72015-11-21 09:17:08 +00001805 if (!FormattingOff && !Line.endswith("\\")) {
Daniel Jasperd89ae9d2015-09-23 08:30:47 +00001806 if (IncludeRegex.match(Line, &Matches)) {
Nico Weberff063702015-10-21 17:13:45 +00001807 StringRef IncludeName = Matches[2];
Eric Liu659afd52016-05-31 13:34:20 +00001808 int Category = Categories.getIncludePriority(
1809 IncludeName,
1810 /*CheckMainHeader=*/!MainIncludeFound && FirstIncludeBlock);
1811 if (Category == 0)
1812 MainIncludeFound = true;
Nico Weberff063702015-10-21 17:13:45 +00001813 IncludesInBlock.push_back({IncludeName, Line, Prev, Category});
Krasimir Georgiev4c2c9c32017-11-27 13:23:45 +00001814 } else if (!IncludesInBlock.empty() && !EmptyLineSkipped) {
Martin Probstc4a0dd42016-05-20 11:24:24 +00001815 sortCppIncludes(Style, IncludesInBlock, Ranges, FileName, Replaces,
1816 Cursor);
Daniel Jasperd89ae9d2015-09-23 08:30:47 +00001817 IncludesInBlock.clear();
Daniel Jasper32d75fa2015-12-21 13:40:49 +00001818 FirstIncludeBlock = false;
Daniel Jasperd89ae9d2015-09-23 08:30:47 +00001819 }
1820 Prev = Pos + 1;
1821 }
1822 if (Pos == StringRef::npos || Pos + 1 == Code.size())
1823 break;
1824 SearchFrom = Pos + 1;
1825 }
1826 if (!IncludesInBlock.empty())
Martin Probstc4a0dd42016-05-20 11:24:24 +00001827 sortCppIncludes(Style, IncludesInBlock, Ranges, FileName, Replaces, Cursor);
1828 return Replaces;
1829}
1830
Krasimir Georgiev7e91b032018-10-05 17:19:26 +00001831// Returns group number to use as a first order sort on imports. Gives UINT_MAX
1832// if the import does not match any given groups.
1833static unsigned findJavaImportGroup(const FormatStyle &Style,
1834 StringRef ImportIdentifier) {
1835 unsigned LongestMatchIndex = UINT_MAX;
1836 unsigned LongestMatchLength = 0;
1837 for (unsigned I = 0; I < Style.JavaImportGroups.size(); I++) {
1838 std::string GroupPrefix = Style.JavaImportGroups[I];
1839 if (ImportIdentifier.startswith(GroupPrefix) &&
1840 GroupPrefix.length() > LongestMatchLength) {
1841 LongestMatchIndex = I;
1842 LongestMatchLength = GroupPrefix.length();
1843 }
1844 }
1845 return LongestMatchIndex;
1846}
1847
1848// Sorts and deduplicates a block of includes given by 'Imports' based on
1849// JavaImportGroups, then adding the necessary replacement to 'Replaces'.
1850// Import declarations with the same text will be deduplicated. Between each
1851// import group, a newline is inserted, and within each import group, a
1852// lexicographic sort based on ASCII value is performed.
1853static void sortJavaImports(const FormatStyle &Style,
1854 const SmallVectorImpl<JavaImportDirective> &Imports,
1855 ArrayRef<tooling::Range> Ranges, StringRef FileName,
1856 tooling::Replacements &Replaces) {
1857 unsigned ImportsBeginOffset = Imports.front().Offset;
1858 unsigned ImportsEndOffset =
1859 Imports.back().Offset + Imports.back().Text.size();
1860 unsigned ImportsBlockSize = ImportsEndOffset - ImportsBeginOffset;
1861 if (!affectsRange(Ranges, ImportsBeginOffset, ImportsEndOffset))
1862 return;
1863 SmallVector<unsigned, 16> Indices;
1864 SmallVector<unsigned, 16> JavaImportGroups;
1865 for (unsigned i = 0, e = Imports.size(); i != e; ++i) {
1866 Indices.push_back(i);
1867 JavaImportGroups.push_back(
1868 findJavaImportGroup(Style, Imports[i].Identifier));
1869 }
Mandeep Singh Grangd36da8a2019-01-18 18:45:26 +00001870 llvm::sort(Indices, [&](unsigned LHSI, unsigned RHSI) {
Krasimir Georgiev7e91b032018-10-05 17:19:26 +00001871 // Negating IsStatic to push static imports above non-static imports.
1872 return std::make_tuple(!Imports[LHSI].IsStatic, JavaImportGroups[LHSI],
1873 Imports[LHSI].Identifier) <
1874 std::make_tuple(!Imports[RHSI].IsStatic, JavaImportGroups[RHSI],
1875 Imports[RHSI].Identifier);
1876 });
1877
1878 // Deduplicate imports.
1879 Indices.erase(std::unique(Indices.begin(), Indices.end(),
1880 [&](unsigned LHSI, unsigned RHSI) {
1881 return Imports[LHSI].Text == Imports[RHSI].Text;
1882 }),
1883 Indices.end());
1884
1885 bool CurrentIsStatic = Imports[Indices.front()].IsStatic;
1886 unsigned CurrentImportGroup = JavaImportGroups[Indices.front()];
1887
1888 std::string result;
1889 for (unsigned Index : Indices) {
1890 if (!result.empty()) {
1891 result += "\n";
1892 if (CurrentIsStatic != Imports[Index].IsStatic ||
1893 CurrentImportGroup != JavaImportGroups[Index])
1894 result += "\n";
1895 }
1896 for (StringRef CommentLine : Imports[Index].AssociatedCommentLines) {
1897 result += CommentLine;
1898 result += "\n";
1899 }
1900 result += Imports[Index].Text;
1901 CurrentIsStatic = Imports[Index].IsStatic;
1902 CurrentImportGroup = JavaImportGroups[Index];
1903 }
1904
1905 auto Err = Replaces.add(tooling::Replacement(FileName, Imports.front().Offset,
1906 ImportsBlockSize, result));
1907 // FIXME: better error handling. For now, just skip the replacement for the
1908 // release version.
1909 if (Err) {
1910 llvm::errs() << llvm::toString(std::move(Err)) << "\n";
1911 assert(false);
1912 }
1913}
1914
1915namespace {
1916
1917const char JavaImportRegexPattern[] =
1918 "^[\t ]*import[\t ]*(static[\t ]*)?([^\t ]*)[\t ]*;";
1919
1920} // anonymous namespace
1921
1922tooling::Replacements sortJavaImports(const FormatStyle &Style, StringRef Code,
1923 ArrayRef<tooling::Range> Ranges,
1924 StringRef FileName,
1925 tooling::Replacements &Replaces) {
1926 unsigned Prev = 0;
1927 unsigned SearchFrom = 0;
1928 llvm::Regex ImportRegex(JavaImportRegexPattern);
1929 SmallVector<StringRef, 4> Matches;
1930 SmallVector<JavaImportDirective, 16> ImportsInBlock;
1931 std::vector<StringRef> AssociatedCommentLines;
1932
1933 bool FormattingOff = false;
1934
1935 for (;;) {
1936 auto Pos = Code.find('\n', SearchFrom);
1937 StringRef Line =
1938 Code.substr(Prev, (Pos != StringRef::npos ? Pos : Code.size()) - Prev);
1939
1940 StringRef Trimmed = Line.trim();
1941 if (Trimmed == "// clang-format off")
1942 FormattingOff = true;
1943 else if (Trimmed == "// clang-format on")
1944 FormattingOff = false;
1945
1946 if (ImportRegex.match(Line, &Matches)) {
1947 if (FormattingOff) {
1948 // If at least one import line has formatting turned off, turn off
1949 // formatting entirely.
1950 return Replaces;
1951 }
1952 StringRef Static = Matches[1];
1953 StringRef Identifier = Matches[2];
1954 bool IsStatic = false;
1955 if (Static.contains("static")) {
1956 IsStatic = true;
1957 }
1958 ImportsInBlock.push_back({Identifier, Line, Prev, AssociatedCommentLines, IsStatic});
1959 AssociatedCommentLines.clear();
1960 } else if (Trimmed.size() > 0 && !ImportsInBlock.empty()) {
1961 // Associating comments within the imports with the nearest import below
1962 AssociatedCommentLines.push_back(Line);
1963 }
1964 Prev = Pos + 1;
1965 if (Pos == StringRef::npos || Pos + 1 == Code.size())
1966 break;
1967 SearchFrom = Pos + 1;
1968 }
1969 if (!ImportsInBlock.empty())
1970 sortJavaImports(Style, ImportsInBlock, Ranges, FileName, Replaces);
1971 return Replaces;
1972}
1973
Martin Probstfa37b182017-01-27 09:09:11 +00001974bool isMpegTS(StringRef Code) {
1975 // MPEG transport streams use the ".ts" file extension. clang-format should
1976 // not attempt to format those. MPEG TS' frame format starts with 0x47 every
1977 // 189 bytes - detect that and return.
1978 return Code.size() > 188 && Code[0] == 0x47 && Code[188] == 0x47;
1979}
1980
Manuel Klimek89628f62017-09-20 09:51:03 +00001981bool isLikelyXml(StringRef Code) { return Code.ltrim().startswith("<"); }
Krasimir Georgieva2e7d0d2017-08-29 13:51:38 +00001982
Martin Probstc4a0dd42016-05-20 11:24:24 +00001983tooling::Replacements sortIncludes(const FormatStyle &Style, StringRef Code,
1984 ArrayRef<tooling::Range> Ranges,
1985 StringRef FileName, unsigned *Cursor) {
1986 tooling::Replacements Replaces;
1987 if (!Style.SortIncludes)
1988 return Replaces;
Krasimir Georgiev86873032017-08-29 13:57:31 +00001989 if (isLikelyXml(Code))
1990 return Replaces;
1991 if (Style.Language == FormatStyle::LanguageKind::LK_JavaScript &&
1992 isMpegTS(Code))
Martin Probstfa37b182017-01-27 09:09:11 +00001993 return Replaces;
Martin Probstc4a0dd42016-05-20 11:24:24 +00001994 if (Style.Language == FormatStyle::LanguageKind::LK_JavaScript)
1995 return sortJavaScriptImports(Style, Code, Ranges, FileName);
Krasimir Georgiev7e91b032018-10-05 17:19:26 +00001996 if (Style.Language == FormatStyle::LanguageKind::LK_Java)
1997 return sortJavaImports(Style, Code, Ranges, FileName, Replaces);
Martin Probstc4a0dd42016-05-20 11:24:24 +00001998 sortCppIncludes(Style, Code, Ranges, FileName, Replaces, Cursor);
Daniel Jasperd89ae9d2015-09-23 08:30:47 +00001999 return Replaces;
2000}
2001
Eric Liu4cfb88a2016-04-25 15:09:22 +00002002template <typename T>
Eric Liu4f8d9942016-07-11 13:53:12 +00002003static llvm::Expected<tooling::Replacements>
Eric Liu4cfb88a2016-04-25 15:09:22 +00002004processReplacements(T ProcessFunc, StringRef Code,
2005 const tooling::Replacements &Replaces,
2006 const FormatStyle &Style) {
Manuel Klimekb12e5a52016-03-01 12:37:30 +00002007 if (Replaces.empty())
2008 return tooling::Replacements();
2009
Eric Liu4f8d9942016-07-11 13:53:12 +00002010 auto NewCode = applyAllReplacements(Code, Replaces);
2011 if (!NewCode)
2012 return NewCode.takeError();
Eric Liu40ef2fb2016-08-01 10:16:37 +00002013 std::vector<tooling::Range> ChangedRanges = Replaces.getAffectedRanges();
Manuel Klimekb12e5a52016-03-01 12:37:30 +00002014 StringRef FileName = Replaces.begin()->getFilePath();
Eric Liu4cfb88a2016-04-25 15:09:22 +00002015
Manuel Klimekb12e5a52016-03-01 12:37:30 +00002016 tooling::Replacements FormatReplaces =
Eric Liu4f8d9942016-07-11 13:53:12 +00002017 ProcessFunc(Style, *NewCode, ChangedRanges, FileName);
Manuel Klimekb12e5a52016-03-01 12:37:30 +00002018
Eric Liu40ef2fb2016-08-01 10:16:37 +00002019 return Replaces.merge(FormatReplaces);
Manuel Klimekb12e5a52016-03-01 12:37:30 +00002020}
2021
Eric Liu4f8d9942016-07-11 13:53:12 +00002022llvm::Expected<tooling::Replacements>
2023formatReplacements(StringRef Code, const tooling::Replacements &Replaces,
2024 const FormatStyle &Style) {
Eric Liu4cfb88a2016-04-25 15:09:22 +00002025 // We need to use lambda function here since there are two versions of
Eric Liubaf58c22016-05-18 13:43:48 +00002026 // `sortIncludes`.
2027 auto SortIncludes = [](const FormatStyle &Style, StringRef Code,
2028 std::vector<tooling::Range> Ranges,
2029 StringRef FileName) -> tooling::Replacements {
2030 return sortIncludes(Style, Code, Ranges, FileName);
2031 };
Eric Liu4f8d9942016-07-11 13:53:12 +00002032 auto SortedReplaces =
Eric Liubaf58c22016-05-18 13:43:48 +00002033 processReplacements(SortIncludes, Code, Replaces, Style);
Eric Liu4f8d9942016-07-11 13:53:12 +00002034 if (!SortedReplaces)
2035 return SortedReplaces.takeError();
Eric Liubaf58c22016-05-18 13:43:48 +00002036
2037 // We need to use lambda function here since there are two versions of
Eric Liu4cfb88a2016-04-25 15:09:22 +00002038 // `reformat`.
2039 auto Reformat = [](const FormatStyle &Style, StringRef Code,
2040 std::vector<tooling::Range> Ranges,
2041 StringRef FileName) -> tooling::Replacements {
2042 return reformat(Style, Code, Ranges, FileName);
2043 };
Eric Liu4f8d9942016-07-11 13:53:12 +00002044 return processReplacements(Reformat, Code, *SortedReplaces, Style);
Eric Liu4cfb88a2016-04-25 15:09:22 +00002045}
2046
Eric Liu659afd52016-05-31 13:34:20 +00002047namespace {
2048
2049inline bool isHeaderInsertion(const tooling::Replacement &Replace) {
Eric Liuc0d3a802016-09-23 15:10:56 +00002050 return Replace.getOffset() == UINT_MAX && Replace.getLength() == 0 &&
Krasimir Georgiev7e91b032018-10-05 17:19:26 +00002051 llvm::Regex(CppIncludeRegexPattern)
2052 .match(Replace.getReplacementText());
Eric Liu659afd52016-05-31 13:34:20 +00002053}
2054
Eric Liuc0d3a802016-09-23 15:10:56 +00002055inline bool isHeaderDeletion(const tooling::Replacement &Replace) {
2056 return Replace.getOffset() == UINT_MAX && Replace.getLength() == 1;
2057}
2058
Eric Liu659afd52016-05-31 13:34:20 +00002059// FIXME: insert empty lines between newly created blocks.
2060tooling::Replacements
2061fixCppIncludeInsertions(StringRef Code, const tooling::Replacements &Replaces,
2062 const FormatStyle &Style) {
Daniel Jasper1dbc2102017-03-31 13:30:24 +00002063 if (!Style.isCpp())
Eric Liu659afd52016-05-31 13:34:20 +00002064 return Replaces;
2065
2066 tooling::Replacements HeaderInsertions;
Eric Liuc0d3a802016-09-23 15:10:56 +00002067 std::set<llvm::StringRef> HeadersToDelete;
Eric Liu40ef2fb2016-08-01 10:16:37 +00002068 tooling::Replacements Result;
Eric Liu659afd52016-05-31 13:34:20 +00002069 for (const auto &R : Replaces) {
Eric Liu40ef2fb2016-08-01 10:16:37 +00002070 if (isHeaderInsertion(R)) {
2071 // Replacements from \p Replaces must be conflict-free already, so we can
2072 // simply consume the error.
2073 llvm::consumeError(HeaderInsertions.add(R));
Eric Liuc0d3a802016-09-23 15:10:56 +00002074 } else if (isHeaderDeletion(R)) {
2075 HeadersToDelete.insert(R.getReplacementText());
Eric Liu40ef2fb2016-08-01 10:16:37 +00002076 } else if (R.getOffset() == UINT_MAX) {
Eric Liu659afd52016-05-31 13:34:20 +00002077 llvm::errs() << "Insertions other than header #include insertion are "
2078 "not supported! "
2079 << R.getReplacementText() << "\n";
Eric Liu40ef2fb2016-08-01 10:16:37 +00002080 } else {
2081 llvm::consumeError(Result.add(R));
2082 }
Eric Liu659afd52016-05-31 13:34:20 +00002083 }
Eric Liuc0d3a802016-09-23 15:10:56 +00002084 if (HeaderInsertions.empty() && HeadersToDelete.empty())
Eric Liu659afd52016-05-31 13:34:20 +00002085 return Replaces;
Eric Liu659afd52016-05-31 13:34:20 +00002086
Eric Liu659afd52016-05-31 13:34:20 +00002087
2088 StringRef FileName = Replaces.begin()->getFilePath();
Eric Liu7129e632018-05-14 20:17:53 +00002089 tooling::HeaderIncludes Includes(FileName, Code, Style.IncludeStyle);
Eric Liu659afd52016-05-31 13:34:20 +00002090
Eric Liubf4c41c2018-05-04 17:55:13 +00002091 for (const auto &Header : HeadersToDelete) {
2092 tooling::Replacements Replaces =
Eric Liu7129e632018-05-14 20:17:53 +00002093 Includes.remove(Header.trim("\"<>"), Header.startswith("<"));
Eric Liubf4c41c2018-05-04 17:55:13 +00002094 for (const auto &R : Replaces) {
2095 auto Err = Result.add(R);
2096 if (Err) {
2097 // Ignore the deletion on conflict.
2098 llvm::errs() << "Failed to add header deletion replacement for "
2099 << Header << ": " << llvm::toString(std::move(Err))
2100 << "\n";
Eric Liuc0d3a802016-09-23 15:10:56 +00002101 }
Eric Liu659afd52016-05-31 13:34:20 +00002102 }
Eric Liu659afd52016-05-31 13:34:20 +00002103 }
2104
Krasimir Georgiev7e91b032018-10-05 17:19:26 +00002105 llvm::Regex IncludeRegex = llvm::Regex(CppIncludeRegexPattern);
Eric Liubf4c41c2018-05-04 17:55:13 +00002106 llvm::SmallVector<StringRef, 4> Matches;
Eric Liu659afd52016-05-31 13:34:20 +00002107 for (const auto &R : HeaderInsertions) {
2108 auto IncludeDirective = R.getReplacementText();
2109 bool Matched = IncludeRegex.match(IncludeDirective, &Matches);
2110 assert(Matched && "Header insertion replacement must have replacement text "
2111 "'#include ...'");
Benjamin Kramer1cb7ee12016-05-31 14:14:42 +00002112 (void)Matched;
Eric Liu659afd52016-05-31 13:34:20 +00002113 auto IncludeName = Matches[2];
Eric Liubf4c41c2018-05-04 17:55:13 +00002114 auto Replace =
Eric Liu7129e632018-05-14 20:17:53 +00002115 Includes.insert(IncludeName.trim("\"<>"), IncludeName.startswith("<"));
Eric Liubf4c41c2018-05-04 17:55:13 +00002116 if (Replace) {
2117 auto Err = Result.add(*Replace);
2118 if (Err) {
2119 llvm::consumeError(std::move(Err));
2120 unsigned NewOffset = Result.getShiftedCodePosition(Replace->getOffset());
2121 auto Shifted = tooling::Replacement(FileName, NewOffset, 0,
2122 Replace->getReplacementText());
2123 Result = Result.merge(tooling::Replacements(Shifted));
2124 }
Eric Liu40ef2fb2016-08-01 10:16:37 +00002125 }
Eric Liu659afd52016-05-31 13:34:20 +00002126 }
2127 return Result;
2128}
2129
2130} // anonymous namespace
2131
Eric Liu4f8d9942016-07-11 13:53:12 +00002132llvm::Expected<tooling::Replacements>
Eric Liu4cfb88a2016-04-25 15:09:22 +00002133cleanupAroundReplacements(StringRef Code, const tooling::Replacements &Replaces,
2134 const FormatStyle &Style) {
2135 // We need to use lambda function here since there are two versions of
2136 // `cleanup`.
2137 auto Cleanup = [](const FormatStyle &Style, StringRef Code,
2138 std::vector<tooling::Range> Ranges,
2139 StringRef FileName) -> tooling::Replacements {
2140 return cleanup(Style, Code, Ranges, FileName);
2141 };
Eric Liu659afd52016-05-31 13:34:20 +00002142 // Make header insertion replacements insert new headers into correct blocks.
2143 tooling::Replacements NewReplaces =
2144 fixCppIncludeInsertions(Code, Replaces, Style);
2145 return processReplacements(Cleanup, Code, NewReplaces, Style);
Eric Liu4cfb88a2016-04-25 15:09:22 +00002146}
2147
Krasimir Georgiev9ad83fe2017-10-30 14:01:50 +00002148namespace internal {
2149std::pair<tooling::Replacements, unsigned>
2150reformat(const FormatStyle &Style, StringRef Code,
2151 ArrayRef<tooling::Range> Ranges, unsigned FirstStartColumn,
2152 unsigned NextStartColumn, unsigned LastStartColumn, StringRef FileName,
2153 FormattingAttemptStatus *Status) {
Eric Liu4cfb88a2016-04-25 15:09:22 +00002154 FormatStyle Expanded = expandPresets(Style);
2155 if (Expanded.DisableFormat)
Krasimir Georgiev9ad83fe2017-10-30 14:01:50 +00002156 return {tooling::Replacements(), 0};
Krasimir Georgiev86873032017-08-29 13:57:31 +00002157 if (isLikelyXml(Code))
Krasimir Georgiev9ad83fe2017-10-30 14:01:50 +00002158 return {tooling::Replacements(), 0};
Krasimir Georgiev86873032017-08-29 13:57:31 +00002159 if (Expanded.Language == FormatStyle::LK_JavaScript && isMpegTS(Code))
Krasimir Georgiev9ad83fe2017-10-30 14:01:50 +00002160 return {tooling::Replacements(), 0};
Daniel Jasper496c1992016-09-07 22:48:53 +00002161
Krasimir Georgiev9ad83fe2017-10-30 14:01:50 +00002162 typedef std::function<std::pair<tooling::Replacements, unsigned>(
2163 const Environment &)>
Krasimir Georgievac16a202017-06-23 11:46:03 +00002164 AnalyzerPass;
2165 SmallVector<AnalyzerPass, 4> Passes;
Krasimir Georgiev32eaa862017-03-01 15:35:39 +00002166
Krasimir Georgievac16a202017-06-23 11:46:03 +00002167 if (Style.Language == FormatStyle::LK_Cpp) {
2168 if (Style.FixNamespaceComments)
2169 Passes.emplace_back([&](const Environment &Env) {
2170 return NamespaceEndCommentsFixer(Env, Expanded).process();
2171 });
2172
2173 if (Style.SortUsingDeclarations)
2174 Passes.emplace_back([&](const Environment &Env) {
2175 return UsingDeclarationsSorter(Env, Expanded).process();
2176 });
Krasimir Georgiev32eaa862017-03-01 15:35:39 +00002177 }
2178
2179 if (Style.Language == FormatStyle::LK_JavaScript &&
Krasimir Georgievac16a202017-06-23 11:46:03 +00002180 Style.JavaScriptQuotes != FormatStyle::JSQS_Leave)
2181 Passes.emplace_back([&](const Environment &Env) {
2182 return JavaScriptRequoter(Env, Expanded).process();
2183 });
2184
2185 Passes.emplace_back([&](const Environment &Env) {
2186 return Formatter(Env, Expanded, Status).process();
2187 });
2188
Eric Liu2e538082018-05-09 21:35:52 +00002189 auto Env =
2190 llvm::make_unique<Environment>(Code, FileName, Ranges, FirstStartColumn,
2191 NextStartColumn, LastStartColumn);
Krasimir Georgievac16a202017-06-23 11:46:03 +00002192 llvm::Optional<std::string> CurrentCode = None;
2193 tooling::Replacements Fixes;
Krasimir Georgiev9ad83fe2017-10-30 14:01:50 +00002194 unsigned Penalty = 0;
Krasimir Georgievac16a202017-06-23 11:46:03 +00002195 for (size_t I = 0, E = Passes.size(); I < E; ++I) {
Krasimir Georgiev9ad83fe2017-10-30 14:01:50 +00002196 std::pair<tooling::Replacements, unsigned> PassFixes = Passes[I](*Env);
Krasimir Georgievac16a202017-06-23 11:46:03 +00002197 auto NewCode = applyAllReplacements(
Krasimir Georgiev9ad83fe2017-10-30 14:01:50 +00002198 CurrentCode ? StringRef(*CurrentCode) : Code, PassFixes.first);
Krasimir Georgievac16a202017-06-23 11:46:03 +00002199 if (NewCode) {
Krasimir Georgiev9ad83fe2017-10-30 14:01:50 +00002200 Fixes = Fixes.merge(PassFixes.first);
2201 Penalty += PassFixes.second;
Krasimir Georgievac16a202017-06-23 11:46:03 +00002202 if (I + 1 < E) {
2203 CurrentCode = std::move(*NewCode);
Eric Liu2e538082018-05-09 21:35:52 +00002204 Env = llvm::make_unique<Environment>(
Krasimir Georgievac16a202017-06-23 11:46:03 +00002205 *CurrentCode, FileName,
Krasimir Georgiev9ad83fe2017-10-30 14:01:50 +00002206 tooling::calculateRangesAfterReplacements(Fixes, Ranges),
2207 FirstStartColumn, NextStartColumn, LastStartColumn);
Krasimir Georgievac16a202017-06-23 11:46:03 +00002208 }
2209 }
Daniel Jasper496c1992016-09-07 22:48:53 +00002210 }
2211
Krasimir Georgiev9ad83fe2017-10-30 14:01:50 +00002212 return {Fixes, Penalty};
2213}
2214} // namespace internal
2215
2216tooling::Replacements reformat(const FormatStyle &Style, StringRef Code,
2217 ArrayRef<tooling::Range> Ranges,
2218 StringRef FileName,
2219 FormattingAttemptStatus *Status) {
2220 return internal::reformat(Style, Code, Ranges,
2221 /*FirstStartColumn=*/0,
2222 /*NextStartColumn=*/0,
2223 /*LastStartColumn=*/0, FileName, Status)
2224 .first;
Eric Liu4cfb88a2016-04-25 15:09:22 +00002225}
2226
Eric Liu4cfb88a2016-04-25 15:09:22 +00002227tooling::Replacements cleanup(const FormatStyle &Style, StringRef Code,
2228 ArrayRef<tooling::Range> Ranges,
2229 StringRef FileName) {
Martin Probst816a9662017-05-29 08:41:11 +00002230 // cleanups only apply to C++ (they mostly concern ctor commas etc.)
2231 if (Style.Language != FormatStyle::LK_Cpp)
2232 return tooling::Replacements();
Eric Liu2e538082018-05-09 21:35:52 +00002233 return Cleaner(Environment(Code, FileName, Ranges), Style).process().first;
Daniel Jasperec04c0d2013-05-16 10:40:07 +00002234}
2235
Krasimir Georgievbcda54b2017-04-21 14:35:20 +00002236tooling::Replacements reformat(const FormatStyle &Style, StringRef Code,
2237 ArrayRef<tooling::Range> Ranges,
2238 StringRef FileName, bool *IncompleteFormat) {
2239 FormattingAttemptStatus Status;
2240 auto Result = reformat(Style, Code, Ranges, FileName, &Status);
2241 if (!Status.FormatComplete)
2242 *IncompleteFormat = true;
2243 return Result;
2244}
2245
Krasimir Georgiev7cb267a2017-02-27 13:28:36 +00002246tooling::Replacements fixNamespaceEndComments(const FormatStyle &Style,
2247 StringRef Code,
2248 ArrayRef<tooling::Range> Ranges,
2249 StringRef FileName) {
Eric Liu2e538082018-05-09 21:35:52 +00002250 return NamespaceEndCommentsFixer(Environment(Code, FileName, Ranges), Style)
2251 .process()
2252 .first;
Krasimir Georgiev7cb267a2017-02-27 13:28:36 +00002253}
2254
Krasimir Georgievb03877a2017-06-21 12:03:12 +00002255tooling::Replacements sortUsingDeclarations(const FormatStyle &Style,
2256 StringRef Code,
2257 ArrayRef<tooling::Range> Ranges,
2258 StringRef FileName) {
Eric Liu2e538082018-05-09 21:35:52 +00002259 return UsingDeclarationsSorter(Environment(Code, FileName, Ranges), Style)
2260 .process()
2261 .first;
Krasimir Georgievb03877a2017-06-21 12:03:12 +00002262}
2263
Daniel Jasper4db69bd2014-09-04 18:23:42 +00002264LangOptions getFormattingLangOpts(const FormatStyle &Style) {
Daniel Jasperc1fa2812013-01-10 13:08:12 +00002265 LangOptions LangOpts;
2266 LangOpts.CPlusPlus = 1;
Daniel Jasper4db69bd2014-09-04 18:23:42 +00002267 LangOpts.CPlusPlus11 = Style.Standard == FormatStyle::LS_Cpp03 ? 0 : 1;
2268 LangOpts.CPlusPlus14 = Style.Standard == FormatStyle::LS_Cpp03 ? 0 : 1;
Aaron Ballmanc351fba2017-12-04 20:27:34 +00002269 LangOpts.CPlusPlus17 = Style.Standard == FormatStyle::LS_Cpp03 ? 0 : 1;
Richard Smithc70f1d62017-12-14 15:16:18 +00002270 LangOpts.CPlusPlus2a = Style.Standard == FormatStyle::LS_Cpp03 ? 0 : 1;
Daniel Jasper55213652013-03-22 10:01:29 +00002271 LangOpts.LineComment = 1;
Daniel Jasper1dbc2102017-03-31 13:30:24 +00002272 bool AlternativeOperators = Style.isCpp();
Daniel Jasper30a24062014-11-14 09:02:28 +00002273 LangOpts.CXXOperatorNames = AlternativeOperators ? 1 : 0;
Daniel Jasperc1fa2812013-01-10 13:08:12 +00002274 LangOpts.Bool = 1;
Erik Pilkingtonfa983902018-10-30 20:31:30 +00002275 LangOpts.ObjC = 1;
Eric Liu4cfb88a2016-04-25 15:09:22 +00002276 LangOpts.MicrosoftExt = 1; // To get kw___try, kw___finally.
Saleem Abdulrasoold170c4b2015-10-04 17:51:05 +00002277 LangOpts.DeclSpecKeyword = 1; // To get __declspec.
Daniel Jasperc1fa2812013-01-10 13:08:12 +00002278 return LangOpts;
2279}
2280
Edwin Vaned544aa72013-09-30 13:31:48 +00002281const char *StyleOptionHelpDescription =
2282 "Coding style, currently supports:\n"
2283 " LLVM, Google, Chromium, Mozilla, WebKit.\n"
2284 "Use -style=file to load style configuration from\n"
2285 ".clang-format file located in one of the parent\n"
2286 "directories of the source file (or current\n"
2287 "directory for stdin).\n"
2288 "Use -style=\"{key: value, ...}\" to set specific\n"
2289 "parameters, e.g.:\n"
2290 " -style=\"{BasedOnStyle: llvm, IndentWidth: 8}\"";
2291
Alexander Kornienkoc1637f12013-12-10 11:28:13 +00002292static FormatStyle::LanguageKind getLanguageByFileName(StringRef FileName) {
Daniel Jasper498f5582015-12-25 08:53:31 +00002293 if (FileName.endswith(".java"))
Daniel Jasperc58c70e2014-09-15 11:21:46 +00002294 return FormatStyle::LK_Java;
Daniel Jasper498f5582015-12-25 08:53:31 +00002295 if (FileName.endswith_lower(".js") || FileName.endswith_lower(".ts"))
2296 return FormatStyle::LK_JavaScript; // JavaScript or TypeScript.
Daniel Jasper03a04fe2016-12-12 12:42:29 +00002297 if (FileName.endswith(".m") || FileName.endswith(".mm"))
2298 return FormatStyle::LK_ObjC;
Daniel Jasper498f5582015-12-25 08:53:31 +00002299 if (FileName.endswith_lower(".proto") ||
2300 FileName.endswith_lower(".protodevel"))
Daniel Jasper7052ce62014-01-19 09:04:08 +00002301 return FormatStyle::LK_Proto;
Krasimir Georgiev66496652017-11-17 15:10:49 +00002302 if (FileName.endswith_lower(".textpb") ||
2303 FileName.endswith_lower(".pb.txt") ||
2304 FileName.endswith_lower(".textproto") ||
2305 FileName.endswith_lower(".asciipb"))
2306 return FormatStyle::LK_TextProto;
Daniel Jasper498f5582015-12-25 08:53:31 +00002307 if (FileName.endswith_lower(".td"))
2308 return FormatStyle::LK_TableGen;
Alexander Kornienkoc1637f12013-12-10 11:28:13 +00002309 return FormatStyle::LK_Cpp;
Alexander Kornienkocabdd732013-11-29 15:19:43 +00002310}
2311
Ben Hamilton3b345c32018-02-21 15:54:31 +00002312FormatStyle::LanguageKind guessLanguage(StringRef FileName, StringRef Code) {
Ben Hamilton6e066352018-02-27 15:56:40 +00002313 const auto GuessedLanguage = getLanguageByFileName(FileName);
2314 if (GuessedLanguage == FormatStyle::LK_Cpp) {
Ben Hamilton07e58362018-02-21 21:27:27 +00002315 auto Extension = llvm::sys::path::extension(FileName);
Ben Hamilton3b345c32018-02-21 15:54:31 +00002316 // If there's no file extension (or it's .h), we need to check the contents
2317 // of the code to see if it contains Objective-C.
Ben Hamilton07e58362018-02-21 21:27:27 +00002318 if (Extension.empty() || Extension == ".h") {
2319 auto NonEmptyFileName = FileName.empty() ? "guess.h" : FileName;
Eric Liu2e538082018-05-09 21:35:52 +00002320 Environment Env(Code, NonEmptyFileName, /*Ranges=*/{});
2321 ObjCHeaderStyleGuesser Guesser(Env, getLLVMStyle());
Ben Hamilton3b345c32018-02-21 15:54:31 +00002322 Guesser.process();
Ben Hamilton6e066352018-02-27 15:56:40 +00002323 if (Guesser.isObjC())
2324 return FormatStyle::LK_ObjC;
Ben Hamilton3b345c32018-02-21 15:54:31 +00002325 }
2326 }
Ben Hamilton6e066352018-02-27 15:56:40 +00002327 return GuessedLanguage;
Ben Hamilton3b345c32018-02-21 15:54:31 +00002328}
2329
Eric Liub4adc912018-06-25 16:29:19 +00002330const char *DefaultFormatStyle = "file";
2331
2332const char *DefaultFallbackStyle = "LLVM";
2333
Antonio Maiorano3adfb6a2017-01-17 00:12:27 +00002334llvm::Expected<FormatStyle> getStyle(StringRef StyleName, StringRef FileName,
Antonio Maiorano7eb75072017-01-20 01:22:42 +00002335 StringRef FallbackStyleName,
Jonas Devliegherefc514902018-10-10 13:27:25 +00002336 StringRef Code,
2337 llvm::vfs::FileSystem *FS) {
Eric Liu547d8792016-03-24 13:22:42 +00002338 if (!FS) {
Jonas Devliegherefc514902018-10-10 13:27:25 +00002339 FS = llvm::vfs::getRealFileSystem().get();
Eric Liu547d8792016-03-24 13:22:42 +00002340 }
Alexander Kornienkoc1637f12013-12-10 11:28:13 +00002341 FormatStyle Style = getLLVMStyle();
Ben Hamilton3b345c32018-02-21 15:54:31 +00002342 Style.Language = guessLanguage(FileName, Code);
Daniel Jasper03a04fe2016-12-12 12:42:29 +00002343
Antonio Maiorano7eb75072017-01-20 01:22:42 +00002344 FormatStyle FallbackStyle = getNoStyle();
2345 if (!getPredefinedStyle(FallbackStyleName, Style.Language, &FallbackStyle))
2346 return make_string_error("Invalid fallback style \"" + FallbackStyleName);
Edwin Vaned544aa72013-09-30 13:31:48 +00002347
2348 if (StyleName.startswith("{")) {
2349 // Parse YAML/JSON style from the command line.
Antonio Maiorano3adfb6a2017-01-17 00:12:27 +00002350 if (std::error_code ec = parseConfiguration(StyleName, &Style))
2351 return make_string_error("Error parsing -style: " + ec.message());
Edwin Vaned544aa72013-09-30 13:31:48 +00002352 return Style;
2353 }
2354
2355 if (!StyleName.equals_lower("file")) {
Alexander Kornienkoc1637f12013-12-10 11:28:13 +00002356 if (!getPredefinedStyle(StyleName, Style.Language, &Style))
Antonio Maiorano3adfb6a2017-01-17 00:12:27 +00002357 return make_string_error("Invalid value for -style");
Edwin Vaned544aa72013-09-30 13:31:48 +00002358 return Style;
2359 }
2360
Alexander Kornienkoc1637f12013-12-10 11:28:13 +00002361 // Look for .clang-format/_clang-format file in the file's parent directories.
Alexander Kornienkocabdd732013-11-29 15:19:43 +00002362 SmallString<128> UnsuitableConfigFiles;
Edwin Vaned544aa72013-09-30 13:31:48 +00002363 SmallString<128> Path(FileName);
Antonio Maiorano3adfb6a2017-01-17 00:12:27 +00002364 if (std::error_code EC = FS->makeAbsolute(Path))
2365 return make_string_error(EC.message());
Antonio Maiorano34c03762016-12-22 05:10:07 +00002366
Alexander Kornienkoe2e03872013-10-14 00:46:35 +00002367 for (StringRef Directory = Path; !Directory.empty();
Edwin Vaned544aa72013-09-30 13:31:48 +00002368 Directory = llvm::sys::path::parent_path(Directory)) {
Eric Liu547d8792016-03-24 13:22:42 +00002369
2370 auto Status = FS->status(Directory);
2371 if (!Status ||
2372 Status->getType() != llvm::sys::fs::file_type::directory_file) {
Edwin Vaned544aa72013-09-30 13:31:48 +00002373 continue;
Eric Liu547d8792016-03-24 13:22:42 +00002374 }
2375
Edwin Vaned544aa72013-09-30 13:31:48 +00002376 SmallString<128> ConfigFile(Directory);
2377
2378 llvm::sys::path::append(ConfigFile, ".clang-format");
Nicola Zaghen3538b392018-05-15 13:30:56 +00002379 LLVM_DEBUG(llvm::dbgs() << "Trying " << ConfigFile << "...\n");
Eric Liud4758322016-03-24 13:22:37 +00002380
Eric Liu547d8792016-03-24 13:22:42 +00002381 Status = FS->status(ConfigFile.str());
Antonio Maiorano3adfb6a2017-01-17 00:12:27 +00002382 bool FoundConfigFile =
Eric Liu547d8792016-03-24 13:22:42 +00002383 Status && (Status->getType() == llvm::sys::fs::file_type::regular_file);
Antonio Maiorano3adfb6a2017-01-17 00:12:27 +00002384 if (!FoundConfigFile) {
Edwin Vaned544aa72013-09-30 13:31:48 +00002385 // Try _clang-format too, since dotfiles are not commonly used on Windows.
2386 ConfigFile = Directory;
2387 llvm::sys::path::append(ConfigFile, "_clang-format");
Nicola Zaghen3538b392018-05-15 13:30:56 +00002388 LLVM_DEBUG(llvm::dbgs() << "Trying " << ConfigFile << "...\n");
Eric Liu547d8792016-03-24 13:22:42 +00002389 Status = FS->status(ConfigFile.str());
Antonio Maiorano3adfb6a2017-01-17 00:12:27 +00002390 FoundConfigFile = Status && (Status->getType() ==
2391 llvm::sys::fs::file_type::regular_file);
Edwin Vaned544aa72013-09-30 13:31:48 +00002392 }
2393
Antonio Maiorano3adfb6a2017-01-17 00:12:27 +00002394 if (FoundConfigFile) {
Rafael Espindola2d2b4202014-07-06 17:43:24 +00002395 llvm::ErrorOr<std::unique_ptr<llvm::MemoryBuffer>> Text =
Eric Liu547d8792016-03-24 13:22:42 +00002396 FS->getBufferForFile(ConfigFile.str());
Antonio Maiorano3adfb6a2017-01-17 00:12:27 +00002397 if (std::error_code EC = Text.getError())
2398 return make_string_error(EC.message());
Rafael Espindola2d2b4202014-07-06 17:43:24 +00002399 if (std::error_code ec =
2400 parseConfiguration(Text.get()->getBuffer(), &Style)) {
Rafael Espindolad0136702014-06-12 02:50:04 +00002401 if (ec == ParseError::Unsuitable) {
Alexander Kornienkocabdd732013-11-29 15:19:43 +00002402 if (!UnsuitableConfigFiles.empty())
2403 UnsuitableConfigFiles.append(", ");
2404 UnsuitableConfigFiles.append(ConfigFile);
Alexander Kornienkobc4ae442013-12-02 15:21:38 +00002405 continue;
Alexander Kornienkocabdd732013-11-29 15:19:43 +00002406 }
Antonio Maiorano3adfb6a2017-01-17 00:12:27 +00002407 return make_string_error("Error reading " + ConfigFile + ": " +
2408 ec.message());
Edwin Vaned544aa72013-09-30 13:31:48 +00002409 }
Nicola Zaghen3538b392018-05-15 13:30:56 +00002410 LLVM_DEBUG(llvm::dbgs()
2411 << "Using configuration file " << ConfigFile << "\n");
Edwin Vaned544aa72013-09-30 13:31:48 +00002412 return Style;
2413 }
2414 }
Antonio Maiorano3adfb6a2017-01-17 00:12:27 +00002415 if (!UnsuitableConfigFiles.empty())
2416 return make_string_error("Configuration file(s) do(es) not support " +
2417 getLanguageName(Style.Language) + ": " +
2418 UnsuitableConfigFiles);
Antonio Maiorano7eb75072017-01-20 01:22:42 +00002419 return FallbackStyle;
Edwin Vaned544aa72013-09-30 13:31:48 +00002420}
2421
Daniel Jasper8d1832e2013-01-07 13:26:07 +00002422} // namespace format
2423} // namespace clang