X-Git-Url: https://git.sesse.net/?a=blobdiff_plain;f=include%2Fvlc_arrays.h;h=b8dbae473ccc7f428c7f79a3ed9ff90fb2eae9aa;hb=12ade3e3bc975d5426ba4af155b7372c31093b31;hp=9073f82bfa89d98caee131a39dc86671e11e5ecb;hpb=2fa6989d9c4578258de43fe11fecba5e170f7883;p=vlc diff --git a/include/vlc_arrays.h b/include/vlc_arrays.h index 9073f82bfa..b8dbae473c 100644 --- a/include/vlc_arrays.h +++ b/include/vlc_arrays.h @@ -2,7 +2,7 @@ * vlc_arrays.h : Arrays and data structures handling ***************************************************************************** * Copyright (C) 1999-2004 the VideoLAN team - * $Id: vlc_playlist.h 17108 2006-10-15 15:28:34Z zorglub $ + * $Id$ * * Authors: Samuel Hocevar * Clément Stenac @@ -19,16 +19,23 @@ * * You should have received a copy of the GNU General Public License * along with this program; if not, write to the Free Software - * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA. *****************************************************************************/ + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA. + *****************************************************************************/ -#if !defined( __LIBVLC__ ) - #error You are not libvlc or one of its plugins. You cannot include this file -#endif +#ifndef VLC_ARRAYS_H_ +#define VLC_ARRAYS_H_ -#ifndef _VLC_ARRAYS_H_ -#define _VLC_ARRAYS_H_ +/** + * \file + * This file defines functions, structures and macros for handling arrays in vlc + */ -#include +/* realloc() that never fails *if* downsizing */ +static inline void *realloc_down( void *ptr, size_t size ) +{ + void *ret = realloc( ptr, size ); + return ret ? ret : ptr; +} /** * Simple dynamic array handling. Array is realloced at each insert/removal @@ -41,37 +48,36 @@ #define INSERT_ELEM( p_ar, i_oldsize, i_pos, elem ) \ do \ { \ - if( !i_oldsize ) (p_ar) = NULL; \ + if( !(i_oldsize) ) (p_ar) = NULL; \ (p_ar) = VLCCVP realloc( p_ar, ((i_oldsize) + 1) * sizeof(*(p_ar)) ); \ + if( !(p_ar) ) abort(); \ if( (i_oldsize) - (i_pos) ) \ { \ memmove( (p_ar) + (i_pos) + 1, (p_ar) + (i_pos), \ ((i_oldsize) - (i_pos)) * sizeof( *(p_ar) ) ); \ } \ - (p_ar)[i_pos] = elem; \ + (p_ar)[(i_pos)] = elem; \ (i_oldsize)++; \ } \ while( 0 ) -#define REMOVE_ELEM( p_ar, i_oldsize, i_pos ) \ +#define REMOVE_ELEM( p_ar, i_size, i_pos ) \ do \ { \ - if( (i_oldsize) - (i_pos) - 1 ) \ + if( (i_size) - (i_pos) - 1 ) \ { \ memmove( (p_ar) + (i_pos), \ (p_ar) + (i_pos) + 1, \ - ((i_oldsize) - (i_pos) - 1) * sizeof( *(p_ar) ) ); \ - } \ - if( i_oldsize > 1 ) \ - { \ - (p_ar) = realloc( p_ar, ((i_oldsize) - 1) * sizeof( *(p_ar) ) ); \ + ((i_size) - (i_pos) - 1) * sizeof( *(p_ar) ) ); \ } \ + if( i_size > 1 ) \ + (p_ar) = realloc_down( p_ar, ((i_size) - 1) * sizeof( *(p_ar) ) );\ else \ { \ free( p_ar ); \ (p_ar) = NULL; \ } \ - (i_oldsize)--; \ + (i_size)--; \ } \ while( 0 ) @@ -83,7 +89,7 @@ #define TAB_CLEAN( count, tab ) \ do { \ - if( tab ) free( tab ); \ + free( tab ); \ (count)= 0; \ (tab)= NULL; \ } while(0) @@ -94,6 +100,7 @@ (tab) = cast realloc( tab, sizeof( void ** ) * ( (count) + 1 ) ); \ else \ (tab) = cast malloc( sizeof( void ** ) ); \ + if( !(tab) ) abort(); \ (tab)[count] = (p); \ (count)++; \ } while(0) @@ -117,6 +124,7 @@ } \ } while(0) + #define TAB_REMOVE( count, tab, p ) \ do { \ int _i_index_; \ @@ -143,6 +151,7 @@ (tab) = cast realloc( tab, sizeof( void ** ) * ( (count) + 1 ) ); \ else \ (tab) = cast malloc( sizeof( void ** ) ); \ + if( !(tab) ) abort(); \ if( (count) - (index) > 0 ) \ memmove( (void**)(tab) + (index) + 1, \ (void**)(tab) + (index), \ @@ -181,19 +190,216 @@ } \ } while(0) + /************************************************************************ - * Dictionaries + * Dynamic arrays with progressive allocation + ************************************************************************/ + +/* Internal functions */ +#define _ARRAY_ALLOC(array, newsize) { \ + (array).i_alloc = newsize; \ + (array).p_elems = VLCCVP realloc( (array).p_elems, (array).i_alloc * \ + sizeof(*(array).p_elems) ); \ + if( !(array).p_elems ) abort(); \ +} + +#define _ARRAY_GROW1(array) { \ + if( (array).i_alloc < 10 ) \ + _ARRAY_ALLOC(array, 10 ) \ + else if( (array).i_alloc == (array).i_size ) \ + _ARRAY_ALLOC(array, (int)(array.i_alloc * 1.5) ) \ +} + +#define _ARRAY_GROW(array,additional) { \ + int i_first = (array).i_alloc; \ + while( (array).i_alloc - i_first < additional ) \ + { \ + if( (array).i_alloc < 10 ) \ + _ARRAY_ALLOC(array, 10 ) \ + else if( (array).i_alloc == (array).i_size ) \ + _ARRAY_ALLOC(array, (int)((array).i_alloc * 1.5) ) \ + else break; \ + } \ +} + +#define _ARRAY_SHRINK(array) { \ + if( (array).i_size > 10 && (array).i_size < (int)((array).i_alloc / 1.5) ) { \ + _ARRAY_ALLOC(array, (array).i_size + 5); \ + } \ +} + +#define ARRAY_SIZE(x) (sizeof(x) / sizeof((x)[0])) + +/* API */ +#define DECL_ARRAY(type) struct { \ + int i_alloc; \ + int i_size; \ + type *p_elems; \ +} + +#define TYPEDEF_ARRAY(type, name) typedef DECL_ARRAY(type) name; + +#define ARRAY_INIT(array) \ + do { \ + (array).i_alloc = 0; \ + (array).i_size = 0; \ + (array).p_elems = NULL; \ + } while(0) + +#define ARRAY_RESET(array) \ + do { \ + (array).i_alloc = 0; \ + (array).i_size = 0; \ + free( (array).p_elems ); (array).p_elems = NULL; \ + } while(0) + +#define ARRAY_APPEND(array, elem) \ + do { \ + _ARRAY_GROW1(array); \ + (array).p_elems[(array).i_size] = elem; \ + (array).i_size++; \ + } while(0) + +#define ARRAY_INSERT(array,elem,pos) \ + do { \ + _ARRAY_GROW1(array); \ + if( (array).i_size - pos ) { \ + memmove( (array).p_elems + pos + 1, (array).p_elems + pos, \ + ((array).i_size-pos) * sizeof(*(array).p_elems) ); \ + } \ + (array).p_elems[pos] = elem; \ + (array).i_size++; \ + } while(0) + +#define ARRAY_REMOVE(array,pos) \ + do { \ + if( (array).i_size - (pos) - 1 ) \ + { \ + memmove( (array).p_elems + pos, (array).p_elems + pos + 1, \ + ( (array).i_size - pos - 1 ) *sizeof(*(array).p_elems) ); \ + } \ + (array).i_size--; \ + _ARRAY_SHRINK(array); \ + } while(0) + +#define ARRAY_VAL(array, pos) array.p_elems[pos] + +#define ARRAY_BSEARCH(array, elem, zetype, key, answer) \ + BSEARCH( (array).p_elems, (array).i_size, elem, zetype, key, answer) + +#define FOREACH_ARRAY( item, array ) { \ + int fe_idx; \ + for( fe_idx = 0 ; fe_idx < (array).i_size ; fe_idx++ ) \ + { \ + item = (array).p_elems[fe_idx]; + +#define FOREACH_END() } } + + +/************************************************************************ + * Dynamic arrays with progressive allocation (Preferred API) ************************************************************************/ +typedef struct vlc_array_t +{ + int i_count; + void ** pp_elems; +} vlc_array_t; -#ifdef __cplus_plus__ -extern "C" +static inline void vlc_array_init( vlc_array_t * p_array ) { -#endif + memset( p_array, 0, sizeof(vlc_array_t) ); +} + +static inline void vlc_array_clear( vlc_array_t * p_array ) +{ + free( p_array->pp_elems ); + memset( p_array, 0, sizeof(vlc_array_t) ); +} + +static inline vlc_array_t * vlc_array_new( void ) +{ + vlc_array_t * ret = (vlc_array_t *)malloc( sizeof(vlc_array_t) ); + if( ret ) vlc_array_init( ret ); + return ret; +} + +static inline void vlc_array_destroy( vlc_array_t * p_array ) +{ + if( !p_array ) + return; + vlc_array_clear( p_array ); + free( p_array ); +} + + +/* Read */ +static inline int +vlc_array_count( vlc_array_t * p_array ) +{ + return p_array->i_count; +} + +static inline void * +vlc_array_item_at_index( vlc_array_t * p_array, int i_index ) +{ + return p_array->pp_elems[i_index]; +} + +static inline int +vlc_array_index_of_item( vlc_array_t * p_array, void * item ) +{ + int i; + for( i = 0; i < p_array->i_count; i++) + { + if( p_array->pp_elems[i] == item ) + return i; + } + return -1; +} + +/* Write */ +static inline void +vlc_array_insert( vlc_array_t * p_array, void * p_elem, int i_index ) +{ + TAB_INSERT_CAST( (void **), p_array->i_count, p_array->pp_elems, p_elem, i_index ); +} + +static inline void +vlc_array_append( vlc_array_t * p_array, void * p_elem ) +{ + vlc_array_insert( p_array, p_elem, p_array->i_count ); +} + +static inline void +vlc_array_remove( vlc_array_t * p_array, int i_index ) +{ + if( i_index >= 0 ) + { + if( p_array->i_count > 1 ) + { + memmove( p_array->pp_elems + i_index, + p_array->pp_elems + i_index+1, + ( p_array->i_count - i_index - 1 ) * sizeof( void* ) ); + } + p_array->i_count--; + if( p_array->i_count == 0 ) + { + free( p_array->pp_elems ); + p_array->pp_elems = NULL; + } + } +} + + +/************************************************************************ + * Dictionaries + ************************************************************************/ + /* This function is not intended to be crypto-secure, we only want it to be * fast and not suck too much. This one is pretty fast and did 0 collisions * in wenglish's dictionary. */ -static inline uint64_t DictHash( const char *psz_string ) +static inline uint64_t DictHash( const char *psz_string, int hashsize ) { uint64_t i_hash = 0; if( psz_string ) @@ -205,221 +411,210 @@ static inline uint64_t DictHash( const char *psz_string ) i_hash ^= i_hash >> 8; } } - return i_hash; + return i_hash % hashsize; } +typedef struct vlc_dictionary_entry_t +{ + char * psz_key; + void * p_value; + struct vlc_dictionary_entry_t * p_next; +} vlc_dictionary_entry_t; + typedef struct vlc_dictionary_t { - struct vlc_dictionary_entries_t - { - char * psz_key; - uint64_t i_hash; - void * p_value; - } * p_entries; - int i_entries; + int i_size; + vlc_dictionary_entry_t ** p_entries; } vlc_dictionary_t; -static void * const kVLCDictionaryNotFound = (void *)-1; +static void * const kVLCDictionaryNotFound = NULL; -static inline void vlc_dictionary_init( vlc_dictionary_t * p_dict ) +static inline void vlc_dictionary_init( vlc_dictionary_t * p_dict, int i_size ) { - p_dict->i_entries = 0; p_dict->p_entries = NULL; + + if( i_size > 0 ) + { + p_dict->p_entries = (vlc_dictionary_entry_t **)calloc( i_size, sizeof(*p_dict->p_entries) ); + if( !p_dict->p_entries ) + i_size = 0; + } + p_dict->i_size = i_size; } -static inline void vlc_dictionary_clear( vlc_dictionary_t * p_dict ) +static inline void vlc_dictionary_clear( vlc_dictionary_t * p_dict, + void ( * pf_free )( void * p_data, void * p_obj ), + void * p_obj ) { - int i; - for ( i = 0; i < p_dict->i_entries; i++ ) + if( p_dict->p_entries ) { - free( p_dict->p_entries[i].psz_key ); + for( int i = 0; i < p_dict->i_size; i++ ) + { + vlc_dictionary_entry_t * p_current, * p_next; + p_current = p_dict->p_entries[i]; + while( p_current ) + { + p_next = p_current->p_next; + if( pf_free != NULL ) + ( * pf_free )( p_current->p_value, p_obj ); + free( p_current->psz_key ); + free( p_current ); + p_current = p_next; + } + } + free( p_dict->p_entries ); + p_dict->p_entries = NULL; } - free( p_dict->p_entries ); - p_dict->i_entries = 0; - p_dict->p_entries = NULL; + p_dict->i_size = 0; } + static inline void * -vlc_dictionary_value_for_key( vlc_dictionary_t * p_dict, const char * psz_key ) +vlc_dictionary_value_for_key( const vlc_dictionary_t * p_dict, const char * psz_key ) { - uint64_t i_hash; - int i, i_pos; - - if( p_dict->i_entries == 0 ) + if( !p_dict->p_entries ) return kVLCDictionaryNotFound; - i_hash = DictHash( psz_key ); - BSEARCH( p_dict->p_entries, p_dict->i_entries, .i_hash, uint64_t, - i_hash, i_pos ); - if( i_pos == -1 ) + int i_pos = DictHash( psz_key, p_dict->i_size ); + vlc_dictionary_entry_t * p_entry = p_dict->p_entries[i_pos]; + + if( !p_entry ) return kVLCDictionaryNotFound; - /* Hash found, let's check it looks like the entry */ - if( !strcmp( psz_key, p_dict->p_entries[i_pos].psz_key ) ) - return p_dict->p_entries[i_pos].p_value; + /* Make sure we return the right item. (Hash collision) */ + do { + if( !strcmp( psz_key, p_entry->psz_key ) ) + return p_entry->p_value; + p_entry = p_entry->p_next; + } while( p_entry ); - /* Hash collision! This should be very rare, but we cannot guarantee - * it will never happen. Just do an exhaustive search amongst all - * entries with the same hash. */ - for( i = i_pos - 1 ; i > 0 && i_hash == p_dict->p_entries[i].i_hash ; i-- ) + return kVLCDictionaryNotFound; +} + +static inline int +vlc_dictionary_keys_count( const vlc_dictionary_t * p_dict ) +{ + vlc_dictionary_entry_t * p_entry; + int i, count = 0; + + if( !p_dict->p_entries ) + return 0; + + for( i = 0; i < p_dict->i_size; i++ ) { - if( !strcmp( psz_key, p_dict->p_entries[i].psz_key ) ) - return p_dict->p_entries[i_pos].p_value; + for( p_entry = p_dict->p_entries[i]; p_entry; p_entry = p_entry->p_next ) count++; } - for( i = i_pos + 1 ; i < p_dict->i_entries && - i_hash == p_dict->p_entries[i].i_hash ; i++ ) + return count; +} + +static inline char ** +vlc_dictionary_all_keys( const vlc_dictionary_t * p_dict ) +{ + vlc_dictionary_entry_t * p_entry; + char ** ppsz_ret; + int i, count = vlc_dictionary_keys_count( p_dict ); + + ppsz_ret = (char**)malloc(sizeof(char *) * (count + 1)); + + count = 0; + for( i = 0; i < p_dict->i_size; i++ ) { - if( !strcmp( psz_key, p_dict->p_entries[i].psz_key )) - return p_dict->p_entries[i_pos].p_value; + for( p_entry = p_dict->p_entries[i]; p_entry; p_entry = p_entry->p_next ) + ppsz_ret[count++] = strdup( p_entry->psz_key ); } - /* Hash found, but entry not found (shouldn't happen!) */ - return kVLCDictionaryNotFound; + ppsz_ret[count] = NULL; + return ppsz_ret; } static inline void -vlc_dictionary_insert( vlc_dictionary_t * p_dict, const char * psz_key, void * p_value ) +__vlc_dictionary_insert( vlc_dictionary_t * p_dict, const char * psz_key, + void * p_value, bool rebuild ) { - uint64_t i_hash = DictHash( psz_key ); - int i_new; - - /* First, caller should take care not to insert twice the same key */ - /* This could be removed for optimization */ - assert( vlc_dictionary_value_for_key( p_dict, psz_key ) == kVLCDictionaryNotFound ); - - /* Find a free slot */ - if( p_dict->i_entries == 0 || i_hash <= p_dict->p_entries[0].i_hash ) - i_new = 0; - else if( i_hash >= p_dict->p_entries[p_dict->i_entries-1].i_hash ) - i_new = p_dict->i_entries; - else + if( !p_dict->p_entries ) + vlc_dictionary_init( p_dict, 1 ); + + int i_pos = DictHash( psz_key, p_dict->i_size ); + vlc_dictionary_entry_t * p_entry; + + p_entry = (vlc_dictionary_entry_t *)malloc(sizeof(*p_entry)); + p_entry->psz_key = strdup( psz_key ); + p_entry->p_value = p_value; + p_entry->p_next = p_dict->p_entries[i_pos]; + p_dict->p_entries[i_pos] = p_entry; + if( rebuild ) { - int i_low = 0, i_high = p_dict->i_entries - 1; - while( i_high - i_low > 1 ) + /* Count how many items there was */ + int count; + for( count = 1; p_entry->p_next; count++ ) + p_entry = p_entry->p_next; + if( count > 3 ) /* XXX: this need tuning */ { - int i_mid = (i_low + i_high)/2; - if( p_dict->p_entries[i_mid].i_hash < i_hash ) { - i_low = i_mid; - } else if( p_dict->p_entries[i_mid].i_hash > i_hash ) { - i_high = i_mid; + /* Here it starts to be not good, rebuild a bigger dictionary */ + struct vlc_dictionary_t new_dict; + int i_new_size = ( (p_dict->i_size+2) * 3) / 2; /* XXX: this need tuning */ + int i; + vlc_dictionary_init( &new_dict, i_new_size ); + for( i = 0; i < p_dict->i_size; i++ ) + { + p_entry = p_dict->p_entries[i]; + while( p_entry ) + { + __vlc_dictionary_insert( &new_dict, p_entry->psz_key, + p_entry->p_value, + false /* To avoid multiple rebuild loop */); + p_entry = p_entry->p_next; + } } + + vlc_dictionary_clear( p_dict, NULL, NULL ); + p_dict->i_size = new_dict.i_size; + p_dict->p_entries = new_dict.p_entries; } - if( p_dict->p_entries[i_low].i_hash < i_hash ) - i_new = i_high; - else - i_new = i_low; } - p_dict->p_entries = realloc( p_dict->p_entries, (p_dict->i_entries + 1) * - sizeof(struct vlc_dictionary_entries_t) ); - p_dict->i_entries++; - if( i_new != p_dict->i_entries -1 ) - { - memmove( &p_dict->p_entries[i_new+1], &p_dict->p_entries[i_new], - ( p_dict->i_entries - i_new - 1 ) * - sizeof(struct vlc_dictionary_entries_t) ); - } - - p_dict->p_entries[i_new].i_hash = i_hash; - p_dict->p_entries[i_new].psz_key = strdup( psz_key ); - p_dict->p_entries[i_new].p_value = p_value; -} -#ifdef __cplus_plus__ -} /* extern "C" */ -#endif -/************************************************************************ - * Dynamic arrays with progressive allocation - ************************************************************************/ - -/* Internal functions */ -#define _ARRAY_ALLOC(array, newsize) { \ - array.i_alloc = newsize; \ - array.p_elems = VLCCVP realloc( array.p_elems, array.i_alloc * \ - sizeof(*array.p_elems) ); \ - assert(array.p_elems); \ -} - -#define _ARRAY_GROW1(array) { \ - if( array.i_alloc < 10 ) \ - _ARRAY_ALLOC(array, 10 ) \ - else if( array.i_alloc == array.i_size ) \ - _ARRAY_ALLOC(array, (int)(array.i_alloc * 1.5) ) \ -} - -#define _ARRAY_GROW(array,additional) { \ - int i_first = array.i_alloc; \ - while( array.i_alloc - i_first < additional ) \ - { \ - if( array.i_alloc < 10 ) \ - _ARRAY_ALLOC(array, 10 ) \ - else if( array.i_alloc == array.i_size ) \ - _ARRAY_ALLOC(array, (int)(array.i_alloc * 1.5) ) \ - else break; \ - } \ } -#define _ARRAY_SHRINK(array) { \ - if( array.i_size > 10 && array.i_size < (int)(array.i_alloc / 1.5) ) { \ - _ARRAY_ALLOC(array, array.i_size + 5); \ - } \ -} - - -/* API */ -#define DECL_ARRAY(type) struct { \ - int i_alloc; \ - int i_size; \ - type *p_elems; \ +static inline void +vlc_dictionary_insert( vlc_dictionary_t * p_dict, const char * psz_key, void * p_value ) +{ + __vlc_dictionary_insert( p_dict, psz_key, p_value, true ); } -#define TYPEDEF_ARRAY(type, name) typedef DECL_ARRAY(type) name; +static inline void +vlc_dictionary_remove_value_for_key( const vlc_dictionary_t * p_dict, const char * psz_key, + void ( * pf_free )( void * p_data, void * p_obj ), + void * p_obj ) +{ + if( !p_dict->p_entries ) + return; -#define ARRAY_INIT(array) \ - array.i_alloc = 0; \ - array.i_size = 0; \ - array.p_elems = NULL; + int i_pos = DictHash( psz_key, p_dict->i_size ); + vlc_dictionary_entry_t * p_entry = p_dict->p_entries[i_pos]; + vlc_dictionary_entry_t * p_prev; -#define ARRAY_RESET(array) \ - array.i_alloc = 0; \ - array.i_size = 0; \ - free( array.p_elems ); array.p_elems = NULL; + if( !p_entry ) + return; /* Not found, nothing to do */ -#define ARRAY_APPEND(array, elem) { \ - _ARRAY_GROW1(array); \ - array.p_elems[array.i_size] = elem; \ - array.i_size++; \ -} - -#define ARRAY_INSERT(array,elem,pos) { \ - _ARRAY_GROW1(array); \ - if( array.i_size - pos ) { \ - memmove( array.p_elems + pos + 1, array.p_elems + pos, \ - (array.i_size-pos) * sizeof(*array.p_elems) ); \ - } \ - array.p_elems[pos] = elem; \ - array.i_size++; \ -} + /* Hash collision */ + p_prev = NULL; + do { + if( !strcmp( psz_key, p_entry->psz_key ) ) + { + if( pf_free != NULL ) + ( * pf_free )( p_entry->p_value, p_obj ); + if( !p_prev ) + p_dict->p_entries[i_pos] = p_entry->p_next; + else + p_prev->p_next = p_entry->p_next; + free( p_entry->psz_key ); + free( p_entry ); + return; + } + p_prev = p_entry; + p_entry = p_entry->p_next; + } while( p_entry ); -#define ARRAY_REMOVE(array,pos) { \ - if( array.i_size - (pos) - 1 ) \ - { \ - memmove( array.p_elems + pos, array.p_elems + pos + 1, \ - ( array.i_size - pos - 1 ) *sizeof(*array.p_elems) ); \ - } \ - array.i_size--; \ - _ARRAY_SHRINK(array); \ + /* No key was found */ } -#define ARRAY_VAL(array, pos) array.p_elems[pos] - -#define ARRAY_BSEARCH(array, elem, zetype, key, answer) \ - BSEARCH( array.p_elems, array.i_size, elem, zetype, key, answer) - -#define FOREACH_ARRAY( item, array ) { \ - int fe_idx; \ - for( fe_idx = 0 ; fe_idx < array.i_size ; fe_idx++ ) \ - { \ - item = array.p_elems[fe_idx]; - -#define FOREACH_END() } } - #endif