contrib/bsddialog/lib/bsddialog_progressview.h

   1 /*-
   2  * SPDX-License-Identifier: BSD-2-Clause
   3  *
   4  * Copyright (c) 2021-2022 Alfonso Sabato Siciliano
   5  *
   6  * Redistribution and use in source and binary forms, with or without
   7  * modification, are permitted provided that the following conditions
   8  * are met:
   9  * 1. Redistributions of source code must retain the above copyright
  10  *    notice, this list of conditions and the following disclaimer.
  11  * 2. Redistributions in binary form must reproduce the above copyright
  12  *    notice, this list of conditions and the following disclaimer in the
  13  *    documentation and/or other materials provided with the distribution.
  14  *
  15  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  16  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  17  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  18  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  19  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  20  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  21  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  22  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  23  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  24  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  25  * SUCH DAMAGE.
  26  */
  27
  28 #ifndef _LIBBSDDIALOG_PROGRESSVIEW_H_
  29 #define _LIBBSDDIALOG_PROGRESSVIEW_H_
  30
  31 /*
  32  * Undocumented API, DO NOT USE!
  33  * Please consider this file private: it is used by bsdinstall/distextract,
  34  * could be deleted or changed in the future.
  35  */
  36
  37 extern bool bsddialog_interruptprogview;
  38 extern bool bsddialog_abortprogview;
  39 extern int  bsddialog_total_progview;
  40
  41 struct bsddialog_fileminibar {
  42         const char *path;
  43         const char *label;
  44         int status; /* next if BSDDIALOG_MG_DONE or BSDDIALOG_MG_FAILED */
  45         long long size;
  46         long long read;
  47 };
  48
  49 struct bsddialog_progviewconf {
  50         const char *fmtbottomstr;
  51         unsigned int refresh; /* in seconds */
  52         int (*callback)(struct bsddialog_fileminibar *minibar);
  53 };
  54
  55 int
  56 bsddialog_progressview (struct bsddialog_conf *conf, const char *text, int rows,
  57     int cols, struct bsddialog_progviewconf *pvconf, unsigned int nminibar,
  58     struct bsddialog_fileminibar *minibar);
  59
  60 #endif