Further hide module_t layout from plugins
[vlc.git] / src / modules / entry.c
1 /*****************************************************************************
2  * entry.c : Callbacks for module entry point
3  *****************************************************************************
4  * Copyright (C) 2001-2007 the VideoLAN team
5  *
6  * This program is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 2 of the License, or
9  * (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software
18  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
19  *****************************************************************************/
20
21 #include <vlc/vlc.h>
22 #include <assert.h>
23
24 static const char default_name[] = "unnamed";
25
26 module_t *vlc_module_create (vlc_object_t *obj)
27 {
28     module_t *module = vlc_object_create (obj, VLC_OBJECT_MODULE);
29     if (module == NULL)
30         return NULL;
31
32 #ifndef HAVE_SHARED_LIBVLC
33     module->p_symbols = &obj->p_libvlc_global->p_module_bank->symbols;
34 #endif
35     module->b_loaded = module->b_submodule = VLC_FALSE;
36     module->b_reentrant = module->b_unloadable = VLC_TRUE;
37     module->psz_object_name = module->psz_longname = default_name;
38     module->psz_help = module->psz_shortname = NULL;
39     module->pp_shortcuts[0] = default_name;
40     for (unsigned i = 1; i < MODULE_SHORTCUT_MAX; i++)
41          module->pp_shortcuts[i] = NULL;
42
43     module->i_cpu = 0;
44     module->psz_program = NULL;
45     module->psz_capability = "";
46     module->i_score = 1;
47     module->pf_activate = NULL;
48     module->pf_deactivate = NULL;
49     return module;
50 }
51
52
53 module_t *vlc_submodule_create (module_t *module)
54 {
55     assert (module != NULL);
56     assert (!module->b_submodule); // subsubmodules are not supported
57
58     module_t *submodule =
59             (module_t *)vlc_object_create (module, VLC_OBJECT_MODULE);
60     if (submodule == NULL)
61         return NULL;
62
63     vlc_object_attach (submodule, module);
64     submodule->b_submodule = VLC_TRUE;
65
66     /* Muahahaha! Heritage! Polymorphism! Ugliness!! */
67     memcpy (submodule->pp_shortcuts, module->pp_shortcuts,
68             sizeof (submodule->pp_shortcuts));
69
70     submodule->psz_object_name = module->psz_object_name;
71     submodule->psz_shortname = module->psz_shortname;
72     submodule->psz_longname = module->psz_longname;
73     submodule->psz_program = module->psz_program;
74     submodule->psz_capability = module->psz_capability;
75     submodule->i_score = module->i_score;
76     submodule->i_cpu = module->i_cpu;
77     submodule->pf_activate = NULL;
78     submodule->pf_deactivate = NULL;
79     return submodule;
80 }
81
82
83 int vlc_module_set (module_t *module, int propid, void *value)
84 {
85     switch (propid)
86     {
87         case VLC_MODULE_CPU_REQUIREMENT:
88             assert (!module->b_submodule);
89             module->i_cpu |= (int)value;
90             break;
91
92         case VLC_MODULE_SHORTCUT:
93         {
94             unsigned i;
95             for (i = 0; module->pp_shortcuts[i] != NULL; i++);
96             if (i >= MODULE_SHORTCUT_MAX)
97                 return VLC_ENOMEM;
98
99             module->pp_shortcuts[i] = (char *)value;
100             break;
101         }
102
103         case VLC_MODULE_SHORTNAME:
104             module->psz_shortname = (char *)value;
105             break;
106
107         case VLC_MODULE_DESCRIPTION:
108             module->psz_longname = (char *)value;
109             break;
110
111         case VLC_MODULE_HELP:
112             module->psz_help = (char *)value;
113             break;
114
115         case VLC_MODULE_CAPABILITY:
116             module->psz_capability = (char *)value;
117             break;
118
119         case VLC_MODULE_SCORE:
120             module->i_score = (int)value;
121             break;
122
123         case VLC_MODULE_PROGRAM:
124             module->psz_program = (char *)value;
125             break;
126
127         case VLC_MODULE_CB_OPEN:
128             module->pf_activate = (int (*) (vlc_object_t *))value;
129             break;
130
131         case VLC_MODULE_CB_CLOSE:
132             module->pf_deactivate = (void (*) (vlc_object_t *))value;
133             break;
134
135         case VLC_MODULE_UNLOADABLE:
136             module->b_unloadable = (value != NULL);
137             break;
138
139         case VLC_MODULE_NAME:
140             module->pp_shortcuts[0] = module->psz_object_name = (char *)value;
141             if (module->psz_longname == default_name)
142                 module->psz_longname = (char *)value;
143             break;
144
145         default:
146             msg_Err (module, "unknown module property %d", propid);
147             msg_Err (module, "LibVLC might be too old to use this module.");
148             return VLC_EGENERIC;
149     }
150     return 0;
151 }