1 /*****************************************************************************
2 * vlc_arrays.h : Arrays and data structures handling
3 *****************************************************************************
4 * Copyright (C) 1999-2004 the VideoLAN team
5 * $Id: vlc_playlist.h 17108 2006-10-15 15:28:34Z zorglub $
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. *****************************************************************************/
24 #if !defined( __LIBVLC__ )
25 #error You are not libvlc or one of its plugins. You cannot include this file
28 #ifndef _VLC_ARRAYS_H_
29 #define _VLC_ARRAYS_H_
34 * Simple dynamic array handling. Array is realloced at each insert/removal
36 #if defined( _MSC_VER ) && _MSC_VER < 1300 && !defined( UNDER_CE )
37 # define VLCCVP (void**) /* Work-around for broken compiler */
41 #define INSERT_ELEM( p_ar, i_oldsize, i_pos, elem ) \
44 if( !i_oldsize ) (p_ar) = NULL; \
45 (p_ar) = VLCCVP realloc( p_ar, ((i_oldsize) + 1) * sizeof(*(p_ar)) ); \
46 if( (i_oldsize) - (i_pos) ) \
48 memmove( (p_ar) + (i_pos) + 1, (p_ar) + (i_pos), \
49 ((i_oldsize) - (i_pos)) * sizeof( *(p_ar) ) ); \
51 (p_ar)[i_pos] = elem; \
56 #define REMOVE_ELEM( p_ar, i_oldsize, i_pos ) \
59 if( (i_oldsize) - (i_pos) - 1 ) \
61 memmove( (p_ar) + (i_pos), \
62 (p_ar) + (i_pos) + 1, \
63 ((i_oldsize) - (i_pos) - 1) * sizeof( *(p_ar) ) ); \
67 (p_ar) = realloc( p_ar, ((i_oldsize) - 1) * sizeof( *(p_ar) ) ); \
78 #define TAB_INIT( count, tab ) \
84 #define TAB_CLEAN( count, tab ) \
86 if( tab ) free( tab ); \
91 #define TAB_APPEND_CAST( cast, count, tab, p ) \
94 (tab) = cast realloc( tab, sizeof( void ** ) * ( (count) + 1 ) ); \
96 (tab) = cast malloc( sizeof( void ** ) ); \
101 #define TAB_APPEND( count, tab, p ) \
102 TAB_APPEND_CAST( , count, tab, p )
103 #define TAB_APPEND_CPP( type, count, tab, p ) \
104 TAB_APPEND_CAST( (type**), count, tab, p )
106 #define TAB_FIND( count, tab, p, index ) \
110 for( _i_ = 0; _i_ < (count); _i_++ ) \
112 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) ); \
194 assert(array.p_elems); \
197 #define _ARRAY_GROW1(array) { \
198 if( array.i_alloc < 10 ) \
199 _ARRAY_ALLOC(array, 10 ) \
200 else if( array.i_alloc == array.i_size ) \
201 _ARRAY_ALLOC(array, (int)(array.i_alloc * 1.5) ) \
204 #define _ARRAY_GROW(array,additional) { \
205 int i_first = array.i_alloc; \
206 while( array.i_alloc - i_first < additional ) \
208 if( array.i_alloc < 10 ) \
209 _ARRAY_ALLOC(array, 10 ) \
210 else if( array.i_alloc == array.i_size ) \
211 _ARRAY_ALLOC(array, (int)(array.i_alloc * 1.5) ) \
216 #define _ARRAY_SHRINK(array) { \
217 if( array.i_size > 10 && array.i_size < (int)(array.i_alloc / 1.5) ) { \
218 _ARRAY_ALLOC(array, array.i_size + 5); \
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() } }
281 /************************************************************************
283 ************************************************************************/
285 /* This function is not intended to be crypto-secure, we only want it to be
286 * fast and not suck too much. This one is pretty fast and did 0 collisions
287 * in wenglish's dictionary.
289 static inline uint64_t DictHash( const char *psz_string, int hashsize )
296 i_hash += *psz_string++;
297 i_hash += i_hash << 10;
298 i_hash ^= i_hash >> 8;
301 return i_hash % hashsize;
304 struct vlc_dictionary_entry_t
308 struct vlc_dictionary_entry_t * p_next;
311 typedef struct vlc_dictionary_t
314 struct vlc_dictionary_entry_t ** p_entries;
317 static void * const kVLCDictionaryNotFound = NULL;
319 static inline void vlc_dictionary_init( vlc_dictionary_t * p_dict, int i_size )
323 p_dict->p_entries = (struct vlc_dictionary_entry_t **)malloc(sizeof(struct vlc_dictionary_entry_t *) * i_size);
324 assert( p_dict->p_entries );
325 memset( p_dict->p_entries, 0, sizeof(struct vlc_dictionary_entry_t *) * i_size );
328 p_dict->p_entries = NULL;
329 p_dict->i_size = i_size;
332 static inline void vlc_dictionary_clear( vlc_dictionary_t * p_dict )
335 struct vlc_dictionary_entry_t * p_current, * p_next;
336 for( i = 0; i < p_dict->i_size; i++ )
338 p_current = p_dict->p_entries[i];
341 p_next = p_dict->p_entries[i]->p_next;
342 free( p_dict->p_entries[i]->psz_key );
347 free( p_dict->p_entries );
354 vlc_dictionary_value_for_key( const vlc_dictionary_t * p_dict, const char * psz_key )
356 if( !p_dict->p_entries )
357 return kVLCDictionaryNotFound;
359 int i_pos = DictHash( psz_key, p_dict->i_size );
360 struct vlc_dictionary_entry_t * p_entry = p_dict->p_entries[i_pos];
362 if( p_entry && !p_entry->p_next )
363 return p_entry->p_value;
366 return kVLCDictionaryNotFound;
370 if( !strcmp( psz_key, p_entry->psz_key ) )
371 return p_entry->p_value;
372 p_entry = p_entry->p_next;
375 return kVLCDictionaryNotFound;
379 vlc_dictionary_keys_count( const vlc_dictionary_t * p_dict )
381 struct vlc_dictionary_entry_t * p_entry;
383 for( i = 0; i < p_dict->i_size; i++ )
385 for( p_entry = p_dict->p_entries[i]; p_entry; p_entry = p_entry->p_next ) count++;
390 static inline char **
391 vlc_dictionary_all_keys( const vlc_dictionary_t * p_dict )
393 struct vlc_dictionary_entry_t * p_entry;
395 int i, count = vlc_dictionary_keys_count( p_dict );
397 ppsz_ret = (char**)malloc(sizeof(char *) * (count + 1));
401 for( i = 0; i < p_dict->i_size; i++ )
403 for( p_entry = p_dict->p_entries[i]; p_entry; p_entry = p_entry->p_next )
405 ppsz_ret[count++] = strdup( p_entry->psz_key );
409 ppsz_ret[count] = NULL;
414 __vlc_dictionary_insert( vlc_dictionary_t * p_dict, const char * psz_key,
415 void * p_value, vlc_bool_t rebuild )
417 if( !p_dict->p_entries )
418 vlc_dictionary_init( p_dict, 1 );
420 int i_pos = DictHash( psz_key, p_dict->i_size );
421 struct vlc_dictionary_entry_t * p_entry = p_dict->p_entries[i_pos];
425 p_entry = p_dict->p_entries[i_pos] = (struct vlc_dictionary_entry_t *)malloc(
426 sizeof(struct vlc_dictionary_entry_t));
429 p_entry->psz_key = strdup( psz_key );
430 assert( p_entry->psz_key );
431 p_entry->p_value = p_value;
432 p_dict->p_entries[i_pos]->p_next = NULL;
435 if( p_entry->p_value == kVLCDictionaryNotFound )
437 /* This one is fine, just high jack */
438 p_entry->psz_key = strdup( psz_key );
439 p_entry->p_value = p_value;
443 /* Hash collision here */
444 p_entry = (struct vlc_dictionary_entry_t *)malloc(sizeof(struct vlc_dictionary_entry_t));
446 p_entry->psz_key = strdup( psz_key );
447 p_entry->p_value = p_value;
448 p_entry->p_next = p_dict->p_entries[i_pos];
449 p_dict->p_entries[i_pos] = p_entry;
453 /* Count how many items there was */
455 for( count = 1; p_entry->p_next; count++ ) p_entry = p_entry->p_next;
456 if( count > 3 ) /* XXX: this need tuning */
458 /* Here it starts to be not good, rebuild a bigger dictionary */
459 struct vlc_dictionary_t new_dict;
460 int i_new_size = ( (p_dict->i_size+2) * 3) / 2; /* XXX: this need tuning */
463 vlc_dictionary_init( &new_dict, i_new_size );
464 for( i = 0; i < p_dict->i_size; i++ )
466 p_entry = p_dict->p_entries[i];
469 __vlc_dictionary_insert( &new_dict, p_entry->psz_key,
471 0 /* To avoid multiple rebuild loop */);
472 p_entry = p_entry->p_next;
475 vlc_dictionary_clear( p_dict );
476 p_dict->i_size = new_dict.i_size;
477 p_dict->p_entries= new_dict.p_entries;
483 vlc_dictionary_insert( vlc_dictionary_t * p_dict, const char * psz_key, void * p_value )
485 __vlc_dictionary_insert( p_dict, psz_key, p_value, 1 );
489 vlc_dictionary_remove_value_for_key( const vlc_dictionary_t * p_dict, const char * psz_key )
491 if( !p_dict->p_entries )
494 int i_pos = DictHash( psz_key, p_dict->i_size );
495 struct vlc_dictionary_entry_t * p_entry = p_dict->p_entries[i_pos];
496 struct vlc_dictionary_entry_t * p_prev;
499 return; /* Not found, nothing to do */
501 if( !p_entry->p_next )
503 free( p_entry->psz_key );
505 p_dict->p_entries[i_pos] = NULL;
511 if( !strcmp( psz_key, p_entry->psz_key ) )
514 p_dict->p_entries[i_pos] = p_entry->p_next;
516 p_prev->p_next = p_entry->p_next;
517 free( p_entry->psz_key );
522 p_entry = p_entry->p_next;
525 /* No key was found */