Fix off-by-one
[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 #include "modules/modules.h"
25 #include "libvlc.h"
26 #include "../libvlc.h"
27
28 static const char default_name[] = "unnamed";
29
30 module_t *vlc_module_create (vlc_object_t *obj)
31 {
32     module_t *module =
33         (module_t *)vlc_custom_create (obj, sizeof (module_t),
34                                        VLC_OBJECT_MODULE, "module");
35     if (module == NULL)
36         return NULL;
37
38     module->b_reentrant = module->b_unloadable = VLC_TRUE;
39     module->psz_object_name = module->psz_longname = default_name;
40     module->pp_shortcuts[0] = default_name;
41     module->i_cpu = 0;
42     module->psz_capability = "";
43     module->i_score = 1;
44     return module;
45 }
46
47
48 module_t *vlc_submodule_create (module_t *module)
49 {
50     assert (module != NULL);
51     assert (!module->b_submodule); // subsubmodules are not supported
52
53     module_t *submodule =
54         (module_t *)vlc_custom_create (VLC_OBJECT (module), sizeof (module_t),
55                                        VLC_OBJECT_MODULE, "submodule");
56     if (submodule == NULL)
57         return NULL;
58
59     vlc_object_attach (submodule, module);
60     submodule->b_submodule = VLC_TRUE;
61
62     /* Muahahaha! Heritage! Polymorphism! Ugliness!! */
63     memcpy (submodule->pp_shortcuts, module->pp_shortcuts,
64             sizeof (submodule->pp_shortcuts));
65
66     submodule->psz_object_name = module->psz_object_name;
67     submodule->psz_shortname = module->psz_shortname;
68     submodule->psz_longname = module->psz_longname;
69     submodule->psz_program = module->psz_program;
70     submodule->psz_capability = module->psz_capability;
71     submodule->i_score = module->i_score;
72     submodule->i_cpu = module->i_cpu;
73     return submodule;
74 }
75
76
77 int vlc_module_set (module_t *module, int propid, void *value)
78 {
79     switch (propid)
80     {
81         case VLC_MODULE_CPU_REQUIREMENT:
82             assert (!module->b_submodule);
83             module->i_cpu |= (int)value;
84             break;
85
86         case VLC_MODULE_SHORTCUT:
87         {
88             unsigned i;
89             for (i = 0; module->pp_shortcuts[i] != NULL; i++);
90             if (i >= (MODULE_SHORTCUT_MAX - 1))
91                 return VLC_ENOMEM;
92
93             module->pp_shortcuts[i] = (char *)value;
94             break;
95         }
96
97         case VLC_MODULE_SHORTNAME:
98             module->psz_shortname = (char *)value;
99             break;
100
101         case VLC_MODULE_DESCRIPTION:
102             module->psz_longname = (char *)value;
103             break;
104
105         case VLC_MODULE_HELP:
106             module->psz_help = (char *)value;
107             break;
108
109         case VLC_MODULE_CAPABILITY:
110             module->psz_capability = (char *)value;
111             break;
112
113         case VLC_MODULE_SCORE:
114             module->i_score = (int)value;
115             break;
116
117         case VLC_MODULE_PROGRAM:
118             module->psz_program = (char *)value;
119             break;
120
121         case VLC_MODULE_CB_OPEN:
122             module->pf_activate = (int (*) (vlc_object_t *))value;
123             break;
124
125         case VLC_MODULE_CB_CLOSE:
126             module->pf_deactivate = (void (*) (vlc_object_t *))value;
127             break;
128
129         case VLC_MODULE_UNLOADABLE:
130             module->b_unloadable = (value != NULL);
131             break;
132
133         case VLC_MODULE_NAME:
134             module->pp_shortcuts[0] = module->psz_object_name = (char *)value;
135             if (module->psz_longname == default_name)
136                 module->psz_longname = (char *)value;
137             break;
138
139         default:
140             msg_Err (module, "unknown module property %d", propid);
141             msg_Err (module, "LibVLC might be too old to use this module.");
142             return VLC_EGENERIC;
143     }
144     return 0;
145 }