wip: refactoring method/transformation registration out of wlxml.js to smartxml ...
[fnpeditor.git] / src / wlxml / wlxml.js
index 4af5e48..7c5207a 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,47 +15,355 @@ var isMetaAttribute = function(attrName) {
 
 //
 
-var WLXMLElementNode = function(nativeNode) {
-    smartxml.ElementNode.call(this, nativeNode);
+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] || instance.document.classTransformations;
+    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) {
+        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))
-                meta[attr.name.substr(5)] = 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) {
-            if(attr.name != 'class' && !isMetaAttribute(attr.name))
+            if(attr.name !== 'class' && !isMetaAttribute(attr.name)) {
                 toret[attr.name] = attr.value;
+            }
         });
         return toret;
+    },
+
+    _getXMLDOMToDump: function() {
+        var DOM = this._$.clone(true, true);
+
+        DOM.find('*').addBack().each(function() {
+            var el = $(this),
+                parent = el.parent(),
+                contents = parent.contents(),
+                idx = contents.index(el),
+                data = el.data();
+
+
+            var txt;
+
+            if(data[formatter_prefix+ 'orig_before']) {
+                txt = idx > 0 && contents[idx-1].nodeType === Node.TEXT_NODE ? contents[idx-1] : null;
+                if(txt && txt.data === data[formatter_prefix + 'orig_before_transformed']) {
+                    txt.data = data[formatter_prefix+ 'orig_before_original'];
+                } else {
+                    el.before(data[formatter_prefix+ 'orig_before']);
+                }
+            }
+            if(data[formatter_prefix+ 'orig_after']) {
+                txt = idx < contents.length-1 && contents[idx+1].nodeType === Node.TEXT_NODE ? contents[idx+1] : null;
+                if(txt && txt.data === data[formatter_prefix + 'orig_after_transformed']) {
+                    txt.data = data[formatter_prefix+ 'orig_after_original'];
+                } else {
+                    el.after(data[formatter_prefix+ 'orig_after']);
+                }
+            }
+            if(data[formatter_prefix+ 'orig_begin']) {
+                el.prepend(data[formatter_prefix+ 'orig_begin']);
+            }
+            if(data[formatter_prefix+ 'orig_end']) {
+                contents = el.contents();
+                txt = (contents.length && contents[contents.length-1].nodeType === Node.TEXT_NODE) ? contents[contents.length-1] : null;
+                if(txt && txt.data === data[formatter_prefix + 'orig_end_transformed']) {
+                    txt.data = data[formatter_prefix+ 'orig_end_original'];
+                } else {
+                    el.append(data[formatter_prefix+ 'orig_end']);
+                }
+            }
+        });
+
+        return DOM;
     }
 });
 
+// WLXMLElementNode.prototype.transformations.register(transformations.createContextTransformation({
+//     name: 'wlxml.setMetaAttribute',
+//     impl: function(args) {
+//         this.setMetaAttribute(args.name, args.value);
+//     },
+//     getChangeRoot: function() {
+//         return this.context;
+//     }
+// }));
 
-var WLXMLDocument = function(xml) {
+
+
+var WLXMLDocumentNode = function() {
+    smartxml.DocumentNode.apply(this, arguments);
+}
+WLXMLDocumentNode.prototype = Object.create(smartxml.DocumentNode.prototype);
+
+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
+    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');
+    },
+
+    registerClassTransformation: function(Transformation, className) {
+        var thisClassTransformations = (this.classTransformations[className] = this.classTransformations[className] || new transformations.TransformationStorage());
+        return thisClassTransformations.register(Transformation);
+    },
+
+    registerClassMethod: function(methodName, method, className) {
+        var thisClassMethods = (this.classMethods[className] = this.classMethods[className] || {});
+        thisClassMethods[methodName] = method;
+    },
+
+    registerExtension: function(extension) {
+        //debugger;
+        var doc = this,
+            existingPropertyNames = _.values(this);
+
+        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;
+        };
+
+        [
+            {source: extension.document, target: doc},
+            {source: extension.documentNode, target: [doc.ElementNodeFactory.prototype, doc.TextNodeFactory.prototype]},
+
+        ].forEach(function(mapping) {
+            if(mapping.source) {
+                if(mapping.source.methods) {
+                    existingPropertyNames = _.values(mapping.target)
+                    _.pairs(mapping.source.methods).forEach(function(pair) {
+                        var methodName = pair[0],
+                            method = pair[1],
+                            targets = _.isArray(mapping.target) ? mapping.target : [mapping.target];
+                        if(_.contains(existingPropertyNames, methodName)) {
+                            throw new Error('Cannot extend {target} with method name {methodName}. Name already exists.'
+                                .replace('{target}', mapping.target)
+                                .replace('{methodName}', methodName)
+                            );
+                        }
+                        targets.forEach(function(target) {
+                            if(target === doc) {
+                                target.registerMethod(methodName, method);
+                            } else {
+                                doc.registerNodeMethod(methodName, method);
+                            }
+
+                        });
+                    });
+                }
+
+                if(mapping.source.transformations) {
+                    _.pairs(mapping.source.transformations).forEach(function(pair) {
+                        var transformation = getTrans(pair[1], pair[0]),
+                            targets = _.isArray(mapping.target) ? mapping.target : [mapping.target];
+                        targets.forEach(function(target) {
+                            if(target === doc) {
+                                target.registerTransformation(transformations.createContextTransformation(transformation));    
+                            } else {
+                                doc.registerNodeTransformation(transformations.createContextTransformation(transformation));
+                            }
+
+                            
+                        });
+                    });
+                }
+            }
+        });
+
+        _.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 transformation = getTrans(pair[1], pair[0]);
+                doc.registerClassTransformation(transformations.createContextTransformation(transformation), 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) {
+        return this.WLXMLDocumentFromXML(xml).root;
+    }
 };
 
 });
\ No newline at end of file