1274116Sdteske/*- 2295107Sdteske * Copyright (c) 2013-2016 Devin Teske <dteske@FreeBSD.org> 3274116Sdteske * All rights reserved. 4274116Sdteske * 5274116Sdteske * Redistribution and use in source and binary forms, with or without 6274116Sdteske * modification, are permitted provided that the following conditions 7274116Sdteske * are met: 8274116Sdteske * 1. Redistributions of source code must retain the above copyright 9274116Sdteske * notice, this list of conditions and the following disclaimer. 10274116Sdteske * 2. Redistributions in binary form must reproduce the above copyright 11274116Sdteske * notice, this list of conditions and the following disclaimer in the 12274116Sdteske * documentation and/or other materials provided with the distribution. 13274116Sdteske * 14274116Sdteske * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 15274116Sdteske * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 16274116Sdteske * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 17274116Sdteske * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 18274116Sdteske * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 19274116Sdteske * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 20274116Sdteske * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 21274116Sdteske * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 22274116Sdteske * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 23274116Sdteske * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 24274116Sdteske * SUCH DAMAGE. 25274116Sdteske * 26274116Sdteske * $FreeBSD: releng/10.3/lib/libdpv/dpv.h 295107 2016-02-01 00:44:29Z dteske $ 27274116Sdteske */ 28274116Sdteske 29274116Sdteske#ifndef _DPV_H_ 30274116Sdteske#define _DPV_H_ 31274116Sdteske 32274116Sdteske#include <sys/types.h> 33274116Sdteske 34274116Sdteske#ifndef TRUE 35274116Sdteske#define TRUE 1 36274116Sdteske#endif 37274116Sdteske#ifndef FALSE 38274116Sdteske#define FALSE 0 39274116Sdteske#endif 40274116Sdteske 41294895Sdteske/* localeconv(3) */ 42294895Sdteske#define LC_NUMERIC_DEFAULT "en_US.ISO8859-1" 43294895Sdteske 44274116Sdteske/* Data to process */ 45274116Sdteskeextern long long dpv_overall_read; 46274116Sdteske 47274116Sdteske/* Interrupt flag */ 48274116Sdteskeextern int dpv_interrupt; /* Set to TRUE in interrupt handler */ 49274116Sdteskeextern int dpv_abort; /* Set to true in callback to abort */ 50274116Sdteske 51274116Sdteske/* 52274116Sdteske * Display types for use with display_type member of dpv_config structure 53274116Sdteske */ 54274116Sdteskeenum dpv_display { 55274116Sdteske DPV_DISPLAY_LIBDIALOG = 0, /* Display using dialog(3) (default) */ 56274116Sdteske DPV_DISPLAY_STDOUT, /* Display on stdout */ 57274116Sdteske DPV_DISPLAY_DIALOG, /* Display using spawned dialog(1) */ 58274116Sdteske DPV_DISPLAY_XDIALOG, /* Display using spawned Xdialog(1) */ 59274116Sdteske}; 60274116Sdteske 61274116Sdteske/* 62274116Sdteske * Output types for use with output_type member of dpv_config structure 63274116Sdteske */ 64274116Sdteskeenum dpv_output { 65274116Sdteske DPV_OUTPUT_NONE = 0, /* No output (default) */ 66274116Sdteske DPV_OUTPUT_FILE, /* Read `output' member as file path */ 67274116Sdteske DPV_OUTPUT_SHELL, /* Read `output' member as shell cmd */ 68274116Sdteske}; 69274116Sdteske 70274116Sdteske/* 71274116Sdteske * Activity types for use with status member of dpv_file_node structure. 72274116Sdteske * If you set a status other than DPV_STATUS_RUNNING on the current file in the 73274116Sdteske * action callback of dpv_config structure, you'll end callbacks for that 74274116Sdteske * dpv_file_node. 75274116Sdteske */ 76274116Sdteskeenum dpv_status { 77274116Sdteske DPV_STATUS_RUNNING = 0, /* Running (default) */ 78274116Sdteske DPV_STATUS_DONE, /* Completed */ 79274116Sdteske DPV_STATUS_FAILED, /* Oops, something went wrong */ 80274116Sdteske}; 81274116Sdteske 82274116Sdteske/* 83274116Sdteske * Anatomy of file option; pass an array of these as dpv() file_list argument 84274116Sdteske * terminated with a NULL pointer. 85274116Sdteske */ 86274116Sdteskestruct dpv_file_node { 87274116Sdteske enum dpv_status status; /* status of read operation */ 88274116Sdteske char *msg; /* display instead of "Done/Fail" */ 89274116Sdteske char *name; /* name of file to read */ 90274116Sdteske char *path; /* path to file */ 91274116Sdteske long long length; /* expected size */ 92274116Sdteske long long read; /* number units read (e.g., bytes) */ 93274116Sdteske struct dpv_file_node *next; /* pointer to next (end with NULL) */ 94274116Sdteske}; 95274116Sdteske 96274116Sdteske/* 97274116Sdteske * Anatomy of config option to pass as dpv() config argument 98274116Sdteske */ 99274116Sdteskestruct dpv_config { 100295107Sdteske uint8_t keep_tite; /* Prevent visually distracting exit */ 101274116Sdteske enum dpv_display display_type; /* Display (default TYPE_LIBDIALOG) */ 102274116Sdteske enum dpv_output output_type; /* Output (default TYPE_NONE) */ 103274116Sdteske int debug; /* Enable debugging output on stderr */ 104274116Sdteske int display_limit; /* Files per `page'. Default -1 */ 105274116Sdteske int label_size; /* Label size. Default 28 */ 106274116Sdteske int pbar_size; /* Mini-progress size. See dpv(3) */ 107274116Sdteske int dialog_updates_per_second; /* Progress updates/s. Default 16 */ 108274116Sdteske int status_updates_per_second; /* dialog(3) status updates/second. 109274116Sdteske * Default 2 */ 110274116Sdteske uint16_t options; /* Special options. Default 0 */ 111274116Sdteske char *title; /* widget title */ 112274116Sdteske char *backtitle; /* Widget backtitle */ 113274116Sdteske char *aprompt; /* Prompt append. Default NULL */ 114274116Sdteske char *pprompt; /* Prompt prefix. Default NULL */ 115274116Sdteske char *msg_done; /* Progress text. Default `Done' */ 116274116Sdteske char *msg_fail; /* Progress text. Default `Fail' */ 117274116Sdteske char *msg_pending; /* Progress text. Default `Pending' */ 118274116Sdteske char *output; /* Output format string; see dpv(3) */ 119274116Sdteske const char *status_solo; /* dialog(3) solo-status format. 120274116Sdteske * Default DPV_STATUS_SOLO */ 121274116Sdteske const char *status_many; /* dialog(3) many-status format. 122274116Sdteske * Default DPV_STATUS_MANY */ 123274116Sdteske 124274116Sdteske /* 125274116Sdteske * Function pointer; action to perform data transfer 126274116Sdteske */ 127274116Sdteske int (*action)(struct dpv_file_node *file, int out); 128274116Sdteske}; 129274116Sdteske 130274116Sdteske/* 131274116Sdteske * Macros for dpv() options bitmask argument 132274116Sdteske */ 133274116Sdteske#define DPV_TEST_MODE 0x0001 /* Test mode (fake reading data) */ 134274116Sdteske#define DPV_WIDE_MODE 0x0002 /* prefix/append bump dialog width */ 135274116Sdteske#define DPV_NO_LABELS 0x0004 /* Hide file_node.name labels */ 136274116Sdteske#define DPV_USE_COLOR 0x0008 /* Override to force color output */ 137274116Sdteske#define DPV_NO_OVERRUN 0x0010 /* Stop transfers when they hit 100% */ 138274116Sdteske 139274116Sdteske/* 140274116Sdteske * Limits (modify with extreme care) 141274116Sdteske */ 142274116Sdteske#define DPV_APROMPT_MAX 4096 /* Buffer size for `-a text' */ 143274116Sdteske#define DPV_DISPLAY_LIMIT 10 /* Max file progress lines */ 144274116Sdteske#define DPV_PPROMPT_MAX 4096 /* Buffer size for `-p text' */ 145274116Sdteske#define DPV_STATUS_FORMAT_MAX 80 /* Buffer size for `-u format' */ 146274116Sdteske 147274116Sdteske/* 148274116Sdteske * Extra display information 149274116Sdteske */ 150274116Sdteske#define DPV_STATUS_SOLO "%'10lli bytes read @ %'9.1f bytes/sec." 151274116Sdteske#define DPV_STATUS_MANY (DPV_STATUS_SOLO " [%i/%i busy/wait]") 152274116Sdteske 153274116Sdteske/* 154274116Sdteske * Strings 155274116Sdteske */ 156274116Sdteske#define DPV_DONE_DEFAULT "Done" 157274116Sdteske#define DPV_FAIL_DEFAULT "Fail" 158274116Sdteske#define DPV_PENDING_DEFAULT "Pending" 159274116Sdteske 160274116Sdteske__BEGIN_DECLS 161274116Sdteskevoid dpv_free(void); 162274116Sdteskeint dpv(struct dpv_config *_config, struct dpv_file_node *_file_list); 163274116Sdteske__END_DECLS 164274116Sdteske 165274116Sdteske#endif /* !_DPV_H_ */ 166