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