mediawiki-extensions-Visual.../modules/ve2/dm/ve.dm.Surface.js
Trevor Parscal e266905b94 Moved history tracking into a startable/stoppable service
And made it not start on it's own, but be started by ve.Surface - this makes it so it's not polling in the unit tests, for instance

Change-Id: I940df04d392fd134d18847949efe0e2232328323
2012-06-13 17:16:04 -07:00

169 lines
4 KiB
JavaScript

/**
* DataModel surface.
*
* @class
* @constructor
* @extends {ve.EventEmitter}
* @param {ve.dm.Document} doc Document model to create surface for
*/
ve.dm.Surface = function( doc ) {
// Inheritance
ve.EventEmitter.call( this );
// Properties
this.documentModel = doc;
this.selection = null;
this.smallStack = [];
this.bigStack = [];
this.undoIndex = 0;
this.historyTrackingInterval = null;
};
/* Methods */
ve.dm.Surface.prototype.startHistoryTracking = function() {
this.historyTrackingInterval = setInterval( ve.proxy( this.breakpoint, this ), 750 );
};
ve.dm.Surface.prototype.stopHistoryTracking = function() {
clearInterval( this.historyTrackingInterval );
};
ve.dm.Surface.prototype.purgeHistory = function() {
this.selection = null;
this.smallStack = [];
this.bigStack = [];
this.undoIndex = 0;
};
ve.dm.Surface.prototype.getHistory = function() {
if ( this.smallStack.length > 0 ) {
return this.bigStack.slice( 0 ).concat( [{ 'stack': this.smallStack.slice(0) }] );
} else {
return this.bigStack.slice( 0 );
}
};
/**
* Gets the document model of the surface.
*
* @method
* @returns {ve.dm.DocumentNode} Document model of the surface
*/
ve.dm.Surface.prototype.getDocument = function() {
return this.documentModel;
};
/**
* Gets the selection
*
* @method
* @returns {ve.Range} Current selection
*/
ve.dm.Surface.prototype.getSelection = function() {
return this.selection;
};
/**
* Sets the selection
*
* @method
* @param {ve.Range} selection
*/
ve.dm.Surface.prototype.setSelection = function( selection ) {
selection.normalize();
if (
( !this.selection ) ||
( !this.selection.equals ( selection ) )
)
{
this.selection = selection;
}
this.emit ('select', this.selection.clone() );
};
/**
* Applies a series of transactions to the content data.
*
* @method
* @param {ve.dm.Transaction} transactions Tranasction to apply to the document
*/
ve.dm.Surface.prototype.transact = function( transaction ) {
this.bigStack = this.bigStack.slice( 0, this.bigStack.length - this.undoIndex );
this.undoIndex = 0;
this.smallStack.push( transaction );
ve.dm.TransactionProcessor.commit( this.getDocument(), transaction );
this.emit( 'transact', transaction );
};
/**
* Applies an annotation to the current selection
*
* @method
* @param {String} annotation action: toggle, clear, set
* @param {Object} annotation object to apply.
*/
ve.dm.Surface.prototype.annotate = function( method, annotation ) {
var selection = this.getSelection();
if ( this.selection.getLength() ) {
var tx = ve.dm.Transaction.newFromAnnotation(
this.getDocument(), selection, method, annotation
);
this.transact( tx );
}
};
ve.dm.Surface.prototype.breakpoint = function( selection ) {
if( this.smallStack.length > 0 ) {
this.bigStack.push( {
stack: this.smallStack,
selection: selection || this.selection.clone()
} );
this.smallStack = [];
this.emit ( 'history' );
}
};
ve.dm.Surface.prototype.undo = function() {
this.breakpoint();
this.undoIndex++;
if ( this.bigStack[this.bigStack.length - this.undoIndex] ) {
var diff = 0;
var item = this.bigStack[this.bigStack.length - this.undoIndex];
for( var i = item.stack.length - 1; i >= 0; i-- ) {
this.documentModel.rollback( item.stack[i] );
diff += item.stack[i].lengthDifference;
}
var selection = item.selection;
selection.end -= diff;
this.emit ( 'history' );
return selection;
}
return null;
};
ve.dm.Surface.prototype.redo = function() {
this.breakpoint();
if ( this.undoIndex > 0 ) {
if ( this.bigStack[this.bigStack.length - this.undoIndex] ) {
var diff = 0;
var item = this.bigStack[this.bigStack.length - this.undoIndex];
for( var i = 0; i < item.stack.length; i++ ) {
this.documentModel.commit( item.stack[i] );
diff += item.stack[i].lengthDifference;
}
var selection = item.selection;
selection.end += diff;
}
this.undoIndex--;
this.emit ( 'history' );
return selection;
}
return null;
};
/* Inheritance */
ve.extendClass( ve.dm.Surface, ve.EventEmitter );