Refactoring - moving key event handlers out of canvas object

[fnpeditor.git] / modules / documentCanvas / canvas / canvas.js

diff --git a/modules/documentCanvas/canvas/canvas.js b/modules/documentCanvas/canvas/canvas.js
index ad294b8..4b43c8c 100644 (file)
--- a/modules/documentCanvas/canvas/canvas.js
+++ b/modules/documentCanvas/canvas/canvas.js
@@ -1,13 +1,18 @@
 define([
 'libs/jquery-1.9.1.min',
 'libs/underscore-min',
 define([
 'libs/jquery-1.9.1.min',
 'libs/underscore-min',

-'modules/documentCanvas/canvas/documentElement'
-], function($, _, documentElement) {
+'libs/backbone-min',
+'modules/documentCanvas/canvas/documentElement',
+'modules/documentCanvas/canvas/keyboard',
+'modules/documentCanvas/canvas/utils'
+], function($, _, Backbone, documentElement, keyboard, utils) {

     
 'use strict';
 
     
 'use strict';
 

-var Canvas = function(wlxml) {
+var Canvas = function(wlxml, publisher) {
+    this.eventBus = _.extend({}, Backbone.Events);

     this.loadWlxml(wlxml);
     this.loadWlxml(wlxml);

+    this.publisher = publisher ? publisher : function() {};

 };
 
 $.extend(Canvas.prototype, {
 };
 
 $.extend(Canvas.prototype, {


@@ -15,64 +20,195 @@ $.extend(Canvas.prototype, {
     loadWlxml: function(wlxml) {
         var d = wlxml ? $($.trim(wlxml)) : null;
         if(d) {
     loadWlxml: function(wlxml) {
         var d = wlxml ? $($.trim(wlxml)) : null;
         if(d) {

-            var wrapper = $('<div>');
-            wrapper.append(d);
-            
-            wrapper.find('*').replaceWith(function() {
+            this.wrapper = $('<div>').addClass('canvas-wrapper').attr('contenteditable', true);
+            this.wrapper.append(d);
+            var canvas = this;
+
+            this.wrapper.find('*').replaceWith(function() {

                 var currentTag = $(this);
                 if(currentTag.attr('wlxml-tag'))
                     return;
                 var currentTag = $(this);
                 if(currentTag.attr('wlxml-tag'))
                     return;

-                var toret = $('<div>').attr('wlxml-tag', currentTag.prop('tagName').toLowerCase());
-                //toret.attr('id', 'xxxxxxxx-xxxx-xxxx-yxxx-xxxxxxxxxxxx'.replace(/[xy]/g, function(c) {var r = Math.random()*16|0,v=c=='x'?r:r&0x3|0x8;return v.toString(16);}));
+
+                var meta = {}, others = {};

                 for(var i = 0; i < this.attributes.length; i++) {
                 for(var i = 0; i < this.attributes.length; i++) {

-                    var attr = this.attributes.item(i);
-                    var value = attr.name === 'class' ? attr.value.replace(/\./g, '-') : attr.value;
-                    toret.attr('wlxml-' + attr.name, value);
+                    var attr = this.attributes[i];
+                    if(attr.name.substr(0, 5) === 'meta-')
+                        meta[attr.name.substr(5)] = attr.value;
+                    else if(attr.name !== 'class')
+                        others[attr.name] = attr.value;

                 }
                 }

-                toret.append(currentTag.contents());
-                return toret;
+
+                var element = documentElement.DocumentNodeElement.create({
+                    tag: currentTag.prop('tagName').toLowerCase(),
+                    klass: currentTag.attr('class'),
+                    meta: meta,
+                    others: others,
+                    rawChildren: currentTag.contents(),
+                    prepopulateOnEmpty: true
+                }, canvas);
+
+                ['orig-before', 'orig-after', 'orig-begin', 'orig-end'].forEach(function(attr) {
+                    element.data(attr, '');
+                });
+                return element.dom();

             });
 
             });
 

-            wrapper.find(':not(iframe)').addBack().contents()
+            var FIRST_CONTENT_INDEX = 0;
+
+            // @@ TODO - refactor!
+            var getNode = function(element) {
+                return element.children('[document-element-content]');
+            }
+
+            this.wrapper.find(':not(iframe)').addBack().contents()

                 .filter(function() {return this.nodeType === Node.TEXT_NODE})
                 .each(function() {
 
                 .filter(function() {return this.nodeType === Node.TEXT_NODE})
                 .each(function() {
 

-                    var el = $(this);
-                    

                     // TODO: use DocumentElement API
                     // TODO: use DocumentElement API

-                    var spanParent = el.parent().attr('wlxml-tag') === 'span',
-                        spanBefore = el.prev().length > 0  && $(el.prev()[0]).attr('wlxml-tag') === 'span',
-                        spanAfter = el.next().length > 0 && $(el.next()[0]).attr('wlxml-tag') === 'span';
-                        
-                    if(spanParent || spanBefore || spanAfter) {
-                        var startSpace = /\s/g.test(this.data.substr(0,1));
-                        var endSpace = /\s/g.test(this.data.substr(-1)) && this.data.length > 1;
-                        var trimmed = $.trim(this.data);
-                        this.data = (startSpace && (spanParent || spanBefore) ? ' ' : '')
-                                    + trimmed
-                                    + (endSpace && (spanParent || spanAfter) ? ' ' : '');

 
 

+                    var el = $(this),
+                        text = {original: el.text(), trimmed: $.trim(el.text())},
+                        elParent = el.parent(),
+                        hasSpanParent = elParent.attr('wlxml-tag') === 'span',
+                        hasSpanBefore = el.prev().length > 0  && getNode($(el.prev()[0])).attr('wlxml-tag') === 'span',
+                        hasSpanAfter = el.next().length > 0 && getNode($(el.next()[0])).attr('wlxml-tag') === 'span';
+
+                    if(el.parent().hasClass('canvas-widget') || elParent.attr('document-text-element') !== undefined)
+                        return true; // continue
+
+                    var addInfo = function(toAdd, where) {
+                        var parentContents = elParent.contents(),
+                            idx = parentContents.index(el[0]),
+                            prev = idx > FIRST_CONTENT_INDEX ? parentContents[idx-1] : null,
+                            next = idx < parentContents.length - 1 ? parentContents[idx+1] : null,
+                            target, key;
+
+                        if(where === 'above') {
+                            target = prev ? $(prev) : elParent.parent();
+                            key = prev ? 'orig-after' : 'orig-begin';
+                        } else if(where === 'below') {
+                            target = next ? $(next) : elParent.parent();
+                            key = next ? 'orig-before' : 'orig-end';
+                        } else { throw new Object;}
+
+                        target.data(key, toAdd);
+                    }
+
+                    text.transformed = text.trimmed;
+                    
+                    if(hasSpanParent || hasSpanBefore || hasSpanAfter) {
+                        var startSpace = /\s/g.test(text.original.substr(0,1)),
+                            endSpace = /\s/g.test(text.original.substr(-1)) && text.original.length > 1;
+                        text.transformed = (startSpace && (hasSpanParent || hasSpanBefore) ? ' ' : '')
+                                    + text.trimmed
+                                    + (endSpace && (hasSpanParent || hasSpanAfter) ? ' ' : '');

                     } else {
                     } else {

-                        var oldLength = this.data.length;
-                        this.data = $.trim(this.data);
-                        if(this.data.length === 0 && oldLength > 0 && el.parent().contents().length === 1)
-                            this.data = ' ';
-                        if(this.data.length === 0)
-                            $(this).remove();
+                        if(text.trimmed.length === 0 && text.original.length > 0 && elParent.contents().length === 1)
+                            text.transformed = ' ';
+                    }
+
+                    if(!text.transformed) {
+                        addInfo(text.original, 'below');
+                        el.remove();
+                        return true; // continue
+                    }
+
+                    if(text.transformed !== text.original) {
+                        if(!text.trimmed) {
+                            addInfo(text.original, 'below');
+                        } else {
+                            var startingMatch = text.original.match(/^\s+/g),
+                                endingMatch = text.original.match(/\s+$/g),
+                                startingWhiteSpace = startingMatch ? startingMatch[0] : null,
+                                endingWhiteSpace = endingMatch ? endingMatch[0] : null;
+
+                            if(endingWhiteSpace) {
+                                if(text.transformed[text.transformed.length - 1] === ' ' && endingWhiteSpace[0] === ' ')
+                                    endingWhiteSpace = endingWhiteSpace.substr(1);
+                                addInfo(endingWhiteSpace, 'below');
+                            }
+
+                            if(startingWhiteSpace) {
+                                if(text.transformed[0] === ' ' && startingWhiteSpace[startingWhiteSpace.length-1] === ' ')
+                                    startingWhiteSpace = startingWhiteSpace.substr(0, startingWhiteSpace.length -1);
+                                addInfo(startingWhiteSpace, 'above');
+                            }
+                        }

                     }
                     }

+
+                    var element = documentElement.DocumentTextElement.create({text: text.transformed});
+                    el.replaceWith(element.dom());

                 });
             
                 });
             

-            this.d = wrapper.children(0);
-            this.d.unwrap();
+            this.d = this.wrapper.children(0);
+
+            this.wrapper.on('keyup keydown keypress', function(e) {
+                keyboard.handleKey(e, this);
+            }.bind(this));
+
+            this.wrapper.on('click', '[document-node-element], [document-text-element]', function(e) {
+                e.stopPropagation();
+                canvas.setCurrentElement(canvas.getDocumentElement(e.currentTarget), {caretTo: false});
+            });
+
+            var observer = new MutationObserver(function(mutations) {
+                mutations.forEach(function(mutation) {
+                    if(documentElement.DocumentTextElement.isContentContainer(mutation.target)) {
+                        observer.disconnect();
+                        if(mutation.target.data === '')
+                            mutation.target.data = utils.unicode.ZWS;
+                        else if(mutation.oldValue === utils.unicode.ZWS) {
+                            mutation.target.data = mutation.target.data.replace(utils.unicode.ZWS, '');
+                            canvas._moveCaretToTextElement(canvas.getDocumentElement(mutation.target), 'end');
+                        }
+                        observer.observe(canvas.d[0], config);
+                        canvas.publisher('contentChanged');
+                    }
+                });
+            });
+            var config = { attributes: false, childList: false, characterData: true, subtree: true, characterDataOldValue: true};
+            observer.observe(this.d[0], config);
+
+
+            this.wrapper.on('mouseover', '[document-node-element], [document-text-element]', function(e) {
+                var el = canvas.getDocumentElement(e.currentTarget);
+                if(!el)
+                    return;
+                e.stopPropagation();
+                if(el instanceof documentElement.DocumentTextElement)
+                    el = el.parent();
+                el.toggleLabel(true);
+            });
+            this.wrapper.on('mouseout', '[document-node-element], [document-text-element]', function(e) {
+                var el = canvas.getDocumentElement(e.currentTarget);
+                if(!el)
+                    return;
+                e.stopPropagation();
+                if(el instanceof documentElement.DocumentTextElement)
+                    el = el.parent();
+                el.toggleLabel(false);
+            });
+
+            this.eventBus.on('elementToggled', function(toggle, element) {
+                if(!toggle) {
+                    element = canvas.getDocumentElement(utils.nearestInDocumentOrder('[document-text-element]:visible', 'above', element.dom()[0]));
+                    canvas.setCurrentElement(element);
+                }
+            })
+

         } else {
             this.d = null;
         }
     },
 
         } else {
             this.d = null;
         }
     },
 

+    view: function() {
+        return this.wrapper;
+    },
+

     doc: function() {
         if(this.d === null)
             return null;
     doc: function() {
         if(this.d === null)
             return null;

-        return documentElement.wrap(this.d.get(0), this); //{wlxmlTag: this.d.prop('tagName')};
+        return documentElement.DocumentNodeElement.fromHTMLElement(this.d.get(0), this); //{wlxmlTag: this.d.prop('tagName')};

     },
 
     wrapText: function(params) {
     },
 
     wrapText: function(params) {


@@ -115,12 +251,165 @@ $.extend(Canvas.prototype, {
             wrapperElement.after({text: suffixOutside});
         return wrapperElement;
     },
             wrapperElement.after({text: suffixOutside});
         return wrapperElement;
     },

+
+    wrapElements: function(params) {
+        if(!(params.element1.parent().sameNode(params.element2.parent())))
+            return;
+
+        var parent = params.element1.parent(),
+            parentChildren = parent.children(),
+            wrapper = documentElement.DocumentNodeElement.create({
+                tag: params._with.tag,
+                klass: params._with.klass}),
+            idx1 = parent.childIndex(params.element1),
+            idx2 = parent.childIndex(params.element2);
+
+        if(idx1 > idx2) {
+            var tmp = idx1;
+            idx1 = idx2;
+            idx2 = tmp;
+        }
+
+        var insertingMethod, insertingTarget;
+        if(idx1 === 0) {
+            insertingMethod = 'prepend';
+            insertingTarget = parent;
+        } else {
+            insertingMethod = 'after';
+            insertingTarget = parentChildren[idx1-1];
+        }
+
+        for(var i = idx1; i <= idx2; i++) {
+            wrapper.append(parentChildren[i].detach());
+        }
+
+        insertingTarget[insertingMethod](wrapper);
+        return wrapper;
+    },
+
+    getSiblingParents: function(params) {
+        var parents1 = [params.element1].concat(params.element1.parents()).reverse(),
+            parents2 = [params.element2].concat(params.element2.parents()).reverse(),
+            noSiblingParents = null;
+
+        if(parents1.length === 0 || parents2.length === 0 || !(parents1[0].sameNode(parents2[0])))
+            return noSiblingParents;
+
+        var i;
+        for(i = 0; i < Math.min(parents1.length, parents2.length); i++) {
+            if(parents1[i].sameNode(parents2[i]))
+                continue;
+            break;
+        }
+        return {element1: parents1[i], element2: parents2[i]};
+    },
+

     getDocumentElement: function(from) {
     getDocumentElement: function(from) {

-        if(from instanceof HTMLElement) {
-           return documentElement.wrap(from, this);
+        if(from instanceof HTMLElement || from instanceof Text) {
+           return documentElement.DocumentElement.fromHTMLElement(from, this);

         }
     },
         }
     },

-    list: {}
+    getCursor: function() {
+        return new Cursor(this);
+    },
+
+    list: {},
+
+    
+    getCurrentNodeElement: function() {
+        return this.getDocumentElement(this.wrapper.find('.current-node-element').parent()[0]);
+    },
+
+    getCurrentTextElement: function() {
+        return this.getDocumentElement(this.wrapper.find('.current-text-element')[0]);
+    },
+
+
+
+    setCurrentElement: function(element, params) {
+        params = _.extend({caretTo: 'end'}, params);
+        var findFirstDirectTextChild = function(e, nodeToLand) {
+            var byBrowser = this.getCursor().getPosition().element;
+            if(byBrowser && byBrowser.parent().sameNode(nodeToLand))
+                return byBrowser;
+            var children = e.children();
+            for(var i = 0; i < children.length; i++) {
+                if(children[i] instanceof documentElement.DocumentTextElement)
+                    return children[i];
+            }
+            return null;
+        }.bind(this);
+        var _markAsCurrent = function(element) {
+            if(element instanceof documentElement.DocumentTextElement) {
+                this.wrapper.find('.current-text-element').removeClass('current-text-element');
+                element.dom().addClass('current-text-element');
+            } else {
+                this.wrapper.find('.current-node-element').removeClass('current-node-element')
+                element._container().addClass('current-node-element');
+                this.publisher('currentElementChanged', element);
+            }
+        }.bind(this);
+
+
+        var isTextElement = element instanceof documentElement.DocumentTextElement,
+            nodeElementToLand = isTextElement ? element.parent() : element,
+            textElementToLand = isTextElement ? element : findFirstDirectTextChild(element, nodeElementToLand),
+            currentTextElement = this.getCurrentTextElement(),
+            currentNodeElement = this.getCurrentNodeElement();
+
+        if(currentTextElement && !(currentTextElement.sameNode(textElementToLand)))
+            this.wrapper.find('.current-text-element').removeClass('current-text-element');
+
+        if(textElementToLand) {
+            _markAsCurrent(textElementToLand);
+            if(params.caretTo || !textElementToLand.sameNode(this.getCursor().getPosition().element))
+                this._moveCaretToTextElement(textElementToLand, params.caretTo); // as method on element?
+            if(!(textElementToLand.sameNode(currentTextElement)))
+                this.publisher('currentTextElementSet', textElementToLand);
+        } else {
+            document.getSelection().removeAllRanges();
+        }
+
+        if(!(currentNodeElement && currentNodeElement.sameNode(nodeElementToLand))) {
+            _markAsCurrent(nodeElementToLand);
+
+            this.publisher('currentNodeElementSet', nodeElementToLand);
+        }
+    },
+
+    _moveCaretToTextElement: function(element, where) {
+        var range = document.createRange(),
+            node = element.dom().contents()[0];
+
+        if(typeof where !== 'number') {
+            range.selectNodeContents(node);
+        } else {
+            range.setStart(node, where);
+        }
+        
+        var collapseArg = true;
+        if(where === 'end')
+            collapseArg = false;
+        range.collapse(collapseArg);
+        
+        var selection = document.getSelection();
+
+        selection.removeAllRanges();
+        selection.addRange(range);
+        this.wrapper.focus(); // FF requires this for caret to be put where range colllapses, Chrome doesn't.
+    },
+
+    setCursorPosition: function(position) {
+        if(position.element)
+            this._moveCaretToTextElement(position.element, position.offset);
+    },
+
+    toXML: function() {
+        var parent = $('<div>'),
+            parts = this.doc().toXML(0);
+        parent.append(parts);
+        return parent.html();
+    }

 });
 
 $.extend(Canvas.prototype.list, {
 });
 
 $.extend(Canvas.prototype.list, {


@@ -161,7 +450,8 @@ $.extend(Canvas.prototype.list, {
         
         var toret;
         if(parent.is('list')) {
         
         var toret;
         if(parent.is('list')) {

-            listElement.wrapWithNodeElement({tag: 'div', klass: 'item'});
+            var item = listElement.wrapWithNodeElement({tag: 'div', klass: 'item'});
+            item.exec('toggleBullet', false);

             toret = listElement.parent();
         } else {
             toret = listElement;
             toret = listElement.parent();
         } else {
             toret = listElement;


@@ -253,9 +543,111 @@ $.extend(Canvas.prototype.list, {
     }
 });
 
     }
 });
 

+
+var Cursor = function(canvas) {
+    this.canvas = canvas;
+};
+
+$.extend(Cursor.prototype, {
+    isSelecting: function() {
+        var selection = window.getSelection();
+        return !selection.isCollapsed;
+    },
+    isSelectingWithinElement: function() {
+        return this.isSelecting() && this.getSelectionStart().element.sameNode(this.getSelectionEnd().element);
+    },
+    isSelectingSiblings: function() {
+        return this.isSelecting() && this.getSelectionStart().element.parent().sameNode(this.getSelectionEnd().element.parent());
+    },
+    getPosition: function() {
+        return this.getSelectionAnchor();
+    },
+    getSelectionStart: function() {
+        return this.getSelectionBoundry('start');
+    },
+    getSelectionEnd: function() {
+        return this.getSelectionBoundry('end');
+    },
+    getSelectionAnchor: function() {
+        return this.getSelectionBoundry('anchor');
+    },
+    getSelectionFocus: function() {
+        return this.getSelectionBoundry('focus');
+    },
+    getSelectionBoundry: function(which) {
+        var selection = window.getSelection(),
+            anchorElement = this.canvas.getDocumentElement(selection.anchorNode),
+            focusElement = this.canvas.getDocumentElement(selection.focusNode);
+        
+        if((!anchorElement) || (anchorElement instanceof documentElement.DocumentNodeElement) || (!focusElement) || focusElement instanceof documentElement.DocumentNodeElement)
+            return {};
+
+        if(which === 'anchor') {
+            return {
+                element: anchorElement,
+                offset: selection.anchorOffset,
+                offsetAtBeginning: selection.anchorOffset === 0,
+                offsetAtEnd: selection.anchorNode.data.length === selection.anchorOffset
+            };
+        }
+        if(which === 'focus') {
+            return {
+                element: focusElement,
+                offset: selection.focusOffset,
+                offsetAtBeginning: selection.focusOffset === 0,
+                offsetAtEnd: selection.focusNode.data.length === selection.focusOffset
+            };
+        }
+        
+        var element,
+            offset;
+
+        if(anchorElement.parent().sameNode(focusElement.parent())) {
+            var parent = anchorElement.parent(),
+                anchorFirst = parent.childIndex(anchorElement) < parent.childIndex(focusElement);
+            if(anchorFirst) {
+                if(which === 'start') {
+                    element = anchorElement;
+                    offset = selection.anchorOffset
+                }
+                else if(which === 'end') {
+                    element = focusElement,
+                    offset = selection.focusOffset
+                }
+            } else {
+                if(which === 'start') {
+                    element = focusElement,
+                    offset = selection.focusOffset
+                }
+                else if(which === 'end') {
+                    element = anchorElement;
+                    offset = selection.anchorOffset
+                }
+            }
+        } else {
+            // TODO: Handle order via https://developer.mozilla.org/en-US/docs/Web/API/Node.compareDocumentPosition
+            if(which === 'start') {
+                element = anchorElement;
+                offset = selection.anchorOffset
+            } else {
+                element = focusElement;
+                offset = selection.focusOffset
+            }
+        }
+
+        var nodeLen = (element.sameNode(focusElement) ? selection.focusNode : selection.anchorNode).length;
+        return {
+            element: element,
+            offset: offset,
+            offsetAtBeginning: offset === 0,
+            offsetAtEnd: nodeLen === offset
+        }
+    }
+})
+

 return {
 return {

-    fromXML: function(xml) {
-        return new Canvas(xml);
+    fromXML: function(xml, publisher) {
+        return new Canvas(xml, publisher);

     }
 };
 
     }
 };