b560982fd875b036fa5e482b76a3d59e399182e4
[fnpeditor.git] / src / wlxml / wlxml.js
1 define([
2     'libs/jquery',
3     'libs/underscore',
4     'smartxml/smartxml',
5     'smartxml/transformations'
6 ], function($, _, smartxml, transformations) {
7     
8 'use strict';
9
10 // utils
11
12 var isMetaAttribute = function(attrName) {
13     return attrName.substr(0, 5) === 'meta-';
14 };
15
16 //
17
18 var AttributesList = function() {};
19 AttributesList.prototype = Object.create({});
20 AttributesList.prototype.keys = function() {
21     return _.keys(this);
22 };
23
24 var installObject = function(instance, klass) {
25     var methods = instance.document.classMethods[klass] || instance.document.classTransformations;
26     if(methods) {
27         instance.object = Object.create(_.extend({
28             transform: function(name, args) {
29                 // TODO: refactor with DocumentElement.transform
30                 var Transformation = instance.document.classTransformations[klass].get(name),
31                     transformation;
32                 if(Transformation) {
33                     transformation = new Transformation(instance.document, instance, args);
34                 }
35                 return instance.document.transform(transformation);
36             }
37         }, methods));
38         _.keys(methods).forEach(function(key) {
39             instance.object[key] = _.bind(instance.object[key], instance);
40         });
41     }
42 }
43
44 var WLXMLElementNode = function(nativeNode, document) {
45     smartxml.ElementNode.call(this, nativeNode, document);
46     installObject(this, this.getClass());
47 };
48 WLXMLElementNode.prototype = Object.create(smartxml.ElementNode.prototype);
49
50 $.extend(WLXMLElementNode.prototype, smartxml.ElementNode.prototype, {
51     getClass: function() {
52         return this.getAttr('class') || '';
53     },
54     setClass: function(klass) {
55         var methods, object;
56         if(klass !== this.klass) {
57             installObject(this, klass);
58             return this.setAttr('class', klass);
59         }
60     },
61     is: function(klass) {
62         return this.getClass().substr(0, klass.length) === klass;
63     },
64     getMetaAttributes: function() {
65         var toret = new AttributesList(),
66             classParts = [''].concat(this.getClass().split('.')),
67             classCurrent, classDesc;
68
69         classParts.forEach(function(part) {
70             classCurrent = classCurrent ? classCurrent + '.' + part : part;
71             classDesc = this.document.options.wlxmlClasses[classCurrent];
72             if(classDesc) {
73                 _.keys(classDesc.attrs).forEach(function(attrName) {
74                     toret[attrName] = _.extend({value: this.getAttr('meta-' + attrName)}, classDesc.attrs[attrName]);
75                 }.bind(this));
76             }
77         }.bind(this));
78         return toret;
79     },
80     setMetaAttribute: function(key, value) {
81         this.setAttr('meta-'+key, value);
82     },
83     getOtherAttributes: function() {
84         var toret = {};
85         this.getAttrs().forEach(function(attr) {
86             if(attr.name !== 'class' && !isMetaAttribute(attr.name)) {
87                 toret[attr.name] = attr.value;
88             }
89         });
90         return toret;
91     },
92
93     _getXMLDOMToDump: function() {
94         var DOM = this._$.clone(true, true);
95
96         DOM.find('*').addBack().each(function() {
97             var el = $(this),
98                 parent = el.parent(),
99                 contents = parent.contents(),
100                 idx = contents.index(el),
101                 data = el.data();
102
103
104             var txt;
105
106             if(data[formatter_prefix+ 'orig_before']) {
107                 txt = idx > 0 && contents[idx-1].nodeType === Node.TEXT_NODE ? contents[idx-1] : null;
108                 if(txt && txt.data === data[formatter_prefix + 'orig_before_transformed']) {
109                     txt.data = data[formatter_prefix+ 'orig_before_original'];
110                 } else {
111                     el.before(data[formatter_prefix+ 'orig_before']);
112                 }
113             }
114             if(data[formatter_prefix+ 'orig_after']) {
115                 txt = idx < contents.length-1 && contents[idx+1].nodeType === Node.TEXT_NODE ? contents[idx+1] : null;
116                 if(txt && txt.data === data[formatter_prefix + 'orig_after_transformed']) {
117                     txt.data = data[formatter_prefix+ 'orig_after_original'];
118                 } else {
119                     el.after(data[formatter_prefix+ 'orig_after']);
120                 }
121             }
122             if(data[formatter_prefix+ 'orig_begin']) {
123                 el.prepend(data[formatter_prefix+ 'orig_begin']);
124             }
125             if(data[formatter_prefix+ 'orig_end']) {
126                 contents = el.contents();
127                 txt = (contents.length && contents[contents.length-1].nodeType === Node.TEXT_NODE) ? contents[contents.length-1] : null;
128                 if(txt && txt.data === data[formatter_prefix + 'orig_end_transformed']) {
129                     txt.data = data[formatter_prefix+ 'orig_end_original'];
130                 } else {
131                     el.append(data[formatter_prefix+ 'orig_end']);
132                 }
133             }
134         });
135
136         return DOM;
137     }
138 });
139
140 // WLXMLElementNode.prototype.transformations.register(transformations.createContextTransformation({
141 //     name: 'wlxml.setMetaAttribute',
142 //     impl: function(args) {
143 //         this.setMetaAttribute(args.name, args.value);
144 //     },
145 //     getChangeRoot: function() {
146 //         return this.context;
147 //     }
148 // }));
149
150
151
152 var WLXMLDocumentNode = function() {
153     smartxml.DocumentNode.apply(this, arguments);
154 }
155 WLXMLDocumentNode.prototype = Object.create(smartxml.DocumentNode.prototype);
156
157 var WLXMLDocument = function(xml, options) {
158     smartxml.Document.call(this, xml);
159     this.options = options;
160
161     this.classMethods = {};
162     this.classTransformations = {};
163 };
164
165 var formatter_prefix = '_wlxml_formatter_';
166
167
168 WLXMLDocument.prototype = Object.create(smartxml.Document.prototype);
169 $.extend(WLXMLDocument.prototype, {
170     ElementNodeFactory: WLXMLElementNode,
171     loadXML: function(xml) {
172         smartxml.Document.prototype.loadXML.call(this, xml, {silent: true});
173         $(this.dom).find(':not(iframe)').addBack().contents()
174             .filter(function() {return this.nodeType === Node.TEXT_NODE;})
175             .each(function() {
176                 var el = $(this),
177                     text = {original: el.text(), trimmed: $.trim(el.text())},
178                     elParent = el.parent(),
179                     hasSpanParent = elParent.prop('tagName') === 'SPAN',
180                     hasSpanBefore = el.prev().length && $(el.prev()).prop('tagName') === 'SPAN',
181                     hasSpanAfter = el.next().length && $(el.next()).prop('tagName') === 'SPAN';
182
183
184                 var addInfo = function(toAdd, where, transformed, original) {
185                     var parentContents = elParent.contents(),
186                         idx = parentContents.index(el[0]),
187                         prev = idx > 0 ? parentContents[idx-1] : null,
188                         next = idx < parentContents.length - 1 ? parentContents[idx+1] : null,
189                         target, key;
190
191                     if(where === 'above') {
192                         target = prev ? $(prev) : elParent;
193                         key = prev ? 'orig_after' : 'orig_begin';
194                     } else if(where === 'below') {
195                         target = next ? $(next) : elParent;
196                         key = next ? 'orig_before' : 'orig_end';
197                     } else { throw new Error();}
198
199                     target.data(formatter_prefix + key, toAdd);
200                     if(transformed !== undefined) {
201                         target.data(formatter_prefix + key + '_transformed', transformed);
202                     }
203                     if(original !== undefined) {
204                         target.data(formatter_prefix + key + '_original', original);
205                     }
206                 };
207
208                 text.transformed = text.trimmed;
209
210                 if(hasSpanParent || hasSpanBefore || hasSpanAfter) {
211                     var startSpace = /\s/g.test(text.original.substr(0,1)),
212                         endSpace = /\s/g.test(text.original.substr(-1)) && text.original.length > 1;
213                     text.transformed = (startSpace && (hasSpanParent || hasSpanBefore) ? ' ' : '');
214                     text.transformed += text.trimmed;
215                     text.transformed += (endSpace && (hasSpanParent || hasSpanAfter) ? ' ' : '');
216                 } else {
217                     if(text.trimmed.length === 0 && text.original.length > 0 && elParent.contents().length === 1) {
218                         text.transformed = ' ';
219                     }
220                 }
221
222                 if(!text.transformed) {
223                     addInfo(text.original, 'below');
224                     el.remove();
225                     return true; // continue
226                 }
227
228                 if(text.transformed !== text.original) {
229                     // if(!text.trimmed) {
230                     //     addInfo(text.original, 'below');
231                     // } else {
232                         var startingMatch = text.original.match(/^\s+/g),
233                             endingMatch = text.original.match(/\s+$/g),
234                             startingWhiteSpace = startingMatch ? startingMatch[0] : null,
235                             endingWhiteSpace = endingMatch ? endingMatch[0] : null;
236
237                         if(endingWhiteSpace) {
238                             if(text.transformed[text.transformed.length - 1] === ' ' && endingWhiteSpace[0] === ' ') {
239                                 endingWhiteSpace = endingWhiteSpace.substr(1);
240                             }
241                             addInfo(endingWhiteSpace, 'below', !text.trimmed ? text.transformed : undefined, !text.trimmed ? text.original : undefined);
242                         }
243
244                         if(startingWhiteSpace && text.trimmed) {
245                             if(text.transformed[0] === ' ' && startingWhiteSpace[startingWhiteSpace.length-1] === ' ') {
246                                 startingWhiteSpace = startingWhiteSpace.substr(0, startingWhiteSpace.length -1);
247                             }
248                             addInfo(startingWhiteSpace, 'above', !text.trimmed ? text.transformed : undefined, !text.trimmed ? text.original : undefined);
249                         }
250                     //}
251                 }
252
253                 el.replaceWith(document.createTextNode(text.transformed));
254             });
255         this.trigger('contentSet');
256     },
257
258     registerClassTransformation: function(Transformation, className) {
259         var thisClassTransformations = (this.classTransformations[className] = this.classTransformations[className] || new transformations.TransformationStorage());
260         return thisClassTransformations.register(Transformation);
261     },
262
263     registerClassMethod: function(methodName, method, className) {
264         var thisClassMethods = (this.classMethods[className] = this.classMethods[className] || {});
265         thisClassMethods[methodName] = method;
266     },
267
268     registerExtension: function(extension) {
269         //debugger;
270         smartxml.Document.prototype.registerExtension.call(this, extension);
271         var doc = this,
272             existingPropertyNames = _.values(this);
273
274         var getTrans = function(desc, methodName) {
275             if(typeof desc === 'function') {
276                 desc = {impl: desc};
277             }
278             if(!desc.impl) {
279                 throw new Error('Got transformation description without implementation.')
280             }
281             desc.name = desc.name || methodName;
282             return desc;
283         };
284
285         _.pairs(extension.wlxmlClass).forEach(function(pair) {
286             var className = pair[0],
287                 classExtension = pair[1];
288
289             _.pairs(classExtension.methods || {}).forEach(function(pair) {
290                 var name = pair[0],
291                     method = pair[1];
292                 doc.registerClassMethod(name, method, className);
293             });
294
295             _.pairs(classExtension.transformations || {}).forEach(function(pair) {
296                 var transformation = getTrans(pair[1], pair[0]);
297                 doc.registerClassTransformation(transformations.createContextTransformation(transformation), className);
298             }); 
299         });
300
301     }
302
303 });
304
305 var wlxmlClasses = {
306     'uri': {
307         attrs: {uri: {type: 'string'}}
308     }
309 };
310
311
312 return {
313     WLXMLDocumentFromXML: function(xml, options) {
314         options = _.extend({wlxmlClasses: wlxmlClasses}, options);
315         return new WLXMLDocument(xml, options);
316     },
317
318     WLXMLElementNodeFromXML: function(xml) {
319         return this.WLXMLDocumentFromXML(xml).root;
320     }
321 };
322
323 });