moving wlxml object api transformations directly into .object properties name space
[fnpeditor.git] / src / smartxml / smartxml.js
index 5ad3010..831a96a 100644 (file)
@@ -2,15 +2,31 @@ define([
     'libs/jquery',
     'libs/underscore',
     'libs/backbone',
-    'smartxml/events'
-], function($, _, Backbone, events) {
+    'smartxml/events',
+    'smartxml/transformations'
+], function($, _, Backbone, events, transformations) {
     
 'use strict';
-
+/* globals Node */
 
 var TEXT_NODE = Node.TEXT_NODE;
 
 
+var INSERTION = function(implementation) {
+    var toret = function(node) {
+        var insertion = this.getNodeInsertion(node),
+            nodeWasContained = this.document.containsNode(insertion.ofNode),
+            nodeParent;
+        if(!(this.document.containsNode(this))) {
+            nodeParent = insertion.ofNode.parent();
+        }
+        implementation.call(this, insertion.ofNode.nativeNode);
+        this.triggerChangeEvent(insertion.insertsNew ? 'nodeAdded' : 'nodeMoved', {node: insertion.ofNode}, nodeParent, nodeWasContained);
+        return insertion.ofNode;
+    };
+    return toret;
+};
+
 var DocumentNode = function(nativeNode, document) {
     if(!document) {
         throw new Error('undefined document for a node');
@@ -21,11 +37,53 @@ var DocumentNode = function(nativeNode, document) {
 };
 
 $.extend(DocumentNode.prototype, {
+
+    transform: function(Transformation, args) {
+        var transformation = new Transformation(this.document, this, args);
+        return this.document.transform(transformation);
+    },
+
     _setNativeNode: function(nativeNode) {
         this.nativeNode = nativeNode;
         this._$ = $(nativeNode);
     },
 
+    clone: function() {
+        var clone = this._$.clone(true, true);
+        // clone.find('*').addBack().each(function() {
+        //     var n = $(this);
+        //     if(n.data('canvasElement')) {
+        //         n.data('canvasElement', $.extend(true, {}, n.data('canvasElement')));
+        //         n.data('canvasElement').$element = n.data('canvasElement').$element.clone(true, true);
+        //     }
+        // });
+        return this.document.createDocumentNode(clone[0]);
+    },
+
+    getPath: function(ancestor) {
+        var nodePath = [this].concat(this.parents()),
+            toret, idx;
+        ancestor = ancestor || this.document.root;
+
+        nodePath.some(function(node, i) {
+            if(node.sameNode(ancestor)) {
+                idx = i;
+                return true;
+            }
+        });
+
+        if(idx !== 'undefined') {
+            nodePath = nodePath.slice(0, idx);
+        }
+        toret = nodePath.map(function(node) {return node.getIndex(); });
+        toret.reverse();
+        return toret;
+    },
+
+    isRoot: function() {
+        return this.document.root.sameNode(this);
+    },
+
     detach: function() {
         var parent = this.parent();
         this._$.detach();
@@ -33,60 +91,110 @@ $.extend(DocumentNode.prototype, {
         return this;
     },
 
+    replaceWith: function(node) {
+        var toret;
+        if(this.isRoot()) {
+            return this.document.replaceRoot(node);
+        }
+        toret = this.after(node);
+        this.detach();
+        return toret;
+    },
+
     sameNode: function(otherNode) {
-        return otherNode && this.nativeNode === otherNode.nativeNode;
+        return !!(otherNode) && this.nativeNode === otherNode.nativeNode;
     },
 
     parent: function() {
         var parentNode = this.nativeNode.parentNode;
         if(parentNode && parentNode.nodeType === Node.ELEMENT_NODE) {
-            return this.document.createElementNode(parentNode);
+            return this.document.createDocumentNode(parentNode);
         }
         return null;
     },
 
-    after: function(node) {
-        var insertion = this.getNodeInsertion(node);
-        this._$.after(insertion.ofNode.nativeNode);
-        this.triggerChangeEvent(insertion.insertsNew ? 'nodeAdded' : 'nodeMoved', {node: insertion.ofNode});
-        return insertion.ofNode;
+    parents: function() {
+        var parent = this.parent(),
+            parents = parent ? parent.parents() : [];
+        if(parent) {
+            parents.unshift(parent);
+        }
+        return parents;
     },
 
-    before: function(node) {
-        var insertion = this.getNodeInsertion(node);
-        this._$.before(insertion.ofNode.nativeNode);
-        this.triggerChangeEvent(insertion.insertsNew ? 'nodeAdded' : 'nodeMoved', {node: insertion.ofNode});
-        return insertion.ofNode;
+    prev: function() {
+        var myIdx = this.getIndex();
+        return myIdx > 0 ? this.parent().contents()[myIdx-1] : null;
     },
 
-    wrapWith: function(node) {
-        node = node instanceof ElementNode ? node : this.document.createElementNode(node);
+    next: function() {
+        if(this.isRoot()) {
+            return null;
+        }
+        var myIdx = this.getIndex(),
+            parentContents = this.parent().contents();
+        return myIdx < parentContents.length - 1 ? parentContents[myIdx+1] : null;
+    },
+
+    isSurroundedByTextElements: function() {
+        var prev = this.prev(),
+            next = this.next();
+        return prev && (prev.nodeType === Node.TEXT_NODE) && next && (next.nodeType === Node.TEXT_NODE);
+    },
 
+    after: INSERTION(function(nativeNode) {
+        return this._$.after(nativeNode);
+    }),
+
+    before: INSERTION(function(nativeNode) {
+        return this._$.before(nativeNode);
+    }),
+
+    wrapWith: function(node) {
+        var insertion = this.getNodeInsertion(node);
         if(this.parent()) {
-            this.before(node);
+            this.before(insertion.ofNode);
         }
-        node.append(this);
-        return node;
+        insertion.ofNode.append(this);
+        return insertion.ofNode;
     },
 
-    triggerChangeEvent: function(type, metaData) {
-        var event = new events.ChangeEvent(type, $.extend({node: this}, metaData || {}));
-        this.document.trigger('change', event);
+    /**
+    * Removes parent of a node if node has no siblings.
+    */
+    unwrap: function() {
+        if(this.isRoot()) {
+            return;
+        }
+        var parent = this.parent(),
+            grandParent;
+        if(parent.contents().length === 1) {
+            grandParent = parent.parent();
+            parent.unwrapContent();
+            return grandParent;
+        }
+    },
+
+    triggerChangeEvent: function(type, metaData, origParent, nodeWasContained) {
+        var node = (metaData && metaData.node) ? metaData.node : this,
+            event = new events.ChangeEvent(type, $.extend({node: node}, metaData || {}));
+        if(type === 'nodeDetached' || this.document.containsNode(event.meta.node)) {
+            this.document.trigger('change', event);
+        }
+        if((type === 'nodeAdded' || type === 'nodeMoved') && !this.document.containsNode(this) && nodeWasContained) {
+             event = new events.ChangeEvent('nodeDetached', {node: node, parent: origParent});
+             this.document.trigger('change', event);
+        }
     },
     
     getNodeInsertion: function(node) {
-        var insertion = {};
-        if(node instanceof DocumentNode) {
-            insertion.ofNode = node;
-            insertion.insertsNew = !this.document.containsNode(node);
-        } else {
-          insertion.ofNode = this.document.createElementNode(node);
-          insertion.insertsNew = true;
-        }
-        return insertion;
+        return this.document.getNodeInsertion(node);
     },
 
     getIndex: function() {
+        if(this.isRoot()) {
+            return 0;
+        }
         return this.parent().indexOf(this);
     }
 });
@@ -99,6 +207,16 @@ ElementNode.prototype = Object.create(DocumentNode.prototype);
 $.extend(ElementNode.prototype, {
     nodeType: Node.ELEMENT_NODE,
 
+    detach: function() {
+        var next;
+        if(this.parent() && this.isSurroundedByTextElements()) {
+            next = this.next();
+            this.prev().appendText(next.getText());
+            next.detach();
+        }
+        return DocumentNode.prototype.detach.call(this);
+    },
+
     setData: function(key, value) {
         if(value !== undefined) {
             this._$.data(key, value);
@@ -119,17 +237,18 @@ $.extend(ElementNode.prototype, {
         return this.nativeNode.tagName.toLowerCase();
     },
 
-    contents: function() {
+    contents: function(selector) {
         var toret = [],
             document = this.document;
-        this._$.contents().each(function() {
-            if(this.nodeType === Node.ELEMENT_NODE) {
-                toret.push(document.createElementNode(this));
-            }
-            else if(this.nodeType === Node.TEXT_NODE) {
-                toret.push(document.createTextNode(this));
-            }
-        });
+        if(selector) {
+            this._$.children(selector).each(function() {
+                toret.push(document.createDocumentNode(this));
+            });
+        } else {
+            this._$.contents().each(function() {
+                toret.push(document.createDocumentNode(this));
+            });
+        }
         return toret;
     },
 
@@ -138,7 +257,7 @@ $.extend(ElementNode.prototype, {
     },
 
     setTag: function(tagName) {
-        var node = this.document.createElementNode({tagName: tagName}),
+        var node = this.document.createDocumentNode({tagName: tagName}),
             oldTagName = this.getTagName(),
             myContents = this._$.contents();
 
@@ -176,18 +295,21 @@ $.extend(ElementNode.prototype, {
         return toret;
     },
 
-    append: function(node) {
-        var insertion = this.getNodeInsertion(node);
-        this._$.append(insertion.ofNode.nativeNode);
-        this.triggerChangeEvent(insertion.insertsNew ? 'nodeAdded' : 'nodeMoved', {node: insertion.ofNode});
-        return insertion.ofNode;
-    },
+    append: INSERTION(function(nativeNode) {
+        this._$.append(nativeNode);
+    }),
 
-    prepend: function(node) {
-        var insertion = this.getNodeInsertion(node);
-        this._$.prepend(insertion.ofNode.nativeNode);
-        this.triggerChangeEvent(insertion.insertsNew ? 'nodeAdded' : 'nodeMoved', {node: insertion.ofNode});
-        return insertion.ofNode;
+    prepend: INSERTION(function(nativeNode) {
+        this._$.prepend(nativeNode);
+    }),
+
+    insertAtIndex: function(nativeNode, index) {
+        var contents = this.contents();
+        if(index < contents.length) {
+            return contents[index].before(nativeNode);
+        } else if(index === contents.length) {
+            return this.append(nativeNode);
+        }
     },
 
     unwrapContent: function() {
@@ -196,18 +318,20 @@ $.extend(ElementNode.prototype, {
             return;
         }
 
-        var parentContents = parent.contents(),
-            myContents = this.contents(),
+        var myContents = this.contents(),
             myIdx = parent.indexOf(this);
 
+
         if(myContents.length === 0) {
             return this.detach();
         }
 
-        var moveLeftRange, moveRightRange, leftMerged;
+        var prev = this.prev(),
+            next = this.next(),
+            moveLeftRange, moveRightRange, leftMerged;
 
-        if(myIdx > 0 && (parentContents[myIdx-1].nodeType === TEXT_NODE) && (myContents[0].nodeType === TEXT_NODE)) {
-            parentContents[myIdx-1].appendText(myContents[0].getText());
+        if(prev && (prev.nodeType === TEXT_NODE) && (myContents[0].nodeType === TEXT_NODE)) {
+            prev.appendText(myContents[0].getText());
             myContents[0].detach();
             moveLeftRange = true;
             leftMerged = true;
@@ -216,9 +340,10 @@ $.extend(ElementNode.prototype, {
         }
 
         if(!(leftMerged && myContents.length === 1)) {
-            if(myIdx < parentContents.length - 1 && (parentContents[myIdx+1].nodeType === TEXT_NODE) && (myContents[myContents.length-1].nodeType === TEXT_NODE)) {
-                parentContents[myIdx+1].prependText(myContents[myContents.length-1].getText());
-                myContents[myContents.length-1].detach();
+            var lastContents = _.last(myContents);
+            if(next && (next.nodeType === TEXT_NODE) && (lastContents.nodeType === TEXT_NODE)) {
+                next.prependText(lastContents.getText());
+                lastContents.detach();
                 moveRightRange = true;
             }
         }
@@ -264,6 +389,7 @@ $.extend(TextNode.prototype, {
     },
 
     setText: function(text) {
+        //console.log('smartxml: ' + text);
         this.nativeNode.data = text;
         this.triggerTextChangeEvent();
     },
@@ -292,6 +418,44 @@ $.extend(TextNode.prototype, {
         }
     },
 
+    split: function(params) {
+        var parentElement = this.parent(),
+            passed = false,
+            succeedingChildren = [],
+            prefix = this.getText().substr(0, params.offset),
+            suffix = this.getText().substr(params.offset);
+
+        parentElement.contents().forEach(function(child) {
+            if(passed) {
+                succeedingChildren.push(child);
+            }
+            if(child.sameNode(this)) {
+                passed = true;
+            }
+        }.bind(this));
+
+        if(prefix.length > 0) {
+            this.setText(prefix);
+        }
+        else {
+            this.detach();
+        }
+
+        var attrs = {};
+        parentElement.getAttrs().forEach(function(attr) {attrs[attr.name] = attr.value; });
+        var newElement = this.document.createDocumentNode({tagName: parentElement.getTagName(), attrs: attrs});
+        parentElement.after(newElement);
+
+        if(suffix.length > 0) {
+            newElement.append({text: suffix});
+        }
+        succeedingChildren.forEach(function(child) {
+            newElement.append(child);
+        });
+
+        return {first: parentElement, second: newElement};
+    },
+
     triggerTextChangeEvent: function() {
         var event = new events.ChangeEvent('nodeTextChange', {node: this});
         this.document.trigger('change', event);
@@ -300,20 +464,46 @@ $.extend(TextNode.prototype, {
 
 
 var parseXML = function(xml) {
-    return $(xml)[0];
+    return $($.trim(xml))[0];
+};
+
+var registerTransformation = function(desc, name, target) {
+    var Transformation = transformations.createContextTransformation(desc, name);
+    target[name] = function(args) {
+        var instance = this;
+        return instance.transform(Transformation, args);
+    }
+};
+
+var registerMethod = function(methodName, method, target) {
+    if(target[methodName]) {
+        throw new Error('Cannot extend {target} with method name {methodName}. Name already exists.'
+            .replace('{target}', target)
+            .replace('{methodName}', methodName)
+        );
+    }
+    target[methodName] = method;
 };
 
+
 var Document = function(xml) {
     this.loadXML(xml);
+    this.undoStack = [];
+    this.redoStack = [];
+    this._transformationLevel = 0;
+    
+    this._nodeMethods = {};
+    this._nodeTransformations = {};
 };
 
 $.extend(Document.prototype, Backbone.Events, {
     ElementNodeFactory: ElementNode,
     TextNodeFactory: TextNode,
 
-    createElementNode: function(from) {
-        if(!(from instanceof HTMLElement)) {
-            if(from.text) {
+    createDocumentNode: function(from) {
+        if(!(from instanceof Node)) {
+            if(from.text !== undefined) {
+                /* globals document */
                 from = document.createTextNode(from.text);
             } else {
                 var node = $('<' + from.tagName + '>');
@@ -331,11 +521,10 @@ $.extend(Document.prototype, Backbone.Events, {
         } else if(from.nodeType === Node.ELEMENT_NODE) {
             Factory = this.ElementNodeFactory;
         }
-        return new Factory(from, this);
-    },
-
-    createTextNode: function(nativeNode) {
-        return new this.TextNodeFactory(nativeNode, this);
+        var toret = new Factory(from, this);
+        _.extend(toret, this._nodeMethods);
+        _.extend(toret, this._nodeTransformations);
+        return toret;
     },
 
     loadXML: function(xml, options) {
@@ -351,21 +540,21 @@ $.extend(Document.prototype, Backbone.Events, {
     },
 
     containsNode: function(node) {
-        return node._$.parents().index(this.root._$) !== -1;
+        return this.root && (node.nativeNode === this.root.nativeNode || node._$.parents().index(this.root._$) !== -1);
     },
 
     wrapNodes: function(params) {
-        if(!(params.element1.parent().sameNode(params.element2.parent()))) {
+        if(!(params.node1.parent().sameNode(params.node2.parent()))) {
             throw new Error('Wrapping non-sibling nodes not supported.');
         }
 
-        var parent = params.element1.parent(),
+        var parent = params.node1.parent(),
             parentContents = parent.contents(),
-            wrapper = this.createElementNode({
+            wrapper = this.createDocumentNode({
                 tagName: params._with.tagName,
                 attrs: params._with.attrs}),
-            idx1 = parent.indexOf(params.element1),
-            idx2 = parent.indexOf(params.element2);
+            idx1 = parent.indexOf(params.node1),
+            idx2 = parent.indexOf(params.node2);
 
         if(idx1 > idx2) {
             var tmp = idx1;
@@ -390,6 +579,25 @@ $.extend(Document.prototype, Backbone.Events, {
         return wrapper;
     },
 
+    getSiblingParents: function(params) {
+        var parents1 = [params.node1].concat(params.node1.parents()).reverse(),
+            parents2 = [params.node2].concat(params.node2.parents()).reverse(),
+            noSiblingParents = null;
+
+        if(parents1.length === 0 || parents2.length === 0 || !(parents1[0].sameNode(parents2[0]))) {
+            return noSiblingParents;
+        }
+
+        var i;
+        for(i = 0; i < Math.min(parents1.length, parents2.length); i++) {
+            if(parents1[i].sameNode(parents2[i])) {
+                continue;
+            }
+            break;
+        }
+        return {node1: parents1[i], node2: parents2[i]};
+    },
+
     _wrapText: function(params) {
         params = _.extend({textNodeIdx: 0}, params);
         if(typeof params.textNodeIdx === 'number') {
@@ -412,7 +620,7 @@ $.extend(Document.prototype, Backbone.Events, {
             throw new Error('Wrapping text in non-sibling text nodes not supported.');
         }
         
-        var wrapperElement = this.createElementNode({tagName: params._with.tagName, attrs: params._with.attrs});
+        var wrapperElement = this.createDocumentNode({tagName: params._with.tagName, attrs: params._with.attrs});
         textNode1.after(wrapperElement);
         textNode1.detach();
         
@@ -438,21 +646,141 @@ $.extend(Document.prototype, Backbone.Events, {
             wrapperElement.after({text: suffixOutside});
         }
         return wrapperElement;
+    },
+
+    trigger: function() {
+        //console.log('trigger: ' + arguments[0] + (arguments[1] ? ', ' + arguments[1].type : ''));
+        Backbone.Events.trigger.apply(this, arguments);
+    },
+
+    getNodeInsertion: function(node) {
+        var insertion = {};
+        if(node instanceof DocumentNode) {
+            insertion.ofNode = node;
+            insertion.insertsNew = !this.containsNode(node);
+        } else {
+          insertion.ofNode = this.createDocumentNode(node);
+          insertion.insertsNew = true;
+        }
+        return insertion;
+    },
+
+    replaceRoot: function(node) {
+        var insertion = this.getNodeInsertion(node);
+        this.root.detach();
+        defineDocumentProperties(this, insertion.ofNode._$);
+        insertion.ofNode.triggerChangeEvent('nodeAdded');
+        return insertion.ofNode;
+    },
+
+    registerMethod: function(methodName, method) {
+        registerMethod(methodName, method, this);
+    },
+
+    registerNodeMethod: function(methodName, method) {
+        registerMethod(methodName, method, this._nodeMethods);
+    },
+
+    registerDocumentTransformation: function(desc, name) {
+        registerTransformation(desc, name, this);
+    },
+
+    registerNodeTransformation: function(desc, name) {
+        registerTransformation(desc, name, this._nodeTransformations);
+    },
+
+    registerExtension: function(extension) {
+        //debugger;
+        var doc = this,
+            existingPropertyNames = _.values(this);
+
+        ['document', 'documentNode'].forEach(function(dstName) {
+            var dstExtension = extension[dstName];
+            if(dstExtension) {
+                if(dstExtension.methods) {
+                    _.pairs(dstExtension.methods).forEach(function(pair) {
+                        var methodName = pair[0],
+                            method = pair[1],
+                            operation;
+                        operation = {document: 'registerMethod', documentNode: 'registerNodeMethod'}[dstName];
+                        doc[operation](methodName, method);
+
+                    });
+                }
+
+                if(dstExtension.transformations) {
+                    _.pairs(dstExtension.transformations).forEach(function(pair) {
+                        var name = pair[0],
+                            desc = pair[1],
+                            operation;
+                        operation = {document: 'registerDocumentTransformation', documentNode: 'registerNodeTransformation'}[dstName];
+                        doc[operation](desc, name);
+                    });
+                }
+            }
+        });
+    },
+
+    transform: function(Transformation, args) {
+        //console.log('transform');
+        var toret, transformation;
+
+        if(typeof Transformation === 'function') {
+            transformation = new Transformation(this, this, args);
+        } else {
+            transformation = Transformation;
+        }
+        if(transformation) {
+            this._transformationLevel++;
+            toret = transformation.run();
+            if(this._transformationLevel === 1) {
+                this.undoStack.push(transformation);
+            }
+            this._transformationLevel--;
+            //console.log('clearing redo stack');
+            this.redoStack = [];
+            return toret;
+        } else {
+            throw new Error('Transformation ' + transformation + ' doesn\'t exist!');
+        }
+    },
+    undo: function() {
+        var transformation = this.undoStack.pop();
+        if(transformation) {
+            transformation.undo();
+            this.redoStack.push(transformation);
+        }
+    },
+    redo: function() {
+        var transformation = this.redoStack.pop();
+        if(transformation) {
+            transformation.run();
+            this.undoStack.push(transformation);
+        }
+    },
+
+    getNodeByPath: function(path) {
+        var toret = this.root;
+        path.forEach(function(idx) {
+            toret = toret.contents()[idx];
+        });
+        return toret;
     }
 });
 
 var defineDocumentProperties = function(doc, $document) {
     Object.defineProperty(doc, 'root', {get: function() {
-        return doc.createElementNode($document[0]);
+        return doc.createDocumentNode($document[0]);
     }, configurable: true});
     Object.defineProperty(doc, 'dom', {get: function() {
         return $document[0];
     }, configurable: true});
 };
 
+
 return {
     documentFromXML: function(xml) {
-        return new Document(parseXML(xml));
+        return new Document(xml);
     },
 
     elementNodeFromXML: function(xml) {
@@ -461,7 +789,8 @@ return {
 
     Document: Document,
     DocumentNode: DocumentNode,
-    ElementNode: ElementNode
+    ElementNode: ElementNode,
+    TextNode: TextNode
 };
 
 });
\ No newline at end of file