mirror of
https://github.com/opnsense/src.git
synced 2026-05-28 04:12:45 -04:00
b319d93437
New features overview: * Unicode. User interface handles multi-column characters. API can handle char* like a multibyte character string. Internally wide characters are used for keyboard input, to adapt word wrapping and dynamic text auto-sizing for multi-column characters. * Forms refactoring. Complete rewrite deleting libformw dependency. * Theme. New utility options to save and load custom theme at run-time. * TUI navigation. Added keys to navigate input components. Changed default focus behavior of input dialogs to be LGPL-dialog-like; a new option can set the previous whiptail-like behavior. See /usr/src/contrib/bsddialog/CHANGELOG '2022-08-29 Version 0.3' for more detailed information. Merge commit '2c9fd7655ba54e7239f528e1af9fe09662de9b03'
141 lines
4.4 KiB
C
141 lines
4.4 KiB
C
/*-
|
|
* SPDX-License-Identifier: BSD-2-Clause
|
|
*
|
|
* Copyright (c) 2021-2022 Alfonso Sabato Siciliano
|
|
*
|
|
* Redistribution and use in source and binary forms, with or without
|
|
* modification, are permitted provided that the following conditions
|
|
* are met:
|
|
* 1. Redistributions of source code must retain the above copyright
|
|
* notice, this list of conditions and the following disclaimer.
|
|
* 2. Redistributions in binary form must reproduce the above copyright
|
|
* notice, this list of conditions and the following disclaimer in the
|
|
* documentation and/or other materials provided with the distribution.
|
|
*
|
|
* THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
|
|
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
|
* ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
|
|
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
|
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
|
|
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
|
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
|
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
|
|
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
|
|
* SUCH DAMAGE.
|
|
*/
|
|
|
|
#ifndef _LIBBSDDIALOG_UTIL_H_
|
|
#define _LIBBSDDIALOG_UTIL_H_
|
|
|
|
#define HBORDERS 2
|
|
#define VBORDERS 2
|
|
#define TEXTHMARGIN 1
|
|
#define TEXTHMARGINS (TEXTHMARGIN + TEXTHMARGIN)
|
|
|
|
/* theme utils */
|
|
extern struct bsddialog_theme t;
|
|
extern bool hastermcolors;
|
|
|
|
/* debug */
|
|
#define BSDDIALOG_DEBUG(y,x,fmt, ...) do { \
|
|
mvprintw(y, x, fmt, __VA_ARGS__); \
|
|
refresh(); \
|
|
} while (0)
|
|
|
|
/* unicode */
|
|
unsigned int strcols(const char *mbstring);
|
|
int str_props(const char *mbstring, unsigned int *cols, bool *has_multi_col);
|
|
void mvwaddwch(WINDOW *w, int y, int x, wchar_t wch);
|
|
wchar_t* alloc_mbstows(const char *mbstring);
|
|
|
|
/* error buffer */
|
|
const char *get_error_string(void);
|
|
void set_error_string(const char *string);
|
|
|
|
#define RETURN_ERROR(str) do { \
|
|
set_error_string(str); \
|
|
return (BSDDIALOG_ERROR); \
|
|
} while (0)
|
|
|
|
/* buttons */
|
|
struct buttons {
|
|
unsigned int nbuttons;
|
|
#define MAXBUTTONS 6 /* ok + extra + cancel + help + 2 generics */
|
|
const char *label[MAXBUTTONS];
|
|
wchar_t first[MAXBUTTONS];
|
|
int value[MAXBUTTONS];
|
|
int curr;
|
|
unsigned int sizebutton; /* including left and right delimiters */
|
|
};
|
|
|
|
#define BUTTON_OK_LABEL "OK"
|
|
#define BUTTON_CANCEL_LABEL "Cancel"
|
|
void
|
|
get_buttons(struct bsddialog_conf *conf, struct buttons *bs,
|
|
const char *yesoklabel, const char *nocancellabel);
|
|
|
|
void
|
|
draw_buttons(WINDOW *window, struct buttons bs, bool shortcut);
|
|
|
|
int buttons_min_width(struct buttons bs);
|
|
bool shortcut_buttons(wint_t key, struct buttons *bs);
|
|
|
|
/* help window with F1 key */
|
|
int f1help(struct bsddialog_conf *conf);
|
|
|
|
/* cleaner */
|
|
int hide_widget(int y, int x, int h, int w, bool withshadow);
|
|
|
|
/* (auto) size and (auto) position */
|
|
#define SCREENLINES (getmaxy(stdscr))
|
|
#define SCREENCOLS (getmaxx(stdscr))
|
|
|
|
int
|
|
text_size(struct bsddialog_conf *conf, int rows, int cols, const char *text,
|
|
struct buttons *bs, int rowsnotext, int startwtext, int *htext, int *wtext);
|
|
|
|
int widget_max_height(struct bsddialog_conf *conf);
|
|
int widget_max_width(struct bsddialog_conf *conf);
|
|
|
|
int
|
|
widget_min_height(struct bsddialog_conf *conf, int htext, int minwidget,
|
|
bool withbuttons);
|
|
|
|
int
|
|
widget_min_width(struct bsddialog_conf *conf, int wtext, int minwidget,
|
|
struct buttons *bs);
|
|
|
|
int
|
|
set_widget_size(struct bsddialog_conf *conf, int rows, int cols, int *h,
|
|
int *w);
|
|
|
|
int
|
|
set_widget_position(struct bsddialog_conf *conf, int *y, int *x, int h, int w);
|
|
|
|
/* widget builders */
|
|
enum elevation { RAISED, LOWERED };
|
|
|
|
void
|
|
draw_borders(struct bsddialog_conf *conf, WINDOW *win, int rows, int cols,
|
|
enum elevation elev);
|
|
|
|
WINDOW *
|
|
new_boxed_window(struct bsddialog_conf *conf, int y, int x, int rows, int cols,
|
|
enum elevation elev);
|
|
|
|
int
|
|
new_dialog(struct bsddialog_conf *conf, WINDOW **shadow, WINDOW **widget, int y,
|
|
int x, int h, int w, WINDOW **textpad, const char *text, struct buttons *bs,
|
|
bool shortcutbuttons);
|
|
|
|
int
|
|
update_dialog(struct bsddialog_conf *conf, WINDOW *shadow, WINDOW *widget,
|
|
int y, int x, int h, int w, WINDOW *textpad, const char *text,
|
|
struct buttons *bs, bool shortcutbuttons);
|
|
|
|
void
|
|
end_dialog(struct bsddialog_conf *conf, WINDOW *shadow, WINDOW *widget,
|
|
WINDOW *textpad);
|
|
|
|
#endif
|