libchimara/glk.h

   1 #ifndef GLK_H
   2 #define GLK_H
   3
   4 /* glk.h: Header file for Glk API, version 0.7.2.
   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. */
  28 #define GLK_MODULE_LINE_ECHO
  29 #define GLK_MODULE_LINE_TERMINATORS
  30 #define GLK_MODULE_UNICODE
  31 #define GLK_MODULE_UNICODE_NORM
  32 #define GLK_MODULE_IMAGE
  33 #define GLK_MODULE_SOUND
  34 #define GLK_MODULE_HYPERLINKS
  35 #define GLK_MODULE_DATETIME
  36
  37 /* These types are opaque object identifiers. They're pointers to opaque
  38  C structures, which are defined differently by each library. */
  39 typedef struct glk_window_struct  *winid_t;
  40 typedef struct glk_stream_struct  *strid_t;
  41 typedef struct glk_fileref_struct *frefid_t;
  42 typedef struct glk_schannel_struct *schanid_t;
  43
  44 #define gestalt_Version (0)
  45 #define gestalt_CharInput (1)
  46 #define gestalt_LineInput (2)
  47 #define gestalt_CharOutput (3)
  48 #define   gestalt_CharOutput_CannotPrint (0)
  49 #define   gestalt_CharOutput_ApproxPrint (1)
  50 #define   gestalt_CharOutput_ExactPrint (2)
  51 #define gestalt_MouseInput (4)
  52 #define gestalt_Timer (5)
  53 #define gestalt_Graphics (6)
  54 #define gestalt_DrawImage (7)
  55 #define gestalt_Sound (8)
  56 #define gestalt_SoundVolume (9)
  57 #define gestalt_SoundNotify (10)
  58 #define gestalt_Hyperlinks (11)
  59 #define gestalt_HyperlinkInput (12)
  60 #define gestalt_SoundMusic (13)
  61 #define gestalt_GraphicsTransparency (14)
  62 #define gestalt_Unicode (15)
  63 #define gestalt_UnicodeNorm (16)
  64 #define gestalt_LineInputEcho (17)
  65 #define gestalt_LineTerminators (18)
  66 #define gestalt_LineTerminatorKey (19)
  67 #define gestalt_DateTime (20)
  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 winmethod_Border   (0x000)
 149 #define winmethod_NoBorder (0x100)
 150 #define winmethod_BorderMask (0x100)
 151
 152 #define fileusage_Data (0x00)
 153 #define fileusage_SavedGame (0x01)
 154 #define fileusage_Transcript (0x02)
 155 #define fileusage_InputRecord (0x03)
 156 #define fileusage_TypeMask (0x0f)
 157
 158 #define fileusage_TextMode   (0x100)
 159 #define fileusage_BinaryMode (0x000)
 160
 161 #define filemode_Write (0x01)
 162 #define filemode_Read (0x02)
 163 #define filemode_ReadWrite (0x03)
 164 #define filemode_WriteAppend (0x05)
 165
 166 #define seekmode_Start (0)
 167 #define seekmode_Current (1)
 168 #define seekmode_End (2)
 169
 170 #define stylehint_Indentation (0)
 171 #define stylehint_ParaIndentation (1)
 172 #define stylehint_Justification (2)
 173 #define stylehint_Size (3)
 174 #define stylehint_Weight (4)
 175 #define stylehint_Oblique (5)
 176 #define stylehint_Proportional (6)
 177 #define stylehint_TextColor (7)
 178 #define stylehint_BackColor (8)
 179 #define stylehint_ReverseColor (9)
 180 #define stylehint_NUMHINTS (10)
 181
 182 #define   stylehint_just_LeftFlush (0)
 183 #define   stylehint_just_LeftRight (1)
 184 #define   stylehint_just_Centered (2)
 185 #define   stylehint_just_RightFlush (3)
 186
 187 /* glk_main() is the top-level function which you define. The Glk library
 188  calls it. */
 189 extern void glk_main(void);
 190
 191 extern void glk_exit(void);
 192 extern void glk_set_interrupt_handler(void (*func)(void));
 193 extern void glk_tick(void);
 194
 195 extern glui32 glk_gestalt(glui32 sel, glui32 val);
 196 extern glui32 glk_gestalt_ext(glui32 sel, glui32 val, glui32 *arr,
 197                                                           glui32 arrlen);
 198
 199 extern unsigned char glk_char_to_lower(unsigned char ch);
 200 extern unsigned char glk_char_to_upper(unsigned char ch);
 201
 202 extern winid_t glk_window_get_root(void);
 203 extern winid_t glk_window_open(winid_t split, glui32 method, glui32 size,
 204                                                            glui32 wintype, glui32 rock);
 205 extern void glk_window_close(winid_t win, stream_result_t *result);
 206 extern void glk_window_get_size(winid_t win, glui32 *widthptr,
 207                                                                 glui32 *heightptr);
 208 extern void glk_window_set_arrangement(winid_t win, glui32 method,
 209                                                                            glui32 size, winid_t keywin);
 210 extern void glk_window_get_arrangement(winid_t win, glui32 *methodptr,
 211                                                                            glui32 *sizeptr, winid_t *keywinptr);
 212 extern winid_t glk_window_iterate(winid_t win, glui32 *rockptr);
 213 extern glui32 glk_window_get_rock(winid_t win);
 214 extern glui32 glk_window_get_type(winid_t win);
 215 extern winid_t glk_window_get_parent(winid_t win);
 216 extern winid_t glk_window_get_sibling(winid_t win);
 217 extern void glk_window_clear(winid_t win);
 218 extern void glk_window_move_cursor(winid_t win, glui32 xpos, glui32 ypos);
 219
 220 extern strid_t glk_window_get_stream(winid_t win);
 221 extern void glk_window_set_echo_stream(winid_t win, strid_t str);
 222 extern strid_t glk_window_get_echo_stream(winid_t win);
 223 extern void glk_set_window(winid_t win);
 224
 225 extern strid_t glk_stream_open_file(frefid_t fileref, glui32 fmode,
 226                                                                         glui32 rock);
 227 extern strid_t glk_stream_open_memory(char *buf, glui32 buflen, glui32 fmode,
 228                                                                           glui32 rock);
 229 extern void glk_stream_close(strid_t str, stream_result_t *result);
 230 extern strid_t glk_stream_iterate(strid_t str, glui32 *rockptr);
 231 extern glui32 glk_stream_get_rock(strid_t str);
 232 extern void glk_stream_set_position(strid_t str, glsi32 pos, glui32 seekmode);
 233 extern glui32 glk_stream_get_position(strid_t str);
 234 extern void glk_stream_set_current(strid_t str);
 235 extern strid_t glk_stream_get_current(void);
 236
 237 extern void glk_put_char(unsigned char ch);
 238 extern void glk_put_char_stream(strid_t str, unsigned char ch);
 239 extern void glk_put_string(char *s);
 240 extern void glk_put_string_stream(strid_t str, char *s);
 241 extern void glk_put_buffer(char *buf, glui32 len);
 242 extern void glk_put_buffer_stream(strid_t str, char *buf, glui32 len);
 243 extern void glk_set_style(glui32 styl);
 244 extern void glk_set_style_stream(strid_t str, glui32 styl);
 245
 246 extern glsi32 glk_get_char_stream(strid_t str);
 247 extern glui32 glk_get_line_stream(strid_t str, char *buf, glui32 len);
 248 extern glui32 glk_get_buffer_stream(strid_t str, char *buf, glui32 len);
 249
 250 extern void glk_stylehint_set(glui32 wintype, glui32 styl, glui32 hint,
 251                                                           glsi32 val);
 252 extern void glk_stylehint_clear(glui32 wintype, glui32 styl, glui32 hint);
 253 extern glui32 glk_style_distinguish(winid_t win, glui32 styl1, glui32 styl2);
 254 extern glui32 glk_style_measure(winid_t win, glui32 styl, glui32 hint,
 255                                                                 glui32 *result);
 256
 257 extern frefid_t glk_fileref_create_temp(glui32 usage, glui32 rock);
 258 extern frefid_t glk_fileref_create_by_name(glui32 usage, char *name,
 259                                                                                    glui32 rock);
 260 extern frefid_t glk_fileref_create_by_prompt(glui32 usage, glui32 fmode,
 261                                                                                          glui32 rock);
 262 extern frefid_t glk_fileref_create_from_fileref(glui32 usage, frefid_t fref,
 263                                                                                                 glui32 rock);
 264 extern void glk_fileref_destroy(frefid_t fref);
 265 extern frefid_t glk_fileref_iterate(frefid_t fref, glui32 *rockptr);
 266 extern glui32 glk_fileref_get_rock(frefid_t fref);
 267 extern void glk_fileref_delete_file(frefid_t fref);
 268 extern glui32 glk_fileref_does_file_exist(frefid_t fref);
 269
 270 extern void glk_select(event_t *event);
 271 extern void glk_select_poll(event_t *event);
 272
 273 extern void glk_request_timer_events(glui32 millisecs);
 274
 275 extern void glk_request_line_event(winid_t win, char *buf, glui32 maxlen,
 276                                                                    glui32 initlen);
 277 extern void glk_request_char_event(winid_t win);
 278 extern void glk_request_mouse_event(winid_t win);
 279
 280 extern void glk_cancel_line_event(winid_t win, event_t *event);
 281 extern void glk_cancel_char_event(winid_t win);
 282 extern void glk_cancel_mouse_event(winid_t win);
 283
 284 #ifdef GLK_MODULE_LINE_ECHO
 285 extern void glk_set_echo_line_event(winid_t win, glui32 val);
 286 #endif /* GLK_MODULE_LINE_ECHO */
 287
 288 #ifdef GLK_MODULE_LINE_TERMINATORS
 289 extern void glk_set_terminators_line_event(winid_t win, glui32 *keycodes,
 290                                                                                    glui32 count);
 291 #endif /* GLK_MODULE_LINE_TERMINATORS */
 292
 293 #ifdef GLK_MODULE_UNICODE
 294
 295 extern glui32 glk_buffer_to_lower_case_uni(glui32 *buf, glui32 len,
 296                                                                                    glui32 numchars);
 297 extern glui32 glk_buffer_to_upper_case_uni(glui32 *buf, glui32 len,
 298                                                                                    glui32 numchars);
 299 extern glui32 glk_buffer_to_title_case_uni(glui32 *buf, glui32 len,
 300                                                                                    glui32 numchars, glui32 lowerrest);
 301
 302 extern void glk_put_char_uni(glui32 ch);
 303 extern void glk_put_string_uni(glui32 *s);
 304 extern void glk_put_buffer_uni(glui32 *buf, glui32 len);
 305 extern void glk_put_char_stream_uni(strid_t str, glui32 ch);
 306 extern void glk_put_string_stream_uni(strid_t str, glui32 *s);
 307 extern void glk_put_buffer_stream_uni(strid_t str, glui32 *buf, glui32 len);
 308
 309 extern glsi32 glk_get_char_stream_uni(strid_t str);
 310 extern glui32 glk_get_buffer_stream_uni(strid_t str, glui32 *buf, glui32 len);
 311 extern glui32 glk_get_line_stream_uni(strid_t str, glui32 *buf, glui32 len);
 312
 313 extern strid_t glk_stream_open_file_uni(frefid_t fileref, glui32 fmode,
 314                                                                                 glui32 rock);
 315 extern strid_t glk_stream_open_memory_uni(glui32 *buf, glui32 buflen,
 316                                                                                   glui32 fmode, glui32 rock);
 317
 318 extern void glk_request_char_event_uni(winid_t win);
 319 extern void glk_request_line_event_uni(winid_t win, glui32 *buf,
 320                                                                            glui32 maxlen, glui32 initlen);
 321
 322 #endif /* GLK_MODULE_UNICODE */
 323
 324 #ifdef GLK_MODULE_UNICODE_NORM
 325
 326 extern glui32 glk_buffer_canon_decompose_uni(glui32 *buf, glui32 len,
 327                                                                                          glui32 numchars);
 328 extern glui32 glk_buffer_canon_normalize_uni(glui32 *buf, glui32 len,
 329                                                                                          glui32 numchars);
 330
 331 #endif /* GLK_MODULE_UNICODE_NORM */
 332
 333 #ifdef GLK_MODULE_IMAGE
 334
 335 #define imagealign_InlineUp (0x01)
 336 #define imagealign_InlineDown (0x02)
 337 #define imagealign_InlineCenter (0x03)
 338 #define imagealign_MarginLeft (0x04)
 339 #define imagealign_MarginRight (0x05)
 340
 341 extern glui32 glk_image_draw(winid_t win, glui32 image, glsi32 val1, glsi32 val2);
 342 extern glui32 glk_image_draw_scaled(winid_t win, glui32 image,
 343                                                                         glsi32 val1, glsi32 val2, glui32 width, glui32 height);
 344 extern glui32 glk_image_get_info(glui32 image, glui32 *width, glui32 *height);
 345
 346 extern void glk_window_flow_break(winid_t win);
 347
 348 extern void glk_window_erase_rect(winid_t win,
 349                                                                   glsi32 left, glsi32 top, glui32 width, glui32 height);
 350 extern void glk_window_fill_rect(winid_t win, glui32 color,
 351                                                                  glsi32 left, glsi32 top, glui32 width, glui32 height);
 352 extern void glk_window_set_background_color(winid_t win, glui32 color);
 353
 354 #endif /* GLK_MODULE_IMAGE */
 355
 356 #ifdef GLK_MODULE_SOUND
 357
 358 extern schanid_t glk_schannel_create(glui32 rock);
 359 extern void glk_schannel_destroy(schanid_t chan);
 360 extern schanid_t glk_schannel_iterate(schanid_t chan, glui32 *rockptr);
 361 extern glui32 glk_schannel_get_rock(schanid_t chan);
 362
 363 extern glui32 glk_schannel_play(schanid_t chan, glui32 snd);
 364 extern glui32 glk_schannel_play_ext(schanid_t chan, glui32 snd, glui32 repeats,
 365                                                                         glui32 notify);
 366 extern void glk_schannel_stop(schanid_t chan);
 367 extern void glk_schannel_set_volume(schanid_t chan, glui32 vol);
 368
 369 extern void glk_sound_load_hint(glui32 snd, glui32 flag);
 370
 371 #endif /* GLK_MODULE_SOUND */
 372
 373 #ifdef GLK_MODULE_HYPERLINKS
 374
 375 extern void glk_set_hyperlink(glui32 linkval);
 376 extern void glk_set_hyperlink_stream(strid_t str, glui32 linkval);
 377 extern void glk_request_hyperlink_event(winid_t win);
 378 extern void glk_cancel_hyperlink_event(winid_t win);
 379
 380 #endif /* GLK_MODULE_HYPERLINKS */
 381
 382 #ifdef GLK_MODULE_DATETIME
 383
 384 typedef struct glktimeval_struct {
 385     glsi32 high_sec;
 386     glui32 low_sec;
 387     glsi32 microsec;
 388 } glktimeval_t;
 389
 390 typedef struct glkdate_struct {
 391     glsi32 year;     /* full (four-digit) year */
 392     glsi32 month;    /* 1-12, 1 is January */
 393     glsi32 day;      /* 1-31 */
 394     glsi32 weekday;  /* 0-6, 0 is Sunday */
 395     glsi32 hour;     /* 0-23 */
 396     glsi32 minute;   /* 0-59 */
 397     glsi32 second;   /* 0-59, maybe 60 during a leap second */
 398     glsi32 microsec; /* 0-999999 */
 399 } glkdate_t;
 400
 401 extern void glk_current_time(glktimeval_t *time);
 402 extern glsi32 glk_current_simple_time(glui32 factor);
 403 extern void glk_time_to_date_utc(glktimeval_t *time, glkdate_t *date);
 404 extern void glk_time_to_date_local(glktimeval_t *time, glkdate_t *date);
 405 extern void glk_simple_time_to_date_utc(glsi32 time, glui32 factor,
 406                                                                                 glkdate_t *date);
 407 extern void glk_simple_time_to_date_local(glsi32 time, glui32 factor,
 408                                                                                   glkdate_t *date);
 409 extern void glk_date_to_time_utc(glkdate_t *date, glktimeval_t *time);
 410 extern void glk_date_to_time_local(glkdate_t *date, glktimeval_t *time);
 411 extern glsi32 glk_date_to_simple_time_utc(glkdate_t *date, glui32 factor);
 412 extern glsi32 glk_date_to_simple_time_local(glkdate_t *date, glui32 factor);
 413
 414 #endif /* GLK_MODULE_DATETIME */
 415
 416 #endif /* GLK_H */