summaryrefslogtreecommitdiff
path: root/src/shared.h
blob: 3b0a5f787df8dd59e2445d6e6c5b7ad22c1721fc (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
#ifndef __VXGG_REWRITE___SHARED_H___3880294315821___
#define __VXGG_REWRITE___SHARED_H___3880294315821___

#include <stddef.h>

#define STATIC_ARRAY_LEN(arr) (sizeof((arr))/sizeof((arr)[0]))

#define RETURNWERR(errval, retval) do {\
    errno = (errval);\
    return (retval);\
} while (0)

// Defines how `x___alloc()` functions should exit. `___VXGG___XALLOC_EXIT_ON_ERROR___ > 0` calls `error()`, and thus functions
// registered with `atexit()` and `on_exit()`. `___VXGG___XALLOC_EXIT_ON_ERROR___ <= 0` calls `abort()` on error. `x___alloc()` 
// type functions will ALWAYS 'abort', doing otherwise defeats the purpose of the function type
#define ___VXGG___XALLOC_EXIT_ON_ERROR___ 1

// Defines whether vxgg functions that can error print out a short warning of the error when one is encountered. 
// `___VXGG___VERBOSE_ERRORS___ > 0` will print diagnostic error messages, and will do nothing otherwise
#define ___VXGG___VERBOSE_ERRORS___ 1

// Macro to exit on an alloc error instead of doing the terrible nested if statement that was being used previously
#define XALLOC_EXIT(msg, ...) do {\
    if(!___VXGG___XALLOC_EXIT_ON_ERROR___)\
        abort();\
    if(!___VXGG___VERBOSE_ERRORS___)\
        exit(EXIT_FAILURE);\
    error(EXIT_FAILURE, errno, (msg)__VA_ARGS__);\
    exit(EXIT_FAILURE); /* Makes gcc happy */\
} while (0)

// Error macro that gcc will not complain about
#define ERROR(status, errnum, format, ...) do {error((status), (errnum), (format)__VA_ARGS__); exit((status));} while (0)

// `malloc()` with error checking. Calls `exit()` or `abort()` on error, depending on the value of `___VXGG___XALLOC_EXIT_ON_ERROR___`
void * xmalloc(size_t size);

// `calloc()` with error checking. Calls `exit()` or `abort()` on error, depending on the value of `___VXGG___XALLOC_EXIT_ON_ERROR___`
void * xcalloc(size_t nmemb, size_t size);

// `reallocarray()` with error checking. Calls `exit()` or `abort()` on error, depending on the value of `___VXGG___XALLOC_EXIT_ON_ERROR___`
void * xreallocarray(void *ptr, size_t nmemb, size_t size);

// Read the entire contents of a file descriptor into a malloc()'ed buffer
int rwbuf(char **str, unsigned long int initsize, int fd);

// Write the entire contents of a buffer into a file descriptor
int wwbuf(int fd, const unsigned char *buf, int len);

// `dirname()` reimplementation that returns a malloc()'ed string. According to the `x___` naming scheme, exits/aborts on alloc error.
char * xdirname(const char * const path);



// Cleanup callback. Should act like `free()`, in that it doesn't crash if the pointer it's given is null
typedef void (*cleanup_callback)(void*);

// Cleanup struct. Stores a STATICALLY defined array of callbacks and void* arguments
typedef struct cl {
	cleanup_callback *funcs;
	void **args;

	int size;
	int used;
} cleanup;

int cleanup_init(cleanup * const loc, int size, cleanup_callback funcs[], void *args[]);
int cleanup_register(cleanup * const loc, cleanup_callback cb, void *arg);
int cleanup_cndregister(cleanup * const loc, unsigned char flag, cleanup_callback cb, void *arg);
int cleanup_clear(cleanup * const loc);
cleanup_callback cleanup_peekf(cleanup * const loc);
cleanup_callback cleanup_popf(cleanup * const loc);
void * cleanup_peeka(cleanup * const loc);
void * cleanup_popa(cleanup * const loc);
int cleanup_fire(cleanup * const loc);

/* Cleanup environment creator. Automatically defines the variables `__CLEANUP`, `__CLEANUP_FUNCS`, and `__CLEANUP_ARGS` and initializes
// via `cleanup_init()` using these variables. */ 
#define cleanup_CREATE(size) \
cleanup __CLEANUP; \
cleanup_callback __CLEANUP_FUNCS[(size)]; \
void *__CLEANUP_ARGS[(size)]; \
cleanup_init(&__CLEANUP, (size), __CLEANUP_FUNCS, __CLEANUP_ARGS)

#define cleanup_REGISTER(cb, arg) cleanup_register(&__CLEANUP, (cb), (arg))
#define cleanup_CNDREGISTER(flag, cb, arg) cleanup_cndregister(&__CLEANUP, (flag), (cb), (arg))

#endif