/
gui.h
218 lines (186 loc) · 7.05 KB
1
2
3
4
5
6
7
8
/**
* MojoSetup; a portable, flexible installation application.
*
* Please see the file LICENSE.txt in the source's root directory.
*
* This file written by Ryan C. Gordon.
*/
9
10
11
12
13
14
15
16
17
18
19
20
#ifndef _INCL_GUI_H_
#define _INCL_GUI_H_
#include "universal.h"
#ifdef __cplusplus
extern "C" {
#endif
typedef enum
{
MOJOGUI_PRIORITY_NEVER_TRY = 0,
21
MOJOGUI_PRIORITY_USER_REQUESTED,
22
23
MOJOGUI_PRIORITY_TRY_FIRST,
MOJOGUI_PRIORITY_TRY_NORMAL,
24
MOJOGUI_PRIORITY_TRY_LAST,
25
MOJOGUI_PRIORITY_TRY_ABSOLUTELY_LAST,
26
MOJOGUI_PRIORITY_TOTAL
27
28
} MojoGuiPluginPriority;
29
30
31
32
33
34
35
36
37
38
39
typedef enum
{
MOJOGUI_NO,
MOJOGUI_YES,
MOJOGUI_ALWAYS,
MOJOGUI_NEVER
} MojoGuiYNAN;
40
41
42
/*
* Abstract GUI interfaces.
*/
43
44
45
46
47
typedef struct MojoGuiSetupOptions MojoGuiSetupOptions;
struct MojoGuiSetupOptions
{
const char *description;
48
const char *tooltip;
49
50
51
boolean value;
boolean is_group_parent;
uint64 size;
52
int opaque; // GUI drivers shouldn't touch this.
53
void *guiopaque; // For GUI drivers. App won't touch or free this.
54
55
56
57
MojoGuiSetupOptions *next_sibling;
MojoGuiSetupOptions *child;
};
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
typedef enum
{
MOJOGUI_SPLASH_NONE,
MOJOGUI_SPLASH_TOP,
MOJOGUI_SPLASH_LEFT,
MOJOGUI_SPLASH_RIGHT,
MOJOGUI_SPLASH_BOTTOM,
MOJOGUI_SPLASH_BACKGROUND,
} MojoGuiSplashPos;
typedef struct MojoGuiSplash MojoGuiSplash;
struct MojoGuiSplash
{
const uint8 *rgba; // framebuffer.
uint32 w; // width in pixels.
uint32 h; // height in pixels.
MojoGuiSplashPos position; // where to put the splash.
};
79
80
81
82
#define MOJOGUI_ENTRY_POINT MojoSetup_Gui_GetInterface
#define MOJOGUI_ENTRY_POINT_STR DEFINE_TO_STR(MOJOGUI_ENTRY_POINT)
// Increment this value when MojoGui's structure changes.
83
#define MOJOGUI_INTERFACE_REVISION 5
84
85
86
typedef struct MojoGui MojoGui;
struct MojoGui
87
{
88
uint8 (*priority)(boolean istty);
89
90
91
92
const char* (*name)(void);
boolean (*init)(void);
void (*deinit)(void);
void (*msgbox)(const char *title, const char *text);
93
94
boolean (*promptyn)(const char *title, const char *text, boolean def);
MojoGuiYNAN (*promptynan)(const char *title, const char *text, boolean def);
95
boolean (*start)(const char *title, const MojoGuiSplash *splash);
96
void (*stop)(void);
97
int (*readme)(const char *name, const uint8 *data, size_t len,
98
boolean can_back, boolean can_fwd);
99
int (*options)(MojoGuiSetupOptions *opts,
100
boolean can_back, boolean can_fwd);
101
102
char * (*destination)(const char **recommendations, int recnum,
int *command, boolean can_back, boolean can_fwd);
103
boolean (*insertmedia)(const char *medianame);
104
void (*progressitem)(void);
105
boolean (*progress)(const char *type, const char *component,
106
int percent, const char *item, boolean can_cancel);
107
void (*final)(const char *msg);
108
109
};
110
111
typedef const MojoGui* (*MojoGuiEntryPoint)(int revision,
const MojoSetupEntryPoints *e);
112
113
114
115
#if !BUILDING_EXTERNAL_PLUGIN
extern const MojoGui *GGui;
const MojoGui *MojoGui_initGuiPlugin(void);
116
117
118
void MojoGui_deinitGuiPlugin(void);
#else
119
120
121
122
123
124
125
// can't use normal STUBBED in gui plugins, since it references logDebug
// without entry-> ...
#ifndef DOXYGEN_SHOULD_IGNORE_THIS
#undef STUBBED
#define STUBBED(x) STUBBED2(entry->,x)
#endif
126
127
__EXPORT__ const MojoGui *MOJOGUI_ENTRY_POINT(int revision,
const MojoSetupEntryPoints *e);
128
129
130
131
132
133
/*
* We do this as a macro so we only have to update one place, and it
* enforces some details in the plugins. Without effort, plugins don't
* support anything but the latest version of the interface.
*/
134
#define MOJOGUI_PLUGIN(module) \
135
static const MojoSetupEntryPoints *entry = NULL; \
136
static uint8 MojoGui_##module##_priority(boolean istty); \
137
138
139
140
static const char* MojoGui_##module##_name(void) { return #module; } \
static boolean MojoGui_##module##_init(void); \
static void MojoGui_##module##_deinit(void); \
static void MojoGui_##module##_msgbox(const char *title, const char *text); \
141
142
static boolean MojoGui_##module##_promptyn(const char *t1, const char *t2, \
boolean d); \
143
static MojoGuiYNAN MojoGui_##module##_promptynan(const char *t1, \
144
const char *t2, boolean d); \
145
146
static boolean MojoGui_##module##_start(const char *t, \
const MojoGuiSplash *splash); \
147
static void MojoGui_##module##_stop(void); \
148
static int MojoGui_##module##_readme(const char *name, const uint8 *data, \
149
150
size_t len, boolean can_back, \
boolean can_fwd); \
151
static int MojoGui_##module##_options(MojoGuiSetupOptions *opts, \
152
boolean can_back, boolean can_fwd); \
153
154
static char *MojoGui_##module##_destination(const char **r, int recnum, \
int *command, boolean can_back, boolean can_fwd); \
155
static boolean MojoGui_##module##_insertmedia(const char *medianame); \
156
static void MojoGui_##module##_progressitem(void); \
157
static boolean MojoGui_##module##_progress(const char *typ, const char *comp, \
158
159
int percent, const char *item, \
boolean can_cancel); \
160
static void MojoGui_##module##_final(const char *msg); \
161
const MojoGui *MojoGuiPlugin_##module(int rev, const MojoSetupEntryPoints *e) \
162
{ \
163
164
165
166
167
168
169
170
if (rev == MOJOGUI_INTERFACE_REVISION) { \
static const MojoGui retval = { \
MojoGui_##module##_priority, \
MojoGui_##module##_name, \
MojoGui_##module##_init, \
MojoGui_##module##_deinit, \
MojoGui_##module##_msgbox, \
MojoGui_##module##_promptyn, \
171
MojoGui_##module##_promptynan, \
172
173
174
MojoGui_##module##_start, \
MojoGui_##module##_stop, \
MojoGui_##module##_readme, \
175
MojoGui_##module##_options, \
176
MojoGui_##module##_destination, \
177
MojoGui_##module##_insertmedia, \
178
MojoGui_##module##_progressitem, \
179
MojoGui_##module##_progress, \
180
MojoGui_##module##_final, \
181
182
}; \
entry = e; \
183
184
185
return &retval; \
} \
return NULL; \
186
187
} \
188
#define CREATE_MOJOGUI_ENTRY_POINT(module) \
189
const MojoGui *MOJOGUI_ENTRY_POINT(int rev, const MojoSetupEntryPoints *e) \
190
{ \
191
return MojoGuiPlugin_##module(rev, e); \
192
193
} \
194
#endif
195
196
197
198
/*
* make some decisions about which GUI plugins to build...
199
200
* We list them all here, but some are built, some aren't. Some are DLLs,
* some aren't...
201
202
*/
203
const MojoGui *MojoGuiPlugin_stdio(int rev, const MojoSetupEntryPoints *e);
204
const MojoGui *MojoGuiPlugin_ncurses(int rev, const MojoSetupEntryPoints *e);
205
const MojoGui *MojoGuiPlugin_gtkplus2(int rev, const MojoSetupEntryPoints *e);
206
const MojoGui *MojoGuiPlugin_www(int rev, const MojoSetupEntryPoints *e);
207
const MojoGui *MojoGuiPlugin_macosx(int rev, const MojoSetupEntryPoints *e);
208
209
210
// !!! FIXME: Qt? KDE? Gnome? Console? Cocoa?
211
212
213
214
215
216
#ifdef __cplusplus
}
#endif
#endif
217
// end of gui.h ...