sbin/camcontrol/progress.h

   1 /*      $NetBSD: progressbar.c,v 1.21 2009/04/12 10:18:52 lukem Exp $   */
   2
   3 /*-
   4  * Copyright (c) 1997-2012 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  * $FreeBSD$
  32  */
  33
  34 #ifndef PROGRESS_H_
  35 #define PROGRESS_H_     20100228
  36
  37 #include <sys/types.h>
  38
  39 #include <inttypes.h>
  40
  41 /* structure used to display a progress meter */
  42 typedef struct progress_t {
  43         char            *prefix;        /* any prefix explanation */
  44         uint64_t         size;          /* total of bytes/units to be counted */
  45         uint64_t         done;          /* number of units counted to date */
  46         uint64_t         percent;       /* cache the percentage complete */
  47         time_t           start;         /* time we started this */
  48         time_t           now;           /* time now */
  49         time_t           eta;           /* estimated # of secs until completion */
  50         int64_t          elapsed;       /* cached # of elapsed seconds */
  51         int32_t          ttywidth;      /* width of tty in columns */
  52 } progress_t;
  53
  54 int progress_init(progress_t */*meter*/, const char */*prefix*/, uint64_t /*size*/);
  55 int progress_update(progress_t */*meter*/, uint64_t /*done*/);
  56 int progress_draw(progress_t */*meter*/);
  57 int progress_reset_size(progress_t */*meter*/, uint64_t /*size*/);
  58 int progress_complete(progress_t */*meter*/, uint64_t /*done*/);
  59
  60 #endif