iPXE
Data Structures | Macros | Functions
dynui.h File Reference

Dynamic user interfaces. More...

#include <ipxe/list.h>

Go to the source code of this file.

Data Structures

struct  dynamic_ui
 A dynamic user interface. More...
 
struct  dynamic_item
 A dynamic user interface item. More...
 

Macros

#define DYNUI_DEFAULT   0x0001
 Dynamic user interface item is default selection. More...
 
#define DYNUI_SECRET   0x0002
 Dynamic user interface item represents a secret. More...
 

Functions

 FILE_LICENCE (GPL2_OR_LATER_OR_UBDL)
 
struct dynamic_ui * create_dynui (const char *name, const char *title)
 Create dynamic user interface. More...
 
struct dynamic_item * add_dynui_item (struct dynamic_ui *dynui, const char *name, const char *text, unsigned int flags, int shortcut)
 Add dynamic user interface item. More...
 
void destroy_dynui (struct dynamic_ui *dynui)
 Destroy dynamic user interface. More...
 
struct dynamic_ui * find_dynui (const char *name)
 Find dynamic user interface. More...
 
struct dynamic_item * dynui_item (struct dynamic_ui *dynui, unsigned int index)
 Find dynamic user interface item by index. More...
 
struct dynamic_item * dynui_shortcut (struct dynamic_ui *dynui, int key)
 Find dynamic user interface item by shortcut key. More...
 
int show_menu (struct dynamic_ui *dynui, unsigned long timeout, unsigned long retimeout, const char *select, struct dynamic_item **selected)
 Show menu. More...
 
int show_form (struct dynamic_ui *dynui)
 Show form. More...
 

Detailed Description

Dynamic user interfaces.

Definition in file dynui.h.

Macro Definition Documentation

◆ DYNUI_DEFAULT

#define DYNUI_DEFAULT   0x0001

Dynamic user interface item is default selection.

Definition at line 45 of file dynui.h.

◆ DYNUI_SECRET

#define DYNUI_SECRET   0x0002

Dynamic user interface item represents a secret.

Definition at line 48 of file dynui.h.

Function Documentation

◆ FILE_LICENCE()

FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL  )

◆ create_dynui()

struct dynamic_ui* create_dynui ( const char *  name,
const char *  title 
)

Create dynamic user interface.

Parameters
nameUser interface name, or NULL
titleUser interface title, or NULL
Return values
dynuiDynamic user interface, or NULL on failure

Definition at line 48 of file dynui.c.

48  {
49  struct dynamic_ui *dynui;
50  size_t name_len;
51  size_t title_len;
52  size_t len;
53  char *name_copy;
54  char *title_copy;
55 
56  /* Destroy any existing user interface of this name */
57  dynui = find_dynui ( name );
58  if ( dynui )
59  destroy_dynui ( dynui );
60 
61  /* Use empty title if none given */
62  if ( ! title )
63  title = "";
64 
65  /* Allocate user interface */
66  name_len = ( name ? ( strlen ( name ) + 1 /* NUL */ ) : 0 );
67  title_len = ( strlen ( title ) + 1 /* NUL */ );
68  len = ( sizeof ( *dynui ) + name_len + title_len );
69  dynui = zalloc ( len );
70  if ( ! dynui )
71  return NULL;
72  name_copy = ( ( void * ) ( dynui + 1 ) );
73  title_copy = ( name_copy + name_len );
74 
75  /* Initialise user interface */
76  if ( name ) {
77  strcpy ( name_copy, name );
78  dynui->name = name_copy;
79  }
80  strcpy ( title_copy, title );
81  dynui->title = title_copy;
82  INIT_LIST_HEAD ( &dynui->items );
83 
84  /* Add to list of user interfaces */
85  list_add_tail ( &dynui->list, &dynamic_uis );
86 
87  DBGC ( dynui, "DYNUI %s created with title \"%s\"\n",
88  dynui->name, dynui->title );
89 
90  return dynui;
91 }
dynamic_ui::title
const char * title
Title.
Definition: dynui.h:21
name
const char * name
Definition: ath9k_hw.c:1984
DBGC
#define DBGC(...)
Definition: compiler.h:505
find_dynui
struct dynamic_ui * find_dynui(const char *name)
Find dynamic user interface.
Definition: dynui.c:172
dynamic_ui::items
struct list_head items
Dynamic user interface items.
Definition: dynui.h:23
list_add_tail
#define list_add_tail(new, head)
Add a new entry to the tail of a list.
Definition: list.h:93
len
ring len
Length.
Definition: dwmac.h:231
strcpy
char * strcpy(char *dest, const char *src)
Copy string.
Definition: string.c:346
zalloc
void * zalloc(size_t size)
Allocate cleared memory.
Definition: malloc.c:661
strlen
size_t strlen(const char *src)
Get length of string.
Definition: string.c:243
dynamic_ui
A dynamic user interface.
Definition: dynui.h:15
INIT_LIST_HEAD
#define INIT_LIST_HEAD(list)
Initialise a list head.
Definition: list.h:45
dynamic_ui::list
struct list_head list
List of dynamic user interfaces.
Definition: dynui.h:17
dynamic_ui::name
const char * name
Name.
Definition: dynui.h:19
destroy_dynui
void destroy_dynui(struct dynamic_ui *dynui)
Destroy dynamic user interface.
Definition: dynui.c:149
NULL
#define NULL
NULL pointer (VOID *)
Definition: Base.h:321

References DBGC, destroy_dynui(), find_dynui(), INIT_LIST_HEAD, dynamic_ui::items, len, dynamic_ui::list, list_add_tail, dynamic_ui::name, name, NULL, strcpy(), strlen(), dynamic_ui::title, and zalloc().

Referenced by dynui_exec().

◆ add_dynui_item()

struct dynamic_item* add_dynui_item ( struct dynamic_ui *  dynui,
const char *  name,
const char *  text,
unsigned int  flags,
int  shortcut 
)

Add dynamic user interface item.

Parameters
dynuiDynamic user interface
nameName, or NULL
textText, or NULL
flagsFlags
shortcutShortcut key
Return values
itemUser interface item, or NULL on failure

Definition at line 103 of file dynui.c.

105  {
106  struct dynamic_item *item;
107  size_t name_len;
108  size_t text_len;
109  size_t len;
110  char *name_copy;
111  char *text_copy;
112 
113  /* Use empty text if none given */
114  if ( ! text )
115  text = "";
116 
117  /* Allocate item */
118  name_len = ( name ? ( strlen ( name ) + 1 /* NUL */ ) : 0 );
119  text_len = ( strlen ( text ) + 1 /* NUL */ );
120  len = ( sizeof ( *item ) + name_len + text_len );
121  item = zalloc ( len );
122  if ( ! item )
123  return NULL;
124  name_copy = ( ( void * ) ( item + 1 ) );
125  text_copy = ( name_copy + name_len );
126 
127  /* Initialise item */
128  if ( name ) {
129  strcpy ( name_copy, name );
130  item->name = name_copy;
131  }
132  strcpy ( text_copy, text );
133  item->text = text_copy;
134  item->index = dynui->count++;
135  item->flags = flags;
136  item->shortcut = shortcut;
137 
138  /* Add to list of items */
139  list_add_tail ( &item->list, &dynui->items );
140 
141  return item;
142 }
name
const char * name
Definition: ath9k_hw.c:1984
dynamic_item
A dynamic user interface item.
Definition: dynui.h:29
dynamic_ui::count
unsigned int count
Number of user interface items.
Definition: dynui.h:25
dynamic_ui::items
struct list_head items
Dynamic user interface items.
Definition: dynui.h:23
dynamic_item::name
const char * name
Name.
Definition: dynui.h:33
list_add_tail
#define list_add_tail(new, head)
Add a new entry to the tail of a list.
Definition: list.h:93
len
ring len
Length.
Definition: dwmac.h:231
strcpy
char * strcpy(char *dest, const char *src)
Copy string.
Definition: string.c:346
flags
uint8_t flags
Flags.
Definition: ena.h:18
zalloc
void * zalloc(size_t size)
Allocate cleared memory.
Definition: malloc.c:661
strlen
size_t strlen(const char *src)
Get length of string.
Definition: string.c:243
dynamic_item::shortcut
int shortcut
Shortcut key.
Definition: dynui.h:41
dynamic_item::text
const char * text
Text.
Definition: dynui.h:35
dynamic_item::flags
unsigned int flags
Flags.
Definition: dynui.h:39
dynamic_item::index
unsigned int index
Index.
Definition: dynui.h:37
dynamic_item::list
struct list_head list
List of dynamic user interface items.
Definition: dynui.h:31
NULL
#define NULL
NULL pointer (VOID *)
Definition: Base.h:321

References dynamic_ui::count, flags, dynamic_item::flags, dynamic_item::index, dynamic_ui::items, len, dynamic_item::list, list_add_tail, dynamic_item::name, name, NULL, dynamic_item::shortcut, strcpy(), strlen(), dynamic_item::text, and zalloc().

Referenced by item_exec().

◆ destroy_dynui()

void destroy_dynui ( struct dynamic_ui *  dynui)

Destroy dynamic user interface.

Parameters
dynuiDynamic user interface

Definition at line 149 of file dynui.c.

149  {
150  struct dynamic_item *item;
151  struct dynamic_item *tmp;
152 
153  /* Remove from list of user interfaces */
154  list_del ( &dynui->list );
155 
156  /* Free items */
157  list_for_each_entry_safe ( item, tmp, &dynui->items, list ) {
158  list_del ( &item->list );
159  free ( item );
160  }
161 
162  /* Free user interface */
163  free ( dynui );
164 }
dynamic_item
A dynamic user interface item.
Definition: dynui.h:29
tmp
unsigned long tmp
Definition: linux_pci.h:64
list_del
#define list_del(list)
Delete an entry from a list.
Definition: list.h:119
dynamic_ui::items
struct list_head items
Dynamic user interface items.
Definition: dynui.h:23
list_for_each_entry_safe
#define list_for_each_entry_safe(pos, tmp, head, member)
Iterate over entries in a list, safe against deletion of the current entry.
Definition: list.h:458
free
static void(* free)(struct refcnt *refcnt))
Definition: refcnt.h:54
dynamic_ui::list
struct list_head list
List of dynamic user interfaces.
Definition: dynui.h:17
dynamic_item::list
struct list_head list
List of dynamic user interface items.
Definition: dynui.h:31

References free, dynamic_ui::items, dynamic_item::list, dynamic_ui::list, list_del, list_for_each_entry_safe, and tmp.

Referenced by choose_exec(), create_dynui(), dynui_exec(), and present_exec().

◆ find_dynui()

struct dynamic_ui* find_dynui ( const char *  name)

Find dynamic user interface.

Parameters
nameUser interface name, or NULL
Return values
dynuiDynamic user interface, or NULL if not found

Definition at line 172 of file dynui.c.

172  {
173  struct dynamic_ui *dynui;
174 
175  list_for_each_entry ( dynui, &dynamic_uis, list ) {
176  if ( ( dynui->name == name ) ||
177  ( strcmp ( dynui->name, name ) == 0 ) ) {
178  return dynui;
179  }
180  }
181 
182  return NULL;
183 }
name
const char * name
Definition: ath9k_hw.c:1984
list_for_each_entry
#define list_for_each_entry(pos, head, member)
Iterate over entries in a list.
Definition: list.h:431
dynamic_ui
A dynamic user interface.
Definition: dynui.h:15
strcmp
int strcmp(const char *first, const char *second)
Compare strings.
Definition: string.c:173
dynamic_ui::list
struct list_head list
List of dynamic user interfaces.
Definition: dynui.h:17
dynamic_ui::name
const char * name
Name.
Definition: dynui.h:19
NULL
#define NULL
NULL pointer (VOID *)
Definition: Base.h:321

References dynamic_ui::list, list_for_each_entry, dynamic_ui::name, name, NULL, and strcmp().

Referenced by create_dynui(), and parse_dynui().

◆ dynui_item()

struct dynamic_item* dynui_item ( struct dynamic_ui *  dynui,
unsigned int  index 
)

Find dynamic user interface item by index.

Parameters
dynuiDynamic user interface
indexIndex
Return values
itemUser interface item, or NULL if not found

Definition at line 192 of file dynui.c.

193  {
194  struct dynamic_item *item;
195 
196  list_for_each_entry ( item, &dynui->items, list ) {
197  if ( index-- == 0 )
198  return item;
199  }
200 
201  return NULL;
202 }
dynamic_item
A dynamic user interface item.
Definition: dynui.h:29
index
long index
Definition: bigint.h:62
dynamic_ui::items
struct list_head items
Dynamic user interface items.
Definition: dynui.h:23
list_for_each_entry
#define list_for_each_entry(pos, head, member)
Iterate over entries in a list.
Definition: list.h:431
dynamic_item::list
struct list_head list
List of dynamic user interface items.
Definition: dynui.h:31
NULL
#define NULL
NULL pointer (VOID *)
Definition: Base.h:321

References index, dynamic_ui::items, dynamic_item::list, list_for_each_entry, and NULL.

Referenced by draw_menu_item(), and menu_loop().

◆ dynui_shortcut()

struct dynamic_item* dynui_shortcut ( struct dynamic_ui *  dynui,
int  key 
)

Find dynamic user interface item by shortcut key.

Parameters
dynuiDynamic user interface
keyShortcut key
Return values
itemUser interface item, or NULL if not found

Definition at line 211 of file dynui.c.

211  {
212  struct dynamic_item *item;
213 
214  list_for_each_entry ( item, &dynui->items, list ) {
215  if ( key && ( key == item->shortcut ) )
216  return item;
217  }
218 
219  return NULL;
220 }
dynamic_item
A dynamic user interface item.
Definition: dynui.h:29
dynamic_ui::items
struct list_head items
Dynamic user interface items.
Definition: dynui.h:23
list_for_each_entry
#define list_for_each_entry(pos, head, member)
Iterate over entries in a list.
Definition: list.h:431
dynamic_item::shortcut
int shortcut
Shortcut key.
Definition: dynui.h:41
dynamic_item::list
struct list_head list
List of dynamic user interface items.
Definition: dynui.h:31
NULL
#define NULL
NULL pointer (VOID *)
Definition: Base.h:321
key
union @391 key
Sense key.
Definition: scsi.h:17

References dynamic_ui::items, key, dynamic_item::list, list_for_each_entry, NULL, and dynamic_item::shortcut.

Referenced by form_loop(), and menu_loop().

◆ show_menu()

int show_menu ( struct dynamic_ui *  dynui,
unsigned long  timeout,
unsigned long  retimeout,
const char *  select,
struct dynamic_item **  selected 
)

Show menu.

Parameters
dynuiDynamic user interface
timeoutInitial timeout period, in ticks (0=indefinite)
retimeoutPost-activity timeout period, in ticks (0=indefinite)
Return values
selectedSelected item
rcReturn status code

Definition at line 251 of file menu_ui.c.

253  {
254  struct dynamic_item *item;
255  struct menu_ui ui;
256  char buf[ MENU_COLS + 1 /* NUL */ ];
257  int named_count = 0;
258  int rc;
259 
260  /* Initialise UI */
261  memset ( &ui, 0, sizeof ( ui ) );
262  ui.dynui = dynui;
263  ui.scroll.rows = MENU_ROWS;
264  ui.timeout = timeout;
265  ui.retimeout = retimeout;
266 
267  list_for_each_entry ( item, &dynui->items, list ) {
268  if ( item->name ) {
269  if ( ! named_count )
270  ui.scroll.current = ui.scroll.count;
271  named_count++;
272  if ( select ) {
273  if ( strcmp ( select, item->name ) == 0 )
274  ui.scroll.current = ui.scroll.count;
275  } else {
276  if ( item->flags & DYNUI_DEFAULT )
277  ui.scroll.current = ui.scroll.count;
278  }
279  }
280  ui.scroll.count++;
281  }
282  if ( ! named_count ) {
283  /* Menus with no named items cannot be selected from,
284  * and will seriously confuse the navigation logic.
285  * Refuse to display any such menus.
286  */
287  return -ENOENT;
288  }
289 
290  /* Initialise screen */
291  initscr();
292  start_color();
293  color_set ( CPAIR_NORMAL, NULL );
294  curs_set ( 0 );
295  erase();
296 
297  /* Draw initial content */
298  attron ( A_BOLD );
299  snprintf ( buf, sizeof ( buf ), "%s", ui.dynui->title );
300  mvprintw ( TITLE_ROW, ( ( COLS - strlen ( buf ) ) / 2 ), "%s", buf );
301  attroff ( A_BOLD );
302  jump_scroll ( &ui.scroll );
303  draw_menu_items ( &ui );
304  draw_menu_item ( &ui, ui.scroll.current );
305 
306  /* Enter main loop */
307  rc = menu_loop ( &ui, selected );
308  assert ( *selected );
309 
310  /* Clear screen */
311  endwin();
312 
313  return rc;
314 }
rc
struct arbelprm_rc_send_wqe rc
Definition: arbel.h:14
dynamic_item
A dynamic user interface item.
Definition: dynui.h:29
MENU_COLS
#define MENU_COLS
Definition: menu_ui.c:47
erase
int erase(void)
Completely clear the screen.
Definition: clear.c:97
menu_ui
A menu user interface.
Definition: menu_ui.c:51
attroff
static int attroff(int attrs)
Definition: curses.h:508
start_color
#define start_color()
Definition: curses.h:396
endwin
int endwin(void)
Finalise console environment.
Definition: wininit.c:31
ENOENT
#define ENOENT
No such file or directory.
Definition: errno.h:514
mvprintw
#define mvprintw(y, x, fmt,...)
Definition: curses.h:648
CPAIR_NORMAL
#define CPAIR_NORMAL
Normal text.
Definition: ansicol.h:40
MENU_ROWS
#define MENU_ROWS
Definition: menu_ui.c:46
dynamic_ui::items
struct list_head items
Dynamic user interface items.
Definition: dynui.h:23
initscr
WINDOW * initscr(void)
Initialise console environment.
Definition: wininit.c:17
dynamic_item::name
const char * name
Name.
Definition: dynui.h:33
assert
assert((readw(&hdr->flags) &(GTF_reading|GTF_writing))==0)
list_for_each_entry
#define list_for_each_entry(pos, head, member)
Iterate over entries in a list.
Definition: list.h:431
jump_scroll
int jump_scroll(struct jump_scroller *scroll)
Jump scroll to new page (if applicable)
Definition: jumpscroll.c:140
COLS
#define COLS
Definition: vga.h:27
strlen
size_t strlen(const char *src)
Get length of string.
Definition: string.c:243
select
int select(fd_set *readfds, int wait)
Check file descriptors for readiness.
Definition: posix_io.c:229
menu_loop
static int menu_loop(struct menu_ui *ui, struct dynamic_item **selected)
Menu main loop.
Definition: menu_ui.c:158
curs_set
int curs_set(int visibility)
Set cursor visibility.
Definition: mucurses.c:153
strcmp
int strcmp(const char *first, const char *second)
Compare strings.
Definition: string.c:173
DYNUI_DEFAULT
#define DYNUI_DEFAULT
Dynamic user interface item is default selection.
Definition: dynui.h:45
menu_ui::retimeout
unsigned long retimeout
Post-activity timeout (0=indefinite)
Definition: menu_ui.c:59
snprintf
int snprintf(char *buf, size_t size, const char *fmt,...)
Write a formatted string to a buffer.
Definition: vsprintf.c:382
color_set
#define color_set(cpno, opts)
Definition: curses.h:240
timeout
void timeout(int)
draw_menu_items
static void draw_menu_items(struct menu_ui *ui)
Draw the current block of menu items.
Definition: menu_ui.c:135
A_BOLD
#define A_BOLD
Definition: curses.h:138
dynamic_item::flags
unsigned int flags
Flags.
Definition: dynui.h:39
menu_ui::dynui
struct dynamic_ui * dynui
Dynamic user interface.
Definition: menu_ui.c:53
NULL
#define NULL
NULL pointer (VOID *)
Definition: Base.h:321
TITLE_ROW
#define TITLE_ROW
Definition: menu_ui.c:43
draw_menu_item
static void draw_menu_item(struct menu_ui *ui, unsigned int index)
Draw a numbered menu item.
Definition: menu_ui.c:68
attron
static int attron(int attrs)
Definition: curses.h:512
memset
void * memset(void *dest, int character, size_t len) __nonnull

References A_BOLD, assert(), attroff(), attron(), color_set, COLS, jump_scroller::count, CPAIR_NORMAL, jump_scroller::current, curs_set(), draw_menu_item(), draw_menu_items(), menu_ui::dynui, DYNUI_DEFAULT, endwin(), ENOENT, erase(), dynamic_item::flags, initscr(), dynamic_ui::items, jump_scroll(), list_for_each_entry, memset(), MENU_COLS, menu_loop(), MENU_ROWS, mvprintw, dynamic_item::name, NULL, rc, menu_ui::retimeout, jump_scroller::rows, menu_ui::scroll, select(), snprintf(), start_color, strcmp(), strlen(), menu_ui::timeout, timeout(), dynamic_ui::title, and TITLE_ROW.

Referenced by choose_exec().

◆ show_form()

int show_form ( struct dynamic_ui *  dynui)

Show form.

Parameters
dynuiDynamic user interface
Return values
rcReturn status code

Definition at line 507 of file form_ui.c.

507  {
508  struct form *form;
509  int rc;
510 
511  /* Allocate and initialise structure */
512  form = alloc_form ( dynui );
513  if ( ! form ) {
514  rc = -ENOMEM;
515  goto err_alloc;
516  }
517 
518  /* Parse setting names and load current values */
519  if ( ( rc = parse_names ( form ) ) != 0 )
520  goto err_parse_names;
521  load_values ( form );
522 
523  /* Lay out form on screen */
524  if ( ( rc = layout_form ( form ) ) != 0 )
525  goto err_layout;
526 
527  /* Draw initial form */
528  initscr();
529  start_color();
530  draw_form ( form );
531 
532  /* Run main loop */
533  if ( ( rc = form_loop ( form ) ) != 0 )
534  goto err_loop;
535 
536  err_loop:
537  color_set ( CPAIR_NORMAL, NULL );
538  endwin();
539  err_layout:
540  err_parse_names:
541  free_form ( form );
542  err_alloc:
543  return rc;
544 }
rc
struct arbelprm_rc_send_wqe rc
Definition: arbel.h:14
draw_form
static void draw_form(struct form *form)
Draw form.
Definition: form_ui.c:252
parse_names
static int parse_names(struct form *form)
Parse setting names.
Definition: form_ui.c:320
start_color
#define start_color()
Definition: curses.h:396
endwin
int endwin(void)
Finalise console environment.
Definition: wininit.c:31
layout_form
static int layout_form(struct form *form)
Assign form rows.
Definition: form_ui.c:158
CPAIR_NORMAL
#define CPAIR_NORMAL
Normal text.
Definition: ansicol.h:40
ENOMEM
#define ENOMEM
Not enough space.
Definition: errno.h:534
form
A form.
Definition: form_ui.c:64
free_form
static void free_form(struct form *form)
Free form.
Definition: form_ui.c:141
initscr
WINDOW * initscr(void)
Initialise console environment.
Definition: wininit.c:17
load_values
static void load_values(struct form *form)
Load current input values.
Definition: form_ui.c:357
alloc_form
static struct form * alloc_form(struct dynamic_ui *dynui)
Allocate form.
Definition: form_ui.c:99
form_loop
static int form_loop(struct form *form)
Form main loop.
Definition: form_ui.c:422
color_set
#define color_set(cpno, opts)
Definition: curses.h:240
form::dynui
struct dynamic_ui * dynui
Dynamic user interface.
Definition: form_ui.c:66
NULL
#define NULL
NULL pointer (VOID *)
Definition: Base.h:321

References alloc_form(), color_set, CPAIR_NORMAL, draw_form(), form::dynui, endwin(), ENOMEM, form_loop(), free_form(), initscr(), layout_form(), load_values(), NULL, parse_names(), rc, and start_color.

Referenced by login_ui(), and present_exec().

Generated by   doxygen 1.8.15