chiark / gitweb /
5044bb35ee8015a3e109b71a1c2b167fbcfac2c6
[ypp-sc-tools.db-live.git] / pctb / common.h
1 /*
2  * useful common stuff, mostly error handling and debugging
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 COMMON_H
29 #define COMMON_H
30
31 #define _GNU_SOURCE
32
33 #include <locale.h>
34 #include <stdarg.h>
35 #include <math.h>
36 #include <stdio.h>
37 #include <errno.h>
38 #include <assert.h>
39 #include <string.h>
40 #include <stdint.h>
41 #include <stdlib.h>
42 #include <unistd.h>
43 #include <dirent.h>
44 #include <pcre.h>
45 #include <inttypes.h>
46
47 #include <sys/wait.h>
48 #include <sys/types.h>
49
50 typedef struct {
51   int w,h;
52   struct RgbImage *rgb;
53   char d[];
54 } CanonImage;
55
56
57 /*----- debugging arrangements, rather contingent -----*/
58
59 typedef struct {
60   int x, y;
61 } Point;
62
63 typedef struct { /* both inclusive */
64   Point tl;
65   Point br;
66 } Rect;
67
68 #define RECT_W(r) ((r).br.x - (r).tl.x + 1)
69 #define RECT_H(r) ((r).br.y - (r).tl.y + 1)
70
71
72
73 #define DEBUG_FLAG_LIST                         \
74    DF(findypp)                                  \
75    DF(pages)                                    \
76    DF(rect)                                     \
77    DF(pixmap)                                   \
78    DF(struct)                                   \
79    DF(ocr)                                      \
80    DF(rsync)                                    \
81    DF(structcolon)                              \
82    DF(callout)
83
84 enum {
85 #define DF(f) dbg__shift_##f,
86   DEBUG_FLAG_LIST
87 #undef DF
88 };
89 enum {
90 #define DF(f) dbg_##f = 1 << dbg__shift_##f,
91   DEBUG_FLAG_LIST
92 #undef DF
93 };
94
95 unsigned debug_flags;
96
97 #define DEBUGP(f) (!!(debug_flags & dbg_##f))
98
99 void debug_flush(void);
100 #define debug stderr
101
102 const char *get_vardir(void);
103 const char *get_libdir(void);
104
105 #define FMT(f,a) __attribute__((format(printf,f,a)))
106 #define SCANFMT(f,a) __attribute__((format(scanf,f,a)))
107 #define NORET __attribute__((noreturn))
108
109 #define DEFINE_VWRAPPERF(decls, funcf, otherattribs)                    \
110   decls void funcf(const char *fmt, ...) FMT(1,2) otherattribs;         \
111   decls void funcf(const char *fmt, ...) {                              \
112     va_list al;  va_start(al,fmt);  v##funcf(fmt,al);  va_end(al);      \
113   }
114
115 #define DEBUG_DEFINE_SOME_DEBUGF(fl,funcf)                              \
116   static void v##funcf(const char *fmt, va_list al) {                   \
117     if (DEBUGP(fl))                                                     \
118       vfprintf(debug,fmt,al);                                           \
119   }                                                                     \
120   DEFINE_VWRAPPERF(static, funcf, )
121
122 #define DEBUG_DEFINE_DEBUGF(fl) DEBUG_DEFINE_SOME_DEBUGF(fl,debugf)
123
124
125 /*---------- error handling ----------*/
126
127 void vfatal(const char *fmt, va_list)  FMT(1,0) NORET;
128 void fatal(const char *fmt, ...)       FMT(1,2) NORET;
129
130 #define sysassert(what) \
131   ((what) ? (void)0 : sysassert_fail(__FILE__, __LINE__, #what))
132
133 void sysassert_fail(const char *file, int line, const char *what)
134    __attribute__((noreturn));
135
136 void waitpid_check_exitstatus(pid_t pid, const char *what);
137
138
139 void *mmalloc(size_t sz);
140 void *mrealloc(void *p, size_t sz);
141
142
143 #define dbassert(x) ((x) ? (void)0 : dbfile_assertfail(__FILE__,__LINE__,#x))
144 void dbfile_assertfail(const char *file, int line, const char *m) NORET;
145
146 FILE *dbfile;
147 void dbfile_getsline(char *lbuf, size_t lbufsz, const char *file, int line);
148 int dbfile_open(const char *tpath); /* 0: ENOENT; 1: worked */
149 void dbfile_close(void); /* idempotent */
150
151 int dbfile_scanf(const char *fmt, ...) SCANFMT(1,2);
152 int dbfile_vscanf(const char *fmt, va_list al) SCANFMT(1,0);
153
154
155 char *masprintf(const char *fmt, ...) FMT(1,2);
156
157 #define EXECLP_HELPER(helper, ...) do{                          \
158     char *helper_path= masprintf("%s/%s",get_libdir(),helper);  \
159     execlp(helper_path,helper, __VA_ARGS__);                    \
160     sysassert(errno==ENOENT);                                   \
161     fatal("Failed to find helper program %s.\n"                 \
162           "(Are you in the correct directory?)", helper);       \
163   }while(0)
164
165
166 #define ARRAYSIZE(a) ((sizeof((a)) / sizeof((a)[0])))
167 #define FILLZERO(obj) (memset(&(obj),0,sizeof((obj))))
168
169 #define STRING(x) #x
170
171 #endif /*COMMON_H*/