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
58 .Xr Xdialog 1 Pq Pa ports/x11/xdialog .
63 argument properties for configuring global display features:
64 .Bd -literal -offset indent
66 uint8_t keep_tite; /* Cleaner exit for scripts */
67 enum dpv_display display_type; /* Def. DPV_DISPLAY_LIBDIALOG */
68 enum dpv_output output_type; /* Default DPV_OUTPUT_NONE */
69 int debug; /* Enable debug on stderr */
70 int display_limit; /* Files/page. Default -1 */
71 int label_size; /* Label size. Default 28 */
72 int pbar_size; /* Mini-progress size */
73 int dialog_updates_per_second; /* Default 16 */
74 int status_updates_per_second; /* Default 2 */
75 uint16_t options; /* Default 0 (none) */
76 char *title; /* Widget title */
77 char *backtitle; /* Widget backtitle */
78 char *aprompt; /* Append. Default NULL */
79 char *pprompt; /* Prefix. Default NULL */
80 char *msg_done; /* Default `Done' */
81 char *msg_fail; /* Default `Fail' */
82 char *msg_pending; /* Default `Pending' */
83 char *output; /* Output format string */
84 const char *status_solo; /* dialog(3) solo-status format.
85 * Default DPV_STATUS_SOLO */
86 const char *status_many; /* dialog(3) many-status format.
87 * Default DPV_STATUS_MANY */
90 * Function pointer; action to perform data transfer
92 int (*action)(struct dpv_file_node *file, int out);
96 DPV_DISPLAY_LIBDIALOG = 0, /* Use dialog(3) (default) */
97 DPV_DISPLAY_STDOUT, /* Use stdout */
98 DPV_DISPLAY_DIALOG, /* Use spawned dialog(1) */
99 DPV_DISPLAY_XDIALOG, /* Use spawned Xdialog(1) */
103 DPV_OUTPUT_NONE = 0, /* No output (default) */
104 DPV_OUTPUT_FILE, /* Read `output' member as file path */
105 DPV_OUTPUT_SHELL, /* Read `output' member as shell cmd */
114 argument is a mask of bit fields indicating various processing options.
116 .Bl -tag -width DPV_NO_OVERRUN
124 argument is not called but instead simulated-data is used to drive progress.
138 .Dv DPV_STATUS_DEFAULT
150 argument will bump the width of the gauge widget.
151 Prompts wider than the maximum width will wrap
154 .Xr Xdialog 1 Pq Pa ports/x11/xdialog ;
155 see BUGS section below
158 Disables the display of labels associated with each transfer
167 Force the use of color even if the
169 does not support color
172 environment variable is ignored
174 .It Dv DPV_NO_OVERRUN
176 callbacks for the current
180 returns 100 or greater
182 alleviates the need to change the
186 but may also cause file truncation if the stream exceeds expected length
198 .Bd -literal -offset indent
199 struct dpv_file_node {
200 enum dpv_status status; /* status of read operation */
201 char *msg; /* display instead of "Done/Fail" */
202 char *name; /* name of file to read */
203 char *path; /* path to file */
204 long long length; /* expected size */
205 long long read; /* number units read (e.g., bytes) */
206 struct dpv_file_node *next;/* pointer to next (end with NULL) */
210 For each of the items in the
216 callback member of the
224 action on the file and return.
227 represents the current progress percentage
229 for the current file.
233 callback provides two variables for each call.
235 provides a reference to the current
239 provides a file descriptor where the data goes.
246 argument was set to DPV_OUTPUT_NONE
247 .Pq default ; when invoking Fn dpv ,
252 will be zero and can be ignored.
255 was set to DPV_OUTPUT_FILE,
257 will be an open file descriptor to a file.
260 was set to DPV_OUTPUT_SHELL,
262 will be an open file descriptor to a pipe for a spawned shell program.
265 is greater than zero,
266 write data that has been read back to
273 callback or asynchronously from a signal handler,
274 two globals are provided via
276 .Bd -literal -offset indent
277 extern int dpv_interrupt; /* Set to TRUE in interrupt handler */
278 extern int dpv_abort; /* Set to true in callback to abort */
281 These globals are not automatically reset and must be manually maintained.
282 Do not forget to reset these globals before subsequent invocations of
284 when making multiple calls from the same program.
292 argument can be used to control callbacks for the current file.
295 member can be set to any of the below from
297 .Bd -literal -offset indent
299 DPV_STATUS_RUNNING = 0, /* Running (default) */
300 DPV_STATUS_DONE, /* Completed */
301 DPV_STATUS_FAILED, /* Oops, something went wrong */
309 which keeps the callbacks coming for the current
313 to anything other than DPV_STATUS_RUNNING will cause
315 to loop to the next file,
316 effecting the next callback,
321 callback is responsible for calculating percentages and
327 can display throughput statistics.
328 Percentages are reported through the
333 Throughput statistics are calculated from the below global
337 .Bd -literal -offset indent
338 extern int dpv_overall_read;
341 Set this to the number of bytes that have been read for all files.
342 Throughput information is displayed in the status line
343 .Pq only available when using Xr dialog 3
344 at the bottom of the screen.
345 See DPV_DISPLAY_LIBDIALOG above.
349 does not have to represent bytes.
353 can be changed to display something other than
358 .Pq for example, counting lines .
362 is processing the current file,
370 argument are used for calculating the display of mini progress bars
379 member of the current
382 .Pq indicating an unknown file length ,
384 .Xr humanize_number 3
387 member is used instead of a traditional progress bar.
388 Otherwise a progress bar is calculated as percentage read to file length.
390 callback must maintain these member values for mini-progress bars.
396 on private global variables initialized by
399 The below environment variables are referenced by
401 .Bl -tag -width ".Ev USE_COLOR"
403 Override command string used to launch
405 .Pq requires Dv DPV_DISPLAY_DIALOG
407 .Xr Xdialog 1 Pq Pa ports/x11/xdialog
408 .Pq requires Dv DPV_DISPLAY_XDIALOG ;
411 .Pq for Dv DPV_DISPLAY_DIALOG
414 .Pq for Dv DPV_DISPLAY_XDIALOG .
423 is either not set or NULL,
426 .Pq that is, Ql $HOME/.dialogrc .
429 disables the use of color when using
432 .Xr Xdialog 1 Pq Pa ports/x11/xdialog .
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
459 .Xr Xdialog 1 Pq Pa ports/x11/xdialog ,
464 library first appeared in
467 .An Devin Teske Aq dteske@FreeBSD.org
469 .Xr Xdialog 1 Pq Pa ports/x11/xdialog ,
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.
488 .Xr Xdialog 1 Pq Pa ports/x11/xdialog
489 does not wrap long prompt texts received after initial launch.
490 This is a known issue with the
493 .Xr Xdialog 1 Pq Pa ports/x11/xdialog .
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
504 .Xr Xdialog 1 Pq Pa ports/x11/xdialog .
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.
523 .Xr Xdialog 1 Pq Pa ports/x11/xdialog ,
524 which renders the color escape sequences as plain text.
527 embedded "\\Z" sequences
531 for additional information.