smartxml: throw exception on transformation returning invalid change root

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

diff --git a/src/wlxml/wlxml.js b/src/wlxml/wlxml.js
index 0f6fa20..b3783af 100644 (file)
--- a/src/wlxml/wlxml.js
+++ b/src/wlxml/wlxml.js
@@ -1,9 +1,14 @@
 define([
-    'smartxml/smartxml'
-], function(smartxml) {
+    'libs/jquery',
+    'libs/underscore',
+    'smartxml/smartxml',
+    'smartxml/transformations'
+], function($, _, smartxml, transformations) {
     
 'use strict';
 
+/* globals Node */
+
 // utils
 
 var isMetaAttribute = function(attrName) {
@@ -12,27 +17,60 @@ var isMetaAttribute = function(attrName) {
 
 //
 
+var AttributesList = function() {};
+AttributesList.prototype = Object.create({});
+AttributesList.prototype.keys = function() {
+    return _.keys(this);
+};
+
+var installObject = function(instance, klass) {
+    var methods = instance.document.classMethods[klass] || {},
+        transformations = instance.document.classTransformations[klass] || {};
+
+    instance.object = Object.create(_.extend({}, methods, transformations));
+    _.keys(methods).concat(_.keys(transformations)).forEach(function(key) {
+        instance.object[key] = _.bind(instance.object[key], instance);
+    });
+};
+
 var WLXMLElementNode = function(nativeNode, document) {
     smartxml.ElementNode.call(this, nativeNode, document);
+    installObject(this, this.getClass());
 };
 WLXMLElementNode.prototype = Object.create(smartxml.ElementNode.prototype);
 
 $.extend(WLXMLElementNode.prototype, smartxml.ElementNode.prototype, {
     getClass: function() {
-        return this.getAttr('class');
+        return this.getAttr('class') || '';
     },
     setClass: function(klass) {
-        return this.setAttr('class', klass);
+        if(klass !== this.klass) {
+            installObject(this, klass);
+            return this.setAttr('class', klass);
+        }
+    },
+    is: function(klass) {
+        return this.getClass().substr(0, klass.length) === klass;
     },
     getMetaAttributes: function() {
-        var toret = [];
-        this.getAttrs().forEach(function(attr) {
-            if(isMetaAttribute(attr.name)) {
-                toret.push({name: attr.name.substr(5), value: attr.value});
+        var toret = new AttributesList(),
+            classParts = [''].concat(this.getClass().split('.')),
+            classCurrent, classDesc;
+
+        classParts.forEach(function(part) {
+            classCurrent = classCurrent ? classCurrent + '.' + part : part;
+            classDesc = this.document.options.wlxmlClasses[classCurrent];
+            if(classDesc) {
+                _.keys(classDesc.attrs).forEach(function(attrName) {
+                    toret[attrName] = _.extend({value: this.getAttr('meta-' + attrName)}, classDesc.attrs[attrName]);
+                }.bind(this));
             }
-        });
+        }.bind(this));
         return toret;
     },
+    setMetaAttribute: function(key, value) {
+        this.setAttr('meta-'+key, value);
+    },
     getOtherAttributes: function() {
         var toret = {};
         this.getAttrs().forEach(function(attr) {
@@ -90,22 +128,39 @@ $.extend(WLXMLElementNode.prototype, smartxml.ElementNode.prototype, {
     }
 });
 
+// WLXMLElementNode.prototype.transformations.register(transformations.createContextTransformation({
+//     name: 'wlxml.setMetaAttribute',
+//     impl: function(args) {
+//         this.setMetaAttribute(args.name, args.value);
+//     },
+//     getChangeRoot: function() {
+//         return this.context;
+//     }
+// }));
 
 
 
+var WLXMLDocumentNode = function() {
+    smartxml.DocumentNode.apply(this, arguments);
+};
+WLXMLDocumentNode.prototype = Object.create(smartxml.DocumentNode.prototype);
 
-var WLXMLDocument = function(xml) {
+var WLXMLDocument = function(xml, options) {
     smartxml.Document.call(this, xml);
+    this.options = options;
+
+    this.classMethods = {};
+    this.classTransformations = {};
 };
 
 var formatter_prefix = '_wlxml_formatter_';
 
+
 WLXMLDocument.prototype = Object.create(smartxml.Document.prototype);
 $.extend(WLXMLDocument.prototype, {
     ElementNodeFactory: WLXMLElementNode,
-
     loadXML: function(xml) {
-        smartxml.Document.prototype.loadXML.call(this, xml);
+        smartxml.Document.prototype.loadXML.call(this, xml, {silent: true});
         $(this.dom).find(':not(iframe)').addBack().contents()
             .filter(function() {return this.nodeType === Node.TEXT_NODE;})
             .each(function() {
@@ -185,18 +240,62 @@ $.extend(WLXMLDocument.prototype, {
                         }
                     //}
                 }
-
+                /* globals document */
                 el.replaceWith(document.createTextNode(text.transformed));
             });
         this.trigger('contentSet');
+    },
+
+    registerClassTransformation: function(Transformation, className) {
+        var thisClassTransformations = (this.classTransformations[className] = this.classTransformations[className] || {});
+        thisClassTransformations[Transformation.prototype.name] = function(args) {
+            var nodeInstance = this;
+            return nodeInstance.transform(Transformation, args);
+        };
+    },
+
+    registerClassMethod: function(methodName, method, className) {
+        var thisClassMethods = (this.classMethods[className] = this.classMethods[className] || {});
+        thisClassMethods[methodName] = method;
+    },
+
+    registerExtension: function(extension) {
+        //debugger;
+        smartxml.Document.prototype.registerExtension.call(this, extension);
+        var doc = this;
+
+        _.pairs(extension.wlxmlClass).forEach(function(pair) {
+            var className = pair[0],
+                classExtension = pair[1];
+
+            _.pairs(classExtension.methods || {}).forEach(function(pair) {
+                var name = pair[0],
+                    method = pair[1];
+                doc.registerClassMethod(name, method, className);
+            });
+
+            _.pairs(classExtension.transformations || {}).forEach(function(pair) {
+                var name = pair[0],
+                    desc = pair[1];
+                doc.registerClassTransformation(transformations.createContextTransformation(desc, name), className);
+            });
+        });
+
     }
 
 });
 
+var wlxmlClasses = {
+    'uri': {
+        attrs: {uri: {type: 'string'}}
+    }
+};
+
 
 return {
-    WLXMLDocumentFromXML: function(xml) {
-        return new WLXMLDocument(xml);
+    WLXMLDocumentFromXML: function(xml, options) {
+        options = _.extend({wlxmlClasses: wlxmlClasses}, options);
+        return new WLXMLDocument(xml, options);
     },
 
     WLXMLElementNodeFromXML: function(xml) {