contrib/lukemftp/progressbar.h

   1 /*      $NetBSD: progressbar.h,v 1.5 2005/02/10 16:00:38 jmc Exp $      */
   2
   3 /*-
   4  * Copyright (c) 1996-2003 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  * 3. All advertising materials mentioning features or use of this software
  19  *    must display the following acknowledgement:
  20  *      This product includes software developed by the NetBSD
  21  *      Foundation, Inc. and its contributors.
  22  * 4. Neither the name of The NetBSD Foundation nor the names of its
  23  *    contributors may be used to endorse or promote products derived
  24  *    from this software without specific prior written permission.
  25  *
  26  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
  27  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  28  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  29  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
  30  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  31  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  32  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  33  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  34  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  35  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  36  * POSSIBILITY OF SUCH DAMAGE.
  37  */
  38
  39 #ifndef STANDALONE_PROGRESS
  40 #include <setjmp.h>
  41 #endif  /* !STANDALONE_PROGRESS */
  42
  43 #ifndef GLOBAL
  44 #define GLOBAL  extern
  45 #endif
  46
  47
  48 #define STALLTIME       5       /* # of seconds of no xfer before "stalling" */
  49
  50 typedef void (*sigfunc)(int);
  51
  52
  53 GLOBAL  FILE   *ttyout;         /* stdout, or stderr if retrieving to stdout */
  54
  55 GLOBAL  int     progress;       /* display transfer progress bar */
  56 GLOBAL  int     ttywidth;       /* width of tty */
  57
  58 GLOBAL  off_t   bytes;          /* current # of bytes read */
  59 GLOBAL  off_t   filesize;       /* size of file being transferred */
  60 GLOBAL  off_t   restart_point;  /* offset to restart transfer */
  61 GLOBAL  char   *prefix;         /* Text written left of progress bar */
  62
  63
  64 #ifndef STANDALONE_PROGRESS
  65 GLOBAL  int     fromatty;       /* input is from a terminal */
  66 GLOBAL  int     verbose;        /* print messages coming back from server */
  67 GLOBAL  int     quit_time;      /* maximum time to wait if stalled */
  68
  69 GLOBAL  char   *direction;      /* direction transfer is occurring */
  70
  71 GLOBAL  sigjmp_buf toplevel;    /* non-local goto stuff for cmd scanner */
  72 #endif  /* !STANDALONE_PROGRESS */
  73
  74 int     foregroundproc(void);
  75 void    alarmtimer(int);
  76 void    progressmeter(int);
  77 sigfunc xsignal(int, sigfunc);
  78 sigfunc xsignal_restart(int, sigfunc, int);
  79
  80 #ifndef STANDALONE_PROGRESS
  81 void    psummary(int);
  82 void    ptransfer(int);
  83 #endif  /* !STANDALONE_PROGRESS */
  84
  85 #ifdef NO_LONG_LONG
  86 # define LLF            "%ld"
  87 # define LLFP(x)        "%" x "ld"
  88 # define LLT            long
  89 # define ULLF           "%lu"
  90 # define ULLFP(x)       "%" x "lu"
  91 # define ULLT           unsigned long
  92 #else
  93 # define LLF            "%lld"
  94 # define LLFP(x)        "%" x "lld"
  95 # define LLT            long long
  96 # define ULLF           "%llu"
  97 # define ULLFP(x)       "%" x "llu"
  98 # define ULLT           unsigned long long
  99 #endif