X-Git-Url: https://git.mdrn.pl/fnpeditor.git/blobdiff_plain/512fcabb2a882e26649612efb2b91f25cfc02ec3..e99c67c2ec195bc34e345616a054966b6cc1554f:/src/smartxml/smartxml.js diff --git a/src/smartxml/smartxml.js b/src/smartxml/smartxml.js index cb90e74..c158bac 100644 --- a/src/smartxml/smartxml.js +++ b/src/smartxml/smartxml.js @@ -2,70 +2,203 @@ define([ 'libs/jquery', 'libs/underscore', 'libs/backbone', - 'smartxml/events' -], function($, _, Backbone, events) { + 'smartxml/events', + 'smartxml/transformations', + 'smartxml/core', + 'smartxml/fragments' +], function($, _, Backbone, events, transformations, coreTransformations, fragments) { 'use strict'; +/* globals Node */ -var TEXT_NODE = Node.TEXT_NODE; - +var privateKey = '_smartxml'; var DocumentNode = function(nativeNode, document) { if(!document) { 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); + }, + _setNativeNode: function(nativeNode) { this.nativeNode = nativeNode; this._$ = $(nativeNode); }, - detach: function() { this._$.detach(); }, + clone: function() { + var clone = this._$.clone(true, true), + node = this; + clone.find('*').addBack().each(function() { + var el = this, + clonedData = $(this).data(); + $(el).removeData(privateKey); + _.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]); + }, + + 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); + }, + + isInDocument: function() { + return this.document.containsNode(this); + }, + + isSiblingOf: function(node) { + return node && this.parent().sameNode(node.parent()); + }, sameNode: function(otherNode) { - return this.nativeNode === otherNode.nativeNode; + return !!(otherNode) && this.nativeNode === otherNode.nativeNode; }, parent: function() { - return this.nativeNode.parentNode ? this.document.createElementNode(this.nativeNode.parentNode) : null; + var parentNode = this.nativeNode.parentNode; + if(parentNode && parentNode.nodeType === Node.ELEMENT_NODE) { + return this.document.createDocumentNode(parentNode); + } + return null; + }, + + parents: function() { + var parent = this.parent(), + parents = parent ? parent.parents() : []; + if(parent) { + parents.unshift(parent); + } + return parents; }, - before: function(node) { - this._$.before(node.nativeNode); + prev: function() { + var myIdx = this.getIndex(); + return myIdx > 0 ? this.parent().contents()[myIdx-1] : null; }, - wrapWith: function(node) { - if(this.parent()) { - this.before(node); + next: function() { + if(this.isRoot()) { + return null; } - node.append(this); + var myIdx = this.getIndex(), + parentContents = this.parent().contents(); + return myIdx < parentContents.length - 1 ? parentContents[myIdx+1] : null; }, - triggerChangeEvent: function(type, metaData) { - var event = new events.ChangeEvent(type, $.extend({node: this}, metaData || {})); - this.document.trigger('change', event); + 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) { + 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' && !this.document.containsNode(this) && nodeWasContained) { + event = new events.ChangeEvent('nodeDetached', {node: node, parent: origParent}); + this.document.trigger('change', event); + } + }, + + getNodeInsertion: function(node) { + return this.document.getNodeInsertion(node); + }, + + getIndex: function() { + var parent; + + if(this.isRoot()) { + return 0; + } + + parent = this.parent(); + return parent ? parent.indexOf(this) : undefined; }, + + getNearestElementNode: function() { + return this.nodeType === Node.ELEMENT_NODE ? this : this.parent(); + } }); + var ElementNode = function(nativeNode, document) { DocumentNode.call(this, nativeNode, document); + $(nativeNode).data(privateKey, {node: this}); }; +ElementNode.prototype = Object.create(DocumentNode.prototype); -$.extend(ElementNode.prototype, DocumentNode.prototype, { +$.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); } }, @@ -73,24 +206,27 @@ $.extend(ElementNode.prototype, DocumentNode.prototype, { if(key) { return this._$.data(key); } - return this._$.data(); + var toret = _.clone(this._$.data()); + delete toret[privateKey]; + return toret; }, getTagName: function() { 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; }, @@ -98,31 +234,10 @@ $.extend(ElementNode.prototype, DocumentNode.prototype, { return this._$.contents().index(node._$); }, - setTag: function(tagName) { - var node = this.document.createElementNode({tagName: tagName}), - oldTagName = this.getTagName(); - - this.getAttrs().forEach(function(attribute) { - node.setAttr(attribute.name, attribute.value, true); - }); - node.setData(this.getData()); - - this._setNativeNode(node._$[0]); - 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++) { @@ -131,123 +246,520 @@ $.extend(ElementNode.prototype, DocumentNode.prototype, { return toret; }, - append: function(documentNode) { - this._$.append(documentNode.nativeNode); + containsNode: function(node) { + return node && (node.nativeNode === this.nativeNode || node._$.parents().index(this._$) !== -1); }, - 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(); - } + getFirstTextNode: function() { + return this._getTextNode('first'); + }, - var moveLeftRange, moveRightRange, leftMerged; + getLastTextNode: function() { + return this._getTextNode('last'); + }, - 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; + _getTextNode: function(which) { + var contents = this.contents(), + toret; + if(which === 'last') { + contents = contents.reverse(); } - - 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; + contents.some(function(node) { + if(node.nodeType === Node.TEXT_NODE) { + toret = node; + return true; } - } - - var childrenLength = this.contents().length; - this.contents().forEach(function(child) { - this.before(child); - }.bind(this)); - - this.detach(); + toret = node.getLastTextNode(); + return !!toret; + }); - return { - element1: parent.contents()[myIdx + (moveLeftRange ? -1 : 0)], - element2: parent.contents()[myIdx + childrenLength-1 + (moveRightRange ? 1 : 0)] - }; + return toret; }, toXML: function() { var wrapper = $('
'); - wrapper.append(this._$); + wrapper.append(this._getXMLDOMToDump()); return wrapper.html(); + }, + + _getXMLDOMToDump: function() { + return this._$; } }); + var TextNode = function(nativeNode, document) { DocumentNode.call(this, nativeNode, document); + this._data = Object.create({}); + nativeNode.__smartxmlTextNodeInstance = this; }; +TextNode.prototype = Object.create(DocumentNode.prototype); -$.extend(TextNode.prototype, DocumentNode.prototype, { +$.extend(TextNode.prototype, { nodeType: Node.TEXT_NODE, + setData: function(arg1, arg2) { + if(arguments.length === 2) { + if(_.isUndefined(arg2)) { + delete this._data[arg1]; + } else { + this._data[arg1] = arg2; + } + } else { + this._data = _.extend({}, arg1); + } + }, + + getData: function(key) { + if(key) { + return this._data[key]; + } + return this._data; + }, + getText: function() { return this.nativeNode.data; }, - appendText: function(text) { - this.nativeNode.data = this.nativeNode.data + text; + + containsNode: function() { + return false; }, - prependText: function(text) { - this.nativeNode.data = text + this.nativeNode.data; + triggerTextChangeEvent: function() { + var event = new events.ChangeEvent('nodeTextChange', {node: this}); + this.document.trigger('change', event); } }); var parseXML = function(xml) { - return $(xml)[0]; + var toret = $($.trim(xml)); + if(toret.length !== 1) { + throw new Error('Unable to parse XML: ' + xml); + } + return toret[0]; + +}; + +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) { - var $document = $(parseXML(xml)); - var doc = this; - Object.defineProperty(this, 'root', {get: function() { - return doc.createElementNode($document[0]); - }}); - Object.defineProperty(this, 'dom', {get: function() { - return $document[0]; - }}); +var Document = function(xml, extensions) { + this.undoStack = []; + this.redoStack = []; + this._currentTransaction = null; + 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); }; -$.extend(Document.prototype, Backbone.Events, { + +$.extend(Document.prototype, Backbone.Events, fragments, { ElementNodeFactory: ElementNode, TextNodeFactory: TextNode, - createElementNode: function(from) { - if(!(from instanceof HTMLElement)) { - from = $('<' + from.tagName + '>'); + createDocumentNode: function(from) { + var cached; + + if(from instanceof Node) { + /* globals Text */ + cached = from instanceof Text ? from.__smartxmlTextNodeInstance : ($(from).data(privateKey) || {}).node; + if(cached instanceof DocumentNode) { + return cached; + } + } else { + if(typeof from === 'string') { + from = parseXML(from); + this.normalizeXML(from); + } else { + 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, 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; + } + 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); + }); + + return toret; + }, + + loadXML: function(xml, options) { + options = options || {}; + this._defineDocumentProperties($(parseXML(xml))); + this.normalizeXML(this.dom); + if(!options.silent) { + this.trigger('contentSet'); } - return new this.ElementNodeFactory(from, this); }, - createTextNode: function(nativeNode) { - return new this.TextNodeFactory(nativeNode, this); + normalizeXML: function(nativeNode) { + void(nativeNode); // noop }, toXML: function() { return this.root.toXML(); + }, + + containsNode: function(node) { + return this.root && this.root.containsNode(node); + }, + + getSiblingParents: function(params) { + var parents1 = [params.node1].concat(params.node1.parents()).reverse(), + parents2 = [params.node2].concat(params.node2.parents()).reverse(), + noSiblingParents = null; + + if(parents1.length === 0 || parents2.length === 0 || !(parents1[0].sameNode(parents2[0]))) { + return noSiblingParents; + } + + 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]}; + }, + + 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; + } + 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); + }); + } + } + }); + }, + + 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 { + transformation = Transformation; + } + if(transformation) { + this._transformationLevel++; + + 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--; + return toret; + } else { + throw new Error('Transformation ' + transformation + ' doesn\'t exist!'); + } + }, + undo: function() { + var transaction = this.undoStack.pop(), + doc = this, + transformations, stopAt; + + if(transaction) { + this._undoInProgress = true; + + // 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. + 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(transaction); + this.trigger('operationEnd'); + } + }, + redo: function() { + var transaction = this.redoStack.pop(); + if(transaction) { + this._transformationLevel++; + transaction.transformations.forEach(function(t) { + t.run({beUndoable: true}); + }); + this._transformationLevel--; + 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.some(function(idx) { + toret = toret.contents()[idx]; + if(!toret) { + return true; + } + }); + return toret; + }, + + _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; } }); return { documentFromXML: function(xml) { - return new Document(parseXML(xml)); + var doc = new Document(xml); + return doc; }, elementNodeFromXML: function(xml) { @@ -256,7 +768,8 @@ return { Document: Document, DocumentNode: DocumentNode, - ElementNode: ElementNode + ElementNode: ElementNode, + TextNode: TextNode }; }); \ No newline at end of file