diff options
author | David Robillard <d@drobilla.net> | 2007-04-21 01:23:59 +0000 |
---|---|---|
committer | David Robillard <d@drobilla.net> | 2007-04-21 01:23:59 +0000 |
commit | 081352a14c7c4f73113d9a491280e327eec14c83 (patch) | |
tree | 41887d3ffce2709a6d0fd7a9ea72a99f54186475 /slv2/plugins.h | |
parent | 09e5c017b096bc84bbbc0b273baffd221144213a (diff) | |
download | lilv-081352a14c7c4f73113d9a491280e327eec14c83.tar.gz lilv-081352a14c7c4f73113d9a491280e327eec14c83.tar.bz2 lilv-081352a14c7c4f73113d9a491280e327eec14c83.zip |
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
Diffstat (limited to 'slv2/plugins.h')
-rw-r--r-- | slv2/plugins.h | 95 |
1 files changed, 95 insertions, 0 deletions
diff --git a/slv2/plugins.h b/slv2/plugins.h new file mode 100644 index 0000000..7b9a5a3 --- /dev/null +++ b/slv2/plugins.h @@ -0,0 +1,95 @@ +/* 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_PLUGINS_H__ +#define __SLV2_PLUGINS_H__ + +#include <slv2/plugin.h> + +#ifdef __cplusplus +extern "C" { +#endif + + +typedef void* SLV2Plugins; + + +/** \defgroup plugins Plugin lists + * + * These functions work with lists of plugins which come from an + * SLV2World. These lists contain only a weak reference to an LV2 plugin + * in the Model. + * + * @{ + */ + + +/** Free a plugin list. + * + * Freeing a plugin list does not destroy the plugins it contains (plugins + * are owned by the world). \a list is invalid after this call. + */ +void +slv2_plugins_free(SLV2World world, + SLV2Plugins list); + + +/** Get the number of plugins in the list. + */ +unsigned +slv2_plugins_size(SLV2Plugins list); + + +/** Get a plugin 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. + */ +SLV2Plugin +slv2_plugins_get_by_uri(SLV2Plugins 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_list_get_length(list) will return NULL, + * so all plugins 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. + */ +SLV2Plugin +slv2_plugins_get_at(SLV2Plugins list, + unsigned index); + + +/** @} */ + +#ifdef __cplusplus +} +#endif + +#endif /* __SLV2_PLUGINS_H__ */ + |