annotate th_util.h @ 45:e031a062b731

Separate program "banner" printing from th_args_help() to th_print_banner().
author Matti Hamalainen <ccr@tnsp.org>
date Mon, 03 Oct 2011 15:37:53 +0300
parents 06a72c643460
children 598609fb49b0
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
bd61a80a6c54 Initial import into Mercurial repository. Discarding old cvs/svn history
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
1 /*
bd61a80a6c54 Initial import into Mercurial repository. Discarding old cvs/svn history
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
2 * Generic utility-functions, macros and defaults
bd61a80a6c54 Initial import into Mercurial repository. Discarding old cvs/svn history
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
3 * Programmed and designed by Matti 'ccr' Hamalainen
16
Matti Hamalainen <ccr@tnsp.org>
parents: 11
diff changeset
4 * (C) Copyright 2002-2010 Tecnic Software productions (TNSP)
0
bd61a80a6c54 Initial import into Mercurial repository. Discarding old cvs/svn history
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
5 *
bd61a80a6c54 Initial import into Mercurial repository. Discarding old cvs/svn history
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
6 * Please read file 'COPYING' for information on license and distribution.
bd61a80a6c54 Initial import into Mercurial repository. Discarding old cvs/svn history
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
7 */
bd61a80a6c54 Initial import into Mercurial repository. Discarding old cvs/svn history
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
8 #ifndef _TH_UTIL_H
bd61a80a6c54 Initial import into Mercurial repository. Discarding old cvs/svn history
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
9 #define _TH_UTIL_H
bd61a80a6c54 Initial import into Mercurial repository. Discarding old cvs/svn history
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
10
bd61a80a6c54 Initial import into Mercurial repository. Discarding old cvs/svn history
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
11 #ifdef __cplusplus
bd61a80a6c54 Initial import into Mercurial repository. Discarding old cvs/svn history
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
12 extern "C" {
bd61a80a6c54 Initial import into Mercurial repository. Discarding old cvs/svn history
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
13 #endif
bd61a80a6c54 Initial import into Mercurial repository. Discarding old cvs/svn history
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
14
bd61a80a6c54 Initial import into Mercurial repository. Discarding old cvs/svn history
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
15 #include "th_types.h"
45
e031a062b731 Separate program "banner" printing from th_args_help() to th_print_banner().
Matti Hamalainen <ccr@tnsp.org>
parents: 33
diff changeset
16 #include <stdio.h>
0
bd61a80a6c54 Initial import into Mercurial repository. Discarding old cvs/svn history
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
17 #include <stdarg.h>
bd61a80a6c54 Initial import into Mercurial repository. Discarding old cvs/svn history
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
18 #include <stdlib.h>
16
Matti Hamalainen <ccr@tnsp.org>
parents: 11
diff changeset
19 #include <sys/types.h>
0
bd61a80a6c54 Initial import into Mercurial repository. Discarding old cvs/svn history
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
20 #ifndef HAVE_NO_ASSERT
bd61a80a6c54 Initial import into Mercurial repository. Discarding old cvs/svn history
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
21 #include <assert.h>
bd61a80a6c54 Initial import into Mercurial repository. Discarding old cvs/svn history
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
22 #endif
bd61a80a6c54 Initial import into Mercurial repository. Discarding old cvs/svn history
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
23
bd61a80a6c54 Initial import into Mercurial repository. Discarding old cvs/svn history
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
24 #ifdef HAVE_STRING_H
bd61a80a6c54 Initial import into Mercurial repository. Discarding old cvs/svn history
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
25 #include <string.h>
bd61a80a6c54 Initial import into Mercurial repository. Discarding old cvs/svn history
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
26 #define HAVE_MEMSET 1
bd61a80a6c54 Initial import into Mercurial repository. Discarding old cvs/svn history
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
27 #else
bd61a80a6c54 Initial import into Mercurial repository. Discarding old cvs/svn history
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
28 #ifdef HAVE_STRINGS_H
bd61a80a6c54 Initial import into Mercurial repository. Discarding old cvs/svn history
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
29 #include <strings.h>
bd61a80a6c54 Initial import into Mercurial repository. Discarding old cvs/svn history
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
30 #endif
bd61a80a6c54 Initial import into Mercurial repository. Discarding old cvs/svn history
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
31 #endif
bd61a80a6c54 Initial import into Mercurial repository. Discarding old cvs/svn history
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
32
bd61a80a6c54 Initial import into Mercurial repository. Discarding old cvs/svn history
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
33 #ifdef HAVE_MEMORY_H
bd61a80a6c54 Initial import into Mercurial repository. Discarding old cvs/svn history
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
34 #include <memory.h>
bd61a80a6c54 Initial import into Mercurial repository. Discarding old cvs/svn history
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
35 #endif
bd61a80a6c54 Initial import into Mercurial repository. Discarding old cvs/svn history
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
36
bd61a80a6c54 Initial import into Mercurial repository. Discarding old cvs/svn history
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
37
4
67f4a4233372 Move defaults to header file.
Matti Hamalainen <ccr@tnsp.org>
parents: 0
diff changeset
38 #ifdef TH_NO_DEFAULTS
6
2f92373537b5 Indentation cleanups.
Matti Hamalainen <ccr@tnsp.org>
parents: 4
diff changeset
39 #define TH_PROG_AUTHOR NULL
2f92373537b5 Indentation cleanups.
Matti Hamalainen <ccr@tnsp.org>
parents: 4
diff changeset
40 #define TH_PROG_LICENSE NULL
4
67f4a4233372 Move defaults to header file.
Matti Hamalainen <ccr@tnsp.org>
parents: 0
diff changeset
41 #else
18
c0d5c825894a Update copyright year.
Matti Hamalainen <ccr@tnsp.org>
parents: 16
diff changeset
42 #define TH_PROG_AUTHOR "By Matti 'ccr' Hämäläinen (C) Copyright 2011 TNSP"
6
2f92373537b5 Indentation cleanups.
Matti Hamalainen <ccr@tnsp.org>
parents: 4
diff changeset
43 #define TH_PROG_LICENSE "This software is licensed under GNU GPL version 2"
4
67f4a4233372 Move defaults to header file.
Matti Hamalainen <ccr@tnsp.org>
parents: 0
diff changeset
44 #endif
67f4a4233372 Move defaults to header file.
Matti Hamalainen <ccr@tnsp.org>
parents: 0
diff changeset
45
67f4a4233372 Move defaults to header file.
Matti Hamalainen <ccr@tnsp.org>
parents: 0
diff changeset
46
0
bd61a80a6c54 Initial import into Mercurial repository. Discarding old cvs/svn history
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
47 /* Replacement for assert() */
bd61a80a6c54 Initial import into Mercurial repository. Discarding old cvs/svn history
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
48 #ifdef HAVE_NO_ASSERT
bd61a80a6c54 Initial import into Mercurial repository. Discarding old cvs/svn history
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
49 # ifdef NDEBUG
bd61a80a6c54 Initial import into Mercurial repository. Discarding old cvs/svn history
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
50 # define assert(NEXPR) /* stub */
bd61a80a6c54 Initial import into Mercurial repository. Discarding old cvs/svn history
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
51 # else
bd61a80a6c54 Initial import into Mercurial repository. Discarding old cvs/svn history
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
52 # define assert(NEXPR) do { if (!(NEXPR)) { fprintf(stderr, "[%s:%d] assert(" # NEXPR ") failed!\n", __FILE__, __LINE__); abort(); } } while (0)
bd61a80a6c54 Initial import into Mercurial repository. Discarding old cvs/svn history
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
53 # endif
bd61a80a6c54 Initial import into Mercurial repository. Discarding old cvs/svn history
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
54 #endif
bd61a80a6c54 Initial import into Mercurial repository. Discarding old cvs/svn history
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
55
bd61a80a6c54 Initial import into Mercurial repository. Discarding old cvs/svn history
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
56 /* Global variables
bd61a80a6c54 Initial import into Mercurial repository. Discarding old cvs/svn history
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
57 */
19
bbb243eba688 Cosmetics.
Matti Hamalainen <ccr@tnsp.org>
parents: 18
diff changeset
58 extern int th_verbosityLevel;
bbb243eba688 Cosmetics.
Matti Hamalainen <ccr@tnsp.org>
parents: 18
diff changeset
59 extern char *th_prog_name,
bbb243eba688 Cosmetics.
Matti Hamalainen <ccr@tnsp.org>
parents: 18
diff changeset
60 *th_prog_fullname,
bbb243eba688 Cosmetics.
Matti Hamalainen <ccr@tnsp.org>
parents: 18
diff changeset
61 *th_prog_version,
bbb243eba688 Cosmetics.
Matti Hamalainen <ccr@tnsp.org>
parents: 18
diff changeset
62 *th_prog_author,
bbb243eba688 Cosmetics.
Matti Hamalainen <ccr@tnsp.org>
parents: 18
diff changeset
63 *th_prog_license;
0
bd61a80a6c54 Initial import into Mercurial repository. Discarding old cvs/svn history
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
64
bd61a80a6c54 Initial import into Mercurial repository. Discarding old cvs/svn history
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
65 /* Functions
bd61a80a6c54 Initial import into Mercurial repository. Discarding old cvs/svn history
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
66 */
6
2f92373537b5 Indentation cleanups.
Matti Hamalainen <ccr@tnsp.org>
parents: 4
diff changeset
67 void th_init(char *progName, char *progFullName, char *progVersion,
19
bbb243eba688 Cosmetics.
Matti Hamalainen <ccr@tnsp.org>
parents: 18
diff changeset
68 char *progAuthor, char *progLicense);
45
e031a062b731 Separate program "banner" printing from th_args_help() to th_print_banner().
Matti Hamalainen <ccr@tnsp.org>
parents: 33
diff changeset
69 void th_print_banner(FILE *outFile, const char *binName, const char *progUsage);
e031a062b731 Separate program "banner" printing from th_args_help() to th_print_banner().
Matti Hamalainen <ccr@tnsp.org>
parents: 33
diff changeset
70
6
2f92373537b5 Indentation cleanups.
Matti Hamalainen <ccr@tnsp.org>
parents: 4
diff changeset
71 void THERR(const char *, ...);
2f92373537b5 Indentation cleanups.
Matti Hamalainen <ccr@tnsp.org>
parents: 4
diff changeset
72 void THMSG(int, const char *, ...);
2f92373537b5 Indentation cleanups.
Matti Hamalainen <ccr@tnsp.org>
parents: 4
diff changeset
73 void THPRINT(int, const char *, ...);
0
bd61a80a6c54 Initial import into Mercurial repository. Discarding old cvs/svn history
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
74
11
e467b3586e4d Cleanups.
Matti Hamalainen <ccr@tnsp.org>
parents: 10
diff changeset
75 void THERR_V(const char *, va_list);
e467b3586e4d Cleanups.
Matti Hamalainen <ccr@tnsp.org>
parents: 10
diff changeset
76 void THMSG_V(int, const char *, va_list);
e467b3586e4d Cleanups.
Matti Hamalainen <ccr@tnsp.org>
parents: 10
diff changeset
77 void THPRINT_V(int, const char *, va_list);
e467b3586e4d Cleanups.
Matti Hamalainen <ccr@tnsp.org>
parents: 10
diff changeset
78
6
2f92373537b5 Indentation cleanups.
Matti Hamalainen <ccr@tnsp.org>
parents: 4
diff changeset
79 void *th_malloc(size_t);
2f92373537b5 Indentation cleanups.
Matti Hamalainen <ccr@tnsp.org>
parents: 4
diff changeset
80 void *th_calloc(size_t, size_t);
2f92373537b5 Indentation cleanups.
Matti Hamalainen <ccr@tnsp.org>
parents: 4
diff changeset
81 void *th_realloc(void *, size_t);
2f92373537b5 Indentation cleanups.
Matti Hamalainen <ccr@tnsp.org>
parents: 4
diff changeset
82 void th_free(void *);
0
bd61a80a6c54 Initial import into Mercurial repository. Discarding old cvs/svn history
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
83
bd61a80a6c54 Initial import into Mercurial repository. Discarding old cvs/svn history
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
84 #ifdef HAVE_MEMSET
6
2f92373537b5 Indentation cleanups.
Matti Hamalainen <ccr@tnsp.org>
parents: 4
diff changeset
85 #define th_memset memset
0
bd61a80a6c54 Initial import into Mercurial repository. Discarding old cvs/svn history
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
86 #else
6
2f92373537b5 Indentation cleanups.
Matti Hamalainen <ccr@tnsp.org>
parents: 4
diff changeset
87 void *th_memset(void *, int, size_t);
0
bd61a80a6c54 Initial import into Mercurial repository. Discarding old cvs/svn history
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
88 #endif
bd61a80a6c54 Initial import into Mercurial repository. Discarding old cvs/svn history
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
89
16
Matti Hamalainen <ccr@tnsp.org>
parents: 11
diff changeset
90
Matti Hamalainen <ccr@tnsp.org>
parents: 11
diff changeset
91 /* Doubly linked list handling
Matti Hamalainen <ccr@tnsp.org>
parents: 11
diff changeset
92 */
Matti Hamalainen <ccr@tnsp.org>
parents: 11
diff changeset
93 typedef struct _qlist_t {
Matti Hamalainen <ccr@tnsp.org>
parents: 11
diff changeset
94 void *data;
Matti Hamalainen <ccr@tnsp.org>
parents: 11
diff changeset
95 size_t num;
Matti Hamalainen <ccr@tnsp.org>
parents: 11
diff changeset
96 struct _qlist_t *prev, *next;
Matti Hamalainen <ccr@tnsp.org>
parents: 11
diff changeset
97 } qlist_t;
Matti Hamalainen <ccr@tnsp.org>
parents: 11
diff changeset
98
Matti Hamalainen <ccr@tnsp.org>
parents: 11
diff changeset
99
Matti Hamalainen <ccr@tnsp.org>
parents: 11
diff changeset
100 qlist_t * th_llist_new(void *data);
Matti Hamalainen <ccr@tnsp.org>
parents: 11
diff changeset
101 void th_llist_free(qlist_t *list);
Matti Hamalainen <ccr@tnsp.org>
parents: 11
diff changeset
102 void th_llist_free_func(qlist_t *list, void (*freefunc)(void *data));
Matti Hamalainen <ccr@tnsp.org>
parents: 11
diff changeset
103
Matti Hamalainen <ccr@tnsp.org>
parents: 11
diff changeset
104 qlist_t * th_llist_append(qlist_t **list, void *data);
Matti Hamalainen <ccr@tnsp.org>
parents: 11
diff changeset
105 qlist_t * th_llist_prepend(qlist_t **list, void *data);
Matti Hamalainen <ccr@tnsp.org>
parents: 11
diff changeset
106 void th_llist_delete(qlist_t **list, const void *data);
Matti Hamalainen <ccr@tnsp.org>
parents: 11
diff changeset
107 void th_llist_delete_node(qlist_t **list, qlist_t *node);
Matti Hamalainen <ccr@tnsp.org>
parents: 11
diff changeset
108
Matti Hamalainen <ccr@tnsp.org>
parents: 11
diff changeset
109 qlist_t * th_llist_get_nth(qlist_t *list, const size_t n);
Matti Hamalainen <ccr@tnsp.org>
parents: 11
diff changeset
110 size_t th_llist_length(const qlist_t *list);
Matti Hamalainen <ccr@tnsp.org>
parents: 11
diff changeset
111 ssize_t th_llist_position(const qlist_t *list, const qlist_t *node);
Matti Hamalainen <ccr@tnsp.org>
parents: 11
diff changeset
112
Matti Hamalainen <ccr@tnsp.org>
parents: 11
diff changeset
113 qlist_t * th_llist_find(qlist_t *list, const void *data);
Matti Hamalainen <ccr@tnsp.org>
parents: 11
diff changeset
114 qlist_t * th_llist_find_func(qlist_t *list, const void *userdata, int (compare)(const void *, const void *));
Matti Hamalainen <ccr@tnsp.org>
parents: 11
diff changeset
115
Matti Hamalainen <ccr@tnsp.org>
parents: 11
diff changeset
116
23
a4f894105953 Add ringbuffer implementation.
Matti Hamalainen <ccr@tnsp.org>
parents: 19
diff changeset
117 /* Ringbuffer implementation
a4f894105953 Add ringbuffer implementation.
Matti Hamalainen <ccr@tnsp.org>
parents: 19
diff changeset
118 */
a4f894105953 Add ringbuffer implementation.
Matti Hamalainen <ccr@tnsp.org>
parents: 19
diff changeset
119 typedef struct {
33
Matti Hamalainen <ccr@tnsp.org>
parents: 23
diff changeset
120 char **data;
23
a4f894105953 Add ringbuffer implementation.
Matti Hamalainen <ccr@tnsp.org>
parents: 19
diff changeset
121 int n, size;
a4f894105953 Add ringbuffer implementation.
Matti Hamalainen <ccr@tnsp.org>
parents: 19
diff changeset
122 void (*deallocator)(void *);
a4f894105953 Add ringbuffer implementation.
Matti Hamalainen <ccr@tnsp.org>
parents: 19
diff changeset
123 } qringbuf_t;
a4f894105953 Add ringbuffer implementation.
Matti Hamalainen <ccr@tnsp.org>
parents: 19
diff changeset
124
a4f894105953 Add ringbuffer implementation.
Matti Hamalainen <ccr@tnsp.org>
parents: 19
diff changeset
125 qringbuf_t * th_ringbuf_new(const size_t size, void (*mdeallocator)(void *));
a4f894105953 Add ringbuffer implementation.
Matti Hamalainen <ccr@tnsp.org>
parents: 19
diff changeset
126 BOOL th_ringbuf_grow(qringbuf_t *buf, const size_t n);
a4f894105953 Add ringbuffer implementation.
Matti Hamalainen <ccr@tnsp.org>
parents: 19
diff changeset
127 void th_ringbuf_free(qringbuf_t *buf);
a4f894105953 Add ringbuffer implementation.
Matti Hamalainen <ccr@tnsp.org>
parents: 19
diff changeset
128 void th_ringbuf_add(qringbuf_t *buf, void *ptr);
a4f894105953 Add ringbuffer implementation.
Matti Hamalainen <ccr@tnsp.org>
parents: 19
diff changeset
129
a4f894105953 Add ringbuffer implementation.
Matti Hamalainen <ccr@tnsp.org>
parents: 19
diff changeset
130
0
bd61a80a6c54 Initial import into Mercurial repository. Discarding old cvs/svn history
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
131 #ifdef __cplusplus
bd61a80a6c54 Initial import into Mercurial repository. Discarding old cvs/svn history
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
132 }
bd61a80a6c54 Initial import into Mercurial repository. Discarding old cvs/svn history
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
133 #endif
bd61a80a6c54 Initial import into Mercurial repository. Discarding old cvs/svn history
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
134 #endif /* _TH_UTIL_H */