etherpad-lite/static/js/ace.js

/**
 * Copyright 2009 Google Inc.
 * 
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 *      http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS-IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

// requires: top
// requires: plugins
// requires: undefined


Ace2Editor.registry = { nextId: 1 };

function Ace2Editor() {
  var thisFunctionsName = "Ace2Editor";
  var ace2 = Ace2Editor;

  var editor = {};
  var info = { editor: editor, id: (ace2.registry.nextId++) };
  var loaded = false;

  var actionsPendingInit = [];
  function pendingInit(func, optDoNow) {
    return function() {
      var that = this;
      var args = arguments;
      function action() {
	func.apply(that, args);
      }
      if (optDoNow) {
	optDoNow.apply(that, args);
      }
      if (loaded) {
	action();
      }
      else {
	actionsPendingInit.push(action);
      }
    };
  }
  function doActionsPendingInit() {
    for(var i=0;i<actionsPendingInit.length;i++) {
      actionsPendingInit[i]();
    }
    actionsPendingInit = [];
  }

  ace2.registry[info.id] = info;

  editor.importText = pendingInit(function(newCode, undoable) {
    info.ace_importText(newCode, undoable); });
  editor.importAText = pendingInit(function(newCode, apoolJsonObj, undoable) {
    info.ace_importAText(newCode, apoolJsonObj, undoable); });
  editor.exportText = function() {
    if (! loaded) return "(awaiting init)\n";
    return info.ace_exportText();
  };
  editor.getFrame = function() { return info.frame || null; };
  editor.focus = pendingInit(function() { info.ace_focus(); });
  editor.setEditable = pendingInit(function(newVal) { info.ace_setEditable(newVal); });
  editor.getFormattedCode = function() { return info.ace_getFormattedCode(); };
  editor.setOnKeyPress = pendingInit(function (handler) { info.ace_setOnKeyPress(handler); });
  editor.setOnKeyDown = pendingInit(function (handler) { info.ace_setOnKeyDown(handler); });
  editor.setNotifyDirty = pendingInit(function (handler) { info.ace_setNotifyDirty(handler); });

  editor.setProperty = pendingInit(function(key, value) { info.ace_setProperty(key, value); });
  editor.getDebugProperty = function(prop) { return info.ace_getDebugProperty(prop); };

  editor.setBaseText = pendingInit(function(txt) { info.ace_setBaseText(txt); });
  editor.setBaseAttributedText = pendingInit(function(atxt, apoolJsonObj) {
    info.ace_setBaseAttributedText(atxt, apoolJsonObj); });
  editor.applyChangesToBase = pendingInit(function (changes, optAuthor,apoolJsonObj) {
    info.ace_applyChangesToBase(changes, optAuthor, apoolJsonObj); });
  // prepareUserChangeset:
  // Returns null if no new changes or ACE not ready.  Otherwise, bundles up all user changes
  // to the latest base text into a Changeset, which is returned (as a string if encodeAsString).
  // If this method returns a truthy value, then applyPreparedChangesetToBase can be called
  // at some later point to consider these changes part of the base, after which prepareUserChangeset
  // must be called again before applyPreparedChangesetToBase.  Multiple consecutive calls
  // to prepareUserChangeset will return an updated changeset that takes into account the
  // latest user changes, and modify the changeset to be applied by applyPreparedChangesetToBase
  // accordingly.
  editor.prepareUserChangeset = function() {
    if (! loaded) return null;
    return info.ace_prepareUserChangeset();
  };
  editor.applyPreparedChangesetToBase = pendingInit(
    function() { info.ace_applyPreparedChangesetToBase(); });
  editor.setUserChangeNotificationCallback = pendingInit(function(callback) {
    info.ace_setUserChangeNotificationCallback(callback);
  });
  editor.setAuthorInfo = pendingInit(function(author, authorInfo) {
    info.ace_setAuthorInfo(author, authorInfo);
  });
  editor.setAuthorSelectionRange = pendingInit(function(author, start, end) {
    info.ace_setAuthorSelectionRange(author, start, end);
  });

  editor.getUnhandledErrors = function() {
    if (! loaded) return [];
    // returns array of {error: <browser Error object>, time: +new Date()}
    return info.ace_getUnhandledErrors();
  };

  editor.callWithAce = pendingInit(function(fn, callStack, normalize) {
    return info.ace_callWithAce(fn, callStack, normalize);
  });

  editor.execCommand = pendingInit(function(cmd, arg1) {
    info.ace_execCommand(cmd, arg1);
  });
  editor.replaceRange = pendingInit(function(start, end, text) {
    info.ace_replaceRange(start, end, text);
  });


  // calls to these functions ($$INCLUDE_...)  are replaced when this file is processed
  // and compressed, putting the compressed code from the named file directly into the
  // source here.

  var $$INCLUDE_CSS = function(fileName) {
    return '<link rel="stylesheet" type="text/css" href="'+fileName+'"/>';
  };
  var $$INCLUDE_JS = function(fileName) {
    return '\x3cscript type="text/javascript" src="'+fileName+'">\x3c/script>';
  };
  var $$INCLUDE_JS_DEV = $$INCLUDE_JS;
  var $$INCLUDE_CSS_DEV = $$INCLUDE_CSS;

  var $$INCLUDE_CSS_Q = function(fileName) {
    return '\'<link rel="stylesheet" type="text/css" href="'+fileName+'"/>\'';
  };
  var $$INCLUDE_JS_Q = function(fileName) {
    return '\'\\x3cscript type="text/javascript" src="'+fileName+'">\\x3c/script>\'';
  };
  var $$INCLUDE_JS_Q_DEV = $$INCLUDE_JS_Q;
  var $$INCLUDE_CSS_Q_DEV = $$INCLUDE_CSS_Q;

  editor.destroy = pendingInit(function() {
    info.ace_dispose();
    info.frame.parentNode.removeChild(info.frame);
    delete ace2.registry[info.id];
    info = null; // prevent IE 6 closure memory leaks
  });

  editor.init = function(containerId, initialCode, doneFunc) {

    editor.importText(initialCode);

    info.onEditorReady = function() {
      loaded = true;
      doActionsPendingInit();
      doneFunc();
    };

    (function() {
      var doctype = '<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" '+
	'"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">';

      var iframeHTML = ["'"+doctype+"<html><head>'"];

      plugins.callHook(
        "aceInitInnerdocbodyHead", {iframeHTML:iframeHTML});
  
      // these lines must conform to a specific format because they are passed by the build script:
      //iframeHTML.push($$INCLUDE_CSS_Q("editor.css syntax.css inner.css"));
      
      iframeHTML.push($$INCLUDE_CSS_Q("/static/css/editor.css"));
      iframeHTML.push($$INCLUDE_CSS_Q("/static/css/syntax.cs"));
      iframeHTML.push($$INCLUDE_CSS_Q("/static/css/inner.css"));
      
      //iframeHTML.push(INCLUDE_JS_Q_DEV("ace2_common_dev.js"));
      //iframeHTML.push(INCLUDE_JS_Q_DEV("profiler.js"));
      
      //iframeHTML.push($$INCLUDE_JS_Q("ace2_common.js skiplist.js virtual_lines.js easysync2.js cssmanager.js colorutils.js undomodule.js contentcollector.js changesettracker.js linestylefilter.js domline.js"));
      //iframeHTML.push($$INCLUDE_JS_Q("ace2_inner.js"));
      
      iframeHTML.push($$INCLUDE_JS_Q("/static/js/ace2_common.js"));
      iframeHTML.push($$INCLUDE_JS_Q("/static/js/skiplist.js"));
      iframeHTML.push($$INCLUDE_JS_Q("/static/js/virtual_lines.js"));
      iframeHTML.push($$INCLUDE_JS_Q("/static/js/easysync2.js"));
      iframeHTML.push($$INCLUDE_JS_Q("/static/js/cssmanager.js"));
      iframeHTML.push($$INCLUDE_JS_Q("/static/js/colorutils.js"));
      iframeHTML.push($$INCLUDE_JS_Q("/static/js/undomodule.js"));
      iframeHTML.push($$INCLUDE_JS_Q("/static/js/contentcollector.js"));
      iframeHTML.push($$INCLUDE_JS_Q("/static/js/changesettracker.js"));
      iframeHTML.push($$INCLUDE_JS_Q("/static/js/linestylefilter.js"));
      iframeHTML.push($$INCLUDE_JS_Q("/static/js/domline.js"));
      iframeHTML.push($$INCLUDE_JS_Q("/static/js/ace2_inner.js"));
      
      iframeHTML.push('\'\\n<style type="text/css" title="dynamicsyntax"></style>\\n\'');
      iframeHTML.push('\'</head><body id="innerdocbody" class="syntax" spellcheck="false">&nbsp;</body></html>\'');

      var outerScript = 'editorId = "'+info.id+'"; editorInfo = parent.'+
	thisFunctionsName+'.registry[editorId]; '+
	'window.onload = function() '+
	'{ window.onload = null; setTimeout'+
	'(function() '+
	'{ var iframe = document.createElement("IFRAME"); '+
	'iframe.scrolling = "no"; var outerdocbody = document.getElementById("outerdocbody"); '+
	'iframe.frameBorder = 0; iframe.allowTransparency = true; '+ // for IE
	'outerdocbody.insertBefore(iframe, outerdocbody.firstChild); '+
	'iframe.ace_outerWin = window; '+
	'readyFunc = function() { editorInfo.onEditorReady(); readyFunc = null; editorInfo = null; }; '+
	'var doc = iframe.contentWindow.document; doc.open(); doc.write('+
	iframeHTML.join('+')+'); doc.close(); '+
	'}, 0); }';

      var outerHTML = [doctype, '<html><head>',
	$$INCLUDE_CSS("/static/css/editor.css"),
	// bizarrely, in FF2, a file with no "external" dependencies won't finish loading properly
	// (throbs busy while typing)
	'<link rel="stylesheet" type="text/css" href="data:text/css,"/>',
	'\x3cscript>', outerScript, '\x3c/script>',
	'</head><body id="outerdocbody"><div id="sidediv"><!-- --></div><div id="linemetricsdiv">x</div><div id="overlaysdiv"><!-- --></div></body></html>'];


      if (!Array.prototype.map) Array.prototype.map = function(fun) { //needed for IE
        if (typeof fun != "function") throw new TypeError();
        var len = this.length;
        var res = new Array(len);
        var thisp = arguments[1];
        for (var i = 0; i < len; i++) {
          if (i in this) res[i] = fun.call(thisp, this[i], i, this);
        }
        return res;
      };

      var outerFrame = document.createElement("IFRAME");
      outerFrame.frameBorder = 0; // for IE
      info.frame = outerFrame;
      document.getElementById(containerId).appendChild(outerFrame);

      var editorDocument = outerFrame.contentWindow.document;

      editorDocument.open();
      editorDocument.write(outerHTML.join(''));
      editorDocument.close();
    })();
  };

  return editor;
}