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