bcfc95424b32c6a0b04c2f0d8cc5de79fe5dd46f
[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, genericElement);
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.findCanvasElement(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     },
294
295     getSelection: function() {
296         return new Selection(this);
297     },
298
299     setCurrentElement: function(element, params) {
300         if(!element) {
301             logger.debug('Invalid element passed to setCurrentElement: ' + element);
302             return;
303         }
304
305         if(!(element instanceof documentElement.DocumentElement)) {
306             element = utils.findCanvasElement(element);
307         }
308
309         if(!element || !this.contains(element)) {
310             logger.warning('Cannot set current element: element doesn\'t exist on canvas');
311             return;
312         }
313
314         params = _.extend({caretTo: 'end'}, params);
315         var findFirstDirectTextChild = function(e, nodeToLand) {
316             var byBrowser = this.getCursor().getPosition().element;
317             if(byBrowser && byBrowser.parent().sameNode(nodeToLand)) {
318                 return byBrowser;
319             }
320             var children = e.children();
321             for(var i = 0; i < children.length; i++) {
322                 if(children[i] instanceof documentElement.DocumentTextElement) {
323                     return children[i];
324                 }
325             }
326             return null;
327         }.bind(this);
328         var _markAsCurrent = function(element) {
329             if(element instanceof documentElement.DocumentTextElement) {
330                 this.wrapper.find('.current-text-element').removeClass('current-text-element');
331                 element.dom.addClass('current-text-element');
332             } else {
333                 this.wrapper.find('.current-node-element').removeClass('current-node-element');
334                 element._container().addClass('current-node-element');
335             }
336         }.bind(this);
337
338
339         var isTextElement = element instanceof documentElement.DocumentTextElement,
340             nodeElementToLand = isTextElement ? element.parent() : element,
341             textElementToLand = isTextElement ? element : findFirstDirectTextChild(element, nodeElementToLand),
342             currentTextElement = this.getCurrentTextElement(),
343             currentNodeElement = this.getCurrentNodeElement();
344
345         if(currentTextElement && !(currentTextElement.sameNode(textElementToLand))) {
346             this.wrapper.find('.current-text-element').removeClass('current-text-element');
347         }
348
349         if(textElementToLand) {
350             _markAsCurrent(textElementToLand);
351             if(params.caretTo || !textElementToLand.sameNode(this.getCursor().getPosition().element)) {
352                 this._moveCaretToTextElement(textElementToLand, params.caretTo); // as method on element?
353             }
354         } else {
355             document.getSelection().removeAllRanges();
356         }
357
358         if(!(currentNodeElement && currentNodeElement.sameNode(nodeElementToLand))) {
359             _markAsCurrent(nodeElementToLand);
360         }
361         this.triggerSelectionChanged();
362     },
363
364     _moveCaretToTextElement: function(element, where) {
365         var range = document.createRange(),
366             node = element.dom.contents()[0];
367
368         if(typeof where !== 'number') {
369             range.selectNodeContents(node);
370         } else {
371             range.setStart(node, Math.min(node.data.length, where));
372         }
373         
374         if(where !== 'whole') {
375             var collapseArg = true;
376             if(where === 'end') {
377                 collapseArg = false;
378             }
379             range.collapse(collapseArg);
380         }
381         var selection = document.getSelection();
382
383         selection.removeAllRanges();
384         selection.addRange(range);
385         this.wrapper.focus(); // FF requires this for caret to be put where range colllapses, Chrome doesn't.
386     },
387
388     setCursorPosition: function(position) {
389         if(position.element) {
390             this._moveCaretToTextElement(position.element, position.offset);
391         }
392     },
393
394     findCanvasElement: function(node) {
395         return utils.findCanvasElement(node);
396     },
397
398     toggleGrid: function() {
399         this.wrapper.toggleClass('grid-on');
400         this.trigger('changed');
401     },
402     isGridToggled: function() {
403         return this.wrapper.hasClass('grid-on');
404     }
405 });
406
407
408 var isText = function(node) {
409     return node && node.nodeType === Node.TEXT_NODE && $(node.parentNode).is('[document-text-element]');
410 };
411
412 var Selection = function(canvas) {
413     this.canvas = canvas;
414     var nativeSelection = this.nativeSelection = window.getSelection();
415     Object.defineProperty(this, 'type', {
416         get: function() {
417             if(nativeSelection.focusNode) {
418                 if(nativeSelection.isCollapsed && isText(nativeSelection.focusNode)) {
419                     return 'caret';
420                 }
421                 if(isText(nativeSelection.focusNode) && isText(nativeSelection.anchorNode)) {
422                     return 'textSelection';
423                 }
424             }
425             if(canvas.getCurrentNodeElement()) {
426                 return 'node';
427             }
428         }
429     });
430 };
431
432 $.extend(Selection.prototype, {
433     toDocumentFragment: function() {
434         var doc = this.canvas.wlxmlDocument,
435             anchorElement = this.canvas.getDocumentElement(this.nativeSelection.anchorNode),
436             focusElement = this.canvas.getDocumentElement(this.nativeSelection.focusNode),
437             anchorNode = anchorElement ? anchorElement.wlxmlNode : null,
438             focusNode = focusElement ? focusElement.wlxmlNode : null;
439         if(this.type === 'caret') {
440             return doc.createFragment(doc.CaretFragment, {node: anchorNode, offset: this.nativeSelection.anchorOffset});
441         }
442         if(this.type === 'textSelection') {
443             if(anchorNode.isSiblingOf(focusNode)) {
444                 return doc.createFragment(doc.TextRangeFragment, {
445                     node1: anchorNode,
446                     offset1: this.nativeSelection.anchorOffset,
447                     node2: focusNode,
448                     offset2: this.nativeSelection.focusOffset,
449                 });
450             }
451             else {
452                 var siblingParents = doc.getSiblingParents({node1: anchorNode, node2: focusNode});
453                 return doc.createFragment(doc.RangeFragment, {
454                     node1: siblingParents.node1,
455                     node2: siblingParents.node2
456                 });
457             }
458         }
459         if(this.type === 'node') {
460             return doc.createFragment(doc.NodeFragment, {node: this.canvas.getCurrentNodeElement().wlxmlNode});
461         }
462     },
463     sameAs: function(other) {
464         void(other);
465     }
466 });
467
468 var Cursor = function(canvas) {
469     this.canvas = canvas;
470     this.selection = window.getSelection();
471 };
472
473 $.extend(Cursor.prototype, {
474     sameAs: function(other) {
475         var same = true;
476         if(!other) {
477             return false;
478         }
479
480         ['focusNode', 'focusOffset', 'anchorNode', 'anchorOffset'].some(function(prop) {
481             same = same && this.selection[prop] === other.selection[prop];
482             if(!same) {
483                 return true; // break
484             }
485         }.bind(this));
486
487         return same;
488     },
489     isSelecting: function() {
490         var selection = window.getSelection();
491         return !selection.isCollapsed;
492     },
493     isSelectingWithinElement: function() {
494         return this.isSelecting() && this.getSelectionStart().element.sameNode(this.getSelectionEnd().element);
495     },
496     isWithinElement: function() {
497         return !this.isSelecting() || this.isSelectingWithinElement();
498     },
499     isSelectingSiblings: function() {
500         return this.isSelecting() && this.getSelectionStart().element.parent().sameNode(this.getSelectionEnd().element.parent());
501     },
502     getPosition: function() {
503         return this.getSelectionAnchor();
504     },
505     getSelectionStart: function() {
506         return this.getSelectionBoundry('start');
507     },
508     getSelectionEnd: function() {
509         return this.getSelectionBoundry('end');
510     },
511     getSelectionAnchor: function() {
512         return this.getSelectionBoundry('anchor');
513     },
514     getSelectionFocus: function() {
515         return this.getSelectionBoundry('focus');
516     },
517     getSelectionBoundry: function(which) {
518         /* globals window */
519         var selection = window.getSelection(),
520             anchorElement = this.canvas.getDocumentElement(selection.anchorNode),
521             focusElement = this.canvas.getDocumentElement(selection.focusNode);
522         
523         if((!anchorElement) || (anchorElement instanceof documentElement.DocumentNodeElement) || (!focusElement) || focusElement instanceof documentElement.DocumentNodeElement) {
524             return {};
525         }
526
527         if(which === 'anchor') {
528             return {
529                 element: anchorElement,
530                 offset: selection.anchorOffset,
531                 offsetAtBeginning: selection.anchorOffset === 0 || anchorElement.getText() === '',
532                 offsetAtEnd: selection.anchorNode.data.length === selection.anchorOffset || anchorElement.getText() === ''
533             };
534         }
535         if(which === 'focus') {
536             return {
537                 element: focusElement,
538                 offset: selection.focusOffset,
539                 offsetAtBeginning: selection.focusOffset === 0 || focusElement.getText() === '',
540                 offsetAtEnd: selection.focusNode.data.length === selection.focusOffset || focusElement.getText() === '',
541             };
542         }
543         
544         var getPlaceData = function(anchorFirst) {
545             var element, offset;
546             if(anchorFirst) {
547                 if(which === 'start') {
548                     element = anchorElement;
549                     offset = selection.anchorOffset;
550                 }
551                 else if(which === 'end') {
552                     element = focusElement;
553                     offset = selection.focusOffset;
554                 }
555             } else {
556                 if(which === 'start') {
557                     element = focusElement;
558                     offset = selection.focusOffset;
559                 }
560                 else if(which === 'end') {
561                     element = anchorElement;
562                     offset = selection.anchorOffset;
563                 }
564             }
565             return {element: element, offset: offset};
566         };
567
568         var anchorFirst, placeData, parent;
569
570         if(anchorElement.parent().sameNode(focusElement.parent())) {
571             parent = anchorElement.parent();
572             if(selection.anchorNode === selection.focusNode) {
573                 anchorFirst = selection.anchorOffset <= selection.focusOffset;
574             } else {
575                 anchorFirst = parent.childIndex(anchorElement) < parent.childIndex(focusElement);
576             }
577             placeData = getPlaceData(anchorFirst);
578         } else {
579             /*jshint bitwise: false*/
580             anchorFirst = selection.anchorNode.compareDocumentPosition(selection.focusNode) & Node.DOCUMENT_POSITION_FOLLOWING;
581             placeData = getPlaceData(anchorFirst);
582         }
583
584         var nodeLen = (placeData.element.sameNode(focusElement) ? selection.focusNode : selection.anchorNode).length;
585         return {
586             element: placeData.element,
587             offset: placeData.offset,
588             offsetAtBeginning: placeData.offset === 0 || focusElement.getText() === '',
589             offsetAtEnd: nodeLen === placeData.offset || focusElement.getText() === ''
590         };
591     }
592 });
593
594 return {
595     fromXMLDocument: function(wlxmlDocument, elements) {
596         return new Canvas(wlxmlDocument, elements);
597     }
598 };
599
600 });