src/view/MainViewFactory.js - master - githubmirror/brackets

src/view/MainViewFactory.js
108 строк4 KB
ficristo
Move most inline jslint directives to config files
12 авг 2016, 10:22
12 авг 2016, 10:22074382a
/*
 * Copyright (c) 2014 - 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.
 *
 */

/**
 * MainViewFactory is a singleton for managing view factories.
 *
 * Registering a view factory:
 *
 *      registerViewFactory({
 *           canOpenFile: function (fullPath) {
 *               return (fullPath.slice(-4) === ".ico");
 *           },
 *           openFile: function(file, pane) {
 *               return createIconView(file, pane);
 *           }
 *      });
 *
 *  The openFile method is used to open the file and construct
 *  a view of it.  Implementation should add the view to the pane
 *
 *      function createIconView(file, pane) {
 *          // IconView will construct its DOM and append
 *          //  it to pane.$el
 *          var view = new IconView(file, pane.$el);
 *          // Then tell the pane to add it to
 *          //  its view map and show it
 *          pane.addView(view, true);
 *          return new $.Deferred().resolve().promise();
 *      }
 *
 *  Factories should only create 1 view of a file per pane.  Brackets currently only supports 1 view of
 *  a file open at a given time but that may change to allow the same file open in more than 1 pane. Therefore
 *  Factories can do a simple check to see if a view already exists and show it before creating a new one:
 *
 *      var view = pane.getViewForPath(file.fullPath);
 *      if (view) {
 *          pane.showView(view);
 *      } else {
 *          return createIconView(file, pane);
 *      }
 *
 */
define(function (require, exports, module) {
    "use strict";

    var _ = require("thirdparty/lodash");


    /**
     * @typedef {canOpenFile:function(path:string):boolean, openFile:function(path:string, pane:Pane)} Factory
     */

    /**
     * The view registration Database
     * @private
     * @type {Array.<Factory>}
     */
    var _factories = [];

    /**
     * Registers a view factory
     * @param {!Factory} factory - the view factory to register
     */
    function registerViewFactory(factory) {
        _factories.push(factory);
    }

    /**
     * Finds a factory that can open the specified file
     * @param {!string} fullPath - the file to open
     * @return {?Factory} A factory that can create a view for the path or undefined if there isn't one.
     */
    function findSuitableFactoryForPath(fullPath) {
        return _.find(_factories, function (factory) {
            // This could get more complex in the future by searching in this order
            //  1) a factory that can open the file by fullPath
            //  2) a factory that can open the file by name
            //  3) a factory that can open the file by filetype
            return factory.canOpenFile(fullPath);
        });
    }

    /*
     * Public API
     */
    exports.registerViewFactory         = registerViewFactory;
    exports.findSuitableFactoryForPath  = findSuitableFactoryForPath;
});