d9e44be26fc049859cbef63e3dda9a9c5b4eba53
[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(typeof from === 'string') {
272                 from = parseXML(from);
273                 this.normalizeXML(from);
274             } else {
275                 if(from.text !== undefined) {
276                     /* globals document */
277                     from = document.createTextNode(from.text);
278                 } else {
279                     var node = $('<' + from.tagName + '>');
280
281                     _.keys(from.attrs || {}).forEach(function(key) {
282                         node.attr(key, from.attrs[key]);
283                     });
284
285                     from = node[0];
286                 }
287             }
288         }
289         var Factory, typeMethods, typeTransformations;
290         if(from.nodeType === Node.TEXT_NODE) {
291             Factory = this.TextNodeFactory;
292             typeMethods = this._textNodeMethods;
293             typeTransformations = this._textNodeTransformations;
294         } else if(from.nodeType === Node.ELEMENT_NODE) {
295             Factory = this.ElementNodeFactory;
296             typeMethods = this._elementNodeMethods;
297             typeTransformations = this._elementNodeTransformations;
298         }
299         var toret = new Factory(from, this);
300         _.extend(toret, this._nodeMethods);
301         _.extend(toret, typeMethods);
302         
303         _.extend(toret, this._nodeTransformations);
304         _.extend(toret, typeTransformations);
305         
306         toret.__super__ = _.extend({}, this._nodeMethods, this._nodeTransformations);
307         _.keys(toret.__super__).forEach(function(key) {
308             toret.__super__[key] = _.bind(toret.__super__[key], toret);
309         });
310
311         return toret;
312     },
313
314     loadXML: function(xml, options) {
315         options = options || {};
316         this._defineDocumentProperties($(parseXML(xml)));
317         this.normalizeXML(this.dom);
318         if(!options.silent) {
319             this.trigger('contentSet');
320         }
321     },
322
323     normalizeXML: function(nativeNode) {
324         void(nativeNode); // noop
325     },
326
327     toXML: function() {
328         return this.root.toXML();
329     },
330
331     containsNode: function(node) {
332         return this.root && (node.nativeNode === this.root.nativeNode || node._$.parents().index(this.root._$) !== -1);
333     },
334
335     getSiblingParents: function(params) {
336         var parents1 = [params.node1].concat(params.node1.parents()).reverse(),
337             parents2 = [params.node2].concat(params.node2.parents()).reverse(),
338             noSiblingParents = null;
339
340         if(parents1.length === 0 || parents2.length === 0 || !(parents1[0].sameNode(parents2[0]))) {
341             return noSiblingParents;
342         }
343
344         var i;
345         for(i = 0; i < Math.min(parents1.length, parents2.length); i++) {
346             if(parents1[i].sameNode(parents2[i])) {
347                 continue;
348             }
349             break;
350         }
351         return {node1: parents1[i], node2: parents2[i]};
352     },
353
354     trigger: function() {
355         Backbone.Events.trigger.apply(this, arguments);
356     },
357
358     getNodeInsertion: function(node) {
359         var insertion = {};
360         if(node instanceof DocumentNode) {
361             insertion.ofNode = node;
362             insertion.insertsNew = !this.containsNode(node);
363         } else {
364           insertion.ofNode = this.createDocumentNode(node);
365           insertion.insertsNew = true;
366         }
367         return insertion;
368     },
369
370     registerMethod: function(methodName, method, dstName) {
371         var doc = this;
372         var destination = {
373             document: doc,
374             documentNode: doc._nodeMethods,
375             textNode: doc._textNodeMethods,
376             elementNode: doc._elementNodeMethods
377         }[dstName];
378         registerMethod(methodName, method, destination);
379     },
380
381     registerTransformation: function(desc, name, dstName) {
382         var doc = this;
383         var destination = {
384             document: doc,
385             documentNode: doc._nodeTransformations,
386             textNode: doc._textNodeTransformations,
387             elementNode: doc._elementNodeTransformations
388         }[dstName];
389         registerTransformation(desc, name, destination);
390     },
391
392     registerExtension: function(extension) {
393         var doc = this;
394
395         ['document', 'documentNode', 'elementNode', 'textNode'].forEach(function(dstName) {
396             var dstExtension = extension[dstName];
397             if(dstExtension) {
398                 if(dstExtension.methods) {
399                     _.pairs(dstExtension.methods).forEach(function(pair) {
400                         var methodName = pair[0],
401                             method = pair[1];
402
403                         doc.registerMethod(methodName, method, dstName);
404
405                     });
406                 }
407
408                 if(dstExtension.transformations) {
409                     _.pairs(dstExtension.transformations).forEach(function(pair) {
410                         var name = pair[0],
411                             desc = pair[1];
412                         doc.registerTransformation(desc, name, dstName);
413                     });
414                 }
415             }
416         });
417     },
418
419     transform: function(Transformation, args) {
420         var toret, transformation;
421
422         if(typeof Transformation === 'function') {
423             transformation = new Transformation(this, this, args);
424         } else {
425             transformation = Transformation;
426         }
427         if(transformation) {
428             this._transformationLevel++;
429             toret = transformation.run({beUndoable:this._transformationLevel === 1});
430             if(this._transformationLevel === 1 && !this._undoInProgress) {
431                 if(this._transactionInProgress) {
432                     this._transactionStack.push(transformation);
433                 } else {
434                     this.undoStack.push(transformation);
435                 }
436             }
437             if(!this._undoInProgress && this._transformationLevel === 1) {
438                 this.redoStack = [];
439             }
440             this._transformationLevel--;
441             return toret;
442         } else {
443             throw new Error('Transformation ' + transformation + ' doesn\'t exist!');
444         }
445     },
446     undo: function() {
447         var transformationObject = this.undoStack.pop(),
448             doc = this,
449             transformations, stopAt;
450
451         if(transformationObject) {
452             this._undoInProgress = true;
453
454             if(_.isArray(transformationObject)) {
455                 // We will modify this array in a minute so make sure we work on a copy.
456                 transformations = transformationObject.slice(0);
457             } else {
458                 // Lets normalize single transformation to a transaction containing one transformation.
459                 transformations = [transformationObject];
460             }
461
462             if(transformations.length > 1) {
463                 // In case of real transactions we don't want to run undo on all of transformations if we don't have to.
464                 stopAt = undefined;
465                 transformations.some(function(t, idx) {
466                     if(!t.undo && t.getChangeRoot().sameNode(doc.root)) {
467                         stopAt = idx;
468                         return true; //break
469                     }
470                 });
471                 if(stopAt !== undefined) {
472                     // We will get away with undoing only this transformations as the one at stopAt reverses the whole document.
473                     transformations = transformations.slice(0, stopAt+1);
474                 }
475             }
476
477             transformations.reverse();
478             transformations.forEach(function(t) {
479                 t.undo();
480             });
481
482             this._undoInProgress = false;
483             this.redoStack.push(transformationObject);
484         }
485     },
486     redo: function() {
487         var transformationObject = this.redoStack.pop(),
488             transformations;
489         if(transformationObject) {
490             this._transformationLevel++;
491             transformations = _.isArray(transformationObject) ? transformationObject : [transformationObject];
492             transformations.forEach(function(t) {
493                 t.run({beUndoable: true});
494             });
495             this._transformationLevel--;
496             this.undoStack.push(transformationObject);
497         }
498     },
499
500     startTransaction: function() {
501         if(this._transactionInProgress) {
502             throw new Error('Nested transactions not supported!');
503         }
504         this._transactionInProgress = true;
505     },
506
507     endTransaction: function() {
508         if(!this._transactionInProgress) {
509             throw new Error('End of transaction requested, but there is no transaction in progress!');
510         }
511         this._transactionInProgress = false;
512         this.undoStack.push(this._transactionStack);
513         this._transactionStack = [];
514     },
515
516     getNodeByPath: function(path) {
517         var toret = this.root;
518         path.forEach(function(idx) {
519             toret = toret.contents()[idx];
520         });
521         return toret;
522     },
523
524     _defineDocumentProperties: function($document) {
525         var doc = this;
526         Object.defineProperty(doc, 'root', {get: function() {
527             return doc.createDocumentNode($document[0]);
528         }, configurable: true});
529         Object.defineProperty(doc, 'dom', {get: function() {
530             return $document[0];
531         }, configurable: true});
532     }
533 });
534
535
536 return {
537     documentFromXML: function(xml) {
538         var doc = new Document(xml);
539         return doc;
540     },
541
542     elementNodeFromXML: function(xml) {
543         return this.documentFromXML(xml).root;
544     },
545
546     Document: Document,
547     DocumentNode: DocumentNode,
548     ElementNode: ElementNode,
549     TextNode: TextNode
550 };
551
552 });