X-Git-Url: https://git.mdrn.pl/fnpeditor.git/blobdiff_plain/e72654c4d22af93a05a8af98ab58cc44b152c6e7..6e641abeaa2fcd8d8f9885db37d127e7d1a34885:/src/smartxml/smartxml.js diff --git a/src/smartxml/smartxml.js b/src/smartxml/smartxml.js index b150cde..d168e6d 100644 --- a/src/smartxml/smartxml.js +++ b/src/smartxml/smartxml.js @@ -2,25 +2,15 @@ define([ 'libs/jquery', 'libs/underscore', 'libs/backbone', - 'smartxml/events' -], function($, _, Backbone, events) { + 'smartxml/events', + 'smartxml/transformations', + 'smartxml/core' +], function($, _, Backbone, events, transformations, coreTransformations) { 'use strict'; +/* globals Node */ -var TEXT_NODE = Node.TEXT_NODE; - - -var INSERTION = function(implementation) { - var toret = function(node) { - var insertion = this.getNodeInsertion(node); - implementation.call(this, insertion.ofNode.nativeNode); - this.triggerChangeEvent(insertion.insertsNew ? 'nodeAdded' : 'nodeMoved', {node: insertion.ofNode}); - return insertion.ofNode; - }; - return toret; -}; - var DocumentNode = function(nativeNode, document) { if(!document) { throw new Error('undefined document for a node'); @@ -31,30 +21,71 @@ var DocumentNode = function(nativeNode, document) { }; $.extend(DocumentNode.prototype, { + + transform: function(Transformation, args) { + var transformation = new Transformation(this.document, this, args); + return this.document.transform(transformation); + }, + _setNativeNode: function(nativeNode) { this.nativeNode = nativeNode; this._$ = $(nativeNode); }, - isRoot: function() { - return this.document.root.sameNode(this); + clone: function() { + 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]); }, - detach: function() { - var parent = this.parent(); - this._$.detach(); - this.triggerChangeEvent('nodeDetached', {parent: parent}); - return this; + getPath: function(ancestor) { + if(!(this.document.containsNode(this))) { + return null; + } + + var nodePath = [this].concat(this.parents()), + toret, idx; + ancestor = ancestor || this.document.root; + + nodePath.some(function(node, i) { + if(node.sameNode(ancestor)) { + idx = i; + return true; + } + }); + + if(idx !== 'undefined') { + nodePath = nodePath.slice(0, idx); + } + toret = nodePath.map(function(node) {return node.getIndex(); }); + toret.reverse(); + return toret; + }, + + isRoot: function() { + return this.document.root.sameNode(this); }, sameNode: function(otherNode) { - return otherNode && this.nativeNode === otherNode.nativeNode; + return !!(otherNode) && this.nativeNode === otherNode.nativeNode; }, parent: function() { var parentNode = this.nativeNode.parentNode; if(parentNode && parentNode.nodeType === Node.ELEMENT_NODE) { - return this.document.createElementNode(parentNode); + return this.document.createDocumentNode(parentNode); } return null; }, @@ -82,64 +113,37 @@ $.extend(DocumentNode.prototype, { return myIdx < parentContents.length - 1 ? parentContents[myIdx+1] : null; }, - after: INSERTION(function(nativeNode) { - return this._$.after(nativeNode); - }), - - before: INSERTION(function(nativeNode) { - return this._$.before(nativeNode); - }), - - wrapWith: function(node) { - node = node instanceof ElementNode ? node : this.document.createElementNode(node); - - if(this.parent()) { - this.before(node); - } - node.append(this); - return node; - }, - - /** - * Removes parent of a node if node has no siblings. - */ - unwrap: function() { - if(this.isRoot()) { - return; - } - var parent = this.parent(), - grandParent; - if(parent.contents().length === 1) { - grandParent = parent.parent(); - parent.unwrapContent(); - return grandParent; - } + isSurroundedByTextElements: function() { + var prev = this.prev(), + next = this.next(); + return prev && (prev.nodeType === Node.TEXT_NODE) && next && (next.nodeType === Node.TEXT_NODE); }, - triggerChangeEvent: function(type, metaData) { - var event = new events.ChangeEvent(type, $.extend({node: this}, metaData || {})); + triggerChangeEvent: function(type, metaData, origParent, nodeWasContained) { + var node = (metaData && metaData.node) ? metaData.node : this, + event = new events.ChangeEvent(type, $.extend({node: node}, metaData || {})); if(type === 'nodeDetached' || this.document.containsNode(event.meta.node)) { this.document.trigger('change', event); } + if((type === 'nodeAdded' || type === 'nodeMoved') && !this.document.containsNode(this) && nodeWasContained) { + event = new events.ChangeEvent('nodeDetached', {node: node, parent: origParent}); + this.document.trigger('change', event); + } }, getNodeInsertion: function(node) { - var insertion = {}; - if(node instanceof DocumentNode) { - insertion.ofNode = node; - insertion.insertsNew = !this.document.containsNode(node); - } else { - insertion.ofNode = this.document.createElementNode(node); - insertion.insertsNew = true; - } - return insertion; + return this.document.getNodeInsertion(node); }, getIndex: function() { + if(this.isRoot()) { + return 0; + } return this.parent().indexOf(this); } }); + var ElementNode = function(nativeNode, document) { DocumentNode.call(this, nativeNode, document); }; @@ -148,18 +152,6 @@ ElementNode.prototype = Object.create(DocumentNode.prototype); $.extend(ElementNode.prototype, { nodeType: Node.ELEMENT_NODE, - detach: function() { - var prev = this.prev(), - next = this.next(); - if(parent) { - if(prev && prev.nodeType === Node.TEXT_NODE && next && next.nodeType === Node.TEXT_NODE) { - prev.appendText(next.getText()); - next.detach(); - } - } - return DocumentNode.prototype.detach.call(this); - }, - setData: function(key, value) { if(value !== undefined) { this._$.data(key, value); @@ -180,17 +172,18 @@ $.extend(ElementNode.prototype, { return this.nativeNode.tagName.toLowerCase(); }, - contents: function() { + contents: function(selector) { var toret = [], document = this.document; - this._$.contents().each(function() { - if(this.nodeType === Node.ELEMENT_NODE) { - toret.push(document.createElementNode(this)); - } - else if(this.nodeType === Node.TEXT_NODE) { - toret.push(document.createTextNode(this)); - } - }); + if(selector) { + this._$.children(selector).each(function() { + toret.push(document.createDocumentNode(this)); + }); + } else { + this._$.contents().each(function() { + toret.push(document.createDocumentNode(this)); + }); + } return toret; }, @@ -198,37 +191,10 @@ $.extend(ElementNode.prototype, { return this._$.contents().index(node._$); }, - setTag: function(tagName) { - var node = this.document.createElementNode({tagName: tagName}), - oldTagName = this.getTagName(), - myContents = this._$.contents(); - - this.getAttrs().forEach(function(attribute) { - node.setAttr(attribute.name, attribute.value, true); - }); - node.setData(this.getData()); - - if(this.sameNode(this.document.root)) { - defineDocumentProperties(this.document, node._$); - } - this._$.replaceWith(node._$); - this._setNativeNode(node._$[0]); - this._$.append(myContents); - this.triggerChangeEvent('nodeTagChange', {oldTagName: oldTagName, newTagName: this.getTagName()}); - }, - getAttr: function(name) { return this._$.attr(name); }, - setAttr: function(name, value, silent) { - var oldVal = this.getAttr(name); - this._$.attr(name, value); - if(!silent) { - this.triggerChangeEvent('nodeAttrChange', {attr: name, oldVal: oldVal, newVal: value}); - } - }, - getAttrs: function() { var toret = []; for(var i = 0; i < this.nativeNode.attributes.length; i++) { @@ -237,64 +203,6 @@ $.extend(ElementNode.prototype, { return toret; }, - append: INSERTION(function(nativeNode) { - this._$.append(nativeNode); - }), - - prepend: INSERTION(function(nativeNode) { - this._$.prepend(nativeNode); - }), - - unwrapContent: function() { - var parent = this.parent(); - if(!parent) { - return; - } - - var parentContents = parent.contents(), - myContents = this.contents(), - myIdx = parent.indexOf(this); - - if(myContents.length === 0) { - return this.detach(); - } - - var moveLeftRange, moveRightRange, leftMerged; - - if(myIdx > 0 && (parentContents[myIdx-1].nodeType === TEXT_NODE) && (myContents[0].nodeType === TEXT_NODE)) { - parentContents[myIdx-1].appendText(myContents[0].getText()); - myContents[0].detach(); - moveLeftRange = true; - leftMerged = true; - } else { - leftMerged = false; - } - - if(!(leftMerged && myContents.length === 1)) { - if(myIdx < parentContents.length - 1 && (parentContents[myIdx+1].nodeType === TEXT_NODE) && (myContents[myContents.length-1].nodeType === TEXT_NODE)) { - parentContents[myIdx+1].prependText(myContents[myContents.length-1].getText()); - myContents[myContents.length-1].detach(); - moveRightRange = true; - } - } - - var childrenLength = this.contents().length; - this.contents().forEach(function(child) { - this.before(child); - }.bind(this)); - - this.detach(); - - return { - element1: parent.contents()[myIdx + (moveLeftRange ? -1 : 0)], - element2: parent.contents()[myIdx + childrenLength-1 + (moveRightRange ? 1 : 0)] - }; - }, - - wrapText: function(params) { - return this.document._wrapText(_.extend({inside: this}, params)); - }, - toXML: function() { var wrapper = $('
'); wrapper.append(this._getXMLDOMToDump()); @@ -306,6 +214,7 @@ $.extend(ElementNode.prototype, { } }); + var TextNode = function(nativeNode, document) { DocumentNode.call(this, nativeNode, document); }; @@ -318,35 +227,6 @@ $.extend(TextNode.prototype, { return this.nativeNode.data; }, - setText: function(text) { - this.nativeNode.data = text; - this.triggerTextChangeEvent(); - }, - - appendText: function(text) { - this.nativeNode.data = this.nativeNode.data + text; - this.triggerTextChangeEvent(); - }, - - prependText: function(text) { - this.nativeNode.data = text + this.nativeNode.data; - this.triggerTextChangeEvent(); - }, - - wrapWith: function(desc) { - if(typeof desc.start === 'number' && typeof desc.end === 'number') { - return this.document._wrapText({ - inside: this.parent(), - textNodeIdx: this.parent().indexOf(this), - offsetStart: Math.min(desc.start, desc.end), - offsetEnd: Math.max(desc.start, desc.end), - _with: {tagName: desc.tagName, attrs: desc.attrs} - }); - } else { - return DocumentNode.prototype.wrapWith.call(this, desc); - } - }, - triggerTextChangeEvent: function() { var event = new events.ChangeEvent('nodeTextChange', {node: this}); this.document.trigger('change', event); @@ -355,10 +235,52 @@ $.extend(TextNode.prototype, { var parseXML = function(xml) { - return $(xml)[0]; + var toret = $($.trim(xml)); + if(!toret.length) { + throw new Error('Unable to parse XML: ' + xml); + } + return toret[0]; + }; -var Document = function(xml) { +var registerTransformation = function(desc, name, target) { + var Transformation = transformations.createContextTransformation(desc, name); + target[name] = function() { + var instance = this, + args = Array.prototype.slice.call(arguments, 0); + return instance.transform(Transformation, args); + }; +}; + +var registerMethod = function(methodName, method, target) { + if(target[methodName]) { + throw new Error('Cannot extend {target} with method name {methodName}. Name already exists.' + .replace('{target}', target) + .replace('{methodName}', methodName) + ); + } + target[methodName] = method; +}; + + +var Document = function(xml, extensions) { + this.undoStack = []; + this.redoStack = []; + this._transactionStack = []; + this._transformationLevel = 0; + + this._nodeMethods = {}; + this._textNodeMethods = {}; + this._elementNodeMethods = {}; + this._nodeTransformations = {}; + this._textNodeTransformations = {}; + this._elementNodeTransformations = {}; + + this.registerExtension(coreTransformations); + + (extensions || []).forEach(function(extension) { + this.registerExtension(extension); + }.bind(this)); this.loadXML(xml); }; @@ -366,41 +288,67 @@ $.extend(Document.prototype, Backbone.Events, { ElementNodeFactory: ElementNode, TextNodeFactory: TextNode, - createElementNode: function(from) { - if(!(from instanceof HTMLElement)) { - if(from.text) { - from = document.createTextNode(from.text); + createDocumentNode: function(from) { + if(!(from instanceof Node)) { + 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]); - }); - - from = node[0]; + 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]; + } } } - var Factory; + var Factory, typeMethods, typeTransformations; if(from.nodeType === Node.TEXT_NODE) { Factory = this.TextNodeFactory; + typeMethods = this._textNodeMethods; + typeTransformations = this._textNodeTransformations; } else if(from.nodeType === Node.ELEMENT_NODE) { Factory = this.ElementNodeFactory; + typeMethods = this._elementNodeMethods; + typeTransformations = this._elementNodeTransformations; } - return new Factory(from, this); - }, + var toret = new Factory(from, this); + _.extend(toret, this._nodeMethods); + _.extend(toret, typeMethods); + + _.extend(toret, this._nodeTransformations); + _.extend(toret, typeTransformations); + + toret.__super__ = _.extend({}, this._nodeMethods, this._nodeTransformations); + _.keys(toret.__super__).forEach(function(key) { + toret.__super__[key] = _.bind(toret.__super__[key], toret); + }); - createTextNode: function(nativeNode) { - return new this.TextNodeFactory(nativeNode, this); + return toret; }, loadXML: function(xml, options) { options = options || {}; - defineDocumentProperties(this, $(parseXML(xml))); + 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(); }, @@ -409,42 +357,6 @@ $.extend(Document.prototype, Backbone.Events, { return this.root && (node.nativeNode === this.root.nativeNode || node._$.parents().index(this.root._$) !== -1); }, - wrapNodes: function(params) { - if(!(params.element1.parent().sameNode(params.element2.parent()))) { - throw new Error('Wrapping non-sibling nodes not supported.'); - } - - var parent = params.element1.parent(), - parentContents = parent.contents(), - wrapper = this.createElementNode({ - tagName: params._with.tagName, - attrs: params._with.attrs}), - idx1 = parent.indexOf(params.element1), - idx2 = parent.indexOf(params.element2); - - if(idx1 > idx2) { - var tmp = idx1; - idx1 = idx2; - idx2 = tmp; - } - - var insertingMethod, insertingTarget; - if(idx1 === 0) { - insertingMethod = 'prepend'; - insertingTarget = parent; - } else { - insertingMethod = 'after'; - insertingTarget = parentContents[idx1-1]; - } - - for(var i = idx1; i <= idx2; i++) { - wrapper.append(parentContents[i].detach()); - } - - insertingTarget[insertingMethod](wrapper); - return wrapper; - }, - getSiblingParents: function(params) { var parents1 = [params.node1].concat(params.node1.parents()).reverse(), parents2 = [params.node2].concat(params.node2.parents()).reverse(), @@ -464,74 +376,194 @@ $.extend(Document.prototype, Backbone.Events, { return {node1: parents1[i], node2: parents2[i]}; }, - _wrapText: function(params) { - params = _.extend({textNodeIdx: 0}, params); - if(typeof params.textNodeIdx === 'number') { - params.textNodeIdx = [params.textNodeIdx]; - } - - var contentsInside = params.inside.contents(), - idx1 = Math.min.apply(Math, params.textNodeIdx), - idx2 = Math.max.apply(Math, params.textNodeIdx), - textNode1 = contentsInside[idx1], - textNode2 = contentsInside[idx2], - sameNode = textNode1.sameNode(textNode2), - prefixOutside = textNode1.getText().substr(0, params.offsetStart), - prefixInside = textNode1.getText().substr(params.offsetStart), - suffixInside = textNode2.getText().substr(0, params.offsetEnd), - suffixOutside = textNode2.getText().substr(params.offsetEnd) - ; - - if(!(textNode1.parent().sameNode(textNode2.parent()))) { - throw new Error('Wrapping text in non-sibling text nodes not supported.'); - } - - var wrapperElement = this.createElementNode({tagName: params._with.tagName, attrs: params._with.attrs}); - textNode1.after(wrapperElement); - textNode1.detach(); - - if(prefixOutside.length > 0) { - wrapperElement.before({text:prefixOutside}); + trigger: function() { + Backbone.Events.trigger.apply(this, arguments); + }, + + getNodeInsertion: function(node) { + var insertion = {}; + if(node instanceof DocumentNode) { + insertion.ofNode = node; + insertion.insertsNew = !this.containsNode(node); + } else { + insertion.ofNode = this.createDocumentNode(node); + insertion.insertsNew = true; } - if(sameNode) { - var core = textNode1.getText().substr(params.offsetStart, params.offsetEnd - params.offsetStart); - wrapperElement.append({text: core}); + return insertion; + }, + + registerMethod: function(methodName, method, dstName) { + var doc = this; + var destination = { + document: doc, + documentNode: doc._nodeMethods, + textNode: doc._textNodeMethods, + elementNode: doc._elementNodeMethods + }[dstName]; + registerMethod(methodName, method, destination); + }, + + registerTransformation: function(desc, name, dstName) { + var doc = this; + var destination = { + document: doc, + documentNode: doc._nodeTransformations, + textNode: doc._textNodeTransformations, + elementNode: doc._elementNodeTransformations + }[dstName]; + registerTransformation(desc, name, destination); + }, + + registerExtension: function(extension) { + var doc = this; + + ['document', 'documentNode', 'elementNode', 'textNode'].forEach(function(dstName) { + var dstExtension = extension[dstName]; + if(dstExtension) { + if(dstExtension.methods) { + _.pairs(dstExtension.methods).forEach(function(pair) { + var methodName = pair[0], + method = pair[1]; + + doc.registerMethod(methodName, method, dstName); + + }); + } + + if(dstExtension.transformations) { + _.pairs(dstExtension.transformations).forEach(function(pair) { + var name = pair[0], + desc = pair[1]; + doc.registerTransformation(desc, name, dstName); + }); + } + } + }); + }, + + transform: function(Transformation, args) { + var toret, transformation; + + if(typeof Transformation === 'function') { + transformation = new Transformation(this, this, args); } else { - textNode2.detach(); - if(prefixInside.length > 0) { - wrapperElement.append({text: prefixInside}); + transformation = Transformation; + } + if(transformation) { + this._transformationLevel++; + toret = transformation.run({beUndoable:this._transformationLevel === 1}); + if(this._transformationLevel === 1 && !this._undoInProgress) { + if(this._transactionInProgress) { + this._transactionStack.push(transformation); + } else { + this.undoStack.push(transformation); + } } - for(var i = idx1 + 1; i < idx2; i++) { - wrapperElement.append(contentsInside[i]); + if(!this._undoInProgress && this._transformationLevel === 1) { + this.redoStack = []; } - if(suffixInside.length > 0) { - wrapperElement.append({text: suffixInside}); + this._transformationLevel--; + return toret; + } else { + throw new Error('Transformation ' + transformation + ' doesn\'t exist!'); + } + }, + undo: function() { + var transformationObject = this.undoStack.pop(), + doc = this, + transformations, stopAt; + + if(transformationObject) { + this._undoInProgress = true; + + if(_.isArray(transformationObject)) { + // We will modify this array in a minute so make sure we work on a copy. + transformations = transformationObject.slice(0); + } else { + // Lets normalize single transformation to a transaction containing one transformation. + transformations = [transformationObject]; + } + + 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(transformationObject); } - if(suffixOutside.length > 0) { - wrapperElement.after({text: suffixOutside}); + }, + redo: function() { + var transformationObject = this.redoStack.pop(), + transformations; + if(transformationObject) { + this._transformationLevel++; + transformations = _.isArray(transformationObject) ? transformationObject : [transformationObject]; + transformations.forEach(function(t) { + t.run({beUndoable: true}); + }); + this._transformationLevel--; + this.undoStack.push(transformationObject); } - return wrapperElement; }, - trigger: function() { - //console.log('trigger: ' + arguments[0] + (arguments[1] ? ', ' + arguments[1].type : '')); - Backbone.Events.trigger.apply(this, arguments); + startTransaction: function() { + if(this._transactionInProgress) { + throw new Error('Nested transactions not supported!'); + } + this._transactionInProgress = true; + }, + + endTransaction: function() { + if(!this._transactionInProgress) { + throw new Error('End of transaction requested, but there is no transaction in progress!'); + } + this._transactionInProgress = false; + if(this._transactionStack.length) { + this.undoStack.push(this._transactionStack); + this._transactionStack = []; + } + }, + + getNodeByPath: function(path) { + var toret = this.root; + path.forEach(function(idx) { + toret = toret.contents()[idx]; + }); + return toret; + }, + + _defineDocumentProperties: function($document) { + var doc = this; + Object.defineProperty(doc, 'root', {get: function() { + return doc.createDocumentNode($document[0]); + }, configurable: true}); + Object.defineProperty(doc, 'dom', {get: function() { + return $document[0]; + }, configurable: true}); } }); -var defineDocumentProperties = function(doc, $document) { - Object.defineProperty(doc, 'root', {get: function() { - return doc.createElementNode($document[0]); - }, configurable: true}); - Object.defineProperty(doc, 'dom', {get: function() { - return $document[0]; - }, configurable: true}); -}; return { documentFromXML: function(xml) { - return new Document(parseXML(xml)); + var doc = new Document(xml); + return doc; }, elementNodeFromXML: function(xml) { @@ -540,7 +572,8 @@ return { Document: Document, DocumentNode: DocumentNode, - ElementNode: ElementNode + ElementNode: ElementNode, + TextNode: TextNode }; }); \ No newline at end of file