2 * general header file for yarrg
5 * This is part of ypp-sc-tools, a set of third-party tools for assisting
6 * players of Yohoho Puzzle Pirates.
8 * Copyright (C) 2009 Ian Jackson <ijackson@chiark.greenend.org.uk>
10 * This program is free software: you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation, either version 3 of the License, or
13 * (at your option) any later version.
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
20 * You should have received a copy of the GNU General Public License
21 * along with this program. If not, see <http://www.gnu.org/licenses/>.
23 * Yohoho and Puzzle Pirates are probably trademarks of Three Rings and
24 * are used without permission. This program is not endorsed or
25 * sponsored by Three Rings.
31 #define DEBUG_FLAG_LIST \
56 /*----- from rgbimage.c -----*/
58 #define MAXIMGIDENT 100
60 typedef uint32_t Rgb; /* red<<0 | green<<8 | blue<<16 */
62 typedef struct RgbImage {
64 Rgb data[]; /* data[ y*w + x ] */
67 void identify_rgbimage(const RgbImage *base, Rect portion,
68 char result[MAXIMGIDENT], const char *what);
69 RgbImage *alloc_rgb_image(int w, int h);
70 void fwrite_ppmraw(FILE *f, const RgbImage *ri);
72 #define RI_PIXEL32(ri,x,y) ((ri)->data + ((y)*(ri)->w + (x)))
74 static inline Rgb ri_rgb(const RgbImage *ri, int x, int y) {
75 return *RI_PIXEL32(ri,x,y);
78 /*----- from structure.c -----*/
80 typedef struct PageStruct PageStruct;
82 void find_structure(const CanonImage *im,
83 PageStruct **pagestruct_r, /* caller must free() */
84 int *max_relevant_y_r,
85 Point *commod_focus_point_r,
86 Point *commod_page_point_r,
87 Point *commod_focuslast_point_r);
88 void store_current_page(CanonImage *ci /*pointer saved*/,
89 PageStruct *pagestruct, /*freed*/
90 RgbImage *rgb /*freed*/);
91 void adjust_colours(CanonImage *ci, const RgbImage *rgb);
93 void select_page(int page);
94 void check_pager_motion(int first, int stop);
96 Rect find_sunshine_widget(void);
98 void canon_colour_prepare(void);
99 void find_islandname(void);
100 void check_correct_commodities(void);
101 void read_screenshots(void);
102 void read_one_screenshot(void);
103 void analyse(FILE *tsv_output);
105 /*----- from convert.c -----*/
107 extern FILE *screenshot_file;
108 void fetch_with_rsync(const char *stem);
109 void fetch_with_rsync_gz(const char *stem);
112 ff_singlepage= 000002,
113 ff_testservers= 000004,
115 ff_charset_edit= 000010,
116 ff_charset_allowedit= 000020,
117 ff_charset_havelocal= 000040,
120 ff_dict_fetch= 000100,
121 ff_dict_submit= 000200,
122 ff_dict_pirate= 000400,
125 ff_needisland= 001000,
126 ff_printisland= 002000,
129 ff_use_yarrg= 010000,
133 ffs_printisland= 003000,
136 extern enum flags o_flags;
139 mf_findwindow= 00001,
140 mf_screenshot= 00010,
141 mf_readscreenshot= 00020,
143 mf_printoceanpirate= 00200,
146 mode_findwindow= 00201,
147 mode_screenshot= 00011,
149 mode_showcharset= 01000,
153 extern enum mode o_mode;
155 extern const char *o_ocean, *o_pirate;
159 #define dbassert(x) ((x) ? (void)0 : dbfile_assertfail(__FILE__,__LINE__,#x))
160 void dbfile_assertfail(const char *file, int line, const char *m) NORET;
163 void dbfile_getsline(char *lbuf, size_t lbufsz, const char *file, int line);
164 int dbfile_open(const char *tpath); /* 0: ENOENT; 1: worked */
165 int dbfile_gzopen(const char *tpath); /* 0: ENOENT; 1: worked */
166 void dbfile_close(void); /* idempotent */
168 int dbfile_scanf(const char *fmt, ...) SCANFMT(1,2);
169 int dbfile_vscanf(const char *fmt, va_list al) SCANFMT(1,0);
171 int gzopen(const char *zpath, int oflags, FILE **f_r, pid_t *pid_r,
172 const char *gziplevel /* 0 for read; may be 0, or "-1" etc. */);
173 /* returns errno value from open */
174 void gzclose(FILE **f, pid_t *p, const char *what);
175 /* also OK with f==0, or p==-1 */
178 const char *get_vardir(void);
179 const char *get_libdir(void);
182 #define EXECLP_HELPER(helper, ...) do{ \
183 char *helper_path= masprintf("%s/%s",get_libdir(),helper); \
184 execlp(helper_path,helper, __VA_ARGS__); \
185 sysassert(errno==ENOENT); \
186 fatal("Failed to find helper program %s.\n" \
187 "(Are you in the correct directory?)", helper); \
191 /*----- from pages.c -----*/
193 void screenshot_startup(void);
194 void set_yppclient_window(unsigned long wul);
195 void find_yppclient_window(void);
196 void take_screenshots(void);
197 void take_one_screenshot(void);
199 #define MAX_PAGES 1000
201 extern const CanonImage *page_images[MAX_PAGES];
202 extern const RgbImage *page0_rgbimage;
205 extern const char *ocean, *pirate;
206 extern char *archipelago, *island;