1 .\" Copyright (c) 2013-2018 Devin Teske
2 .\" All rights reserved.
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
7 .\" 1. Redistributions of source code must retain the above copyright
8 .\" notice, this list of conditions and the following disclaimer.
9 .\" 2. Redistributions in binary form must reproduce the above copyright
10 .\" notice, this list of conditions and the following disclaimer in the
11 .\" documentation and/or other materials provided with the distribution.
13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32 .Nd dialog progress view library
39 .Fa "struct dpv_config *config"
40 .Fa "struct dpv_file_node *file_list"
49 library provides an interface for creating complex
51 widgets for displaying progress on various actions.
54 library can display progress with one of
59 .Pq x11/xdialog from the ports tree .
64 argument properties for configuring global display features:
65 .Bd -literal -offset indent
67 uint8_t keep_tite; /* Cleaner exit for scripts */
68 enum dpv_display display_type; /* Def. DPV_DISPLAY_LIBDIALOG */
69 enum dpv_output output_type; /* Default DPV_OUTPUT_NONE */
70 int debug; /* Enable debug on stderr */
71 int display_limit; /* Files/page. Default -1 */
72 int label_size; /* Label size. Default 28 */
73 int pbar_size; /* Mini-progress size */
74 int dialog_updates_per_second; /* Default 16 */
75 int status_updates_per_second; /* Default 2 */
76 uint16_t options; /* Default 0 (none) */
77 char *title; /* Widget title */
78 char *backtitle; /* Widget backtitle */
79 char *aprompt; /* Append. Default NULL */
80 char *pprompt; /* Prefix. Default NULL */
81 char *msg_done; /* Default `Done' */
82 char *msg_fail; /* Default `Fail' */
83 char *msg_pending; /* Default `Pending' */
84 char *output; /* Output format string */
85 const char *status_solo; /* dialog(3) solo-status format.
86 * Default DPV_STATUS_SOLO */
87 const char *status_many; /* dialog(3) many-status format.
88 * Default DPV_STATUS_MANY */
91 * Function pointer; action to perform data transfer
93 int (*action)(struct dpv_file_node *file, int out);
97 DPV_DISPLAY_LIBDIALOG = 0, /* Use dialog(3) (default) */
98 DPV_DISPLAY_STDOUT, /* Use stdout */
99 DPV_DISPLAY_DIALOG, /* Use spawned dialog(1) */
100 DPV_DISPLAY_XDIALOG, /* Use spawned Xdialog(1) */
104 DPV_OUTPUT_NONE = 0, /* No output (default) */
105 DPV_OUTPUT_FILE, /* Read `output' member as file path */
106 DPV_OUTPUT_SHELL, /* Read `output' member as shell cmd */
115 argument is a mask of bit fields indicating various processing options.
117 .Bl -tag -width DPV_NO_OVERRUN
125 argument is not called but instead simulated-data is used to drive progress.
139 .Dv DPV_STATUS_DEFAULT
151 argument will bump the width of the gauge widget.
152 Prompts wider than the maximum width will wrap
156 see BUGS section below
159 Disables the display of labels associated with each transfer
168 Force the use of color even if the
170 does not support color
173 environment variable is ignored
175 .It Dv DPV_NO_OVERRUN
177 callbacks for the current
181 returns 100 or greater
183 alleviates the need to change the
187 but may also cause file truncation if the stream exceeds expected length
199 .Bd -literal -offset indent
200 struct dpv_file_node {
201 enum dpv_status status; /* status of read operation */
202 char *msg; /* display instead of "Done/Fail" */
203 char *name; /* name of file to read */
204 char *path; /* path to file */
205 long long length; /* expected size */
206 long long read; /* number units read (e.g., bytes) */
207 struct dpv_file_node *next;/* pointer to next (end with NULL) */
211 For each of the items in the
217 callback member of the
225 action on the file and return.
228 represents the current progress percentage
230 for the current file.
234 callback provides two variables for each call.
236 provides a reference to the current
240 provides a file descriptor where the data goes.
247 argument was set to DPV_OUTPUT_NONE
248 .Pq default ; when invoking Fn dpv ,
253 will be zero and can be ignored.
256 was set to DPV_OUTPUT_FILE,
258 will be an open file descriptor to a file.
261 was set to DPV_OUTPUT_SHELL,
263 will be an open file descriptor to a pipe for a spawned shell program.
266 is greater than zero,
267 write data that has been read back to
274 callback or asynchronously from a signal handler,
275 two globals are provided via
277 .Bd -literal -offset indent
278 extern int dpv_interrupt; /* Set to TRUE in interrupt handler */
279 extern int dpv_abort; /* Set to true in callback to abort */
282 These globals are not automatically reset and must be manually maintained.
283 Do not forget to reset these globals before subsequent invocations of
285 when making multiple calls from the same program.
293 argument can be used to control callbacks for the current file.
296 member can be set to any of the below from
298 .Bd -literal -offset indent
300 DPV_STATUS_RUNNING = 0, /* Running (default) */
301 DPV_STATUS_DONE, /* Completed */
302 DPV_STATUS_FAILED, /* Oops, something went wrong */
310 which keeps the callbacks coming for the current
314 to anything other than DPV_STATUS_RUNNING will cause
316 to loop to the next file,
317 effecting the next callback,
322 callback is responsible for calculating percentages and
328 can display throughput statistics.
329 Percentages are reported through the
334 Throughput statistics are calculated from the below global
338 .Bd -literal -offset indent
339 extern int dpv_overall_read;
342 Set this to the number of bytes that have been read for all files.
343 Throughput information is displayed in the status line
344 .Pq only available when using Xr dialog 3
345 at the bottom of the screen.
346 See DPV_DISPLAY_LIBDIALOG above.
350 does not have to represent bytes.
354 can be changed to display something other than
359 .Pq for example, counting lines .
363 is processing the current file,
371 argument are used for calculating the display of mini progress bars
380 member of the current
383 .Pq indicating an unknown file length ,
385 .Xr humanize_number 3
388 member is used instead of a traditional progress bar.
389 Otherwise a progress bar is calculated as percentage read to file length.
391 callback must maintain these member values for mini-progress bars.
397 on private global variables initialized by
400 The below environment variables are referenced by
402 .Bl -tag -width ".Ev USE_COLOR"
404 Override command string used to launch
406 .Pq requires Dv DPV_DISPLAY_DIALOG
409 .Pq requires Dv DPV_DISPLAY_XDIALOG ;
412 .Pq for Dv DPV_DISPLAY_DIALOG
415 .Pq for Dv DPV_DISPLAY_XDIALOG .
424 is either not set or NULL,
427 .Pq that is, Ql $HOME/.dialogrc .
430 disables the use of color when using
432 .Pq does not apply to Xr Xdialog 1 .
433 .It Ev msg_done Ev msg_fail Ev msg_pending
434 Internationalization strings for overriding the default English strings
440 To prevent their usage,
449 argument to default macros
450 .Pq DPV_DONE_DEFAULT, DPV_FAIL_DEFAULT, and DPV_PENDING_DEFAULT
454 .Bl -tag -width ".Pa $HOME/.dialogrc" -compact
455 .It Pa $HOME/.dialogrc
464 library first appeared in
467 .An Devin Teske Aq dteske@FreeBSD.org
471 .Ql Fl -title Ar title
476 .Va struct dpv_config
479 .Ql Fl -backtitle Ar backtitle
484 .Va struct dpv_config
486 displays the backtitle in place of the title and vice-versa.
489 does not wrap long prompt texts received after initial launch.
490 This is a known issue with the
494 Embed escaped newlines within prompt text to force line breaks.
497 does not display the first character after a series of escaped escape-sequences
498 (for example, ``\\\\n'' produces ``\\'' instead of ``\\n'').
499 This is a known issue with
506 If an application ignores
508 when set and NULL before calling
510 with color escape sequences anyway,
514 may not render properly.
515 Workaround is to detect when
517 is set and NULL and either not use color escape sequences at that time or use
521 forcing interpretation of color sequences.
524 which renders the color escape sequences as plain text.
527 embedded "\\Z" sequences
531 for additional information.