ui/ncurses: Add support for help screens
authorJeremy Kerr <jk@ozlabs.org>
Tue, 10 Dec 2013 03:48:25 +0000 (11:48 +0800)
committerJeremy Kerr <jk@ozlabs.org>
Fri, 31 Jan 2014 00:46:34 +0000 (08:46 +0800)
Add a textscreen-based help screen system, triggered from the cui
module's cui_show_help()

Signed-off-by: Jeremy Kerr <jk@ozlabs.org>
ui/ncurses/Makefile.am
ui/ncurses/nc-cui.c
ui/ncurses/nc-cui.h
ui/ncurses/nc-helpscreen.c [new file with mode: 0644]
ui/ncurses/nc-helpscreen.h [new file with mode: 0644]

index c03bdb7f9b42b0933fff75ebfb83a0ed061d6045..81602987b70139f471843e0e0d35a3e33b6c2c8c 100644 (file)
@@ -35,6 +35,8 @@ libpbnc_la_SOURCES = \
        nc-cui.h \
        nc-boot-editor.c \
        nc-boot-editor.h \
+       nc-helpscreen.c \
+       nc-helpscreen.h \
        nc-menu.c \
        nc-menu.h \
        nc-scr.c \
index e3422734ebd06d83ec30415b8012c89beb54435a..650e90345cffa723abc1a04146b7103889ff17bd 100644 (file)
@@ -38,6 +38,7 @@
 #include "nc-boot-editor.h"
 #include "nc-config.h"
 #include "nc-sysinfo.h"
+#include "nc-helpscreen.h"
 
 static void cui_start(void)
 {
@@ -246,6 +247,28 @@ void cui_show_config(struct cui *cui)
        cui_set_current(cui, config_screen_scr(cui->config_screen));
 }
 
+static void cui_help_exit(struct cui *cui)
+{
+       cui_set_current(cui, help_screen_return_scr(cui->help_screen));
+       talloc_free(cui->help_screen);
+       cui->help_screen = NULL;
+}
+
+void cui_show_help(struct cui *cui, const char *title, const char *text)
+{
+       if (!cui->current)
+               return;
+
+       if (cui->help_screen)
+               return;
+
+       cui->help_screen = help_screen_init(cui, cui->current,
+                       title, text, cui_help_exit);
+
+       if (cui->help_screen)
+               cui_set_current(cui, help_screen_scr(cui->help_screen));
+}
+
 /**
  * cui_set_current - Set the currently active screen and redraw it.
  */
index 90af3613cb880cdab94d12c8d8546e98021442b5..e59a6b67c4de4695b7065947b0200606a1122cff 100644 (file)
@@ -59,6 +59,7 @@ struct cui {
        struct config *config;
        struct config_screen *config_screen;
        struct boot_editor *boot_editor;
+       struct help_screen *help_screen;
        struct pjs *pjs;
        void *platform_info;
        unsigned int default_item;
@@ -74,6 +75,7 @@ void cui_item_edit(struct pmenu_item *item);
 void cui_item_new(struct pmenu *menu);
 void cui_show_sysinfo(struct cui *cui);
 void cui_show_config(struct cui *cui);
+void cui_show_help(struct cui *cui, const char *title, const char *text);
 int cui_send_config(struct cui *cui, struct config *config);
 
 /* convenience routines */
diff --git a/ui/ncurses/nc-helpscreen.c b/ui/ncurses/nc-helpscreen.c
new file mode 100644 (file)
index 0000000..d70a8ec
--- /dev/null
@@ -0,0 +1,69 @@
+/*
+ *  Copyright (C) 2013 IBM Corporation
+ *
+ *  This program is free software; you can redistribute it and/or modify
+ *  it under the terms of the GNU General Public License as published by
+ *  the Free Software Foundation; version 2 of the License.
+ *
+ *  This program is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *  GNU General Public License for more details.
+ *
+ *  You should have received a copy of the GNU General Public License
+ *  along with this program; if not, write to the Free Software
+ *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+ */
+
+#if defined(HAVE_CONFIG_H)
+#include "config.h"
+#endif
+
+#include <string.h>
+
+#include <talloc/talloc.h>
+#include <types/types.h>
+#include <log/log.h>
+#include <util/util.h>
+
+#include "nc-cui.h"
+#include "nc-textscreen.h"
+#include "nc-helpscreen.h"
+
+struct help_screen {
+       struct text_screen text_scr;
+       struct nc_scr *return_scr;
+};
+
+struct nc_scr *help_screen_scr(struct help_screen *screen)
+{
+       return text_screen_scr(&screen->text_scr);
+}
+
+struct nc_scr *help_screen_return_scr(struct help_screen *screen)
+{
+       return screen->return_scr;
+}
+
+struct help_screen *help_screen_init(struct cui *cui,
+               struct nc_scr *current_scr,
+               const char *title_suffix, const char *text,
+               void (*on_exit)(struct cui *))
+{
+       struct help_screen *screen;
+       const char *title;
+
+       screen = talloc_zero(cui, struct help_screen);
+       screen->return_scr = current_scr;
+
+       title = "Petitboot help";
+       if (title_suffix)
+               title = talloc_asprintf(screen,
+                               "Petitboot help: %s", title_suffix);
+
+       text_screen_init(&screen->text_scr, cui, title, on_exit);
+       text_screen_set_text(&screen->text_scr, text);
+       text_screen_draw(&screen->text_scr);
+
+       return screen;
+}
diff --git a/ui/ncurses/nc-helpscreen.h b/ui/ncurses/nc-helpscreen.h
new file mode 100644 (file)
index 0000000..f104411
--- /dev/null
@@ -0,0 +1,31 @@
+/*
+ *  Copyright (C) 2013 IBM Corporation
+ *
+ *  This program is free software; you can redistribute it and/or modify
+ *  it under the terms of the GNU General Public License as published by
+ *  the Free Software Foundation; version 2 of the License.
+ *
+ *  This program is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *  GNU General Public License for more details.
+ *
+ *  You should have received a copy of the GNU General Public License
+ *  along with this program; if not, write to the Free Software
+ *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+ */
+
+#ifndef _NC_HELPSCREEN_H
+#define _NC_HELPSCREEN_H
+
+struct help_screen;
+
+struct nc_scr *help_screen_scr(struct help_screen *screen);
+struct nc_scr *help_screen_return_scr(struct help_screen *screen);
+
+struct help_screen *help_screen_init(struct cui *cui,
+               struct nc_scr *current_scr,
+               const char *title_suffix, const char *text,
+               void (*on_exit)(struct cui *));
+
+#endif /* defined _NC_HELPSCREEN_H */