wlxml: getParent/isInside takes context roots into account
[fnpeditor.git] / src / smartxml / smartxml.js
index 31faef0..c158bac 100644 (file)
@@ -4,24 +4,36 @@ define([
     '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 */
 
 
+var privateKey = '_smartxml';
+
 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, {
 
+    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);
@@ -38,7 +50,7 @@ $.extend(DocumentNode.prototype, {
         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];
@@ -78,6 +90,14 @@ $.extend(DocumentNode.prototype, {
         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;
     },
@@ -113,22 +133,27 @@ $.extend(DocumentNode.prototype, {
         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)) {
-            if(type === 'nodeMoved') {
-                event.meta.parent = origParent;
-            }
             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);
         }
@@ -139,28 +164,41 @@ $.extend(DocumentNode.prototype, {
     },
 
     getIndex: function() {
+        var parent;
+
         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);
+    $(nativeNode).data(privateKey, {node: this});
 };
 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()));
-            this._$.data(key);
+            this._$.data(arg1);
         }
     },
 
@@ -168,7 +206,9 @@ $.extend(ElementNode.prototype, {
         if(key) {
             return this._$.data(key);
         }
-        return this._$.data();
+        var toret = _.clone(this._$.data());
+        delete toret[privateKey];
+        return toret;
     },
 
     getTagName: function() {
@@ -210,6 +250,32 @@ $.extend(ElementNode.prototype, {
         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());
@@ -224,16 +290,42 @@ $.extend(ElementNode.prototype, {
 
 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,
 
+    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;
     },
 
+
+    containsNode: function() {
+        return false;
+    },
+
     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));
-    if(!toret.length) {
+    if(toret.length !== 1) {
         throw new Error('Unable to parse XML: ' + xml);
     }
     return toret[0];
@@ -291,12 +383,20 @@ var Document = function(xml, extensions) {
     this.loadXML(xml);
 };
 
-$.extend(Document.prototype, Backbone.Events, {
+$.extend(Document.prototype, Backbone.Events, fragments, {
     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);
@@ -479,7 +579,7 @@ $.extend(Document.prototype, Backbone.Events, {
         if(!this._currentTransaction) {
             return this.transaction(function() {
                 return this.transform(Transformation, args);
-            }, this);
+            }, {context: this});
         }
 
         if(typeof Transformation === 'function') {
@@ -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.
-                stopAt = undefined;
                 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.trigger('operationEnd');
         }
     },
     redo: function() {
@@ -553,6 +653,8 @@ $.extend(Document.prototype, Backbone.Events, {
             });
             this._transformationLevel--;
             this.undoStack.push(transaction);
+            this.trigger('operationEnd');
+
         }
     },
 
@@ -570,6 +672,7 @@ $.extend(Document.prototype, Backbone.Events, {
         }
         if(this._currentTransaction.hasTransformations()) {
             this.undoStack.push(this._currentTransaction);
+            this.trigger('operationEnd');
         }
         this._currentTransaction = null;
     },
@@ -581,20 +684,36 @@ $.extend(Document.prototype, Backbone.Events, {
         this.replaceRoot(this._rollbackBackup);
         this._rollbackBackup = null;
         this._currentTransaction = null;
+        this._transformationLevel = 0;
     },
 
-    transaction: function(callback, context, metadata) {
+    transaction: function(callback, params) {
         var toret;
-        this.startTransaction(metadata);
-        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();
+        if(params.success) {
+            params.success(toret);
+        }
         return toret;
     },
 
     getNodeByPath: function(path) {
         var toret = this.root;
-        path.forEach(function(idx) {
+        path.some(function(idx) {
             toret = toret.contents()[idx];
+            if(!toret) {
+                return true;
+            }
         });
         return toret;
     },
@@ -613,6 +732,13 @@ $.extend(Document.prototype, Backbone.Events, {
             }
             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);
     }
 });