blob: 2c4f8760540a4b88d74b23ae142ce9773a484c7e [file] [log] [blame]
Daniel Jasperf7935112012-12-03 18:12:45 +00001//===--- Format.cpp - Format C++ code -------------------------------------===//
2//
3// The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
9///
10/// \file
Adrian Prantl9fc8faf2018-05-09 01:00:01 +000011/// This file implements functions declared in Format.h. This will be
Daniel Jasperf7935112012-12-03 18:12:45 +000012/// split into separate files as we go.
13///
Daniel Jasperf7935112012-12-03 18:12:45 +000014//===----------------------------------------------------------------------===//
15
Daniel Jasper85c472d2015-09-29 07:53:08 +000016#include "clang/Format/Format.h"
Eric Liu4cfb88a2016-04-25 15:09:22 +000017#include "AffectedRangeManager.h"
Daniel Jasperde0328a2013-08-16 11:20:30 +000018#include "ContinuationIndenter.h"
Krasimir Georgiev9ad83fe2017-10-30 14:01:50 +000019#include "FormatInternal.h"
Martin Probstc4a0dd42016-05-20 11:24:24 +000020#include "FormatTokenLexer.h"
Krasimir Georgiev7cb267a2017-02-27 13:28:36 +000021#include "NamespaceEndCommentsFixer.h"
Martin Probstc4a0dd42016-05-20 11:24:24 +000022#include "SortJavaScriptImports.h"
23#include "TokenAnalyzer.h"
Daniel Jasper7a6d09b2013-01-29 21:01:14 +000024#include "TokenAnnotator.h"
Daniel Jasper0df50932014-12-10 19:00:42 +000025#include "UnwrappedLineFormatter.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000026#include "UnwrappedLineParser.h"
Krasimir Georgievb03877a2017-06-21 12:03:12 +000027#include "UsingDeclarationsSorter.h"
Alexander Kornienkocb45bc12013-04-15 14:28:00 +000028#include "WhitespaceManager.h"
Daniel Jasperec04c0d2013-05-16 10:40:07 +000029#include "clang/Basic/Diagnostic.h"
Benjamin Kramerf3ca26982014-05-10 16:31:55 +000030#include "clang/Basic/DiagnosticOptions.h"
Chandler Carruth44eb4f62013-01-02 10:28:36 +000031#include "clang/Basic/SourceManager.h"
Daniel Jasperf7935112012-12-03 18:12:45 +000032#include "clang/Lex/Lexer.h"
Eric Liu44564ac2018-06-04 09:04:12 +000033#include "clang/Tooling/Inclusions/HeaderIncludes.h"
Alexander Kornienkoffd6d042013-03-27 11:52:18 +000034#include "llvm/ADT/STLExtras.h"
Ben Hamiltone2e3e672018-01-17 17:33:08 +000035#include "llvm/ADT/StringRef.h"
Manuel Klimek2ef908e2013-02-13 10:46:36 +000036#include "llvm/Support/Allocator.h"
Manuel Klimek24998102013-01-16 14:55:28 +000037#include "llvm/Support/Debug.h"
Edwin Vaned544aa72013-09-30 13:31:48 +000038#include "llvm/Support/Path.h"
Birunthan Mohanathasb001a0b2015-07-03 17:25:16 +000039#include "llvm/Support/Regex.h"
Jonas Devliegherefc514902018-10-10 13:27:25 +000040#include "llvm/Support/VirtualFileSystem.h"
Chandler Carruth5553d0d2014-01-07 11:51:46 +000041#include "llvm/Support/YAMLTraits.h"
Martin Probst081f1762016-06-01 15:19:53 +000042#include <algorithm>
Eric Liu4cfb88a2016-04-25 15:09:22 +000043#include <memory>
Eric Liubf4c41c2018-05-04 17:55:13 +000044#include <mutex>
Daniel Jasper8b529712012-12-04 13:02:32 +000045#include <string>
Eric Liubf4c41c2018-05-04 17:55:13 +000046#include <unordered_map>
Daniel Jasper8b529712012-12-04 13:02:32 +000047
Chandler Carruth10346662014-04-22 03:17:02 +000048#define DEBUG_TYPE "format-formatter"
49
Alexander Kornienko6d2c88e2013-12-10 10:30:34 +000050using clang::format::FormatStyle;
51
NAKAMURA Takumi057a9422017-11-01 04:43:22 +000052LLVM_YAML_IS_SEQUENCE_VECTOR(clang::format::FormatStyle::RawStringFormat)
Daniel Jaspere1e43192014-04-01 12:55:11 +000053
Alexander Kornienkod6538332013-05-07 15:32:14 +000054namespace llvm {
55namespace yaml {
Alexander Kornienko6d2c88e2013-12-10 10:30:34 +000056template <> struct ScalarEnumerationTraits<FormatStyle::LanguageKind> {
57 static void enumeration(IO &IO, FormatStyle::LanguageKind &Value) {
58 IO.enumCase(Value, "Cpp", FormatStyle::LK_Cpp);
Daniel Jasperc58c70e2014-09-15 11:21:46 +000059 IO.enumCase(Value, "Java", FormatStyle::LK_Java);
Alexander Kornienko6d2c88e2013-12-10 10:30:34 +000060 IO.enumCase(Value, "JavaScript", FormatStyle::LK_JavaScript);
Daniel Jasper03a04fe2016-12-12 12:42:29 +000061 IO.enumCase(Value, "ObjC", FormatStyle::LK_ObjC);
Daniel Jasper7052ce62014-01-19 09:04:08 +000062 IO.enumCase(Value, "Proto", FormatStyle::LK_Proto);
Daniel Jasper498f5582015-12-25 08:53:31 +000063 IO.enumCase(Value, "TableGen", FormatStyle::LK_TableGen);
Krasimir Georgiev26b144c2017-07-03 15:05:14 +000064 IO.enumCase(Value, "TextProto", FormatStyle::LK_TextProto);
Alexander Kornienko6d2c88e2013-12-10 10:30:34 +000065 }
66};
67
68template <> struct ScalarEnumerationTraits<FormatStyle::LanguageStandard> {
69 static void enumeration(IO &IO, FormatStyle::LanguageStandard &Value) {
70 IO.enumCase(Value, "Cpp03", FormatStyle::LS_Cpp03);
71 IO.enumCase(Value, "C++03", FormatStyle::LS_Cpp03);
72 IO.enumCase(Value, "Cpp11", FormatStyle::LS_Cpp11);
73 IO.enumCase(Value, "C++11", FormatStyle::LS_Cpp11);
74 IO.enumCase(Value, "Auto", FormatStyle::LS_Auto);
75 }
76};
77
78template <> struct ScalarEnumerationTraits<FormatStyle::UseTabStyle> {
79 static void enumeration(IO &IO, FormatStyle::UseTabStyle &Value) {
80 IO.enumCase(Value, "Never", FormatStyle::UT_Never);
81 IO.enumCase(Value, "false", FormatStyle::UT_Never);
82 IO.enumCase(Value, "Always", FormatStyle::UT_Always);
83 IO.enumCase(Value, "true", FormatStyle::UT_Always);
84 IO.enumCase(Value, "ForIndentation", FormatStyle::UT_ForIndentation);
Marianne Mailhot-Sarrasin51fe2792016-04-14 14:52:26 +000085 IO.enumCase(Value, "ForContinuationAndIndentation",
86 FormatStyle::UT_ForContinuationAndIndentation);
Alexander Kornienko6d2c88e2013-12-10 10:30:34 +000087 }
88};
89
Daniel Jasperabd1f572016-03-02 22:44:03 +000090template <> struct ScalarEnumerationTraits<FormatStyle::JavaScriptQuoteStyle> {
91 static void enumeration(IO &IO, FormatStyle::JavaScriptQuoteStyle &Value) {
92 IO.enumCase(Value, "Leave", FormatStyle::JSQS_Leave);
93 IO.enumCase(Value, "Single", FormatStyle::JSQS_Single);
94 IO.enumCase(Value, "Double", FormatStyle::JSQS_Double);
95 }
96};
97
Daniel Jasperd74cf402014-04-08 12:46:38 +000098template <> struct ScalarEnumerationTraits<FormatStyle::ShortFunctionStyle> {
99 static void enumeration(IO &IO, FormatStyle::ShortFunctionStyle &Value) {
100 IO.enumCase(Value, "None", FormatStyle::SFS_None);
101 IO.enumCase(Value, "false", FormatStyle::SFS_None);
102 IO.enumCase(Value, "All", FormatStyle::SFS_All);
103 IO.enumCase(Value, "true", FormatStyle::SFS_All);
104 IO.enumCase(Value, "Inline", FormatStyle::SFS_Inline);
Francois Ferrandd3f0e3d2017-06-21 13:56:02 +0000105 IO.enumCase(Value, "InlineOnly", FormatStyle::SFS_InlineOnly);
Daniel Jasper9e709352014-11-26 10:43:58 +0000106 IO.enumCase(Value, "Empty", FormatStyle::SFS_Empty);
Daniel Jasperd74cf402014-04-08 12:46:38 +0000107 }
108};
109
Ben Hamilton4dc658c2018-02-02 20:15:14 +0000110template <> struct ScalarEnumerationTraits<FormatStyle::BinPackStyle> {
111 static void enumeration(IO &IO, FormatStyle::BinPackStyle &Value) {
112 IO.enumCase(Value, "Auto", FormatStyle::BPS_Auto);
113 IO.enumCase(Value, "Always", FormatStyle::BPS_Always);
114 IO.enumCase(Value, "Never", FormatStyle::BPS_Never);
115 }
116};
117
Daniel Jasperac043c92014-09-15 11:11:00 +0000118template <> struct ScalarEnumerationTraits<FormatStyle::BinaryOperatorStyle> {
119 static void enumeration(IO &IO, FormatStyle::BinaryOperatorStyle &Value) {
120 IO.enumCase(Value, "All", FormatStyle::BOS_All);
121 IO.enumCase(Value, "true", FormatStyle::BOS_All);
122 IO.enumCase(Value, "None", FormatStyle::BOS_None);
123 IO.enumCase(Value, "false", FormatStyle::BOS_None);
124 IO.enumCase(Value, "NonAssignment", FormatStyle::BOS_NonAssignment);
125 }
126};
127
Alexander Kornienko6d2c88e2013-12-10 10:30:34 +0000128template <> struct ScalarEnumerationTraits<FormatStyle::BraceBreakingStyle> {
129 static void enumeration(IO &IO, FormatStyle::BraceBreakingStyle &Value) {
130 IO.enumCase(Value, "Attach", FormatStyle::BS_Attach);
131 IO.enumCase(Value, "Linux", FormatStyle::BS_Linux);
Birunthan Mohanathas305fa9c2015-07-12 03:13:54 +0000132 IO.enumCase(Value, "Mozilla", FormatStyle::BS_Mozilla);
Alexander Kornienko6d2c88e2013-12-10 10:30:34 +0000133 IO.enumCase(Value, "Stroustrup", FormatStyle::BS_Stroustrup);
134 IO.enumCase(Value, "Allman", FormatStyle::BS_Allman);
Alexander Kornienko3a33f022013-12-12 09:49:52 +0000135 IO.enumCase(Value, "GNU", FormatStyle::BS_GNU);
Roman Kashitsyn291f64f2015-08-10 13:43:19 +0000136 IO.enumCase(Value, "WebKit", FormatStyle::BS_WebKit);
Daniel Jasperc1bc38e2015-09-29 14:57:55 +0000137 IO.enumCase(Value, "Custom", FormatStyle::BS_Custom);
Alexander Kornienko6d2c88e2013-12-10 10:30:34 +0000138 }
139};
140
Manuel Klimek89628f62017-09-20 09:51:03 +0000141template <>
142struct ScalarEnumerationTraits<FormatStyle::BreakConstructorInitializersStyle> {
143 static void
144 enumeration(IO &IO, FormatStyle::BreakConstructorInitializersStyle &Value) {
Francois Ferranda6b6d512017-05-24 11:36:58 +0000145 IO.enumCase(Value, "BeforeColon", FormatStyle::BCIS_BeforeColon);
146 IO.enumCase(Value, "BeforeComma", FormatStyle::BCIS_BeforeComma);
147 IO.enumCase(Value, "AfterColon", FormatStyle::BCIS_AfterColon);
148 }
149};
150
Daniel Jasperc1bc38e2015-09-29 14:57:55 +0000151template <>
Francois Ferrand6bb103f2018-06-11 14:41:26 +0000152struct ScalarEnumerationTraits<FormatStyle::BreakInheritanceListStyle> {
153 static void
154 enumeration(IO &IO, FormatStyle::BreakInheritanceListStyle &Value) {
155 IO.enumCase(Value, "BeforeColon", FormatStyle::BILS_BeforeColon);
156 IO.enumCase(Value, "BeforeComma", FormatStyle::BILS_BeforeComma);
157 IO.enumCase(Value, "AfterColon", FormatStyle::BILS_AfterColon);
158 }
159};
160
161template <>
Krasimir Georgievad47c902017-08-30 14:34:57 +0000162struct ScalarEnumerationTraits<FormatStyle::PPDirectiveIndentStyle> {
163 static void enumeration(IO &IO, FormatStyle::PPDirectiveIndentStyle &Value) {
164 IO.enumCase(Value, "None", FormatStyle::PPDIS_None);
165 IO.enumCase(Value, "AfterHash", FormatStyle::PPDIS_AfterHash);
166 }
167};
168
169template <>
Zachary Turner448592e2015-12-18 22:20:15 +0000170struct ScalarEnumerationTraits<FormatStyle::ReturnTypeBreakingStyle> {
171 static void enumeration(IO &IO, FormatStyle::ReturnTypeBreakingStyle &Value) {
172 IO.enumCase(Value, "None", FormatStyle::RTBS_None);
173 IO.enumCase(Value, "All", FormatStyle::RTBS_All);
174 IO.enumCase(Value, "TopLevel", FormatStyle::RTBS_TopLevel);
175 IO.enumCase(Value, "TopLevelDefinitions",
176 FormatStyle::RTBS_TopLevelDefinitions);
177 IO.enumCase(Value, "AllDefinitions", FormatStyle::RTBS_AllDefinitions);
178 }
179};
180
181template <>
Francois Ferrand58e6fe52018-05-16 08:25:03 +0000182struct ScalarEnumerationTraits<FormatStyle::BreakTemplateDeclarationsStyle> {
183 static void enumeration(IO &IO, FormatStyle::BreakTemplateDeclarationsStyle &Value) {
184 IO.enumCase(Value, "No", FormatStyle::BTDS_No);
185 IO.enumCase(Value, "MultiLine", FormatStyle::BTDS_MultiLine);
186 IO.enumCase(Value, "Yes", FormatStyle::BTDS_Yes);
187
188 // For backward compatibility.
189 IO.enumCase(Value, "false", FormatStyle::BTDS_MultiLine);
190 IO.enumCase(Value, "true", FormatStyle::BTDS_Yes);
191 }
192};
193
194template <>
Daniel Jasperc1bc38e2015-09-29 14:57:55 +0000195struct ScalarEnumerationTraits<FormatStyle::DefinitionReturnTypeBreakingStyle> {
196 static void
197 enumeration(IO &IO, FormatStyle::DefinitionReturnTypeBreakingStyle &Value) {
Birunthan Mohanathasa0388a82015-06-29 15:30:42 +0000198 IO.enumCase(Value, "None", FormatStyle::DRTBS_None);
199 IO.enumCase(Value, "All", FormatStyle::DRTBS_All);
200 IO.enumCase(Value, "TopLevel", FormatStyle::DRTBS_TopLevel);
201
202 // For backward compatibility.
203 IO.enumCase(Value, "false", FormatStyle::DRTBS_None);
204 IO.enumCase(Value, "true", FormatStyle::DRTBS_All);
205 }
206};
207
Alexander Kornienkod6538332013-05-07 15:32:14 +0000208template <>
Alexander Kornienko6d2c88e2013-12-10 10:30:34 +0000209struct ScalarEnumerationTraits<FormatStyle::NamespaceIndentationKind> {
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000210 static void enumeration(IO &IO,
Alexander Kornienko6d2c88e2013-12-10 10:30:34 +0000211 FormatStyle::NamespaceIndentationKind &Value) {
212 IO.enumCase(Value, "None", FormatStyle::NI_None);
213 IO.enumCase(Value, "Inner", FormatStyle::NI_Inner);
214 IO.enumCase(Value, "All", FormatStyle::NI_All);
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000215 }
216};
217
Daniel Jasper6501f7e2015-10-27 12:38:37 +0000218template <> struct ScalarEnumerationTraits<FormatStyle::BracketAlignmentStyle> {
219 static void enumeration(IO &IO, FormatStyle::BracketAlignmentStyle &Value) {
220 IO.enumCase(Value, "Align", FormatStyle::BAS_Align);
221 IO.enumCase(Value, "DontAlign", FormatStyle::BAS_DontAlign);
222 IO.enumCase(Value, "AlwaysBreak", FormatStyle::BAS_AlwaysBreak);
223
224 // For backward compatibility.
225 IO.enumCase(Value, "true", FormatStyle::BAS_Align);
226 IO.enumCase(Value, "false", FormatStyle::BAS_DontAlign);
227 }
228};
229
Manuel Klimek89628f62017-09-20 09:51:03 +0000230template <>
231struct ScalarEnumerationTraits<FormatStyle::EscapedNewlineAlignmentStyle> {
232 static void enumeration(IO &IO,
233 FormatStyle::EscapedNewlineAlignmentStyle &Value) {
Daniel Jasper7fdbb3f2017-05-08 15:08:00 +0000234 IO.enumCase(Value, "DontAlign", FormatStyle::ENAS_DontAlign);
235 IO.enumCase(Value, "Left", FormatStyle::ENAS_Left);
236 IO.enumCase(Value, "Right", FormatStyle::ENAS_Right);
237
238 // For backward compatibility.
239 IO.enumCase(Value, "true", FormatStyle::ENAS_Left);
240 IO.enumCase(Value, "false", FormatStyle::ENAS_Right);
241 }
242};
243
Jacques Pienaarfc275112015-02-18 23:48:37 +0000244template <> struct ScalarEnumerationTraits<FormatStyle::PointerAlignmentStyle> {
245 static void enumeration(IO &IO, FormatStyle::PointerAlignmentStyle &Value) {
Daniel Jasper553d4872014-06-17 12:40:34 +0000246 IO.enumCase(Value, "Middle", FormatStyle::PAS_Middle);
247 IO.enumCase(Value, "Left", FormatStyle::PAS_Left);
248 IO.enumCase(Value, "Right", FormatStyle::PAS_Right);
249
Alp Toker958027b2014-07-14 19:42:55 +0000250 // For backward compatibility.
Daniel Jasper553d4872014-06-17 12:40:34 +0000251 IO.enumCase(Value, "true", FormatStyle::PAS_Left);
252 IO.enumCase(Value, "false", FormatStyle::PAS_Right);
253 }
254};
255
256template <>
Alexander Kornienko6d2c88e2013-12-10 10:30:34 +0000257struct ScalarEnumerationTraits<FormatStyle::SpaceBeforeParensOptions> {
Manuel Klimeka8eb9142013-05-13 12:51:40 +0000258 static void enumeration(IO &IO,
Alexander Kornienko6d2c88e2013-12-10 10:30:34 +0000259 FormatStyle::SpaceBeforeParensOptions &Value) {
260 IO.enumCase(Value, "Never", FormatStyle::SBPO_Never);
Alexander Kornienkofdca83d2013-12-10 10:18:34 +0000261 IO.enumCase(Value, "ControlStatements",
Alexander Kornienko6d2c88e2013-12-10 10:30:34 +0000262 FormatStyle::SBPO_ControlStatements);
263 IO.enumCase(Value, "Always", FormatStyle::SBPO_Always);
Alexander Kornienkofdca83d2013-12-10 10:18:34 +0000264
265 // For backward compatibility.
Alexander Kornienko6d2c88e2013-12-10 10:30:34 +0000266 IO.enumCase(Value, "false", FormatStyle::SBPO_Never);
267 IO.enumCase(Value, "true", FormatStyle::SBPO_ControlStatements);
Alexander Kornienkofdca83d2013-12-10 10:18:34 +0000268 }
269};
270
Alexander Kornienko6d2c88e2013-12-10 10:30:34 +0000271template <> struct MappingTraits<FormatStyle> {
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000272 static void mapping(IO &IO, FormatStyle &Style) {
273 // When reading, read the language first, we need it for getPredefinedStyle.
274 IO.mapOptional("Language", Style.Language);
275
Alexander Kornienko49149672013-05-10 11:56:10 +0000276 if (IO.outputting()) {
Jacques Pienaarfc275112015-02-18 23:48:37 +0000277 StringRef StylesArray[] = {"LLVM", "Google", "Chromium",
278 "Mozilla", "WebKit", "GNU"};
Alexander Kornienko49149672013-05-10 11:56:10 +0000279 ArrayRef<StringRef> Styles(StylesArray);
280 for (size_t i = 0, e = Styles.size(); i < e; ++i) {
281 StringRef StyleName(Styles[i]);
Alexander Kornienko6d2c88e2013-12-10 10:30:34 +0000282 FormatStyle PredefinedStyle;
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000283 if (getPredefinedStyle(StyleName, Style.Language, &PredefinedStyle) &&
Alexander Kornienko006b5c82013-05-19 00:53:30 +0000284 Style == PredefinedStyle) {
Alexander Kornienko49149672013-05-10 11:56:10 +0000285 IO.mapOptional("# BasedOnStyle", StyleName);
286 break;
287 }
288 }
289 } else {
Alexander Kornienkod6538332013-05-07 15:32:14 +0000290 StringRef BasedOnStyle;
291 IO.mapOptional("BasedOnStyle", BasedOnStyle);
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000292 if (!BasedOnStyle.empty()) {
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000293 FormatStyle::LanguageKind OldLanguage = Style.Language;
294 FormatStyle::LanguageKind Language =
295 ((FormatStyle *)IO.getContext())->Language;
296 if (!getPredefinedStyle(BasedOnStyle, Language, &Style)) {
Alexander Kornienko006b5c82013-05-19 00:53:30 +0000297 IO.setError(Twine("Unknown value for BasedOnStyle: ", BasedOnStyle));
298 return;
299 }
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000300 Style.Language = OldLanguage;
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000301 }
Alexander Kornienkod6538332013-05-07 15:32:14 +0000302 }
303
Birunthan Mohanathas50a6f912015-06-28 14:52:34 +0000304 // For backward compatibility.
305 if (!IO.outputting()) {
Daniel Jasper7fdbb3f2017-05-08 15:08:00 +0000306 IO.mapOptional("AlignEscapedNewlinesLeft", Style.AlignEscapedNewlines);
Birunthan Mohanathas50a6f912015-06-28 14:52:34 +0000307 IO.mapOptional("DerivePointerBinding", Style.DerivePointerAlignment);
308 IO.mapOptional("IndentFunctionDeclarationAfterType",
309 Style.IndentWrappedFunctionNames);
310 IO.mapOptional("PointerBindsToType", Style.PointerAlignment);
311 IO.mapOptional("SpaceAfterControlStatementKeyword",
312 Style.SpaceBeforeParens);
313 }
314
Alexander Kornienkod6538332013-05-07 15:32:14 +0000315 IO.mapOptional("AccessModifierOffset", Style.AccessModifierOffset);
Daniel Jasper3aa9a6a2014-11-18 23:55:27 +0000316 IO.mapOptional("AlignAfterOpenBracket", Style.AlignAfterOpenBracket);
Birunthan Mohanathas35cfbd72015-06-28 14:51:17 +0000317 IO.mapOptional("AlignConsecutiveAssignments",
318 Style.AlignConsecutiveAssignments);
Daniel Jaspere12597c2015-10-01 10:06:54 +0000319 IO.mapOptional("AlignConsecutiveDeclarations",
320 Style.AlignConsecutiveDeclarations);
Daniel Jasper7fdbb3f2017-05-08 15:08:00 +0000321 IO.mapOptional("AlignEscapedNewlines", Style.AlignEscapedNewlines);
Daniel Jasper3219e432014-12-02 13:24:51 +0000322 IO.mapOptional("AlignOperands", Style.AlignOperands);
Daniel Jasper552f4a72013-07-31 23:55:15 +0000323 IO.mapOptional("AlignTrailingComments", Style.AlignTrailingComments);
Alexander Kornienkod6538332013-05-07 15:32:14 +0000324 IO.mapOptional("AllowAllParametersOfDeclarationOnNextLine",
325 Style.AllowAllParametersOfDeclarationOnNextLine);
Daniel Jasper17605d32014-05-14 09:33:35 +0000326 IO.mapOptional("AllowShortBlocksOnASingleLine",
327 Style.AllowShortBlocksOnASingleLine);
Daniel Jasperb87899b2014-09-10 13:11:45 +0000328 IO.mapOptional("AllowShortCaseLabelsOnASingleLine",
329 Style.AllowShortCaseLabelsOnASingleLine);
Birunthan Mohanathas35cfbd72015-06-28 14:51:17 +0000330 IO.mapOptional("AllowShortFunctionsOnASingleLine",
331 Style.AllowShortFunctionsOnASingleLine);
Alexander Kornienkod6538332013-05-07 15:32:14 +0000332 IO.mapOptional("AllowShortIfStatementsOnASingleLine",
333 Style.AllowShortIfStatementsOnASingleLine);
Daniel Jasper3a685df2013-05-16 12:12:21 +0000334 IO.mapOptional("AllowShortLoopsOnASingleLine",
335 Style.AllowShortLoopsOnASingleLine);
Daniel Jasperca4ea1c2014-08-05 12:16:31 +0000336 IO.mapOptional("AlwaysBreakAfterDefinitionReturnType",
337 Style.AlwaysBreakAfterDefinitionReturnType);
Zachary Turner448592e2015-12-18 22:20:15 +0000338 IO.mapOptional("AlwaysBreakAfterReturnType",
339 Style.AlwaysBreakAfterReturnType);
340 // If AlwaysBreakAfterDefinitionReturnType was specified but
341 // AlwaysBreakAfterReturnType was not, initialize the latter from the
342 // former for backwards compatibility.
343 if (Style.AlwaysBreakAfterDefinitionReturnType != FormatStyle::DRTBS_None &&
344 Style.AlwaysBreakAfterReturnType == FormatStyle::RTBS_None) {
345 if (Style.AlwaysBreakAfterDefinitionReturnType == FormatStyle::DRTBS_All)
346 Style.AlwaysBreakAfterReturnType = FormatStyle::RTBS_AllDefinitions;
347 else if (Style.AlwaysBreakAfterDefinitionReturnType ==
348 FormatStyle::DRTBS_TopLevel)
349 Style.AlwaysBreakAfterReturnType =
350 FormatStyle::RTBS_TopLevelDefinitions;
351 }
352
Alexander Kornienko58611712013-07-04 12:02:44 +0000353 IO.mapOptional("AlwaysBreakBeforeMultilineStrings",
354 Style.AlwaysBreakBeforeMultilineStrings);
Birunthan Mohanathas35cfbd72015-06-28 14:51:17 +0000355 IO.mapOptional("AlwaysBreakTemplateDeclarations",
356 Style.AlwaysBreakTemplateDeclarations);
357 IO.mapOptional("BinPackArguments", Style.BinPackArguments);
358 IO.mapOptional("BinPackParameters", Style.BinPackParameters);
Daniel Jasperc1bc38e2015-09-29 14:57:55 +0000359 IO.mapOptional("BraceWrapping", Style.BraceWrapping);
Daniel Jaspere33d4af2013-07-26 16:56:36 +0000360 IO.mapOptional("BreakBeforeBinaryOperators",
361 Style.BreakBeforeBinaryOperators);
Birunthan Mohanathas35cfbd72015-06-28 14:51:17 +0000362 IO.mapOptional("BreakBeforeBraces", Style.BreakBeforeBraces);
Francois Ferrand6bb103f2018-06-11 14:41:26 +0000363
364 bool BreakBeforeInheritanceComma = false;
Francois Ferrande56a8292017-06-14 12:29:47 +0000365 IO.mapOptional("BreakBeforeInheritanceComma",
Francois Ferrand6bb103f2018-06-11 14:41:26 +0000366 BreakBeforeInheritanceComma);
367 IO.mapOptional("BreakInheritanceList",
368 Style.BreakInheritanceList);
369 // If BreakBeforeInheritanceComma was specified but
370 // BreakInheritance was not, initialize the latter from the
371 // former for backwards compatibility.
372 if (BreakBeforeInheritanceComma &&
373 Style.BreakInheritanceList == FormatStyle::BILS_BeforeColon)
374 Style.BreakInheritanceList = FormatStyle::BILS_BeforeComma;
375
Daniel Jasper165b29e2013-11-08 00:57:11 +0000376 IO.mapOptional("BreakBeforeTernaryOperators",
377 Style.BreakBeforeTernaryOperators);
Francois Ferranda6b6d512017-05-24 11:36:58 +0000378
379 bool BreakConstructorInitializersBeforeComma = false;
Daniel Jaspere33d4af2013-07-26 16:56:36 +0000380 IO.mapOptional("BreakConstructorInitializersBeforeComma",
Francois Ferranda6b6d512017-05-24 11:36:58 +0000381 BreakConstructorInitializersBeforeComma);
382 IO.mapOptional("BreakConstructorInitializers",
383 Style.BreakConstructorInitializers);
384 // If BreakConstructorInitializersBeforeComma was specified but
385 // BreakConstructorInitializers was not, initialize the latter from the
386 // former for backwards compatibility.
387 if (BreakConstructorInitializersBeforeComma &&
388 Style.BreakConstructorInitializers == FormatStyle::BCIS_BeforeColon)
389 Style.BreakConstructorInitializers = FormatStyle::BCIS_BeforeComma;
390
Daniel Jaspere1a7b762016-02-01 11:21:02 +0000391 IO.mapOptional("BreakAfterJavaFieldAnnotations",
392 Style.BreakAfterJavaFieldAnnotations);
393 IO.mapOptional("BreakStringLiterals", Style.BreakStringLiterals);
Alexander Kornienkod6538332013-05-07 15:32:14 +0000394 IO.mapOptional("ColumnLimit", Style.ColumnLimit);
Birunthan Mohanathas35cfbd72015-06-28 14:51:17 +0000395 IO.mapOptional("CommentPragmas", Style.CommentPragmas);
Francois Ferrande56a8292017-06-14 12:29:47 +0000396 IO.mapOptional("CompactNamespaces", Style.CompactNamespaces);
Alexander Kornienkod6538332013-05-07 15:32:14 +0000397 IO.mapOptional("ConstructorInitializerAllOnOneLineOrOnePerLine",
398 Style.ConstructorInitializerAllOnOneLineOrOnePerLine);
Daniel Jasper50d634b2014-10-28 16:53:38 +0000399 IO.mapOptional("ConstructorInitializerIndentWidth",
400 Style.ConstructorInitializerIndentWidth);
Birunthan Mohanathas35cfbd72015-06-28 14:51:17 +0000401 IO.mapOptional("ContinuationIndentWidth", Style.ContinuationIndentWidth);
402 IO.mapOptional("Cpp11BracedListStyle", Style.Cpp11BracedListStyle);
Daniel Jasper553d4872014-06-17 12:40:34 +0000403 IO.mapOptional("DerivePointerAlignment", Style.DerivePointerAlignment);
Birunthan Mohanathas35cfbd72015-06-28 14:51:17 +0000404 IO.mapOptional("DisableFormat", Style.DisableFormat);
Daniel Jasperb10cbc42013-07-10 14:02:49 +0000405 IO.mapOptional("ExperimentalAutoDetectBinPacking",
406 Style.ExperimentalAutoDetectBinPacking);
Krasimir Georgiev32eaa862017-03-01 15:35:39 +0000407 IO.mapOptional("FixNamespaceComments", Style.FixNamespaceComments);
Birunthan Mohanathas35cfbd72015-06-28 14:51:17 +0000408 IO.mapOptional("ForEachMacros", Style.ForEachMacros);
Eric Liu9d92c022018-05-14 19:51:33 +0000409 IO.mapOptional("IncludeBlocks", Style.IncludeStyle.IncludeBlocks);
410 IO.mapOptional("IncludeCategories", Style.IncludeStyle.IncludeCategories);
411 IO.mapOptional("IncludeIsMainRegex", Style.IncludeStyle.IncludeIsMainRegex);
Alexander Kornienkod6538332013-05-07 15:32:14 +0000412 IO.mapOptional("IndentCaseLabels", Style.IndentCaseLabels);
Krasimir Georgievad47c902017-08-30 14:34:57 +0000413 IO.mapOptional("IndentPPDirectives", Style.IndentPPDirectives);
Birunthan Mohanathas35cfbd72015-06-28 14:51:17 +0000414 IO.mapOptional("IndentWidth", Style.IndentWidth);
415 IO.mapOptional("IndentWrappedFunctionNames",
416 Style.IndentWrappedFunctionNames);
Krasimir Georgiev7e91b032018-10-05 17:19:26 +0000417 IO.mapOptional("JavaImportGroups", Style.JavaImportGroups);
Martin Probst0cd74ee2016-06-13 16:39:50 +0000418 IO.mapOptional("JavaScriptQuotes", Style.JavaScriptQuotes);
419 IO.mapOptional("JavaScriptWrapImports", Style.JavaScriptWrapImports);
Daniel Jaspera26fc5c2014-03-21 13:43:14 +0000420 IO.mapOptional("KeepEmptyLinesAtTheStartOfBlocks",
421 Style.KeepEmptyLinesAtTheStartOfBlocks);
Birunthan Mohanathasb001a0b2015-07-03 17:25:16 +0000422 IO.mapOptional("MacroBlockBegin", Style.MacroBlockBegin);
423 IO.mapOptional("MacroBlockEnd", Style.MacroBlockEnd);
Birunthan Mohanathas35cfbd72015-06-28 14:51:17 +0000424 IO.mapOptional("MaxEmptyLinesToKeep", Style.MaxEmptyLinesToKeep);
Daniel Jasper65ee3472013-07-31 23:16:02 +0000425 IO.mapOptional("NamespaceIndentation", Style.NamespaceIndentation);
Ben Hamilton4dc658c2018-02-02 20:15:14 +0000426 IO.mapOptional("ObjCBinPackProtocolList", Style.ObjCBinPackProtocolList);
Daniel Jasper50d634b2014-10-28 16:53:38 +0000427 IO.mapOptional("ObjCBlockIndentWidth", Style.ObjCBlockIndentWidth);
Daniel Jaspere9beea22014-01-28 15:20:33 +0000428 IO.mapOptional("ObjCSpaceAfterProperty", Style.ObjCSpaceAfterProperty);
Alexander Kornienkod6538332013-05-07 15:32:14 +0000429 IO.mapOptional("ObjCSpaceBeforeProtocolList",
430 Style.ObjCSpaceBeforeProtocolList);
Manuel Klimek89628f62017-09-20 09:51:03 +0000431 IO.mapOptional("PenaltyBreakAssignment", Style.PenaltyBreakAssignment);
Daniel Jasper33b909c2013-10-25 14:29:37 +0000432 IO.mapOptional("PenaltyBreakBeforeFirstCallParameter",
433 Style.PenaltyBreakBeforeFirstCallParameter);
Alexander Kornienkodd7ece52013-06-07 16:02:52 +0000434 IO.mapOptional("PenaltyBreakComment", Style.PenaltyBreakComment);
Daniel Jasper4e9678f2013-07-11 20:41:21 +0000435 IO.mapOptional("PenaltyBreakFirstLessLess",
436 Style.PenaltyBreakFirstLessLess);
Birunthan Mohanathas35cfbd72015-06-28 14:51:17 +0000437 IO.mapOptional("PenaltyBreakString", Style.PenaltyBreakString);
Francois Ferrand58e6fe52018-05-16 08:25:03 +0000438 IO.mapOptional("PenaltyBreakTemplateDeclaration",
439 Style.PenaltyBreakTemplateDeclaration);
Alexander Kornienkod6538332013-05-07 15:32:14 +0000440 IO.mapOptional("PenaltyExcessCharacter", Style.PenaltyExcessCharacter);
441 IO.mapOptional("PenaltyReturnTypeOnItsOwnLine",
442 Style.PenaltyReturnTypeOnItsOwnLine);
Daniel Jasper553d4872014-06-17 12:40:34 +0000443 IO.mapOptional("PointerAlignment", Style.PointerAlignment);
Krasimir Georgiev9ad83fe2017-10-30 14:01:50 +0000444 IO.mapOptional("RawStringFormats", Style.RawStringFormats);
Daniel Jaspera0a50392015-12-01 13:28:53 +0000445 IO.mapOptional("ReflowComments", Style.ReflowComments);
446 IO.mapOptional("SortIncludes", Style.SortIncludes);
Krasimir Georgievac16a202017-06-23 11:46:03 +0000447 IO.mapOptional("SortUsingDeclarations", Style.SortUsingDeclarations);
Daniel Jasperdb986eb2014-09-03 07:37:29 +0000448 IO.mapOptional("SpaceAfterCStyleCast", Style.SpaceAfterCStyleCast);
Manuel Klimek89628f62017-09-20 09:51:03 +0000449 IO.mapOptional("SpaceAfterTemplateKeyword",
450 Style.SpaceAfterTemplateKeyword);
Daniel Jasperd94bff32013-09-25 15:15:02 +0000451 IO.mapOptional("SpaceBeforeAssignmentOperators",
452 Style.SpaceBeforeAssignmentOperators);
Hans Wennborgbfc34062018-06-14 08:01:09 +0000453 IO.mapOptional("SpaceBeforeCpp11BracedList",
454 Style.SpaceBeforeCpp11BracedList);
Francois Ferrand2a9ea782018-03-01 10:09:13 +0000455 IO.mapOptional("SpaceBeforeCtorInitializerColon",
456 Style.SpaceBeforeCtorInitializerColon);
457 IO.mapOptional("SpaceBeforeInheritanceColon",
458 Style.SpaceBeforeInheritanceColon);
Birunthan Mohanathas35cfbd72015-06-28 14:51:17 +0000459 IO.mapOptional("SpaceBeforeParens", Style.SpaceBeforeParens);
Francois Ferrand2a9ea782018-03-01 10:09:13 +0000460 IO.mapOptional("SpaceBeforeRangeBasedForLoopColon",
461 Style.SpaceBeforeRangeBasedForLoopColon);
Birunthan Mohanathas35cfbd72015-06-28 14:51:17 +0000462 IO.mapOptional("SpaceInEmptyParentheses", Style.SpaceInEmptyParentheses);
463 IO.mapOptional("SpacesBeforeTrailingComments",
464 Style.SpacesBeforeTrailingComments);
465 IO.mapOptional("SpacesInAngles", Style.SpacesInAngles);
466 IO.mapOptional("SpacesInContainerLiterals",
467 Style.SpacesInContainerLiterals);
468 IO.mapOptional("SpacesInCStyleCastParentheses",
469 Style.SpacesInCStyleCastParentheses);
470 IO.mapOptional("SpacesInParentheses", Style.SpacesInParentheses);
471 IO.mapOptional("SpacesInSquareBrackets", Style.SpacesInSquareBrackets);
472 IO.mapOptional("Standard", Style.Standard);
Francois Ferrand6f40e212018-10-02 16:37:51 +0000473 IO.mapOptional("StatementMacros", Style.StatementMacros);
Birunthan Mohanathas35cfbd72015-06-28 14:51:17 +0000474 IO.mapOptional("TabWidth", Style.TabWidth);
475 IO.mapOptional("UseTab", Style.UseTab);
Alexander Kornienkod6538332013-05-07 15:32:14 +0000476 }
477};
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000478
Daniel Jasperc1bc38e2015-09-29 14:57:55 +0000479template <> struct MappingTraits<FormatStyle::BraceWrappingFlags> {
480 static void mapping(IO &IO, FormatStyle::BraceWrappingFlags &Wrapping) {
481 IO.mapOptional("AfterClass", Wrapping.AfterClass);
482 IO.mapOptional("AfterControlStatement", Wrapping.AfterControlStatement);
483 IO.mapOptional("AfterEnum", Wrapping.AfterEnum);
484 IO.mapOptional("AfterFunction", Wrapping.AfterFunction);
485 IO.mapOptional("AfterNamespace", Wrapping.AfterNamespace);
486 IO.mapOptional("AfterObjCDeclaration", Wrapping.AfterObjCDeclaration);
487 IO.mapOptional("AfterStruct", Wrapping.AfterStruct);
488 IO.mapOptional("AfterUnion", Wrapping.AfterUnion);
Krasimir Georgievd6ce9372017-09-15 11:23:50 +0000489 IO.mapOptional("AfterExternBlock", Wrapping.AfterExternBlock);
Daniel Jasperc1bc38e2015-09-29 14:57:55 +0000490 IO.mapOptional("BeforeCatch", Wrapping.BeforeCatch);
491 IO.mapOptional("BeforeElse", Wrapping.BeforeElse);
492 IO.mapOptional("IndentBraces", Wrapping.IndentBraces);
Francois Ferrandad722562017-06-30 20:25:55 +0000493 IO.mapOptional("SplitEmptyFunction", Wrapping.SplitEmptyFunction);
494 IO.mapOptional("SplitEmptyRecord", Wrapping.SplitEmptyRecord);
495 IO.mapOptional("SplitEmptyNamespace", Wrapping.SplitEmptyNamespace);
Daniel Jasperc1bc38e2015-09-29 14:57:55 +0000496 }
497};
498
Krasimir Georgiev9ad83fe2017-10-30 14:01:50 +0000499template <> struct MappingTraits<FormatStyle::RawStringFormat> {
500 static void mapping(IO &IO, FormatStyle::RawStringFormat &Format) {
Krasimir Georgiev9ad83fe2017-10-30 14:01:50 +0000501 IO.mapOptional("Language", Format.Language);
Krasimir Georgiev4527f132018-01-17 12:24:59 +0000502 IO.mapOptional("Delimiters", Format.Delimiters);
Krasimir Georgiev2537e222018-01-17 16:17:26 +0000503 IO.mapOptional("EnclosingFunctions", Format.EnclosingFunctions);
Krasimir Georgiev412ed092018-01-19 16:18:47 +0000504 IO.mapOptional("CanonicalDelimiter", Format.CanonicalDelimiter);
Krasimir Georgiev9ad83fe2017-10-30 14:01:50 +0000505 IO.mapOptional("BasedOnStyle", Format.BasedOnStyle);
506 }
507};
508
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000509// Allows to read vector<FormatStyle> while keeping default values.
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000510// IO.getContext() should contain a pointer to the FormatStyle structure, that
511// will be used to get default values for missing keys.
512// If the first element has no Language specified, it will be treated as the
513// default one for the following elements.
Jacques Pienaarfc275112015-02-18 23:48:37 +0000514template <> struct DocumentListTraits<std::vector<FormatStyle>> {
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000515 static size_t size(IO &IO, std::vector<FormatStyle> &Seq) {
516 return Seq.size();
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000517 }
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000518 static FormatStyle &element(IO &IO, std::vector<FormatStyle> &Seq,
Alexander Kornienko6d2c88e2013-12-10 10:30:34 +0000519 size_t Index) {
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000520 if (Index >= Seq.size()) {
521 assert(Index == Seq.size());
Alexander Kornienko6d2c88e2013-12-10 10:30:34 +0000522 FormatStyle Template;
Krasimir Georgiev1696bb62017-11-09 15:12:17 +0000523 if (!Seq.empty() && Seq[0].Language == FormatStyle::LK_None) {
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000524 Template = Seq[0];
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000525 } else {
Daniel Jasperb05a81d2014-05-09 13:11:16 +0000526 Template = *((const FormatStyle *)IO.getContext());
Alexander Kornienko6d2c88e2013-12-10 10:30:34 +0000527 Template.Language = FormatStyle::LK_None;
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000528 }
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000529 Seq.resize(Index + 1, Template);
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000530 }
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000531 return Seq[Index];
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000532 }
533};
Daniel Jasperd89ae9d2015-09-23 08:30:47 +0000534} // namespace yaml
535} // namespace llvm
Alexander Kornienkod6538332013-05-07 15:32:14 +0000536
Daniel Jasperf7935112012-12-03 18:12:45 +0000537namespace clang {
538namespace format {
539
Rafael Espindola6d0d89b2014-06-12 03:31:26 +0000540const std::error_category &getParseCategory() {
Benjamin Kramerf76861c2018-03-20 21:52:19 +0000541 static const ParseErrorCategory C{};
Rafael Espindolad0136702014-06-12 02:50:04 +0000542 return C;
543}
544std::error_code make_error_code(ParseError e) {
Rafael Espindola6d0d89b2014-06-12 03:31:26 +0000545 return std::error_code(static_cast<int>(e), getParseCategory());
Rafael Espindolad0136702014-06-12 02:50:04 +0000546}
547
Antonio Maiorano3adfb6a2017-01-17 00:12:27 +0000548inline llvm::Error make_string_error(const llvm::Twine &Message) {
549 return llvm::make_error<llvm::StringError>(Message,
550 llvm::inconvertibleErrorCode());
551}
552
Reid Kleckner6432d452016-10-19 23:39:55 +0000553const char *ParseErrorCategory::name() const noexcept {
Rafael Espindolad0136702014-06-12 02:50:04 +0000554 return "clang-format.parse_error";
555}
556
557std::string ParseErrorCategory::message(int EV) const {
558 switch (static_cast<ParseError>(EV)) {
559 case ParseError::Success:
560 return "Success";
561 case ParseError::Error:
562 return "Invalid argument";
563 case ParseError::Unsuitable:
564 return "Unsuitable";
565 }
Saleem Abdulrasoolfbfbaf62014-06-12 19:33:26 +0000566 llvm_unreachable("unexpected parse error");
Rafael Espindolad0136702014-06-12 02:50:04 +0000567}
568
Daniel Jasperc1bc38e2015-09-29 14:57:55 +0000569static FormatStyle expandPresets(const FormatStyle &Style) {
Daniel Jasper55bbe662015-10-07 04:06:10 +0000570 if (Style.BreakBeforeBraces == FormatStyle::BS_Custom)
571 return Style;
Daniel Jasperc1bc38e2015-09-29 14:57:55 +0000572 FormatStyle Expanded = Style;
Manuel Klimek89628f62017-09-20 09:51:03 +0000573 Expanded.BraceWrapping = {false, false, false, false, false,
574 false, false, false, false, false,
575 false, false, true, true, true};
Daniel Jasperc1bc38e2015-09-29 14:57:55 +0000576 switch (Style.BreakBeforeBraces) {
577 case FormatStyle::BS_Linux:
578 Expanded.BraceWrapping.AfterClass = true;
579 Expanded.BraceWrapping.AfterFunction = true;
580 Expanded.BraceWrapping.AfterNamespace = true;
Daniel Jasperc1bc38e2015-09-29 14:57:55 +0000581 break;
582 case FormatStyle::BS_Mozilla:
583 Expanded.BraceWrapping.AfterClass = true;
584 Expanded.BraceWrapping.AfterEnum = true;
585 Expanded.BraceWrapping.AfterFunction = true;
586 Expanded.BraceWrapping.AfterStruct = true;
587 Expanded.BraceWrapping.AfterUnion = true;
Krasimir Georgievd6ce9372017-09-15 11:23:50 +0000588 Expanded.BraceWrapping.AfterExternBlock = true;
Sylvestre Ledru82c9a0e2017-09-13 20:03:29 +0000589 Expanded.BraceWrapping.SplitEmptyFunction = true;
Francois Ferrandad722562017-06-30 20:25:55 +0000590 Expanded.BraceWrapping.SplitEmptyRecord = false;
Daniel Jasperc1bc38e2015-09-29 14:57:55 +0000591 break;
592 case FormatStyle::BS_Stroustrup:
593 Expanded.BraceWrapping.AfterFunction = true;
594 Expanded.BraceWrapping.BeforeCatch = true;
595 Expanded.BraceWrapping.BeforeElse = true;
596 break;
597 case FormatStyle::BS_Allman:
598 Expanded.BraceWrapping.AfterClass = true;
599 Expanded.BraceWrapping.AfterControlStatement = true;
600 Expanded.BraceWrapping.AfterEnum = true;
601 Expanded.BraceWrapping.AfterFunction = true;
602 Expanded.BraceWrapping.AfterNamespace = true;
603 Expanded.BraceWrapping.AfterObjCDeclaration = true;
604 Expanded.BraceWrapping.AfterStruct = true;
Krasimir Georgievd6ce9372017-09-15 11:23:50 +0000605 Expanded.BraceWrapping.AfterExternBlock = true;
Daniel Jasperc1bc38e2015-09-29 14:57:55 +0000606 Expanded.BraceWrapping.BeforeCatch = true;
607 Expanded.BraceWrapping.BeforeElse = true;
608 break;
609 case FormatStyle::BS_GNU:
Manuel Klimek89628f62017-09-20 09:51:03 +0000610 Expanded.BraceWrapping = {true, true, true, true, true, true, true, true,
611 true, true, true, true, true, true, true};
Daniel Jasperc1bc38e2015-09-29 14:57:55 +0000612 break;
613 case FormatStyle::BS_WebKit:
614 Expanded.BraceWrapping.AfterFunction = true;
615 break;
616 default:
617 break;
618 }
619 return Expanded;
620}
621
Daniel Jasperf7935112012-12-03 18:12:45 +0000622FormatStyle getLLVMStyle() {
623 FormatStyle LLVMStyle;
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000624 LLVMStyle.Language = FormatStyle::LK_Cpp;
Daniel Jasperf7935112012-12-03 18:12:45 +0000625 LLVMStyle.AccessModifierOffset = -2;
Daniel Jasper7fdbb3f2017-05-08 15:08:00 +0000626 LLVMStyle.AlignEscapedNewlines = FormatStyle::ENAS_Right;
Daniel Jasper6501f7e2015-10-27 12:38:37 +0000627 LLVMStyle.AlignAfterOpenBracket = FormatStyle::BAS_Align;
Daniel Jasper3219e432014-12-02 13:24:51 +0000628 LLVMStyle.AlignOperands = true;
Daniel Jasper552f4a72013-07-31 23:55:15 +0000629 LLVMStyle.AlignTrailingComments = true;
Daniel Jaspera44991332015-04-29 13:06:49 +0000630 LLVMStyle.AlignConsecutiveAssignments = false;
Daniel Jaspere12597c2015-10-01 10:06:54 +0000631 LLVMStyle.AlignConsecutiveDeclarations = false;
Daniel Jasperf7db4332013-01-29 16:03:49 +0000632 LLVMStyle.AllowAllParametersOfDeclarationOnNextLine = true;
Daniel Jasperd74cf402014-04-08 12:46:38 +0000633 LLVMStyle.AllowShortFunctionsOnASingleLine = FormatStyle::SFS_All;
Daniel Jasper17605d32014-05-14 09:33:35 +0000634 LLVMStyle.AllowShortBlocksOnASingleLine = false;
Daniel Jasperb87899b2014-09-10 13:11:45 +0000635 LLVMStyle.AllowShortCaseLabelsOnASingleLine = false;
Daniel Jasper1b750ed2013-01-14 16:24:39 +0000636 LLVMStyle.AllowShortIfStatementsOnASingleLine = false;
Daniel Jasper3a685df2013-05-16 12:12:21 +0000637 LLVMStyle.AllowShortLoopsOnASingleLine = false;
Zachary Turner448592e2015-12-18 22:20:15 +0000638 LLVMStyle.AlwaysBreakAfterReturnType = FormatStyle::RTBS_None;
Birunthan Mohanathasa0388a82015-06-29 15:30:42 +0000639 LLVMStyle.AlwaysBreakAfterDefinitionReturnType = FormatStyle::DRTBS_None;
Alexander Kornienko58611712013-07-04 12:02:44 +0000640 LLVMStyle.AlwaysBreakBeforeMultilineStrings = false;
Francois Ferrand58e6fe52018-05-16 08:25:03 +0000641 LLVMStyle.AlwaysBreakTemplateDeclarations = FormatStyle::BTDS_MultiLine;
Daniel Jasper18210d72014-10-09 09:52:05 +0000642 LLVMStyle.BinPackArguments = true;
Francois Ferrande56a8292017-06-14 12:29:47 +0000643 LLVMStyle.BinPackParameters = true;
Daniel Jasperac043c92014-09-15 11:11:00 +0000644 LLVMStyle.BreakBeforeBinaryOperators = FormatStyle::BOS_None;
Daniel Jasper165b29e2013-11-08 00:57:11 +0000645 LLVMStyle.BreakBeforeTernaryOperators = true;
Daniel Jaspere33d4af2013-07-26 16:56:36 +0000646 LLVMStyle.BreakBeforeBraces = FormatStyle::BS_Attach;
Manuel Klimek89628f62017-09-20 09:51:03 +0000647 LLVMStyle.BraceWrapping = {false, false, false, false, false,
648 false, false, false, false, false,
649 false, false, true, true, true};
Nico Weber2cd92f12015-10-15 16:03:01 +0000650 LLVMStyle.BreakAfterJavaFieldAnnotations = false;
Francois Ferranda6b6d512017-05-24 11:36:58 +0000651 LLVMStyle.BreakConstructorInitializers = FormatStyle::BCIS_BeforeColon;
Francois Ferrand6bb103f2018-06-11 14:41:26 +0000652 LLVMStyle.BreakInheritanceList = FormatStyle::BILS_BeforeColon;
Daniel Jaspere1a7b762016-02-01 11:21:02 +0000653 LLVMStyle.BreakStringLiterals = true;
Alexander Kornienkoc8602662013-05-06 14:11:27 +0000654 LLVMStyle.ColumnLimit = 80;
Daniel Jaspere1e43192014-04-01 12:55:11 +0000655 LLVMStyle.CommentPragmas = "^ IWYU pragma:";
Francois Ferrande56a8292017-06-14 12:29:47 +0000656 LLVMStyle.CompactNamespaces = false;
Alexander Kornienkoc8602662013-05-06 14:11:27 +0000657 LLVMStyle.ConstructorInitializerAllOnOneLineOrOnePerLine = false;
Daniel Jaspercdaffa42013-08-13 10:58:30 +0000658 LLVMStyle.ConstructorInitializerIndentWidth = 4;
Daniel Jaspere1e43192014-04-01 12:55:11 +0000659 LLVMStyle.ContinuationIndentWidth = 4;
Chandler Carruthf8b72662014-03-02 12:37:31 +0000660 LLVMStyle.Cpp11BracedListStyle = true;
Daniel Jasper553d4872014-06-17 12:40:34 +0000661 LLVMStyle.DerivePointerAlignment = false;
Daniel Jasperb10cbc42013-07-10 14:02:49 +0000662 LLVMStyle.ExperimentalAutoDetectBinPacking = false;
Krasimir Georgiev32eaa862017-03-01 15:35:39 +0000663 LLVMStyle.FixNamespaceComments = true;
Daniel Jaspere1e43192014-04-01 12:55:11 +0000664 LLVMStyle.ForEachMacros.push_back("foreach");
665 LLVMStyle.ForEachMacros.push_back("Q_FOREACH");
666 LLVMStyle.ForEachMacros.push_back("BOOST_FOREACH");
Eric Liu9d92c022018-05-14 19:51:33 +0000667 LLVMStyle.IncludeStyle.IncludeCategories = {
668 {"^\"(llvm|llvm-c|clang|clang-c)/", 2},
669 {"^(<|\"(gtest|gmock|isl|json)/)", 3},
670 {".*", 1}};
671 LLVMStyle.IncludeStyle.IncludeIsMainRegex = "(Test)?$";
672 LLVMStyle.IncludeStyle.IncludeBlocks = tooling::IncludeStyle::IBS_Preserve;
Alexander Kornienkoc8602662013-05-06 14:11:27 +0000673 LLVMStyle.IndentCaseLabels = false;
Krasimir Georgievad47c902017-08-30 14:34:57 +0000674 LLVMStyle.IndentPPDirectives = FormatStyle::PPDIS_None;
Daniel Jasperc75e1ef2014-07-09 08:42:42 +0000675 LLVMStyle.IndentWrappedFunctionNames = false;
Daniel Jaspere33d4af2013-07-26 16:56:36 +0000676 LLVMStyle.IndentWidth = 2;
Martin Probstfb2342d2016-06-13 17:50:10 +0000677 LLVMStyle.JavaScriptQuotes = FormatStyle::JSQS_Leave;
678 LLVMStyle.JavaScriptWrapImports = true;
Alexander Kornienkoebb43ca2013-09-05 14:08:34 +0000679 LLVMStyle.TabWidth = 8;
Alexander Kornienkoc8602662013-05-06 14:11:27 +0000680 LLVMStyle.MaxEmptyLinesToKeep = 1;
Daniel Jaspera26fc5c2014-03-21 13:43:14 +0000681 LLVMStyle.KeepEmptyLinesAtTheStartOfBlocks = true;
Daniel Jasper65ee3472013-07-31 23:16:02 +0000682 LLVMStyle.NamespaceIndentation = FormatStyle::NI_None;
Ben Hamilton4dc658c2018-02-02 20:15:14 +0000683 LLVMStyle.ObjCBinPackProtocolList = FormatStyle::BPS_Auto;
Daniel Jasper50d634b2014-10-28 16:53:38 +0000684 LLVMStyle.ObjCBlockIndentWidth = 2;
Daniel Jaspere9beea22014-01-28 15:20:33 +0000685 LLVMStyle.ObjCSpaceAfterProperty = false;
Nico Webera6087752013-01-10 20:12:55 +0000686 LLVMStyle.ObjCSpaceBeforeProtocolList = true;
Daniel Jasper553d4872014-06-17 12:40:34 +0000687 LLVMStyle.PointerAlignment = FormatStyle::PAS_Right;
Alexander Kornienkoc8602662013-05-06 14:11:27 +0000688 LLVMStyle.SpacesBeforeTrailingComments = 1;
Chandler Carruthf8b72662014-03-02 12:37:31 +0000689 LLVMStyle.Standard = FormatStyle::LS_Cpp11;
Alexander Kornienko3c3d09c2013-09-27 16:14:22 +0000690 LLVMStyle.UseTab = FormatStyle::UT_Never;
Daniel Jaspera0a50392015-12-01 13:28:53 +0000691 LLVMStyle.ReflowComments = true;
Daniel Jasperb55acad2013-08-20 12:36:34 +0000692 LLVMStyle.SpacesInParentheses = false;
Daniel Jasperad981f82014-08-26 11:41:14 +0000693 LLVMStyle.SpacesInSquareBrackets = false;
Daniel Jasperb55acad2013-08-20 12:36:34 +0000694 LLVMStyle.SpaceInEmptyParentheses = false;
Daniel Jasperb2e10a52014-01-15 15:09:08 +0000695 LLVMStyle.SpacesInContainerLiterals = true;
Daniel Jasperb55acad2013-08-20 12:36:34 +0000696 LLVMStyle.SpacesInCStyleCastParentheses = false;
Daniel Jasperdb986eb2014-09-03 07:37:29 +0000697 LLVMStyle.SpaceAfterCStyleCast = false;
Sylvestre Ledru83bbd572016-08-09 14:24:40 +0000698 LLVMStyle.SpaceAfterTemplateKeyword = true;
Francois Ferrand2a9ea782018-03-01 10:09:13 +0000699 LLVMStyle.SpaceBeforeCtorInitializerColon = true;
700 LLVMStyle.SpaceBeforeInheritanceColon = true;
Alexander Kornienkofdca83d2013-12-10 10:18:34 +0000701 LLVMStyle.SpaceBeforeParens = FormatStyle::SBPO_ControlStatements;
Francois Ferrand2a9ea782018-03-01 10:09:13 +0000702 LLVMStyle.SpaceBeforeRangeBasedForLoopColon = true;
Daniel Jasperd94bff32013-09-25 15:15:02 +0000703 LLVMStyle.SpaceBeforeAssignmentOperators = true;
Hans Wennborgbfc34062018-06-14 08:01:09 +0000704 LLVMStyle.SpaceBeforeCpp11BracedList = false;
Daniel Jasperdd978ae2013-10-29 14:52:02 +0000705 LLVMStyle.SpacesInAngles = false;
Daniel Jasper4e9678f2013-07-11 20:41:21 +0000706
Francois Ferrand9976efa2017-05-22 08:28:17 +0000707 LLVMStyle.PenaltyBreakAssignment = prec::Assignment;
Daniel Jasper19a541e2013-12-19 16:45:34 +0000708 LLVMStyle.PenaltyBreakComment = 300;
Alexander Kornienkofe7a57f2013-12-10 15:42:15 +0000709 LLVMStyle.PenaltyBreakFirstLessLess = 120;
710 LLVMStyle.PenaltyBreakString = 1000;
711 LLVMStyle.PenaltyExcessCharacter = 1000000;
Daniel Jasper4e9678f2013-07-11 20:41:21 +0000712 LLVMStyle.PenaltyReturnTypeOnItsOwnLine = 60;
Daniel Jasper33b909c2013-10-25 14:29:37 +0000713 LLVMStyle.PenaltyBreakBeforeFirstCallParameter = 19;
Francois Ferrand58e6fe52018-05-16 08:25:03 +0000714 LLVMStyle.PenaltyBreakTemplateDeclaration = prec::Relational;
Daniel Jasper4e9678f2013-07-11 20:41:21 +0000715
Daniel Jasperc64b09a2014-05-22 15:12:22 +0000716 LLVMStyle.DisableFormat = false;
Daniel Jasperda446772015-11-16 12:38:56 +0000717 LLVMStyle.SortIncludes = true;
Krasimir Georgievac16a202017-06-23 11:46:03 +0000718 LLVMStyle.SortUsingDeclarations = true;
Francois Ferrand6f40e212018-10-02 16:37:51 +0000719 LLVMStyle.StatementMacros.push_back("Q_UNUSED");
720 LLVMStyle.StatementMacros.push_back("QT_REQUIRE_VERSION");
Daniel Jasperc64b09a2014-05-22 15:12:22 +0000721
Daniel Jasperf7935112012-12-03 18:12:45 +0000722 return LLVMStyle;
723}
724
Nico Weber514ecc82014-02-02 20:50:45 +0000725FormatStyle getGoogleStyle(FormatStyle::LanguageKind Language) {
Krasimir Georgiev26b144c2017-07-03 15:05:14 +0000726 if (Language == FormatStyle::LK_TextProto) {
727 FormatStyle GoogleStyle = getGoogleStyle(FormatStyle::LK_Proto);
728 GoogleStyle.Language = FormatStyle::LK_TextProto;
Krasimir Georgieveda222e2018-01-24 11:18:39 +0000729
Krasimir Georgiev26b144c2017-07-03 15:05:14 +0000730 return GoogleStyle;
731 }
732
Alexander Kornienkofe7a57f2013-12-10 15:42:15 +0000733 FormatStyle GoogleStyle = getLLVMStyle();
Nico Weber514ecc82014-02-02 20:50:45 +0000734 GoogleStyle.Language = Language;
735
Daniel Jasperf7935112012-12-03 18:12:45 +0000736 GoogleStyle.AccessModifierOffset = -1;
Daniel Jasper7fdbb3f2017-05-08 15:08:00 +0000737 GoogleStyle.AlignEscapedNewlines = FormatStyle::ENAS_Left;
Daniel Jasper085a2ed2013-04-24 13:46:00 +0000738 GoogleStyle.AllowShortIfStatementsOnASingleLine = true;
Daniel Jasper5bd0b9e2013-05-23 18:05:18 +0000739 GoogleStyle.AllowShortLoopsOnASingleLine = true;
Alexander Kornienko58611712013-07-04 12:02:44 +0000740 GoogleStyle.AlwaysBreakBeforeMultilineStrings = true;
Francois Ferrand58e6fe52018-05-16 08:25:03 +0000741 GoogleStyle.AlwaysBreakTemplateDeclarations = FormatStyle::BTDS_Yes;
Alexander Kornienkoc8602662013-05-06 14:11:27 +0000742 GoogleStyle.ConstructorInitializerAllOnOneLineOrOnePerLine = true;
Daniel Jasper553d4872014-06-17 12:40:34 +0000743 GoogleStyle.DerivePointerAlignment = true;
Eric Liu9d92c022018-05-14 19:51:33 +0000744 GoogleStyle.IncludeStyle.IncludeCategories = {
Krasimir Georgieva84e7872017-09-26 14:58:29 +0000745 {"^<ext/.*\\.h>", 2}, {"^<.*\\.h>", 1}, {"^<.*", 2}, {".*", 3}};
Eric Liu9d92c022018-05-14 19:51:33 +0000746 GoogleStyle.IncludeStyle.IncludeIsMainRegex = "([-_](test|unittest))?$";
Alexander Kornienkoc8602662013-05-06 14:11:27 +0000747 GoogleStyle.IndentCaseLabels = true;
Daniel Jaspera26fc5c2014-03-21 13:43:14 +0000748 GoogleStyle.KeepEmptyLinesAtTheStartOfBlocks = false;
Ben Hamilton3a47fdd2018-02-08 01:49:10 +0000749 GoogleStyle.ObjCBinPackProtocolList = FormatStyle::BPS_Never;
Daniel Jaspere9beea22014-01-28 15:20:33 +0000750 GoogleStyle.ObjCSpaceAfterProperty = false;
Ben Hamiltonf84f1182018-01-18 18:37:16 +0000751 GoogleStyle.ObjCSpaceBeforeProtocolList = true;
Daniel Jasper553d4872014-06-17 12:40:34 +0000752 GoogleStyle.PointerAlignment = FormatStyle::PAS_Left;
Krasimir Georgiev5559cc32018-04-25 14:56:19 +0000753 GoogleStyle.RawStringFormats = {
Krasimir Georgiev4527f132018-01-17 12:24:59 +0000754 {
Krasimir Georgiev5559cc32018-04-25 14:56:19 +0000755 FormatStyle::LK_Cpp,
756 /*Delimiters=*/
757 {
758 "cc",
759 "CC",
760 "cpp",
761 "Cpp",
762 "CPP",
763 "c++",
764 "C++",
765 },
766 /*EnclosingFunctionNames=*/
767 {},
768 /*CanonicalDelimiter=*/"",
769 /*BasedOnStyle=*/"google",
Krasimir Georgiev4527f132018-01-17 12:24:59 +0000770 },
Krasimir Georgiev5559cc32018-04-25 14:56:19 +0000771 {
772 FormatStyle::LK_TextProto,
773 /*Delimiters=*/
774 {
775 "pb",
776 "PB",
777 "proto",
778 "PROTO",
779 },
780 /*EnclosingFunctionNames=*/
Krasimir Georgiev42948e32018-06-26 12:00:14 +0000781 {
Krasimir Georgiev42948e32018-06-26 12:00:14 +0000782 "EqualsProto",
Krasimir Georgiev61f46f22018-06-29 14:25:25 +0000783 "EquivToProto",
Krasimir Georgievce0b8d62018-08-01 12:35:23 +0000784 "PARSE_PARTIAL_TEXT_PROTO",
Krasimir Georgiev61f46f22018-06-29 14:25:25 +0000785 "PARSE_TEST_PROTO",
786 "PARSE_TEXT_PROTO",
787 "ParseTextOrDie",
Krasimir Georgievce0b8d62018-08-01 12:35:23 +0000788 "ParseTextProtoOrDie",
Krasimir Georgiev42948e32018-06-26 12:00:14 +0000789 },
Krasimir Georgiev5559cc32018-04-25 14:56:19 +0000790 /*CanonicalDelimiter=*/"",
791 /*BasedOnStyle=*/"google",
792 },
793 };
Alexander Kornienkoc8602662013-05-06 14:11:27 +0000794 GoogleStyle.SpacesBeforeTrailingComments = 2;
795 GoogleStyle.Standard = FormatStyle::LS_Auto;
Daniel Jasper4e9678f2013-07-11 20:41:21 +0000796
Daniel Jasper4e9678f2013-07-11 20:41:21 +0000797 GoogleStyle.PenaltyReturnTypeOnItsOwnLine = 200;
Daniel Jasper33b909c2013-10-25 14:29:37 +0000798 GoogleStyle.PenaltyBreakBeforeFirstCallParameter = 1;
Daniel Jasper4e9678f2013-07-11 20:41:21 +0000799
Daniel Jasperc58c70e2014-09-15 11:21:46 +0000800 if (Language == FormatStyle::LK_Java) {
Daniel Jasper6501f7e2015-10-27 12:38:37 +0000801 GoogleStyle.AlignAfterOpenBracket = FormatStyle::BAS_DontAlign;
Daniel Jasper3219e432014-12-02 13:24:51 +0000802 GoogleStyle.AlignOperands = false;
Daniel Jasperfd4ed182015-01-04 20:40:45 +0000803 GoogleStyle.AlignTrailingComments = false;
Daniel Jasper9e709352014-11-26 10:43:58 +0000804 GoogleStyle.AllowShortFunctionsOnASingleLine = FormatStyle::SFS_Empty;
Daniel Jasperfd4ed182015-01-04 20:40:45 +0000805 GoogleStyle.AllowShortIfStatementsOnASingleLine = false;
Daniel Jasper1cd3c712015-01-14 12:24:59 +0000806 GoogleStyle.AlwaysBreakBeforeMultilineStrings = false;
Daniel Jasperc58c70e2014-09-15 11:21:46 +0000807 GoogleStyle.BreakBeforeBinaryOperators = FormatStyle::BOS_NonAssignment;
808 GoogleStyle.ColumnLimit = 100;
809 GoogleStyle.SpaceAfterCStyleCast = true;
Daniel Jasper61d81972014-11-14 08:22:46 +0000810 GoogleStyle.SpacesBeforeTrailingComments = 1;
Daniel Jasperc58c70e2014-09-15 11:21:46 +0000811 } else if (Language == FormatStyle::LK_JavaScript) {
Daniel Jasper6501f7e2015-10-27 12:38:37 +0000812 GoogleStyle.AlignAfterOpenBracket = FormatStyle::BAS_AlwaysBreak;
Daniel Jasper41a2bf72015-12-21 13:52:19 +0000813 GoogleStyle.AlignOperands = false;
Daniel Jasper28d8a5a2016-09-07 23:01:13 +0000814 GoogleStyle.AllowShortFunctionsOnASingleLine = FormatStyle::SFS_Empty;
Daniel Jasper6501f7e2015-10-27 12:38:37 +0000815 GoogleStyle.AlwaysBreakBeforeMultilineStrings = false;
Daniel Jaspere551bb72014-11-05 17:22:31 +0000816 GoogleStyle.BreakBeforeTernaryOperators = false;
Krasimir Georgiev6a5c95b2018-07-30 08:45:45 +0000817 // taze:, triple slash directives (`/// <...`), @see, which is commonly
818 // followed by overlong URLs.
819 GoogleStyle.CommentPragmas = "(taze:|^/[ \t]*<|@see)";
Daniel Jasper8f83a902014-05-09 10:28:58 +0000820 GoogleStyle.MaxEmptyLinesToKeep = 3;
Martin Probstece8c0c2016-06-13 16:41:28 +0000821 GoogleStyle.NamespaceIndentation = FormatStyle::NI_All;
Nico Weber514ecc82014-02-02 20:50:45 +0000822 GoogleStyle.SpacesInContainerLiterals = false;
Daniel Jasperabd1f572016-03-02 22:44:03 +0000823 GoogleStyle.JavaScriptQuotes = FormatStyle::JSQS_Single;
Martin Probst0cd74ee2016-06-13 16:39:50 +0000824 GoogleStyle.JavaScriptWrapImports = false;
Nico Weber514ecc82014-02-02 20:50:45 +0000825 } else if (Language == FormatStyle::LK_Proto) {
Daniel Jasper67e65212018-08-15 19:07:55 +0000826 GoogleStyle.AllowShortFunctionsOnASingleLine = FormatStyle::SFS_Empty;
Daniel Jasper9c95dfe2018-03-12 10:32:18 +0000827 GoogleStyle.AlwaysBreakBeforeMultilineStrings = false;
Daniel Jasper783bac62014-04-15 09:54:30 +0000828 GoogleStyle.SpacesInContainerLiterals = false;
Krasimir Georgievc2091802018-01-31 10:14:10 +0000829 GoogleStyle.Cpp11BracedListStyle = false;
Krasimir Georgiev374e6de2018-02-08 10:47:12 +0000830 // This affects protocol buffer options specifications and text protos.
831 // Text protos are currently mostly formatted inside C++ raw string literals
832 // and often the current breaking behavior of string literals is not
833 // beneficial there. Investigate turning this on once proper string reflow
834 // has been implemented.
835 GoogleStyle.BreakStringLiterals = false;
Daniel Jasper03a04fe2016-12-12 12:42:29 +0000836 } else if (Language == FormatStyle::LK_ObjC) {
Ben Hamilton1ab722e2018-06-14 17:30:10 +0000837 GoogleStyle.AlwaysBreakBeforeMultilineStrings = false;
Daniel Jasper03a04fe2016-12-12 12:42:29 +0000838 GoogleStyle.ColumnLimit = 100;
Nico Weber514ecc82014-02-02 20:50:45 +0000839 }
840
Daniel Jasperf7935112012-12-03 18:12:45 +0000841 return GoogleStyle;
842}
843
Nico Weber514ecc82014-02-02 20:50:45 +0000844FormatStyle getChromiumStyle(FormatStyle::LanguageKind Language) {
845 FormatStyle ChromiumStyle = getGoogleStyle(Language);
Nico Weber450425c2014-11-26 16:43:18 +0000846 if (Language == FormatStyle::LK_Java) {
Daniel Jasperfd4ed182015-01-04 20:40:45 +0000847 ChromiumStyle.AllowShortIfStatementsOnASingleLine = true;
Nico Weber2cd92f12015-10-15 16:03:01 +0000848 ChromiumStyle.BreakAfterJavaFieldAnnotations = true;
Nico Weber450425c2014-11-26 16:43:18 +0000849 ChromiumStyle.ContinuationIndentWidth = 8;
Nico Weber2cd92f12015-10-15 16:03:01 +0000850 ChromiumStyle.IndentWidth = 4;
Krasimir Georgiev7e91b032018-10-05 17:19:26 +0000851 // See styleguide for import groups:
852 // https://chromium.googlesource.com/chromium/src/+/master/styleguide/java/java.md#Import-Order
853 ChromiumStyle.JavaImportGroups = {
854 "android",
855 "com",
856 "dalvik",
857 "junit",
858 "org",
859 "com.google.android.apps.chrome",
860 "org.chromium",
861 "java",
862 "javax",
863 };
864 ChromiumStyle.SortIncludes = true;
Nico Weberea649692017-01-04 02:33:36 +0000865 } else if (Language == FormatStyle::LK_JavaScript) {
866 ChromiumStyle.AllowShortIfStatementsOnASingleLine = false;
867 ChromiumStyle.AllowShortLoopsOnASingleLine = false;
Nico Weber450425c2014-11-26 16:43:18 +0000868 } else {
869 ChromiumStyle.AllowAllParametersOfDeclarationOnNextLine = false;
870 ChromiumStyle.AllowShortFunctionsOnASingleLine = FormatStyle::SFS_Inline;
871 ChromiumStyle.AllowShortIfStatementsOnASingleLine = false;
872 ChromiumStyle.AllowShortLoopsOnASingleLine = false;
873 ChromiumStyle.BinPackParameters = false;
874 ChromiumStyle.DerivePointerAlignment = false;
Nico Weber9e2bc302017-01-31 18:42:05 +0000875 if (Language == FormatStyle::LK_ObjC)
876 ChromiumStyle.ColumnLimit = 80;
Nico Weber450425c2014-11-26 16:43:18 +0000877 }
Daniel Jasper1b750ed2013-01-14 16:24:39 +0000878 return ChromiumStyle;
879}
880
Alexander Kornienkoc8602662013-05-06 14:11:27 +0000881FormatStyle getMozillaStyle() {
882 FormatStyle MozillaStyle = getLLVMStyle();
883 MozillaStyle.AllowAllParametersOfDeclarationOnNextLine = false;
Birunthan Mohanathasa0810022015-06-29 15:18:58 +0000884 MozillaStyle.AllowShortFunctionsOnASingleLine = FormatStyle::SFS_Inline;
Manuel Klimek89628f62017-09-20 09:51:03 +0000885 MozillaStyle.AlwaysBreakAfterReturnType = FormatStyle::RTBS_TopLevel;
Birunthan Mohanathasa0388a82015-06-29 15:30:42 +0000886 MozillaStyle.AlwaysBreakAfterDefinitionReturnType =
887 FormatStyle::DRTBS_TopLevel;
Francois Ferrand58e6fe52018-05-16 08:25:03 +0000888 MozillaStyle.AlwaysBreakTemplateDeclarations = FormatStyle::BTDS_Yes;
Sylvestre Ledrudcb038d2016-12-14 16:09:29 +0000889 MozillaStyle.BinPackParameters = false;
890 MozillaStyle.BinPackArguments = false;
Birunthan Mohanathas305fa9c2015-07-12 03:13:54 +0000891 MozillaStyle.BreakBeforeBraces = FormatStyle::BS_Mozilla;
Francois Ferranda6b6d512017-05-24 11:36:58 +0000892 MozillaStyle.BreakConstructorInitializers = FormatStyle::BCIS_BeforeComma;
Francois Ferrand6bb103f2018-06-11 14:41:26 +0000893 MozillaStyle.BreakInheritanceList = FormatStyle::BILS_BeforeComma;
Birunthan Mohanathasa0810022015-06-29 15:18:58 +0000894 MozillaStyle.ConstructorInitializerIndentWidth = 2;
895 MozillaStyle.ContinuationIndentWidth = 2;
Chandler Carruthf8b72662014-03-02 12:37:31 +0000896 MozillaStyle.Cpp11BracedListStyle = false;
Krasimir Georgiev32eaa862017-03-01 15:35:39 +0000897 MozillaStyle.FixNamespaceComments = false;
Alexander Kornienkoc8602662013-05-06 14:11:27 +0000898 MozillaStyle.IndentCaseLabels = true;
Daniel Jaspere9beea22014-01-28 15:20:33 +0000899 MozillaStyle.ObjCSpaceAfterProperty = true;
Alexander Kornienkoc8602662013-05-06 14:11:27 +0000900 MozillaStyle.ObjCSpaceBeforeProtocolList = false;
901 MozillaStyle.PenaltyReturnTypeOnItsOwnLine = 200;
Daniel Jasper553d4872014-06-17 12:40:34 +0000902 MozillaStyle.PointerAlignment = FormatStyle::PAS_Left;
Sylvestre Ledru83bbd572016-08-09 14:24:40 +0000903 MozillaStyle.SpaceAfterTemplateKeyword = false;
Alexander Kornienkoc8602662013-05-06 14:11:27 +0000904 return MozillaStyle;
905}
906
Daniel Jasperffefb3d2013-07-24 13:10:59 +0000907FormatStyle getWebKitStyle() {
908 FormatStyle Style = getLLVMStyle();
Daniel Jasper65ee3472013-07-31 23:16:02 +0000909 Style.AccessModifierOffset = -4;
Daniel Jasper6501f7e2015-10-27 12:38:37 +0000910 Style.AlignAfterOpenBracket = FormatStyle::BAS_DontAlign;
Daniel Jasper3219e432014-12-02 13:24:51 +0000911 Style.AlignOperands = false;
Daniel Jasper552f4a72013-07-31 23:55:15 +0000912 Style.AlignTrailingComments = false;
Daniel Jasperac043c92014-09-15 11:11:00 +0000913 Style.BreakBeforeBinaryOperators = FormatStyle::BOS_All;
Roman Kashitsyn291f64f2015-08-10 13:43:19 +0000914 Style.BreakBeforeBraces = FormatStyle::BS_WebKit;
Francois Ferranda6b6d512017-05-24 11:36:58 +0000915 Style.BreakConstructorInitializers = FormatStyle::BCIS_BeforeComma;
Chandler Carruthf8b72662014-03-02 12:37:31 +0000916 Style.Cpp11BracedListStyle = false;
Daniel Jasper65ee3472013-07-31 23:16:02 +0000917 Style.ColumnLimit = 0;
Krasimir Georgiev32eaa862017-03-01 15:35:39 +0000918 Style.FixNamespaceComments = false;
Daniel Jaspere33d4af2013-07-26 16:56:36 +0000919 Style.IndentWidth = 4;
Daniel Jasper65ee3472013-07-31 23:16:02 +0000920 Style.NamespaceIndentation = FormatStyle::NI_Inner;
Daniel Jasper50d634b2014-10-28 16:53:38 +0000921 Style.ObjCBlockIndentWidth = 4;
Daniel Jaspere9beea22014-01-28 15:20:33 +0000922 Style.ObjCSpaceAfterProperty = true;
Daniel Jasper553d4872014-06-17 12:40:34 +0000923 Style.PointerAlignment = FormatStyle::PAS_Left;
Hans Wennborgbfc34062018-06-14 08:01:09 +0000924 Style.SpaceBeforeCpp11BracedList = true;
Daniel Jasperffefb3d2013-07-24 13:10:59 +0000925 return Style;
926}
927
Alexander Kornienkofe7a57f2013-12-10 15:42:15 +0000928FormatStyle getGNUStyle() {
929 FormatStyle Style = getLLVMStyle();
Birunthan Mohanathasa0388a82015-06-29 15:30:42 +0000930 Style.AlwaysBreakAfterDefinitionReturnType = FormatStyle::DRTBS_All;
Zachary Turner448592e2015-12-18 22:20:15 +0000931 Style.AlwaysBreakAfterReturnType = FormatStyle::RTBS_AllDefinitions;
Daniel Jasperac043c92014-09-15 11:11:00 +0000932 Style.BreakBeforeBinaryOperators = FormatStyle::BOS_All;
Alexander Kornienko3a33f022013-12-12 09:49:52 +0000933 Style.BreakBeforeBraces = FormatStyle::BS_GNU;
Alexander Kornienkofe7a57f2013-12-10 15:42:15 +0000934 Style.BreakBeforeTernaryOperators = true;
Chandler Carruthf8b72662014-03-02 12:37:31 +0000935 Style.Cpp11BracedListStyle = false;
Alexander Kornienkofe7a57f2013-12-10 15:42:15 +0000936 Style.ColumnLimit = 79;
Krasimir Georgiev32eaa862017-03-01 15:35:39 +0000937 Style.FixNamespaceComments = false;
Alexander Kornienkofe7a57f2013-12-10 15:42:15 +0000938 Style.SpaceBeforeParens = FormatStyle::SBPO_Always;
Chandler Carruthf8b72662014-03-02 12:37:31 +0000939 Style.Standard = FormatStyle::LS_Cpp03;
Alexander Kornienkofe7a57f2013-12-10 15:42:15 +0000940 return Style;
941}
942
Daniel Jasperc64b09a2014-05-22 15:12:22 +0000943FormatStyle getNoStyle() {
944 FormatStyle NoStyle = getLLVMStyle();
945 NoStyle.DisableFormat = true;
Daniel Jasperda446772015-11-16 12:38:56 +0000946 NoStyle.SortIncludes = false;
Krasimir Georgievac16a202017-06-23 11:46:03 +0000947 NoStyle.SortUsingDeclarations = false;
Daniel Jasperc64b09a2014-05-22 15:12:22 +0000948 return NoStyle;
949}
950
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000951bool getPredefinedStyle(StringRef Name, FormatStyle::LanguageKind Language,
952 FormatStyle *Style) {
953 if (Name.equals_lower("llvm")) {
Alexander Kornienko006b5c82013-05-19 00:53:30 +0000954 *Style = getLLVMStyle();
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000955 } else if (Name.equals_lower("chromium")) {
Nico Weber514ecc82014-02-02 20:50:45 +0000956 *Style = getChromiumStyle(Language);
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000957 } else if (Name.equals_lower("mozilla")) {
Alexander Kornienko006b5c82013-05-19 00:53:30 +0000958 *Style = getMozillaStyle();
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000959 } else if (Name.equals_lower("google")) {
Nico Weber514ecc82014-02-02 20:50:45 +0000960 *Style = getGoogleStyle(Language);
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000961 } else if (Name.equals_lower("webkit")) {
Daniel Jasperffefb3d2013-07-24 13:10:59 +0000962 *Style = getWebKitStyle();
Alexander Kornienkofe7a57f2013-12-10 15:42:15 +0000963 } else if (Name.equals_lower("gnu")) {
964 *Style = getGNUStyle();
Daniel Jasperc64b09a2014-05-22 15:12:22 +0000965 } else if (Name.equals_lower("none")) {
966 *Style = getNoStyle();
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000967 } else {
Alexander Kornienko006b5c82013-05-19 00:53:30 +0000968 return false;
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000969 }
Alexander Kornienkod6538332013-05-07 15:32:14 +0000970
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000971 Style->Language = Language;
Alexander Kornienko006b5c82013-05-19 00:53:30 +0000972 return true;
Alexander Kornienkod6538332013-05-07 15:32:14 +0000973}
974
Rafael Espindolac0809172014-06-12 14:02:15 +0000975std::error_code parseConfiguration(StringRef Text, FormatStyle *Style) {
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000976 assert(Style);
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000977 FormatStyle::LanguageKind Language = Style->Language;
978 assert(Language != FormatStyle::LK_None);
Alexander Kornienko06e00332013-05-20 15:18:01 +0000979 if (Text.trim().empty())
Rafael Espindolad0136702014-06-12 02:50:04 +0000980 return make_error_code(ParseError::Error);
Krasimir Georgiev54076fe2018-01-15 12:06:16 +0000981 Style->StyleSet.Clear();
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000982 std::vector<FormatStyle> Styles;
Alexander Kornienkod6538332013-05-07 15:32:14 +0000983 llvm::yaml::Input Input(Text);
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000984 // DocumentListTraits<vector<FormatStyle>> uses the context to get default
985 // values for the fields, keys for which are missing from the configuration.
986 // Mapping also uses the context to get the language to find the correct
987 // base style.
988 Input.setContext(Style);
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000989 Input >> Styles;
990 if (Input.error())
991 return Input.error();
992
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000993 for (unsigned i = 0; i < Styles.size(); ++i) {
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000994 // Ensures that only the first configuration can skip the Language option.
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000995 if (Styles[i].Language == FormatStyle::LK_None && i != 0)
Rafael Espindolad0136702014-06-12 02:50:04 +0000996 return make_error_code(ParseError::Error);
Alexander Kornienkocabdd732013-11-29 15:19:43 +0000997 // Ensure that each language is configured at most once.
Alexander Kornienkoc1637f12013-12-10 11:28:13 +0000998 for (unsigned j = 0; j < i; ++j) {
999 if (Styles[i].Language == Styles[j].Language) {
Nicola Zaghen3538b392018-05-15 13:30:56 +00001000 LLVM_DEBUG(llvm::dbgs()
1001 << "Duplicate languages in the config file on positions "
1002 << j << " and " << i << "\n");
Rafael Espindolad0136702014-06-12 02:50:04 +00001003 return make_error_code(ParseError::Error);
Alexander Kornienkoc1637f12013-12-10 11:28:13 +00001004 }
Alexander Kornienkocabdd732013-11-29 15:19:43 +00001005 }
1006 }
1007 // Look for a suitable configuration starting from the end, so we can
1008 // find the configuration for the specific language first, and the default
Alexander Kornienkoc1637f12013-12-10 11:28:13 +00001009 // configuration (which can only be at slot 0) after it.
Krasimir Georgiev54076fe2018-01-15 12:06:16 +00001010 FormatStyle::FormatStyleSet StyleSet;
1011 bool LanguageFound = false;
Alexander Kornienkoc1637f12013-12-10 11:28:13 +00001012 for (int i = Styles.size() - 1; i >= 0; --i) {
Krasimir Georgiev54076fe2018-01-15 12:06:16 +00001013 if (Styles[i].Language != FormatStyle::LK_None)
1014 StyleSet.Add(Styles[i]);
1015 if (Styles[i].Language == Language)
1016 LanguageFound = true;
Alexander Kornienkocabdd732013-11-29 15:19:43 +00001017 }
Krasimir Georgiev54076fe2018-01-15 12:06:16 +00001018 if (!LanguageFound) {
1019 if (Styles.empty() || Styles[0].Language != FormatStyle::LK_None)
1020 return make_error_code(ParseError::Unsuitable);
1021 FormatStyle DefaultStyle = Styles[0];
1022 DefaultStyle.Language = Language;
1023 StyleSet.Add(std::move(DefaultStyle));
1024 }
1025 *Style = *StyleSet.Get(Language);
1026 return make_error_code(ParseError::Success);
Alexander Kornienkod6538332013-05-07 15:32:14 +00001027}
1028
1029std::string configurationAsText(const FormatStyle &Style) {
1030 std::string Text;
1031 llvm::raw_string_ostream Stream(Text);
1032 llvm::yaml::Output Output(Stream);
1033 // We use the same mapping method for input and output, so we need a non-const
1034 // reference here.
Daniel Jasperc1bc38e2015-09-29 14:57:55 +00001035 FormatStyle NonConstStyle = expandPresets(Style);
Alexander Kornienkod6538332013-05-07 15:32:14 +00001036 Output << NonConstStyle;
Alexander Kornienko9a38ec22013-05-13 12:56:35 +00001037 return Stream.str();
Alexander Kornienkod6538332013-05-07 15:32:14 +00001038}
1039
Krasimir Georgiev54076fe2018-01-15 12:06:16 +00001040llvm::Optional<FormatStyle>
1041FormatStyle::FormatStyleSet::Get(FormatStyle::LanguageKind Language) const {
1042 if (!Styles)
1043 return None;
1044 auto It = Styles->find(Language);
1045 if (It == Styles->end())
1046 return None;
1047 FormatStyle Style = It->second;
1048 Style.StyleSet = *this;
1049 return Style;
1050}
1051
1052void FormatStyle::FormatStyleSet::Add(FormatStyle Style) {
1053 assert(Style.Language != LK_None &&
1054 "Cannot add a style for LK_None to a StyleSet");
1055 assert(
1056 !Style.StyleSet.Styles &&
1057 "Cannot add a style associated with an existing StyleSet to a StyleSet");
1058 if (!Styles)
1059 Styles = std::make_shared<MapType>();
1060 (*Styles)[Style.Language] = std::move(Style);
1061}
1062
1063void FormatStyle::FormatStyleSet::Clear() {
1064 Styles.reset();
1065}
1066
1067llvm::Optional<FormatStyle>
1068FormatStyle::GetLanguageStyle(FormatStyle::LanguageKind Language) const {
1069 return StyleSet.Get(Language);
1070}
1071
Craig Topperaf35e852013-06-30 22:29:28 +00001072namespace {
1073
Daniel Jasper496c1992016-09-07 22:48:53 +00001074class JavaScriptRequoter : public TokenAnalyzer {
Eric Liu4cfb88a2016-04-25 15:09:22 +00001075public:
Daniel Jasper496c1992016-09-07 22:48:53 +00001076 JavaScriptRequoter(const Environment &Env, const FormatStyle &Style)
1077 : TokenAnalyzer(Env, Style) {}
Eric Liu4cfb88a2016-04-25 15:09:22 +00001078
Krasimir Georgiev9ad83fe2017-10-30 14:01:50 +00001079 std::pair<tooling::Replacements, unsigned>
Eric Liu4cfb88a2016-04-25 15:09:22 +00001080 analyze(TokenAnnotator &Annotator,
1081 SmallVectorImpl<AnnotatedLine *> &AnnotatedLines,
Martin Probsta9855af2016-09-02 14:29:48 +00001082 FormatTokenLexer &Tokens) override {
Manuel Klimek0dddcf72018-04-23 09:34:26 +00001083 AffectedRangeMgr.computeAffectedLines(AnnotatedLines);
Daniel Jasper496c1992016-09-07 22:48:53 +00001084 tooling::Replacements Result;
1085 requoteJSStringLiteral(AnnotatedLines, Result);
Krasimir Georgiev9ad83fe2017-10-30 14:01:50 +00001086 return {Result, 0};
Alexander Kornienko62b85b92013-03-13 14:41:29 +00001087 }
1088
1089private:
Daniel Jasper496c1992016-09-07 22:48:53 +00001090 // Replaces double/single-quoted string literal as appropriate, re-escaping
1091 // the contents in the process.
Daniel Jasper97439922016-03-17 13:03:41 +00001092 void requoteJSStringLiteral(SmallVectorImpl<AnnotatedLine *> &Lines,
Eric Liu4cfb88a2016-04-25 15:09:22 +00001093 tooling::Replacements &Result) {
Daniel Jasper97439922016-03-17 13:03:41 +00001094 for (AnnotatedLine *Line : Lines) {
1095 requoteJSStringLiteral(Line->Children, Result);
1096 if (!Line->Affected)
1097 continue;
1098 for (FormatToken *FormatTok = Line->First; FormatTok;
1099 FormatTok = FormatTok->Next) {
1100 StringRef Input = FormatTok->TokenText;
Martin Probsta1669792016-05-12 11:20:32 +00001101 if (FormatTok->Finalized || !FormatTok->isStringLiteral() ||
Daniel Jasper97439922016-03-17 13:03:41 +00001102 // NB: testing for not starting with a double quote to avoid
Daniel Jasper496c1992016-09-07 22:48:53 +00001103 // breaking `template strings`.
Eric Liu635423e2016-04-28 07:52:03 +00001104 (Style.JavaScriptQuotes == FormatStyle::JSQS_Single &&
Daniel Jasper97439922016-03-17 13:03:41 +00001105 !Input.startswith("\"")) ||
Eric Liu635423e2016-04-28 07:52:03 +00001106 (Style.JavaScriptQuotes == FormatStyle::JSQS_Double &&
Daniel Jasper97439922016-03-17 13:03:41 +00001107 !Input.startswith("\'")))
1108 continue;
1109
1110 // Change start and end quote.
Eric Liu635423e2016-04-28 07:52:03 +00001111 bool IsSingle = Style.JavaScriptQuotes == FormatStyle::JSQS_Single;
Daniel Jasper97439922016-03-17 13:03:41 +00001112 SourceLocation Start = FormatTok->Tok.getLocation();
1113 auto Replace = [&](SourceLocation Start, unsigned Length,
1114 StringRef ReplacementText) {
Eric Liu40ef2fb2016-08-01 10:16:37 +00001115 auto Err = Result.add(tooling::Replacement(
1116 Env.getSourceManager(), Start, Length, ReplacementText));
1117 // FIXME: handle error. For now, print error message and skip the
1118 // replacement for release version.
Piotr Padlewski1ec383c2016-12-23 11:40:44 +00001119 if (Err) {
Eric Liu40ef2fb2016-08-01 10:16:37 +00001120 llvm::errs() << llvm::toString(std::move(Err)) << "\n";
Piotr Padlewski1ec383c2016-12-23 11:40:44 +00001121 assert(false);
1122 }
Daniel Jasper97439922016-03-17 13:03:41 +00001123 };
1124 Replace(Start, 1, IsSingle ? "'" : "\"");
1125 Replace(FormatTok->Tok.getEndLoc().getLocWithOffset(-1), 1,
1126 IsSingle ? "'" : "\"");
1127
1128 // Escape internal quotes.
Daniel Jasper97439922016-03-17 13:03:41 +00001129 bool Escaped = false;
1130 for (size_t i = 1; i < Input.size() - 1; i++) {
1131 switch (Input[i]) {
Eric Liu4cfb88a2016-04-25 15:09:22 +00001132 case '\\':
1133 if (!Escaped && i + 1 < Input.size() &&
1134 ((IsSingle && Input[i + 1] == '"') ||
1135 (!IsSingle && Input[i + 1] == '\''))) {
1136 // Remove this \, it's escaping a " or ' that no longer needs
1137 // escaping
Eric Liu4cfb88a2016-04-25 15:09:22 +00001138 Replace(Start.getLocWithOffset(i), 1, "");
1139 continue;
1140 }
1141 Escaped = !Escaped;
1142 break;
1143 case '\"':
1144 case '\'':
1145 if (!Escaped && IsSingle == (Input[i] == '\'')) {
1146 // Escape the quote.
1147 Replace(Start.getLocWithOffset(i), 0, "\\");
Eric Liu4cfb88a2016-04-25 15:09:22 +00001148 }
1149 Escaped = false;
1150 break;
1151 default:
1152 Escaped = false;
1153 break;
Daniel Jasper97439922016-03-17 13:03:41 +00001154 }
1155 }
Daniel Jasper97439922016-03-17 13:03:41 +00001156 }
1157 }
1158 }
Daniel Jasper496c1992016-09-07 22:48:53 +00001159};
1160
1161class Formatter : public TokenAnalyzer {
1162public:
1163 Formatter(const Environment &Env, const FormatStyle &Style,
Krasimir Georgievbcda54b2017-04-21 14:35:20 +00001164 FormattingAttemptStatus *Status)
1165 : TokenAnalyzer(Env, Style), Status(Status) {}
Daniel Jasper496c1992016-09-07 22:48:53 +00001166
Krasimir Georgiev9ad83fe2017-10-30 14:01:50 +00001167 std::pair<tooling::Replacements, unsigned>
Daniel Jasper496c1992016-09-07 22:48:53 +00001168 analyze(TokenAnnotator &Annotator,
1169 SmallVectorImpl<AnnotatedLine *> &AnnotatedLines,
1170 FormatTokenLexer &Tokens) override {
1171 tooling::Replacements Result;
1172 deriveLocalStyle(AnnotatedLines);
Manuel Klimek0dddcf72018-04-23 09:34:26 +00001173 AffectedRangeMgr.computeAffectedLines(AnnotatedLines);
Daniel Jasper496c1992016-09-07 22:48:53 +00001174 for (unsigned i = 0, e = AnnotatedLines.size(); i != e; ++i) {
1175 Annotator.calculateFormattingInformation(*AnnotatedLines[i]);
1176 }
1177 Annotator.setCommentLineLevels(AnnotatedLines);
1178
1179 WhitespaceManager Whitespaces(
1180 Env.getSourceManager(), Style,
1181 inputUsesCRLF(Env.getSourceManager().getBufferData(Env.getFileID())));
1182 ContinuationIndenter Indenter(Style, Tokens.getKeywords(),
1183 Env.getSourceManager(), Whitespaces, Encoding,
1184 BinPackInconclusiveFunctions);
Krasimir Georgiev9ad83fe2017-10-30 14:01:50 +00001185 unsigned Penalty =
1186 UnwrappedLineFormatter(&Indenter, &Whitespaces, Style,
1187 Tokens.getKeywords(), Env.getSourceManager(),
1188 Status)
1189 .format(AnnotatedLines, /*DryRun=*/false,
1190 /*AdditionalIndent=*/0,
1191 /*FixBadIndentation=*/false,
1192 /*FirstStartColumn=*/Env.getFirstStartColumn(),
1193 /*NextStartColumn=*/Env.getNextStartColumn(),
1194 /*LastStartColumn=*/Env.getLastStartColumn());
Daniel Jasper496c1992016-09-07 22:48:53 +00001195 for (const auto &R : Whitespaces.generateReplacements())
1196 if (Result.add(R))
Krasimir Georgieve56e9a42017-10-30 14:30:14 +00001197 return std::make_pair(Result, 0);
1198 return std::make_pair(Result, Penalty);
Daniel Jasper496c1992016-09-07 22:48:53 +00001199 }
1200
1201private:
Alexander Kornienko9e649af2013-09-11 12:25:57 +00001202 static bool inputUsesCRLF(StringRef Text) {
1203 return Text.count('\r') * 2 > Text.count('\n');
1204 }
1205
Daniel Jasper352f0df2015-07-18 16:35:30 +00001206 bool
1207 hasCpp03IncompatibleFormat(const SmallVectorImpl<AnnotatedLine *> &Lines) {
Eric Liu4cfb88a2016-04-25 15:09:22 +00001208 for (const AnnotatedLine *Line : Lines) {
Daniel Jasper352f0df2015-07-18 16:35:30 +00001209 if (hasCpp03IncompatibleFormat(Line->Children))
1210 return true;
1211 for (FormatToken *Tok = Line->First->Next; Tok; Tok = Tok->Next) {
1212 if (Tok->WhitespaceRange.getBegin() == Tok->WhitespaceRange.getEnd()) {
1213 if (Tok->is(tok::coloncolon) && Tok->Previous->is(TT_TemplateOpener))
1214 return true;
1215 if (Tok->is(TT_TemplateCloser) &&
1216 Tok->Previous->is(TT_TemplateCloser))
1217 return true;
1218 }
1219 }
1220 }
1221 return false;
1222 }
1223
1224 int countVariableAlignments(const SmallVectorImpl<AnnotatedLine *> &Lines) {
1225 int AlignmentDiff = 0;
Eric Liu4cfb88a2016-04-25 15:09:22 +00001226 for (const AnnotatedLine *Line : Lines) {
Daniel Jasper352f0df2015-07-18 16:35:30 +00001227 AlignmentDiff += countVariableAlignments(Line->Children);
1228 for (FormatToken *Tok = Line->First; Tok && Tok->Next; Tok = Tok->Next) {
1229 if (!Tok->is(TT_PointerOrReference))
1230 continue;
1231 bool SpaceBefore =
1232 Tok->WhitespaceRange.getBegin() != Tok->WhitespaceRange.getEnd();
1233 bool SpaceAfter = Tok->Next->WhitespaceRange.getBegin() !=
1234 Tok->Next->WhitespaceRange.getEnd();
1235 if (SpaceBefore && !SpaceAfter)
1236 ++AlignmentDiff;
1237 if (!SpaceBefore && SpaceAfter)
1238 --AlignmentDiff;
1239 }
1240 }
1241 return AlignmentDiff;
1242 }
1243
Manuel Klimek71814b42013-10-11 21:25:45 +00001244 void
1245 deriveLocalStyle(const SmallVectorImpl<AnnotatedLine *> &AnnotatedLines) {
Daniel Jasperb10cbc42013-07-10 14:02:49 +00001246 bool HasBinPackedFunction = false;
1247 bool HasOnePerLineFunction = false;
Daniel Jasper7fce3ab2013-02-06 14:22:40 +00001248 for (unsigned i = 0, e = AnnotatedLines.size(); i != e; ++i) {
Daniel Jasper9fe0e8d2013-09-05 09:29:45 +00001249 if (!AnnotatedLines[i]->First->Next)
Daniel Jasper7fce3ab2013-02-06 14:22:40 +00001250 continue;
Daniel Jasper9fe0e8d2013-09-05 09:29:45 +00001251 FormatToken *Tok = AnnotatedLines[i]->First->Next;
Manuel Klimek6e6310e2013-05-29 14:47:47 +00001252 while (Tok->Next) {
Daniel Jasperb10cbc42013-07-10 14:02:49 +00001253 if (Tok->PackingKind == PPK_BinPacked)
1254 HasBinPackedFunction = true;
1255 if (Tok->PackingKind == PPK_OnePerLine)
1256 HasOnePerLineFunction = true;
1257
Manuel Klimek6e6310e2013-05-29 14:47:47 +00001258 Tok = Tok->Next;
Daniel Jasper7fce3ab2013-02-06 14:22:40 +00001259 }
1260 }
Eric Liu635423e2016-04-28 07:52:03 +00001261 if (Style.DerivePointerAlignment)
1262 Style.PointerAlignment = countVariableAlignments(AnnotatedLines) <= 0
1263 ? FormatStyle::PAS_Left
1264 : FormatStyle::PAS_Right;
1265 if (Style.Standard == FormatStyle::LS_Auto)
1266 Style.Standard = hasCpp03IncompatibleFormat(AnnotatedLines)
1267 ? FormatStyle::LS_Cpp11
1268 : FormatStyle::LS_Cpp03;
Daniel Jasperb10cbc42013-07-10 14:02:49 +00001269 BinPackInconclusiveFunctions =
1270 HasBinPackedFunction || !HasOnePerLineFunction;
Daniel Jasper7fce3ab2013-02-06 14:22:40 +00001271 }
1272
Daniel Jasperb10cbc42013-07-10 14:02:49 +00001273 bool BinPackInconclusiveFunctions;
Krasimir Georgievbcda54b2017-04-21 14:35:20 +00001274 FormattingAttemptStatus *Status;
Eric Liu4cfb88a2016-04-25 15:09:22 +00001275};
1276
1277// This class clean up the erroneous/redundant code around the given ranges in
1278// file.
1279class Cleaner : public TokenAnalyzer {
1280public:
Eric Liu635423e2016-04-28 07:52:03 +00001281 Cleaner(const Environment &Env, const FormatStyle &Style)
1282 : TokenAnalyzer(Env, Style),
Eric Liu4cfb88a2016-04-25 15:09:22 +00001283 DeletedTokens(FormatTokenLess(Env.getSourceManager())) {}
1284
1285 // FIXME: eliminate unused parameters.
Krasimir Georgiev9ad83fe2017-10-30 14:01:50 +00001286 std::pair<tooling::Replacements, unsigned>
Eric Liu4cfb88a2016-04-25 15:09:22 +00001287 analyze(TokenAnnotator &Annotator,
1288 SmallVectorImpl<AnnotatedLine *> &AnnotatedLines,
Martin Probsta9855af2016-09-02 14:29:48 +00001289 FormatTokenLexer &Tokens) override {
Eric Liu4cfb88a2016-04-25 15:09:22 +00001290 // FIXME: in the current implementation the granularity of affected range
1291 // is an annotated line. However, this is not sufficient. Furthermore,
1292 // redundant code introduced by replacements does not necessarily
1293 // intercept with ranges of replacements that result in the redundancy.
1294 // To determine if some redundant code is actually introduced by
1295 // replacements(e.g. deletions), we need to come up with a more
1296 // sophisticated way of computing affected ranges.
Manuel Klimek0dddcf72018-04-23 09:34:26 +00001297 AffectedRangeMgr.computeAffectedLines(AnnotatedLines);
Eric Liu4cfb88a2016-04-25 15:09:22 +00001298
1299 checkEmptyNamespace(AnnotatedLines);
1300
Eric Liuce5e4bc2016-05-18 08:02:56 +00001301 for (auto &Line : AnnotatedLines) {
1302 if (Line->Affected) {
1303 cleanupRight(Line->First, tok::comma, tok::comma);
1304 cleanupRight(Line->First, TT_CtorInitializerColon, tok::comma);
Eric Liu2574d152016-09-13 15:02:43 +00001305 cleanupRight(Line->First, tok::l_paren, tok::comma);
1306 cleanupLeft(Line->First, tok::comma, tok::r_paren);
Eric Liuce5e4bc2016-05-18 08:02:56 +00001307 cleanupLeft(Line->First, TT_CtorInitializerComma, tok::l_brace);
1308 cleanupLeft(Line->First, TT_CtorInitializerColon, tok::l_brace);
Malcolm Parsons5d8cdb82016-10-20 14:58:45 +00001309 cleanupLeft(Line->First, TT_CtorInitializerColon, tok::equal);
Eric Liuce5e4bc2016-05-18 08:02:56 +00001310 }
1311 }
1312
Krasimir Georgiev9ad83fe2017-10-30 14:01:50 +00001313 return {generateFixes(), 0};
Eric Liu4cfb88a2016-04-25 15:09:22 +00001314 }
1315
1316private:
1317 bool containsOnlyComments(const AnnotatedLine &Line) {
1318 for (FormatToken *Tok = Line.First; Tok != nullptr; Tok = Tok->Next) {
1319 if (Tok->isNot(tok::comment))
1320 return false;
1321 }
1322 return true;
1323 }
1324
1325 // Iterate through all lines and remove any empty (nested) namespaces.
1326 void checkEmptyNamespace(SmallVectorImpl<AnnotatedLine *> &AnnotatedLines) {
Eric Liu7956c402016-10-05 15:49:01 +00001327 std::set<unsigned> DeletedLines;
Eric Liu4cfb88a2016-04-25 15:09:22 +00001328 for (unsigned i = 0, e = AnnotatedLines.size(); i != e; ++i) {
1329 auto &Line = *AnnotatedLines[i];
Sam McCall6f3778c2018-09-05 07:44:02 +00001330 if (Line.startsWithNamespace()) {
Eric Liu7956c402016-10-05 15:49:01 +00001331 checkEmptyNamespace(AnnotatedLines, i, i, DeletedLines);
Eric Liu4cfb88a2016-04-25 15:09:22 +00001332 }
1333 }
1334
1335 for (auto Line : DeletedLines) {
1336 FormatToken *Tok = AnnotatedLines[Line]->First;
1337 while (Tok) {
1338 deleteToken(Tok);
1339 Tok = Tok->Next;
1340 }
1341 }
1342 }
1343
1344 // The function checks if the namespace, which starts from \p CurrentLine, and
1345 // its nested namespaces are empty and delete them if they are empty. It also
1346 // sets \p NewLine to the last line checked.
1347 // Returns true if the current namespace is empty.
1348 bool checkEmptyNamespace(SmallVectorImpl<AnnotatedLine *> &AnnotatedLines,
Eric Liu7956c402016-10-05 15:49:01 +00001349 unsigned CurrentLine, unsigned &NewLine,
1350 std::set<unsigned> &DeletedLines) {
Eric Liu4cfb88a2016-04-25 15:09:22 +00001351 unsigned InitLine = CurrentLine, End = AnnotatedLines.size();
Eric Liu635423e2016-04-28 07:52:03 +00001352 if (Style.BraceWrapping.AfterNamespace) {
Eric Liu4cfb88a2016-04-25 15:09:22 +00001353 // If the left brace is in a new line, we should consume it first so that
1354 // it does not make the namespace non-empty.
1355 // FIXME: error handling if there is no left brace.
1356 if (!AnnotatedLines[++CurrentLine]->startsWith(tok::l_brace)) {
1357 NewLine = CurrentLine;
1358 return false;
1359 }
1360 } else if (!AnnotatedLines[CurrentLine]->endsWith(tok::l_brace)) {
1361 return false;
1362 }
1363 while (++CurrentLine < End) {
1364 if (AnnotatedLines[CurrentLine]->startsWith(tok::r_brace))
1365 break;
1366
Sam McCall6f3778c2018-09-05 07:44:02 +00001367 if (AnnotatedLines[CurrentLine]->startsWithNamespace()) {
Eric Liu7956c402016-10-05 15:49:01 +00001368 if (!checkEmptyNamespace(AnnotatedLines, CurrentLine, NewLine,
1369 DeletedLines))
Eric Liu4cfb88a2016-04-25 15:09:22 +00001370 return false;
1371 CurrentLine = NewLine;
1372 continue;
1373 }
1374
1375 if (containsOnlyComments(*AnnotatedLines[CurrentLine]))
1376 continue;
1377
1378 // If there is anything other than comments or nested namespaces in the
1379 // current namespace, the namespace cannot be empty.
1380 NewLine = CurrentLine;
1381 return false;
1382 }
1383
1384 NewLine = CurrentLine;
1385 if (CurrentLine >= End)
1386 return false;
1387
1388 // Check if the empty namespace is actually affected by changed ranges.
1389 if (!AffectedRangeMgr.affectsCharSourceRange(CharSourceRange::getCharRange(
1390 AnnotatedLines[InitLine]->First->Tok.getLocation(),
1391 AnnotatedLines[CurrentLine]->Last->Tok.getEndLoc())))
1392 return false;
1393
1394 for (unsigned i = InitLine; i <= CurrentLine; ++i) {
1395 DeletedLines.insert(i);
1396 }
1397
1398 return true;
1399 }
1400
Eric Liuce5e4bc2016-05-18 08:02:56 +00001401 // Checks pairs {start, start->next},..., {end->previous, end} and deletes one
1402 // of the token in the pair if the left token has \p LK token kind and the
1403 // right token has \p RK token kind. If \p DeleteLeft is true, the left token
1404 // is deleted on match; otherwise, the right token is deleted.
1405 template <typename LeftKind, typename RightKind>
1406 void cleanupPair(FormatToken *Start, LeftKind LK, RightKind RK,
1407 bool DeleteLeft) {
1408 auto NextNotDeleted = [this](const FormatToken &Tok) -> FormatToken * {
1409 for (auto *Res = Tok.Next; Res; Res = Res->Next)
1410 if (!Res->is(tok::comment) &&
1411 DeletedTokens.find(Res) == DeletedTokens.end())
1412 return Res;
1413 return nullptr;
1414 };
1415 for (auto *Left = Start; Left;) {
1416 auto *Right = NextNotDeleted(*Left);
1417 if (!Right)
1418 break;
1419 if (Left->is(LK) && Right->is(RK)) {
1420 deleteToken(DeleteLeft ? Left : Right);
Eric Liu01426ff2016-09-09 17:50:49 +00001421 for (auto *Tok = Left->Next; Tok && Tok != Right; Tok = Tok->Next)
1422 deleteToken(Tok);
Eric Liuce5e4bc2016-05-18 08:02:56 +00001423 // If the right token is deleted, we should keep the left token
1424 // unchanged and pair it with the new right token.
1425 if (!DeleteLeft)
1426 continue;
1427 }
1428 Left = Right;
1429 }
1430 }
1431
1432 template <typename LeftKind, typename RightKind>
1433 void cleanupLeft(FormatToken *Start, LeftKind LK, RightKind RK) {
1434 cleanupPair(Start, LK, RK, /*DeleteLeft=*/true);
1435 }
1436
1437 template <typename LeftKind, typename RightKind>
1438 void cleanupRight(FormatToken *Start, LeftKind LK, RightKind RK) {
1439 cleanupPair(Start, LK, RK, /*DeleteLeft=*/false);
1440 }
1441
Eric Liu4cfb88a2016-04-25 15:09:22 +00001442 // Delete the given token.
1443 inline void deleteToken(FormatToken *Tok) {
1444 if (Tok)
1445 DeletedTokens.insert(Tok);
1446 }
1447
1448 tooling::Replacements generateFixes() {
1449 tooling::Replacements Fixes;
1450 std::vector<FormatToken *> Tokens;
1451 std::copy(DeletedTokens.begin(), DeletedTokens.end(),
1452 std::back_inserter(Tokens));
1453
1454 // Merge multiple continuous token deletions into one big deletion so that
1455 // the number of replacements can be reduced. This makes computing affected
1456 // ranges more efficient when we run reformat on the changed code.
1457 unsigned Idx = 0;
1458 while (Idx < Tokens.size()) {
1459 unsigned St = Idx, End = Idx;
1460 while ((End + 1) < Tokens.size() &&
1461 Tokens[End]->Next == Tokens[End + 1]) {
1462 End++;
1463 }
1464 auto SR = CharSourceRange::getCharRange(Tokens[St]->Tok.getLocation(),
1465 Tokens[End]->Tok.getEndLoc());
Eric Liu40ef2fb2016-08-01 10:16:37 +00001466 auto Err =
1467 Fixes.add(tooling::Replacement(Env.getSourceManager(), SR, ""));
1468 // FIXME: better error handling. for now just print error message and skip
1469 // for the release version.
Piotr Padlewski1ec383c2016-12-23 11:40:44 +00001470 if (Err) {
Eric Liu40ef2fb2016-08-01 10:16:37 +00001471 llvm::errs() << llvm::toString(std::move(Err)) << "\n";
Piotr Padlewski1ec383c2016-12-23 11:40:44 +00001472 assert(false && "Fixes must not conflict!");
1473 }
Eric Liu4cfb88a2016-04-25 15:09:22 +00001474 Idx = End + 1;
1475 }
1476
1477 return Fixes;
1478 }
1479
1480 // Class for less-than inequality comparason for the set `RedundantTokens`.
1481 // We store tokens in the order they appear in the translation unit so that
1482 // we do not need to sort them in `generateFixes()`.
1483 struct FormatTokenLess {
Eric Liu635423e2016-04-28 07:52:03 +00001484 FormatTokenLess(const SourceManager &SM) : SM(SM) {}
Eric Liu4cfb88a2016-04-25 15:09:22 +00001485
Eric Liu2874ac32016-05-18 08:14:49 +00001486 bool operator()(const FormatToken *LHS, const FormatToken *RHS) const {
Eric Liu4cfb88a2016-04-25 15:09:22 +00001487 return SM.isBeforeInTranslationUnit(LHS->Tok.getLocation(),
1488 RHS->Tok.getLocation());
1489 }
Eric Liu635423e2016-04-28 07:52:03 +00001490 const SourceManager &SM;
Eric Liu4cfb88a2016-04-25 15:09:22 +00001491 };
1492
1493 // Tokens to be deleted.
1494 std::set<FormatToken *, FormatTokenLess> DeletedTokens;
Daniel Jasperf7935112012-12-03 18:12:45 +00001495};
1496
Ben Hamiltone2e3e672018-01-17 17:33:08 +00001497class ObjCHeaderStyleGuesser : public TokenAnalyzer {
1498public:
1499 ObjCHeaderStyleGuesser(const Environment &Env, const FormatStyle &Style)
1500 : TokenAnalyzer(Env, Style), IsObjC(false) {}
1501
1502 std::pair<tooling::Replacements, unsigned>
1503 analyze(TokenAnnotator &Annotator,
1504 SmallVectorImpl<AnnotatedLine *> &AnnotatedLines,
1505 FormatTokenLexer &Tokens) override {
1506 assert(Style.Language == FormatStyle::LK_Cpp);
Ben Hamilton0675e872018-11-05 16:59:33 +00001507 IsObjC = guessIsObjC(Env.getSourceManager(), AnnotatedLines,
1508 Tokens.getKeywords());
Ben Hamiltone2e3e672018-01-17 17:33:08 +00001509 tooling::Replacements Result;
1510 return {Result, 0};
1511 }
1512
1513 bool isObjC() { return IsObjC; }
1514
1515private:
Ben Hamilton0675e872018-11-05 16:59:33 +00001516 static bool
1517 guessIsObjC(const SourceManager &SourceManager,
1518 const SmallVectorImpl<AnnotatedLine *> &AnnotatedLines,
1519 const AdditionalKeywords &Keywords) {
Krasimir Georgiev8e216782018-01-17 20:01:02 +00001520 // Keep this array sorted, since we are binary searching over it.
1521 static constexpr llvm::StringLiteral FoundationIdentifiers[] = {
Ben Hamiltone2e3e672018-01-17 17:33:08 +00001522 "CGFloat",
Ben Hamilton19c782d2018-03-22 03:25:22 +00001523 "CGPoint",
1524 "CGPointMake",
1525 "CGPointZero",
1526 "CGRect",
1527 "CGRectEdge",
1528 "CGRectInfinite",
1529 "CGRectMake",
1530 "CGRectNull",
1531 "CGRectZero",
1532 "CGSize",
1533 "CGSizeMake",
1534 "CGVector",
1535 "CGVectorMake",
Ben Hamiltone2e3e672018-01-17 17:33:08 +00001536 "NSAffineTransform",
1537 "NSArray",
1538 "NSAttributedString",
Ben Hamiltonb1a79192018-04-12 15:11:53 +00001539 "NSBlockOperation",
Jacek Olesiakce4f0af2018-02-15 08:47:56 +00001540 "NSBundle",
Ben Hamiltone2e3e672018-01-17 17:33:08 +00001541 "NSCache",
Jacek Olesiakce4f0af2018-02-15 08:47:56 +00001542 "NSCalendar",
Ben Hamiltone2e3e672018-01-17 17:33:08 +00001543 "NSCharacterSet",
1544 "NSCountedSet",
1545 "NSData",
1546 "NSDataDetector",
1547 "NSDecimal",
1548 "NSDecimalNumber",
1549 "NSDictionary",
1550 "NSEdgeInsets",
1551 "NSHashTable",
1552 "NSIndexPath",
1553 "NSIndexSet",
1554 "NSInteger",
Ben Hamiltonb1a79192018-04-12 15:11:53 +00001555 "NSInvocationOperation",
Ben Hamiltone2e3e672018-01-17 17:33:08 +00001556 "NSLocale",
1557 "NSMapTable",
1558 "NSMutableArray",
1559 "NSMutableAttributedString",
1560 "NSMutableCharacterSet",
1561 "NSMutableData",
1562 "NSMutableDictionary",
1563 "NSMutableIndexSet",
1564 "NSMutableOrderedSet",
1565 "NSMutableSet",
1566 "NSMutableString",
1567 "NSNumber",
1568 "NSNumberFormatter",
Jacek Olesiakce4f0af2018-02-15 08:47:56 +00001569 "NSObject",
Ben Hamiltonb1a79192018-04-12 15:11:53 +00001570 "NSOperation",
1571 "NSOperationQueue",
1572 "NSOperationQueuePriority",
Ben Hamiltone2e3e672018-01-17 17:33:08 +00001573 "NSOrderedSet",
1574 "NSPoint",
1575 "NSPointerArray",
Ben Hamiltonb1a79192018-04-12 15:11:53 +00001576 "NSQualityOfService",
Ben Hamiltone2e3e672018-01-17 17:33:08 +00001577 "NSRange",
1578 "NSRect",
1579 "NSRegularExpression",
1580 "NSSet",
1581 "NSSize",
1582 "NSString",
Jacek Olesiakce4f0af2018-02-15 08:47:56 +00001583 "NSTimeZone",
Ben Hamiltone2e3e672018-01-17 17:33:08 +00001584 "NSUInteger",
1585 "NSURL",
1586 "NSURLComponents",
1587 "NSURLQueryItem",
1588 "NSUUID",
Jacek Olesiakce4f0af2018-02-15 08:47:56 +00001589 "NSValue",
Ben Hamilton19c782d2018-03-22 03:25:22 +00001590 "UIImage",
1591 "UIView",
Ben Hamiltone2e3e672018-01-17 17:33:08 +00001592 };
1593
Ben Hamiltonea7a27b2018-03-27 15:01:21 +00001594 for (auto Line : AnnotatedLines) {
1595 for (const FormatToken *FormatTok = Line->First; FormatTok;
Ben Hamiltone2e3e672018-01-17 17:33:08 +00001596 FormatTok = FormatTok->Next) {
Jacek Olesiakce4f0af2018-02-15 08:47:56 +00001597 if ((FormatTok->Previous && FormatTok->Previous->is(tok::at) &&
Ben Hamiltonb1a79192018-04-12 15:11:53 +00001598 (FormatTok->Tok.getObjCKeywordID() != tok::objc_not_keyword ||
Ben Hamiltone2e3e672018-01-17 17:33:08 +00001599 FormatTok->isOneOf(tok::numeric_constant, tok::l_square,
1600 tok::l_brace))) ||
1601 (FormatTok->Tok.isAnyIdentifier() &&
Krasimir Georgiev8e216782018-01-17 20:01:02 +00001602 std::binary_search(std::begin(FoundationIdentifiers),
1603 std::end(FoundationIdentifiers),
1604 FormatTok->TokenText)) ||
Ben Hamiltone2e3e672018-01-17 17:33:08 +00001605 FormatTok->is(TT_ObjCStringLiteral) ||
1606 FormatTok->isOneOf(Keywords.kw_NS_ENUM, Keywords.kw_NS_OPTIONS,
1607 TT_ObjCBlockLBrace, TT_ObjCBlockLParen,
1608 TT_ObjCDecl, TT_ObjCForIn, TT_ObjCMethodExpr,
1609 TT_ObjCMethodSpecifier, TT_ObjCProperty)) {
Ben Hamilton0675e872018-11-05 16:59:33 +00001610 LLVM_DEBUG(llvm::dbgs()
1611 << "Detected ObjC at location "
1612 << FormatTok->Tok.getLocation().printToString(
1613 SourceManager)
1614 << " token: " << FormatTok->TokenText << " token type: "
1615 << getTokenTypeName(FormatTok->Type) << "\n");
Ben Hamiltone2e3e672018-01-17 17:33:08 +00001616 return true;
1617 }
Ben Hamilton0675e872018-11-05 16:59:33 +00001618 if (guessIsObjC(SourceManager, Line->Children, Keywords))
Ben Hamilton6432afe2018-03-22 17:37:19 +00001619 return true;
1620 }
Ben Hamiltone2e3e672018-01-17 17:33:08 +00001621 }
1622 return false;
1623 }
1624
1625 bool IsObjC;
1626};
1627
Daniel Jasperd89ae9d2015-09-23 08:30:47 +00001628struct IncludeDirective {
1629 StringRef Filename;
1630 StringRef Text;
1631 unsigned Offset;
Daniel Jasperd2629dc2015-12-16 10:10:16 +00001632 int Category;
Daniel Jasperd89ae9d2015-09-23 08:30:47 +00001633};
1634
Krasimir Georgiev7e91b032018-10-05 17:19:26 +00001635struct JavaImportDirective {
1636 StringRef Identifier;
1637 StringRef Text;
1638 unsigned Offset;
1639 std::vector<StringRef> AssociatedCommentLines;
1640 bool IsStatic;
1641};
1642
Craig Topperaf35e852013-06-30 22:29:28 +00001643} // end anonymous namespace
1644
Daniel Jasperd89ae9d2015-09-23 08:30:47 +00001645// Determines whether 'Ranges' intersects with ('Start', 'End').
1646static bool affectsRange(ArrayRef<tooling::Range> Ranges, unsigned Start,
1647 unsigned End) {
1648 for (auto Range : Ranges) {
1649 if (Range.getOffset() < End &&
1650 Range.getOffset() + Range.getLength() > Start)
1651 return true;
1652 }
1653 return false;
1654}
1655
Eric Liua992afe2016-08-10 09:32:23 +00001656// Returns a pair (Index, OffsetToEOL) describing the position of the cursor
1657// before sorting/deduplicating. Index is the index of the include under the
1658// cursor in the original set of includes. If this include has duplicates, it is
1659// the index of the first of the duplicates as the others are going to be
1660// removed. OffsetToEOL describes the cursor's position relative to the end of
1661// its current line.
1662// If `Cursor` is not on any #include, `Index` will be UINT_MAX.
1663static std::pair<unsigned, unsigned>
1664FindCursorIndex(const SmallVectorImpl<IncludeDirective> &Includes,
1665 const SmallVectorImpl<unsigned> &Indices, unsigned Cursor) {
1666 unsigned CursorIndex = UINT_MAX;
1667 unsigned OffsetToEOL = 0;
1668 for (int i = 0, e = Includes.size(); i != e; ++i) {
1669 unsigned Start = Includes[Indices[i]].Offset;
1670 unsigned End = Start + Includes[Indices[i]].Text.size();
1671 if (!(Cursor >= Start && Cursor < End))
1672 continue;
1673 CursorIndex = Indices[i];
1674 OffsetToEOL = End - Cursor;
1675 // Put the cursor on the only remaining #include among the duplicate
1676 // #includes.
1677 while (--i >= 0 && Includes[CursorIndex].Text == Includes[Indices[i]].Text)
1678 CursorIndex = i;
1679 break;
1680 }
1681 return std::make_pair(CursorIndex, OffsetToEOL);
1682}
1683
1684// Sorts and deduplicate a block of includes given by 'Includes' alphabetically
1685// adding the necessary replacement to 'Replaces'. 'Includes' must be in strict
1686// source order.
1687// #include directives with the same text will be deduplicated, and only the
1688// first #include in the duplicate #includes remains. If the `Cursor` is
1689// provided and put on a deleted #include, it will be moved to the remaining
1690// #include in the duplicate #includes.
Martin Probstc4a0dd42016-05-20 11:24:24 +00001691static void sortCppIncludes(const FormatStyle &Style,
Eric Liua992afe2016-08-10 09:32:23 +00001692 const SmallVectorImpl<IncludeDirective> &Includes,
1693 ArrayRef<tooling::Range> Ranges, StringRef FileName,
1694 tooling::Replacements &Replaces, unsigned *Cursor) {
1695 unsigned IncludesBeginOffset = Includes.front().Offset;
Daniel Jasperd6a00782016-08-30 21:33:41 +00001696 unsigned IncludesEndOffset =
1697 Includes.back().Offset + Includes.back().Text.size();
1698 unsigned IncludesBlockSize = IncludesEndOffset - IncludesBeginOffset;
1699 if (!affectsRange(Ranges, IncludesBeginOffset, IncludesEndOffset))
Daniel Jasperd89ae9d2015-09-23 08:30:47 +00001700 return;
1701 SmallVector<unsigned, 16> Indices;
1702 for (unsigned i = 0, e = Includes.size(); i != e; ++i)
1703 Indices.push_back(i);
Daniel Jasper94a96fc2016-03-03 17:34:14 +00001704 std::stable_sort(
1705 Indices.begin(), Indices.end(), [&](unsigned LHSI, unsigned RHSI) {
1706 return std::tie(Includes[LHSI].Category, Includes[LHSI].Filename) <
1707 std::tie(Includes[RHSI].Category, Includes[RHSI].Filename);
1708 });
Eric Liua992afe2016-08-10 09:32:23 +00001709 // The index of the include on which the cursor will be put after
1710 // sorting/deduplicating.
1711 unsigned CursorIndex;
1712 // The offset from cursor to the end of line.
1713 unsigned CursorToEOLOffset;
1714 if (Cursor)
1715 std::tie(CursorIndex, CursorToEOLOffset) =
1716 FindCursorIndex(Includes, Indices, *Cursor);
1717
1718 // Deduplicate #includes.
1719 Indices.erase(std::unique(Indices.begin(), Indices.end(),
1720 [&](unsigned LHSI, unsigned RHSI) {
1721 return Includes[LHSI].Text == Includes[RHSI].Text;
1722 }),
1723 Indices.end());
Daniel Jasperd89ae9d2015-09-23 08:30:47 +00001724
Krasimir Georgiev4c2c9c32017-11-27 13:23:45 +00001725 int CurrentCategory = Includes.front().Category;
1726
Daniel Jasperd89ae9d2015-09-23 08:30:47 +00001727 // If the #includes are out of order, we generate a single replacement fixing
1728 // the entire block. Otherwise, no replacement is generated.
Eric Liua992afe2016-08-10 09:32:23 +00001729 if (Indices.size() == Includes.size() &&
Krasimir Georgiev4c2c9c32017-11-27 13:23:45 +00001730 std::is_sorted(Indices.begin(), Indices.end()) &&
Eric Liu9d92c022018-05-14 19:51:33 +00001731 Style.IncludeStyle.IncludeBlocks == tooling::IncludeStyle::IBS_Preserve)
Daniel Jasperd89ae9d2015-09-23 08:30:47 +00001732 return;
1733
Daniel Jasperb68aabf2015-11-23 08:36:35 +00001734 std::string result;
Daniel Jasperb68aabf2015-11-23 08:36:35 +00001735 for (unsigned Index : Indices) {
Krasimir Georgiev4c2c9c32017-11-27 13:23:45 +00001736 if (!result.empty()) {
Daniel Jasperb68aabf2015-11-23 08:36:35 +00001737 result += "\n";
Eric Liu9d92c022018-05-14 19:51:33 +00001738 if (Style.IncludeStyle.IncludeBlocks ==
1739 tooling::IncludeStyle::IBS_Regroup &&
Krasimir Georgiev4c2c9c32017-11-27 13:23:45 +00001740 CurrentCategory != Includes[Index].Category)
1741 result += "\n";
1742 }
Daniel Jasperb68aabf2015-11-23 08:36:35 +00001743 result += Includes[Index].Text;
Eric Liua992afe2016-08-10 09:32:23 +00001744 if (Cursor && CursorIndex == Index)
1745 *Cursor = IncludesBeginOffset + result.size() - CursorToEOLOffset;
Krasimir Georgiev4c2c9c32017-11-27 13:23:45 +00001746 CurrentCategory = Includes[Index].Category;
Daniel Jasperd89ae9d2015-09-23 08:30:47 +00001747 }
1748
Eric Liu40ef2fb2016-08-01 10:16:37 +00001749 auto Err = Replaces.add(tooling::Replacement(
Eric Liua992afe2016-08-10 09:32:23 +00001750 FileName, Includes.front().Offset, IncludesBlockSize, result));
Eric Liu40ef2fb2016-08-01 10:16:37 +00001751 // FIXME: better error handling. For now, just skip the replacement for the
1752 // release version.
Piotr Padlewski1ec383c2016-12-23 11:40:44 +00001753 if (Err) {
Eric Liu40ef2fb2016-08-01 10:16:37 +00001754 llvm::errs() << llvm::toString(std::move(Err)) << "\n";
Piotr Padlewski1ec383c2016-12-23 11:40:44 +00001755 assert(false);
1756 }
Daniel Jasperd89ae9d2015-09-23 08:30:47 +00001757}
1758
Eric Liu659afd52016-05-31 13:34:20 +00001759namespace {
1760
Krasimir Georgiev7e91b032018-10-05 17:19:26 +00001761const char CppIncludeRegexPattern[] =
Eric Liu659afd52016-05-31 13:34:20 +00001762 R"(^[\t\ ]*#[\t\ ]*(import|include)[^"<]*(["<][^">]*[">]))";
1763
1764} // anonymous namespace
1765
Martin Probstc4a0dd42016-05-20 11:24:24 +00001766tooling::Replacements sortCppIncludes(const FormatStyle &Style, StringRef Code,
1767 ArrayRef<tooling::Range> Ranges,
1768 StringRef FileName,
1769 tooling::Replacements &Replaces,
1770 unsigned *Cursor) {
Daniel Jasperd89ae9d2015-09-23 08:30:47 +00001771 unsigned Prev = 0;
1772 unsigned SearchFrom = 0;
Krasimir Georgiev7e91b032018-10-05 17:19:26 +00001773 llvm::Regex IncludeRegex(CppIncludeRegexPattern);
Daniel Jasperd89ae9d2015-09-23 08:30:47 +00001774 SmallVector<StringRef, 4> Matches;
1775 SmallVector<IncludeDirective, 16> IncludesInBlock;
Daniel Jasper85c472d2015-09-29 07:53:08 +00001776
1777 // In compiled files, consider the first #include to be the main #include of
1778 // the file if it is not a system #include. This ensures that the header
1779 // doesn't have hidden dependencies
1780 // (http://llvm.org/docs/CodingStandards.html#include-style).
1781 //
1782 // FIXME: Do some sanity checking, e.g. edit distance of the base name, to fix
1783 // cases where the first #include is unlikely to be the main header.
Eric Liu7129e632018-05-14 20:17:53 +00001784 tooling::IncludeCategoryManager Categories(Style.IncludeStyle, FileName);
Daniel Jasper32d75fa2015-12-21 13:40:49 +00001785 bool FirstIncludeBlock = true;
Daniel Jaspera252f5d2015-12-21 17:28:24 +00001786 bool MainIncludeFound = false;
Daniel Jasper9b8c7c72015-11-21 09:17:08 +00001787 bool FormattingOff = false;
1788
Daniel Jasperd89ae9d2015-09-23 08:30:47 +00001789 for (;;) {
1790 auto Pos = Code.find('\n', SearchFrom);
1791 StringRef Line =
1792 Code.substr(Prev, (Pos != StringRef::npos ? Pos : Code.size()) - Prev);
Daniel Jasper9b8c7c72015-11-21 09:17:08 +00001793
1794 StringRef Trimmed = Line.trim();
1795 if (Trimmed == "// clang-format off")
1796 FormattingOff = true;
1797 else if (Trimmed == "// clang-format on")
1798 FormattingOff = false;
1799
Krasimir Georgiev4c2c9c32017-11-27 13:23:45 +00001800 const bool EmptyLineSkipped =
Eric Liu9d92c022018-05-14 19:51:33 +00001801 Trimmed.empty() &&
1802 (Style.IncludeStyle.IncludeBlocks == tooling::IncludeStyle::IBS_Merge ||
1803 Style.IncludeStyle.IncludeBlocks ==
1804 tooling::IncludeStyle::IBS_Regroup);
Krasimir Georgiev4c2c9c32017-11-27 13:23:45 +00001805
Daniel Jasper9b8c7c72015-11-21 09:17:08 +00001806 if (!FormattingOff && !Line.endswith("\\")) {
Daniel Jasperd89ae9d2015-09-23 08:30:47 +00001807 if (IncludeRegex.match(Line, &Matches)) {
Nico Weberff063702015-10-21 17:13:45 +00001808 StringRef IncludeName = Matches[2];
Eric Liu659afd52016-05-31 13:34:20 +00001809 int Category = Categories.getIncludePriority(
1810 IncludeName,
1811 /*CheckMainHeader=*/!MainIncludeFound && FirstIncludeBlock);
1812 if (Category == 0)
1813 MainIncludeFound = true;
Nico Weberff063702015-10-21 17:13:45 +00001814 IncludesInBlock.push_back({IncludeName, Line, Prev, Category});
Krasimir Georgiev4c2c9c32017-11-27 13:23:45 +00001815 } else if (!IncludesInBlock.empty() && !EmptyLineSkipped) {
Martin Probstc4a0dd42016-05-20 11:24:24 +00001816 sortCppIncludes(Style, IncludesInBlock, Ranges, FileName, Replaces,
1817 Cursor);
Daniel Jasperd89ae9d2015-09-23 08:30:47 +00001818 IncludesInBlock.clear();
Daniel Jasper32d75fa2015-12-21 13:40:49 +00001819 FirstIncludeBlock = false;
Daniel Jasperd89ae9d2015-09-23 08:30:47 +00001820 }
1821 Prev = Pos + 1;
1822 }
1823 if (Pos == StringRef::npos || Pos + 1 == Code.size())
1824 break;
1825 SearchFrom = Pos + 1;
1826 }
1827 if (!IncludesInBlock.empty())
Martin Probstc4a0dd42016-05-20 11:24:24 +00001828 sortCppIncludes(Style, IncludesInBlock, Ranges, FileName, Replaces, Cursor);
1829 return Replaces;
1830}
1831
Krasimir Georgiev7e91b032018-10-05 17:19:26 +00001832// Returns group number to use as a first order sort on imports. Gives UINT_MAX
1833// if the import does not match any given groups.
1834static unsigned findJavaImportGroup(const FormatStyle &Style,
1835 StringRef ImportIdentifier) {
1836 unsigned LongestMatchIndex = UINT_MAX;
1837 unsigned LongestMatchLength = 0;
1838 for (unsigned I = 0; I < Style.JavaImportGroups.size(); I++) {
1839 std::string GroupPrefix = Style.JavaImportGroups[I];
1840 if (ImportIdentifier.startswith(GroupPrefix) &&
1841 GroupPrefix.length() > LongestMatchLength) {
1842 LongestMatchIndex = I;
1843 LongestMatchLength = GroupPrefix.length();
1844 }
1845 }
1846 return LongestMatchIndex;
1847}
1848
1849// Sorts and deduplicates a block of includes given by 'Imports' based on
1850// JavaImportGroups, then adding the necessary replacement to 'Replaces'.
1851// Import declarations with the same text will be deduplicated. Between each
1852// import group, a newline is inserted, and within each import group, a
1853// lexicographic sort based on ASCII value is performed.
1854static void sortJavaImports(const FormatStyle &Style,
1855 const SmallVectorImpl<JavaImportDirective> &Imports,
1856 ArrayRef<tooling::Range> Ranges, StringRef FileName,
1857 tooling::Replacements &Replaces) {
1858 unsigned ImportsBeginOffset = Imports.front().Offset;
1859 unsigned ImportsEndOffset =
1860 Imports.back().Offset + Imports.back().Text.size();
1861 unsigned ImportsBlockSize = ImportsEndOffset - ImportsBeginOffset;
1862 if (!affectsRange(Ranges, ImportsBeginOffset, ImportsEndOffset))
1863 return;
1864 SmallVector<unsigned, 16> Indices;
1865 SmallVector<unsigned, 16> JavaImportGroups;
1866 for (unsigned i = 0, e = Imports.size(); i != e; ++i) {
1867 Indices.push_back(i);
1868 JavaImportGroups.push_back(
1869 findJavaImportGroup(Style, Imports[i].Identifier));
1870 }
1871 llvm::sort(Indices.begin(), Indices.end(), [&](unsigned LHSI, unsigned RHSI) {
1872 // Negating IsStatic to push static imports above non-static imports.
1873 return std::make_tuple(!Imports[LHSI].IsStatic, JavaImportGroups[LHSI],
1874 Imports[LHSI].Identifier) <
1875 std::make_tuple(!Imports[RHSI].IsStatic, JavaImportGroups[RHSI],
1876 Imports[RHSI].Identifier);
1877 });
1878
1879 // Deduplicate imports.
1880 Indices.erase(std::unique(Indices.begin(), Indices.end(),
1881 [&](unsigned LHSI, unsigned RHSI) {
1882 return Imports[LHSI].Text == Imports[RHSI].Text;
1883 }),
1884 Indices.end());
1885
1886 bool CurrentIsStatic = Imports[Indices.front()].IsStatic;
1887 unsigned CurrentImportGroup = JavaImportGroups[Indices.front()];
1888
1889 std::string result;
1890 for (unsigned Index : Indices) {
1891 if (!result.empty()) {
1892 result += "\n";
1893 if (CurrentIsStatic != Imports[Index].IsStatic ||
1894 CurrentImportGroup != JavaImportGroups[Index])
1895 result += "\n";
1896 }
1897 for (StringRef CommentLine : Imports[Index].AssociatedCommentLines) {
1898 result += CommentLine;
1899 result += "\n";
1900 }
1901 result += Imports[Index].Text;
1902 CurrentIsStatic = Imports[Index].IsStatic;
1903 CurrentImportGroup = JavaImportGroups[Index];
1904 }
1905
1906 auto Err = Replaces.add(tooling::Replacement(FileName, Imports.front().Offset,
1907 ImportsBlockSize, result));
1908 // FIXME: better error handling. For now, just skip the replacement for the
1909 // release version.
1910 if (Err) {
1911 llvm::errs() << llvm::toString(std::move(Err)) << "\n";
1912 assert(false);
1913 }
1914}
1915
1916namespace {
1917
1918const char JavaImportRegexPattern[] =
1919 "^[\t ]*import[\t ]*(static[\t ]*)?([^\t ]*)[\t ]*;";
1920
1921} // anonymous namespace
1922
1923tooling::Replacements sortJavaImports(const FormatStyle &Style, StringRef Code,
1924 ArrayRef<tooling::Range> Ranges,
1925 StringRef FileName,
1926 tooling::Replacements &Replaces) {
1927 unsigned Prev = 0;
1928 unsigned SearchFrom = 0;
1929 llvm::Regex ImportRegex(JavaImportRegexPattern);
1930 SmallVector<StringRef, 4> Matches;
1931 SmallVector<JavaImportDirective, 16> ImportsInBlock;
1932 std::vector<StringRef> AssociatedCommentLines;
1933
1934 bool FormattingOff = false;
1935
1936 for (;;) {
1937 auto Pos = Code.find('\n', SearchFrom);
1938 StringRef Line =
1939 Code.substr(Prev, (Pos != StringRef::npos ? Pos : Code.size()) - Prev);
1940
1941 StringRef Trimmed = Line.trim();
1942 if (Trimmed == "// clang-format off")
1943 FormattingOff = true;
1944 else if (Trimmed == "// clang-format on")
1945 FormattingOff = false;
1946
1947 if (ImportRegex.match(Line, &Matches)) {
1948 if (FormattingOff) {
1949 // If at least one import line has formatting turned off, turn off
1950 // formatting entirely.
1951 return Replaces;
1952 }
1953 StringRef Static = Matches[1];
1954 StringRef Identifier = Matches[2];
1955 bool IsStatic = false;
1956 if (Static.contains("static")) {
1957 IsStatic = true;
1958 }
1959 ImportsInBlock.push_back({Identifier, Line, Prev, AssociatedCommentLines, IsStatic});
1960 AssociatedCommentLines.clear();
1961 } else if (Trimmed.size() > 0 && !ImportsInBlock.empty()) {
1962 // Associating comments within the imports with the nearest import below
1963 AssociatedCommentLines.push_back(Line);
1964 }
1965 Prev = Pos + 1;
1966 if (Pos == StringRef::npos || Pos + 1 == Code.size())
1967 break;
1968 SearchFrom = Pos + 1;
1969 }
1970 if (!ImportsInBlock.empty())
1971 sortJavaImports(Style, ImportsInBlock, Ranges, FileName, Replaces);
1972 return Replaces;
1973}
1974
Martin Probstfa37b182017-01-27 09:09:11 +00001975bool isMpegTS(StringRef Code) {
1976 // MPEG transport streams use the ".ts" file extension. clang-format should
1977 // not attempt to format those. MPEG TS' frame format starts with 0x47 every
1978 // 189 bytes - detect that and return.
1979 return Code.size() > 188 && Code[0] == 0x47 && Code[188] == 0x47;
1980}
1981
Manuel Klimek89628f62017-09-20 09:51:03 +00001982bool isLikelyXml(StringRef Code) { return Code.ltrim().startswith("<"); }
Krasimir Georgieva2e7d0d2017-08-29 13:51:38 +00001983
Martin Probstc4a0dd42016-05-20 11:24:24 +00001984tooling::Replacements sortIncludes(const FormatStyle &Style, StringRef Code,
1985 ArrayRef<tooling::Range> Ranges,
1986 StringRef FileName, unsigned *Cursor) {
1987 tooling::Replacements Replaces;
1988 if (!Style.SortIncludes)
1989 return Replaces;
Krasimir Georgiev86873032017-08-29 13:57:31 +00001990 if (isLikelyXml(Code))
1991 return Replaces;
1992 if (Style.Language == FormatStyle::LanguageKind::LK_JavaScript &&
1993 isMpegTS(Code))
Martin Probstfa37b182017-01-27 09:09:11 +00001994 return Replaces;
Martin Probstc4a0dd42016-05-20 11:24:24 +00001995 if (Style.Language == FormatStyle::LanguageKind::LK_JavaScript)
1996 return sortJavaScriptImports(Style, Code, Ranges, FileName);
Krasimir Georgiev7e91b032018-10-05 17:19:26 +00001997 if (Style.Language == FormatStyle::LanguageKind::LK_Java)
1998 return sortJavaImports(Style, Code, Ranges, FileName, Replaces);
Martin Probstc4a0dd42016-05-20 11:24:24 +00001999 sortCppIncludes(Style, Code, Ranges, FileName, Replaces, Cursor);
Daniel Jasperd89ae9d2015-09-23 08:30:47 +00002000 return Replaces;
2001}
2002
Eric Liu4cfb88a2016-04-25 15:09:22 +00002003template <typename T>
Eric Liu4f8d9942016-07-11 13:53:12 +00002004static llvm::Expected<tooling::Replacements>
Eric Liu4cfb88a2016-04-25 15:09:22 +00002005processReplacements(T ProcessFunc, StringRef Code,
2006 const tooling::Replacements &Replaces,
2007 const FormatStyle &Style) {
Manuel Klimekb12e5a52016-03-01 12:37:30 +00002008 if (Replaces.empty())
2009 return tooling::Replacements();
2010
Eric Liu4f8d9942016-07-11 13:53:12 +00002011 auto NewCode = applyAllReplacements(Code, Replaces);
2012 if (!NewCode)
2013 return NewCode.takeError();
Eric Liu40ef2fb2016-08-01 10:16:37 +00002014 std::vector<tooling::Range> ChangedRanges = Replaces.getAffectedRanges();
Manuel Klimekb12e5a52016-03-01 12:37:30 +00002015 StringRef FileName = Replaces.begin()->getFilePath();
Eric Liu4cfb88a2016-04-25 15:09:22 +00002016
Manuel Klimekb12e5a52016-03-01 12:37:30 +00002017 tooling::Replacements FormatReplaces =
Eric Liu4f8d9942016-07-11 13:53:12 +00002018 ProcessFunc(Style, *NewCode, ChangedRanges, FileName);
Manuel Klimekb12e5a52016-03-01 12:37:30 +00002019
Eric Liu40ef2fb2016-08-01 10:16:37 +00002020 return Replaces.merge(FormatReplaces);
Manuel Klimekb12e5a52016-03-01 12:37:30 +00002021}
2022
Eric Liu4f8d9942016-07-11 13:53:12 +00002023llvm::Expected<tooling::Replacements>
2024formatReplacements(StringRef Code, const tooling::Replacements &Replaces,
2025 const FormatStyle &Style) {
Eric Liu4cfb88a2016-04-25 15:09:22 +00002026 // We need to use lambda function here since there are two versions of
Eric Liubaf58c22016-05-18 13:43:48 +00002027 // `sortIncludes`.
2028 auto SortIncludes = [](const FormatStyle &Style, StringRef Code,
2029 std::vector<tooling::Range> Ranges,
2030 StringRef FileName) -> tooling::Replacements {
2031 return sortIncludes(Style, Code, Ranges, FileName);
2032 };
Eric Liu4f8d9942016-07-11 13:53:12 +00002033 auto SortedReplaces =
Eric Liubaf58c22016-05-18 13:43:48 +00002034 processReplacements(SortIncludes, Code, Replaces, Style);
Eric Liu4f8d9942016-07-11 13:53:12 +00002035 if (!SortedReplaces)
2036 return SortedReplaces.takeError();
Eric Liubaf58c22016-05-18 13:43:48 +00002037
2038 // We need to use lambda function here since there are two versions of
Eric Liu4cfb88a2016-04-25 15:09:22 +00002039 // `reformat`.
2040 auto Reformat = [](const FormatStyle &Style, StringRef Code,
2041 std::vector<tooling::Range> Ranges,
2042 StringRef FileName) -> tooling::Replacements {
2043 return reformat(Style, Code, Ranges, FileName);
2044 };
Eric Liu4f8d9942016-07-11 13:53:12 +00002045 return processReplacements(Reformat, Code, *SortedReplaces, Style);
Eric Liu4cfb88a2016-04-25 15:09:22 +00002046}
2047
Eric Liu659afd52016-05-31 13:34:20 +00002048namespace {
2049
2050inline bool isHeaderInsertion(const tooling::Replacement &Replace) {
Eric Liuc0d3a802016-09-23 15:10:56 +00002051 return Replace.getOffset() == UINT_MAX && Replace.getLength() == 0 &&
Krasimir Georgiev7e91b032018-10-05 17:19:26 +00002052 llvm::Regex(CppIncludeRegexPattern)
2053 .match(Replace.getReplacementText());
Eric Liu659afd52016-05-31 13:34:20 +00002054}
2055
Eric Liuc0d3a802016-09-23 15:10:56 +00002056inline bool isHeaderDeletion(const tooling::Replacement &Replace) {
2057 return Replace.getOffset() == UINT_MAX && Replace.getLength() == 1;
2058}
2059
Eric Liu659afd52016-05-31 13:34:20 +00002060// FIXME: insert empty lines between newly created blocks.
2061tooling::Replacements
2062fixCppIncludeInsertions(StringRef Code, const tooling::Replacements &Replaces,
2063 const FormatStyle &Style) {
Daniel Jasper1dbc2102017-03-31 13:30:24 +00002064 if (!Style.isCpp())
Eric Liu659afd52016-05-31 13:34:20 +00002065 return Replaces;
2066
2067 tooling::Replacements HeaderInsertions;
Eric Liuc0d3a802016-09-23 15:10:56 +00002068 std::set<llvm::StringRef> HeadersToDelete;
Eric Liu40ef2fb2016-08-01 10:16:37 +00002069 tooling::Replacements Result;
Eric Liu659afd52016-05-31 13:34:20 +00002070 for (const auto &R : Replaces) {
Eric Liu40ef2fb2016-08-01 10:16:37 +00002071 if (isHeaderInsertion(R)) {
2072 // Replacements from \p Replaces must be conflict-free already, so we can
2073 // simply consume the error.
2074 llvm::consumeError(HeaderInsertions.add(R));
Eric Liuc0d3a802016-09-23 15:10:56 +00002075 } else if (isHeaderDeletion(R)) {
2076 HeadersToDelete.insert(R.getReplacementText());
Eric Liu40ef2fb2016-08-01 10:16:37 +00002077 } else if (R.getOffset() == UINT_MAX) {
Eric Liu659afd52016-05-31 13:34:20 +00002078 llvm::errs() << "Insertions other than header #include insertion are "
2079 "not supported! "
2080 << R.getReplacementText() << "\n";
Eric Liu40ef2fb2016-08-01 10:16:37 +00002081 } else {
2082 llvm::consumeError(Result.add(R));
2083 }
Eric Liu659afd52016-05-31 13:34:20 +00002084 }
Eric Liuc0d3a802016-09-23 15:10:56 +00002085 if (HeaderInsertions.empty() && HeadersToDelete.empty())
Eric Liu659afd52016-05-31 13:34:20 +00002086 return Replaces;
Eric Liu659afd52016-05-31 13:34:20 +00002087
Eric Liu659afd52016-05-31 13:34:20 +00002088
2089 StringRef FileName = Replaces.begin()->getFilePath();
Eric Liu7129e632018-05-14 20:17:53 +00002090 tooling::HeaderIncludes Includes(FileName, Code, Style.IncludeStyle);
Eric Liu659afd52016-05-31 13:34:20 +00002091
Eric Liubf4c41c2018-05-04 17:55:13 +00002092 for (const auto &Header : HeadersToDelete) {
2093 tooling::Replacements Replaces =
Eric Liu7129e632018-05-14 20:17:53 +00002094 Includes.remove(Header.trim("\"<>"), Header.startswith("<"));
Eric Liubf4c41c2018-05-04 17:55:13 +00002095 for (const auto &R : Replaces) {
2096 auto Err = Result.add(R);
2097 if (Err) {
2098 // Ignore the deletion on conflict.
2099 llvm::errs() << "Failed to add header deletion replacement for "
2100 << Header << ": " << llvm::toString(std::move(Err))
2101 << "\n";
Eric Liuc0d3a802016-09-23 15:10:56 +00002102 }
Eric Liu659afd52016-05-31 13:34:20 +00002103 }
Eric Liu659afd52016-05-31 13:34:20 +00002104 }
2105
Krasimir Georgiev7e91b032018-10-05 17:19:26 +00002106 llvm::Regex IncludeRegex = llvm::Regex(CppIncludeRegexPattern);
Eric Liubf4c41c2018-05-04 17:55:13 +00002107 llvm::SmallVector<StringRef, 4> Matches;
Eric Liu659afd52016-05-31 13:34:20 +00002108 for (const auto &R : HeaderInsertions) {
2109 auto IncludeDirective = R.getReplacementText();
2110 bool Matched = IncludeRegex.match(IncludeDirective, &Matches);
2111 assert(Matched && "Header insertion replacement must have replacement text "
2112 "'#include ...'");
Benjamin Kramer1cb7ee12016-05-31 14:14:42 +00002113 (void)Matched;
Eric Liu659afd52016-05-31 13:34:20 +00002114 auto IncludeName = Matches[2];
Eric Liubf4c41c2018-05-04 17:55:13 +00002115 auto Replace =
Eric Liu7129e632018-05-14 20:17:53 +00002116 Includes.insert(IncludeName.trim("\"<>"), IncludeName.startswith("<"));
Eric Liubf4c41c2018-05-04 17:55:13 +00002117 if (Replace) {
2118 auto Err = Result.add(*Replace);
2119 if (Err) {
2120 llvm::consumeError(std::move(Err));
2121 unsigned NewOffset = Result.getShiftedCodePosition(Replace->getOffset());
2122 auto Shifted = tooling::Replacement(FileName, NewOffset, 0,
2123 Replace->getReplacementText());
2124 Result = Result.merge(tooling::Replacements(Shifted));
2125 }
Eric Liu40ef2fb2016-08-01 10:16:37 +00002126 }
Eric Liu659afd52016-05-31 13:34:20 +00002127 }
2128 return Result;
2129}
2130
2131} // anonymous namespace
2132
Eric Liu4f8d9942016-07-11 13:53:12 +00002133llvm::Expected<tooling::Replacements>
Eric Liu4cfb88a2016-04-25 15:09:22 +00002134cleanupAroundReplacements(StringRef Code, const tooling::Replacements &Replaces,
2135 const FormatStyle &Style) {
2136 // We need to use lambda function here since there are two versions of
2137 // `cleanup`.
2138 auto Cleanup = [](const FormatStyle &Style, StringRef Code,
2139 std::vector<tooling::Range> Ranges,
2140 StringRef FileName) -> tooling::Replacements {
2141 return cleanup(Style, Code, Ranges, FileName);
2142 };
Eric Liu659afd52016-05-31 13:34:20 +00002143 // Make header insertion replacements insert new headers into correct blocks.
2144 tooling::Replacements NewReplaces =
2145 fixCppIncludeInsertions(Code, Replaces, Style);
2146 return processReplacements(Cleanup, Code, NewReplaces, Style);
Eric Liu4cfb88a2016-04-25 15:09:22 +00002147}
2148
Krasimir Georgiev9ad83fe2017-10-30 14:01:50 +00002149namespace internal {
2150std::pair<tooling::Replacements, unsigned>
2151reformat(const FormatStyle &Style, StringRef Code,
2152 ArrayRef<tooling::Range> Ranges, unsigned FirstStartColumn,
2153 unsigned NextStartColumn, unsigned LastStartColumn, StringRef FileName,
2154 FormattingAttemptStatus *Status) {
Eric Liu4cfb88a2016-04-25 15:09:22 +00002155 FormatStyle Expanded = expandPresets(Style);
2156 if (Expanded.DisableFormat)
Krasimir Georgiev9ad83fe2017-10-30 14:01:50 +00002157 return {tooling::Replacements(), 0};
Krasimir Georgiev86873032017-08-29 13:57:31 +00002158 if (isLikelyXml(Code))
Krasimir Georgiev9ad83fe2017-10-30 14:01:50 +00002159 return {tooling::Replacements(), 0};
Krasimir Georgiev86873032017-08-29 13:57:31 +00002160 if (Expanded.Language == FormatStyle::LK_JavaScript && isMpegTS(Code))
Krasimir Georgiev9ad83fe2017-10-30 14:01:50 +00002161 return {tooling::Replacements(), 0};
Daniel Jasper496c1992016-09-07 22:48:53 +00002162
Krasimir Georgiev9ad83fe2017-10-30 14:01:50 +00002163 typedef std::function<std::pair<tooling::Replacements, unsigned>(
2164 const Environment &)>
Krasimir Georgievac16a202017-06-23 11:46:03 +00002165 AnalyzerPass;
2166 SmallVector<AnalyzerPass, 4> Passes;
Krasimir Georgiev32eaa862017-03-01 15:35:39 +00002167
Krasimir Georgievac16a202017-06-23 11:46:03 +00002168 if (Style.Language == FormatStyle::LK_Cpp) {
2169 if (Style.FixNamespaceComments)
2170 Passes.emplace_back([&](const Environment &Env) {
2171 return NamespaceEndCommentsFixer(Env, Expanded).process();
2172 });
2173
2174 if (Style.SortUsingDeclarations)
2175 Passes.emplace_back([&](const Environment &Env) {
2176 return UsingDeclarationsSorter(Env, Expanded).process();
2177 });
Krasimir Georgiev32eaa862017-03-01 15:35:39 +00002178 }
2179
2180 if (Style.Language == FormatStyle::LK_JavaScript &&
Krasimir Georgievac16a202017-06-23 11:46:03 +00002181 Style.JavaScriptQuotes != FormatStyle::JSQS_Leave)
2182 Passes.emplace_back([&](const Environment &Env) {
2183 return JavaScriptRequoter(Env, Expanded).process();
2184 });
2185
2186 Passes.emplace_back([&](const Environment &Env) {
2187 return Formatter(Env, Expanded, Status).process();
2188 });
2189
Eric Liu2e538082018-05-09 21:35:52 +00002190 auto Env =
2191 llvm::make_unique<Environment>(Code, FileName, Ranges, FirstStartColumn,
2192 NextStartColumn, LastStartColumn);
Krasimir Georgievac16a202017-06-23 11:46:03 +00002193 llvm::Optional<std::string> CurrentCode = None;
2194 tooling::Replacements Fixes;
Krasimir Georgiev9ad83fe2017-10-30 14:01:50 +00002195 unsigned Penalty = 0;
Krasimir Georgievac16a202017-06-23 11:46:03 +00002196 for (size_t I = 0, E = Passes.size(); I < E; ++I) {
Krasimir Georgiev9ad83fe2017-10-30 14:01:50 +00002197 std::pair<tooling::Replacements, unsigned> PassFixes = Passes[I](*Env);
Krasimir Georgievac16a202017-06-23 11:46:03 +00002198 auto NewCode = applyAllReplacements(
Krasimir Georgiev9ad83fe2017-10-30 14:01:50 +00002199 CurrentCode ? StringRef(*CurrentCode) : Code, PassFixes.first);
Krasimir Georgievac16a202017-06-23 11:46:03 +00002200 if (NewCode) {
Krasimir Georgiev9ad83fe2017-10-30 14:01:50 +00002201 Fixes = Fixes.merge(PassFixes.first);
2202 Penalty += PassFixes.second;
Krasimir Georgievac16a202017-06-23 11:46:03 +00002203 if (I + 1 < E) {
2204 CurrentCode = std::move(*NewCode);
Eric Liu2e538082018-05-09 21:35:52 +00002205 Env = llvm::make_unique<Environment>(
Krasimir Georgievac16a202017-06-23 11:46:03 +00002206 *CurrentCode, FileName,
Krasimir Georgiev9ad83fe2017-10-30 14:01:50 +00002207 tooling::calculateRangesAfterReplacements(Fixes, Ranges),
2208 FirstStartColumn, NextStartColumn, LastStartColumn);
Krasimir Georgievac16a202017-06-23 11:46:03 +00002209 }
2210 }
Daniel Jasper496c1992016-09-07 22:48:53 +00002211 }
2212
Krasimir Georgiev9ad83fe2017-10-30 14:01:50 +00002213 return {Fixes, Penalty};
2214}
2215} // namespace internal
2216
2217tooling::Replacements reformat(const FormatStyle &Style, StringRef Code,
2218 ArrayRef<tooling::Range> Ranges,
2219 StringRef FileName,
2220 FormattingAttemptStatus *Status) {
2221 return internal::reformat(Style, Code, Ranges,
2222 /*FirstStartColumn=*/0,
2223 /*NextStartColumn=*/0,
2224 /*LastStartColumn=*/0, FileName, Status)
2225 .first;
Eric Liu4cfb88a2016-04-25 15:09:22 +00002226}
2227
Eric Liu4cfb88a2016-04-25 15:09:22 +00002228tooling::Replacements cleanup(const FormatStyle &Style, StringRef Code,
2229 ArrayRef<tooling::Range> Ranges,
2230 StringRef FileName) {
Martin Probst816a9662017-05-29 08:41:11 +00002231 // cleanups only apply to C++ (they mostly concern ctor commas etc.)
2232 if (Style.Language != FormatStyle::LK_Cpp)
2233 return tooling::Replacements();
Eric Liu2e538082018-05-09 21:35:52 +00002234 return Cleaner(Environment(Code, FileName, Ranges), Style).process().first;
Daniel Jasperec04c0d2013-05-16 10:40:07 +00002235}
2236
Krasimir Georgievbcda54b2017-04-21 14:35:20 +00002237tooling::Replacements reformat(const FormatStyle &Style, StringRef Code,
2238 ArrayRef<tooling::Range> Ranges,
2239 StringRef FileName, bool *IncompleteFormat) {
2240 FormattingAttemptStatus Status;
2241 auto Result = reformat(Style, Code, Ranges, FileName, &Status);
2242 if (!Status.FormatComplete)
2243 *IncompleteFormat = true;
2244 return Result;
2245}
2246
Krasimir Georgiev7cb267a2017-02-27 13:28:36 +00002247tooling::Replacements fixNamespaceEndComments(const FormatStyle &Style,
2248 StringRef Code,
2249 ArrayRef<tooling::Range> Ranges,
2250 StringRef FileName) {
Eric Liu2e538082018-05-09 21:35:52 +00002251 return NamespaceEndCommentsFixer(Environment(Code, FileName, Ranges), Style)
2252 .process()
2253 .first;
Krasimir Georgiev7cb267a2017-02-27 13:28:36 +00002254}
2255
Krasimir Georgievb03877a2017-06-21 12:03:12 +00002256tooling::Replacements sortUsingDeclarations(const FormatStyle &Style,
2257 StringRef Code,
2258 ArrayRef<tooling::Range> Ranges,
2259 StringRef FileName) {
Eric Liu2e538082018-05-09 21:35:52 +00002260 return UsingDeclarationsSorter(Environment(Code, FileName, Ranges), Style)
2261 .process()
2262 .first;
Krasimir Georgievb03877a2017-06-21 12:03:12 +00002263}
2264
Daniel Jasper4db69bd2014-09-04 18:23:42 +00002265LangOptions getFormattingLangOpts(const FormatStyle &Style) {
Daniel Jasperc1fa2812013-01-10 13:08:12 +00002266 LangOptions LangOpts;
2267 LangOpts.CPlusPlus = 1;
Daniel Jasper4db69bd2014-09-04 18:23:42 +00002268 LangOpts.CPlusPlus11 = Style.Standard == FormatStyle::LS_Cpp03 ? 0 : 1;
2269 LangOpts.CPlusPlus14 = Style.Standard == FormatStyle::LS_Cpp03 ? 0 : 1;
Aaron Ballmanc351fba2017-12-04 20:27:34 +00002270 LangOpts.CPlusPlus17 = Style.Standard == FormatStyle::LS_Cpp03 ? 0 : 1;
Richard Smithc70f1d62017-12-14 15:16:18 +00002271 LangOpts.CPlusPlus2a = Style.Standard == FormatStyle::LS_Cpp03 ? 0 : 1;
Daniel Jasper55213652013-03-22 10:01:29 +00002272 LangOpts.LineComment = 1;
Daniel Jasper1dbc2102017-03-31 13:30:24 +00002273 bool AlternativeOperators = Style.isCpp();
Daniel Jasper30a24062014-11-14 09:02:28 +00002274 LangOpts.CXXOperatorNames = AlternativeOperators ? 1 : 0;
Daniel Jasperc1fa2812013-01-10 13:08:12 +00002275 LangOpts.Bool = 1;
Erik Pilkingtonfa983902018-10-30 20:31:30 +00002276 LangOpts.ObjC = 1;
Eric Liu4cfb88a2016-04-25 15:09:22 +00002277 LangOpts.MicrosoftExt = 1; // To get kw___try, kw___finally.
Saleem Abdulrasoold170c4b2015-10-04 17:51:05 +00002278 LangOpts.DeclSpecKeyword = 1; // To get __declspec.
Daniel Jasperc1fa2812013-01-10 13:08:12 +00002279 return LangOpts;
2280}
2281
Edwin Vaned544aa72013-09-30 13:31:48 +00002282const char *StyleOptionHelpDescription =
2283 "Coding style, currently supports:\n"
2284 " LLVM, Google, Chromium, Mozilla, WebKit.\n"
2285 "Use -style=file to load style configuration from\n"
2286 ".clang-format file located in one of the parent\n"
2287 "directories of the source file (or current\n"
2288 "directory for stdin).\n"
2289 "Use -style=\"{key: value, ...}\" to set specific\n"
2290 "parameters, e.g.:\n"
2291 " -style=\"{BasedOnStyle: llvm, IndentWidth: 8}\"";
2292
Alexander Kornienkoc1637f12013-12-10 11:28:13 +00002293static FormatStyle::LanguageKind getLanguageByFileName(StringRef FileName) {
Daniel Jasper498f5582015-12-25 08:53:31 +00002294 if (FileName.endswith(".java"))
Daniel Jasperc58c70e2014-09-15 11:21:46 +00002295 return FormatStyle::LK_Java;
Daniel Jasper498f5582015-12-25 08:53:31 +00002296 if (FileName.endswith_lower(".js") || FileName.endswith_lower(".ts"))
2297 return FormatStyle::LK_JavaScript; // JavaScript or TypeScript.
Daniel Jasper03a04fe2016-12-12 12:42:29 +00002298 if (FileName.endswith(".m") || FileName.endswith(".mm"))
2299 return FormatStyle::LK_ObjC;
Daniel Jasper498f5582015-12-25 08:53:31 +00002300 if (FileName.endswith_lower(".proto") ||
2301 FileName.endswith_lower(".protodevel"))
Daniel Jasper7052ce62014-01-19 09:04:08 +00002302 return FormatStyle::LK_Proto;
Krasimir Georgiev66496652017-11-17 15:10:49 +00002303 if (FileName.endswith_lower(".textpb") ||
2304 FileName.endswith_lower(".pb.txt") ||
2305 FileName.endswith_lower(".textproto") ||
2306 FileName.endswith_lower(".asciipb"))
2307 return FormatStyle::LK_TextProto;
Daniel Jasper498f5582015-12-25 08:53:31 +00002308 if (FileName.endswith_lower(".td"))
2309 return FormatStyle::LK_TableGen;
Alexander Kornienkoc1637f12013-12-10 11:28:13 +00002310 return FormatStyle::LK_Cpp;
Alexander Kornienkocabdd732013-11-29 15:19:43 +00002311}
2312
Ben Hamilton3b345c32018-02-21 15:54:31 +00002313FormatStyle::LanguageKind guessLanguage(StringRef FileName, StringRef Code) {
Ben Hamilton6e066352018-02-27 15:56:40 +00002314 const auto GuessedLanguage = getLanguageByFileName(FileName);
2315 if (GuessedLanguage == FormatStyle::LK_Cpp) {
Ben Hamilton07e58362018-02-21 21:27:27 +00002316 auto Extension = llvm::sys::path::extension(FileName);
Ben Hamilton3b345c32018-02-21 15:54:31 +00002317 // If there's no file extension (or it's .h), we need to check the contents
2318 // of the code to see if it contains Objective-C.
Ben Hamilton07e58362018-02-21 21:27:27 +00002319 if (Extension.empty() || Extension == ".h") {
2320 auto NonEmptyFileName = FileName.empty() ? "guess.h" : FileName;
Eric Liu2e538082018-05-09 21:35:52 +00002321 Environment Env(Code, NonEmptyFileName, /*Ranges=*/{});
2322 ObjCHeaderStyleGuesser Guesser(Env, getLLVMStyle());
Ben Hamilton3b345c32018-02-21 15:54:31 +00002323 Guesser.process();
Ben Hamilton6e066352018-02-27 15:56:40 +00002324 if (Guesser.isObjC())
2325 return FormatStyle::LK_ObjC;
Ben Hamilton3b345c32018-02-21 15:54:31 +00002326 }
2327 }
Ben Hamilton6e066352018-02-27 15:56:40 +00002328 return GuessedLanguage;
Ben Hamilton3b345c32018-02-21 15:54:31 +00002329}
2330
Eric Liub4adc912018-06-25 16:29:19 +00002331const char *DefaultFormatStyle = "file";
2332
2333const char *DefaultFallbackStyle = "LLVM";
2334
Antonio Maiorano3adfb6a2017-01-17 00:12:27 +00002335llvm::Expected<FormatStyle> getStyle(StringRef StyleName, StringRef FileName,
Antonio Maiorano7eb75072017-01-20 01:22:42 +00002336 StringRef FallbackStyleName,
Jonas Devliegherefc514902018-10-10 13:27:25 +00002337 StringRef Code,
2338 llvm::vfs::FileSystem *FS) {
Eric Liu547d8792016-03-24 13:22:42 +00002339 if (!FS) {
Jonas Devliegherefc514902018-10-10 13:27:25 +00002340 FS = llvm::vfs::getRealFileSystem().get();
Eric Liu547d8792016-03-24 13:22:42 +00002341 }
Alexander Kornienkoc1637f12013-12-10 11:28:13 +00002342 FormatStyle Style = getLLVMStyle();
Ben Hamilton3b345c32018-02-21 15:54:31 +00002343 Style.Language = guessLanguage(FileName, Code);
Daniel Jasper03a04fe2016-12-12 12:42:29 +00002344
Antonio Maiorano7eb75072017-01-20 01:22:42 +00002345 FormatStyle FallbackStyle = getNoStyle();
2346 if (!getPredefinedStyle(FallbackStyleName, Style.Language, &FallbackStyle))
2347 return make_string_error("Invalid fallback style \"" + FallbackStyleName);
Edwin Vaned544aa72013-09-30 13:31:48 +00002348
2349 if (StyleName.startswith("{")) {
2350 // Parse YAML/JSON style from the command line.
Antonio Maiorano3adfb6a2017-01-17 00:12:27 +00002351 if (std::error_code ec = parseConfiguration(StyleName, &Style))
2352 return make_string_error("Error parsing -style: " + ec.message());
Edwin Vaned544aa72013-09-30 13:31:48 +00002353 return Style;
2354 }
2355
2356 if (!StyleName.equals_lower("file")) {
Alexander Kornienkoc1637f12013-12-10 11:28:13 +00002357 if (!getPredefinedStyle(StyleName, Style.Language, &Style))
Antonio Maiorano3adfb6a2017-01-17 00:12:27 +00002358 return make_string_error("Invalid value for -style");
Edwin Vaned544aa72013-09-30 13:31:48 +00002359 return Style;
2360 }
2361
Alexander Kornienkoc1637f12013-12-10 11:28:13 +00002362 // Look for .clang-format/_clang-format file in the file's parent directories.
Alexander Kornienkocabdd732013-11-29 15:19:43 +00002363 SmallString<128> UnsuitableConfigFiles;
Edwin Vaned544aa72013-09-30 13:31:48 +00002364 SmallString<128> Path(FileName);
Antonio Maiorano3adfb6a2017-01-17 00:12:27 +00002365 if (std::error_code EC = FS->makeAbsolute(Path))
2366 return make_string_error(EC.message());
Antonio Maiorano34c03762016-12-22 05:10:07 +00002367
Alexander Kornienkoe2e03872013-10-14 00:46:35 +00002368 for (StringRef Directory = Path; !Directory.empty();
Edwin Vaned544aa72013-09-30 13:31:48 +00002369 Directory = llvm::sys::path::parent_path(Directory)) {
Eric Liu547d8792016-03-24 13:22:42 +00002370
2371 auto Status = FS->status(Directory);
2372 if (!Status ||
2373 Status->getType() != llvm::sys::fs::file_type::directory_file) {
Edwin Vaned544aa72013-09-30 13:31:48 +00002374 continue;
Eric Liu547d8792016-03-24 13:22:42 +00002375 }
2376
Edwin Vaned544aa72013-09-30 13:31:48 +00002377 SmallString<128> ConfigFile(Directory);
2378
2379 llvm::sys::path::append(ConfigFile, ".clang-format");
Nicola Zaghen3538b392018-05-15 13:30:56 +00002380 LLVM_DEBUG(llvm::dbgs() << "Trying " << ConfigFile << "...\n");
Eric Liud4758322016-03-24 13:22:37 +00002381
Eric Liu547d8792016-03-24 13:22:42 +00002382 Status = FS->status(ConfigFile.str());
Antonio Maiorano3adfb6a2017-01-17 00:12:27 +00002383 bool FoundConfigFile =
Eric Liu547d8792016-03-24 13:22:42 +00002384 Status && (Status->getType() == llvm::sys::fs::file_type::regular_file);
Antonio Maiorano3adfb6a2017-01-17 00:12:27 +00002385 if (!FoundConfigFile) {
Edwin Vaned544aa72013-09-30 13:31:48 +00002386 // Try _clang-format too, since dotfiles are not commonly used on Windows.
2387 ConfigFile = Directory;
2388 llvm::sys::path::append(ConfigFile, "_clang-format");
Nicola Zaghen3538b392018-05-15 13:30:56 +00002389 LLVM_DEBUG(llvm::dbgs() << "Trying " << ConfigFile << "...\n");
Eric Liu547d8792016-03-24 13:22:42 +00002390 Status = FS->status(ConfigFile.str());
Antonio Maiorano3adfb6a2017-01-17 00:12:27 +00002391 FoundConfigFile = Status && (Status->getType() ==
2392 llvm::sys::fs::file_type::regular_file);
Edwin Vaned544aa72013-09-30 13:31:48 +00002393 }
2394
Antonio Maiorano3adfb6a2017-01-17 00:12:27 +00002395 if (FoundConfigFile) {
Rafael Espindola2d2b4202014-07-06 17:43:24 +00002396 llvm::ErrorOr<std::unique_ptr<llvm::MemoryBuffer>> Text =
Eric Liu547d8792016-03-24 13:22:42 +00002397 FS->getBufferForFile(ConfigFile.str());
Antonio Maiorano3adfb6a2017-01-17 00:12:27 +00002398 if (std::error_code EC = Text.getError())
2399 return make_string_error(EC.message());
Rafael Espindola2d2b4202014-07-06 17:43:24 +00002400 if (std::error_code ec =
2401 parseConfiguration(Text.get()->getBuffer(), &Style)) {
Rafael Espindolad0136702014-06-12 02:50:04 +00002402 if (ec == ParseError::Unsuitable) {
Alexander Kornienkocabdd732013-11-29 15:19:43 +00002403 if (!UnsuitableConfigFiles.empty())
2404 UnsuitableConfigFiles.append(", ");
2405 UnsuitableConfigFiles.append(ConfigFile);
Alexander Kornienkobc4ae442013-12-02 15:21:38 +00002406 continue;
Alexander Kornienkocabdd732013-11-29 15:19:43 +00002407 }
Antonio Maiorano3adfb6a2017-01-17 00:12:27 +00002408 return make_string_error("Error reading " + ConfigFile + ": " +
2409 ec.message());
Edwin Vaned544aa72013-09-30 13:31:48 +00002410 }
Nicola Zaghen3538b392018-05-15 13:30:56 +00002411 LLVM_DEBUG(llvm::dbgs()
2412 << "Using configuration file " << ConfigFile << "\n");
Edwin Vaned544aa72013-09-30 13:31:48 +00002413 return Style;
2414 }
2415 }
Antonio Maiorano3adfb6a2017-01-17 00:12:27 +00002416 if (!UnsuitableConfigFiles.empty())
2417 return make_string_error("Configuration file(s) do(es) not support " +
2418 getLanguageName(Style.Language) + ": " +
2419 UnsuitableConfigFiles);
Antonio Maiorano7eb75072017-01-20 01:22:42 +00002420 return FallbackStyle;
Edwin Vaned544aa72013-09-30 13:31:48 +00002421}
2422
Daniel Jasper8d1832e2013-01-07 13:26:07 +00002423} // namespace format
2424} // namespace clang