git.sesse.net Git - vlc/blob - plugins/text/ncurses.c

   1 /*****************************************************************************
   2  * ncurses.c : NCurses plugin for vlc
   3  *****************************************************************************
   4  * Copyright (C) 2001 VideoLAN
   5  *
   6  * Authors: Samuel Hocevar <sam@zoy.org>
   7  *
   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.
  12  *
  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.
  17  *
  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  *****************************************************************************/
  22
  23 #define MODULE_NAME ncurses
  24
  25 /*****************************************************************************
  26  * Preamble
  27  *****************************************************************************/
  28 #include "defs.h"
  29
  30 #include <stdlib.h>                                      /* malloc(), free() */
  31
  32 #include "config.h"
  33 #include "common.h"                                     /* boolean_t, byte_t */
  34 #include "threads.h"
  35 #include "mtime.h"
  36
  37 #include "modules.h"
  38 #include "modules_inner.h"
  39
  40 /*****************************************************************************
  41  * Building configuration tree
  42  *****************************************************************************/
  43 MODULE_CONFIG_START
  44 ADD_WINDOW( "Configuration for NCurses module" )
  45     ADD_COMMENT( "For now, the NCurses module cannot be configured" )
  46 MODULE_CONFIG_END
  47
  48 /*****************************************************************************
  49  * Capabilities defined in the other files.
  50  ******************************************************************************/
  51 extern void intf_getfunctions( function_list_t * p_function_list );
  52
  53 /*****************************************************************************
  54  * InitModule: get the module structure and configuration.
  55  *****************************************************************************
  56  * We have to fill psz_name, psz_longname and psz_version. These variables
  57  * will be strdup()ed later by the main application because the module can
  58  * be unloaded later to save memory, and we want to be able to access this
  59  * data even after the module has been unloaded.
  60  *****************************************************************************/
  61 int InitModule( module_t * p_module )
  62 {
  63     p_module->psz_name = MODULE_STRING;
  64     p_module->psz_longname = "ncurses interface module";
  65     p_module->psz_version = VERSION;
  66
  67     p_module->i_capabilities = MODULE_CAPABILITY_NULL
  68                                 | MODULE_CAPABILITY_INTF;
  69
  70     return( 0 );
  71 }
  72
  73 /*****************************************************************************
  74  * ActivateModule: set the module to an usable state.
  75  *****************************************************************************
  76  * This function fills the capability functions and the configuration
  77  * structure. Once ActivateModule() has been called, the i_usage can
  78  * be set to 0 and calls to NeedModule() be made to increment it. To unload
  79  * the module, one has to wait until i_usage == 0 and call DeactivateModule().
  80  *****************************************************************************/
  81 int ActivateModule( module_t * p_module )
  82 {
  83     p_module->p_functions = malloc( sizeof( module_functions_t ) );
  84     if( p_module->p_functions == NULL )
  85     {
  86         return( -1 );
  87     }
  88
  89     intf_getfunctions( &p_module->p_functions->intf );
  90
  91     p_module->p_config = p_config;
  92
  93     return( 0 );
  94 }
  95
  96 /*****************************************************************************
  97  * DeactivateModule: make sure the module can be unloaded.
  98  *****************************************************************************
  99  * This function must only be called when i_usage == 0. If it successfully
 100  * returns, i_usage can be set to -1 and the module unloaded. Be careful to
 101  * lock usage_lock during the whole process.
 102  *****************************************************************************/
 103 int DeactivateModule( module_t * p_module )
 104 {
 105     free( p_module->p_functions );
 106
 107     return( 0 );
 108 }
 109