Keeping xmlns and other attributes intact
[fnpeditor.git] / modules / documentCanvas / canvas / documentElement.js
1 define([
2 'libs/jquery-1.9.1.min',
3 'libs/underscore-min',
4 'modules/documentCanvas/classAttributes'
5 ], function($, _, classAttributes) {
6     
7 'use strict';
8
9
10 // DocumentElement represents a text or an element node from WLXML document rendered inside Canvas
11 var DocumentElement = function(htmlElement, canvas) {
12     if(arguments.length === 0)
13         return;
14     this.canvas = canvas;
15     this._setupDOMHandler(htmlElement);
16 }
17
18 var elementTypeFromParams = function(params) {
19     return params.text !== undefined ? DocumentTextElement : DocumentNodeElement;
20
21 };
22
23 $.extend(DocumentElement, {
24     create: function(params, canvas) {
25         return elementTypeFromParams(params).create(params);
26     },
27
28     createDOM: function(params) {
29         return elementTypeFromParams(params).createDOM(params);
30     },
31
32     fromHTMLElement: function(htmlElement, canvas) {
33         var $element = $(htmlElement);
34         if(htmlElement.nodeType === Node.ELEMENT_NODE && $element.attr('wlxml-tag'))
35             return DocumentNodeElement.fromHTMLElement(htmlElement, canvas);
36         if($element.attr('wlxml-text') !== undefined || (htmlElement.nodeType === Node.TEXT_NODE && $element.parent().attr('wlxml-text') !== undefined))
37             return DocumentTextElement.fromHTMLElement(htmlElement, canvas);
38         return undefined;
39     }
40 });
41
42 $.extend(DocumentElement.prototype, {
43     _setupDOMHandler: function(htmlElement) {
44         this.$element = $(htmlElement);
45     },
46     dom: function() {
47         return this.$element;
48     },
49     parent: function() {
50         var parents = this.$element.parents('[wlxml-tag]');
51         if(parents.length)
52             return DocumentElement.fromHTMLElement(parents[0], this.canvas);
53         return null;
54     },
55
56     parents: function() {
57         var parents = [],
58             parent = this.parent();
59         while(parent) {
60             parents.push(parent);
61             parent = parent.parent();
62         }
63         return parents;
64     },
65
66     sameNode: function(other) {
67         return other && (typeof other === typeof this) && other.dom()[0] === this.dom()[0];
68     },
69
70     wrapWithNodeElement: function(wlxmlNode) {
71         var wrapper = DocumentNodeElement.create({tag: wlxmlNode.tag, klass: wlxmlNode.klass});
72         this.dom().replaceWith(wrapper.dom());
73         wrapper.append(this);
74         return wrapper;
75     },
76
77     detach: function() {
78         this.dom().detach();
79         this.canvas = null;
80     },
81
82     markAsCurrent: function() {
83         this.canvas.markAsCurrent(this);
84     },
85
86     getVerticallyFirstTextElement: function() {
87         var toret;
88         this.children().some(function(child) {
89             if(!child.isVisible())
90                 return false; // continue
91             if(child instanceof DocumentTextElement) {
92                 toret = child;
93                 return true; // break
94             } else {
95                 toret = child.getVerticallyFirstTextElement();
96                 if(toret)
97                     return true; // break
98             }
99         });
100         return toret;
101     },
102
103     isVisible: function() {
104         return this instanceof DocumentTextElement || this.getWlxmlTag() !== 'metadata';
105     }
106 });
107
108
109 // DocumentNodeElement represents an element node from WLXML document rendered inside Canvas
110 var DocumentNodeElement = function(htmlElement, canvas) {
111     DocumentElement.call(this, htmlElement, canvas);
112 };
113
114 $.extend(DocumentNodeElement, {
115     createDOM: function(params) {
116         var dom = $('<div>')
117             .attr('wlxml-tag', params.tag);
118         if(params.klass)
119             dom.attr('wlxml-class', params.klass.replace(/\./g, '-'));
120         if(params.meta) {
121             _.keys(params.meta).forEach(function(key) {
122                 dom.attr('wlxml-meta-'+key, params.meta[key]);
123             });
124         }
125         dom.data('other-attrs', params.others);
126         return dom;
127     },
128
129     create: function(params, canvas) {
130         return this.fromHTMLElement(this.createDOM(params)[0]);
131     },
132
133     fromHTMLElement: function(htmlElement, canvas) {
134         return new this(htmlElement, canvas);
135     }
136 });
137
138 var manipulate = function(e, params, action) {
139     var element;
140     if(params instanceof DocumentElement) {
141         element = params;
142     } else {
143         element = DocumentElement.create(params);
144     }
145     e.dom()[action](element.dom());
146     return element;
147 };
148
149 DocumentNodeElement.prototype = new DocumentElement();
150
151 $.extend(DocumentNodeElement.prototype, {
152     data: function() {
153         var dom = this.dom(),
154             args = Array.prototype.slice.call(arguments, 0);
155         if(args.length === 2 && args[1] === undefined)
156             return dom.removeData(args[1]);
157         return dom.data.apply(dom, arguments);
158     },
159     toXML: function(level) {
160         var node = $('<' + this.getWlxmlTag() + '>'),
161             toret = $('<div>');
162         if(this.getWlxmlClass())
163             node.attr('class', this.getWlxmlClass());
164         var meta = this.getWlxmlMetaAttrs();
165         meta.forEach(function(attr) {
166             node.attr('meta-' + attr.name, attr.value);
167         });
168         _.keys(this.data('other-attrs') || {}).forEach(function(key) {
169             node.attr(key, this.data('other-attrs')[key]);
170         }, this);
171
172         if(this.data('orig-before') !== undefined) {
173             toret.append(document.createTextNode(this.data('orig-before')));
174         } else if(level && this.getWlxmlTag() !== 'span') {
175             toret.append('\n' + (new Array(level * 2 + 1)).join(' '));
176         }
177         if(this.data('orig-append') !== undefined) {
178             node.append(this.data('orig-append'));
179             //toret = toret.prepend(document.createTextNode(this.data('orig-prepend')));
180         } else if(this.getWlxmlTag() !== 'span'){
181             node.append('\n' + (new Array(level * 2 + 1)).join(' '));
182         }
183
184         toret.append(node);
185         return toret.contents();
186     },
187     append: function(params) {
188         if(params.tag !== 'span')
189             this.data('orig-append', undefined);
190         return manipulate(this, params, 'append');
191     },
192     before: function(params) {
193         return manipulate(this, params, 'before');
194
195     },
196     after: function(params) {
197         return manipulate(this, params, 'after');
198     },
199     children: function() {
200         var toret = [];
201         if(this instanceof DocumentTextElement)
202             return toret;
203
204
205         var elementContent = this.dom().contents();
206         var element = this;
207         elementContent.each(function(idx) {
208             var childElement = DocumentElement.fromHTMLElement(this, element.canvas);
209             if(idx === 0 && elementContent.length > 1 && elementContent[1].nodeType === Node.ELEMENT_NODE && (childElement instanceof DocumentTextElement) && $.trim($(this).text()) === '')
210                 return true;
211             if(idx > 0 && childElement instanceof DocumentTextElement) {
212                 if(toret[toret.length-1] instanceof DocumentNodeElement && $.trim($(this).text()) === '')
213                     return true;
214             }
215             toret.push(childElement);
216         });
217         return toret;
218     },
219     childIndex: function(child) {
220         var children = this.children(),
221             toret = null;
222         children.forEach(function(c, idx) {
223             if(c.sameNode(child)) {
224                 toret = idx;
225                 return false;
226             }
227         });
228         return toret;
229     },
230     getWlxmlTag: function() {
231         return this.dom().attr('wlxml-tag');
232     },
233     setWlxmlTag: function(tag) {
234         this.dom().attr('wlxml-tag', tag);
235     },
236     getWlxmlClass: function() {
237         var klass = this.dom().attr('wlxml-class');
238         if(klass)
239             return klass.replace(/-/g, '.');
240         return undefined;
241     },
242     setWlxmlClass: function(klass) {
243         this.getWlxmlMetaAttrs().forEach(function(attr) {
244             if(!classAttributes.hasMetaAttr(klass, attr.name))
245                 this.dom().removeAttr('wlxml-meta-' + attr.name);
246         }, this);
247
248         if(klass)
249             this.dom().attr('wlxml-class', klass.replace(/\./g, '-'));
250         else
251             this.dom().removeAttr('wlxml-class');
252     },
253     is: function(what) {
254         if(what === 'list' && _.contains(['list-items', 'list-items-enum'], this.dom().attr('wlxml-class')))
255             return true;
256         return false;
257     },
258
259
260     getWlxmlMetaAttr: function(attr) {
261         return this.dom().attr('wlxml-meta-'+attr);
262     },
263     getWlxmlMetaAttrs: function() {
264         var toret = [];
265         var attrList = classAttributes.getMetaAttrsList(this.getWlxmlClass());
266         attrList.all.forEach(function(attr) {
267             toret.push({name: attr.name, value: this.getWlxmlMetaAttr(attr.name) || ''});
268         }, this);
269         return toret;
270     },
271     setWlxmlMetaAttr: function(attr, value) {
272         this.dom().attr('wlxml-meta-'+attr, value);
273     }
274 });
275
276
277 // DocumentNodeElement represents a text node from WLXML document rendered inside Canvas
278 var DocumentTextElement = function(htmlElement, canvas) {
279     DocumentElement.call(this, htmlElement, canvas);
280 };
281
282 $.extend(DocumentTextElement, {
283     createDOM: function(params) {
284         return $('<div>')
285             .attr('wlxml-text', '')
286             .text(params.text);
287     },
288
289     create: function(params, canvas) {
290         return this.fromHTMLElement(this.createDOM(params)[0]);
291     },
292
293     fromHTMLElement: function(htmlElement, canvas) {
294         return new this(htmlElement, canvas);
295     }
296 });
297
298 DocumentTextElement.prototype = new DocumentElement();
299
300 $.extend(DocumentTextElement.prototype, {
301     toXML: function() {
302         return this.getText();
303     },
304     _setupDOMHandler: function(htmlElement) {
305         var $element = $(htmlElement);
306         if(htmlElement.nodeType === Node.TEXT_NODE)
307             this.$element = $element.parent();
308         else
309             this.$element = $element;
310     },
311     setText: function(text) {
312         this.dom().contents()[0].data = text;
313     },
314     getText: function() {
315         return this.dom().text();
316     },
317     after: function(params) {
318         if(params instanceof DocumentTextElement || params.text)
319             return false;
320         var element;
321         if(params instanceof DocumentNodeElement) {
322             element = params;
323         } else {
324             element = DocumentNodeElement.create(params);
325         }
326         this.dom().wrap('<div>');
327         this.dom().parent().after(element.dom());
328         this.dom().unwrap();
329         return element;
330     },
331     before: function(params) {
332         if(params instanceof DocumentTextElement || params.text)
333             return false;
334         var element;
335         if(params instanceof DocumentNodeElement) {
336             element = params;
337         } else {
338             element = DocumentNodeElement.create(params);
339         }
340         this.dom().wrap('<div>');
341         this.dom().parent().before(element.dom());
342         this.dom().unwrap();
343         return element;
344     },
345     wrapWithNodeElement: function(wlxmlNode) {
346         if(typeof wlxmlNode.start === 'number' && typeof wlxmlNode.end === 'number') {
347             return this.canvas.wrapText({
348                 inside: this.parent(),
349                 textNodeIdx: this.parent().childIndex(this),
350                 offsetStart: Math.min(wlxmlNode.start, wlxmlNode.end),
351                 offsetEnd: Math.max(wlxmlNode.start, wlxmlNode.end),
352                 _with: {tag: wlxmlNode.tag, klass: wlxmlNode.klass}
353             });
354         } else {
355             return DocumentElement.prototype.wrapWithNodeElement.call(this, wlxmlNode);
356         }
357     },
358     unwrap: function() {
359         var parent = this.parent(),
360             toret;
361         if(parent.children().length === 1) {
362             toret = parent.parent();
363             var grandParent = parent.parent();
364             if(grandParent) {
365                 var grandParentChildren = grandParent.children(),
366                     idx = grandParent.childIndex(parent),
367                     prev = idx - 1 > -1 ? grandParentChildren[idx-1] : null,
368                     next = idx + 1 < grandParentChildren.length ? grandParentChildren[idx+1] : null;
369                 if(prev && next) {
370                     prev.setText(prev.getText() + this.getText() + next.getText());
371                     next.detach();
372                 } else if (prev || next) {
373                     var target = prev ? prev : next;
374                     target.setText(target.getText() + this.getText());
375                 } else {
376                     parent.after(this);
377                 }
378             } else {
379                 parent.after(this);
380             }
381             parent.detach();
382             return toret;
383         }
384     },
385     split: function(params) {
386         var parentElement = this.parent(),
387             myIdx = parentElement.childIndex(this),
388             myCanvas = this.canvas,
389             passed = false,
390             succeedingChildren = [],
391             thisElement = this,
392             prefix = this.getText().substr(0, params.offset),
393             suffix = this.getText().substr(params.offset);
394
395         parentElement.children().forEach(function(child) {
396             if(passed)
397                 succeedingChildren.push(child);
398             if(child.sameNode(thisElement))
399                 passed = true;
400         });
401
402         if(prefix.length > 0)
403             this.setText(prefix);
404         else
405             this.detach();
406         
407         var newElement = DocumentNodeElement.create({tag: parentElement.getWlxmlTag(), klass: parentElement.getWlxmlClass()}, myCanvas);
408         parentElement.after(newElement);
409
410         if(suffix.length > 0)
411             newElement.append({text: suffix});
412         succeedingChildren.forEach(function(child) {
413             newElement.append(child);
414         });
415
416         return {first: parentElement, second: newElement};
417     },
418 });
419
420 return {
421     DocumentElement: DocumentElement,
422     DocumentNodeElement: DocumentNodeElement,
423     DocumentTextElement: DocumentTextElement
424 };
425
426 });