moving wlxml object api transformations directly into .object properties name space

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

diff --git a/src/smartxml/smartxml.js b/src/smartxml/smartxml.js
index 0b12620..831a96a 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,13 +37,27 @@ var DocumentNode = function(nativeNode, document) {
 };
 
 $.extend(DocumentNode.prototype, {
 };
 
 $.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() {
     _setNativeNode: function(nativeNode) {
         this.nativeNode = nativeNode;
         this._$ = $(nativeNode);
     },
 
     clone: function() {

-        return this.document.createDocumentNode(this._$.clone(true, true)[0]);
+        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) {
     },
 
     getPath: function(ancestor) {


@@ -155,11 +175,16 @@ $.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) {


@@ -184,7 +209,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();


@@ -212,12 +237,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() {
-            toret.push(document.createDocumentNode(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;
     },
 


@@ -272,6 +303,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) {


@@ -349,6 +389,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();
     },


@@ -426,8 +467,33 @@ var parseXML = function(xml) {
     return $($.trim(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);
 var Document = function(xml) {
     this.loadXML(xml);

+    this.undoStack = [];
+    this.redoStack = [];
+    this._transformationLevel = 0;
+    
+    this._nodeMethods = {};
+    this._nodeTransformations = {};

 };
 
 $.extend(Document.prototype, Backbone.Events, {
 };
 
 $.extend(Document.prototype, Backbone.Events, {


@@ -437,6 +503,7 @@ $.extend(Document.prototype, Backbone.Events, {
     createDocumentNode: function(from) {
         if(!(from instanceof Node)) {
             if(from.text !== undefined) {
     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 + '>');


@@ -454,7 +521,10 @@ $.extend(Document.prototype, Backbone.Events, {
         } else if(from.nodeType === Node.ELEMENT_NODE) {
             Factory = this.ElementNodeFactory;
         }
         } else if(from.nodeType === Node.ELEMENT_NODE) {
             Factory = this.ElementNodeFactory;
         }

-        return new Factory(from, this);
+        var toret = new Factory(from, this);
+        _.extend(toret, this._nodeMethods);
+        _.extend(toret, this._nodeTransformations);
+        return toret;

     },
 
     loadXML: function(xml, options) {
     },
 
     loadXML: function(xml, options) {


@@ -474,17 +544,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(),
             wrapper = this.createDocumentNode({
                 tagName: params._with.tagName,
                 attrs: params._with.attrs}),
             parentContents = parent.contents(),
             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;
 
         if(idx1 > idx2) {
             var tmp = idx1;


@@ -601,6 +671,100 @@ $.extend(Document.prototype, Backbone.Events, {
         defineDocumentProperties(this, insertion.ofNode._$);
         insertion.ofNode.triggerChangeEvent('nodeAdded');
         return insertion.ofNode;
         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;

     }
 });
 
     }
 });
 


@@ -613,6 +777,7 @@ var defineDocumentProperties = function(doc, $document) {
     }, configurable: true});
 };
 
     }, configurable: true});
 };
 

+

 return {
     documentFromXML: function(xml) {
         return new Document(xml);
 return {
     documentFromXML: function(xml) {
         return new Document(xml);


@@ -624,7 +789,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