xine-lib 1.2.12
sorted_array.h
Go to the documentation of this file.
1/*
2 * Copyright (C) 2000-2022 the xine project
3 *
4 * This file is part of xine, a free video player.
5 *
6 * xine is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
10 *
11 * xine is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110, USA
19 *
20 * Sorted array which grows automatically when you add elements.
21 * A binary search is used to find the position of a new element.
22 *
23 * Example:
24 * Let's create de comparison method for integers:
25 *
26 * int int_comparator(void *a, void *b) {
27 * if ((int)a < (int)b) {
28 * return -1;
29 * } else if ((int)a == (int)b) {
30 * return 0;
31 * } else {
32 * return 1;
33 * }
34 * }
35 *
36 * Create a sorted array for integers:
37 * xine_sarray_t *sarray = xine_sarray_new(10, int_comparator);
38 *
39 * Add elements:
40 * xine_sarray_add(sarray, (void*)4);
41 * xine_sarray_add(sarray, (void*)28);
42 * xine_sarray_add(sarray, (void*)7);
43 *
44 * Find an element:
45 * int pos = xine_sarray_binary_search(sarray, (void*)7);
46 * if (pos >= 0)
47 * FOUND
48 * else
49 * NOT FOUND
50 *
51 * Delete the array:
52 * xine_sarray_delete(sarray);
53 */
54#ifndef XINE_SORTED_ARRAY_H
55#define XINE_SORTED_ARRAY_H
56
57#include <stddef.h> /* size_t */
58#include <xine/attributes.h>
59
60/* version */
61#define XINE_SARRAY 2
62
63/* Array type */
65
66/* Array element comparator */
67typedef int (*xine_sarray_comparator_t)(void*, void*);
68
69/* Constructor */
71
72/* Destructor */
74
75/* Set mode */
76/* For both add() and binary_search(): if there are multiple matching indices,
77 * select 1 of them randomly. That is, the order of matches does not matter, just be fast. */
78#define XINE_SARRAY_MODE_DEFAULT 0x00000000
79/* select the first match. */
80#define XINE_SARRAY_MODE_FIRST 0x80000000
81/* select the last match (+ 1 if found). */
82#define XINE_SARRAY_MODE_LAST 0x40000000
83/* For add(): if there is a match already, dont add another copy,
84 * and return ~(found_index) instead. */
85#define XINE_SARRAY_MODE_UNIQUE 0x20000000
86void xine_sarray_set_mode (xine_sarray_t *sarray, unsigned int mode) XINE_PROTECTED;
87
88/* Returns the number of element stored in the array */
90
91/* Removes all elements from an array */
93
94/* Adds the element into the array
95 Returns the insertion position */
96int xine_sarray_add(xine_sarray_t *sarray, void *value) XINE_PROTECTED;
97
98/* Removes one element from an array at the position specified */
99void xine_sarray_remove(xine_sarray_t *sarray, unsigned int position) XINE_PROTECTED;
100
101/* Removes one element from an array by user pointer.
102 * Return the index it was found at, or ~0. */
104
105/* Get the element at the position specified */
106void *xine_sarray_get(xine_sarray_t *sarray, unsigned int position) XINE_PROTECTED;
107
108/* Returns the index of the search key, if it is contained in the list.
109 Otherwise, (-(insertion point) - 1) or ~(insertion point).
110 The insertion point is defined as the point at which the key would be
111 inserted into the array. */
113
114/* XINE_SARRAY >= 2: update the location of an existing entry,
115 * eg from a stack dummy to a neqly allocted real object.
116 * new_ptr == NULL does the same as xine_sarray_remove ().
117 * WARNING: this does _not_ recheck the sort order. */
118void xine_sarray_move_location (xine_sarray_t *sarray, void *new_ptr, unsigned int position) XINE_PROTECTED;
119
120#endif
121
#define XINE_MALLOC
Definition: attributes.h:141
#define XINE_PROTECTED
Definition: attributes.h:75
void xine_sarray_remove(xine_sarray_t *sarray, unsigned int position)
Definition: sorted_array.c:189
void xine_sarray_set_mode(xine_sarray_t *sarray, unsigned int mode)
Definition: sorted_array.c:144
int xine_sarray_binary_search(xine_sarray_t *sarray, void *key)
Definition: sorted_array.c:101
int xine_sarray_remove_ptr(xine_sarray_t *sarray, void *ptr)
Definition: sorted_array.c:206
void * xine_sarray_get(xine_sarray_t *sarray, unsigned int position)
Definition: sorted_array.c:153
void xine_sarray_clear(xine_sarray_t *sarray)
Definition: sorted_array.c:161
int(* xine_sarray_comparator_t)(void *, void *)
Definition: sorted_array.h:67
void xine_sarray_move_location(xine_sarray_t *sarray, void *new_ptr, unsigned int position)
Definition: sorted_array.c:170
size_t xine_sarray_size(const xine_sarray_t *sarray)
Definition: sorted_array.c:140
void xine_sarray_delete(xine_sarray_t *sarray)
Definition: sorted_array.c:132
int xine_sarray_add(xine_sarray_t *sarray, void *value)
Definition: sorted_array.c:278
xine_sarray_t * xine_sarray_new(size_t initial_size, xine_sarray_comparator_t comparator)
Definition: sorted_array.c:111
Definition: sorted_array.c:34
xine_sarray_comparator_t comparator
Definition: sorted_array.c:38
enable disable number of frames of telecine pattern sync required before mode change make frames evenly spaced for film mode(24 fps)" ) PARAM_ITEM( POST_PARAM_TYPE_BOOL
char key[16]
Definition: xine_speex_decoder.c:94