2ed9c478496659270fd7d8126bb29a4bfbdc7996
[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 var TEXT_NODE = Node.TEXT_NODE;
14
15
16
17 var DocumentNode = function(nativeNode, document) {
18     if(!document) {
19         throw new Error('undefined document for a node');
20     }
21     this.document = document;
22     this._setNativeNode(nativeNode);
23
24 };
25
26 $.extend(DocumentNode.prototype, {
27
28     transform: function(Transformation, args) {
29         var transformation = new Transformation(this.document, this, args);
30         return this.document.transform(transformation);
31     },
32
33     _setNativeNode: function(nativeNode) {
34         this.nativeNode = nativeNode;
35         this._$ = $(nativeNode);
36     },
37
38     clone: function() {
39         var clone = this._$.clone(true, true);
40         // clone.find('*').addBack().each(function() {
41         //     var n = $(this);
42         //     if(n.data('canvasElement')) {
43         //         n.data('canvasElement', $.extend(true, {}, n.data('canvasElement')));
44         //         n.data('canvasElement').$element = n.data('canvasElement').$element.clone(true, true);
45         //     }
46         // });
47         return this.document.createDocumentNode(clone[0]);
48     },
49
50     getPath: function(ancestor) {
51         var nodePath = [this].concat(this.parents()),
52             toret, idx;
53         ancestor = ancestor || this.document.root;
54
55         nodePath.some(function(node, i) {
56             if(node.sameNode(ancestor)) {
57                 idx = i;
58                 return true;
59             }
60         });
61
62         if(idx !== 'undefined') {
63             nodePath = nodePath.slice(0, idx);
64         }
65         toret = nodePath.map(function(node) {return node.getIndex(); });
66         toret.reverse();
67         return toret;
68     },
69
70     isRoot: function() {
71         return this.document.root.sameNode(this);
72     },
73
74     sameNode: function(otherNode) {
75         return !!(otherNode) && this.nativeNode === otherNode.nativeNode;
76     },
77
78     parent: function() {
79         var parentNode = this.nativeNode.parentNode;
80         if(parentNode && parentNode.nodeType === Node.ELEMENT_NODE) {
81             return this.document.createDocumentNode(parentNode);
82         }
83         return null;
84     },
85
86     parents: function() {
87         var parent = this.parent(),
88             parents = parent ? parent.parents() : [];
89         if(parent) {
90             parents.unshift(parent);
91         }
92         return parents;
93     },
94
95     prev: function() {
96         var myIdx = this.getIndex();
97         return myIdx > 0 ? this.parent().contents()[myIdx-1] : null;
98     },
99
100     next: function() {
101         if(this.isRoot()) {
102             return null;
103         }
104         var myIdx = this.getIndex(),
105             parentContents = this.parent().contents();
106         return myIdx < parentContents.length - 1 ? parentContents[myIdx+1] : null;
107     },
108
109     isSurroundedByTextElements: function() {
110         var prev = this.prev(),
111             next = this.next();
112         return prev && (prev.nodeType === Node.TEXT_NODE) && next && (next.nodeType === Node.TEXT_NODE);
113     },
114
115     triggerChangeEvent: function(type, metaData, origParent, nodeWasContained) {
116         var node = (metaData && metaData.node) ? metaData.node : this,
117             event = new events.ChangeEvent(type, $.extend({node: node}, metaData || {}));
118         if(type === 'nodeDetached' || this.document.containsNode(event.meta.node)) {
119             this.document.trigger('change', event);
120         }
121         if((type === 'nodeAdded' || type === 'nodeMoved') && !this.document.containsNode(this) && nodeWasContained) {
122              event = new events.ChangeEvent('nodeDetached', {node: node, parent: origParent});
123              this.document.trigger('change', event);
124         }
125     },
126     
127     getNodeInsertion: function(node) {
128         return this.document.getNodeInsertion(node);
129     },
130
131     getIndex: function() {
132         if(this.isRoot()) {
133             return 0;
134         }
135         return this.parent().indexOf(this);
136     }
137 });
138
139
140 var ElementNode = function(nativeNode, document) {
141     DocumentNode.call(this, nativeNode, document);
142 };
143 ElementNode.prototype = Object.create(DocumentNode.prototype);
144
145 $.extend(ElementNode.prototype, {
146     nodeType: Node.ELEMENT_NODE,
147
148     setData: function(key, value) {
149         if(value !== undefined) {
150             this._$.data(key, value);
151         } else {
152             this._$.removeData(_.keys(this._$.data()));
153             this._$.data(key);
154         }
155     },
156
157     getData: function(key) {
158         if(key) {
159             return this._$.data(key);
160         }
161         return this._$.data();
162     },
163
164     getTagName: function() {
165         return this.nativeNode.tagName.toLowerCase();
166     },
167
168     contents: function(selector) {
169         var toret = [],
170             document = this.document;
171         if(selector) {
172             this._$.children(selector).each(function() {
173                 toret.push(document.createDocumentNode(this));
174             });
175         } else {
176             this._$.contents().each(function() {
177                 toret.push(document.createDocumentNode(this));
178             });
179         }
180         return toret;
181     },
182
183     indexOf: function(node) {
184         return this._$.contents().index(node._$);
185     },
186
187     getAttr: function(name) {
188         return this._$.attr(name);
189     },
190
191     getAttrs: function() {
192         var toret = [];
193         for(var i = 0; i < this.nativeNode.attributes.length; i++) {
194             toret.push(this.nativeNode.attributes[i]);
195         }
196         return toret;
197     },
198
199     toXML: function() {
200         var wrapper = $('<div>');
201         wrapper.append(this._getXMLDOMToDump());
202         return wrapper.html();
203     },
204     
205     _getXMLDOMToDump: function() {
206         return this._$;
207     }
208 });
209
210
211 var TextNode = function(nativeNode, document) {
212     DocumentNode.call(this, nativeNode, document);
213 };
214 TextNode.prototype = Object.create(DocumentNode.prototype);
215
216 $.extend(TextNode.prototype, {
217     nodeType: Node.TEXT_NODE,
218
219     getText: function() {
220         return this.nativeNode.data;
221     },
222
223     triggerTextChangeEvent: function() {
224         var event = new events.ChangeEvent('nodeTextChange', {node: this});
225         this.document.trigger('change', event);
226     }
227 });
228
229
230 var parseXML = function(xml) {
231     return $($.trim(xml))[0];
232 };
233
234 var registerTransformation = function(desc, name, target) {
235     var Transformation = transformations.createContextTransformation(desc, name);
236     //+ to sie powinna nazywac registerTransformationFromDesc or sth
237     //+ ew. spr czy nie override (tylko jesli powyzej sa prototypy to trudno do nich dojsc)
238     target[name] = function(args) {
239         var instance = this;
240         return instance.transform(Transformation, args);
241     }
242 };
243
244 var registerMethod = function(methodName, method, target) {
245     if(target[methodName]) {
246         throw new Error('Cannot extend {target} with method name {methodName}. Name already exists.'
247             .replace('{target}', target)
248             .replace('{methodName}', methodName)
249         );
250     }
251     target[methodName] = method;
252 };
253
254
255 var Document = function(xml) {
256     this.loadXML(xml);
257     this.undoStack = [];
258     this.redoStack = [];
259     this._transformationLevel = 0;
260     
261     this._nodeMethods = {};
262     this._textNodeMethods = {};
263     this._elementNodeMethods = {};
264     this._nodeTransformations = {};
265     this._textNodeTransformations = {};
266     this._elementNodeTransformations = {};
267 };
268
269 $.extend(Document.prototype, Backbone.Events, {
270     ElementNodeFactory: ElementNode,
271     TextNodeFactory: TextNode,
272
273     createDocumentNode: function(from) {
274         if(!(from instanceof Node)) {
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         var Factory, typeMethods, typeTransformations;
289         if(from.nodeType === Node.TEXT_NODE) {
290             Factory = this.TextNodeFactory;
291             typeMethods = this._textNodeMethods;
292             typeTransformations = this._textNodeTransformations;
293         } else if(from.nodeType === Node.ELEMENT_NODE) {
294             Factory = this.ElementNodeFactory;
295             typeMethods = this._elementNodeMethods;
296             typeTransformations = this._elementNodeTransformations;
297         }
298         var toret = new Factory(from, this);
299         _.extend(toret, this._nodeMethods);
300         _.extend(toret, typeMethods);
301         _.extend(toret, this._nodeTransformations);
302         _.extend(toret, typeTransformations);
303         return toret;
304     },
305
306     loadXML: function(xml, options) {
307         options = options || {};
308         this._defineDocumentProperties($(parseXML(xml)));
309         if(!options.silent) {
310             this.trigger('contentSet');
311         }
312     },
313
314     toXML: function() {
315         return this.root.toXML();
316     },
317
318     containsNode: function(node) {
319         return this.root && (node.nativeNode === this.root.nativeNode || node._$.parents().index(this.root._$) !== -1);
320     },
321
322     getSiblingParents: function(params) {
323         var parents1 = [params.node1].concat(params.node1.parents()).reverse(),
324             parents2 = [params.node2].concat(params.node2.parents()).reverse(),
325             noSiblingParents = null;
326
327         if(parents1.length === 0 || parents2.length === 0 || !(parents1[0].sameNode(parents2[0]))) {
328             return noSiblingParents;
329         }
330
331         var i;
332         for(i = 0; i < Math.min(parents1.length, parents2.length); i++) {
333             if(parents1[i].sameNode(parents2[i])) {
334                 continue;
335             }
336             break;
337         }
338         return {node1: parents1[i], node2: parents2[i]};
339     },
340
341     trigger: function() {
342         //console.log('trigger: ' + arguments[0] + (arguments[1] ? ', ' + arguments[1].type : ''));
343         Backbone.Events.trigger.apply(this, arguments);
344     },
345
346     getNodeInsertion: function(node) {
347         var insertion = {};
348         if(node instanceof DocumentNode) {
349             insertion.ofNode = node;
350             insertion.insertsNew = !this.containsNode(node);
351         } else {
352           insertion.ofNode = this.createDocumentNode(node);
353           insertion.insertsNew = true;
354         }
355         return insertion;
356     },
357
358     registerMethod: function(methodName, method, dstName) {
359         var doc = this;
360         var destination = {
361             document: doc,
362             documentNode: doc._nodeMethods,
363             textNode: doc._textNodeMethods,
364             elementNode: doc._elementNodeMethods
365         }[dstName];
366         registerMethod(methodName, method, destination);
367     },
368
369     registerTransformation: function(desc, name, dstName) {
370         var doc = this;
371         var destination = {
372             document: doc,
373             documentNode: doc._nodeTransformations,
374             textNode: doc._textNodeTransformations,
375             elementNode: doc._elementNodeTransformations
376         }[dstName];
377         registerTransformation(desc, name, destination);
378     },
379
380     registerExtension: function(extension) {
381         //debugger;
382         var doc = this,
383             existingPropertyNames = _.values(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         //console.log('transform');
411         var toret, transformation;
412
413         // ref: odrebnie przygotowanie transformacji, odrebnie jej wykonanie (to pierwsze to analog transform z node)
414
415         if(typeof Transformation === 'function') {
416             transformation = new Transformation(this, this, args);
417         } else {
418             transformation = Transformation;
419         }
420         if(transformation) {
421             this._transformationLevel++;
422             toret = transformation.run();
423             if(this._transformationLevel === 1) {
424                 this.undoStack.push(transformation);
425             }
426             this._transformationLevel--;
427             //console.log('clearing redo stack');
428             this.redoStack = [];
429             return toret;
430         } else {
431             throw new Error('Transformation ' + transformation + ' doesn\'t exist!');
432         }
433     },
434     undo: function() {
435         var transformation = this.undoStack.pop();
436         if(transformation) {
437             transformation.undo();
438             this.redoStack.push(transformation);
439         }
440     },
441     redo: function() {
442         var transformation = this.redoStack.pop();
443         if(transformation) {
444             transformation.run();
445             this.undoStack.push(transformation);
446         }
447     },
448
449     getNodeByPath: function(path) {
450         var toret = this.root;
451         path.forEach(function(idx) {
452             toret = toret.contents()[idx];
453         });
454         return toret;
455     },
456
457     _defineDocumentProperties: function($document) {
458         var doc = this;
459         Object.defineProperty(doc, 'root', {get: function() {
460             return doc.createDocumentNode($document[0]);
461         }, configurable: true});
462         Object.defineProperty(doc, 'dom', {get: function() {
463             return $document[0];
464         }, configurable: true});
465     }
466 });
467
468
469 return {
470     documentFromXML: function(xml) {
471         var doc = new Document(xml);
472         doc.registerExtension(coreTransformations);
473         return doc;
474     },
475
476     elementNodeFromXML: function(xml) {
477         return this.documentFromXML(xml).root;
478     },
479
480     Document: Document,
481     DocumentNode: DocumentNode,
482     ElementNode: ElementNode,
483     TextNode: TextNode
484 };
485
486 });