editor: plugins/core - support for undo/redo selection restore in most actions
[fnpeditor.git] / src / editor / modules / documentCanvas / canvas / canvas.js
1 define([
2 'libs/jquery',
3 'libs/underscore',
4 'libs/backbone',
5 'fnpjs/logging/logging',
6 'modules/documentCanvas/canvas/documentElement',
7 'modules/documentCanvas/canvas/keyboard',
8 'modules/documentCanvas/canvas/utils',
9 'modules/documentCanvas/canvas/wlxmlListener',
10 'modules/documentCanvas/canvas/elementsRegister',
11 'modules/documentCanvas/canvas/genericElement',
12 ], function($, _, Backbone, logging, documentElement, keyboard, utils, wlxmlListener, ElementsRegister, genericElement) {
13     
14 'use strict';
15 /* global document:false, window:false, Node:false, gettext */
16
17 var logger = logging.getLogger('canvas');
18
19 var TextHandler = function(canvas) {this.canvas = canvas; this.buffer = null;};
20 $.extend(TextHandler.prototype, {
21     handle: function(node, text) {
22         this.setText(text, node);
23         // return;
24         // if(!this.node) {
25         //     this.node = node;
26         // }
27         // if(this.node.sameNode(node)) {
28         //     this._ping(text);
29         // } else {
30         //     this.flush();
31         //     this.node = node;
32         //     this._ping(text);
33         // }
34     },
35     _ping: _.throttle(function(text) {
36         this.buffer = text;
37         this.flush();
38     }, 1000),
39     flush: function() {
40         if(this.buffer !== null) {
41             this.setText(this.buffer, this.node);
42             this.buffer = null;
43         }
44     },
45     setText: function(text, node) {
46         //this.canvas.wlxmlDocument.transform('setText', {node:node, text: text});
47         node.document.transaction(function() {
48             node.setText(text);
49         }, {
50             metadata:{
51                 description: gettext('Changing text')
52             }
53         });
54
55     }
56
57 });
58
59
60 var Canvas = function(wlxmlDocument, elements) {
61     this.elementsRegister = new ElementsRegister(documentElement.DocumentNodeElement);
62
63     elements = [
64         {tag: 'section', klass: null, prototype: genericElement},
65         {tag: 'div', klass: null, prototype: genericElement},
66         {tag: 'header', klass: null, prototype: genericElement},
67         {tag: 'span', klass: null, prototype: genericElement},
68         {tag: 'aside', klass: null, prototype: genericElement}
69     ].concat(elements || []);
70
71     (elements).forEach(function(elementDesc) {
72         this.elementsRegister.register(elementDesc);
73     }.bind(this));
74     this.eventBus = _.extend({}, Backbone.Events);
75     this.wrapper = $('<div>').addClass('canvas-wrapper').attr('contenteditable', true);
76     this.wlxmlListener = wlxmlListener.create(this);
77     this.loadWlxmlDocument(wlxmlDocument);
78     this.setupEventHandling();
79     this.textHandler = new TextHandler(this);
80 };
81
82 $.extend(Canvas.prototype, Backbone.Events, {
83
84     loadWlxmlDocument: function(wlxmlDocument) {
85         if(!wlxmlDocument) {
86             return false;
87         }
88
89         this.wlxmlListener.listenTo(wlxmlDocument);
90         this.wlxmlDocument = wlxmlDocument;
91         this.reloadRoot();
92     },
93
94     createElement: function(wlxmlNode) {
95         var Factory;
96         if(wlxmlNode.nodeType === Node.TEXT_NODE) {
97             Factory = documentElement.DocumentTextElement;
98         } else {
99             Factory = this.elementsRegister.getElement({tag: wlxmlNode.getTagName(), klass: wlxmlNode.getClass()});
100         }
101         return new Factory(wlxmlNode, this);
102     },
103
104     getDocumentElement: function(htmlElement) {
105         /* globals HTMLElement, Text */
106         if(!htmlElement || !(htmlElement instanceof HTMLElement || htmlElement instanceof Text)) {
107             return null;
108         }
109         var $element = $(htmlElement);
110         if(htmlElement.nodeType === Node.ELEMENT_NODE && $element.attr('document-node-element') !== undefined) {
111             return $element.data('canvas-element');
112         }
113
114         if(htmlElement.nodeType === Node.TEXT_NODE && $element.parent().attr('document-text-element') !== undefined) {
115             $element = $element.parent();
116         }
117
118         if($element.attr('document-text-element') !== undefined || (htmlElement.nodeType === Node.TEXT_NODE && $element.parent().attr('document-text-element') !== undefined)) {
119             //return DocumentTextElement.fromHTMLElement(htmlElement, canvas);
120             return $element.data('canvas-element');
121         }
122     },
123
124     reloadRoot: function() {
125         this.rootElement = this.createElement(this.wlxmlDocument.root);
126         this.wrapper.empty();
127         this.wrapper.append(this.rootElement.dom);
128     },
129
130     setupEventHandling: function() {
131         var canvas = this;
132
133         this.wrapper.on('keyup keydown keypress', function(e) {
134             keyboard.handleKey(e, canvas);
135         });
136
137         this.wrapper.on('mouseup', function() {
138             canvas.triggerSelectionChanged();
139         });
140
141         var mouseDown;
142         this.wrapper.on('mousedown', '[document-node-element], [document-text-element]', function(e) {
143             mouseDown = e.target;
144         });
145
146         this.wrapper.on('click', '[document-node-element], [document-text-element]', function(e) {
147             e.stopPropagation();
148             if(e.originalEvent.detail === 3) {
149                 e.preventDefault();
150                 canvas._moveCaretToTextElement(canvas.getDocumentElement(e.currentTarget), 'whole');
151             } else {
152                 if(mouseDown === e.target) {
153                     canvas.setCurrentElement(canvas.getDocumentElement(e.currentTarget), {caretTo: false});
154                 }
155             }
156         });
157
158         this.wrapper.on('paste', function(e) {
159             e.preventDefault();
160
161             var clipboardData = e.originalEvent.clipboardData;
162             if(!clipboardData || !clipboardData.getData) {
163                 return; // TODO: alert
164             }
165
166             var text = clipboardData.getData('text/plain').replace(/\r?\n|\r/g, ' '),
167                 cursor = canvas.getCursor(),
168                 element = cursor.getPosition().element,
169                 lhs, rhs;
170             
171             if(element && cursor.isWithinElement()) {
172                 lhs = element.getText().substr(0, cursor.getSelectionStart().offset);
173                 rhs = element.getText().substr(cursor.getSelectionEnd().offset);
174                 element.setText(lhs+text+rhs);
175                 canvas.setCurrentElement(element, {caretTo: lhs.length + text.length});
176             } else {
177                 /* jshint noempty:false */
178                 // TODO: alert
179             }
180         });
181
182         /* globals MutationObserver */
183         var observer = new MutationObserver(function(mutations) {
184             mutations.forEach(function(mutation) {
185                 if(documentElement.DocumentTextElement.isContentContainer(mutation.target)) {
186                     observer.disconnect();
187                     if(mutation.target.data === '') {
188                         mutation.target.data = utils.unicode.ZWS;
189                     }
190                     else if(mutation.oldValue === utils.unicode.ZWS) {
191                         mutation.target.data = mutation.target.data.replace(utils.unicode.ZWS, '');
192                         canvas._moveCaretToTextElement(canvas.getDocumentElement(mutation.target), 'end');
193                     }
194                     observer.observe(canvas.wrapper[0], config);
195
196                     var textElement = canvas.getDocumentElement(mutation.target),
197                         toSet = mutation.target.data !== utils.unicode.ZWS ? mutation.target.data : '';
198
199                     //textElement.data('wlxmlNode').setText(toSet);
200                     //textElement.data('wlxmlNode').document.transform('setText', {node: textElement.data('wlxmlNode'), text: toSet});
201                     if(textElement.wlxmlNode.getText() !== toSet) {
202                         canvas.textHandler.handle(textElement.wlxmlNode, toSet);
203                     }
204                 }
205             });
206         });
207         var config = { attributes: false, childList: false, characterData: true, subtree: true, characterDataOldValue: true};
208         observer.observe(this.wrapper[0], config);
209
210
211         this.wrapper.on('mouseover', '[document-node-element], [document-text-element]', function(e) {
212             var el = canvas.getDocumentElement(e.currentTarget);
213             if(!el) {
214                 return;
215             }
216             e.stopPropagation();
217             if(el instanceof documentElement.DocumentTextElement) {
218                 el = el.parent();
219             }
220             el.toggleLabel(true);
221         });
222         this.wrapper.on('mouseout', '[document-node-element], [document-text-element]', function(e) {
223             var el = canvas.getDocumentElement(e.currentTarget);
224             if(!el) {
225                 return;
226             }
227             e.stopPropagation();
228             if(el instanceof documentElement.DocumentTextElement) {
229                 el = el.parent();
230             }
231             el.toggleLabel(false);
232         });
233
234         this.eventBus.on('elementToggled', function(toggle, element) {
235             if(!toggle) {
236                 canvas.setCurrentElement(canvas.getPreviousTextElement(element));
237             }
238         });
239     },
240
241     view: function() {
242         return this.wrapper;
243     },
244
245     doc: function() {
246         return this.rootElement;
247     },
248
249     toggleElementHighlight: function(node, toggle) {
250         var element = utils.getElementForNode(node);
251         element.toggleHighlight(toggle);
252     },
253
254     getCursor: function() {
255         return new Cursor(this);
256     },
257
258     
259     getCurrentNodeElement: function() {
260         var htmlElement = this.wrapper.find('.current-node-element').parent()[0];
261         if(htmlElement) {
262             return this.getDocumentElement(htmlElement);
263         }
264     },
265
266     getCurrentTextElement: function() {
267         var htmlElement = this.wrapper.find('.current-text-element')[0];
268         if(htmlElement) {
269             return this.getDocumentElement(htmlElement);
270         }
271     },
272
273     getPreviousTextElement: function(relativeToElement, includeInvisible) {
274         return this.getNearestTextElement('above', relativeToElement, includeInvisible);
275     },
276
277     getNextTextElement: function(relativeToElement, includeInvisible) {
278         return this.getNearestTextElement('below', relativeToElement, includeInvisible);
279     },
280
281     getNearestTextElement: function(direction, relativeToElement, includeInvisible) {
282         includeInvisible = includeInvisible !== undefined ? includeInvisible : false;
283         var selector = '[document-text-element]' + (includeInvisible ? '' : ':visible');
284         return this.getDocumentElement(utils.nearestInDocumentOrder(selector, direction, relativeToElement.dom[0]));
285     },
286
287     contains: function(element) {
288         return element.dom.parents().index(this.wrapper) !== -1;
289     },
290
291     triggerSelectionChanged: function() {
292         this.trigger('selectionChanged', this.getSelection());
293         var s = this.getSelection(),
294             f = s.toDocumentFragment();
295         if(f && f instanceof f.RangeFragment) {
296                 var $current = this.wrapper.find('.current-node-element');
297                 var current = $current && this.getDocumentElement($current.parent()[0]);
298                 
299                 if($current) {
300                     $current.removeClass('current-node-element');
301                 }
302                 if(current) {
303                     current.markAsCurrent(false);
304                 }
305         }
306     },
307
308     getSelection: function() {
309         return new Selection(this);
310     },
311
312     select: function(fragment) {
313         if(fragment instanceof this.wlxmlDocument.RangeFragment) {
314             this.setCurrentElement(fragment.endNode, {caretTo: fragment.endOffset});
315         } else if(fragment instanceof this.wlxmlDocument.NodeFragment) {
316             var params = {
317                 caretTo: fragment instanceof this.wlxmlDocument.CaretFragment ? fragment.offset : 'start'
318             };
319             this.setCurrentElement(fragment.node, params);
320         } else {
321             logger.debug('Fragment not supported');
322         }
323     },
324
325     setCurrentElement: function(element, params) {
326         if(!element) {
327             logger.debug('Invalid element passed to setCurrentElement: ' + element);
328             return;
329         }
330
331         if(!(element instanceof documentElement.DocumentElement)) {
332             element = utils.getElementForNode(element);
333         }
334
335         if(!element || !this.contains(element)) {
336             logger.warning('Cannot set current element: element doesn\'t exist on canvas');
337             return;
338         }
339
340         params = _.extend({caretTo: 'end'}, params);
341         var findFirstDirectTextChild = function(e, nodeToLand) {
342             var byBrowser = this.getCursor().getPosition().element;
343             if(byBrowser && byBrowser.parent().sameNode(nodeToLand)) {
344                 return byBrowser;
345             }
346             return e.getVerticallyFirstTextElement();
347         }.bind(this);
348         var _markAsCurrent = function(element) {
349             if(element instanceof documentElement.DocumentTextElement) {
350                 this.wrapper.find('.current-text-element').removeClass('current-text-element');
351                 element.dom.addClass('current-text-element');
352             } else {
353                 var $current = this.wrapper.find('.current-node-element');
354                 var current = this.getDocumentElement($current.parent()[0]);
355                 $current.removeClass('current-node-element');
356
357                 if(current) {
358                     current.markAsCurrent(false);
359                 }
360                 element._container().addClass('current-node-element');
361                 element.markAsCurrent(true);
362             }
363         }.bind(this);
364
365
366         var isTextElement = element instanceof documentElement.DocumentTextElement,
367             nodeElementToLand = isTextElement ? element.parent() : element,
368             textElementToLand = isTextElement ? element : findFirstDirectTextChild(element, nodeElementToLand),
369             currentTextElement = this.getCurrentTextElement(),
370             currentNodeElement = this.getCurrentNodeElement();
371
372         if(currentTextElement && !(currentTextElement.sameNode(textElementToLand))) {
373             this.wrapper.find('.current-text-element').removeClass('current-text-element');
374         }
375
376         if(textElementToLand) {
377             _markAsCurrent(textElementToLand);
378             if(params.caretTo || !textElementToLand.sameNode(this.getCursor().getPosition().element)) {
379                 this._moveCaretToTextElement(textElementToLand, params.caretTo); // as method on element?
380             }
381         } else {
382             document.getSelection().removeAllRanges();
383         }
384
385         if(!(currentNodeElement && currentNodeElement.sameNode(nodeElementToLand))) {
386             _markAsCurrent(nodeElementToLand);
387         }
388         this.triggerSelectionChanged();
389     },
390
391     _moveCaretToTextElement: function(element, where) {
392         var range = document.createRange(),
393             node = element.dom.contents()[0];
394
395         if(typeof where !== 'number') {
396             range.selectNodeContents(node);
397         } else {
398             range.setStart(node, Math.min(node.data.length, where));
399         }
400         
401         if(where !== 'whole') {
402             var collapseArg = true;
403             if(where === 'end') {
404                 collapseArg = false;
405             }
406             range.collapse(collapseArg);
407         }
408         var selection = document.getSelection();
409
410         selection.removeAllRanges();
411         selection.addRange(range);
412         this.wrapper.focus(); // FF requires this for caret to be put where range colllapses, Chrome doesn't.
413     },
414
415     setCursorPosition: function(position) {
416         if(position.element) {
417             this._moveCaretToTextElement(position.element, position.offset);
418         }
419     },
420
421     toggleGrid: function() {
422         this.wrapper.toggleClass('grid-on');
423         this.trigger('changed');
424     },
425     isGridToggled: function() {
426         return this.wrapper.hasClass('grid-on');
427     }
428 });
429
430
431 var isText = function(node) {
432     return node && node.nodeType === Node.TEXT_NODE && $(node.parentNode).is('[document-text-element]');
433 };
434
435 var Selection = function(canvas) {
436     this.canvas = canvas;
437     var nativeSelection = this.nativeSelection = window.getSelection();
438     Object.defineProperty(this, 'type', {
439         get: function() {
440             if(nativeSelection.focusNode) {
441                 if(nativeSelection.isCollapsed && isText(nativeSelection.focusNode)) {
442                     return 'caret';
443                 }
444                 if(isText(nativeSelection.focusNode) && isText(nativeSelection.anchorNode)) {
445                     return 'textSelection';
446                 }
447             }
448             if(canvas.getCurrentNodeElement()) {
449                 return 'node';
450             }
451         }
452     });
453 };
454
455 $.extend(Selection.prototype, {
456     toDocumentFragment: function() {
457         var doc = this.canvas.wlxmlDocument,
458             anchorElement = this.canvas.getDocumentElement(this.nativeSelection.anchorNode),
459             focusElement = this.canvas.getDocumentElement(this.nativeSelection.focusNode),
460             anchorNode = anchorElement ? anchorElement.wlxmlNode : null,
461             focusNode = focusElement ? focusElement.wlxmlNode : null;
462         if(this.type === 'caret') {
463             return doc.createFragment(doc.CaretFragment, {node: anchorNode, offset: this.nativeSelection.anchorOffset});
464         }
465         if(this.type === 'textSelection') {
466             if(anchorNode.isSiblingOf(focusNode)) {
467                 return doc.createFragment(doc.TextRangeFragment, {
468                     node1: anchorNode,
469                     offset1: this.nativeSelection.anchorOffset,
470                     node2: focusNode,
471                     offset2: this.nativeSelection.focusOffset,
472                 });
473             }
474             else {
475                 var siblingParents = doc.getSiblingParents({node1: anchorNode, node2: focusNode});
476                 return doc.createFragment(doc.RangeFragment, {
477                     node1: siblingParents.node1,
478                     node2: siblingParents.node2
479                 });
480             }
481         }
482         if(this.type === 'node') {
483             return doc.createFragment(doc.NodeFragment, {node: this.canvas.getCurrentNodeElement().wlxmlNode});
484         }
485     },
486     sameAs: function(other) {
487         void(other);
488     }
489 });
490
491 var Cursor = function(canvas) {
492     this.canvas = canvas;
493     this.selection = window.getSelection();
494 };
495
496 $.extend(Cursor.prototype, {
497     sameAs: function(other) {
498         var same = true;
499         if(!other) {
500             return false;
501         }
502
503         ['focusNode', 'focusOffset', 'anchorNode', 'anchorOffset'].some(function(prop) {
504             same = same && this.selection[prop] === other.selection[prop];
505             if(!same) {
506                 return true; // break
507             }
508         }.bind(this));
509
510         return same;
511     },
512     isSelecting: function() {
513         var selection = window.getSelection();
514         return !selection.isCollapsed;
515     },
516     isSelectingWithinElement: function() {
517         return this.isSelecting() && this.getSelectionStart().element.sameNode(this.getSelectionEnd().element);
518     },
519     isWithinElement: function() {
520         return !this.isSelecting() || this.isSelectingWithinElement();
521     },
522     isSelectingSiblings: function() {
523         return this.isSelecting() && this.getSelectionStart().element.parent().sameNode(this.getSelectionEnd().element.parent());
524     },
525     getPosition: function() {
526         return this.getSelectionAnchor();
527     },
528     getSelectionStart: function() {
529         return this.getSelectionBoundry('start');
530     },
531     getSelectionEnd: function() {
532         return this.getSelectionBoundry('end');
533     },
534     getSelectionAnchor: function() {
535         return this.getSelectionBoundry('anchor');
536     },
537     getSelectionFocus: function() {
538         return this.getSelectionBoundry('focus');
539     },
540     getSelectionBoundry: function(which) {
541         /* globals window */
542         var selection = window.getSelection(),
543             anchorElement = this.canvas.getDocumentElement(selection.anchorNode),
544             focusElement = this.canvas.getDocumentElement(selection.focusNode);
545         
546         if((!anchorElement) || (anchorElement instanceof documentElement.DocumentNodeElement) || (!focusElement) || focusElement instanceof documentElement.DocumentNodeElement) {
547             return {};
548         }
549
550         if(which === 'anchor') {
551             return {
552                 element: anchorElement,
553                 offset: selection.anchorOffset,
554                 offsetAtBeginning: selection.anchorOffset === 0 || anchorElement.getText() === '',
555                 offsetAtEnd: selection.anchorNode.data.length === selection.anchorOffset || anchorElement.getText() === ''
556             };
557         }
558         if(which === 'focus') {
559             return {
560                 element: focusElement,
561                 offset: selection.focusOffset,
562                 offsetAtBeginning: selection.focusOffset === 0 || focusElement.getText() === '',
563                 offsetAtEnd: selection.focusNode.data.length === selection.focusOffset || focusElement.getText() === '',
564             };
565         }
566         
567         var getPlaceData = function(anchorFirst) {
568             var element, offset;
569             if(anchorFirst) {
570                 if(which === 'start') {
571                     element = anchorElement;
572                     offset = selection.anchorOffset;
573                 }
574                 else if(which === 'end') {
575                     element = focusElement;
576                     offset = selection.focusOffset;
577                 }
578             } else {
579                 if(which === 'start') {
580                     element = focusElement;
581                     offset = selection.focusOffset;
582                 }
583                 else if(which === 'end') {
584                     element = anchorElement;
585                     offset = selection.anchorOffset;
586                 }
587             }
588             return {element: element, offset: offset};
589         };
590
591         var anchorFirst, placeData, parent;
592
593         if(anchorElement.parent().sameNode(focusElement.parent())) {
594             parent = anchorElement.parent();
595             if(selection.anchorNode === selection.focusNode) {
596                 anchorFirst = selection.anchorOffset <= selection.focusOffset;
597             } else {
598                 anchorFirst = (parent.getFirst(anchorElement, focusElement) === anchorElement);
599             }
600             placeData = getPlaceData(anchorFirst);
601         } else {
602             /*jshint bitwise: false*/
603             anchorFirst = selection.anchorNode.compareDocumentPosition(selection.focusNode) & Node.DOCUMENT_POSITION_FOLLOWING;
604             placeData = getPlaceData(anchorFirst);
605         }
606
607         var nodeLen = (placeData.element.sameNode(focusElement) ? selection.focusNode : selection.anchorNode).length;
608         return {
609             element: placeData.element,
610             offset: placeData.offset,
611             offsetAtBeginning: placeData.offset === 0 || focusElement.getText() === '',
612             offsetAtEnd: nodeLen === placeData.offset || focusElement.getText() === ''
613         };
614     }
615 });
616
617 return {
618     fromXMLDocument: function(wlxmlDocument, elements) {
619         return new Canvas(wlxmlDocument, elements);
620     }
621 };
622
623 });