Here's the updated patch with documentation.
On Thu, May 29, 2014 at 6:08 PM, Darshit Shah <[email protected]> wrote: > On Thu, May 29, 2014 at 6:01 PM, Giuseppe Scrivano <[email protected]> wrote: >> Darshit Shah <[email protected]> writes: >> >>> On Thu, May 29, 2014 at 4:30 PM, Giuseppe Scrivano <[email protected]> >>> wrote: >>>> Darshit Shah <[email protected]> writes: >>>> >>>>> Has anyone tested out this patch yet? >>>>> >>>>> I'd really like some feedback on this before it gets merged. I prefer >>>>> this implementation of the progress bar over the original one. Does >>>>> anybody have any issues / suggestions? >>>> >>>> it looks very nice, thanks to have worked on it. >>>> >>>> Do you think we could make an argument to --progress instead? Something >>>> like: >>>> >>>> wget --progress=bar:force:noscroll ... >>> >>> Given the number of people who asked for a noscroll option, I think >>> this one would be often used and hence, I'd like to keep as short an >>> option for this as possible. In fact I was thinking about adding a >>> short option, -ns or something similar. >> >> well, if we implement it trough --progress these people can just type it >> once in their ~/.wgetrc file. >> >> I am just hesitant to add a new command line argument as we will get stuck >> with it forever if we'll change idea. >> > Right, I didn't think about using it through wgetrc. > I'll add it as a parameter there then. >> Giuseppe > > > > -- > Thanking You, > Darshit Shah -- Thanking You, Darshit Shah
From b557d9635ddffe749c93f154dafe9b229560a34b Mon Sep 17 00:00:00 2001 From: Darshit Shah <[email protected]> Date: Tue, 20 May 2014 00:15:45 +0530 Subject: [PATCH] More progress bar aesthetic changes This commit introduces two new changes to how the progress bar looks: 1. Support the --progress=bar:noscroll option which will prevent the filename from scrolling in the progress bar 2. Print human readable value for the amount already downloaded for any file --- doc/ChangeLog | 4 ++++ doc/wget.texi | 31 +++++++++++++++++++++---- src/ChangeLog | 18 +++++++++++++++ src/ftp.c | 4 ++-- src/http.c | 4 ++-- src/init.c | 1 + src/main.c | 4 ++-- src/options.h | 1 + src/progress.c | 72 ++++++++++++++++++++++++++++++++++++++-------------------- src/utils.c | 8 +++---- src/utils.h | 2 +- 11 files changed, 110 insertions(+), 39 deletions(-) diff --git a/doc/ChangeLog b/doc/ChangeLog index 91269b0..17d5e8a 100644 --- a/doc/ChangeLog +++ b/doc/ChangeLog @@ -1,3 +1,7 @@ +2014-05-24 Darshit Shah <[email protected]> + + * wget.texi: Document noscroll parameter to progress=bar + 2014-05-01 Darshit Shah <[email protected]> * wget.texi: Add documentation for --show-progress diff --git a/doc/wget.texi b/doc/wget.texi index e1f29dc..45f6beb 100644 --- a/doc/wget.texi +++ b/doc/wget.texi @@ -732,7 +732,12 @@ Use @samp{--progress=dot} to switch to the ``dot'' display. It traces the retrieval by printing dots on the screen, each dot representing a fixed amount of downloaded data. -When using the dotted retrieval, you may also set the @dfn{style} by +The progress @var{type} can also take one or more parameters. The parameters +vary based on the @var{type} selected. Parameters to @var{type} are passed by +appending them to the type sperated by a colon (:) like this: +@samp{--progress=@var{type}:@var{parameter1}:@var{parameter2}}. + +When using the dotted retrieval, you may set the @dfn{style} by specifying the type as @samp{dot:@var{style}}. Different styles assign different meaning to one dot. With the @code{default} style each dot represents 1K, there are ten dots in a cluster and 50 dots in a line. @@ -745,11 +750,25 @@ If @code{mega} is not enough then you can use the @code{giga} style---each dot represents 1M retrieved, there are eight dots in a cluster, and 32 dots on each line (so each line contains 32M). +With @samp{--progress=bar}, there are currently two possible parameters, +@var{force} and @var{noscroll}. + +When the output is not a TTY, the progress bar always falls back to ``dot'', +even if @samp{--progress=bar} was passed to Wget during invokation. This +behaviour can be overridden and the ``bar'' output forced by using the ``force'' +parameter as @samp{--progress=bar:force}. + +By default, the @samp{bar} style progress bar scroll the name of the file from +left to right for the file being downloaded if the filename exceeds the maximum +length allotted for its display. In certain cases, such as with +@samp{--progress=bar:force}, one may not want the scrolling filename in the +progress bar. By passing the ``noscroll'' parameter, Wget can be forced to +display as much of the filename as possible without scrolling through it. + Note that you can set the default style using the @code{progress} command in @file{.wgetrc}. That setting may be overridden from the -command line. The exception is that, when the output is not a TTY, the -``dot'' progress will be favored over ``bar''. To force the bar output, -use @samp{--progress=bar:force}. +command line. For example, to force the bar output without scrolling, +use @samp{--progress=bar:force:noscroll}. @item --show-progress Force wget to display the progress bar in any verbosity. @@ -761,6 +780,10 @@ is often a desired a property when invoking wget to download several small/large files. In such a case, wget could simply be invoked with this parameter to get a much cleaner output on the screen. +@item --no-scroll +Do not scroll the filename of the file being downloaded in the progress bar + + @item -N @itemx --timestamping Turn on time-stamping. @xref{Time-Stamping}, for details. diff --git a/src/ChangeLog b/src/ChangeLog index f07ddc5..c8c3de0 100644 --- a/src/ChangeLog +++ b/src/ChangeLog @@ -1,3 +1,21 @@ +2014-05-20 Darshit Shah <[email protected]> + + * utils.c (human_readable): Add new parameters, acc and decimals for the + function. acc decides the number under which decimal values are shown for a + certain value, while decimals decides the number of decimal digits displayed + * utils.h (human_readable): Update declartion of the function + * ftp.c (print_length): Update call to human_readable + * http.c (gethttp): Same + * init.c (defaults): Enable scrolling filenames by default + * main.c (main): Update call to human_readable + * options.h (options): Add new option noscroll + * progress.c (create_image): Update the look of the progress bar. Human + readable download size by default and add support for noscroll. + (dot_set_params, bar_set_params): Change paramter to char * since strtok + needs to modify the string. + (bar_set_params): Add support for noscroll parameter to bar. + + 2014-05-03 Tim Ruehsen <[email protected]> * ftp-ls.c (ftp_parse_vms_ls): Explicitly typecast strlen's output diff --git a/src/ftp.c b/src/ftp.c index 25f05a4..e63d98d 100644 --- a/src/ftp.c +++ b/src/ftp.c @@ -221,13 +221,13 @@ print_length (wgint size, wgint start, bool authoritative) { logprintf (LOG_VERBOSE, _("Length: %s"), number_to_static_string (size)); if (size >= 1024) - logprintf (LOG_VERBOSE, " (%s)", human_readable (size)); + logprintf (LOG_VERBOSE, " (%s)", human_readable (size, 10, 1)); if (start > 0) { if (size - start >= 1024) logprintf (LOG_VERBOSE, _(", %s (%s) remaining"), number_to_static_string (size - start), - human_readable (size - start)); + human_readable (size - start, 10, 1)); else logprintf (LOG_VERBOSE, _(", %s remaining"), number_to_static_string (size - start)); diff --git a/src/http.c b/src/http.c index b50acf4..0583fae 100644 --- a/src/http.c +++ b/src/http.c @@ -2804,13 +2804,13 @@ read_header: logputs (LOG_VERBOSE, number_to_static_string (contlen + contrange)); if (contlen + contrange >= 1024) logprintf (LOG_VERBOSE, " (%s)", - human_readable (contlen + contrange)); + human_readable (contlen + contrange, 10, 1)); if (contrange) { if (contlen >= 1024) logprintf (LOG_VERBOSE, _(", %s (%s) remaining"), number_to_static_string (contlen), - human_readable (contlen)); + human_readable (contlen, 10, 1)); else logprintf (LOG_VERBOSE, _(", %s remaining"), number_to_static_string (contlen)); diff --git a/src/init.c b/src/init.c index fbef133..804e473 100644 --- a/src/init.c +++ b/src/init.c @@ -413,6 +413,7 @@ defaults (void) /* Use a negative value to mark the absence of --start-pos option */ opt.start_pos = -1; opt.show_progress = false; + opt.noscroll = false; } /* Return the user's home directory (strdup-ed), or NULL if none is diff --git a/src/main.c b/src/main.c index 29c1324..20b8aa3 100644 --- a/src/main.c +++ b/src/main.c @@ -1714,7 +1714,7 @@ outputting to a regular file.\n")); datetime_str (time (NULL)), wall_time, numurls, - human_readable (total_downloaded_bytes), + human_readable (total_downloaded_bytes, 10, 1), download_time, retr_rate (total_downloaded_bytes, total_download_time)); xfree (wall_time); @@ -1724,7 +1724,7 @@ outputting to a regular file.\n")); if (opt.quota && total_downloaded_bytes > opt.quota) logprintf (LOG_NOTQUIET, _("Download quota of %s EXCEEDED!\n"), - human_readable (opt.quota)); + human_readable (opt.quota, 10, 1)); } if (opt.cookies_output) diff --git a/src/options.h b/src/options.h index 9358e30..2855149 100644 --- a/src/options.h +++ b/src/options.h @@ -135,6 +135,7 @@ struct options char *base_href; char *progress_type; /* progress indicator type. */ bool show_progress; /* Show only the progress bar */ + bool noscroll; /* Don't scroll the filename in the progressbar */ char *proxy_user; /*oli*/ char *proxy_passwd; diff --git a/src/progress.c b/src/progress.c index 6cb22d7..0c809eb 100644 --- a/src/progress.c +++ b/src/progress.c @@ -51,7 +51,7 @@ struct progress_implementation { void (*update) (void *, wgint, double); void (*draw) (void *); void (*finish) (void *, double); - void (*set_params) (const char *); + void (*set_params) (char *); }; /* Necessary forward declarations. */ @@ -60,13 +60,13 @@ static void *dot_create (const char *, wgint, wgint); static void dot_update (void *, wgint, double); static void dot_finish (void *, double); static void dot_draw (void *); -static void dot_set_params (const char *); +static void dot_set_params (char *); static void *bar_create (const char *, wgint, wgint); static void bar_update (void *, wgint, double); static void bar_draw (void *); static void bar_finish (void *, double); -static void bar_set_params (const char *); +static void bar_set_params (char *); static struct progress_implementation implementations[] = { { "dot", 0, dot_create, dot_update, dot_draw, dot_finish, dot_set_params }, @@ -112,7 +112,7 @@ set_progress_implementation (const char *name) { size_t i, namelen; struct progress_implementation *pi = implementations; - const char *colon; + char *colon; if (!name) name = DEFAULT_PROGRESS_IMPLEMENTATION; @@ -419,7 +419,7 @@ dot_finish (void *progress, double dltime) giga. */ static void -dot_set_params (const char *params) +dot_set_params (char *params) { if (!params || !*params) params = opt.dot_style; @@ -889,7 +889,7 @@ create_image (struct bar_progress *bp, double dl_total_time, bool done) int orig_filename_len = strlen (bp->f_download); /* The progress bar should look like this: - file xx% [=======> ] nn,nnn 12.34KB/s eta 36m 51s + file xx% [=======> ] nnn.nnK 12.34KB/s eta 36m 51s Calculate the geometry. The idea is to assign as much room as possible to the progress bar. The other idea is to never let @@ -898,17 +898,26 @@ create_image (struct bar_progress *bp, double dl_total_time, bool done) It would be especially bad for the progress bar to be resized randomly. - "file " - Downloaded filename - MAX MAX_FILENAME_LEN chars + 1 + "file " - Downloaded filename - MAX_FILENAME_LEN chars + 1 "xx% " or "100%" - percentage - 4 chars "[]" - progress bar decorations - 2 chars - " nnn,nnn,nnn" - downloaded bytes - 12 chars or very rarely more - " 12.5KB/s" - download rate - 9 chars + " nnn.nnK" - downloaded bytes - 7 chars + 1 + " 12.5KB/s" - download rate - 8 chars + 1 " eta 36m 51s" - ETA - 14 chars "=====>..." - progress bar - the rest */ - int dlbytes_size = 1 + MAX (size_grouped_len, 11); - int progress_size = bp->width - (MAX_FILENAME_LEN + 1 + 4 + 2 + dlbytes_size + 8 + 14); + +#define PROGRESS_FILENAME_LEN MAX_FILENAME_LEN + 1 +#define PROGRESS_PERCENT_LEN 4 +#define PROGRESS_DECORAT_LEN 2 +#define PROGRESS_FILESIZE_LEN 7 + 1 +#define PROGRESS_DWNLOAD_RATE 8 + 1 +#define PROGRESS_ETA_LEN 14 + + int progress_size = bp->width - (PROGRESS_FILENAME_LEN + PROGRESS_PERCENT_LEN + + PROGRESS_DECORAT_LEN + PROGRESS_FILESIZE_LEN + + PROGRESS_DWNLOAD_RATE + PROGRESS_ETA_LEN); /* The difference between the number of bytes used, and the number of columns used. */ @@ -929,7 +938,7 @@ create_image (struct bar_progress *bp, double dl_total_time, bool done) { int offset; - if (orig_filename_len > MAX_FILENAME_LEN) + if (((orig_filename_len > MAX_FILENAME_LEN) && !opt.noscroll) && !done) offset = ((int) bp->tick) % (orig_filename_len - MAX_FILENAME_LEN); else offset = 0; @@ -1014,13 +1023,20 @@ create_image (struct bar_progress *bp, double dl_total_time, bool done) } ++bp->tick; - /* " 234,567,890" */ - sprintf (p, " %s", size_grouped); + /* " 234.56M" */ + const char * down_size = human_readable (size, 1000, 2); + int cols_diff = 7 - count_cols (down_size); + while (cols_diff > 0) + { + *p++=' '; + cols_diff--; + } + sprintf (p, " %s", down_size); move_to_end (p); - /* Pad with spaces to 11 chars for the size_grouped field; + /* Pad with spaces to 7 chars for the size_grouped field; * couldn't use the field width specifier in sprintf, because * it counts in bytes, not characters. */ - for (size_grouped_pad = 11 - size_grouped_len; + for (size_grouped_pad = PROGRESS_FILESIZE_LEN - 7; size_grouped_pad > 0; --size_grouped_pad) { @@ -1030,20 +1046,20 @@ create_image (struct bar_progress *bp, double dl_total_time, bool done) /* " 12.52Kb/s or 12.52KB/s" */ if (hist->total_time > 0 && hist->total_bytes) { - static const char *short_units[] = { "B/s", "KB/s", "MB/s", "GB/s" }; - static const char *short_units_bits[] = { "b/s", "Kb/s", "Mb/s", "Gb/s" }; + static const char *short_units[] = { " B/s", "KB/s", "MB/s", "GB/s" }; + static const char *short_units_bits[] = { " b/s", "Kb/s", "Mb/s", "Gb/s" }; int units = 0; /* Calculate the download speed using the history ring and recent data that hasn't made it to the ring yet. */ wgint dlquant = hist->total_bytes + bp->recent_bytes; double dltime = hist->total_time + (dl_total_time - bp->recent_start); double dlspeed = calc_rate (dlquant, dltime, &units); - sprintf (p, "%4.*f%s", dlspeed >= 99.95 ? 0 : dlspeed >= 9.995 ? 1 : 2, + sprintf (p, " %4.*f%s", dlspeed >= 99.95 ? 0 : dlspeed >= 9.995 ? 1 : 2, dlspeed, !opt.report_bps ? short_units[units] : short_units_bits[units]); move_to_end (p); } else - APPEND_LITERAL ("--.-KB/s"); + APPEND_LITERAL (" --.-KB/s"); if (!done) { @@ -1126,13 +1142,21 @@ display_image (char *buf) } static void -bar_set_params (const char *params) +bar_set_params (char *params) { char *term = getenv ("TERM"); - if (params - && 0 == strcmp (params, "force")) - current_impl_locked = 1; + if (params) + { + char *param = strtok (params, ":"); + do + { + if (0 == strcmp (param, "force")) + current_impl_locked = 1; + else if (0 == strcmp (param, "noscroll")) + opt.noscroll = true; + } while ((param = strtok (NULL, ":")) != NULL); + } if ((opt.lfilename #ifdef HAVE_ISATTY diff --git a/src/utils.c b/src/utils.c index 11ca75c..8168fb3 100644 --- a/src/utils.c +++ b/src/utils.c @@ -1523,7 +1523,7 @@ with_thousand_seps (wgint n) some detail. */ char * -human_readable (HR_NUMTYPE n) +human_readable (HR_NUMTYPE n, const int acc, const int decimals) { /* These suffixes are compatible with those of GNU `ls -lh'. */ static char powers[] = @@ -1556,10 +1556,10 @@ human_readable (HR_NUMTYPE n) if ((n / 1024) < 1024 || i == countof (powers) - 1) { double val = n / 1024.0; - /* Print values smaller than 10 with one decimal digits, and - others without any decimals. */ + /* Print values smaller than the accuracy level (acc) with (decimal) + * decimal digits, and others without any decimals. */ snprintf (buf, sizeof (buf), "%.*f%c", - val < 10 ? 1 : 0, val, powers[i]); + val < acc ? decimals : 0, val, powers[i]); return buf; } n /= 1024; diff --git a/src/utils.h b/src/utils.h index e244b8a..1f4cb69 100644 --- a/src/utils.h +++ b/src/utils.h @@ -121,7 +121,7 @@ const char *with_thousand_seps (wgint); #else # define HR_NUMTYPE double #endif -char *human_readable (HR_NUMTYPE); +char *human_readable (HR_NUMTYPE, const int, const int); int numdigit (wgint); -- 1.9.3
