wlxml: extending isInside/getParent/is to support tag name

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

diff --git a/src/smartxml/smartxml.js b/src/smartxml/smartxml.js
index acbe04d..08897cc 100644 (file)
--- a/src/smartxml/smartxml.js
+++ b/src/smartxml/smartxml.js
@@ -4,8 +4,9 @@ define([
     'libs/backbone',
     'smartxml/events',
     'smartxml/transformations',
     'libs/backbone',
     'smartxml/events',
     'smartxml/transformations',

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

     
 'use strict';
 /* globals Node */
     
 'use strict';
 /* globals Node */


@@ -33,7 +34,20 @@ $.extend(DocumentNode.prototype, {
     },
 
     clone: function() {
     },
 
     clone: function() {

-        var clone = this._$.clone(true, true);
+        var clone = this._$.clone(true, true),
+            node = this;
+        clone.find('*').addBack().each(function() {
+            var el = this,
+                clonedData = $(this).data();
+
+            _.pairs(clonedData).forEach(function(pair) {
+                var key = pair[0],
+                    value = pair[1];
+                if(_.isFunction(value.clone)) {
+                    clonedData[key] = value.clone(node.document.createDocumentNode(el));
+                }
+            });
+        });

         return this.document.createDocumentNode(clone[0]);
     },
 
         return this.document.createDocumentNode(clone[0]);
     },
 


@@ -53,7 +67,7 @@ $.extend(DocumentNode.prototype, {
             }
         });
 
             }
         });
 

-        if(idx !== 'undefined') {
+        if(idx !== undefined) {

             nodePath = nodePath.slice(0, idx);
         }
         toret = nodePath.map(function(node) {return node.getIndex(); });
             nodePath = nodePath.slice(0, idx);
         }
         toret = nodePath.map(function(node) {return node.getIndex(); });


@@ -65,6 +79,10 @@ $.extend(DocumentNode.prototype, {
         return this.document.root.sameNode(this);
     },
 
         return this.document.root.sameNode(this);
     },
 

+    isSiblingOf: function(node) {
+        return node && this.parent().sameNode(node.parent());
+    },
+

     sameNode: function(otherNode) {
         return !!(otherNode) && this.nativeNode === otherNode.nativeNode;
     },
     sameNode: function(otherNode) {
         return !!(otherNode) && this.nativeNode === otherNode.nativeNode;
     },


@@ -110,6 +128,9 @@ $.extend(DocumentNode.prototype, {
         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)) {
         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)) {

+            if(type === 'nodeMoved') {
+                event.meta.parent = origParent;
+            }

             this.document.trigger('change', event);
         }
         if((type === 'nodeAdded' || type === 'nodeMoved') && !this.document.containsNode(this) && nodeWasContained) {
             this.document.trigger('change', event);
         }
         if((type === 'nodeAdded' || type === 'nodeMoved') && !this.document.containsNode(this) && nodeWasContained) {


@@ -127,6 +148,10 @@ $.extend(DocumentNode.prototype, {
             return 0;
         }
         return this.parent().indexOf(this);
             return 0;
         }
         return this.parent().indexOf(this);

+    },
+
+    getNearestElementNode: function() {
+        return this.nodeType === Node.ELEMENT_NODE ? this : this.parent();

     }
 });
 
     }
 });
 


@@ -190,6 +215,10 @@ $.extend(ElementNode.prototype, {
         return toret;
     },
 
         return toret;
     },
 

+    containsNode: function(node) {
+        return node && (node.nativeNode === this.nativeNode || node._$.parents().index(this._$) !== -1);
+    },
+

     toXML: function() {
         var wrapper = $('<div>');
         wrapper.append(this._getXMLDOMToDump());
     toXML: function() {
         var wrapper = $('<div>');
         wrapper.append(this._getXMLDOMToDump());


@@ -250,11 +279,10 @@ var registerMethod = function(methodName, method, target) {
 };
 
 
 };
 
 

-var Document = function(xml) {
-    this.loadXML(xml);
+var Document = function(xml, extensions) {

     this.undoStack = [];
     this.redoStack = [];
     this.undoStack = [];
     this.redoStack = [];

-    this._transactionStack = [];
+    this._currentTransaction = null;

     this._transformationLevel = 0;
     
     this._nodeMethods = {};
     this._transformationLevel = 0;
     
     this._nodeMethods = {};


@@ -265,9 +293,14 @@ var Document = function(xml) {
     this._elementNodeTransformations = {};
     
     this.registerExtension(coreTransformations);
     this._elementNodeTransformations = {};
     
     this.registerExtension(coreTransformations);

+
+    (extensions || []).forEach(function(extension) {
+        this.registerExtension(extension);
+    }.bind(this));
+    this.loadXML(xml);

 };
 
 };
 

-$.extend(Document.prototype, Backbone.Events, {
+$.extend(Document.prototype, Backbone.Events, fragments, {

     ElementNodeFactory: ElementNode,
     TextNodeFactory: TextNode,
 
     ElementNodeFactory: ElementNode,
     TextNodeFactory: TextNode,
 


@@ -337,7 +370,7 @@ $.extend(Document.prototype, Backbone.Events, {
     },
 
     containsNode: function(node) {
     },
 
     containsNode: function(node) {

-        return this.root && (node.nativeNode === this.root.nativeNode || node._$.parents().index(this.root._$) !== -1);
+        return this.root && this.root.containsNode(node);

     },
 
     getSiblingParents: function(params) {
     },
 
     getSiblingParents: function(params) {


@@ -349,13 +382,17 @@ $.extend(Document.prototype, Backbone.Events, {
             return noSiblingParents;
         }
 
             return noSiblingParents;
         }
 

-        var i;
-        for(i = 0; i < Math.min(parents1.length, parents2.length); i++) {
+        var stop = Math.min(parents1.length, parents2.length),
+            i;
+        for(i = 0; i < stop; i++) {

             if(parents1[i].sameNode(parents2[i])) {
                 continue;
             }
             break;
         }
             if(parents1[i].sameNode(parents2[i])) {
                 continue;
             }
             break;
         }

+        if(i === stop) {
+            i--;
+        }

         return {node1: parents1[i], node2: parents2[i]};
     },
 
         return {node1: parents1[i], node2: parents2[i]};
     },
 


@@ -424,9 +461,36 @@ $.extend(Document.prototype, Backbone.Events, {
         });
     },
 
         });
     },
 

+    ifChanged: function(context, action, documentChangedHandler, documentUnchangedHandler) {
+        var hasChanged = false,
+            changeMonitor = function() {
+                hasChanged = true;
+            };
+
+        this.on('change', changeMonitor);
+        action.call(context);
+        this.off('change', changeMonitor);
+        
+        if(hasChanged) {
+            if(documentChangedHandler) {
+                documentChangedHandler.call(context);
+            }
+        } else {
+            if(documentUnchangedHandler) {
+                documentUnchangedHandler.call(context);
+            }
+        }
+    },
+

     transform: function(Transformation, args) {
         var toret, transformation;
 
     transform: function(Transformation, args) {
         var toret, transformation;
 

+        if(!this._currentTransaction) {
+            return this.transaction(function() {
+                return this.transform(Transformation, args);
+            }, {context: this});
+        }
+

         if(typeof Transformation === 'function') {
             transformation = new Transformation(this, this, args);
         } else {
         if(typeof Transformation === 'function') {
             transformation = new Transformation(this, this, args);
         } else {


@@ -434,17 +498,20 @@ $.extend(Document.prototype, Backbone.Events, {
         }
         if(transformation) {
             this._transformationLevel++;
         }
         if(transformation) {
             this._transformationLevel++;

-            toret = transformation.run({beUndoable:this._transformationLevel === 1});
-            if(this._transformationLevel === 1 && !this._undoInProgress) {
-                if(this._transactionInProgress) {
-                    this._transactionStack.push(transformation);
-                } else {
-                    this.undoStack.push(transformation);
+            
+            this.ifChanged(
+                this,
+                function() {
+                    toret = transformation.run({beUndoable:this._transformationLevel === 1});
+                },
+                function() {
+                    if(this._transformationLevel === 1 && !this._undoInProgress) {
+                        this._currentTransaction.pushTransformation(transformation);
+                        this.redoStack = [];
+                    }

                 }
                 }

-            }
-            if(!this._undoInProgress && this._transformationLevel === 1) {
-                this.redoStack = [];
-            }
+            );
+

             this._transformationLevel--;
             return toret;
         } else {
             this._transformationLevel--;
             return toret;
         } else {


@@ -452,20 +519,15 @@ $.extend(Document.prototype, Backbone.Events, {
         }
     },
     undo: function() {
         }
     },
     undo: function() {

-        var transformationObject = this.undoStack.pop(),
+        var transaction = this.undoStack.pop(),

             doc = this,
             transformations, stopAt;
 
             doc = this,
             transformations, stopAt;
 

-        if(transformationObject) {
+        if(transaction) {

             this._undoInProgress = true;
 
             this._undoInProgress = true;
 

-            if(_.isArray(transformationObject)) {
-                // We will modify this array in a minute so make sure we work on a copy.
-                transformations = transformationObject.slice(0);
-            } else {
-                // Lets normalize single transformation to a transaction containing one transformation.
-                transformations = [transformationObject];
-            }
+            // We will modify this array in a minute so make sure we work on a copy.
+            transformations = transaction.transformations.slice(0);

 
             if(transformations.length > 1) {
                 // In case of real transactions we don't want to run undo on all of transformations if we don't have to.
 
             if(transformations.length > 1) {
                 // In case of real transactions we don't want to run undo on all of transformations if we don't have to.


@@ -488,39 +550,71 @@ $.extend(Document.prototype, Backbone.Events, {
             });
 
             this._undoInProgress = false;
             });
 
             this._undoInProgress = false;

-            this.redoStack.push(transformationObject);
+            this.redoStack.push(transaction);
+            this.trigger('operationEnd');

         }
     },
     redo: function() {
         }
     },
     redo: function() {

-        var transformationObject = this.redoStack.pop(),
-            transformations;
-        if(transformationObject) {
+        var transaction = this.redoStack.pop();
+        if(transaction) {

             this._transformationLevel++;
             this._transformationLevel++;

-            transformations = _.isArray(transformationObject) ? transformationObject : [transformationObject];
-            transformations.forEach(function(t) {
+            transaction.transformations.forEach(function(t) {

                 t.run({beUndoable: true});
             });
             this._transformationLevel--;
                 t.run({beUndoable: true});
             });
             this._transformationLevel--;

-            this.undoStack.push(transformationObject);
+            this.undoStack.push(transaction);
+            this.trigger('operationEnd');
+

         }
     },
 
         }
     },
 

-    startTransaction: function() {
-        if(this._transactionInProgress) {
+    startTransaction: function(metadata) {
+        if(this._currentTransaction) {

             throw new Error('Nested transactions not supported!');
         }
             throw new Error('Nested transactions not supported!');
         }

-        this._transactionInProgress = true;
+        this._rollbackBackup = this.root.clone();
+        this._currentTransaction = new Transaction([], metadata);

     },
 
     endTransaction: function() {
     },
 
     endTransaction: function() {

-        if(!this._transactionInProgress) {
+        if(!this._currentTransaction) {

             throw new Error('End of transaction requested, but there is no transaction in progress!');
         }
             throw new Error('End of transaction requested, but there is no transaction in progress!');
         }

-        this._transactionInProgress = false;
-        if(this._transactionStack.length) {
-            this.undoStack.push(this._transactionStack);
-            this._transactionStack = [];
+        if(this._currentTransaction.hasTransformations()) {
+            this.undoStack.push(this._currentTransaction);
+            this.trigger('operationEnd');

         }
         }

+        this._currentTransaction = null;
+    },
+
+    rollbackTransaction: function() {
+        if(!this._currentTransaction) {
+            throw new Error('Transaction rollback requested, but there is no transaction in progress!');
+        }
+        this.replaceRoot(this._rollbackBackup);
+        this._rollbackBackup = null;
+        this._currentTransaction = null;
+        this._transformationLevel = 0;
+    },
+
+    transaction: function(callback, params) {
+        var toret;
+        params = params || {};
+        this.startTransaction(params.metadata);
+        try {
+            toret = callback.call(params.context || this);
+        } catch(e) {
+            if(params.error) {
+                params.error(e);
+            }
+            this.rollbackTransaction();
+            return;
+        }
+        this.endTransaction();
+        if(params.success) {
+            params.success(toret);
+        }
+        return toret;

     },
 
     getNodeByPath: function(path) {
     },
 
     getNodeByPath: function(path) {


@@ -534,11 +628,37 @@ $.extend(Document.prototype, Backbone.Events, {
     _defineDocumentProperties: function($document) {
         var doc = this;
         Object.defineProperty(doc, 'root', {get: function() {
     _defineDocumentProperties: function($document) {
         var doc = this;
         Object.defineProperty(doc, 'root', {get: function() {

+            if(!$document) {
+                return null;
+            }

             return doc.createDocumentNode($document[0]);
         }, configurable: true});
         Object.defineProperty(doc, 'dom', {get: function() {
             return doc.createDocumentNode($document[0]);
         }, configurable: true});
         Object.defineProperty(doc, 'dom', {get: function() {

+            if(!$document) {
+                return null;
+            }

             return $document[0];
         }, configurable: true});
             return $document[0];
         }, configurable: true});

+    },
+
+    createFragment: function(Type, params) {
+        if(!Type.prototype instanceof fragments.Fragment) {
+            throw new Error('Can\'t create a fragment: `Type` is not a valid Fragment');
+        }
+        return new Type(this, params);
+    }
+});
+
+var Transaction = function(transformations, metadata) {
+    this.transformations = transformations || [];
+    this.metadata = metadata;
+};
+$.extend(Transaction.prototype, {
+    pushTransformation: function(transformation) {
+        this.transformations.push(transformation);
+    },
+    hasTransformations: function() {
+        return this.transformations.length > 0;

     }
 });
 
     }
 });