/*
- */
+ * 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 <ijackson@chiark.greenend.org.uk>
+ *
+ * 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 <http://www.gnu.org/licenses/>.
+ *
+ * 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"
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 ----------*/
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);
}
static void snapshot(Snapshot **output) {
-// char *cmd;
-// int r;
-// XImage *xim;
-
free_snapshot(output);
debugf("PAGING snapshot\n");
timestamp();
*output= XGetImage(disp,id, 0,0, wwidth,wheight, AllPlanes, ZPixmap);
timestamp();
-
+
+ check_not_disturbed();
+
debugf("PAGING snapshot done.\n");
}
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)) {
+ 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;
/* waits longer if we're going to return an image identical to previously
* if previously==0, all images are considered identical to it */
" last_input=%f previously=%p\n",
last_input, previously);
+ char *doing;
+ sysassert( vasprintf(&doing,fmt,al) >=0);
+
+ progress("%s",doing);
+
for (;;) {
double at_snapshot= timestamp();
double need_sleep= min_update_allowance - (at_snapshot - last_input);
break;
}
+ progress_spinner("%s",doing);
+
debugf("PAGING wait_for_stability retry\n");
free_snapshot(&last); last=*output; *output=0;
}
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 ...\n");
+ 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(rxpos<rwidth && rypos<rheight);
+ check_client_window_all_on_screen();
}
static void set_focus(void) {
int screen= XScreenNumberOfScreen(attr.screen);
- progress("taking control of YPP client window ...\n");
+ progress("taking control of YPP client window...");
debugf("PAGING set_focus\n");
sync_after_input();
+ delay(0.5);
+ xassert( XSelectInput(disp, id,
+ StructureNotifyMask|
+ VisibilityChangeMask|
+ FocusChangeMask
+ ) );
+
translate_coords_toroot(10,10, &xpos,&ypos);
XTestFakeMotionEvent(disp,screen, xpos,ypos, 0);
ShMask shiftmasks[3];
CanonImage *im;
- fprintf(screenshots_file,
+ fprintf(screenshot_file,
"P6\n"
"%d %d\n"
"255\n", sn->width, sn->height);
((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;
}
/* find the window and check it's on the right kind of screen */
raise_and_get_details();
- wait_for_stability(¤t,0,0);
+ 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 */
set_focus();
- wait_for_stability(¤t,0, send_pgup_many);
+ wait_for_stability(¤t,0, send_pgup_many,
+ "paging up to top of commodity list...");
/* now to actually page down */
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);
+ wait_for_stability(¤t,last, 0,
+ "collecting screenshot of page %d...",
+ npages+1);
+
if (npages && /* first pagedown doesn't do much */
identical(current,last)) {
free_snapshot(¤t);
send_pgdown();
npages++;
}
+ progress("finishing with the YPP client...");
+ send_pgdown_torestore();
+
debugf("PAGING all done.\n");
+ progress_log("collected %d screenshots.",npages);
}
void take_one_screenshot(void) {
raise_and_get_details();
sync_after_input();
- wait_for_stability(¤t,0,0);
+ wait_for_stability(¤t,0,0, "taking screenshot...");
page_images[0]= convert_page(current);
npages= 1;
+ progress_log("collected single screenshot.");
}
void set_yppclient_window(unsigned long wul) {
void find_yppclient_window(void) {
Window root, gotroot, gotparent;
- int screen, r;
+ int screen;
int nfound=0;
if (id) return;
+ progress("looking for YPP client window...");
+
static const char prefix[]= "Puzzle Pirates - ";
static const char onthe[]= " on the ";
static const char suffix[]= " ocean";
#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; screen<ScreenCount(disp); screen++) {
debugfind("FINDYPP screen %d\n", screen);
unsigned int nchildren1;
Window *children1=0;
- r= XQueryTree(disp,root,
+ xassert( XQueryTree(disp,root,
&gotroot,&gotparent,
- &children1,&nchildren1);
- eassert(r);
+ &children1,&nchildren1) );
debugfind("FINDYPP screen %d nchildren1=%d\n", screen, nchildren1);
int i;
unsigned int nchildren2;
Window *children2=0;
- r= XQueryTree(disp,w1,
- &gotroot,&gotparent,
- &children2,&nchildren2);
- eassert(r);
+ xassert( XQueryTree(disp,w1,
+ &gotroot,&gotparent,
+ &children2,&nchildren2) );
debugfind("FINDYPP screen %d c1[%2d]=0x%08lx nchildren2=%d\n",
screen, i, (unsigned long)w1, nchildren2);
unsigned long len, gotbytesafter;
char *title;
unsigned char *gottitle=0;
- r= XGetWindowProperty(disp,w2, wm_name,0,512, False,
- AnyPropertyType,&gottype, &gotfmt, &len,
- &gotbytesafter, &gottitle);
- eassert(!r);
+ xassert( !XGetWindowProperty(disp,w2, wm_name,0,512, False,
+ AnyPropertyType,&gottype, &gotfmt, &len,
+ &gotbytesafter, &gottitle) );
title= (char*)gottitle;
if (DEBUGP(findypp)) {
REQUIRE( !memcmp(spc1, onthe, S(onthe)) );
#define ASSIGN(what, start, end) do { \
- r= asprintf(&what, "%.*s", end - start, start); eassert(r>0); \
+ 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\n",
- (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");
}
~yarrgweb / ypp-sc-tools.db-test.git / blobdiff