Output formatting wip
[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             if(attr.value)
167                 node.attr('meta-' + attr.name, attr.value);
168         });
169         _.keys(this.data('other-attrs') || {}).forEach(function(key) {
170             node.attr(key, this.data('other-attrs')[key]);
171         }, this);
172
173         if(this.data('orig-before') && this.data('orig-before').length) {
174             this.data('orig-before').forEach(function(toAdd) {
175                 if(toAdd)
176                     toret.prepend(document.createTextNode(toAdd));
177             });
178         } else if(level && this.getWlxmlTag() !== 'span') {
179             toret.append('\n' + (new Array(level * 2 + 1)).join(' '));
180         }
181         if(this.data('orig-append') && this.data('orig-append').length) {
182             this.data('orig-append').forEach(function(toAdd) {
183                 if(toAdd)
184                     node.prepend(toAdd);
185             });
186             //toret = toret.prepend(document.createTextNode(this.data('orig-prepend')));
187         } else if(this.getWlxmlTag() !== 'span'){
188             node.append('\n' + (new Array(level * 2 + 1)).join(' '));
189         }
190
191         toret.append(node);
192         return toret.contents();
193     },
194     append: function(params) {
195         if(params.tag !== 'span')
196             this.data('orig-append', []);
197         return manipulate(this, params, 'append');
198     },
199     before: function(params) {
200         return manipulate(this, params, 'before');
201
202     },
203     after: function(params) {
204         return manipulate(this, params, 'after');
205     },
206     children: function() {
207         var toret = [];
208         if(this instanceof DocumentTextElement)
209             return toret;
210
211
212         var elementContent = this.dom().contents();
213         var element = this;
214         elementContent.each(function(idx) {
215             var childElement = DocumentElement.fromHTMLElement(this, element.canvas);
216             if(idx === 0 && elementContent.length > 1 && elementContent[1].nodeType === Node.ELEMENT_NODE && (childElement instanceof DocumentTextElement) && $.trim($(this).text()) === '')
217                 return true;
218             if(idx > 0 && childElement instanceof DocumentTextElement) {
219                 if(toret[toret.length-1] instanceof DocumentNodeElement && $.trim($(this).text()) === '')
220                     return true;
221             }
222             toret.push(childElement);
223         });
224         return toret;
225     },
226     childIndex: function(child) {
227         var children = this.children(),
228             toret = null;
229         children.forEach(function(c, idx) {
230             if(c.sameNode(child)) {
231                 toret = idx;
232                 return false;
233             }
234         });
235         return toret;
236     },
237     getWlxmlTag: function() {
238         return this.dom().attr('wlxml-tag');
239     },
240     setWlxmlTag: function(tag) {
241         this.dom().attr('wlxml-tag', tag);
242     },
243     getWlxmlClass: function() {
244         var klass = this.dom().attr('wlxml-class');
245         if(klass)
246             return klass.replace(/-/g, '.');
247         return undefined;
248     },
249     setWlxmlClass: function(klass) {
250         this.getWlxmlMetaAttrs().forEach(function(attr) {
251             if(!classAttributes.hasMetaAttr(klass, attr.name))
252                 this.dom().removeAttr('wlxml-meta-' + attr.name);
253         }, this);
254
255         if(klass)
256             this.dom().attr('wlxml-class', klass.replace(/\./g, '-'));
257         else
258             this.dom().removeAttr('wlxml-class');
259     },
260     is: function(what) {
261         if(what === 'list' && _.contains(['list-items', 'list-items-enum'], this.dom().attr('wlxml-class')))
262             return true;
263         return false;
264     },
265
266
267     getWlxmlMetaAttr: function(attr) {
268         return this.dom().attr('wlxml-meta-'+attr);
269     },
270     getWlxmlMetaAttrs: function() {
271         var toret = [];
272         var attrList = classAttributes.getMetaAttrsList(this.getWlxmlClass());
273         attrList.all.forEach(function(attr) {
274             toret.push({name: attr.name, value: this.getWlxmlMetaAttr(attr.name) || ''});
275         }, this);
276         return toret;
277     },
278     setWlxmlMetaAttr: function(attr, value) {
279         this.dom().attr('wlxml-meta-'+attr, value);
280     }
281 });
282
283
284 // DocumentNodeElement represents a text node from WLXML document rendered inside Canvas
285 var DocumentTextElement = function(htmlElement, canvas) {
286     DocumentElement.call(this, htmlElement, canvas);
287 };
288
289 $.extend(DocumentTextElement, {
290     createDOM: function(params) {
291         return $('<div>')
292             .attr('wlxml-text', '')
293             .text(params.text);
294     },
295
296     create: function(params, canvas) {
297         return this.fromHTMLElement(this.createDOM(params)[0]);
298     },
299
300     fromHTMLElement: function(htmlElement, canvas) {
301         return new this(htmlElement, canvas);
302     }
303 });
304
305 DocumentTextElement.prototype = new DocumentElement();
306
307 $.extend(DocumentTextElement.prototype, {
308     toXML: function() {
309         return this.getText();
310     },
311     _setupDOMHandler: function(htmlElement) {
312         var $element = $(htmlElement);
313         if(htmlElement.nodeType === Node.TEXT_NODE)
314             this.$element = $element.parent();
315         else
316             this.$element = $element;
317     },
318     setText: function(text) {
319         this.dom().contents()[0].data = text;
320     },
321     getText: function() {
322         return this.dom().text();
323     },
324     after: function(params) {
325         if(params instanceof DocumentTextElement || params.text)
326             return false;
327         var element;
328         if(params instanceof DocumentNodeElement) {
329             element = params;
330         } else {
331             element = DocumentNodeElement.create(params);
332         }
333         this.dom().wrap('<div>');
334         this.dom().parent().after(element.dom());
335         this.dom().unwrap();
336         return element;
337     },
338     before: function(params) {
339         if(params instanceof DocumentTextElement || params.text)
340             return false;
341         var element;
342         if(params instanceof DocumentNodeElement) {
343             element = params;
344         } else {
345             element = DocumentNodeElement.create(params);
346         }
347         this.dom().wrap('<div>');
348         this.dom().parent().before(element.dom());
349         this.dom().unwrap();
350         return element;
351     },
352     wrapWithNodeElement: function(wlxmlNode) {
353         if(typeof wlxmlNode.start === 'number' && typeof wlxmlNode.end === 'number') {
354             return this.canvas.wrapText({
355                 inside: this.parent(),
356                 textNodeIdx: this.parent().childIndex(this),
357                 offsetStart: Math.min(wlxmlNode.start, wlxmlNode.end),
358                 offsetEnd: Math.max(wlxmlNode.start, wlxmlNode.end),
359                 _with: {tag: wlxmlNode.tag, klass: wlxmlNode.klass}
360             });
361         } else {
362             return DocumentElement.prototype.wrapWithNodeElement.call(this, wlxmlNode);
363         }
364     },
365     unwrap: function() {
366         var parent = this.parent(),
367             toret;
368         if(parent.children().length === 1) {
369             toret = parent.parent();
370             var grandParent = parent.parent();
371             if(grandParent) {
372                 var grandParentChildren = grandParent.children(),
373                     idx = grandParent.childIndex(parent),
374                     prev = idx - 1 > -1 ? grandParentChildren[idx-1] : null,
375                     next = idx + 1 < grandParentChildren.length ? grandParentChildren[idx+1] : null;
376                 if(prev && next) {
377                     prev.setText(prev.getText() + this.getText() + next.getText());
378                     next.detach();
379                 } else if (prev || next) {
380                     var target = prev ? prev : next;
381                     target.setText(target.getText() + this.getText());
382                 } else {
383                     parent.after(this);
384                 }
385             } else {
386                 parent.after(this);
387             }
388             parent.detach();
389             return toret;
390         }
391     },
392     split: function(params) {
393         var parentElement = this.parent(),
394             myIdx = parentElement.childIndex(this),
395             myCanvas = this.canvas,
396             passed = false,
397             succeedingChildren = [],
398             thisElement = this,
399             prefix = this.getText().substr(0, params.offset),
400             suffix = this.getText().substr(params.offset);
401
402         parentElement.children().forEach(function(child) {
403             if(passed)
404                 succeedingChildren.push(child);
405             if(child.sameNode(thisElement))
406                 passed = true;
407         });
408
409         if(prefix.length > 0)
410             this.setText(prefix);
411         else
412             this.detach();
413         
414         var newElement = DocumentNodeElement.create({tag: parentElement.getWlxmlTag(), klass: parentElement.getWlxmlClass()}, myCanvas);
415         parentElement.after(newElement);
416
417         if(suffix.length > 0)
418             newElement.append({text: suffix});
419         succeedingChildren.forEach(function(child) {
420             newElement.append(child);
421         });
422
423         return {first: parentElement, second: newElement};
424     },
425 });
426
427 return {
428     DocumentElement: DocumentElement,
429     DocumentNodeElement: DocumentNodeElement,
430     DocumentTextElement: DocumentTextElement
431 };
432
433 });