PDF XChange Forum

Code: Select all

/** Script to synchronize two windows
  * Original script by benep and posted https://forum.pdf-xchange.com/viewtopic.php?p=167809#p167809
  *
  * v0.6.1 if changes don't stick, save that to the state, so it doesn't get pushed back
  * v0.6 2025-03-04 Update in preparation for rewrite to individually set zoom, pan, etc. Resolve drifting issue.
  * v0.5.1 2024-08-15 Use documentFileName for case where no docID was assigned, add question for sync cancel, fix some JSlint
  * v0.5 2024-08-15 Different alert if documents have same ID, checkbox option for vert split
  * v0.4 2024-04-18 Changed icon to 40x40, set cMarked while tool is active
  * v0.3 2024-04-09 applied menu item to show side by side
  * v0.2 2024-04-09 changed global to xutil, added trusted function for documents, added menu item
  *
  * @todo: add options, use globals and xutils for timeout
*/
var myIcon = {count:0, width:40, height:40, read:function(nBytes=this.data.length/2){return this.data.slice(this.count,this.count+=2*nBytes);}, data:(a=>{let[b,c]=a.split(":");c=c?.match(/.{8}/g);let d=(a,b)=>a.replace(/./g,a=>parseInt(a,10+b)-b);return b.replace(/([g-p]+)([0-9a-f]+|[q-z]+)/gi,(a,b,e)=>(/[q-z]/.test(e)?c[d(e,26)]:e).repeat(d(b,16)));})("pqiuhoqiuhnqhuirhuhmqhuirhuhlqhukrhuhkqhukrhuhjqhumrhuhiqhumrhuhhqhuirhvirhqirhuhgqhuirhqirhqirhupqhuiriqiriqirhuoqhuiriqiriqirhupqhrjqirjqhrhgqhrjqirjqhrhkqirhoqirpqhsxhrvnvirhthsyh80D3D3D3mqhsxhrvnvirhthsyhFFB0B0B0mqhrvovirhszhtqhtrmqhrvnvhrrirhszhtqhtrmqivnsirhtsixhttlqivnsirhtsixhttlqivnsirjxhrwlqivnsirjxhrwlqivishFFE7F1DDisrhtuhsirkxhtvkqivnsirkxhtvkqivishsrhFF9CC671htwhsshshrxhtxkxhryh40F1F1F1jqivnshrxhtxkxhrykqivishsrhtwhFF7CB342hsshshyhtylxhtzjqiviskwhshyhtylxhtzjqivishtuisshFFDFECD1hsirhuqkxhurhusiqivislwirhuqkxhurhusiqivnsirhshzhryjxhutiqivnsirhshzhryjxhutiqivnsiyishuuhuvhrzhxhuwh80D6D6D6hqivnsiyishuuhuvhrzhxhuwh40D6D6D6hqhvhrrislwirshwjshuxhrwhxhuyhqhvhrrislwirsiwhzhshuxhrwhxhuyhqhrrhtislwirhwhzhFFFCFCFChsthshsthuzhrzhqhrrhtislwirjwhzhshsthuzhrzhqitnsirlrtishFF7D7D7DhqitnsirnshthqitnshyhrxlrthruhshthqitnsiyhrumshthqitislwirslwhFFF8F8F8hshthqitislwhrshFFA1BFE6hshFFEED17DhFFECC34EhFFF2D688hFFFEFCF7ishthqitislwirlwishthqitislwirhFFF3F2EFhvqhsuhsqhvrishthqitmshruirjrtkshthqitnsirhvqhsuhsqhsvhswishthqitnsirxjrtkshthqitnshyhFFB4BCC5hsuhsqisvhswishthqitislwirslwishthqitiskwhzhFFBDD6F8hFFB6BFC8hsqjsvhvsishthqitislwirlwishthqitislwirhvriswhvshFFFEFDFAishthqitnsirkrthshruhshthqitlshruhsirnshthqitnsiynshthqitnsiynshthqhrqotivtothqhrqotivtothqhvuhrqntirnthrqh20D9D9D9hvuhrqntirnthFF858585hgqirhoqirhkqhrjqirjqhrhgqhrjqirjqhrpqhuiriqiriqirhuoqhuiriqiriqirhupqhuirhqirhqirhuhgqhuirhqirhqirhuhhqhumrhuhiqhumrhuhjqhukrhuhkqhukrhuhlqhuirhuhmqhuirhuhnqiuhoqiupq:00000000FF42A5F5FFFFFFFFFF8080808042A5F5FF9F9F9FFF9E9E9EFF616161FFC0D8FAFFD5D5D580898989FF909090FF7BA2D0FFFEFEFEFFFBFBFB80A3A3A3FF848484FFBFD7FAFF767676FF636363FFE8B629FFA4CA7CFF86B951FFFDFDFDFFEBC047FFE5AC0AFFE6B01740DBDBDBFF737373FF7C7C7CFF626262FF787878FF8F8F8F80D5D5D5FFE3EFD780C7C7C7FF8CBC5AFF578BC0FF779FCE80B8B8B8FF9B9B9BFF6B6B6B40EBEBEB80A7A7A7FFF9F9F9FFACACACFF656565FFE3E3E3FF7A7A7AFFBEBEBEFFEECE74FFF0CF74FFF0D075FF6794C640D9D9D9")};
app.addToolButton({
    cName: "syncDocs",
    oIcon: myIcon,
    cLabel: "Sync",
    cExec: 'xutil.scrollSync.toggleSyncState();',
    cTooltext: "Toggle syncronizing the view of two documents. Select tool again to cancel sync.",
    cEnable: "event.rc = (event.target != null)", // at least one document
    cMarked: "event.rc = xutil.scrollSync.isActive", // hilight tool button while the tool is running
    //nPos: -1
});

if ('undefined' === typeof xutil) {
	Object.defineProperty( globalThis, 'xutil', { value: {}, writable: false });
}


xutil.scrollSync = {
  //////////////////////////////
  //       SETTINGS
  //////////////////////////////
  interval: 50, // milliseconds to check for moved doc
  ckPan: true, // check panning (position)
  ckZoom: true, // check zoom
  ckRotation: true, // check page view rotation
  ckPage: true, // check page changes
  ckPageNo: false, // check page number
  //////////////////////////////
  //       SETTINGS
  //////////////////////////////
  
  //activeDocs: [],
  isActive: false,
  
  docs: [],
  //doc1: null,
  //doc2: null,
  doc1ID: '',
  doc2ID: '',
  
  states: [],
  //state1: '',
  //state2: '',
  timer: null,
  data:{stpv: true}, // default check box

  checkSync: function() {
    let cnt = 0;
    for (let d of this.activeDocs) {
      const docIDs = this.getID( d ); //.docID.join('');
      if (docIDs === this.doc1ID || docIDs === this.doc2ID) {
        cnt++;
      }
    }
    if (cnt < 2) {
      xutil.scrollSync.isActive = false;
      app.clearInterval(xutil.scrollSync.timer);
      app.alert('Synchronisation of views canceled because of missing document.',1);
    }
  },
  
  // added for case where docID has not been assigned by pdf creator
  // uses file name as proxy
  getID( doc ) {
    return doc.docID.join('') || doc.documentFileName;
  },
  
  // set up states to current values
  setStates() {
    const me = this;
    for (let i in me.docs) {
        me.states[i] = Object.assign({}, me.docs[i].viewState);
    }
  },

  doSync: function() {
	const me = xutil.scrollSync;
    me.checkSync();
    try {
      if (me.isActive) {
        const docs = me.docs; //['doc1','doc2'];
        const states = me.states; //['state1','state2'];
        
        let updateDoc;
        const precise = 3;
        const vsCheck = [];
        // check pan
        if (me.ckPan) {
            vsCheck.push( 'pageViewY', 'pageViewX');
        }
        // check zoom
        if (me.ckZoom) {
            vsCheck.push( 'pageViewZoom', 'pageViewZoomType'); // maybe remove zoomType
        }
        // check rotation
        if (me.ckRotation) {
            vsCheck.push( 'pageViewRotation');
        }
        // check page change
        if (me.ckPage) {
            vsCheck.push( 'pageViewPageNum', 'pageViewRow');
        }
        
        for (let i in docs) {
            // Properties of viewState (build 394):
            // pageViewLayoutMode, pageViewZoom, pageViewZoomType, pageViewRow, pageViewX, pageViewY, pageViewBX, pageViewBY, pageViewPageNum, pageViewRotation, ocgStates, overViewPos

            // check and update
            for (let p of vsCheck) {
                // this viewstate property value
                let vs = docs[i].viewState[p];
                // for page position, the comparison needs to be less precise
                let precision = ('pageViewY' === p || 'pageViewX' === p) ? 1 / docs[i].viewState.pageViewZoom : 0.001;
                
                let compare = Math.abs( vs - states[i][p] );
                if ( precision < compare ) {
                //console.println([p, compare, vs]);
                //console.println(p + ":" + states[i][p] + ' - ' + vs)
                //console.println(JSON.stringify(docs[i].viewState))
                    updateDoc = true;
                    // save page difference
                    const pgDiff = vs - states[i][p];
                    // update all document saved viewstates
                    for (let j in docs) {
                        // save state
                        let val = vs;
                        switch (p) {
                          // check page number
                          case 'pageViewPageNum':
                          case 'pageViewRow':
                            if (!me.ckPageNo && i !== j ) {
                                val = states[j][p] + pgDiff;
                            }
                            //console.println([i,j,vs,val,- states[i][p] + vs])
                            break;
                          case 'pageViewX':
                            states[j]['pageViewBX'] = docs[i].viewState['pageViewBX'];
                            break;
                          case 'pageViewY':
                            states[j]['pageViewBY'] = docs[i].viewState['pageViewBY'];
                            break;
                        }
                        
                        states[j][p] = val;

                    }
                }
            }
            // don't check the other document if this one was already changed
            if (updateDoc) {
            // update the document viewstates
                for (let j in docs) {
                    if ( i !== j) {
                        docs[j].viewState = states[j];
                        // the new viewState may not stick (ie view is out of page range)
                        // save back to states so that it doesn't push the changed document back at next interval
                        for (let p of vsCheck) {
                            // this viewstate property value
                            const precision = 3;
                            if (states[j][p].toPrecision(precision) !== docs[j].viewState[p].toPrecision(precision)) {
                                states[j][p] = docs[j].viewState[p]; 
                            }
                        }
                    }
                }
            
                break;
            }
            //const curState = JSON.stringify(me[docs[i]].viewState);
            //if (curState != me[states[i]]) {
            //  me[states[i]] = curState;
            //  me[docs[1-i]].viewState = JSON.parse(curState);
            //}
        }


      }
    } catch (err) {
      app.clearInterval(me.timer);
      me.isActive = false;
      console.println(JSON.stringify(err));
      app.alert('There was an unexpexted error! See JS-console for more information.');
    }
  },

  toggleSyncState: function() {
    const me = xutil.scrollSync;
    if (me.isActive) {
      if (4 === app.alert( {cMsg:'Cancel Synchronisation?', nIcon:2, nType:2} )) {
        me.isActive = false;
        app.clearInterval(me.timer);
        if (me.data?.stpv) app.execMenuItem('cmd.window.allDocsToOneTabGroup');
      }
      //app.alert('Synchronisation canceled.',3);
      return;
    }
    if (me.activeDocs.length < 2) {
      app.alert('There need to be at least two opened documents.',1);
    } else {
      const dialog = {
        docList: {},
        initialize: function(dlg) {
          const lst1 = {}, lst2 = {};
          this.docList = {};
          for (let i = 0; i < me.activeDocs.length; i++) {
            const doc = me.activeDocs[i];
            const key = (i+1) + ' - ' + (doc.documentFileName.length ? doc.documentFileName : 'New Document*');
            lst1[key] = (i === 0 ? 1 : -1) * (i+1);
            lst2[key] = (i === 1 ? 1 : -1) * (i+1);
            this.docList[key] = doc;
          }
          dlg.load({ lst1, lst2, stpv: me.data?.stpv });
        },
        commit: function(dlg) {
          me.data = dlg.store();
          const s1 = this.getSelectedEntry(me.data.lst1);
          const s2 = this.getSelectedEntry(me.data.lst2);
          //me.doc1 = this.docList[s1.key];
          //me.doc2 = this.docList[s2.key];
          me.docs = [ this.docList[s1.key], this.docList[s2.key]];
          me.doc1ID = this.getID( this.docList[s1.key] ); //.docID.join('');
          me.doc2ID = this.getID( this.docList[s2.key] ); //.docID.join('');
          me.isActive = true;
          me.docs.forEach( d => {d.bringToFront();});
		  //me.doc1.bringToFront();
		  //me.doc2.bringToFront();
 	      if (me.data.stpv) app.execMenuItem('cmd.window.activeDocToNewVertTabGroup');
          // set up current states
          me.setStates();
          me.timer = app.setInterval('xutil.scrollSync.doSync()', me.interval);
          // return 'ok'
        },
        validate: function(dlg) {
          const data = dlg.store();
          const s1 = this.getSelectedEntry(data.lst1);
          const s2 = this.getSelectedEntry(data.lst2);
          const id1 = this.getID( this.docList[s1.key] ); //.docID.join('');
          const id2 = this.getID( this.docList[s2.key] ); //.docID.join('');
          if (s1.val === s2.val) {
            app.alert('Choose different files.',1);
            return false;
          } else if (id1 !== '' && id1 === id2) { // some documents are created without docID
            console.println('The documents may be identical because the document IDs are the same.',3);
            //return false;
          }
          return true;
        },
        // added for case where docID has not been assigned by pdf creator
        // uses file name as proxy
        getID( doc ) {
          return doc.docID.join('') || doc.documentFileName;
        },
        getSelectedEntry: function(lst) {
            for (const key in lst) {
              if (Object.hasOwnProperty.call(lst, key)) {
                const val = +lst[key];
                if ( val >= 0) return {key, val};
              }
            }
        },
        description: { name: 'Sync views', align_children: 'align_left', elements: [
          { type: 'static_text', name: 'Choose which documents to sync:', bold: true },
          { type: 'cluster', name: 'Doc 1', align_children: 'align_left', elements: [
            { type: 'popup', item_id: 'lst1', width: 240 }
          ]},
          { type: 'cluster', name: 'Doc 2', align_children: 'align_left', elements: [
            { type: 'popup', item_id: 'lst2', width: 240 }
          ]},
          { type: 'cluster', name: 'Settings', align_children: 'align_left', elements: [
            { type: 'check_box', item_id: 'stpv', name: 'Open vertical split view' },
          ]},
          { type: 'ok_cancel', ok_name: 'sync' }
        ]}
      };


      if (app.execDialog(dialog) !== 'ok' && me.isActive) {
        me.isActive = false;
        app.clearInterval(me.timer);
        app.alert('Synchronisation canceled.',3);
      }

    }
  }

};
{
    // add priveliged function to get active docs with closure
    let aD = app.trustedFunction(() => {
      app.beginPriv();
      return app.activeDocs;
    });
    Object.defineProperty(xutil.scrollSync,'activeDocs', {
      get() {return aD();},
    });
}

Code: Select all

  //////////////////////////////
  //       SETTINGS
  //////////////////////////////
  interval: 50, // milliseconds to check for moved doc
  ckPan: true, // check panning (position)
  ckZoom: true, // check zoom
  ckRotation: true, // check page view rotation
  ckPage: true, // check page changes
  ckPageNo: false, // check page number