6 /* glk.h: Header file for Glk API, version 0.7.0.
7 Designed by Andrew Plotkin <erkyrath@eblong.com>
8 http://www.eblong.com/zarf/glk/index.html
10 This file is copyright 1998-2004 by Andrew Plotkin. You may copy,
11 distribute, and incorporate it into your own programs, by any means
12 and under any conditions, as long as you do not modify it. You may
13 also modify this file, incorporate it into your own programs,
14 and distribute the modified version, as long as you retain a notice
15 in your program or documentation which mentions my name and the URL
19 /* You may have to edit the definition of glui32 to make sure it's really a
20 32-bit unsigned integer type, and glsi32 to make sure it's really a
21 32-bit signed integer type. If they're not, horrible things will happen. */
22 typedef guint32 glui32;
23 typedef gint32 glsi32;
25 /* These are the compile-time conditionals that reveal various Glk optional
27 #define GLK_MODULE_UNICODE
28 #define GLK_MODULE_IMAGE
29 #define GLK_MODULE_SOUND
30 #define GLK_MODULE_HYPERLINKS
32 /* These types are opaque object identifiers. They're pointers to opaque
33 C structures, which are defined differently by each library. */
34 typedef struct glk_window_struct *winid_t;
35 typedef struct glk_stream_struct *strid_t;
36 typedef struct glk_fileref_struct *frefid_t;
37 typedef struct glk_schannel_struct *schanid_t;
39 #define gestalt_Version (0)
40 #define gestalt_CharInput (1)
41 #define gestalt_LineInput (2)
42 #define gestalt_CharOutput (3)
43 #define gestalt_CharOutput_CannotPrint (0)
44 #define gestalt_CharOutput_ApproxPrint (1)
45 #define gestalt_CharOutput_ExactPrint (2)
46 #define gestalt_MouseInput (4)
47 #define gestalt_Timer (5)
48 #define gestalt_Graphics (6)
49 #define gestalt_DrawImage (7)
50 #define gestalt_Sound (8)
51 #define gestalt_SoundVolume (9)
52 #define gestalt_SoundNotify (10)
53 #define gestalt_Hyperlinks (11)
54 #define gestalt_HyperlinkInput (12)
55 #define gestalt_SoundMusic (13)
56 #define gestalt_GraphicsTransparency (14)
57 #define gestalt_Unicode (15)
59 #define evtype_None (0)
60 #define evtype_Timer (1)
61 #define evtype_CharInput (2)
62 #define evtype_LineInput (3)
63 #define evtype_MouseInput (4)
64 #define evtype_Arrange (5)
65 #define evtype_Redraw (6)
66 #define evtype_SoundNotify (7)
67 #define evtype_Hyperlink (8)
69 typedef struct event_struct {
75 #define keycode_Unknown (0xffffffff)
76 #define keycode_Left (0xfffffffe)
77 #define keycode_Right (0xfffffffd)
78 #define keycode_Up (0xfffffffc)
79 #define keycode_Down (0xfffffffb)
80 #define keycode_Return (0xfffffffa)
81 #define keycode_Delete (0xfffffff9)
82 #define keycode_Escape (0xfffffff8)
83 #define keycode_Tab (0xfffffff7)
84 #define keycode_PageUp (0xfffffff6)
85 #define keycode_PageDown (0xfffffff5)
86 #define keycode_Home (0xfffffff4)
87 #define keycode_End (0xfffffff3)
88 #define keycode_Func1 (0xffffffef)
89 #define keycode_Func2 (0xffffffee)
90 #define keycode_Func3 (0xffffffed)
91 #define keycode_Func4 (0xffffffec)
92 #define keycode_Func5 (0xffffffeb)
93 #define keycode_Func6 (0xffffffea)
94 #define keycode_Func7 (0xffffffe9)
95 #define keycode_Func8 (0xffffffe8)
96 #define keycode_Func9 (0xffffffe7)
97 #define keycode_Func10 (0xffffffe6)
98 #define keycode_Func11 (0xffffffe5)
99 #define keycode_Func12 (0xffffffe4)
100 /* The last keycode is always (0x100000000 - keycode_MAXVAL) */
101 #define keycode_MAXVAL (28)
103 #define style_Normal (0)
104 #define style_Emphasized (1)
105 #define style_Preformatted (2)
106 #define style_Header (3)
107 #define style_Subheader (4)
108 #define style_Alert (5)
109 #define style_Note (6)
110 #define style_BlockQuote (7)
111 #define style_Input (8)
112 #define style_User1 (9)
113 #define style_User2 (10)
114 #define style_NUMSTYLES (11)
116 typedef struct stream_result_struct {
121 #define wintype_AllTypes (0)
122 #define wintype_Pair (1)
123 #define wintype_Blank (2)
124 #define wintype_TextBuffer (3)
125 #define wintype_TextGrid (4)
126 #define wintype_Graphics (5)
128 #define winmethod_Left (0x00)
129 #define winmethod_Right (0x01)
130 #define winmethod_Above (0x02)
131 #define winmethod_Below (0x03)
132 #define winmethod_DirMask (0x0f)
134 #define winmethod_Fixed (0x10)
135 #define winmethod_Proportional (0x20)
136 #define winmethod_DivisionMask (0xf0)
138 #define fileusage_Data (0x00)
139 #define fileusage_SavedGame (0x01)
140 #define fileusage_Transcript (0x02)
141 #define fileusage_InputRecord (0x03)
142 #define fileusage_TypeMask (0x0f)
144 #define fileusage_TextMode (0x100)
145 #define fileusage_BinaryMode (0x000)
147 #define filemode_Write (0x01)
148 #define filemode_Read (0x02)
149 #define filemode_ReadWrite (0x03)
150 #define filemode_WriteAppend (0x05)
152 #define seekmode_Start (0)
153 #define seekmode_Current (1)
154 #define seekmode_End (2)
156 #define stylehint_Indentation (0)
157 #define stylehint_ParaIndentation (1)
158 #define stylehint_Justification (2)
159 #define stylehint_Size (3)
160 #define stylehint_Weight (4)
161 #define stylehint_Oblique (5)
162 #define stylehint_Proportional (6)
163 #define stylehint_TextColor (7)
164 #define stylehint_BackColor (8)
165 #define stylehint_ReverseColor (9)
166 #define stylehint_NUMHINTS (10)
168 #define stylehint_just_LeftFlush (0)
169 #define stylehint_just_LeftRight (1)
170 #define stylehint_just_Centered (2)
171 #define stylehint_just_RightFlush (3)
173 /* glk_main() is the top-level function which you define. The Glk library
175 extern void glk_main(void);
177 extern void glk_exit(void);
178 extern void glk_set_interrupt_handler(void (*func)(void));
179 extern void glk_tick(void);
181 extern glui32 glk_gestalt(glui32 sel, glui32 val);
182 extern glui32 glk_gestalt_ext(glui32 sel, glui32 val, glui32 *arr,
185 extern unsigned char glk_char_to_lower(unsigned char ch);
186 extern unsigned char glk_char_to_upper(unsigned char ch);
188 extern winid_t glk_window_get_root(void);
189 extern winid_t glk_window_open(winid_t split, glui32 method, glui32 size,
190 glui32 wintype, glui32 rock);
191 extern void glk_window_close(winid_t win, stream_result_t *result);
192 extern void glk_window_get_size(winid_t win, glui32 *widthptr,
194 extern void glk_window_set_arrangement(winid_t win, glui32 method,
195 glui32 size, winid_t keywin);
196 extern void glk_window_get_arrangement(winid_t win, glui32 *methodptr,
197 glui32 *sizeptr, winid_t *keywinptr);
198 extern winid_t glk_window_iterate(winid_t win, glui32 *rockptr);
199 extern glui32 glk_window_get_rock(winid_t win);
200 extern glui32 glk_window_get_type(winid_t win);
201 extern winid_t glk_window_get_parent(winid_t win);
202 extern winid_t glk_window_get_sibling(winid_t win);
203 extern void glk_window_clear(winid_t win);
204 extern void glk_window_move_cursor(winid_t win, glui32 xpos, glui32 ypos);
206 extern strid_t glk_window_get_stream(winid_t win);
207 extern void glk_window_set_echo_stream(winid_t win, strid_t str);
208 extern strid_t glk_window_get_echo_stream(winid_t win);
209 extern void glk_set_window(winid_t win);
211 extern strid_t glk_stream_open_file(frefid_t fileref, glui32 fmode,
213 extern strid_t glk_stream_open_memory(char *buf, glui32 buflen, glui32 fmode,
215 extern void glk_stream_close(strid_t str, stream_result_t *result);
216 extern strid_t glk_stream_iterate(strid_t str, glui32 *rockptr);
217 extern glui32 glk_stream_get_rock(strid_t str);
218 extern void glk_stream_set_position(strid_t str, glsi32 pos, glui32 seekmode);
219 extern glui32 glk_stream_get_position(strid_t str);
220 extern void glk_stream_set_current(strid_t str);
221 extern strid_t glk_stream_get_current(void);
223 extern void glk_put_char(unsigned char ch);
224 extern void glk_put_char_stream(strid_t str, unsigned char ch);
225 extern void glk_put_string(char *s);
226 extern void glk_put_string_stream(strid_t str, char *s);
227 extern void glk_put_buffer(char *buf, glui32 len);
228 extern void glk_put_buffer_stream(strid_t str, char *buf, glui32 len);
229 extern void glk_set_style(glui32 styl);
230 extern void glk_set_style_stream(strid_t str, glui32 styl);
232 extern glsi32 glk_get_char_stream(strid_t str);
233 extern glui32 glk_get_line_stream(strid_t str, char *buf, glui32 len);
234 extern glui32 glk_get_buffer_stream(strid_t str, char *buf, glui32 len);
236 extern void glk_stylehint_set(glui32 wintype, glui32 styl, glui32 hint,
238 extern void glk_stylehint_clear(glui32 wintype, glui32 styl, glui32 hint);
239 extern glui32 glk_style_distinguish(winid_t win, glui32 styl1, glui32 styl2);
240 extern glui32 glk_style_measure(winid_t win, glui32 styl, glui32 hint,
243 extern frefid_t glk_fileref_create_temp(glui32 usage, glui32 rock);
244 extern frefid_t glk_fileref_create_by_name(glui32 usage, char *name,
246 extern frefid_t glk_fileref_create_by_prompt(glui32 usage, glui32 fmode,
248 extern frefid_t glk_fileref_create_from_fileref(glui32 usage, frefid_t fref,
250 extern void glk_fileref_destroy(frefid_t fref);
251 extern frefid_t glk_fileref_iterate(frefid_t fref, glui32 *rockptr);
252 extern glui32 glk_fileref_get_rock(frefid_t fref);
253 extern void glk_fileref_delete_file(frefid_t fref);
254 extern glui32 glk_fileref_does_file_exist(frefid_t fref);
256 extern void glk_select(event_t *event);
257 extern void glk_select_poll(event_t *event);
259 extern void glk_request_timer_events(glui32 millisecs);
261 extern void glk_request_line_event(winid_t win, char *buf, glui32 maxlen,
263 extern void glk_request_char_event(winid_t win);
264 extern void glk_request_mouse_event(winid_t win);
266 extern void glk_cancel_line_event(winid_t win, event_t *event);
267 extern void glk_cancel_char_event(winid_t win);
268 extern void glk_cancel_mouse_event(winid_t win);
270 #ifdef GLK_MODULE_UNICODE
272 extern glui32 glk_buffer_to_lower_case_uni(glui32 *buf, glui32 len,
274 extern glui32 glk_buffer_to_upper_case_uni(glui32 *buf, glui32 len,
276 extern glui32 glk_buffer_to_title_case_uni(glui32 *buf, glui32 len,
277 glui32 numchars, glui32 lowerrest);
279 extern void glk_put_char_uni(glui32 ch);
280 extern void glk_put_string_uni(glui32 *s);
281 extern void glk_put_buffer_uni(glui32 *buf, glui32 len);
282 extern void glk_put_char_stream_uni(strid_t str, glui32 ch);
283 extern void glk_put_string_stream_uni(strid_t str, glui32 *s);
284 extern void glk_put_buffer_stream_uni(strid_t str, glui32 *buf, glui32 len);
286 extern glsi32 glk_get_char_stream_uni(strid_t str);
287 extern glui32 glk_get_buffer_stream_uni(strid_t str, glui32 *buf, glui32 len);
288 extern glui32 glk_get_line_stream_uni(strid_t str, glui32 *buf, glui32 len);
290 extern strid_t glk_stream_open_file_uni(frefid_t fileref, glui32 fmode,
292 extern strid_t glk_stream_open_memory_uni(glui32 *buf, glui32 buflen,
293 glui32 fmode, glui32 rock);
295 extern void glk_request_char_event_uni(winid_t win);
296 extern void glk_request_line_event_uni(winid_t win, glui32 *buf,
297 glui32 maxlen, glui32 initlen);
299 #endif /* GLK_MODULE_UNICODE */
301 #ifdef GLK_MODULE_IMAGE
303 #define imagealign_InlineUp (0x01)
304 #define imagealign_InlineDown (0x02)
305 #define imagealign_InlineCenter (0x03)
306 #define imagealign_MarginLeft (0x04)
307 #define imagealign_MarginRight (0x05)
309 extern glui32 glk_image_draw(winid_t win, glui32 image, glsi32 val1, glsi32 val2);
310 extern glui32 glk_image_draw_scaled(winid_t win, glui32 image,
311 glsi32 val1, glsi32 val2, glui32 width, glui32 height);
312 extern glui32 glk_image_get_info(glui32 image, glui32 *width, glui32 *height);
314 extern void glk_window_flow_break(winid_t win);
316 extern void glk_window_erase_rect(winid_t win,
317 glsi32 left, glsi32 top, glui32 width, glui32 height);
318 extern void glk_window_fill_rect(winid_t win, glui32 color,
319 glsi32 left, glsi32 top, glui32 width, glui32 height);
320 extern void glk_window_set_background_color(winid_t win, glui32 color);
322 #endif /* GLK_MODULE_IMAGE */
324 #ifdef GLK_MODULE_SOUND
326 extern schanid_t glk_schannel_create(glui32 rock);
327 extern void glk_schannel_destroy(schanid_t chan);
328 extern schanid_t glk_schannel_iterate(schanid_t chan, glui32 *rockptr);
329 extern glui32 glk_schannel_get_rock(schanid_t chan);
331 extern glui32 glk_schannel_play(schanid_t chan, glui32 snd);
332 extern glui32 glk_schannel_play_ext(schanid_t chan, glui32 snd, glui32 repeats,
334 extern void glk_schannel_stop(schanid_t chan);
335 extern void glk_schannel_set_volume(schanid_t chan, glui32 vol);
337 extern void glk_sound_load_hint(glui32 snd, glui32 flag);
339 #endif /* GLK_MODULE_SOUND */
341 #ifdef GLK_MODULE_HYPERLINKS
343 extern void glk_set_hyperlink(glui32 linkval);
344 extern void glk_set_hyperlink_stream(strid_t str, glui32 linkval);
345 extern void glk_request_hyperlink_event(winid_t win);
346 extern void glk_cancel_hyperlink_event(winid_t win);
348 #endif /* GLK_MODULE_HYPERLINKS */