1 /*****************************************************************************
2 * null.c : NULL module for vlc
3 *****************************************************************************
4 * Copyright (C) 2000 VideoLAN
6 * Authors: Samuel Hocevar <sam@zoy.org>
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software
20 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111, USA.
21 *****************************************************************************/
23 #define MODULE_NAME null
25 /*****************************************************************************
27 *****************************************************************************/
30 #include <stdlib.h> /* malloc(), free() */
31 #include <string.h> /* strdup() */
34 #include "common.h" /* boolean_t, byte_t */
39 #include "modules_inner.h"
41 /*****************************************************************************
42 * Build configuration tree.
43 *****************************************************************************/
45 ADD_WINDOW( "Configuration for null module" )
46 ADD_PANE( "First pane" )
47 ADD_FRAME( "First frame" )
48 ADD_COMMENT( "You can put whatever you want here." )
49 ADD_STRING( "Random text: ", MODULE_VAR(text), NULL )
50 ADD_FRAME( "Second frame" )
51 ADD_COMMENT( "The file below is not used." )
52 ADD_FILE( "Select file: ", MODULE_VAR(file), NULL )
53 ADD_FRAME( "Third frame" )
54 ADD_COMMENT( "This space intentionally left blank." )
55 ADD_PANE( "Second pane" )
57 ADD_COMMENT( "There is nothing in this frame." )
60 /*****************************************************************************
61 * InitModule: get the module structure and configuration.
62 *****************************************************************************
63 * We have to fill psz_name, psz_longname and psz_version. These variables
64 * will be strdup()ed later by the main application because the module can
65 * be unloaded later to save memory, and we want to be able to access this
66 * data even after the module has been unloaded.
67 *****************************************************************************/
70 p_module->psz_name = MODULE_STRING;
71 p_module->psz_longname = "the Null module that does nothing";
72 p_module->psz_version = VERSION;
74 p_module->i_capabilities = MODULE_CAPABILITY_NULL;
79 /*****************************************************************************
80 * ActivateModule: set the module to an usable state.
81 *****************************************************************************
82 * This function fills the capability functions and the configuration
83 * structure. Once ActivateModule() has been called, the i_usage can
84 * be set to 0 and calls to NeedModule() be made to increment it. To unload
85 * the module, one has to wait until i_usage == 0 and call DeactivateModule().
86 *****************************************************************************/
89 /* Since the Null module can't do anything, there is no need to
90 * fill the p_functions structure. */
91 p_module->p_functions = NULL;
92 p_module->p_config = p_config;
97 /*****************************************************************************
98 * DeactivateModule: make sure the module can be unloaded.
99 *****************************************************************************
100 * This function must only be called when i_usage == 0. If it successfully
101 * returns, i_usage can be set to -1 and the module unloaded. Be careful to
102 * lock usage_lock during the whole process.
103 *****************************************************************************/
106 /* We didn't allocate p_functions - so we don't have to free it */