chiark / gitweb /
Obsidian: Add islands where chart scraper is confused
[ypp-sc-tools.db-test.git] / yarrg / convert.h
1 /*
2  * general header file for yarrg
3  */
4 /*
5  *  This is part of ypp-sc-tools, a set of third-party tools for assisting
6  *  players of Yohoho Puzzle Pirates.
7  * 
8  *  Copyright (C) 2009 Ian Jackson <ijackson@chiark.greenend.org.uk>
9  * 
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.
14  * 
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.
19  * 
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/>.
22  * 
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.
26  */
27
28 #ifndef CONVERT_H
29 #define CONVERT_H
30
31 #define DEBUG_FLAG_LIST                         \
32    DF(findypp)                                  \
33    DF(pages)                                    \
34    DF(keymap)                                   \
35    DF(rect)                                     \
36    DF(pixmap)                                   \
37    DF(struct)                                   \
38    DF(ocr)                                      \
39    DF(rsync)                                    \
40    DF(structcolon)                              \
41    DF(callout)
42
43
44 #include "common.h"
45 #include "ocr.h"
46
47 #include <fnmatch.h>
48 #include <pcre.h>
49 #include <pam.h>
50 #include <time.h>
51 #include <limits.h>
52 #include <ctype.h>
53
54 #include <sys/time.h>
55
56
57 /*----- from rgbimage.c -----*/
58
59 #define MAXIMGIDENT 100
60
61 typedef uint32_t Rgb; /* red<<0 | green<<8 | blue<<16 */
62
63 typedef struct RgbImage {
64   int w, h;
65   Rgb data[]; /* data[ y*w + x ] */
66 } RgbImage;
67
68 void identify_rgbimage(const RgbImage *base, Rect portion,
69                        char result[MAXIMGIDENT], const char *what);
70 RgbImage *alloc_rgb_image(int w, int h);
71 void fwrite_ppmraw(FILE *f, const RgbImage *ri);
72
73 #define RI_PIXEL32(ri,x,y) ((ri)->data + ((y)*(ri)->w + (x)))
74
75 static inline Rgb ri_rgb(const RgbImage *ri, int x, int y) {
76   return *RI_PIXEL32(ri,x,y);
77 }
78
79 /*----- from structure.c -----*/
80
81 typedef struct PageStruct PageStruct;
82
83 void find_structure(const CanonImage *im,
84                     PageStruct **pagestruct_r, /* caller must free() */
85                     int *max_relevant_y_r,
86                     Point *commod_focus_point_r,
87                     Point *commod_page_point_r,
88                     Point *commod_focuslast_point_r);
89 void store_current_page(CanonImage *ci /*pointer saved*/,
90                         PageStruct *pagestruct, /*freed*/
91                         RgbImage *rgb /*freed*/);
92 void adjust_colours(CanonImage *ci, const RgbImage *rgb);
93
94 void select_page(int page);
95 void check_pager_motion(int first, int stop);
96
97 Rect find_sunshine_widget(void);
98
99 void canon_colour_prepare(void);
100 void find_islandname(void);
101 void check_correct_commodities(void);
102 void read_screenshots(void);
103 void read_one_screenshot(void);
104 void analyse(FILE *tsv_output);
105
106 /*----- from convert.c -----*/
107
108 extern FILE *screenshot_file;
109 void fetch_with_rsync(const char *stem);
110 void fetch_with_rsync_gz(const char *stem);
111
112 enum flags {
113   ff_singlepage=          000002,
114   ff_testservers=         000004,
115
116   ff_charset_edit=        000010,
117   ff_charset_allowedit=   000020,
118   ff_charset_havelocal=   000040,
119   ffm_charset=            000070,
120   
121   ff_dict_fetch=          000100,
122   ff_dict_submit=         000200,
123   ff_dict_pirate=         000400,
124   ffs_dict=               000700,
125
126   ff_needisland=          001000,
127   ff_printisland=         002000,
128   ff_upload=              004000,
129   
130   ff_use_yarrg=           010000,
131   ff_use_pctb=            020000,
132   ffm_use=                070000,
133   
134   ffs_printisland=        003000,
135   ffs_upload=             005000,
136 };
137 extern enum flags o_flags;
138
139 enum mode {
140   mf_findwindow=        00001,
141   mf_screenshot=        00010,
142   mf_readscreenshot=    00020,
143   mf_analyse=           00100,
144   mf_printoceanpirate=  00200,
145   mfm_special=          07000,
146   
147   mode_findwindow=      00201,
148   mode_screenshot=      00011,
149   mode_analyse=         00120,
150   mode_showcharset=     01000,
151
152   mode_all=           00111,
153 };
154 extern enum mode o_mode;
155
156 extern const char *o_ocean, *o_pirate;
157 extern int o_quiet;
158
159
160 #define dbassert(x) ((x) ? (void)0 : dbfile_assertfail(__FILE__,__LINE__,#x))
161 void dbfile_assertfail(const char *file, int line, const char *m) NORET;
162
163 FILE *dbfile;
164 void dbfile_getsline(char *lbuf, size_t lbufsz, const char *file, int line);
165 int dbfile_open(const char *tpath);   /* 0: ENOENT; 1: worked */
166 int dbfile_gzopen(const char *tpath); /* 0: ENOENT; 1: worked */
167 void dbfile_close(void); /* idempotent */
168
169 int dbfile_scanf(const char *fmt, ...) SCANFMT(1,2);
170 int dbfile_vscanf(const char *fmt, va_list al) SCANFMT(1,0);
171
172 int gzopen(const char *zpath, int oflags, FILE **f_r, pid_t *pid_r,
173            const char *gziplevel /* 0 for read; may be 0, or "-1" etc. */);
174   /* returns errno value from open */
175 void gzclose(FILE **f, pid_t *p, const char *what);
176   /* also OK with f==0, or p==-1 */
177
178
179 const char *get_vardir(void);
180 const char *get_libdir(void);
181
182
183 #define EXECLP_HELPER(helper, ...) do{                          \
184     char *helper_path= masprintf("%s/%s",get_libdir(),helper);  \
185     execlp(helper_path,helper, __VA_ARGS__);                    \
186     sysassert(errno==ENOENT);                                   \
187     fatal("Failed to find helper program %s.\n"                 \
188           "(Are you in the correct directory?)", helper);       \
189   }while(0)
190
191
192 /*----- from pages.c -----*/
193
194 void screenshot_startup(void);
195 void set_yppclient_window(unsigned long wul);
196 void find_yppclient_window(void);
197 void take_screenshots(void);
198 void take_one_screenshot(void);
199
200 #define MAX_PAGES 1000
201
202 extern const CanonImage *page_images[MAX_PAGES];
203 extern const RgbImage *page0_rgbimage;
204 extern int npages;
205
206 extern const char *ocean, *pirate;
207 extern char *archipelago, *island;
208
209 #endif /*CONVERT_H*/