#include "glkunix.h"
#include "init.h"
#include "magic.h"
+#include "style.h"
#define CHIMARA_GLK_MIN_WIDTH 0
#define CHIMARA_GLK_MIN_HEIGHT 0
* SECTION:chimara-glk
* @short_description: Widget which executes a Glk program
* @stability: Unstable
- * @include: chimara/chimara-glk.h
+ * @include: libchimara/chimara-glk.h
*
* The #ChimaraGlk widget opens and runs a Glk program. The program must be
* compiled as a plugin module, with a function <function>glk_main()</function>
* <ulink
* url="http://www.gnu.org/software/libtool/manual/html_node/Finding-the-dlname.html">
* Libtool manual</ulink>).
+ *
+ * You need to initialize multithreading in any program you use a #ChimaraGlk
+ * widget in. This means including the following incantation at the beginning
+ * of your program:
+ * |[
+ * if(!g_thread_supported())
+ * g_thread_init(NULL);
+ * gdk_threads_init();
+ * ]|
+ * This initialization must take place <emphasis>before</emphasis> the call to
+ * gtk_init(). In addition to this, you must also protect your call to
+ * gtk_main() by calling gdk_threads_enter() right before it, and
+ * gdk_threads_leave() right after it.
+ *
+ * The following sample program shows how to initialize and construct a simple
+ * GTK window that runs a Glk program:
+ * |[
+ * #include <glib.h>
+ * #include <gtk/gtk.h>
+ * #include <libchimara/chimara-glk.h>
+ *
+ * static gboolean
+ * quit(void)
+ * {
+ * gtk_main_quit();
+ * return TRUE;
+ * }
+ *
+ * int
+ * main(int argc, char *argv[])
+ * {
+ * GtkWidget *window, *glk;
+ * GError *error = NULL;
+ * gchar *plugin_argv[] = { "plugin.so", "-option" };
+ *
+ * /<!---->* Initialize threads and GTK *<!---->/
+ * if(!g_thread_supported())
+ * g_thread_init(NULL);
+ * gdk_threads_init();
+ * gtk_init(&argc, &argv);
+ *
+ * /<!---->* Construct the window and its contents. We quit the GTK main loop
+ * * when the window's close button is clicked. *<!---->/
+ * window = gtk_window_new(GTK_WINDOW_TOPLEVEL);
+ * g_signal_connect(window, "delete-event", G_CALLBACK(quit), NULL);
+ * glk = chimara_glk_new();
+ * gtk_container_add(GTK_CONTAINER(window), glk);
+ * gtk_widget_show_all(window);
+ *
+ * /<!---->* Start the Glk program in a separate thread *<!---->/
+ * if(!chimara_glk_run(CHIMARA_GLK(glk), "./plugin.so", 2, plugin_argv, &error))
+ * g_error("Error starting Glk library: %s\n", error->message);
+ *
+ * /<!---->* Start the GTK main loop *<!---->/
+ * gdk_threads_enter();
+ * gtk_main();
+ * gdk_threads_leave();
+ *
+ * /<!---->* After the GTK main loop exits, signal the Glk program to shut down if
+ * * it is still running, and wait for it to exit. *<!---->/
+ * chimara_glk_stop(CHIMARA_GLK(glk));
+ * chimara_glk_wait(CHIMARA_GLK(glk));
+ *
+ * return 0;
+ * }
+ * ]|
*/
typedef void (* glk_main_t) (void);
PROP_INTERACTIVE,
PROP_PROTECT,
PROP_SPACING,
+ PROP_PROGRAM_NAME,
+ PROP_PROGRAM_INFO,
+ PROP_STORY_NAME
};
enum {
CHAR_INPUT,
LINE_INPUT,
TEXT_BUFFER_OUTPUT,
+ ILIAD_SCREEN_UPDATE,
LAST_SIGNAL
};
priv->self = self;
priv->interactive = TRUE;
priv->protect = FALSE;
- priv->default_styles = g_new0(StyleSet,1);
- priv->current_styles = g_new0(StyleSet,1);
+ priv->styles = g_new0(StyleSet,1);
+ priv->glk_styles = g_new0(StyleSet,1);
priv->pager_attr_list = pango_attr_list_new();
priv->final_message = g_strdup("[ The game has finished ]");
priv->running = FALSE;
priv->resource_loaded = g_cond_new();
priv->resource_info_available = g_cond_new();
priv->image_cache = NULL;
+ priv->program_name = NULL;
+ priv->program_info = NULL;
+ priv->story_name = NULL;
priv->interrupt_handler = NULL;
priv->root_window = NULL;
priv->fileref_list = NULL;
case PROP_SPACING:
g_value_set_uint(value, priv->spacing);
break;
- default:
+ case PROP_PROGRAM_NAME:
+ g_value_set_string(value, priv->program_name);
+ break;
+ case PROP_PROGRAM_INFO:
+ g_value_set_string(value, priv->program_info);
+ break;
+ case PROP_STORY_NAME:
+ g_value_set_string(value, priv->story_name);
+ break;
+ default:
G_OBJECT_WARN_INVALID_PROPERTY_ID(object, prop_id, pspec);
}
}
/* Free widget properties */
g_free(priv->final_message);
/* Free styles */
- g_hash_table_destroy(priv->default_styles->text_buffer);
- g_hash_table_destroy(priv->default_styles->text_grid);
- g_hash_table_destroy(priv->current_styles->text_buffer);
- g_hash_table_destroy(priv->current_styles->text_grid);
+ g_hash_table_destroy(priv->styles->text_buffer);
+ g_hash_table_destroy(priv->styles->text_grid);
+ g_hash_table_destroy(priv->glk_styles->text_buffer);
+ g_hash_table_destroy(priv->glk_styles->text_grid);
pango_attr_list_unref(priv->pager_attr_list);
/* Free the event queue */
/* Free other stuff */
g_free(priv->current_dir);
+ g_free(priv->program_name);
+ g_free(priv->program_info);
+ g_free(priv->story_name);
/* Chain up to parent */
G_OBJECT_CLASS(chimara_glk_parent_class)->finalize(object);
{
CHIMARA_GLK_USE_PRIVATE(self, priv);
priv->running = FALSE;
+ priv->program_name = NULL;
+ g_object_notify(G_OBJECT(self), "program-name");
+ priv->program_info = NULL;
+ g_object_notify(G_OBJECT(self), "program-info");
+ priv->story_name = NULL;
+ g_object_notify(G_OBJECT(self), "story-name");
}
static void
/* Default signal handler */
}
+static void
+chimara_glk_iliad_screen_update(ChimaraGlk *self, gboolean typing)
+{
+ /* Default signal handler */
+}
+
/* COMPAT: G_PARAM_STATIC_STRINGS only appeared in GTK 2.13.0 */
#ifndef G_PARAM_STATIC_STRINGS
klass->char_input = chimara_glk_char_input;
klass->line_input = chimara_glk_line_input;
klass->text_buffer_output = chimara_glk_text_buffer_output;
+ klass->iliad_screen_update = chimara_glk_iliad_screen_update;
+
/**
* ChimaraGlk::stopped:
* @glk: The widget that received the signal
chimara_glk_signals[CHAR_INPUT] = g_signal_new("char-input",
G_OBJECT_CLASS_TYPE(klass), 0,
G_STRUCT_OFFSET(ChimaraGlkClass, char_input), NULL, NULL,
- chimara_marshal_VOID__UINT_UINT,
+ _chimara_marshal_VOID__UINT_UINT,
G_TYPE_NONE, 2, G_TYPE_UINT, G_TYPE_UINT);
/**
* ChimaraGlk::line-input:
chimara_glk_signals[LINE_INPUT] = g_signal_new("line-input",
G_OBJECT_CLASS_TYPE(klass), 0,
G_STRUCT_OFFSET(ChimaraGlkClass, line_input), NULL, NULL,
- chimara_marshal_VOID__UINT_STRING,
+ _chimara_marshal_VOID__UINT_STRING,
G_TYPE_NONE, 2, G_TYPE_UINT, G_TYPE_STRING);
/**
* ChimaraGlk::text-buffer-output:
chimara_glk_signals[TEXT_BUFFER_OUTPUT] = g_signal_new("text-buffer-output",
G_OBJECT_CLASS_TYPE(klass), 0,
G_STRUCT_OFFSET(ChimaraGlkClass, text_buffer_output), NULL, NULL,
- chimara_marshal_VOID__UINT_STRING,
+ _chimara_marshal_VOID__UINT_STRING,
G_TYPE_NONE, 2, G_TYPE_UINT, G_TYPE_STRING);
+ /**
+ * ChimaraGlk::iliad-update-screen:
+ * @self: The widget that received the signal
+ * @typing: Whether to perform a typing or full screen update
+ *
+ * Iliad specific signal which is emitted whenever the screen needs to be updated.
+ * Since iliad screen updates are very slow, updating should only be done when
+ * necessary.
+ */
+ chimara_glk_signals[ILIAD_SCREEN_UPDATE] = g_signal_new("iliad-screen-update",
+ G_OBJECT_CLASS_TYPE(klass), 0,
+ G_STRUCT_OFFSET(ChimaraGlkClass, iliad_screen_update), NULL, NULL,
+ _chimara_marshal_VOID__BOOLEAN,
+ G_TYPE_NONE, 1, G_TYPE_BOOLEAN);
/* Properties */
/**
*
* Sets whether the widget is interactive. A Glk widget is normally
* interactive, but in non-interactive mode, keyboard and mouse input are
- * ignored and the Glk program is controlled by chimara_glk_feed_text().
+ * ignored and the Glk program is controlled by
+ * chimara_glk_feed_char_input() and chimara_glk_feed_line_input().
* <quote>More</quote> prompts when a lot of text is printed to a text
* buffer are also disabled. This is typically used when you wish to control
* an interpreter program by feeding it a predefined list of commands.
0, G_MAXUINT, 0,
G_PARAM_READWRITE | G_PARAM_CONSTRUCT | G_PARAM_LAX_VALIDATION | G_PARAM_STATIC_STRINGS) );
- /* Private data */
+ /**
+ * ChimaraGlk:program-name:
+ *
+ * The name of the currently running Glk program. You cannot set this
+ * property yourself. It is set to the filename of the plugin when you call
+ * chimara_glk_run(), but the plugin can change it by calling
+ * garglk_set_program_name(). To find out when this information changes,
+ * for example to put the program name in the title bar of a window, connect
+ * to the <code>::notify::program-name</code> signal.
+ */
+ g_object_class_install_property(object_class, PROP_PROGRAM_NAME,
+ g_param_spec_string("program-name", _("Program name"),
+ _("Name of the currently running program"),
+ NULL,
+ G_PARAM_READABLE | G_PARAM_STATIC_STRINGS) );
+
+ /**
+ * ChimaraGlk:program-info:
+ *
+ * Information about the currently running Glk program. You cannot set this
+ * property yourself. The plugin can change it by calling
+ * garglk_set_program_info(). See also #ChimaraGlk:program-name.
+ */
+ g_object_class_install_property(object_class, PROP_PROGRAM_INFO,
+ g_param_spec_string("program-info", _("Program info"),
+ _("Information about the currently running program"),
+ NULL,
+ G_PARAM_READABLE | G_PARAM_STATIC_STRINGS) );
+
+ /**
+ * ChimaraGlk:story-name:
+ *
+ * The name of the story currently running in the Glk interpreter. You
+ * cannot set this property yourself. It is set to the story filename when
+ * you call chimara_if_run_game(), but the plugin can change it by calling
+ * garglk_set_story_name().
+ *
+ * Strictly speaking, this should be a property of #ChimaraIF, but it is
+ * legal for any Glk program to call garglk_set_story_name(), even if it is
+ * not an interpreter and does not load story files.
+ */
+ g_object_class_install_property(object_class, PROP_STORY_NAME,
+ g_param_spec_string("story-name", _("Story name"),
+ _("Name of the story currently loaded in the interpreter"),
+ NULL,
+ G_PARAM_READABLE | G_PARAM_STATIC_STRINGS) );
+
+ /* Private data */
g_type_class_add_private(klass, sizeof(ChimaraGlkPrivate));
}
* @glk: a #ChimaraGlk widget
*
* Resets the styles for text buffer and text grid windows to their defaults.
+ * <para><warning>
+ * This function is not implemented yet.
+ * </warning></para>
*/
void
chimara_glk_set_css_to_default(ChimaraGlk *glk)
* chimara_glk_set_css_from_file:
* @glk: a #ChimaraGlk widget
* @filename: path to a CSS file, or %NULL
- * @error: location to store a <link linkend="glib-GError">GError</link>, or
- * %NULL
+ * @error: location to store a <link
+ * linkend="glib-Error-Reporting">GError</link>, or %NULL
*
* Sets the styles for text buffer and text grid windows according to the CSS
* file @filename. Note that the styles are set cumulatively on top of whatever
scanner->input_name = filename;
scan_css_file(scanner, glk);
- /* Set the current style to a copy of the default style */
- /* FIXME this is not correct */
- copy_default_styles_to_current_styles(glk);
-
if(close(fd) == -1) {
*error = g_error_new(G_IO_ERROR, g_io_error_from_errno(errno),
_("Error closing file \"%s\": %s"), filename, g_strerror(errno));
/**
* chimara_glk_set_css_from_string:
* @glk: a #ChimaraGlk widget
- * @filename: a string containing CSS code
+ * @css: a string containing CSS code
*
- * Sets the styles for text buffer and text grid windows according to @css. Note
- * that the styles are set cumulatively on top of whatever the styles are at the
- * time this function is called; to reset the styles to their defaults, use
- * chimara_glk_set_css_to_default().
+ * Sets the styles for text buffer and text grid windows according to the CSS
+ * code @css. Note that the styles are set cumulatively on top of whatever the
+ * styles are at the time this function is called; to reset the styles to their
+ * defaults, use chimara_glk_set_css_to_default().
*/
void
chimara_glk_set_css_from_string(ChimaraGlk *glk, const gchar *css)
g_scanner_input_text(scanner, css, strlen(css));
scanner->input_name = "<string>";
scan_css_file(scanner, glk);
-
- /* Set the current style to a copy of the default style */
- /* FIXME this is not correct */
- copy_default_styles_to_current_styles(glk);
}
/**
* class="header">glk.h</filename>
* @argc: Number of command line arguments in @argv
* @argv: Array of command line arguments to pass to the plugin
- * @error: location to store a <link linkend="glib-GError">GError</link>, or
- * %NULL
+ * @error: location to store a <link
+ * linkend="glib-Error-Reporting">GError</link>, or %NULL
*
* Opens a Glk program compiled as a plugin. Sorts out its command line
* arguments from #glkunix_arguments, calls its startup function
startup->args.argv = g_new0(gchar *, 1);
}
- /* Set the program name */
+ /* Set the program invocation name */
startup->args.argv[0] = g_strdup(plugin);
}
startup->glk_data = priv;
+ /* Set the program name */
+ priv->program_name = g_path_get_basename(plugin);
+ g_object_notify(G_OBJECT(glk), "program-name");
+
/* Run in a separate thread */
priv->thread = g_thread_create((GThreadFunc)glk_enter, startup, TRUE, error);
g_async_queue_push(priv->line_input_queue, g_strdup(text));
event_throw(glk, evtype_ForcedLineInput, NULL, 0, 0);
}
+
+/**
+ * chimara_glk_get_tag:
+ * @glk: a #ChimarGlk widget
+ * @window: The type of window to retrieve the tag for
+ * @name: The name of the tag to retrieve
+ *
+ * Use this function to get a #GtkTextTag so style properties can be changed.
+ * See also #chimara_glk_set_css_from_string.
+ *
+ * The layout of the text in Chimara is controlled by two sets of tags: one set
+ * describing the style in text buffers and one for text grids. See also the
+ * GLK specification for the difference between the two. The main narrative of
+ * a game is usually rendered in text buffers, whereas text grids are mostly
+ * used for status bars and in game menus.
+ *
+ * The following tag names are supported:
+ * <itemizedlist>
+ * <listitem><para>normal</para></listitem>
+ * <listitem><para>emphasized</para></listitem>
+ * <listitem><para>preformatted</para></listitem>
+ * <listitem><para>header</para></listitem>
+ * <listitem><para>subheader</para></listitem>
+ * <listitem><para>alert</para></listitem>
+ * <listitem><para>note</para></listitem>
+ * <listitem><para>block-quote</para></listitem>
+ * <listitem><para>input</para></listitem>
+ * <listitem><para>user1</para></listitem>
+ * <listitem><para>user2</para></listitem>
+ * <listitem><para>hyperlink</para></listitem>
+ * <listitem><para>pager</para></listitem>
+ * </itenizedlist>
+ */
+GtkTextTag*
+chimara_glk_get_tag(ChimaraGlk *glk, ChimaraGlkWindowType window, const gchar *name)
+{
+ CHIMARA_GLK_USE_PRIVATE(glk, priv);
+
+ switch(window) {
+ case CHIMARA_GLK_TEXT_BUFFER:
+ return GTK_TEXT_TAG( g_hash_table_lookup(priv->styles->text_buffer, name) );
+ break;
+ case CHIMARA_GLK_TEXT_GRID:
+ return GTK_TEXT_TAG( g_hash_table_lookup(priv->styles->text_grid, name) );
+ break;
+ default:
+ ILLEGAL_PARAM("Unknown window type: %u", window);
+ return NULL;
+ }
+}
+
+/**
+ * chimara_glk_get_tag:
+ * @glk: a #ChimarGlk widget
+ *
+ * Retrieves the possible tag names to use in #chimara_glk_get_tag.
+ */
+const gchar**
+chimara_glk_get_tag_names(ChimaraGlk *glk)
+{
+ return style_get_tag_names();
+}
+
+/**
+ * chimara_glk_get_num_tag_names:
+ * @glk: a #ChimaraGlk widget
+ *
+ * Retrieves the number of style tags returned by #chimara_glk_get_tag_names.
+ */
+gint
+chimara_glk_get_num_tag_names(ChimaraGlk *glk)
+{
+ return CHIMARA_NUM_STYLES;
+}
+
+/**
+ * chimara_glk_update_style:
+ * @glk: a #ChimaraGlk widget
+ *
+ * Processes style updates and updates the widget to reflect the new style.
+ * Call this every time you change a property of a #GtkTextTag retrieved by
+ * #chimara_glk_get_tag.
+ */
+void
+chimara_glk_update_style(ChimaraGlk *glk)
+{
+ CHIMARA_GLK_USE_PRIVATE(glk, priv);
+ style_update(glk);
+
+ /* Schedule a redraw */
+ g_mutex_lock(priv->arrange_lock);
+ priv->needs_rearrange = TRUE;
+ priv->ignore_next_arrange_event = TRUE;
+ g_mutex_unlock(priv->arrange_lock);
+ gtk_widget_queue_resize( GTK_WIDGET(priv->self) );
+}
projects / rodin / chimara.git / blobdiff