[421b7d2] | 1 | /* useful.h |
---|
[d1b1380] | 2 | * Lots of oddments that come in handy generally |
---|
[a4454620] | 3 | * Copyright (C) 1993-2003,2004,2010,2011,2014 Olly Betts |
---|
[846746e] | 4 | * |
---|
[89231c4] | 5 | * This program is free software; you can redistribute it and/or modify |
---|
| 6 | * it under the terms of the GNU General Public License as published by |
---|
| 7 | * the Free Software Foundation; either version 2 of the License, or |
---|
| 8 | * (at your option) any later version. |
---|
[846746e] | 9 | * |
---|
| 10 | * This program is distributed in the hope that it will be useful, |
---|
| 11 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
---|
[89231c4] | 12 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
---|
| 13 | * GNU General Public License for more details. |
---|
[846746e] | 14 | * |
---|
[89231c4] | 15 | * You should have received a copy of the GNU General Public License |
---|
| 16 | * along with this program; if not, write to the Free Software |
---|
[ecbc6c18] | 17 | * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA |
---|
[d1b1380] | 18 | */ |
---|
| 19 | |
---|
| 20 | /* only include once */ |
---|
| 21 | #ifndef USEFUL_H |
---|
| 22 | #define USEFUL_H |
---|
| 23 | |
---|
[04078a7] | 24 | #ifndef PACKAGE |
---|
| 25 | # error config.h must be included first in each C/C++ source file |
---|
| 26 | #endif |
---|
[fa42426] | 27 | |
---|
[5b894c3] | 28 | #include <stdint.h> |
---|
[d1b1380] | 29 | #include <stdlib.h> /* for Borland C which #defines max() & min() there */ |
---|
| 30 | #include <stdio.h> |
---|
| 31 | #include <math.h> |
---|
| 32 | #include "osalloc.h" |
---|
| 33 | |
---|
| 34 | /* Macro to allow easy building of macros contain multiple statements, such |
---|
[0804fbe] | 35 | * that the likes of “if (x == y) macro1(x); else x = 2;” works properly */ |
---|
[a420b49] | 36 | #define BLK(X) do {X} while(0) |
---|
[d1b1380] | 37 | |
---|
| 38 | /* Macro to do nothing, but avoid compiler warnings about empty if bodies &c */ |
---|
| 39 | #define NOP (void)0 |
---|
| 40 | |
---|
[0580c6a] | 41 | /* In C++ code, #include<algorithm> and use std::max and std::min instead. */ |
---|
| 42 | #ifndef __cplusplus |
---|
| 43 | /* Return max/min of two numbers. */ |
---|
| 44 | /* May be defined already (e.g. by Borland C in stdlib.h) */ |
---|
[d1b1380] | 45 | /* NB Bad news if X or Y has side-effects... */ |
---|
[0580c6a] | 46 | # ifndef max |
---|
| 47 | # define max(X, Y) ((X) > (Y) ? (X) : (Y)) |
---|
| 48 | # endif |
---|
| 49 | # ifndef min |
---|
| 50 | # define min(X, Y) ((X) < (Y) ? (X) : (Y)) |
---|
| 51 | # endif |
---|
[a420b49] | 52 | #endif |
---|
[d1b1380] | 53 | |
---|
[1ec8db0] | 54 | /* M_PI, etc may be defined in math.h */ |
---|
[bca0071] | 55 | #ifndef M_PI |
---|
| 56 | # ifdef PI /* MSVC defines PI IIRC */ |
---|
| 57 | # define M_PI PI |
---|
[d1b1380] | 58 | # else |
---|
[bca0071] | 59 | # define M_PI 3.14159265358979323846264338327950288419716939937510582097494459 |
---|
[d1b1380] | 60 | # endif |
---|
[bca0071] | 61 | #endif |
---|
[bceebf4] | 62 | #ifndef M_PI_2 |
---|
| 63 | # define M_PI_2 (M_PI / 2.0) |
---|
| 64 | #endif |
---|
| 65 | #ifndef M_PI_4 |
---|
| 66 | # define M_PI_4 (M_PI / 4.0) |
---|
| 67 | #endif |
---|
[d1b1380] | 68 | |
---|
[a420b49] | 69 | #define MM_PER_INCH 25.4 /* exact value */ |
---|
[d1b1380] | 70 | #define METRES_PER_FOOT 0.3048 /* exact value */ |
---|
| 71 | |
---|
| 72 | #define putnl() putchar('\n') /* print a newline char */ |
---|
[e02a6a6] | 73 | #define fputnl(FH) PUTC('\n', (FH)) /* print a newline char to a file */ |
---|
[d1b1380] | 74 | /* print a line followed by a newline char to a file */ |
---|
[e02a6a6] | 75 | #define fputsnl(SZ, FH) BLK(fputs((SZ), (FH)); PUTC('\n', (FH));) |
---|
[a420b49] | 76 | #define sqrd(X) ((X) * (X)) /* macro to square things */ |
---|
[27b8b59] | 77 | |
---|
| 78 | /* 2D Euclidean distance */ |
---|
| 79 | #ifndef HAVE_HYPOT |
---|
| 80 | # define hypot(X, Y) sqrt(sqrd((double)(X)) + sqrd((double)(Y))) |
---|
| 81 | #endif |
---|
[bca0071] | 82 | #define rad(X) ((M_PI / 180.0) * (X)) /* convert from degrees to radians */ |
---|
| 83 | #define deg(X) ((180.0 / M_PI) * (X)) /* convert from radians to degrees */ |
---|
[d1b1380] | 84 | |
---|
[bd1913f] | 85 | /* macro to convert argument to a string literal */ |
---|
[fa42426] | 86 | #define STRING(X) STRING_(X) |
---|
| 87 | #define STRING_(X) #X |
---|
[d1b1380] | 88 | |
---|
[7dbc68f] | 89 | #include "osdepend.h" |
---|
| 90 | |
---|
[c0563da] | 91 | #ifndef WORDS_BIGENDIAN |
---|
[8c45eea] | 92 | # define put16(W, FH) BLK(int16_t w = (W); fwrite(&w, 2, 1, (FH));) |
---|
| 93 | # define put32(W, FH) BLK(int32_t w = (W); fwrite(&w, 4, 1, (FH));) |
---|
[5dd874a] | 94 | |
---|
[d9434a0] | 95 | # ifdef __GNUC__ |
---|
| 96 | __attribute__((unused)) |
---|
| 97 | # endif |
---|
[5dd874a] | 98 | static inline int16_t get16(FILE *fh) { |
---|
| 99 | int16_t w; |
---|
[a4454620] | 100 | if (fread(&w, 2, 1, fh) == 0) { |
---|
| 101 | /* We check feof() and ferror() afterwards, so checking the return |
---|
| 102 | * value achieves nothing, but we get a warning from glibc's |
---|
| 103 | * _FORTIFY_SOURCE if we don't pretend to. */ |
---|
| 104 | } |
---|
[5dd874a] | 105 | return w; |
---|
| 106 | } |
---|
| 107 | |
---|
[d9434a0] | 108 | # ifdef __GNUC__ |
---|
| 109 | __attribute__((unused)) |
---|
| 110 | # endif |
---|
[5dd874a] | 111 | static inline int32_t get32(FILE *fh) { |
---|
| 112 | int32_t w; |
---|
[a4454620] | 113 | if (fread(&w, 4, 1, fh) == 0) { |
---|
| 114 | /* We check feof() and ferror() afterwards, so checking the return |
---|
| 115 | * value achieves nothing, but we get a warning from glibc's |
---|
| 116 | * _FORTIFY_SOURCE if we don't pretend to. */ |
---|
| 117 | } |
---|
[5dd874a] | 118 | return w; |
---|
| 119 | } |
---|
[c0563da] | 120 | #else |
---|
[9965b2b] | 121 | void useful_put16(int16_t, FILE *); |
---|
| 122 | void useful_put32(int32_t, FILE *); |
---|
| 123 | int16_t useful_get16(FILE *); |
---|
| 124 | int32_t useful_get32(FILE *); |
---|
[d1b1380] | 125 | |
---|
[c0563da] | 126 | # define put16(W, FH) useful_put16(W, FH) |
---|
| 127 | # define put32(W, FH) useful_put32(W, FH) |
---|
| 128 | # define get16(FH) useful_get16(FH) |
---|
| 129 | # define get32(FH) useful_get32(FH) |
---|
[d1b1380] | 130 | #endif |
---|
| 131 | |
---|
| 132 | #endif /* !USEFUL_H */ |
---|