fuwafuwa
/
etherpad-lite
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

more docs

This commit is contained in:
Constantin Jucovschi 2012-02-26 11:34:06 +00:00
parent 3abdd34160
commit ac86535cdf
1 changed files with 36 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
static/js/Changeset.js
View File

@ -182,12 +182,21 @@ exports.opIterator = function (opsStr, optStartIndex) {
}; };
}; };
/**
* Cleans an Op object
* @param {Op} object to be cleared
*/
exports.clearOp = function (op) { exports.clearOp = function (op) {
op.opcode = ''; op.opcode = '';
op.chars = 0; op.chars = 0;
op.lines = 0; op.lines = 0;
op.attribs = ''; op.attribs = '';
}; };
/**
* Creates a new Op object
* @param optOpcode the type operation of the Op object
*/
exports.newOp = function (optOpcode) { exports.newOp = function (optOpcode) {
return { return {
opcode: (optOpcode || ''), opcode: (optOpcode || ''),
@ -196,6 +205,11 @@ exports.newOp = function (optOpcode) {
attribs: '' attribs: ''
}; };
}; };
/**
* Clones an Op
* @param op Op to be cloned
*/
exports.cloneOp = function (op) { exports.cloneOp = function (op) {
return { return {
opcode: op.opcode, opcode: op.opcode,
@ -204,12 +218,22 @@ exports.cloneOp = function (op) {
attribs: op.attribs attribs: op.attribs
}; };
}; };
/**
* Copies op1 to op2
* @param op1 src Op
* @param op2 dest Op
*/
exports.copyOp = function (op1, op2) { exports.copyOp = function (op1, op2) {
op2.opcode = op1.opcode; op2.opcode = op1.opcode;
op2.chars = op1.chars; op2.chars = op1.chars;
op2.lines = op1.lines; op2.lines = op1.lines;
op2.attribs = op1.attribs; op2.attribs = op1.attribs;
}; };
/**
* Writes the Op in a string the way that changesets need it
*/
exports.opString = function (op) { exports.opString = function (op) {
// just for debugging // just for debugging
if (!op.opcode) return 'null'; if (!op.opcode) return 'null';
@ -217,11 +241,19 @@ exports.opString = function (op) {
assem.append(op); assem.append(op);
return assem.toString(); return assem.toString();
}; };
/**
* Used just for debugging
*/
exports.stringOp = function (str) { exports.stringOp = function (str) {
// just for debugging // just for debugging
return exports.opIterator(str).next(); return exports.opIterator(str).next();
}; };
/**
* Used to check if a Changeset if valid
* @param cs {Changeset} Changeset to be checked
*/
exports.checkRep = function (cs) { exports.checkRep = function (cs) {
// doesn't check things that require access to attrib pool (e.g. attribute order) // doesn't check things that require access to attrib pool (e.g. attribute order)
// or original string (e.g. newline positions) // or original string (e.g. newline positions)
@ -271,6 +303,10 @@ exports.checkRep = function (cs) {
return cs; return cs;
} }
/**
* ==================== Changeset Functions =======================
*/
exports.smartOpAssembler = function () { exports.smartOpAssembler = function () {
// Like opAssembler but able to produce conforming exportss // Like opAssembler but able to produce conforming exportss
// from slightly looser input, at the cost of speed. // from slightly looser input, at the cost of speed.