2 * Interaction with the YPP client via X11
5 * This is part of ypp-sc-tools, a set of third-party tools for assisting
6 * players of Yohoho Puzzle Pirates.
8 * Copyright (C) 2009 Ian Jackson <ijackson@chiark.greenend.org.uk>
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.
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.
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/>.
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.
29 * Only this file #includes the X11 headers, as they're quite
30 * pollutant of the namespace.
33 #include "structure.h"
36 #include <X11/extensions/XTest.h>
37 #include <X11/keysym.h>
38 #include <X11/Xutil.h>
40 #include <X11/extensions/XShm.h>
44 CanonImage *page_images[MAX_PAGES];
46 RgbImage *page0_rgbimage;
48 const char *ocean, *pirate;
50 static XWindowAttributes attr;
53 static struct timeval tv_startup;
54 static unsigned wwidth, wheight;
55 static int max_relevant_y= -1;
58 static XShmSegmentInfo shminfo;
60 DEBUG_DEFINE_DEBUGF(pages)
62 #define xassert(what) \
64 fatal("X11 operation unexpectedly failed." \
65 " %s:%d: %s\n", __FILE__,__LINE__,#what))
67 static KeyCode keycode(KeySym sym) {
68 return XKeysymToKeycode(disp,sym);
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) );
78 /*---------- pager ----------*/
80 typedef RgbImage Snapshot;
82 static double last_input;
83 static const double min_update_allowance= 0.25;
85 static double timestamp(void) {
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);
94 static void delay(double need_sleep) {
95 debugf("PAGING delay %f\n",need_sleep);
96 sysassert(! usleep(need_sleep * 1e6) );
99 static void sync_after_input(void) {
100 xassert( XSync(disp, False) );
101 last_input= timestamp();
104 static void translate_coords_toroot(int wx, int wy, int *rx, int *ry) {
106 xassert( XTranslateCoordinates(disp, id,attr.root, wx,wy, rx,ry, &dummy) );
109 static void check_client_window_all_on_screen(void) {
111 unsigned rwidth, rheight;
116 xassert( XGetGeometry(disp,attr.root, &dummy, &rxpos,&rypos,
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 &&
124 onroot.br.x < rwidth &&
125 onroot.br.y < rheight))
126 fatal("YPP client window is not entirely on the screen.");
129 static void check_not_disturbed(void) {
134 r= XCheckMaskEvent(disp, ~0, &ev);
135 if (r==False) return;
138 case VisibilityNotify:
139 if (ev.xvisibility.state != VisibilityUnobscured)
140 fatal("YPP client window has become obscured.");
142 case ConfigureNotify:
143 check_client_window_all_on_screen();
146 fatal("Focus left YPP client window.");
149 warning("focus entered YPP client window ?!");
152 fatal("Received unexpected X11 event (type code %d)!", ev.type);
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);
162 static void mouse_1_updown_here(void) {
163 check_not_disturbed();
164 XTestFakeButtonEvent(disp,1,1, 50);
165 XTestFakeButtonEvent(disp,1,0, 50);
167 static void mouse_1_updown(int x, int y) {
168 check_not_disturbed();
169 int screen= XScreenNumberOfScreen(attr.screen);
171 translate_coords_toroot(x,y, &xpos,&ypos);
172 XTestFakeMotionEvent(disp, screen, xpos,ypos, 0);
173 mouse_1_updown_here();
178 static void send_pgup_many(void) {
180 for (i=0; i<25; i++) {
184 debugf("PAGING PageUp x %d\n",i);
187 static void send_pgdown(void) {
190 debugf("PAGING PageDown\n");
193 static void send_pgdown_torestore(void) {
194 debugf("PAGING PageDown x %d\n", -pgupdown);
195 while (pgupdown < 0) {
202 static void free_snapshot(Snapshot **io) {
207 #define SAMPLEMASK 0xfful
213 static void compute_shift_mask(ShMask *sm, unsigned long ximage_mask) {
218 if (ximage_mask <= (SAMPLEMASK>>1)) {
219 sm->lshift++; ximage_mask <<= 1;
220 } else if (ximage_mask > SAMPLEMASK) {
221 sm->rshift++; ximage_mask >>= 1;
225 assert(!(sm->lshift && sm->rshift));
227 assert(sm->lshift < LONG_BIT);
228 assert(sm->rshift < LONG_BIT);
231 static void rtimestamp(double *t, const char *wh) {
232 double n= timestamp();
233 debugf("PAGING INTERVAL %f %s\n", n-*t, wh);
237 static void snapshot(Snapshot **output) {
238 XImage *im_use, *im_free=0;
240 ShMask shiftmasks[3];
242 debugf("PAGING snapshot\n");
244 double begin= timestamp();
246 xassert( XShmGetImage(disp,id,shmim, 0,0, AllPlanes) );
247 rtimestamp(&begin, "XShmGetImage");
249 size_t dsz= shmim->bytes_per_line * shmim->height;
250 im_use= im_free= mmalloc(sizeof(*im_use) + dsz);
252 im_free->data= (void*)(im_free+1);
253 memcpy(im_free->data, shmim->data, dsz);
254 rtimestamp(&begin, "mmalloc/memcpy");
256 xassert( im_use= im_free=
257 XGetImage(disp,id, 0,0, wwidth,wheight, AllPlanes, ZPixmap) );
258 rtimestamp(&begin, "XGetImage");
261 #define COMPUTE_SHIFT_MASK(ix, rgb) \
262 compute_shift_mask(&shiftmasks[ix], im_use->rgb##_mask)
263 COMPUTE_SHIFT_MASK(0, red);
264 COMPUTE_SHIFT_MASK(1, green);
265 COMPUTE_SHIFT_MASK(2, blue);
268 *output= alloc_rgb_image(wwidth, wheight);
270 rtimestamp(&begin, "compute_shift_masks+alloc_rgb_image");
273 unsigned char *op= (*output)->data;
274 for (y=0; y<wheight; y++) {
275 for (x=0; x<wwidth; x++) {
276 long xrgb= XGetPixel(im_use,x,y);
277 for (i=0; i<3; i++) {
278 unsigned long sample=
279 ((xrgb << shiftmasks[i].lshift) >> shiftmasks[i].rshift)
286 rtimestamp(&begin,"w*h*XGetPixel");
288 XDestroyImage(im_free);
290 rtimestamp(&begin,"XDestroyImage");
291 check_not_disturbed();
293 debugf("PAGING snapshot done.\n");
296 static int identical(const Snapshot *a, const Snapshot *b) {
297 if (!(a->w == b->w &&
301 int compare_to= a->h;
302 if (max_relevant_y && compare_to > max_relevant_y)
303 compare_to= max_relevant_y;
305 return !memcmp(a->data, b->data, a->w * 3 * compare_to);
308 static void wait_for_stability(Snapshot **output,
309 const Snapshot *previously,
310 void (*with_keypress)(void),
311 const char *fmt, ...)
314 static void wait_for_stability(Snapshot **output,
315 const Snapshot *previously,
316 void (*with_keypress)(void),
317 const char *fmt, ...) {
322 /* waits longer if we're going to return an image identical to previously
323 * if previously==0, all images are considered identical to it */
326 sysassert( vasprintf(&doing,fmt,al) >=0 );
327 progress("%s",doing);
329 debugf("PAGING wait_for_stability"
330 " last_input=%f previously=%p `%s'\n",
331 last_input, previously, doing);
334 double at_snapshot= timestamp();
335 double need_sleep= min_update_allowance - (at_snapshot - last_input);
336 if (need_sleep > 0) { delay(need_sleep); continue; }
340 if (!with_keypress &&
341 !(previously && identical(*output,previously))) {
342 debugf("PAGING wait_for_stability simple\n");
346 if (last && identical(*output,last)) {
347 debugf("PAGING wait_for_stability stabilised\n");
351 progress_spinner("%s",doing);
353 debugf("PAGING wait_for_stability retry\n");
355 free_snapshot(&last); last=*output; *output=0;
363 free_snapshot(&last);
365 debugf("PAGING wait_for_stability done.\n");
369 static void raise_and_get_details(void) {
370 int evbase,errbase,majver,minver;
374 progress("raising and checking YPP client window...");
376 debugf("PAGING raise_and_get_details\n");
378 int xtest= XTestQueryExtension(disp, &evbase,&errbase,&majver,&minver);
379 if (!xtest) fatal("X server does not support the XTEST extension.");
381 xassert( XRaiseWindow(disp, id) );
382 /* in case VisibilityNotify triggers right away before we have had a
383 * change to raise; to avoid falsely detecting lowering in that case */
385 xassert( XSelectInput(disp, id,
390 xassert( XRaiseWindow(disp, id) );
391 /* in case the window was lowered between our Raise and our SelectInput;
392 * to avoid failing to detect that lowering */
394 xassert( XGetWindowAttributes(disp, id, &attr) );
395 xassert( XGetGeometry(disp,id, &attr.root,
396 &wxpos,&wypos, &wwidth,&wheight,
399 if (!(wwidth >= 320 && wheight >= 320))
400 fatal("YPP client window is implausibly small?");
402 check_client_window_all_on_screen();
404 int shm= XShmQueryExtension(disp);
407 xassert( shmim= XShmCreateImage(disp, attr.visual, attr.depth, ZPixmap,
408 0,&shminfo, wwidth,wheight) );
410 sigset_t oldset, all;
412 sysassert(! sigprocmask(SIG_BLOCK,&all,&oldset) );
416 sysassert(! pipe(pfd) );
417 sysassert( (cleaner= fork()) != -1 );
419 sysassert(! close(pfd[1]) );
421 int r= read(pfd[0], &shminfo.shmid, sizeof(shminfo.shmid));
423 if (r==sizeof(shminfo.shmid)) break;
424 assert(r==-1 && errno==EINTR);
428 int r= read(pfd[0],&bc,1);
430 assert(r==-1 && errno==EINTR);
432 sysassert(! shmctl(shminfo.shmid,IPC_RMID,0) );
435 sysassert(! close(pfd[0]) );
437 sysassert(! sigprocmask(SIG_SETMASK,&oldset,0) );
439 assert(shmim->height == wheight);
440 sysassert( (shminfo.shmid=
441 shmget(IPC_PRIVATE, shmim->bytes_per_line * wheight,
442 IPC_CREAT|0600)) >= 0 );
444 sysassert( write(pfd[1],&shminfo.shmid,sizeof(shminfo.shmid)) ==
445 sizeof(shminfo.shmid) );
446 sysassert( shminfo.shmaddr= shmat(shminfo.shmid,0,0) );
447 shmim->data= shminfo.shmaddr;
448 shminfo.readOnly= False;
449 xassert( XShmAttach(disp,&shminfo) );
451 close(pfd[1]); /* causes IPC_RMID */
455 static void set_focus_commodity(void) {
456 int screen= XScreenNumberOfScreen(attr.screen);
458 progress("taking control of YPP client window...");
460 debugf("PAGING set_focus\n");
462 mouse_1_updown(160,160);
466 xassert( XSelectInput(disp, id,
468 VisibilityChangeMask|
473 translate_coords_toroot(10,10, &xpos,&ypos);
474 XTestFakeMotionEvent(disp,screen, xpos,ypos, 0);
478 debugf("PAGING raise_and_set_focus done.\n");
481 static CanonImage *convert_page(Snapshot *sn, RgbImage *ri) {
484 fprintf(screenshot_file,
487 "255\n", sn->w, sn->h);
489 CANONICALISE_IMAGE(im, sn->w, sn->h, {
492 for (i=0; i<3; i++) {
494 unsigned long sample= RI_PIXEL(sn,x,y)[i];
496 fputc(sample, screenshot_file);
499 CANONIMG_ALSO_STORERGB(ri);
502 sysassert(!ferror(screenshot_file));
503 sysassert(!fflush(screenshot_file));
508 static void prepare_ypp_client(void) {
512 /* find the window and check it's on the right kind of screen */
513 raise_and_get_details();
514 wait_for_stability(¤t,0,0, "checking current YPP client screen...");
531 test= convert_page(current, 0);
532 find_structure(test, &max_relevant_y);
533 check_correct_commodities();
535 free_snapshot(¤t);
537 progress("requesting status information...");
538 mouse_1_updown(250, wheight-10);
539 mouse_1_updown_here();
540 mouse_1_updown_here();
542 check_not_disturbed();
547 sysassert(! usleep(1000000) );
550 void take_screenshots(void) {
551 Snapshot *current=0, *last=0;
553 prepare_ypp_client();
555 /* page to the top - keep pressing page up until the image stops changing */
556 set_focus_commodity();
557 wait_for_stability(¤t,0, send_pgup_many,
558 "paging up to top of commodity list...");
560 /* now to actually page down */
562 debugf("paging page %d\n",npages);
564 if (!(npages < MAX_PAGES))
565 fatal("Paging down seems to generate too many pages - max is %d.",
568 page_images[npages]= convert_page(current, 0);
569 free_snapshot(&last); last=current; current=0;
571 debugf("PAGING page %d converted\n",npages);
573 wait_for_stability(¤t,last, 0,
574 "collecting screenshot of page %d...",
577 if (npages && /* first pagedown doesn't do much */
578 identical(current,last)) {
579 free_snapshot(¤t);
586 progress("finishing with the YPP client...");
587 send_pgdown_torestore();
589 debugf("PAGING all done.\n");
590 progress_log("collected %d screenshots.",npages);
593 void take_one_screenshot(void) {
596 prepare_ypp_client();
597 wait_for_stability(¤t,0,0, "taking screenshot...");
598 page0_rgbimage= alloc_rgb_image(current->w, current->h);
599 page_images[0]= convert_page(current, page0_rgbimage);
601 progress_log("collected single screenshot.");
604 void set_yppclient_window(unsigned long wul) {
608 DEBUG_DEFINE_SOME_DEBUGF(findypp,debugfind)
610 void find_yppclient_window(void) {
611 Window root, gotroot, gotparent;
617 progress("looking for YPP client window...");
619 static const char prefix[]= "Puzzle Pirates - ";
620 static const char onthe[]= " on the ";
621 static const char suffix[]= " ocean";
622 #define S(x) (sizeof((x))-1)
624 Atom wm_name= XInternAtom(disp,"WM_NAME",True);
625 xassert(wm_name != None);
627 for (screen=0; screen<ScreenCount(disp); screen++) {
628 debugfind("FINDYPP screen %d\n", screen);
629 root= RootWindow(disp,screen);
630 unsigned int nchildren1;
633 xassert( XQueryTree(disp,root,
635 &children1,&nchildren1) );
636 debugfind("FINDYPP screen %d nchildren1=%d\n", screen, nchildren1);
639 for (i=0; i<nchildren1; i++) {
640 Window w1= children1[i];
641 unsigned int nchildren2;
644 xassert( XQueryTree(disp,w1,
646 &children2,&nchildren2) );
647 debugfind("FINDYPP screen %d c1[%2d]=0x%08lx nchildren2=%d\n",
648 screen, i, (unsigned long)w1, nchildren2);
651 for (j=-1; j<(int)nchildren2; j++) {
652 Window w2= j<0 ? w1 : children2[j];
653 debugfind("FINDYPP screen %d c1[%2d]=0x%08lx c2[%2d]=0x%08lx",
654 screen, i, (unsigned long)w1, j, (unsigned long)w2);
658 unsigned long len, gotbytesafter;
660 unsigned char *gottitle=0;
661 xassert( !XGetWindowProperty(disp,w2, wm_name,0,512, False,
662 AnyPropertyType,&gottype, &gotfmt, &len,
663 &gotbytesafter, &gottitle) );
664 title= (char*)gottitle;
666 if (DEBUGP(findypp)) {
667 debugfind(" gf=%d len=%lu gba=%lu \"", gotfmt,len,gotbytesafter);
669 for (p=title; p < title+len; p++) {
671 if (c>=' ' && c<=126) fputc(c,debug);
672 else fprintf(debug,"\\x%02x",c & 0xff);
677 #define REQUIRE(pred) \
678 if (!(pred)) { debugfind(" failed test %s\n", #pred); continue; } \
681 REQUIRE( gottype!=None );
683 REQUIRE( gotfmt==8 );
685 REQUIRE( len >= S(prefix) + 1 + S(onthe) + 1 + S(suffix) );
687 char *spc1= strchr( title + S(prefix), ' '); REQUIRE(spc1);
688 char *spc2= strrchr((title + len) - S(suffix), ' '); REQUIRE(spc2);
690 REQUIRE( (title + len) - spc1 >= S(onthe) + S(suffix) );
691 REQUIRE( spc2 - title >= S(prefix) + S(onthe) );
693 REQUIRE( !memcmp(title, prefix, S(prefix)) );
694 REQUIRE( !memcmp(title + len - S(suffix), suffix, S(suffix)) );
695 REQUIRE( !memcmp(spc1, onthe, S(onthe)) );
697 #define ASSIGN(what, start, end) \
698 what= masprintf("%.*s", (end)-(start), start); \
699 if (o_##what) REQUIRE( !strcasecmp(o_##what, what) ); \
702 ASSIGN(ocean, spc1 + S(onthe), (title + len) - S(suffix));
703 ASSIGN(pirate, title + S(prefix), spc1);
705 debugfind(" YES!\n");
708 progress_log("found YPP client (0x%lx):"
710 (unsigned long)id, ocean, pirate);
712 if (children2) XFree(children2);
714 if (children1) XFree(children1);
717 fatal("Found several possible YPP clients. Close one,\n"
718 " disambiguate with --pirate or --ocean,"
719 " or specify --window-id.\n");
721 fatal("Did not find %sYPP client."
722 " Use --window-id and/or report this as a fault.\n",
723 o_ocean || o_pirate ? "matching ": "");