chiark / gitweb /
Merge branch 'master' of ijackson@chiark:things/ypp-sc-tools
[ypp-sc-tools.db-test.git] / pctb / pages.c
index cd33cae6df38325cefc3cce5dc125cce5c428653..56fb4092b8e35650586c35a4ffd18c3b400e1f70 100644 (file)
@@ -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 <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"
 
@@ -8,8 +37,13 @@
 #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;
 
@@ -18,6 +52,10 @@ 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)
 
@@ -117,22 +155,49 @@ static void check_not_disturbed(void) {
 }      
 
 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);
@@ -159,7 +224,12 @@ 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,
@@ -258,22 +328,65 @@ static void raise_and_get_details(void) {
     fatal("YPP client window is implausibly small?");
 
   check_client_window_all_on_screen();
+
+  int shm= XShmQueryExtension(disp);
+  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) {
+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);
@@ -283,6 +396,7 @@ static void set_focus(void) {
                        FocusChangeMask
                        ) );
 
+  int xpos,ypos;
   translate_coords_toroot(10,10, &xpos,&ypos);
   XTestFakeMotionEvent(disp,screen, xpos,ypos, 0);
 
@@ -315,11 +429,11 @@ static void compute_shift_mask(ShMask *sm, unsigned long ximage_mask) {
   assert(sm->rshift < LONG_BIT);
 }
 
-static CanonImage *convert_page(Snapshot *sn) {
+static CanonImage *convert_page(Snapshot *sn, RgbImage *ri) {
   ShMask shiftmasks[3];
   CanonImage *im;
 
-  fprintf(screenshots_file,
+  fprintf(screenshot_file,
          "P6\n"
          "%d %d\n"
          "255\n", sn->width, sn->height);
@@ -340,29 +454,50 @@ static CanonImage *convert_page(Snapshot *sn) {
        ((xrgb << shiftmasks[i].lshift)
              >> shiftmasks[i].rshift) & SAMPLEMASK;
       rgb |= sample;
-      fputc(sample, screenshots_file);
+      fputc(sample, screenshot_file);
     }
+    if (ri)
+      CANONIMG_ALSO_STORERGB(ri);
   });
 
-  sysassert(!ferror(screenshots_file));
-  sysassert(!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(&current,0,0, "checking current YPP client screen...");
-  test= convert_page(current);
-  find_structure(test);
+  test= convert_page(current, 0);
+  find_structure(test, &max_relevant_y);
+  check_correct_commodities();
   free(test);
+  free_snapshot(&current);
 
+  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(&current,0, send_pgup_many,
                     "paging up to top of commodity list...");
 
@@ -374,7 +509,7 @@ void take_screenshots(void) {
       fatal("Paging down seems to generate too many pages - max is %d.",
            MAX_PAGES);
     
-    page_images[npages]= convert_page(current);
+    page_images[npages]= convert_page(current, 0);
     free_snapshot(&last); last=current; current=0;
 
     debugf("PAGING page %d converted\n",npages);
@@ -392,17 +527,20 @@ 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);
 }    
 
 void take_one_screenshot(void) {
   Snapshot *current=0;
-  
-  raise_and_get_details();
-  sync_after_input();
+
+  prepare_ypp_client();
   wait_for_stability(&current,0,0, "taking screenshot...");
-  page_images[0]= convert_page(current);
+  page0_rgbimage= alloc_rgb_image(current->width, current->height);
+  page_images[0]= convert_page(current, 0);
   npages= 1;
   progress_log("collected single screenshot.");
 }