Home | History | Annotate | Line # | Download | only in ftp 
      1 /*	$NetBSD: progressbar.h,v 1.9 2021/01/06 04:43:14 lukem Exp $	*/
      2 
      3 /*-
      4  * Copyright (c) 1996-2021 The NetBSD Foundation, Inc.
      5  * All rights reserved.
      6  *
      7  * This code is derived from software contributed to The NetBSD Foundation
      8  * by Luke Mewburn.
      9  *
     10  * Redistribution and use in source and binary forms, with or without
     11  * modification, are permitted provided that the following conditions
     12  * are met:
     13  * 1. Redistributions of source code must retain the above copyright
     14  *    notice, this list of conditions and the following disclaimer.
     15  * 2. Redistributions in binary form must reproduce the above copyright
     16  *    notice, this list of conditions and the following disclaimer in the
     17  *    documentation and/or other materials provided with the distribution.
     18  *
     19  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
     20  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
     21  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
     22  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
     23  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
     24  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
     25  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
     26  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
     27  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
     28  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
     29  * POSSIBILITY OF SUCH DAMAGE.
     30  */
     31 
     32 #ifndef STANDALONE_PROGRESS
     33 #include <setjmp.h>
     34 #endif	/* !STANDALONE_PROGRESS */
     35 
     36 #ifndef	GLOBAL
     37 #define	GLOBAL	extern
     38 #endif
     39 
     40 
     41 #define	STALLTIME	5	/* # of seconds of no xfer before "stalling" */
     42 
     43 typedef void (*sigfunc)(int);
     44 
     45 
     46 GLOBAL	FILE   *ttyout;		/* stdout, or stderr if retrieving to stdout */
     47 
     48 GLOBAL	int	progress;	/* display transfer progress bar */
     49 GLOBAL	int	ttywidth;	/* width of tty */
     50 
     51 GLOBAL	off_t	bytes;		/* current # of bytes read */
     52 GLOBAL	off_t	filesize;	/* size of file being transferred */
     53 GLOBAL	off_t	restart_point;	/* offset to restart transfer */
     54 GLOBAL	char   *prefix;		/* Text written left of progress bar */
     55 
     56 
     57 #ifndef	STANDALONE_PROGRESS
     58 GLOBAL	int	fromatty;	/* input is from a terminal */
     59 GLOBAL	int	verbose;	/* print messages coming back from server */
     60 GLOBAL	int	quit_time;	/* maximum time to wait if stalled */
     61 
     62 GLOBAL	const char  *direction;	/* direction transfer is occurring */
     63 
     64 GLOBAL	sigjmp_buf toplevel;	/* non-local goto stuff for cmd scanner */
     65 #endif	/* !STANDALONE_PROGRESS */
     66 
     67 int	foregroundproc(void);
     68 void	alarmtimer(int);
     69 void	progressmeter(int);
     70 sigfunc	xsignal(int, sigfunc);
     71 
     72 #ifndef STANDALONE_PROGRESS
     73 void	psummary(int);
     74 void	ptransfer(int);
     75 #endif	/* !STANDALONE_PROGRESS */
     76 
     77 #ifdef NO_LONG_LONG
     78 # define LLF		"%ld"
     79 # define LLFP(x)	"%" x "ld"
     80 # define LLT		long
     81 # define ULLF		"%lu"
     82 # define ULLFP(x)	"%" x "lu"
     83 # define ULLT		unsigned long
     84 #else
     85 # define LLF		"%lld"
     86 # define LLFP(x)	"%" x "lld"
     87 # define LLT		long long
     88 # define ULLF		"%llu"
     89 # define ULLFP(x)	"%" x "llu"
     90 # define ULLT		unsigned long long
     91 #endif
     92