52236b65554d85815106262e97f691f6fcfc61de
[fnpeditor.git] / src / smartxml / smartxml.js
1 define([
2     'libs/jquery',
3     'libs/underscore',
4     'libs/backbone',
5     'smartxml/events',
6     'smartxml/transformations',
7     'smartxml/core'
8 ], function($, _, Backbone, events, transformations, coreTransformations) {
9     
10 'use strict';
11 /* globals Node */
12
13
14 var DocumentNode = function(nativeNode, document) {
15     if(!document) {
16         throw new Error('undefined document for a node');
17     }
18     this.document = document;
19     this._setNativeNode(nativeNode);
20
21 };
22
23 $.extend(DocumentNode.prototype, {
24
25     transform: function(Transformation, args) {
26         var transformation = new Transformation(this.document, this, args);
27         return this.document.transform(transformation);
28     },
29
30     _setNativeNode: function(nativeNode) {
31         this.nativeNode = nativeNode;
32         this._$ = $(nativeNode);
33     },
34
35     clone: function() {
36         var clone = this._$.clone(true, true);
37         return this.document.createDocumentNode(clone[0]);
38     },
39
40     getPath: function(ancestor) {
41         if(!(this.document.containsNode(this))) {
42             return null;
43         }
44
45         var nodePath = [this].concat(this.parents()),
46             toret, idx;
47         ancestor = ancestor || this.document.root;
48
49         nodePath.some(function(node, i) {
50             if(node.sameNode(ancestor)) {
51                 idx = i;
52                 return true;
53             }
54         });
55
56         if(idx !== 'undefined') {
57             nodePath = nodePath.slice(0, idx);
58         }
59         toret = nodePath.map(function(node) {return node.getIndex(); });
60         toret.reverse();
61         return toret;
62     },
63
64     isRoot: function() {
65         return this.document.root.sameNode(this);
66     },
67
68     sameNode: function(otherNode) {
69         return !!(otherNode) && this.nativeNode === otherNode.nativeNode;
70     },
71
72     parent: function() {
73         var parentNode = this.nativeNode.parentNode;
74         if(parentNode && parentNode.nodeType === Node.ELEMENT_NODE) {
75             return this.document.createDocumentNode(parentNode);
76         }
77         return null;
78     },
79
80     parents: function() {
81         var parent = this.parent(),
82             parents = parent ? parent.parents() : [];
83         if(parent) {
84             parents.unshift(parent);
85         }
86         return parents;
87     },
88
89     prev: function() {
90         var myIdx = this.getIndex();
91         return myIdx > 0 ? this.parent().contents()[myIdx-1] : null;
92     },
93
94     next: function() {
95         if(this.isRoot()) {
96             return null;
97         }
98         var myIdx = this.getIndex(),
99             parentContents = this.parent().contents();
100         return myIdx < parentContents.length - 1 ? parentContents[myIdx+1] : null;
101     },
102
103     isSurroundedByTextElements: function() {
104         var prev = this.prev(),
105             next = this.next();
106         return prev && (prev.nodeType === Node.TEXT_NODE) && next && (next.nodeType === Node.TEXT_NODE);
107     },
108
109     triggerChangeEvent: function(type, metaData, origParent, nodeWasContained) {
110         var node = (metaData && metaData.node) ? metaData.node : this,
111             event = new events.ChangeEvent(type, $.extend({node: node}, metaData || {}));
112         if(type === 'nodeDetached' || this.document.containsNode(event.meta.node)) {
113             this.document.trigger('change', event);
114         }
115         if((type === 'nodeAdded' || type === 'nodeMoved') && !this.document.containsNode(this) && nodeWasContained) {
116              event = new events.ChangeEvent('nodeDetached', {node: node, parent: origParent});
117              this.document.trigger('change', event);
118         }
119     },
120     
121     getNodeInsertion: function(node) {
122         return this.document.getNodeInsertion(node);
123     },
124
125     getIndex: function() {
126         if(this.isRoot()) {
127             return 0;
128         }
129         return this.parent().indexOf(this);
130     }
131 });
132
133
134 var ElementNode = function(nativeNode, document) {
135     DocumentNode.call(this, nativeNode, document);
136 };
137 ElementNode.prototype = Object.create(DocumentNode.prototype);
138
139 $.extend(ElementNode.prototype, {
140     nodeType: Node.ELEMENT_NODE,
141
142     setData: function(key, value) {
143         if(value !== undefined) {
144             this._$.data(key, value);
145         } else {
146             this._$.removeData(_.keys(this._$.data()));
147             this._$.data(key);
148         }
149     },
150
151     getData: function(key) {
152         if(key) {
153             return this._$.data(key);
154         }
155         return this._$.data();
156     },
157
158     getTagName: function() {
159         return this.nativeNode.tagName.toLowerCase();
160     },
161
162     contents: function(selector) {
163         var toret = [],
164             document = this.document;
165         if(selector) {
166             this._$.children(selector).each(function() {
167                 toret.push(document.createDocumentNode(this));
168             });
169         } else {
170             this._$.contents().each(function() {
171                 toret.push(document.createDocumentNode(this));
172             });
173         }
174         return toret;
175     },
176
177     indexOf: function(node) {
178         return this._$.contents().index(node._$);
179     },
180
181     getAttr: function(name) {
182         return this._$.attr(name);
183     },
184
185     getAttrs: function() {
186         var toret = [];
187         for(var i = 0; i < this.nativeNode.attributes.length; i++) {
188             toret.push(this.nativeNode.attributes[i]);
189         }
190         return toret;
191     },
192
193     toXML: function() {
194         var wrapper = $('<div>');
195         wrapper.append(this._getXMLDOMToDump());
196         return wrapper.html();
197     },
198     
199     _getXMLDOMToDump: function() {
200         return this._$;
201     }
202 });
203
204
205 var TextNode = function(nativeNode, document) {
206     DocumentNode.call(this, nativeNode, document);
207 };
208 TextNode.prototype = Object.create(DocumentNode.prototype);
209
210 $.extend(TextNode.prototype, {
211     nodeType: Node.TEXT_NODE,
212
213     getText: function() {
214         return this.nativeNode.data;
215     },
216
217     triggerTextChangeEvent: function() {
218         var event = new events.ChangeEvent('nodeTextChange', {node: this});
219         this.document.trigger('change', event);
220     }
221 });
222
223
224 var parseXML = function(xml) {
225     return $($.trim(xml))[0];
226 };
227
228 var registerTransformation = function(desc, name, target) {
229     var Transformation = transformations.createContextTransformation(desc, name);
230     target[name] = function() {
231         var instance = this,
232             args = Array.prototype.slice.call(arguments, 0);
233         return instance.transform(Transformation, args);
234     };
235 };
236
237 var registerMethod = function(methodName, method, target) {
238     if(target[methodName]) {
239         throw new Error('Cannot extend {target} with method name {methodName}. Name already exists.'
240             .replace('{target}', target)
241             .replace('{methodName}', methodName)
242         );
243     }
244     target[methodName] = method;
245 };
246
247
248 var Document = function(xml) {
249     this.loadXML(xml);
250     this.undoStack = [];
251     this.redoStack = [];
252     this._transactionStack = [];
253     this._transformationLevel = 0;
254     
255     this._nodeMethods = {};
256     this._textNodeMethods = {};
257     this._elementNodeMethods = {};
258     this._nodeTransformations = {};
259     this._textNodeTransformations = {};
260     this._elementNodeTransformations = {};
261     
262     this.registerExtension(coreTransformations);
263 };
264
265 $.extend(Document.prototype, Backbone.Events, {
266     ElementNodeFactory: ElementNode,
267     TextNodeFactory: TextNode,
268
269     createDocumentNode: function(from) {
270         if(!(from instanceof Node)) {
271             if(from.text !== undefined) {
272                 /* globals document */
273                 from = document.createTextNode(from.text);
274             } else {
275                 var node = $('<' + from.tagName + '>');
276
277                 _.keys(from.attrs || {}).forEach(function(key) {
278                     node.attr(key, from.attrs[key]);
279                 });
280
281                 from = node[0];
282             }
283         }
284         var Factory, typeMethods, typeTransformations;
285         if(from.nodeType === Node.TEXT_NODE) {
286             Factory = this.TextNodeFactory;
287             typeMethods = this._textNodeMethods;
288             typeTransformations = this._textNodeTransformations;
289         } else if(from.nodeType === Node.ELEMENT_NODE) {
290             Factory = this.ElementNodeFactory;
291             typeMethods = this._elementNodeMethods;
292             typeTransformations = this._elementNodeTransformations;
293         }
294         var toret = new Factory(from, this);
295         _.extend(toret, this._nodeMethods);
296         _.extend(toret, typeMethods);
297         
298         _.extend(toret, this._nodeTransformations);
299         _.extend(toret, typeTransformations);
300         
301         toret.__super__ = _.extend({}, this._nodeMethods, this._nodeTransformations);
302         _.keys(toret.__super__).forEach(function(key) {
303             toret.__super__[key] = _.bind(toret.__super__[key], toret);
304         });
305
306         return toret;
307     },
308
309     loadXML: function(xml, options) {
310         options = options || {};
311         this._defineDocumentProperties($(parseXML(xml)));
312         if(!options.silent) {
313             this.trigger('contentSet');
314         }
315     },
316
317     toXML: function() {
318         return this.root.toXML();
319     },
320
321     containsNode: function(node) {
322         return this.root && (node.nativeNode === this.root.nativeNode || node._$.parents().index(this.root._$) !== -1);
323     },
324
325     getSiblingParents: function(params) {
326         var parents1 = [params.node1].concat(params.node1.parents()).reverse(),
327             parents2 = [params.node2].concat(params.node2.parents()).reverse(),
328             noSiblingParents = null;
329
330         if(parents1.length === 0 || parents2.length === 0 || !(parents1[0].sameNode(parents2[0]))) {
331             return noSiblingParents;
332         }
333
334         var i;
335         for(i = 0; i < Math.min(parents1.length, parents2.length); i++) {
336             if(parents1[i].sameNode(parents2[i])) {
337                 continue;
338             }
339             break;
340         }
341         return {node1: parents1[i], node2: parents2[i]};
342     },
343
344     trigger: function() {
345         Backbone.Events.trigger.apply(this, arguments);
346     },
347
348     getNodeInsertion: function(node) {
349         var insertion = {};
350         if(node instanceof DocumentNode) {
351             insertion.ofNode = node;
352             insertion.insertsNew = !this.containsNode(node);
353         } else {
354           insertion.ofNode = this.createDocumentNode(node);
355           insertion.insertsNew = true;
356         }
357         return insertion;
358     },
359
360     registerMethod: function(methodName, method, dstName) {
361         var doc = this;
362         var destination = {
363             document: doc,
364             documentNode: doc._nodeMethods,
365             textNode: doc._textNodeMethods,
366             elementNode: doc._elementNodeMethods
367         }[dstName];
368         registerMethod(methodName, method, destination);
369     },
370
371     registerTransformation: function(desc, name, dstName) {
372         var doc = this;
373         var destination = {
374             document: doc,
375             documentNode: doc._nodeTransformations,
376             textNode: doc._textNodeTransformations,
377             elementNode: doc._elementNodeTransformations
378         }[dstName];
379         registerTransformation(desc, name, destination);
380     },
381
382     registerExtension: function(extension) {
383         var doc = this;
384
385         ['document', 'documentNode', 'elementNode', 'textNode'].forEach(function(dstName) {
386             var dstExtension = extension[dstName];
387             if(dstExtension) {
388                 if(dstExtension.methods) {
389                     _.pairs(dstExtension.methods).forEach(function(pair) {
390                         var methodName = pair[0],
391                             method = pair[1];
392
393                         doc.registerMethod(methodName, method, dstName);
394
395                     });
396                 }
397
398                 if(dstExtension.transformations) {
399                     _.pairs(dstExtension.transformations).forEach(function(pair) {
400                         var name = pair[0],
401                             desc = pair[1];
402                         doc.registerTransformation(desc, name, dstName);
403                     });
404                 }
405             }
406         });
407     },
408
409     transform: function(Transformation, args) {
410         var toret, transformation;
411
412         if(typeof Transformation === 'function') {
413             transformation = new Transformation(this, this, args);
414         } else {
415             transformation = Transformation;
416         }
417         if(transformation) {
418             this._transformationLevel++;
419             toret = transformation.run({beUndoable:this._transformationLevel === 1});
420             if(this._transformationLevel === 1 && !this._undoInProgress) {
421                 if(this._transactionInProgress) {
422                     this._transactionStack.push(transformation);
423                 } else {
424                     this.undoStack.push(transformation);
425                 }
426             }
427             if(!this._undoInProgress && this._transformationLevel === 1) {
428                 this.redoStack = [];
429             }
430             this._transformationLevel--;
431             return toret;
432         } else {
433             throw new Error('Transformation ' + transformation + ' doesn\'t exist!');
434         }
435     },
436     undo: function() {
437         var transformationObject = this.undoStack.pop(),
438             doc = this,
439             transformations, stopAt;
440
441         if(transformationObject) {
442             this._undoInProgress = true;
443
444             if(_.isArray(transformationObject)) {
445                 // We will modify this array in a minute so make sure we work on a copy.
446                 transformations = transformationObject.slice(0);
447             } else {
448                 // Lets normalize single transformation to a transaction containing one transformation.
449                 transformations = [transformationObject];
450             }
451
452             if(transformations.length > 1) {
453                 // In case of real transactions we don't want to run undo on all of transformations if we don't have to.
454                 stopAt = undefined;
455                 transformations.some(function(t, idx) {
456                     if(!t.undo && t.getChangeRoot().sameNode(doc.root)) {
457                         stopAt = idx;
458                         return true; //break
459                     }
460                 });
461                 if(stopAt !== undefined) {
462                     // We will get away with undoing only this transformations as the one at stopAt reverses the whole document.
463                     transformations = transformations.slice(0, stopAt+1);
464                 }
465             }
466
467             transformations.reverse();
468             transformations.forEach(function(t) {
469                 t.undo();
470             });
471
472             this._undoInProgress = false;
473             this.redoStack.push(transformationObject);
474         }
475     },
476     redo: function() {
477         var transformationObject = this.redoStack.pop(),
478             transformations;
479         if(transformationObject) {
480             this._transformationLevel++;
481             transformations = _.isArray(transformationObject) ? transformationObject : [transformationObject];
482             transformations.forEach(function(t) {
483                 t.run({beUndoable: true});
484             });
485             this._transformationLevel--;
486             this.undoStack.push(transformationObject);
487         }
488     },
489
490     startTransaction: function() {
491         if(this._transactionInProgress) {
492             throw new Error('Nested transactions not supported!');
493         }
494         this._transactionInProgress = true;
495     },
496
497     endTransaction: function() {
498         if(!this._transactionInProgress) {
499             throw new Error('End of transaction requested, but there is no transaction in progress!');
500         }
501         this._transactionInProgress = false;
502         this.undoStack.push(this._transactionStack);
503         this._transactionStack = [];
504     },
505
506     getNodeByPath: function(path) {
507         var toret = this.root;
508         path.forEach(function(idx) {
509             toret = toret.contents()[idx];
510         });
511         return toret;
512     },
513
514     _defineDocumentProperties: function($document) {
515         var doc = this;
516         Object.defineProperty(doc, 'root', {get: function() {
517             return doc.createDocumentNode($document[0]);
518         }, configurable: true});
519         Object.defineProperty(doc, 'dom', {get: function() {
520             return $document[0];
521         }, configurable: true});
522     }
523 });
524
525
526 return {
527     documentFromXML: function(xml) {
528         var doc = new Document(xml);
529         return doc;
530     },
531
532     elementNodeFromXML: function(xml) {
533         return this.documentFromXML(xml).root;
534     },
535
536     Document: Document,
537     DocumentNode: DocumentNode,
538     ElementNode: ElementNode,
539     TextNode: TextNode
540 };
541
542 });