Fixing xml output after removing text with white space
[fnpeditor.git] / modules / documentCanvas / canvas / canvas.js
index 3eb4c6e..19c2a3f 100644 (file)
@@ -6,8 +6,9 @@ define([
     
 'use strict';
 
-var Canvas = function(wlxml) {
+var Canvas = function(wlxml, publisher) {
     this.loadWlxml(wlxml);
+    this.publisher = publisher ? publisher : function() {};
 };
 
 $.extend(Canvas.prototype, {
@@ -15,64 +16,157 @@ $.extend(Canvas.prototype, {
     loadWlxml: function(wlxml) {
         var d = wlxml ? $($.trim(wlxml)) : null;
         if(d) {
-            var wrapper = $('<div>');
-            wrapper.append(d);
+            this.wrapper = $('<div>').addClass('canvas-wrapper').attr('contenteditable', true);
+            this.wrapper.append(d);
             
-            wrapper.find('*').replaceWith(function() {
+            this.wrapper.find('*').replaceWith(function() {
                 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++) {
-                    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
+                });
+
+                element.dom().append(currentTag.contents());
+                ['orig-before', 'orig-append'].forEach(function(attr) {
+                    element.data(attr, ['']);
+                });
+                return element.dom();
             });
 
-            wrapper.find(':not(iframe)').addBack().contents()
+            this.wrapper.find(':not(iframe)').addBack().contents()
                 .filter(function() {return this.nodeType === Node.TEXT_NODE})
                 .each(function() {
-
-                    var el = $(this);
-                    
                     // 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  && $(el.prev()[0]).attr('wlxml-tag') === 'span',
+                        hasSpanAfter = el.next().length > 0 && $(el.next()[0]).attr('wlxml-tag') === 'span';
+
+
+                    var addInfo = function(toAdd) {
+                        var parentContents = elParent.contents(),
+                            idx = parentContents.index(el[0]),
+                            next = idx < parentContents.length - 1 ? parentContents[idx+1] : null;
+                        if(next) {
+                            $(next).data('orig-before', toAdd);
+                        } else {
+                            elParent.data('orig-append', 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 {
-                        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]);
+                        el.remove();
+                        return true; // continue
                     }
+
+                    if(text.transformed !== text.original) {
+                        var toAdd = [];
+                        if(!text.trimmed) {
+                            toAdd.push(text.original);
+                        } 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);
+                                toAdd.push(endingWhiteSpace);
+                            }
+
+                            if(startingWhiteSpace) {
+                                if(text.transformed[0] === ' ' && startingWhiteSpace[startingWhiteSpace.length-1] === ' ')
+                                    startingWhiteSpace = startingWhiteSpace.substr(0, startingWhiteSpace.length -1);
+                                toAdd.push(startingWhiteSpace);
+                            }
+                        }
+                        addInfo(toAdd);
+                    }
+
+                    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);
+
+            var canvas = this;
+            this.wrapper.on('keydown', function(e) {
+                if(e.which === 13) { 
+                    e.preventDefault();
+                    var cursor = canvas.getCursor();
+                    if(!cursor.isSelecting()) {
+                        var position = cursor.getPosition(),
+                            elements = position.element.split({offset: position.offset}),
+                            newEmpty,
+                            goto;
+
+                        if(position.offsetAtBeginning)
+                            newEmpty = elements.first;
+                        else if(position.offsetAtEnd)
+                            newEmpty = elements.second;
+                        if(newEmpty) {
+                            goto = newEmpty.append(documentElement.DocumentTextElement.create({text: '\u200B'}, this));
+                            canvas.setCurrentElement(goto);
+                        }
+                    }
+                }
+            });
+
+            this.wrapper.on('keyup', function(e) {
+                if(e.which >= 37 && e.which <= 40)
+                    canvas.setCurrentElement(canvas.getCursor().getPosition().element, {caretTo: false})
+            });
+
+            this.wrapper.on('click', '[wlxml-tag], [wlxml-text]', function(e) {
+                e.stopPropagation();
+                canvas.setCurrentElement(canvas.getDocumentElement(e.target), {caretTo: false});
+            });
+
         } else {
             this.d = null;
         }
     },
 
+    view: function() {
+        return this.wrapper;
+    },
+
     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) {
@@ -115,7 +209,122 @@ $.extend(Canvas.prototype, {
             wrapperElement.after({text: suffixOutside});
         return wrapperElement;
     },
-    list: {}
+    getDocumentElement: function(from) {
+        if(from instanceof HTMLElement || from instanceof Text) {
+           return documentElement.DocumentElement.fromHTMLElement(from, this);
+        }
+    },
+    getCursor: function() {
+        return new Cursor(this);
+    },
+
+    list: {},
+
+
+
+    highlightElement: function(element) {
+        this.wrapper.find('.highlighted-element').removeClass('highlighted-element');
+        element.dom().addClass('highlighted-element');
+    },
+
+    dimElement: function(element) {
+        element.dom().removeClass('highlighted-element');
+    },
+    
+    getCurrentNodeElement: function() {
+        return this.getDocumentElement(this.wrapper.find('.current-node-element')[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.dom().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, {
@@ -135,7 +344,8 @@ $.extend(Canvas.prototype.list, {
         
         var place = 'before';
         var canvas = this;
-        parent.children().forEach(function(element) {
+        parent.children().some(function(element) {
+            var _e = element;
             if(element.sameNode(params.element1))
                 place = 'inside';
             if(place === 'inside') {
@@ -147,15 +357,15 @@ $.extend(Canvas.prototype.list, {
                 element.setWlxmlClass('item');
                 elementsToWrap.push(element);
             }
-            if(element.sameNode(params.element2))
-                return false;
+            if(_e.sameNode(params.element2))
+                return true;
         });
         
         var listElement = documentElement.DocumentNodeElement.create({tag: 'div', klass: 'list-items' + (params.type === 'enum' ? '-enum' : '')});
         
         var toret;
         if(parent.is('list')) {
-            listElement.wrap({tag: 'div', klass: 'item'});
+            listElement.wrapWithNodeElement({tag: 'div', klass: 'item'});
             toret = listElement.parent();
         } else {
             toret = listElement;
@@ -169,6 +379,7 @@ $.extend(Canvas.prototype.list, {
         });
     },
     extractItems: function(params) {
+        params = _.extend({merge: true}, params);
         var list = params.element1.parent();
         if(!list.is('list') || !(list.sameNode(params.element2.parent())))
             return false;
@@ -199,7 +410,7 @@ $.extend(Canvas.prototype.list, {
 
         var reference = listIsNested ? list.parent() : list;
         if(succeedingItems.length === 0) {
-            var list = reference;
+            var reference_orig = reference;
             extractedItems.forEach(function(item) {
                 reference.after(item);
                 reference = item;
@@ -207,7 +418,7 @@ $.extend(Canvas.prototype.list, {
                     item.setWlxmlClass(null);
             });
             if(precedingItems.length === 0)
-                list.detach();
+                reference_orig.detach();
         } else if(precedingItems.length === 0) {
             extractedItems.forEach(function(item) {
                 reference.before(item);
@@ -215,12 +426,11 @@ $.extend(Canvas.prototype.list, {
                     item.setWlxmlClass(null);
             });
         } else {
-            var ptr = reference;
             extractedItems.forEach(function(item) {
-                ptr.after(item);
+                reference.after(item);
                 if(!listIsNested)
                     item.setWlxmlClass(null);
-                ptr = item;
+                reference = item;
             });
             var secondList = documentElement.DocumentNodeElement.create({tag: 'div', klass:'list-items'}, this),
                 toAdd = secondList;
@@ -232,14 +442,125 @@ $.extend(Canvas.prototype.list, {
                 secondList.append(item);
             });
 
-            ptr.after(toAdd);
+            reference.after(toAdd);
+        }
+        if(!params.merge && listIsNested) {
+            return this.extractItems({element1: extractedItems[0], element2: extractedItems[extractedItems.length-1]});
         }
+        return true;
+    },
+    areItemsOfTheSameList: function(params) {
+        var e1 = params.element1,
+            e2 = params.element2;
+        return e1.parent().sameNode(e2.parent())
+            && e1.parent().is('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 instanceof documentElement.DocumentNodeElement || focusElement instanceof documentElement.DocumentNodeElement)
+            return {};
+
+        if(which === 'anchor') {
+            return {
+                element: anchorElement,
+                offset: selection.anchorOffset,
+                offsetAtBeginning: selection.anchorOffset === 0,
+                offsetAtEnd: anchorElement && anchorElement.getText().length === selection.anchorOffset
+            };
+        }
+        if(which === 'focus') {
+            return {
+                element: focusElement,
+                offset: selection.focusOffset,
+                offsetAtBeginning: selection.focusOffset === 0,
+                offsetAtEnd: focusElement && focusElement.getText().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
+            }
+        }
+
+        return {
+            element: element,
+            offset: offset,
+            offsetAtBeginning: offset === 0,
+            offsetAtEnd: element.getText().length === offset
+        }
+    }
+})
+
 return {
-    fromXML: function(xml) {
-        return new Canvas(xml);
+    fromXML: function(xml, publisher) {
+        return new Canvas(xml, publisher);
     }
 };