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 1379153..831a96a 100644 (file)
--- a/src/smartxml/smartxml.js
+++ b/src/smartxml/smartxml.js
@@ -2,8 +2,9 @@ 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';
 /* globals Node */
     
 'use strict';
 /* globals Node */


@@ -14,25 +15,18 @@ var TEXT_NODE = Node.TEXT_NODE;
 var INSERTION = function(implementation) {
     var toret = function(node) {
         var insertion = this.getNodeInsertion(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);
             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);
+        this.triggerChangeEvent(insertion.insertsNew ? 'nodeAdded' : 'nodeMoved', {node: insertion.ofNode}, nodeParent, nodeWasContained);

         return insertion.ofNode;
     };
     return toret;
 };
 
         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');
 var DocumentNode = function(nativeNode, document) {
     if(!document) {
         throw new Error('undefined document for a node');


@@ -44,12 +38,8 @@ var DocumentNode = function(nativeNode, document) {
 
 $.extend(DocumentNode.prototype, {
 
 
 $.extend(DocumentNode.prototype, {
 

-    transform: function(name, args) {
-        var Transformation = contextTransformations[name],
-            transformation;
-        if(Transformation) {
-            transformation = new Transformation(this.document, this, args);
-        }
+    transform: function(Transformation, args) {
+        var transformation = new Transformation(this.document, this, args);

         return this.document.transform(transformation);
     },
 
         return this.document.transform(transformation);
     },
 


@@ -185,13 +175,13 @@ $.extend(DocumentNode.prototype, {
         }
     },
 
         }
     },
 

-    triggerChangeEvent: function(type, metaData, origParent) {
+    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);
         }
         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))) {
+        if((type === 'nodeAdded' || type === 'nodeMoved') && !this.document.containsNode(this) && nodeWasContained) {

              event = new events.ChangeEvent('nodeDetached', {node: node, parent: origParent});
              this.document.trigger('change', event);
         }
              event = new events.ChangeEvent('nodeDetached', {node: node, parent: origParent});
              this.document.trigger('change', event);
         }


@@ -247,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;
     },
 


@@ -393,7 +389,7 @@ $.extend(TextNode.prototype, {
     },
 
     setText: function(text) {
     },
 
     setText: function(text) {

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

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


@@ -471,10 +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);
     this.undoStack = [];
     this.redoStack = [];
 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, {


@@ -502,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) {


@@ -651,25 +673,75 @@ $.extend(Document.prototype, Backbone.Events, {
         return insertion.ofNode;
     },
 
         return insertion.ofNode;
     },
 

-    transform: function(transformationName, args) {
-        console.log('transform');
-        var Transformation, transformation, toret;
-        if(typeof transformationName === 'string') {
-            Transformation = transformations[transformationName];
-            if(Transformation) {
-                transformation = new Transformation(args);
+    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 {
         } else {

-            transformation = transformationName;
+            transformation = Transformation;

         }
         if(transformation) {
         }
         if(transformation) {

+            this._transformationLevel++;

             toret = transformation.run();
             toret = transformation.run();

-            this.undoStack.push(transformation);
-            console.log('clearing redo stack');
+            if(this._transformationLevel === 1) {
+                this.undoStack.push(transformation);
+            }
+            this._transformationLevel--;
+            //console.log('clearing redo stack');

             this.redoStack = [];
             return toret;
         } else {
             this.redoStack = [];
             return toret;
         } else {

-            throw new Error('Transformation ' + transformationName + ' doesn\'t exist!');
+            throw new Error('Transformation ' + transformation + ' doesn\'t exist!');

         }
     },
     undo: function() {
         }
     },
     undo: function() {


@@ -706,314 +778,6 @@ var defineDocumentProperties = function(doc, $document) {
 };
 
 
 };
 
 

-// 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.nodePath = args.node.getPath();
-    this.document = args.node.document;
-};
-$.extend(Detach2NodeTransformation.prototype, {
-    run: function() {
-        var node = this.document.getNodeByPath(this.nodePath),
-            root = node.parent() ? node.parent() : this.document.root;
-        
-        this.rootPath = root.getPath();
-        this.oldRoot = (root).clone();
-        node.detach();
-    },
-    undo: function() {
-        this.document.getNodeByPath(this.rootPath).replaceWith(this.oldRoot);
-    }
-});
-//transformations['detach2'] = Detach2NodeTransformation;
-
-//2a. generyczna transformacja
-
-var createTransformation = function(desc) {
-
-    var NodeTransformation = function(args) {
-        this.nodePath = args.node.getPath();
-        this.document = args.node.document;
-        this.args = args;
-    };
-    $.extend(NodeTransformation.prototype, {
-        run: function() {
-            var node = this.document.getNodeByPath(this.nodePath),
-                root;
-
-            if(desc.getRoot) {
-                root = desc.getRoot(node);
-            } else {
-                root = this.document.root;
-            }
-            
-            this.rootPath = root.getPath();
-            this.oldRoot = (root).clone();
-            desc.impl.call(node, this.args);
-        },
-        undo: function() {
-            this.document.getNodeByPath(this.rootPath).replaceWith(this.oldRoot);
-        }
-    });
-
-    return NodeTransformation;
-}
-
-///
-var Transformation = function(args) {
-    this.args = args;
-};
-$.extend(Transformation.prototype, {
-    run: function() {
-        throw new Error('not implemented');
-    },
-    undo: function() {
-        throw new Error('not implemented');
-    },
-});
-
-var createGenericTransformation = function(desc) {
-    var GenericTransformation = function(document, args) {
-        //document.getNodeByPath(contextPath).call(this, args);
-        this.args = args;
-        this.document = document;
-    };
-    $.extend(GenericTransformation.prototype, {
-        run: function() {
-            var changeRoot = desc.getChangeRoot ? desc.getChangeRoot.call(this) : this.document.root;
-            this.snapshot = changeRoot.clone();
-            this.changeRootPath = changeRoot.getPath();
-            return desc.impl.call(this.context, this.args); // a argumenty do metody?
-        },
-        undo: function() {
-            this.document.getNodeByPath(this.changeRootPath).replaceWith(this.snapshot);
-        },
-    });
-
-    return GenericTransformation;
-};
-
-// var T = createGenericTransformation({impl: function() {}});
-// var t = T(doc, {a:1,b:2,c3:3});
-
-
-var createContextTransformation = function(desc) {
-    // mozna sie pozbyc przez przeniesienie object/context na koniec argumentow konstruktora generic transformation
-    var GenericTransformation = createGenericTransformation(desc);
-
-    var ContextTransformation = function(document, object, args) {
-        var contextPath = object.getPath();
-
-        GenericTransformation.call(this, document, args);
-        
-        Object.defineProperty(this, 'context', {
-            get: function() {
-                return document.getNodeByPath(contextPath);
-            }
-        });
-    }
-    ContextTransformation.prototype = Object.create(GenericTransformation.prototype);
-    return ContextTransformation;
-}
-// var T = createContextTransformation({impl: function() {}});
-// var t = T(doc, node, {a:1,b:2,c3:3});
-///
-
-var contextTransformations = {};
-contextTransformations['setText'] = createContextTransformation({
-    impl: function(args) {
-        this.setText(args.text);
-    },
-    getChangeRoot: function() {
-        return this.context;
-    }
-});
-
-contextTransformations['setAttr'] = createContextTransformation({
-    impl: function(args) {
-        this.setAttr(args.name, args.value);
-    },
-    getChangeRoot: function() {
-        return this.context;
-    }
-});
-
-contextTransformations['split'] = createContextTransformation({
-    impl: function(args) {
-        return this.split({offset: args.offset});
-    }//,
-    // getChangeRoot: function() {
-    //     return this.context.parent().parent();
-    // }
-});
-
-// var TRANSFORMATION2 = function(f, getChangeRoot, undo) {
-//     var context = this,
-
-
-//     var transformation = createContextTransformation({
-//         impl: f,
-//         getChangeRoot: getChangeRoot,
-
-//     });
-
-//     var toret = function() {
-//         var 
-//         f.apply(context, createArgs ? createArgs(arguments) : arguments)
-//     };
-//     return toret;
-// }
-
-transformations['detach2'] = createTransformation({
-    // impl: function() {
-    //     //this.setAttr('class', 'cite'); //  
-    // },
-    impl: ElementNode.prototype.detach,
-    getRoot: function(node) {
-        return node.parent();
-    }
-
-});
-
-transformations['setText-old'] = createTransformation({
-    impl: function(args) {
-        this.setText(args.text)
-    },
-    getRoot: function(node) {
-        return node;
-    }
-
-});
-
-transformations['setClass-old'] = createTransformation({
-    impl: function(args) {
-        this.setClass(args.klass);
-    },
-    getRoot: function(node) {
-        return node;
-    }
-})
-
-//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.path = this.node.getPath();
-        if(this.node.isSurroundedByTextElements()) {
-            this.prevText = this.node.prev().getText();
-            this.nextText = this.node.next().getText();
-            this.merge = true;
-        } else {
-            this.prevText = this.nextText = null;
-            this.merge = false;
-        }
-
-        this.node.detach();
-    },
-    undo: function() {
-        var parent = this.document.getNodeByPath(this.path.slice(0,-1)),
-            idx = _.last(this.path);
-        var inserted = parent.insertAtIndex(this.node, idx);
-        if(this.merge) {
-            if(inserted.next()) {
-                inserted.before({text: this.prevText});
-                inserted.next().setText(this.nextText);
-            } else {
-                inserted.prev().setText(this.prevText);
-                inserted.after({text: this.nextText});
-            }
-        }
-    }
-});
-transformations['detach3'] = Detach3NodeTransformation;
-
-
-var registerTransformationsFromObject = function(object) {
-    _.pairs(object).filter(function(pair) {
-        var property = pair[1];
-        return typeof property === 'function' && property._isTransformation;
-    })
-    .forEach(function(pair) {
-        var name = pair[0],
-            method = pair[1];
-        object.registerTransformation(name, createContextTransformation(method));
-    });
-};
-registerTransformationsFromObject(ElementNode.prototype);
-registerTransformationsFromObject(TextNode.prototype);
-registerTransformationsFromObject(Document.prototype);
-

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


@@ -1025,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