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
  27 struct cui_opt_data {
  28         const char *name;
  29         struct pb_boot_data *bd;
  30
  31         /* optional data */
  32         const struct device *dev;
  33         const struct boot_option *opt;
  34         uint32_t opt_hash;
  35 };
  36
  37 /**
  38  * struct cui - Data structure defining a cui state machine.
  39  * @c_sig: Signature for callback type checking, should be cui_sig.
  40  * @abort: When set to true signals the state machine to exit.
  41  * @current: Pointer to the active nc object.
  42  * @main: Pointer to the user supplied main menu.
  43  *
  44  * Device boot_options are dynamically added and removed from the @main
  45  * menu.
  46  */
  47
  48 struct cui {
  49         enum pb_nc_sig c_sig;
  50         bool has_input;
  51         sig_atomic_t abort;
  52         sig_atomic_t resize;
  53         struct nc_scr *current;
  54         struct pmenu *main;
  55         struct waitset *waitset;
  56         struct discover_client *client;
  57         struct system_info *sysinfo;
  58         struct sysinfo_screen *sysinfo_screen;
  59         struct config *config;
  60         struct config_screen *config_screen;
  61         struct boot_editor *boot_editor;
  62         struct help_screen *help_screen;
  63         struct pjs *pjs;
  64         void *platform_info;
  65         unsigned int default_item;
  66         int (*on_boot)(struct cui *cui, struct cui_opt_data *cod);
  67 };
  68
  69 struct cui *cui_init(void* platform_info,
  70                 int (*js_map)(const struct js_event *e),
  71                 int start_deamon);
  72 struct nc_scr *cui_set_current(struct cui *cui, struct nc_scr *scr);
  73 int cui_run(struct cui *cui, struct pmenu *main, unsigned int default_item);
  74 void cui_item_edit(struct pmenu_item *item);
  75 void cui_item_new(struct pmenu *menu);
  76 void cui_show_sysinfo(struct cui *cui);
  77 void cui_show_config(struct cui *cui);
  78 void cui_show_help(struct cui *cui, const char *title, const char *text);
  79 int cui_send_config(struct cui *cui, struct config *config);
  80 void cui_send_reinit(struct cui *cui);
  81
  82 /* convenience routines */
  83
  84 void cui_abort(struct cui *cui);
  85 void cui_resize(struct cui *cui);
  86 void cui_on_exit(struct pmenu *menu);
  87 void cui_on_open(struct pmenu *menu);
  88 int cui_run_cmd(struct pmenu_item *item);
  89
  90 static inline struct cui *cui_from_arg(void *arg)
  91 {
  92         struct cui *cui = (struct cui *)arg;
  93
  94         assert(cui->c_sig == pb_cui_sig);
  95         return cui;
  96 }
  97
  98 static inline struct cui *cui_from_pmenu(struct pmenu *menu)
  99 {
 100         return cui_from_arg(menu->scr.ui_ctx);
 101 }
 102
 103 static inline struct cui *cui_from_item(struct pmenu_item *item)
 104 {
 105         return cui_from_pmenu(item->pmenu);
 106 }
 107
 108 #endif