pctb/pages.c

   1 /*
   2  * Interaction with the YPP client via X11
   3  */
   4 /*
   5  *  This is part of ypp-sc-tools, a set of third-party tools for assisting
   6  *  players of Yohoho Puzzle Pirates.
   7  *
   8  *  Copyright (C) 2009 Ian Jackson <ijackson@chiark.greenend.org.uk>
   9  *
  10  *  This program is free software: you can redistribute it and/or modify
  11  *  it under the terms of the GNU General Public License as published by
  12  *  the Free Software Foundation, either version 3 of the License, or
  13  *  (at your option) any later version.
  14  *
  15  *  This program is distributed in the hope that it will be useful,
  16  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  *  GNU General Public License for more details.
  19  *
  20  *  You should have received a copy of the GNU General Public License
  21  *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
  22  *
  23  *  Yohoho and Puzzle Pirates are probably trademarks of Three Rings and
  24  *  are used without permission.  This program is not endorsed or
  25  *  sponsored by Three Rings.
  26  */
  27
  28 /*
  29  * Only this file #includes the X11 headers, as they're quite
  30  * pollutant of the namespace.
  31  */
  32
  33 #include "structure.h"
  34
  35 #include <X11/Xlib.h>
  36 #include <X11/extensions/XTest.h>
  37 #include <X11/keysym.h>
  38 #include <X11/Xutil.h>
  39
  40 #include <X11/extensions/XShm.h>
  41 #include <sys/ipc.h>
  42 #include <sys/shm.h>
  43
  44 CanonImage *page_images[MAX_PAGES];
  45 int npages;
  46 RgbImage *page0_rgbimage;
  47
  48 const char *ocean, *pirate;
  49
  50 static XWindowAttributes attr;
  51 static Window id;
  52 static Display *disp;
  53 static struct timeval tv_startup;
  54 static unsigned wwidth, wheight;
  55 static int max_relevant_y= -1;
  56
  57 static XImage *shmim;
  58 static XShmSegmentInfo shminfo;
  59
  60 DEBUG_DEFINE_DEBUGF(pages)
  61
  62 #define xassert(what)                                   \
  63   ((what) ? (void)0 :                                   \
  64    fatal("X11 operation unexpectedly failed."           \
  65          " %s:%d: %s\n", __FILE__,__LINE__,#what))
  66
  67 static KeyCode keycode(KeySym sym) {
  68   return XKeysymToKeycode(disp,sym);
  69 }
  70
  71 void screenshot_startup(void) {
  72   progress("starting...");
  73   disp= XOpenDisplay(0);
  74   if (!disp) fatal("Unable to open X11 display.");
  75   sysassert(! gettimeofday(&tv_startup,0) );
  76 }
  77
  78 /*---------- pager ----------*/
  79
  80 typedef RgbImage Snapshot;
  81
  82 static double last_input;
  83 static const double min_update_allowance= 0.25;
  84
  85 static double timestamp(void) {
  86   struct timeval tv;
  87
  88   sysassert(! gettimeofday(&tv,0) );
  89   double t= (tv.tv_sec - tv_startup.tv_sec) +
  90             (tv.tv_usec - tv_startup.tv_usec) * 1e-6;
  91   debugf("PAGING %f\n",t);
  92   return t;
  93 }
  94 static void delay(double need_sleep) {
  95   debugf("PAGING     delay %f\n",need_sleep);
  96   sysassert(! usleep(need_sleep * 1e6) );
  97 }
  98
  99 static void sync_after_input(void) {
 100   xassert( XSync(disp, False) );
 101   last_input= timestamp();
 102 }
 103
 104 static void translate_coords_toroot(int wx, int wy, int *rx, int *ry) {
 105   Window dummy;
 106   xassert( XTranslateCoordinates(disp, id,attr.root, wx,wy, rx,ry, &dummy) );
 107 }
 108
 109 static void check_client_window_all_on_screen(void) {
 110   Rect onroot;
 111   unsigned rwidth, rheight;
 112   Window dummy;
 113   unsigned bd, depth;
 114   int rxpos, rypos;
 115
 116   xassert( XGetGeometry(disp,attr.root, &dummy, &rxpos,&rypos,
 117                         &rwidth, &rheight,
 118                         &bd,&depth) );
 119
 120   translate_coords_toroot(0,0, &onroot.tl.x,&onroot.tl.y);
 121   translate_coords_toroot(wwidth-1,wheight-1, &onroot.br.x,&onroot.br.y);
 122   if (!(onroot.tl.x >= 0 &&
 123         onroot.tl.y >= 0 &&
 124         onroot.br.x < rwidth &&
 125         onroot.br.y < rheight))
 126     fatal("YPP client window is not entirely on the screen.");
 127 }
 128
 129 static void check_not_disturbed(void) {
 130   XEvent ev;
 131   int r;
 132
 133   for (;;) {
 134     r= XCheckMaskEvent(disp, ~0, &ev);
 135     if (r==False) return;
 136
 137     switch (ev.type) {
 138     case VisibilityNotify:
 139       if (ev.xvisibility.state != VisibilityUnobscured)
 140         fatal("YPP client window has become obscured.");
 141       break;
 142     case ConfigureNotify:
 143       check_client_window_all_on_screen();
 144       break;
 145     case FocusOut:
 146       fatal("Focus left YPP client window.");
 147       break;
 148     case FocusIn:
 149       warning("focus entered YPP client window ?!");
 150       break;
 151     default:
 152       fatal("Received unexpected X11 event (type code %d)!", ev.type);
 153     }
 154   }
 155 }
 156
 157 static void send_key(KeySym sym) {
 158   check_not_disturbed();
 159   XTestFakeKeyEvent(disp, keycode(sym),1, 10);
 160   XTestFakeKeyEvent(disp, keycode(sym),0, 10);
 161 }
 162 static void mouse_1_updown_here(void) {
 163   check_not_disturbed();
 164   XTestFakeButtonEvent(disp,1,1, 50);
 165   XTestFakeButtonEvent(disp,1,0, 50);
 166 }
 167 static void mouse_1_updown(int x, int y) {
 168   check_not_disturbed();
 169   int screen= XScreenNumberOfScreen(attr.screen);
 170   int xpos, ypos;
 171   translate_coords_toroot(x,y, &xpos,&ypos);
 172   XTestFakeMotionEvent(disp, screen, xpos,ypos, 0);
 173   mouse_1_updown_here();
 174 }
 175
 176 static int pgupdown;
 177
 178 static void send_pgup_many(void) {
 179   int i;
 180   for (i=0; i<25; i++) {
 181     send_key(XK_Prior);
 182     pgupdown--;
 183   }
 184   debugf("PAGING   PageUp x %d\n",i);
 185   sync_after_input();
 186 }
 187 static void send_pgdown(void) {
 188   send_key(XK_Next);
 189   pgupdown++;
 190   debugf("PAGING   PageDown\n");
 191   sync_after_input();
 192 }
 193 static void send_pgdown_torestore(void) {
 194   debugf("PAGING   PageDown x %d\n", -pgupdown);
 195   while (pgupdown < 0) {
 196     send_key(XK_Next);
 197     pgupdown++;
 198   }
 199   sync_after_input();
 200 }
 201
 202 static void free_snapshot(Snapshot **io) {
 203   free(*io);
 204   *io= 0;
 205 }
 206
 207 #define SAMPLEMASK 0xfful
 208
 209 typedef struct {
 210   int lshift, rshift;
 211 } ShMask;
 212
 213 static void compute_shift_mask(ShMask *sm, unsigned long ximage_mask) {
 214   sm->lshift= 0;
 215   sm->rshift= 0;
 216
 217   for (;;) {
 218     if (ximage_mask <= (SAMPLEMASK>>1)) {
 219       sm->lshift++;  ximage_mask <<= 1;
 220     } else if (ximage_mask > SAMPLEMASK) {
 221       sm->rshift++;  ximage_mask >>= 1;
 222     } else {
 223       break;
 224     }
 225     assert(!(sm->lshift && sm->rshift));
 226   }
 227   assert(sm->lshift < LONG_BIT);
 228   assert(sm->rshift < LONG_BIT);
 229 }
 230
 231 static void rtimestamp(double *t, const char *wh) {
 232   double n= timestamp();
 233   debugf("PAGING                INTERVAL %f  %s\n", n-*t, wh);
 234   *t= n;
 235 }
 236
 237 static void snapshot(Snapshot **output) {
 238   XImage *im_use, *im_free=0;
 239
 240   ShMask shiftmasks[3];
 241
 242   debugf("PAGING   snapshot\n");
 243
 244   double begin= timestamp();
 245   if (shmim) {
 246     rtimestamp(&begin, "XShmGetImage before");
 247     xassert( XShmGetImage(disp,id,shmim, 0,0, AllPlanes) );
 248     rtimestamp(&begin, "XShmGetImage");
 249
 250     size_t dsz= shmim->bytes_per_line * shmim->height;
 251     im_use= im_free= mmalloc(sizeof(*im_use) + dsz);
 252     *im_free= *shmim;
 253     im_free->data= (void*)(im_free+1);
 254     memcpy(im_free->data, shmim->data, dsz);
 255     rtimestamp(&begin, "mmalloc/memcpy");
 256   } else {
 257     xassert( im_use= im_free=
 258              XGetImage(disp,id, 0,0, wwidth,wheight, AllPlanes, ZPixmap) );
 259     rtimestamp(&begin, "XGetImage");
 260   }
 261
 262 #define COMPUTE_SHIFT_MASK(ix, rgb) \
 263   compute_shift_mask(&shiftmasks[ix], im_use->rgb##_mask)
 264   COMPUTE_SHIFT_MASK(0, red);
 265   COMPUTE_SHIFT_MASK(1, green);
 266   COMPUTE_SHIFT_MASK(2, blue);
 267
 268   if (!*output)
 269     *output= alloc_rgb_image(wwidth, wheight);
 270
 271   rtimestamp(&begin, "compute_shift_masks+alloc_rgb_image");
 272
 273   int x,y,i;
 274   unsigned char *op= (*output)->data;
 275   for (y=0; y<wheight; y++) {
 276     for (x=0; x<wwidth; x++) {
 277       long xrgb= XGetPixel(im_use,x,y);
 278       for (i=0; i<3; i++) {
 279         unsigned long sample=
 280           ((xrgb << shiftmasks[i].lshift) >> shiftmasks[i].rshift)
 281           & SAMPLEMASK;
 282         *op++= sample;
 283       }
 284     }
 285   }
 286
 287   rtimestamp(&begin,"w*h*XGetPixel");
 288   if (im_free)
 289     XDestroyImage(im_free);
 290
 291   rtimestamp(&begin,"XDestroyImage");
 292   check_not_disturbed();
 293
 294   debugf("PAGING   snapshot done.\n");
 295 }
 296
 297 static int identical(const Snapshot *a, const Snapshot *b) {
 298   if (!(a->w == b->w &&
 299         a->h == b->h))
 300     return 0;
 301
 302   int compare_to= a->h;
 303   if (max_relevant_y && compare_to > max_relevant_y)
 304     compare_to= max_relevant_y;
 305
 306   return !memcmp(a->data, b->data, a->w * 3 * compare_to);
 307 }
 308
 309 static void wait_for_stability(Snapshot **output,
 310                                const Snapshot *previously,
 311                                void (*with_keypress)(void),
 312                                const char *fmt, ...)
 313      FMT(4,5);
 314
 315 static void wait_for_stability(Snapshot **output,
 316                                const Snapshot *previously,
 317                                void (*with_keypress)(void),
 318                                const char *fmt, ...) {
 319   va_list al;
 320   va_start(al,fmt);
 321
 322   Snapshot *last=0;
 323   /* waits longer if we're going to return an image identical to previously
 324    * if previously==0, all images are considered identical to it */
 325
 326   char *doing;
 327   sysassert( vasprintf(&doing,fmt,al) >=0 );
 328   progress("%s",doing);
 329
 330   debugf("PAGING  wait_for_stability"
 331           "  last_input=%f previously=%p `%s'\n",
 332           last_input, previously, doing);
 333
 334   for (;;) {
 335     double at_snapshot= timestamp();
 336     double need_sleep= min_update_allowance - (at_snapshot - last_input);
 337     if (need_sleep > 0) { delay(need_sleep); continue; }
 338
 339     snapshot(output);
 340
 341     if (!with_keypress &&
 342         !(previously && identical(*output,previously))) {
 343       debugf("PAGING  wait_for_stability  simple\n");
 344       break;
 345     }
 346
 347     if (last && identical(*output,last)) {
 348       debugf("PAGING  wait_for_stability  stabilised\n");
 349       break;
 350     }
 351
 352     progress_spinner("%s",doing);
 353
 354     debugf("PAGING  wait_for_stability  retry\n");
 355
 356     free_snapshot(&last); last=*output; *output=0;
 357
 358     if (with_keypress)
 359       with_keypress();
 360
 361     delay(0.5);
 362   }
 363
 364   free_snapshot(&last);
 365   free(doing);
 366   debugf("PAGING  wait_for_stability done.\n");
 367   va_end(al);
 368 }
 369
 370 static void raise_and_get_details(void) {
 371   int evbase,errbase,majver,minver;
 372   int wxpos, wypos;
 373   unsigned bd,depth;
 374
 375   progress("raising and checking YPP client window...");
 376
 377   debugf("PAGING raise_and_get_details\n");
 378
 379   int xtest= XTestQueryExtension(disp, &evbase,&errbase,&majver,&minver);
 380   if (!xtest) fatal("X server does not support the XTEST extension.");
 381
 382   xassert( XRaiseWindow(disp, id) );
 383   /* in case VisibilityNotify triggers right away before we have had a
 384    * change to raise; to avoid falsely detecting lowering in that case */
 385
 386   xassert( XSelectInput(disp, id,
 387                         StructureNotifyMask|
 388                         VisibilityChangeMask
 389                         ) );
 390
 391   xassert( XRaiseWindow(disp, id) );
 392   /* in case the window was lowered between our Raise and our SelectInput;
 393    * to avoid failing to detect that lowering */
 394
 395   xassert( XGetWindowAttributes(disp, id, &attr) );
 396   xassert( XGetGeometry(disp,id, &attr.root,
 397                         &wxpos,&wypos, &wwidth,&wheight,
 398                         &bd,&depth) );
 399
 400   if (!(wwidth >= 320 && wheight >= 320))
 401     fatal("YPP client window is implausibly small?");
 402
 403   check_client_window_all_on_screen();
 404
 405   int shm= XShmQueryExtension(disp);
 406   debugf("PAGING shm=%d\n",shm);
 407   if (shm) {
 408     xassert( shmim= XShmCreateImage(disp, attr.visual, attr.depth, ZPixmap,
 409                                     0,&shminfo, wwidth,wheight) );
 410
 411     sigset_t oldset, all;
 412     sigfillset(&all);
 413     sysassert(! sigprocmask(SIG_BLOCK,&all,&oldset) );
 414
 415     int pfd[2];
 416     pid_t cleaner;
 417     sysassert(! pipe(pfd) );
 418     sysassert( (cleaner= fork()) != -1 );
 419     if (!cleaner) {
 420       sysassert(! close(pfd[1]) );
 421       for (;;) {
 422         int r= read(pfd[0], &shminfo.shmid, sizeof(shminfo.shmid));
 423         if (!r) exit(0);
 424         if (r==sizeof(shminfo.shmid)) break;
 425         assert(r==-1 && errno==EINTR);
 426       }
 427       for (;;) {
 428         char bc;
 429         int r= read(pfd[0],&bc,1);
 430         if (r>=0) break;
 431         assert(r==-1 && errno==EINTR);
 432       }
 433       sysassert(! shmctl(shminfo.shmid,IPC_RMID,0) );
 434       exit(0);
 435     }
 436     sysassert(! close(pfd[0]) );
 437
 438     sysassert(! sigprocmask(SIG_SETMASK,&oldset,0) );
 439
 440     assert(shmim->height == wheight);
 441     sysassert( (shminfo.shmid=
 442                 shmget(IPC_PRIVATE, shmim->bytes_per_line * wheight,
 443                        IPC_CREAT|0600)) >= 0 );
 444
 445     sysassert( write(pfd[1],&shminfo.shmid,sizeof(shminfo.shmid)) ==
 446                sizeof(shminfo.shmid) );
 447     sysassert( shminfo.shmaddr= shmat(shminfo.shmid,0,0) );
 448     shmim->data= shminfo.shmaddr;
 449     shminfo.readOnly= False;
 450     xassert( XShmAttach(disp,&shminfo) );
 451
 452     close(pfd[1]); /* causes IPC_RMID */
 453   }
 454 }
 455
 456 static void set_focus_commodity(void) {
 457   int screen= XScreenNumberOfScreen(attr.screen);
 458
 459   progress("taking control of YPP client window...");
 460
 461   debugf("PAGING set_focus\n");
 462
 463   mouse_1_updown(160,160);
 464   sync_after_input();
 465
 466   delay(0.5);
 467   xassert( XSelectInput(disp, id,
 468                         StructureNotifyMask|
 469                         VisibilityChangeMask|
 470                         FocusChangeMask
 471                         ) );
 472
 473   int xpos,ypos;
 474   translate_coords_toroot(10,10, &xpos,&ypos);
 475   XTestFakeMotionEvent(disp,screen, xpos,ypos, 0);
 476
 477   sync_after_input();
 478
 479   debugf("PAGING raise_and_set_focus done.\n");
 480 }
 481
 482 static CanonImage *convert_page(Snapshot *sn, RgbImage *ri) {
 483   CanonImage *im;
 484
 485   fprintf(screenshot_file,
 486           "P6\n"
 487           "%d %d\n"
 488           "255\n", sn->w, sn->h);
 489
 490   CANONICALISE_IMAGE(im, sn->w, sn->h, {
 491     int i;
 492     rgb= 0;
 493     for (i=0; i<3; i++) {
 494       rgb <<= 8;
 495       unsigned long sample= RI_PIXEL(sn,x,y)[i];
 496       rgb |= sample;
 497       fputc(sample, screenshot_file);
 498     }
 499     if (ri)
 500       CANONIMG_ALSO_STORERGB(ri);
 501   });
 502
 503   sysassert(!ferror(screenshot_file));
 504   sysassert(!fflush(screenshot_file));
 505
 506   return im;
 507 }
 508
 509 static void prepare_ypp_client(void) {
 510   CanonImage *test;
 511   Snapshot *current=0;
 512
 513   /* find the window and check it's on the right kind of screen */
 514   raise_and_get_details();
 515   wait_for_stability(&current,0,0, "checking current YPP client screen...");
 516
 517   test= convert_page(current, 0);
 518   find_structure(test, &max_relevant_y);
 519   check_correct_commodities();
 520   Rect sunshine= find_sunshine_widget();
 521
 522   progress("poking client...");
 523   mouse_1_updown((sunshine.tl.x   + sunshine.br.x) / 2,
 524                  (sunshine.tl.y*9 + sunshine.br.y) / 10);
 525
 526   free(test);
 527
 528   wait_for_stability(&current,0,0, "checking basic YPP client screen...");
 529   mouse_1_updown(250, wheight-10);
 530   mouse_1_updown_here();
 531   mouse_1_updown_here();
 532   XSync(disp,False);
 533   check_not_disturbed();
 534   send_key(XK_slash);
 535   send_key(XK_w);
 536   send_key(XK_Return);
 537   sync_after_input();
 538
 539   Snapshot *status=0;
 540   wait_for_stability(&status,current,0, "awaiting status information...");
 541   free_snapshot(&current);
 542   free_snapshot(&status);
 543 }
 544
 545 void take_screenshots(void) {
 546   Snapshot *current=0, *last=0;
 547
 548   prepare_ypp_client();
 549
 550   /* page to the top - keep pressing page up until the image stops changing */
 551   set_focus_commodity();
 552   wait_for_stability(&current,0, send_pgup_many,
 553                      "paging up to top of commodity list...");
 554
 555   /* now to actually page down */
 556   for (;;) {
 557     debugf("paging page %d\n",npages);
 558
 559     if (!(npages < MAX_PAGES))
 560       fatal("Paging down seems to generate too many pages - max is %d.",
 561             MAX_PAGES);
 562
 563     page_images[npages]= convert_page(current, 0);
 564     free_snapshot(&last); last=current; current=0;
 565
 566     debugf("PAGING page %d converted\n",npages);
 567
 568     wait_for_stability(&current,last, 0,
 569                        "collecting screenshot of page %d...",
 570                        npages+1);
 571
 572     if (npages &&  /* first pagedown doesn't do much */
 573         identical(current,last)) {
 574       free_snapshot(&current);
 575       break;
 576     }
 577
 578     send_pgdown();
 579     npages++;
 580   }
 581   progress("finishing with the YPP client...");
 582   send_pgdown_torestore();
 583
 584   debugf("PAGING all done.\n");
 585   progress_log("collected %d screenshots.",npages);
 586 }
 587
 588 void take_one_screenshot(void) {
 589   Snapshot *current=0;
 590
 591   prepare_ypp_client();
 592   wait_for_stability(&current,0,0, "taking screenshot...");
 593   page0_rgbimage= alloc_rgb_image(current->w, current->h);
 594   page_images[0]= convert_page(current, page0_rgbimage);
 595   npages= 1;
 596   progress_log("collected single screenshot.");
 597 }
 598
 599 void set_yppclient_window(unsigned long wul) {
 600   id= wul;
 601 }
 602
 603 DEBUG_DEFINE_SOME_DEBUGF(findypp,debugfind)
 604
 605 void find_yppclient_window(void) {
 606   Window root, gotroot, gotparent;
 607   int screen;
 608   int nfound=0;
 609
 610   if (id) return;
 611
 612   progress("looking for YPP client window...");
 613
 614   static const char prefix[]= "Puzzle Pirates - ";
 615   static const char onthe[]= " on the ";
 616   static const char suffix[]= " ocean";
 617 #define S(x) (sizeof((x))-1)
 618
 619   Atom wm_name= XInternAtom(disp,"WM_NAME",True);
 620   xassert(wm_name != None);
 621
 622   for (screen=0; screen<ScreenCount(disp); screen++) {
 623     debugfind("FINDYPP screen %d\n", screen);
 624     root= RootWindow(disp,screen);
 625     unsigned int nchildren1;
 626     Window *children1=0;
 627
 628     xassert( XQueryTree(disp,root,
 629                   &gotroot,&gotparent,
 630                   &children1,&nchildren1) );
 631     debugfind("FINDYPP screen %d nchildren1=%d\n", screen, nchildren1);
 632
 633     int i;
 634     for (i=0; i<nchildren1; i++) {
 635       Window w1= children1[i];
 636       unsigned int nchildren2;
 637       Window *children2=0;
 638
 639       xassert( XQueryTree(disp,w1,
 640                           &gotroot,&gotparent,
 641                           &children2,&nchildren2) );
 642       debugfind("FINDYPP screen %d c1[%2d]=0x%08lx nchildren2=%d\n",
 643                 screen, i, (unsigned long)w1, nchildren2);
 644
 645       int j;
 646       for (j=-1; j<(int)nchildren2; j++) {
 647         Window w2= j<0 ? w1 : children2[j];
 648         debugfind("FINDYPP screen %d c1[%2d]=0x%08lx c2[%2d]=0x%08lx",
 649                   screen, i, (unsigned long)w1, j, (unsigned long)w2);
 650
 651         int gotfmt;
 652         Atom gottype;
 653         unsigned long len, gotbytesafter;
 654         char *title;
 655         unsigned char *gottitle=0;
 656         xassert( !XGetWindowProperty(disp,w2, wm_name,0,512, False,
 657                                      AnyPropertyType,&gottype, &gotfmt, &len,
 658                                      &gotbytesafter, &gottitle) );
 659         title= (char*)gottitle;
 660
 661         if (DEBUGP(findypp)) {
 662           debugfind(" gf=%d len=%lu gba=%lu \"", gotfmt,len,gotbytesafter);
 663           char *p;
 664           for (p=title; p < title+len; p++) {
 665             char c= *p;
 666             if (c>=' ' && c<=126) fputc(c,debug);
 667             else fprintf(debug,"\\x%02x",c & 0xff);
 668           }
 669           fputs("\": ",debug);
 670         }
 671
 672 #define REQUIRE(pred)                                                      \
 673         if (!(pred)) { debugfind(" failed test  %s\n", #pred); continue; } \
 674         else
 675
 676         REQUIRE( gottype!=None );
 677         REQUIRE( len );
 678         REQUIRE( gotfmt==8 );
 679
 680         REQUIRE( len >= S(prefix) + 1 + S(onthe) + 1 + S(suffix) );
 681
 682         char *spc1= strchr(  title        + S(prefix), ' ');  REQUIRE(spc1);
 683         char *spc2= strrchr((title + len) - S(suffix), ' ');  REQUIRE(spc2);
 684
 685         REQUIRE( (title + len) - spc1  >= S(onthe)  + S(suffix) );
 686         REQUIRE(  spc2         - title >= S(prefix) + S(onthe) );
 687
 688         REQUIRE( !memcmp(title,                   prefix, S(prefix)) );
 689         REQUIRE( !memcmp(title + len - S(suffix), suffix, S(suffix))  );
 690         REQUIRE( !memcmp(spc1,                    onthe,  S(onthe))  );
 691
 692 #define ASSIGN(what, start, end)                                \
 693         what= masprintf("%.*s", (end)-(start), start);          \
 694         if (o_##what) REQUIRE( !strcasecmp(o_##what, what) );   \
 695         else
 696
 697         ASSIGN(ocean,  spc1 + S(onthe),   (title + len) - S(suffix));
 698         ASSIGN(pirate, title + S(prefix),  spc1);
 699
 700         debugfind(" YES!\n");
 701         id= w2;
 702         nfound++;
 703         progress_log("found YPP client (0x%lx):"
 704                      " %s ocean - %s.",
 705                      (unsigned long)id, ocean, pirate);
 706       }
 707       if (children2) XFree(children2);
 708     }
 709     if (children1) XFree(children1);
 710   }
 711   if (nfound>1)
 712     fatal("Found several possible YPP clients.   Close one,\n"
 713           " disambiguate with --pirate or --ocean,"
 714           " or specify --window-id.\n");
 715   if (nfound<1)
 716     fatal("Did not find %sYPP client."
 717           " Use --window-id and/or report this as a fault.\n",
 718           o_ocean || o_pirate ? "matching ": "");
 719 }