From 081352a14c7c4f73113d9a491280e327eec14c83 Mon Sep 17 00:00:00 2001
From: David Robillard <d@drobilla.net>
Date: Sat, 21 Apr 2007 01:23:59 +0000
Subject: Changed "categories" to "plugin classes" to better match RDF. Renamed
 files to match API.

git-svn-id: http://svn.drobilla.net/lad/slv2@466 a436a847-0d15-0410-975c-d299462d15a1
---
 slv2/pluginclasses.h | 80 ++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 80 insertions(+)
 create mode 100644 slv2/pluginclasses.h

(limited to 'slv2/pluginclasses.h')

diff --git a/slv2/pluginclasses.h b/slv2/pluginclasses.h
new file mode 100644
index 0000000..39177b8
--- /dev/null
+++ b/slv2/pluginclasses.h
@@ -0,0 +1,80 @@
+/* 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_PLUGIN_CLASSES_H__
+#define __SLV2_PLUGIN_CLASSES_H__
+
+#include <slv2/pluginclass.h>
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+
+typedef void* SLV2PluginClasses;
+
+
+/** \defgroup plugin_classes Plugin classes (categories)
+ * 
+ * @{
+ */
+
+/** Get the number of plugins in the list.
+ */
+unsigned
+slv2_plugin_classes_size(SLV2PluginClasses list);
+
+
+/** Get a plugin class from the list by URI.
+ *
+ * Return value is shared (stored in \a list) and must not be freed or
+ * modified by the caller in any way.
+ *
+ * Time = O(log2(n))
+ * 
+ * \return NULL if plugin with \a url not found in \a list.
+ */
+SLV2PluginClass
+slv2_plugin_classes_get_by_uri(SLV2PluginClasses list,
+                               const char*       uri);
+
+
+/** Get a plugin from the list by index.
+ *
+ * \a index has no significance other than as an index into this list.
+ * Any \a index not less than slv2_plugin_classes_get_length(list) will return NULL,
+ * so all plugin_classes in a list can be enumerated by repeated calls
+ * to this function starting with \a index = 0.
+ *
+ * Time = O(1)
+ *
+ * \return NULL if \a index out of range.
+ */
+SLV2PluginClass
+slv2_plugin_classes_get_at(SLV2PluginClasses list,
+                           unsigned          index);
+
+
+/** @} */
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif /* __SLV2_PLUGIN_CLASSES_H__ */
+
-- 
cgit v1.2.1