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