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
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
|
/**************************************************************************
*
* Copyright 2008 Tungsten Graphics, Inc., Cedar Park, Texas.
* All Rights Reserved.
*
* Permission is hereby granted, free of charge, to any person obtaining a
* copy of this software and associated documentation files (the
* "Software"), to deal in the Software without restriction, including
* without limitation the rights to use, copy, modify, merge, publish,
* distribute, sub license, and/or sell copies of the Software, and to
* permit persons to whom the Software is furnished to do so, subject to
* the following conditions:
*
* The above copyright notice and this permission notice (including the
* next paragraph) shall be included in all copies or substantial portions
* of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
* OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT.
* IN NO EVENT SHALL TUNGSTEN GRAPHICS AND/OR ITS SUPPLIERS BE LIABLE FOR
* ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*
**************************************************************************/
/**
* @file
* Generic handle table.
*
* @author José Fonseca <jrfonseca@tungstengraphics.com>
*/
#ifndef U_HANDLE_TABLE_H_
#define U_HANDLE_TABLE_H_
#ifdef __cplusplus
extern "C" {
#endif
/**
* Abstract data type to map integer handles to objects.
*
* Also referred as "pointer array".
*/
struct handle_table;
struct handle_table *
handle_table_create(void);
/**
* Set an optional destructor callback.
*
* If set, it will be called during handle_table_remove and
* handle_table_destroy calls.
*/
void
handle_table_set_destroy(struct handle_table *ht,
void (*destroy)(void *object));
/**
* Add a new object.
*
* Returns a zero handle on failure (out of memory).
*/
unsigned
handle_table_add(struct handle_table *ht,
void *object);
/**
* Returns zero on failure (out of memory).
*/
unsigned
handle_table_set(struct handle_table *ht,
unsigned handle,
void *object);
/**
* Fetch an existing object.
*
* Returns NULL for an invalid handle.
*/
void *
handle_table_get(struct handle_table *ht,
unsigned handle);
void
handle_table_remove(struct handle_table *ht,
unsigned handle);
void
handle_table_destroy(struct handle_table *ht);
unsigned
handle_table_get_first_handle(struct handle_table *ht);
unsigned
handle_table_get_next_handle(struct handle_table *ht,
unsigned handle);
#ifdef __cplusplus
}
#endif
#endif /* U_HANDLE_TABLE_H_ */
|
