Unreviewed, rolling out r152598.
[WebKit-https.git] / Source / WebInspectorUI / Tools / PrettyPrinting / CodeMirrorFormatters.js
1 // In the inspector token types have been modified to include extra mode information
2 // after the actual token type. So we can't do token === "foo". So instead we do
3 // /\bfoo\b/.test(token).
4
5 CodeMirror.extendMode("javascript", {
6     shouldHaveSpaceBeforeToken: function(lastToken, lastContent, token, state, content, isComment)
7     {
8         if (!token) {
9             if (content === "(") // Most keywords like "if (" but not "function(" or "typeof(".
10                 return lastToken && /\bkeyword\b/.test(lastToken) && (lastContent !== "function" && lastContent !== "typeof" && lastContent !== "instanceof");
11             if (content === ":") // Ternary.
12                 return (state.lexical.type === "stat" || state.lexical.type === ")");
13             if (content === "!") // Unary ! should not be confused with "!=".
14                 return false;
15             return "+-/*&&||!===+=-=>=<=?".indexOf(content) >= 0; // Operators.
16         }
17
18         if (isComment)
19             return true;
20
21         if (/\bkeyword\b/.test(token)) { // Most keywords require spaces before them, unless a '}' can come before it.
22             if (content === "else" || content === "catch" || content === "finally")
23                 return lastContent === "}";
24             return false;
25         }
26
27         return false;
28     },
29
30     shouldHaveSpaceAfterLastToken: function(lastToken, lastContent, token, state, content, isComment)
31     {
32         if (lastToken && /\bkeyword\b/.test(lastToken)) {  // Most keywords require spaces after them, unless a '{' or ';' can come after it.
33             if (lastContent === "else")
34                 return true;
35             if (lastContent === "catch")
36                 return true;
37             if (lastContent === "return")
38                 return content !== ";";
39             if (lastContent === "throw")
40                 return true;
41             if (lastContent === "try")
42                 return true;
43             if (lastContent === "finally")
44                 return true;
45             return false;
46         }
47
48         if (lastToken && /\bcomment\b/.test(lastToken)) // Embedded /* comment */.
49             return true;
50         if (lastContent === ")") // "){".
51             return content === "{";
52         if (lastContent === ";") // In for loop.
53             return state.lexical.type === ")";
54         if (lastContent === "!") // Unary ! should not be confused with "!=".
55             return false;
56
57         return ",+-/*&&||:!===+=-=>=<=?".indexOf(lastContent) >= 0; // Operators.
58     },
59
60     newlinesAfterToken: function(lastToken, lastContent, token, state, content, isComment)
61     {
62         if (!token) {
63             if (content === ",") // In object literals, like in {a:1,b:2}, but not in param lists or vardef lists.
64                 return state.lexical.type === "}" ? 1 : 0;
65             if (content === ";") // Everywhere except in for loop conditions.
66                 return state.lexical.type !== ")" ? 1 : 0;
67             if (content === ":" && state.lexical.type === "}" && state.lexical.prev && state.lexical.prev.type === "form") // Switch case/default.
68                 return 1;
69             return content.length === 1 && "{}".indexOf(content) >= 0 ? 1 : 0; // After braces.
70         }
71
72         if (isComment)
73             return 1;
74
75         return 0;
76     },
77
78     removeLastNewline: function(lastToken, lastContent, token, state, content, isComment, firstTokenOnLine)
79     {
80         if (!token) {
81             if (content === "}") // "{}".
82                 return lastContent === "{";
83             if (content === ";") // "x = {};" or ";;".
84                 return "};".indexOf(lastContent) >= 0;
85             if (content === ":") // Ternary.
86                 return lastContent === "}" && (state.lexical.type === "stat" || state.lexical.type === ")");
87             if (",().".indexOf(content) >= 0) // "})", "}.bind", "function() { ... }()", or "}, false)".
88                 return lastContent === "}";
89             return false;
90         }
91
92         if (isComment) { // Comment after semicolon.
93             if (!firstTokenOnLine && lastContent === ";")
94                 return true;
95             return false;
96         }
97
98         if (/\bkeyword\b/.test(token)) {
99             if (content === "else" || content === "catch" || content === "finally") // "} else", "} catch", "} finally"
100                 return lastContent === "}";
101             return false;
102         }
103
104         return false;
105     },
106
107     indentAfterToken: function(lastToken, lastContent, token, state, content, isComment)
108     {
109         return content === "{" || content === "case" || content === "default";
110     },
111
112     newlineBeforeToken: function(lastToken, lastContent, token, state, content, isComment)
113     {
114         if (state._jsPrettyPrint.shouldIndent)
115             return true;
116
117         return content === "}" && lastContent !== "{"; // "{}"
118     },
119
120     indentBeforeToken: function(lastToken, lastContent, token, state, content, isComment)
121     {
122         if (state._jsPrettyPrint.shouldIndent)
123             return true;
124
125         return false;
126     },
127
128     dedentsBeforeToken: function(lastToken, lastContent, token, state, content, isComment)
129     {
130         var dedent = 0;
131
132         if (state._jsPrettyPrint.shouldDedent)
133             dedent += state._jsPrettyPrint.dedentSize;
134
135         if (!token && content === "}")
136             dedent += 1;
137         else if (token && /\bkeyword\b/.test(token) && (content === "case" || content === "default"))
138             dedent += 1;
139
140         return dedent;
141     },
142
143     modifyStateForTokenPre: function(lastToken, lastContent, token, state, content, isComment)
144     {
145         if (!state._jsPrettyPrint) {
146             state._jsPrettyPrint = {
147                 indentCount: 0,       // How far have we indented because of single statement blocks.
148                 shouldIndent: false,  // Signal we should indent on entering a single statement block.
149                 shouldDedent: false,  // Signal we should dedent on leaving a single statement block.
150                 dedentSize: 0,        // How far we should dedent when leaving a single statement block.
151                 lastIfIndentCount: 0, // Keep track of the indent the last time we saw an if without braces.
152                 openBraceStartMarkers: [],  // Keep track of non-single statement blocks.
153                 openBraceTrackingCount: -1, // Keep track of "{" and "}" in non-single statement blocks.
154             };
155         }
156
157         // - Entering:
158         //   - Preconditions:
159         //     - last lexical was a "form" we haven't encountered before
160         //     - last content was ")", "else", or "do"
161         //     - current lexical is not ")" (in an expression or condition)
162         //   - Cases:
163         //     1. "{"
164         //       - indent +0
165         //       - save this indent size so when we encounter the "}" we know how far to dedent
166         //     2. "else if"
167         //       - indent +0 and do not signal to add a newline and indent
168         //       - mark the last if location so when we encounter an "else" we know how far to dedent
169         //       - mark the lexical state so we know we are inside a single statement block
170         //     3. Token without brace.
171         //       - indent +1 and signal to add a newline and indent
172         //       - mark the last if location so when we encounter an "else" we know how far to dedent
173         //       - mark the lexical state so we know we are inside a single statement block
174         if (!isComment && state.lexical.prev && state.lexical.prev.type === "form" && !state.lexical.prev._jsPrettyPrintMarker && (lastContent === ")" || lastContent === "else" || lastContent === "do") && (state.lexical.type !== ")")) {
175             if (content === "{") {
176                 // Save the state at the opening brace so we can return to it when we see "}".
177                 var savedState = {indentCount:state._jsPrettyPrint.indentCount, openBraceTrackingCount:state._jsPrettyPrint.openBraceTrackingCount};
178                 state._jsPrettyPrint.openBraceStartMarkers.push(savedState);
179                 state._jsPrettyPrint.openBraceTrackingCount = 1;
180             } else if (state.lexical.type !== "}") {
181                 // Increase the indent count. Signal for a newline and indent if needed.
182                 if (!(lastContent === "else" && content === "if")) {
183                     state._jsPrettyPrint.indentCount++;
184                     state._jsPrettyPrint.shouldIndent = true;
185                 }
186                 state.lexical.prev._jsPrettyPrintMarker = true;
187                 if (state._jsPrettyPrint.enteringIf)
188                     state._jsPrettyPrint.lastIfIndentCount = state._jsPrettyPrint.indentCount - 1;
189             }
190         }
191
192         // - Leaving:
193         //   - Preconditions:
194         //     - we must be indented
195         //     - ignore ";", wait for the next token instead.
196         //   - Cases:
197         //     1. "else"
198         //       - dedent to the last "if"
199         //     2. "}" and all braces we saw are balanced
200         //       - dedent to the last "{"
201         //     3. Token without a marker on the stack
202         //       - dedent all the way
203         else if (state._jsPrettyPrint.indentCount) {
204             console.assert(!state._jsPrettyPrint.shouldDedent);
205             console.assert(!state._jsPrettyPrint.dedentSize);
206
207             // Track "{" and "}" to know when the "}" is really closing a block.
208             if (!isComment) {
209                 if (content === "{")
210                     state._jsPrettyPrint.openBraceTrackingCount++;
211                 else if (content === "}")
212                     state._jsPrettyPrint.openBraceTrackingCount--;
213             }
214
215             if (content === ";") {
216                 // Ignore.
217             } else if (content === "else") {
218                 // Dedent to the last "if".
219                 if (lastContent !== "}") {
220                     state._jsPrettyPrint.shouldDedent = true;
221                     state._jsPrettyPrint.dedentSize = state._jsPrettyPrint.indentCount - state._jsPrettyPrint.lastIfIndentCount;
222                     state._jsPrettyPrint.lastIfIndentCount = 0;
223                 }
224             } else if (content === "}" && !state._jsPrettyPrint.openBraceTrackingCount && state._jsPrettyPrint.openBraceStartMarkers.length) {
225                 // Dedent to the last "{".
226                 var savedState = state._jsPrettyPrint.openBraceStartMarkers.pop();
227                 state._jsPrettyPrint.shouldDedent = true;
228                 state._jsPrettyPrint.dedentSize = state._jsPrettyPrint.indentCount - savedState.indentCount;
229                 state._jsPrettyPrint.openBraceTrackingCount = savedState.openBraceTrackingCount;
230             } else {
231                 // Dedent all the way.
232                 var shouldDedent = true;
233                 var lexical = state.lexical.prev;
234                 while (lexical) {
235                     if (lexical._jsPrettyPrintMarker) {
236                         shouldDedent = false;
237                         break;
238                     }
239                     lexical = lexical.prev;
240                 }
241                 if (shouldDedent) {
242                     state._jsPrettyPrint.shouldDedent = true;
243                     state._jsPrettyPrint.dedentSize = state._jsPrettyPrint.indentCount;
244                 }
245             }
246         }
247
248         // Signal for when we will be entering an if.
249         if (token && state.lexical.type === "form" && state.lexical.prev && state.lexical.prev !== "form" && /\bkeyword\b/.test(token))
250             state._jsPrettyPrint.enteringIf = (content === "if");
251     },
252
253     modifyStateForTokenPost: function(lastToken, lastContent, token, state, content, isComment)
254     {
255         if (state._jsPrettyPrint.shouldIndent)
256             state._jsPrettyPrint.shouldIndent = false;
257
258         if (state._jsPrettyPrint.shouldDedent) {
259             state._jsPrettyPrint.indentCount -= state._jsPrettyPrint.dedentSize;
260             state._jsPrettyPrint.dedentSize = 0;
261             state._jsPrettyPrint.shouldDedent = false;
262         }
263     }
264 });
265
266 CodeMirror.extendMode("css-base", {
267     shouldHaveSpaceBeforeToken: function(lastToken, lastContent, token, state, content, isComment)
268     {
269         if (!token) {
270             if (content === "{")
271                 return true;
272             return false;
273         }
274
275         if (isComment)
276             return true;
277
278         if (/\bkeyword\b/.test(token)) {
279             if (content.charAt(0) === "!") // "!important".
280                 return true;
281             return false;
282         }
283
284         return false;
285     },
286
287     shouldHaveSpaceAfterLastToken: function(lastToken, lastContent, token, state, content, isComment)
288     {
289         if (!lastToken) {
290             if (lastContent === ",")
291                 return true;
292             return false;
293         }
294
295         if (/\boperator\b/.test(lastToken)) {
296             if (lastContent === ":") // Space in "prop: value" but not in a selectors "a:link" or "div::after" or media queries "(max-device-width:480px)".
297                 return state.stack.lastValue === "propertyValue";
298             return false;
299         }
300
301         if (/\bcomment\b/.test(lastToken))
302             return true;
303
304         return false;
305     },
306
307     newlinesAfterToken: function(lastToken, lastContent, token, state, content, isComment)
308     {
309         if (!token) {
310             if (content === ";")
311                 return 1;
312             if (content === ",") { // "a,b,c,...,z{}" rule list at top level or in @media top level and only if the line length will be large.
313                 if ((!state.stack.length || state.stack.lastValue === "@media{") && state._cssPrettyPrint.lineLength > 60) {
314                     state._cssPrettyPrint.lineLength = 0;
315                     return 1;
316                 }
317                 return 0;
318             }
319             if (content === "{")
320                 return 1;
321             if (content === "}") // 2 newlines between rule declarations.
322                 return 2;
323             return 0;
324         }
325
326         if (isComment)
327             return 1;
328
329         return 0;
330     },
331
332     removeLastNewline: function(lastToken, lastContent, token, state, content, isComment, firstTokenOnLine)
333     {
334         if (isComment) { // Comment after semicolon.
335             if (!firstTokenOnLine && lastContent === ";")
336                 return true;
337             return false;
338         }
339
340         return content === "}" && (lastContent === "{" || lastContent === "}"); // "{}" and "}\n}" when closing @media.
341     },
342
343     indentAfterToken: function(lastToken, lastContent, token, state, content, isComment)
344     {
345         return content === "{";
346     },
347
348     newlineBeforeToken: function(lastToken, lastContent, token, state, content, isComment)
349     {
350         return content === "}" && (lastContent !== "{" && lastContent !== "}"); // "{}" and "}\n}" when closing @media.
351     },
352
353     indentBeforeToken: function(lastToken, lastContent, token, state, content, isComment)
354     {
355         return false;
356     },
357
358     dedentsBeforeToken: function(lastToken, lastContent, token, state, content, isComment)
359     {
360         return content === "}" ? 1 : 0;
361     },
362
363     modifyStateForTokenPost: function(lastToken, lastContent, token, state, content, isComment)
364     {
365         if (!state._cssPrettyPrint)
366             state._cssPrettyPrint = {lineLength: 0};
367
368         // In order insert newlines in selector lists we need keep track of the length of the current line.
369         // This isn't exact line length, only the builder knows that, but it is good enough to get an idea.
370         // If we are at a top level, keep track of the current line length, otherwise we reset to 0.
371         if (!state.stack.length || state.stack.lastValue === "@media{")
372             state._cssPrettyPrint.lineLength += content.length;
373         else
374             state._cssPrettyPrint.lineLength = 0;
375     }
376 });