13a0db227ffe90888ad760c61a63226988c974e0apatrick@chromium.org/************************************************************************** 23a0db227ffe90888ad760c61a63226988c974e0apatrick@chromium.org * 33a0db227ffe90888ad760c61a63226988c974e0apatrick@chromium.org * Copyright 2008 Tungsten Graphics, Inc., Cedar Park, Texas. 43a0db227ffe90888ad760c61a63226988c974e0apatrick@chromium.org * All Rights Reserved. 53a0db227ffe90888ad760c61a63226988c974e0apatrick@chromium.org * 63a0db227ffe90888ad760c61a63226988c974e0apatrick@chromium.org * Permission is hereby granted, free of charge, to any person obtaining a 73a0db227ffe90888ad760c61a63226988c974e0apatrick@chromium.org * copy of this software and associated documentation files (the 83a0db227ffe90888ad760c61a63226988c974e0apatrick@chromium.org * "Software"), to deal in the Software without restriction, including 93a0db227ffe90888ad760c61a63226988c974e0apatrick@chromium.org * without limitation the rights to use, copy, modify, merge, publish, 103a0db227ffe90888ad760c61a63226988c974e0apatrick@chromium.org * distribute, sub license, and/or sell copies of the Software, and to 113a0db227ffe90888ad760c61a63226988c974e0apatrick@chromium.org * permit persons to whom the Software is furnished to do so, subject to 123a0db227ffe90888ad760c61a63226988c974e0apatrick@chromium.org * the following conditions: 133a0db227ffe90888ad760c61a63226988c974e0apatrick@chromium.org * 143a0db227ffe90888ad760c61a63226988c974e0apatrick@chromium.org * The above copyright notice and this permission notice (including the 153a0db227ffe90888ad760c61a63226988c974e0apatrick@chromium.org * next paragraph) shall be included in all copies or substantial portions 163a0db227ffe90888ad760c61a63226988c974e0apatrick@chromium.org * of the Software. 173a0db227ffe90888ad760c61a63226988c974e0apatrick@chromium.org * 183a0db227ffe90888ad760c61a63226988c974e0apatrick@chromium.org * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS 193a0db227ffe90888ad760c61a63226988c974e0apatrick@chromium.org * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF 203a0db227ffe90888ad760c61a63226988c974e0apatrick@chromium.org * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. 213a0db227ffe90888ad760c61a63226988c974e0apatrick@chromium.org * IN NO EVENT SHALL TUNGSTEN GRAPHICS AND/OR ITS SUPPLIERS BE LIABLE FOR 223a0db227ffe90888ad760c61a63226988c974e0apatrick@chromium.org * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, 233a0db227ffe90888ad760c61a63226988c974e0apatrick@chromium.org * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE 243a0db227ffe90888ad760c61a63226988c974e0apatrick@chromium.org * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. 253a0db227ffe90888ad760c61a63226988c974e0apatrick@chromium.org * 263a0db227ffe90888ad760c61a63226988c974e0apatrick@chromium.org **************************************************************************/ 273a0db227ffe90888ad760c61a63226988c974e0apatrick@chromium.org 283a0db227ffe90888ad760c61a63226988c974e0apatrick@chromium.org/** 293a0db227ffe90888ad760c61a63226988c974e0apatrick@chromium.org * @file 303a0db227ffe90888ad760c61a63226988c974e0apatrick@chromium.org * Generic handle table. 313a0db227ffe90888ad760c61a63226988c974e0apatrick@chromium.org * 323a0db227ffe90888ad760c61a63226988c974e0apatrick@chromium.org * @author José Fonseca <jrfonseca@tungstengraphics.com> 333a0db227ffe90888ad760c61a63226988c974e0apatrick@chromium.org */ 343a0db227ffe90888ad760c61a63226988c974e0apatrick@chromium.org 353a0db227ffe90888ad760c61a63226988c974e0apatrick@chromium.org#ifndef U_HANDLE_TABLE_H_ 363a0db227ffe90888ad760c61a63226988c974e0apatrick@chromium.org#define U_HANDLE_TABLE_H_ 373a0db227ffe90888ad760c61a63226988c974e0apatrick@chromium.org 383a0db227ffe90888ad760c61a63226988c974e0apatrick@chromium.org 393a0db227ffe90888ad760c61a63226988c974e0apatrick@chromium.org#ifdef __cplusplus 403a0db227ffe90888ad760c61a63226988c974e0apatrick@chromium.orgextern "C" { 413a0db227ffe90888ad760c61a63226988c974e0apatrick@chromium.org#endif 423a0db227ffe90888ad760c61a63226988c974e0apatrick@chromium.org 433a0db227ffe90888ad760c61a63226988c974e0apatrick@chromium.org 443a0db227ffe90888ad760c61a63226988c974e0apatrick@chromium.org/** 453a0db227ffe90888ad760c61a63226988c974e0apatrick@chromium.org * Abstract data type to map integer handles to objects. 463a0db227ffe90888ad760c61a63226988c974e0apatrick@chromium.org * 473a0db227ffe90888ad760c61a63226988c974e0apatrick@chromium.org * Also referred as "pointer array". 483a0db227ffe90888ad760c61a63226988c974e0apatrick@chromium.org */ 493a0db227ffe90888ad760c61a63226988c974e0apatrick@chromium.orgstruct handle_table; 503a0db227ffe90888ad760c61a63226988c974e0apatrick@chromium.org 513a0db227ffe90888ad760c61a63226988c974e0apatrick@chromium.org 523a0db227ffe90888ad760c61a63226988c974e0apatrick@chromium.orgstruct handle_table * 533a0db227ffe90888ad760c61a63226988c974e0apatrick@chromium.orghandle_table_create(void); 543a0db227ffe90888ad760c61a63226988c974e0apatrick@chromium.org 553a0db227ffe90888ad760c61a63226988c974e0apatrick@chromium.org 563a0db227ffe90888ad760c61a63226988c974e0apatrick@chromium.org/** 573a0db227ffe90888ad760c61a63226988c974e0apatrick@chromium.org * Set an optional destructor callback. 583a0db227ffe90888ad760c61a63226988c974e0apatrick@chromium.org * 593a0db227ffe90888ad760c61a63226988c974e0apatrick@chromium.org * If set, it will be called during handle_table_remove and 603a0db227ffe90888ad760c61a63226988c974e0apatrick@chromium.org * handle_table_destroy calls. 613a0db227ffe90888ad760c61a63226988c974e0apatrick@chromium.org */ 623a0db227ffe90888ad760c61a63226988c974e0apatrick@chromium.orgvoid 633a0db227ffe90888ad760c61a63226988c974e0apatrick@chromium.orghandle_table_set_destroy(struct handle_table *ht, 643a0db227ffe90888ad760c61a63226988c974e0apatrick@chromium.org void (*destroy)(void *object)); 653a0db227ffe90888ad760c61a63226988c974e0apatrick@chromium.org 663a0db227ffe90888ad760c61a63226988c974e0apatrick@chromium.org 673a0db227ffe90888ad760c61a63226988c974e0apatrick@chromium.org/** 683a0db227ffe90888ad760c61a63226988c974e0apatrick@chromium.org * Add a new object. 693a0db227ffe90888ad760c61a63226988c974e0apatrick@chromium.org * 703a0db227ffe90888ad760c61a63226988c974e0apatrick@chromium.org * Returns a zero handle on failure (out of memory). 713a0db227ffe90888ad760c61a63226988c974e0apatrick@chromium.org */ 723a0db227ffe90888ad760c61a63226988c974e0apatrick@chromium.orgunsigned 733a0db227ffe90888ad760c61a63226988c974e0apatrick@chromium.orghandle_table_add(struct handle_table *ht, 743a0db227ffe90888ad760c61a63226988c974e0apatrick@chromium.org void *object); 753a0db227ffe90888ad760c61a63226988c974e0apatrick@chromium.org 763a0db227ffe90888ad760c61a63226988c974e0apatrick@chromium.org/** 773a0db227ffe90888ad760c61a63226988c974e0apatrick@chromium.org * Returns zero on failure (out of memory). 783a0db227ffe90888ad760c61a63226988c974e0apatrick@chromium.org */ 793a0db227ffe90888ad760c61a63226988c974e0apatrick@chromium.orgunsigned 803a0db227ffe90888ad760c61a63226988c974e0apatrick@chromium.orghandle_table_set(struct handle_table *ht, 813a0db227ffe90888ad760c61a63226988c974e0apatrick@chromium.org unsigned handle, 823a0db227ffe90888ad760c61a63226988c974e0apatrick@chromium.org void *object); 833a0db227ffe90888ad760c61a63226988c974e0apatrick@chromium.org 843a0db227ffe90888ad760c61a63226988c974e0apatrick@chromium.org/** 853a0db227ffe90888ad760c61a63226988c974e0apatrick@chromium.org * Fetch an existing object. 863a0db227ffe90888ad760c61a63226988c974e0apatrick@chromium.org * 873a0db227ffe90888ad760c61a63226988c974e0apatrick@chromium.org * Returns NULL for an invalid handle. 883a0db227ffe90888ad760c61a63226988c974e0apatrick@chromium.org */ 893a0db227ffe90888ad760c61a63226988c974e0apatrick@chromium.orgvoid * 903a0db227ffe90888ad760c61a63226988c974e0apatrick@chromium.orghandle_table_get(struct handle_table *ht, 913a0db227ffe90888ad760c61a63226988c974e0apatrick@chromium.org unsigned handle); 923a0db227ffe90888ad760c61a63226988c974e0apatrick@chromium.org 933a0db227ffe90888ad760c61a63226988c974e0apatrick@chromium.org 943a0db227ffe90888ad760c61a63226988c974e0apatrick@chromium.orgvoid 953a0db227ffe90888ad760c61a63226988c974e0apatrick@chromium.orghandle_table_remove(struct handle_table *ht, 963a0db227ffe90888ad760c61a63226988c974e0apatrick@chromium.org unsigned handle); 973a0db227ffe90888ad760c61a63226988c974e0apatrick@chromium.org 983a0db227ffe90888ad760c61a63226988c974e0apatrick@chromium.org 993a0db227ffe90888ad760c61a63226988c974e0apatrick@chromium.orgvoid 1003a0db227ffe90888ad760c61a63226988c974e0apatrick@chromium.orghandle_table_destroy(struct handle_table *ht); 1013a0db227ffe90888ad760c61a63226988c974e0apatrick@chromium.org 1023a0db227ffe90888ad760c61a63226988c974e0apatrick@chromium.org 1033a0db227ffe90888ad760c61a63226988c974e0apatrick@chromium.orgunsigned 1043a0db227ffe90888ad760c61a63226988c974e0apatrick@chromium.orghandle_table_get_first_handle(struct handle_table *ht); 1053a0db227ffe90888ad760c61a63226988c974e0apatrick@chromium.org 1063a0db227ffe90888ad760c61a63226988c974e0apatrick@chromium.org 1073a0db227ffe90888ad760c61a63226988c974e0apatrick@chromium.orgunsigned 1083a0db227ffe90888ad760c61a63226988c974e0apatrick@chromium.orghandle_table_get_next_handle(struct handle_table *ht, 1093a0db227ffe90888ad760c61a63226988c974e0apatrick@chromium.org unsigned handle); 1103a0db227ffe90888ad760c61a63226988c974e0apatrick@chromium.org 1113a0db227ffe90888ad760c61a63226988c974e0apatrick@chromium.org 1123a0db227ffe90888ad760c61a63226988c974e0apatrick@chromium.org#ifdef __cplusplus 1133a0db227ffe90888ad760c61a63226988c974e0apatrick@chromium.org} 1143a0db227ffe90888ad760c61a63226988c974e0apatrick@chromium.org#endif 1153a0db227ffe90888ad760c61a63226988c974e0apatrick@chromium.org 1163a0db227ffe90888ad760c61a63226988c974e0apatrick@chromium.org#endif /* U_HANDLE_TABLE_H_ */ 117