2 * Copyright (C) 2013 IBM Corporation
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License as published by
6 * the Free Software Foundation; version 2 of the License.
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
13 * You should have received a copy of the GNU General Public License
14 * along with this program; if not, write to the Free Software
15 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
22 #include <linux/input.h> /* This must be included before ncurses.h */
23 #if defined HAVE_NCURSESW_CURSES_H
24 # include <ncursesw/curses.h>
25 #elif defined HAVE_NCURSESW_H
26 # include <ncursesw.h>
27 #elif defined HAVE_NCURSES_CURSES_H
28 # include <ncurses/curses.h>
29 #elif defined HAVE_NCURSES_H
31 #elif defined HAVE_CURSES_H
34 # error "Curses header file not found."
37 #if defined HAVE_NCURSESW_FORM_H
38 # include <ncursesw/form.h>
39 #elif defined HAVE_NCURSES_FORM_H
40 # include <ncurses/form.h>
41 #elif defined HAVE_FORM_H
44 # error "Curses form.h not found."
50 #include <talloc/talloc.h>
51 #include <types/types.h>
53 #include <util/util.h>
57 #include "nc-widgets.h"
61 #define to_checkbox(w) container_of(w, struct nc_widget_checkbox, widget)
62 #define to_textbox(w) container_of(w, struct nc_widget_textbox, widget)
63 #define to_button(w) container_of(w, struct nc_widget_button, widget)
64 #define to_select(w) container_of(w, struct nc_widget_select, widget)
66 static const char *checkbox_checked_str = "[*]";
67 static const char *checkbox_unchecked_str = "[ ]";
69 static const char *select_selected_str = "(*)";
70 static const char *select_unselected_str = "( )";
77 int n_fields, n_alloc_fields;
78 void (*widget_focus)(struct nc_widget *, void *);
79 void *widget_focus_arg;
85 bool (*process_key)(struct nc_widget *, FORM *, int);
86 void (*set_visible)(struct nc_widget *, bool);
87 void (*move)(struct nc_widget *, int, int);
96 struct nc_widget_label {
97 struct nc_widget widget;
101 struct nc_widget_checkbox {
102 struct nc_widget widget;
106 struct nc_widget_textbox {
107 struct nc_widget widget;
110 struct nc_widget_select {
111 struct nc_widget widget;
112 struct select_option {
118 int n_options, selected_option;
119 struct nc_widgetset *set;
120 void (*on_change)(void *, int);
124 struct nc_widget_button {
125 struct nc_widget widget;
126 void (*click)(void *arg);
130 static void widgetset_add_field(struct nc_widgetset *set, FIELD *field);
132 static bool process_key_nop(struct nc_widget *widget __attribute__((unused)),
133 FORM *form __attribute((unused)),
134 int key __attribute__((unused)))
139 static void field_set_visible(FIELD *field, bool visible)
141 int opts = field_opts(field) & ~O_VISIBLE;
144 set_field_opts(field, opts);
147 static void field_move(FIELD *field, int y, int x)
149 move_field(field, y, x);
152 static int label_destructor(void *ptr)
154 struct nc_widget_label *label = ptr;
155 free_field(label->widget.field);
160 struct nc_widget_label *widget_new_label(struct nc_widgetset *set,
161 int y, int x, char *str)
163 struct nc_widget_label *label;
169 label = talloc_zero(set, struct nc_widget_label);
170 label->widget.height = 1;
171 label->widget.width = len;
174 label->widget.process_key = process_key_nop;
175 label->widget.field = f = new_field(1, len, y, x, 0, 0);
176 label->widget.focussed_attr = A_NORMAL;
177 label->widget.unfocussed_attr = A_NORMAL;
179 field_opts_off(f, O_ACTIVE);
180 set_field_buffer(f, 0, str);
181 set_field_userptr(f, &label->widget);
183 widgetset_add_field(set, label->widget.field);
184 talloc_set_destructor(label, label_destructor);
189 bool widget_checkbox_get_value(struct nc_widget_checkbox *checkbox)
191 return checkbox->checked;
194 static void checkbox_set_buffer(struct nc_widget_checkbox *checkbox)
197 str = checkbox->checked ? checkbox_checked_str : checkbox_unchecked_str;
198 set_field_buffer(checkbox->widget.field, 0, str);
201 static bool checkbox_process_key(struct nc_widget *widget,
202 FORM *form __attribute__((unused)), int key)
204 struct nc_widget_checkbox *checkbox = to_checkbox(widget);
209 checkbox->checked = !checkbox->checked;
210 checkbox_set_buffer(checkbox);
215 static int checkbox_destructor(void *ptr)
217 struct nc_widget_checkbox *checkbox = ptr;
218 free_field(checkbox->widget.field);
222 struct nc_widget_checkbox *widget_new_checkbox(struct nc_widgetset *set,
223 int y, int x, bool checked)
225 struct nc_widget_checkbox *checkbox;
228 checkbox = talloc_zero(set, struct nc_widget_checkbox);
229 checkbox->checked = checked;
230 checkbox->widget.height = 1;
231 checkbox->widget.width = strlen(checkbox_checked_str);
232 checkbox->widget.x = x;
233 checkbox->widget.y = y;
234 checkbox->widget.process_key = checkbox_process_key;
235 checkbox->widget.focussed_attr = A_REVERSE;
236 checkbox->widget.unfocussed_attr = A_NORMAL;
237 checkbox->widget.field = f = new_field(1, strlen(checkbox_checked_str),
240 field_opts_off(f, O_EDIT);
241 set_field_userptr(f, &checkbox->widget);
242 checkbox_set_buffer(checkbox);
244 widgetset_add_field(set, checkbox->widget.field);
245 talloc_set_destructor(checkbox, checkbox_destructor);
250 static char *strip_string(char *str)
256 /* clear trailing space */
257 for (i = len - 1; i >= 0; i--) {
258 if (!isspace(str[i]))
263 /* increment str past leading space */
264 for (i = 0; i < len; i++) {
265 if (str[i] == '\0' || !isspace(str[i]))
272 char *widget_textbox_get_value(struct nc_widget_textbox *textbox)
274 char *str = field_buffer(textbox->widget.field, 0);
275 return str ? strip_string(str) : NULL;
278 static bool textbox_process_key(
279 struct nc_widget *widget __attribute__((unused)),
284 form_driver(form, REQ_BEG_FIELD);
287 form_driver(form, REQ_END_FIELD);
290 form_driver(form, REQ_LEFT_CHAR);
293 form_driver(form, REQ_RIGHT_CHAR);
296 if (form_driver(form, REQ_LEFT_CHAR) != E_OK)
300 form_driver(form, REQ_DEL_CHAR);
303 form_driver(form, key);
310 static int textbox_destructor(void *ptr)
312 struct nc_widget_textbox *textbox = ptr;
313 free_field(textbox->widget.field);
317 struct nc_widget_textbox *widget_new_textbox(struct nc_widgetset *set,
318 int y, int x, int len, char *str)
320 struct nc_widget_textbox *textbox;
323 textbox = talloc_zero(set, struct nc_widget_textbox);
324 textbox->widget.height = 1;
325 textbox->widget.width = len;
326 textbox->widget.x = x;
327 textbox->widget.y = y;
328 textbox->widget.process_key = textbox_process_key;
329 textbox->widget.field = f = new_field(1, len, y, x, 0, 0);
330 textbox->widget.focussed_attr = A_REVERSE;
331 textbox->widget.unfocussed_attr = A_UNDERLINE;
333 field_opts_off(f, O_STATIC | O_WRAP | O_BLANK);
334 set_field_buffer(f, 0, str);
335 set_field_back(f, textbox->widget.unfocussed_attr);
336 set_field_userptr(f, &textbox->widget);
338 widgetset_add_field(set, textbox->widget.field);
339 talloc_set_destructor(textbox, textbox_destructor);
344 static void select_option_change(struct select_option *opt, bool selected)
348 str = selected ? select_selected_str : select_unselected_str;
350 memcpy(opt->str, str, strlen(str));
351 set_field_buffer(opt->field, 0, opt->str);
354 static bool select_process_key(struct nc_widget *w, FORM *form, int key)
356 struct nc_widget_select *select = to_select(w);
357 struct select_option *new_opt, *old_opt;
369 field = current_field(form);
372 for (i = 0; i < select->n_options; i++) {
373 if (select->options[i].field == field) {
374 new_opt = &select->options[i];
383 if (new_idx == select->selected_option)
386 old_opt = &select->options[select->selected_option];
388 select_option_change(old_opt, false);
389 select_option_change(new_opt, true);
391 select->selected_option = new_idx;
393 if (select->on_change)
394 select->on_change(select->on_change_arg, new_opt->val);
399 static void select_set_visible(struct nc_widget *widget, bool visible)
401 struct nc_widget_select *select = to_select(widget);
404 for (i = 0; i < select->n_options; i++)
405 field_set_visible(select->options[i].field, visible);
408 static void select_move(struct nc_widget *widget, int y, int x)
410 struct nc_widget_select *select = to_select(widget);
413 for (i = 0; i < select->n_options; i++)
414 field_move(select->options[i].field, y + i, x);
417 static int select_destructor(void *ptr)
419 struct nc_widget_select *select = ptr;
422 for (i = 0; i < select->n_options; i++)
423 free_field(select->options[i].field);
428 struct nc_widget_select *widget_new_select(struct nc_widgetset *set,
429 int y, int x, int len)
431 struct nc_widget_select *select;
433 select = talloc_zero(set, struct nc_widget_select);
434 select->widget.width = len;
435 select->widget.height = 0;
436 select->widget.x = x;
437 select->widget.y = y;
438 select->widget.process_key = select_process_key;
439 select->widget.set_visible = select_set_visible;
440 select->widget.move = select_move;
441 select->widget.focussed_attr = A_REVERSE;
442 select->widget.unfocussed_attr = A_NORMAL;
448 talloc_set_destructor(select, select_destructor);
453 void widget_select_add_option(struct nc_widget_select *select, int value,
454 const char *text, bool selected)
460 /* if we never see an option with selected set, we want the first
461 * one to be selected */
462 if (select->n_options == 0)
465 select_option_change(&select->options[select->selected_option],
469 select->selected_option = select->n_options;
470 str = select_selected_str;
472 str = select_unselected_str;
474 i = select->n_options++;
475 select->widget.height = select->n_options;
477 select->options = talloc_realloc(select, select->options,
478 struct select_option, i + 2);
479 select->options[i].val = value;
480 select->options[i].str = talloc_asprintf(select->options,
483 select->options[i].field = f = new_field(1, select->size,
487 field_opts_off(f, O_WRAP | O_EDIT);
488 set_field_userptr(f, &select->widget);
489 set_field_buffer(f, 0, select->options[i].str);
491 widgetset_add_field(select->set, f);
494 int widget_select_get_value(struct nc_widget_select *select)
496 return select->options[select->selected_option].val;
499 int widget_select_height(struct nc_widget_select *select)
501 return select->n_options;
504 void widget_select_on_change(struct nc_widget_select *select,
505 void (*on_change)(void *, int), void *arg)
507 select->on_change = on_change;
508 select->on_change_arg = arg;
511 static bool button_process_key(struct nc_widget *widget,
512 FORM *form __attribute__((unused)), int key)
514 struct nc_widget_button *button = to_button(widget);
523 button->click(button->arg);
530 static int button_destructor(void *ptr)
532 struct nc_widget_button *button = ptr;
533 free_field(button->widget.field);
537 struct nc_widget_button *widget_new_button(struct nc_widgetset *set,
538 int y, int x, int size, const char *str,
539 void (*click)(void *), void *arg)
541 struct nc_widget_button *button;
546 button = talloc_zero(set, struct nc_widget_button);
547 button->widget.height = 1;
548 button->widget.width = size;
549 button->widget.x = x;
550 button->widget.y = y;
551 button->widget.field = f = new_field(1, size + 2, y, x, 0, 0);
552 button->widget.process_key = button_process_key;
553 button->widget.focussed_attr = A_REVERSE;
554 button->widget.unfocussed_attr = A_NORMAL;
555 button->click = click;
558 field_opts_off(f, O_EDIT);
559 set_field_userptr(f, &button->widget);
561 /* center str in a size-char buffer, but don't overrun */
563 len = min(len, size);
564 idx = (size - len) / 2;
566 text = talloc_array(button, char, size + 3);
567 memset(text, ' ', size + 2);
568 memcpy(text + idx + 1, str, len);
570 text[size + 1] = ']';
571 text[size + 2] = '\0';
573 set_field_buffer(f, 0, text);
575 widgetset_add_field(set, button->widget.field);
576 talloc_set_destructor(button, button_destructor);
581 static void widget_focus_change(struct nc_widget *widget, FIELD *field,
584 int attr = focussed ? widget->focussed_attr : widget->unfocussed_attr;
585 set_field_back(field, attr);
588 bool widgetset_process_key(struct nc_widgetset *set, int key)
590 struct nc_widget *widget;
594 field = current_field(set->form);
597 /* handle field change events */
601 req = REQ_PREV_FIELD;
605 req = REQ_NEXT_FIELD;
608 req = REQ_FIRST_FIELD;
611 req = REQ_LAST_FIELD;
615 widget = field_userptr(field);
617 widget_focus_change(widget, field, false);
618 form_driver(set->form, req);
619 form_driver(set->form, REQ_END_FIELD);
620 field = current_field(set->form);
621 widget = field_userptr(field);
622 widget_focus_change(widget, field, true);
623 if (set->widget_focus)
624 set->widget_focus(widget, set->widget_focus_arg);
628 if (!widget->process_key)
631 return widget->process_key(widget, set->form, key);
634 static int widgetset_destructor(void *ptr)
636 struct nc_widgetset *set = ptr;
637 free_form(set->form);
641 struct nc_widgetset *widgetset_create(void *ctx, WINDOW *main, WINDOW *sub)
643 struct nc_widgetset *set;
645 set = talloc_zero(ctx, struct nc_widgetset);
646 set->n_alloc_fields = 8;
649 set->fields = talloc_array(set, FIELD *, set->n_alloc_fields);
650 talloc_set_destructor(set, widgetset_destructor);
655 void widgetset_set_widget_focus(struct nc_widgetset *set,
656 widget_focus_cb cb, void *arg)
658 set->widget_focus = cb;
659 set->widget_focus_arg = arg;
662 void widgetset_post(struct nc_widgetset *set)
664 struct nc_widget *widget;
667 set->form = new_form(set->fields);
668 set_form_win(set->form, set->mainwin);
669 set_form_sub(set->form, set->subwin);
670 post_form(set->form);
671 form_driver(set->form, REQ_END_FIELD);
673 if (set->cur_field) {
674 set_current_field(set->form, set->cur_field);
675 field = set->cur_field;
678 field = current_field(set->form);
679 widget = field_userptr(field);
680 widget_focus_change(widget, field, true);
681 if (set->widget_focus)
682 set->widget_focus(widget, set->widget_focus_arg);
685 void widgetset_unpost(struct nc_widgetset *set)
687 set->cur_field = current_field(set->form);
688 unpost_form(set->form);
689 free_form(set->form);
693 static void widgetset_add_field(struct nc_widgetset *set, FIELD *field)
695 if (set->n_fields == set->n_alloc_fields - 1) {
696 set->n_alloc_fields *= 2;
697 set->fields = talloc_realloc(set, set->fields,
698 FIELD *, set->n_alloc_fields);
702 set->fields[set->n_fields - 1] = field;
703 set->fields[set->n_fields] = NULL;
706 #define DECLARE_BASEFN(type) \
707 struct nc_widget *widget_ ## type ## _base \
708 (struct nc_widget_ ## type *w) \
709 { return &w->widget; }
711 DECLARE_BASEFN(textbox);
712 DECLARE_BASEFN(checkbox);
713 DECLARE_BASEFN(select);
714 DECLARE_BASEFN(label);
715 DECLARE_BASEFN(button);
717 void widget_set_visible(struct nc_widget *widget, bool visible)
719 if (widget->set_visible)
720 widget->set_visible(widget, visible);
722 field_set_visible(widget->field, visible);
725 void widget_move(struct nc_widget *widget, int y, int x)
728 widget->move(widget, y, x);
730 field_move(widget->field, y, x);
736 int widget_height(struct nc_widget *widget)
738 return widget->height;
741 int widget_width(struct nc_widget *widget)
743 return widget->width;
746 int widget_x(struct nc_widget *widget)
751 int widget_y(struct nc_widget *widget)