Refactoring extension registration - abstracting away registration on objects

[fnpeditor.git] / src / smartxml / smartxml.js

diff --git a/src/smartxml/smartxml.js b/src/smartxml/smartxml.js
index 637fda6..8110a97 100644 (file)
--- a/src/smartxml/smartxml.js
+++ b/src/smartxml/smartxml.js
@@ -2,20 +2,26 @@ define([
     'libs/jquery',
     'libs/underscore',
     'libs/backbone',
     'libs/jquery',
     'libs/underscore',
     'libs/backbone',

-    'smartxml/events'
-], function($, _, Backbone, events) {
+    'smartxml/events',
+    'smartxml/transformations'
+], function($, _, Backbone, events, transformations) {

     
 'use strict';
     
 'use strict';

-
+/* globals Node */

 
 var TEXT_NODE = Node.TEXT_NODE;
 
 
 var INSERTION = function(implementation) {
     var toret = function(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),
+            nodeWasContained = this.document.containsNode(insertion.ofNode),
+            nodeParent;
+        if(!(this.document.containsNode(this))) {
+            nodeParent = insertion.ofNode.parent();
+        }

         implementation.call(this, insertion.ofNode.nativeNode);
         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, nodeWasContained);

         return insertion.ofNode;
     };
     return toret;
         return insertion.ofNode;
     };
     return toret;


@@ -31,11 +37,55 @@ var DocumentNode = function(nativeNode, document) {
 };
 
 $.extend(DocumentNode.prototype, {
 };
 
 $.extend(DocumentNode.prototype, {

+
+    transformations: new transformations.TransformationStorage(),
+
+    transform: function(name, args) {
+        var Transformation = this.transformations.get(name),
+            transformation;
+        if(Transformation) {
+            transformation = new Transformation(this.document, this, args);
+        }
+        return this.document.transform(transformation);
+    },
+

     _setNativeNode: function(nativeNode) {
         this.nativeNode = nativeNode;
         this._$ = $(nativeNode);
     },
 
     _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);
     },
     isRoot: function() {
         return this.document.root.sameNode(this);
     },


@@ -47,14 +97,24 @@ $.extend(DocumentNode.prototype, {
         return this;
     },
 
         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) {
     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) {
     },
 
     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;
     },
         }
         return null;
     },


@@ -121,23 +181,20 @@ $.extend(DocumentNode.prototype, {
         }
     },
 
         }
     },
 

-    triggerChangeEvent: function(type, metaData) {
-        var event = new events.ChangeEvent(type, $.extend({node: this}, metaData || {}));
+    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 === '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) {
     },
     
     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() {
     },
 
     getIndex: function() {


@@ -158,7 +215,7 @@ $.extend(ElementNode.prototype, {
 
     detach: function() {
         var next;
 
     detach: function() {
         var next;

-        if(parent && this.isSurroundedByTextElements()) {
+        if(this.parent() && this.isSurroundedByTextElements()) {

             next = this.next();
             this.prev().appendText(next.getText());
             next.detach();
             next = this.next();
             this.prev().appendText(next.getText());
             next.detach();


@@ -186,17 +243,18 @@ $.extend(ElementNode.prototype, {
         return this.nativeNode.tagName.toLowerCase();
     },
 
         return this.nativeNode.tagName.toLowerCase();
     },
 

-    contents: function() {
+    contents: function(selector) {

         var toret = [],
             document = this.document;
         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;
     },
 
         return toret;
     },
 


@@ -205,7 +263,7 @@ $.extend(ElementNode.prototype, {
     },
 
     setTag: function(tagName) {
     },
 
     setTag: function(tagName) {

-        var node = this.document.createElementNode({tagName: tagName}),
+        var node = this.document.createDocumentNode({tagName: tagName}),

             oldTagName = this.getTagName(),
             myContents = this._$.contents();
 
             oldTagName = this.getTagName(),
             myContents = this._$.contents();
 


@@ -251,6 +309,15 @@ $.extend(ElementNode.prototype, {
         this._$.prepend(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() {
         var parent = this.parent();
         if(!parent) {
     unwrapContent: function() {
         var parent = this.parent();
         if(!parent) {


@@ -315,6 +382,63 @@ $.extend(ElementNode.prototype, {
     }
 });
 
     }
 });
 

+// trans
+
+// todo - split+append
+
+ElementNode.prototype.transformations.register(transformations.createContextTransformation({
+    name: 'smartxml.setAttr',
+    impl: function(args) {
+        this.setAttr(args.name, args.value);
+    },
+    getChangeRoot: function() {
+        return this.context;
+    }
+}));
+
+ElementNode.prototype.transformations.register(transformations.createContextTransformation({
+    name: 'smartxml.setAttr2',
+    impl: function(args) {
+        this.prevAttr = this.getAttr(args.name);
+        this.setAttr(args.name, args.value);
+    },
+    undo: function(args) {
+        this.setAttr(args.name, this.prevAttr);
+    }
+}));
+
+DocumentNode.prototype.transformations.register(transformations.createContextTransformation({
+    name: 'smartxml.wrapWith',
+    getChangeRoot: function() {
+        return this.context.parent();
+    },
+    impl: function(args) {
+        return this.wrapWith(args);
+    }
+}));
+
+DocumentNode.prototype.transformations.register(transformations.createContextTransformation({
+    name: 'smartxml.wrapText',
+    getChangeRoot: function() {
+        return this.context;
+    },
+    impl: function(args) {
+        return this.wrapText(args);
+    }
+}));
+
+DocumentNode.prototype.transformations.register(transformations.createContextTransformation({
+    name: 'smartxml.detach',
+    getChangeRoot: function() {
+        return this.context.parent();
+    },
+    impl: function(args) {
+        return this.detach();
+    }
+}));
+
+///
+

 var TextNode = function(nativeNode, document) {
     DocumentNode.call(this, nativeNode, document);
 };
 var TextNode = function(nativeNode, document) {
     DocumentNode.call(this, nativeNode, document);
 };


@@ -328,6 +452,7 @@ $.extend(TextNode.prototype, {
     },
 
     setText: function(text) {
     },
 
     setText: function(text) {

+        //console.log('smartxml: ' + text);

         this.nativeNode.data = text;
         this.triggerTextChangeEvent();
     },
         this.nativeNode.data = text;
         this.triggerTextChangeEvent();
     },


@@ -356,6 +481,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);
     triggerTextChangeEvent: function() {
         var event = new events.ChangeEvent('nodeTextChange', {node: this});
         this.document.trigger('change', event);


@@ -363,21 +526,75 @@ $.extend(TextNode.prototype, {
 });
 
 
 });
 
 

+TextNode.prototype.transformations.register(transformations.createContextTransformation({
+    name: 'rng.breakContent',
+    // impl: function(args) {
+    //     var node = this.context,
+    //         newNodes, emptyNode, emptyText;
+    //     newNodes = node.transform('smartxml.split', {offset: args.offset});
+    //     [newNodes.first, newNodes.second].some(function(newNode) {
+    //         if(!(newNode.contents().length)) {
+    //             newNode.transform('smartxml.append', {text: ''});
+    //             return true; // break
+    //         }
+    //     });
+    //     return _.extend(newNodes, {emptyText: emptyText});
+    // },
+    impl: function(args) {
+        var node = this,
+            newNodes, emptyNode, emptyText;
+        newNodes = node.split({offset: args.offset});
+        [newNodes.first, newNodes.second].some(function(newNode) {
+            if(!(newNode.contents().length)) {
+                newNode.append({text: ''});
+                return true; // break
+            }
+        });
+        return _.extend(newNodes, {emptyText: emptyText});
+    },
+    getChangeRoot: function() {
+        return this.context.parent().parent();
+    },
+    isAllowed: function(args) {
+        var parent = this.parent();
+        return !!(parent && parent.parent());
+    }
+}));
+
+
+ElementNode.prototype.transformations.register(transformations.createContextTransformation({
+    name: 'smartxml.setText',
+    impl: function(args) {
+        this.setText(args.text);
+    },
+    getChangeRoot: function() {
+        return this.context;
+    }
+}));
+
+

 var parseXML = function(xml) {
 var parseXML = function(xml) {

-    return $(xml)[0];
+    return $($.trim(xml))[0];

 };
 
 var Document = function(xml) {
     this.loadXML(xml);
 };
 
 var Document = function(xml) {
     this.loadXML(xml);

+    this.undoStack = [];
+    this.redoStack = [];
+    this._transformationLevel = 0;
+    this.transformations = new transformations.TransformationStorage();
+

 };
 
 $.extend(Document.prototype, Backbone.Events, {
     ElementNodeFactory: ElementNode,
     TextNodeFactory: TextNode,
 };
 
 $.extend(Document.prototype, Backbone.Events, {
     ElementNodeFactory: ElementNode,
     TextNodeFactory: TextNode,

+    transformations: new transformations.TransformationStorage(),

 
 

-    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 + '>');
                 from = document.createTextNode(from.text);
             } else {
                 var node = $('<' + from.tagName + '>');


@@ -398,10 +615,6 @@ $.extend(Document.prototype, Backbone.Events, {
         return new Factory(from, this);
     },
 
         return new Factory(from, this);
     },
 

-    createTextNode: function(nativeNode) {
-        return new this.TextNodeFactory(nativeNode, this);
-    },
-

     loadXML: function(xml, options) {
         options = options || {};
         defineDocumentProperties(this, $(parseXML(xml)));
     loadXML: function(xml, options) {
         options = options || {};
         defineDocumentProperties(this, $(parseXML(xml)));


@@ -419,17 +632,17 @@ $.extend(Document.prototype, Backbone.Events, {
     },
 
     wrapNodes: function(params) {
     },
 
     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.');
         }
 
             throw new Error('Wrapping non-sibling nodes not supported.');
         }
 

-        var parent = params.element1.parent(),
+        var parent = params.node1.parent(),

             parentContents = parent.contents(),
             parentContents = parent.contents(),

-            wrapper = this.createElementNode({
+            wrapper = this.createDocumentNode({

                 tagName: params._with.tagName,
                 attrs: params._with.attrs}),
                 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;
 
         if(idx1 > idx2) {
             var tmp = idx1;


@@ -495,7 +708,7 @@ $.extend(Document.prototype, Backbone.Events, {
             throw new Error('Wrapping text in non-sibling text nodes not supported.');
         }
         
             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();
         
         textNode1.after(wrapperElement);
         textNode1.detach();
         


@@ -526,21 +739,102 @@ $.extend(Document.prototype, Backbone.Events, {
     trigger: function() {
         //console.log('trigger: ' + arguments[0] + (arguments[1] ? ', ' + arguments[1].type : ''));
         Backbone.Events.trigger.apply(this, arguments);
     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(transformation, args) {
+        //console.log('transform');
+        var Transformation, toret;
+        if(typeof transformation === 'string') {
+            Transformation = this.transformations.get(transformation);
+            if(Transformation) {
+                transformation = new Transformation(this, this, args);
+            }
+        } 
+        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() {
     }
 });
 
 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});
 };
 
     }, configurable: true});
     Object.defineProperty(doc, 'dom', {get: function() {
         return $document[0];
     }, configurable: true});
 };
 

+Document.prototype.transformations.register(transformations.createContextTransformation({
+    name: 'smartxml.wrapNodes',
+    // init: function() {
+
+    // },
+    // getChangeRoot: function() {
+    //     return this.context;
+    // },
+    impl: function(args) {
+        this.wrapNodes(args);
+    },
+
+}));
+
+

 return {
     documentFromXML: function(xml) {
 return {
     documentFromXML: function(xml) {

-        return new Document(parseXML(xml));
+        return new Document(xml);

     },
 
     elementNodeFromXML: function(xml) {
     },
 
     elementNodeFromXML: function(xml) {


@@ -549,7 +843,8 @@ return {
 
     Document: Document,
     DocumentNode: DocumentNode,
 
     Document: Document,
     DocumentNode: DocumentNode,

-    ElementNode: ElementNode
+    ElementNode: ElementNode,
+    TextNode: TextNode

 };
 
 });
\ No newline at end of file
 };
 
 });
\ No newline at end of file