wip: removing console calls
[fnpeditor.git] / src / wlxml / wlxml.js
index 0f6fa20..ee85a03 100644 (file)
@@ -1,6 +1,9 @@
 define([
-    'smartxml/smartxml'
-], function(smartxml) {
+    'libs/jquery',
+    'libs/underscore',
+    'smartxml/smartxml',
+    'smartxml/transformations'
+], function($, _, smartxml, transformations) {
     
 'use strict';
 
@@ -12,27 +15,71 @@ 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];
+    if(methods) {
+        instance.object = Object.create(_.extend({
+            transform: function(name, args) {
+                // TODO: refactor with DocumentElement.transform
+                var Transformation = instance.document.classTransformations[klass].get(name),
+                    transformation;
+                if(Transformation) {
+                    transformation = new Transformation(instance.document, instance, args);
+                }
+                return instance.document.transform(transformation);
+            }
+        }, methods));
+        _.keys(methods).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);
+        var methods, object;
+        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 +137,57 @@ $.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.DocumentNodeFactory = function() {
+    //     WLXMLDocumentNode.apply(this, arguments);
+    // };
+
+    // this.DocumentNodeFactory.prototype = Object.create(WLXMLDocumentNode.prototype);    
+    
+    this.ElementNodeFactory = function() {
+        WLXMLElementNode.apply(this, arguments);
+    }
+    this.ElementNodeFactory.prototype = Object.create(WLXMLElementNode.prototype);
+    this.ElementNodeFactory.prototype.transformations = new transformations.TransformationStorage();
+
+    this.TextNodeFactory = function() {
+        smartxml.TextNode.apply(this, arguments);
+    }
+    this.TextNodeFactory.prototype = Object.create(smartxml.TextNode.prototype);
+    this.TextNodeFactory.prototype.transformations = new transformations.TransformationStorage();
+
+    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() {
@@ -189,19 +271,124 @@ $.extend(WLXMLDocument.prototype, {
                 el.replaceWith(document.createTextNode(text.transformed));
             });
         this.trigger('contentSet');
+    },
+
+    registerExtension: function(extension) {
+        //debugger;
+        var doc = this,
+            existingPropertyName = _.values(this);
+
+        [
+            {source: extension.document, target: doc},
+            {source: extension.documentNode, target: [doc.ElementNodeFactory.prototype, doc.TextNodeFactory.prototype]},
+
+        ].forEach(function(x) {
+            if(x.source && x.source.methods) {
+                existingPropertyName = _.values(x.target)
+                _.pairs(x.source.methods).forEach(function(pair) {
+                    var methodName = pair[0],
+                        method = pair[1],
+                        targets = _.isArray(x.target) ? x.target : [x.target];
+                    if(_.contains(existingPropertyName, methodName)) {
+                        throw new Error('Cannot extend XXX with method name {methodName}. Name already exists.'.replace('{methodName}', methodName));
+                    }
+                    targets.forEach(function(target) {
+                        target[methodName] = method;
+                    });
+                    
+                });   
+            }
+        });
+
+
+        var getTrans = function(desc, methodName) {
+            if(typeof desc === 'function') {
+                desc = {impl: desc};
+            }
+            if(!desc.impl) {
+                throw new Error('Got transformation description without implementation.')
+            }
+            desc.name = desc.name || methodName;
+            return desc;
+        };
+
+        if(extension.document && extension.document.transformations) {
+            _.pairs(extension.document.transformations).forEach(function(pair) {
+                var transformation = getTrans(pair[1], pair[0]);
+                doc.transformations.register(transformations.createContextTransformation(transformation));
+            });   
+        }
+
+        if(extension.documentNode && extension.documentNode.transformations) {
+            _.pairs(extension.documentNode.transformations).forEach(function(pair) {
+                var transformation = getTrans(pair[1], pair[0]);
+                
+                doc.ElementNodeFactory.prototype.transformations.register(transformations.createContextTransformation(transformation));
+                doc.TextNodeFactory.prototype.transformations.register(transformations.createContextTransformation(transformation));
+            });   
+        }
+
+        _.pairs(extension.wlxmlClass).forEach(function(pair) {
+            var className = pair[0],
+                classExtension = pair[1],
+                thisClassMethods = (doc.classMethods[className] = doc.classMethods[className] || {}),
+                thisClassTransformations = (doc.classTransformations[className] = doc.classTransformations[className] || new transformations.TransformationStorage());
+    
+            _.extend(thisClassMethods, classExtension.methods || {}); //@ warning/throw on override?
+            
+
+            _.pairs(classExtension.transformations || {}).forEach(function(pair) {
+                var transformation = getTrans(pair[1], pair[0]);
+                thisClassTransformations.register(transformations.createContextTransformation(transformation));
+            }); 
+        });
+
     }
 
 });
 
+var wlxmlClasses = {
+    'uri': {
+        attrs: {uri: {type: 'string'}}
+    }
+};
+
+var classMethods = {};
 
 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) {
         return this.WLXMLDocumentFromXML(xml).root;
+    },
+
+    registerExtension: function(extension) {
+        // @@ depracated
+        if(extension.documentTransformations) {
+            extension.documentTransformations.forEach(function(method) {
+                WLXMLDocument.prototype.transformations.register(transformations.createContextTransformation(method));
+            });
+        }
+
+        _.pairs(extension.classMethods).forEach(function(pair) {
+            var className = pair[0],
+                methods = pair[1];
+            _.pairs(methods).forEach(function(pair) {
+                var methodName = pair[0],
+                    method = pair[1];
+                classMethods[className] = classMethods[className] || {};
+                classMethods[className][methodName] = method;
+            });
+            
+        });
+
+        _.extend(WLXMLDocument.prototype, extension.documentMethods);
+
     }
+
 };
 
 });
\ No newline at end of file