ActiveState Community

/**
 * @fileoverview  Enter trigger for PHPdoc (code based on TAB trigger for Abbreviations by Stan Angeloff)
 * @author        Nathan Rijksen (http://naatan.com/)
 * @contributor   Todd Whiteman
 * @version       0.2
 */

if (typeof(extensions) === 'undefined')
/**
 * Komodo Extensions Namespace.
 * This namespace was suggested by JeffG. More information is available at:
 *    {@link http://community.activestate.com/forum-topic/extension-s-namespace}
 *
 * @type  Object
 */
extensions = {};

if (extensions.AutoTriggerDoc && extensions.AutoTriggerDoc.onKeyPress) {
    // Remove the existing trigger handler, we'll re-instate it.
    var editor_pane = ko.views.manager.topView;
    editor_pane.removeEventListener('keypress', extensions.AutoTriggerDoc.onKeyPress, true);
}
extensions.AutoTriggerDoc = {};

(function() {

    var log = ko.logging.getLogger("AutoTriggerDoc");
    //log.setLevel(ko.logging.LOG_DEBUG);

    this.onKeyPress = function(e) {
        try {
            // Only trap when ENTER pressed with no modifiers
            if (e.keyCode !== 13 || e.ctrlKey || e.altKey || e.shiftKey) return true;

            log.debug("onKeyPress:: enter key pressed:: keyCode: " + e.keyCode);

            var preventDefault = endUndoAction = false;
            try {

                ko.views.manager.currentView.setFocus();
                // Create shorthands for 'currentView'
                var view = ko.views.manager.currentView;
                /**
                 * @type {Components.interfaces.ISciMoz}
                 */
                var editor = view.scimoz;

                // Ensure we don't have have remaining indicators within the document
                // ToddW: Not sure why this was here? Removing it for now.
                //if (view.document.hasTabstopInsertionTable &&
                //    view.document.getTabstopInsertionTable({}).length > 0) {
                //    log.debug("hasTabstopInsertionTable:: length: " + view.document.getTabstopInsertionTable({}).length);
                //    return true;
                //}

                // Don't do anything if there is a selection within the document
                if (editor.anchor != editor.currentPos) {
                    return false;
                }

                var lang = view.document.language;
                // Start at cursor position and break at any non-word character
                var currentPos = editor.currentPos;
                var rangeStart = currentPos - 3;
                var strLeft = editor.getTextRange(rangeStart, currentPos);
                log.debug("strLeft: " + strLeft);

                // If we have a matching range, make sure it's a word
                if (strLeft !== null && strLeft == '/**') {

                    preventDefault = endUndoAction = true;

                    var lineno = editor.lineFromPosition(currentPos);
                    var nxt_start = editor.positionFromLine(lineno+1);
                    var nxt_end = editor.getLineEndPosition(lineno+1);
                    var nxtLine = editor.getTextRange(nxt_start, nxt_end);
                    var snipType;
                    var snipText = '\n * [[%tabstop:Summary]]\n';
                    var type_tabstop = '[[%tabstop:Type]]';
                    var desc_tabstop = '[[%tabstop:Description]]';

                    var match = nxtLine.match(/\bfunction(\s*[-_a-z0-9]+\s*)?\((.*)\)/i);
                    if (match) {
                        var fvars = match[2].split(',');
                        for (var i = 0; i <= fvars.length - 1; i++) {
                            fvar = fvars[i].replace(/\s*?(\$[-_a-z0-9]*).*/i, "$1");
                            if (lang == "PHP") {
                                snipText += ' * @param ' + type_tabstop + ' ' +
                                            fvar + ' - ' + desc_tabstop + '\n';
                            } else if (lang == "JavaScript") {
                                snipText += ' * @param ' + fvar + ' ' +
                                            type_tabstop + ' - ' + desc_tabstop + '\n';
                            }
                        }
                        snipType = 'function';
                    } else if (nxtLine.match(/^\s*?class/i)) {
                        snipType = 'class';
                    } else if (nxtLine.match(/^\s*?var/i)) {
                        if (lang == "PHP") {
                            snipText += ' * @var ' + type_tabstop + ' - ' + desc_tabstop + '\n';
                        } else if (lang == "JavaScript") {
                            snipText += ' * @type ' + type_tabstop + ' - ' + desc_tabstop + '\n';
                        }
                        snipType = 'var';
                    }
                    if (snipType) {
                        var snippet = ko.abbrev.findAbbrevSnippet('phpdoc_' + snipType);
                        if (snippet) {
                            snipText += snippet.value;
                        }
                    }
                    snipText += " */"
                    var fakeSnippet = {
                        hasAttribute: function(name) {
                            return name in this;
                        },
                        getStringAttribute: function(name) {
                            return this[name];
                        },
                        name: "autodoc snippet",
                        indent_relative: "true",
                        value: snipText
                    };
                    log.debug("snipText: " + snipText);
                    ko.projects.snippetInsert(fakeSnippet);
                }
            } finally {
                if (preventDefault) {
                    e.preventDefault();
                    e.stopPropagation();
                }
            }
        } catch(ex) {
            log.exception(ex);
        }
    }
    var editor_pane = ko.views.manager.topView;
    editor_pane.addEventListener('keypress', this.onKeyPress, true);

}).apply(extensions.AutoTriggerDoc);