undoredo wip
[fnpeditor.git] / src / smartxml / smartxml.js
index 6e754de..fa5f551 100644 (file)
@@ -6,21 +6,33 @@ define([
 ], function($, _, Backbone, events) {
     
 'use strict';
-
+/* globals Node */
 
 var TEXT_NODE = Node.TEXT_NODE;
 
 
 var INSERTION = function(implementation) {
     var toret = function(node) {
-        var insertion = this.getNodeInsertion(node);
+        var insertion = this.getNodeInsertion(node),
+            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});
+        this.triggerChangeEvent(insertion.insertsNew ? 'nodeAdded' : 'nodeMoved', {node: insertion.ofNode}, nodeParent);
         return insertion.ofNode;
     };
     return toret;
 };
 
+// var TRANSFORMATION = function(name, implementation) {
+//     //implementation._isTransformation = true;
+
+//     createDumbTransformation(name, implementation, )
+
+//     return implementation;
+// };
+
 var DocumentNode = function(nativeNode, document) {
     if(!document) {
         throw new Error('undefined document for a node');
@@ -36,6 +48,34 @@ $.extend(DocumentNode.prototype, {
         this._$ = $(nativeNode);
     },
 
+    clone: function() {
+        return this.document.createDocumentNode(this._$.clone(true, true)[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();
@@ -43,14 +83,24 @@ $.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;
     },
@@ -64,6 +114,26 @@ $.extend(DocumentNode.prototype, {
         return parents;
     },
 
+    prev: function() {
+        var myIdx = this.getIndex();
+        return myIdx > 0 ? this.parent().contents()[myIdx-1] : null;
+    },
+
+    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);
     }),
@@ -73,33 +143,50 @@ $.extend(DocumentNode.prototype, {
     }),
 
     wrapWith: function(node) {
-        node = node instanceof ElementNode ? node : this.document.createElementNode(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) {
+        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))) {
+             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);
     }
 });
@@ -112,6 +199,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);
@@ -136,12 +233,7 @@ $.extend(ElementNode.prototype, {
         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));
-            }
+            toret.push(document.createDocumentNode(this));
         });
         return toret;
     },
@@ -151,7 +243,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();
 
@@ -197,24 +289,35 @@ $.extend(ElementNode.prototype, {
         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() {
         var parent = this.parent();
         if(!parent) {
             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;
@@ -223,9 +326,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;
             }
         }
@@ -299,6 +403,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);
@@ -307,20 +449,23 @@ $.extend(TextNode.prototype, {
 
 
 var parseXML = function(xml) {
-    return $(xml)[0];
+    return $($.trim(xml))[0];
 };
 
 var Document = function(xml) {
     this.loadXML(xml);
+    this.undoStack = [];
+    this.redoStack = [];
 };
 
 $.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 + '>');
@@ -341,10 +486,6 @@ $.extend(Document.prototype, Backbone.Events, {
         return new Factory(from, this);
     },
 
-    createTextNode: function(nativeNode) {
-        return new this.TextNodeFactory(nativeNode, this);
-    },
-
     loadXML: function(xml, options) {
         options = options || {};
         defineDocumentProperties(this, $(parseXML(xml)));
@@ -362,17 +503,17 @@ $.extend(Document.prototype, Backbone.Events, {
     },
 
     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;
@@ -438,7 +579,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();
         
@@ -469,21 +610,182 @@ $.extend(Document.prototype, Backbone.Events, {
     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;
+    },
+
+    transform: function(transformationName, args) {
+        var Transformation = transformations[transformationName],
+            transformation;
+        if(Transformation) {
+            transformation = new Transformation(args);
+            transformation.run();
+            this.undoStack.push(transformation);
+        } else {
+            throw new Error('Transformation ' + transformationName + ' 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});
 };
 
+
+// var registerTransformationsFromObject = function(object) {
+//     _.values(object).filter(function(val) {
+//         return typeof val === 'function' && val._isTransformation;
+//     })
+//     .forEach(function(val) {
+//         registerTransformation(val._transformationName, val, object);
+//     });
+// };
+// registerTransformationsFromObject(ElementNode.prototype);
+// registerTransformationsFromObject(TextNode.prototype);
+// registerTransformationsFromObject(Document.prototype);
+
+// var Transformation = function() {
+// };
+// $.extend(Transformation.prototype, {
+
+// });
+
+
+// var createDumbTransformation = function(impl, contextObject) {
+//     var DumbTransformation = function(args) {
+//         this.args = this.args;
+//     };
+//     DumbTransformation.prototype = Object.create(Transformation.prototype);
+//     $.extend(DumbTransformation.prototype, {
+//         run: function() {
+//             impl.apply(contextObject, this.args);
+//         }
+//     });
+
+//     return DumbTransformation;
+
+
+// };
+
+var transformations = {};
+// var registerTransformation = function(name, impl, contextObject) {
+//     if(typeof impl === 'function') {
+//         transformations[name] = createDumbTransformation(impl, contextObject);
+//     }
+// };
+
+// registerTransformation('detachx', DocumentNode.prototype.detach,  )
+
+
+// 1. detach via totalny fallback
+var DetachNodeTransformation = function(args) {
+    this.node = args.node;
+    this.document = this.node.document;
+};
+$.extend(DetachNodeTransformation.prototype, {
+    run: function() {
+        this.oldRoot = this.node.document.root.clone();
+        this.path = this.node.getPath();
+        this.node.detach(); // @TS
+        
+    },
+    undo: function() {
+        this.document.root.replaceWith(this.oldRoot); // this.getDocument?
+        this.node = this.document.getNodeByPath(this.path);
+    }
+});
+transformations['detach'] = DetachNodeTransformation;
+
+//2. detach via wskazanie changeroot
+
+var Detach2NodeTransformation = function(args) {
+    this.node = args.node;
+    this.document = this.node.document;
+};
+$.extend(Detach2NodeTransformation.prototype, {
+    run: function() {
+        this.root = this.node.parent() ? this.node.parent() : this.node.document.root;
+        this.oldRoot = (this.root).clone();
+        this.path = this.node.getPath();
+        this.node.detach();
+        
+    },
+    undo: function() {
+        this.root.replaceWith(this.oldRoot); // this.getDocument?
+        this.node = this.document.getNodeByPath(this.path);
+    }
+});
+transformations['detach2'] = Detach2NodeTransformation;
+
+//3. detach z pełnym własnym redo
+
+var Detach3NodeTransformation = function(args) {
+    this.node = args.node;
+    this.document = this.node.document;
+};
+$.extend(Detach3NodeTransformation.prototype, {
+    run: function() {
+        this.index = this.node.getIndex();
+        this.parent = this.node.parent();
+        this.node.detach();
+    },
+    undo: function() {
+        var contents = this.parent.contents();
+        if(contents.length === 0) {
+            this.parent.append(this.node)
+        }
+    }
+});
+transformations['detach3'] = Detach3NodeTransformation;
+
 return {
     documentFromXML: function(xml) {
-        return new Document(parseXML(xml));
+        return new Document(xml);
     },
 
     elementNodeFromXML: function(xml) {