michael@0: /**
michael@0:  * Helper to test CodeMirror highlighting modes. It pretty prints output of the
michael@0:  * highlighter and can check against expected styles.
michael@0:  *
michael@0:  * Mode tests are registered by calling test.mode(testName, mode,
michael@0:  * tokens), where mode is a mode object as returned by
michael@0:  * CodeMirror.getMode, and tokens is an array of lines that make up
michael@0:  * the test.
michael@0:  *
michael@0:  * These lines are strings, in which styled stretches of code are
michael@0:  * enclosed in brackets `[]`, and prefixed by their style. For
michael@0:  * example, `[keyword if]`. Brackets in the code itself must be
michael@0:  * duplicated to prevent them from being interpreted as token
michael@0:  * boundaries. For example `a[[i]]` for `a[i]`. If a token has
michael@0:  * multiple styles, the styles must be separated by ampersands, for
michael@0:  * example `[tag&error </hmtl>]`.
michael@0:  *
michael@0:  * See the test.js files in the css, markdown, gfm, and stex mode
michael@0:  * directories for examples.
michael@0:  */
michael@0: (function() {
michael@0:   function findSingle(str, pos, ch) {
michael@0:     for (;;) {
michael@0:       var found = str.indexOf(ch, pos);
michael@0:       if (found == -1) return null;
michael@0:       if (str.charAt(found + 1) != ch) return found;
michael@0:       pos = found + 2;
michael@0:     }
michael@0:   }
michael@0: 
michael@0:   var styleName = /[\w&-_]+/g;
michael@0:   function parseTokens(strs) {
michael@0:     var tokens = [], plain = "";
michael@0:     for (var i = 0; i < strs.length; ++i) {
michael@0:       if (i) plain += "\n";
michael@0:       var str = strs[i], pos = 0;
michael@0:       while (pos < str.length) {
michael@0:         var style = null, text;
michael@0:         if (str.charAt(pos) == "[" && str.charAt(pos+1) != "[") {
michael@0:           styleName.lastIndex = pos + 1;
michael@0:           var m = styleName.exec(str);
michael@0:           style = m[0].replace(/&/g, " ");
michael@0:           var textStart = pos + style.length + 2;
michael@0:           var end = findSingle(str, textStart, "]");
michael@0:           if (end == null) throw new Error("Unterminated token at " + pos + " in '" + str + "'" + style);
michael@0:           text = str.slice(textStart, end);
michael@0:           pos = end + 1;
michael@0:         } else {
michael@0:           var end = findSingle(str, pos, "[");
michael@0:           if (end == null) end = str.length;
michael@0:           text = str.slice(pos, end);
michael@0:           pos = end;
michael@0:         }
michael@0:         text = text.replace(/\[\[|\]\]/g, function(s) {return s.charAt(0);});
michael@0:         tokens.push(style, text);
michael@0:         plain += text;
michael@0:       }
michael@0:     }
michael@0:     return {tokens: tokens, plain: plain};
michael@0:   }
michael@0: 
michael@0:   test.mode = function(name, mode, tokens, modeName) {
michael@0:     var data = parseTokens(tokens);
michael@0:     return test((modeName || mode.name) + "_" + name, function() {
michael@0:       return compare(data.plain, data.tokens, mode);
michael@0:     });
michael@0:   };
michael@0: 
michael@0:   function esc(str) {
michael@0:     return str.replace('&', '&amp;').replace('<', '&lt;');
michael@0:   }
michael@0: 
michael@0:   function compare(text, expected, mode) {
michael@0: 
michael@0:     var expectedOutput = [];
michael@0:     for (var i = 0; i < expected.length; i += 2) {
michael@0:       var sty = expected[i];
michael@0:       if (sty && sty.indexOf(" ")) sty = sty.split(' ').sort().join(' ');
michael@0:       expectedOutput.push(sty, expected[i + 1]);
michael@0:     }
michael@0: 
michael@0:     var observedOutput = highlight(text, mode);
michael@0: 
michael@0:     var s = "";
michael@0:     var diff = highlightOutputsDifferent(expectedOutput, observedOutput);
michael@0:     if (diff != null) {
michael@0:       s += '<div class="mt-test mt-fail">';
michael@0:       s +=   '<pre>' + esc(text) + '</pre>';
michael@0:       s +=   '<div class="cm-s-default">';
michael@0:       s += 'expected:';
michael@0:       s +=   prettyPrintOutputTable(expectedOutput, diff);
michael@0:       s += 'observed:';
michael@0:       s +=   prettyPrintOutputTable(observedOutput, diff);
michael@0:       s +=   '</div>';
michael@0:       s += '</div>';
michael@0:     }
michael@0:     if (observedOutput.indentFailures) {
michael@0:       for (var i = 0; i < observedOutput.indentFailures.length; i++)
michael@0:         s += "<div class='mt-test mt-fail'>" + esc(observedOutput.indentFailures[i]) + "</div>";
michael@0:     }
michael@0:     if (s) throw new Failure(s);
michael@0:   }
michael@0: 
michael@0:   function highlight(string, mode) {
michael@0:     var state = mode.startState()
michael@0: 
michael@0:     var lines = string.replace(/\r\n/g,'\n').split('\n');
michael@0:     var st = [], pos = 0;
michael@0:     for (var i = 0; i < lines.length; ++i) {
michael@0:       var line = lines[i], newLine = true;
michael@0:       if (mode.indent) {
michael@0:         var ws = line.match(/^\s*/)[0];
michael@0:         var indent = mode.indent(state, line.slice(ws.length));
michael@0:         if (indent != CodeMirror.Pass && indent != ws.length)
michael@0:           (st.indentFailures || (st.indentFailures = [])).push(
michael@0:             "Indentation of line " + (i + 1) + " is " + indent + " (expected " + ws.length + ")");
michael@0:       }
michael@0:       var stream = new CodeMirror.StringStream(line);
michael@0:       if (line == "" && mode.blankLine) mode.blankLine(state);
michael@0:       /* Start copied code from CodeMirror.highlight */
michael@0:       while (!stream.eol()) {
michael@0:         var compare = mode.token(stream, state), substr = stream.current();
michael@0:         if (compare && compare.indexOf(" ") > -1) compare = compare.split(' ').sort().join(' ');
michael@0:         stream.start = stream.pos;
michael@0:         if (pos && st[pos-2] == compare && !newLine) {
michael@0:           st[pos-1] += substr;
michael@0:         } else if (substr) {
michael@0:           st[pos++] = compare; st[pos++] = substr;
michael@0:         }
michael@0:         // Give up when line is ridiculously long
michael@0:         if (stream.pos > 5000) {
michael@0:           st[pos++] = null; st[pos++] = this.text.slice(stream.pos);
michael@0:           break;
michael@0:         }
michael@0:         newLine = false;
michael@0:       }
michael@0:     }
michael@0: 
michael@0:     return st;
michael@0:   }
michael@0: 
michael@0:   function highlightOutputsDifferent(o1, o2) {
michael@0:     var minLen = Math.min(o1.length, o2.length);
michael@0:     for (var i = 0; i < minLen; ++i)
michael@0:       if (o1[i] != o2[i]) return i >> 1;
michael@0:     if (o1.length > minLen || o2.length > minLen) return minLen;
michael@0:   }
michael@0: 
michael@0:   function prettyPrintOutputTable(output, diffAt) {
michael@0:     var s = '<table class="mt-output">';
michael@0:     s += '<tr>';
michael@0:     for (var i = 0; i < output.length; i += 2) {
michael@0:       var style = output[i], val = output[i+1];
michael@0:       s +=
michael@0:       '<td class="mt-token"' + (i == diffAt * 2 ? " style='background: pink'" : "") + '>' +
michael@0:         '<span class="cm-' + esc(String(style)) + '">' +
michael@0:         esc(val.replace(/ /g,'\xb7')) +
michael@0:         '</span>' +
michael@0:         '</td>';
michael@0:     }
michael@0:     s += '</tr><tr>';
michael@0:     for (var i = 0; i < output.length; i += 2) {
michael@0:       s += '<td class="mt-style"><span>' + (output[i] || null) + '</span></td>';
michael@0:     }
michael@0:     s += '</table>';
michael@0:     return s;
michael@0:   }
michael@0: })();