interpreters/nitfol/glk.h

   1 #ifndef GLK_H
   2 #define GLK_H
   3
   4 /* glk.h: Header file for Glk API, version 0.7.0.
   5     Designed by Andrew Plotkin <erkyrath@eblong.com>
   6     http://www.eblong.com/zarf/glk/index.html
   7
   8     This file is copyright 1998-2004 by Andrew Plotkin. You may copy,
   9     distribute, and incorporate it into your own programs, by any means
  10     and under any conditions, as long as you do not modify it. You may
  11     also modify this file, incorporate it into your own programs,
  12     and distribute the modified version, as long as you retain a notice
  13     in your program or documentation which mentions my name and the URL
  14     shown above.
  15 */
  16
  17 /* You may have to edit the definition of glui32 to make sure it's really a
  18     32-bit unsigned integer type, and glsi32 to make sure it's really a
  19     32-bit signed integer type. If they're not, horrible things will happen. */
  20 #include <limits.h>\r
  21 #if (USHORT_MAX == 4294967295)\r
  22 typedef unsigned short glui32;\r
  23 typedef signed   short glsi32;\r
  24 #elif (UINT_MAX   == 4294967295)\r
  25 typedef unsigned int glui32;\r
  26 typedef signed   int glsi32;\r
  27 #elif (ULONG_MAX) == 4294967295)\r
  28 typedef unsigned long glui32;\r
  29 typedef signed long glsi32;\r
  30 #else\r
  31 #error No 32-bit integer type found.\r
  32 #endif\r
  33
  34
  35 /* These are the compile-time conditionals that reveal various Glk optional
  36     modules. */
  37 #define GLK_MODULE_UNICODE
  38 #define GLK_MODULE_IMAGE
  39 #define GLK_MODULE_SOUND
  40 #define GLK_MODULE_HYPERLINKS
  41
  42 /* These types are opaque object identifiers. They're pointers to opaque
  43     C structures, which are defined differently by each library. */
  44 typedef struct glk_window_struct  *winid_t;
  45 typedef struct glk_stream_struct  *strid_t;
  46 typedef struct glk_fileref_struct *frefid_t;
  47 typedef struct glk_schannel_struct *schanid_t;
  48
  49 #define gestalt_Version (0)
  50 #define gestalt_CharInput (1)
  51 #define gestalt_LineInput (2)
  52 #define gestalt_CharOutput (3)
  53 #define gestalt_CharOutput_CannotPrint (0)
  54 #define gestalt_CharOutput_ApproxPrint (1)
  55 #define gestalt_CharOutput_ExactPrint (2)
  56 #define gestalt_MouseInput (4)
  57 #define gestalt_Timer (5)
  58 #define gestalt_Graphics (6)
  59 #define gestalt_DrawImage (7)
  60 #define gestalt_Sound (8)
  61 #define gestalt_SoundVolume (9)
  62 #define gestalt_SoundNotify (10)
  63 #define gestalt_Hyperlinks (11)
  64 #define gestalt_HyperlinkInput (12)
  65 #define gestalt_SoundMusic (13)
  66 #define gestalt_GraphicsTransparency (14)
  67 #define gestalt_Unicode (15)
  68
  69 #define evtype_None (0)
  70 #define evtype_Timer (1)
  71 #define evtype_CharInput (2)
  72 #define evtype_LineInput (3)
  73 #define evtype_MouseInput (4)
  74 #define evtype_Arrange (5)
  75 #define evtype_Redraw (6)
  76 #define evtype_SoundNotify (7)
  77 #define evtype_Hyperlink (8)
  78
  79 typedef struct event_struct {
  80     glui32 type;
  81     winid_t win;
  82     glui32 val1, val2;
  83 } event_t;
  84
  85 #define keycode_Unknown  (0xffffffff)
  86 #define keycode_Left     (0xfffffffe)
  87 #define keycode_Right    (0xfffffffd)
  88 #define keycode_Up       (0xfffffffc)
  89 #define keycode_Down     (0xfffffffb)
  90 #define keycode_Return   (0xfffffffa)
  91 #define keycode_Delete   (0xfffffff9)
  92 #define keycode_Escape   (0xfffffff8)
  93 #define keycode_Tab      (0xfffffff7)
  94 #define keycode_PageUp   (0xfffffff6)
  95 #define keycode_PageDown (0xfffffff5)
  96 #define keycode_Home     (0xfffffff4)
  97 #define keycode_End      (0xfffffff3)
  98 #define keycode_Func1    (0xffffffef)
  99 #define keycode_Func2    (0xffffffee)
 100 #define keycode_Func3    (0xffffffed)
 101 #define keycode_Func4    (0xffffffec)
 102 #define keycode_Func5    (0xffffffeb)
 103 #define keycode_Func6    (0xffffffea)
 104 #define keycode_Func7    (0xffffffe9)
 105 #define keycode_Func8    (0xffffffe8)
 106 #define keycode_Func9    (0xffffffe7)
 107 #define keycode_Func10   (0xffffffe6)
 108 #define keycode_Func11   (0xffffffe5)
 109 #define keycode_Func12   (0xffffffe4)
 110 /* The last keycode is always (0x100000000 - keycode_MAXVAL) */
 111 #define keycode_MAXVAL   (28)
 112
 113 #define style_Normal (0)
 114 #define style_Emphasized (1)
 115 #define style_Preformatted (2)
 116 #define style_Header (3)
 117 #define style_Subheader (4)
 118 #define style_Alert (5)
 119 #define style_Note (6)
 120 #define style_BlockQuote (7)
 121 #define style_Input (8)
 122 #define style_User1 (9)
 123 #define style_User2 (10)
 124 #define style_NUMSTYLES (11)
 125
 126 typedef struct stream_result_struct {
 127     glui32 readcount;
 128     glui32 writecount;
 129 } stream_result_t;
 130
 131 #define wintype_AllTypes (0)
 132 #define wintype_Pair (1)
 133 #define wintype_Blank (2)
 134 #define wintype_TextBuffer (3)
 135 #define wintype_TextGrid (4)
 136 #define wintype_Graphics (5)
 137
 138 #define winmethod_Left  (0x00)
 139 #define winmethod_Right (0x01)
 140 #define winmethod_Above (0x02)
 141 #define winmethod_Below (0x03)
 142 #define winmethod_DirMask (0x0f)
 143
 144 #define winmethod_Fixed (0x10)
 145 #define winmethod_Proportional (0x20)
 146 #define winmethod_DivisionMask (0xf0)
 147
 148 #define fileusage_Data (0x00)
 149 #define fileusage_SavedGame (0x01)
 150 #define fileusage_Transcript (0x02)
 151 #define fileusage_InputRecord (0x03)
 152 #define fileusage_TypeMask (0x0f)
 153
 154 #define fileusage_TextMode   (0x100)
 155 #define fileusage_BinaryMode (0x000)
 156
 157 #define filemode_Write (0x01)
 158 #define filemode_Read (0x02)
 159 #define filemode_ReadWrite (0x03)
 160 #define filemode_WriteAppend (0x05)
 161
 162 #define seekmode_Start (0)
 163 #define seekmode_Current (1)
 164 #define seekmode_End (2)
 165
 166 #define stylehint_Indentation (0)
 167 #define stylehint_ParaIndentation (1)
 168 #define stylehint_Justification (2)
 169 #define stylehint_Size (3)
 170 #define stylehint_Weight (4)
 171 #define stylehint_Oblique (5)
 172 #define stylehint_Proportional (6)
 173 #define stylehint_TextColor (7)
 174 #define stylehint_BackColor (8)
 175 #define stylehint_ReverseColor (9)
 176 #define stylehint_NUMHINTS (10)
 177
 178 #define   stylehint_just_LeftFlush (0)
 179 #define   stylehint_just_LeftRight (1)
 180 #define   stylehint_just_Centered (2)
 181 #define   stylehint_just_RightFlush (3)
 182
 183 /* glk_main() is the top-level function which you define. The Glk library
 184     calls it. */
 185 extern void glk_main(void);
 186
 187 extern void glk_exit(void);
 188 extern void glk_set_interrupt_handler(void (*func)(void));
 189 extern void glk_tick(void);
 190
 191 extern glui32 glk_gestalt(glui32 sel, glui32 val);
 192 extern glui32 glk_gestalt_ext(glui32 sel, glui32 val, glui32 *arr,
 193     glui32 arrlen);
 194
 195 extern unsigned char glk_char_to_lower(unsigned char ch);
 196 extern unsigned char glk_char_to_upper(unsigned char ch);
 197
 198 extern winid_t glk_window_get_root(void);
 199 extern winid_t glk_window_open(winid_t split, glui32 method, glui32 size,
 200     glui32 wintype, glui32 rock);
 201 extern void glk_window_close(winid_t win, stream_result_t *result);
 202 extern void glk_window_get_size(winid_t win, glui32 *widthptr,
 203     glui32 *heightptr);
 204 extern void glk_window_set_arrangement(winid_t win, glui32 method,
 205     glui32 size, winid_t keywin);
 206 extern void glk_window_get_arrangement(winid_t win, glui32 *methodptr,
 207     glui32 *sizeptr, winid_t *keywinptr);
 208 extern winid_t glk_window_iterate(winid_t win, glui32 *rockptr);
 209 extern glui32 glk_window_get_rock(winid_t win);
 210 extern glui32 glk_window_get_type(winid_t win);
 211 extern winid_t glk_window_get_parent(winid_t win);
 212 extern winid_t glk_window_get_sibling(winid_t win);
 213 extern void glk_window_clear(winid_t win);
 214 extern void glk_window_move_cursor(winid_t win, glui32 xpos, glui32 ypos);
 215
 216 extern strid_t glk_window_get_stream(winid_t win);
 217 extern void glk_window_set_echo_stream(winid_t win, strid_t str);
 218 extern strid_t glk_window_get_echo_stream(winid_t win);
 219 extern void glk_set_window(winid_t win);
 220
 221 extern strid_t glk_stream_open_file(frefid_t fileref, glui32 fmode,
 222     glui32 rock);
 223 extern strid_t glk_stream_open_memory(char *buf, glui32 buflen, glui32 fmode,
 224     glui32 rock);
 225 extern void glk_stream_close(strid_t str, stream_result_t *result);
 226 extern strid_t glk_stream_iterate(strid_t str, glui32 *rockptr);
 227 extern glui32 glk_stream_get_rock(strid_t str);
 228 extern void glk_stream_set_position(strid_t str, glsi32 pos, glui32 seekmode);
 229 extern glui32 glk_stream_get_position(strid_t str);
 230 extern void glk_stream_set_current(strid_t str);
 231 extern strid_t glk_stream_get_current(void);
 232
 233 extern void glk_put_char(unsigned char ch);
 234 extern void glk_put_char_stream(strid_t str, unsigned char ch);
 235 extern void glk_put_string(char *s);
 236 extern void glk_put_string_stream(strid_t str, char *s);
 237 extern void glk_put_buffer(char *buf, glui32 len);
 238 extern void glk_put_buffer_stream(strid_t str, char *buf, glui32 len);
 239 extern void glk_set_style(glui32 styl);
 240 extern void glk_set_style_stream(strid_t str, glui32 styl);
 241
 242 extern glsi32 glk_get_char_stream(strid_t str);
 243 extern glui32 glk_get_line_stream(strid_t str, char *buf, glui32 len);
 244 extern glui32 glk_get_buffer_stream(strid_t str, char *buf, glui32 len);
 245
 246 extern void glk_stylehint_set(glui32 wintype, glui32 styl, glui32 hint,
 247     glsi32 val);
 248 extern void glk_stylehint_clear(glui32 wintype, glui32 styl, glui32 hint);
 249 extern glui32 glk_style_distinguish(winid_t win, glui32 styl1, glui32 styl2);
 250 extern glui32 glk_style_measure(winid_t win, glui32 styl, glui32 hint,
 251     glui32 *result);
 252
 253 extern frefid_t glk_fileref_create_temp(glui32 usage, glui32 rock);
 254 extern frefid_t glk_fileref_create_by_name(glui32 usage, char *name,
 255     glui32 rock);
 256 extern frefid_t glk_fileref_create_by_prompt(glui32 usage, glui32 fmode,
 257     glui32 rock);
 258 extern frefid_t glk_fileref_create_from_fileref(glui32 usage, frefid_t fref,
 259     glui32 rock);
 260 extern void glk_fileref_destroy(frefid_t fref);
 261 extern frefid_t glk_fileref_iterate(frefid_t fref, glui32 *rockptr);
 262 extern glui32 glk_fileref_get_rock(frefid_t fref);
 263 extern void glk_fileref_delete_file(frefid_t fref);
 264 extern glui32 glk_fileref_does_file_exist(frefid_t fref);
 265
 266 extern void glk_select(event_t *event);
 267 extern void glk_select_poll(event_t *event);
 268
 269 extern void glk_request_timer_events(glui32 millisecs);
 270
 271 extern void glk_request_line_event(winid_t win, char *buf, glui32 maxlen,
 272     glui32 initlen);
 273 extern void glk_request_char_event(winid_t win);
 274 extern void glk_request_mouse_event(winid_t win);
 275
 276 extern void glk_cancel_line_event(winid_t win, event_t *event);
 277 extern void glk_cancel_char_event(winid_t win);
 278 extern void glk_cancel_mouse_event(winid_t win);
 279
 280 #ifdef GLK_MODULE_UNICODE
 281
 282 extern glui32 glk_buffer_to_lower_case_uni(glui32 *buf, glui32 len,
 283     glui32 numchars);
 284 extern glui32 glk_buffer_to_upper_case_uni(glui32 *buf, glui32 len,
 285     glui32 numchars);
 286 extern glui32 glk_buffer_to_title_case_uni(glui32 *buf, glui32 len,
 287     glui32 numchars, glui32 lowerrest);
 288
 289 extern void glk_put_char_uni(glui32 ch);
 290 extern void glk_put_string_uni(glui32 *s);
 291 extern void glk_put_buffer_uni(glui32 *buf, glui32 len);
 292 extern void glk_put_char_stream_uni(strid_t str, glui32 ch);
 293 extern void glk_put_string_stream_uni(strid_t str, glui32 *s);
 294 extern void glk_put_buffer_stream_uni(strid_t str, glui32 *buf, glui32 len);
 295
 296 extern glsi32 glk_get_char_stream_uni(strid_t str);
 297 extern glui32 glk_get_buffer_stream_uni(strid_t str, glui32 *buf, glui32 len);
 298 extern glui32 glk_get_line_stream_uni(strid_t str, glui32 *buf, glui32 len);
 299
 300 extern strid_t glk_stream_open_file_uni(frefid_t fileref, glui32 fmode,
 301     glui32 rock);
 302 extern strid_t glk_stream_open_memory_uni(glui32 *buf, glui32 buflen,
 303     glui32 fmode, glui32 rock);
 304
 305 extern void glk_request_char_event_uni(winid_t win);
 306 extern void glk_request_line_event_uni(winid_t win, glui32 *buf,
 307     glui32 maxlen, glui32 initlen);
 308
 309 #endif /* GLK_MODULE_UNICODE */
 310
 311 #ifdef GLK_MODULE_IMAGE
 312
 313 #define imagealign_InlineUp (0x01)
 314 #define imagealign_InlineDown (0x02)
 315 #define imagealign_InlineCenter (0x03)
 316 #define imagealign_MarginLeft (0x04)
 317 #define imagealign_MarginRight (0x05)
 318
 319 extern glui32 glk_image_draw(winid_t win, glui32 image, glsi32 val1, glsi32 val2);
 320 extern glui32 glk_image_draw_scaled(winid_t win, glui32 image,
 321     glsi32 val1, glsi32 val2, glui32 width, glui32 height);
 322 extern glui32 glk_image_get_info(glui32 image, glui32 *width, glui32 *height);
 323
 324 extern void glk_window_flow_break(winid_t win);
 325
 326 extern void glk_window_erase_rect(winid_t win,
 327     glsi32 left, glsi32 top, glui32 width, glui32 height);
 328 extern void glk_window_fill_rect(winid_t win, glui32 color,
 329     glsi32 left, glsi32 top, glui32 width, glui32 height);
 330 extern void glk_window_set_background_color(winid_t win, glui32 color);
 331
 332 #endif /* GLK_MODULE_IMAGE */
 333
 334 #ifdef GLK_MODULE_SOUND
 335
 336 extern schanid_t glk_schannel_create(glui32 rock);
 337 extern void glk_schannel_destroy(schanid_t chan);
 338 extern schanid_t glk_schannel_iterate(schanid_t chan, glui32 *rockptr);
 339 extern glui32 glk_schannel_get_rock(schanid_t chan);
 340
 341 extern glui32 glk_schannel_play(schanid_t chan, glui32 snd);
 342 extern glui32 glk_schannel_play_ext(schanid_t chan, glui32 snd, glui32 repeats,
 343     glui32 notify);
 344 extern void glk_schannel_stop(schanid_t chan);
 345 extern void glk_schannel_set_volume(schanid_t chan, glui32 vol);
 346
 347 extern void glk_sound_load_hint(glui32 snd, glui32 flag);
 348
 349 #endif /* GLK_MODULE_SOUND */
 350
 351 #ifdef GLK_MODULE_HYPERLINKS
 352
 353 extern void glk_set_hyperlink(glui32 linkval);
 354 extern void glk_set_hyperlink_stream(strid_t str, glui32 linkval);
 355 extern void glk_request_hyperlink_event(winid_t win);
 356 extern void glk_cancel_hyperlink_event(winid_t win);
 357
 358 #endif /* GLK_MODULE_HYPERLINKS */
 359
 360 /* XXX non-official Glk functions that may or may not exist */
 361
 362 #define GARGLK 1
 363
 364 extern char* garglk_fileref_get_name(frefid_t fref);
 365
 366 extern void garglk_set_program_name(const char *name);
 367 extern void garglk_set_program_info(const char *info);
 368 extern void garglk_set_story_name(const char *name);
 369 extern void garglk_set_config(const char *name);
 370
 371 /* not implemented */
 372
 373 #define garglk_font_Roman           (0)
 374 #define garglk_font_Italic          (1)
 375 #define garglk_font_Bold            (2)
 376 #define garglk_font_BoldItalic      (3)
 377 #define garglk_font_MonoRoman       (4)
 378 #define garglk_font_MonoItalic      (5)
 379 #define garglk_font_MonoBold        (6)
 380 #define garglk_font_MonoBoldItalic  (7)
 381
 382 #define garglk_color_White          (0)
 383 #define garglk_color_Red            (1)
 384 #define garglk_color_Green          (2)
 385 #define garglk_color_Blue           (3)
 386 #define garglk_color_Cyan           (4)
 387 #define garglk_color_Magenta        (5)
 388 #define garglk_color_Yellow         (6)
 389 #define garglk_color_Black          (7)
 390
 391 extern void garglk_set_style_font(glui32 font);
 392 extern void garglk_set_style_stream_font(strid_t str, glui32 font);
 393 extern void garglk_set_style_color(glui32 bg, glui32 fg);
 394 extern void garglk_set_style_stream_color(strid_t str, glui32 bg, glui32 fg);
 395
 396 /* JM: functions added to support Z-machine features that aren't in the Glk standard */
 397
 398 /* garglk_set_line_terminators - amends the current line input request to include terminating
 399  * key codes. any of the specified key codes will terminate input (without printing a newline),
 400  * and the key code will be returned in the event record as val2. */
 401 extern void garglk_set_line_terminators(winid_t win, const glui32 *keycodes, glui32 numkeycodes);
 402
 403 /* garglk_unput_string - removes the specified string from the end of the output buffer, if
 404  * indeed it is there. */
 405 extern void garglk_unput_string(char *str);
 406 extern void garglk_unput_string_uni(glui32 *str);
 407
 408 #define zcolor_Current      (0)
 409 #define zcolor_Default      (1)
 410 #define zcolor_Black        (2)
 411 #define zcolor_Red          (3)
 412 #define zcolor_Green        (4)
 413 #define zcolor_Yellow       (5)
 414 #define zcolor_Blue         (6)
 415 #define zcolor_Magenta      (7)
 416 #define zcolor_Cyan         (8)
 417 #define zcolor_White        (9)
 418 #define zcolor_LightGrey    (10)
 419 #define zcolor_MediumGrey   (11)
 420 #define zcolor_DarkGrey     (12)
 421 #define zcolor_NUMCOLORS    (13)
 422
 423 extern void garglk_set_zcolors(glui32 fg, glui32 bg);
 424 extern void garglk_set_reversevideo(glui32 reverse);
 425
 426 #endif /* GLK_H */