b28f8d1433118afdc0acd5c24c549dab7591fd2e
[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() {
239         var instance = this,
240             args = Array.prototype.slice.call(arguments, 0);
241         return instance.transform(Transformation, args);
242     }
243 };
244
245 var registerMethod = function(methodName, method, target) {
246     if(target[methodName]) {
247         throw new Error('Cannot extend {target} with method name {methodName}. Name already exists.'
248             .replace('{target}', target)
249             .replace('{methodName}', methodName)
250         );
251     }
252     target[methodName] = method;
253 };
254
255
256 var Document = function(xml) {
257     this.loadXML(xml);
258     this.undoStack = [];
259     this.redoStack = [];
260     this._transformationLevel = 0;
261     
262     this._nodeMethods = {};
263     this._textNodeMethods = {};
264     this._elementNodeMethods = {};
265     this._nodeTransformations = {};
266     this._textNodeTransformations = {};
267     this._elementNodeTransformations = {};
268 };
269
270 $.extend(Document.prototype, Backbone.Events, {
271     ElementNodeFactory: ElementNode,
272     TextNodeFactory: TextNode,
273
274     createDocumentNode: function(from) {
275         if(!(from instanceof Node)) {
276             if(from.text !== undefined) {
277                 /* globals document */
278                 from = document.createTextNode(from.text);
279             } else {
280                 var node = $('<' + from.tagName + '>');
281
282                 _.keys(from.attrs || {}).forEach(function(key) {
283                     node.attr(key, from.attrs[key]);
284                 });
285
286                 from = node[0];
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         _.extend(toret, this._nodeTransformations);
303         _.extend(toret, typeTransformations);
304         return toret;
305     },
306
307     loadXML: function(xml, options) {
308         options = options || {};
309         this._defineDocumentProperties($(parseXML(xml)));
310         if(!options.silent) {
311             this.trigger('contentSet');
312         }
313     },
314
315     toXML: function() {
316         return this.root.toXML();
317     },
318
319     containsNode: function(node) {
320         return this.root && (node.nativeNode === this.root.nativeNode || node._$.parents().index(this.root._$) !== -1);
321     },
322
323     getSiblingParents: function(params) {
324         var parents1 = [params.node1].concat(params.node1.parents()).reverse(),
325             parents2 = [params.node2].concat(params.node2.parents()).reverse(),
326             noSiblingParents = null;
327
328         if(parents1.length === 0 || parents2.length === 0 || !(parents1[0].sameNode(parents2[0]))) {
329             return noSiblingParents;
330         }
331
332         var i;
333         for(i = 0; i < Math.min(parents1.length, parents2.length); i++) {
334             if(parents1[i].sameNode(parents2[i])) {
335                 continue;
336             }
337             break;
338         }
339         return {node1: parents1[i], node2: parents2[i]};
340     },
341
342     trigger: function() {
343         //console.log('trigger: ' + arguments[0] + (arguments[1] ? ', ' + arguments[1].type : ''));
344         Backbone.Events.trigger.apply(this, arguments);
345     },
346
347     getNodeInsertion: function(node) {
348         var insertion = {};
349         if(node instanceof DocumentNode) {
350             insertion.ofNode = node;
351             insertion.insertsNew = !this.containsNode(node);
352         } else {
353           insertion.ofNode = this.createDocumentNode(node);
354           insertion.insertsNew = true;
355         }
356         return insertion;
357     },
358
359     registerMethod: function(methodName, method, dstName) {
360         var doc = this;
361         var destination = {
362             document: doc,
363             documentNode: doc._nodeMethods,
364             textNode: doc._textNodeMethods,
365             elementNode: doc._elementNodeMethods
366         }[dstName];
367         registerMethod(methodName, method, destination);
368     },
369
370     registerTransformation: function(desc, name, dstName) {
371         var doc = this;
372         var destination = {
373             document: doc,
374             documentNode: doc._nodeTransformations,
375             textNode: doc._textNodeTransformations,
376             elementNode: doc._elementNodeTransformations
377         }[dstName];
378         registerTransformation(desc, name, destination);
379     },
380
381     registerExtension: function(extension) {
382         //debugger;
383         var doc = this,
384             existingPropertyNames = _.values(this);
385
386         ['document', 'documentNode', 'elementNode', 'textNode'].forEach(function(dstName) {
387             var dstExtension = extension[dstName];
388             if(dstExtension) {
389                 if(dstExtension.methods) {
390                     _.pairs(dstExtension.methods).forEach(function(pair) {
391                         var methodName = pair[0],
392                             method = pair[1];
393
394                         doc.registerMethod(methodName, method, dstName);
395
396                     });
397                 }
398
399                 if(dstExtension.transformations) {
400                     _.pairs(dstExtension.transformations).forEach(function(pair) {
401                         var name = pair[0],
402                             desc = pair[1];
403                         doc.registerTransformation(desc, name, dstName);
404                     });
405                 }
406             }
407         });
408     },
409
410     transform: function(Transformation, args) {
411         //console.log('transform');
412         var toret, transformation;
413
414         // ref: odrebnie przygotowanie transformacji, odrebnie jej wykonanie (to pierwsze to analog transform z node)
415
416         if(typeof Transformation === 'function') {
417             transformation = new Transformation(this, this, args);
418         } else {
419             transformation = Transformation;
420         }
421         if(transformation) {
422             this._transformationLevel++;
423             toret = transformation.run();
424             if(this._transformationLevel === 1) {
425                 this.undoStack.push(transformation);
426             }
427             this._transformationLevel--;
428             //console.log('clearing redo stack');
429             this.redoStack = [];
430             return toret;
431         } else {
432             throw new Error('Transformation ' + transformation + ' doesn\'t exist!');
433         }
434     },
435     undo: function() {
436         var transformation = this.undoStack.pop();
437         if(transformation) {
438             transformation.undo();
439             this.redoStack.push(transformation);
440         }
441     },
442     redo: function() {
443         var transformation = this.redoStack.pop();
444         if(transformation) {
445             transformation.run();
446             this.undoStack.push(transformation);
447         }
448     },
449
450     getNodeByPath: function(path) {
451         var toret = this.root;
452         path.forEach(function(idx) {
453             toret = toret.contents()[idx];
454         });
455         return toret;
456     },
457
458     _defineDocumentProperties: function($document) {
459         var doc = this;
460         Object.defineProperty(doc, 'root', {get: function() {
461             return doc.createDocumentNode($document[0]);
462         }, configurable: true});
463         Object.defineProperty(doc, 'dom', {get: function() {
464             return $document[0];
465         }, configurable: true});
466     }
467 });
468
469
470 return {
471     documentFromXML: function(xml) {
472         var doc = new Document(xml);
473         doc.registerExtension(coreTransformations);
474         return doc;
475     },
476
477     elementNodeFromXML: function(xml) {
478         return this.documentFromXML(xml).root;
479     },
480
481     Document: Document,
482     DocumentNode: DocumentNode,
483     ElementNode: ElementNode,
484     TextNode: TextNode
485 };
486
487 });