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 rtimestamp(&begin, "XShmGetImage before");
247 xassert( XShmGetImage(disp,id,shmim, 0,0, AllPlanes) );
248 rtimestamp(&begin, "XShmGetImage");
250 size_t dsz= shmim->bytes_per_line * shmim->height;
251 im_use= im_free= mmalloc(sizeof(*im_use) + dsz);
253 im_free->data= (void*)(im_free+1);
254 memcpy(im_free->data, shmim->data, dsz);
255 rtimestamp(&begin, "mmalloc/memcpy");
257 rtimestamp(&begin, "XGetImage before");
258 xassert( im_use= im_free=
259 XGetImage(disp,id, 0,0, wwidth,wheight, AllPlanes, ZPixmap) );
260 rtimestamp(&begin, "XGetImage");
263 #define COMPUTE_SHIFT_MASK(ix, rgb) \
264 compute_shift_mask(&shiftmasks[ix], im_use->rgb##_mask)
265 COMPUTE_SHIFT_MASK(0, red);
266 COMPUTE_SHIFT_MASK(1, green);
267 COMPUTE_SHIFT_MASK(2, blue);
270 *output= alloc_rgb_image(wwidth, wheight);
272 rtimestamp(&begin, "compute_shift_masks+alloc_rgb_image");
275 unsigned char *op= (*output)->data;
276 for (y=0; y<wheight; y++) {
277 for (x=0; x<wwidth; x++) {
278 long xrgb= XGetPixel(im_use,x,y);
279 for (i=0; i<3; i++) {
280 unsigned long sample=
281 ((xrgb << shiftmasks[i].lshift) >> shiftmasks[i].rshift)
288 rtimestamp(&begin,"w*h*XGetPixel");
290 XDestroyImage(im_free);
292 rtimestamp(&begin,"XDestroyImage");
293 check_not_disturbed();
295 debugf("PAGING snapshot done.\n");
298 static int identical(const Snapshot *a, const Snapshot *b) {
299 if (!(a->w == b->w &&
303 int compare_to= a->h;
304 if (max_relevant_y>=0 && compare_to > max_relevant_y)
305 compare_to= max_relevant_y;
307 return !memcmp(a->data, b->data, a->w * 3 * compare_to);
310 static void wait_for_stability(Snapshot **output,
311 const Snapshot *previously,
312 void (*with_keypress)(void),
313 const char *fmt, ...)
316 static void wait_for_stability(Snapshot **output,
317 const Snapshot *previously,
318 void (*with_keypress)(void),
319 const char *fmt, ...) {
325 /* waits longer if we're going to return an image identical to previously
326 * if previously==0, all images are considered identical to it */
329 sysassert( vasprintf(&doing,fmt,al) >=0 );
331 debugf("PAGING wait_for_stability"
332 " last_input=%f previously=%p `%s'\n",
333 last_input, previously, doing);
335 double min_interval= 25000; /*us*/
337 progress_spinner("%s",doing);
339 double since_last_input= timestamp() - last_input;
340 double this_interval= min_interval - since_last_input;
342 if (this_interval >= 0)
343 usleep(this_interval);
348 debugf("PAGING wait_for_stability first...\n");
349 last=*output; *output=0;
350 } else if (!identical(*output,last)) {
351 debugf("PAGING wait_for_stability changed...\n");
352 free(last); last=*output; *output=0;
354 if (!with_keypress) {
362 identical(*output,previously) ? 5
364 debugf("PAGING wait_for_stability nidentical=%d threshold=%d\n",
365 nidentical, threshold);
366 if (nidentical >= threshold)
377 free_snapshot(&last);
379 debugf("PAGING wait_for_stability done.\n");
383 static void raise_and_get_details(void) {
384 int evbase,errbase,majver,minver;
388 progress("raising and checking YPP client window...");
390 debugf("PAGING raise_and_get_details\n");
392 int xtest= XTestQueryExtension(disp, &evbase,&errbase,&majver,&minver);
393 if (!xtest) fatal("X server does not support the XTEST extension.");
395 xassert( XRaiseWindow(disp, id) );
396 /* in case VisibilityNotify triggers right away before we have had a
397 * change to raise; to avoid falsely detecting lowering in that case */
399 xassert( XSelectInput(disp, id,
404 xassert( XRaiseWindow(disp, id) );
405 /* in case the window was lowered between our Raise and our SelectInput;
406 * to avoid failing to detect that lowering */
408 xassert( XGetWindowAttributes(disp, id, &attr) );
409 xassert( XGetGeometry(disp,id, &attr.root,
410 &wxpos,&wypos, &wwidth,&wheight,
413 if (!(wwidth >= 320 && wheight >= 320))
414 fatal("YPP client window is implausibly small?");
416 check_client_window_all_on_screen();
420 int shm= XShmQueryVersion(disp, &major,&minor,&shmpixmaps);
421 debugf("PAGING shm=%d %d.%d pixmaps=%d\n",shm,major,minor,shmpixmaps);
423 xassert( shmim= XShmCreateImage(disp, attr.visual, attr.depth, ZPixmap,
424 0,&shminfo, wwidth,wheight) );
426 sigset_t oldset, all;
428 sysassert(! sigprocmask(SIG_BLOCK,&all,&oldset) );
432 sysassert(! pipe(pfd) );
433 sysassert( (cleaner= fork()) != -1 );
435 sysassert(! close(pfd[1]) );
437 int r= read(pfd[0], &shminfo.shmid, sizeof(shminfo.shmid));
439 if (r==sizeof(shminfo.shmid)) break;
440 assert(r==-1 && errno==EINTR);
444 int r= read(pfd[0],&bc,1);
446 assert(r==-1 && errno==EINTR);
448 sysassert(! shmctl(shminfo.shmid,IPC_RMID,0) );
451 sysassert(! close(pfd[0]) );
453 sysassert(! sigprocmask(SIG_SETMASK,&oldset,0) );
455 assert(shmim->height == wheight);
456 sysassert( (shminfo.shmid=
457 shmget(IPC_PRIVATE, shmim->bytes_per_line * wheight,
458 IPC_CREAT|0600)) >= 0 );
460 sysassert( write(pfd[1],&shminfo.shmid,sizeof(shminfo.shmid)) ==
461 sizeof(shminfo.shmid) );
462 sysassert( shminfo.shmaddr= shmat(shminfo.shmid,0,0) );
463 shmim->data= shminfo.shmaddr;
464 shminfo.readOnly= False;
465 xassert( XShmAttach(disp,&shminfo) );
467 close(pfd[1]); /* causes IPC_RMID */
471 static void set_focus_commodity(void) {
472 int screen= XScreenNumberOfScreen(attr.screen);
474 progress("taking control of YPP client window...");
476 debugf("PAGING set_focus\n");
478 mouse_1_updown(160,160);
482 xassert( XSelectInput(disp, id,
484 VisibilityChangeMask|
489 translate_coords_toroot(10,10, &xpos,&ypos);
490 XTestFakeMotionEvent(disp,screen, xpos,ypos, 0);
494 debugf("PAGING raise_and_set_focus done.\n");
497 static CanonImage *convert_page(Snapshot *sn, RgbImage *ri) {
500 fwrite_ppmraw(screenshot_file, sn);
501 if (ri) memcpy(ri->data, sn->data, ri->h * ri->w * 3);
503 unsigned char *pixel= sn->data;
504 CANONICALISE_IMAGE(im, sn->w, sn->h, {
512 sysassert(!ferror(screenshot_file));
513 sysassert(!fflush(screenshot_file));
518 static void prepare_ypp_client(void) {
522 /* find the window and check it's on the right kind of screen */
523 raise_and_get_details();
524 wait_for_stability(¤t,0,0, "checking current YPP client screen...");
526 test= convert_page(current, 0);
527 find_structure(test, &max_relevant_y);
528 check_correct_commodities();
529 Rect sunshine= find_sunshine_widget();
531 progress("poking client...");
532 mouse_1_updown((sunshine.tl.x + sunshine.br.x) / 2,
533 (sunshine.tl.y*9 + sunshine.br.y) / 10);
537 wait_for_stability(¤t,0,0, "checking basic YPP client screen...");
538 mouse_1_updown(250, wheight-10);
539 mouse_1_updown_here();
540 mouse_1_updown_here();
542 check_not_disturbed();
549 wait_for_stability(&status,current,0, "awaiting status information...");
550 free_snapshot(¤t);
551 free_snapshot(&status);
554 void take_screenshots(void) {
555 Snapshot *current=0, *last=0;
557 prepare_ypp_client();
559 /* page to the top - keep pressing page up until the image stops changing */
560 set_focus_commodity();
561 wait_for_stability(¤t,0, send_pgup_many,
562 "paging up to top of commodity list...");
564 /* now to actually page down */
566 debugf("paging page %d\n",npages);
568 if (!(npages < MAX_PAGES))
569 fatal("Paging down seems to generate too many pages - max is %d.",
572 page_images[npages]= convert_page(current, 0);
573 free_snapshot(&last); last=current; current=0;
575 debugf("PAGING page %d converted\n",npages);
577 wait_for_stability(¤t,last, 0,
578 "collecting screenshot of page %d...",
581 if (npages && /* first pagedown doesn't do much */
582 identical(current,last)) {
583 free_snapshot(¤t);
590 progress("finishing with the YPP client...");
591 send_pgdown_torestore();
593 debugf("PAGING all done.\n");
594 progress_log("collected %d screenshots.",npages);
597 void take_one_screenshot(void) {
600 prepare_ypp_client();
601 wait_for_stability(¤t,0,0, "taking screenshot...");
602 page0_rgbimage= alloc_rgb_image(current->w, current->h);
603 page_images[0]= convert_page(current, page0_rgbimage);
605 progress_log("collected single screenshot.");
608 void set_yppclient_window(unsigned long wul) {
612 DEBUG_DEFINE_SOME_DEBUGF(findypp,debugfind)
618 static void findypp_recurse(int depth, int targetdepth, Window w) {
619 unsigned int nchildren;
622 Window gotroot, gotparent;
624 static const char prefix[]= "Puzzle Pirates - ";
625 static const char onthe[]= " on the ";
626 static const char suffix[]= " ocean";
627 #define S(x) (sizeof((x))-1)
629 debugfind("FINDYPP %d/%d screen %d %*s %lx",
630 depth,targetdepth,screen,
631 depth,"",(unsigned long)w);
633 if (depth!=targetdepth) {
634 xassert( XQueryTree(disp,w,
636 &children,&nchildren) );
637 debugfind(" nchildren=%d\n",nchildren);
639 for (i=0; i<nchildren; i++) {
640 Window child= children[i];
641 findypp_recurse(depth+1, targetdepth, child);
650 unsigned long len, gotbytesafter;
652 unsigned char *gottitle=0;
653 xassert( !XGetWindowProperty(disp,w, wm_name,0,512, False,
654 AnyPropertyType,&gottype, &gotfmt, &len,
655 &gotbytesafter, &gottitle) );
656 title= (char*)gottitle;
658 if (DEBUGP(findypp)) {
659 debugfind(" gf=%d len=%lu gba=%lu \"", gotfmt,len,gotbytesafter);
661 for (p=title; p < title+len; p++) {
663 if (c>=' ' && c<=126) fputc(c,debug);
664 else fprintf(debug,"\\x%02x",c & 0xff);
669 #define REQUIRE(pred) \
670 if (!(pred)) { debugfind(" failed test %s\n", #pred); return; } \
673 REQUIRE( gottype!=None );
675 REQUIRE( gotfmt==8 );
677 REQUIRE( len >= S(prefix) + 1 + S(onthe) + 1 + S(suffix) );
679 char *spc1= strchr( title + S(prefix), ' '); REQUIRE(spc1);
680 char *spc2= strrchr((title + len) - S(suffix), ' '); REQUIRE(spc2);
682 REQUIRE( (title + len) - spc1 >= S(onthe) + S(suffix) );
683 REQUIRE( spc2 - title >= S(prefix) + S(onthe) );
685 REQUIRE( !memcmp(title, prefix, S(prefix)) );
686 REQUIRE( !memcmp(title + len - S(suffix), suffix, S(suffix)) );
687 REQUIRE( !memcmp(spc1, onthe, S(onthe)) );
689 #define ASSIGN(what, start, end) \
690 what= masprintf("%.*s", (end)-(start), start); \
691 if (o_##what) REQUIRE( !strcasecmp(o_##what, what) ); \
694 ASSIGN(ocean, spc1 + S(onthe), (title + len) - S(suffix));
695 ASSIGN(pirate, title + S(prefix), spc1);
697 debugfind(" YES!\n");
700 progress_log("found YPP client (0x%lx):"
702 (unsigned long)id, ocean, pirate);
705 void find_yppclient_window(void) {
712 progress("looking for YPP client window...");
714 xassert( (wm_name= XInternAtom(disp,"WM_NAME",True)) != None);
716 for (targetdepth=1; targetdepth<4; targetdepth++) {
717 for (screen=0; screen<ScreenCount(disp); screen++) {
718 debugfind("FINDYPP screen %d\n", screen);
719 findypp_recurse(0,targetdepth, RootWindow(disp,screen));
725 fatal("Found several possible YPP clients. Close one,\n"
726 " disambiguate with --pirate or --ocean,"
727 " or specify --window-id.\n");
729 fatal("Did not find %sYPP client."
730 " Use --window-id and/or report this as a fault.\n",
731 o_ocean || o_pirate ? "matching ": "");