/**
diff-related JS APIs for fossil.
*/
"use strict";
/* Locate the UI element (if any) into which we can inject some diff-related
UI controls. */
window.fossil.onPageLoad(function(){
const potentialParents = window.fossil.page.diffControlContainers = [
/* CSS selectors for possible parents for injected diff-related UI
controls. */
/* Put the most likely pages at the end, as array.pop() is more
efficient than array.shift() (see loop below). */
/* /filedit */ 'body.cpage-fileedit #fileedit-tab-diff-buttons',
/* /wikiedit */ 'body.cpage-wikiedit #wikiedit-tab-diff-buttons',
/* /fdiff */ 'body.fdiff form div.submenu',
/* /vdiff */ 'body.vdiff form div.submenu',
/* /info, /vinfo, /ckout */ 'body.vinfo div.sectionmenu.info-changes-menu'
];
window.fossil.page.diffControlContainer = undefined;
while( potentialParents.length ){
if( (window.fossil.page.diffControlContainer
= document.querySelector(potentialParents.pop())) ){
break;
}
}
});
window.fossil.onPageLoad(function(){
/**
Adds toggle checkboxes to each file entry in the diff views for
/info and similar pages.
*/
const D = window.fossil.dom;
const allToggles = [/*collection of all diff-toggle checkboxes */];
const addToggle = function(diffElem){
const sib = diffElem.previousElementSibling,
ckbox = sib ? D.addClass(D.checkbox(true), 'diff-toggle') : 0;
if(!sib) return;
const lblToggle = D.label();
D.append(lblToggle, ckbox, D.text(" show/hide "));
const wrapper = D.append(D.span(), lblToggle);
allToggles.push(ckbox);
D.append(sib, D.append(wrapper, lblToggle));
ckbox.addEventListener('change', function(){
diffElem.classList[this.checked ? 'remove' : 'add']('hidden');
}, false);
};
if( !document.querySelector('body.fdiff') ){
/* Don't show the diff toggle button for /fdiff because it only
has a single file to show (and also a different DOM layout). */
document.querySelectorAll('table.diff').forEach(addToggle);
}
const icm = allToggles.length>1 ? window.fossil.page.diffControlContainer : 0;
if(icm) {
const btnAll = D.addClass(D.a("#", "Toggle all diffs"), "button");
D.append( icm, btnAll );
btnAll.addEventListener('click', function(ev){
ev.preventDefault();
ev.stopPropagation();
/* Figure out whether we want to show all or hide all: if any diffs are
toggled off, show all, else hide all. */
let show = false;
let ckbox;
for( ckbox of allToggles ){
if( !ckbox.checked ){
show = true;
break;
}
}
for( ckbox of allToggles ){
/* Toggle all entries to match this new state. We use click()
instead of ckbox.checked=... so that the on-change event handler
fires. */
if(ckbox.checked!==show) ckbox.click();
}
}, false);
}
});
window.fossil.onPageLoad(function(){
const F = window.fossil, D = F.dom;
const Diff = F.diff = {
e:{/*certain cached DOM elements*/},
config: {
chunkLoadLines: (
F.config.diffContextLines * 3
/*per /chat discussion*/
) || 20,
chunkFetch: {
/* Default callack handlers for Diff.fetchArtifactChunk(),
unless overridden by options passeed to that function. */
beforesend: function(){},
aftersend: function(){},
onerror: function(e){
console.error("XHR error: ",e);
}
}
}
};
/**
Uses the /jchunk AJAX route to fetch specific lines of a given
artifact. The argument must be an Object suitable for passing as
the second argument to fossil.fetch(). Its urlParams property
must be an object with these properties:
{
name: full hash of the target file,
from: first 1-based line number of the file to fetch (inclusive),
to: last 1-based line number of the file to fetch (inclusive)
}
The fetchOpt object is NOT cloned for use by the call: it is used
as-is and may be modified by this call. Thus callers "really
should" pass a temporary object, not a long-lived one.
If fetchOpt does not define any of the (beforesend, aftersend,
onerror) callbacks, the defaults from fossil.diff.config.chunkFetch
are used, so any given client page may override those to provide
page-level default handling.
Note that onload callback is ostensibly optional but this
function is not of much use without an onload
handler. Conversely, the default onerror handler is often
customized on a per-page basis to send the error output somewhere
where the user can see it.
The response, on success, will be an array of strings, each entry
being one line from the requested artifact. If the 'to' line is
greater than the length of the file, the array will be shorter
than (to-from) lines.
The /jchunk route reports errors via JSON objects with
an "error" string property describing the problem.
This is an async operation. Returns the fossil object.
*/
Diff.fetchArtifactChunk = function(fetchOpt){
if(!fetchOpt.beforesend) fetchOpt.beforesend = Diff.config.chunkFetch.beforesend;
if(!fetchOpt.aftersend) fetchOpt.aftersend = Diff.config.chunkFetch.aftersend;
if(!fetchOpt.onerror) fetchOpt.onerror = Diff.config.chunkFetch.onerror;
fetchOpt.responseType = 'json';
return F.fetch('jchunk', fetchOpt);
};
/**
Extracts either the starting or ending line number from a
line-numer column in the given tr. isSplit must be true if tr
represents a split diff, else false. Expects its tr to be valid:
GIGO applies. Returns the starting line number if getStart, else
the ending line number. Returns the line number from the LHS file
if getLHS is true, else the RHS.
*/
const extractLineNo = function f(getLHS, getStart, tr, isSplit){
var n = getLHS ? 0 : isSplit ? 3 : 1;
return parseInt(tr.childNodes[n].innerText);
};
/**
Installs chunk-loading controls into TR.diffskip element tr.
Each instance corresponds to a single TR.diffskip element.
The goal is to base these controls roughly on github's, a good
example of which, for use as a model, is:
https://github.com/msteveb/autosetup/commit/235925e914a52a542
*/
const ChunkLoadControls = function(tr){
this.$fetchQueue = [];
this.e = {/*DOM elements*/
tr: tr,
table: tr.parentElement/*TBODY*/.parentElement
};
this.isSplit = this.e.table.classList.contains('splitdiff')/*else udiff*/;
this.fileHash = this.e.table.dataset.lefthash;
tr.$chunker = this /* keep GC from reaping this */;
this.pos = {
/* These line numbers correspond to the LHS file. Because the
contents are common to both sides, we have the same number
for the RHS, but need to extract those line numbers from the
neighboring TR blocks */
startLhs: +tr.dataset.startln,
endLhs: +tr.dataset.endln
};
D.clearElement(tr);
this.e.td = D.addClass(
/* Holder for our UI controls */
D.attr(D.td(tr), 'colspan', this.isSplit ? 6 : 4),
'chunkctrl'
);
this.e.msgWidget = D.addClass(D.span(), 'hidden');
this.e.btnWrapper = D.div();
D.append(this.e.td, this.e.btnWrapper);
/**
Depending on various factors, we need one or more of:
- A single button to load the initial chunk incrementally
- A single button to load all lines then remove this control
- Two buttons: one to load upwards, one to load downwards
- A single button to load the final chunk incrementally
*/
if(tr.nextElementSibling){
this.pos.next = {
startLhs: extractLineNo(true, true, tr.nextElementSibling, this.isSplit),
startRhs: extractLineNo(false, true, tr.nextElementSibling, this.isSplit)
};
}
if(tr.previousElementSibling){
this.pos.prev = {
endLhs: extractLineNo(true, false, tr.previousElementSibling, this.isSplit),
endRhs: extractLineNo(false, false, tr.previousElementSibling, this.isSplit)
};
}
let btnUp = false, btnDown = false;
/**
this.pos.next refers to the line numbers in the next TR's chunk.
this.pos.prev refers to the line numbers in the previous TR's chunk.
this.pos corresponds to the line numbers of the gap.
*/
if(this.pos.prev && this.pos.next
&& ((this.pos.endLhs - this.pos.startLhs)
<= Diff.config.chunkLoadLines)){
/* Place a single button to load the whole block, rather
than separate up/down buttons. */
btnDown = false;
btnUp = this.createButton(this.FetchType.FillGap);
}else{
/* Figure out which chunk-load buttons to add... */
if(this.pos.prev){
btnDown = this.createButton(this.FetchType.PrevDown);
}
if(this.pos.next){
btnUp = this.createButton(this.FetchType.NextUp);
}
}
//this.e.btnUp = btnUp;
//this.e.btnDown = btnDown;
if(btnUp) D.append(this.e.btnWrapper, btnUp);
if(btnDown) D.append(this.e.btnWrapper, btnDown);
D.append(this.e.btnWrapper, this.e.msgWidget);
/* For debugging only... */
this.e.posState = D.span();
D.append(this.e.btnWrapper, this.e.posState);
this.updatePosDebug();
};
ChunkLoadControls.prototype = {
/** An "enum" of values describing the types of context
fetches/operations performed by this type. The values in this
object must not be changed without modifying all logic which
relies on their relative order. */
FetchType:{
/** Append context to the bottom of the previous diff chunk. */
PrevDown: 1,
/** Fill a complete gap between the previous/next diff chunks
or at the start of the next chunk or end of the previous
chunks. */
FillGap: 0,
/** Prepend context to the start of the next diff chunk. */
NextUp: -1,
/** Process the next queued action. */
ProcessQueue: 0x7fffffff
},
/**
Creates and returns a button element for fetching a chunk in
the given fetchType (as documented for fetchChunk()).
*/
createButton: function(fetchType){
let b;
switch(fetchType){
case this.FetchType.PrevDown:
b = D.append(
D.addClass(D.span(), 'down'),
D.span(/*glyph holder*/)
);
break;
case this.FetchType.FillGap:
b = D.append(
D.addClass(D.span(), 'up', 'down'),
D.span(/*glyph holder*/)
);
break;
case this.FetchType.NextUp:
b = D.append(
D.addClass(D.span(), 'up'),
D.span(/*glyph holder*/)
);
break;
default:
throw new Error("Internal API misuse: unexpected fetchType value "+fetchType);
}
D.addClass(b, 'jcbutton');
b.addEventListener('click', ()=>this.fetchChunk(fetchType),false);
return b;
},
updatePosDebug: function(){
if(this.e.posState){
D.clearElement(this.e.posState);
//D.append(D.clearElement(this.e.posState), JSON.stringify(this.pos));
}
return this;
},
/* Attempt to clean up resources and remove some circular references to
that GC can do the right thing. */
destroy: function(){
delete this.$fetchQueue;
D.remove(this.e.tr);
delete this.e.tr.$chunker;
delete this.e.tr;
delete this.e;
delete this.pos;
},
/**
If the gap between this.pos.endLhs/startLhs is less than or equal to
Diff.config.chunkLoadLines then this function replaces any up/down buttons
with a gap-filler button, else it's a no-op. Returns this object.
As a special case, do not apply this at the start or bottom
of the diff, only between two diff chunks.
*/
maybeReplaceButtons: function(){
if(this.pos.next && this.pos.prev
&& (this.pos.endLhs - this.pos.startLhs <= Diff.config.chunkLoadLines)){
D.clearElement(this.e.btnWrapper);
D.append(this.e.btnWrapper, this.createButton(this.FetchType.FillGap));
if( this.$fetchQueue && this.$fetchQueue.length>1 ){
this.$fetchQueue[1] = this.FetchType.FillGap;
this.$fetchQueue.length = 2;
}
}
return this;
},
/**
Callack for /jchunk responses.
*/
injectResponse: function f(fetchType/*as for fetchChunk()*/,
urlParam/*from fetchChunk()*/,
lines/*response lines*/){
if(!lines.length){
/* No more data to load */
this.destroy();
return this;
}
this.msg(false);
var startLnR = -2147483648; /* ⚠ */
switch( fetchType ){
case this.FetchType.PrevDown:
startLnR = this.pos.prev.endRhs + 1;
break;
case this.FetchType.NextUp:
startLnR = this.pos.next.startRhs - lines.length;
break;
case this.FetchType.FillGap:
startLnR = this.pos.prev ?
this.pos.prev.endRhs + 1 :
this.pos.next.startRhs - lines.length;
break;
}
const lnTo = Math.min(urlParam.to,
urlParam.from +
lines.length - 1/*b/c request range is inclusive*/);
function createDiffCommonLine(isSplit,lnl,lnr,txt){
var tr, td;
tr = document.createElement('tr');
tr.className = 'diffline';
td = document.createElement('td');
td.className = 'diffln difflnl';
td.appendChild(document.createTextNode(lnl));
tr.appendChild(td);
if( isSplit ){
td = document.createElement('td');
td.className = 'diffsep';
tr.appendChild(td);
td = document.createElement('td');
td.className = 'difftxt difftxtl';
td.appendChild(document.createTextNode(txt));
tr.appendChild(td);
}
td = document.createElement('td');
td.className = 'diffln difflnlr';
td.appendChild(document.createTextNode(lnr));
tr.appendChild(td);
td = document.createElement('td');
td.className = 'diffsep';
tr.appendChild(td);
td = document.createElement('td');
td.className = 'difftxt difftxt' + ( isSplit ? 'r' : 'u' );
td.appendChild(document.createTextNode(txt));
tr.appendChild(td);
return tr;
}
if( fetchType==this.FetchType.NextUp ){
for( i=lnTo; i>=urlParam.from; i-- ){
var tr =
createDiffCommonLine(
this.isSplit,i,startLnR+i-urlParam.from,lines[i-urlParam.from]);
this.e.tr.parentElement.insertBefore(tr,this.e.tr.nextElementSibling);
}
}else{
for( i=urlParam.from; i<=lnTo; i++ ){
var tr =
createDiffCommonLine(
this.isSplit,i,startLnR+i-urlParam.from,lines[i-urlParam.from]);
this.e.tr.parentElement.insertBefore(tr,this.e.tr);
}
}
if(this.FetchType.FillGap===fetchType){
this.destroy();
return this;
}else if(this.FetchType.PrevDown===fetchType){
this.pos.startLhs += lines.length;
this.pos.prev.endRhs += lines.length;
this.pos.prev.endLhs += lines.length;
if(lines.length < (urlParam.to - urlParam.from)){
/* No more data. */
this.destroy();
}else{
this.maybeReplaceButtons();
this.updatePosDebug();
}
return this;
}else if(this.FetchType.NextUp===fetchType){
this.pos.endLhs -= lines.length;
this.pos.next.startRhs -= lines.length;
this.pos.next.startLhs -= lines.length;
if(this.pos.endLhs<1
|| lines.length < (urlParam.to - urlParam.from)){
/* No more data. */
this.destroy();
}else{
this.maybeReplaceButtons();
this.updatePosDebug();
}
return this;
}else{
throw new Error("Unexpected 'fetchType' value.");
}
},
/**
Sets this widget's message to the given text. If the message
represents an error, the first argument must be truthy, else it
must be falsy. Returns this object.
*/
msg: function(isError,txt){
if(txt){
if(isError) D.addClass(this.e.msgWidget, 'error');
else D.removeClass(this.e.msgWidget, 'error');
D.append(
D.removeClass(D.clearElement(this.e.msgWidget), 'hidden'),
txt);
}else{
D.addClass(D.clearElement(this.e.msgWidget), 'hidden');
}
return this;
},
/**
Fetches and inserts a line chunk. fetchType is:
this.FetchType.NextUp = upwards from next chunk (this.pos.next)
this.FetchType.FillGap = the whole gap between this.pos.prev
and this.pos.next, or the whole gap before/after the
initial/final chunk in the diff.
this.FetchType.PrevDown = downwards from the previous chunk
(this.pos.prev)
Those values are set at the time this object is initialized but
one instance of this class may have 2 buttons, one each for
fetchTypes NextUp and PrevDown.
This is an async operation. While it is in transit, any calls
to this function will have no effect except (possibly) to emit
a warning. Returns this object.
*/
fetchChunk: function(fetchType){
if( !this.$fetchQueue ) return this; // HACKHACK: are we destroyed?
if( fetchType==this.FetchType.ProcessQueue ){
this.$fetchQueue.shift();
if( this.$fetchQueue.length==0 ) return this;
//console.log('fetchChunk: processing queue ...');
}
else{
this.$fetchQueue.push(fetchType);
if( this.$fetchQueue.length!=1 ) return this;
//console.log('fetchChunk: processing user input ...');
}
fetchType = this.$fetchQueue[0];
if( fetchType==this.FetchType.ProcessQueue ){
/* Unexpected! Clear queue so recovery (manual restart) is possible. */
this.$fetchQueue.length = 0;
return this;
}
/* Forewarning, this is a bit confusing: when fetching the
previous lines, we're doing so on behalf of the *next* diff
chunk (this.pos.next), and vice versa. */
if(fetchType===this.FetchType.NextUp && !this.pos.next
|| fetchType===this.FetchType.PrevDown && !this.pos.prev){
console.error("Attempt to fetch diff lines but don't have any.");
return this;
}
this.msg(false,"Fetching diff chunk...");
const self = this;
const fOpt = {
urlParams:{
name: this.fileHash, from: 0, to: 0
},
aftersend: ()=>this.msg(false),
onload: function(list){
self.injectResponse(fetchType,up,list);
if( !self.$fetchQueue || self.$fetchQueue.length==0 ) return;
/* Keep queue length > 0, or clicks stalled during (unusually lengthy)
injectResponse() may sneak in as soon as setTimeout() allows, find
an empty queue, and therefore start over with queue processing. */
self.$fetchQueue[0] = self.FetchType.ProcessQueue;
setTimeout(self.fetchChunk.bind(self,self.FetchType.ProcessQueue));
}
};
const up = fOpt.urlParams;
if(fetchType===this.FetchType.FillGap){
/* Easiest case: filling a whole gap. */
up.from = this.pos.startLhs;
up.to = this.pos.endLhs;
}else if(this.FetchType.PrevDown===fetchType){
/* Append to previous TR. */
if(!this.pos.prev){
console.error("Attempt to fetch next diff lines but don't have any.");
return this;
}
up.from = this.pos.prev.endLhs + 1;
up.to = up.from +
Diff.config.chunkLoadLines - 1/*b/c request range is inclusive*/;
if( this.pos.next && this.pos.next.startLhs <= up.to ){
up.to = this.pos.next.startLhs - 1;
fetchType = this.FetchType.FillGap;
}
}else{
/* Prepend to next TR */
if(!this.pos.next){
console.error("Attempt to fetch previous diff lines but don't have any.");
return this;
}
up.to = this.pos.next.startLhs - 1;
up.from = Math.max(1, up.to - Diff.config.chunkLoadLines + 1);
if( this.pos.prev && this.pos.prev.endLhs >= up.from ){
up.from = this.pos.prev.endLhs + 1;
fetchType = this.FetchType.FillGap;
}
}
//console.debug("fetchChunk(",fetchType,")",up);
fOpt.onerror = function(err){
if(self.e/*guard against a late-stage onerror() call*/){
self.msg(true,err.message);
self.$fetchQueue.length = 0;
}else{
Diff.config.chunkFetch.onerror.call(this,err);
}
};
Diff.fetchArtifactChunk(fOpt);
return this;
}
};
/**
Adds context-loading buttons to one or more tables. The argument
may be a forEach-capable list of diff table elements, a query
selector string matching 0 or more diff tables, or falsy, in
which case all relevant diff tables are set up. It tags each
table it processes to that it will not be processed multiple
times by subsequent calls to this function.
Note that this only works for diffs which have been marked up
with certain state, namely table.dataset.lefthash and TR
entries which hold state related to browsing context.
*/
Diff.setupDiffContextLoad = function(tables){
if('string'===typeof tables){
tables = document.querySelectorAll(tables);
}else if(!tables){
tables = document.querySelectorAll('table.diff[data-lefthash]:not(.diffskipped)');
}
/* Potential performance-related TODO: instead of installing all
of these at once, install them as the corresponding TR is
scrolled into view. */
tables.forEach(function(table){
if(table.classList.contains('diffskipped') || !table.dataset.lefthash) return;
D.addClass(table, 'diffskipped'/*avoid processing these more than once */);
table.querySelectorAll('tr.diffskip[data-startln]').forEach(function(tr){
new ChunkLoadControls(D.addClass(tr, 'jchunk'));
});
});
return F;
};
Diff.setupDiffContextLoad();
});
/* Click-handler for side-by-side diffs to activate text selection for the most
** recently clicked side (left or right). If the click-handler target is one of
** the simple-nested <del> or <ins> elements, the parent <td> is deciding. Note
** the "pointerdown" event seems to be exactly what is desired here: activating
** the clicked side just before the selection operation starts. */
(function(){
window.addEventListener('load',function(){
var s = document.getElementsByClassName('splitdiff');
for( var i=0; i<s.length; i++ ){
s[i].addEventListener('pointerdown',splitdiff_click);
}
});
function splitdiff_click(e){
var n = e.target.nodeName,
t = n=='DEL' || n=='INS' ? e.target.parentElement : e.target;
if( /\bdifftxtl\b/.test(t.className) ){
var s = document.getElementsByClassName('splitdiff');
for( var i=0; i<s.length; i++ ){
s[i].classList.remove('select_right');
s[i].classList.add('select_left');
}
}else if( /\bdifftxtr\b/.test(t.className) ){
var s = document.getElementsByClassName('splitdiff');
for( var i=0; i<s.length; i++ ){
s[i].classList.remove('select_left');
s[i].classList.add('select_right');
}
}
}
}());