source: git/src/useful.h @ 58dfbe4f

faster-cavernloglog-selectstereo-2025walls-datawalls-data-hanging-as-warningwarn-only-for-hanging-survey
Last change on this file since 58dfbe4f was d9434a0, checked in by Olly Betts <olly@…>, 16 months ago

Suppress clang -Wunused-function warning

  • Property mode set to 100644
File size: 3.9 KB
Line 
1/* useful.h
2 * Lots of oddments that come in handy generally
3 * Copyright (C) 1993-2003,2004,2010,2011,2014 Olly Betts
4 *
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.
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
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13 * GNU General Public License for more details.
14 *
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
17 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
18 */
19
20/* only include once */
21#ifndef USEFUL_H
22#define USEFUL_H
23
24#include <config.h>
25
26#include <stdint.h>
27#include <stdlib.h> /* for Borland C which #defines max() & min() there */
28#include <stdio.h>
29#include <math.h>
30#include "osalloc.h"
31
32/* Macro to allow easy building of macros contain multiple statements, such
33 * that the likes of “if (x == y) macro1(x); else x = 2;” works properly  */
34#define BLK(X) do {X} while(0)
35
36/* Macro to do nothing, but avoid compiler warnings about empty if bodies &c */
37#define NOP (void)0
38
39/* In C++ code, #include<algorithm> and use std::max and std::min instead. */
40#ifndef __cplusplus
41/* Return max/min of two numbers. */
42/* May be defined already (e.g. by Borland C in stdlib.h) */
43/* NB Bad news if X or Y has side-effects... */
44# ifndef max
45#  define max(X, Y) ((X) > (Y) ? (X) : (Y))
46# endif
47# ifndef min
48#  define min(X, Y) ((X) < (Y) ? (X) : (Y))
49# endif
50#endif
51
52/* M_PI, etc may be defined in math.h */
53#ifndef M_PI
54# ifdef PI /* MSVC defines PI IIRC */
55#  define M_PI PI
56# else
57#  define M_PI 3.14159265358979323846264338327950288419716939937510582097494459
58# endif
59#endif
60#ifndef M_PI_2
61# define M_PI_2 (M_PI / 2.0)
62#endif
63#ifndef M_PI_4
64# define M_PI_4 (M_PI / 4.0)
65#endif
66
67#define MM_PER_INCH 25.4 /* exact value */
68#define METRES_PER_FOOT 0.3048 /* exact value */
69
70#define putnl() putchar('\n')    /* print a newline char */
71#define fputnl(FH) PUTC('\n', (FH)) /* print a newline char to a file */
72/* print a line followed by a newline char to a file */
73#define fputsnl(SZ, FH) BLK(fputs((SZ), (FH)); PUTC('\n', (FH));)
74#define sqrd(X) ((X) * (X))        /* macro to square things */
75
76/* 2D Euclidean distance */
77#ifndef HAVE_HYPOT
78# define hypot(X, Y) sqrt(sqrd((double)(X)) + sqrd((double)(Y)))
79#endif
80#define rad(X) ((M_PI / 180.0) * (X))  /* convert from degrees to radians */
81#define deg(X) ((180.0 / M_PI) * (X))  /* convert from radians to degrees */
82
83/* macro to convert argument to a string literal */
84#define STRING(X) STRING_(X)
85#define STRING_(X) #X
86
87#ifndef WORDS_BIGENDIAN
88# define put16(W, FH) BLK(int16_t w = (W); fwrite(&w, 2, 1, (FH));)
89# define put32(W, FH) BLK(int32_t w = (W); fwrite(&w, 4, 1, (FH));)
90
91# ifdef __GNUC__
92__attribute__((unused))
93# endif
94static inline int16_t get16(FILE *fh) {
95    int16_t w;
96    if (fread(&w, 2, 1, fh) == 0) {
97        /* We check feof() and ferror() afterwards, so checking the return
98         * value achieves nothing, but we get a warning from glibc's
99         * _FORTIFY_SOURCE if we don't pretend to. */
100    }
101    return w;
102}
103
104# ifdef __GNUC__
105__attribute__((unused))
106# endif
107static inline int32_t get32(FILE *fh) {
108    int32_t w;
109    if (fread(&w, 4, 1, fh) == 0) {
110        /* We check feof() and ferror() afterwards, so checking the return
111         * value achieves nothing, but we get a warning from glibc's
112         * _FORTIFY_SOURCE if we don't pretend to. */
113    }
114    return w;
115}
116#else
117void useful_put16(int16_t, FILE *);
118void useful_put32(int32_t, FILE *);
119int16_t useful_get16(FILE *);
120int32_t useful_get32(FILE *);
121
122# define put16(W, FH) useful_put16(W, FH)
123# define put32(W, FH) useful_put32(W, FH)
124# define get16(FH) useful_get16(FH)
125# define get32(FH) useful_get32(FH)
126#endif
127
128#endif /* !USEFUL_H */
Note: See TracBrowser for help on using the repository browser.