modules/documentCanvas/canvas/canvas.js

   1 define([
   2 'libs/jquery-1.9.1.min',
   3 'libs/underscore-min',
   4 'modules/documentCanvas/canvas/documentElement'
   5 ], function($, _, documentElement) {
   6
   7 'use strict';
   8
   9 var Canvas = function(wlxml, publisher) {
  10     this.loadWlxml(wlxml);
  11     this.publisher = publisher ? publisher : function() {};
  12 };
  13
  14 $.extend(Canvas.prototype, {
  15
  16     loadWlxml: function(wlxml) {
  17         var d = wlxml ? $($.trim(wlxml)) : null;
  18         if(d) {
  19             this.wrapper = $('<div>').addClass('canvas-wrapper').attr('contenteditable', true);
  20             this.wrapper.append(d);
  21
  22             this.wrapper.find('*').replaceWith(function() {
  23                 var currentTag = $(this);
  24                 if(currentTag.attr('wlxml-tag'))
  25                     return;
  26
  27                 var meta = {}, others = {};
  28                 for(var i = 0; i < this.attributes.length; i++) {
  29                     var attr = this.attributes[i];
  30                     if(attr.name.substr(0, 5) === 'meta-')
  31                         meta[attr.name.substr(5)] = attr.value;
  32                     else if(attr.name !== 'class')
  33                         others[attr.name] = attr.value;
  34                 }
  35
  36                 var element = documentElement.DocumentNodeElement.create({
  37                     tag: currentTag.prop('tagName').toLowerCase(),
  38                     klass: currentTag.attr('class'),
  39                     meta: meta,
  40                     others: others
  41                 });
  42
  43                 element.dom().append(currentTag.contents());
  44                 ['orig-before', 'orig-append'].forEach(function(attr) {
  45                     element.data(attr, ['']);
  46                 });
  47                 return element.dom();
  48             });
  49
  50             this.wrapper.find(':not(iframe)').addBack().contents()
  51                 .filter(function() {return this.nodeType === Node.TEXT_NODE})
  52                 .each(function() {
  53                     // TODO: use DocumentElement API
  54
  55                     var el = $(this),
  56                         text = {original: el.text(), trimmed: $.trim(el.text())},
  57                         elParent = el.parent(),
  58                         hasSpanParent = elParent.attr('wlxml-tag') === 'span',
  59                         hasSpanBefore = el.prev().length > 0  && $(el.prev()[0]).attr('wlxml-tag') === 'span',
  60                         hasSpanAfter = el.next().length > 0 && $(el.next()[0]).attr('wlxml-tag') === 'span';
  61
  62
  63                     var addInfo = function(toAdd) {
  64                         var parentContents = elParent.contents(),
  65                             idx = parentContents.index(el[0]),
  66                             next = idx < parentContents.length - 1 ? parentContents[idx+1] : null;
  67                         if(next) {
  68                             $(next).data('orig-before', toAdd);
  69                         } else {
  70                             elParent.data('orig-append', toAdd);
  71                         }
  72                     }
  73
  74                     text.transformed = text.trimmed;
  75
  76                     if(hasSpanParent || hasSpanBefore || hasSpanAfter) {
  77                         var startSpace = /\s/g.test(text.original.substr(0,1)),
  78                             endSpace = /\s/g.test(text.original.substr(-1)) && text.original.length > 1;
  79                         text.transformed = (startSpace && (hasSpanParent || hasSpanBefore) ? ' ' : '')
  80                                     + text.trimmed
  81                                     + (endSpace && (hasSpanParent || hasSpanAfter) ? ' ' : '');
  82                     } else {
  83                         if(text.trimmed.length === 0 && text.original.length > 0 && elParent.contents().length === 1)
  84                             text.transformed = ' ';
  85                     }
  86
  87                     if(!text.transformed) {
  88                         addInfo([text.original]);
  89                         el.remove();
  90                         return true; // continue
  91                     }
  92
  93                     if(text.transformed !== text.original) {
  94                         var toAdd = [];
  95                         if(!text.trimmed) {
  96                             toAdd.push(text.original);
  97                         } else {
  98                             var startingMatch = text.original.match(/^\s+/g),
  99                                 endingMatch = text.original.match(/\s+$/g),
 100                                 startingWhiteSpace = startingMatch ? startingMatch[0] : null,
 101                                 endingWhiteSpace = endingMatch ? endingMatch[0] : null;
 102
 103                             if(endingWhiteSpace) {
 104                                 if(text.transformed[text.transformed.length - 1] === ' ' && endingWhiteSpace[0] === ' ')
 105                                     endingWhiteSpace = endingWhiteSpace.substr(1);
 106                                 toAdd.push(endingWhiteSpace);
 107                             }
 108
 109                             if(startingWhiteSpace) {
 110                                 if(text.transformed[0] === ' ' && startingWhiteSpace[startingWhiteSpace.length-1] === ' ')
 111                                     startingWhiteSpace = startingWhiteSpace.substr(0, startingWhiteSpace.length -1);
 112                                 toAdd.push(startingWhiteSpace);
 113                             }
 114                         }
 115                         addInfo(toAdd);
 116                     }
 117
 118                     var element = documentElement.DocumentTextElement.create({text: text.transformed});
 119                     el.replaceWith(element.dom());
 120                 });
 121
 122             this.d = this.wrapper.children(0);
 123
 124             var canvas = this;
 125             this.wrapper.on('keydown', function(e) {
 126                 if(e.which === 13) {
 127                     e.preventDefault();
 128                     var cursor = canvas.getCursor();
 129                     if(!cursor.isSelecting()) {
 130                         var position = cursor.getPosition(),
 131                             elements = position.element.split({offset: position.offset}),
 132                             newEmpty,
 133                             goto;
 134
 135                         if(position.offsetAtBeginning)
 136                             newEmpty = elements.first;
 137                         else if(position.offsetAtEnd)
 138                             newEmpty = elements.second;
 139                         if(newEmpty) {
 140                             goto = newEmpty.append(documentElement.DocumentTextElement.create({text: '\u200B'}, this));
 141                             canvas.setCurrentElement(goto);
 142                         }
 143                     }
 144                 }
 145             });
 146
 147             this.wrapper.on('keyup', function(e) {
 148                 if(e.which >= 37 && e.which <= 40)
 149                     canvas.setCurrentElement(canvas.getCursor().getPosition().element, {caretTo: false})
 150             });
 151
 152             this.wrapper.on('click', '[wlxml-tag], [wlxml-text]', function(e) {
 153                 e.stopPropagation();
 154                 canvas.setCurrentElement(canvas.getDocumentElement(e.target), {caretTo: false});
 155             });
 156
 157         } else {
 158             this.d = null;
 159         }
 160     },
 161
 162     view: function() {
 163         return this.wrapper;
 164     },
 165
 166     doc: function() {
 167         if(this.d === null)
 168             return null;
 169         return documentElement.DocumentNodeElement.fromHTMLElement(this.d.get(0), this); //{wlxmlTag: this.d.prop('tagName')};
 170     },
 171
 172     wrapText: function(params) {
 173         params = _.extend({textNodeIdx: 0}, params);
 174         if(typeof params.textNodeIdx === 'number')
 175             params.textNodeIdx = [params.textNodeIdx];
 176
 177         var childrenInside = params.inside.children(),
 178             idx1 = Math.min.apply(Math, params.textNodeIdx),
 179             idx2 = Math.max.apply(Math, params.textNodeIdx),
 180             textNode1 = childrenInside[idx1],
 181             textNode2 = childrenInside[idx2],
 182             sameNode = textNode1.sameNode(textNode2),
 183             prefixOutside = textNode1.getText().substr(0, params.offsetStart),
 184             prefixInside = textNode1.getText().substr(params.offsetStart),
 185             suffixInside = textNode2.getText().substr(0, params.offsetEnd),
 186             suffixOutside = textNode2.getText().substr(params.offsetEnd)
 187         ;
 188
 189         var wrapperElement = documentElement.DocumentNodeElement.create({tag: params._with.tag, klass: params._with.klass});
 190         textNode1.after(wrapperElement);
 191         textNode1.detach();
 192
 193         if(prefixOutside.length > 0)
 194             wrapperElement.before({text:prefixOutside});
 195         if(sameNode) {
 196             var core = textNode1.getText().substr(params.offsetStart, params.offsetEnd - params.offsetStart);
 197             wrapperElement.append({text: core});
 198         } else {
 199             textNode2.detach();
 200             if(prefixInside.length > 0)
 201                 wrapperElement.append({text: prefixInside});
 202             for(var i = idx1 + 1; i < idx2; i++) {
 203                 wrapperElement.append(childrenInside[i]);
 204             }
 205             if(suffixInside.length > 0)
 206                 wrapperElement.append({text: suffixInside});
 207         }
 208         if(suffixOutside.length > 0)
 209             wrapperElement.after({text: suffixOutside});
 210         return wrapperElement;
 211     },
 212     getDocumentElement: function(from) {
 213         if(from instanceof HTMLElement || from instanceof Text) {
 214            return documentElement.DocumentElement.fromHTMLElement(from, this);
 215         }
 216     },
 217     getCursor: function() {
 218         return new Cursor(this);
 219     },
 220
 221     list: {},
 222
 223
 224
 225     highlightElement: function(element) {
 226         this.wrapper.find('.highlighted-element').removeClass('highlighted-element');
 227         element.dom().addClass('highlighted-element');
 228     },
 229
 230     dimElement: function(element) {
 231         element.dom().removeClass('highlighted-element');
 232     },
 233
 234     getCurrentNodeElement: function() {
 235         return this.getDocumentElement(this.wrapper.find('.current-node-element')[0]);
 236     },
 237
 238     getCurrentTextElement: function() {
 239         return this.getDocumentElement(this.wrapper.find('.current-text-element')[0]);
 240     },
 241
 242
 243
 244     setCurrentElement: function(element, params) {
 245         params = _.extend({caretTo: 'end'}, params);
 246         var findFirstDirectTextChild = function(e, nodeToLand) {
 247             var byBrowser = this.getCursor().getPosition().element;
 248             if(byBrowser && byBrowser.parent().sameNode(nodeToLand))
 249                 return byBrowser;
 250             var children = e.children();
 251             for(var i = 0; i < children.length; i++) {
 252                 if(children[i] instanceof documentElement.DocumentTextElement)
 253                     return children[i];
 254             }
 255             return null;
 256         }.bind(this);
 257         var _markAsCurrent = function(element) {
 258             if(element instanceof documentElement.DocumentTextElement) {
 259                 this.wrapper.find('.current-text-element').removeClass('current-text-element');
 260                 element.dom().addClass('current-text-element');
 261             } else {
 262                 this.wrapper.find('.current-node-element').removeClass('current-node-element')
 263                 element.dom().addClass('current-node-element');
 264                 this.publisher('currentElementChanged', element);
 265             }
 266         }.bind(this);
 267
 268
 269         var isTextElement = element instanceof documentElement.DocumentTextElement,
 270             nodeElementToLand = isTextElement ? element.parent() : element,
 271             textElementToLand = isTextElement ? element : findFirstDirectTextChild(element, nodeElementToLand),
 272             currentTextElement = this.getCurrentTextElement(),
 273             currentNodeElement = this.getCurrentNodeElement();
 274
 275         if(currentTextElement && !(currentTextElement.sameNode(textElementToLand)))
 276             this.wrapper.find('.current-text-element').removeClass('current-text-element');
 277
 278         if(textElementToLand) {
 279             _markAsCurrent(textElementToLand);
 280             if(params.caretTo || !textElementToLand.sameNode(this.getCursor().getPosition().element))
 281                 this._moveCaretToTextElement(textElementToLand, params.caretTo); // as method on element?
 282             if(!(textElementToLand.sameNode(currentTextElement)))
 283                 this.publisher('currentTextElementSet', textElementToLand);
 284         } else {
 285             document.getSelection().removeAllRanges();
 286         }
 287
 288         if(!(currentNodeElement && currentNodeElement.sameNode(nodeElementToLand))) {
 289             _markAsCurrent(nodeElementToLand);
 290
 291             this.publisher('currentNodeElementSet', nodeElementToLand);
 292         }
 293     },
 294
 295     _moveCaretToTextElement: function(element, where) {
 296         var range = document.createRange(),
 297             node = element.dom().contents()[0];
 298
 299         if(typeof where !== 'number') {
 300             range.selectNodeContents(node);
 301         } else {
 302             range.setStart(node, where);
 303         }
 304
 305         var collapseArg = true;
 306         if(where === 'end')
 307             collapseArg = false;
 308         range.collapse(collapseArg);
 309
 310         var selection = document.getSelection();
 311
 312         selection.removeAllRanges();
 313         selection.addRange(range);
 314         this.wrapper.focus(); // FF requires this for caret to be put where range colllapses, Chrome doesn't.
 315     },
 316
 317     setCursorPosition: function(position) {
 318         if(position.element)
 319             this._moveCaretToTextElement(position.element, position.offset);
 320     },
 321
 322     toXML: function() {
 323         var parent = $('<div>');
 324         this.doc().toXML(parent, 0)
 325         return parent.html();
 326     }
 327 });
 328
 329 $.extend(Canvas.prototype.list, {
 330     create: function(params) {
 331         if(!(params.element1.parent().sameNode(params.element2.parent())))
 332             return false;
 333
 334         var parent = params.element1.parent();
 335
 336         if(parent.childIndex(params.element1) > parent.childIndex(params.element2)) {
 337             var tmp = params.element1;
 338             params.element1 = params.element2;
 339             params.element2 = tmp;
 340         }
 341
 342         var elementsToWrap = [];
 343
 344         var place = 'before';
 345         var canvas = this;
 346         parent.children().some(function(element) {
 347             var _e = element;
 348             if(element.sameNode(params.element1))
 349                 place = 'inside';
 350             if(place === 'inside') {
 351                 if(element instanceof documentElement.DocumentTextElement) {
 352                     element = element.wrapWithNodeElement({tag: 'div', klass: 'list.item'});
 353                     if(element.children()[0].sameNode(params.element1))
 354                         params.element1 = element;
 355                 }
 356                 element.setWlxmlClass('item');
 357                 elementsToWrap.push(element);
 358             }
 359             if(_e.sameNode(params.element2))
 360                 return true;
 361         });
 362
 363         var listElement = documentElement.DocumentNodeElement.create({tag: 'div', klass: 'list-items' + (params.type === 'enum' ? '-enum' : '')});
 364
 365         var toret;
 366         if(parent.is('list')) {
 367             listElement.wrapWithNodeElement({tag: 'div', klass: 'item'});
 368             toret = listElement.parent();
 369         } else {
 370             toret = listElement;
 371         }
 372
 373         params.element1.before(toret);
 374
 375         elementsToWrap.forEach(function(element) {
 376             element.detach();
 377             listElement.append(element);
 378         });
 379     },
 380     extractItems: function(params) {
 381         params = _.extend({merge: true}, params);
 382         var list = params.element1.parent();
 383         if(!list.is('list') || !(list.sameNode(params.element2.parent())))
 384             return false;
 385
 386         var idx1 = list.childIndex(params.element1),
 387             idx2 = list.childIndex(params.element2),
 388             precedingItems = [],
 389             extractedItems = [],
 390             succeedingItems = [],
 391             items = list.children(),
 392             listIsNested = list.parent().getWlxmlClass() === 'item',
 393             i;
 394
 395         if(idx1 > idx2) {
 396             var tmp = idx1; idx1 = idx2; idx2 = tmp;
 397         }
 398
 399         items.forEach(function(item, idx) {
 400             if(idx < idx1)
 401                 precedingItems.push(item);
 402             else if(idx >= idx1 && idx <= idx2) {
 403                 extractedItems.push(item);
 404             }
 405             else {
 406                 succeedingItems.push(item);
 407             }
 408         });
 409
 410         var reference = listIsNested ? list.parent() : list;
 411         if(succeedingItems.length === 0) {
 412             var reference_orig = reference;
 413             extractedItems.forEach(function(item) {
 414                 reference.after(item);
 415                 reference = item;
 416                 if(!listIsNested)
 417                     item.setWlxmlClass(null);
 418             });
 419             if(precedingItems.length === 0)
 420                 reference_orig.detach();
 421         } else if(precedingItems.length === 0) {
 422             extractedItems.forEach(function(item) {
 423                 reference.before(item);
 424                 if(!listIsNested)
 425                     item.setWlxmlClass(null);
 426             });
 427         } else {
 428             extractedItems.forEach(function(item) {
 429                 reference.after(item);
 430                 if(!listIsNested)
 431                     item.setWlxmlClass(null);
 432                 reference = item;
 433             });
 434             var secondList = documentElement.DocumentNodeElement.create({tag: 'div', klass:'list-items'}, this),
 435                 toAdd = secondList;
 436
 437             if(listIsNested) {
 438                 toAdd = secondList.wrapWithNodeElement({tag: 'div', klass:'item'});
 439             }
 440             succeedingItems.forEach(function(item) {
 441                 secondList.append(item);
 442             });
 443
 444             reference.after(toAdd);
 445         }
 446         if(!params.merge && listIsNested) {
 447             return this.extractItems({element1: extractedItems[0], element2: extractedItems[extractedItems.length-1]});
 448         }
 449         return true;
 450     },
 451     areItemsOfTheSameList: function(params) {
 452         var e1 = params.element1,
 453             e2 = params.element2;
 454         return e1.parent().sameNode(e2.parent())
 455             && e1.parent().is('list');
 456     }
 457 });
 458
 459
 460 var Cursor = function(canvas) {
 461     this.canvas = canvas;
 462 };
 463
 464 $.extend(Cursor.prototype, {
 465     isSelecting: function() {
 466         var selection = window.getSelection();
 467         return !selection.isCollapsed;
 468     },
 469     isSelectingWithinElement: function() {
 470         return this.isSelecting() && this.getSelectionStart().element.sameNode(this.getSelectionEnd().element);
 471     },
 472     isSelectingSiblings: function() {
 473         return this.isSelecting() && this.getSelectionStart().element.parent().sameNode(this.getSelectionEnd().element.parent());
 474     },
 475     getPosition: function() {
 476         return this.getSelectionAnchor();
 477     },
 478     getSelectionStart: function() {
 479         return this.getSelectionBoundry('start');
 480     },
 481     getSelectionEnd: function() {
 482         return this.getSelectionBoundry('end');
 483     },
 484     getSelectionAnchor: function() {
 485         return this.getSelectionBoundry('anchor');
 486     },
 487     getSelectionFocus: function() {
 488         return this.getSelectionBoundry('focus');
 489     },
 490     getSelectionBoundry: function(which) {
 491         var selection = window.getSelection(),
 492             anchorElement = this.canvas.getDocumentElement(selection.anchorNode),
 493             focusElement = this.canvas.getDocumentElement(selection.focusNode);
 494
 495         if(anchorElement instanceof documentElement.DocumentNodeElement || focusElement instanceof documentElement.DocumentNodeElement)
 496             return {};
 497
 498         if(which === 'anchor') {
 499             return {
 500                 element: anchorElement,
 501                 offset: selection.anchorOffset,
 502                 offsetAtBeginning: selection.anchorOffset === 0,
 503                 offsetAtEnd: anchorElement && anchorElement.getText().length === selection.anchorOffset
 504             };
 505         }
 506         if(which === 'focus') {
 507             return {
 508                 element: focusElement,
 509                 offset: selection.focusOffset,
 510                 offsetAtBeginning: selection.focusOffset === 0,
 511                 offsetAtEnd: focusElement && focusElement.getText().length === selection.focusOffset
 512             };
 513         }
 514
 515         var element,
 516             offset;
 517
 518         if(anchorElement.parent().sameNode(focusElement.parent())) {
 519             var parent = anchorElement.parent(),
 520                 anchorFirst = parent.childIndex(anchorElement) < parent.childIndex(focusElement);
 521             if(anchorFirst) {
 522                 if(which === 'start') {
 523                     element = anchorElement;
 524                     offset = selection.anchorOffset;
 525                 }
 526                 else if(which === 'end') {
 527                     element = focusElement,
 528                     offset = selection.focusOffset;
 529                 }
 530             } else {
 531                 if(which === 'start') {
 532                     element = focusElement,
 533                     offset = selection.focusOffset
 534                 }
 535                 else if(which === 'end') {
 536                     element = anchorElement;
 537                     offset = selection.anchorOffset;
 538                 }
 539             }
 540         } else {
 541             // TODO: Handle order via https://developer.mozilla.org/en-US/docs/Web/API/Node.compareDocumentPosition
 542             if(which === 'start') {
 543                 element = anchorElement;
 544                 offset = selection.anchorOffset
 545             } else {
 546                 element = focusElement;
 547                 offset = selection.focusOffset
 548             }
 549         }
 550
 551         return {
 552             element: element,
 553             offset: offset,
 554             offsetAtBeginning: offset === 0,
 555             offsetAtEnd: element.getText().length === offset
 556         }
 557     }
 558 })
 559
 560 return {
 561     fromXML: function(xml, publisher) {
 562         return new Canvas(xml, publisher);
 563     }
 564 };
 565
 566 });