3a7f3cb14de0757845fa56fc35dcae22cd66878f
[vsc-common.git] / include / libvscmisc / types.h
1 /*
2  * types.h: Library of miscellaneous stuff for other libvsc* libraries
3  *
4  * Copyright (C) 2009 Matthias Bolte <matthias.bolte@googlemail.com>
5  *
6  * This library is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Lesser General Public
8  * License as published by the Free Software Foundation; either
9  * version 2.1 of the License, or (at your option) any later version.
10  *
11  * This library is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14  * Lesser General Public License for more details.
15  *
16  * You should have received a copy of the GNU Lesser General Public
17  * License along with this library; if not, write to the Free Software
18  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307  USA
19  */
20
21 #ifndef __VSC_MISC__TYPES_H__
22 #define __VSC_MISC__TYPES_H__
23
24 #include <sys/time.h> /* for struct timeval */
25
26 #ifndef TRUE
27 #define TRUE 1
28 #endif
29
30 #ifndef FALSE
31 #define FALSE 0
32 #endif
33
34 #define VSC__ATTR__UNUSED __attribute__((__unused__))
35 #define VSC__ATTR__PRINTF(a, b) __attribute__ ((format (printf, a, b)))
36
37 #ifdef __cplusplus
38 extern "C" {
39 #endif
40
41 enum VscErrorCode {
42         VSC__ERROR_CODE__UNDEFINED = 0,
43         VSC__ERROR_CODE__INTERNAL_ERROR,
44         VSC__ERROR_CODE__OUT_OF_MEMORY,
45         VSC__ERROR_CODE__XMLRPC_ERROR,
46         VSC__ERROR_CODE__PTHREAD_ERROR,
47         VSC__ERROR_CODE__LIBVIRT_ERROR,
48         VSC__ERROR_CODE__INVALID_ARGUMENT,
49         VSC__ERROR_CODE__INVALID_CALL,
50         VSC__ERROR_CODE__INVALID_UUID_STRING,
51         VSC__ERROR_CODE__INVALID_IPV4_STRING,
52         VSC__ERROR_CODE__INVALID_HOST_TYPE_STRING,
53         VSC__ERROR_CODE__NOT_INITIALIZED,
54         VSC__ERROR_CODE__NOT_IMPLEMENTED_YET,
55         VSC__ERROR_CODE__ALREADY_KNOWN,
56         VSC__ERROR_CODE__ERRNO,
57         VSC__ERROR_CODE__TRACE,
58 };
59
60 struct VscError {
61         struct VscError *next;
62         int occured;
63         enum VscErrorCode code;
64         char *message;
65         const char *file;
66         int line;
67         const char *function;
68         struct timeval timestamp;
69 };
70
71 struct VscList {
72         struct VscList *next;
73 };
74
75 typedef struct VscList * (*VscList_DuplicateFunction) (struct VscError *error,
76                                                        struct VscList *item);
77 typedef int (*VscList_MatchFunction) (struct VscList *item, void *match_data);
78 typedef int (*VscList_FreeFunction) (struct VscList **item);
79
80 #ifdef __cplusplus
81 }
82 #endif
83
84 #endif /* __VSC_MISC__TYPES_H__ */