smartxml: some helper functions

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

diff --git a/src/smartxml/smartxml.js b/src/smartxml/smartxml.js
index 2d0e09f..749d4f4 100644 (file)
--- a/src/smartxml/smartxml.js
+++ b/src/smartxml/smartxml.js
@@ -1,150 +1,715 @@
 define([
 define([

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

     
 'use strict';
     
 'use strict';

+/* globals Node */

 
 
 
 

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

 
 

-var parseXML = function(xml) {
-    return $(xml)[0];

 };
 
 };
 

-var Document = function(nativeNode) {
-    var $document = $(nativeNode);
+$.extend(DocumentNode.prototype, {

 
 

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

 
 

-    Object.defineProperty(this, 'root', {get: function() { return new ElementNode($document[0]);}});
-};
+    _setNativeNode: function(nativeNode) {
+        this.nativeNode = nativeNode;
+        this._$ = $(nativeNode);
+    },

 
 

+    clone: function() {
+        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]);
+    },

 
 

-var DocumentNode = function(nativeNode) {
-    this.nativeNode = nativeNode;
-    this._$ = $(nativeNode);
-};
+    getPath: function(ancestor) {
+        if(!(this.document.containsNode(this))) {
+            return null;
+        }

 
 

-$.extend(DocumentNode.prototype, {
-    detach: function() { this._$.detach(); },
+        var nodePath = [this].concat(this.parents()),
+            toret, idx;
+        ancestor = ancestor || this.document.root;
+
+        nodePath.some(function(node, i) {
+            if(node.sameNode(ancestor)) {
+                idx = i;
+                return true;
+            }
+        });
+
+        if(idx !== undefined) {
+            nodePath = nodePath.slice(0, idx);
+        }
+        toret = nodePath.map(function(node) {return node.getIndex(); });
+        toret.reverse();
+        return toret;
+    },
+
+    isRoot: function() {
+        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) {
 
     sameNode: function(otherNode) {

-        return this.nativeNode === otherNode.nativeNode;
+        return !!(otherNode) && this.nativeNode === otherNode.nativeNode;
+    },
+
+    parent: function() {
+        var parentNode = this.nativeNode.parentNode;
+        if(parentNode && parentNode.nodeType === Node.ELEMENT_NODE) {
+            return this.document.createDocumentNode(parentNode);
+        }
+        return null;
+    },
+
+    parents: function() {
+        var parent = this.parent(),
+            parents = parent ? parent.parents() : [];
+        if(parent) {
+            parents.unshift(parent);
+        }
+        return parents;
+    },
+
+    prev: function() {
+        var myIdx = this.getIndex();
+        return myIdx > 0 ? this.parent().contents()[myIdx-1] : null;
+    },
+
+    next: function() {
+        if(this.isRoot()) {
+            return null;
+        }
+        var myIdx = this.getIndex(),
+            parentContents = this.parent().contents();
+        return myIdx < parentContents.length - 1 ? parentContents[myIdx+1] : null;
+    },
+
+    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) {
+             event = new events.ChangeEvent('nodeDetached', {node: node, parent: origParent});
+             this.document.trigger('change', event);
+        }
+    },
+    
+    getNodeInsertion: function(node) {
+        return this.document.getNodeInsertion(node);
+    },
+
+    getIndex: function() {
+        if(this.isRoot()) {
+            return 0;
+        }
+        return this.parent().indexOf(this);
+    },
+
+    getNearestElementNode: function() {
+        return this.nodeType === Node.ELEMENT_NODE ? this : this.parent();

     }
 });
 
     }
 });
 

-var ElementNode = function(nativeNode) {
-    DocumentNode.apply(this, arguments);
+
+var ElementNode = function(nativeNode, document) {
+    DocumentNode.call(this, nativeNode, document);

 };
 };

+ElementNode.prototype = Object.create(DocumentNode.prototype);

 
 

-$.extend(ElementNode.prototype, DocumentNode.prototype, {
+$.extend(ElementNode.prototype, {

     nodeType: Node.ELEMENT_NODE,
 
     nodeType: Node.ELEMENT_NODE,
 

+    setData: function(key, value) {
+        if(value !== undefined) {
+            this._$.data(key, value);
+        } else {
+            this._$.removeData(_.keys(this._$.data()));
+            this._$.data(key);
+        }
+    },
+
+    getData: function(key) {
+        if(key) {
+            return this._$.data(key);
+        }
+        return this._$.data();
+    },
+

     getTagName: function() {
         return this.nativeNode.tagName.toLowerCase();
     },
 
     getTagName: function() {
         return this.nativeNode.tagName.toLowerCase();
     },
 

-    append: function(documentNode) {
-        this._$.append(documentNode.nativeNode);
+    contents: function(selector) {
+        var toret = [],
+            document = this.document;
+        if(selector) {
+            this._$.children(selector).each(function() {
+                toret.push(document.createDocumentNode(this));
+            });
+        } else {
+            this._$.contents().each(function() {
+                toret.push(document.createDocumentNode(this));
+            });
+        }
+        return toret;
+    },
+
+    indexOf: function(node) {
+        return this._$.contents().index(node._$);

     },
 
     },
 

-    before: function(node) {
-        this._$.before(node.nativeNode);
+    getAttr: function(name) {
+        return this._$.attr(name);

     },
 
     },
 

-    contents: function() {
+    getAttrs: function() {

         var toret = [];
         var toret = [];

-        this._$.contents().each(function() {
-            if(this.nodeType === Node.ELEMENT_NODE)
-                toret.push(new ElementNode(this));
-            else if(this.nodeType === Node.TEXT_NODE)
-                toret.push(new TextNode(this));
+        for(var i = 0; i < this.nativeNode.attributes.length; i++) {
+            toret.push(this.nativeNode.attributes[i]);
+        }
+        return toret;
+    },
+
+    containsNode: function(node) {
+        return node && (node.nativeNode === this.nativeNode || node._$.parents().index(this._$) !== -1);
+    },
+
+    getLastTextNode: function() {
+        var contents = this.contents(),
+            toret;
+
+        contents.reverse().some(function(node) {
+            if(node.nodeType === Node.TEXT_NODE) {
+                toret = node;
+                return true;
+            }
+            toret = node.getLastTextNode();
+            return !!toret;

         });
         });

+

         return toret;
     },
 
         return toret;
     },
 

-    indexOf: function(node) {
-        return this._$.contents().index(node._$);
+    toXML: function() {
+        var wrapper = $('<div>');
+        wrapper.append(this._getXMLDOMToDump());
+        return wrapper.html();

     },
     },

+    
+    _getXMLDOMToDump: function() {
+        return this._$;
+    }
+});

 
 

-    parent: function() {
-        return new ElementNode(this._$.parent());
+
+var TextNode = function(nativeNode, document) {
+    DocumentNode.call(this, nativeNode, document);
+};
+TextNode.prototype = Object.create(DocumentNode.prototype);
+
+$.extend(TextNode.prototype, {
+    nodeType: Node.TEXT_NODE,
+
+    getText: function() {
+        return this.nativeNode.data;

     },
 
     },
 

-    unwrapContent: function() {
-        var parent = this.parent();
-        if(!parent)
-            return;

 
 

-        var parentContents = parent.contents(),
-            myContents = this.contents(),
-            myIdx = parent.indexOf(this);
+    containsNode: function() {
+        return false;
+    },
+
+    triggerTextChangeEvent: function() {
+        var event = new events.ChangeEvent('nodeTextChange', {node: this});
+        this.document.trigger('change', event);
+    }
+});

 
 

-        if(myContents.length === 0)
-            return this.detach();

 
 

-        var moveLeftRange, moveRightRange, leftMerged;
+var parseXML = function(xml) {
+    var toret = $($.trim(xml));
+    if(!toret.length) {
+        throw new Error('Unable to parse XML: ' + xml);
+    }
+    return toret[0];

 
 

-        if(myIdx > 0 && (parentContents[myIdx-1].nodeType === TEXT_NODE) && (myContents[0].nodeType === TEXT_NODE)) {
-            parentContents[myIdx-1].appendText(myContents[0].getText());
-            myContents[0].detach();
-            moveLeftRange = true;
-            leftMerged = true;
+};
+
+var registerTransformation = function(desc, name, target) {
+    var Transformation = transformations.createContextTransformation(desc, name);
+    target[name] = function() {
+        var instance = this,
+            args = Array.prototype.slice.call(arguments, 0);
+        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, extensions) {
+    this.undoStack = [];
+    this.redoStack = [];
+    this._currentTransaction = null;
+    this._transformationLevel = 0;
+    
+    this._nodeMethods = {};
+    this._textNodeMethods = {};
+    this._elementNodeMethods = {};
+    this._nodeTransformations = {};
+    this._textNodeTransformations = {};
+    this._elementNodeTransformations = {};
+    
+    this.registerExtension(coreTransformations);
+
+    (extensions || []).forEach(function(extension) {
+        this.registerExtension(extension);
+    }.bind(this));
+    this.loadXML(xml);
+};
+
+$.extend(Document.prototype, Backbone.Events, fragments, {
+    ElementNodeFactory: ElementNode,
+    TextNodeFactory: TextNode,
+
+    createDocumentNode: function(from) {
+        if(!(from instanceof Node)) {
+            if(typeof from === 'string') {
+                from = parseXML(from);
+                this.normalizeXML(from);
+            } else {
+                if(from.text !== undefined) {
+                    /* globals document */
+                    from = document.createTextNode(from.text);
+                } else {
+                    if(!from.tagName) {
+                        throw new Error('tagName missing');
+                    }
+                    var node = $('<' + from.tagName + '>');
+
+                    _.keys(from.attrs || {}).forEach(function(key) {
+                        node.attr(key, from.attrs[key]);
+                    });
+
+                    from = node[0];
+                }
+            }
+        }
+        var Factory, typeMethods, typeTransformations;
+        if(from.nodeType === Node.TEXT_NODE) {
+            Factory = this.TextNodeFactory;
+            typeMethods = this._textNodeMethods;
+            typeTransformations = this._textNodeTransformations;
+        } else if(from.nodeType === Node.ELEMENT_NODE) {
+            Factory = this.ElementNodeFactory;
+            typeMethods = this._elementNodeMethods;
+            typeTransformations = this._elementNodeTransformations;
+        }
+        var toret = new Factory(from, this);
+        _.extend(toret, this._nodeMethods);
+        _.extend(toret, typeMethods);
+        
+        _.extend(toret, this._nodeTransformations);
+        _.extend(toret, typeTransformations);
+        
+        toret.__super__ = _.extend({}, this._nodeMethods, this._nodeTransformations);
+        _.keys(toret.__super__).forEach(function(key) {
+            toret.__super__[key] = _.bind(toret.__super__[key], toret);
+        });
+
+        return toret;
+    },
+
+    loadXML: function(xml, options) {
+        options = options || {};
+        this._defineDocumentProperties($(parseXML(xml)));
+        this.normalizeXML(this.dom);
+        if(!options.silent) {
+            this.trigger('contentSet');
+        }
+    },
+
+    normalizeXML: function(nativeNode) {
+        void(nativeNode); // noop
+    },
+
+    toXML: function() {
+        return this.root.toXML();
+    },
+
+    containsNode: function(node) {
+        return this.root && this.root.containsNode(node);
+    },
+
+    getSiblingParents: function(params) {
+        var parents1 = [params.node1].concat(params.node1.parents()).reverse(),
+            parents2 = [params.node2].concat(params.node2.parents()).reverse(),
+            noSiblingParents = null;
+
+        if(parents1.length === 0 || parents2.length === 0 || !(parents1[0].sameNode(parents2[0]))) {
+            return noSiblingParents;
+        }
+
+        var stop = Math.min(parents1.length, parents2.length),
+            i;
+        for(i = 0; i < stop; i++) {
+            if(parents1[i].sameNode(parents2[i])) {
+                continue;
+            }
+            break;
+        }
+        if(i === stop) {
+            i--;
+        }
+        return {node1: parents1[i], node2: parents2[i]};
+    },
+
+    trigger: function() {
+        Backbone.Events.trigger.apply(this, arguments);
+    },
+
+    getNodeInsertion: function(node) {
+        var insertion = {};
+        if(node instanceof DocumentNode) {
+            insertion.ofNode = node;
+            insertion.insertsNew = !this.containsNode(node);

         } else {
         } else {

-            leftMerged = false;
+          insertion.ofNode = this.createDocumentNode(node);
+          insertion.insertsNew = true;

         }
         }

+        return insertion;
+    },
+
+    registerMethod: function(methodName, method, dstName) {
+        var doc = this;
+        var destination = {
+            document: doc,
+            documentNode: doc._nodeMethods,
+            textNode: doc._textNodeMethods,
+            elementNode: doc._elementNodeMethods
+        }[dstName];
+        registerMethod(methodName, method, destination);
+    },
+
+    registerTransformation: function(desc, name, dstName) {
+        var doc = this;
+        var destination = {
+            document: doc,
+            documentNode: doc._nodeTransformations,
+            textNode: doc._textNodeTransformations,
+            elementNode: doc._elementNodeTransformations
+        }[dstName];
+        registerTransformation(desc, name, destination);
+    },
+
+    registerExtension: function(extension) {
+        var doc = this;
+
+        ['document', 'documentNode', 'elementNode', 'textNode'].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];
+
+                        doc.registerMethod(methodName, method, dstName);
+
+                    });
+                }
+
+                if(dstExtension.transformations) {
+                    _.pairs(dstExtension.transformations).forEach(function(pair) {
+                        var name = pair[0],
+                            desc = pair[1];
+                        doc.registerTransformation(desc, name, dstName);
+                    });
+                }
+            }
+        });
+    },

 
 

-        if(!(leftMerged && myContents.length === 1)) {
-            if(myIdx < parentContents.length - 1 && (parentContents[myIdx+1].nodeType === TEXT_NODE) && (myContents[myContents.length-1].nodeType === TEXT_NODE)) {
-                parentContents[myIdx+1].prependText(myContents[myContents.length-1].getText());
-                myContents[myContents.length-1].detach();
-                moveRightRange = true;
+    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);

             }
         }
             }
         }

+    },

 
 

-        var childrenLength = this.contents().length;
-        this.contents().forEach(function(child) {
-            this.before(child);
-        }.bind(this));
+    transform: function(Transformation, args) {
+        var toret, transformation;

 
 

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

 
 

-        return {
-            element1: parent.contents()[myIdx + (moveLeftRange ? -1 : 0)],
-            element2: parent.contents()[myIdx + childrenLength-1 + (moveRightRange ? 1 : 0)]
-        };
-    }
+        if(typeof Transformation === 'function') {
+            transformation = new Transformation(this, this, args);
+        } else {
+            transformation = Transformation;
+        }
+        if(transformation) {
+            this._transformationLevel++;
+            
+            this.ifChanged(
+                this,
+                function() {
+                    toret = transformation.run({beUndoable:this._transformationLevel === 1});
+                },
+                function() {
+                    if(this._transformationLevel === 1 && !this._undoInProgress) {
+                        this._currentTransaction.pushTransformation(transformation);
+                        this.redoStack = [];
+                    }
+                }
+            );
+
+            this._transformationLevel--;
+            return toret;
+        } else {
+            throw new Error('Transformation ' + transformation + ' doesn\'t exist!');
+        }
+    },
+    undo: function() {
+        var transaction = this.undoStack.pop(),
+            doc = this,
+            transformations, stopAt;
+
+        if(transaction) {
+            this._undoInProgress = true;
+
+            // 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.
+                stopAt = undefined;
+                transformations.some(function(t, idx) {
+                    if(!t.undo && t.getChangeRoot().sameNode(doc.root)) {
+                        stopAt = idx;
+                        return true; //break
+                    }
+                });
+                if(stopAt !== undefined) {
+                    // We will get away with undoing only this transformations as the one at stopAt reverses the whole document.
+                    transformations = transformations.slice(0, stopAt+1);
+                }
+            }

 
 

-});
+            transformations.reverse();
+            transformations.forEach(function(t) {
+                t.undo();
+            });

 
 

-var TextNode = function(nativeNode) {
-    DocumentNode.apply(this, arguments);
-};
+            this._undoInProgress = false;
+            this.redoStack.push(transaction);
+            this.trigger('operationEnd');
+        }
+    },
+    redo: function() {
+        var transaction = this.redoStack.pop();
+        if(transaction) {
+            this._transformationLevel++;
+            transaction.transformations.forEach(function(t) {
+                t.run({beUndoable: true});
+            });
+            this._transformationLevel--;
+            this.undoStack.push(transaction);
+            this.trigger('operationEnd');

 
 

-$.extend(TextNode.prototype, DocumentNode.prototype, {
-    nodeType: Node.TEXT_NODE,
+        }
+    },

 
 

-    getText: function() {
-        return this.nativeNode.data;
+    startTransaction: function(metadata) {
+        if(this._currentTransaction) {
+            throw new Error('Nested transactions not supported!');
+        }
+        this._rollbackBackup = this.root.clone();
+        this._currentTransaction = new Transaction([], metadata);
+    },
+
+    endTransaction: function() {
+        if(!this._currentTransaction) {
+            throw new Error('End of transaction requested, but there is no transaction in progress!');
+        }
+        if(this._currentTransaction.hasTransformations()) {
+            this.undoStack.push(this._currentTransaction);
+            this.trigger('operationEnd');
+        }
+        this._currentTransaction = null;

     },
 
     },
 

-    appendText: function(text) {
-        this.nativeNode.data = this.nativeNode.data + text;
+    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;

     },
 
     },
 

-    prependText: function(text) {
-        this.nativeNode.data = text + this.nativeNode.data;
+    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) {
+        var toret = this.root;
+        path.forEach(function(idx) {
+            toret = toret.contents()[idx];
+        });
+        return toret;
+    },
+
+    _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() {
+            if(!$document) {
+                return null;
+            }
+            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;

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

-        return new Document(parseXML(xml));
+        var doc = new Document(xml);
+        return doc;

     },
 
     elementNodeFromXML: function(xml) {
     },
 
     elementNodeFromXML: function(xml) {

-        return new ElementNode(parseXML(xml));
-    }
+        return this.documentFromXML(xml).root;
+    },
+
+    Document: Document,
+    DocumentNode: DocumentNode,
+    ElementNode: ElementNode,
+    TextNode: TextNode

 };
 
 });
\ No newline at end of file
 };
 
 });
\ No newline at end of file