clang  15.0.0git
WhitespaceManager.cpp
Go to the documentation of this file.
1 //===--- WhitespaceManager.cpp - Format C++ code --------------------------===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 ///
9 /// \file
10 /// This file implements WhitespaceManager class.
11 ///
12 //===----------------------------------------------------------------------===//
13 
14 #include "WhitespaceManager.h"
15 #include "llvm/ADT/STLExtras.h"
16 #include "llvm/ADT/SmallVector.h"
17 #include <algorithm>
18 
19 namespace clang {
20 namespace format {
21 
23  const Change &C1, const Change &C2) const {
24  return SourceMgr.isBeforeInTranslationUnit(
27 }
28 
30  bool CreateReplacement,
32  int Spaces, unsigned StartOfTokenColumn,
33  unsigned NewlinesBefore,
34  StringRef PreviousLinePostfix,
35  StringRef CurrentLinePrefix, bool IsAligned,
46 }
47 
49  unsigned Spaces,
50  unsigned StartOfTokenColumn,
51  bool IsAligned, bool InPPDirective) {
52  if (Tok.Finalized)
53  return;
54  Tok.setDecision((Newlines > 0) ? FD_Break : FD_Continue);
55  Changes.push_back(Change(Tok, /*CreateReplacement=*/true, Tok.WhitespaceRange,
56  Spaces, StartOfTokenColumn, Newlines, "", "",
57  IsAligned, InPPDirective && !Tok.IsFirst,
58  /*IsInsideToken=*/false));
59 }
60 
62  bool InPPDirective) {
63  if (Tok.Finalized)
64  return;
65  Changes.push_back(Change(Tok, /*CreateReplacement=*/false,
66  Tok.WhitespaceRange, /*Spaces=*/0,
67  Tok.OriginalColumn, Tok.NewlinesBefore, "", "",
68  /*IsAligned=*/false, InPPDirective && !Tok.IsFirst,
69  /*IsInsideToken=*/false));
70 }
71 
72 llvm::Error
74  return Replaces.add(Replacement);
75 }
76 
77 bool WhitespaceManager::inputUsesCRLF(StringRef Text, bool DefaultToCRLF) {
78  size_t LF = Text.count('\n');
79  size_t CR = Text.count('\r') * 2;
80  return LF == CR ? DefaultToCRLF : CR > LF;
81 }
82 
84  const FormatToken &Tok, unsigned Offset, unsigned ReplaceChars,
85  StringRef PreviousPostfix, StringRef CurrentPrefix, bool InPPDirective,
86  unsigned Newlines, int Spaces) {
87  if (Tok.Finalized)
88  return;
90  Changes.push_back(
91  Change(Tok, /*CreateReplacement=*/true,
92  SourceRange(Start, Start.getLocWithOffset(ReplaceChars)), Spaces,
93  std::max(0, Spaces), Newlines, PreviousPostfix, CurrentPrefix,
94  /*IsAligned=*/true, InPPDirective && !Tok.IsFirst,
95  /*IsInsideToken=*/true));
96 }
97 
99  if (Changes.empty())
100  return Replaces;
101 
102  llvm::sort(Changes, Change::IsBeforeInFile(SourceMgr));
103  calculateLineBreakInformation();
104  alignConsecutiveMacros();
105  alignConsecutiveDeclarations();
106  alignConsecutiveBitFields();
107  alignConsecutiveAssignments();
108  alignChainedConditionals();
109  alignTrailingComments();
110  alignEscapedNewlines();
111  alignArrayInitializers();
112  generateChanges();
113 
114  return Replaces;
115 }
116 
117 void WhitespaceManager::calculateLineBreakInformation() {
118  Changes[0].PreviousEndOfTokenColumn = 0;
119  Change *LastOutsideTokenChange = &Changes[0];
120  for (unsigned i = 1, e = Changes.size(); i != e; ++i) {
121  SourceLocation OriginalWhitespaceStart =
122  Changes[i].OriginalWhitespaceRange.getBegin();
123  SourceLocation PreviousOriginalWhitespaceEnd =
124  Changes[i - 1].OriginalWhitespaceRange.getEnd();
125  unsigned OriginalWhitespaceStartOffset =
126  SourceMgr.getFileOffset(OriginalWhitespaceStart);
127  unsigned PreviousOriginalWhitespaceEndOffset =
128  SourceMgr.getFileOffset(PreviousOriginalWhitespaceEnd);
129  assert(PreviousOriginalWhitespaceEndOffset <=
130  OriginalWhitespaceStartOffset);
131  const char *const PreviousOriginalWhitespaceEndData =
132  SourceMgr.getCharacterData(PreviousOriginalWhitespaceEnd);
133  StringRef Text(PreviousOriginalWhitespaceEndData,
134  SourceMgr.getCharacterData(OriginalWhitespaceStart) -
135  PreviousOriginalWhitespaceEndData);
136  // Usually consecutive changes would occur in consecutive tokens. This is
137  // not the case however when analyzing some preprocessor runs of the
138  // annotated lines. For example, in this code:
139  //
140  // #if A // line 1
141  // int i = 1;
142  // #else B // line 2
143  // int i = 2;
144  // #endif // line 3
145  //
146  // one of the runs will produce the sequence of lines marked with line 1, 2
147  // and 3. So the two consecutive whitespace changes just before '// line 2'
148  // and before '#endif // line 3' span multiple lines and tokens:
149  //
150  // #else B{change X}[// line 2
151  // int i = 2;
152  // ]{change Y}#endif // line 3
153  //
154  // For this reason, if the text between consecutive changes spans multiple
155  // newlines, the token length must be adjusted to the end of the original
156  // line of the token.
157  auto NewlinePos = Text.find_first_of('\n');
158  if (NewlinePos == StringRef::npos) {
159  Changes[i - 1].TokenLength = OriginalWhitespaceStartOffset -
160  PreviousOriginalWhitespaceEndOffset +
161  Changes[i].PreviousLinePostfix.size() +
162  Changes[i - 1].CurrentLinePrefix.size();
163  } else {
164  Changes[i - 1].TokenLength =
165  NewlinePos + Changes[i - 1].CurrentLinePrefix.size();
166  }
167 
168  // If there are multiple changes in this token, sum up all the changes until
169  // the end of the line.
170  if (Changes[i - 1].IsInsideToken && Changes[i - 1].NewlinesBefore == 0) {
171  LastOutsideTokenChange->TokenLength +=
172  Changes[i - 1].TokenLength + Changes[i - 1].Spaces;
173  } else {
174  LastOutsideTokenChange = &Changes[i - 1];
175  }
176 
177  Changes[i].PreviousEndOfTokenColumn =
178  Changes[i - 1].StartOfTokenColumn + Changes[i - 1].TokenLength;
179 
180  Changes[i - 1].IsTrailingComment =
181  (Changes[i].NewlinesBefore > 0 || Changes[i].Tok->is(tok::eof) ||
182  (Changes[i].IsInsideToken && Changes[i].Tok->is(tok::comment))) &&
183  Changes[i - 1].Tok->is(tok::comment) &&
184  // FIXME: This is a dirty hack. The problem is that
185  // BreakableLineCommentSection does comment reflow changes and here is
186  // the aligning of trailing comments. Consider the case where we reflow
187  // the second line up in this example:
188  //
189  // // line 1
190  // // line 2
191  //
192  // That amounts to 2 changes by BreakableLineCommentSection:
193  // - the first, delimited by (), for the whitespace between the tokens,
194  // - and second, delimited by [], for the whitespace at the beginning
195  // of the second token:
196  //
197  // // line 1(
198  // )[// ]line 2
199  //
200  // So in the end we have two changes like this:
201  //
202  // // line1()[ ]line 2
203  //
204  // Note that the OriginalWhitespaceStart of the second change is the
205  // same as the PreviousOriginalWhitespaceEnd of the first change.
206  // In this case, the below check ensures that the second change doesn't
207  // get treated as a trailing comment change here, since this might
208  // trigger additional whitespace to be wrongly inserted before "line 2"
209  // by the comment aligner here.
210  //
211  // For a proper solution we need a mechanism to say to WhitespaceManager
212  // that a particular change breaks the current sequence of trailing
213  // comments.
214  OriginalWhitespaceStart != PreviousOriginalWhitespaceEnd;
215  }
216  // FIXME: The last token is currently not always an eof token; in those
217  // cases, setting TokenLength of the last token to 0 is wrong.
218  Changes.back().TokenLength = 0;
219  Changes.back().IsTrailingComment = Changes.back().Tok->is(tok::comment);
220 
221  const WhitespaceManager::Change *LastBlockComment = nullptr;
222  for (auto &Change : Changes) {
223  // Reset the IsTrailingComment flag for changes inside of trailing comments
224  // so they don't get realigned later. Comment line breaks however still need
225  // to be aligned.
226  if (Change.IsInsideToken && Change.NewlinesBefore == 0)
227  Change.IsTrailingComment = false;
228  Change.StartOfBlockComment = nullptr;
229  Change.IndentationOffset = 0;
230  if (Change.Tok->is(tok::comment)) {
231  if (Change.Tok->is(TT_LineComment) || !Change.IsInsideToken) {
232  LastBlockComment = &Change;
233  } else if ((Change.StartOfBlockComment = LastBlockComment)) {
234  Change.IndentationOffset =
235  Change.StartOfTokenColumn -
236  Change.StartOfBlockComment->StartOfTokenColumn;
237  }
238  } else {
239  LastBlockComment = nullptr;
240  }
241  }
242 
243  // Compute conditional nesting level
244  // Level is increased for each conditional, unless this conditional continues
245  // a chain of conditional, i.e. starts immediately after the colon of another
246  // conditional.
247  SmallVector<bool, 16> ScopeStack;
248  int ConditionalsLevel = 0;
249  for (auto &Change : Changes) {
250  for (unsigned i = 0, e = Change.Tok->FakeLParens.size(); i != e; ++i) {
251  bool isNestedConditional =
252  Change.Tok->FakeLParens[e - 1 - i] == prec::Conditional &&
253  !(i == 0 && Change.Tok->Previous &&
254  Change.Tok->Previous->is(TT_ConditionalExpr) &&
255  Change.Tok->Previous->is(tok::colon));
256  if (isNestedConditional)
257  ++ConditionalsLevel;
258  ScopeStack.push_back(isNestedConditional);
259  }
260 
261  Change.ConditionalsLevel = ConditionalsLevel;
262 
263  for (unsigned i = Change.Tok->FakeRParens; i > 0 && ScopeStack.size(); --i)
264  if (ScopeStack.pop_back_val())
265  --ConditionalsLevel;
266  }
267 }
268 
269 // Align a single sequence of tokens, see AlignTokens below.
270 // Column - The token for which Matches returns true is moved to this column.
271 // RightJustify - Whether it is the token's right end or left end that gets
272 // moved to that column.
273 template <typename F>
274 static void
275 AlignTokenSequence(const FormatStyle &Style, unsigned Start, unsigned End,
276  unsigned Column, bool RightJustify, F &&Matches,
278  bool FoundMatchOnLine = false;
279  int Shift = 0;
280 
281  // ScopeStack keeps track of the current scope depth. It contains indices of
282  // the first token on each scope.
283  // We only run the "Matches" function on tokens from the outer-most scope.
284  // However, we do need to pay special attention to one class of tokens
285  // that are not in the outer-most scope, and that is function parameters
286  // which are split across multiple lines, as illustrated by this example:
287  // double a(int x);
288  // int b(int y,
289  // double z);
290  // In the above example, we need to take special care to ensure that
291  // 'double z' is indented along with it's owning function 'b'.
292  // The same holds for calling a function:
293  // double a = foo(x);
294  // int b = bar(foo(y),
295  // foor(z));
296  // Similar for broken string literals:
297  // double x = 3.14;
298  // auto s = "Hello"
299  // "World";
300  // Special handling is required for 'nested' ternary operators.
301  SmallVector<unsigned, 16> ScopeStack;
302 
303  for (unsigned i = Start; i != End; ++i) {
304  if (ScopeStack.size() != 0 &&
305  Changes[i].indentAndNestingLevel() <
306  Changes[ScopeStack.back()].indentAndNestingLevel()) {
307  ScopeStack.pop_back();
308  }
309 
310  // Compare current token to previous non-comment token to ensure whether
311  // it is in a deeper scope or not.
312  unsigned PreviousNonComment = i - 1;
313  while (PreviousNonComment > Start &&
314  Changes[PreviousNonComment].Tok->is(tok::comment)) {
315  --PreviousNonComment;
316  }
317  if (i != Start && Changes[i].indentAndNestingLevel() >
318  Changes[PreviousNonComment].indentAndNestingLevel()) {
319  ScopeStack.push_back(i);
320  }
321 
322  bool InsideNestedScope = ScopeStack.size() != 0;
323  bool ContinuedStringLiteral = i > Start &&
324  Changes[i].Tok->is(tok::string_literal) &&
325  Changes[i - 1].Tok->is(tok::string_literal);
326  bool SkipMatchCheck = InsideNestedScope || ContinuedStringLiteral;
327 
328  if (Changes[i].NewlinesBefore > 0 && !SkipMatchCheck) {
329  Shift = 0;
330  FoundMatchOnLine = false;
331  }
332 
333  // If this is the first matching token to be aligned, remember by how many
334  // spaces it has to be shifted, so the rest of the changes on the line are
335  // shifted by the same amount
336  if (!FoundMatchOnLine && !SkipMatchCheck && Matches(Changes[i])) {
337  FoundMatchOnLine = true;
338  Shift = Column - (RightJustify ? Changes[i].TokenLength : 0) -
339  Changes[i].StartOfTokenColumn;
340  Changes[i].Spaces += Shift;
341  // FIXME: This is a workaround that should be removed when we fix
342  // http://llvm.org/PR53699. An assertion later below verifies this.
343  if (Changes[i].NewlinesBefore == 0) {
344  Changes[i].Spaces =
345  std::max(Changes[i].Spaces,
346  static_cast<int>(Changes[i].Tok->SpacesRequiredBefore));
347  }
348  }
349 
350  // This is for function parameters that are split across multiple lines,
351  // as mentioned in the ScopeStack comment.
352  if (InsideNestedScope && Changes[i].NewlinesBefore > 0) {
353  unsigned ScopeStart = ScopeStack.back();
354  auto ShouldShiftBeAdded = [&] {
355  // Function declaration
356  if (Changes[ScopeStart - 1].Tok->is(TT_FunctionDeclarationName))
357  return true;
358 
359  // Lambda.
360  if (Changes[ScopeStart - 1].Tok->is(TT_LambdaLBrace))
361  return false;
362 
363  // Continued function declaration
364  if (ScopeStart > Start + 1 &&
365  Changes[ScopeStart - 2].Tok->is(TT_FunctionDeclarationName)) {
366  return true;
367  }
368 
369  // Continued function call
370  if (ScopeStart > Start + 1 &&
371  Changes[ScopeStart - 2].Tok->is(tok::identifier) &&
372  Changes[ScopeStart - 1].Tok->is(tok::l_paren) &&
373  Changes[ScopeStart].Tok->isNot(TT_LambdaLSquare)) {
374  if (Changes[i].Tok->MatchingParen &&
375  Changes[i].Tok->MatchingParen->is(TT_LambdaLBrace)) {
376  return false;
377  }
378  if (Changes[ScopeStart].NewlinesBefore > 0)
379  return false;
380  if (Changes[i].Tok->is(tok::l_brace) &&
381  Changes[i].Tok->is(BK_BracedInit)) {
382  return true;
383  }
384  return Style.BinPackArguments;
385  }
386 
387  // Ternary operator
388  if (Changes[i].Tok->is(TT_ConditionalExpr))
389  return true;
390 
391  // Period Initializer .XXX = 1.
392  if (Changes[i].Tok->is(TT_DesignatedInitializerPeriod))
393  return true;
394 
395  // Continued ternary operator
396  if (Changes[i].Tok->Previous &&
397  Changes[i].Tok->Previous->is(TT_ConditionalExpr)) {
398  return true;
399  }
400 
401  // Continued direct-list-initialization using braced list.
402  if (ScopeStart > Start + 1 &&
403  Changes[ScopeStart - 2].Tok->is(tok::identifier) &&
404  Changes[ScopeStart - 1].Tok->is(tok::l_brace) &&
405  Changes[i].Tok->is(tok::l_brace) &&
406  Changes[i].Tok->is(BK_BracedInit)) {
407  return true;
408  }
409 
410  // Continued braced list.
411  if (ScopeStart > Start + 1 &&
412  Changes[ScopeStart - 2].Tok->isNot(tok::identifier) &&
413  Changes[ScopeStart - 1].Tok->is(tok::l_brace) &&
414  Changes[i].Tok->isNot(tok::r_brace)) {
415  for (unsigned OuterScopeStart : llvm::reverse(ScopeStack)) {
416  // Lambda.
417  if (OuterScopeStart > Start &&
418  Changes[OuterScopeStart - 1].Tok->is(TT_LambdaLBrace)) {
419  return false;
420  }
421  }
422  if (Changes[ScopeStart].NewlinesBefore > 0)
423  return false;
424  return true;
425  }
426 
427  return false;
428  };
429 
430  if (ShouldShiftBeAdded())
431  Changes[i].Spaces += Shift;
432  }
433 
434  if (ContinuedStringLiteral)
435  Changes[i].Spaces += Shift;
436 
437  // We should not remove required spaces unless we break the line before.
438  assert(Shift >= 0 || Changes[i].NewlinesBefore > 0 ||
439  Changes[i].Spaces >=
440  static_cast<int>(Changes[i].Tok->SpacesRequiredBefore) ||
441  Changes[i].Tok->is(tok::eof));
442 
443  Changes[i].StartOfTokenColumn += Shift;
444  if (i + 1 != Changes.size())
445  Changes[i + 1].PreviousEndOfTokenColumn += Shift;
446 
447  // If PointerAlignment is PAS_Right, keep *s or &s next to the token
448  if (Style.PointerAlignment == FormatStyle::PAS_Right &&
449  Changes[i].Spaces != 0) {
450  for (int Previous = i - 1;
451  Previous >= 0 &&
452  Changes[Previous].Tok->getType() == TT_PointerOrReference;
453  --Previous) {
454  Changes[Previous + 1].Spaces -= Shift;
455  Changes[Previous].Spaces += Shift;
456  Changes[Previous].StartOfTokenColumn += Shift;
457  }
458  }
459  }
460 }
461 
462 // Walk through a subset of the changes, starting at StartAt, and find
463 // sequences of matching tokens to align. To do so, keep track of the lines and
464 // whether or not a matching token was found on a line. If a matching token is
465 // found, extend the current sequence. If the current line cannot be part of a
466 // sequence, e.g. because there is an empty line before it or it contains only
467 // non-matching tokens, finalize the previous sequence.
468 // The value returned is the token on which we stopped, either because we
469 // exhausted all items inside Changes, or because we hit a scope level higher
470 // than our initial scope.
471 // This function is recursive. Each invocation processes only the scope level
472 // equal to the initial level, which is the level of Changes[StartAt].
473 // If we encounter a scope level greater than the initial level, then we call
474 // ourselves recursively, thereby avoiding the pollution of the current state
475 // with the alignment requirements of the nested sub-level. This recursive
476 // behavior is necessary for aligning function prototypes that have one or more
477 // arguments.
478 // If this function encounters a scope level less than the initial level,
479 // it returns the current position.
480 // There is a non-obvious subtlety in the recursive behavior: Even though we
481 // defer processing of nested levels to recursive invocations of this
482 // function, when it comes time to align a sequence of tokens, we run the
483 // alignment on the entire sequence, including the nested levels.
484 // When doing so, most of the nested tokens are skipped, because their
485 // alignment was already handled by the recursive invocations of this function.
486 // However, the special exception is that we do NOT skip function parameters
487 // that are split across multiple lines. See the test case in FormatTest.cpp
488 // that mentions "split function parameter alignment" for an example of this.
489 // When the parameter RightJustify is true, the operator will be
490 // right-justified. It is used to align compound assignments like `+=` and `=`.
491 // When RightJustify and ACS.PadOperators are true, operators in each block to
492 // be aligned will be padded on the left to the same length before aligning.
493 template <typename F>
494 static unsigned AlignTokens(const FormatStyle &Style, F &&Matches,
496  unsigned StartAt,
497  const FormatStyle::AlignConsecutiveStyle &ACS = {},
498  bool RightJustify = false) {
499  // We arrange each line in 3 parts. The operator to be aligned (the anchor),
500  // and text to its left and right. In the aligned text the width of each part
501  // will be the maximum of that over the block that has been aligned. Maximum
502  // widths of each part so far. When RightJustify is true and ACS.PadOperators
503  // is false, the part from start of line to the right end of the anchor.
504  // Otherwise, only the part to the left of the anchor. Including the space
505  // that exists on its left from the start. Not including the padding added on
506  // the left to right-justify the anchor.
507  unsigned WidthLeft = 0;
508  // The operator to be aligned when RightJustify is true and ACS.PadOperators
509  // is false. 0 otherwise.
510  unsigned WidthAnchor = 0;
511  // Width to the right of the anchor. Plus width of the anchor when
512  // RightJustify is false.
513  unsigned WidthRight = 0;
514 
515  // Line number of the start and the end of the current token sequence.
516  unsigned StartOfSequence = 0;
517  unsigned EndOfSequence = 0;
518 
519  // Measure the scope level (i.e. depth of (), [], {}) of the first token, and
520  // abort when we hit any token in a higher scope than the starting one.
521  auto IndentAndNestingLevel = StartAt < Changes.size()
522  ? Changes[StartAt].indentAndNestingLevel()
523  : std::tuple<unsigned, unsigned, unsigned>();
524 
525  // Keep track of the number of commas before the matching tokens, we will only
526  // align a sequence of matching tokens if they are preceded by the same number
527  // of commas.
528  unsigned CommasBeforeLastMatch = 0;
529  unsigned CommasBeforeMatch = 0;
530 
531  // Whether a matching token has been found on the current line.
532  bool FoundMatchOnLine = false;
533 
534  // Whether the current line consists purely of comments.
535  bool LineIsComment = true;
536 
537  // Aligns a sequence of matching tokens, on the MinColumn column.
538  //
539  // Sequences start from the first matching token to align, and end at the
540  // first token of the first line that doesn't need to be aligned.
541  //
542  // We need to adjust the StartOfTokenColumn of each Change that is on a line
543  // containing any matching token to be aligned and located after such token.
544  auto AlignCurrentSequence = [&] {
545  if (StartOfSequence > 0 && StartOfSequence < EndOfSequence) {
546  AlignTokenSequence(Style, StartOfSequence, EndOfSequence,
547  WidthLeft + WidthAnchor, RightJustify, Matches,
548  Changes);
549  }
550  WidthLeft = 0;
551  WidthAnchor = 0;
552  WidthRight = 0;
553  StartOfSequence = 0;
554  EndOfSequence = 0;
555  };
556 
557  unsigned i = StartAt;
558  for (unsigned e = Changes.size(); i != e; ++i) {
559  if (Changes[i].indentAndNestingLevel() < IndentAndNestingLevel)
560  break;
561 
562  if (Changes[i].NewlinesBefore != 0) {
563  CommasBeforeMatch = 0;
564  EndOfSequence = i;
565 
566  // Whether to break the alignment sequence because of an empty line.
567  bool EmptyLineBreak =
568  (Changes[i].NewlinesBefore > 1) && !ACS.AcrossEmptyLines;
569 
570  // Whether to break the alignment sequence because of a line without a
571  // match.
572  bool NoMatchBreak =
573  !FoundMatchOnLine && !(LineIsComment && ACS.AcrossComments);
574 
575  if (EmptyLineBreak || NoMatchBreak)
576  AlignCurrentSequence();
577 
578  // A new line starts, re-initialize line status tracking bools.
579  // Keep the match state if a string literal is continued on this line.
580  if (i == 0 || !Changes[i].Tok->is(tok::string_literal) ||
581  !Changes[i - 1].Tok->is(tok::string_literal)) {
582  FoundMatchOnLine = false;
583  }
584  LineIsComment = true;
585  }
586 
587  if (!Changes[i].Tok->is(tok::comment))
588  LineIsComment = false;
589 
590  if (Changes[i].Tok->is(tok::comma)) {
591  ++CommasBeforeMatch;
592  } else if (Changes[i].indentAndNestingLevel() > IndentAndNestingLevel) {
593  // Call AlignTokens recursively, skipping over this scope block.
594  unsigned StoppedAt = AlignTokens(Style, Matches, Changes, i, ACS);
595  i = StoppedAt - 1;
596  continue;
597  }
598 
599  if (!Matches(Changes[i]))
600  continue;
601 
602  // If there is more than one matching token per line, or if the number of
603  // preceding commas, do not match anymore, end the sequence.
604  if (FoundMatchOnLine || CommasBeforeMatch != CommasBeforeLastMatch)
605  AlignCurrentSequence();
606 
607  CommasBeforeLastMatch = CommasBeforeMatch;
608  FoundMatchOnLine = true;
609 
610  if (StartOfSequence == 0)
611  StartOfSequence = i;
612 
613  unsigned ChangeWidthLeft = Changes[i].StartOfTokenColumn;
614  unsigned ChangeWidthAnchor = 0;
615  unsigned ChangeWidthRight = 0;
616  if (RightJustify)
617  if (ACS.PadOperators)
618  ChangeWidthAnchor = Changes[i].TokenLength;
619  else
620  ChangeWidthLeft += Changes[i].TokenLength;
621  else
622  ChangeWidthRight = Changes[i].TokenLength;
623  for (unsigned j = i + 1; j != e && Changes[j].NewlinesBefore == 0; ++j) {
624  ChangeWidthRight += Changes[j].Spaces;
625  // Changes are generally 1:1 with the tokens, but a change could also be
626  // inside of a token, in which case it's counted more than once: once for
627  // the whitespace surrounding the token (!IsInsideToken) and once for
628  // each whitespace change within it (IsInsideToken).
629  // Therefore, changes inside of a token should only count the space.
630  if (!Changes[j].IsInsideToken)
631  ChangeWidthRight += Changes[j].TokenLength;
632  }
633 
634  // If we are restricted by the maximum column width, end the sequence.
635  unsigned NewLeft = std::max(ChangeWidthLeft, WidthLeft);
636  unsigned NewAnchor = std::max(ChangeWidthAnchor, WidthAnchor);
637  unsigned NewRight = std::max(ChangeWidthRight, WidthRight);
638  // `ColumnLimit == 0` means there is no column limit.
639  if (Style.ColumnLimit != 0 &&
640  Style.ColumnLimit < NewLeft + NewAnchor + NewRight) {
641  AlignCurrentSequence();
642  StartOfSequence = i;
643  WidthLeft = ChangeWidthLeft;
644  WidthAnchor = ChangeWidthAnchor;
645  WidthRight = ChangeWidthRight;
646  } else {
647  WidthLeft = NewLeft;
648  WidthAnchor = NewAnchor;
649  WidthRight = NewRight;
650  }
651  }
652 
653  EndOfSequence = i;
654  AlignCurrentSequence();
655  return i;
656 }
657 
658 // Aligns a sequence of matching tokens, on the MinColumn column.
659 //
660 // Sequences start from the first matching token to align, and end at the
661 // first token of the first line that doesn't need to be aligned.
662 //
663 // We need to adjust the StartOfTokenColumn of each Change that is on a line
664 // containing any matching token to be aligned and located after such token.
665 static void AlignMacroSequence(
666  unsigned &StartOfSequence, unsigned &EndOfSequence, unsigned &MinColumn,
667  unsigned &MaxColumn, bool &FoundMatchOnLine,
668  std::function<bool(const WhitespaceManager::Change &C)> AlignMacrosMatches,
670  if (StartOfSequence > 0 && StartOfSequence < EndOfSequence) {
671 
672  FoundMatchOnLine = false;
673  int Shift = 0;
674 
675  for (unsigned I = StartOfSequence; I != EndOfSequence; ++I) {
676  if (Changes[I].NewlinesBefore > 0) {
677  Shift = 0;
678  FoundMatchOnLine = false;
679  }
680 
681  // If this is the first matching token to be aligned, remember by how many
682  // spaces it has to be shifted, so the rest of the changes on the line are
683  // shifted by the same amount
684  if (!FoundMatchOnLine && AlignMacrosMatches(Changes[I])) {
685  FoundMatchOnLine = true;
686  Shift = MinColumn - Changes[I].StartOfTokenColumn;
687  Changes[I].Spaces += Shift;
688  }
689 
690  assert(Shift >= 0);
691  Changes[I].StartOfTokenColumn += Shift;
692  if (I + 1 != Changes.size())
693  Changes[I + 1].PreviousEndOfTokenColumn += Shift;
694  }
695  }
696 
697  MinColumn = 0;
698  MaxColumn = UINT_MAX;
699  StartOfSequence = 0;
700  EndOfSequence = 0;
701 }
702 
703 void WhitespaceManager::alignConsecutiveMacros() {
704  if (!Style.AlignConsecutiveMacros.Enabled)
705  return;
706 
707  auto AlignMacrosMatches = [](const Change &C) {
708  const FormatToken *Current = C.Tok;
709  unsigned SpacesRequiredBefore = 1;
710 
711  if (Current->SpacesRequiredBefore == 0 || !Current->Previous)
712  return false;
713 
714  Current = Current->Previous;
715 
716  // If token is a ")", skip over the parameter list, to the
717  // token that precedes the "("
718  if (Current->is(tok::r_paren) && Current->MatchingParen) {
719  Current = Current->MatchingParen->Previous;
720  SpacesRequiredBefore = 0;
721  }
722 
723  if (!Current || !Current->is(tok::identifier))
724  return false;
725 
726  if (!Current->Previous || !Current->Previous->is(tok::pp_define))
727  return false;
728 
729  // For a macro function, 0 spaces are required between the
730  // identifier and the lparen that opens the parameter list.
731  // For a simple macro, 1 space is required between the
732  // identifier and the first token of the defined value.
733  return Current->Next->SpacesRequiredBefore == SpacesRequiredBefore;
734  };
735 
736  unsigned MinColumn = 0;
737  unsigned MaxColumn = UINT_MAX;
738 
739  // Start and end of the token sequence we're processing.
740  unsigned StartOfSequence = 0;
741  unsigned EndOfSequence = 0;
742 
743  // Whether a matching token has been found on the current line.
744  bool FoundMatchOnLine = false;
745 
746  // Whether the current line consists only of comments
747  bool LineIsComment = true;
748 
749  unsigned I = 0;
750  for (unsigned E = Changes.size(); I != E; ++I) {
751  if (Changes[I].NewlinesBefore != 0) {
752  EndOfSequence = I;
753 
754  // Whether to break the alignment sequence because of an empty line.
755  bool EmptyLineBreak = (Changes[I].NewlinesBefore > 1) &&
756  !Style.AlignConsecutiveMacros.AcrossEmptyLines;
757 
758  // Whether to break the alignment sequence because of a line without a
759  // match.
760  bool NoMatchBreak =
761  !FoundMatchOnLine &&
762  !(LineIsComment && Style.AlignConsecutiveMacros.AcrossComments);
763 
764  if (EmptyLineBreak || NoMatchBreak) {
765  AlignMacroSequence(StartOfSequence, EndOfSequence, MinColumn, MaxColumn,
766  FoundMatchOnLine, AlignMacrosMatches, Changes);
767  }
768 
769  // A new line starts, re-initialize line status tracking bools.
770  FoundMatchOnLine = false;
771  LineIsComment = true;
772  }
773 
774  if (!Changes[I].Tok->is(tok::comment))
775  LineIsComment = false;
776 
777  if (!AlignMacrosMatches(Changes[I]))
778  continue;
779 
780  FoundMatchOnLine = true;
781 
782  if (StartOfSequence == 0)
783  StartOfSequence = I;
784 
785  unsigned ChangeMinColumn = Changes[I].StartOfTokenColumn;
786  int LineLengthAfter = -Changes[I].Spaces;
787  for (unsigned j = I; j != E && Changes[j].NewlinesBefore == 0; ++j)
788  LineLengthAfter += Changes[j].Spaces + Changes[j].TokenLength;
789  unsigned ChangeMaxColumn = Style.ColumnLimit - LineLengthAfter;
790 
791  MinColumn = std::max(MinColumn, ChangeMinColumn);
792  MaxColumn = std::min(MaxColumn, ChangeMaxColumn);
793  }
794 
795  EndOfSequence = I;
796  AlignMacroSequence(StartOfSequence, EndOfSequence, MinColumn, MaxColumn,
797  FoundMatchOnLine, AlignMacrosMatches, Changes);
798 }
799 
800 void WhitespaceManager::alignConsecutiveAssignments() {
801  if (!Style.AlignConsecutiveAssignments.Enabled)
802  return;
803 
804  AlignTokens(
805  Style,
806  [&](const Change &C) {
807  // Do not align on equal signs that are first on a line.
808  if (C.NewlinesBefore > 0)
809  return false;
810 
811  // Do not align on equal signs that are last on a line.
812  if (&C != &Changes.back() && (&C + 1)->NewlinesBefore > 0)
813  return false;
814 
815  // Do not align operator= overloads.
816  FormatToken *Previous = C.Tok->getPreviousNonComment();
817  if (Previous && Previous->is(tok::kw_operator))
818  return false;
819 
820  return Style.AlignConsecutiveAssignments.AlignCompound
821  ? C.Tok->getPrecedence() == prec::Assignment
822  : C.Tok->is(tok::equal);
823  },
824  Changes, /*StartAt=*/0, Style.AlignConsecutiveAssignments,
825  /*RightJustify=*/true);
826 }
827 
828 void WhitespaceManager::alignConsecutiveBitFields() {
829  if (!Style.AlignConsecutiveBitFields.Enabled)
830  return;
831 
832  AlignTokens(
833  Style,
834  [&](Change const &C) {
835  // Do not align on ':' that is first on a line.
836  if (C.NewlinesBefore > 0)
837  return false;
838 
839  // Do not align on ':' that is last on a line.
840  if (&C != &Changes.back() && (&C + 1)->NewlinesBefore > 0)
841  return false;
842 
843  return C.Tok->is(TT_BitFieldColon);
844  },
845  Changes, /*StartAt=*/0, Style.AlignConsecutiveBitFields);
846 }
847 
848 void WhitespaceManager::alignConsecutiveDeclarations() {
849  if (!Style.AlignConsecutiveDeclarations.Enabled)
850  return;
851 
852  AlignTokens(
853  Style,
854  [](Change const &C) {
855  // tok::kw_operator is necessary for aligning operator overload
856  // definitions.
857  if (C.Tok->isOneOf(TT_FunctionDeclarationName, tok::kw_operator))
858  return true;
859  if (C.Tok->isNot(TT_StartOfName))
860  return false;
861  if (C.Tok->Previous &&
862  C.Tok->Previous->is(TT_StatementAttributeLikeMacro))
863  return false;
864  // Check if there is a subsequent name that starts the same declaration.
865  for (FormatToken *Next = C.Tok->Next; Next; Next = Next->Next) {
866  if (Next->is(tok::comment))
867  continue;
868  if (Next->is(TT_PointerOrReference))
869  return false;
870  if (!Next->Tok.getIdentifierInfo())
871  break;
872  if (Next->isOneOf(TT_StartOfName, TT_FunctionDeclarationName,
873  tok::kw_operator)) {
874  return false;
875  }
876  }
877  return true;
878  },
879  Changes, /*StartAt=*/0, Style.AlignConsecutiveDeclarations);
880 }
881 
882 void WhitespaceManager::alignChainedConditionals() {
883  if (Style.BreakBeforeTernaryOperators) {
884  AlignTokens(
885  Style,
886  [](Change const &C) {
887  // Align question operators and last colon
888  return C.Tok->is(TT_ConditionalExpr) &&
889  ((C.Tok->is(tok::question) && !C.NewlinesBefore) ||
890  (C.Tok->is(tok::colon) && C.Tok->Next &&
891  (C.Tok->Next->FakeLParens.size() == 0 ||
892  C.Tok->Next->FakeLParens.back() != prec::Conditional)));
893  },
894  Changes, /*StartAt=*/0);
895  } else {
896  static auto AlignWrappedOperand = [](Change const &C) {
897  FormatToken *Previous = C.Tok->getPreviousNonComment();
898  return C.NewlinesBefore && Previous && Previous->is(TT_ConditionalExpr) &&
899  (Previous->is(tok::colon) &&
900  (C.Tok->FakeLParens.size() == 0 ||
901  C.Tok->FakeLParens.back() != prec::Conditional));
902  };
903  // Ensure we keep alignment of wrapped operands with non-wrapped operands
904  // Since we actually align the operators, the wrapped operands need the
905  // extra offset to be properly aligned.
906  for (Change &C : Changes)
907  if (AlignWrappedOperand(C))
908  C.StartOfTokenColumn -= 2;
909  AlignTokens(
910  Style,
911  [this](Change const &C) {
912  // Align question operators if next operand is not wrapped, as
913  // well as wrapped operands after question operator or last
914  // colon in conditional sequence
915  return (C.Tok->is(TT_ConditionalExpr) && C.Tok->is(tok::question) &&
916  &C != &Changes.back() && (&C + 1)->NewlinesBefore == 0 &&
917  !(&C + 1)->IsTrailingComment) ||
918  AlignWrappedOperand(C);
919  },
920  Changes, /*StartAt=*/0);
921  }
922 }
923 
924 void WhitespaceManager::alignTrailingComments() {
925  unsigned MinColumn = 0;
926  unsigned MaxColumn = UINT_MAX;
927  unsigned StartOfSequence = 0;
928  bool BreakBeforeNext = false;
929  unsigned Newlines = 0;
930  for (unsigned i = 0, e = Changes.size(); i != e; ++i) {
931  if (Changes[i].StartOfBlockComment)
932  continue;
933  Newlines += Changes[i].NewlinesBefore;
934  if (!Changes[i].IsTrailingComment)
935  continue;
936 
937  unsigned ChangeMinColumn = Changes[i].StartOfTokenColumn;
938  unsigned ChangeMaxColumn;
939 
940  if (Style.ColumnLimit == 0)
941  ChangeMaxColumn = UINT_MAX;
942  else if (Style.ColumnLimit >= Changes[i].TokenLength)
943  ChangeMaxColumn = Style.ColumnLimit - Changes[i].TokenLength;
944  else
945  ChangeMaxColumn = ChangeMinColumn;
946 
947  // If we don't create a replacement for this change, we have to consider
948  // it to be immovable.
949  if (!Changes[i].CreateReplacement)
950  ChangeMaxColumn = ChangeMinColumn;
951 
952  if (i + 1 != e && Changes[i + 1].ContinuesPPDirective)
953  ChangeMaxColumn -= 2;
954  // If this comment follows an } in column 0, it probably documents the
955  // closing of a namespace and we don't want to align it.
956  bool FollowsRBraceInColumn0 = i > 0 && Changes[i].NewlinesBefore == 0 &&
957  Changes[i - 1].Tok->is(tok::r_brace) &&
958  Changes[i - 1].StartOfTokenColumn == 0;
959  bool WasAlignedWithStartOfNextLine = false;
960  if (Changes[i].NewlinesBefore == 1) { // A comment on its own line.
961  unsigned CommentColumn = SourceMgr.getSpellingColumnNumber(
962  Changes[i].OriginalWhitespaceRange.getEnd());
963  for (unsigned j = i + 1; j != e; ++j) {
964  if (Changes[j].Tok->is(tok::comment))
965  continue;
966 
967  unsigned NextColumn = SourceMgr.getSpellingColumnNumber(
968  Changes[j].OriginalWhitespaceRange.getEnd());
969  // The start of the next token was previously aligned with the
970  // start of this comment.
971  WasAlignedWithStartOfNextLine =
972  CommentColumn == NextColumn ||
973  CommentColumn == NextColumn + Style.IndentWidth;
974  break;
975  }
976  }
977  if (!Style.AlignTrailingComments || FollowsRBraceInColumn0) {
978  alignTrailingComments(StartOfSequence, i, MinColumn);
979  MinColumn = ChangeMinColumn;
980  MaxColumn = ChangeMinColumn;
981  StartOfSequence = i;
982  } else if (BreakBeforeNext || Newlines > 1 ||
983  (ChangeMinColumn > MaxColumn || ChangeMaxColumn < MinColumn) ||
984  // Break the comment sequence if the previous line did not end
985  // in a trailing comment.
986  (Changes[i].NewlinesBefore == 1 && i > 0 &&
987  !Changes[i - 1].IsTrailingComment) ||
988  WasAlignedWithStartOfNextLine) {
989  alignTrailingComments(StartOfSequence, i, MinColumn);
990  MinColumn = ChangeMinColumn;
991  MaxColumn = ChangeMaxColumn;
992  StartOfSequence = i;
993  } else {
994  MinColumn = std::max(MinColumn, ChangeMinColumn);
995  MaxColumn = std::min(MaxColumn, ChangeMaxColumn);
996  }
997  BreakBeforeNext = (i == 0) || (Changes[i].NewlinesBefore > 1) ||
998  // Never start a sequence with a comment at the beginning
999  // of the line.
1000  (Changes[i].NewlinesBefore == 1 && StartOfSequence == i);
1001  Newlines = 0;
1002  }
1003  alignTrailingComments(StartOfSequence, Changes.size(), MinColumn);
1004 }
1005 
1006 void WhitespaceManager::alignTrailingComments(unsigned Start, unsigned End,
1007  unsigned Column) {
1008  for (unsigned i = Start; i != End; ++i) {
1009  int Shift = 0;
1010  if (Changes[i].IsTrailingComment)
1011  Shift = Column - Changes[i].StartOfTokenColumn;
1012  if (Changes[i].StartOfBlockComment) {
1013  Shift = Changes[i].IndentationOffset +
1014  Changes[i].StartOfBlockComment->StartOfTokenColumn -
1015  Changes[i].StartOfTokenColumn;
1016  }
1017  if (Shift < 0)
1018  continue;
1019  Changes[i].Spaces += Shift;
1020  if (i + 1 != Changes.size())
1021  Changes[i + 1].PreviousEndOfTokenColumn += Shift;
1022  Changes[i].StartOfTokenColumn += Shift;
1023  }
1024 }
1025 
1026 void WhitespaceManager::alignEscapedNewlines() {
1027  if (Style.AlignEscapedNewlines == FormatStyle::ENAS_DontAlign)
1028  return;
1029 
1030  bool AlignLeft = Style.AlignEscapedNewlines == FormatStyle::ENAS_Left;
1031  unsigned MaxEndOfLine = AlignLeft ? 0 : Style.ColumnLimit;
1032  unsigned StartOfMacro = 0;
1033  for (unsigned i = 1, e = Changes.size(); i < e; ++i) {
1034  Change &C = Changes[i];
1035  if (C.NewlinesBefore > 0) {
1036  if (C.ContinuesPPDirective) {
1037  MaxEndOfLine = std::max(C.PreviousEndOfTokenColumn + 2, MaxEndOfLine);
1038  } else {
1039  alignEscapedNewlines(StartOfMacro + 1, i, MaxEndOfLine);
1040  MaxEndOfLine = AlignLeft ? 0 : Style.ColumnLimit;
1041  StartOfMacro = i;
1042  }
1043  }
1044  }
1045  alignEscapedNewlines(StartOfMacro + 1, Changes.size(), MaxEndOfLine);
1046 }
1047 
1048 void WhitespaceManager::alignEscapedNewlines(unsigned Start, unsigned End,
1049  unsigned Column) {
1050  for (unsigned i = Start; i < End; ++i) {
1051  Change &C = Changes[i];
1052  if (C.NewlinesBefore > 0) {
1053  assert(C.ContinuesPPDirective);
1054  if (C.PreviousEndOfTokenColumn + 1 > Column)
1055  C.EscapedNewlineColumn = 0;
1056  else
1057  C.EscapedNewlineColumn = Column;
1058  }
1059  }
1060 }
1061 
1062 void WhitespaceManager::alignArrayInitializers() {
1063  if (Style.AlignArrayOfStructures == FormatStyle::AIAS_None)
1064  return;
1065 
1066  for (unsigned ChangeIndex = 1U, ChangeEnd = Changes.size();
1067  ChangeIndex < ChangeEnd; ++ChangeIndex) {
1068  auto &C = Changes[ChangeIndex];
1069  if (C.Tok->IsArrayInitializer) {
1070  bool FoundComplete = false;
1071  for (unsigned InsideIndex = ChangeIndex + 1; InsideIndex < ChangeEnd;
1072  ++InsideIndex) {
1073  if (Changes[InsideIndex].Tok == C.Tok->MatchingParen) {
1074  alignArrayInitializers(ChangeIndex, InsideIndex + 1);
1075  ChangeIndex = InsideIndex + 1;
1076  FoundComplete = true;
1077  break;
1078  }
1079  }
1080  if (!FoundComplete)
1081  ChangeIndex = ChangeEnd;
1082  }
1083  }
1084 }
1085 
1086 void WhitespaceManager::alignArrayInitializers(unsigned Start, unsigned End) {
1087 
1088  if (Style.AlignArrayOfStructures == FormatStyle::AIAS_Right)
1089  alignArrayInitializersRightJustified(getCells(Start, End));
1090  else if (Style.AlignArrayOfStructures == FormatStyle::AIAS_Left)
1091  alignArrayInitializersLeftJustified(getCells(Start, End));
1092 }
1093 
1094 void WhitespaceManager::alignArrayInitializersRightJustified(
1095  CellDescriptions &&CellDescs) {
1096  if (!CellDescs.isRectangular())
1097  return;
1098 
1099  auto &Cells = CellDescs.Cells;
1100  // Now go through and fixup the spaces.
1101  auto *CellIter = Cells.begin();
1102  for (auto i = 0U; i < CellDescs.CellCounts[0]; ++i, ++CellIter) {
1103  unsigned NetWidth = 0U;
1104  if (isSplitCell(*CellIter))
1105  NetWidth = getNetWidth(Cells.begin(), CellIter, CellDescs.InitialSpaces);
1106  auto CellWidth = getMaximumCellWidth(CellIter, NetWidth);
1107 
1108  if (Changes[CellIter->Index].Tok->is(tok::r_brace)) {
1109  // So in here we want to see if there is a brace that falls
1110  // on a line that was split. If so on that line we make sure that
1111  // the spaces in front of the brace are enough.
1112  const auto *Next = CellIter;
1113  do {
1114  const FormatToken *Previous = Changes[Next->Index].Tok->Previous;
1115  if (Previous && Previous->isNot(TT_LineComment)) {
1116  Changes[Next->Index].Spaces = 0;
1117  Changes[Next->Index].NewlinesBefore = 0;
1118  }
1119  Next = Next->NextColumnElement;
1120  } while (Next);
1121  // Unless the array is empty, we need the position of all the
1122  // immediately adjacent cells
1123  if (CellIter != Cells.begin()) {
1124  auto ThisNetWidth =
1125  getNetWidth(Cells.begin(), CellIter, CellDescs.InitialSpaces);
1126  auto MaxNetWidth = getMaximumNetWidth(
1127  Cells.begin(), CellIter, CellDescs.InitialSpaces,
1128  CellDescs.CellCounts[0], CellDescs.CellCounts.size());
1129  if (ThisNetWidth < MaxNetWidth)
1130  Changes[CellIter->Index].Spaces = (MaxNetWidth - ThisNetWidth);
1131  auto RowCount = 1U;
1132  auto Offset = std::distance(Cells.begin(), CellIter);
1133  for (const auto *Next = CellIter->NextColumnElement; Next != nullptr;
1134  Next = Next->NextColumnElement) {
1135  auto *Start = (Cells.begin() + RowCount * CellDescs.CellCounts[0]);
1136  auto *End = Start + Offset;
1137  ThisNetWidth = getNetWidth(Start, End, CellDescs.InitialSpaces);
1138  if (ThisNetWidth < MaxNetWidth)
1139  Changes[Next->Index].Spaces = (MaxNetWidth - ThisNetWidth);
1140  ++RowCount;
1141  }
1142  }
1143  } else {
1144  auto ThisWidth =
1145  calculateCellWidth(CellIter->Index, CellIter->EndIndex, true) +
1146  NetWidth;
1147  if (Changes[CellIter->Index].NewlinesBefore == 0) {
1148  Changes[CellIter->Index].Spaces = (CellWidth - (ThisWidth + NetWidth));
1149  Changes[CellIter->Index].Spaces += (i > 0) ? 1 : 0;
1150  }
1151  alignToStartOfCell(CellIter->Index, CellIter->EndIndex);
1152  for (const auto *Next = CellIter->NextColumnElement; Next != nullptr;
1153  Next = Next->NextColumnElement) {
1154  ThisWidth =
1155  calculateCellWidth(Next->Index, Next->EndIndex, true) + NetWidth;
1156  if (Changes[Next->Index].NewlinesBefore == 0) {
1157  Changes[Next->Index].Spaces = (CellWidth - ThisWidth);
1158  Changes[Next->Index].Spaces += (i > 0) ? 1 : 0;
1159  }
1160  alignToStartOfCell(Next->Index, Next->EndIndex);
1161  }
1162  }
1163  }
1164 }
1165 
1166 void WhitespaceManager::alignArrayInitializersLeftJustified(
1167  CellDescriptions &&CellDescs) {
1168 
1169  if (!CellDescs.isRectangular())
1170  return;
1171 
1172  auto &Cells = CellDescs.Cells;
1173  // Now go through and fixup the spaces.
1174  auto *CellIter = Cells.begin();
1175  // The first cell needs to be against the left brace.
1176  if (Changes[CellIter->Index].NewlinesBefore == 0)
1177  Changes[CellIter->Index].Spaces = 0;
1178  else
1179  Changes[CellIter->Index].Spaces = CellDescs.InitialSpaces;
1180  ++CellIter;
1181  for (auto i = 1U; i < CellDescs.CellCounts[0]; i++, ++CellIter) {
1182  auto MaxNetWidth = getMaximumNetWidth(
1183  Cells.begin(), CellIter, CellDescs.InitialSpaces,
1184  CellDescs.CellCounts[0], CellDescs.CellCounts.size());
1185  auto ThisNetWidth =
1186  getNetWidth(Cells.begin(), CellIter, CellDescs.InitialSpaces);
1187  if (Changes[CellIter->Index].NewlinesBefore == 0) {
1188  Changes[CellIter->Index].Spaces =
1189  MaxNetWidth - ThisNetWidth +
1190  (Changes[CellIter->Index].Tok->isNot(tok::r_brace) ? 1 : 0);
1191  }
1192  auto RowCount = 1U;
1193  auto Offset = std::distance(Cells.begin(), CellIter);
1194  for (const auto *Next = CellIter->NextColumnElement; Next != nullptr;
1195  Next = Next->NextColumnElement) {
1196  if (RowCount > CellDescs.CellCounts.size())
1197  break;
1198  auto *Start = (Cells.begin() + RowCount * CellDescs.CellCounts[0]);
1199  auto *End = Start + Offset;
1200  auto ThisNetWidth = getNetWidth(Start, End, CellDescs.InitialSpaces);
1201  if (Changes[Next->Index].NewlinesBefore == 0) {
1202  Changes[Next->Index].Spaces =
1203  MaxNetWidth - ThisNetWidth +
1204  (Changes[Next->Index].Tok->isNot(tok::r_brace) ? 1 : 0);
1205  }
1206  ++RowCount;
1207  }
1208  }
1209 }
1210 
1211 bool WhitespaceManager::isSplitCell(const CellDescription &Cell) {
1212  if (Cell.HasSplit)
1213  return true;
1214  for (const auto *Next = Cell.NextColumnElement; Next != nullptr;
1215  Next = Next->NextColumnElement) {
1216  if (Next->HasSplit)
1217  return true;
1218  }
1219  return false;
1220 }
1221 
1222 WhitespaceManager::CellDescriptions WhitespaceManager::getCells(unsigned Start,
1223  unsigned End) {
1224 
1225  unsigned Depth = 0;
1226  unsigned Cell = 0;
1227  SmallVector<unsigned> CellCounts;
1228  unsigned InitialSpaces = 0;
1229  unsigned InitialTokenLength = 0;
1230  unsigned EndSpaces = 0;
1231  SmallVector<CellDescription> Cells;
1232  const FormatToken *MatchingParen = nullptr;
1233  for (unsigned i = Start; i < End; ++i) {
1234  auto &C = Changes[i];
1235  if (C.Tok->is(tok::l_brace))
1236  ++Depth;
1237  else if (C.Tok->is(tok::r_brace))
1238  --Depth;
1239  if (Depth == 2) {
1240  if (C.Tok->is(tok::l_brace)) {
1241  Cell = 0;
1242  MatchingParen = C.Tok->MatchingParen;
1243  if (InitialSpaces == 0) {
1244  InitialSpaces = C.Spaces + C.TokenLength;
1245  InitialTokenLength = C.TokenLength;
1246  auto j = i - 1;
1247  for (; Changes[j].NewlinesBefore == 0 && j > Start; --j) {
1248  InitialSpaces += Changes[j].Spaces + Changes[j].TokenLength;
1249  InitialTokenLength += Changes[j].TokenLength;
1250  }
1251  if (C.NewlinesBefore == 0) {
1252  InitialSpaces += Changes[j].Spaces + Changes[j].TokenLength;
1253  InitialTokenLength += Changes[j].TokenLength;
1254  }
1255  }
1256  } else if (C.Tok->is(tok::comma)) {
1257  if (!Cells.empty())
1258  Cells.back().EndIndex = i;
1259  if (C.Tok->getNextNonComment()->isNot(tok::r_brace)) // dangling comma
1260  ++Cell;
1261  }
1262  } else if (Depth == 1) {
1263  if (C.Tok == MatchingParen) {
1264  if (!Cells.empty())
1265  Cells.back().EndIndex = i;
1266  Cells.push_back(CellDescription{i, ++Cell, i + 1, false, nullptr});
1267  CellCounts.push_back(C.Tok->Previous->isNot(tok::comma) ? Cell + 1
1268  : Cell);
1269  // Go to the next non-comment and ensure there is a break in front
1270  const auto *NextNonComment = C.Tok->getNextNonComment();
1271  while (NextNonComment->is(tok::comma))
1272  NextNonComment = NextNonComment->getNextNonComment();
1273  auto j = i;
1274  while (Changes[j].Tok != NextNonComment && j < End)
1275  ++j;
1276  if (j < End && Changes[j].NewlinesBefore == 0 &&
1277  Changes[j].Tok->isNot(tok::r_brace)) {
1278  Changes[j].NewlinesBefore = 1;
1279  // Account for the added token lengths
1280  Changes[j].Spaces = InitialSpaces - InitialTokenLength;
1281  }
1282  } else if (C.Tok->is(tok::comment)) {
1283  // Trailing comments stay at a space past the last token
1284  C.Spaces = Changes[i - 1].Tok->is(tok::comma) ? 1 : 2;
1285  } else if (C.Tok->is(tok::l_brace)) {
1286  // We need to make sure that the ending braces is aligned to the
1287  // start of our initializer
1288  auto j = i - 1;
1289  for (; j > 0 && !Changes[j].Tok->ArrayInitializerLineStart; --j)
1290  ; // Nothing the loop does the work
1291  EndSpaces = Changes[j].Spaces;
1292  }
1293  } else if (Depth == 0 && C.Tok->is(tok::r_brace)) {
1294  C.NewlinesBefore = 1;
1295  C.Spaces = EndSpaces;
1296  }
1297  if (C.Tok->StartsColumn) {
1298  // This gets us past tokens that have been split over multiple
1299  // lines
1300  bool HasSplit = false;
1301  if (Changes[i].NewlinesBefore > 0) {
1302  // So if we split a line previously and the tail line + this token is
1303  // less then the column limit we remove the split here and just put
1304  // the column start at a space past the comma
1305  //
1306  // FIXME This if branch covers the cases where the column is not
1307  // the first column. This leads to weird pathologies like the formatting
1308  // auto foo = Items{
1309  // Section{
1310  // 0, bar(),
1311  // }
1312  // };
1313  // Well if it doesn't lead to that it's indicative that the line
1314  // breaking should be revisited. Unfortunately alot of other options
1315  // interact with this
1316  auto j = i - 1;
1317  if ((j - 1) > Start && Changes[j].Tok->is(tok::comma) &&
1318  Changes[j - 1].NewlinesBefore > 0) {
1319  --j;
1320  auto LineLimit = Changes[j].Spaces + Changes[j].TokenLength;
1321  if (LineLimit < Style.ColumnLimit) {
1322  Changes[i].NewlinesBefore = 0;
1323  Changes[i].Spaces = 1;
1324  }
1325  }
1326  }
1327  while (Changes[i].NewlinesBefore > 0 && Changes[i].Tok == C.Tok) {
1328  Changes[i].Spaces = InitialSpaces;
1329  ++i;
1330  HasSplit = true;
1331  }
1332  if (Changes[i].Tok != C.Tok)
1333  --i;
1334  Cells.push_back(CellDescription{i, Cell, i, HasSplit, nullptr});
1335  }
1336  }
1337 
1338  return linkCells({Cells, CellCounts, InitialSpaces});
1339 }
1340 
1341 unsigned WhitespaceManager::calculateCellWidth(unsigned Start, unsigned End,
1342  bool WithSpaces) const {
1343  unsigned CellWidth = 0;
1344  for (auto i = Start; i < End; i++) {
1345  if (Changes[i].NewlinesBefore > 0)
1346  CellWidth = 0;
1347  CellWidth += Changes[i].TokenLength;
1348  CellWidth += (WithSpaces ? Changes[i].Spaces : 0);
1349  }
1350  return CellWidth;
1351 }
1352 
1353 void WhitespaceManager::alignToStartOfCell(unsigned Start, unsigned End) {
1354  if ((End - Start) <= 1)
1355  return;
1356  // If the line is broken anywhere in there make sure everything
1357  // is aligned to the parent
1358  for (auto i = Start + 1; i < End; i++)
1359  if (Changes[i].NewlinesBefore > 0)
1360  Changes[i].Spaces = Changes[Start].Spaces;
1361 }
1362 
1363 WhitespaceManager::CellDescriptions
1364 WhitespaceManager::linkCells(CellDescriptions &&CellDesc) {
1365  auto &Cells = CellDesc.Cells;
1366  for (auto *CellIter = Cells.begin(); CellIter != Cells.end(); ++CellIter) {
1367  if (CellIter->NextColumnElement == nullptr &&
1368  ((CellIter + 1) != Cells.end())) {
1369  for (auto *NextIter = CellIter + 1; NextIter != Cells.end(); ++NextIter) {
1370  if (NextIter->Cell == CellIter->Cell) {
1371  CellIter->NextColumnElement = &(*NextIter);
1372  break;
1373  }
1374  }
1375  }
1376  }
1377  return std::move(CellDesc);
1378 }
1379 
1380 void WhitespaceManager::generateChanges() {
1381  for (unsigned i = 0, e = Changes.size(); i != e; ++i) {
1382  const Change &C = Changes[i];
1383  if (i > 0 && Changes[i - 1].OriginalWhitespaceRange.getBegin() ==
1384  C.OriginalWhitespaceRange.getBegin()) {
1385  // Do not generate two replacements for the same location.
1386  continue;
1387  }
1388  if (C.CreateReplacement) {
1389  std::string ReplacementText = C.PreviousLinePostfix;
1390  if (C.ContinuesPPDirective) {
1391  appendEscapedNewlineText(ReplacementText, C.NewlinesBefore,
1392  C.PreviousEndOfTokenColumn,
1393  C.EscapedNewlineColumn);
1394  } else {
1395  appendNewlineText(ReplacementText, C.NewlinesBefore);
1396  }
1397  // FIXME: This assert should hold if we computed the column correctly.
1398  // assert((int)C.StartOfTokenColumn >= C.Spaces);
1399  appendIndentText(
1400  ReplacementText, C.Tok->IndentLevel, std::max(0, C.Spaces),
1401  std::max((int)C.StartOfTokenColumn, C.Spaces) - std::max(0, C.Spaces),
1402  C.IsAligned);
1403  ReplacementText.append(C.CurrentLinePrefix);
1404  storeReplacement(C.OriginalWhitespaceRange, ReplacementText);
1405  }
1406  }
1407 }
1408 
1409 void WhitespaceManager::storeReplacement(SourceRange Range, StringRef Text) {
1410  unsigned WhitespaceLength = SourceMgr.getFileOffset(Range.getEnd()) -
1411  SourceMgr.getFileOffset(Range.getBegin());
1412  // Don't create a replacement, if it does not change anything.
1413  if (StringRef(SourceMgr.getCharacterData(Range.getBegin()),
1414  WhitespaceLength) == Text) {
1415  return;
1416  }
1417  auto Err = Replaces.add(tooling::Replacement(
1418  SourceMgr, CharSourceRange::getCharRange(Range), Text));
1419  // FIXME: better error handling. For now, just print an error message in the
1420  // release version.
1421  if (Err) {
1422  llvm::errs() << llvm::toString(std::move(Err)) << "\n";
1423  assert(false);
1424  }
1425 }
1426 
1427 void WhitespaceManager::appendNewlineText(std::string &Text,
1428  unsigned Newlines) {
1429  if (UseCRLF) {
1430  Text.reserve(Text.size() + 2 * Newlines);
1431  for (unsigned i = 0; i < Newlines; ++i)
1432  Text.append("\r\n");
1433  } else {
1434  Text.append(Newlines, '\n');
1435  }
1436 }
1437 
1438 void WhitespaceManager::appendEscapedNewlineText(
1439  std::string &Text, unsigned Newlines, unsigned PreviousEndOfTokenColumn,
1440  unsigned EscapedNewlineColumn) {
1441  if (Newlines > 0) {
1442  unsigned Spaces =
1443  std::max<int>(1, EscapedNewlineColumn - PreviousEndOfTokenColumn - 1);
1444  for (unsigned i = 0; i < Newlines; ++i) {
1445  Text.append(Spaces, ' ');
1446  Text.append(UseCRLF ? "\\\r\n" : "\\\n");
1447  Spaces = std::max<int>(0, EscapedNewlineColumn - 1);
1448  }
1449  }
1450 }
1451 
1452 void WhitespaceManager::appendIndentText(std::string &Text,
1453  unsigned IndentLevel, unsigned Spaces,
1454  unsigned WhitespaceStartColumn,
1455  bool IsAligned) {
1456  switch (Style.UseTab) {
1457  case FormatStyle::UT_Never:
1458  Text.append(Spaces, ' ');
1459  break;
1460  case FormatStyle::UT_Always: {
1461  if (Style.TabWidth) {
1462  unsigned FirstTabWidth =
1463  Style.TabWidth - WhitespaceStartColumn % Style.TabWidth;
1464 
1465  // Insert only spaces when we want to end up before the next tab.
1466  if (Spaces < FirstTabWidth || Spaces == 1) {
1467  Text.append(Spaces, ' ');
1468  break;
1469  }
1470  // Align to the next tab.
1471  Spaces -= FirstTabWidth;
1472  Text.append("\t");
1473 
1474  Text.append(Spaces / Style.TabWidth, '\t');
1475  Text.append(Spaces % Style.TabWidth, ' ');
1476  } else if (Spaces == 1) {
1477  Text.append(Spaces, ' ');
1478  }
1479  break;
1480  }
1482  if (WhitespaceStartColumn == 0) {
1483  unsigned Indentation = IndentLevel * Style.IndentWidth;
1484  Spaces = appendTabIndent(Text, Spaces, Indentation);
1485  }
1486  Text.append(Spaces, ' ');
1487  break;
1489  if (WhitespaceStartColumn == 0)
1490  Spaces = appendTabIndent(Text, Spaces, Spaces);
1491  Text.append(Spaces, ' ');
1492  break;
1494  if (WhitespaceStartColumn == 0) {
1495  unsigned Indentation =
1496  IsAligned ? IndentLevel * Style.IndentWidth : Spaces;
1497  Spaces = appendTabIndent(Text, Spaces, Indentation);
1498  }
1499  Text.append(Spaces, ' ');
1500  break;
1501  }
1502 }
1503 
1504 unsigned WhitespaceManager::appendTabIndent(std::string &Text, unsigned Spaces,
1505  unsigned Indentation) {
1506  // This happens, e.g. when a line in a block comment is indented less than the
1507  // first one.
1508  if (Indentation > Spaces)
1509  Indentation = Spaces;
1510  if (Style.TabWidth) {
1511  unsigned Tabs = Indentation / Style.TabWidth;
1512  Text.append(Tabs, '\t');
1513  Spaces -= Tabs * Style.TabWidth;
1514  }
1515  return Spaces;
1516 }
1517 
1518 } // namespace format
1519 } // namespace clang
clang::format::WhitespaceManager::Change::Spaces
int Spaces
Definition: WhitespaceManager.h:142
clang::format::WhitespaceManager::Change::ConditionalsLevel
int ConditionalsLevel
Definition: WhitespaceManager.h:169
clang::format::AlignTokenSequence
static void AlignTokenSequence(const FormatStyle &Style, unsigned Start, unsigned End, unsigned Column, bool RightJustify, F &&Matches, SmallVector< WhitespaceManager::Change, 16 > &Changes)
Definition: WhitespaceManager.cpp:275
clang::prec::Conditional
@ Conditional
Definition: OperatorPrecedence.h:30
max
__DEVICE__ int max(int __a, int __b)
Definition: __clang_cuda_math.h:196
clang::format::FormatStyle::AlignConsecutiveStyle
Alignment options.
Definition: Format.h:160
clang::format::AlignTokens
static unsigned AlignTokens(const FormatStyle &Style, F &&Matches, SmallVector< WhitespaceManager::Change, 16 > &Changes, unsigned StartAt, const FormatStyle::AlignConsecutiveStyle &ACS={}, bool RightJustify=false)
Definition: WhitespaceManager.cpp:494
clang::for
for(unsigned I=0, E=TL.getNumArgs();I !=E;++I)
Definition: RecursiveASTVisitor.h:1401
clang::SourceRange
A trivial tuple used to represent a source range.
Definition: SourceLocation.h:210
clang::format::AlignMacroSequence
static void AlignMacroSequence(unsigned &StartOfSequence, unsigned &EndOfSequence, unsigned &MinColumn, unsigned &MaxColumn, bool &FoundMatchOnLine, std::function< bool(const WhitespaceManager::Change &C)> AlignMacrosMatches, SmallVector< WhitespaceManager::Change, 16 > &Changes)
Definition: WhitespaceManager.cpp:665
string
string(SUBSTRING ${CMAKE_CURRENT_BINARY_DIR} 0 ${PATH_LIB_START} PATH_HEAD) string(SUBSTRING $
Definition: CMakeLists.txt:22
clang::format::WhitespaceManager::Change::StartOfTokenColumn
unsigned StartOfTokenColumn
Definition: WhitespaceManager.h:130
clang::SourceManager::getFileOffset
unsigned getFileOffset(SourceLocation SpellingLoc) const
Returns the offset from the start of the file that the specified SourceLocation represents.
Definition: SourceManager.h:1292
llvm::SmallVector
Definition: LLVM.h:38
clang::if
if(T->getSizeExpr()) TRY_TO(TraverseStmt(T -> getSizeExpr()))
Definition: RecursiveASTVisitor.h:1098
clang::SourceLocation
Encodes a location in the source.
Definition: SourceLocation.h:86
clang::SourceLocation::getLocWithOffset
SourceLocation getLocWithOffset(IntTy Offset) const
Return a source location with the specified offset from this SourceLocation.
Definition: SourceLocation.h:134
clang::SourceRange::getBegin
SourceLocation getBegin() const
Definition: SourceLocation.h:219
clang::format::WhitespaceManager::generateReplacements
const tooling::Replacements & generateReplacements()
Returns all the Replacements created during formatting.
Definition: WhitespaceManager.cpp:98
clang::format::WhitespaceManager::inputUsesCRLF
static bool inputUsesCRLF(StringRef Text, bool DefaultToCRLF)
Infers whether the input is using CRLF.
Definition: WhitespaceManager.cpp:77
AttributeLangSupport::C
@ C
Definition: SemaDeclAttr.cpp:55
clang::format::FormatStyle::PAS_Right
@ PAS_Right
Align pointer to the right.
Definition: Format.h:2857
clang::tooling::Replacements
Maintains a set of replacements that are conflict-free.
Definition: Replacement.h:209
clang::format::WhitespaceManager::Change::PreviousLinePostfix
std::string PreviousLinePostfix
Definition: WhitespaceManager.h:132
clang::format::WhitespaceManager::addUntouchableToken
void addUntouchableToken(const FormatToken &Tok, bool InPPDirective)
Adds information about an unchangeable token's whitespace.
Definition: WhitespaceManager.cpp:61
clang::format::WhitespaceManager::Change::CreateReplacement
bool CreateReplacement
Definition: WhitespaceManager.h:126
clang::format::FormatStyle
The FormatStyle is used to configure the formatting to follow specific guidelines.
Definition: Format.h:54
clang::format::FormatToken
A wrapper around a Token storing information about the whitespace characters preceding it.
Definition: FormatToken.h:227
clang::prec::Assignment
@ Assignment
Definition: OperatorPrecedence.h:29
clang::format::FormatToken::OriginalColumn
unsigned OriginalColumn
The original 0-based column of this token, including expanded tabs.
Definition: FormatToken.h:410
clang::format::WhitespaceManager::Change::Tok
const FormatToken * Tok
Definition: WhitespaceManager.h:124
clang::format::FormatToken::IsFirst
unsigned IsFirst
Indicates that this is the first token of the file.
Definition: FormatToken.h:264
clang::format::BK_BracedInit
@ BK_BracedInit
Definition: FormatToken.h:153
End
SourceLocation End
Definition: USRLocFinder.cpp:167
clang::format::WhitespaceManager::addReplacement
llvm::Error addReplacement(const tooling::Replacement &Replacement)
Definition: WhitespaceManager.cpp:73
clang::format::WhitespaceManager::Change::IndentationOffset
int IndentationOffset
Definition: WhitespaceManager.h:165
clang::SourceManager::getSpellingColumnNumber
unsigned getSpellingColumnNumber(SourceLocation Loc, bool *Invalid=nullptr) const
Definition: SourceManager.cpp:1232
clang::format::WhitespaceManager::Change
Represents a change before a token, a break inside a token, or the layout of an unchanged token (or w...
Definition: WhitespaceManager.h:94
clang::format::FormatToken::NewlinesBefore
unsigned NewlinesBefore
The number of newlines immediately before the Token.
Definition: FormatToken.h:375
Offset
unsigned Offset
Definition: Format.cpp:2574
clang::format::FormatStyle::ENAS_DontAlign
@ ENAS_DontAlign
Don't align escaped newlines.
Definition: Format.h:307
U
clang::CharSourceRange::getCharRange
static CharSourceRange getCharRange(SourceRange R)
Definition: SourceLocation.h:265
clang::format::FormatStyle::UT_Always
@ UT_Always
Use tabs whenever we need to fill whitespace that spans at least from one tab stop to the next one.
Definition: Format.h:3837
clang::format::WhitespaceManager::Change::OriginalWhitespaceRange
SourceRange OriginalWhitespaceRange
Definition: WhitespaceManager.h:129
clang::format::WhitespaceManager::Change::IsTrailingComment
bool IsTrailingComment
Definition: WhitespaceManager.h:151
min
__DEVICE__ int min(int __a, int __b)
Definition: __clang_cuda_math.h:197
clang::format::WhitespaceManager::Change::IsInsideToken
bool IsInsideToken
Definition: WhitespaceManager.h:146
clang::threadSafety::sx::toString
std::string toString(const til::SExpr *E)
Definition: ThreadSafetyCommon.h:90
clang::format::FormatStyle::ENAS_Left
@ ENAS_Left
Align escaped newlines as far left as possible.
Definition: Format.h:318
clang::format::WhitespaceManager::Change::IsAligned
bool IsAligned
Definition: WhitespaceManager.h:134
clang::dependency_directives_scan::pp_define
@ pp_define
Definition: DependencyDirectivesScanner.h:63
Depth
int Depth
Definition: ASTDiff.cpp:191
clang::format::FormatStyle::AIAS_None
@ AIAS_None
Don't align array initializer columns.
Definition: Format.h:130
clang::format::FD_Break
@ FD_Break
Definition: FormatToken.h:158
WhitespaceManager.h
clang::format::WhitespaceManager::Change::Change
Change(const FormatToken &Tok, bool CreateReplacement, SourceRange OriginalWhitespaceRange, int Spaces, unsigned StartOfTokenColumn, unsigned NewlinesBefore, StringRef PreviousLinePostfix, StringRef CurrentLinePrefix, bool IsAligned, bool ContinuesPPDirective, bool IsInsideToken)
Creates a Change.
Definition: WhitespaceManager.cpp:29
clang::format::WhitespaceManager::Change::NewlinesBefore
unsigned NewlinesBefore
Definition: WhitespaceManager.h:131
clang::SourceManager::isBeforeInTranslationUnit
bool isBeforeInTranslationUnit(SourceLocation LHS, SourceLocation RHS) const
Determines the order of 2 source locations in the translation unit.
Definition: SourceManager.cpp:2014
clang::format::FormatStyle::AIAS_Left
@ AIAS_Left
Align array column and left justify the columns e.g.
Definition: Format.h:118
clang::format::FormatStyle::UT_Never
@ UT_Never
Never use tab.
Definition: Format.h:3826
clang::format::WhitespaceManager::Change::TokenLength
unsigned TokenLength
Definition: WhitespaceManager.h:152
clang::transformer::EditKind::Range
@ Range
clang::format::WhitespaceManager::Change::ContinuesPPDirective
bool ContinuesPPDirective
Definition: WhitespaceManager.h:135
false
#define false
Definition: stdbool.h:22
clang::format::FormatToken::Finalized
unsigned Finalized
If true, this token has been fully formatted (indented and potentially re-formatted inside),...
Definition: FormatToken.h:300
UINT_MAX
#define UINT_MAX
Definition: limits.h:56
clang::format::WhitespaceManager::Change::CurrentLinePrefix
std::string CurrentLinePrefix
Definition: WhitespaceManager.h:133
clang::SourceManager::getCharacterData
const char * getCharacterData(SourceLocation SL, bool *Invalid=nullptr) const
Return a pointer to the start of the specified location in the appropriate spelling MemoryBuffer.
Definition: SourceManager.cpp:1152
clang::tooling::Replacement
A text replacement.
Definition: Replacement.h:83
clang::format::WhitespaceManager::Change::PreviousEndOfTokenColumn
unsigned PreviousEndOfTokenColumn
Definition: WhitespaceManager.h:153
clang::format::FormatToken::getStartOfNonWhitespace
SourceLocation getStartOfNonWhitespace() const
Returns actual token start location without leading escaped newlines and whitespace.
Definition: FormatToken.h:680
clang::format::FD_Continue
@ FD_Continue
Definition: FormatToken.h:158
clang::format::WhitespaceManager::Change::StartOfBlockComment
const Change * StartOfBlockComment
Definition: WhitespaceManager.h:164
clang::format::WhitespaceManager::Change::IsBeforeInFile::operator()
bool operator()(const Change &C1, const Change &C2) const
Definition: WhitespaceManager.cpp:22
clang
Definition: CalledOnceCheck.h:17
Text
StringRef Text
Definition: Format.cpp:2573
distance
float __ovld __cnfn distance(float, float)
Returns the distance between p0 and p1.
clang::format::WhitespaceManager::Change::EscapedNewlineColumn
unsigned EscapedNewlineColumn
Definition: WhitespaceManager.h:154
clang::format::FormatStyle::AIAS_Right
@ AIAS_Right
Align array column and right justify the columns e.g.
Definition: Format.h:128
clang::format::WhitespaceManager::Change::IsBeforeInFile
Functor to sort changes in original source order.
Definition: WhitespaceManager.h:96
clang::tooling::Replacements::add
llvm::Error add(const Replacement &R)
Adds a new replacement R to the current set of replacements.
Definition: Replacement.cpp:245
clang::format::FormatStyle::UT_ForContinuationAndIndentation
@ UT_ForContinuationAndIndentation
Fill all leading whitespace with tabs, and use spaces for alignment that appears within a line (e....
Definition: Format.h:3831
clang::comments::tok::eof
@ eof
Definition: CommentLexer.h:33
Previous
StateNode * Previous
Definition: UnwrappedLineFormatter.cpp:1128
clang::format::FormatToken::WhitespaceRange
SourceRange WhitespaceRange
The range of the whitespace immediately preceding the Token.
Definition: FormatToken.h:254
clang::format::WhitespaceManager::replaceWhitespaceInToken
void replaceWhitespaceInToken(const FormatToken &Tok, unsigned Offset, unsigned ReplaceChars, StringRef PreviousPostfix, StringRef CurrentPrefix, bool InPPDirective, unsigned Newlines, int Spaces)
Inserts or replaces whitespace in the middle of a token.
Definition: WhitespaceManager.cpp:83
clang::prec::Shift
@ Shift
Definition: OperatorPrecedence.h:39
clang::format::WhitespaceManager::replaceWhitespace
void replaceWhitespace(FormatToken &Tok, unsigned Newlines, unsigned Spaces, unsigned StartOfTokenColumn, bool isAligned=false, bool InPPDirective=false)
Replaces the whitespace in front of Tok.
Definition: WhitespaceManager.cpp:48
clang::format::FormatStyle::UT_ForIndentation
@ UT_ForIndentation
Use tabs only for indentation.
Definition: Format.h:3828
clang::format::FormatStyle::UT_AlignWithSpaces
@ UT_AlignWithSpaces
Use tabs for line continuation and indentation, and spaces for alignment.
Definition: Format.h:3834
clang::format::FormatToken::setDecision
void setDecision(FormatDecision D)
Definition: FormatToken.h:326