help.c File Reference

Include dependency graph for help.c:

Macros
#define	ShowConsole()
#define	PauseConsole()
#define	LINE_START   8
#define	PADDING_SPACES   25
#define	OPTION_VALUE_SEP   " "

Functions
static void	Help (libvlc_int_t *, const char *)
static void	Usage (libvlc_int_t *, const char *)
static void	Version (void)
static void	ListModules (libvlc_int_t *, bool)
static unsigned	ConsoleWidth (void)
	Returns the console width or a best guess.
bool	config_PrintHelp (libvlc_int_t *obj)
	Checks for help command line options such as –help or –version.
static void	print_help_on_full_help (void)
static void	print_section (const module_t *m, const module_config_t **sect, bool color, bool desc)
static void	print_desc (const char *str, unsigned margin, bool color)
static int	vlc_swidth (const char *str)
static void	print_item (const module_t *m, const struct vlc_param *param, const module_config_t **section, bool color, bool desc)
static bool	module_match (const module_t *m, const char *pattern, bool strict)
static bool	plugin_show (const vlc_plugin_t *plugin)

Variables
static const char	vlc_usage []

Macro Definition Documentation

LINE_START

#define LINE_START   8

Referenced by print_item().

OPTION_VALUE_SEP

#define OPTION_VALUE_SEP   " "

Referenced by print_item().

PADDING_SPACES

#define PADDING_SPACES   25

Referenced by print_item().

PauseConsole

#define PauseConsole

(

)

Value:

(void)0

Referenced by Help(), ListModules(), and Version().

ShowConsole

#define ShowConsole

(

)

Value:

(void)0

Referenced by Help(), ListModules(), and Version().

Function Documentation

config_PrintHelp()

bool config_PrintHelp

(

libvlc_int_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().

ConsoleWidth()

unsigned ConsoleWidth ( void )

static

Returns the console width or a best guess.

Referenced by print_desc().

Help()

void Help ( libvlc_int_t * p_this, const char * psz_help_name )

static

References _, PauseConsole, print_help_on_full_help(), ShowConsole, Usage(), and vlc_usage.

Referenced by config_PrintHelp().

ListModules()

void ListModules ( libvlc_int_t * p_this, bool b_verbose )

static

References count, vlc_param::i, module_t::i_score, module_t::i_shortcuts, list, module_get_object(), module_gettext(), module_list_free(), module_list_get(), PauseConsole, module_t::pp_shortcuts, module_t::psz_capability, module_t::psz_longname, ShowConsole, TS_CYAN_BOLD, TS_GREEN_BOLD, TS_MAGENTA_BOLD, TS_RESET, TS_RESET_BOLD, and var_InheritBool().

Referenced by config_PrintHelp().

module_match()

bool module_match ( const module_t * m, const char * pattern, bool strict )

static

References module_t::i_shortcuts, module_get_object(), and module_t::pp_shortcuts.

Referenced by Usage().

plugin_show()

bool plugin_show ( const vlc_plugin_t * plugin )

static

References vlc_plugin_t::conf, CONFIG_ITEM, vlc_param::i, module_config_t::i_type, vlc_param::item, vlc_param::obsolete, vlc_plugin_t::params, and vlc_plugin_t::size.

Referenced by Usage().

print_desc()

void print_desc ( const char * str, unsigned margin, bool color )

static

References ConsoleWidth(), TS_BLUE_BOLD, TS_RESET, unlikely, and vlc_towc().

Referenced by print_item().

print_help_on_full_help()

void print_help_on_full_help ( void )

inlinestatic

References _.

Referenced by Help().

print_item()

void print_item ( const module_t * m, const struct vlc_param * param, const module_config_t ** section, bool color, bool desc )

static

References _, asprintf(), CONFIG_CLASS, config_GetIntChoices(), config_GetPszChoices(), CONFIG_HINT_CATEGORY, CONFIG_ITEM_BOOL, CONFIG_ITEM_FLOAT, CONFIG_ITEM_INTEGER, CONFIG_ITEM_STRING, CONFIG_SECTION, CONFIG_SUBCATEGORY, module_value_t::f, module_value_t::i, module_config_t::i_type, vlc_param::item, LINE_START, module_config_t::max, module_config_t::min, module_gettext(), OPTION_VALUE_SEP, module_config_t::orig, PADDING_SPACES, print_desc(), print_section(), module_config_t::psz_longtext, module_config_t::psz_name, module_config_t::psz_text, vlc_param::shortname, TS_BOLD, TS_CYAN_BOLD, TS_GREEN_BOLD, TS_RESET, TS_YELLOW_BOLD, and vlc_swidth().

Referenced by Usage().

print_section()

void print_section ( const module_t * m, const module_config_t ** sect, bool color, bool desc )

static

References module_gettext(), module_config_t::psz_longtext, module_config_t::psz_text, TS_MAGENTA_BOLD, TS_RED_BOLD, and TS_RESET.

Referenced by print_item().

Usage()

void Usage ( libvlc_int_t * p_this, const char * psz_search )

static

References _, module_get_object(), module_gettext(), module_match(), vlc_param::obsolete, p, plugin_show(), print_item(), module_t::psz_help, module_t::psz_longname, TS_BOLD, TS_CYAN_BOLD, TS_GREEN_BOLD, TS_RESET, var_InheritBool(), and vlc_plugins.

Referenced by Help().

Version()

void Version ( void )

static

References _, LICENSE_MSG, PauseConsole, psz_vlc_changeset, ShowConsole, VLC_CompileBy(), VLC_CompileHost(), and VLC_Compiler().

Referenced by config_PrintHelp().

vlc_swidth()

int vlc_swidth ( const char * str )

static

References vlc_towc().

Referenced by print_item().

Variable Documentation

vlc_usage

const char vlc_usage[]

static

Referenced by Help().