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