sbin/camcontrol/progress.h

   1 /*      $NetBSD: progressbar.c,v 1.21 2009/04/12 10:18:52 lukem Exp $   */
   2
   3 /*-
   4  * SPDX-License-Identifier: BSD-2-Clause-NetBSD
   5  *
   6  * Copyright (c) 1997-2012 The NetBSD Foundation, Inc.
   7  * All rights reserved.
   8  *
   9  * This code is derived from software contributed to The NetBSD Foundation
  10  * by Luke Mewburn.
  11  *
  12  * Redistribution and use in source and binary forms, with or without
  13  * modification, are permitted provided that the following conditions
  14  * are met:
  15  * 1. Redistributions of source code must retain the above copyright
  16  *    notice, this list of conditions and the following disclaimer.
  17  * 2. Redistributions in binary form must reproduce the above copyright
  18  *    notice, this list of conditions and the following disclaimer in the
  19  *    documentation and/or other materials provided with the distribution.
  20  *
  21  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
  22  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  23  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  24  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
  25  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  26  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  27  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  28  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  29  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  30  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  31  * POSSIBILITY OF SUCH DAMAGE.
  32  *
  33  * $FreeBSD$
  34  */
  35
  36 #ifndef PROGRESS_H_
  37 #define PROGRESS_H_     20100228
  38
  39 #include <sys/types.h>
  40
  41 #include <inttypes.h>
  42
  43 /* structure used to display a progress meter */
  44 typedef struct progress_t {
  45         char            *prefix;        /* any prefix explanation */
  46         uint64_t         size;          /* total of bytes/units to be counted */
  47         uint64_t         done;          /* number of units counted to date */
  48         uint64_t         percent;       /* cache the percentage complete */
  49         time_t           start;         /* time we started this */
  50         time_t           now;           /* time now */
  51         time_t           eta;           /* estimated # of secs until completion */
  52         int64_t          elapsed;       /* cached # of elapsed seconds */
  53         int32_t          ttywidth;      /* width of tty in columns */
  54 } progress_t;
  55
  56 int progress_init(progress_t */*meter*/, const char */*prefix*/, uint64_t /*size*/);
  57 int progress_update(progress_t */*meter*/, uint64_t /*done*/);
  58 int progress_draw(progress_t */*meter*/);
  59 int progress_reset_size(progress_t */*meter*/, uint64_t /*size*/);
  60 int progress_complete(progress_t */*meter*/, uint64_t /*done*/);
  61
  62 #endif