Fix less-than-zero comparison on unsigned integers
[neverball] / share / common.h
1 /*
2  *  Copyright (C) 2007  Neverball authors
3  *
4  *  This  program is  free software;  you can  redistribute  it and/or
5  *  modify it  under the  terms of the  GNU General Public  License as
6  *  published by the Free Software Foundation; either version 2 of the
7  *  License, or (at your option) any later version.
8  *
9  *  This program  is distributed in the  hope that it  will be useful,
10  *  but  WITHOUT ANY WARRANTY;  without even  the implied  warranty of
11  *  MERCHANTABILITY or FITNESS FOR  A PARTICULAR PURPOSE.  See the GNU
12  *  General Public License for more details.
13  *
14  *  You should have received a  copy of the GNU General Public License
15  *  along  with this  program;  if  not, write  to  the Free  Software
16  *  Foundation,  Inc.,   59  Temple  Place,  Suite   330,  Boston,  MA
17  *  02111-1307 USA
18  */
19
20 #ifndef COMMON_H
21 #define COMMON_H
22
23 #include <time.h>
24 #include <stdio.h>
25 #include "fs.h"
26
27 /* Random stuff. */
28
29 #ifdef __GNUC__
30 #define NULL_TERMINATED __attribute__ ((__sentinel__))
31 #else
32 #define NULL_TERMINATED
33 #endif
34
35 /* Math. */
36
37 #define MIN(x, y) ((x) < (y) ? (x) : (y))
38 #define MAX(x, y) ((x) > (y) ? (x) : (y))
39
40 #define SIGN(n) ((n) < 0 ? -1 : ((n) ? +1 : 0))
41 #define ROUND(f) ((int) ((f) + 0.5f * SIGN(f)))
42
43 #define TIME_TO_MS(t) ROUND((t) * 1000.0f)
44 #define MS_TO_TIME(m) ((m) * 0.001f)
45
46 int rand_between(int low, int high);
47
48 /* Arrays and strings. */
49
50 #define ARRAYSIZE(a) (sizeof (a) / sizeof ((a)[0]))
51 #define MAXSTRLEN(a) (sizeof (a) - 1)
52
53 #define SAFECPY(dst, src) \
54     (strncpy((dst), (src), MAXSTRLEN(dst)))
55 #define SAFECAT(dst, src) \
56     (strncat((dst), (src), MAXSTRLEN(dst) - MIN(strlen(dst), MAXSTRLEN(dst))))
57
58 int   read_line(char **, fs_file);
59 char *strip_newline(char *);
60
61 char *dupe_string(const char *);
62 char *concat_string(const char *first, ...) NULL_TERMINATED;
63
64 #ifdef strdup
65 #undef strdup
66 #endif
67 #define strdup dupe_string
68
69 #define str_starts_with(s, h) (strncmp((s), (h), strlen(h)) == 0)
70 #define str_ends_with(s, t) (strcmp((s) + strlen(s) - strlen(t), (t)) == 0)
71
72 /* Time. */
73
74 time_t make_time_from_utc(struct tm *);
75 const char *date_to_str(time_t);
76
77 /* Files. */
78
79 int  file_exists(const char *);
80 int  file_rename(const char *, const char *);
81 void file_copy(FILE *fin, FILE *fout);
82
83 /* Paths. */
84
85 int path_is_sep(int);
86 int path_is_abs(const char *);
87
88 char *path_join(const char *, const char *);
89
90 const char *path_last_sep(const char *);
91 const char *path_next_sep(const char *);
92
93 const char *base_name(const char *name);
94 const char *base_name_sans(const char *name, const char *suffix);
95 const char *dir_name(const char *name);
96
97 #endif