src/extensions/default/CodeFolding/foldhelpers/handlebarsFold.js - master - githubmirror/brackets

src/extensions/default/CodeFolding/foldhelpers/handlebarsFold.js
205 строк8 KB
Patrick Oladimeji
Adds code folding support for handlebars template files (#12675)
05 окт 2016, 19:39
05 окт 2016, 19:39281a4df
/*
 * Copyright (c) 2016 - present Adobe Systems Incorporated. All rights reserved.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a
 * copy of this software and associated documentation files (the "Software"),
 * to deal in the Software without restriction, including without limitation
 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
 * and/or sell copies of the Software, and to permit persons to whom the
 * Software is furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
 * DEALINGS IN THE SOFTWARE.
 *
 */

/**
 * Fold range finder for handlebars/mustache template type files.
 * @author Patrick Oladimeji
 * @date 14/08/2016 22:04:21
 */

define(function (require, exports, module) {
    "use strict";
    var CodeMirror  = brackets.getModule("thirdparty/CodeMirror/lib/codemirror"),
        _           = brackets.getModule("thirdparty/lodash"),
        StringUtils = brackets.getModule("utils/StringUtils");

    /**
     * Utility function for scanning the text in a document until a certain condition is met
     * @param {object}  cm  The code mirror object representing the document
     * @param {string}  startCh  The start character position for the scan operation
     * @param {number}  startLine The start line position for the scan operation
     * @param {function (string): boolean} condition A predicate function that takes in the text seen so far and returns true if the scanning process should be halted
     * @returns {{from:CodeMirror.Pos, to: CodeMirror.Pos, string: string}} An object representing the range of text scanned.
     */
    function scanTextUntil(cm, startCh, startLine, condition) {
        var line = cm.getLine(startLine),
            seen = "",
            characterIndex = startCh,
            currentLine = startLine,
            range;
        while (currentLine <= cm.lastLine()) {
            if (line.length === 0) {
                characterIndex = 0;
                line = cm.getLine(++currentLine);
            } else {
                seen = seen.concat(line[characterIndex] || "");
                if (condition(seen)) {
                    range = {
                        from: {ch: startCh, line: startLine},
                        to: {ch: characterIndex, line: currentLine},
                        string: seen
                    };
                    return range;
                } else if (characterIndex >= line.length) {
                    seen = seen.concat(cm.lineSeparator());
                    if (condition(seen)) {
                        range = {
                            from: {ch: startCh, line: startLine},
                            to: {ch: characterIndex, line: currentLine},
                            string: seen
                        };
                        return range;
                    }
                    characterIndex = 0;
                    line = cm.getLine(++currentLine);
                } else {
                    ++characterIndex;
                }
            }
        }
    }

    /**
     * Utility function used to detect the end of a helper name when scanning a series of text.
     * The end of a helper name is signalled by a space character or the `}`
     * @param   {string}  seen The string seen so far
     * @returns {boolean} True when the end of a helper name has been detected.
     */
    function endHelperName(seen) {
        return (/\s$/).test(seen) || StringUtils.endsWith(seen, "}");
    }

    /**
     * Returns a predicate function that returns true when a specific character is found
     * @param   {string}   character the character to use in the match function
     * @returns {function} A function that checks if the last character of the parameter string matches the parameter character
     */
    function readUntil(character) {
        return function (seen) {
            return seen[seen.length - 1] === character;
        };
    }

    function getRange(cm, start) {
        var currentLine = start.line,
            text = cm.getLine(currentLine) || "",
            i = 0,
            tagStack = [],
            braceStack = [],
            found,
            openTag,
            openPos,
            currentCharacter,
            openTagIndex = text.indexOf("{{"),
            range;

        if (openTagIndex < 0 || text[openTagIndex + 2] === "/") {
            return;
        }

        found = scanTextUntil(cm, openTagIndex + 2, currentLine, endHelperName);
        if (!found) {
            return;
        }

        openPos = {
            from: {line: currentLine, ch: openTagIndex},
            to: found.to
        };
        openTag = found.string.substring(0, found.string.length - 1);
        if (openTag[0] === "#" || openTag[0] === "~" || openTag[0] === "^") {
            found = scanTextUntil(cm, openPos.to.ch, openPos.to.line, function (seen) {
                return seen.length > 1 && seen.substr(-2) === "}}";
            });
            if (found) {
                openPos.to = {line: found.to.line, ch: found.to.ch + 1};
            }
            tagStack.push(openTag.substr(1));
        } else {
            braceStack.push("{{");
        }

        i = found.to.ch;
        currentLine = found.to.line;

        while (currentLine <= cm.lastLine()) {
            text = cm.getLine(currentLine);
            currentCharacter = (text && text[i]) || "";
            switch (currentCharacter) {
            case "{":
                if (text[i + 1] === "{") {
                    found = scanTextUntil(cm, i + 2, currentLine, endHelperName);
                    if (found) {
                        var tag = found.string.substring(0, found.string.length - 1);
                        if (tag[0] === "#" || tag[0] === "~" || tag[0] === "^") {
                            tagStack.push(tag.substr(1));
                        } else if (tag[0] === "/" &&
                                   (_.last(tagStack) === tag.substr(1) || _.last(tagStack) === "*" + tag.substr(1))) {
                            tagStack.pop();
                            if (tagStack.length === 0 && braceStack.length === 0) {
                                range = {
                                    from: openPos.to,
                                    to: {ch: i, line: currentLine}
                                };
                                return range;
                            }
                        } else {
                            braceStack.push("{{");
                        }
                    }
                }
                break;
            case "}":
                if (text[i + 1] === "}") {
                    braceStack.pop();
                    if (braceStack.length === 0 && tagStack.length === 0) {
                        range = {
                            from: openPos.to,
                            to: {ch: i, line: currentLine}
                        };
                        return range;
                    }
                }
                break;
            case "\"":
            case "'":
                found = scanTextUntil(cm, i + 1, currentLine, readUntil(text[i]));
                if (found) {
                    i = found.to.ch;
                    currentLine = found.to.line;
                }
                break;
            default:
                break;
            }

            ++i;
            if (i >= text.length) {
                ++currentLine;
                i = 0;
            }
        }
    }

    module.exports = getRange;
});