X-Git-Url: https://www.chiark.greenend.org.uk/ucgi/~yarrgweb/git?p=ypp-sc-tools.db-test.git;a=blobdiff_plain;f=pctb%2Fpages.c;h=42dd5bc88413c35020674c3d67f9c70e722fb6b6;hp=ffd0ba6e4c8c9c8a39d4268291f65638030d0f87;hb=8b296a5f4da05a4dcf356f71e1ce4e63d8d282cf;hpb=09e8b6a8735c8cd1f7f3ffbabc1a05f0a8f8ca75 diff --git a/pctb/pages.c b/pctb/pages.c index ffd0ba6..42dd5bc 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" @@ -21,15 +50,20 @@ static unsigned wwidth, wheight; 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,49 +75,46 @@ 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) { - int r; Window dummy; - r= XTranslateCoordinates(disp, id,attr.root, wx,wy, rx,ry, &dummy); - eassert(r); + xassert( XTranslateCoordinates(disp, id,attr.root, wx,wy, rx,ry, &dummy) ); } static void check_client_window_all_on_screen(void) { - int r; - int rxpos, rypos; + Rect onroot; unsigned rwidth, rheight; Window dummy; unsigned bd, depth; + int rxpos, rypos; - r= XGetGeometry(disp,attr.root, &dummy, &rxpos,&rypos, - &rwidth, &rheight, - &bd,&depth); + xassert( XGetGeometry(disp,attr.root, &dummy, &rxpos,&rypos, + &rwidth, &rheight, + &bd,&depth) ); - translate_coords_toroot(0,0, &rxpos,&rypos); - eassert(rxpos>=0 && rypos>=0); - - translate_coords_toroot(wwidth-1,wheight-1, &rxpos,&rypos); - eassert(rxpos= 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) { @@ -96,19 +127,20 @@ static void check_not_disturbed(void) { switch (ev.type) { case VisibilityNotify: - eassert(ev.xvisibility.state == VisibilityUnobscured); + if (ev.xvisibility.state != VisibilityUnobscured) + fatal("YPP client window has become obscured."); break; case ConfigureNotify: check_client_window_all_on_screen(); break; case FocusOut: - eassert(!"focus left YPP client window"); + fatal("Focus left YPP client window."); break; case FocusIn: warning("focus entered YPP client window ?!"); break; default: - eassert(!"unexpected X11 event"); + fatal("Received unexpected X11 event (type code %d)!", ev.type); } } } @@ -173,7 +205,6 @@ static void wait_for_stability(Snapshot **output, 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 */ @@ -182,7 +213,7 @@ static void wait_for_stability(Snapshot **output, last_input, previously); char *doing; - r= vasprintf(&doing,fmt,al); eassert(r>=0); + sysassert( vasprintf(&doing,fmt,al) >=0); progress("%s",doing); @@ -223,7 +254,6 @@ static void wait_for_stability(Snapshot **output, } static void raise_and_get_details(void) { - int r; int evbase,errbase,majver,minver; int wxpos, wypos; unsigned bd,depth; @@ -232,34 +262,34 @@ static void raise_and_get_details(void) { 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); + xassert( XGetWindowAttributes(disp, id, &attr) ); + xassert( XGetGeometry(disp,id, &attr.root, + &wxpos,&wypos, &wwidth,&wheight, + &bd,&depth) ); - eassert(wwidth >= 320 && wheight >= 320); + if (!(wwidth >= 320 && wheight >= 320)) + fatal("YPP client window is implausibly small?"); check_client_window_all_on_screen(); } static void set_focus(void) { - int r; int screen= XScreenNumberOfScreen(attr.screen); progress("taking control of YPP client window..."); @@ -276,11 +306,11 @@ static void set_focus(void) { sync_after_input(); delay(0.5); - r= XSelectInput(disp, id, - StructureNotifyMask| - VisibilityChangeMask| - FocusChangeMask - ); eassert(r); + xassert( XSelectInput(disp, id, + StructureNotifyMask| + VisibilityChangeMask| + FocusChangeMask + ) ); translate_coords_toroot(10,10, &xpos,&ypos); XTestFakeMotionEvent(disp,screen, xpos,ypos, 0); @@ -343,7 +373,8 @@ static CanonImage *convert_page(Snapshot *sn) { } }); - eassert(!fflush(screenshots_file)); + sysassert(!ferror(screenshots_file)); + sysassert(!fflush(screenshots_file)); return im; } @@ -368,7 +399,10 @@ 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; @@ -410,7 +444,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; @@ -423,7 +457,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"); }