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