1 /*****************************************************************************
2 * vlc_arrays.h : Arrays and data structures handling
3 *****************************************************************************
4 * Copyright (C) 1999-2004 the VideoLAN team
7 * Authors: Samuel Hocevar <sam@zoy.org>
8 * Clément Stenac <zorglub@videolan.org>
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; either version 2 of the License, or
13 * (at your option) any later version.
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
20 * You should have received a copy of the GNU General Public License
21 * along with this program; if not, write to the Free Software
22 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA. *****************************************************************************/
29 * This file defines functions, structures and macros for handling arrays in vlc
33 * Simple dynamic array handling. Array is realloced at each insert/removal
35 #if defined( _MSC_VER ) && _MSC_VER < 1300 && !defined( UNDER_CE )
36 # define VLCCVP (void**) /* Work-around for broken compiler */
40 #define INSERT_ELEM( p_ar, i_oldsize, i_pos, elem ) \
43 if( !i_oldsize ) (p_ar) = NULL; \
44 (p_ar) = VLCCVP realloc( p_ar, ((i_oldsize) + 1) * sizeof(*(p_ar)) ); \
45 if( (i_oldsize) - (i_pos) ) \
47 memmove( (p_ar) + (i_pos) + 1, (p_ar) + (i_pos), \
48 ((i_oldsize) - (i_pos)) * sizeof( *(p_ar) ) ); \
50 (p_ar)[i_pos] = elem; \
55 #define REMOVE_ELEM( p_ar, i_oldsize, i_pos ) \
58 if( (i_oldsize) - (i_pos) - 1 ) \
60 memmove( (p_ar) + (i_pos), \
61 (p_ar) + (i_pos) + 1, \
62 ((i_oldsize) - (i_pos) - 1) * sizeof( *(p_ar) ) ); \
66 (p_ar) = realloc( p_ar, ((i_oldsize) - 1) * sizeof( *(p_ar) ) ); \
77 #define TAB_INIT( count, tab ) \
83 #define TAB_CLEAN( count, tab ) \
90 #define TAB_APPEND_CAST( cast, count, tab, p ) \
93 (tab) = cast realloc( tab, sizeof( void ** ) * ( (count) + 1 ) ); \
95 (tab) = cast malloc( sizeof( void ** ) ); \
100 #define TAB_APPEND( count, tab, p ) \
101 TAB_APPEND_CAST( , count, tab, p )
102 #define TAB_APPEND_CPP( type, count, tab, p ) \
103 TAB_APPEND_CAST( (type**), count, tab, p )
105 #define TAB_FIND( count, tab, p, index ) \
109 for( _i_ = 0; _i_ < (count); _i_++ ) \
111 if( (tab)[_i_] == (p) ) \
120 #define TAB_REMOVE( count, tab, p ) \
123 TAB_FIND( count, tab, p, _i_index_ ); \
124 if( _i_index_ >= 0 ) \
128 memmove( ((void**)(tab) + _i_index_), \
129 ((void**)(tab) + _i_index_+1), \
130 ( (count) - _i_index_ - 1 ) * sizeof( void* ) );\
141 #define TAB_INSERT_CAST( cast, count, tab, p, index ) do { \
143 (tab) = cast realloc( tab, sizeof( void ** ) * ( (count) + 1 ) ); \
145 (tab) = cast malloc( sizeof( void ** ) ); \
146 if( (count) - (index) > 0 ) \
147 memmove( (void**)(tab) + (index) + 1, \
148 (void**)(tab) + (index), \
149 ((count) - (index)) * sizeof(*(tab)) );\
150 (tab)[(index)] = (p); \
154 #define TAB_INSERT( count, tab, p, index ) \
155 TAB_INSERT_CAST( , count, tab, p, index )
158 * Binary search in a sorted array. The key must be comparable by < and >
159 * \param entries array of entries
160 * \param count number of entries
161 * \param elem key to check within an entry (like .id, or ->i_id)
162 * \param zetype type of the key
163 * \param key value of the key
164 * \param answer index of answer within the array. -1 if not found
166 #define BSEARCH( entries, count, elem, zetype, key, answer ) \
168 int low = 0, high = count - 1; \
170 while( low <= high ) {\
171 int mid = (low + high ) / 2; /* Just don't care about 2^30 tables */ \
172 zetype mid_val = entries[mid] elem;\
173 if( mid_val < key ) \
175 else if ( mid_val > key ) \
179 answer = mid; break; \
185 /************************************************************************
186 * Dynamic arrays with progressive allocation
187 ************************************************************************/
189 /* Internal functions */
190 #define _ARRAY_ALLOC(array, newsize) { \
191 array.i_alloc = newsize; \
192 array.p_elems = VLCCVP realloc( array.p_elems, array.i_alloc * \
193 sizeof(*array.p_elems) ); \
196 #define _ARRAY_GROW1(array) { \
197 if( array.i_alloc < 10 ) \
198 _ARRAY_ALLOC(array, 10 ) \
199 else if( array.i_alloc == array.i_size ) \
200 _ARRAY_ALLOC(array, (int)(array.i_alloc * 1.5) ) \
203 #define _ARRAY_GROW(array,additional) { \
204 int i_first = array.i_alloc; \
205 while( array.i_alloc - i_first < additional ) \
207 if( array.i_alloc < 10 ) \
208 _ARRAY_ALLOC(array, 10 ) \
209 else if( array.i_alloc == array.i_size ) \
210 _ARRAY_ALLOC(array, (int)(array.i_alloc * 1.5) ) \
215 #define _ARRAY_SHRINK(array) { \
216 if( array.i_size > 10 && array.i_size < (int)(array.i_alloc / 1.5) ) { \
217 _ARRAY_ALLOC(array, array.i_size + 5); \
221 #define ARRAY_SIZE(x) (sizeof(x) / sizeof((x)[0]))
224 #define DECL_ARRAY(type) struct { \
230 #define TYPEDEF_ARRAY(type, name) typedef DECL_ARRAY(type) name;
232 #define ARRAY_INIT(array) \
235 array.p_elems = NULL;
237 #define ARRAY_RESET(array) \
240 free( array.p_elems ); array.p_elems = NULL;
242 #define ARRAY_APPEND(array, elem) { \
243 _ARRAY_GROW1(array); \
244 array.p_elems[array.i_size] = elem; \
248 #define ARRAY_INSERT(array,elem,pos) { \
249 _ARRAY_GROW1(array); \
250 if( array.i_size - pos ) { \
251 memmove( array.p_elems + pos + 1, array.p_elems + pos, \
252 (array.i_size-pos) * sizeof(*array.p_elems) ); \
254 array.p_elems[pos] = elem; \
258 #define ARRAY_REMOVE(array,pos) { \
259 if( array.i_size - (pos) - 1 ) \
261 memmove( array.p_elems + pos, array.p_elems + pos + 1, \
262 ( array.i_size - pos - 1 ) *sizeof(*array.p_elems) ); \
265 _ARRAY_SHRINK(array); \
268 #define ARRAY_VAL(array, pos) array.p_elems[pos]
270 #define ARRAY_BSEARCH(array, elem, zetype, key, answer) \
271 BSEARCH( array.p_elems, array.i_size, elem, zetype, key, answer)
273 #define FOREACH_ARRAY( item, array ) { \
275 for( fe_idx = 0 ; fe_idx < (array).i_size ; fe_idx++ ) \
277 item = (array).p_elems[fe_idx];
279 #define FOREACH_END() } }
282 /************************************************************************
283 * Dynamic arrays with progressive allocation (Preferred API)
284 ************************************************************************/
285 typedef struct vlc_array_t
291 static inline void vlc_array_init( vlc_array_t * p_array )
293 memset( p_array, 0, sizeof(vlc_array_t) );
296 static inline void vlc_array_clear( vlc_array_t * p_array )
298 free( p_array->pp_elems );
299 memset( p_array, 0, sizeof(vlc_array_t) );
302 static inline vlc_array_t * vlc_array_new( void )
304 vlc_array_t * ret = (vlc_array_t *)malloc( sizeof(vlc_array_t) );
305 if( ret ) vlc_array_init( ret );
309 static inline void vlc_array_destroy( vlc_array_t * p_array )
313 vlc_array_clear( p_array );
320 vlc_array_count( vlc_array_t * p_array )
322 return p_array->i_count;
326 vlc_array_item_at_index( vlc_array_t * p_array, int i_index )
328 return p_array->pp_elems[i_index];
332 vlc_array_index_of_item( vlc_array_t * p_array, void * item )
335 for( i = 0; i < p_array->i_count; i++)
337 if( p_array->pp_elems[i] == item )
345 vlc_array_insert( vlc_array_t * p_array, void * p_elem, int i_index )
347 TAB_INSERT_CAST( (void **), p_array->i_count, p_array->pp_elems, p_elem, i_index );
351 vlc_array_append( vlc_array_t * p_array, void * p_elem )
353 vlc_array_insert( p_array, p_elem, p_array->i_count );
357 vlc_array_remove( vlc_array_t * p_array, int i_index )
361 if( p_array->i_count > 1 )
363 memmove( p_array->pp_elems + i_index,
364 p_array->pp_elems + i_index+1,
365 ( p_array->i_count - i_index - 1 ) * sizeof( void* ) );
368 if( p_array->i_count == 0 )
370 free( p_array->pp_elems );
371 p_array->pp_elems = NULL;
377 /************************************************************************
379 ************************************************************************/
381 /* This function is not intended to be crypto-secure, we only want it to be
382 * fast and not suck too much. This one is pretty fast and did 0 collisions
383 * in wenglish's dictionary.
385 static inline uint64_t DictHash( const char *psz_string, int hashsize )
392 i_hash += *psz_string++;
393 i_hash += i_hash << 10;
394 i_hash ^= i_hash >> 8;
397 return i_hash % hashsize;
400 struct vlc_dictionary_entry_t
404 struct vlc_dictionary_entry_t * p_next;
407 typedef struct vlc_dictionary_t
410 struct vlc_dictionary_entry_t ** p_entries;
413 static void * const kVLCDictionaryNotFound = NULL;
415 static inline void vlc_dictionary_init( vlc_dictionary_t * p_dict, int i_size )
419 p_dict->p_entries = (struct vlc_dictionary_entry_t **)malloc(sizeof(struct vlc_dictionary_entry_t *) * i_size);
420 memset( p_dict->p_entries, 0, sizeof(struct vlc_dictionary_entry_t *) * i_size );
423 p_dict->p_entries = NULL;
424 p_dict->i_size = i_size;
427 static inline void vlc_dictionary_clear( vlc_dictionary_t * p_dict )
430 struct vlc_dictionary_entry_t * p_current, * p_next;
431 if( p_dict->p_entries )
433 for( i = 0; i < p_dict->i_size; i++ )
435 p_current = p_dict->p_entries[i];
438 p_next = p_current->p_next;
439 free( p_current->psz_key );
444 free( p_dict->p_entries );
452 vlc_dictionary_value_for_key( const vlc_dictionary_t * p_dict, const char * psz_key )
454 if( !p_dict->p_entries )
455 return kVLCDictionaryNotFound;
457 int i_pos = DictHash( psz_key, p_dict->i_size );
458 struct vlc_dictionary_entry_t * p_entry = p_dict->p_entries[i_pos];
461 return kVLCDictionaryNotFound;
463 /* Make sure we return the right item. (Hash collision) */
465 if( !strcmp( psz_key, p_entry->psz_key ) )
466 return p_entry->p_value;
467 p_entry = p_entry->p_next;
470 return kVLCDictionaryNotFound;
474 vlc_dictionary_keys_count( const vlc_dictionary_t * p_dict )
476 struct vlc_dictionary_entry_t * p_entry;
479 if( !p_dict->p_entries )
482 for( i = 0; i < p_dict->i_size; i++ )
484 for( p_entry = p_dict->p_entries[i]; p_entry; p_entry = p_entry->p_next ) count++;
489 static inline char **
490 vlc_dictionary_all_keys( const vlc_dictionary_t * p_dict )
492 struct vlc_dictionary_entry_t * p_entry;
494 int i, count = vlc_dictionary_keys_count( p_dict );
496 ppsz_ret = (char**)malloc(sizeof(char *) * (count + 1));
499 for( i = 0; i < p_dict->i_size; i++ )
501 for( p_entry = p_dict->p_entries[i]; p_entry; p_entry = p_entry->p_next )
502 ppsz_ret[count++] = strdup( p_entry->psz_key );
504 ppsz_ret[count] = NULL;
509 __vlc_dictionary_insert( vlc_dictionary_t * p_dict, const char * psz_key,
510 void * p_value, bool rebuild )
512 if( !p_dict->p_entries )
513 vlc_dictionary_init( p_dict, 1 );
515 int i_pos = DictHash( psz_key, p_dict->i_size );
516 struct vlc_dictionary_entry_t * p_entry;
518 p_entry = (struct vlc_dictionary_entry_t *)malloc(sizeof(struct vlc_dictionary_entry_t));
519 p_entry->psz_key = strdup( psz_key );
520 p_entry->p_value = p_value;
521 p_entry->p_next = p_dict->p_entries[i_pos];
522 p_dict->p_entries[i_pos] = p_entry;
525 /* Count how many items there was */
527 for( count = 1; p_entry->p_next; count++ ) p_entry = p_entry->p_next;
528 if( count > 3 ) /* XXX: this need tuning */
530 /* Here it starts to be not good, rebuild a bigger dictionary */
531 struct vlc_dictionary_t new_dict;
532 int i_new_size = ( (p_dict->i_size+2) * 3) / 2; /* XXX: this need tuning */
534 vlc_dictionary_init( &new_dict, i_new_size );
535 for( i = 0; i < p_dict->i_size; i++ )
537 p_entry = p_dict->p_entries[i];
540 __vlc_dictionary_insert( &new_dict, p_entry->psz_key,
542 0 /* To avoid multiple rebuild loop */);
543 p_entry = p_entry->p_next;
547 vlc_dictionary_clear( p_dict );
548 p_dict->i_size = new_dict.i_size;
549 p_dict->p_entries = new_dict.p_entries;
555 vlc_dictionary_insert( vlc_dictionary_t * p_dict, const char * psz_key, void * p_value )
557 __vlc_dictionary_insert( p_dict, psz_key, p_value, 1 );
561 vlc_dictionary_remove_value_for_key( const vlc_dictionary_t * p_dict, const char * psz_key )
563 if( !p_dict->p_entries )
566 int i_pos = DictHash( psz_key, p_dict->i_size );
567 struct vlc_dictionary_entry_t * p_entry = p_dict->p_entries[i_pos];
568 struct vlc_dictionary_entry_t * p_prev;
571 return; /* Not found, nothing to do */
576 if( !strcmp( psz_key, p_entry->psz_key ) )
579 p_dict->p_entries[i_pos] = p_entry->p_next;
581 p_prev->p_next = p_entry->p_next;
582 free( p_entry->psz_key );
587 p_entry = p_entry->p_next;
590 /* No key was found */