formatting xml output wip
[fnpeditor.git] / modules / documentCanvas / canvas / canvas.js
1 define([
2 'libs/jquery-1.9.1.min',
3 'libs/underscore-min',
4 'modules/documentCanvas/canvas/documentElement'
5 ], function($, _, documentElement) {
6     
7 'use strict';
8
9 var Canvas = function(wlxml, publisher) {
10     this.loadWlxml(wlxml);
11     this.publisher = publisher ? publisher : function() {};
12 };
13
14 $.extend(Canvas.prototype, {
15
16     loadWlxml: function(wlxml) {
17         var d = wlxml ? $($.trim(wlxml)) : null;
18         if(d) {
19             this.wrapper = $('<div>').addClass('canvas-wrapper').attr('contenteditable', true);
20             this.wrapper.append(d);
21             
22             this.wrapper.find('*').replaceWith(function() {
23                 var currentTag = $(this);
24                 if(currentTag.attr('wlxml-tag'))
25                     return;
26
27                 var meta = {};
28                 for(var i = 0; i < this.attributes.length; i++) {
29                     var attr = this.attributes[i];
30                     if(attr.name.substr(0, 5) === 'meta-')
31                         meta[attr.name.substr(5)] = attr.value;
32                 }
33
34                 var element = documentElement.DocumentNodeElement.create({
35                     tag: currentTag.prop('tagName').toLowerCase(),
36                     klass: currentTag.attr('class'),
37                     meta: meta
38                 });
39
40                 element.dom().append(currentTag.contents());
41                 ['orig-before', 'orig-append'].forEach(function(attr) {
42                     element.data(attr, '');
43                 });
44                 return element.dom();
45             });
46
47             this.wrapper.find(':not(iframe)').addBack().contents()
48                 .filter(function() {return this.nodeType === Node.TEXT_NODE})
49                 .each(function() {
50
51                     var el = $(this);
52                     
53                     // TODO: use DocumentElement API
54                     var spanParent = el.parent().attr('wlxml-tag') === 'span',
55                         spanBefore = el.prev().length > 0  && $(el.prev()[0]).attr('wlxml-tag') === 'span',
56                         spanAfter = el.next().length > 0 && $(el.next()[0]).attr('wlxml-tag') === 'span';
57                         
58                     if(spanParent || spanBefore || spanAfter) {
59                         var startSpace = /\s/g.test(this.data.substr(0,1));
60                         var endSpace = /\s/g.test(this.data.substr(-1)) && this.data.length > 1;
61                         var trimmed = $.trim(this.data);
62                         this.data = (startSpace && (spanParent || spanBefore) ? ' ' : '')
63                                     + trimmed
64                                     + (endSpace && (spanParent || spanAfter) ? ' ' : '');
65
66                     } else {
67                         var oldText = this.data,
68                             oldLength = this.data.length;
69                         this.data = $.trim(this.data);
70                         if(this.data.length === 0 && oldLength > 0 && el.parent().contents().length === 1)
71                             this.data = ' ';
72                         if(this.data.length === 0) {
73                             var parent = $(this).parent(),
74                                 parentContents = parent.contents(),
75                                 idx = parentContents.index(this),
76                                 next = idx < parentContents.length - 1 ? parentContents[idx+1] : null;
77
78                             if(next) {
79                                 $(next).data('orig-before', oldText);
80                             } else {
81                                 parent.data('orig-append', oldText);
82                             }
83                             $(this).remove();
84
85                             return true; // continue
86                         }
87                     }
88
89                     var element = documentElement.DocumentTextElement.create({text: this.data});
90                     $(this).replaceWith(element.dom());
91                 });
92             
93             this.d = this.wrapper.children(0);
94
95             var canvas = this;
96             this.wrapper.on('keydown', function(e) {
97                 if(e.which === 13) { 
98                     e.preventDefault();
99                     var cursor = canvas.getCursor();
100                     if(!cursor.isSelecting()) {
101                         var position = cursor.getPosition(),
102                             elements = position.element.split({offset: position.offset}),
103                             newEmpty,
104                             goto;
105
106                         if(position.offsetAtBeginning)
107                             newEmpty = elements.first;
108                         else if(position.offsetAtEnd)
109                             newEmpty = elements.second;
110                         if(newEmpty) {
111                             goto = newEmpty.append(documentElement.DocumentTextElement.create({text: '\u200B'}, this));
112                             canvas.setCurrentElement(goto);
113                         }
114                     }
115                 }
116             });
117
118             this.wrapper.on('keyup', function(e) {
119                 if(e.which >= 37 && e.which <= 40)
120                     canvas.setCurrentElement(canvas.getCursor().getPosition().element, {caretTo: false})
121             });
122
123             this.wrapper.on('click', '[wlxml-tag], [wlxml-text]', function(e) {
124                 e.stopPropagation();
125                 canvas.setCurrentElement(canvas.getDocumentElement(e.target), {caretTo: false});
126             });
127
128         } else {
129             this.d = null;
130         }
131     },
132
133     view: function() {
134         return this.wrapper;
135     },
136
137     doc: function() {
138         if(this.d === null)
139             return null;
140         return documentElement.DocumentNodeElement.fromHTMLElement(this.d.get(0), this); //{wlxmlTag: this.d.prop('tagName')};
141     },
142
143     wrapText: function(params) {
144         params = _.extend({textNodeIdx: 0}, params);
145         if(typeof params.textNodeIdx === 'number')
146             params.textNodeIdx = [params.textNodeIdx];
147         
148         var childrenInside = params.inside.children(),
149             idx1 = Math.min.apply(Math, params.textNodeIdx),
150             idx2 = Math.max.apply(Math, params.textNodeIdx),
151             textNode1 = childrenInside[idx1],
152             textNode2 = childrenInside[idx2],
153             sameNode = textNode1.sameNode(textNode2),
154             prefixOutside = textNode1.getText().substr(0, params.offsetStart),
155             prefixInside = textNode1.getText().substr(params.offsetStart),
156             suffixInside = textNode2.getText().substr(0, params.offsetEnd),
157             suffixOutside = textNode2.getText().substr(params.offsetEnd)
158         ;
159         
160         var wrapperElement = documentElement.DocumentNodeElement.create({tag: params._with.tag, klass: params._with.klass});
161         textNode1.after(wrapperElement);
162         textNode1.detach();
163         
164         if(prefixOutside.length > 0)
165             wrapperElement.before({text:prefixOutside});
166         if(sameNode) {
167             var core = textNode1.getText().substr(params.offsetStart, params.offsetEnd - params.offsetStart);
168             wrapperElement.append({text: core});
169         } else {
170             textNode2.detach();
171             if(prefixInside.length > 0)
172                 wrapperElement.append({text: prefixInside});
173             for(var i = idx1 + 1; i < idx2; i++) {
174                 wrapperElement.append(childrenInside[i]);
175             }
176             if(suffixInside.length > 0)
177                 wrapperElement.append({text: suffixInside});
178         }
179         if(suffixOutside.length > 0)
180             wrapperElement.after({text: suffixOutside});
181         return wrapperElement;
182     },
183     getDocumentElement: function(from) {
184         if(from instanceof HTMLElement || from instanceof Text) {
185            return documentElement.DocumentElement.fromHTMLElement(from, this);
186         }
187     },
188     getCursor: function() {
189         return new Cursor(this);
190     },
191
192     list: {},
193
194
195
196     highlightElement: function(element) {
197         this.wrapper.find('.highlighted-element').removeClass('highlighted-element');
198         element.dom().addClass('highlighted-element');
199     },
200
201     dimElement: function(element) {
202         element.dom().removeClass('highlighted-element');
203     },
204     
205     getCurrentNodeElement: function() {
206         return this.getDocumentElement(this.wrapper.find('.current-node-element')[0]);
207     },
208
209     getCurrentTextElement: function() {
210         return this.getDocumentElement(this.wrapper.find('.current-text-element')[0]);
211     },
212
213
214
215     setCurrentElement: function(element, params) {
216         params = _.extend({caretTo: 'end'}, params);
217         var findFirstDirectTextChild = function(e, nodeToLand) {
218             var byBrowser = this.getCursor().getPosition().element;
219             if(byBrowser && byBrowser.parent().sameNode(nodeToLand))
220                 return byBrowser;
221             var children = e.children();
222             for(var i = 0; i < children.length; i++) {
223                 if(children[i] instanceof documentElement.DocumentTextElement)
224                     return children[i];
225             }
226             return null;
227         }.bind(this);
228         var _markAsCurrent = function(element) {
229             if(element instanceof documentElement.DocumentTextElement) {
230                 this.wrapper.find('.current-text-element').removeClass('current-text-element');
231                 element.dom().addClass('current-text-element');
232             } else {
233                 this.wrapper.find('.current-node-element').removeClass('current-node-element')
234                 element.dom().addClass('current-node-element');
235                 this.publisher('currentElementChanged', element);
236             }
237         }.bind(this);
238
239
240         var isTextElement = element instanceof documentElement.DocumentTextElement,
241             nodeElementToLand = isTextElement ? element.parent() : element,
242             textElementToLand = isTextElement ? element : findFirstDirectTextChild(element, nodeElementToLand),
243             currentTextElement = this.getCurrentTextElement(),
244             currentNodeElement = this.getCurrentNodeElement();
245
246         if(currentTextElement && !(currentTextElement.sameNode(textElementToLand)))
247             this.wrapper.find('.current-text-element').removeClass('current-text-element');
248
249         if(textElementToLand) {
250             _markAsCurrent(textElementToLand);
251             if(params.caretTo || !textElementToLand.sameNode(this.getCursor().getPosition().element))
252                 this._moveCaretToTextElement(textElementToLand, params.caretTo); // as method on element?
253             if(!(textElementToLand.sameNode(currentTextElement)))
254                 this.publisher('currentTextElementSet', textElementToLand);
255         } else {
256             document.getSelection().removeAllRanges();
257         }
258
259         if(!(currentNodeElement && currentNodeElement.sameNode(nodeElementToLand))) {
260             _markAsCurrent(nodeElementToLand);
261
262             this.publisher('currentNodeElementSet', nodeElementToLand);
263         }
264     },
265
266     _moveCaretToTextElement: function(element, where) {
267         var range = document.createRange(),
268             node = element.dom().contents()[0];
269
270         if(typeof where !== 'number') {
271             range.selectNodeContents(node);
272         } else {
273             range.setStart(node, where);
274         }
275         
276         var collapseArg = true;
277         if(where === 'end')
278             collapseArg = false;
279         range.collapse(collapseArg);
280         
281         var selection = document.getSelection();
282
283         selection.removeAllRanges();
284         selection.addRange(range);
285         this.wrapper.focus(); // FF requires this for caret to be put where range colllapses, Chrome doesn't.
286     },
287
288     setCursorPosition: function(position) {
289         if(position.element)
290             this._moveCaretToTextElement(position.element, position.offset);
291     },
292
293     toXML: function() {
294         var d = function(element, parent, level) {
295             console.log(element.getText ? 'text: ' + element.getText() : 'node: ' + element.getWlxmlTag());
296             var isElementNode = element instanceof documentElement.DocumentNodeElement;
297             parent.prepend(element.toXML(level));
298             if(isElementNode) {
299                 var dom = $(parent.children()[0]),
300                     elementChildren = element.children();
301                 for(var i = elementChildren.length - 1; i >= 0; i--) {
302                     d(elementChildren[i], dom, level + 1);
303                 }
304             }
305         }
306         var parent = $('<div>');
307         d(this.doc(), parent, 0);
308         return parent.html();
309     }
310 });
311
312 $.extend(Canvas.prototype.list, {
313     create: function(params) {
314         if(!(params.element1.parent().sameNode(params.element2.parent())))
315             return false;
316             
317         var parent = params.element1.parent();
318         
319         if(parent.childIndex(params.element1) > parent.childIndex(params.element2)) {
320             var tmp = params.element1;
321             params.element1 = params.element2;
322             params.element2 = tmp;
323         }
324         
325         var elementsToWrap = [];
326         
327         var place = 'before';
328         var canvas = this;
329         parent.children().some(function(element) {
330             var _e = element;
331             if(element.sameNode(params.element1))
332                 place = 'inside';
333             if(place === 'inside') {
334                 if(element instanceof documentElement.DocumentTextElement) {
335                     element = element.wrapWithNodeElement({tag: 'div', klass: 'list.item'});
336                     if(element.children()[0].sameNode(params.element1))
337                         params.element1 = element;
338                 }
339                 element.setWlxmlClass('item');
340                 elementsToWrap.push(element);
341             }
342             if(_e.sameNode(params.element2))
343                 return true;
344         });
345         
346         var listElement = documentElement.DocumentNodeElement.create({tag: 'div', klass: 'list-items' + (params.type === 'enum' ? '-enum' : '')});
347         
348         var toret;
349         if(parent.is('list')) {
350             listElement.wrapWithNodeElement({tag: 'div', klass: 'item'});
351             toret = listElement.parent();
352         } else {
353             toret = listElement;
354         }  
355         
356         params.element1.before(toret);
357         
358         elementsToWrap.forEach(function(element) {
359             element.detach();
360             listElement.append(element);
361         });
362     },
363     extractItems: function(params) {
364         params = _.extend({merge: true}, params);
365         var list = params.element1.parent();
366         if(!list.is('list') || !(list.sameNode(params.element2.parent())))
367             return false;
368
369         var idx1 = list.childIndex(params.element1),
370             idx2 = list.childIndex(params.element2),
371             precedingItems = [],
372             extractedItems = [],
373             succeedingItems = [],
374             items = list.children(),
375             listIsNested = list.parent().getWlxmlClass() === 'item',
376             i;
377
378         if(idx1 > idx2) {
379             var tmp = idx1; idx1 = idx2; idx2 = tmp;
380         }
381
382         items.forEach(function(item, idx) {
383             if(idx < idx1)
384                 precedingItems.push(item);
385             else if(idx >= idx1 && idx <= idx2) {
386                 extractedItems.push(item);
387             }
388             else {
389                 succeedingItems.push(item);
390             }
391         });
392
393         var reference = listIsNested ? list.parent() : list;
394         if(succeedingItems.length === 0) {
395             var reference_orig = reference;
396             extractedItems.forEach(function(item) {
397                 reference.after(item);
398                 reference = item;
399                 if(!listIsNested)
400                     item.setWlxmlClass(null);
401             });
402             if(precedingItems.length === 0)
403                 reference_orig.detach();
404         } else if(precedingItems.length === 0) {
405             extractedItems.forEach(function(item) {
406                 reference.before(item);
407                 if(!listIsNested)
408                     item.setWlxmlClass(null);
409             });
410         } else {
411             extractedItems.forEach(function(item) {
412                 reference.after(item);
413                 if(!listIsNested)
414                     item.setWlxmlClass(null);
415                 reference = item;
416             });
417             var secondList = documentElement.DocumentNodeElement.create({tag: 'div', klass:'list-items'}, this),
418                 toAdd = secondList;
419             
420             if(listIsNested) {
421                 toAdd = secondList.wrapWithNodeElement({tag: 'div', klass:'item'});
422             }
423             succeedingItems.forEach(function(item) {
424                 secondList.append(item);
425             });
426
427             reference.after(toAdd);
428         }
429         if(!params.merge && listIsNested) {
430             return this.extractItems({element1: extractedItems[0], element2: extractedItems[extractedItems.length-1]});
431         }
432         return true;
433     },
434     areItemsOfTheSameList: function(params) {
435         var e1 = params.element1,
436             e2 = params.element2;
437         return e1.parent().sameNode(e2.parent())
438             && e1.parent().is('list');
439     }
440 });
441
442
443 var Cursor = function(canvas) {
444     this.canvas = canvas;
445 };
446
447 $.extend(Cursor.prototype, {
448     isSelecting: function() {
449         var selection = window.getSelection();
450         return !selection.isCollapsed;
451     },
452     isSelectingWithinElement: function() {
453         return this.isSelecting() && this.getSelectionStart().element.sameNode(this.getSelectionEnd().element);
454     },
455     isSelectingSiblings: function() {
456         return this.isSelecting() && this.getSelectionStart().element.parent().sameNode(this.getSelectionEnd().element.parent());
457     },
458     getPosition: function() {
459         return this.getSelectionAnchor();
460     },
461     getSelectionStart: function() {
462         return this.getSelectionBoundry('start');
463     },
464     getSelectionEnd: function() {
465         return this.getSelectionBoundry('end');
466     },
467     getSelectionAnchor: function() {
468         return this.getSelectionBoundry('anchor');
469     },
470     getSelectionFocus: function() {
471         return this.getSelectionBoundry('focus');
472     },
473     getSelectionBoundry: function(which) {
474         var selection = window.getSelection(),
475             anchorElement = this.canvas.getDocumentElement(selection.anchorNode),
476             focusElement = this.canvas.getDocumentElement(selection.focusNode);
477         
478         if(anchorElement instanceof documentElement.DocumentNodeElement || focusElement instanceof documentElement.DocumentNodeElement)
479             return {};
480
481         if(which === 'anchor') {
482             return {
483                 element: anchorElement,
484                 offset: selection.anchorOffset,
485                 offsetAtBeginning: selection.anchorOffset === 0,
486                 offsetAtEnd: anchorElement && anchorElement.getText().length === selection.anchorOffset
487             };
488         }
489         if(which === 'focus') {
490             return {
491                 element: focusElement,
492                 offset: selection.focusOffset,
493                 offsetAtBeginning: selection.focusOffset === 0,
494                 offsetAtEnd: focusElement && focusElement.getText().length === selection.focusOffset
495             };
496         }
497         
498         var element,
499             offset;
500
501         if(anchorElement.parent().sameNode(focusElement.parent())) {
502             var parent = anchorElement.parent(),
503                 anchorFirst = parent.childIndex(anchorElement) < parent.childIndex(focusElement);
504             if(anchorFirst) {
505                 if(which === 'start') {
506                     element = anchorElement;
507                     offset = selection.anchorOffset;
508                 }
509                 else if(which === 'end') {
510                     element = focusElement,
511                     offset = selection.focusOffset;
512                 }
513             } else {
514                 if(which === 'start') {
515                     element = focusElement,
516                     offset = selection.focusOffset
517                 }
518                 else if(which === 'end') {
519                     element = anchorElement;
520                     offset = selection.anchorOffset;
521                 }
522             }
523         } else {
524             // TODO: Handle order via https://developer.mozilla.org/en-US/docs/Web/API/Node.compareDocumentPosition
525             if(which === 'start') {
526                 element = anchorElement;
527                 offset = selection.anchorOffset
528             } else {
529                 element = focusElement;
530                 offset = selection.focusOffset
531             }
532         }
533
534         return {
535             element: element,
536             offset: offset,
537             offsetAtBeginning: offset === 0,
538             offsetAtEnd: element.getText().length === offset
539         }
540     }
541 })
542
543 return {
544     fromXML: function(xml, publisher) {
545         return new Canvas(xml, publisher);
546     }
547 };
548
549 });