X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~yarrgweb/git?p=ypp-sc-tools.web-live.git;a=blobdiff_plain;f=pctb%2Fpages.c;h=ab3a2b0b118125fcbe13e816d607c3ac834459ca;hp=fbf33171bd3a90182cc7e650361654767f0181d6;hb=1317a7e50044aa2b0542baeb5e15e97199e4c7b2;hpb=a628ba6e81f90a4ebc632731bc5e39ca5daae7fb diff --git a/pctb/pages.c b/pctb/pages.c index fbf3317..ab3a2b0 100644 --- a/pctb/pages.c +++ b/pctb/pages.c @@ -1,5 +1,34 @@ /* - */ + * Interaction with the YPP client via X11 + */ +/* + * This is part of ypp-sc-tools, a set of third-party tools for assisting + * players of Yohoho Puzzle Pirates. + * + * Copyright (C) 2009 Ian Jackson + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + * + * Yohoho and Puzzle Pirates are probably trademarks of Three Rings and + * are used without permission. This program is not endorsed or + * sponsored by Three Rings. + */ + +/* + * Only this file #includes the X11 headers, as they're quite + * pollutant of the namespace. + */ #include "structure.h" @@ -18,18 +47,24 @@ static Window id; static Display *disp; static struct timeval tv_startup; static unsigned wwidth, wheight; +static int max_relevant_y= -1; DEBUG_DEFINE_DEBUGF(pages) +#define xassert(what) \ + ((what) ? (void)0 : \ + fatal("X11 operation unexpectedly failed." \ + " %s:%d: %s\n", __FILE__,__LINE__,#what)) + static KeyCode keycode(KeySym sym) { return XKeysymToKeycode(disp,sym); } void screenshot_startup(void) { - int r; progress("starting..."); - disp= XOpenDisplay(0); eassert(disp); - r= gettimeofday(&tv_startup,0); eassert(!r); + disp= XOpenDisplay(0); + if (!disp) fatal("Unable to open X11 display."); + sysassert(! gettimeofday(&tv_startup,0) ); } /*---------- pager ----------*/ @@ -41,43 +76,107 @@ static const double min_update_allowance= 0.25; static double timestamp(void) { struct timeval tv; - int r; - r= gettimeofday(&tv,0); eassert(!r); + sysassert(! gettimeofday(&tv,0) ); double t= (tv.tv_sec - tv_startup.tv_sec) + (tv.tv_usec - tv_startup.tv_usec) * 1e-6; debugf("PAGING %f\n",t); return t; } static void delay(double need_sleep) { - int r; debugf("PAGING delay %f\n",need_sleep); - r= usleep(need_sleep * 1e6); eassert(!r); + sysassert(! usleep(need_sleep * 1e6) ); } static void sync_after_input(void) { - int r; - r= XSync(disp, False); eassert(r); + xassert( XSync(disp, False) ); last_input= timestamp(); } +static void translate_coords_toroot(int wx, int wy, int *rx, int *ry) { + Window dummy; + xassert( XTranslateCoordinates(disp, id,attr.root, wx,wy, rx,ry, &dummy) ); +} + +static void check_client_window_all_on_screen(void) { + Rect onroot; + unsigned rwidth, rheight; + Window dummy; + unsigned bd, depth; + int rxpos, rypos; + + xassert( XGetGeometry(disp,attr.root, &dummy, &rxpos,&rypos, + &rwidth, &rheight, + &bd,&depth) ); + + translate_coords_toroot(0,0, &onroot.tl.x,&onroot.tl.y); + translate_coords_toroot(wwidth-1,wheight-1, &onroot.br.x,&onroot.br.y); + if (!(onroot.tl.x >= 0 && + onroot.tl.y >= 0 && + onroot.br.x < rwidth && + onroot.br.y < rheight)) + fatal("YPP client window is not entirely on the screen."); +} + +static void check_not_disturbed(void) { + XEvent ev; + int r; + + for (;;) { + r= XCheckMaskEvent(disp, ~0, &ev); + if (r==False) return; + + switch (ev.type) { + case VisibilityNotify: + if (ev.xvisibility.state != VisibilityUnobscured) + fatal("YPP client window has become obscured."); + break; + case ConfigureNotify: + check_client_window_all_on_screen(); + break; + case FocusOut: + fatal("Focus left YPP client window."); + break; + case FocusIn: + warning("focus entered YPP client window ?!"); + break; + default: + fatal("Received unexpected X11 event (type code %d)!", ev.type); + } + } +} + static void send_key(KeySym sym) { + check_not_disturbed(); XTestFakeKeyEvent(disp, keycode(sym),1, 10); XTestFakeKeyEvent(disp, keycode(sym),0, 10); } +static int pgupdown; + static void send_pgup_many(void) { int i; - for (i=0; i<25; i++) + for (i=0; i<25; i++) { send_key(XK_Prior); + pgupdown--; + } debugf("PAGING PageUp x %d\n",i); sync_after_input(); } static void send_pgdown(void) { send_key(XK_Next); + pgupdown++; debugf("PAGING PageDown\n"); sync_after_input(); } +static void send_pgdown_torestore(void) { + debugf("PAGING PageDown x %d\n", -pgupdown); + while (pgupdown < 0) { + send_key(XK_Next); + pgupdown++; + } + sync_after_input(); +} static void free_snapshot(Snapshot **io) { if (*io) XDestroyImage(*io); @@ -92,7 +191,9 @@ static void snapshot(Snapshot **output) { timestamp(); *output= XGetImage(disp,id, 0,0, wwidth,wheight, AllPlanes, ZPixmap); timestamp(); - + + check_not_disturbed(); + debugf("PAGING snapshot done.\n"); } @@ -102,15 +203,28 @@ static int identical(const Snapshot *a, const Snapshot *b) { a->bytes_per_line == b->bytes_per_line && a->format == b->format)) return 0; - return !memcmp(a->data, b->data, a->bytes_per_line * a->height); + + int compare_to= a->height; + if (max_relevant_y && compare_to > max_relevant_y) + compare_to= max_relevant_y; + + return !memcmp(a->data, b->data, a->bytes_per_line * compare_to); } +static void wait_for_stability(Snapshot **output, + const Snapshot *previously, + void (*with_keypress)(void), + const char *fmt, ...) + FMT(4,5); + static void wait_for_stability(Snapshot **output, const Snapshot *previously, void (*with_keypress)(void), const char *fmt, ...) { + va_list al; + va_start(al,fmt); + Snapshot *last=0; - int r; /* waits longer if we're going to return an image identical to previously * if previously==0, all images are considered identical to it */ @@ -119,12 +233,9 @@ static void wait_for_stability(Snapshot **output, last_input, previously); char *doing; - va_list al; - va_start(al,fmt); - r= asprintf(&doing,fmt,al); eassert(r>=0); - va_end(al); + sysassert( vasprintf(&doing,fmt,al) >=0); - progress(doing); + progress("%s",doing); for (;;) { double at_snapshot= timestamp(); @@ -144,7 +255,7 @@ static void wait_for_stability(Snapshot **output, break; } - progress_spinner(doing); + progress_spinner("%s",doing); debugf("PAGING wait_for_stability retry\n"); @@ -159,60 +270,43 @@ static void wait_for_stability(Snapshot **output, free_snapshot(&last); free(doing); debugf("PAGING wait_for_stability done.\n"); -} - -static void translate_coords_toroot(int wx, int wy, int *rx, int *ry) { - int r; - Window dummy; - r= XTranslateCoordinates(disp, id,attr.root, wx,wy, rx,ry, &dummy); - eassert(r); + va_end(al); } static void raise_and_get_details(void) { - int r; int evbase,errbase,majver,minver; int wxpos, wypos; unsigned bd,depth; - Window dummy; progress("raising and checking YPP client window..."); debugf("PAGING raise_and_get_details\n"); - r= XTestQueryExtension(disp, &evbase,&errbase,&majver,&minver); - eassert(r==True); + int xtest= XTestQueryExtension(disp, &evbase,&errbase,&majver,&minver); + if (!xtest) fatal("X server does not support the XTEST extension."); - r= XRaiseWindow(disp, id); eassert(r); + xassert( XRaiseWindow(disp, id) ); /* in case VisibilityNotify triggers right away before we have had a * change to raise; to avoid falsely detecting lowering in that case */ - r= XSelectInput(disp, id, - StructureNotifyMask| - VisibilityChangeMask - ); eassert(r); + xassert( XSelectInput(disp, id, + StructureNotifyMask| + VisibilityChangeMask + ) ); - r= XRaiseWindow(disp, id); eassert(r); + xassert( XRaiseWindow(disp, id) ); /* in case the window was lowered between our Raise and our SelectInput; * to avoid failing to detect that lowering */ - r= XGetWindowAttributes(disp, id, &attr); eassert(r); - r= XGetGeometry(disp,id, &attr.root, - &wxpos,&wypos, &wwidth,&wheight, - &bd,&depth); - - eassert(wwidth >= 320 && wheight >= 320); + xassert( XGetWindowAttributes(disp, id, &attr) ); + xassert( XGetGeometry(disp,id, &attr.root, + &wxpos,&wypos, &wwidth,&wheight, + &bd,&depth) ); - int rxpos, rypos; - unsigned rwidth, rheight; - r= XGetGeometry(disp,attr.root, &dummy, &rxpos,&rypos, - &rwidth, &rheight, - &bd,&depth); - - translate_coords_toroot(0,0, &rxpos,&rypos); - eassert(rxpos>=0 && rypos>=0); + if (!(wwidth >= 320 && wheight >= 320)) + fatal("YPP client window is implausibly small?"); - translate_coords_toroot(wwidth-1,wheight-1, &rxpos,&rypos); - eassert(rxposwidth, sn->height); @@ -288,11 +389,12 @@ static CanonImage *convert_page(Snapshot *sn) { ((xrgb << shiftmasks[i].lshift) >> shiftmasks[i].rshift) & SAMPLEMASK; rgb |= sample; - fputc(sample, screenshots_file); + fputc(sample, screenshot_file); } }); - eassert(!fflush(screenshots_file)); + sysassert(!ferror(screenshot_file)); + sysassert(!fflush(screenshot_file)); return im; } @@ -305,7 +407,8 @@ void take_screenshots(void) { raise_and_get_details(); wait_for_stability(¤t,0,0, "checking current YPP client screen..."); test= convert_page(current); - find_structure(test); + find_structure(test, &max_relevant_y); + check_correct_commodities(); free(test); /* page to the top - keep pressing page up until the image stops changing */ @@ -317,14 +420,18 @@ void take_screenshots(void) { for (;;) { debugf("paging page %d\n",npages); - eassert(npages < MAX_PAGES); + if (!(npages < MAX_PAGES)) + fatal("Paging down seems to generate too many pages - max is %d.", + MAX_PAGES); + page_images[npages]= convert_page(current); free_snapshot(&last); last=current; current=0; debugf("PAGING page %d converted\n",npages); wait_for_stability(¤t,last, 0, - "collecting screenshot of page %d...",npages+1); + "collecting screenshot of page %d...", + npages+1); if (npages && /* first pagedown doesn't do much */ identical(current,last)) { @@ -335,6 +442,9 @@ void take_screenshots(void) { send_pgdown(); npages++; } + progress("finishing with the YPP client..."); + send_pgdown_torestore(); + debugf("PAGING all done.\n"); progress_log("collected %d screenshots.",npages); } @@ -358,7 +468,7 @@ DEBUG_DEFINE_SOME_DEBUGF(findypp,debugfind) void find_yppclient_window(void) { Window root, gotroot, gotparent; - int screen, r; + int screen; int nfound=0; if (id) return; @@ -371,7 +481,7 @@ void find_yppclient_window(void) { #define S(x) (sizeof((x))-1) Atom wm_name= XInternAtom(disp,"WM_NAME",True); - eassert(wm_name != None); + xassert(wm_name != None); for (screen=0; screen0); \ + sysassert( asprintf(&what, "%.*s", (end)-(start), start) >0 ); \ }while(0) - ASSIGN(ocean, title + S(prefix), spc1); - ASSIGN(pirate, spc1 + S(onthe), (title + len) - S(suffix)); + ASSIGN(pirate, title + S(prefix), spc1); + ASSIGN(ocean, spc1 + S(onthe), (title + len) - S(suffix)); debugfind(" YES!\n"); id= w2; nfound++; - progress_log("found YPP client window (0x%lx): %s on the %s ocean.", - (unsigned long)id, pirate, ocean); + progress_log("found YPP client (0x%lx):" + " %s ocean - %s.", + (unsigned long)id, ocean, pirate); } if (children2) XFree(children2); } if (children1) XFree(children1); } - eassert(nfound==1); + if (nfound>1) + fatal("Found several YPP clients." + " Close one, or specify the windowid with --window-id.\n"); + if (nfound<1) + fatal("Did not find YPP client." + " Use --window-id and/or report this as a fault.\n"); }