Defines | Functions | Variables

configuration.h File Reference

Go to the source code of this file.

Defines

#define config_LoadCmdLine(a, b, c, d)   config_LoadCmdLine(VLC_OBJECT(a),b,c,d)
#define config_LoadConfigFile(a)   config_LoadConfigFile(VLC_OBJECT(a))
#define CONFIG_CLASS(x)   ((x) & ~0x1F)
#define IsConfigStringType(type)   (((type) & CONFIG_ITEM_STRING) != 0)
#define IsConfigIntegerType(type)   (((type) & CONFIG_ITEM_INTEGER) != 0)
#define IsConfigFloatType(type)   ((type) == CONFIG_ITEM_FLOAT)
#define CONFIG_FILE   "vlcrc"

Functions

int config_CreateDir (vlc_object_t *, const char *)
int config_AutoSaveConfigFile (vlc_object_t *)
void config_Free (module_config_t *, size_t)
 Destroys an array of configuration items.
int config_LoadCmdLine (vlc_object_t *, int, const char *[], int *)
 Parse command line for configuration options.
int config_LoadConfigFile (vlc_object_t *)
bool config_PrintHelp (vlc_object_t *)
 Checks for help command line options such as --help or --version.
int config_SortConfig (void)
 Index the configuration items by name for faster lookups.
void config_UnsortConfig (void)
bool config_IsSafe (const char *)

Variables

vlc_rwlock_t config_lock
bool config_dirty

Define Documentation

#define CONFIG_CLASS (   x  )     ((x) & ~0x1F)
#define CONFIG_FILE   "vlcrc"
#define config_LoadCmdLine (   a,
  b,
  c,
  d 
)    config_LoadCmdLine(VLC_OBJECT(a),b,c,d)

Referenced by libvlc_InternalInit().

#define config_LoadConfigFile (   a  )     config_LoadConfigFile(VLC_OBJECT(a))

Referenced by libvlc_InternalInit().

#define IsConfigFloatType (   type  )     ((type) == CONFIG_ITEM_FLOAT)
#define IsConfigIntegerType (   type  )     (((type) & CONFIG_ITEM_INTEGER) != 0)
#define IsConfigStringType (   type  )     (((type) & CONFIG_ITEM_STRING) != 0)

Function Documentation

int config_AutoSaveConfigFile ( vlc_object_t  ) 
int config_CreateDir ( vlc_object_t ,
const char *   
)
void config_Free ( module_config_t config,
size_t  confsize 
)
bool config_IsSafe ( const char *   ) 
int config_LoadCmdLine ( vlc_object_t p_this,
int  i_argc,
const char *  ppsz_argv[],
int *  pindex 
)

Parse command line for configuration options.

Now that the module_bank has been initialized, we can dynamically generate the longopts structure used by getops. We have to do it this way because we don't know (and don't want to know) in advance the configuration options used (ie. exported) by each module.

Parameters:
p_this object to write command line options as variables to
i_argc number of command line arguments
ppsz_args commandl ine arguments [IN/OUT]
pindex NULL to ignore unknown options, otherwise index of the first non-option argument [OUT]
Returns:
0 on success, -1 on error.

References vlc_getopt_s::arg, asprintf(), b_ignore_errors, module_config_t::b_removed, CONFIG_CLASS, config_FindConfig(), CONFIG_ITEM, CONFIG_ITEM_BOOL, CONFIG_ITEM_FLOAT, CONFIG_ITEM_INTEGER, CONFIG_ITEM_STRING, module_t::confsize, vlc_option::flag, vlc_option::has_arg, module_t::i_bool_items, module_t::i_config_items, module_config_t::i_short, i_type, module_config_t::i_type, vlc_getopt_s::ind, list, module_list_free(), module_list_get(), name, vlc_option::name, vlc_getopt_s::opt, module_t::p_config, psz_name, module_config_t::psz_name, strdup(), strtoll(), us_atof(), vlc_option::val, var_Create, var_SetBool, var_SetFloat, var_SetInteger, var_SetString, vlc_getopt_long(), VLC_VAR_BOOL, VLC_VAR_FLOAT, VLC_VAR_INTEGER, and VLC_VAR_STRING.

int config_LoadConfigFile ( vlc_object_t  ) 
bool config_PrintHelp ( vlc_object_t obj  ) 

Checks for help command line options such as --help or --version.

If one is found, print the corresponding text.

Returns:
true if a command line options caused some help message to be printed, false otherwise.

References Help(), ListModules(), var_Create, var_InheritBool, var_InheritString, var_SetBool, Version(), and VLC_VAR_BOOL.

Referenced by libvlc_InternalInit().

int config_SortConfig ( void   ) 

Index the configuration items by name for faster lookups.

References confcmp(), config, CONFIG_ITEM, module_t::confsize, module_config_t::i_type, module_list_free(), module_list_get(), module_t::p_config, and unlikely.

Referenced by module_InitBank(), and module_LoadPlugins().

void config_UnsortConfig ( void   ) 

References config.

Referenced by module_EndBank(), and module_LoadPlugins().


Variable Documentation

 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Defines