TernProvider.js

/**
 * Ternific Copyright (c) 2014 Miguel Castillo.
 *
 * Licensed under MIT
 */


define(function (require, exports, module) {
    "use strict";

    var CodeMirror   = brackets.getModule("thirdparty/CodeMirror2/lib/codemirror");
    var spromise     = require("libs/js/spromise");
    var localServer  = require("LocalServer"),
        remoteServer = require("RemoteServer"),
        fileLoader   = require("FileLoader");

    /**
     * @constructor
     *
     * TernProvider is a set of interfaces that facilitate the interaction
     * with tern.
     */
    function TernProvider() {
        var _self = this;
        _self.docs = [];
        _self.currentDocument = null;
    }


    TernProvider.prototype.clear = function() {
        var _self = this;
        _self.docs = [];

        if (_self.tern) {
            _self.tern.clear();
        }
    };


    TernProvider.prototype.query = function (cm, settings, allowFragments) {
        return this.tern.query(cm, settings, allowFragments);
    };


    TernProvider.prototype.findDocByProperty = function (propName, data) {
        var index = 0, length = this.docs.length;
        for (index = 0; index < length; index++) {
            if (this.docs[index][propName] === data) {
                return this.docs[index];
            }
        }
    };


    TernProvider.prototype.findDocByName = function (name) {
        return this.findDocByProperty("name", name);
    };


    TernProvider.prototype.findDocByInstance = function (doc) {
        return this.findDocByProperty("doc", doc);
    };


    TernProvider.prototype.registerDocument = function (cm, file) {
        var _self   = this,
            name    = file.name,
            dir     = file.parentPath,
            docMeta = _self.findDocByName(name);

        //
        // If the document has not been registered, then we set one up
        //
        if (!docMeta) {
            docMeta = {
                file: file,
                name: name,
                doc: cm.getDoc(),
                changed: null
            };

            _self.docs.push(docMeta);
            _self.tern.addFile(docMeta.name, docMeta.doc.getValue());
        }
        //
        // If the document exists but has not been registered, then we
        // update the properties that need updating and setup up a change
        // tracking callback.
        // This particular case happens when a document is loaded as a
        // dependency when resolved by tern, and later that document is
        // opened in brackets, which will need registration for tracking
        // changes.
        //
        // Only documents that are open in brackets and currently in focus
        // are the ones that should be tracked for changes.  Currently,
        // if a document isn't open in brackets then we are going to assume
        // that it is not being changed. I'm not worried about external
        // editors opening documents and modifying them outside of the
        // current instance of brackets.
        //
        else {
            docMeta.doc     = cm.getDoc();
            docMeta.changed = null;
        }

        _self.cm = cm;
        _self.currentDocument = docMeta;
        _self.tern.setCurrentDocument(docMeta);
        _self.tern.setDocs(_self.docs);
        _self.tern.loadSettings(dir);

        docMeta._trackChange = function (cm1, change) {
            _self.tern.trackChange(docMeta.doc, change);
        };

        CodeMirror.on(docMeta.doc, "change", docMeta._trackChange);
        return docMeta;
    };


    TernProvider.prototype.unregisterDocument = function (cm) {
        var docMeta = this.findDocByInstance(cm.getDoc());
        if (docMeta && docMeta.doc && docMeta._trackChange) {
            CodeMirror.off(docMeta.doc, "change", docMeta._trackChange);
        }
    };


    /**
     * Will read file from disk or remote http file, then will load the content
     * into tern's server.
     *
     * This will bypass the list of cached documents.
     */
    TernProvider.prototype.addFile = function (name) {
        var _self = this;

        return fileLoader.readFile(name, _self.currentDocument.file.parentPath).done(function(data) {
            var docMeta = {
                file: data.file,
                name: name, //data.fullPath,
                doc: new CodeMirror.Doc(data.content, "javascript"),
                changed: null
            };

            _self.docs.push(docMeta);
            _self.tern.addFile(docMeta.name, docMeta.doc.getValue());
        });
    };


    /**
     *  Interface to operate against a local instance of tern
     */
    function LocalProvider() {
        TernProvider.apply(this, arguments);
        var _self = this;
        _self.onReady = localServer(this).then(function(tern) {
            _self.tern = tern;
            return _self;
        }).done;
    }


    LocalProvider.prototype = new TernProvider();
    LocalProvider.prototype.constructor = LocalProvider;


    /**
     * Gets a file from the list of cached documents. If the document isn't cached,
     * it will get loaded either from local drive or remote via http.  This newly
     * retrieved document will be added to the list of cached documents.
     */
    LocalProvider.prototype.getFile = function (name) {
        var _self = this;
        var docMeta = _self.findDocByName(name);

        if (docMeta) {
            return spromise.resolved({
                docMeta: docMeta,
                content: docMeta.doc.getValue()
            });
        }

        return fileLoader.readFile(name, _self.currentDocument.file.parentPath)
                .then(function(data) {
                    var docMeta = {
                        file: data.file,
                        name: name, //data.fullPath,
                        doc: new CodeMirror.Doc(data.content, "javascript"),
                        changed: null
                    };

                    _self.docs.push(docMeta);
                    return {
                        docMeta: docMeta,
                        content: data.content
                    };
                });
    };


    /**
     *  Interface to operate against a remote tern server
     */
    function RemoteProvider() {
        TernProvider.apply(this, arguments);
        var _self = this;
        _self.onReady = remoteServer(this).then(function(tern) {
            _self.tern = tern;
            return _self;
        }).done;
    }


    RemoteProvider.prototype = new TernProvider();
    RemoteProvider.prototype.constructor = RemoteProvider;


    return {
        Remote: RemoteProvider,
        Local: LocalProvider
    };

});