libchimara/glk.h

   1 #ifndef GLK_H
   2 #define GLK_H
   3
   4 /* glk.h: Header file for Glk API, version 0.7.3.
   5     Designed by Andrew Plotkin <erkyrath@eblong.com>
   6     http://eblong.com/zarf/glk/
   7
   8     This file is copyright 1998-2011 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 /* If your system does not have <stdint.h>, you'll have to remove this
  18     include line. Then edit the definition of glui32 to make sure it's
  19     really a 32-bit unsigned integer type, and glsi32 to make sure
  20     it's really a 32-bit signed integer type. If they're not, horrible
  21     things will happen. */
  22 #include <stdint.h>
  23 typedef uint32_t glui32;
  24 typedef int32_t glsi32;
  25
  26 /* These are the compile-time conditionals that reveal various Glk optional
  27     modules. Note that if GLK_MODULE_SOUND2 is defined, GLK_MODULE_SOUND
  28     must be also. */
  29 #define GLK_MODULE_LINE_ECHO
  30 #define GLK_MODULE_LINE_TERMINATORS
  31 #define GLK_MODULE_UNICODE
  32 #define GLK_MODULE_UNICODE_NORM
  33 #define GLK_MODULE_IMAGE
  34 #define GLK_MODULE_SOUND
  35 #define GLK_MODULE_SOUND2
  36 #define GLK_MODULE_HYPERLINKS
  37 #define GLK_MODULE_DATETIME
  38
  39 /* These types are opaque object identifiers. They're pointers to opaque
  40     C structures, which are defined differently by each library. */
  41 typedef struct glk_window_struct  *winid_t;
  42 typedef struct glk_stream_struct  *strid_t;
  43 typedef struct glk_fileref_struct *frefid_t;
  44 typedef struct glk_schannel_struct *schanid_t;
  45
  46 #define gestalt_Version (0)
  47 #define gestalt_CharInput (1)
  48 #define gestalt_LineInput (2)
  49 #define gestalt_CharOutput (3)
  50 #define   gestalt_CharOutput_CannotPrint (0)
  51 #define   gestalt_CharOutput_ApproxPrint (1)
  52 #define   gestalt_CharOutput_ExactPrint (2)
  53 #define gestalt_MouseInput (4)
  54 #define gestalt_Timer (5)
  55 #define gestalt_Graphics (6)
  56 #define gestalt_DrawImage (7)
  57 #define gestalt_Sound (8)
  58 #define gestalt_SoundVolume (9)
  59 #define gestalt_SoundNotify (10)
  60 #define gestalt_Hyperlinks (11)
  61 #define gestalt_HyperlinkInput (12)
  62 #define gestalt_SoundMusic (13)
  63 #define gestalt_GraphicsTransparency (14)
  64 #define gestalt_Unicode (15)
  65 #define gestalt_UnicodeNorm (16)
  66 #define gestalt_LineInputEcho (17)
  67 #define gestalt_LineTerminators (18)
  68 #define gestalt_LineTerminatorKey (19)
  69 #define gestalt_DateTime (20)
  70 #define gestalt_Sound2 (21)
  71
  72 #define evtype_None (0)
  73 #define evtype_Timer (1)
  74 #define evtype_CharInput (2)
  75 #define evtype_LineInput (3)
  76 #define evtype_MouseInput (4)
  77 #define evtype_Arrange (5)
  78 #define evtype_Redraw (6)
  79 #define evtype_SoundNotify (7)
  80 #define evtype_Hyperlink (8)
  81 #define evtype_VolumeNotify (9)
  82
  83 typedef struct event_struct {
  84     glui32 type;
  85     winid_t win;
  86     glui32 val1, val2;
  87 } event_t;
  88
  89 #define keycode_Unknown  (0xffffffff)
  90 #define keycode_Left     (0xfffffffe)
  91 #define keycode_Right    (0xfffffffd)
  92 #define keycode_Up       (0xfffffffc)
  93 #define keycode_Down     (0xfffffffb)
  94 #define keycode_Return   (0xfffffffa)
  95 #define keycode_Delete   (0xfffffff9)
  96 #define keycode_Escape   (0xfffffff8)
  97 #define keycode_Tab      (0xfffffff7)
  98 #define keycode_PageUp   (0xfffffff6)
  99 #define keycode_PageDown (0xfffffff5)
 100 #define keycode_Home     (0xfffffff4)
 101 #define keycode_End      (0xfffffff3)
 102 #define keycode_Func1    (0xffffffef)
 103 #define keycode_Func2    (0xffffffee)
 104 #define keycode_Func3    (0xffffffed)
 105 #define keycode_Func4    (0xffffffec)
 106 #define keycode_Func5    (0xffffffeb)
 107 #define keycode_Func6    (0xffffffea)
 108 #define keycode_Func7    (0xffffffe9)
 109 #define keycode_Func8    (0xffffffe8)
 110 #define keycode_Func9    (0xffffffe7)
 111 #define keycode_Func10   (0xffffffe6)
 112 #define keycode_Func11   (0xffffffe5)
 113 #define keycode_Func12   (0xffffffe4)
 114 /* The last keycode is always (0x100000000 - keycode_MAXVAL) */
 115 #define keycode_MAXVAL   (28)
 116
 117 #define style_Normal (0)
 118 #define style_Emphasized (1)
 119 #define style_Preformatted (2)
 120 #define style_Header (3)
 121 #define style_Subheader (4)
 122 #define style_Alert (5)
 123 #define style_Note (6)
 124 #define style_BlockQuote (7)
 125 #define style_Input (8)
 126 #define style_User1 (9)
 127 #define style_User2 (10)
 128 #define style_NUMSTYLES (11)
 129
 130 typedef struct stream_result_struct {
 131     glui32 readcount;
 132     glui32 writecount;
 133 } stream_result_t;
 134
 135 #define wintype_AllTypes (0)
 136 #define wintype_Pair (1)
 137 #define wintype_Blank (2)
 138 #define wintype_TextBuffer (3)
 139 #define wintype_TextGrid (4)
 140 #define wintype_Graphics (5)
 141
 142 #define winmethod_Left  (0x00)
 143 #define winmethod_Right (0x01)
 144 #define winmethod_Above (0x02)
 145 #define winmethod_Below (0x03)
 146 #define winmethod_DirMask (0x0f)
 147
 148 #define winmethod_Fixed (0x10)
 149 #define winmethod_Proportional (0x20)
 150 #define winmethod_DivisionMask (0xf0)
 151
 152 #define winmethod_Border   (0x000)
 153 #define winmethod_NoBorder (0x100)
 154 #define winmethod_BorderMask (0x100)
 155
 156 #define fileusage_Data (0x00)
 157 #define fileusage_SavedGame (0x01)
 158 #define fileusage_Transcript (0x02)
 159 #define fileusage_InputRecord (0x03)
 160 #define fileusage_TypeMask (0x0f)
 161
 162 #define fileusage_TextMode   (0x100)
 163 #define fileusage_BinaryMode (0x000)
 164
 165 #define filemode_Write (0x01)
 166 #define filemode_Read (0x02)
 167 #define filemode_ReadWrite (0x03)
 168 #define filemode_WriteAppend (0x05)
 169
 170 #define seekmode_Start (0)
 171 #define seekmode_Current (1)
 172 #define seekmode_End (2)
 173
 174 #define stylehint_Indentation (0)
 175 #define stylehint_ParaIndentation (1)
 176 #define stylehint_Justification (2)
 177 #define stylehint_Size (3)
 178 #define stylehint_Weight (4)
 179 #define stylehint_Oblique (5)
 180 #define stylehint_Proportional (6)
 181 #define stylehint_TextColor (7)
 182 #define stylehint_BackColor (8)
 183 #define stylehint_ReverseColor (9)
 184 #define stylehint_NUMHINTS (10)
 185
 186 #define   stylehint_just_LeftFlush (0)
 187 #define   stylehint_just_LeftRight (1)
 188 #define   stylehint_just_Centered (2)
 189 #define   stylehint_just_RightFlush (3)
 190
 191 /* glk_main() is the top-level function which you define. The Glk library
 192     calls it. */
 193 extern void glk_main(void);
 194
 195 extern void glk_exit(void);
 196 extern void glk_set_interrupt_handler(void (*func)(void));
 197 extern void glk_tick(void);
 198
 199 extern glui32 glk_gestalt(glui32 sel, glui32 val);
 200 extern glui32 glk_gestalt_ext(glui32 sel, glui32 val, glui32 *arr,
 201     glui32 arrlen);
 202
 203 extern unsigned char glk_char_to_lower(unsigned char ch);
 204 extern unsigned char glk_char_to_upper(unsigned char ch);
 205
 206 extern winid_t glk_window_get_root(void);
 207 extern winid_t glk_window_open(winid_t split, glui32 method, glui32 size,
 208     glui32 wintype, glui32 rock);
 209 extern void glk_window_close(winid_t win, stream_result_t *result);
 210 extern void glk_window_get_size(winid_t win, glui32 *widthptr,
 211     glui32 *heightptr);
 212 extern void glk_window_set_arrangement(winid_t win, glui32 method,
 213     glui32 size, winid_t keywin);
 214 extern void glk_window_get_arrangement(winid_t win, glui32 *methodptr,
 215     glui32 *sizeptr, winid_t *keywinptr);
 216 extern winid_t glk_window_iterate(winid_t win, glui32 *rockptr);
 217 extern glui32 glk_window_get_rock(winid_t win);
 218 extern glui32 glk_window_get_type(winid_t win);
 219 extern winid_t glk_window_get_parent(winid_t win);
 220 extern winid_t glk_window_get_sibling(winid_t win);
 221 extern void glk_window_clear(winid_t win);
 222 extern void glk_window_move_cursor(winid_t win, glui32 xpos, glui32 ypos);
 223
 224 extern strid_t glk_window_get_stream(winid_t win);
 225 extern void glk_window_set_echo_stream(winid_t win, strid_t str);
 226 extern strid_t glk_window_get_echo_stream(winid_t win);
 227 extern void glk_set_window(winid_t win);
 228
 229 extern strid_t glk_stream_open_file(frefid_t fileref, glui32 fmode,
 230     glui32 rock);
 231 extern strid_t glk_stream_open_memory(char *buf, glui32 buflen, glui32 fmode,
 232     glui32 rock);
 233 extern void glk_stream_close(strid_t str, stream_result_t *result);
 234 extern strid_t glk_stream_iterate(strid_t str, glui32 *rockptr);
 235 extern glui32 glk_stream_get_rock(strid_t str);
 236 extern void glk_stream_set_position(strid_t str, glsi32 pos, glui32 seekmode);
 237 extern glui32 glk_stream_get_position(strid_t str);
 238 extern void glk_stream_set_current(strid_t str);
 239 extern strid_t glk_stream_get_current(void);
 240
 241 extern void glk_put_char(unsigned char ch);
 242 extern void glk_put_char_stream(strid_t str, unsigned char ch);
 243 extern void glk_put_string(char *s);
 244 extern void glk_put_string_stream(strid_t str, char *s);
 245 extern void glk_put_buffer(char *buf, glui32 len);
 246 extern void glk_put_buffer_stream(strid_t str, char *buf, glui32 len);
 247 extern void glk_set_style(glui32 styl);
 248 extern void glk_set_style_stream(strid_t str, glui32 styl);
 249
 250 extern glsi32 glk_get_char_stream(strid_t str);
 251 extern glui32 glk_get_line_stream(strid_t str, char *buf, glui32 len);
 252 extern glui32 glk_get_buffer_stream(strid_t str, char *buf, glui32 len);
 253
 254 extern void glk_stylehint_set(glui32 wintype, glui32 styl, glui32 hint,
 255     glsi32 val);
 256 extern void glk_stylehint_clear(glui32 wintype, glui32 styl, glui32 hint);
 257 extern glui32 glk_style_distinguish(winid_t win, glui32 styl1, glui32 styl2);
 258 extern glui32 glk_style_measure(winid_t win, glui32 styl, glui32 hint,
 259     glui32 *result);
 260
 261 extern frefid_t glk_fileref_create_temp(glui32 usage, glui32 rock);
 262 extern frefid_t glk_fileref_create_by_name(glui32 usage, char *name,
 263     glui32 rock);
 264 extern frefid_t glk_fileref_create_by_prompt(glui32 usage, glui32 fmode,
 265     glui32 rock);
 266 extern frefid_t glk_fileref_create_from_fileref(glui32 usage, frefid_t fref,
 267     glui32 rock);
 268 extern void glk_fileref_destroy(frefid_t fref);
 269 extern frefid_t glk_fileref_iterate(frefid_t fref, glui32 *rockptr);
 270 extern glui32 glk_fileref_get_rock(frefid_t fref);
 271 extern void glk_fileref_delete_file(frefid_t fref);
 272 extern glui32 glk_fileref_does_file_exist(frefid_t fref);
 273
 274 extern void glk_select(event_t *event);
 275 extern void glk_select_poll(event_t *event);
 276
 277 extern void glk_request_timer_events(glui32 millisecs);
 278
 279 extern void glk_request_line_event(winid_t win, char *buf, glui32 maxlen,
 280     glui32 initlen);
 281 extern void glk_request_char_event(winid_t win);
 282 extern void glk_request_mouse_event(winid_t win);
 283
 284 extern void glk_cancel_line_event(winid_t win, event_t *event);
 285 extern void glk_cancel_char_event(winid_t win);
 286 extern void glk_cancel_mouse_event(winid_t win);
 287
 288 #ifdef GLK_MODULE_LINE_ECHO
 289 extern void glk_set_echo_line_event(winid_t win, glui32 val);
 290 #endif /* GLK_MODULE_LINE_ECHO */
 291
 292 #ifdef GLK_MODULE_LINE_TERMINATORS
 293 extern void glk_set_terminators_line_event(winid_t win, glui32 *keycodes,
 294     glui32 count);
 295 #endif /* GLK_MODULE_LINE_TERMINATORS */
 296
 297 #ifdef GLK_MODULE_UNICODE
 298
 299 extern glui32 glk_buffer_to_lower_case_uni(glui32 *buf, glui32 len,
 300     glui32 numchars);
 301 extern glui32 glk_buffer_to_upper_case_uni(glui32 *buf, glui32 len,
 302     glui32 numchars);
 303 extern glui32 glk_buffer_to_title_case_uni(glui32 *buf, glui32 len,
 304     glui32 numchars, glui32 lowerrest);
 305
 306 extern void glk_put_char_uni(glui32 ch);
 307 extern void glk_put_string_uni(glui32 *s);
 308 extern void glk_put_buffer_uni(glui32 *buf, glui32 len);
 309 extern void glk_put_char_stream_uni(strid_t str, glui32 ch);
 310 extern void glk_put_string_stream_uni(strid_t str, glui32 *s);
 311 extern void glk_put_buffer_stream_uni(strid_t str, glui32 *buf, glui32 len);
 312
 313 extern glsi32 glk_get_char_stream_uni(strid_t str);
 314 extern glui32 glk_get_buffer_stream_uni(strid_t str, glui32 *buf, glui32 len);
 315 extern glui32 glk_get_line_stream_uni(strid_t str, glui32 *buf, glui32 len);
 316
 317 extern strid_t glk_stream_open_file_uni(frefid_t fileref, glui32 fmode,
 318     glui32 rock);
 319 extern strid_t glk_stream_open_memory_uni(glui32 *buf, glui32 buflen,
 320     glui32 fmode, glui32 rock);
 321
 322 extern void glk_request_char_event_uni(winid_t win);
 323 extern void glk_request_line_event_uni(winid_t win, glui32 *buf,
 324     glui32 maxlen, glui32 initlen);
 325
 326 #endif /* GLK_MODULE_UNICODE */
 327
 328 #ifdef GLK_MODULE_UNICODE_NORM
 329
 330 extern glui32 glk_buffer_canon_decompose_uni(glui32 *buf, glui32 len,
 331     glui32 numchars);
 332 extern glui32 glk_buffer_canon_normalize_uni(glui32 *buf, glui32 len,
 333     glui32 numchars);
 334
 335 #endif /* GLK_MODULE_UNICODE_NORM */
 336
 337 #ifdef GLK_MODULE_IMAGE
 338
 339 #define imagealign_InlineUp (0x01)
 340 #define imagealign_InlineDown (0x02)
 341 #define imagealign_InlineCenter (0x03)
 342 #define imagealign_MarginLeft (0x04)
 343 #define imagealign_MarginRight (0x05)
 344
 345 extern glui32 glk_image_draw(winid_t win, glui32 image, glsi32 val1, glsi32 val2);
 346 extern glui32 glk_image_draw_scaled(winid_t win, glui32 image,
 347     glsi32 val1, glsi32 val2, glui32 width, glui32 height);
 348 extern glui32 glk_image_get_info(glui32 image, glui32 *width, glui32 *height);
 349
 350 extern void glk_window_flow_break(winid_t win);
 351
 352 extern void glk_window_erase_rect(winid_t win,
 353     glsi32 left, glsi32 top, glui32 width, glui32 height);
 354 extern void glk_window_fill_rect(winid_t win, glui32 color,
 355     glsi32 left, glsi32 top, glui32 width, glui32 height);
 356 extern void glk_window_set_background_color(winid_t win, glui32 color);
 357
 358 #endif /* GLK_MODULE_IMAGE */
 359
 360 #ifdef GLK_MODULE_SOUND
 361
 362 extern schanid_t glk_schannel_create(glui32 rock);
 363 extern void glk_schannel_destroy(schanid_t chan);
 364 extern schanid_t glk_schannel_iterate(schanid_t chan, glui32 *rockptr);
 365 extern glui32 glk_schannel_get_rock(schanid_t chan);
 366
 367 extern glui32 glk_schannel_play(schanid_t chan, glui32 snd);
 368 extern glui32 glk_schannel_play_ext(schanid_t chan, glui32 snd, glui32 repeats,
 369     glui32 notify);
 370 extern void glk_schannel_stop(schanid_t chan);
 371 extern void glk_schannel_set_volume(schanid_t chan, glui32 vol);
 372
 373 extern void glk_sound_load_hint(glui32 snd, glui32 flag);
 374
 375 #ifdef GLK_MODULE_SOUND2
 376 /* Note that this section is nested inside the #ifdef GLK_MODULE_SOUND.
 377    GLK_MODULE_SOUND must be defined if GLK_MODULE_SOUND2 is. */
 378
 379 extern schanid_t glk_schannel_create_ext(glui32 rock, glui32 volume);
 380 extern glui32 glk_schannel_play_multi(schanid_t *chanarray, glui32 chancount,
 381     glui32 *sndarray, glui32 soundcount, glui32 notify);
 382 extern void glk_schannel_pause(schanid_t chan);
 383 extern void glk_schannel_unpause(schanid_t chan);
 384 extern void glk_schannel_set_volume_ext(schanid_t chan, glui32 vol,
 385     glui32 duration, glui32 notify);
 386
 387 #endif /* GLK_MODULE_SOUND2 */
 388 #endif /* GLK_MODULE_SOUND */
 389
 390 #ifdef GLK_MODULE_HYPERLINKS
 391
 392 extern void glk_set_hyperlink(glui32 linkval);
 393 extern void glk_set_hyperlink_stream(strid_t str, glui32 linkval);
 394 extern void glk_request_hyperlink_event(winid_t win);
 395 extern void glk_cancel_hyperlink_event(winid_t win);
 396
 397 #endif /* GLK_MODULE_HYPERLINKS */
 398
 399 #ifdef GLK_MODULE_DATETIME
 400
 401 typedef struct glktimeval_struct {
 402     glsi32 high_sec;
 403     glui32 low_sec;
 404     glsi32 microsec;
 405 } glktimeval_t;
 406
 407 typedef struct glkdate_struct {
 408     glsi32 year;     /* full (four-digit) year */
 409     glsi32 month;    /* 1-12, 1 is January */
 410     glsi32 day;      /* 1-31 */
 411     glsi32 weekday;  /* 0-6, 0 is Sunday */
 412     glsi32 hour;     /* 0-23 */
 413     glsi32 minute;   /* 0-59 */
 414     glsi32 second;   /* 0-59, maybe 60 during a leap second */
 415     glsi32 microsec; /* 0-999999 */
 416 } glkdate_t;
 417
 418 extern void glk_current_time(glktimeval_t *time);
 419 extern glsi32 glk_current_simple_time(glui32 factor);
 420 extern void glk_time_to_date_utc(glktimeval_t *time, glkdate_t *date);
 421 extern void glk_time_to_date_local(glktimeval_t *time, glkdate_t *date);
 422 extern void glk_simple_time_to_date_utc(glsi32 time, glui32 factor,
 423     glkdate_t *date);
 424 extern void glk_simple_time_to_date_local(glsi32 time, glui32 factor,
 425     glkdate_t *date);
 426 extern void glk_date_to_time_utc(glkdate_t *date, glktimeval_t *time);
 427 extern void glk_date_to_time_local(glkdate_t *date, glktimeval_t *time);
 428 extern glsi32 glk_date_to_simple_time_utc(glkdate_t *date, glui32 factor);
 429 extern glsi32 glk_date_to_simple_time_local(glkdate_t *date, glui32 factor);
 430
 431 #endif /* GLK_MODULE_DATETIME */
 432
 433 #endif /* GLK_H */