6 'smartxml/transformations',
9 ], function($, _, Backbone, events, transformations, coreTransformations, fragments) {
15 var DocumentNode = function(nativeNode, document) {
17 throw new Error('undefined document for a node');
19 this.document = document;
20 this._setNativeNode(nativeNode);
24 $.extend(DocumentNode.prototype, {
26 transform: function(Transformation, args) {
27 var transformation = new Transformation(this.document, this, args);
28 return this.document.transform(transformation);
31 _setNativeNode: function(nativeNode) {
32 this.nativeNode = nativeNode;
33 this._$ = $(nativeNode);
37 var clone = this._$.clone(true, true),
39 clone.find('*').addBack().each(function() {
41 clonedData = $(this).data();
43 _.pairs(clonedData).forEach(function(pair) {
46 if(_.isFunction(value.clone)) {
47 clonedData[key] = value.clone(node.document.createDocumentNode(el));
51 return this.document.createDocumentNode(clone[0]);
54 getPath: function(ancestor) {
55 if(!(this.document.containsNode(this))) {
59 var nodePath = [this].concat(this.parents()),
61 ancestor = ancestor || this.document.root;
63 nodePath.some(function(node, i) {
64 if(node.sameNode(ancestor)) {
70 if(idx !== undefined) {
71 nodePath = nodePath.slice(0, idx);
73 toret = nodePath.map(function(node) {return node.getIndex(); });
79 return this.document.root.sameNode(this);
82 isInDocument: function() {
83 return this.document.containsNode(this);
86 isSiblingOf: function(node) {
87 return node && this.parent().sameNode(node.parent());
90 sameNode: function(otherNode) {
91 return !!(otherNode) && this.nativeNode === otherNode.nativeNode;
95 var parentNode = this.nativeNode.parentNode;
96 if(parentNode && parentNode.nodeType === Node.ELEMENT_NODE) {
97 return this.document.createDocumentNode(parentNode);
102 parents: function() {
103 var parent = this.parent(),
104 parents = parent ? parent.parents() : [];
106 parents.unshift(parent);
112 var myIdx = this.getIndex();
113 return myIdx > 0 ? this.parent().contents()[myIdx-1] : null;
120 var myIdx = this.getIndex(),
121 parentContents = this.parent().contents();
122 return myIdx < parentContents.length - 1 ? parentContents[myIdx+1] : null;
125 isSurroundedByTextElements: function() {
126 var prev = this.prev(),
128 return prev && (prev.nodeType === Node.TEXT_NODE) && next && (next.nodeType === Node.TEXT_NODE);
131 triggerChangeEvent: function(type, metaData, origParent, nodeWasContained) {
132 var node = (metaData && metaData.node) ? metaData.node : this,
133 event = new events.ChangeEvent(type, $.extend({node: node}, metaData || {}));
134 if(type === 'nodeDetached' || this.document.containsNode(event.meta.node)) {
135 if(type === 'nodeMoved') {
136 event.meta.parent = origParent;
138 this.document.trigger('change', event);
140 if((type === 'nodeAdded' || type === 'nodeMoved') && !this.document.containsNode(this) && nodeWasContained) {
141 event = new events.ChangeEvent('nodeDetached', {node: node, parent: origParent});
142 this.document.trigger('change', event);
146 getNodeInsertion: function(node) {
147 return this.document.getNodeInsertion(node);
150 getIndex: function() {
154 return this.parent().indexOf(this);
157 getNearestElementNode: function() {
158 return this.nodeType === Node.ELEMENT_NODE ? this : this.parent();
163 var ElementNode = function(nativeNode, document) {
164 DocumentNode.call(this, nativeNode, document);
166 ElementNode.prototype = Object.create(DocumentNode.prototype);
168 $.extend(ElementNode.prototype, {
169 nodeType: Node.ELEMENT_NODE,
171 setData: function(key, value) {
172 if(value !== undefined) {
173 this._$.data(key, value);
175 this._$.removeData(_.keys(this._$.data()));
180 getData: function(key) {
182 return this._$.data(key);
184 return this._$.data();
187 getTagName: function() {
188 return this.nativeNode.tagName.toLowerCase();
191 contents: function(selector) {
193 document = this.document;
195 this._$.children(selector).each(function() {
196 toret.push(document.createDocumentNode(this));
199 this._$.contents().each(function() {
200 toret.push(document.createDocumentNode(this));
206 indexOf: function(node) {
207 return this._$.contents().index(node._$);
210 getAttr: function(name) {
211 return this._$.attr(name);
214 getAttrs: function() {
216 for(var i = 0; i < this.nativeNode.attributes.length; i++) {
217 toret.push(this.nativeNode.attributes[i]);
222 containsNode: function(node) {
223 return node && (node.nativeNode === this.nativeNode || node._$.parents().index(this._$) !== -1);
227 var wrapper = $('<div>');
228 wrapper.append(this._getXMLDOMToDump());
229 return wrapper.html();
232 _getXMLDOMToDump: function() {
238 var TextNode = function(nativeNode, document) {
239 DocumentNode.call(this, nativeNode, document);
241 TextNode.prototype = Object.create(DocumentNode.prototype);
243 $.extend(TextNode.prototype, {
244 nodeType: Node.TEXT_NODE,
246 getText: function() {
247 return this.nativeNode.data;
250 triggerTextChangeEvent: function() {
251 var event = new events.ChangeEvent('nodeTextChange', {node: this});
252 this.document.trigger('change', event);
257 var parseXML = function(xml) {
258 var toret = $($.trim(xml));
260 throw new Error('Unable to parse XML: ' + xml);
266 var registerTransformation = function(desc, name, target) {
267 var Transformation = transformations.createContextTransformation(desc, name);
268 target[name] = function() {
270 args = Array.prototype.slice.call(arguments, 0);
271 return instance.transform(Transformation, args);
275 var registerMethod = function(methodName, method, target) {
276 if(target[methodName]) {
277 throw new Error('Cannot extend {target} with method name {methodName}. Name already exists.'
278 .replace('{target}', target)
279 .replace('{methodName}', methodName)
282 target[methodName] = method;
286 var Document = function(xml, extensions) {
289 this._currentTransaction = null;
290 this._transformationLevel = 0;
292 this._nodeMethods = {};
293 this._textNodeMethods = {};
294 this._elementNodeMethods = {};
295 this._nodeTransformations = {};
296 this._textNodeTransformations = {};
297 this._elementNodeTransformations = {};
299 this.registerExtension(coreTransformations);
301 (extensions || []).forEach(function(extension) {
302 this.registerExtension(extension);
307 $.extend(Document.prototype, Backbone.Events, fragments, {
308 ElementNodeFactory: ElementNode,
309 TextNodeFactory: TextNode,
311 createDocumentNode: function(from) {
312 if(!(from instanceof Node)) {
313 if(typeof from === 'string') {
314 from = parseXML(from);
315 this.normalizeXML(from);
317 if(from.text !== undefined) {
318 /* globals document */
319 from = document.createTextNode(from.text);
322 throw new Error('tagName missing');
324 var node = $('<' + from.tagName + '>');
326 _.keys(from.attrs || {}).forEach(function(key) {
327 node.attr(key, from.attrs[key]);
334 var Factory, typeMethods, typeTransformations;
335 if(from.nodeType === Node.TEXT_NODE) {
336 Factory = this.TextNodeFactory;
337 typeMethods = this._textNodeMethods;
338 typeTransformations = this._textNodeTransformations;
339 } else if(from.nodeType === Node.ELEMENT_NODE) {
340 Factory = this.ElementNodeFactory;
341 typeMethods = this._elementNodeMethods;
342 typeTransformations = this._elementNodeTransformations;
344 var toret = new Factory(from, this);
345 _.extend(toret, this._nodeMethods);
346 _.extend(toret, typeMethods);
348 _.extend(toret, this._nodeTransformations);
349 _.extend(toret, typeTransformations);
351 toret.__super__ = _.extend({}, this._nodeMethods, this._nodeTransformations);
352 _.keys(toret.__super__).forEach(function(key) {
353 toret.__super__[key] = _.bind(toret.__super__[key], toret);
359 loadXML: function(xml, options) {
360 options = options || {};
361 this._defineDocumentProperties($(parseXML(xml)));
362 this.normalizeXML(this.dom);
363 if(!options.silent) {
364 this.trigger('contentSet');
368 normalizeXML: function(nativeNode) {
369 void(nativeNode); // noop
373 return this.root.toXML();
376 containsNode: function(node) {
377 return this.root && this.root.containsNode(node);
380 getSiblingParents: function(params) {
381 var parents1 = [params.node1].concat(params.node1.parents()).reverse(),
382 parents2 = [params.node2].concat(params.node2.parents()).reverse(),
383 noSiblingParents = null;
385 if(parents1.length === 0 || parents2.length === 0 || !(parents1[0].sameNode(parents2[0]))) {
386 return noSiblingParents;
389 var stop = Math.min(parents1.length, parents2.length),
391 for(i = 0; i < stop; i++) {
392 if(parents1[i].sameNode(parents2[i])) {
400 return {node1: parents1[i], node2: parents2[i]};
403 trigger: function() {
404 Backbone.Events.trigger.apply(this, arguments);
407 getNodeInsertion: function(node) {
409 if(node instanceof DocumentNode) {
410 insertion.ofNode = node;
411 insertion.insertsNew = !this.containsNode(node);
413 insertion.ofNode = this.createDocumentNode(node);
414 insertion.insertsNew = true;
419 registerMethod: function(methodName, method, dstName) {
423 documentNode: doc._nodeMethods,
424 textNode: doc._textNodeMethods,
425 elementNode: doc._elementNodeMethods
427 registerMethod(methodName, method, destination);
430 registerTransformation: function(desc, name, dstName) {
434 documentNode: doc._nodeTransformations,
435 textNode: doc._textNodeTransformations,
436 elementNode: doc._elementNodeTransformations
438 registerTransformation(desc, name, destination);
441 registerExtension: function(extension) {
444 ['document', 'documentNode', 'elementNode', 'textNode'].forEach(function(dstName) {
445 var dstExtension = extension[dstName];
447 if(dstExtension.methods) {
448 _.pairs(dstExtension.methods).forEach(function(pair) {
449 var methodName = pair[0],
452 doc.registerMethod(methodName, method, dstName);
457 if(dstExtension.transformations) {
458 _.pairs(dstExtension.transformations).forEach(function(pair) {
461 doc.registerTransformation(desc, name, dstName);
468 ifChanged: function(context, action, documentChangedHandler, documentUnchangedHandler) {
469 var hasChanged = false,
470 changeMonitor = function() {
474 this.on('change', changeMonitor);
475 action.call(context);
476 this.off('change', changeMonitor);
479 if(documentChangedHandler) {
480 documentChangedHandler.call(context);
483 if(documentUnchangedHandler) {
484 documentUnchangedHandler.call(context);
489 transform: function(Transformation, args) {
490 var toret, transformation;
492 if(!this._currentTransaction) {
493 return this.transaction(function() {
494 return this.transform(Transformation, args);
498 if(typeof Transformation === 'function') {
499 transformation = new Transformation(this, this, args);
501 transformation = Transformation;
504 this._transformationLevel++;
509 toret = transformation.run({beUndoable:this._transformationLevel === 1});
512 if(this._transformationLevel === 1 && !this._undoInProgress) {
513 this._currentTransaction.pushTransformation(transformation);
519 this._transformationLevel--;
522 throw new Error('Transformation ' + transformation + ' doesn\'t exist!');
526 var transaction = this.undoStack.pop(),
528 transformations, stopAt;
531 this._undoInProgress = true;
533 // We will modify this array in a minute so make sure we work on a copy.
534 transformations = transaction.transformations.slice(0);
536 if(transformations.length > 1) {
537 // In case of real transactions we don't want to run undo on all of transformations if we don't have to.
539 transformations.some(function(t, idx) {
540 if(!t.undo && t.getChangeRoot().sameNode(doc.root)) {
545 if(stopAt !== undefined) {
546 // We will get away with undoing only this transformations as the one at stopAt reverses the whole document.
547 transformations = transformations.slice(0, stopAt+1);
551 transformations.reverse();
552 transformations.forEach(function(t) {
556 this._undoInProgress = false;
557 this.redoStack.push(transaction);
558 this.trigger('operationEnd');
562 var transaction = this.redoStack.pop();
564 this._transformationLevel++;
565 transaction.transformations.forEach(function(t) {
566 t.run({beUndoable: true});
568 this._transformationLevel--;
569 this.undoStack.push(transaction);
570 this.trigger('operationEnd');
575 startTransaction: function(metadata) {
576 if(this._currentTransaction) {
577 throw new Error('Nested transactions not supported!');
579 this._rollbackBackup = this.root.clone();
580 this._currentTransaction = new Transaction([], metadata);
583 endTransaction: function() {
584 if(!this._currentTransaction) {
585 throw new Error('End of transaction requested, but there is no transaction in progress!');
587 if(this._currentTransaction.hasTransformations()) {
588 this.undoStack.push(this._currentTransaction);
589 this.trigger('operationEnd');
591 this._currentTransaction = null;
594 rollbackTransaction: function() {
595 if(!this._currentTransaction) {
596 throw new Error('Transaction rollback requested, but there is no transaction in progress!');
598 this.replaceRoot(this._rollbackBackup);
599 this._rollbackBackup = null;
600 this._currentTransaction = null;
601 this._transformationLevel = 0;
604 transaction: function(callback, params) {
606 params = params || {};
607 this.startTransaction(params.metadata);
609 toret = callback.call(params.context || this);
614 this.rollbackTransaction();
617 this.endTransaction();
619 params.success(toret);
624 getNodeByPath: function(path) {
625 var toret = this.root;
626 path.forEach(function(idx) {
627 toret = toret.contents()[idx];
632 _defineDocumentProperties: function($document) {
634 Object.defineProperty(doc, 'root', {get: function() {
638 return doc.createDocumentNode($document[0]);
639 }, configurable: true});
640 Object.defineProperty(doc, 'dom', {get: function() {
645 }, configurable: true});
648 createFragment: function(Type, params) {
649 if(!Type.prototype instanceof fragments.Fragment) {
650 throw new Error('Can\'t create a fragment: `Type` is not a valid Fragment');
652 return new Type(this, params);
656 var Transaction = function(transformations, metadata) {
657 this.transformations = transformations || [];
658 this.metadata = metadata;
660 $.extend(Transaction.prototype, {
661 pushTransformation: function(transformation) {
662 this.transformations.push(transformation);
664 hasTransformations: function() {
665 return this.transformations.length > 0;
671 documentFromXML: function(xml) {
672 var doc = new Document(xml);
676 elementNodeFromXML: function(xml) {
677 return this.documentFromXML(xml).root;
681 DocumentNode: DocumentNode,
682 ElementNode: ElementNode,