wip: removing console calls
[fnpeditor.git] / src / wlxml / wlxml.js
index 51655d4..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,111 +137,258 @@ $.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.dom).find(':not(iframe)').addBack().contents()
-    .filter(function() {return this.nodeType === Node.TEXT_NODE;})
-    .each(function() {
-        var el = $(this),
-            text = {original: el.text(), trimmed: $.trim(el.text())},
-            elParent = el.parent(),
-            hasSpanParent = elParent.prop('tagName') === 'SPAN',
-            hasSpanBefore = el.prev().length && $(el.prev()).prop('tagName') === 'SPAN',
-            hasSpanAfter = el.next().length && $(el.next()).prop('tagName') === 'SPAN';
-
-
-        var addInfo = function(toAdd, where, transformed, original) {
-            var parentContents = elParent.contents(),
-                idx = parentContents.index(el[0]),
-                prev = idx > 0 ? parentContents[idx-1] : null,
-                next = idx < parentContents.length - 1 ? parentContents[idx+1] : null,
-                target, key;
-
-            if(where === 'above') {
-                target = prev ? $(prev) : elParent;
-                key = prev ? 'orig_after' : 'orig_begin';
-            } else if(where === 'below') {
-                target = next ? $(next) : elParent;
-                key = next ? 'orig_before' : 'orig_end';
-            } else { throw new Object;}
-
-            target.data(formatter_prefix + key, toAdd);
-            if(transformed !== undefined) {
-                target.data(formatter_prefix + key + '_transformed', transformed);
-            }
-            if(original !== undefined) {
-                target.data(formatter_prefix + key + '_original', original);   
-            }
-        }
+    // this.DocumentNodeFactory = function() {
+    //     WLXMLDocumentNode.apply(this, arguments);
+    // };
 
-        text.transformed = text.trimmed;
-
-        if(hasSpanParent || hasSpanBefore || hasSpanAfter) {
-            var startSpace = /\s/g.test(text.original.substr(0,1)),
-                endSpace = /\s/g.test(text.original.substr(-1)) && text.original.length > 1;
-            text.transformed = (startSpace && (hasSpanParent || hasSpanBefore) ? ' ' : '');
-            text.transformed += text.trimmed;
-            text.transformed += (endSpace && (hasSpanParent || hasSpanAfter) ? ' ' : '');
-        } else {
-            if(text.trimmed.length === 0 && text.original.length > 0 && elParent.contents().length === 1) {
-                text.transformed = ' ';
-            }
-        }
-
-        if(!text.transformed) {
-            addInfo(text.original, 'below');
-            el.remove();
-            return true; // continue
-        }
-
-        if(text.transformed !== text.original) {
-            // if(!text.trimmed) {
-            //     addInfo(text.original, 'below');
-            // } else {
-                var startingMatch = text.original.match(/^\s+/g),
-                    endingMatch = text.original.match(/\s+$/g),
-                    startingWhiteSpace = startingMatch ? startingMatch[0] : null,
-                    endingWhiteSpace = endingMatch ? endingMatch[0] : null;
-
-                if(endingWhiteSpace) {
-                    if(text.transformed[text.transformed.length - 1] === ' ' && endingWhiteSpace[0] === ' ')
-                        endingWhiteSpace = endingWhiteSpace.substr(1);
-                    addInfo(endingWhiteSpace, 'below', !text.trimmed ? text.transformed : undefined, !text.trimmed ? text.original : undefined);
-                }
+    // 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();
 
-                if(startingWhiteSpace && text.trimmed) {
-                    if(text.transformed[0] === ' ' && startingWhiteSpace[startingWhiteSpace.length-1] === ' ')
-                        startingWhiteSpace = startingWhiteSpace.substr(0, startingWhiteSpace.length -1);
-                    addInfo(startingWhiteSpace, 'above', !text.trimmed ? text.transformed : undefined, !text.trimmed ? text.original : undefined);
-                }
-            //}
-        }
+    this.TextNodeFactory = function() {
+        smartxml.TextNode.apply(this, arguments);
+    }
+    this.TextNodeFactory.prototype = Object.create(smartxml.TextNode.prototype);
+    this.TextNodeFactory.prototype.transformations = new transformations.TransformationStorage();
 
-        el.replaceWith(document.createTextNode(text.transformed));
-    });
+    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, {silent: true});
+        $(this.dom).find(':not(iframe)').addBack().contents()
+            .filter(function() {return this.nodeType === Node.TEXT_NODE;})
+            .each(function() {
+                var el = $(this),
+                    text = {original: el.text(), trimmed: $.trim(el.text())},
+                    elParent = el.parent(),
+                    hasSpanParent = elParent.prop('tagName') === 'SPAN',
+                    hasSpanBefore = el.prev().length && $(el.prev()).prop('tagName') === 'SPAN',
+                    hasSpanAfter = el.next().length && $(el.next()).prop('tagName') === 'SPAN';
+
+
+                var addInfo = function(toAdd, where, transformed, original) {
+                    var parentContents = elParent.contents(),
+                        idx = parentContents.index(el[0]),
+                        prev = idx > 0 ? parentContents[idx-1] : null,
+                        next = idx < parentContents.length - 1 ? parentContents[idx+1] : null,
+                        target, key;
+
+                    if(where === 'above') {
+                        target = prev ? $(prev) : elParent;
+                        key = prev ? 'orig_after' : 'orig_begin';
+                    } else if(where === 'below') {
+                        target = next ? $(next) : elParent;
+                        key = next ? 'orig_before' : 'orig_end';
+                    } else { throw new Error();}
+
+                    target.data(formatter_prefix + key, toAdd);
+                    if(transformed !== undefined) {
+                        target.data(formatter_prefix + key + '_transformed', transformed);
+                    }
+                    if(original !== undefined) {
+                        target.data(formatter_prefix + key + '_original', original);
+                    }
+                };
+
+                text.transformed = text.trimmed;
+
+                if(hasSpanParent || hasSpanBefore || hasSpanAfter) {
+                    var startSpace = /\s/g.test(text.original.substr(0,1)),
+                        endSpace = /\s/g.test(text.original.substr(-1)) && text.original.length > 1;
+                    text.transformed = (startSpace && (hasSpanParent || hasSpanBefore) ? ' ' : '');
+                    text.transformed += text.trimmed;
+                    text.transformed += (endSpace && (hasSpanParent || hasSpanAfter) ? ' ' : '');
+                } else {
+                    if(text.trimmed.length === 0 && text.original.length > 0 && elParent.contents().length === 1) {
+                        text.transformed = ' ';
+                    }
+                }
+
+                if(!text.transformed) {
+                    addInfo(text.original, 'below');
+                    el.remove();
+                    return true; // continue
+                }
+
+                if(text.transformed !== text.original) {
+                    // if(!text.trimmed) {
+                    //     addInfo(text.original, 'below');
+                    // } else {
+                        var startingMatch = text.original.match(/^\s+/g),
+                            endingMatch = text.original.match(/\s+$/g),
+                            startingWhiteSpace = startingMatch ? startingMatch[0] : null,
+                            endingWhiteSpace = endingMatch ? endingMatch[0] : null;
+
+                        if(endingWhiteSpace) {
+                            if(text.transformed[text.transformed.length - 1] === ' ' && endingWhiteSpace[0] === ' ') {
+                                endingWhiteSpace = endingWhiteSpace.substr(1);
+                            }
+                            addInfo(endingWhiteSpace, 'below', !text.trimmed ? text.transformed : undefined, !text.trimmed ? text.original : undefined);
+                        }
+
+                        if(startingWhiteSpace && text.trimmed) {
+                            if(text.transformed[0] === ' ' && startingWhiteSpace[startingWhiteSpace.length-1] === ' ') {
+                                startingWhiteSpace = startingWhiteSpace.substr(0, startingWhiteSpace.length -1);
+                            }
+                            addInfo(startingWhiteSpace, 'above', !text.trimmed ? text.transformed : undefined, !text.trimmed ? text.original : undefined);
+                        }
+                    //}
+                }
+
+                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