'libs/backbone',
'smartxml/events',
'smartxml/transformations',
- 'smartxml/core'
-], function($, _, Backbone, events, transformations, coreTransformations) {
+ 'smartxml/core',
+ 'smartxml/fragments'
+], function($, _, Backbone, events, transformations, coreTransformations, fragments) {
'use strict';
/* globals Node */
throw new Error('undefined document for a node');
}
this.document = document;
+ this.object = {};
this._setNativeNode(nativeNode);
};
$.extend(DocumentNode.prototype, {
+ getProperty: function(propName) {
+ var toret = this.object[propName];
+ if(toret && _.isFunction(toret)) {
+ toret = toret.call(this);
+ }
+ return toret;
+ },
+
transform: function(Transformation, args) {
var transformation = new Transformation(this.document, this, args);
return this.document.transform(transformation);
},
clone: function() {
- var clone = this._$.clone(true, true);
+ var clone = this._$.clone(true, true),
+ node = this;
+ clone.find('*').addBack().each(function() {
+ var el = this,
+ clonedData = $(this).data();
+
+ _.pairs(clonedData).forEach(function(pair) {
+ var key = pair[0],
+ value = pair[1];
+ if(_.isFunction(value.clone)) {
+ clonedData[key] = value.clone(node.document.createDocumentNode(el));
+ }
+ });
+ });
return this.document.createDocumentNode(clone[0]);
},
}
});
- if(idx !== 'undefined') {
+ if(idx !== undefined) {
nodePath = nodePath.slice(0, idx);
}
toret = nodePath.map(function(node) {return node.getIndex(); });
return this.document.root.sameNode(this);
},
+ isInDocument: function() {
+ return this.document.containsNode(this);
+ },
+
+ isSiblingOf: function(node) {
+ return node && this.parent().sameNode(node.parent());
+ },
+
sameNode: function(otherNode) {
return !!(otherNode) && this.nativeNode === otherNode.nativeNode;
},
return myIdx < parentContents.length - 1 ? parentContents[myIdx+1] : null;
},
- isSurroundedByTextElements: function() {
- var prev = this.prev(),
- next = this.next();
- return prev && (prev.nodeType === Node.TEXT_NODE) && next && (next.nodeType === Node.TEXT_NODE);
+ isSurroundedByTextNodes: function() {
+ return this.isPrecededByTextNode() && this.isFollowedByTextNode();
+ },
+
+ isPrecededByTextNode: function() {
+ var prev = this.prev();
+ return prev && prev.nodeType === Node.TEXT_NODE;
+ },
+
+ isFollowedByTextNode: function() {
+ var next = this.next();
+ return next && next.nodeType === Node.TEXT_NODE;
},
triggerChangeEvent: function(type, metaData, origParent, nodeWasContained) {
if(type === 'nodeDetached' || this.document.containsNode(event.meta.node)) {
this.document.trigger('change', event);
}
- if((type === 'nodeAdded' || type === 'nodeMoved') && !this.document.containsNode(this) && nodeWasContained) {
+ if(type === 'nodeAdded' && !this.document.containsNode(this) && nodeWasContained) {
event = new events.ChangeEvent('nodeDetached', {node: node, parent: origParent});
this.document.trigger('change', event);
}
},
getIndex: function() {
+ var parent;
+
if(this.isRoot()) {
return 0;
}
- return this.parent().indexOf(this);
+
+ parent = this.parent();
+ return parent ? parent.indexOf(this) : undefined;
+ },
+
+ getNearestElementNode: function() {
+ return this.nodeType === Node.ELEMENT_NODE ? this : this.parent();
}
});
$.extend(ElementNode.prototype, {
nodeType: Node.ELEMENT_NODE,
- setData: function(key, value) {
- if(value !== undefined) {
- this._$.data(key, value);
+ setData: function(arg1, arg2) {
+ if(arguments.length === 2) {
+ if(_.isUndefined(arg2)) {
+ this._$.removeData(arg1);
+ } else {
+ this._$.data(arg1, arg2);
+ }
} else {
this._$.removeData(_.keys(this._$.data()));
- this._$.data(key);
+ this._$.data(arg1);
}
},
return toret;
},
+ containsNode: function(node) {
+ return node && (node.nativeNode === this.nativeNode || node._$.parents().index(this._$) !== -1);
+ },
+
+ getLastTextNode: function() {
+ var contents = this.contents(),
+ toret;
+
+ contents.reverse().some(function(node) {
+ if(node.nodeType === Node.TEXT_NODE) {
+ toret = node;
+ return true;
+ }
+ toret = node.getLastTextNode();
+ return !!toret;
+ });
+
+ return toret;
+ },
+
toXML: function() {
var wrapper = $('<div>');
wrapper.append(this._getXMLDOMToDump());
return this.nativeNode.data;
},
+
+ containsNode: function() {
+ return false;
+ },
+
triggerTextChangeEvent: function() {
var event = new events.ChangeEvent('nodeTextChange', {node: this});
this.document.trigger('change', event);
var parseXML = function(xml) {
- return $($.trim(xml))[0];
+ var toret = $($.trim(xml));
+ if(!toret.length) {
+ throw new Error('Unable to parse XML: ' + xml);
+ }
+ return toret[0];
+
};
var registerTransformation = function(desc, name, target) {
};
-var Document = function(xml) {
- this.loadXML(xml);
+var Document = function(xml, extensions) {
this.undoStack = [];
this.redoStack = [];
+ this._currentTransaction = null;
this._transformationLevel = 0;
this._nodeMethods = {};
this._elementNodeTransformations = {};
this.registerExtension(coreTransformations);
+
+ (extensions || []).forEach(function(extension) {
+ this.registerExtension(extension);
+ }.bind(this));
+ this.loadXML(xml);
};
-$.extend(Document.prototype, Backbone.Events, {
+$.extend(Document.prototype, Backbone.Events, fragments, {
ElementNodeFactory: ElementNode,
TextNodeFactory: TextNode,
createDocumentNode: function(from) {
if(!(from instanceof Node)) {
- if(from.text !== undefined) {
- /* globals document */
- from = document.createTextNode(from.text);
+ if(typeof from === 'string') {
+ from = parseXML(from);
+ this.normalizeXML(from);
} else {
- var node = $('<' + from.tagName + '>');
-
- _.keys(from.attrs || {}).forEach(function(key) {
- node.attr(key, from.attrs[key]);
- });
+ if(from.text !== undefined) {
+ /* globals document */
+ from = document.createTextNode(from.text);
+ } else {
+ if(!from.tagName) {
+ throw new Error('tagName missing');
+ }
+ var node = $('<' + from.tagName + '>');
+
+ _.keys(from.attrs || {}).forEach(function(key) {
+ node.attr(key, from.attrs[key]);
+ });
- from = node[0];
+ from = node[0];
+ }
}
}
var Factory, typeMethods, typeTransformations;
loadXML: function(xml, options) {
options = options || {};
this._defineDocumentProperties($(parseXML(xml)));
+ this.normalizeXML(this.dom);
if(!options.silent) {
this.trigger('contentSet');
}
},
+ normalizeXML: function(nativeNode) {
+ void(nativeNode); // noop
+ },
+
toXML: function() {
return this.root.toXML();
},
containsNode: function(node) {
- return this.root && (node.nativeNode === this.root.nativeNode || node._$.parents().index(this.root._$) !== -1);
+ return this.root && this.root.containsNode(node);
},
getSiblingParents: function(params) {
return noSiblingParents;
}
- var i;
- for(i = 0; i < Math.min(parents1.length, parents2.length); i++) {
+ var stop = Math.min(parents1.length, parents2.length),
+ i;
+ for(i = 0; i < stop; i++) {
if(parents1[i].sameNode(parents2[i])) {
continue;
}
break;
}
+ if(i === stop) {
+ i--;
+ }
return {node1: parents1[i], node2: parents2[i]};
},
});
},
+ ifChanged: function(context, action, documentChangedHandler, documentUnchangedHandler) {
+ var hasChanged = false,
+ changeMonitor = function() {
+ hasChanged = true;
+ };
+
+ this.on('change', changeMonitor);
+ action.call(context);
+ this.off('change', changeMonitor);
+
+ if(hasChanged) {
+ if(documentChangedHandler) {
+ documentChangedHandler.call(context);
+ }
+ } else {
+ if(documentUnchangedHandler) {
+ documentUnchangedHandler.call(context);
+ }
+ }
+ },
+
transform: function(Transformation, args) {
var toret, transformation;
+ if(!this._currentTransaction) {
+ return this.transaction(function() {
+ return this.transform(Transformation, args);
+ }, {context: this});
+ }
+
if(typeof Transformation === 'function') {
transformation = new Transformation(this, this, args);
} else {
}
if(transformation) {
this._transformationLevel++;
- toret = transformation.run({beUndoable:this._transformationLevel === 1});
- if(this._transformationLevel === 1 && !this._undoInProgress) {
- this.undoStack.push(transformation);
- }
+
+ this.ifChanged(
+ this,
+ function() {
+ toret = transformation.run({beUndoable:this._transformationLevel === 1});
+ },
+ function() {
+ if(this._transformationLevel === 1 && !this._undoInProgress) {
+ this._currentTransaction.pushTransformation(transformation);
+ this.redoStack = [];
+ }
+ }
+ );
+
this._transformationLevel--;
- if(!this._undoInProgress) {
- this.redoStack = [];
- }
return toret;
} else {
throw new Error('Transformation ' + transformation + ' doesn\'t exist!');
}
},
undo: function() {
- var transformation = this.undoStack.pop();
- if(transformation) {
+ var transaction = this.undoStack.pop(),
+ doc = this,
+ transformations, stopAt;
+
+ if(transaction) {
this._undoInProgress = true;
- transformation.undo();
+
+ // We will modify this array in a minute so make sure we work on a copy.
+ transformations = transaction.transformations.slice(0);
+
+ if(transformations.length > 1) {
+ // In case of real transactions we don't want to run undo on all of transformations if we don't have to.
+ stopAt = undefined;
+ transformations.some(function(t, idx) {
+ if(!t.undo && t.getChangeRoot().sameNode(doc.root)) {
+ stopAt = idx;
+ return true; //break
+ }
+ });
+ if(stopAt !== undefined) {
+ // We will get away with undoing only this transformations as the one at stopAt reverses the whole document.
+ transformations = transformations.slice(0, stopAt+1);
+ }
+ }
+
+ transformations.reverse();
+ transformations.forEach(function(t) {
+ t.undo();
+ });
+
this._undoInProgress = false;
- this.redoStack.push(transformation);
+ this.redoStack.push(transaction);
+ this.trigger('operationEnd');
}
},
redo: function() {
- var transformation = this.redoStack.pop();
- if(transformation) {
+ var transaction = this.redoStack.pop();
+ if(transaction) {
this._transformationLevel++;
- transformation.run({beUndoable: true});
+ transaction.transformations.forEach(function(t) {
+ t.run({beUndoable: true});
+ });
this._transformationLevel--;
- this.undoStack.push(transformation);
+ this.undoStack.push(transaction);
+ this.trigger('operationEnd');
}
},
+ startTransaction: function(metadata) {
+ if(this._currentTransaction) {
+ throw new Error('Nested transactions not supported!');
+ }
+ this._rollbackBackup = this.root.clone();
+ this._currentTransaction = new Transaction([], metadata);
+ },
+
+ endTransaction: function() {
+ if(!this._currentTransaction) {
+ throw new Error('End of transaction requested, but there is no transaction in progress!');
+ }
+ if(this._currentTransaction.hasTransformations()) {
+ this.undoStack.push(this._currentTransaction);
+ this.trigger('operationEnd');
+ }
+ this._currentTransaction = null;
+ },
+
+ rollbackTransaction: function() {
+ if(!this._currentTransaction) {
+ throw new Error('Transaction rollback requested, but there is no transaction in progress!');
+ }
+ this.replaceRoot(this._rollbackBackup);
+ this._rollbackBackup = null;
+ this._currentTransaction = null;
+ this._transformationLevel = 0;
+ },
+
+ transaction: function(callback, params) {
+ var toret;
+ params = params || {};
+ this.startTransaction(params.metadata);
+ try {
+ toret = callback.call(params.context || this);
+ } catch(e) {
+ if(params.error) {
+ params.error(e);
+ }
+ this.rollbackTransaction();
+ return;
+ }
+ this.endTransaction();
+ if(params.success) {
+ params.success(toret);
+ }
+ return toret;
+ },
+
getNodeByPath: function(path) {
var toret = this.root;
path.forEach(function(idx) {
_defineDocumentProperties: function($document) {
var doc = this;
Object.defineProperty(doc, 'root', {get: function() {
+ if(!$document) {
+ return null;
+ }
return doc.createDocumentNode($document[0]);
}, configurable: true});
Object.defineProperty(doc, 'dom', {get: function() {
+ if(!$document) {
+ return null;
+ }
return $document[0];
}, configurable: true});
+ },
+
+ createFragment: function(Type, params) {
+ if(!Type.prototype instanceof fragments.Fragment) {
+ throw new Error('Can\'t create a fragment: `Type` is not a valid Fragment');
+ }
+ return new Type(this, params);
+ }
+});
+
+var Transaction = function(transformations, metadata) {
+ this.transformations = transformations || [];
+ this.metadata = metadata;
+};
+$.extend(Transaction.prototype, {
+ pushTransformation: function(transformation) {
+ this.transformations.push(transformation);
+ },
+ hasTransformations: function() {
+ return this.transformations.length > 0;
}
});
fnp / fnpeditor.git / blobdiff