add comments

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

diff --git a/src/smartxml/smartxml.js b/src/smartxml/smartxml.js
index ab4d6fb..c158bac 100644 (file)
--- a/src/smartxml/smartxml.js
+++ b/src/smartxml/smartxml.js
@@ -4,24 +4,36 @@ 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 */
 
 

+var privateKey = '_smartxml';
+

 var DocumentNode = function(nativeNode, document) {
     if(!document) {
         throw new Error('undefined document for a node');
     }
     this.document = document;
 var DocumentNode = function(nativeNode, document) {
     if(!document) {
         throw new Error('undefined document for a node');
     }
     this.document = document;

+    this.object = {};

     this._setNativeNode(nativeNode);
 
 };
 
 $.extend(DocumentNode.prototype, {
 
     this._setNativeNode(nativeNode);
 
 };
 
 $.extend(DocumentNode.prototype, {
 

+    getProperty: function(propName) {
+        var toret = this.object[propName];
+        if(toret && _.isFunction(toret)) {
+            toret = toret.call(this);
+        }
+        return toret;
+    },
+

     transform: function(Transformation, args) {
         var transformation = new Transformation(this.document, this, args);
         return this.document.transform(transformation);
     transform: function(Transformation, args) {
         var transformation = new Transformation(this.document, this, args);
         return this.document.transform(transformation);


@@ -38,7 +50,7 @@ $.extend(DocumentNode.prototype, {
         clone.find('*').addBack().each(function() {
             var el = this,
                 clonedData = $(this).data();
         clone.find('*').addBack().each(function() {
             var el = this,
                 clonedData = $(this).data();

-
+            $(el).removeData(privateKey);

             _.pairs(clonedData).forEach(function(pair) {
                 var key = pair[0],
                     value = pair[1];
             _.pairs(clonedData).forEach(function(pair) {
                 var key = pair[0],
                     value = pair[1];


@@ -78,6 +90,14 @@ $.extend(DocumentNode.prototype, {
         return this.document.root.sameNode(this);
     },
 
         return this.document.root.sameNode(this);
     },
 

+    isInDocument: function() {
+        return this.document.containsNode(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;
     },


@@ -113,22 +133,27 @@ $.extend(DocumentNode.prototype, {
         return myIdx < parentContents.length - 1 ? parentContents[myIdx+1] : null;
     },
 
         return myIdx < parentContents.length - 1 ? parentContents[myIdx+1] : null;
     },
 

-    isSurroundedByTextElements: function() {
-        var prev = this.prev(),
-            next = this.next();
-        return prev && (prev.nodeType === Node.TEXT_NODE) && next && (next.nodeType === Node.TEXT_NODE);
+    isSurroundedByTextNodes: function() {
+        return this.isPrecededByTextNode() && this.isFollowedByTextNode();
+    },
+
+    isPrecededByTextNode: function() {
+        var prev = this.prev();
+        return prev && prev.nodeType === Node.TEXT_NODE;
+    },
+
+    isFollowedByTextNode: function() {
+        var next = this.next();
+        return next && next.nodeType === Node.TEXT_NODE;

     },
 
     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)) {
     },
 
     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)) {

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

             this.document.trigger('change', event);
         }
             this.document.trigger('change', event);
         }

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


@@ -139,28 +164,41 @@ $.extend(DocumentNode.prototype, {
     },
 
     getIndex: function() {
     },
 
     getIndex: function() {

+        var parent;
+

         if(this.isRoot()) {
             return 0;
         }
         if(this.isRoot()) {
             return 0;
         }

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

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

+    $(nativeNode).data(privateKey, {node: this});

 };
 ElementNode.prototype = Object.create(DocumentNode.prototype);
 
 $.extend(ElementNode.prototype, {
     nodeType: Node.ELEMENT_NODE,
 
 };
 ElementNode.prototype = Object.create(DocumentNode.prototype);
 
 $.extend(ElementNode.prototype, {
     nodeType: Node.ELEMENT_NODE,
 

-    setData: function(key, value) {
-        if(value !== undefined) {
-            this._$.data(key, value);
+    setData: function(arg1, arg2) {
+        if(arguments.length === 2) {
+            if(_.isUndefined(arg2)) {
+                this._$.removeData(arg1);
+            } else {
+                this._$.data(arg1, arg2);
+            }

         } else {
             this._$.removeData(_.keys(this._$.data()));
         } else {
             this._$.removeData(_.keys(this._$.data()));

-            this._$.data(key);
+            this._$.data(arg1);

         }
     },
 
         }
     },
 


@@ -168,7 +206,9 @@ $.extend(ElementNode.prototype, {
         if(key) {
             return this._$.data(key);
         }
         if(key) {
             return this._$.data(key);
         }

-        return this._$.data();
+        var toret = _.clone(this._$.data());
+        delete toret[privateKey];
+        return toret;

     },
 
     getTagName: function() {
     },
 
     getTagName: function() {


@@ -210,6 +250,32 @@ $.extend(ElementNode.prototype, {
         return node && (node.nativeNode === this.nativeNode || node._$.parents().index(this._$) !== -1);
     },
 
         return node && (node.nativeNode === this.nativeNode || node._$.parents().index(this._$) !== -1);
     },
 

+    getFirstTextNode: function() {
+        return this._getTextNode('first');
+    },
+
+    getLastTextNode: function() {
+        return this._getTextNode('last');
+    },
+
+    _getTextNode: function(which) {
+        var contents = this.contents(),
+            toret;
+        if(which === 'last') {
+            contents = contents.reverse();
+        }
+        contents.some(function(node) {
+            if(node.nodeType === Node.TEXT_NODE) {
+                toret = node;
+                return true;
+            }
+            toret = node.getLastTextNode();
+            return !!toret;
+        });
+
+        return toret;
+    },
+

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


@@ -224,16 +290,42 @@ $.extend(ElementNode.prototype, {
 
 var TextNode = function(nativeNode, document) {
     DocumentNode.call(this, nativeNode, document);
 
 var TextNode = function(nativeNode, document) {
     DocumentNode.call(this, nativeNode, document);

+    this._data = Object.create({});
+    nativeNode.__smartxmlTextNodeInstance = this;

 };
 TextNode.prototype = Object.create(DocumentNode.prototype);
 
 $.extend(TextNode.prototype, {
     nodeType: Node.TEXT_NODE,
 
 };
 TextNode.prototype = Object.create(DocumentNode.prototype);
 
 $.extend(TextNode.prototype, {
     nodeType: Node.TEXT_NODE,
 

+    setData: function(arg1, arg2) {
+        if(arguments.length === 2) {
+            if(_.isUndefined(arg2)) {
+                delete this._data[arg1];
+            } else {
+                this._data[arg1] = arg2;
+            }
+        } else {
+            this._data = _.extend({}, arg1);
+        }
+    },
+
+    getData: function(key) {
+        if(key) {
+            return this._data[key];
+        }
+        return this._data;
+    },
+

     getText: function() {
         return this.nativeNode.data;
     },
 
     getText: function() {
         return this.nativeNode.data;
     },
 

+
+    containsNode: function() {
+        return false;
+    },
+

     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);


@@ -243,7 +335,7 @@ $.extend(TextNode.prototype, {
 
 var parseXML = function(xml) {
     var toret = $($.trim(xml));
 
 var parseXML = function(xml) {
     var toret = $($.trim(xml));

-    if(!toret.length) {
+    if(toret.length !== 1) {

         throw new Error('Unable to parse XML: ' + xml);
     }
     return toret[0];
         throw new Error('Unable to parse XML: ' + xml);
     }
     return toret[0];


@@ -291,12 +383,20 @@ var Document = function(xml, extensions) {
     this.loadXML(xml);
 };
 
     this.loadXML(xml);
 };
 

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

     ElementNodeFactory: ElementNode,
     TextNodeFactory: TextNode,
 
     createDocumentNode: function(from) {
     ElementNodeFactory: ElementNode,
     TextNodeFactory: TextNode,
 
     createDocumentNode: function(from) {

-        if(!(from instanceof Node)) {
+        var cached;
+
+        if(from instanceof Node) {
+            /* globals Text */
+            cached = from instanceof Text ? from.__smartxmlTextNodeInstance : ($(from).data(privateKey) || {}).node;
+            if(cached instanceof DocumentNode) {
+                return cached;
+            }
+        } else {

             if(typeof from === 'string') {
                 from = parseXML(from);
                 this.normalizeXML(from);
             if(typeof from === 'string') {
                 from = parseXML(from);
                 this.normalizeXML(from);


@@ -476,6 +576,12 @@ $.extend(Document.prototype, Backbone.Events, {
     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 {


@@ -491,13 +597,7 @@ $.extend(Document.prototype, Backbone.Events, {
                 },
                 function() {
                     if(this._transformationLevel === 1 && !this._undoInProgress) {
                 },
                 function() {
                     if(this._transformationLevel === 1 && !this._undoInProgress) {

-                        if(this._currentTransaction) {
-                            this._currentTransaction.pushTransformation(transformation);
-                        } else {
-                            this.undoStack.push(new Transaction([transformation]));
-                        }
-                    }
-                    if(!this._undoInProgress && this._transformationLevel === 1) {
+                        this._currentTransaction.pushTransformation(transformation);

                         this.redoStack = [];
                     }
                 }
                         this.redoStack = [];
                     }
                 }


@@ -522,7 +622,6 @@ $.extend(Document.prototype, Backbone.Events, {
 
             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.

-                stopAt = undefined;

                 transformations.some(function(t, idx) {
                     if(!t.undo && t.getChangeRoot().sameNode(doc.root)) {
                         stopAt = idx;
                 transformations.some(function(t, idx) {
                     if(!t.undo && t.getChangeRoot().sameNode(doc.root)) {
                         stopAt = idx;


@@ -542,6 +641,7 @@ $.extend(Document.prototype, Backbone.Events, {
 
             this._undoInProgress = false;
             this.redoStack.push(transaction);
 
             this._undoInProgress = false;
             this.redoStack.push(transaction);

+            this.trigger('operationEnd');

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


@@ -553,14 +653,17 @@ $.extend(Document.prototype, Backbone.Events, {
             });
             this._transformationLevel--;
             this.undoStack.push(transaction);
             });
             this._transformationLevel--;
             this.undoStack.push(transaction);

+            this.trigger('operationEnd');
+

         }
     },
 
         }
     },
 

-    startTransaction: function() {
+    startTransaction: function(metadata) {

         if(this._currentTransaction) {
             throw new Error('Nested transactions not supported!');
         }
         if(this._currentTransaction) {
             throw new Error('Nested transactions not supported!');
         }

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

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


@@ -569,22 +672,48 @@ $.extend(Document.prototype, Backbone.Events, {
         }
         if(this._currentTransaction.hasTransformations()) {
             this.undoStack.push(this._currentTransaction);
         }
         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._currentTransaction = null;

+        this._transformationLevel = 0;

     },
 
     },
 

-    transaction: function(callback, context) {
+    transaction: function(callback, params) {

         var toret;
         var toret;

-        this.startTransaction();
-        toret = callback.call(context);
+        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();
         this.endTransaction();

+        if(params.success) {
+            params.success(toret);
+        }

         return toret;
     },
 
     getNodeByPath: function(path) {
         var toret = this.root;
         return toret;
     },
 
     getNodeByPath: function(path) {
         var toret = this.root;

-        path.forEach(function(idx) {
+        path.some(function(idx) {

             toret = toret.contents()[idx];
             toret = toret.contents()[idx];

+            if(!toret) {
+                return true;
+            }

         });
         return toret;
     },
         });
         return toret;
     },


@@ -603,11 +732,19 @@ $.extend(Document.prototype, Backbone.Events, {
             }
             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) {
+var Transaction = function(transformations, metadata) {

     this.transformations = transformations || [];
     this.transformations = transformations || [];

+    this.metadata = metadata;

 };
 $.extend(Transaction.prototype, {
     pushTransformation: function(transformation) {
 };
 $.extend(Transaction.prototype, {
     pushTransformation: function(transformation) {