Change I/O signals to pass a unique window ID

[projects/chimara/chimara.git] / libchimara / chimara-glk.h

diff --git a/libchimara/chimara-glk.h b/libchimara/chimara-glk.h
index f4d9eddc0784f4dc27272e76ec48f17458af6d8b..953f84ee0eddd6f63b2af2fa0e89090708435ba0 100644 (file)
--- a/libchimara/chimara-glk.h
+++ b/libchimara/chimara-glk.h
@@ -21,24 +21,32 @@ G_BEGIN_DECLS
  * 
  * This structure contains no public members.
  */
-typedef struct _ChimaraGlk {
+typedef struct {
        GtkContainer parent_instance;
     
        /*< public >*/
 } ChimaraGlk;
 
-typedef struct _ChimaraGlkClass {
+typedef struct {
        GtkContainerClass parent_class;
        /* Signals */
        void(* stopped) (ChimaraGlk *self);
        void(* started) (ChimaraGlk *self);
        void(* waiting) (ChimaraGlk *self);
-       void(* char_input) (ChimaraGlk *self, guint32 window_rock, guint keysym);
-       void(* line_input) (ChimaraGlk *self, guint32 window_rock, gchar *text);
-       void(* text_buffer_output) (ChimaraGlk *self, guint32 window_rock, gchar *text);
+       void(* char_input) (ChimaraGlk *self, guint32 window_rock, char *string_id, unsigned keysym);
+       void(* line_input) (ChimaraGlk *self, guint32 window_rock, char *string_id, char *text);
+       void(* text_buffer_output) (ChimaraGlk *self, guint32 window_rock, char *string_id, char *text);
        void(* iliad_screen_update) (ChimaraGlk *self, gboolean typing);
 } ChimaraGlkClass;
 
+/**
+ * ChimaraGlkWindowType:
+ * @CHIMARA_GLK_TEXT_BUFFER: The styles for text buffer windows.
+ * @CHIMARA_GLK_TEXT_GRID: The styles for text grid windows.
+ *
+ * Specifies the type of windows for which to retrieve the style tag with
+ * chimara_glk_get_tag().
+ */
 typedef enum {
        CHIMARA_GLK_TEXT_BUFFER,
        CHIMARA_GLK_TEXT_GRID
@@ -66,6 +74,34 @@ typedef enum _ChimaraError {
        CHIMARA_PLUGIN_ALREADY_RUNNING
 } ChimaraError;
 
+/**
+ * ChimaraResourceType:
+ * @CHIMARA_RESOURCE_SOUND: A sound file.
+ * @CHIMARA_RESOURCE_IMAGE: An image file.
+ *
+ * The type of resource that the Glk program is requesting, passed to a
+ * #ChimaraResourceLoadFunc.
+ */
+typedef enum _ChimaraResourceType {
+       CHIMARA_RESOURCE_SOUND,
+       CHIMARA_RESOURCE_IMAGE
+} ChimaraResourceType;
+
+/**
+ * ChimaraResourceLoadFunc:
+ * @usage: A #ChimaraResourceType constant.
+ * @resnum: The resource number to look for.
+ * @user_data: A pointer to provide to the callback.
+ *
+ * The type of function passed to chimara_glk_set_resource_load_callback(). It
+ * takes a #ChimaraResourceType constant, @usage, to indicate what sort of 
+ * resource to look for; @resnum is the resource number to look for, and
+ * @user_data is the user data provided along with the callback. The function
+ * must return an allocated string containing the filename where the resource
+ * can be found.
+ */
+typedef gchar * (*ChimaraResourceLoadFunc)(ChimaraResourceType usage, guint32 resnum, gpointer user_data);
+
 /**
  * CHIMARA_ERROR:
  *
@@ -86,17 +122,19 @@ void chimara_glk_set_css_from_string(ChimaraGlk *glk, const gchar *css);
 void chimara_glk_set_spacing(ChimaraGlk *glk, guint spacing);
 guint chimara_glk_get_spacing(ChimaraGlk *glk);
 gboolean chimara_glk_run(ChimaraGlk *glk, const gchar *plugin, int argc, char *argv[], GError **error);
+gboolean chimara_glk_run_file(ChimaraGlk *self, GFile *plugin_file, int argc, char *argv[], GError **error);
 void chimara_glk_stop(ChimaraGlk *glk);
 void chimara_glk_wait(ChimaraGlk *glk);
+void chimara_glk_unload_plugin(ChimaraGlk *glk);
 gboolean chimara_glk_get_running(ChimaraGlk *glk);
 void chimara_glk_feed_char_input(ChimaraGlk *glk, guint32 keyval);
 void chimara_glk_feed_line_input(ChimaraGlk *glk, const gchar *text);
 gboolean chimara_glk_is_char_input_pending(ChimaraGlk *glk);
 gboolean chimara_glk_is_line_input_pending(ChimaraGlk *glk);
 GtkTextTag *chimara_glk_get_tag(ChimaraGlk *glk, ChimaraGlkWindowType window, const gchar *name);
-const gchar **chimara_glk_get_tag_names(ChimaraGlk *glk);
-gint chimara_glk_get_num_tag_names(ChimaraGlk *glk);
+const gchar **chimara_glk_get_tag_names(ChimaraGlk *glk, unsigned int *num_tags);
 void chimara_glk_update_style(ChimaraGlk *glk);
+void chimara_glk_set_resource_load_callback(ChimaraGlk *glk, ChimaraResourceLoadFunc func, gpointer user_data, GDestroyNotify destroy_user_data);
 
 G_END_DECLS