/*
- */
+ * 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"
#include <X11/keysym.h>
#include <X11/Xutil.h>
+#include <X11/extensions/XShm.h>
+#include <sys/ipc.h>
+#include <sys/shm.h>
+
CanonImage *page_images[MAX_PAGES];
int npages;
+RgbImage *page0_rgbimage;
-char *ocean, *pirate;
+const char *ocean, *pirate;
static XWindowAttributes attr;
static Window id;
static Display *disp;
static struct timeval tv_startup;
static unsigned wwidth, wheight;
+static int max_relevant_y= -1;
+
+static XImage *shmim;
+static XShmSegmentInfo shminfo;
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 ----------*/
-typedef XImage Snapshot;
+typedef RgbImage Snapshot;
static double last_input;
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<rwidth && rypos<rheight);
+ 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) {
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);
}
}
}
static void send_key(KeySym sym) {
+ check_not_disturbed();
XTestFakeKeyEvent(disp, keycode(sym),1, 10);
XTestFakeKeyEvent(disp, keycode(sym),0, 10);
}
+static void mouse_1_updown_here(void) {
+ check_not_disturbed();
+ XTestFakeButtonEvent(disp,1,1, 50);
+ XTestFakeButtonEvent(disp,1,0, 50);
+}
+static void mouse_1_updown(int x, int y) {
+ check_not_disturbed();
+ int screen= XScreenNumberOfScreen(attr.screen);
+ int xpos, ypos;
+ translate_coords_toroot(x,y, &xpos,&ypos);
+ XTestFakeMotionEvent(disp, screen, xpos,ypos, 0);
+ mouse_1_updown_here();
+}
+
+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);
+ free(*io);
*io= 0;
}
+#define SAMPLEMASK 0xfful
+
+typedef struct {
+ int lshift, rshift;
+} ShMask;
+
+static void compute_shift_mask(ShMask *sm, unsigned long ximage_mask) {
+ sm->lshift= 0;
+ sm->rshift= 0;
+
+ for (;;) {
+ if (ximage_mask <= (SAMPLEMASK>>1)) {
+ sm->lshift++; ximage_mask <<= 1;
+ } else if (ximage_mask > SAMPLEMASK) {
+ sm->rshift++; ximage_mask >>= 1;
+ } else {
+ break;
+ }
+ assert(!(sm->lshift && sm->rshift));
+ }
+ assert(sm->lshift < LONG_BIT);
+ assert(sm->rshift < LONG_BIT);
+}
+
+static void rtimestamp(double *t, const char *wh) {
+ double n= timestamp();
+ debugf("PAGING INTERVAL %f %s\n", n-*t, wh);
+ *t= n;
+}
+
static void snapshot(Snapshot **output) {
- free_snapshot(output);
+ XImage *im_use, *im_free=0;
+
+ ShMask shiftmasks[3];
debugf("PAGING snapshot\n");
- timestamp();
- *output= XGetImage(disp,id, 0,0, wwidth,wheight, AllPlanes, ZPixmap);
- timestamp();
+ double begin= timestamp();
+ if (shmim) {
+ xassert( XShmGetImage(disp,id,shmim, 0,0, AllPlanes) );
+ rtimestamp(&begin, "XShmGetImage");
+
+ size_t dsz= shmim->bytes_per_line * shmim->height;
+ im_use= im_free= mmalloc(sizeof(*im_use) + dsz);
+ *im_free= *shmim;
+ im_free->data= (void*)(im_free+1);
+ memcpy(im_free->data, shmim->data, dsz);
+ rtimestamp(&begin, "mmalloc/memcpy");
+ } else {
+ xassert( im_use= im_free=
+ XGetImage(disp,id, 0,0, wwidth,wheight, AllPlanes, ZPixmap) );
+ rtimestamp(&begin, "XGetImage");
+ }
+#define COMPUTE_SHIFT_MASK(ix, rgb) \
+ compute_shift_mask(&shiftmasks[ix], im_use->rgb##_mask)
+ COMPUTE_SHIFT_MASK(0, red);
+ COMPUTE_SHIFT_MASK(1, green);
+ COMPUTE_SHIFT_MASK(2, blue);
+
+ if (!*output)
+ *output= alloc_rgb_image(wwidth, wheight);
+
+ rtimestamp(&begin, "compute_shift_masks+alloc_rgb_image");
+
+ int x,y,i;
+ unsigned char *op= (*output)->data;
+ for (y=0; y<wheight; y++) {
+ for (x=0; x<wwidth; x++) {
+ long xrgb= XGetPixel(im_use,x,y);
+ for (i=0; i<3; i++) {
+ unsigned long sample=
+ ((xrgb << shiftmasks[i].lshift) >> shiftmasks[i].rshift)
+ & SAMPLEMASK;
+ *op++= sample;
+ }
+ }
+ }
+
+ rtimestamp(&begin,"w*h*XGetPixel");
+ if (im_free)
+ XDestroyImage(im_free);
+
+ rtimestamp(&begin,"XDestroyImage");
check_not_disturbed();
debugf("PAGING snapshot done.\n");
}
static int identical(const Snapshot *a, const Snapshot *b) {
- if (!(a->width == b->width &&
- a->height == b->height &&
- a->bytes_per_line == b->bytes_per_line &&
- a->format == b->format))
+ if (!(a->w == b->w &&
+ a->h == b->h))
return 0;
- return !memcmp(a->data, b->data, a->bytes_per_line * a->height);
+
+ int compare_to= a->h;
+ if (max_relevant_y && compare_to > max_relevant_y)
+ compare_to= max_relevant_y;
+
+ return !memcmp(a->data, b->data, a->w * 3 * compare_to);
}
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 */
last_input, previously);
char *doing;
- r= vasprintf(&doing,fmt,al); eassert(r>=0);
+ sysassert( vasprintf(&doing,fmt,al) >=0);
progress("%s",doing);
}
static void raise_and_get_details(void) {
- int r;
int evbase,errbase,majver,minver;
int wxpos, wypos;
unsigned bd,depth;
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();
+
+ int shm= XShmQueryExtension(disp);
+ shm=0;
+ if (shm) {
+ xassert( shmim= XShmCreateImage(disp, attr.visual, attr.depth, ZPixmap,
+ 0,&shminfo, wwidth,wheight) );
+
+ sigset_t oldset, all;
+ sigfillset(&all);
+ sysassert(! sigprocmask(SIG_BLOCK,&all,&oldset) );
+
+ int pfd[2];
+ pid_t cleaner;
+ sysassert(! pipe(pfd) );
+ sysassert( (cleaner= fork()) != -1 );
+ if (!cleaner) {
+ sysassert(! close(pfd[1]) );
+ for (;;) {
+ int r= read(pfd[0], &shminfo.shmid, sizeof(shminfo.shmid));
+ if (!r) exit(0);
+ if (r==sizeof(shminfo.shmid)) break;
+ assert(r==-1 && errno==EINTR);
+ }
+ for (;;) {
+ char bc;
+ int r= read(pfd[0],&bc,1);
+ if (r>=0) break;
+ assert(r==-1 && errno==EINTR);
+ }
+ sysassert(! shmctl(shminfo.shmid,IPC_RMID,0) );
+ exit(0);
+ }
+ sysassert(! close(pfd[0]) );
+
+ sysassert(! sigprocmask(SIG_SETMASK,&oldset,0) );
+
+ assert(shmim->height == wheight);
+ sysassert( (shminfo.shmid=
+ shmget(IPC_PRIVATE, shmim->bytes_per_line * wheight,
+ IPC_CREAT|0600)) >= 0 );
+
+ sysassert( write(pfd[1],&shminfo.shmid,sizeof(shminfo.shmid)) ==
+ sizeof(shminfo.shmid) );
+ sysassert( shminfo.shmaddr= shmat(shminfo.shmid,0,0) );
+ shmim->data= shminfo.shmaddr;
+ shminfo.readOnly= False;
+ xassert( XShmAttach(disp,&shminfo) );
+
+ close(pfd[1]); /* causes IPC_RMID */
+ }
}
-static void set_focus(void) {
- int r;
+static void set_focus_commodity(void) {
int screen= XScreenNumberOfScreen(attr.screen);
progress("taking control of YPP client window...");
debugf("PAGING set_focus\n");
- int xpos, ypos;
- translate_coords_toroot(160,160, &xpos,&ypos);
- XTestFakeMotionEvent(disp,screen, xpos,ypos, 0);
-
- XTestFakeButtonEvent(disp,1,1, 50);
- XTestFakeButtonEvent(disp,1,0, 50);
-
+ mouse_1_updown(160,160);
sync_after_input();
delay(0.5);
- r= XSelectInput(disp, id,
- StructureNotifyMask|
- VisibilityChangeMask|
- FocusChangeMask
- ); eassert(r);
+ xassert( XSelectInput(disp, id,
+ StructureNotifyMask|
+ VisibilityChangeMask|
+ FocusChangeMask
+ ) );
+ int xpos,ypos;
translate_coords_toroot(10,10, &xpos,&ypos);
XTestFakeMotionEvent(disp,screen, xpos,ypos, 0);
debugf("PAGING raise_and_set_focus done.\n");
}
-#define SAMPLEMASK 0xfful
-
-typedef struct {
- int lshift, rshift;
-} ShMask;
-
-static void compute_shift_mask(ShMask *sm, unsigned long ximage_mask) {
- sm->lshift= 0;
- sm->rshift= 0;
-
- for (;;) {
- if (ximage_mask <= (SAMPLEMASK>>1)) {
- sm->lshift++; ximage_mask <<= 1;
- } else if (ximage_mask > SAMPLEMASK) {
- sm->rshift++; ximage_mask >>= 1;
- } else {
- break;
- }
- assert(!(sm->lshift && sm->rshift));
- }
- assert(sm->lshift < LONG_BIT);
- assert(sm->rshift < LONG_BIT);
-}
-
-static CanonImage *convert_page(Snapshot *sn) {
- ShMask shiftmasks[3];
+static CanonImage *convert_page(Snapshot *sn, RgbImage *ri) {
CanonImage *im;
- fprintf(screenshots_file,
+ fprintf(screenshot_file,
"P6\n"
"%d %d\n"
- "255\n", sn->width, sn->height);
-
-#define COMPUTE_SHIFT_MASK(ix, rgb) \
- compute_shift_mask(&shiftmasks[ix], sn->rgb##_mask)
- COMPUTE_SHIFT_MASK(0, red);
- COMPUTE_SHIFT_MASK(1, green);
- COMPUTE_SHIFT_MASK(2, blue);
+ "255\n", sn->w, sn->h);
- CANONICALISE_IMAGE(im, sn->width, sn->height, {
- long xrgb= XGetPixel(sn, x, y);
+ CANONICALISE_IMAGE(im, sn->w, sn->h, {
int i;
rgb= 0;
for (i=0; i<3; i++) {
rgb <<= 8;
- unsigned long sample=
- ((xrgb << shiftmasks[i].lshift)
- >> shiftmasks[i].rshift) & SAMPLEMASK;
+ unsigned long sample= RI_PIXEL(sn,x,y)[i];
rgb |= sample;
- fputc(sample, screenshots_file);
+ fputc(sample, screenshot_file);
}
+ if (ri)
+ CANONIMG_ALSO_STORERGB(ri);
});
- eassert(!fflush(screenshots_file));
+ sysassert(!ferror(screenshot_file));
+ sysassert(!fflush(screenshot_file));
return im;
}
-void take_screenshots(void) {
- Snapshot *current=0, *last=0;
+static void prepare_ypp_client(void) {
CanonImage *test;
-
+ Snapshot *current=0;
+
/* find the window and check it's on the right kind of screen */
raise_and_get_details();
wait_for_stability(¤t,0,0, "checking current YPP client screen...");
- test= convert_page(current);
- find_structure(test);
+
+#if 1
+timestamp();
+snapshot(¤t);
+snapshot(¤t);
+snapshot(¤t);
+snapshot(¤t);
+snapshot(¤t);
+snapshot(¤t);
+snapshot(¤t);
+snapshot(¤t);
+snapshot(¤t);
+snapshot(¤t);
+timestamp();
+#endif
+
+ test= convert_page(current, 0);
+ find_structure(test, &max_relevant_y);
+ check_correct_commodities();
free(test);
+ free_snapshot(¤t);
+ progress("requesting status information...");
+ mouse_1_updown(250, wheight-10);
+ mouse_1_updown_here();
+ mouse_1_updown_here();
+ XSync(disp,False);
+ check_not_disturbed();
+ send_key(XK_slash);
+ send_key(XK_w);
+ send_key(XK_Return);
+ sync_after_input();
+}
+
+void take_screenshots(void) {
+ Snapshot *current=0, *last=0;
+
+ prepare_ypp_client();
+
/* page to the top - keep pressing page up until the image stops changing */
- set_focus();
+ set_focus_commodity();
wait_for_stability(¤t,0, send_pgup_many,
"paging up to top of commodity list...");
for (;;) {
debugf("paging page %d\n",npages);
- eassert(npages < MAX_PAGES);
- page_images[npages]= convert_page(current);
+ if (!(npages < MAX_PAGES))
+ fatal("Paging down seems to generate too many pages - max is %d.",
+ MAX_PAGES);
+
+ page_images[npages]= convert_page(current, 0);
free_snapshot(&last); last=current; current=0;
debugf("PAGING page %d converted\n",npages);
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) {
Snapshot *current=0;
-
- raise_and_get_details();
- sync_after_input();
+
+ prepare_ypp_client();
wait_for_stability(¤t,0,0, "taking screenshot...");
- page_images[0]= convert_page(current);
+ page0_rgbimage= alloc_rgb_image(current->w, current->h);
+ page_images[0]= convert_page(current, 0);
npages= 1;
progress_log("collected single screenshot.");
}
void find_yppclient_window(void) {
Window root, gotroot, gotparent;
- int screen, r;
+ int screen;
int nfound=0;
if (id) return;
#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(title + len - S(suffix), suffix, S(suffix)) );
REQUIRE( !memcmp(spc1, onthe, S(onthe)) );
-#define ASSIGN(what, start, end) do { \
- r= asprintf(&what, "%.*s", (end)-(start), start); eassert(r>0); \
- }while(0)
- ASSIGN(pirate, title + S(prefix), spc1);
+#define ASSIGN(what, start, end) \
+ what= masprintf("%.*s", (end)-(start), start); \
+ if (o_##what) REQUIRE( !strcmp(o_##what, what) ); \
+ else
+
ASSIGN(ocean, spc1 + S(onthe), (title + len) - S(suffix));
+ ASSIGN(pirate, title + S(prefix), spc1);
debugfind(" YES!\n");
id= w2;
nfound++;
- progress_log("found YPP client [--window-id 0x%lx]:"
+ progress_log("found YPP client (0x%lx):"
" %s ocean - %s.",
(unsigned long)id, ocean, pirate);
}
}
if (children1) XFree(children1);
}
- eassert(nfound==1);
+ if (nfound>1)
+ fatal("Found several possible YPP clients."
+ " Close one, or specify the windowid with --window-id.\n");
+ if (nfound<1)
+ fatal("Did not find %sYPP client."
+ " Use --window-id and/or report this as a fault.\n",
+ o_ocean || o_pirate ? "matching ": "");
}