Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 1 | //===--- 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 |
| 11 | /// \brief This file implements functions declared in Format.h. This will be |
| 12 | /// split into separate files as we go. |
| 13 | /// |
| 14 | /// This is EXPERIMENTAL code under heavy development. It is not in a state yet, |
| 15 | /// where it can be used to format real code. |
| 16 | /// |
| 17 | //===----------------------------------------------------------------------===// |
| 18 | |
| 19 | #include "clang/Format/Format.h" |
Chandler Carruth | 55fc873 | 2012-12-04 09:13:33 +0000 | [diff] [blame] | 20 | #include "UnwrappedLineParser.h" |
Daniel Jasper | 675d2e3 | 2012-12-21 10:20:02 +0000 | [diff] [blame] | 21 | #include "clang/Basic/OperatorPrecedence.h" |
Chandler Carruth | b99083e | 2013-01-02 10:28:36 +0000 | [diff] [blame] | 22 | #include "clang/Basic/SourceManager.h" |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 23 | #include "clang/Lex/Lexer.h" |
Daniel Jasper | 8822d3a | 2012-12-04 13:02:32 +0000 | [diff] [blame] | 24 | #include <string> |
| 25 | |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 26 | namespace clang { |
| 27 | namespace format { |
| 28 | |
Daniel Jasper | 7160751 | 2013-01-07 10:48:50 +0000 | [diff] [blame] | 29 | enum TokenType { |
| 30 | TT_Unknown, |
| 31 | TT_TemplateOpener, |
| 32 | TT_TemplateCloser, |
| 33 | TT_BinaryOperator, |
| 34 | TT_UnaryOperator, |
| 35 | TT_TrailingUnaryOperator, |
| 36 | TT_OverloadedOperator, |
| 37 | TT_PointerOrReference, |
| 38 | TT_ConditionalExpr, |
| 39 | TT_CtorInitializerColon, |
| 40 | TT_LineComment, |
| 41 | TT_BlockComment, |
| 42 | TT_DirectorySeparator, |
| 43 | TT_PureVirtualSpecifier, |
| 44 | TT_ObjCMethodSpecifier |
| 45 | }; |
| 46 | |
| 47 | enum LineType { |
| 48 | LT_Invalid, |
| 49 | LT_Other, |
| 50 | LT_PreprocessorDirective, |
| 51 | LT_VirtualFunctionDecl, |
| 52 | LT_ObjCMethodDecl |
| 53 | }; |
| 54 | |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 55 | class AnnotatedToken { |
| 56 | public: |
| 57 | AnnotatedToken(const FormatToken &FormatTok) |
| 58 | : FormatTok(FormatTok), Type(TT_Unknown), |
| 59 | ClosesTemplateDeclaration(false), Parent(NULL) { |
| 60 | } |
| 61 | |
| 62 | bool is(tok::TokenKind Kind) const { |
| 63 | return FormatTok.Tok.is(Kind); |
| 64 | } |
| 65 | bool isNot(tok::TokenKind Kind) const { |
| 66 | return FormatTok.Tok.isNot(Kind); |
| 67 | } |
| 68 | bool isObjCAtKeyword(tok::ObjCKeywordKind Kind) const { |
| 69 | return FormatTok.Tok.isObjCAtKeyword(Kind); |
| 70 | } |
| 71 | |
| 72 | FormatToken FormatTok; |
| 73 | |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 74 | TokenType Type; |
| 75 | |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 76 | bool SpaceRequiredBefore; |
| 77 | bool CanBreakBefore; |
| 78 | bool MustBreakBefore; |
Daniel Jasper | 9a64fb5 | 2013-01-02 15:08:56 +0000 | [diff] [blame] | 79 | |
| 80 | bool ClosesTemplateDeclaration; |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 81 | |
| 82 | std::vector<AnnotatedToken> Children; |
| 83 | AnnotatedToken *Parent; |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 84 | }; |
| 85 | |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 86 | static prec::Level getPrecedence(const AnnotatedToken &Tok) { |
| 87 | return getBinOpPrecedence(Tok.FormatTok.Tok.getKind(), true, true); |
Daniel Jasper | cf225b6 | 2012-12-24 13:43:52 +0000 | [diff] [blame] | 88 | } |
| 89 | |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 90 | using llvm::MutableArrayRef; |
| 91 | |
| 92 | FormatStyle getLLVMStyle() { |
| 93 | FormatStyle LLVMStyle; |
| 94 | LLVMStyle.ColumnLimit = 80; |
| 95 | LLVMStyle.MaxEmptyLinesToKeep = 1; |
| 96 | LLVMStyle.PointerAndReferenceBindToType = false; |
| 97 | LLVMStyle.AccessModifierOffset = -2; |
| 98 | LLVMStyle.SplitTemplateClosingGreater = true; |
Alexander Kornienko | 1575731 | 2012-12-06 18:03:27 +0000 | [diff] [blame] | 99 | LLVMStyle.IndentCaseLabels = false; |
Daniel Jasper | 7ad4eff | 2013-01-07 11:09:06 +0000 | [diff] [blame] | 100 | LLVMStyle.SpacesBeforeTrailingComments = 1; |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 101 | return LLVMStyle; |
| 102 | } |
| 103 | |
| 104 | FormatStyle getGoogleStyle() { |
| 105 | FormatStyle GoogleStyle; |
| 106 | GoogleStyle.ColumnLimit = 80; |
| 107 | GoogleStyle.MaxEmptyLinesToKeep = 1; |
| 108 | GoogleStyle.PointerAndReferenceBindToType = true; |
| 109 | GoogleStyle.AccessModifierOffset = -1; |
| 110 | GoogleStyle.SplitTemplateClosingGreater = false; |
Alexander Kornienko | 1575731 | 2012-12-06 18:03:27 +0000 | [diff] [blame] | 111 | GoogleStyle.IndentCaseLabels = true; |
Daniel Jasper | 7ad4eff | 2013-01-07 11:09:06 +0000 | [diff] [blame] | 112 | GoogleStyle.SpacesBeforeTrailingComments = 2; |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 113 | return GoogleStyle; |
| 114 | } |
| 115 | |
| 116 | struct OptimizationParameters { |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 117 | unsigned PenaltyIndentLevel; |
Daniel Jasper | a4974cf | 2012-12-24 16:43:00 +0000 | [diff] [blame] | 118 | unsigned PenaltyLevelDecrease; |
Daniel Jasper | ceb99ab | 2013-01-09 10:16:05 +0000 | [diff] [blame] | 119 | unsigned PenaltyExcessCharacter; |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 120 | }; |
| 121 | |
| 122 | class UnwrappedLineFormatter { |
| 123 | public: |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 124 | UnwrappedLineFormatter( |
| 125 | const FormatStyle &Style, SourceManager &SourceMgr, |
| 126 | const UnwrappedLine &Line, unsigned PreviousEndOfLineColumn, |
| 127 | LineType CurrentLineType, const AnnotatedToken &RootToken, |
| 128 | tooling::Replacements &Replaces, bool StructuralError) |
Daniel Jasper | 1321eb5 | 2012-12-18 21:05:13 +0000 | [diff] [blame] | 129 | : Style(Style), SourceMgr(SourceMgr), Line(Line), |
Manuel Klimek | d4397b9 | 2013-01-04 23:34:14 +0000 | [diff] [blame] | 130 | PreviousEndOfLineColumn(PreviousEndOfLineColumn), |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 131 | CurrentLineType(CurrentLineType), RootToken(RootToken), |
Daniel Jasper | 7160751 | 2013-01-07 10:48:50 +0000 | [diff] [blame] | 132 | Replaces(Replaces), StructuralError(StructuralError) { |
Daniel Jasper | e2c7acf | 2012-12-24 00:13:23 +0000 | [diff] [blame] | 133 | Parameters.PenaltyIndentLevel = 15; |
Daniel Jasper | 46a46a2 | 2013-01-07 07:13:20 +0000 | [diff] [blame] | 134 | Parameters.PenaltyLevelDecrease = 30; |
Daniel Jasper | ceb99ab | 2013-01-09 10:16:05 +0000 | [diff] [blame] | 135 | Parameters.PenaltyExcessCharacter = 1000000; |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 136 | } |
| 137 | |
Manuel Klimek | d4397b9 | 2013-01-04 23:34:14 +0000 | [diff] [blame] | 138 | /// \brief Formats an \c UnwrappedLine. |
| 139 | /// |
| 140 | /// \returns The column after the last token in the last line of the |
| 141 | /// \c UnwrappedLine. |
| 142 | unsigned format() { |
Daniel Jasper | 3b5943f | 2012-12-06 09:56:08 +0000 | [diff] [blame] | 143 | // Format first token and initialize indent. |
Alexander Kornienko | cff563c | 2012-12-04 17:27:50 +0000 | [diff] [blame] | 144 | unsigned Indent = formatFirstToken(); |
Daniel Jasper | 3b5943f | 2012-12-06 09:56:08 +0000 | [diff] [blame] | 145 | |
| 146 | // Initialize state dependent on indent. |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 147 | IndentState State; |
Daniel Jasper | 3b5943f | 2012-12-06 09:56:08 +0000 | [diff] [blame] | 148 | State.Column = Indent; |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 149 | State.NextToken = &RootToken; |
Alexander Kornienko | cff563c | 2012-12-04 17:27:50 +0000 | [diff] [blame] | 150 | State.Indent.push_back(Indent + 4); |
| 151 | State.LastSpace.push_back(Indent); |
Daniel Jasper | 3b5943f | 2012-12-06 09:56:08 +0000 | [diff] [blame] | 152 | State.FirstLessLess.push_back(0); |
Daniel Jasper | a324a0e | 2012-12-21 14:37:20 +0000 | [diff] [blame] | 153 | State.ForLoopVariablePos = 0; |
| 154 | State.LineContainsContinuedForLoopSection = false; |
Daniel Jasper | a4974cf | 2012-12-24 16:43:00 +0000 | [diff] [blame] | 155 | State.StartOfLineLevel = 1; |
Daniel Jasper | 3b5943f | 2012-12-06 09:56:08 +0000 | [diff] [blame] | 156 | |
| 157 | // The first token has already been indented and thus consumed. |
| 158 | moveStateToNextToken(State); |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 159 | |
Daniel Jasper | 1321eb5 | 2012-12-18 21:05:13 +0000 | [diff] [blame] | 160 | // Check whether the UnwrappedLine can be put onto a single line. If so, |
| 161 | // this is bound to be the optimal solution (by definition) and we don't |
Daniel Jasper | 1f42f11 | 2013-01-04 18:52:56 +0000 | [diff] [blame] | 162 | // need to analyze the entire solution space. |
Daniel Jasper | 1321eb5 | 2012-12-18 21:05:13 +0000 | [diff] [blame] | 163 | unsigned Columns = State.Column; |
| 164 | bool FitsOnALine = true; |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 165 | const AnnotatedToken *Tok = State.NextToken; |
| 166 | while (Tok != NULL) { |
| 167 | Columns += (Tok->SpaceRequiredBefore ? 1 : 0) + |
| 168 | Tok->FormatTok.TokenLength; |
Daniel Jasper | 1321eb5 | 2012-12-18 21:05:13 +0000 | [diff] [blame] | 169 | // A special case for the colon of a constructor initializer as this only |
| 170 | // needs to be put on a new line if the line needs to be split. |
Manuel Klimek | d544c57 | 2013-01-07 09:24:17 +0000 | [diff] [blame] | 171 | if (Columns > Style.ColumnLimit - (Line.InPPDirective ? 1 : 0) || |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 172 | (Tok->MustBreakBefore && Tok->Type != TT_CtorInitializerColon)) { |
Daniel Jasper | 1321eb5 | 2012-12-18 21:05:13 +0000 | [diff] [blame] | 173 | FitsOnALine = false; |
| 174 | break; |
| 175 | } |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 176 | Tok = Tok->Children.empty() ? NULL : &Tok->Children[0]; |
Daniel Jasper | 1321eb5 | 2012-12-18 21:05:13 +0000 | [diff] [blame] | 177 | } |
| 178 | |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 179 | // Start iterating at 1 as we have correctly formatted of Token #0 above. |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 180 | while (State.NextToken != NULL) { |
Daniel Jasper | 1321eb5 | 2012-12-18 21:05:13 +0000 | [diff] [blame] | 181 | if (FitsOnALine) { |
| 182 | addTokenToState(false, false, State); |
| 183 | } else { |
| 184 | unsigned NoBreak = calcPenalty(State, false, UINT_MAX); |
| 185 | unsigned Break = calcPenalty(State, true, NoBreak); |
| 186 | addTokenToState(Break < NoBreak, false, State); |
| 187 | } |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 188 | } |
Manuel Klimek | d4397b9 | 2013-01-04 23:34:14 +0000 | [diff] [blame] | 189 | return State.Column; |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 190 | } |
| 191 | |
| 192 | private: |
| 193 | /// \brief The current state when indenting a unwrapped line. |
| 194 | /// |
| 195 | /// As the indenting tries different combinations this is copied by value. |
| 196 | struct IndentState { |
| 197 | /// \brief The number of used columns in the current line. |
| 198 | unsigned Column; |
| 199 | |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 200 | const AnnotatedToken *NextToken; |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 201 | |
Daniel Jasper | a4974cf | 2012-12-24 16:43:00 +0000 | [diff] [blame] | 202 | /// \brief The parenthesis level of the first token on the current line. |
| 203 | unsigned StartOfLineLevel; |
| 204 | |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 205 | /// \brief The position to which a specific parenthesis level needs to be |
| 206 | /// indented. |
| 207 | std::vector<unsigned> Indent; |
| 208 | |
Daniel Jasper | 3b5943f | 2012-12-06 09:56:08 +0000 | [diff] [blame] | 209 | /// \brief The position of the last space on each level. |
| 210 | /// |
| 211 | /// Used e.g. to break like: |
| 212 | /// functionCall(Parameter, otherCall( |
| 213 | /// OtherParameter)); |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 214 | std::vector<unsigned> LastSpace; |
| 215 | |
Daniel Jasper | 3b5943f | 2012-12-06 09:56:08 +0000 | [diff] [blame] | 216 | /// \brief The position the first "<<" operator encountered on each level. |
| 217 | /// |
| 218 | /// Used to align "<<" operators. 0 if no such operator has been encountered |
| 219 | /// on a level. |
| 220 | std::vector<unsigned> FirstLessLess; |
| 221 | |
Daniel Jasper | a324a0e | 2012-12-21 14:37:20 +0000 | [diff] [blame] | 222 | /// \brief The column of the first variable in a for-loop declaration. |
| 223 | /// |
| 224 | /// Used to align the second variable if necessary. |
| 225 | unsigned ForLoopVariablePos; |
| 226 | |
| 227 | /// \brief \c true if this line contains a continued for-loop section. |
| 228 | bool LineContainsContinuedForLoopSection; |
| 229 | |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 230 | /// \brief Comparison operator to be able to used \c IndentState in \c map. |
| 231 | bool operator<(const IndentState &Other) const { |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 232 | if (Other.NextToken != NextToken) |
| 233 | return Other.NextToken > NextToken; |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 234 | if (Other.Column != Column) |
| 235 | return Other.Column > Column; |
Daniel Jasper | a4974cf | 2012-12-24 16:43:00 +0000 | [diff] [blame] | 236 | if (Other.StartOfLineLevel != StartOfLineLevel) |
| 237 | return Other.StartOfLineLevel > StartOfLineLevel; |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 238 | if (Other.Indent.size() != Indent.size()) |
| 239 | return Other.Indent.size() > Indent.size(); |
| 240 | for (int i = 0, e = Indent.size(); i != e; ++i) { |
| 241 | if (Other.Indent[i] != Indent[i]) |
| 242 | return Other.Indent[i] > Indent[i]; |
| 243 | } |
| 244 | if (Other.LastSpace.size() != LastSpace.size()) |
| 245 | return Other.LastSpace.size() > LastSpace.size(); |
| 246 | for (int i = 0, e = LastSpace.size(); i != e; ++i) { |
| 247 | if (Other.LastSpace[i] != LastSpace[i]) |
| 248 | return Other.LastSpace[i] > LastSpace[i]; |
| 249 | } |
Daniel Jasper | 3b5943f | 2012-12-06 09:56:08 +0000 | [diff] [blame] | 250 | if (Other.FirstLessLess.size() != FirstLessLess.size()) |
| 251 | return Other.FirstLessLess.size() > FirstLessLess.size(); |
| 252 | for (int i = 0, e = FirstLessLess.size(); i != e; ++i) { |
| 253 | if (Other.FirstLessLess[i] != FirstLessLess[i]) |
| 254 | return Other.FirstLessLess[i] > FirstLessLess[i]; |
| 255 | } |
Daniel Jasper | a324a0e | 2012-12-21 14:37:20 +0000 | [diff] [blame] | 256 | if (Other.ForLoopVariablePos != ForLoopVariablePos) |
| 257 | return Other.ForLoopVariablePos < ForLoopVariablePos; |
| 258 | if (Other.LineContainsContinuedForLoopSection != |
| 259 | LineContainsContinuedForLoopSection) |
| 260 | return LineContainsContinuedForLoopSection; |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 261 | return false; |
| 262 | } |
| 263 | }; |
| 264 | |
Daniel Jasper | 2040915 | 2012-12-04 14:54:30 +0000 | [diff] [blame] | 265 | /// \brief Appends the next token to \p State and updates information |
| 266 | /// necessary for indentation. |
| 267 | /// |
| 268 | /// Puts the token on the current line if \p Newline is \c true and adds a |
| 269 | /// line break and necessary indentation otherwise. |
| 270 | /// |
| 271 | /// If \p DryRun is \c false, also creates and stores the required |
| 272 | /// \c Replacement. |
| 273 | void addTokenToState(bool Newline, bool DryRun, IndentState &State) { |
Daniel Jasper | 9c837d0 | 2013-01-09 07:06:56 +0000 | [diff] [blame] | 274 | const AnnotatedToken &Current = *State.NextToken; |
| 275 | const AnnotatedToken &Previous = *State.NextToken->Parent; |
Daniel Jasper | 2040915 | 2012-12-04 14:54:30 +0000 | [diff] [blame] | 276 | unsigned ParenLevel = State.Indent.size() - 1; |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 277 | |
| 278 | if (Newline) { |
Manuel Klimek | 060143e | 2013-01-02 18:33:23 +0000 | [diff] [blame] | 279 | unsigned WhitespaceStartColumn = State.Column; |
Daniel Jasper | 9c837d0 | 2013-01-09 07:06:56 +0000 | [diff] [blame] | 280 | if (Previous.is(tok::l_brace)) { |
Daniel Jasper | 9cda800 | 2013-01-07 13:08:40 +0000 | [diff] [blame] | 281 | // FIXME: This does not work with nested static initializers. |
| 282 | // Implement a better handling for static initializers and similar |
| 283 | // constructs. |
| 284 | State.Column = Line.Level * 2 + 2; |
Daniel Jasper | 9c837d0 | 2013-01-09 07:06:56 +0000 | [diff] [blame] | 285 | } else if (Current.is(tok::string_literal) && |
| 286 | Previous.is(tok::string_literal)) { |
| 287 | State.Column = State.Column - Previous.FormatTok.TokenLength; |
| 288 | } else if (Current.is(tok::lessless) && |
Daniel Jasper | a324a0e | 2012-12-21 14:37:20 +0000 | [diff] [blame] | 289 | State.FirstLessLess[ParenLevel] != 0) { |
Daniel Jasper | 3b5943f | 2012-12-06 09:56:08 +0000 | [diff] [blame] | 290 | State.Column = State.FirstLessLess[ParenLevel]; |
Daniel Jasper | a324a0e | 2012-12-21 14:37:20 +0000 | [diff] [blame] | 291 | } else if (ParenLevel != 0 && |
Daniel Jasper | 9c837d0 | 2013-01-09 07:06:56 +0000 | [diff] [blame] | 292 | (Previous.is(tok::equal) || Current.is(tok::arrow) || |
| 293 | Current.is(tok::period) || Previous.is(tok::question) || |
| 294 | Previous.Type == TT_ConditionalExpr)) { |
| 295 | // Indent and extra 4 spaces after if we know the current expression is |
| 296 | // continued. Don't do that on the top level, as we already indent 4 |
| 297 | // there. |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 298 | State.Column = State.Indent[ParenLevel] + 4; |
Daniel Jasper | 9c837d0 | 2013-01-09 07:06:56 +0000 | [diff] [blame] | 299 | } else if (RootToken.is(tok::kw_for) && Previous.is(tok::comma)) { |
Daniel Jasper | a324a0e | 2012-12-21 14:37:20 +0000 | [diff] [blame] | 300 | State.Column = State.ForLoopVariablePos; |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 301 | } else if (State.NextToken->Parent->ClosesTemplateDeclaration) { |
Daniel Jasper | 9a64fb5 | 2013-01-02 15:08:56 +0000 | [diff] [blame] | 302 | State.Column = State.Indent[ParenLevel] - 4; |
Daniel Jasper | a324a0e | 2012-12-21 14:37:20 +0000 | [diff] [blame] | 303 | } else { |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 304 | State.Column = State.Indent[ParenLevel]; |
Daniel Jasper | a324a0e | 2012-12-21 14:37:20 +0000 | [diff] [blame] | 305 | } |
| 306 | |
Daniel Jasper | a4974cf | 2012-12-24 16:43:00 +0000 | [diff] [blame] | 307 | State.StartOfLineLevel = ParenLevel + 1; |
| 308 | |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 309 | if (RootToken.is(tok::kw_for)) |
Daniel Jasper | 9c837d0 | 2013-01-09 07:06:56 +0000 | [diff] [blame] | 310 | State.LineContainsContinuedForLoopSection = Previous.isNot(tok::semi); |
Daniel Jasper | 2040915 | 2012-12-04 14:54:30 +0000 | [diff] [blame] | 311 | |
Manuel Klimek | 060143e | 2013-01-02 18:33:23 +0000 | [diff] [blame] | 312 | if (!DryRun) { |
| 313 | if (!Line.InPPDirective) |
Daniel Jasper | 9c837d0 | 2013-01-09 07:06:56 +0000 | [diff] [blame] | 314 | replaceWhitespace(Current.FormatTok, 1, State.Column); |
Manuel Klimek | 060143e | 2013-01-02 18:33:23 +0000 | [diff] [blame] | 315 | else |
Daniel Jasper | 9c837d0 | 2013-01-09 07:06:56 +0000 | [diff] [blame] | 316 | replacePPWhitespace(Current.FormatTok, 1, State.Column, |
| 317 | WhitespaceStartColumn); |
Manuel Klimek | 060143e | 2013-01-02 18:33:23 +0000 | [diff] [blame] | 318 | } |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 319 | |
Daniel Jasper | d64f738 | 2013-01-09 09:50:48 +0000 | [diff] [blame] | 320 | State.LastSpace[ParenLevel] = State.Column; |
Daniel Jasper | 9c837d0 | 2013-01-09 07:06:56 +0000 | [diff] [blame] | 321 | if (Current.is(tok::colon) && CurrentLineType != LT_ObjCMethodDecl && |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 322 | State.NextToken->Type != TT_ConditionalExpr) |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 323 | State.Indent[ParenLevel] += 2; |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 324 | } else { |
Daniel Jasper | 9c837d0 | 2013-01-09 07:06:56 +0000 | [diff] [blame] | 325 | if (Current.is(tok::equal) && RootToken.is(tok::kw_for)) |
| 326 | State.ForLoopVariablePos = State.Column - |
| 327 | Previous.FormatTok.TokenLength; |
Daniel Jasper | a324a0e | 2012-12-21 14:37:20 +0000 | [diff] [blame] | 328 | |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 329 | unsigned Spaces = State.NextToken->SpaceRequiredBefore ? 1 : 0; |
| 330 | if (State.NextToken->Type == TT_LineComment) |
Daniel Jasper | 7ad4eff | 2013-01-07 11:09:06 +0000 | [diff] [blame] | 331 | Spaces = Style.SpacesBeforeTrailingComments; |
Daniel Jasper | 2040915 | 2012-12-04 14:54:30 +0000 | [diff] [blame] | 332 | |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 333 | if (!DryRun) |
| 334 | replaceWhitespace(Current, 0, Spaces); |
Daniel Jasper | 2040915 | 2012-12-04 14:54:30 +0000 | [diff] [blame] | 335 | |
Daniel Jasper | 3fc0bb7 | 2013-01-09 10:40:23 +0000 | [diff] [blame] | 336 | // FIXME: Do we need to do this for assignments nested in other |
| 337 | // expressions? |
| 338 | if (RootToken.isNot(tok::kw_for) && ParenLevel == 0 && |
Daniel Jasper | 9cda800 | 2013-01-07 13:08:40 +0000 | [diff] [blame] | 339 | (getPrecedence(Previous) == prec::Assignment || |
Daniel Jasper | 9c837d0 | 2013-01-09 07:06:56 +0000 | [diff] [blame] | 340 | Previous.is(tok::kw_return))) |
Daniel Jasper | cf225b6 | 2012-12-24 13:43:52 +0000 | [diff] [blame] | 341 | State.Indent[ParenLevel] = State.Column + Spaces; |
Daniel Jasper | 9c837d0 | 2013-01-09 07:06:56 +0000 | [diff] [blame] | 342 | if (Previous.is(tok::l_paren) || |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 343 | State.NextToken->Parent->Type == TT_TemplateOpener) |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 344 | State.Indent[ParenLevel] = State.Column; |
Daniel Jasper | 1321eb5 | 2012-12-18 21:05:13 +0000 | [diff] [blame] | 345 | |
Daniel Jasper | 9cda800 | 2013-01-07 13:08:40 +0000 | [diff] [blame] | 346 | // Top-level spaces that are not part of assignments are exempt as that |
| 347 | // mostly leads to better results. |
Daniel Jasper | 3b5943f | 2012-12-06 09:56:08 +0000 | [diff] [blame] | 348 | State.Column += Spaces; |
Daniel Jasper | 9cda800 | 2013-01-07 13:08:40 +0000 | [diff] [blame] | 349 | if (Spaces > 0 && |
| 350 | (ParenLevel != 0 || getPrecedence(Previous) == prec::Assignment)) |
Daniel Jasper | 3b5943f | 2012-12-06 09:56:08 +0000 | [diff] [blame] | 351 | State.LastSpace[ParenLevel] = State.Column; |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 352 | } |
Daniel Jasper | 2040915 | 2012-12-04 14:54:30 +0000 | [diff] [blame] | 353 | moveStateToNextToken(State); |
| 354 | } |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 355 | |
Daniel Jasper | 2040915 | 2012-12-04 14:54:30 +0000 | [diff] [blame] | 356 | /// \brief Mark the next token as consumed in \p State and modify its stacks |
| 357 | /// accordingly. |
| 358 | void moveStateToNextToken(IndentState &State) { |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 359 | const AnnotatedToken &Current = *State.NextToken; |
Daniel Jasper | 3b5943f | 2012-12-06 09:56:08 +0000 | [diff] [blame] | 360 | unsigned ParenLevel = State.Indent.size() - 1; |
| 361 | |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 362 | if (Current.is(tok::lessless) && State.FirstLessLess[ParenLevel] == 0) |
Daniel Jasper | 3b5943f | 2012-12-06 09:56:08 +0000 | [diff] [blame] | 363 | State.FirstLessLess[ParenLevel] = State.Column; |
| 364 | |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 365 | State.Column += Current.FormatTok.TokenLength; |
Daniel Jasper | 2040915 | 2012-12-04 14:54:30 +0000 | [diff] [blame] | 366 | |
Daniel Jasper | cf225b6 | 2012-12-24 13:43:52 +0000 | [diff] [blame] | 367 | // If we encounter an opening (, [, { or <, we add a level to our stacks to |
Daniel Jasper | 2040915 | 2012-12-04 14:54:30 +0000 | [diff] [blame] | 368 | // prepare for the following tokens. |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 369 | if (Current.is(tok::l_paren) || Current.is(tok::l_square) || |
| 370 | Current.is(tok::l_brace) || |
| 371 | State.NextToken->Type == TT_TemplateOpener) { |
Daniel Jasper | 2040915 | 2012-12-04 14:54:30 +0000 | [diff] [blame] | 372 | State.Indent.push_back(4 + State.LastSpace.back()); |
| 373 | State.LastSpace.push_back(State.LastSpace.back()); |
Daniel Jasper | 3b5943f | 2012-12-06 09:56:08 +0000 | [diff] [blame] | 374 | State.FirstLessLess.push_back(0); |
Daniel Jasper | 2040915 | 2012-12-04 14:54:30 +0000 | [diff] [blame] | 375 | } |
| 376 | |
Daniel Jasper | cf225b6 | 2012-12-24 13:43:52 +0000 | [diff] [blame] | 377 | // If we encounter a closing ), ], } or >, we can remove a level from our |
Daniel Jasper | 2040915 | 2012-12-04 14:54:30 +0000 | [diff] [blame] | 378 | // stacks. |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 379 | if (Current.is(tok::r_paren) || Current.is(tok::r_square) || |
| 380 | (Current.is(tok::r_brace) && State.NextToken != &RootToken) || |
| 381 | State.NextToken->Type == TT_TemplateCloser) { |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 382 | State.Indent.pop_back(); |
| 383 | State.LastSpace.pop_back(); |
Daniel Jasper | 3b5943f | 2012-12-06 09:56:08 +0000 | [diff] [blame] | 384 | State.FirstLessLess.pop_back(); |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 385 | } |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 386 | if (State.NextToken->Children.empty()) |
| 387 | State.NextToken = NULL; |
| 388 | else |
| 389 | State.NextToken = &State.NextToken->Children[0]; |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 390 | } |
| 391 | |
Nico Weber | decf7bc | 2013-01-07 15:15:29 +0000 | [diff] [blame] | 392 | /// \brief Calculate the penalty for splitting after the token at \p Index. |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 393 | unsigned splitPenalty(const AnnotatedToken &Tok) { |
| 394 | const AnnotatedToken &Left = Tok; |
| 395 | const AnnotatedToken &Right = Tok.Children[0]; |
Daniel Jasper | a324a0e | 2012-12-21 14:37:20 +0000 | [diff] [blame] | 396 | |
| 397 | // In for-loops, prefer breaking at ',' and ';'. |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 398 | if (RootToken.is(tok::kw_for) && |
| 399 | (Left.isNot(tok::comma) && Left.isNot(tok::semi))) |
Daniel Jasper | a324a0e | 2012-12-21 14:37:20 +0000 | [diff] [blame] | 400 | return 20; |
| 401 | |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 402 | if (Left.is(tok::semi) || Left.is(tok::comma) || |
| 403 | Left.ClosesTemplateDeclaration) |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 404 | return 0; |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 405 | if (Left.is(tok::l_paren)) |
Daniel Jasper | 723f030 | 2013-01-02 14:40:02 +0000 | [diff] [blame] | 406 | return 20; |
Daniel Jasper | 9a0b494 | 2012-12-17 14:34:14 +0000 | [diff] [blame] | 407 | |
Daniel Jasper | 9c837d0 | 2013-01-09 07:06:56 +0000 | [diff] [blame] | 408 | if (Left.is(tok::question) || Left.Type == TT_ConditionalExpr) |
| 409 | return prec::Assignment; |
Daniel Jasper | 9cda800 | 2013-01-07 13:08:40 +0000 | [diff] [blame] | 410 | prec::Level Level = getPrecedence(Left); |
| 411 | |
| 412 | // Breaking after an assignment leads to a bad result as the two sides of |
| 413 | // the assignment are visually very close together. |
| 414 | if (Level == prec::Assignment) |
| 415 | return 50; |
| 416 | |
Daniel Jasper | e2c7acf | 2012-12-24 00:13:23 +0000 | [diff] [blame] | 417 | if (Level != prec::Unknown) |
| 418 | return Level; |
| 419 | |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 420 | if (Right.is(tok::arrow) || Right.is(tok::period)) |
Daniel Jasper | 46a46a2 | 2013-01-07 07:13:20 +0000 | [diff] [blame] | 421 | return 150; |
Daniel Jasper | 9a0b494 | 2012-12-17 14:34:14 +0000 | [diff] [blame] | 422 | |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 423 | return 3; |
| 424 | } |
| 425 | |
Daniel Jasper | ceb99ab | 2013-01-09 10:16:05 +0000 | [diff] [blame] | 426 | unsigned getColumnLimit() { |
| 427 | return Style.ColumnLimit - (Line.InPPDirective ? 1 : 0); |
| 428 | } |
| 429 | |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 430 | /// \brief Calculate the number of lines needed to format the remaining part |
| 431 | /// of the unwrapped line. |
| 432 | /// |
| 433 | /// Assumes the formatting so far has led to |
| 434 | /// the \c IndentState \p State. If \p NewLine is set, a new line will be |
| 435 | /// added after the previous token. |
| 436 | /// |
| 437 | /// \param StopAt is used for optimization. If we can determine that we'll |
| 438 | /// definitely need at least \p StopAt additional lines, we already know of a |
| 439 | /// better solution. |
| 440 | unsigned calcPenalty(IndentState State, bool NewLine, unsigned StopAt) { |
| 441 | // We are at the end of the unwrapped line, so we don't need any more lines. |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 442 | if (State.NextToken == NULL) |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 443 | return 0; |
| 444 | |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 445 | if (!NewLine && State.NextToken->MustBreakBefore) |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 446 | return UINT_MAX; |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 447 | if (NewLine && !State.NextToken->CanBreakBefore) |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 448 | return UINT_MAX; |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 449 | if (!NewLine && State.NextToken->Parent->is(tok::semi) && |
Daniel Jasper | a324a0e | 2012-12-21 14:37:20 +0000 | [diff] [blame] | 450 | State.LineContainsContinuedForLoopSection) |
| 451 | return UINT_MAX; |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 452 | |
Daniel Jasper | 33182dd | 2012-12-05 14:57:28 +0000 | [diff] [blame] | 453 | unsigned CurrentPenalty = 0; |
| 454 | if (NewLine) { |
| 455 | CurrentPenalty += Parameters.PenaltyIndentLevel * State.Indent.size() + |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 456 | splitPenalty(*State.NextToken->Parent); |
Daniel Jasper | a4974cf | 2012-12-24 16:43:00 +0000 | [diff] [blame] | 457 | } else { |
| 458 | if (State.Indent.size() < State.StartOfLineLevel) |
| 459 | CurrentPenalty += Parameters.PenaltyLevelDecrease * |
| 460 | (State.StartOfLineLevel - State.Indent.size()); |
Daniel Jasper | 33182dd | 2012-12-05 14:57:28 +0000 | [diff] [blame] | 461 | } |
| 462 | |
Daniel Jasper | 2040915 | 2012-12-04 14:54:30 +0000 | [diff] [blame] | 463 | addTokenToState(NewLine, true, State); |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 464 | |
Daniel Jasper | ceb99ab | 2013-01-09 10:16:05 +0000 | [diff] [blame] | 465 | // Exceeding column limit is bad, assign penalty. |
| 466 | if (State.Column > getColumnLimit()) { |
| 467 | unsigned ExcessCharacters = State.Column - getColumnLimit(); |
| 468 | CurrentPenalty += Parameters.PenaltyExcessCharacter * ExcessCharacters; |
| 469 | } |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 470 | |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 471 | if (StopAt <= CurrentPenalty) |
| 472 | return UINT_MAX; |
| 473 | StopAt -= CurrentPenalty; |
| 474 | |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 475 | StateMap::iterator I = Memory.find(State); |
Daniel Jasper | 33182dd | 2012-12-05 14:57:28 +0000 | [diff] [blame] | 476 | if (I != Memory.end()) { |
| 477 | // If this state has already been examined, we can safely return the |
| 478 | // previous result if we |
| 479 | // - have not hit the optimatization (and thus returned UINT_MAX) OR |
| 480 | // - are now computing for a smaller or equal StopAt. |
| 481 | unsigned SavedResult = I->second.first; |
| 482 | unsigned SavedStopAt = I->second.second; |
Daniel Jasper | 9a0b494 | 2012-12-17 14:34:14 +0000 | [diff] [blame] | 483 | if (SavedResult != UINT_MAX) |
| 484 | return SavedResult + CurrentPenalty; |
| 485 | else if (StopAt <= SavedStopAt) |
| 486 | return UINT_MAX; |
Daniel Jasper | 33182dd | 2012-12-05 14:57:28 +0000 | [diff] [blame] | 487 | } |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 488 | |
| 489 | unsigned NoBreak = calcPenalty(State, false, StopAt); |
| 490 | unsigned WithBreak = calcPenalty(State, true, std::min(StopAt, NoBreak)); |
| 491 | unsigned Result = std::min(NoBreak, WithBreak); |
Daniel Jasper | 9a0b494 | 2012-12-17 14:34:14 +0000 | [diff] [blame] | 492 | |
| 493 | // We have to store 'Result' without adding 'CurrentPenalty' as the latter |
| 494 | // can depend on 'NewLine'. |
Daniel Jasper | 33182dd | 2012-12-05 14:57:28 +0000 | [diff] [blame] | 495 | Memory[State] = std::pair<unsigned, unsigned>(Result, StopAt); |
Daniel Jasper | 9a0b494 | 2012-12-17 14:34:14 +0000 | [diff] [blame] | 496 | |
| 497 | return Result == UINT_MAX ? UINT_MAX : Result + CurrentPenalty; |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 498 | } |
| 499 | |
| 500 | /// \brief Replaces the whitespace in front of \p Tok. Only call once for |
| 501 | /// each \c FormatToken. |
Daniel Jasper | 9c837d0 | 2013-01-09 07:06:56 +0000 | [diff] [blame] | 502 | void replaceWhitespace(const AnnotatedToken &Tok, unsigned NewLines, |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 503 | unsigned Spaces) { |
Manuel Klimek | 060143e | 2013-01-02 18:33:23 +0000 | [diff] [blame] | 504 | Replaces.insert(tooling::Replacement( |
Daniel Jasper | 9c837d0 | 2013-01-09 07:06:56 +0000 | [diff] [blame] | 505 | SourceMgr, Tok.FormatTok.WhiteSpaceStart, |
| 506 | Tok.FormatTok.WhiteSpaceLength, |
Manuel Klimek | 060143e | 2013-01-02 18:33:23 +0000 | [diff] [blame] | 507 | std::string(NewLines, '\n') + std::string(Spaces, ' '))); |
| 508 | } |
| 509 | |
| 510 | /// \brief Like \c replaceWhitespace, but additionally adds right-aligned |
| 511 | /// backslashes to escape newlines inside a preprocessor directive. |
| 512 | /// |
| 513 | /// This function and \c replaceWhitespace have the same behavior if |
| 514 | /// \c Newlines == 0. |
Daniel Jasper | 9c837d0 | 2013-01-09 07:06:56 +0000 | [diff] [blame] | 515 | void replacePPWhitespace(const AnnotatedToken &Tok, unsigned NewLines, |
Manuel Klimek | 060143e | 2013-01-02 18:33:23 +0000 | [diff] [blame] | 516 | unsigned Spaces, unsigned WhitespaceStartColumn) { |
Manuel Klimek | a080a18 | 2013-01-02 16:30:12 +0000 | [diff] [blame] | 517 | std::string NewLineText; |
Manuel Klimek | 060143e | 2013-01-02 18:33:23 +0000 | [diff] [blame] | 518 | if (NewLines > 0) { |
Daniel Jasper | cd16238 | 2013-01-07 13:26:07 +0000 | [diff] [blame] | 519 | unsigned Offset = std::min<int>(Style.ColumnLimit - 1, |
| 520 | WhitespaceStartColumn); |
Manuel Klimek | a080a18 | 2013-01-02 16:30:12 +0000 | [diff] [blame] | 521 | for (unsigned i = 0; i < NewLines; ++i) { |
| 522 | NewLineText += std::string(Style.ColumnLimit - Offset - 1, ' '); |
| 523 | NewLineText += "\\\n"; |
| 524 | Offset = 0; |
| 525 | } |
| 526 | } |
Daniel Jasper | 9c837d0 | 2013-01-09 07:06:56 +0000 | [diff] [blame] | 527 | Replaces.insert( |
| 528 | tooling::Replacement(SourceMgr, Tok.FormatTok.WhiteSpaceStart, |
| 529 | Tok.FormatTok.WhiteSpaceLength, |
| 530 | NewLineText + std::string(Spaces, ' '))); |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 531 | } |
| 532 | |
| 533 | /// \brief Add a new line and the required indent before the first Token |
Alexander Kornienko | 720ffb6 | 2012-12-05 13:56:52 +0000 | [diff] [blame] | 534 | /// of the \c UnwrappedLine if there was no structural parsing error. |
| 535 | /// Returns the indent level of the \c UnwrappedLine. |
Alexander Kornienko | cff563c | 2012-12-04 17:27:50 +0000 | [diff] [blame] | 536 | unsigned formatFirstToken() { |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 537 | const FormatToken &Tok = RootToken.FormatTok; |
| 538 | if (!Tok.WhiteSpaceStart.isValid() || StructuralError) |
| 539 | return SourceMgr.getSpellingColumnNumber(Tok.Tok.getLocation()) - 1; |
Alexander Kornienko | cff563c | 2012-12-04 17:27:50 +0000 | [diff] [blame] | 540 | |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 541 | unsigned Newlines = std::min(Tok.NewlinesBefore, |
Daniel Jasper | cd16238 | 2013-01-07 13:26:07 +0000 | [diff] [blame] | 542 | Style.MaxEmptyLinesToKeep + 1); |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 543 | if (Newlines == 0 && !Tok.IsFirst) |
Alexander Kornienko | cff563c | 2012-12-04 17:27:50 +0000 | [diff] [blame] | 544 | Newlines = 1; |
| 545 | unsigned Indent = Line.Level * 2; |
Nico Weber | 6092d4e | 2013-01-07 19:05:19 +0000 | [diff] [blame] | 546 | |
| 547 | bool IsAccessModifier = false; |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 548 | if (RootToken.is(tok::kw_public) || RootToken.is(tok::kw_protected) || |
| 549 | RootToken.is(tok::kw_private)) |
Nico Weber | 6092d4e | 2013-01-07 19:05:19 +0000 | [diff] [blame] | 550 | IsAccessModifier = true; |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 551 | else if (RootToken.is(tok::at) && !RootToken.Children.empty() && |
| 552 | (RootToken.Children[0].isObjCAtKeyword(tok::objc_public) || |
| 553 | RootToken.Children[0].isObjCAtKeyword(tok::objc_protected) || |
| 554 | RootToken.Children[0].isObjCAtKeyword(tok::objc_package) || |
| 555 | RootToken.Children[0].isObjCAtKeyword(tok::objc_private))) |
Nico Weber | 6092d4e | 2013-01-07 19:05:19 +0000 | [diff] [blame] | 556 | IsAccessModifier = true; |
| 557 | |
| 558 | if (IsAccessModifier && |
Alexander Kornienko | 56e49c5 | 2012-12-10 16:34:48 +0000 | [diff] [blame] | 559 | static_cast<int>(Indent) + Style.AccessModifierOffset >= 0) |
Alexander Kornienko | cff563c | 2012-12-04 17:27:50 +0000 | [diff] [blame] | 560 | Indent += Style.AccessModifierOffset; |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 561 | if (!Line.InPPDirective || Tok.HasUnescapedNewline) |
| 562 | replaceWhitespace(Tok, Newlines, Indent); |
Manuel Klimek | 060143e | 2013-01-02 18:33:23 +0000 | [diff] [blame] | 563 | else |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 564 | replacePPWhitespace(Tok, Newlines, Indent, PreviousEndOfLineColumn); |
Alexander Kornienko | cff563c | 2012-12-04 17:27:50 +0000 | [diff] [blame] | 565 | return Indent; |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 566 | } |
| 567 | |
| 568 | FormatStyle Style; |
| 569 | SourceManager &SourceMgr; |
| 570 | const UnwrappedLine &Line; |
Manuel Klimek | d4397b9 | 2013-01-04 23:34:14 +0000 | [diff] [blame] | 571 | const unsigned PreviousEndOfLineColumn; |
Daniel Jasper | 7160751 | 2013-01-07 10:48:50 +0000 | [diff] [blame] | 572 | const LineType CurrentLineType; |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 573 | const AnnotatedToken &RootToken; |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 574 | tooling::Replacements &Replaces; |
Alexander Kornienko | cff563c | 2012-12-04 17:27:50 +0000 | [diff] [blame] | 575 | bool StructuralError; |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 576 | |
Daniel Jasper | 33182dd | 2012-12-05 14:57:28 +0000 | [diff] [blame] | 577 | // A map from an indent state to a pair (Result, Used-StopAt). |
| 578 | typedef std::map<IndentState, std::pair<unsigned, unsigned> > StateMap; |
| 579 | StateMap Memory; |
| 580 | |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 581 | OptimizationParameters Parameters; |
| 582 | }; |
| 583 | |
| 584 | /// \brief Determines extra information about the tokens comprising an |
| 585 | /// \c UnwrappedLine. |
| 586 | class TokenAnnotator { |
| 587 | public: |
| 588 | TokenAnnotator(const UnwrappedLine &Line, const FormatStyle &Style, |
Manuel Klimek | 6cf5814 | 2013-01-07 08:54:53 +0000 | [diff] [blame] | 589 | SourceManager &SourceMgr, Lexer &Lex) |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 590 | : Style(Style), SourceMgr(SourceMgr), Lex(Lex), |
| 591 | RootToken(Line.RootToken) { |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 592 | } |
| 593 | |
| 594 | /// \brief A parser that gathers additional information about tokens. |
| 595 | /// |
| 596 | /// The \c TokenAnnotator tries to matches parenthesis and square brakets and |
| 597 | /// store a parenthesis levels. It also tries to resolve matching "<" and ">" |
| 598 | /// into template parameter lists. |
| 599 | class AnnotatingParser { |
| 600 | public: |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 601 | AnnotatingParser(AnnotatedToken &RootToken) |
| 602 | : CurrentToken(&RootToken), KeywordVirtualFound(false) { |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 603 | } |
| 604 | |
Daniel Jasper | 2040915 | 2012-12-04 14:54:30 +0000 | [diff] [blame] | 605 | bool parseAngle() { |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 606 | while (CurrentToken != NULL) { |
| 607 | if (CurrentToken->is(tok::greater)) { |
| 608 | CurrentToken->Type = TT_TemplateCloser; |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 609 | next(); |
| 610 | return true; |
| 611 | } |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 612 | if (CurrentToken->is(tok::r_paren) || CurrentToken->is(tok::r_square) || |
| 613 | CurrentToken->is(tok::r_brace)) |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 614 | return false; |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 615 | if (CurrentToken->is(tok::pipepipe) || CurrentToken->is(tok::ampamp) || |
| 616 | CurrentToken->is(tok::question) || CurrentToken->is(tok::colon)) |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 617 | return false; |
Daniel Jasper | 1f42f11 | 2013-01-04 18:52:56 +0000 | [diff] [blame] | 618 | if (!consumeToken()) |
| 619 | return false; |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 620 | } |
| 621 | return false; |
| 622 | } |
| 623 | |
Daniel Jasper | 2040915 | 2012-12-04 14:54:30 +0000 | [diff] [blame] | 624 | bool parseParens() { |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 625 | while (CurrentToken != NULL) { |
| 626 | if (CurrentToken->is(tok::r_paren)) { |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 627 | next(); |
| 628 | return true; |
| 629 | } |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 630 | if (CurrentToken->is(tok::r_square) || CurrentToken->is(tok::r_brace)) |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 631 | return false; |
Daniel Jasper | 1f42f11 | 2013-01-04 18:52:56 +0000 | [diff] [blame] | 632 | if (!consumeToken()) |
| 633 | return false; |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 634 | } |
| 635 | return false; |
| 636 | } |
| 637 | |
Daniel Jasper | 2040915 | 2012-12-04 14:54:30 +0000 | [diff] [blame] | 638 | bool parseSquare() { |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 639 | while (CurrentToken != NULL) { |
| 640 | if (CurrentToken->is(tok::r_square)) { |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 641 | next(); |
| 642 | return true; |
| 643 | } |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 644 | if (CurrentToken->is(tok::r_paren) || CurrentToken->is(tok::r_brace)) |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 645 | return false; |
Daniel Jasper | 1f42f11 | 2013-01-04 18:52:56 +0000 | [diff] [blame] | 646 | if (!consumeToken()) |
| 647 | return false; |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 648 | } |
| 649 | return false; |
| 650 | } |
| 651 | |
Daniel Jasper | 2040915 | 2012-12-04 14:54:30 +0000 | [diff] [blame] | 652 | bool parseConditional() { |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 653 | while (CurrentToken != NULL) { |
| 654 | if (CurrentToken->is(tok::colon)) { |
| 655 | CurrentToken->Type = TT_ConditionalExpr; |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 656 | next(); |
| 657 | return true; |
| 658 | } |
Daniel Jasper | 1f42f11 | 2013-01-04 18:52:56 +0000 | [diff] [blame] | 659 | if (!consumeToken()) |
| 660 | return false; |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 661 | } |
| 662 | return false; |
| 663 | } |
| 664 | |
Daniel Jasper | 9a64fb5 | 2013-01-02 15:08:56 +0000 | [diff] [blame] | 665 | bool parseTemplateDeclaration() { |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 666 | if (CurrentToken != NULL && CurrentToken->is(tok::less)) { |
| 667 | CurrentToken->Type = TT_TemplateOpener; |
Daniel Jasper | 9a64fb5 | 2013-01-02 15:08:56 +0000 | [diff] [blame] | 668 | next(); |
| 669 | if (!parseAngle()) |
| 670 | return false; |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 671 | CurrentToken->Parent->ClosesTemplateDeclaration = true; |
Daniel Jasper | 9a64fb5 | 2013-01-02 15:08:56 +0000 | [diff] [blame] | 672 | parseLine(); |
| 673 | return true; |
| 674 | } |
| 675 | return false; |
| 676 | } |
| 677 | |
Daniel Jasper | 1f42f11 | 2013-01-04 18:52:56 +0000 | [diff] [blame] | 678 | bool consumeToken() { |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 679 | AnnotatedToken *Tok = CurrentToken; |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 680 | next(); |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 681 | switch (Tok->FormatTok.Tok.getKind()) { |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 682 | case tok::l_paren: |
Daniel Jasper | 1f42f11 | 2013-01-04 18:52:56 +0000 | [diff] [blame] | 683 | if (!parseParens()) |
| 684 | return false; |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 685 | if (CurrentToken != NULL && CurrentToken->is(tok::colon)) { |
| 686 | CurrentToken->Type = TT_CtorInitializerColon; |
Daniel Jasper | 1321eb5 | 2012-12-18 21:05:13 +0000 | [diff] [blame] | 687 | next(); |
| 688 | } |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 689 | break; |
| 690 | case tok::l_square: |
Daniel Jasper | 1f42f11 | 2013-01-04 18:52:56 +0000 | [diff] [blame] | 691 | if (!parseSquare()) |
| 692 | return false; |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 693 | break; |
| 694 | case tok::less: |
Daniel Jasper | 2040915 | 2012-12-04 14:54:30 +0000 | [diff] [blame] | 695 | if (parseAngle()) |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 696 | Tok->Type = TT_TemplateOpener; |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 697 | else { |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 698 | Tok->Type = TT_BinaryOperator; |
| 699 | CurrentToken = Tok; |
| 700 | next(); |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 701 | } |
| 702 | break; |
Daniel Jasper | 1f42f11 | 2013-01-04 18:52:56 +0000 | [diff] [blame] | 703 | case tok::r_paren: |
| 704 | case tok::r_square: |
| 705 | return false; |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 706 | case tok::greater: |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 707 | Tok->Type = TT_BinaryOperator; |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 708 | break; |
| 709 | case tok::kw_operator: |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 710 | if (CurrentToken->is(tok::l_paren)) { |
| 711 | CurrentToken->Type = TT_OverloadedOperator; |
Daniel Jasper | f6aef6a | 2012-12-24 10:56:04 +0000 | [diff] [blame] | 712 | next(); |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 713 | if (CurrentToken != NULL && CurrentToken->is(tok::r_paren)) { |
| 714 | CurrentToken->Type = TT_OverloadedOperator; |
Daniel Jasper | f6aef6a | 2012-12-24 10:56:04 +0000 | [diff] [blame] | 715 | next(); |
| 716 | } |
| 717 | } else { |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 718 | while (CurrentToken != NULL && CurrentToken->isNot(tok::l_paren)) { |
| 719 | CurrentToken->Type = TT_OverloadedOperator; |
Daniel Jasper | f6aef6a | 2012-12-24 10:56:04 +0000 | [diff] [blame] | 720 | next(); |
| 721 | } |
| 722 | } |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 723 | break; |
| 724 | case tok::question: |
Daniel Jasper | 2040915 | 2012-12-04 14:54:30 +0000 | [diff] [blame] | 725 | parseConditional(); |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 726 | break; |
Daniel Jasper | 9a64fb5 | 2013-01-02 15:08:56 +0000 | [diff] [blame] | 727 | case tok::kw_template: |
| 728 | parseTemplateDeclaration(); |
| 729 | break; |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 730 | default: |
| 731 | break; |
| 732 | } |
Daniel Jasper | 1f42f11 | 2013-01-04 18:52:56 +0000 | [diff] [blame] | 733 | return true; |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 734 | } |
| 735 | |
Daniel Jasper | cd1a32b | 2012-12-21 17:58:39 +0000 | [diff] [blame] | 736 | void parseIncludeDirective() { |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 737 | while (CurrentToken != NULL) { |
| 738 | if (CurrentToken->is(tok::slash)) |
| 739 | CurrentToken->Type = TT_DirectorySeparator; |
| 740 | else if (CurrentToken->is(tok::less)) |
| 741 | CurrentToken->Type = TT_TemplateOpener; |
| 742 | else if (CurrentToken->is(tok::greater)) |
| 743 | CurrentToken->Type = TT_TemplateCloser; |
Daniel Jasper | cd1a32b | 2012-12-21 17:58:39 +0000 | [diff] [blame] | 744 | next(); |
| 745 | } |
| 746 | } |
| 747 | |
| 748 | void parsePreprocessorDirective() { |
| 749 | next(); |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 750 | if (CurrentToken == NULL) |
Daniel Jasper | cd1a32b | 2012-12-21 17:58:39 +0000 | [diff] [blame] | 751 | return; |
Manuel Klimek | f6fd00b | 2013-01-05 22:56:06 +0000 | [diff] [blame] | 752 | // Hashes in the middle of a line can lead to any strange token |
| 753 | // sequence. |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 754 | if (CurrentToken->FormatTok.Tok.getIdentifierInfo() == NULL) |
Manuel Klimek | f6fd00b | 2013-01-05 22:56:06 +0000 | [diff] [blame] | 755 | return; |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 756 | switch ( |
| 757 | CurrentToken->FormatTok.Tok.getIdentifierInfo()->getPPKeywordID()) { |
Daniel Jasper | cd1a32b | 2012-12-21 17:58:39 +0000 | [diff] [blame] | 758 | case tok::pp_include: |
Nico Weber | b23ae0c | 2012-12-21 18:21:56 +0000 | [diff] [blame] | 759 | case tok::pp_import: |
Daniel Jasper | cd1a32b | 2012-12-21 17:58:39 +0000 | [diff] [blame] | 760 | parseIncludeDirective(); |
| 761 | break; |
| 762 | default: |
| 763 | break; |
| 764 | } |
| 765 | } |
| 766 | |
Daniel Jasper | 7160751 | 2013-01-07 10:48:50 +0000 | [diff] [blame] | 767 | LineType parseLine() { |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 768 | if (CurrentToken->is(tok::hash)) { |
Daniel Jasper | cd1a32b | 2012-12-21 17:58:39 +0000 | [diff] [blame] | 769 | parsePreprocessorDirective(); |
Daniel Jasper | 7160751 | 2013-01-07 10:48:50 +0000 | [diff] [blame] | 770 | return LT_PreprocessorDirective; |
Daniel Jasper | cd1a32b | 2012-12-21 17:58:39 +0000 | [diff] [blame] | 771 | } |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 772 | while (CurrentToken != NULL) { |
| 773 | if (CurrentToken->is(tok::kw_virtual)) |
Daniel Jasper | 7160751 | 2013-01-07 10:48:50 +0000 | [diff] [blame] | 774 | KeywordVirtualFound = true; |
Daniel Jasper | 1f42f11 | 2013-01-04 18:52:56 +0000 | [diff] [blame] | 775 | if (!consumeToken()) |
Daniel Jasper | 7160751 | 2013-01-07 10:48:50 +0000 | [diff] [blame] | 776 | return LT_Invalid; |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 777 | } |
Daniel Jasper | 7160751 | 2013-01-07 10:48:50 +0000 | [diff] [blame] | 778 | if (KeywordVirtualFound) |
| 779 | return LT_VirtualFunctionDecl; |
| 780 | return LT_Other; |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 781 | } |
| 782 | |
| 783 | void next() { |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 784 | if (CurrentToken != NULL && !CurrentToken->Children.empty()) |
| 785 | CurrentToken = &CurrentToken->Children[0]; |
| 786 | else |
| 787 | CurrentToken = NULL; |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 788 | } |
| 789 | |
| 790 | private: |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 791 | AnnotatedToken *CurrentToken; |
Daniel Jasper | 7160751 | 2013-01-07 10:48:50 +0000 | [diff] [blame] | 792 | bool KeywordVirtualFound; |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 793 | }; |
| 794 | |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 795 | void createAnnotatedTokens(AnnotatedToken &Current) { |
| 796 | if (!Current.FormatTok.Children.empty()) { |
| 797 | Current.Children.push_back(AnnotatedToken(Current.FormatTok.Children[0])); |
| 798 | Current.Children.back().Parent = &Current; |
| 799 | createAnnotatedTokens(Current.Children.back()); |
| 800 | } |
| 801 | } |
Daniel Jasper | 7160751 | 2013-01-07 10:48:50 +0000 | [diff] [blame] | 802 | |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 803 | void calculateExtraInformation(AnnotatedToken &Current) { |
| 804 | Current.SpaceRequiredBefore = spaceRequiredBefore(Current); |
| 805 | |
Manuel Klimek | 526ed11 | 2013-01-09 15:25:02 +0000 | [diff] [blame^] | 806 | if (Current.FormatTok.MustBreakBefore) { |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 807 | Current.MustBreakBefore = true; |
| 808 | } else { |
Manuel Klimek | 526ed11 | 2013-01-09 15:25:02 +0000 | [diff] [blame^] | 809 | if (Current.Type == TT_CtorInitializerColon || Current.Parent->Type == |
| 810 | TT_LineComment || (Current.is(tok::string_literal) && |
| 811 | Current.Parent->is(tok::string_literal))) { |
| 812 | Current.MustBreakBefore = true; |
| 813 | } else if (Current.is(tok::at) && Current.Parent->Parent->is(tok::at)) { |
| 814 | // Don't put two objc's '@' on the same line. This could happen, |
| 815 | // as in, @optional @property ... |
| 816 | Current.MustBreakBefore = true; |
| 817 | } else { |
| 818 | Current.MustBreakBefore = false; |
| 819 | } |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 820 | } |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 821 | Current.CanBreakBefore = Current.MustBreakBefore || canBreakBefore(Current); |
| 822 | |
| 823 | if (!Current.Children.empty()) |
| 824 | calculateExtraInformation(Current.Children[0]); |
| 825 | } |
| 826 | |
| 827 | bool annotate() { |
| 828 | createAnnotatedTokens(RootToken); |
| 829 | |
| 830 | AnnotatingParser Parser(RootToken); |
Daniel Jasper | 7160751 | 2013-01-07 10:48:50 +0000 | [diff] [blame] | 831 | CurrentLineType = Parser.parseLine(); |
| 832 | if (CurrentLineType == LT_Invalid) |
Daniel Jasper | 1f42f11 | 2013-01-04 18:52:56 +0000 | [diff] [blame] | 833 | return false; |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 834 | |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 835 | determineTokenTypes(RootToken, /*IsRHS=*/false); |
Daniel Jasper | 7160751 | 2013-01-07 10:48:50 +0000 | [diff] [blame] | 836 | |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 837 | if (RootToken.Type == TT_ObjCMethodSpecifier) |
Daniel Jasper | 7160751 | 2013-01-07 10:48:50 +0000 | [diff] [blame] | 838 | CurrentLineType = LT_ObjCMethodDecl; |
| 839 | |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 840 | if (!RootToken.Children.empty()) |
| 841 | calculateExtraInformation(RootToken.Children[0]); |
Daniel Jasper | 1f42f11 | 2013-01-04 18:52:56 +0000 | [diff] [blame] | 842 | return true; |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 843 | } |
| 844 | |
Daniel Jasper | 7160751 | 2013-01-07 10:48:50 +0000 | [diff] [blame] | 845 | LineType getLineType() { |
| 846 | return CurrentLineType; |
| 847 | } |
| 848 | |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 849 | const AnnotatedToken &getRootToken() { |
| 850 | return RootToken; |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 851 | } |
| 852 | |
| 853 | private: |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 854 | void determineTokenTypes(AnnotatedToken &Current, bool IsRHS) { |
| 855 | if (getPrecedence(Current) == prec::Assignment || |
| 856 | Current.is(tok::kw_return) || Current.is(tok::kw_throw)) |
| 857 | IsRHS = true; |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 858 | |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 859 | if (Current.Type == TT_Unknown) { |
| 860 | if (Current.is(tok::star) || Current.is(tok::amp)) { |
| 861 | Current.Type = determineStarAmpUsage(Current, IsRHS); |
Daniel Jasper | 886568d | 2013-01-09 08:36:49 +0000 | [diff] [blame] | 862 | } else if (Current.is(tok::minus) || Current.is(tok::plus) || |
| 863 | Current.is(tok::caret)) { |
| 864 | Current.Type = determinePlusMinusCaretUsage(Current); |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 865 | } else if (Current.is(tok::minusminus) || Current.is(tok::plusplus)) { |
| 866 | Current.Type = determineIncrementUsage(Current); |
| 867 | } else if (Current.is(tok::exclaim)) { |
| 868 | Current.Type = TT_UnaryOperator; |
| 869 | } else if (isBinaryOperator(Current)) { |
| 870 | Current.Type = TT_BinaryOperator; |
| 871 | } else if (Current.is(tok::comment)) { |
| 872 | std::string Data(Lexer::getSpelling(Current.FormatTok.Tok, SourceMgr, |
| 873 | Lex.getLangOpts())); |
Manuel Klimek | 6cf5814 | 2013-01-07 08:54:53 +0000 | [diff] [blame] | 874 | if (StringRef(Data).startswith("//")) |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 875 | Current.Type = TT_LineComment; |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 876 | else |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 877 | Current.Type = TT_BlockComment; |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 878 | } |
| 879 | } |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 880 | |
| 881 | if (!Current.Children.empty()) |
| 882 | determineTokenTypes(Current.Children[0], IsRHS); |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 883 | } |
| 884 | |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 885 | bool isBinaryOperator(const AnnotatedToken &Tok) { |
Daniel Jasper | cd1a32b | 2012-12-21 17:58:39 +0000 | [diff] [blame] | 886 | // Comma is a binary operator, but does not behave as such wrt. formatting. |
Daniel Jasper | cf225b6 | 2012-12-24 13:43:52 +0000 | [diff] [blame] | 887 | return getPrecedence(Tok) > prec::Comma; |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 888 | } |
| 889 | |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 890 | TokenType determineStarAmpUsage(const AnnotatedToken &Tok, bool IsRHS) { |
| 891 | if (Tok.Parent == NULL) |
Daniel Jasper | 7160751 | 2013-01-07 10:48:50 +0000 | [diff] [blame] | 892 | return TT_UnaryOperator; |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 893 | if (Tok.Children.size() == 0) |
Daniel Jasper | 7160751 | 2013-01-07 10:48:50 +0000 | [diff] [blame] | 894 | return TT_Unknown; |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 895 | const FormatToken &PrevToken = Tok.Parent->FormatTok; |
| 896 | const FormatToken &NextToken = Tok.Children[0].FormatTok; |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 897 | |
Daniel Jasper | 9bb0d28 | 2013-01-04 20:46:38 +0000 | [diff] [blame] | 898 | if (PrevToken.Tok.is(tok::l_paren) || PrevToken.Tok.is(tok::l_square) || |
| 899 | PrevToken.Tok.is(tok::comma) || PrevToken.Tok.is(tok::kw_return) || |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 900 | PrevToken.Tok.is(tok::colon) || Tok.Parent->Type == TT_BinaryOperator) |
Daniel Jasper | 7160751 | 2013-01-07 10:48:50 +0000 | [diff] [blame] | 901 | return TT_UnaryOperator; |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 902 | |
Daniel Jasper | ef5b9c3 | 2013-01-02 15:46:59 +0000 | [diff] [blame] | 903 | if (PrevToken.Tok.isLiteral() || NextToken.Tok.isLiteral() || |
Daniel Jasper | ba3d307 | 2013-01-02 17:21:36 +0000 | [diff] [blame] | 904 | NextToken.Tok.is(tok::plus) || NextToken.Tok.is(tok::minus) || |
| 905 | NextToken.Tok.is(tok::plusplus) || NextToken.Tok.is(tok::minusminus) || |
| 906 | NextToken.Tok.is(tok::tilde) || NextToken.Tok.is(tok::exclaim) || |
| 907 | NextToken.Tok.is(tok::kw_alignof) || NextToken.Tok.is(tok::kw_sizeof)) |
Daniel Jasper | 7160751 | 2013-01-07 10:48:50 +0000 | [diff] [blame] | 908 | return TT_BinaryOperator; |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 909 | |
Daniel Jasper | ef5b9c3 | 2013-01-02 15:46:59 +0000 | [diff] [blame] | 910 | if (NextToken.Tok.is(tok::comma) || NextToken.Tok.is(tok::r_paren) || |
| 911 | NextToken.Tok.is(tok::greater)) |
Daniel Jasper | 7160751 | 2013-01-07 10:48:50 +0000 | [diff] [blame] | 912 | return TT_PointerOrReference; |
Daniel Jasper | ef5b9c3 | 2013-01-02 15:46:59 +0000 | [diff] [blame] | 913 | |
Daniel Jasper | 112fb27 | 2012-12-05 07:51:39 +0000 | [diff] [blame] | 914 | // It is very unlikely that we are going to find a pointer or reference type |
| 915 | // definition on the RHS of an assignment. |
Nico Weber | 00d5a04 | 2012-12-23 01:07:46 +0000 | [diff] [blame] | 916 | if (IsRHS) |
Daniel Jasper | 7160751 | 2013-01-07 10:48:50 +0000 | [diff] [blame] | 917 | return TT_BinaryOperator; |
Daniel Jasper | 112fb27 | 2012-12-05 07:51:39 +0000 | [diff] [blame] | 918 | |
Daniel Jasper | 7160751 | 2013-01-07 10:48:50 +0000 | [diff] [blame] | 919 | return TT_PointerOrReference; |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 920 | } |
| 921 | |
Daniel Jasper | 886568d | 2013-01-09 08:36:49 +0000 | [diff] [blame] | 922 | TokenType determinePlusMinusCaretUsage(const AnnotatedToken &Tok) { |
Daniel Jasper | 98e6b4a | 2012-12-21 09:41:31 +0000 | [diff] [blame] | 923 | // At the start of the line, +/- specific ObjectiveC method declarations. |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 924 | if (Tok.Parent == NULL) |
Daniel Jasper | 7160751 | 2013-01-07 10:48:50 +0000 | [diff] [blame] | 925 | return TT_ObjCMethodSpecifier; |
Daniel Jasper | 98e6b4a | 2012-12-21 09:41:31 +0000 | [diff] [blame] | 926 | |
| 927 | // Use heuristics to recognize unary operators. |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 928 | if (Tok.Parent->is(tok::equal) || Tok.Parent->is(tok::l_paren) || |
| 929 | Tok.Parent->is(tok::comma) || Tok.Parent->is(tok::l_square) || |
| 930 | Tok.Parent->is(tok::question) || Tok.Parent->is(tok::colon) || |
| 931 | Tok.Parent->is(tok::kw_return) || Tok.Parent->is(tok::kw_case)) |
Daniel Jasper | 7160751 | 2013-01-07 10:48:50 +0000 | [diff] [blame] | 932 | return TT_UnaryOperator; |
Daniel Jasper | 98e6b4a | 2012-12-21 09:41:31 +0000 | [diff] [blame] | 933 | |
| 934 | // There can't be to consecutive binary operators. |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 935 | if (Tok.Parent->Type == TT_BinaryOperator) |
Daniel Jasper | 7160751 | 2013-01-07 10:48:50 +0000 | [diff] [blame] | 936 | return TT_UnaryOperator; |
Daniel Jasper | 98e6b4a | 2012-12-21 09:41:31 +0000 | [diff] [blame] | 937 | |
| 938 | // Fall back to marking the token as binary operator. |
Daniel Jasper | 7160751 | 2013-01-07 10:48:50 +0000 | [diff] [blame] | 939 | return TT_BinaryOperator; |
Daniel Jasper | 98e6b4a | 2012-12-21 09:41:31 +0000 | [diff] [blame] | 940 | } |
| 941 | |
| 942 | /// \brief Determine whether ++/-- are pre- or post-increments/-decrements. |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 943 | TokenType determineIncrementUsage(const AnnotatedToken &Tok) { |
| 944 | if (Tok.Parent != NULL && Tok.Parent->is(tok::identifier)) |
Daniel Jasper | 7160751 | 2013-01-07 10:48:50 +0000 | [diff] [blame] | 945 | return TT_TrailingUnaryOperator; |
Daniel Jasper | 98e6b4a | 2012-12-21 09:41:31 +0000 | [diff] [blame] | 946 | |
Daniel Jasper | 7160751 | 2013-01-07 10:48:50 +0000 | [diff] [blame] | 947 | return TT_UnaryOperator; |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 948 | } |
| 949 | |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 950 | bool spaceRequiredBetween(const AnnotatedToken &Left, |
| 951 | const AnnotatedToken &Right) { |
Daniel Jasper | 765561f | 2013-01-08 16:17:54 +0000 | [diff] [blame] | 952 | if (Right.is(tok::hashhash)) |
| 953 | return Left.is(tok::hash); |
| 954 | if (Left.is(tok::hashhash) || Left.is(tok::hash)) |
| 955 | return Right.is(tok::hash); |
Daniel Jasper | 8b39c66 | 2012-12-10 18:59:13 +0000 | [diff] [blame] | 956 | if (Right.is(tok::r_paren) || Right.is(tok::semi) || Right.is(tok::comma)) |
| 957 | return false; |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 958 | if (Left.is(tok::kw_template) && Right.is(tok::less)) |
| 959 | return true; |
| 960 | if (Left.is(tok::arrow) || Right.is(tok::arrow)) |
| 961 | return false; |
| 962 | if (Left.is(tok::exclaim) || Left.is(tok::tilde)) |
| 963 | return false; |
Nico Weber | cb4d690 | 2013-01-08 19:40:21 +0000 | [diff] [blame] | 964 | if (Left.is(tok::at) && |
| 965 | (Right.is(tok::identifier) || Right.is(tok::string_literal) || |
| 966 | Right.is(tok::char_constant) || Right.is(tok::numeric_constant) || |
| 967 | Right.is(tok::l_paren) || Right.is(tok::l_brace))) |
Fariborz Jahanian | 154120c | 2012-12-20 19:54:13 +0000 | [diff] [blame] | 968 | return false; |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 969 | if (Left.is(tok::less) || Right.is(tok::greater) || Right.is(tok::less)) |
| 970 | return false; |
Daniel Jasper | c74e279 | 2012-12-07 09:52:15 +0000 | [diff] [blame] | 971 | if (Right.is(tok::amp) || Right.is(tok::star)) |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 972 | return Left.FormatTok.Tok.isLiteral() || |
Daniel Jasper | d7610b8 | 2012-12-24 16:51:15 +0000 | [diff] [blame] | 973 | (Left.isNot(tok::star) && Left.isNot(tok::amp) && |
| 974 | !Style.PointerAndReferenceBindToType); |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 975 | if (Left.is(tok::amp) || Left.is(tok::star)) |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 976 | return Right.FormatTok.Tok.isLiteral() || |
| 977 | Style.PointerAndReferenceBindToType; |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 978 | if (Right.is(tok::star) && Left.is(tok::l_paren)) |
| 979 | return false; |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 980 | if (Left.is(tok::l_square) || Right.is(tok::l_square) || |
| 981 | Right.is(tok::r_square)) |
| 982 | return false; |
Daniel Jasper | c74e279 | 2012-12-07 09:52:15 +0000 | [diff] [blame] | 983 | if (Left.is(tok::coloncolon) || |
| 984 | (Right.is(tok::coloncolon) && |
| 985 | (Left.is(tok::identifier) || Left.is(tok::greater)))) |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 986 | return false; |
| 987 | if (Left.is(tok::period) || Right.is(tok::period)) |
| 988 | return false; |
| 989 | if (Left.is(tok::colon) || Right.is(tok::colon)) |
| 990 | return true; |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 991 | if (Left.is(tok::l_paren)) |
| 992 | return false; |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 993 | if (Right.is(tok::l_paren)) { |
Daniel Jasper | 98e6b4a | 2012-12-21 09:41:31 +0000 | [diff] [blame] | 994 | return Left.is(tok::kw_if) || Left.is(tok::kw_for) || |
Daniel Jasper | d7610b8 | 2012-12-24 16:51:15 +0000 | [diff] [blame] | 995 | Left.is(tok::kw_while) || Left.is(tok::kw_switch) || |
| 996 | (Left.isNot(tok::identifier) && Left.isNot(tok::kw_sizeof) && |
Daniel Jasper | ba3d307 | 2013-01-02 17:21:36 +0000 | [diff] [blame] | 997 | Left.isNot(tok::kw_typeof) && Left.isNot(tok::kw_alignof)); |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 998 | } |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 999 | if (Left.is(tok::at) && |
| 1000 | Right.FormatTok.Tok.getObjCKeywordID() != tok::objc_not_keyword) |
Nico Weber | d0af4b4 | 2013-01-07 16:14:28 +0000 | [diff] [blame] | 1001 | return false; |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 1002 | return true; |
| 1003 | } |
| 1004 | |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 1005 | bool spaceRequiredBefore(const AnnotatedToken &Tok) { |
Daniel Jasper | da92771 | 2013-01-07 15:36:15 +0000 | [diff] [blame] | 1006 | if (CurrentLineType == LT_ObjCMethodDecl) { |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 1007 | if (Tok.is(tok::identifier) && !Tok.Children.empty() && |
| 1008 | Tok.Children[0].is(tok::colon) && Tok.Parent->is(tok::identifier)) |
Daniel Jasper | da92771 | 2013-01-07 15:36:15 +0000 | [diff] [blame] | 1009 | return true; |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 1010 | if (Tok.is(tok::colon)) |
Daniel Jasper | da92771 | 2013-01-07 15:36:15 +0000 | [diff] [blame] | 1011 | return false; |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 1012 | if (Tok.Parent->Type == TT_ObjCMethodSpecifier) |
Daniel Jasper | da92771 | 2013-01-07 15:36:15 +0000 | [diff] [blame] | 1013 | return true; |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 1014 | if (Tok.Parent->is(tok::r_paren) && Tok.is(tok::identifier)) |
Daniel Jasper | da92771 | 2013-01-07 15:36:15 +0000 | [diff] [blame] | 1015 | // Don't space between ')' and <id> |
| 1016 | return false; |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 1017 | if (Tok.Parent->is(tok::colon) && Tok.is(tok::l_paren)) |
Daniel Jasper | da92771 | 2013-01-07 15:36:15 +0000 | [diff] [blame] | 1018 | // Don't space between ':' and '(' |
| 1019 | return false; |
| 1020 | } |
| 1021 | |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 1022 | if (Tok.Type == TT_CtorInitializerColon) |
Daniel Jasper | da92771 | 2013-01-07 15:36:15 +0000 | [diff] [blame] | 1023 | return true; |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 1024 | if (Tok.Type == TT_OverloadedOperator) |
| 1025 | return Tok.is(tok::identifier) || Tok.is(tok::kw_new) || |
| 1026 | Tok.is(tok::kw_delete); |
| 1027 | if (Tok.Parent->Type == TT_OverloadedOperator) |
Daniel Jasper | da92771 | 2013-01-07 15:36:15 +0000 | [diff] [blame] | 1028 | return false; |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 1029 | if (Tok.is(tok::colon)) |
| 1030 | return RootToken.isNot(tok::kw_case) && (!Tok.Children.empty()); |
| 1031 | if (Tok.Parent->Type == TT_UnaryOperator) |
Daniel Jasper | da92771 | 2013-01-07 15:36:15 +0000 | [diff] [blame] | 1032 | return false; |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 1033 | if (Tok.Type == TT_UnaryOperator) |
| 1034 | return Tok.Parent->isNot(tok::l_paren) && |
| 1035 | Tok.Parent->isNot(tok::l_square); |
| 1036 | if (Tok.Parent->is(tok::greater) && Tok.is(tok::greater)) { |
| 1037 | return Tok.Type == TT_TemplateCloser && Tok.Parent->Type == |
Daniel Jasper | da92771 | 2013-01-07 15:36:15 +0000 | [diff] [blame] | 1038 | TT_TemplateCloser && Style.SplitTemplateClosingGreater; |
| 1039 | } |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 1040 | if (Tok.Type == TT_DirectorySeparator || |
| 1041 | Tok.Parent->Type == TT_DirectorySeparator) |
Daniel Jasper | da92771 | 2013-01-07 15:36:15 +0000 | [diff] [blame] | 1042 | return false; |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 1043 | if (Tok.Type == TT_BinaryOperator || Tok.Parent->Type == TT_BinaryOperator) |
Daniel Jasper | da92771 | 2013-01-07 15:36:15 +0000 | [diff] [blame] | 1044 | return true; |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 1045 | if (Tok.Parent->Type == TT_TemplateCloser && Tok.is(tok::l_paren)) |
Daniel Jasper | da92771 | 2013-01-07 15:36:15 +0000 | [diff] [blame] | 1046 | return false; |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 1047 | if (Tok.is(tok::less) && RootToken.is(tok::hash)) |
Daniel Jasper | da92771 | 2013-01-07 15:36:15 +0000 | [diff] [blame] | 1048 | return true; |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 1049 | if (Tok.Type == TT_TrailingUnaryOperator) |
Daniel Jasper | da92771 | 2013-01-07 15:36:15 +0000 | [diff] [blame] | 1050 | return false; |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 1051 | return spaceRequiredBetween(*Tok.Parent, Tok); |
Daniel Jasper | da92771 | 2013-01-07 15:36:15 +0000 | [diff] [blame] | 1052 | } |
| 1053 | |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 1054 | bool canBreakBefore(const AnnotatedToken &Right) { |
| 1055 | const AnnotatedToken &Left = *Right.Parent; |
Daniel Jasper | da92771 | 2013-01-07 15:36:15 +0000 | [diff] [blame] | 1056 | if (CurrentLineType == LT_ObjCMethodDecl) { |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 1057 | if (Right.is(tok::identifier) && !Right.Children.empty() && |
| 1058 | Right.Children[0].is(tok::colon) && Left.is(tok::identifier)) |
Daniel Jasper | da92771 | 2013-01-07 15:36:15 +0000 | [diff] [blame] | 1059 | return true; |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 1060 | if (CurrentLineType == LT_ObjCMethodDecl && Right.is(tok::identifier) && |
| 1061 | Left.is(tok::l_paren) && Left.Parent->is(tok::colon)) |
Daniel Jasper | da92771 | 2013-01-07 15:36:15 +0000 | [diff] [blame] | 1062 | // Don't break this identifier as ':' or identifier |
| 1063 | // before it will break. |
| 1064 | return false; |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 1065 | if (Right.is(tok::colon) && Left.is(tok::identifier) && |
| 1066 | Left.CanBreakBefore) |
Daniel Jasper | da92771 | 2013-01-07 15:36:15 +0000 | [diff] [blame] | 1067 | // Don't break at ':' if identifier before it can beak. |
| 1068 | return false; |
| 1069 | } |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 1070 | if (Left.ClosesTemplateDeclaration) |
Daniel Jasper | 5eda31e | 2013-01-02 18:30:06 +0000 | [diff] [blame] | 1071 | return true; |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 1072 | if (Left.Type == TT_PointerOrReference || Left.Type == TT_TemplateCloser || |
Daniel Jasper | 2db356d | 2013-01-08 20:03:18 +0000 | [diff] [blame] | 1073 | Left.Type == TT_UnaryOperator || Right.Type == TT_ConditionalExpr) |
Daniel Jasper | 4dc41de | 2013-01-02 08:44:14 +0000 | [diff] [blame] | 1074 | return false; |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 1075 | if (Left.is(tok::equal) && CurrentLineType == LT_VirtualFunctionDecl) |
Daniel Jasper | 7160751 | 2013-01-07 10:48:50 +0000 | [diff] [blame] | 1076 | return false; |
| 1077 | |
Daniel Jasper | 043835a | 2013-01-09 09:33:39 +0000 | [diff] [blame] | 1078 | if (Right.is(tok::comment)) |
| 1079 | return !Right.Children.empty(); |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 1080 | if (Right.is(tok::r_paren) || Right.is(tok::l_brace) || |
Daniel Jasper | 043835a | 2013-01-09 09:33:39 +0000 | [diff] [blame] | 1081 | Right.is(tok::greater)) |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 1082 | return false; |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 1083 | return (isBinaryOperator(Left) && Left.isNot(tok::lessless)) || |
| 1084 | Left.is(tok::comma) || Right.is(tok::lessless) || |
| 1085 | Right.is(tok::arrow) || Right.is(tok::period) || |
| 1086 | Right.is(tok::colon) || Left.is(tok::semi) || |
Daniel Jasper | 9c837d0 | 2013-01-09 07:06:56 +0000 | [diff] [blame] | 1087 | Left.is(tok::l_brace) || Left.is(tok::question) || |
| 1088 | Left.Type == TT_ConditionalExpr || |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 1089 | (Left.is(tok::l_paren) && !Right.is(tok::r_paren)); |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 1090 | } |
| 1091 | |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 1092 | FormatStyle Style; |
| 1093 | SourceManager &SourceMgr; |
Manuel Klimek | 6cf5814 | 2013-01-07 08:54:53 +0000 | [diff] [blame] | 1094 | Lexer &Lex; |
Daniel Jasper | 7160751 | 2013-01-07 10:48:50 +0000 | [diff] [blame] | 1095 | LineType CurrentLineType; |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 1096 | AnnotatedToken RootToken; |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 1097 | }; |
| 1098 | |
Alexander Kornienko | 469a21b | 2012-12-07 16:15:44 +0000 | [diff] [blame] | 1099 | class LexerBasedFormatTokenSource : public FormatTokenSource { |
| 1100 | public: |
| 1101 | LexerBasedFormatTokenSource(Lexer &Lex, SourceManager &SourceMgr) |
Daniel Jasper | 1321eb5 | 2012-12-18 21:05:13 +0000 | [diff] [blame] | 1102 | : GreaterStashed(false), Lex(Lex), SourceMgr(SourceMgr), |
Alexander Kornienko | 469a21b | 2012-12-07 16:15:44 +0000 | [diff] [blame] | 1103 | IdentTable(Lex.getLangOpts()) { |
| 1104 | Lex.SetKeepWhitespaceMode(true); |
| 1105 | } |
| 1106 | |
| 1107 | virtual FormatToken getNextToken() { |
| 1108 | if (GreaterStashed) { |
| 1109 | FormatTok.NewlinesBefore = 0; |
| 1110 | FormatTok.WhiteSpaceStart = |
| 1111 | FormatTok.Tok.getLocation().getLocWithOffset(1); |
| 1112 | FormatTok.WhiteSpaceLength = 0; |
| 1113 | GreaterStashed = false; |
| 1114 | return FormatTok; |
| 1115 | } |
| 1116 | |
| 1117 | FormatTok = FormatToken(); |
| 1118 | Lex.LexFromRawLexer(FormatTok.Tok); |
Manuel Klimek | 9541938 | 2013-01-07 07:56:50 +0000 | [diff] [blame] | 1119 | StringRef Text = rawTokenText(FormatTok.Tok); |
Alexander Kornienko | 469a21b | 2012-12-07 16:15:44 +0000 | [diff] [blame] | 1120 | FormatTok.WhiteSpaceStart = FormatTok.Tok.getLocation(); |
Manuel Klimek | f6fd00b | 2013-01-05 22:56:06 +0000 | [diff] [blame] | 1121 | if (SourceMgr.getFileOffset(FormatTok.WhiteSpaceStart) == 0) |
| 1122 | FormatTok.IsFirst = true; |
Alexander Kornienko | 469a21b | 2012-12-07 16:15:44 +0000 | [diff] [blame] | 1123 | |
| 1124 | // Consume and record whitespace until we find a significant token. |
| 1125 | while (FormatTok.Tok.is(tok::unknown)) { |
Manuel Klimek | a080a18 | 2013-01-02 16:30:12 +0000 | [diff] [blame] | 1126 | FormatTok.NewlinesBefore += Text.count('\n'); |
Daniel Jasper | cd16238 | 2013-01-07 13:26:07 +0000 | [diff] [blame] | 1127 | FormatTok.HasUnescapedNewline = Text.count("\\\n") != |
| 1128 | FormatTok.NewlinesBefore; |
Alexander Kornienko | 469a21b | 2012-12-07 16:15:44 +0000 | [diff] [blame] | 1129 | FormatTok.WhiteSpaceLength += FormatTok.Tok.getLength(); |
| 1130 | |
| 1131 | if (FormatTok.Tok.is(tok::eof)) |
| 1132 | return FormatTok; |
| 1133 | Lex.LexFromRawLexer(FormatTok.Tok); |
Manuel Klimek | 9541938 | 2013-01-07 07:56:50 +0000 | [diff] [blame] | 1134 | Text = rawTokenText(FormatTok.Tok); |
Manuel Klimek | d4397b9 | 2013-01-04 23:34:14 +0000 | [diff] [blame] | 1135 | } |
Manuel Klimek | 9541938 | 2013-01-07 07:56:50 +0000 | [diff] [blame] | 1136 | |
| 1137 | // Now FormatTok is the next non-whitespace token. |
| 1138 | FormatTok.TokenLength = Text.size(); |
| 1139 | |
Manuel Klimek | d4397b9 | 2013-01-04 23:34:14 +0000 | [diff] [blame] | 1140 | // In case the token starts with escaped newlines, we want to |
| 1141 | // take them into account as whitespace - this pattern is quite frequent |
| 1142 | // in macro definitions. |
| 1143 | // FIXME: What do we want to do with other escaped spaces, and escaped |
| 1144 | // spaces or newlines in the middle of tokens? |
| 1145 | // FIXME: Add a more explicit test. |
| 1146 | unsigned i = 0; |
Daniel Jasper | 7160751 | 2013-01-07 10:48:50 +0000 | [diff] [blame] | 1147 | while (i + 1 < Text.size() && Text[i] == '\\' && Text[i + 1] == '\n') { |
Manuel Klimek | d4397b9 | 2013-01-04 23:34:14 +0000 | [diff] [blame] | 1148 | FormatTok.WhiteSpaceLength += 2; |
Manuel Klimek | 9541938 | 2013-01-07 07:56:50 +0000 | [diff] [blame] | 1149 | FormatTok.TokenLength -= 2; |
Manuel Klimek | d4397b9 | 2013-01-04 23:34:14 +0000 | [diff] [blame] | 1150 | i += 2; |
Alexander Kornienko | 469a21b | 2012-12-07 16:15:44 +0000 | [diff] [blame] | 1151 | } |
| 1152 | |
| 1153 | if (FormatTok.Tok.is(tok::raw_identifier)) { |
Manuel Klimek | d4397b9 | 2013-01-04 23:34:14 +0000 | [diff] [blame] | 1154 | IdentifierInfo &Info = IdentTable.get(Text); |
Daniel Jasper | cd1a32b | 2012-12-21 17:58:39 +0000 | [diff] [blame] | 1155 | FormatTok.Tok.setIdentifierInfo(&Info); |
Alexander Kornienko | 469a21b | 2012-12-07 16:15:44 +0000 | [diff] [blame] | 1156 | FormatTok.Tok.setKind(Info.getTokenID()); |
| 1157 | } |
| 1158 | |
| 1159 | if (FormatTok.Tok.is(tok::greatergreater)) { |
| 1160 | FormatTok.Tok.setKind(tok::greater); |
| 1161 | GreaterStashed = true; |
| 1162 | } |
| 1163 | |
| 1164 | return FormatTok; |
| 1165 | } |
| 1166 | |
| 1167 | private: |
| 1168 | FormatToken FormatTok; |
| 1169 | bool GreaterStashed; |
| 1170 | Lexer &Lex; |
| 1171 | SourceManager &SourceMgr; |
| 1172 | IdentifierTable IdentTable; |
| 1173 | |
| 1174 | /// Returns the text of \c FormatTok. |
Manuel Klimek | 9541938 | 2013-01-07 07:56:50 +0000 | [diff] [blame] | 1175 | StringRef rawTokenText(Token &Tok) { |
Alexander Kornienko | 469a21b | 2012-12-07 16:15:44 +0000 | [diff] [blame] | 1176 | return StringRef(SourceMgr.getCharacterData(Tok.getLocation()), |
| 1177 | Tok.getLength()); |
| 1178 | } |
| 1179 | }; |
| 1180 | |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 1181 | class Formatter : public UnwrappedLineConsumer { |
| 1182 | public: |
| 1183 | Formatter(const FormatStyle &Style, Lexer &Lex, SourceManager &SourceMgr, |
| 1184 | const std::vector<CharSourceRange> &Ranges) |
Daniel Jasper | 1321eb5 | 2012-12-18 21:05:13 +0000 | [diff] [blame] | 1185 | : Style(Style), Lex(Lex), SourceMgr(SourceMgr), Ranges(Ranges), |
Alexander Kornienko | cff563c | 2012-12-04 17:27:50 +0000 | [diff] [blame] | 1186 | StructuralError(false) { |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 1187 | } |
| 1188 | |
Daniel Jasper | accb0b0 | 2012-12-04 21:05:31 +0000 | [diff] [blame] | 1189 | virtual ~Formatter() { |
| 1190 | } |
| 1191 | |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 1192 | tooling::Replacements format() { |
Alexander Kornienko | 469a21b | 2012-12-07 16:15:44 +0000 | [diff] [blame] | 1193 | LexerBasedFormatTokenSource Tokens(Lex, SourceMgr); |
| 1194 | UnwrappedLineParser Parser(Style, Tokens, *this); |
Alexander Kornienko | cff563c | 2012-12-04 17:27:50 +0000 | [diff] [blame] | 1195 | StructuralError = Parser.parse(); |
Manuel Klimek | d4397b9 | 2013-01-04 23:34:14 +0000 | [diff] [blame] | 1196 | unsigned PreviousEndOfLineColumn = 0; |
Alexander Kornienko | cff563c | 2012-12-04 17:27:50 +0000 | [diff] [blame] | 1197 | for (std::vector<UnwrappedLine>::iterator I = UnwrappedLines.begin(), |
| 1198 | E = UnwrappedLines.end(); |
| 1199 | I != E; ++I) |
Daniel Jasper | cd16238 | 2013-01-07 13:26:07 +0000 | [diff] [blame] | 1200 | PreviousEndOfLineColumn = formatUnwrappedLine(*I, |
| 1201 | PreviousEndOfLineColumn); |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 1202 | return Replaces; |
| 1203 | } |
| 1204 | |
| 1205 | private: |
Alexander Kornienko | 720ffb6 | 2012-12-05 13:56:52 +0000 | [diff] [blame] | 1206 | virtual void consumeUnwrappedLine(const UnwrappedLine &TheLine) { |
Alexander Kornienko | cff563c | 2012-12-04 17:27:50 +0000 | [diff] [blame] | 1207 | UnwrappedLines.push_back(TheLine); |
| 1208 | } |
| 1209 | |
Manuel Klimek | d4397b9 | 2013-01-04 23:34:14 +0000 | [diff] [blame] | 1210 | unsigned formatUnwrappedLine(const UnwrappedLine &TheLine, |
| 1211 | unsigned PreviousEndOfLineColumn) { |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 1212 | const FormatToken *First = &TheLine.RootToken; |
| 1213 | const FormatToken *Last = First; |
| 1214 | while (!Last->Children.empty()) |
| 1215 | Last = &Last->Children.back(); |
Daniel Jasper | cd16238 | 2013-01-07 13:26:07 +0000 | [diff] [blame] | 1216 | CharSourceRange LineRange = CharSourceRange::getTokenRange( |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 1217 | First->Tok.getLocation(), |
| 1218 | Last->Tok.getLocation()); |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 1219 | |
| 1220 | for (unsigned i = 0, e = Ranges.size(); i != e; ++i) { |
| 1221 | if (SourceMgr.isBeforeInTranslationUnit(LineRange.getEnd(), |
| 1222 | Ranges[i].getBegin()) || |
| 1223 | SourceMgr.isBeforeInTranslationUnit(Ranges[i].getEnd(), |
| 1224 | LineRange.getBegin())) |
| 1225 | continue; |
| 1226 | |
Manuel Klimek | 6cf5814 | 2013-01-07 08:54:53 +0000 | [diff] [blame] | 1227 | TokenAnnotator Annotator(TheLine, Style, SourceMgr, Lex); |
Daniel Jasper | 1f42f11 | 2013-01-04 18:52:56 +0000 | [diff] [blame] | 1228 | if (!Annotator.annotate()) |
Manuel Klimek | d4397b9 | 2013-01-04 23:34:14 +0000 | [diff] [blame] | 1229 | break; |
| 1230 | UnwrappedLineFormatter Formatter( |
| 1231 | Style, SourceMgr, TheLine, PreviousEndOfLineColumn, |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 1232 | Annotator.getLineType(), Annotator.getRootToken(), Replaces, |
Daniel Jasper | 7160751 | 2013-01-07 10:48:50 +0000 | [diff] [blame] | 1233 | StructuralError); |
Manuel Klimek | d4397b9 | 2013-01-04 23:34:14 +0000 | [diff] [blame] | 1234 | return Formatter.format(); |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 1235 | } |
Manuel Klimek | d4397b9 | 2013-01-04 23:34:14 +0000 | [diff] [blame] | 1236 | // If we did not reformat this unwrapped line, the column at the end of the |
| 1237 | // last token is unchanged - thus, we can calculate the end of the last |
| 1238 | // token, and return the result. |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 1239 | return SourceMgr.getSpellingColumnNumber(Last->Tok.getLocation()) + |
| 1240 | Lex.MeasureTokenLength(Last->Tok.getLocation(), SourceMgr, |
Manuel Klimek | d4397b9 | 2013-01-04 23:34:14 +0000 | [diff] [blame] | 1241 | Lex.getLangOpts()) - |
| 1242 | 1; |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 1243 | } |
| 1244 | |
| 1245 | FormatStyle Style; |
| 1246 | Lexer &Lex; |
| 1247 | SourceManager &SourceMgr; |
| 1248 | tooling::Replacements Replaces; |
| 1249 | std::vector<CharSourceRange> Ranges; |
Alexander Kornienko | cff563c | 2012-12-04 17:27:50 +0000 | [diff] [blame] | 1250 | std::vector<UnwrappedLine> UnwrappedLines; |
| 1251 | bool StructuralError; |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 1252 | }; |
| 1253 | |
| 1254 | tooling::Replacements reformat(const FormatStyle &Style, Lexer &Lex, |
| 1255 | SourceManager &SourceMgr, |
| 1256 | std::vector<CharSourceRange> Ranges) { |
| 1257 | Formatter formatter(Style, Lex, SourceMgr, Ranges); |
| 1258 | return formatter.format(); |
| 1259 | } |
| 1260 | |
Daniel Jasper | cd16238 | 2013-01-07 13:26:07 +0000 | [diff] [blame] | 1261 | } // namespace format |
| 1262 | } // namespace clang |