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