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.
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
21 extern char* garglk_fileref_get_name(frefid_t fref);
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);
28 This function is not implemented even in Gargoyle. Looks like it was planned,
30 extern void garglk_set_config(const char *name);
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);
41 * Z-machine color constant representing no color, i.e. transparency.
43 * <warning><para>Passing this constant to garglk_set_zcolors() or
44 * garglk_set_zcolors_stream() is not currently implemented.</para></warning>
46 #define zcolor_Transparent (-4)
50 * Z-machine color constant representing the color at the current position of
53 * <warning><para>Passing this constant to garglk_set_zcolors() or
54 * garglk_set_zcolors_stream() is not currently implemented.</para></warning>
56 #define zcolor_Cursor (-3)
60 * Z-machine color constant representing the current color.
62 #define zcolor_Current (-2)
66 * Z-machine color constant representing the default color.
68 #define zcolor_Default (-1)
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);
75 /* non standard keycodes */
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().
86 #define keycode_Erase (0xffffef7f)
88 * keycode_MouseWheelUp:
90 * This key code represents the mouse wheel scrolling up in a window. It is
91 * never used in Chimara.
93 #define keycode_MouseWheelUp (0xffffeffe)
95 * keycode_MouseWheelDown:
97 * This key code represents the mouse wheel scrolling down in a window. It is
98 * never used in Chimara.
100 #define keycode_MouseWheelDown (0xffffefff)
102 #endif /* __GARGLK_H__ */