Preliminary categories support.

git-svn-id: http://svn.drobilla.net/lad/slv2@465 a436a847-0d15-0410-975c-d299462d15a1

6 files changed, 163 insertions, 0 deletions

diff --git a/slv2/Makefile.am b/slv2/Makefile.am
index e20cde8..8e1b827 100644
--- a/slv2/Makefile.am
+++ b/slv2/Makefile.am
@@ -5,6 +5,8 @@ slv2include_HEADERS = \
 	types.h \
 	slv2.h \
 	world.h \
+	category.h \
+	categories.h \
 	plugin.h \
 	port.h \
 	pluginlist.h \
diff --git a/slv2/categories.h b/slv2/categories.h
new file mode 100644
index 0000000..44b9aee
--- /dev/null
+++ b/slv2/categories.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_CATEGORIES_H__
+#define __SLV2_CATEGORIES_H__
+
+#include <slv2/category.h>
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+
+typedef void* SLV2Categories;
+
+
+/** \defgroup categories Categories
+ * 
+ * @{
+ */
+
+/** Get the number of plugins in the list.
+ */
+unsigned
+slv2_categories_size(SLV2Categories list);
+
+
+/** Get a category 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.
+ */
+SLV2Category
+slv2_categories_get_by_uri(SLV2Categories 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_categories_get_length(list) will return NULL,
+ * so all categories 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.
+ */
+SLV2Category
+slv2_categories_get_at(SLV2Categories list,
+                       unsigned       index);
+
+
+/** @} */
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif /* __SLV2_CATEGORIES_H__ */
+
diff --git a/slv2/category.h b/slv2/category.h
new file mode 100644
index 0000000..1d0159f
--- /dev/null
+++ b/slv2/category.h
@@ -0,0 +1,70 @@
+/* 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_CATEGORY_H__
+#define __SLV2_CATEGORY_H__
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+#include <slv2/types.h>
+
+/** \addtogroup data
+ * @{
+ */
+
+
+/** Get the URI of this category.
+ *
+ * Returned value is owned by \a category and must not be freed by caller.
+ *
+ * Time = O(1)
+ */
+const char* slv2_category_get_uri(SLV2Category category);
+
+
+/** Get the label of this category, ie "Oscillators".
+ *
+ * Returned value is owned by \a category and must not be freed by caller.
+ *
+ * Time = O(1)
+ */
+const char* slv2_category_get_label(SLV2Category category);
+
+#if 0
+/** Get the path of this category, ie "Plugins/Generators/Oscillators".
+ *
+ * SLV2 automatically generates an ideal category heirarchy given the plugins
+ * present.  The last fragment of the path is the category's label,
+ * as returned by slv2_category_get_label.
+ *
+ * Returned value is owned by \a category and must not be freed by caller.
+ *
+ * Time = O(1)
+ */
+const char* slv2_category_get_path(SLV2Category category);
+#endif
+
+/** @} */
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif /* __SLV2_CATEGORY_H__ */
diff --git a/slv2/plugin.h b/slv2/plugin.h
index 30394d3..4db5130 100644
--- a/slv2/plugin.h
+++ b/slv2/plugin.h
@@ -134,6 +134,12 @@ char*
 slv2_plugin_get_name(SLV2Plugin plugin);
 
 
+/** Get the category this plugin belongs to.
+ */
+SLV2Category
+slv2_plugin_get_category(SLV2Plugin plugin);
+
+
 /** Get a value associated with the plugin in a plugin's data files.
  *
  * Returns the ?object of all triples found of the form:
diff --git a/slv2/slv2.h b/slv2/slv2.h
index 431bd17..a052e56 100644
--- a/slv2/slv2.h
+++ b/slv2/slv2.h
@@ -25,6 +25,7 @@ extern "C" {
 
 #include <slv2/types.h>
 #include <slv2/world.h>
+#include <slv2/category.h>
 #include <slv2/plugin.h>
 #include <slv2/port.h>
 #include <slv2/pluginlist.h>
diff --git a/slv2/types.h b/slv2/types.h
index c22b2be..f595dd1 100644
--- a/slv2/types.h
+++ b/slv2/types.h
@@ -56,6 +56,10 @@ typedef struct _Plugin* SLV2Plugin;
 typedef struct _World* SLV2World;
 
 
+/** A plugin category.  Opaque, but valid to compare to NULL. */
+typedef struct _Category* SLV2Category;
+
+
 #ifdef __cplusplus
 }
 #endif