src/smartxml/smartxml.js

   1 define([
   2     'libs/jquery',
   3     'libs/underscore',
   4     'libs/backbone',
   5     'smartxml/events',
   6     'smartxml/transformations'
   7 ], function($, _, Backbone, events, transformations) {
   8
   9 'use strict';
  10 /* globals Node */
  11
  12 var TEXT_NODE = Node.TEXT_NODE;
  13
  14
  15 var INSERTION = function(implementation) {
  16     var toret = function(node) {
  17         var insertion = this.getNodeInsertion(node),
  18             nodeWasContained = this.document.containsNode(insertion.ofNode),
  19             nodeParent;
  20         if(!(this.document.containsNode(this))) {
  21             nodeParent = insertion.ofNode.parent();
  22         }
  23         implementation.call(this, insertion.ofNode.nativeNode);
  24         this.triggerChangeEvent(insertion.insertsNew ? 'nodeAdded' : 'nodeMoved', {node: insertion.ofNode}, nodeParent, nodeWasContained);
  25         return insertion.ofNode;
  26     };
  27     return toret;
  28 };
  29
  30 var DocumentNode = function(nativeNode, document) {
  31     if(!document) {
  32         throw new Error('undefined document for a node');
  33     }
  34     this.document = document;
  35     this._setNativeNode(nativeNode);
  36
  37 };
  38
  39 $.extend(DocumentNode.prototype, {
  40
  41     transform: function(Transformation, args) {
  42         var transformation = new Transformation(this.document, this, args);
  43         return this.document.transform(transformation);
  44     },
  45
  46     _setNativeNode: function(nativeNode) {
  47         this.nativeNode = nativeNode;
  48         this._$ = $(nativeNode);
  49     },
  50
  51     clone: function() {
  52         var clone = this._$.clone(true, true);
  53         // clone.find('*').addBack().each(function() {
  54         //     var n = $(this);
  55         //     if(n.data('canvasElement')) {
  56         //         n.data('canvasElement', $.extend(true, {}, n.data('canvasElement')));
  57         //         n.data('canvasElement').$element = n.data('canvasElement').$element.clone(true, true);
  58         //     }
  59         // });
  60         return this.document.createDocumentNode(clone[0]);
  61     },
  62
  63     getPath: function(ancestor) {
  64         var nodePath = [this].concat(this.parents()),
  65             toret, idx;
  66         ancestor = ancestor || this.document.root;
  67
  68         nodePath.some(function(node, i) {
  69             if(node.sameNode(ancestor)) {
  70                 idx = i;
  71                 return true;
  72             }
  73         });
  74
  75         if(idx !== 'undefined') {
  76             nodePath = nodePath.slice(0, idx);
  77         }
  78         toret = nodePath.map(function(node) {return node.getIndex(); });
  79         toret.reverse();
  80         return toret;
  81     },
  82
  83     isRoot: function() {
  84         return this.document.root.sameNode(this);
  85     },
  86
  87     detach: function() {
  88         var parent = this.parent();
  89         this._$.detach();
  90         this.triggerChangeEvent('nodeDetached', {parent: parent});
  91         return this;
  92     },
  93
  94     replaceWith: function(node) {
  95         var toret;
  96         if(this.isRoot()) {
  97             return this.document.replaceRoot(node);
  98         }
  99         toret = this.after(node);
 100         this.detach();
 101         return toret;
 102     },
 103
 104     sameNode: function(otherNode) {
 105         return !!(otherNode) && this.nativeNode === otherNode.nativeNode;
 106     },
 107
 108     parent: function() {
 109         var parentNode = this.nativeNode.parentNode;
 110         if(parentNode && parentNode.nodeType === Node.ELEMENT_NODE) {
 111             return this.document.createDocumentNode(parentNode);
 112         }
 113         return null;
 114     },
 115
 116     parents: function() {
 117         var parent = this.parent(),
 118             parents = parent ? parent.parents() : [];
 119         if(parent) {
 120             parents.unshift(parent);
 121         }
 122         return parents;
 123     },
 124
 125     prev: function() {
 126         var myIdx = this.getIndex();
 127         return myIdx > 0 ? this.parent().contents()[myIdx-1] : null;
 128     },
 129
 130     next: function() {
 131         if(this.isRoot()) {
 132             return null;
 133         }
 134         var myIdx = this.getIndex(),
 135             parentContents = this.parent().contents();
 136         return myIdx < parentContents.length - 1 ? parentContents[myIdx+1] : null;
 137     },
 138
 139     isSurroundedByTextElements: function() {
 140         var prev = this.prev(),
 141             next = this.next();
 142         return prev && (prev.nodeType === Node.TEXT_NODE) && next && (next.nodeType === Node.TEXT_NODE);
 143     },
 144
 145     after: INSERTION(function(nativeNode) {
 146         return this._$.after(nativeNode);
 147     }),
 148
 149     before: INSERTION(function(nativeNode) {
 150         return this._$.before(nativeNode);
 151     }),
 152
 153     wrapWith: function(node) {
 154         var insertion = this.getNodeInsertion(node);
 155         if(this.parent()) {
 156             this.before(insertion.ofNode);
 157         }
 158         insertion.ofNode.append(this);
 159         return insertion.ofNode;
 160     },
 161
 162     /**
 163     * Removes parent of a node if node has no siblings.
 164     */
 165     unwrap: function() {
 166         if(this.isRoot()) {
 167             return;
 168         }
 169         var parent = this.parent(),
 170             grandParent;
 171         if(parent.contents().length === 1) {
 172             grandParent = parent.parent();
 173             parent.unwrapContent();
 174             return grandParent;
 175         }
 176     },
 177
 178     triggerChangeEvent: function(type, metaData, origParent, nodeWasContained) {
 179         var node = (metaData && metaData.node) ? metaData.node : this,
 180             event = new events.ChangeEvent(type, $.extend({node: node}, metaData || {}));
 181         if(type === 'nodeDetached' || this.document.containsNode(event.meta.node)) {
 182             this.document.trigger('change', event);
 183         }
 184         if((type === 'nodeAdded' || type === 'nodeMoved') && !this.document.containsNode(this) && nodeWasContained) {
 185              event = new events.ChangeEvent('nodeDetached', {node: node, parent: origParent});
 186              this.document.trigger('change', event);
 187         }
 188     },
 189
 190     getNodeInsertion: function(node) {
 191         return this.document.getNodeInsertion(node);
 192     },
 193
 194     getIndex: function() {
 195         if(this.isRoot()) {
 196             return 0;
 197         }
 198         return this.parent().indexOf(this);
 199     }
 200 });
 201
 202 var ElementNode = function(nativeNode, document) {
 203     DocumentNode.call(this, nativeNode, document);
 204 };
 205 ElementNode.prototype = Object.create(DocumentNode.prototype);
 206
 207 $.extend(ElementNode.prototype, {
 208     nodeType: Node.ELEMENT_NODE,
 209
 210     detach: function() {
 211         var next;
 212         if(this.parent() && this.isSurroundedByTextElements()) {
 213             next = this.next();
 214             this.prev().appendText(next.getText());
 215             next.detach();
 216         }
 217         return DocumentNode.prototype.detach.call(this);
 218     },
 219
 220     setData: function(key, value) {
 221         if(value !== undefined) {
 222             this._$.data(key, value);
 223         } else {
 224             this._$.removeData(_.keys(this._$.data()));
 225             this._$.data(key);
 226         }
 227     },
 228
 229     getData: function(key) {
 230         if(key) {
 231             return this._$.data(key);
 232         }
 233         return this._$.data();
 234     },
 235
 236     getTagName: function() {
 237         return this.nativeNode.tagName.toLowerCase();
 238     },
 239
 240     contents: function(selector) {
 241         var toret = [],
 242             document = this.document;
 243         if(selector) {
 244             this._$.children(selector).each(function() {
 245                 toret.push(document.createDocumentNode(this));
 246             });
 247         } else {
 248             this._$.contents().each(function() {
 249                 toret.push(document.createDocumentNode(this));
 250             });
 251         }
 252         return toret;
 253     },
 254
 255     indexOf: function(node) {
 256         return this._$.contents().index(node._$);
 257     },
 258
 259     setTag: function(tagName) {
 260         var node = this.document.createDocumentNode({tagName: tagName}),
 261             oldTagName = this.getTagName(),
 262             myContents = this._$.contents();
 263
 264         this.getAttrs().forEach(function(attribute) {
 265             node.setAttr(attribute.name, attribute.value, true);
 266         });
 267         node.setData(this.getData());
 268
 269         if(this.sameNode(this.document.root)) {
 270             defineDocumentProperties(this.document, node._$);
 271         }
 272         this._$.replaceWith(node._$);
 273         this._setNativeNode(node._$[0]);
 274         this._$.append(myContents);
 275         this.triggerChangeEvent('nodeTagChange', {oldTagName: oldTagName, newTagName: this.getTagName()});
 276     },
 277
 278     getAttr: function(name) {
 279         return this._$.attr(name);
 280     },
 281
 282     setAttr: function(name, value, silent) {
 283         var oldVal = this.getAttr(name);
 284         this._$.attr(name, value);
 285         if(!silent) {
 286             this.triggerChangeEvent('nodeAttrChange', {attr: name, oldVal: oldVal, newVal: value});
 287         }
 288     },
 289
 290     getAttrs: function() {
 291         var toret = [];
 292         for(var i = 0; i < this.nativeNode.attributes.length; i++) {
 293             toret.push(this.nativeNode.attributes[i]);
 294         }
 295         return toret;
 296     },
 297
 298     append: INSERTION(function(nativeNode) {
 299         this._$.append(nativeNode);
 300     }),
 301
 302     prepend: INSERTION(function(nativeNode) {
 303         this._$.prepend(nativeNode);
 304     }),
 305
 306     insertAtIndex: function(nativeNode, index) {
 307         var contents = this.contents();
 308         if(index < contents.length) {
 309             return contents[index].before(nativeNode);
 310         } else if(index === contents.length) {
 311             return this.append(nativeNode);
 312         }
 313     },
 314
 315     unwrapContent: function() {
 316         var parent = this.parent();
 317         if(!parent) {
 318             return;
 319         }
 320
 321         var myContents = this.contents(),
 322             myIdx = parent.indexOf(this);
 323
 324
 325         if(myContents.length === 0) {
 326             return this.detach();
 327         }
 328
 329         var prev = this.prev(),
 330             next = this.next(),
 331             moveLeftRange, moveRightRange, leftMerged;
 332
 333         if(prev && (prev.nodeType === TEXT_NODE) && (myContents[0].nodeType === TEXT_NODE)) {
 334             prev.appendText(myContents[0].getText());
 335             myContents[0].detach();
 336             moveLeftRange = true;
 337             leftMerged = true;
 338         } else {
 339             leftMerged = false;
 340         }
 341
 342         if(!(leftMerged && myContents.length === 1)) {
 343             var lastContents = _.last(myContents);
 344             if(next && (next.nodeType === TEXT_NODE) && (lastContents.nodeType === TEXT_NODE)) {
 345                 next.prependText(lastContents.getText());
 346                 lastContents.detach();
 347                 moveRightRange = true;
 348             }
 349         }
 350
 351         var childrenLength = this.contents().length;
 352         this.contents().forEach(function(child) {
 353             this.before(child);
 354         }.bind(this));
 355
 356         this.detach();
 357
 358         return {
 359             element1: parent.contents()[myIdx + (moveLeftRange ? -1 : 0)],
 360             element2: parent.contents()[myIdx + childrenLength-1 + (moveRightRange ? 1 : 0)]
 361         };
 362     },
 363
 364     wrapText: function(params) {
 365         return this.document._wrapText(_.extend({inside: this}, params));
 366     },
 367
 368     toXML: function() {
 369         var wrapper = $('<div>');
 370         wrapper.append(this._getXMLDOMToDump());
 371         return wrapper.html();
 372     },
 373
 374     _getXMLDOMToDump: function() {
 375         return this._$;
 376     }
 377 });
 378
 379 var TextNode = function(nativeNode, document) {
 380     DocumentNode.call(this, nativeNode, document);
 381 };
 382 TextNode.prototype = Object.create(DocumentNode.prototype);
 383
 384 $.extend(TextNode.prototype, {
 385     nodeType: Node.TEXT_NODE,
 386
 387     getText: function() {
 388         return this.nativeNode.data;
 389     },
 390
 391     setText: function(text) {
 392         //console.log('smartxml: ' + text);
 393         this.nativeNode.data = text;
 394         this.triggerTextChangeEvent();
 395     },
 396
 397     appendText: function(text) {
 398         this.nativeNode.data = this.nativeNode.data + text;
 399         this.triggerTextChangeEvent();
 400     },
 401
 402     prependText: function(text) {
 403         this.nativeNode.data = text + this.nativeNode.data;
 404         this.triggerTextChangeEvent();
 405     },
 406
 407     wrapWith: function(desc) {
 408         if(typeof desc.start === 'number' && typeof desc.end === 'number') {
 409             return this.document._wrapText({
 410                 inside: this.parent(),
 411                 textNodeIdx: this.parent().indexOf(this),
 412                 offsetStart: Math.min(desc.start, desc.end),
 413                 offsetEnd: Math.max(desc.start, desc.end),
 414                 _with: {tagName: desc.tagName, attrs: desc.attrs}
 415             });
 416         } else {
 417             return DocumentNode.prototype.wrapWith.call(this, desc);
 418         }
 419     },
 420
 421     split: function(params) {
 422         var parentElement = this.parent(),
 423             passed = false,
 424             succeedingChildren = [],
 425             prefix = this.getText().substr(0, params.offset),
 426             suffix = this.getText().substr(params.offset);
 427
 428         parentElement.contents().forEach(function(child) {
 429             if(passed) {
 430                 succeedingChildren.push(child);
 431             }
 432             if(child.sameNode(this)) {
 433                 passed = true;
 434             }
 435         }.bind(this));
 436
 437         if(prefix.length > 0) {
 438             this.setText(prefix);
 439         }
 440         else {
 441             this.detach();
 442         }
 443
 444         var attrs = {};
 445         parentElement.getAttrs().forEach(function(attr) {attrs[attr.name] = attr.value; });
 446         var newElement = this.document.createDocumentNode({tagName: parentElement.getTagName(), attrs: attrs});
 447         parentElement.after(newElement);
 448
 449         if(suffix.length > 0) {
 450             newElement.append({text: suffix});
 451         }
 452         succeedingChildren.forEach(function(child) {
 453             newElement.append(child);
 454         });
 455
 456         return {first: parentElement, second: newElement};
 457     },
 458
 459     triggerTextChangeEvent: function() {
 460         var event = new events.ChangeEvent('nodeTextChange', {node: this});
 461         this.document.trigger('change', event);
 462     }
 463 });
 464
 465
 466 var parseXML = function(xml) {
 467     return $($.trim(xml))[0];
 468 };
 469
 470 var registerTransformation = function(desc, name, target) {
 471     var Transformation = transformations.createContextTransformation(desc, name);
 472     target[name] = function(args) {
 473         var instance = this;
 474         return instance.transform(Transformation, args);
 475     }
 476 };
 477
 478 var registerMethod = function(methodName, method, target) {
 479     if(target[methodName]) {
 480         throw new Error('Cannot extend {target} with method name {methodName}. Name already exists.'
 481             .replace('{target}', target)
 482             .replace('{methodName}', methodName)
 483         );
 484     }
 485     target[methodName] = method;
 486 };
 487
 488
 489 var Document = function(xml) {
 490     this.loadXML(xml);
 491     this.undoStack = [];
 492     this.redoStack = [];
 493     this._transformationLevel = 0;
 494
 495     this._nodeMethods = {};
 496     this._nodeTransformations = {};
 497 };
 498
 499 $.extend(Document.prototype, Backbone.Events, {
 500     ElementNodeFactory: ElementNode,
 501     TextNodeFactory: TextNode,
 502
 503     createDocumentNode: function(from) {
 504         if(!(from instanceof Node)) {
 505             if(from.text !== undefined) {
 506                 /* globals document */
 507                 from = document.createTextNode(from.text);
 508             } else {
 509                 var node = $('<' + from.tagName + '>');
 510
 511                 _.keys(from.attrs || {}).forEach(function(key) {
 512                     node.attr(key, from.attrs[key]);
 513                 });
 514
 515                 from = node[0];
 516             }
 517         }
 518         var Factory;
 519         if(from.nodeType === Node.TEXT_NODE) {
 520             Factory = this.TextNodeFactory;
 521         } else if(from.nodeType === Node.ELEMENT_NODE) {
 522             Factory = this.ElementNodeFactory;
 523         }
 524         var toret = new Factory(from, this);
 525         _.extend(toret, this._nodeMethods);
 526         _.extend(toret, this._nodeTransformations);
 527         return toret;
 528     },
 529
 530     loadXML: function(xml, options) {
 531         options = options || {};
 532         defineDocumentProperties(this, $(parseXML(xml)));
 533         if(!options.silent) {
 534             this.trigger('contentSet');
 535         }
 536     },
 537
 538     toXML: function() {
 539         return this.root.toXML();
 540     },
 541
 542     containsNode: function(node) {
 543         return this.root && (node.nativeNode === this.root.nativeNode || node._$.parents().index(this.root._$) !== -1);
 544     },
 545
 546     wrapNodes: function(params) {
 547         if(!(params.node1.parent().sameNode(params.node2.parent()))) {
 548             throw new Error('Wrapping non-sibling nodes not supported.');
 549         }
 550
 551         var parent = params.node1.parent(),
 552             parentContents = parent.contents(),
 553             wrapper = this.createDocumentNode({
 554                 tagName: params._with.tagName,
 555                 attrs: params._with.attrs}),
 556             idx1 = parent.indexOf(params.node1),
 557             idx2 = parent.indexOf(params.node2);
 558
 559         if(idx1 > idx2) {
 560             var tmp = idx1;
 561             idx1 = idx2;
 562             idx2 = tmp;
 563         }
 564
 565         var insertingMethod, insertingTarget;
 566         if(idx1 === 0) {
 567             insertingMethod = 'prepend';
 568             insertingTarget = parent;
 569         } else {
 570             insertingMethod = 'after';
 571             insertingTarget = parentContents[idx1-1];
 572         }
 573
 574         for(var i = idx1; i <= idx2; i++) {
 575             wrapper.append(parentContents[i].detach());
 576         }
 577
 578         insertingTarget[insertingMethod](wrapper);
 579         return wrapper;
 580     },
 581
 582     getSiblingParents: function(params) {
 583         var parents1 = [params.node1].concat(params.node1.parents()).reverse(),
 584             parents2 = [params.node2].concat(params.node2.parents()).reverse(),
 585             noSiblingParents = null;
 586
 587         if(parents1.length === 0 || parents2.length === 0 || !(parents1[0].sameNode(parents2[0]))) {
 588             return noSiblingParents;
 589         }
 590
 591         var i;
 592         for(i = 0; i < Math.min(parents1.length, parents2.length); i++) {
 593             if(parents1[i].sameNode(parents2[i])) {
 594                 continue;
 595             }
 596             break;
 597         }
 598         return {node1: parents1[i], node2: parents2[i]};
 599     },
 600
 601     _wrapText: function(params) {
 602         params = _.extend({textNodeIdx: 0}, params);
 603         if(typeof params.textNodeIdx === 'number') {
 604             params.textNodeIdx = [params.textNodeIdx];
 605         }
 606
 607         var contentsInside = params.inside.contents(),
 608             idx1 = Math.min.apply(Math, params.textNodeIdx),
 609             idx2 = Math.max.apply(Math, params.textNodeIdx),
 610             textNode1 = contentsInside[idx1],
 611             textNode2 = contentsInside[idx2],
 612             sameNode = textNode1.sameNode(textNode2),
 613             prefixOutside = textNode1.getText().substr(0, params.offsetStart),
 614             prefixInside = textNode1.getText().substr(params.offsetStart),
 615             suffixInside = textNode2.getText().substr(0, params.offsetEnd),
 616             suffixOutside = textNode2.getText().substr(params.offsetEnd)
 617         ;
 618
 619         if(!(textNode1.parent().sameNode(textNode2.parent()))) {
 620             throw new Error('Wrapping text in non-sibling text nodes not supported.');
 621         }
 622
 623         var wrapperElement = this.createDocumentNode({tagName: params._with.tagName, attrs: params._with.attrs});
 624         textNode1.after(wrapperElement);
 625         textNode1.detach();
 626
 627         if(prefixOutside.length > 0) {
 628             wrapperElement.before({text:prefixOutside});
 629         }
 630         if(sameNode) {
 631             var core = textNode1.getText().substr(params.offsetStart, params.offsetEnd - params.offsetStart);
 632             wrapperElement.append({text: core});
 633         } else {
 634             textNode2.detach();
 635             if(prefixInside.length > 0) {
 636                 wrapperElement.append({text: prefixInside});
 637             }
 638             for(var i = idx1 + 1; i < idx2; i++) {
 639                 wrapperElement.append(contentsInside[i]);
 640             }
 641             if(suffixInside.length > 0) {
 642                 wrapperElement.append({text: suffixInside});
 643             }
 644         }
 645         if(suffixOutside.length > 0) {
 646             wrapperElement.after({text: suffixOutside});
 647         }
 648         return wrapperElement;
 649     },
 650
 651     trigger: function() {
 652         //console.log('trigger: ' + arguments[0] + (arguments[1] ? ', ' + arguments[1].type : ''));
 653         Backbone.Events.trigger.apply(this, arguments);
 654     },
 655
 656     getNodeInsertion: function(node) {
 657         var insertion = {};
 658         if(node instanceof DocumentNode) {
 659             insertion.ofNode = node;
 660             insertion.insertsNew = !this.containsNode(node);
 661         } else {
 662           insertion.ofNode = this.createDocumentNode(node);
 663           insertion.insertsNew = true;
 664         }
 665         return insertion;
 666     },
 667
 668     replaceRoot: function(node) {
 669         var insertion = this.getNodeInsertion(node);
 670         this.root.detach();
 671         defineDocumentProperties(this, insertion.ofNode._$);
 672         insertion.ofNode.triggerChangeEvent('nodeAdded');
 673         return insertion.ofNode;
 674     },
 675
 676     registerMethod: function(methodName, method) {
 677         registerMethod(methodName, method, this);
 678     },
 679
 680     registerNodeMethod: function(methodName, method) {
 681         registerMethod(methodName, method, this._nodeMethods);
 682     },
 683
 684     registerDocumentTransformation: function(desc, name) {
 685         registerTransformation(desc, name, this);
 686     },
 687
 688     registerNodeTransformation: function(desc, name) {
 689         registerTransformation(desc, name, this._nodeTransformations);
 690     },
 691
 692     registerExtension: function(extension) {
 693         //debugger;
 694         var doc = this,
 695             existingPropertyNames = _.values(this);
 696
 697         ['document', 'documentNode'].forEach(function(dstName) {
 698             var dstExtension = extension[dstName];
 699             if(dstExtension) {
 700                 if(dstExtension.methods) {
 701                     _.pairs(dstExtension.methods).forEach(function(pair) {
 702                         var methodName = pair[0],
 703                             method = pair[1],
 704                             operation;
 705                         operation = {document: 'registerMethod', documentNode: 'registerNodeMethod'}[dstName];
 706                         doc[operation](methodName, method);
 707
 708                     });
 709                 }
 710
 711                 if(dstExtension.transformations) {
 712                     _.pairs(dstExtension.transformations).forEach(function(pair) {
 713                         var name = pair[0],
 714                             desc = pair[1],
 715                             operation;
 716                         operation = {document: 'registerDocumentTransformation', documentNode: 'registerNodeTransformation'}[dstName];
 717                         doc[operation](desc, name);
 718                     });
 719                 }
 720             }
 721         });
 722     },
 723
 724     transform: function(Transformation, args) {
 725         //console.log('transform');
 726         var toret, transformation;
 727
 728         if(typeof Transformation === 'function') {
 729             transformation = new Transformation(this, this, args);
 730         } else {
 731             transformation = Transformation;
 732         }
 733         if(transformation) {
 734             this._transformationLevel++;
 735             toret = transformation.run();
 736             if(this._transformationLevel === 1) {
 737                 this.undoStack.push(transformation);
 738             }
 739             this._transformationLevel--;
 740             //console.log('clearing redo stack');
 741             this.redoStack = [];
 742             return toret;
 743         } else {
 744             throw new Error('Transformation ' + transformation + ' doesn\'t exist!');
 745         }
 746     },
 747     undo: function() {
 748         var transformation = this.undoStack.pop();
 749         if(transformation) {
 750             transformation.undo();
 751             this.redoStack.push(transformation);
 752         }
 753     },
 754     redo: function() {
 755         var transformation = this.redoStack.pop();
 756         if(transformation) {
 757             transformation.run();
 758             this.undoStack.push(transformation);
 759         }
 760     },
 761
 762     getNodeByPath: function(path) {
 763         var toret = this.root;
 764         path.forEach(function(idx) {
 765             toret = toret.contents()[idx];
 766         });
 767         return toret;
 768     }
 769 });
 770
 771 var defineDocumentProperties = function(doc, $document) {
 772     Object.defineProperty(doc, 'root', {get: function() {
 773         return doc.createDocumentNode($document[0]);
 774     }, configurable: true});
 775     Object.defineProperty(doc, 'dom', {get: function() {
 776         return $document[0];
 777     }, configurable: true});
 778 };
 779
 780
 781 return {
 782     documentFromXML: function(xml) {
 783         return new Document(xml);
 784     },
 785
 786     elementNodeFromXML: function(xml) {
 787         return this.documentFromXML(xml).root;
 788     },
 789
 790     Document: Document,
 791     DocumentNode: DocumentNode,
 792     ElementNode: ElementNode,
 793     TextNode: TextNode
 794 };
 795
 796 });