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 4e8e575..8110a97 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');


@@ -43,6 +37,18 @@ 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);


@@ -175,13 +181,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);
         }


@@ -237,12 +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() {
-            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;
     },
 


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


@@ -383,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();
     },


@@ -456,6 +526,53 @@ $.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) {
     return $($.trim(xml))[0];
 };
 var parseXML = function(xml) {
     return $($.trim(xml))[0];
 };


@@ -464,11 +581,15 @@ var Document = function(xml) {
     this.loadXML(xml);
     this.undoStack = [];
     this.redoStack = [];
     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(),

 
     createDocumentNode: function(from) {
         if(!(from instanceof Node)) {
 
     createDocumentNode: function(from) {
         if(!(from instanceof Node)) {


@@ -640,16 +761,27 @@ $.extend(Document.prototype, Backbone.Events, {
         return insertion.ofNode;
     },
 
         return insertion.ofNode;
     },
 

-    transform: function(transformationName, args) {
-        var Transformation = transformations[transformationName],
-            transformation;
-        if(Transformation) {
-            transformation = new Transformation(args);
-            transformation.run();
-            this.undoStack.push(transformation);
+    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 = [];
             this.redoStack = [];

+            return toret;

         } else {
         } else {

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

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


@@ -685,131 +817,20 @@ var defineDocumentProperties = function(doc, $document) {
     }, configurable: true});
 };
 
     }, configurable: true});
 };
 

+Document.prototype.transformations.register(transformations.createContextTransformation({
+    name: 'smartxml.wrapNodes',
+    // init: function() {

 
 

-// 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();
+    // },
+    // getChangeRoot: function() {
+    //     return this.context;
+    // },
+    impl: function(args) {
+        this.wrapNodes(args);

     },
     },

-    undo: function() {
-        this.document.getNodeByPath(this.rootPath).replaceWith(this.oldRoot);
-    }
-});
-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.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;

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


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