modules: introduce PA_MODULE_DEPRECATED() macro for marking modules deprecated
[profile/ivi/pulseaudio-panda.git] / src / pulsecore / modinfo.h
1 #ifndef foomodinfohfoo
2 #define foomodinfohfoo
3
4 /***
5   This file is part of PulseAudio.
6
7   Copyright 2004-2006 Lennart Poettering
8
9   PulseAudio is free software; you can redistribute it and/or modify
10   it under the terms of the GNU Lesser General Public License as published
11   by the Free Software Foundation; either version 2.1 of the License,
12   or (at your option) any later version.
13
14   PulseAudio is distributed in the hope that it will be useful, but
15   WITHOUT ANY WARRANTY; without even the implied warranty of
16   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17   General Public License for more details.
18
19   You should have received a copy of the GNU Lesser General Public License
20   along with PulseAudio; if not, write to the Free Software
21   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
22   USA.
23 ***/
24
25 /* Some functions for reading module meta data from PulseAudio modules */
26 #include <pulsecore/macro.h>
27
28 typedef struct pa_modinfo {
29     char *author;
30     char *description;
31     char *usage;
32     char *version;
33     char *deprecated;
34     pa_bool_t load_once;
35 } pa_modinfo;
36
37 /* Read meta data from an libtool handle */
38 pa_modinfo *pa_modinfo_get_by_handle(lt_dlhandle dl, const char *module_name);
39
40 /* Read meta data from a module file */
41 pa_modinfo *pa_modinfo_get_by_name(const char *name);
42
43 /* Free meta data */
44 void pa_modinfo_free(pa_modinfo *i);
45
46 #endif