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