b225caa05bac77d689fd5d16798a2ab929e0b716
[petitboot] / 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/timer.h"
25 #include "nc-menu.h"
26 #include "nc-ked.h"
27
28 struct cui_opt_data {
29         const char *name;
30         struct pb_kexec_data *kd;
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         sig_atomic_t abort;
52         sig_atomic_t resize;
53         struct nc_scr *current;
54         struct pmenu *main;
55         struct ui_timer timer;
56         void *platform_info;
57         unsigned int default_item;
58         int (*on_kexec)(struct cui *cui, struct cui_opt_data *cod);
59 };
60
61 struct cui *cui_init(void* platform_info,
62         int (*on_kexec)(struct cui *, struct cui_opt_data *));
63 struct nc_scr *cui_set_current(struct cui *cui, struct nc_scr *scr);
64 int cui_run(struct cui *cui, struct pmenu *main, unsigned int default_item);
65 int cui_ked_run(struct pmenu_item *item);
66
67 /* convenience routines */
68
69 void cui_abort(struct cui *cui);
70 void cui_resize(struct cui *cui);
71 void cui_on_exit(struct pmenu *menu);
72 void cui_on_open(struct pmenu *menu);
73 int cui_run_cmd(struct pmenu_item *item);
74
75 static inline struct cui *cui_from_arg(void *arg)
76 {
77         struct cui *cui = (struct cui *)arg;
78
79         assert(cui->c_sig == pb_cui_sig);
80         return cui;
81 }
82
83 static inline struct cui *cui_from_pmenu(struct pmenu *menu)
84 {
85         return cui_from_arg(menu->scr.ui_ctx);
86 }
87
88 static inline struct cui *cui_from_item(struct pmenu_item *item)
89 {
90         return cui_from_pmenu(item->pmenu);
91 }
92
93 static inline struct cui *cui_from_timer(struct ui_timer *timer)
94 {
95         struct cui *cui;
96
97         cui = (struct cui *)((char *)timer
98                 - (size_t)&((struct cui *)0)->timer);
99         assert(cui->c_sig == pb_cui_sig);
100
101         return cui;
102 }
103
104 #endif