lib/libdpv/dprompt.h

   1 /*-
   2  * Copyright (c) 2013-2014 Devin Teske <dteske@FreeBSD.org>
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in the
  12  *    documentation and/or other materials provided with the distribution.
  13  *
  14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  15  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  17  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  18  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  19  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  20  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  21  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  22  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  23  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  24  * SUCH DAMAGE.
  25  *
  26  * $FreeBSD$
  27  */
  28
  29 #ifndef _DPROMPT_H_
  30 #define _DPROMPT_H_
  31
  32 #include <sys/cdefs.h>
  33
  34 #include "dpv.h"
  35
  36 /* Display characteristics */
  37 #define ENV_MSG_DONE    "msg_done"
  38 #define ENV_MSG_FAIL    "msg_fail"
  39 #define ENV_MSG_PENDING "msg_pending"
  40 extern int display_limit;
  41 extern int label_size;
  42 extern int pbar_size;
  43
  44 __BEGIN_DECLS
  45 void    dprompt_clear(void);
  46 void    dprompt_dprint(int _fd, const char *_prefix, const char *_append,
  47             int _overall);
  48 void    dprompt_free(void);
  49 void    dprompt_init(struct dpv_file_node *_file_list);
  50 void    dprompt_libprint(const char *_prefix, const char *_append,
  51             int _overall);
  52 void    dprompt_recreate(struct dpv_file_node *_file_list,
  53             struct dpv_file_node *_curfile, int _pct);
  54 int     dprompt_add(const char *_format, ...);
  55 int     dprompt_sprint(char * restrict _str, const char *_prefix,
  56             const char *_append);
  57 __END_DECLS
  58
  59 #endif /* !_DPROMPT_H_ */