#include <stdio.h>
#include <string.h>
#include <stdlib.h>
+#include <wchar.h>
+#include <wctype.h>
#include <vlc_common.h>
-#include <vlc_charset.h>
#include <vlc_modules.h>
#include <vlc_plugin.h>
#include "modules/modules.h"
#include "config/configuration.h"
#include "libvlc.h"
-#if defined( WIN32 ) && !defined( UNDER_CE )
+#if defined( _WIN32 )
+# include <vlc_charset.h>
+# define wcwidth(cp) (cp, 1) /* LOL */
+#else
+# include <unistd.h>
+# include <termios.h>
+# include <sys/ioctl.h>
+#endif
+
+#if defined( _WIN32 ) && !VLC_WINSTORE_APP
static void ShowConsole (void);
static void PauseConsole (void);
#else
# define ShowConsole() (void)0
# define PauseConsole() (void)0
-# include <unistd.h>
#endif
static void Help (vlc_object_t *, const char *);
static void Usage (vlc_object_t *, const char *);
static void Version (void);
static void ListModules (vlc_object_t *, bool);
-static int ConsoleWidth (void);
+
+/**
+ * Returns the console width or a best guess.
+ */
+static unsigned ConsoleWidth(void)
+{
+#ifdef TIOCGWINSZ
+ struct winsize ws;
+
+ if (ioctl(STDOUT_FILENO, TIOCGWINSZ, &ws) == 0)
+ return ws.ws_col;
+#endif
+#ifdef WIOCGETD
+ struct uwdata uw;
+
+ if (ioctl(STDOUT_FILENO, WIOCGETD, &uw) == 0)
+ return uw.uw_height / uw.uw_vs;
+#endif
+#if defined (_WIN32) && !VLC_WINSTORE_APP
+ CONSOLE_SCREEN_BUFFER_INFO buf;
+
+ if (GetConsoleScreenBufferInfo(GetStdHandle(STD_OUTPUT_HANDLE), &buf))
+ return buf.dwSize.X;
+#endif
+ return 80;
+}
/**
* Checks for help command line options such as --help or --version.
*****************************************************************************/
static inline void print_help_on_full_help( void )
{
- utf8_fprintf( stdout, "\n" );
- utf8_fprintf( stdout, "%s\n", _("To get exhaustive help, use '-H'.") );
+ putchar('\n');
+ puts(_("To get exhaustive help, use '-H'."));
}
static const char vlc_usage[] = N_(
if( psz_help_name && !strcmp( psz_help_name, "help" ) )
{
- utf8_fprintf( stdout, _(vlc_usage), "vlc" );
- Usage( p_this, "=help" );
- Usage( p_this, "=main" );
+ printf(_(vlc_usage), "vlc");
+ Usage( p_this, "=core" );
print_help_on_full_help();
}
else if( psz_help_name && !strcmp( psz_help_name, "longhelp" ) )
{
- utf8_fprintf( stdout, _(vlc_usage), "vlc" );
+ printf(_(vlc_usage), "vlc");
Usage( p_this, NULL );
print_help_on_full_help();
}
else if( psz_help_name && !strcmp( psz_help_name, "full-help" ) )
{
- utf8_fprintf( stdout, _(vlc_usage), "vlc" );
+ printf(_(vlc_usage), "vlc");
Usage( p_this, NULL );
}
else if( psz_help_name )
# define CYAN COL(36)
# define WHITE COL(0)
# define GRAY "\033[0m"
-static void
-print_help_section( const module_t *m, const module_config_t *p_item,
- bool b_color, bool b_description )
+# define LINE_START 8
+# define PADDING_SPACES 25
+
+static void print_section(const module_t *m, const module_config_t **sect,
+ bool color, bool desc)
{
- if( !p_item ) return;
- if( b_color )
- {
- utf8_fprintf( stdout, RED" %s:\n"GRAY,
- module_gettext( m, p_item->psz_text ) );
- if( b_description && p_item->psz_longtext )
- utf8_fprintf( stdout, MAGENTA" %s\n"GRAY,
- module_gettext( m, p_item->psz_longtext ) );
- }
- else
- {
- utf8_fprintf( stdout, " %s:\n",
- module_gettext( m, p_item->psz_text ) );
- if( b_description && p_item->psz_longtext )
- utf8_fprintf( stdout, " %s\n",
- module_gettext(m, p_item->psz_longtext ) );
- }
+ const module_config_t *item = *sect;
+
+ if (item == NULL)
+ return;
+ *sect = NULL;
+
+ printf(color ? RED" %s:\n"GRAY : " %s:\n",
+ module_gettext(m, item->psz_text));
+ if (desc && item->psz_longtext != NULL)
+ printf(color ? MAGENTA" %s\n"GRAY : " %s\n",
+ module_gettext(m, item->psz_longtext));
}
-static void Usage (vlc_object_t *p_this, char const *psz_search)
+static void print_desc(const char *str, unsigned margin, bool color)
{
-#define FORMAT_STRING " %s --%s%s%s%s%s%s%s "
- /* short option ------' | | | | | | |
- * option name ------------' | | | | | |
- * <bra ---------------------' | | | | |
- * option type or "" ----------' | | | |
- * ket> -------------------------' | | |
- * padding spaces -----------------' | |
- * comment --------------------------' |
- * comment suffix ---------------------'
- *
- * The purpose of having bra and ket is that we might i18n them as well.
- */
-
-#define COLOR_FORMAT_STRING (WHITE" %s --%s"YELLOW"%s%s%s%s%s%s "GRAY)
-#define COLOR_FORMAT_STRING_BOOL (WHITE" %s --%s%s%s%s%s%s%s "GRAY)
-
-#define LINE_START 8
-#define PADDING_SPACES 25
-#ifdef WIN32
-# define OPTION_VALUE_SEP "="
-#else
-# define OPTION_VALUE_SEP " "
-#endif
- char psz_spaces_text[PADDING_SPACES+LINE_START+1];
- char psz_spaces_longtext[LINE_START+3];
- char psz_format[sizeof(COLOR_FORMAT_STRING)];
- char psz_format_bool[sizeof(COLOR_FORMAT_STRING_BOOL)];
- char psz_buffer[10000];
- char psz_short[4];
- int i_width = ConsoleWidth() - (PADDING_SPACES+LINE_START+1);
- int i_width_description = i_width + PADDING_SPACES - 1;
- bool b_advanced = var_InheritBool( p_this, "advanced" );
- bool b_description = var_InheritBool( p_this, "help-verbose" );
- bool b_description_hack;
- bool b_color = var_InheritBool( p_this, "color" );
- bool b_has_advanced = false;
- bool b_found = false;
- unsigned i_only_advanced = 0; /* Number of modules ignored because they
- * only have advanced options */
- bool b_strict = psz_search && *psz_search == '=';
- if( b_strict ) psz_search++;
-
- memset( psz_spaces_text, ' ', PADDING_SPACES+LINE_START );
- psz_spaces_text[PADDING_SPACES+LINE_START] = '\0';
- memset( psz_spaces_longtext, ' ', LINE_START+2 );
- psz_spaces_longtext[LINE_START+2] = '\0';
-#ifndef WIN32
- if( !isatty( 1 ) )
-#endif
- b_color = false; // don't put color control codes in a .txt file
-
- if( b_color )
- {
- strcpy( psz_format, COLOR_FORMAT_STRING );
- strcpy( psz_format_bool, COLOR_FORMAT_STRING_BOOL );
- }
- else
- {
- strcpy( psz_format, FORMAT_STRING );
- strcpy( psz_format_bool, FORMAT_STRING );
- }
+ unsigned width = ConsoleWidth() - margin;
- /* List all modules */
- module_t **list = module_list_get (NULL);
- if (!list)
- return;
+ if (color)
+ fputs(BLUE, stdout);
- /* Ugly hack to make sure that the help options always come first
- * (part 1) */
- if( !psz_search )
- Usage( p_this, "help" );
+ const char *word = str;
+ int wordlen = 0, wordwidth = 0;
+ unsigned offset = 0;
+ bool newline = true;
- /* Enumerate the config for each module */
- for (size_t i = 0; list[i]; i++)
+ while (str[0])
{
- bool b_help_module;
- module_t *p_parser = list[i];
- module_config_t *p_item = NULL;
- module_config_t *p_section = NULL;
- module_config_t *p_end = p_parser->p_config + p_parser->confsize;
- const char *objname = module_get_object (p_parser);
+ uint32_t cp;
+ size_t charlen = vlc_towc(str, &cp);
+ if (unlikely(charlen == (size_t)-1))
+ break;
+
+ int charwidth = wcwidth(cp);
+ if (charwidth < 0)
+ charwidth = 0;
- if( psz_search &&
- ( b_strict ? strcmp( objname, psz_search )
- : !strstr( objname, psz_search ) ) )
+ str += charlen;
+
+ if (iswspace(cp))
{
- char *const *pp_shortcuts = p_parser->pp_shortcuts;
- unsigned i;
- for( i = 0; i < p_parser->i_shortcuts; i++ )
+ if (!newline)
{
- if( b_strict ? !strcmp( psz_search, pp_shortcuts[i] )
- : !!strstr( pp_shortcuts[i], psz_search ) )
- break;
+ putchar(' '); /* insert space */
+ charwidth = 1;
}
- if( i == p_parser->i_shortcuts )
- continue;
+ fwrite(word, 1, wordlen, stdout); /* write complete word */
+ word = str;
+ wordlen = 0;
+ wordwidth = 0;
+ newline = false;
}
-
- /* Ignore modules without config options */
- if( !p_parser->i_config_items )
+ else
{
- continue;
+ wordlen += charlen;
+ wordwidth += charwidth;
}
- b_help_module = !strcmp( "help", objname );
- /* Ugly hack to make sure that the help options always come first
- * (part 2) */
- if( !psz_search && b_help_module )
- continue;
-
- /* Ignore modules with only advanced config options if requested */
- if( !b_advanced )
+ offset += charwidth;
+ if (offset >= width)
{
- for( p_item = p_parser->p_config;
- p_item < p_end;
- p_item++ )
- {
- if( CONFIG_ITEM(p_item->i_type) &&
- !p_item->b_advanced && !p_item->b_removed ) break;
- }
-
- if( p_item == p_end )
- {
- i_only_advanced++;
- continue;
+ if (newline)
+ { /* overflow (word wider than line) */
+ fwrite(word, 1, wordlen - charlen, stdout);
+ word = str - charlen;
+ wordlen = charlen;
+ wordwidth = charwidth;
}
+ printf("\n%*s", margin, ""); /* new line */
+ offset = wordwidth;
+ newline = true;
}
+ }
- b_found = true;
+ if (!newline)
+ putchar(' ');
+ printf(color ? "%s\n"GRAY : "%s\n", word);
+}
- /* Print name of module */
- if( strcmp( "main", objname ) )
- {
- if( b_color )
- utf8_fprintf( stdout, "\n " GREEN "%s" GRAY " (%s)\n",
- module_gettext( p_parser, p_parser->psz_longname ),
- objname );
- else
- utf8_fprintf( stdout, "\n %s\n",
- module_gettext(p_parser, p_parser->psz_longname ) );
- }
- if( p_parser->psz_help )
- {
- if( b_color )
- utf8_fprintf( stdout, CYAN" %s\n"GRAY,
- module_gettext( p_parser, p_parser->psz_help ) );
- else
- utf8_fprintf( stdout, " %s\n",
- module_gettext( p_parser, p_parser->psz_help ) );
- }
+static int vlc_swidth(const char *str)
+{
+ for (int total = 0;;)
+ {
+ uint32_t cp;
+ size_t charlen = vlc_towc(str, &cp);
+
+ if (charlen == 0)
+ return total;
+ if (charlen == (size_t)-1)
+ return -1;
+ str += charlen;
+
+ int w = wcwidth(cp);
+ if (w == -1)
+ return -1;
+ total += w;
+ }
+}
- /* Print module options */
- for( p_item = p_parser->p_config;
- p_item < p_end;
- p_item++ )
- {
- char *psz_text, *psz_spaces = psz_spaces_text;
- const char *psz_bra = NULL, *psz_type = NULL, *psz_ket = NULL;
- const char *psz_suf = "", *psz_prefix = NULL;
- signed int i;
- size_t i_cur_width;
-
- /* Skip removed options */
- if( p_item->b_removed )
- {
- continue;
- }
- /* Skip advanced options if requested */
- if( p_item->b_advanced && !b_advanced )
- {
- b_has_advanced = true;
- continue;
- }
+static void print_item(const module_t *m, const module_config_t *item,
+ const module_config_t **section, bool color, bool desc)
+{
+#ifndef _WIN32
+# define OPTION_VALUE_SEP " "
+#else
+# define OPTION_VALUE_SEP "="
+#endif
+ const char *bra = OPTION_VALUE_SEP "<", *type, *ket = ">";
+ const char *prefix = NULL, *suffix = NULL;
+ char *typebuf = NULL;
- switch( CONFIG_CLASS(p_item->i_type) )
+ switch (CONFIG_CLASS(item->i_type))
+ {
+ case 0: // hint class
+ switch (item->i_type)
{
- case 0: // hint class
- switch( p_item->i_type )
- {
case CONFIG_HINT_CATEGORY:
case CONFIG_HINT_USAGE:
- if( !strcmp( "main", objname ) )
- {
- if( b_color )
- utf8_fprintf( stdout, GREEN "\n %s\n" GRAY,
- module_gettext( p_parser, p_item->psz_text ) );
- else
- utf8_fprintf( stdout, "\n %s\n",
- module_gettext( p_parser, p_item->psz_text ) );
- }
- if( b_description && p_item->psz_longtext )
- {
- if( b_color )
- utf8_fprintf( stdout, CYAN " %s\n" GRAY,
- module_gettext( p_parser, p_item->psz_longtext ) );
- else
- utf8_fprintf( stdout, " %s\n",
- module_gettext( p_parser, p_item->psz_longtext ) );
- }
- break;
+ printf(color ? GREEN "\n %s\n" GRAY : "\n %s\n",
+ module_gettext(m, item->psz_text));
+
+ if (desc && item->psz_longtext != NULL)
+ printf(color ? CYAN " %s\n" GRAY : " %s\n",
+ module_gettext(m, item->psz_longtext));
+ break;
- case CONFIG_HINT_SUBCATEGORY:
- if( strcmp( "main", objname ) )
- break;
case CONFIG_SECTION:
- p_section = p_item;
+ *section = item;
break;
- }
- break;
+ }
+ return;
- case CONFIG_ITEM_STRING:
- print_help_section( p_parser, p_section, b_color,
- b_description );
- p_section = NULL;
- psz_bra = OPTION_VALUE_SEP "<";
- psz_type = _("string");
- psz_ket = ">";
+ case CONFIG_ITEM_STRING:
+ type = _("string");
+ if (item->list_count > 0)
+ {
+ size_t len = 0;
- if( p_item->list_count )
- {
- psz_bra = OPTION_VALUE_SEP "{";
- psz_type = psz_buffer;
- psz_buffer[0] = '\0';
- for( i = 0; i < p_item->list_count; i++ )
- {
- if( i ) strcat( psz_buffer, "," );
- strcat( psz_buffer, p_item->list.psz[i] );
- }
- psz_ket = "}";
- }
- break;
- case CONFIG_ITEM_INTEGER:
- print_help_section( p_parser, p_section, b_color,
- b_description );
- p_section = NULL;
- psz_bra = OPTION_VALUE_SEP "<";
- psz_type = _("integer");
- psz_ket = ">";
-
- if( p_item->min.i || p_item->max.i )
- {
- sprintf( psz_buffer, "%s [%"PRId64" .. %"PRId64"]",
- psz_type, p_item->min.i, p_item->max.i );
- psz_type = psz_buffer;
- }
+ for (unsigned i = 0; i < item->list_count; i++)
+ len += strlen(item->list.psz[i]) + 1;
- if( p_item->list_count )
- {
- psz_bra = OPTION_VALUE_SEP "{";
- psz_type = psz_buffer;
- psz_buffer[0] = '\0';
- for( i = 0; i < p_item->list_count; i++ )
- {
- if( i ) strcat( psz_buffer, ", " );
- sprintf( psz_buffer + strlen(psz_buffer), "%i (%s)",
- p_item->list.i[i],
- module_gettext( p_parser, p_item->list_text[i] ) );
- }
- psz_ket = "}";
- }
- break;
- case CONFIG_ITEM_FLOAT:
- print_help_section( p_parser, p_section, b_color,
- b_description );
- p_section = NULL;
- psz_bra = OPTION_VALUE_SEP "<";
- psz_type = _("float");
- psz_ket = ">";
- if( p_item->min.f || p_item->max.f )
- {
- sprintf( psz_buffer, "%s [%f .. %f]", psz_type,
- p_item->min.f, p_item->max.f );
- psz_type = psz_buffer;
- }
- break;
- case CONFIG_ITEM_BOOL:
- print_help_section( p_parser, p_section, b_color,
- b_description );
- p_section = NULL;
- psz_bra = ""; psz_type = ""; psz_ket = "";
- if( !b_help_module )
+ typebuf = malloc(len);
+ if (typebuf == NULL)
+ break;
+
+ bra = OPTION_VALUE_SEP "{";
+ type = typebuf;
+ ket = "}";
+
+ *typebuf = 0;
+ for (unsigned i = 0; i < item->list_count; i++)
{
- psz_suf = p_item->value.i ? _(" (default enabled)") :
- _(" (default disabled)");
+ if (i > 0)
+ strcat(typebuf, ",");
+ strcat(typebuf, item->list.psz[i]);
}
- break;
}
+ break;
- if( !psz_type )
- {
- continue;
- }
+ case CONFIG_ITEM_INTEGER:
+ type = _("integer");
- /* Add short option if any */
- if( p_item->i_short )
- {
- sprintf( psz_short, "-%c,", p_item->i_short );
- }
- else
+ if (item->list_count > 0)
{
- strcpy( psz_short, " " );
- }
+ size_t len = 0;
- i = PADDING_SPACES - strlen( p_item->psz_name )
- - strlen( psz_bra ) - strlen( psz_type )
- - strlen( psz_ket ) - 1;
+ for (unsigned i = 0; i < item->list_count; i++)
+ len += strlen(item->list_text[i]) + 4 * sizeof (int) + 5;
- if( CONFIG_CLASS(p_item->i_type) == CONFIG_ITEM_BOOL
- && !b_help_module )
- {
- psz_prefix = ", --no-";
- i -= strlen( p_item->psz_name ) + strlen( psz_prefix );
- }
+ typebuf = malloc(len);
+ if (typebuf == NULL)
+ break;
- if( i < 0 )
- {
- psz_spaces[0] = '\n';
- i = 0;
+ bra = OPTION_VALUE_SEP "{";
+ type = typebuf;
+ ket = "}";
+
+ *typebuf = 0;
+ for (unsigned i = 0; i < item->list_count; i++)
+ {
+ if (i != 0)
+ strcat(typebuf, ", ");
+ sprintf(typebuf + strlen(typebuf), "%i (%s)",
+ item->list.i[i],
+ module_gettext(m, item->list_text[i]));
+ }
}
- else
+ else if (item->min.i != 0 || item->max.i != 0)
{
- psz_spaces[i] = '\0';
+ if (asprintf(&typebuf, "%s [%"PRId64" .. %"PRId64"]",
+ type, item->min.i, item->max.i) >= 0)
+ type = typebuf;
+ else
+ typebuf = NULL;
}
+ break;
- if( CONFIG_CLASS(p_item->i_type) == CONFIG_ITEM_BOOL
- && !b_help_module )
+ case CONFIG_ITEM_FLOAT:
+ type = _("float");
+ if (item->min.f != 0.f || item->max.f != 0.f)
{
- utf8_fprintf( stdout, psz_format_bool, psz_short,
- p_item->psz_name, psz_prefix, p_item->psz_name,
- psz_bra, psz_type, psz_ket, psz_spaces );
- }
- else
- {
- utf8_fprintf( stdout, psz_format, psz_short, p_item->psz_name,
- "", "", psz_bra, psz_type, psz_ket, psz_spaces );
+ if (asprintf(&typebuf, "%s [%f .. %f]", type,
+ item->min.f, item->max.f) >= 0)
+ type = typebuf;
+ else
+ typebuf = NULL;
}
+ break;
+
+ case CONFIG_ITEM_BOOL:
+ bra = type = ket = "";
+ prefix = ", --no-";
+ suffix = item->value.i ? _("(default enabled)")
+ : _("(default disabled)");
+ break;
+ default:
+ return;
+ }
- psz_spaces[i] = ' ';
+ print_section(m, section, color, desc);
- /* We wrap the rest of the output */
- sprintf( psz_buffer, "%s%s", module_gettext( p_parser, p_item->psz_text ),
- psz_suf );
- b_description_hack = b_description;
+ /* Add short option if any */
+ char shortopt[4];
+ if (item->i_short != '\0')
+ sprintf(shortopt, "-%c,", item->i_short);
+ else
+ strcpy(shortopt, " ");
- description:
- psz_text = psz_buffer;
- i_cur_width = b_description && !b_description_hack
- ? i_width_description
- : i_width;
- if( !*psz_text ) strcpy(psz_text, " ");
- while( *psz_text )
- {
- char *psz_parser, *psz_word;
- size_t i_end = strlen( psz_text );
+ if (CONFIG_CLASS(item->i_type) == CONFIG_ITEM_BOOL)
+ printf(color ? WHITE" %s --%s" "%s%s%s%s%s "GRAY
+ : " %s --%s%s%s%s%s%s ", shortopt, item->psz_name,
+ prefix, item->psz_name, bra, type, ket);
+ else
+ printf(color ? WHITE" %s --%s"YELLOW"%s%s%s%s%s "GRAY
+ : " %s --%s%s%s%s%s%s ", shortopt, item->psz_name,
+ "", "", /* XXX */ bra, type, ket);
+
+ /* Wrap description */
+ int offset = PADDING_SPACES - strlen(item->psz_name)
+ - strlen(bra) - vlc_swidth(type) - strlen(ket) - 1;
+ if (CONFIG_CLASS(item->i_type) == CONFIG_ITEM_BOOL)
+ offset -= strlen(item->psz_name) + vlc_swidth(prefix);
+ if (offset < 0)
+ {
+ putchar('\n');
+ offset = PADDING_SPACES + LINE_START;
+ }
- /* If the remaining text fits in a line, print it. */
- if( i_end <= i_cur_width )
- {
- if( b_color )
- {
- if( !b_description || b_description_hack )
- utf8_fprintf( stdout, BLUE"%s\n"GRAY, psz_text );
- else
- utf8_fprintf( stdout, "%s\n", psz_text );
- }
- else
- {
- utf8_fprintf( stdout, "%s\n", psz_text );
- }
- break;
- }
+ printf("%*s", offset, "");
+ print_desc(module_gettext(m, item->psz_longtext),
+ PADDING_SPACES + LINE_START, color);
- /* Otherwise, eat as many words as possible */
- psz_parser = psz_text;
- do
- {
- psz_word = psz_parser;
- psz_parser = strchr( psz_word, ' ' );
- /* If no space was found, we reached the end of the text
- * block; otherwise, we skip the space we just found. */
- psz_parser = psz_parser ? psz_parser + 1
- : psz_text + i_end;
-
- } while( (size_t)(psz_parser - psz_text) <= i_cur_width );
-
- /* We cut a word in one of these cases:
- * - it's the only word in the line and it's too long.
- * - we used less than 80% of the width and the word we are
- * going to wrap is longer than 40% of the width, and even
- * if the word would have fit in the next line. */
- if( psz_word == psz_text
- || ( (size_t)(psz_word - psz_text) < 80 * i_cur_width / 100
- && (size_t)(psz_parser - psz_word) > 40 * i_cur_width / 100 ) )
- {
- char c = psz_text[i_cur_width];
- psz_text[i_cur_width] = '\0';
- if( b_color )
- {
- if( !b_description || b_description_hack )
- utf8_fprintf( stdout, BLUE"%s\n%s"GRAY,
- psz_text, psz_spaces );
- else
- utf8_fprintf( stdout, "%s\n%s",
- psz_text, psz_spaces );
- }
- else
- {
- utf8_fprintf( stdout, "%s\n%s", psz_text, psz_spaces );
- }
- psz_text += i_cur_width;
- psz_text[0] = c;
- }
- else
- {
- psz_word[-1] = '\0';
- if( b_color )
- {
- if( !b_description || b_description_hack )
- utf8_fprintf( stdout, BLUE"%s\n%s"GRAY,
- psz_text, psz_spaces );
- else
- utf8_fprintf( stdout, "%s\n%s",
- psz_text, psz_spaces );
- }
- else
- {
- utf8_fprintf( stdout, "%s\n%s", psz_text, psz_spaces );
- }
- psz_text = psz_word;
- }
- }
+ if (suffix != NULL)
+ {
+ printf("%*s", offset, "");
+ print_desc(suffix, PADDING_SPACES + LINE_START, color);
+ }
- if( b_description_hack && p_item->psz_longtext )
- {
- sprintf( psz_buffer, "%s%s",
- module_gettext( p_parser, p_item->psz_longtext ),
- psz_suf );
- b_description_hack = false;
- psz_spaces = psz_spaces_longtext;
- utf8_fprintf( stdout, "%s", psz_spaces );
- goto description;
- }
- }
+ if (desc && (item->psz_longtext != NULL && item->psz_longtext[0]))
+ { /* Wrap long description */
+ printf("%*s", LINE_START + 2, "");
+ print_desc(module_gettext(m, item->psz_longtext),
+ LINE_START + 2, false);
}
- if( b_has_advanced )
+ free(typebuf);
+}
+
+static bool module_match(const module_t *m, const char *pattern, bool strict)
+{
+ if (pattern == NULL)
+ return true;
+
+ const char *objname = module_get_object(m);
+
+ if (strict ? (strcmp(objname, pattern) == 0)
+ : (strstr(objname, pattern) != NULL))
+ return true;
+
+ for (unsigned i = 0; i < m->i_shortcuts; i++)
{
- if( b_color )
- utf8_fprintf( stdout, "\n" WHITE "%s" GRAY " %s\n", _( "Note:" ),
- _( "add --advanced to your command line to see advanced options."));
- else
- utf8_fprintf( stdout, "\n%s %s\n", _( "Note:" ),
- _( "add --advanced to your command line to see advanced options."));
+ const char *shortcut = m->pp_shortcuts[i];
+
+ if (strict ? (strcmp(shortcut, pattern) == 0)
+ : (strstr(shortcut, pattern) != NULL))
+ return true;
}
+ return false;
+}
- if( i_only_advanced > 0 )
+static bool module_show(const module_t *m, bool advanced)
+{
+ for (size_t i = 0; i < m->confsize; i++)
{
- if( b_color )
- utf8_fprintf( stdout, "\n" WHITE "%s" GRAY " ", _( "Note:" ) );
- else
- utf8_fprintf( stdout, "\n%s ", _( "Note:" ) );
+ const module_config_t *item = m->p_config + i;
+
+ if (!CONFIG_ITEM(item->i_type))
+ continue;
+ if (item->b_removed)
+ continue;
+ if ((!advanced) && item->b_advanced)
+ continue;
+ return true;
+ }
+ return false;
+}
+
+static void Usage (vlc_object_t *p_this, char const *psz_search)
+{
+ bool b_has_advanced = false;
+ bool found = false;
+ unsigned i_only_advanced = 0; /* Number of modules ignored because they
+ * only have advanced options */
+ bool strict = false;
+ if (psz_search != NULL && psz_search[0] == '=')
+ {
+ strict = true;
+ psz_search++;
+ }
+
+ bool color = false;
+#ifndef _WIN32
+ if (isatty(STDOUT_FILENO))
+ color = var_InheritBool(p_this, "color");
+#endif
+
+ const bool desc = var_InheritBool(p_this, "help-verbose");
+ const bool advanced = var_InheritBool(p_this, "advanced");
+
+ /* List all modules */
+ size_t count;
+ module_t **list = module_list_get (&count);
+
+ /* Enumerate the config for each module */
+ for (size_t i = 0; i < count; i++)
+ {
+ const module_t *m = list[i];
+ const module_config_t *section = NULL;
+ const char *objname = module_get_object(m);
+
+ if (m->i_config_items == 0)
+ continue; /* Ignore modules without config options */
+ if (!module_match(m, psz_search, strict))
+ continue;
+ found = true;
- utf8_fprintf( stdout, vlc_ngettext("%u module was not displayed "
- "because it only has advanced options.\n",
- "%u modules were not displayed "
- "because they only have advanced options.\n",
- i_only_advanced ), i_only_advanced );
+ if (!module_show(m, advanced))
+ { /* Ignore modules with only advanced config options if requested */
+ i_only_advanced++;
+ continue;
+ }
+
+ /* Print name of module */
+ printf(color ? "\n " GREEN "%s" GRAY " (%s)\n" : "\n %s (%s)\n",
+ module_gettext(m, m->psz_longname), objname);
+ if (m->psz_help != NULL)
+ printf(color ? CYAN" %s\n"GRAY : " %s\n",
+ module_gettext(m, m->psz_help));
+
+ /* Print module options */
+ for (size_t j = 0; j < m->confsize; j++)
+ {
+ const module_config_t *item = m->p_config + j;
+
+ if (item->b_removed)
+ continue; /* Skip removed options */
+ if (item->b_advanced && !advanced)
+ { /* Skip advanced options unless requested */
+ b_has_advanced = true;
+ continue;
+ }
+ print_item(m, item, §ion, color, desc);
+ }
}
- else if( !b_found )
+
+ if( b_has_advanced )
+ printf(color ? "\n" WHITE "%s" GRAY " %s\n"
+ : "\n%s %s\n", _( "Note:" ), _( "add --advanced to your "
+ "command line to see advanced options."));
+ if( i_only_advanced > 0 )
{
- if( b_color )
- utf8_fprintf( stdout, "\n" WHITE "%s" GRAY "\n",
- _( "No matching module found. Use --list or " \
- "--list-verbose to list available modules." ) );
- else
- utf8_fprintf( stdout, "\n%s\n",
- _( "No matching module found. Use --list or " \
- "--list-verbose to list available modules." ) );
+ printf(color ? "\n" WHITE "%s" GRAY " " : "\n%s ", _( "Note:" ) );
+ printf(vlc_ngettext("%u module was not displayed because it only has "
+ "advanced options.\n", "%u modules were not displayed because "
+ "they only have advanced options.\n", i_only_advanced),
+ i_only_advanced);
}
+ else if (!found)
+ printf(color ? "\n" WHITE "%s" GRAY "\n" : "\n%s\n",
+ _("No matching module found. Use --list or "
+ "--list-verbose to list available modules."));
/* Release the module list */
module_list_free (list);
*****************************************************************************/
static void ListModules (vlc_object_t *p_this, bool b_verbose)
{
- module_t *p_parser;
-
- bool b_color = var_InheritBool( p_this, "color" );
+ bool color = false;
ShowConsole();
-#ifdef WIN32
- b_color = false; // don't put color control codes in a .txt file
+#ifndef _WIN32
+ if (isatty(STDOUT_FILENO))
+ color = var_InheritBool(p_this, "color");
#else
- if( !isatty( 1 ) )
- b_color = false;
+ (void) p_this;
#endif
/* List all modules */
- module_t **list = module_list_get (NULL);
+ size_t count;
+ module_t **list = module_list_get (&count);
/* Enumerate each module */
- for (size_t j = 0; (p_parser = list[j]) != NULL; j++)
+ for (size_t j = 0; j < count; j++)
{
+ module_t *p_parser = list[j];
const char *objname = module_get_object (p_parser);
- if( b_color )
- utf8_fprintf( stdout, GREEN" %-22s "WHITE"%s\n"GRAY, objname,
- module_gettext( p_parser, p_parser->psz_longname ) );
- else
- utf8_fprintf( stdout, " %-22s %s\n", objname,
- module_gettext( p_parser, p_parser->psz_longname ) );
+ printf(color ? GREEN" %-22s "WHITE"%s\n"GRAY : " %-22s %s\n",
+ objname, module_gettext(p_parser, p_parser->psz_longname));
if( b_verbose )
{
char *const *pp_shortcuts = p_parser->pp_shortcuts;
for( unsigned i = 0; i < p_parser->i_shortcuts; i++ )
- {
if( strcmp( pp_shortcuts[i], objname ) )
- {
- if( b_color )
- utf8_fprintf( stdout, CYAN" s %s\n"GRAY,
- pp_shortcuts[i] );
- else
- utf8_fprintf( stdout, " s %s\n",
- pp_shortcuts[i] );
- }
- }
- if( p_parser->psz_capability )
- {
- if( b_color )
- utf8_fprintf( stdout, MAGENTA" c %s (%d)\n"GRAY,
- p_parser->psz_capability,
- p_parser->i_score );
- else
- utf8_fprintf( stdout, " c %s (%d)\n",
- p_parser->psz_capability,
- p_parser->i_score );
- }
+ printf(color ? CYAN" s %s\n"GRAY : " s %s\n",
+ pp_shortcuts[i]);
+ if (p_parser->psz_capability != NULL)
+ printf(color ? MAGENTA" c %s (%d)\n"GRAY : " c %s (%d)\n",
+ p_parser->psz_capability, p_parser->i_score);
}
}
module_list_free (list);
static void Version( void )
{
ShowConsole();
- utf8_fprintf( stdout, _("VLC version %s (%s)\n"), VERSION_MESSAGE,
- psz_vlc_changeset );
- utf8_fprintf( stdout, _("Compiled by %s on %s (%s)\n"),
- VLC_CompileBy(), VLC_CompileHost(), __DATE__" "__TIME__ );
- utf8_fprintf( stdout, _("Compiler: %s\n"), VLC_Compiler() );
- utf8_fprintf( stdout, "%s", LICENSE_MSG );
+ printf(_("VLC version %s (%s)\n"), VERSION_MESSAGE, psz_vlc_changeset);
+ printf(_("Compiled by %s on %s (%s)\n"), VLC_CompileBy(),
+ VLC_CompileHost(), __DATE__" "__TIME__ );
+ printf(_("Compiler: %s\n"), VLC_Compiler());
+ fputs(LICENSE_MSG, stdout);
PauseConsole();
}
-#if defined (WIN32) && !defined (UNDER_CE)
+#if defined( _WIN32 ) && !VLC_WINSTORE_APP
/*****************************************************************************
* ShowConsole: On Win32, create an output console for debug messages
*****************************************************************************
*****************************************************************************/
static void ShowConsole( void )
{
- FILE *f_help = NULL;
-
if( getenv( "PWD" ) ) return; /* Cygwin shell or Wine */
- AllocConsole();
+ if( !AllocConsole() ) return;
+
/* Use the ANSI code page (e.g. Windows-1252) as expected by the LibVLC
* Unicode/locale subsystem. By default, we have the obsolecent OEM code
* page (e.g. CP437 or CP850). */
SetConsoleOutputCP (GetACP ());
- SetConsoleTitle ("VLC media player version "PACKAGE_VERSION);
+ SetConsoleTitle (TEXT("VLC media player version ") TEXT(PACKAGE_VERSION));
freopen( "CONOUT$", "w", stderr );
freopen( "CONIN$", "r", stdin );
- f_help = fopen( "vlc-help.txt", "wt" );
- if( f_help != NULL )
+ if( freopen( "vlc-help.txt", "wt", stdout ) != NULL )
{
- fclose( f_help );
- freopen( "vlc-help.txt", "wt", stdout );
- utf8_fprintf( stderr, _("\nDumped content to vlc-help.txt file.\n") );
+ fputs( "\xEF\xBB\xBF", stdout );
+ fprintf( stderr, _("\nDumped content to vlc-help.txt file.\n") );
}
- else freopen( "CONOUT$", "w", stdout );
+ else
+ freopen( "CONOUT$", "w", stdout );
}
/*****************************************************************************
fclose( stdout );
}
#endif
-
-/*****************************************************************************
- * ConsoleWidth: Return the console width in characters
- *****************************************************************************
- * We use the stty shell command to get the console width; if this fails or
- * if the width is less than 80, we default to 80.
- *****************************************************************************/
-static int ConsoleWidth( void )
-{
- unsigned i_width = 80;
-
-#ifndef WIN32
- FILE *file = popen( "stty size 2>/dev/null", "r" );
- if (file != NULL)
- {
- if (fscanf (file, "%*u %u", &i_width) <= 0)
- i_width = 80;
- pclose( file );
- }
-#elif !defined (UNDER_CE)
- CONSOLE_SCREEN_BUFFER_INFO buf;
-
- if (GetConsoleScreenBufferInfo (GetStdHandle (STD_OUTPUT_HANDLE), &buf))
- i_width = buf.dwSize.X;
-#endif
-
- return i_width;
-}
projects / vlc / blobdiff