configuration.h File Reference

Go to the source code of this file.

Macros
#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 *)
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

Macro Definition Documentation

#define CONFIG_CLASS

(

x

)

((x) & ~0x1F)

Referenced by config_GetType(), config_LoadCmdLine(), config_LoadConfigFile(), config_SaveConfigFile(), and Usage().

#define CONFIG_FILE   "vlcrc"

Referenced by config_GetConfigFile(), and config_OpenConfigFile().

#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)

Referenced by config_GetFloat(), config_PutFloat(), config_ResetAll(), config_SaveConfigFile(), and vlc_plugin_setter().

#define IsConfigIntegerType

(

type

)

(((type) & CONFIG_ITEM_INTEGER) != 0)

Referenced by config_Free(), config_GetInt(), config_PutInt(), config_ResetAll(), config_SaveConfigFile(), vlc_config_create(), and vlc_plugin_setter().

#define IsConfigStringType

(

type

)

(((type) & CONFIG_ITEM_STRING) != 0)

Referenced by config_Free(), config_GetPsz(), config_GetPszChoices(), config_PutPsz(), config_ResetAll(), config_SaveConfigFile(), and vlc_plugin_setter().

Function Documentation

int config_AutoSaveConfigFile

(

vlc_object_t *

)

References config_dirty, config_lock, config_SaveConfigFile, vlc_rwlock_rdlock(), and vlc_rwlock_unlock().

Referenced by libvlc_InternalCleanup().

int config_CreateDir	(	vlc_object_t *	,
		const char *
	)

References config_CreateDir(), DIR_SEP_CHAR, msg_Warn, and vlc_mkdir().

Referenced by config_CreateDir(), config_PrepareDir(), and playlist_MLDump().

void config_Free	(	module_config_t *	config,
		size_t	confsize
	)

Destroys an array of configuration items.

Parameters

config	start of array of items
confsize	number of items in the array

References module_config_t::i, module_config_t::i_type, IsConfigIntegerType, IsConfigStringType, module_config_t::list, module_config_t::list_count, module_config_t::list_text, module_config_t::orig, module_value_t::psz, module_config_t::psz, module_config_t::psz_longtext, module_config_t::psz_name, module_config_t::psz_text, module_config_t::psz_type, and module_config_t::value.

Referenced by vlc_module_destroy().

bool config_IsSafe

(

const char *

)

References module_config_t::b_safe, and config_FindConfig().

Referenced by var_OptionParse().

int config_LoadCmdLine	(	vlc_object_t *	,
		int	,
		const char *	[],
		int *
	)

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.

< Not enough memory

< No error

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

Referenced by module_InitBank(), and module_LoadPlugins().

void config_UnsortConfig

(

void

)

References config.

Referenced by module_EndBank(), and module_LoadPlugins().

Variable Documentation

bool config_dirty

Referenced by config_AutoSaveConfigFile(), config_PutFloat(), config_PutInt(), and config_PutPsz().

vlc_rwlock_t config_lock

Referenced by _DLL_InitTerm(), config_AutoSaveConfigFile(), config_GetFloat(), config_GetInt(), config_GetPsz(), config_LoadConfigFile(), config_PutFloat(), config_PutInt(), config_PutPsz(), config_ResetAll(), and config_SaveConfigFile().