chiark / gitweb /
Show contents of OK message from yarrg upload server
[ypp-sc-tools.db-test.git] / yarrg / 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 const char *ocean, *pirate;
45
46 static XWindowAttributes attr;
47 static Window id;
48 static Display *disp;
49 static struct timeval tv_startup;
50 static unsigned wwidth, wheight;
51 static int max_relevant_y= -1;
52 static Point commod_focus_point, commod_page_point, commod_focuslast_point;
53
54 static XImage *shmim;
55 static XShmSegmentInfo shminfo;
56
57 DEBUG_DEFINE_DEBUGF(pages)
58
59 #define xassert(what)                                   \
60   ((what) ? (void)0 :                                   \
61    fatal("X11 operation unexpectedly failed."           \
62          " %s:%d: %s\n", __FILE__,__LINE__,#what))
63
64 static KeyCode keycode(KeySym sym) {
65   return XKeysymToKeycode(disp,sym);
66 }
67
68 void screenshot_startup(void) {
69   progress("starting...");
70   disp= XOpenDisplay(0);
71   if (!disp) fatal("Unable to open X11 display.");
72   sysassert(! gettimeofday(&tv_startup,0) );
73 }
74
75 /*---------- pager ----------*/
76
77 typedef RgbImage Snapshot;
78
79 static double last_input;
80 static const double min_update_allowance= 0.25;
81
82 static double timestamp(void) {
83   struct timeval tv;
84   
85   sysassert(! gettimeofday(&tv,0) );
86   double t= (tv.tv_sec - tv_startup.tv_sec) +
87             (tv.tv_usec - tv_startup.tv_usec) * 1e-6;
88   debugf("PAGING %f\n",t);
89   return t;
90 }
91 static void delay(double need_sleep) {
92   debugf("PAGING     delay %f\n",need_sleep);
93   sysassert(! usleep(need_sleep * 1e6) );
94 }
95
96 static void sync_after_input(void) {
97   xassert( XSync(disp, False) );
98   last_input= timestamp();
99 }
100
101 static void translate_coords_toroot(int wx, int wy, int *rx, int *ry) {
102   Window dummy;
103   xassert( XTranslateCoordinates(disp, id,attr.root, wx,wy, rx,ry, &dummy) );
104 }
105 static void translate_coords_toroot_p(Point w, int *rx, int *ry) {
106   translate_coords_toroot(w.x, w.y, rx, ry);
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, 10);
165   XTestFakeButtonEvent(disp,1,0, 10);
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 static void pgdown_by_mouse(void) {
176   check_not_disturbed();
177   debugf("PAGING   Mouse\n");
178   mouse_1_updown_here();
179   sync_after_input();
180 }
181
182 static int pgupdown;
183
184 static void send_pgup_many(void) {
185   int i;
186   for (i=0; i<25; i++) {
187     send_key(XK_Prior);
188     pgupdown--;
189   }
190   debugf("PAGING   PageUp x %d\n",i);
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   debugf("SHIFTMASK %p={.lshift=%d, .rshift=%d} image_mask=%lx\n",
230          sm, sm->lshift, sm->rshift, ximage_mask);
231 }
232
233 static void rtimestamp(double *t, const char *wh) {
234   double n= timestamp();
235   debugf("PAGING                INTERVAL %f  %s\n", n-*t, wh);
236   *t= n;
237 }
238
239 static void snapshot(Snapshot **output) {
240   XImage *im_use, *im_free=0;
241
242   ShMask shiftmasks[3];
243
244   debugf("PAGING   snapshot\n");
245
246   double begin= timestamp();
247   if (shmim) {
248     rtimestamp(&begin, "XShmGetImage before");
249     xassert( XShmGetImage(disp,id,shmim, 0,0, AllPlanes) );
250     rtimestamp(&begin, "XShmGetImage");
251
252     size_t dsz= shmim->bytes_per_line * shmim->height;
253     im_use= im_free= mmalloc(sizeof(*im_use) + dsz);
254     *im_free= *shmim;
255     im_free->data= (void*)(im_free+1);
256     memcpy(im_free->data, shmim->data, dsz);
257     rtimestamp(&begin, "mmalloc/memcpy");
258   } else {
259     rtimestamp(&begin, "XGetImage before");
260     xassert( im_use= im_free=
261              XGetImage(disp,id, 0,0, wwidth,wheight, AllPlanes, ZPixmap) );
262     rtimestamp(&begin, "XGetImage");
263   }
264
265 #define COMPUTE_SHIFT_MASK(ix, rgb) \
266   compute_shift_mask(&shiftmasks[ix], im_use->rgb##_mask)
267   COMPUTE_SHIFT_MASK(0, blue);
268   COMPUTE_SHIFT_MASK(1, green);
269   COMPUTE_SHIFT_MASK(2, red);
270   
271   if (!*output)
272     *output= alloc_rgb_image(wwidth, wheight);
273
274   rtimestamp(&begin, "compute_shift_masks+alloc_rgb_image");
275
276   int x,y,i;
277   uint32_t *op32= (*output)->data;
278   for (y=0; y<wheight; y++) {
279     if (im_use->xoffset == 0 &&
280         im_use->format == ZPixmap &&
281         im_use->byte_order == LSBFirst &&
282         im_use->depth == 24 &&
283         im_use->bits_per_pixel == 32 &&
284         im_use->red_mask   == 0x0000ffU &&
285         im_use->green_mask == 0x00ff00U &&
286         im_use->blue_mask  == 0xff0000U) {
287       const char *p= im_use->data + y * im_use->bytes_per_line;
288 //      debugf("optimised copy y=%d",y);
289       memcpy(op32, p, wwidth*sizeof(*op32));
290       op32 += wwidth;
291     } else {
292       for (x=0; x<wwidth; x++) {
293         long xrgb= XGetPixel(im_use,x,y);
294         Rgb sample= 0;
295         for (i=0; i<3; i++) {
296           sample <<= 8;
297           sample |=
298             ((xrgb << shiftmasks[i].lshift) >> shiftmasks[i].rshift)
299             & SAMPLEMASK;
300         }
301         *op32++= sample;
302       }
303     }
304   }
305
306   rtimestamp(&begin,"w*h*XGetPixel");
307   if (im_free)
308     XDestroyImage(im_free);
309   
310   rtimestamp(&begin,"XDestroyImage");
311   check_not_disturbed();
312
313   debugf("PAGING   snapshot done.\n");
314 }
315
316 static int identical(const Snapshot *a, const Snapshot *b) {
317   if (!(a->w == b->w &&
318         a->h == b->h))
319     return 0;
320
321   int compare_to= a->h;
322   if (max_relevant_y>=0 && compare_to > max_relevant_y)
323     compare_to= max_relevant_y;
324   
325   return !memcmp(a->data, b->data, a->w * 3 * compare_to);
326 }
327
328 static void wait_for_stability(Snapshot **output,
329                                const Snapshot *previously,
330                                void (*with_keypress)(void),
331                                const char *fmt, ...)
332      FMT(4,5);
333
334 static void wait_for_stability(Snapshot **output,
335                                const Snapshot *previously,
336                                void (*with_keypress)(void),
337                                const char *fmt, ...) {
338   va_list al;
339   va_start(al,fmt);
340
341   Snapshot *last=0;
342   int nidentical=0;
343   /* waits longer if we're going to return an image identical to previously
344    * if previously==0, all images are considered identical to it */
345
346   char *doing;
347   sysassert( vasprintf(&doing,fmt,al) >=0 );
348
349   debugf("PAGING  wait_for_stability"
350           "  last_input=%f previously=%p `%s'\n",
351           last_input, previously, doing);
352
353   double min_interval= 0.025;
354   for (;;) {
355     progress_spinner("%s",doing);
356     
357     double since_last_input= timestamp() - last_input;
358     double this_interval= min_interval - since_last_input;
359
360     if (this_interval >= 0)
361       delay(this_interval);
362
363     snapshot(output);
364
365     if (!last) {
366       debugf("PAGING  wait_for_stability first...\n");
367       last=*output; *output=0;
368     } else if (!identical(*output,last)) {
369       debugf("PAGING  wait_for_stability changed...\n");
370       free_snapshot(&last); last=*output; *output=0;
371       nidentical=0;
372       if (!with_keypress) {
373         min_interval *= 3.0;
374         min_interval += 0.1;
375       }
376     } else {
377       nidentical++;
378       int threshold=
379         !previously ? 3 :
380         identical(*output,previously) ? 5
381         : 1;
382       debugf("PAGING  wait_for_stability nidentical=%d threshold=%d\n",
383               nidentical, threshold);
384       if (nidentical >= threshold)
385         break;
386
387       min_interval += 0.1;
388       min_interval *= 2.0;
389     }
390
391     if (with_keypress)
392       with_keypress();
393   }
394
395   free_snapshot(&last);
396   free(doing);
397   debugf("PAGING  wait_for_stability done.\n");
398   va_end(al);
399 }
400
401 static void raise_and_get_details(void) {
402   int evbase,errbase,majver,minver;
403   int wxpos, wypos;
404   unsigned bd,depth;
405
406   progress("raising and checking YPP client window...");
407
408   debugf("PAGING raise_and_get_details\n");
409
410   int xtest= XTestQueryExtension(disp, &evbase,&errbase,&majver,&minver);
411   if (!xtest) fatal("X server does not support the XTEST extension.");
412
413   xassert( XRaiseWindow(disp, id) );
414   /* in case VisibilityNotify triggers right away before we have had a
415    * change to raise; to avoid falsely detecting lowering in that case */
416   
417   xassert( XSelectInput(disp, id,
418                         StructureNotifyMask|
419                         VisibilityChangeMask
420                         ) );
421
422   xassert( XRaiseWindow(disp, id) );
423   /* in case the window was lowered between our Raise and our SelectInput;
424    * to avoid failing to detect that lowering */
425
426   xassert( XGetWindowAttributes(disp, id, &attr) );
427   xassert( XGetGeometry(disp,id, &attr.root,
428                         &wxpos,&wypos, &wwidth,&wheight,
429                         &bd,&depth) );
430
431   if (!(wwidth >= 320 && wheight >= 320))
432     fatal("YPP client window is implausibly small?");
433
434   if (attr.depth < 24)
435     fatal("Display is not 24bpp.");
436
437   check_client_window_all_on_screen();
438
439   Bool shmpixmaps=0;
440   int major=0,minor=0;
441   int shm= XShmQueryVersion(disp, &major,&minor,&shmpixmaps);
442   debugf("PAGING shm=%d %d.%d pixmaps=%d\n",shm,major,minor,shmpixmaps);
443   if (shm) {
444     xassert( shmim= XShmCreateImage(disp, attr.visual, attr.depth, ZPixmap,
445                                     0,&shminfo, wwidth,wheight) );
446
447     sigset_t oldset, all;
448     sigfillset(&all);
449     sysassert(! sigprocmask(SIG_BLOCK,&all,&oldset) );
450
451     int pfd[2];
452     pid_t cleaner;
453     sysassert(! pipe(pfd) );
454     sysassert( (cleaner= fork()) != -1 );
455     if (!cleaner) {
456       sysassert(! close(pfd[1]) );
457       for (;;) {
458         int r= read(pfd[0], &shminfo.shmid, sizeof(shminfo.shmid));
459         if (!r) exit(0);
460         if (r==sizeof(shminfo.shmid)) break;
461         assert(r==-1 && errno==EINTR);
462       }
463       for (;;) {
464         char bc;
465         int r= read(pfd[0],&bc,1);
466         if (r>=0) break;
467         assert(r==-1 && errno==EINTR);
468       }
469       sysassert(! shmctl(shminfo.shmid,IPC_RMID,0) );
470       exit(0);
471     }
472     sysassert(! close(pfd[0]) );
473
474     sysassert(! sigprocmask(SIG_SETMASK,&oldset,0) );
475
476     assert(shmim->height == wheight);
477     sysassert( (shminfo.shmid=
478                 shmget(IPC_PRIVATE, shmim->bytes_per_line * wheight,
479                        IPC_CREAT|0600)) >= 0 );
480
481     sysassert( write(pfd[1],&shminfo.shmid,sizeof(shminfo.shmid)) ==
482                sizeof(shminfo.shmid) );
483     sysassert( shminfo.shmaddr= shmat(shminfo.shmid,0,0) );
484     shmim->data= shminfo.shmaddr;
485     shminfo.readOnly= False;
486     xassert( XShmAttach(disp,&shminfo) );
487
488     close(pfd[1]); /* causes IPC_RMID */
489   }
490 }
491
492 static void set_focus_commodity(void) {
493   int screen= XScreenNumberOfScreen(attr.screen);
494
495   progress("taking control of YPP client window...");
496
497   debugf("PAGING set_focus\n");
498
499   mouse_1_updown(commod_focus_point.x, commod_focus_point.y);
500   sync_after_input();
501
502   delay(0.5);
503   xassert( XSelectInput(disp, id,
504                         StructureNotifyMask|
505                         VisibilityChangeMask|
506                         FocusChangeMask
507                         ) );
508
509   int xpos,ypos;
510   translate_coords_toroot_p(commod_page_point, &xpos,&ypos);
511   XTestFakeMotionEvent(disp, screen, xpos,ypos, 0);
512
513   sync_after_input();
514
515   debugf("PAGING raise_and_set_focus done.\n");
516 }
517
518 static CanonImage *convert_page(const Snapshot *sn, RgbImage **rgb_r) {
519   CanonImage *im;
520   RgbImage *ri;
521
522   fwrite_ppmraw(screenshot_file, sn);
523
524   const Rgb *pixel= sn->data;
525   CANONICALISE_IMAGE(im, sn->w, sn->h, ri, {
526     rgb= *pixel++;
527   });
528
529   sysassert(!ferror(screenshot_file));
530   sysassert(!fflush(screenshot_file));
531
532   if (rgb_r) *rgb_r= ri;
533   else free(ri);
534
535   return im;
536 }
537
538 static void prepare_ypp_client(void) {
539   CanonImage *test;
540   Snapshot *current=0;
541   
542   /* find the window and check it's on the right kind of screen */
543   raise_and_get_details();
544   wait_for_stability(&current,0,0, "checking current YPP client screen...");
545
546   test= convert_page(current,0);
547   find_structure(test,0, &max_relevant_y,
548                  &commod_focus_point,
549                  &commod_page_point,
550                  &commod_focuslast_point);
551   check_correct_commodities();
552   Rect sunshine= find_sunshine_widget();
553
554   progress("poking client...");
555   mouse_1_updown((sunshine.tl.x   + sunshine.br.x) / 2,
556                  (sunshine.tl.y*9 + sunshine.br.y) / 10);
557
558   free(test);
559
560   wait_for_stability(&current,0,0, "checking basic YPP client screen...");
561   mouse_1_updown(250, wheight-10);
562   mouse_1_updown_here();
563   mouse_1_updown_here();
564   XSync(disp,False);
565   check_not_disturbed();
566   send_key(XK_slash);
567   send_key(XK_w);
568   send_key(XK_Return);
569   sync_after_input();
570
571   Snapshot *status=0;
572   wait_for_stability(&status,current,0, "awaiting status information...");
573   free_snapshot(&current);
574   free_snapshot(&status);
575 }
576
577 static void convert_store_page(Snapshot *current) {
578   RgbImage *rgb;
579   CanonImage *ci;
580   PageStruct *pstruct;
581   
582   progress("page %d prescanning   ...",npages);
583   ci= convert_page(current,&rgb);
584
585   progress("page %d overview      ...",npages);
586   find_structure(ci,&pstruct, 0,0,0,0);
587
588   store_current_page(ci,pstruct,rgb);
589 }
590
591 void take_screenshots(void) {
592   Snapshot *current=0, *last=0;
593
594   prepare_ypp_client();
595   
596   /* page to the top - keep pressing page up until the image stops changing */
597   set_focus_commodity();
598   wait_for_stability(&current,0, send_pgup_many,
599                      "paging up to top of commodity list...");
600
601   /* now to actually page down */
602   for (;;) {
603     debugf("page %d paging\n",npages);
604
605     if (!(npages < MAX_PAGES))
606       fatal("Paging down seems to generate too many pages - max is %d.",
607             MAX_PAGES);
608
609     convert_store_page(current);
610     free_snapshot(&last); last=current; current=0;
611
612     debugf("PAGING page %d converted\n",npages);
613
614     wait_for_stability(&current,last, 0,
615                        "page %d collecting    ...",
616                        npages+1);
617
618     if (npages &&  /* first pagedown doesn't do much */
619         identical(current,last)) {
620       npages++;
621       free_snapshot(&current);
622       break;
623     }
624
625     pgdown_by_mouse();
626     npages++;
627   }
628   progress("finishing with the YPP client...");
629   mouse_1_updown(commod_focuslast_point.x, commod_focuslast_point.y);
630   sync_after_input();
631   send_pgdown_torestore();
632   sync_after_input();
633
634   debugf("PAGING all done.\n");
635   progress_log("collected %d screenshots.",npages);
636 }    
637
638 void take_one_screenshot(void) {
639   Snapshot *current=0;
640
641   prepare_ypp_client();
642   wait_for_stability(&current,0,0, "taking screenshot...");
643   convert_store_page(current);
644   npages= 1;
645   progress_log("collected single screenshot.");
646 }
647
648 void set_yppclient_window(unsigned long wul) {
649   id= wul;
650 }
651
652 DEBUG_DEFINE_SOME_DEBUGF(findypp,debugfind)
653
654 static int nfound;
655 static Atom wm_name;
656 static int screen;
657
658 static void findypp_recurse(int depth, int targetdepth, Window w) {
659   unsigned int nchildren;
660   int i;
661   Window *children=0;
662   Window gotroot, gotparent;
663
664   static const char prefix[]= "Puzzle Pirates - ";
665   static const char onthe[]= " on the ";
666   static const char suffix[]= " ocean";
667 #define S(x) ((int)sizeof((x))-1)
668
669   debugfind("FINDYPP %d/%d screen %d  %*s %lx",
670             depth,targetdepth,screen,
671             depth,"",(unsigned long)w);
672   
673   if (depth!=targetdepth) {
674     xassert( XQueryTree(disp,w,
675                         &gotroot,&gotparent,
676                         &children,&nchildren) );
677     debugfind(" nchildren=%d\n",nchildren);
678   
679     for (i=0; i<nchildren; i++) {
680       Window child= children[i];
681       findypp_recurse(depth+1, targetdepth, child);
682     }
683     XFree(children);
684     return;
685   }
686     
687
688   int gotfmt;
689   Atom gottype;
690   unsigned long len, gotbytesafter;
691   char *title;
692   unsigned char *gottitle=0;
693   xassert( !XGetWindowProperty(disp,w, wm_name,0,512, False,
694                                AnyPropertyType,&gottype, &gotfmt, &len,
695                                &gotbytesafter, &gottitle) );
696   title= (char*)gottitle;
697
698   if (DEBUGP(findypp)) {
699     debugfind(" gf=%d len=%lu gba=%lu \"", gotfmt,len,gotbytesafter);
700     char *p;
701     for (p=title; p < title+len; p++) {
702       char c= *p;
703       if (c>=' ' && c<=126) fputc(c,debug);
704       else fprintf(debug,"\\x%02x",c & 0xff);
705     }
706     fputs("\": ",debug);
707   }
708
709 #define REQUIRE(pred)                                                   \
710   if (!(pred)) { debugfind(" failed test  %s\n", #pred); return; }      \
711   else
712
713   REQUIRE( gottype!=None );
714   REQUIRE( len );
715   REQUIRE( gotfmt==8 );
716
717   REQUIRE( len >= S(prefix) + 1 + S(onthe) + 1 + S(suffix) );
718
719   char *spc1= strchr(  title        + S(prefix), ' ');  REQUIRE(spc1);
720   char *spc2= strrchr((title + len) - S(suffix), ' ');  REQUIRE(spc2);
721
722   REQUIRE( (title + len) - spc1  >= S(onthe)  + S(suffix) );
723   REQUIRE(  spc2         - title >= S(prefix) + S(onthe) );
724
725   REQUIRE( !memcmp(title,                   prefix, S(prefix)) );
726   REQUIRE( !memcmp(title + len - S(suffix), suffix, S(suffix))  );
727   REQUIRE( !memcmp(spc1,                    onthe,  S(onthe))  );
728
729 #define ASSIGN(what, start, end)                        \
730   what= masprintf("%.*s", (int)((end)-(start)), start); \
731   if (o_##what) REQUIRE( !strcasecmp(o_##what, what) ); \
732   else
733
734   ASSIGN(ocean,  spc1 + S(onthe),   (title + len) - S(suffix));
735   ASSIGN(pirate, title + S(prefix),  spc1);
736
737   debugfind(" YES!\n");
738   id= w;
739   nfound++;
740   progress_log("found YPP client (0x%lx):"
741                " %s ocean - %s.",
742                (unsigned long)id, ocean, pirate);
743 }
744
745 void find_yppclient_window(void) {
746   int targetdepth;
747
748   nfound=0;
749   
750   if (id) return;
751   
752   progress("looking for YPP client window...");
753
754   xassert( (wm_name= XInternAtom(disp,"WM_NAME",True)) != None);
755
756   for (targetdepth=1; targetdepth<4; targetdepth++) {
757     for (screen=0; screen<ScreenCount(disp); screen++) {
758       debugfind("FINDYPP screen %d\n", screen);
759       findypp_recurse(0,targetdepth, RootWindow(disp,screen));
760     }
761     if (nfound) break;
762   }
763
764   if (nfound>1)
765     fatal("Found several possible YPP clients.   Close one,\n"
766           " disambiguate with --pirate or --ocean,"
767           " or specify --window-id.\n");
768   if (nfound<1)
769     fatal("Did not find %sYPP client."
770           " Use --window-id and/or report this as a fault.\n",
771           o_ocean || o_pirate ? "matching ": "");
772 }