chiark / gitweb /
panner.tcl: copyright notice
[ypp-sc-tools.db-live.git] / yarrg / 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 <stddef.h>
43 #include <unistd.h>
44 #include <dirent.h>
45 #include <inttypes.h>
46
47 #include <fcntl.h>
48 #include <unistd.h>
49 #include <sys/wait.h>
50 #include <sys/types.h>
51
52 typedef struct {
53   int w,h;
54   char d[];
55 } CanonImage;
56
57
58 /*----- debugging arrangements, rather contingent -----*/
59
60 typedef struct {
61   int x, y;
62 } Point;
63
64 typedef struct { /* both inclusive */
65   Point tl;
66   Point br;
67 } Rect;
68
69 #define RECT_W(r) ((r).br.x - (r).tl.x + 1)
70 #define RECT_H(r) ((r).br.y - (r).tl.y + 1)
71
72 #ifdef DEBUG_FLAG_LIST
73 enum {
74 #define DF(f) dbg__shift_##f,
75   DEBUG_FLAG_LIST
76 #undef DF
77 };
78 enum {
79 #define DF(f) dbg_##f = 1 << dbg__shift_##f,
80   DEBUG_FLAG_LIST
81 #undef DF
82 };
83 #define DEBUGP(f) (!!(debug_flags & dbg_##f))
84
85 #endif /*DEBUG_FLAG_LIST*/
86
87 #ifndef debug_flags
88 extern unsigned debug_flags;
89 #endif
90
91 void debug_flush(void);
92 #ifndef debug
93 # define debug stderr
94 #endif
95
96 #define FMT(f,a) __attribute__((format(printf,f,a)))
97 #define SCANFMT(f,a) __attribute__((format(scanf,f,a)))
98 #define NORET __attribute__((noreturn))
99
100 #define DEFINE_VWRAPPERF(decls, funcf, otherattribs)                    \
101   decls void funcf(const char *fmt, ...) FMT(1,2) otherattribs;         \
102   decls void funcf(const char *fmt, ...) {                              \
103     va_list al;  va_start(al,fmt);  v##funcf(fmt,al);  va_end(al);      \
104   }
105
106 #define DEBUG_DEFINE_SOME_DEBUGF(fl,funcf)                              \
107   static void v##funcf(const char *fmt, va_list al) {                   \
108     if (DEBUGP(fl))                                                     \
109       vfprintf(debug,fmt,al);                                           \
110   }                                                                     \
111   DEFINE_VWRAPPERF(static, funcf, )
112
113 #define DEBUG_DEFINE_DEBUGF(fl) DEBUG_DEFINE_SOME_DEBUGF(fl,debugf)
114
115
116 /*---------- error handling ----------*/
117
118 extern int o_quiet;
119
120 void vwarning(const char *fmt, va_list) FMT(1,0);
121 void warning(const char *fmt, ...)      FMT(1,2);
122
123 void vprogress(const char *fmt, va_list) FMT(1,0);
124 void progress(const char *fmt, ...)      FMT(1,2);
125
126 void vprogress_log(const char *fmt, va_list) FMT(1,0);
127 void progress_log(const char *fmt, ...)      FMT(1,2);
128
129 void vprogress_spinner(const char *fmt, va_list) FMT(1,0);
130 void progress_spinner(const char *fmt, ...)      FMT(1,2);
131
132 void vfatal(const char *fmt, va_list)  FMT(1,0) NORET;
133 void fatal(const char *fmt, ...)       FMT(1,2) NORET;
134
135 #define sysassert(what) \
136   ((what) ? (void)0 : sysassert_fail(__FILE__, __LINE__, #what))
137
138 void sysassert_fail(const char *file, int line, const char *what)
139    __attribute__((noreturn));
140
141 void waitpid_check_exitstatus(pid_t pid, const char *what, int sigpipeok);
142
143
144 void *mmalloc(size_t sz);
145 void *mcalloc(size_t sz);
146 void *mrealloc(void *p, size_t sz);
147
148 char *masprintf(const char *fmt, ...) FMT(1,2);
149
150
151 #define ARRAYSIZE(a) ((sizeof((a)) / sizeof((a)[0])))
152 #define FILLZERO(obj) (memset(&(obj),0,sizeof((obj))))
153
154 #define STRING2(x) #x
155 #define STRING(x) STRING2(x)
156
157 #endif /*COMMON_H*/