editor: canvas - initiate commands transactions via Document.transaction
[fnpeditor.git] / src / wlxml / wlxml.js
index 30a53c5..4f6e356 100644 (file)
 define([
-    'smartxml/smartxml'
-], function(smartxml) {
+    'libs/jquery',
+    'libs/underscore',
+    'smartxml/smartxml',
+    'smartxml/transformations',
+    'wlxml/extensions/metadata/metadata'
+], function($, _, smartxml, transformations, metadataExtension) {
     
 'use strict';
 
-// utils
+/* globals Node */
 
-var isMetaAttribute = function(attrName) {
-    return attrName.substr(0, 5) === 'meta-';
+
+var AttributesList = function() {};
+AttributesList.prototype = Object.create({});
+AttributesList.prototype.keys = function() {
+    return _.keys(this);
+};
+
+var getClassLists = function(klassName) {
+    var toret = [],
+        classParts = [''].concat(klassName.split('.')),
+        classCurrent;
+
+    classParts.forEach(function(part) {
+        classCurrent = classCurrent ? classCurrent + '.' + part : part;
+        toret.push(classCurrent);
+    });
+    return toret;
 };
 
-//
+var installObject = function(instance, klass) {
+    var methods = {},
+        transformations = {};
+
+    getClassLists(klass).forEach(function(klassName) {
+        _.extend(methods, instance.document.classMethods[klassName] || {});
+        _.extend(methods, instance.document.classTransformations[klassName] || {});
+    });
+    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(attrName)}, classDesc.attrs[attrName]);
+                }.bind(this));
             }
-        });
+        }.bind(this));
         return toret;
     },
+    setMetaAttribute: function(key, value) {
+        this.setAttr(key, value);
+    },
     getOtherAttributes: function() {
-        var toret = {};
+        var toret = {},
+            node = this;
         this.getAttrs().forEach(function(attr) {
-            if(attr.name !== 'class' && !isMetaAttribute(attr.name)) {
-                toret[attr.name] = attr.value;
+            if(attr.name !== 'class' && !node.isMetaAttribute(attr.name)) {
+                toret[attr.name] = {value: attr.value};
             }
         });
         return toret;
     },
+    isMetaAttribute: function(attrName) {
+        return attrName !== 'class' &&_.contains(_.keys(this.getMetaAttributes()), attrName);
+    },
 
     _getXMLDOMToDump: function() {
-        var DOM = this._$.clone(true, true);
+        var DOM = this._$.clone(true, true),
+            doc = this.document;
 
         DOM.find('*').addBack().each(function() {
             var el = $(this),
@@ -54,7 +107,7 @@ $.extend(WLXMLElementNode.prototype, smartxml.ElementNode.prototype, {
                 data = el.data();
 
 
-            var txt;
+            var txt, documentNode, metaNode;
 
             if(data[formatter_prefix+ 'orig_before']) {
                 txt = idx > 0 && contents[idx-1].nodeType === Node.TEXT_NODE ? contents[idx-1] : null;
@@ -84,29 +137,79 @@ $.extend(WLXMLElementNode.prototype, smartxml.ElementNode.prototype, {
                     el.append(data[formatter_prefix+ 'orig_end']);
                 }
             }
+
+
+            if(this.nodeType === Node.ELEMENT_NODE) {
+                documentNode = doc.createDocumentNode(this);
+                metaNode = $('<metadata>');
+                documentNode.getMetadata().forEach(function(row) {
+                    metaNode.append('<dc:'+ row.key + '>' + row.value + '</dc:' + row.key + '>');
+                });
+                if(metaNode.children().length) {
+                    $(this).prepend(metaNode);
+                }
+            }
+
         });
 
+        
+
         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 WLXMLDocumentNode = function() {
+    smartxml.DocumentNode.apply(this, arguments);
+};
+WLXMLDocumentNode.prototype = Object.create(smartxml.DocumentNode.prototype);
 
-var WLXMLDocument = function(xml) {
-    smartxml.Document.call(this, xml);
+var WLXMLDocument = function(xml, options) {
+    this.classMethods = {};
+    this.classTransformations = {};
+    smartxml.Document.call(this, xml, [metadataExtension]);
+    this.options = options;
 };
 
 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);
-        $(this.dom).find(':not(iframe)').addBack().contents()
+        smartxml.Document.prototype.loadXML.call(this, xml, {silent: true});
+        this.trigger('contentSet');
+    },
+
+    normalizeXML: function(nativeNode) {
+        var doc = this,
+            prefixLength = 'dc:'.length;
+
+        $(nativeNode).find('metadata').each(function() {
+            var metadataNode = $(this),
+                owner = doc.createDocumentNode(metadataNode.parent()[0]),
+                metadata = owner.getMetadata();
+                
+            metadataNode.children().each(function() {
+                metadata.add({key: (this.tagName).toLowerCase().substr(prefixLength), value: $(this).text()}, {undoable: false});
+            });
+            metadataNode.remove();
+        });
+        nativeNode.normalize();
+
+        $(nativeNode).find(':not(iframe)').addBack().contents()
             .filter(function() {return this.nodeType === Node.TEXT_NODE;})
             .each(function() {
                 var el = $(this),
@@ -130,7 +233,7 @@ $.extend(WLXMLDocument.prototype, {
                     } else if(where === 'below') {
                         target = next ? $(next) : elParent;
                         key = next ? 'orig_before' : 'orig_end';
-                    } else { throw new Object;}
+                    } else { throw new Error();}
 
                     target.data(formatter_prefix + key, toAdd);
                     if(transformed !== undefined) {
@@ -139,7 +242,7 @@ $.extend(WLXMLDocument.prototype, {
                     if(original !== undefined) {
                         target.data(formatter_prefix + key + '_original', original);
                     }
-                }
+                };
 
                 text.transformed = text.trimmed;
 
@@ -171,30 +274,78 @@ $.extend(WLXMLDocument.prototype, {
                             endingWhiteSpace = endingMatch ? endingMatch[0] : null;
 
                         if(endingWhiteSpace) {
-                            if(text.transformed[text.transformed.length - 1] === ' ' && endingWhiteSpace[0] === ' ')
+                            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] === ' ')
+                            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);
                         }
                     //}
                 }
-
+                /* 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() {
+            var nodeInstance = this;
+            var args = Array.prototype.slice.call(arguments, 0);
+            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 = {
+    'link': {
+        attrs: {href: {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) {