git.ozlabs.org Git - petitboot/blob - ui/ncurses/nc-cui.h

   1 /*
   2  *  Copyright (C) 2009 Sony Computer Entertainment Inc.
   3  *  Copyright 2009 Sony Corp.
   4  *
   5  *  This program is free software; you can redistribute it and/or modify
   6  *  it under the terms of the GNU General Public License as published by
   7  *  the Free Software Foundation; version 2 of the License.
   8  *
   9  *  This program is distributed in the hope that it will be useful,
  10  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  *  GNU General Public License for more details.
  13  *
  14  *  You should have received a copy of the GNU General Public License
  15  *  along with this program; if not, write to the Free Software
  16  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  17  */
  18
  19 #if !defined(_PB_NC_CUI_H)
  20 #define _PB_NC_CUI_H
  21
  22 #include <signal.h>
  23
  24 #include "ui/common/joystick.h"
  25 #include "nc-menu.h"
  26 #include "nc-helpscreen.h"
  27
  28 struct cui_opt_data {
  29         const char *name;
  30         struct pb_boot_data *bd;
  31
  32         /* optional data */
  33         const struct device *dev;
  34         const struct boot_option *opt;
  35         uint32_t opt_hash;
  36 };
  37
  38 /**
  39  * struct cui - Data structure defining a cui state machine.
  40  * @c_sig: Signature for callback type checking, should be cui_sig.
  41  * @abort: When set to true signals the state machine to exit.
  42  * @current: Pointer to the active nc object.
  43  * @main: Pointer to the user supplied main menu.
  44  *
  45  * Device boot_options are dynamically added and removed from the @main
  46  * menu.
  47  */
  48
  49 struct cui {
  50         enum pb_nc_sig c_sig;
  51         bool has_input;
  52         sig_atomic_t abort;
  53         sig_atomic_t resize;
  54         struct nc_scr *current;
  55         struct pmenu *main;
  56         struct waitset *waitset;
  57         struct discover_client *client;
  58         struct system_info *sysinfo;
  59         struct sysinfo_screen *sysinfo_screen;
  60         struct config *config;
  61         struct config_screen *config_screen;
  62         struct boot_editor *boot_editor;
  63         struct help_screen *help_screen;
  64         struct pjs *pjs;
  65         void *platform_info;
  66         unsigned int default_item;
  67         int (*on_boot)(struct cui *cui, struct cui_opt_data *cod);
  68 };
  69
  70 struct cui *cui_init(void* platform_info,
  71                 int (*js_map)(const struct js_event *e),
  72                 int start_deamon);
  73 struct nc_scr *cui_set_current(struct cui *cui, struct nc_scr *scr);
  74 int cui_run(struct cui *cui);
  75 void cui_item_edit(struct pmenu_item *item);
  76 void cui_item_new(struct pmenu *menu);
  77 void cui_show_sysinfo(struct cui *cui);
  78 void cui_show_config(struct cui *cui);
  79 void cui_show_help(struct cui *cui, const char *title,
  80                 const struct help_text *text);
  81 int cui_send_config(struct cui *cui, struct config *config);
  82 void cui_send_reinit(struct cui *cui);
  83
  84 /* convenience routines */
  85
  86 void cui_abort(struct cui *cui);
  87 void cui_resize(struct cui *cui);
  88 void cui_on_exit(struct pmenu *menu);
  89 void cui_on_open(struct pmenu *menu);
  90 int cui_run_cmd(struct pmenu_item *item);
  91
  92 static inline struct cui *cui_from_arg(void *arg)
  93 {
  94         struct cui *cui = (struct cui *)arg;
  95
  96         assert(cui->c_sig == pb_cui_sig);
  97         return cui;
  98 }
  99
 100 static inline struct cui *cui_from_pmenu(struct pmenu *menu)
 101 {
 102         return cui_from_arg(menu->scr.ui_ctx);
 103 }
 104
 105 static inline struct cui *cui_from_item(struct pmenu_item *item)
 106 {
 107         return cui_from_pmenu(item->pmenu);
 108 }
 109
 110 #endif