Add some auxiliary string macros
[neverball] / share / common.h
1 /*
2  *  Copyright (C) 2007  Neverball contributors
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 #ifdef __GNUC__
28 #define NULL_TERMINATED __attribute__ ((__sentinel__))
29 #else
30 #define NULL_TERMINATED
31 #endif
32
33 #define ARRAYSIZE(a) (sizeof (a) / sizeof ((a)[0]))
34
35 #define MIN(x, y) ((x) < (y) ? (x) : (y))
36 #define MAX(x, y) ((x) > (y) ? (x) : (y))
37
38 int   read_line(char **, fs_file);
39 char *strip_newline(char *);
40
41 char *dupe_string(const char *);
42 char *concat_string(const char *first, ...) NULL_TERMINATED;
43 char *trunc_string(const char *src, char *dst, int len);
44
45 #ifdef strdup
46 #undef strdup
47 #endif
48 #define strdup dupe_string
49
50 #define str_starts_with(s, h) (strncmp((s), (h), strlen(h)) == 0)
51 #define str_ends_with(s, t) (strcmp((s) + strlen(s) - strlen(t), (t)) == 0)
52
53 time_t make_time_from_utc(struct tm *);
54 const char *date_to_str(time_t);
55
56 int  file_exists(const char *);
57 int  file_rename(const char *, const char *);
58 void file_copy(FILE *fin, FILE *fout);
59
60 int path_is_sep(int);
61 int path_is_abs(const char *);
62
63 char       *base_name(const char *name, const char *suffix);
64 const char *dir_name(const char *name);
65
66 char *path_resolve(const char *ref, const char *rel);
67
68 int rand_between(int low, int high);
69
70 #endif