libchimara/garglk.h

   1 #ifndef __GARGLK_H__
   2 #define __GARGLK_H__
   3
   4 /**
   5  * GARGLK:
   6  *
   7  * To test at compile time whether the Gargoyle extensions are available, you
   8  * can perform a preprocessor test for the existence of %GARGLK. If this
   9  * macro is defined, then so are all the Gargoyle extensions. If not, not.
  10  *
  11  * <note><title>Chimara</title><para>
  12  *   Currently, in Chimara, the functions are defined, but a few of them
  13  *   (garglk_set_line_terminators(),
  14  *   garglk_unput_string(), and garglk_unput_string_uni()) are not implemented.
  15  *   You can call them, but they will have no effect except to print a warning
  16  *   to the console.
  17  * </para></note>
  18  */
  19 #define GARGLK 1
  20
  21 extern char* garglk_fileref_get_name(frefid_t fref);
  22
  23 extern void garglk_set_program_name(const char *name);
  24 extern void garglk_set_program_info(const char *info);
  25 extern void garglk_set_story_name(const char *name);
  26 extern void garglk_set_story_title(const char *title);
  27 /*
  28  This function is not implemented even in Gargoyle. Looks like it was planned,
  29  but never added.
  30 extern void garglk_set_config(const char *name);
  31 */
  32
  33 /* garglk_unput_string - removes the specified string from the end of the output buffer, if
  34  * indeed it is there. */
  35 extern void garglk_unput_string(char *str);
  36 extern void garglk_unput_string_uni(glui32 *str);
  37
  38 /**
  39  * zcolor_Transparent:
  40  *
  41  * Z-machine color constant representing no color, i.e. transparency.
  42  *
  43  * <warning><para>Passing this constant to garglk_set_zcolors() or
  44  * garglk_set_zcolors_stream() is not currently implemented.</para></warning>
  45  */
  46 #define zcolor_Transparent   (-4)
  47 /**
  48  * zcolor_Cursor:
  49  *
  50  * Z-machine color constant representing the color at the current position of
  51  * the cursor.
  52  *
  53  * <warning><para>Passing this constant to garglk_set_zcolors() or
  54  * garglk_set_zcolors_stream() is not currently implemented.</para></warning>
  55  */
  56 #define zcolor_Cursor        (-3)
  57 /**
  58  * zcolor_Current:
  59  *
  60  * Z-machine color constant representing the current color.
  61  */
  62 #define zcolor_Current       (-2)
  63 /**
  64  * zcolor_Default:
  65  *
  66  * Z-machine color constant representing the default color.
  67  */
  68 #define zcolor_Default       (-1)
  69
  70 extern void garglk_set_zcolors(glui32 fg, glui32 bg);
  71 extern void garglk_set_zcolors_stream(strid_t str, glui32 fg, glui32 bg);
  72 extern void garglk_set_reversevideo(glui32 reverse);
  73 extern void garglk_set_reversevideo_stream(strid_t str, glui32 reverse);
  74
  75 /* non standard keycodes */
  76 /**
  77  * keycode_Erase:
  78  *
  79  * Since %keycode_Delete represents either the <keycap>Delete</keycap> or
  80  * <keycap>Backspace</keycap> key, Gargoyle defines a separate constant
  81  * %keycode_Erase to represent <emphasis>only</emphasis> the
  82  * <keycap>Delete</keycap> key. In character input, <keycap>Delete</keycap> is
  83  * still reported as %keycode_Delete, but the two are distinguished in
  84  * glk_set_terminators_line_event().
  85  */
  86 #define keycode_Erase    (0xffffef7f)
  87 /**
  88  * keycode_MouseWheelUp:
  89  *
  90  * This key code represents the mouse wheel scrolling up in a window. It is
  91  * never used in Chimara.
  92  */
  93 #define keycode_MouseWheelUp        (0xffffeffe)
  94 /**
  95  * keycode_MouseWheelDown:
  96  *
  97  * This key code represents the mouse wheel scrolling down in a window. It is
  98  * never used in Chimara.
  99  */
 100 #define keycode_MouseWheelDown      (0xffffefff)
 101
 102 #endif /* __GARGLK_H__ */