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_unput_string() and garglk_unput_string_uni()) are not implemented.
14 * You can call them, but they will have no effect except to print a warning
20 extern char* garglk_fileref_get_name(frefid_t fref);
22 extern void garglk_set_program_name(const char *name);
23 extern void garglk_set_program_info(const char *info);
24 extern void garglk_set_story_name(const char *name);
25 extern void garglk_set_story_title(const char *title);
27 This function is not implemented even in Gargoyle. Looks like it was planned,
29 extern void garglk_set_config(const char *name);
32 /* garglk_unput_string - removes the specified string from the end of the output buffer, if
33 * indeed it is there. */
34 extern void garglk_unput_string(char *str);
35 extern void garglk_unput_string_uni(glui32 *str);
40 * Z-machine color constant representing no color, i.e. transparency.
42 * <warning><para>Passing this constant to garglk_set_zcolors() or
43 * garglk_set_zcolors_stream() is not currently implemented.</para></warning>
45 #define zcolor_Transparent (-4)
49 * Z-machine color constant representing the color at the current position of
52 * <warning><para>Passing this constant to garglk_set_zcolors() or
53 * garglk_set_zcolors_stream() is not currently implemented.</para></warning>
55 #define zcolor_Cursor (-3)
59 * Z-machine color constant representing the current color.
61 #define zcolor_Current (-2)
65 * Z-machine color constant representing the default color.
67 #define zcolor_Default (-1)
69 extern void garglk_set_zcolors(glui32 fg, glui32 bg);
70 extern void garglk_set_zcolors_stream(strid_t str, glui32 fg, glui32 bg);
71 extern void garglk_set_reversevideo(glui32 reverse);
72 extern void garglk_set_reversevideo_stream(strid_t str, glui32 reverse);
74 /* non standard keycodes */
78 * Since %keycode_Delete represents either the <keycap>Delete</keycap> or
79 * <keycap>Backspace</keycap> key, Gargoyle defines a separate constant
80 * %keycode_Erase to represent <emphasis>only</emphasis> the
81 * <keycap>Delete</keycap> key. In character input, <keycap>Delete</keycap> is
82 * still reported as %keycode_Delete, but the two are distinguished in
83 * glk_set_terminators_line_event().
85 #define keycode_Erase (0xffffef7f)
87 * keycode_MouseWheelUp:
89 * This key code represents the mouse wheel scrolling up in a window. It is
90 * never used in Chimara.
92 #define keycode_MouseWheelUp (0xffffeffe)
94 * keycode_MouseWheelDown:
96 * This key code represents the mouse wheel scrolling down in a window. It is
97 * never used in Chimara.
99 #define keycode_MouseWheelDown (0xffffefff)
101 #endif /* __GARGLK_H__ */