1 files changed, 94 insertions, 0 deletions
diff --git a/include/xine/sorted_array.h b/include/xine/sorted_array.h
new file mode 100644
index 000000000..0d229199a
--- /dev/null
+++ b/include/xine/sorted_array.h
@@ -0,0 +1,94 @@
+/*
+ * Copyright (C) 2000-2006 the xine project
+ *
+ * This file is part of xine, a free video player.
+ *
+ * xine is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * xine is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * 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, USA
+ *
+ * Sorted array which grows automatically when you add elements.
+ * A binary search is used to find the position of a new element.
+ *
+ * Example:
+ *   Let's create de comparison method for integers:
+ *
+ *     int int_comparator(void *a, void *b) {
+ *       if ((int)a < (int)b) {
+ *         return -1;
+ *       } else if ((int)a == (int)b) {
+ *         return 0;
+ *       } else {
+ *        return 1;
+ *       }
+ *     }
+ *
+ *   Create a sorted array for integers:
+ *     xine_sarray_t *sarray = xine_sarray_new(10, int_comparator);
+ *
+ *   Add elements:
+ *     xine_sarray_add(sarray, (void*)4);
+ *     xine_sarray_add(sarray, (void*)28);
+ *     xine_sarray_add(sarray, (void*)7);
+ *
+ *   Find an element:
+ *     int pos = xine_sarray_binary_search(sarray, (void*)7);
+ *     if (pos >= 0)
+ *       FOUND
+ *     else
+ *       NOT FOUND
+ *
+ *   Delete the array:
+ *     xine_sarray_delete(sarray);
+ */
+#ifndef XINE_SORTED_ARRAY_H
+#define XINE_SORTED_ARRAY_H
+
+#include "array.h"
+
+/* Array type */
+typedef struct xine_sarray_s xine_sarray_t;
+
+/* Array element comparator */
+typedef int (*xine_sarray_comparator_t)(void*, void*);
+
+/* Constructor */
+xine_sarray_t *xine_sarray_new(size_t initial_size, xine_sarray_comparator_t comparator) XINE_MALLOC XINE_PROTECTED;
+
+/* Destructor */
+void xine_sarray_delete(xine_sarray_t *sarray) XINE_PROTECTED;
+
+/* Returns the number of element stored in the array */
+size_t xine_sarray_size(const xine_sarray_t *sarray) XINE_PROTECTED;
+
+/* Removes all elements from an array */
+void xine_sarray_clear(xine_sarray_t *sarray) XINE_PROTECTED;
+
+/* Adds the element into the array
+   Returns the insertion position */
+int xine_sarray_add(xine_sarray_t *sarray, void *value) XINE_PROTECTED;
+
+/* Removes one element from an array at the position specified */
+void xine_sarray_remove(xine_sarray_t *sarray, unsigned int position) XINE_PROTECTED;
+
+/* Get the element at the position specified */
+void *xine_sarray_get(xine_sarray_t *sarray, unsigned int position) XINE_PROTECTED;
+
+/* Returns the index of the search key, if it is contained in the list.
+   Otherwise, (-(insertion point) - 1) or ~(insertion point).
+   The insertion point is defined as the point at which the key would be
+   inserted into the array. */
+int xine_sarray_binary_search(xine_sarray_t *sarray, void *key) XINE_PROTECTED;
+
+#endif
+