summaryrefslogtreecommitdiffstats
path: root/slv2/strings.h
diff options
context:
space:
mode:
Diffstat (limited to 'slv2/strings.h')
-rw-r--r--slv2/strings.h84
1 files changed, 84 insertions, 0 deletions
diff --git a/slv2/strings.h b/slv2/strings.h
new file mode 100644
index 0000000..5a16025
--- /dev/null
+++ b/slv2/strings.h
@@ -0,0 +1,84 @@
+/* SLV2
+ * Copyright (C) 2007 Dave Robillard <http://drobilla.net>
+ *
+ * This library 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.
+ *
+ * This library 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 St, Fifth Floor, Boston, MA 02110-1301 USA.
+ */
+
+#ifndef __SLV2_STRINGS_H__
+#define __SLV2_STRINGS_H__
+
+#include <stdbool.h>
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+
+/** \defgroup strings Collections of strings
+ *
+ * SLV2Strings is an ordered collection of strings which is fast for random
+ * access by index (i.e. a fancy array).
+ *
+ * @{
+ */
+
+
+typedef void* SLV2Strings;
+
+
+/** Allocate a new, empty SLV2Strings
+ */
+SLV2Strings
+slv2_strings_new();
+
+
+/** Get the number of elements in a string list.
+ */
+unsigned
+slv2_strings_size(SLV2Strings list);
+
+
+/** Get a string from a string list at the given index.
+ *
+ * @return the element at \a index, or NULL if index is out of range.
+ *
+ * Time = O(1)
+ */
+const char*
+slv2_strings_get_at(SLV2Strings list, unsigned index);
+
+
+/** Return whether \a list contains \a string.
+ *
+ * Time = O(n)
+ */
+bool
+slv2_strings_contains(SLV2Strings list, const char* string);
+
+
+/** Free a string list.
+ */
+void
+slv2_strings_free(SLV2Strings);
+
+
+/** @} */
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif /* __SLV2_STRINGS_H__ */
+