/* licensing and copyright information here */
+#include <sys/types.h>
+#include <sys/stat.h>
+#include <fcntl.h>
+#include <unistd.h>
+#include <errno.h>
#include <math.h>
#include <gtk/gtk.h>
#include <config.h>
#include <glib/gi18n-lib.h>
#include <gmodule.h>
#include <pango/pango.h>
+#include <gio/gio.h>
#include "chimara-glk.h"
#include "chimara-glk-private.h"
#include "chimara-marshallers.h"
#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
*
* 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 GDK threading in any program you use a #ChimaraGlk
+ * widget in.
+ * This means calling gdk_threads_init() at the beginning of your program,
+ * <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>
+ *
+ * int
+ * main(int argc, char *argv[])
+ * {
+ * GtkWidget *window, *glk;
+ * GError *error = NULL;
+ * gchar *plugin_argv[] = { "plugin.so", "-option" };
+ *
+ * /<!---->* Initialize threads and GTK *<!---->/
+ * 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(gtk_main_quit), NULL);
+ * glk = chimara_glk_new();
+ * gtk_container_add(GTK_CONTAINER(window), glk);
+ * gtk_widget_show_all(window);
+ *
+ * /<!---->* Add a reference to the ChimaraGlk widget, since we want it to
+ * * persist after the window's delete-event -- otherwise it will be destroyed
+ * * with the window. *<!---->/
+ * g_object_ref(glk);
+ *
+ * /<!---->* 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));
+ * g_object_unref(glk);
+ *
+ * return 0;
+ * }
+ * ]|
*/
typedef void (* glk_main_t) (void);
PROP_0,
PROP_INTERACTIVE,
PROP_PROTECT,
- PROP_DEFAULT_FONT_DESCRIPTION,
- PROP_MONOSPACE_FONT_DESCRIPTION,
PROP_SPACING,
+ PROP_PROGRAM_NAME,
+ PROP_PROGRAM_INFO,
+ PROP_STORY_NAME,
+ PROP_RUNNING
};
enum {
CHAR_INPUT,
LINE_INPUT,
TEXT_BUFFER_OUTPUT,
+ ILIAD_SCREEN_UPDATE,
LAST_SIGNAL
};
static void
chimara_glk_init(ChimaraGlk *self)
{
- GTK_WIDGET_SET_FLAGS(GTK_WIDGET(self), GTK_NO_WINDOW);
+ chimara_init(); /* This is a library entry point */
+
+ gtk_widget_set_has_window(GTK_WIDGET(self), FALSE);
ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(self);
priv->self = self;
priv->interactive = TRUE;
- priv->protect = FALSE;
- priv->default_font_desc = pango_font_description_from_string("Serif");
- priv->monospace_font_desc = pango_font_description_from_string("Monospace");
- priv->css_file = NULL;
- priv->default_styles = g_new0(StyleSet,1);
- priv->current_styles = g_new0(StyleSet,1);
- priv->pager_attr_list = pango_attr_list_new();
- priv->style_initialized = FALSE;
+ priv->styles = g_new0(StyleSet,1);
+ priv->glk_styles = g_new0(StyleSet,1);
priv->final_message = g_strdup("[ The game has finished ]");
- priv->running = FALSE;
- priv->program = NULL;
- priv->thread = NULL;
priv->event_queue = g_queue_new();
- priv->event_lock = g_mutex_new();
- priv->event_queue_not_empty = g_cond_new();
- priv->event_queue_not_full = g_cond_new();
- priv->abort_lock = g_mutex_new();
- priv->abort_signalled = FALSE;
- priv->shutdown_lock = g_mutex_new();
- priv->shutdown_key_pressed = g_cond_new();
- priv->arrange_lock = g_mutex_new();
- priv->rearranged = g_cond_new();
- priv->needs_rearrange = FALSE;
- priv->ignore_next_arrange_event = FALSE;
- priv->char_input_queue = g_async_queue_new();
- priv->line_input_queue = g_async_queue_new();
- /* Should be g_async_queue_new_full(g_free); but only in GTK >= 2.16 */
- priv->resource_lock = g_mutex_new();
- priv->resource_loaded = g_cond_new();
- priv->resource_info_available = g_cond_new();
- priv->image_cache = NULL;
- priv->interrupt_handler = NULL;
- priv->root_window = NULL;
- priv->fileref_list = NULL;
- priv->current_stream = NULL;
- priv->stream_list = NULL;
- priv->timer_id = 0;
- priv->in_startup = FALSE;
- priv->current_dir = NULL;
+ priv->char_input_queue = g_async_queue_new_full(g_free);
+ priv->line_input_queue = g_async_queue_new_full(g_free);
+
+ g_mutex_init(&priv->event_lock);
+ g_mutex_init(&priv->abort_lock);
+ g_mutex_init(&priv->shutdown_lock);
+ g_mutex_init(&priv->arrange_lock);
+ g_mutex_init(&priv->resource_lock);
+
+ g_cond_init(&priv->event_queue_not_empty);
+ g_cond_init(&priv->event_queue_not_full);
+ g_cond_init(&priv->shutdown_key_pressed);
+ g_cond_init(&priv->rearranged);
+ g_cond_init(&priv->resource_loaded);
+ g_cond_init(&priv->resource_info_available);
+
+ style_init(self);
}
static void
case PROP_PROTECT:
chimara_glk_set_protect( glk, g_value_get_boolean(value) );
break;
- case PROP_DEFAULT_FONT_DESCRIPTION:
- chimara_glk_set_default_font_description( glk, (PangoFontDescription *)g_value_get_pointer(value) );
- break;
- case PROP_MONOSPACE_FONT_DESCRIPTION:
- chimara_glk_set_monospace_font_description( glk, (PangoFontDescription *)g_value_get_pointer(value) );
- break;
case PROP_SPACING:
chimara_glk_set_spacing( glk, g_value_get_uint(value) );
break;
case PROP_PROTECT:
g_value_set_boolean(value, priv->protect);
break;
- case PROP_DEFAULT_FONT_DESCRIPTION:
- g_value_set_pointer(value, priv->default_font_desc);
- break;
- case PROP_MONOSPACE_FONT_DESCRIPTION:
- g_value_set_pointer(value, priv->monospace_font_desc);
- break;
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;
+ case PROP_RUNNING:
+ g_value_set_boolean(value, priv->running);
+ break;
+ default:
G_OBJECT_WARN_INVALID_PROPERTY_ID(object, prop_id, pspec);
}
}
{
ChimaraGlk *self = CHIMARA_GLK(object);
CHIMARA_GLK_USE_PRIVATE(self, priv);
+ priv->after_finalize = TRUE;
/* Free widget properties */
- pango_font_description_free(priv->default_font_desc);
- pango_font_description_free(priv->monospace_font_desc);
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);
- pango_attr_list_unref(priv->pager_attr_list);
- priv->style_initialized = FALSE;
-
+ 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);
+
/* Free the event queue */
- g_mutex_lock(priv->event_lock);
+ g_mutex_lock(&priv->event_lock);
g_queue_foreach(priv->event_queue, (GFunc)g_free, NULL);
g_queue_free(priv->event_queue);
- g_cond_free(priv->event_queue_not_empty);
- g_cond_free(priv->event_queue_not_full);
+ g_cond_clear(&priv->event_queue_not_empty);
+ g_cond_clear(&priv->event_queue_not_full);
priv->event_queue = NULL;
- g_mutex_unlock(priv->event_lock);
- g_mutex_free(priv->event_lock);
+ g_mutex_unlock(&priv->event_lock);
+ g_mutex_clear(&priv->event_lock);
+
/* Free the abort signaling mechanism */
- g_mutex_lock(priv->abort_lock);
+ g_mutex_lock(&priv->abort_lock);
/* Make sure no other thread is busy with this */
- g_mutex_unlock(priv->abort_lock);
- g_mutex_free(priv->abort_lock);
- priv->abort_lock = NULL;
+ g_mutex_unlock(&priv->abort_lock);
+ g_mutex_clear(&priv->abort_lock);
+
/* Free the shutdown keypress signaling mechanism */
- g_mutex_lock(priv->shutdown_lock);
- g_cond_free(priv->shutdown_key_pressed);
- g_mutex_unlock(priv->shutdown_lock);
- priv->shutdown_lock = NULL;
+ g_mutex_lock(&priv->shutdown_lock);
+ g_cond_clear(&priv->shutdown_key_pressed);
+ g_mutex_unlock(&priv->shutdown_lock);
+ g_mutex_clear(&priv->shutdown_lock);
+
/* Free the window arrangement signaling */
- g_mutex_lock(priv->arrange_lock);
- g_cond_free(priv->rearranged);
- g_mutex_unlock(priv->arrange_lock);
- g_mutex_free(priv->arrange_lock);
- priv->arrange_lock = NULL;
- g_mutex_lock(priv->resource_lock);
- g_cond_free(priv->resource_loaded);
- g_cond_free(priv->resource_info_available);
- g_mutex_unlock(priv->resource_lock);
- g_mutex_free(priv->resource_lock);
+ g_mutex_lock(&priv->arrange_lock);
+ g_cond_clear(&priv->rearranged);
+ g_mutex_unlock(&priv->arrange_lock);
+ g_mutex_clear(&priv->arrange_lock);
+
+ g_mutex_lock(&priv->resource_lock);
+ g_cond_clear(&priv->resource_loaded);
+ g_cond_clear(&priv->resource_info_available);
+ g_mutex_unlock(&priv->resource_lock);
+ g_mutex_clear(&priv->resource_lock);
g_slist_foreach(priv->image_cache, (GFunc)clear_image_cache, NULL);
g_slist_free(priv->image_cache);
/* Unref input queues (this should destroy them since any Glk thread has stopped by now */
g_async_queue_unref(priv->char_input_queue);
g_async_queue_unref(priv->line_input_queue);
+ /* Destroy callback data if ownership retained */
+ if(priv->resource_load_callback_destroy_data)
+ priv->resource_load_callback_destroy_data(priv->resource_load_callback_data);
/* Free other stuff */
- if(priv->current_dir)
- g_free(priv->current_dir);
+ g_free(priv->current_dir);
+ g_free(priv->program_name);
+ g_free(priv->program_info);
+ g_free(priv->story_name);
+ g_free(priv->styles);
+ g_free(priv->glk_styles);
/* Chain up to parent */
G_OBJECT_CLASS(chimara_glk_parent_class)->finalize(object);
}
-/* Internal function: Recursively get the Glk window tree's size request */
+/* Implementation of get_request_mode(): Always request constant size */
+static GtkSizeRequestMode
+chimara_glk_get_request_mode(GtkWidget *widget)
+{
+ return GTK_SIZE_REQUEST_CONSTANT_SIZE;
+}
+
+/* Minimal implementation of width request. Allocation in Glk is
+strictly top-down, so we just request our current size by returning 1. */
static void
-request_recurse(winid_t win, GtkRequisition *requisition, guint spacing)
+chimara_glk_get_preferred_width(GtkWidget *widget, int *minimal, int *natural)
{
- if(win->type == wintype_Pair)
- {
- /* Get children's size requests */
- GtkRequisition child1, child2;
- request_recurse(win->window_node->children->data, &child1, spacing);
- request_recurse(win->window_node->children->next->data, &child2, spacing);
+ g_return_if_fail(widget || CHIMARA_IS_GLK(widget));
+ g_return_if_fail(minimal);
+ g_return_if_fail(natural);
- glui32 division = win->split_method & winmethod_DivisionMask;
- glui32 direction = win->split_method & winmethod_DirMask;
-
- /* If the split is fixed, get the size of the fixed child */
- if(division == winmethod_Fixed)
- {
- switch(direction)
- {
- case winmethod_Left:
- child1.width = win->key_window?
- win->constraint_size * win->key_window->unit_width
- : 0;
- break;
- case winmethod_Right:
- child2.width = win->key_window?
- win->constraint_size * win->key_window->unit_width
- : 0;
- break;
- case winmethod_Above:
- child1.height = win->key_window?
- win->constraint_size * win->key_window->unit_height
- : 0;
- break;
- case winmethod_Below:
- child2.height = win->key_window?
- win->constraint_size * win->key_window->unit_height
- : 0;
- break;
- }
- }
-
- /* Add the children's requests */
- switch(direction)
- {
- case winmethod_Left:
- case winmethod_Right:
- requisition->width = child1.width + child2.width + spacing;
- requisition->height = MAX(child1.height, child2.height);
- break;
- case winmethod_Above:
- case winmethod_Below:
- requisition->width = MAX(child1.width, child2.width);
- requisition->height = child1.height + child2.height + spacing;
- break;
- }
- }
-
- /* For non-pair windows, just use the size that GTK requests */
- else
- gtk_widget_size_request(win->frame, requisition);
+ *minimal = *natural = 1;
}
-/* Overrides gtk_widget_size_request */
+/* Minimal implementation of height request. Allocation in Glk is
+strictly top-down, so we just request our current size by returning 1. */
static void
-chimara_glk_size_request(GtkWidget *widget, GtkRequisition *requisition)
+chimara_glk_get_preferred_height(GtkWidget *widget, int *minimal, int *natural)
{
- g_return_if_fail(widget);
- g_return_if_fail(requisition);
- g_return_if_fail(CHIMARA_IS_GLK(widget));
-
- ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(widget);
-
- /* For now, just pass the size request on to the root Glk window */
- if(priv->root_window)
- {
- request_recurse(priv->root_window->data, requisition, priv->spacing);
- requisition->width += 2 * GTK_CONTAINER(widget)->border_width;
- requisition->height += 2 * GTK_CONTAINER(widget)->border_width;
- }
- else
- {
- requisition->width = CHIMARA_GLK_MIN_WIDTH + 2 * GTK_CONTAINER(widget)->border_width;
- requisition->height = CHIMARA_GLK_MIN_HEIGHT + 2 * GTK_CONTAINER(widget)->border_width;
- }
+ g_return_if_fail(widget || CHIMARA_IS_GLK(widget));
+ g_return_if_fail(minimal);
+ g_return_if_fail(natural);
+
+ *minimal = *natural = 1;
}
/* Recursively give the Glk windows their allocated space. Returns a window
{
glui32 division = win->split_method & winmethod_DivisionMask;
glui32 direction = win->split_method & winmethod_DirMask;
+ unsigned border = ((win->split_method & winmethod_BorderMask) == winmethod_NoBorder)? 0 : spacing;
/* If the space gets too small to honor the spacing property, then just
ignore spacing in this window and below. */
- if( (spacing > allocation->width && (direction == winmethod_Left || direction == winmethod_Right))
- || (spacing > allocation->height && (direction == winmethod_Above || direction == winmethod_Below)) )
- spacing = 0;
+ if( (border > allocation->width && (direction == winmethod_Left || direction == winmethod_Right))
+ || (border > allocation->height && (direction == winmethod_Above || direction == winmethod_Below)) )
+ border = 0;
GtkAllocation child1, child2;
child1.x = allocation->x;
{
case winmethod_Left:
child1.width = win->key_window?
- CLAMP(win->constraint_size * win->key_window->unit_width, 0, allocation->width - spacing)
+ CLAMP(win->constraint_size * win->key_window->unit_width, 0, allocation->width - border)
: 0;
break;
case winmethod_Right:
child2.width = win->key_window?
- CLAMP(win->constraint_size * win->key_window->unit_width, 0, allocation->width - spacing)
+ CLAMP(win->constraint_size * win->key_window->unit_width, 0, allocation->width - border)
: 0;
break;
case winmethod_Above:
child1.height = win->key_window?
- CLAMP(win->constraint_size * win->key_window->unit_height, 0, allocation->height - spacing)
+ CLAMP(win->constraint_size * win->key_window->unit_height, 0, allocation->height - border)
: 0;
break;
case winmethod_Below:
child2.height = win->key_window?
- CLAMP(win->constraint_size * win->key_window->unit_height, 0, allocation->height - spacing)
+ CLAMP(win->constraint_size * win->key_window->unit_height, 0, allocation->height - border)
: 0;
break;
}
switch(direction)
{
case winmethod_Left:
- child1.width = MAX(0, (gint)ceil(fraction * (allocation->width - spacing)) );
+ child1.width = MAX(0, (gint)ceil(fraction * (allocation->width - border)) );
break;
case winmethod_Right:
- child2.width = MAX(0, (gint)ceil(fraction * (allocation->width - spacing)) );
+ child2.width = MAX(0, (gint)ceil(fraction * (allocation->width - border)) );
break;
case winmethod_Above:
- child1.height = MAX(0, (gint)ceil(fraction * (allocation->height - spacing)) );
+ child1.height = MAX(0, (gint)ceil(fraction * (allocation->height - border)) );
break;
case winmethod_Below:
- child2.height = MAX(0, (gint)ceil(fraction * (allocation->height - spacing)) );
+ child2.height = MAX(0, (gint)ceil(fraction * (allocation->height - border)) );
break;
}
}
switch(direction)
{
case winmethod_Left:
- child2.width = MAX(0, allocation->width - spacing - child1.width);
- child2.x = child1.x + child1.width + spacing;
+ child2.width = MAX(0, allocation->width - border - child1.width);
+ child2.x = child1.x + child1.width + border;
child2.y = child1.y;
child1.height = child2.height = allocation->height;
break;
case winmethod_Right:
- child1.width = MAX(0, allocation->width - spacing - child2.width);
- child2.x = child1.x + child1.width + spacing;
+ child1.width = MAX(0, allocation->width - border - child2.width);
+ child2.x = child1.x + child1.width + border;
child2.y = child1.y;
child1.height = child2.height = allocation->height;
break;
case winmethod_Above:
- child2.height = MAX(0, allocation->height - spacing - child1.height);
+ child2.height = MAX(0, allocation->height - border - child1.height);
child2.x = child1.x;
- child2.y = child1.y + child1.height + spacing;
+ child2.y = child1.y + child1.height + border;
child1.width = child2.width = allocation->width;
break;
case winmethod_Below:
- child1.height = MAX(0, allocation->height - spacing - child2.height);
+ child1.height = MAX(0, allocation->height - border - child2.height);
child2.x = child1.x;
- child2.y = child1.y + child1.height + spacing;
+ child2.y = child1.y + child1.height + border;
child1.width = child2.width = allocation->width;
break;
}
/* It says in the spec that when a text grid window is resized smaller,
the bottom or right area is thrown away; when it is resized larger, the
bottom or right area is filled with blanks. */
- glui32 newwidth = (glui32)(win->widget->allocation.width / win->unit_width);
- glui32 newheight = (glui32)(win->widget->allocation.height / win->unit_height);
- gint line;
- GtkTextBuffer *textbuffer = gtk_text_view_get_buffer( GTK_TEXT_VIEW(win->widget) );
- GtkTextIter start, end;
-
- for(line = 0; line < win->height; line++)
+ GtkAllocation widget_allocation;
+ gtk_widget_get_allocation(win->widget, &widget_allocation);
+ glui32 new_width = (glui32)(widget_allocation.width / win->unit_width);
+ glui32 new_height = (glui32)(widget_allocation.height / win->unit_height);
+
+ if(new_width != win->width || new_height != win->height)
{
- gtk_text_buffer_get_iter_at_line(textbuffer, &start, line);
- /* If this line is going to fall off the bottom, delete it */
- if(line >= newheight)
- {
- end = start;
- gtk_text_iter_forward_to_line_end(&end);
- gtk_text_iter_forward_char(&end);
- gtk_text_buffer_delete(textbuffer, &start, &end);
- break;
+ // Window has changed size, trim or expand the textbuffer if necessary.
+ GtkTextBuffer *buffer = gtk_text_view_get_buffer( GTK_TEXT_VIEW(win->widget) );
+ GtkTextIter start, end;
+
+ // Add or remove lines
+ if(new_height == 0) {
+ gtk_text_buffer_get_start_iter(buffer, &start);
+ gtk_text_buffer_get_end_iter(buffer, &end);
+ gtk_text_buffer_delete(buffer, &start, &end);
}
- /* If this line is not long enough, add spaces on the end */
- if(newwidth > win->width)
+ else if(new_height < win->height)
{
- gchar *spaces = g_strnfill(newwidth - win->width, ' ');
+ // Remove surplus lines
+ gtk_text_buffer_get_end_iter(buffer, &end);
+ gtk_text_buffer_get_iter_at_line(buffer, &start, new_height-1);
gtk_text_iter_forward_to_line_end(&start);
- gtk_text_buffer_insert(textbuffer, &start, spaces, -1);
- g_free(spaces);
+ gtk_text_buffer_delete(buffer, &start, &end);
+
}
- /* But if it's too long, delete characters from the end */
- else if(newwidth < win->width)
+ else if(new_height > win->height)
{
+ // Add extra lines
+ gint lines_to_add = new_height - win->height;
+ gtk_text_buffer_get_end_iter(buffer, &end);
+ start = end;
+
+ gchar *blanks = g_strnfill(win->width, ' ');
+ gchar **blanklines = g_new0(gchar *, lines_to_add + 1);
+ int count;
+ for(count = 0; count < lines_to_add; count++)
+ blanklines[count] = blanks;
+ blanklines[lines_to_add] = NULL;
+ gchar *vertical_blanks = g_strjoinv("\n", blanklines);
+ g_free(blanklines);
+ g_free(blanks);
+
+ if(win->height > 0)
+ gtk_text_buffer_insert(buffer, &end, "\n", 1);
+
+ gtk_text_buffer_insert(buffer, &end, vertical_blanks, -1);
+ }
+
+ // Trim or expand lines
+ if(new_width < win->width) {
+ gtk_text_buffer_get_start_iter(buffer, &start);
+ end = start;
+
+ gint line;
+ for(line = 0; line <= new_height; line++) {
+ // Trim the line
+ gtk_text_iter_forward_cursor_positions(&start, new_width);
+ gtk_text_iter_forward_to_line_end(&end);
+ gtk_text_buffer_delete(buffer, &start, &end);
+ gtk_text_iter_forward_line(&start);
+ end = start;
+ }
+ } else if(new_width > win->width) {
+ gint chars_to_add = new_width - win->width;
+ gchar *horizontal_blanks = g_strnfill(chars_to_add, ' ');
+
+ gtk_text_buffer_get_start_iter(buffer, &start);
end = start;
- gtk_text_iter_forward_chars(&start, newwidth);
- gtk_text_iter_forward_to_line_end(&end);
- gtk_text_buffer_delete(textbuffer, &start, &end);
+
+ gint line;
+ for(line = 0; line <= new_height; line++) {
+ gtk_text_iter_forward_to_line_end(&start);
+ end = start;
+ gint start_offset = gtk_text_iter_get_offset(&start);
+ gtk_text_buffer_insert(buffer, &end, horizontal_blanks, -1);
+ gtk_text_buffer_get_iter_at_offset(buffer, &start, start_offset);
+ gtk_text_iter_forward_line(&start);
+ end = start;
+ }
+
+ g_free(horizontal_blanks);
}
- /* Note: if the widths are equal, do nothing */
- }
- /* Add blank lines if there aren't enough lines to fit the new size */
- if(newheight > win->height)
- {
- gchar *blanks = g_strnfill(win->width, ' ');
- gchar **blanklines = g_new0(gchar *, (newheight - win->height) + 1);
- int count;
- for(count = 0; count < newheight - win->height; count++)
- blanklines[count] = blanks;
- blanklines[newheight - win->height] = NULL;
- gchar *text = g_strjoinv("\n", blanklines);
- g_free(blanklines); /* not g_strfreev() */
- g_free(blanks);
-
- gtk_text_buffer_get_end_iter(textbuffer, &start);
- gtk_text_buffer_insert(textbuffer, &start, "\n", -1);
- gtk_text_buffer_insert(textbuffer, &start, text, -1);
- g_free(text);
}
- gboolean arrange = !(win->width == newwidth && win->height == newheight);
- win->width = newwidth;
- win->height = newheight;
+ gboolean arrange = !(win->width == new_width && win->height == new_height);
+ win->width = new_width;
+ win->height = new_height;
return arrange? win : NULL;
}
ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(widget);
- widget->allocation = *allocation;
-
+ gtk_widget_set_allocation(widget, allocation);
+
if(priv->root_window) {
- GtkAllocation child;
- child.x = allocation->x + GTK_CONTAINER(widget)->border_width;
- child.y = allocation->y + GTK_CONTAINER(widget)->border_width;
- child.width = CLAMP(allocation->width - 2 * GTK_CONTAINER(widget)->border_width, 0, allocation->width);
- child.height = CLAMP(allocation->height - 2 * GTK_CONTAINER(widget)->border_width, 0, allocation->height);
+ GtkAllocation child = *allocation;
winid_t arrange = allocate_recurse(priv->root_window->data, &child, priv->spacing);
-
+
/* arrange points to a window that contains all text grid and graphics
windows which have been resized */
- g_mutex_lock(priv->arrange_lock);
+ g_mutex_lock(&priv->arrange_lock);
if(!priv->ignore_next_arrange_event)
{
if(arrange)
else
priv->ignore_next_arrange_event = FALSE;
priv->needs_rearrange = FALSE;
- g_cond_signal(priv->rearranged);
- g_mutex_unlock(priv->arrange_lock);
+ g_cond_signal(&priv->rearranged);
+ g_mutex_unlock(&priv->arrange_lock);
}
}
{
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
priv->running = TRUE;
}
-static void
-chimara_glk_waiting(ChimaraGlk *self)
-{
- /* Default signal handler */
-}
-
-static void
-chimara_glk_char_input(ChimaraGlk *self, guint window_rock, guint keysym)
-{
- /* Default signal handler */
-}
-
-static void
-chimara_glk_line_input(ChimaraGlk *self, guint window_rock, gchar *text)
-{
- /* Default signal handler */
-}
-
-static void
-chimara_glk_text_buffer_output(ChimaraGlk *self, guint window_rock, gchar *text)
-{
- /* Default signal handler */
-}
-
-/* COMPAT: G_PARAM_STATIC_STRINGS only appeared in GTK 2.13.0 */
-#ifndef G_PARAM_STATIC_STRINGS
-
-/* COMPAT: G_PARAM_STATIC_NAME and friends only appeared in GTK 2.8 */
-#if GTK_CHECK_VERSION(2,8,0)
-#define G_PARAM_STATIC_STRINGS (G_PARAM_STATIC_NAME | G_PARAM_STATIC_NICK | G_PARAM_STATIC_BLURB)
-#else
-#define G_PARAM_STATIC_STRINGS (0)
-#endif
-
-#endif
-
static void
chimara_glk_class_init(ChimaraGlkClass *klass)
{
object_class->finalize = chimara_glk_finalize;
GtkWidgetClass *widget_class = GTK_WIDGET_CLASS(klass);
- widget_class->size_request = chimara_glk_size_request;
+ widget_class->get_request_mode = chimara_glk_get_request_mode;
+ widget_class->get_preferred_width = chimara_glk_get_preferred_width;
+ widget_class->get_preferred_height = chimara_glk_get_preferred_height;
widget_class->size_allocate = chimara_glk_size_allocate;
GtkContainerClass *container_class = GTK_CONTAINER_CLASS(klass);
container_class->forall = chimara_glk_forall;
+ /* Automatically handle the GtkContainer:border-width property */
+ gtk_container_class_handle_border_width(container_class);
/* Signals */
klass->stopped = chimara_glk_stopped;
klass->started = chimara_glk_started;
- klass->waiting = chimara_glk_waiting;
- klass->char_input = chimara_glk_char_input;
- klass->line_input = chimara_glk_line_input;
- klass->text_buffer_output = chimara_glk_text_buffer_output;
+
/**
* ChimaraGlk::stopped:
* @glk: The widget that received the signal
g_cclosure_marshal_VOID__VOID, G_TYPE_NONE, 0);
/**
* ChimaraGlk::char-input:
- * @glk: The widget that received the signal
+ * @self: The widget that received the signal
* @window_rock: The rock value of the window that received character input
* (see <link linkend="chimara-Rocks">Rocks</link>)
- * @keysym: The key that was typed, in the form of a key symbol from
+ * @window_id_string: A string value uniquely identifying the window that
+ * received character input
+ * @keysym: The key that was typed, in the form of a key symbol from
* <filename class="headerfile">gdk/gdkkeysyms.h</filename>
- *
+ *
* Emitted when a Glk window receives character input.
+ * The @window_rock can be used to identify the window.
+ * However, rock values in Glk are allowed to be identical for different
+ * windows, so Chimara also provides a string value with which the window
+ * can be uniquely identified.
*/
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,
- G_TYPE_NONE, 2, G_TYPE_UINT, G_TYPE_UINT);
+ _chimara_marshal_VOID__UINT_STRING_UINT,
+ G_TYPE_NONE, 3, G_TYPE_UINT, G_TYPE_STRING, G_TYPE_UINT);
/**
* ChimaraGlk::line-input:
- * @glk: The widget that received the signal
+ * @self: The widget that received the signal
* @window_rock: The rock value of the window that received line input (see
* <link linkend="chimara-Rocks">Rocks</link>)
+ * @window_id_string: A string value uniquely identifying the window that
+ * received the input
* @text: The text that was typed
- *
+ *
* Emitted when a Glk window receives line input.
+ * The @window_rock can be used to identify the window.
+ * However, rock values in Glk are allowed to be identical for different
+ * windows, so Chimara also provides a string value with which the window
+ * can be uniquely identified.
*/
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,
- G_TYPE_NONE, 2, G_TYPE_UINT, G_TYPE_STRING);
+ _chimara_marshal_VOID__UINT_STRING_STRING,
+ G_TYPE_NONE, 3, G_TYPE_UINT, G_TYPE_STRING, G_TYPE_STRING);
/**
* ChimaraGlk::text-buffer-output:
- * @glk: The widget that received the signal
+ * @self: The widget that received the signal
* @window_rock: The rock value of the window that was printed to (see <link
* linkend="chimara-Rocks">Rocks</link>)
- *
+ * @window_id_string: A string value uniquely identifying the window that
+ * was printed to
+ *
* Emitted when text is printed to a text buffer window.
+ * The @window_rock can be used to identify the window.
+ * However, rock values in Glk are allowed to be identical for different
+ * windows, so Chimara also provides a string value with which the window
+ * can be uniquely identified.
*/
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,
- G_TYPE_NONE, 2, G_TYPE_UINT, G_TYPE_STRING);
+ _chimara_marshal_VOID__UINT_STRING_STRING,
+ G_TYPE_NONE, 3, G_TYPE_UINT, G_TYPE_STRING, G_TYPE_STRING);
+ /**
+ * ChimaraGlk::iliad-screen-update:
+ * @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.
FALSE,
G_PARAM_READWRITE | G_PARAM_CONSTRUCT | G_PARAM_LAX_VALIDATION | G_PARAM_STATIC_STRINGS) );
- /* We can't use G_PARAM_CONSTRUCT on these because then the constructor will
- initialize them with NULL */
/**
- * ChimaraGlk:default-font-description:
- *
- * Pointer to a #PangoFontDescription describing the default proportional
- * font, to be used in text buffer windows for example.
+ * ChimaraGlk:spacing:
*
- * Default value: font description created from the string
- * <quote>Sans</quote>
+ * The amount of space between the Glk windows. This space forms a visible
+ * border between windows; however, if you open a window using the
+ * %winmethod_NoBorder flag, there will be no spacing between it and its
+ * sibling window, no matter what the value of this property is.
*/
- g_object_class_install_property(object_class, PROP_DEFAULT_FONT_DESCRIPTION,
- g_param_spec_pointer("default-font-description", _("Default Font"),
- _("Font description of the default proportional font"),
- G_PARAM_READWRITE | G_PARAM_LAX_VALIDATION | G_PARAM_STATIC_STRINGS) );
-
+ g_object_class_install_property(object_class, PROP_SPACING,
+ g_param_spec_uint("spacing", _("Spacing"),
+ _("The amount of space between Glk windows"),
+ 0, G_MAXUINT, 0,
+ G_PARAM_READWRITE | G_PARAM_CONSTRUCT | G_PARAM_LAX_VALIDATION | G_PARAM_STATIC_STRINGS) );
+
/**
- * ChimaraGlk:monospace-font-description:
+ * ChimaraGlk:program-name:
*
- * Pointer to a #PangoFontDescription describing the default monospace font,
- * to be used in text grid windows and %style_Preformatted, for example.
+ * 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:
*
- * Default value: font description created from the string
- * <quote>Monospace</quote>
+ * 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_MONOSPACE_FONT_DESCRIPTION,
- g_param_spec_pointer("monospace-font-description", _("Monospace Font"),
- _("Font description of the default monospace font"),
- G_PARAM_READWRITE | G_PARAM_LAX_VALIDATION | G_PARAM_STATIC_STRINGS) );
-
+ 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:spacing:
+ * ChimaraGlk:story-name:
*
- * The amount of space between the Glk windows.
+ * 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_SPACING,
- g_param_spec_uint("spacing", _("Spacing"),
- _("The amount of space between Glk windows"),
- 0, G_MAXUINT, 0,
- G_PARAM_READWRITE | G_PARAM_CONSTRUCT | G_PARAM_LAX_VALIDATION | G_PARAM_STATIC_STRINGS) );
+ 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 */
+ /**
+ * ChimaraGlk:running:
+ *
+ * Whether this Glk widget is currently running a game or not.
+ */
+ g_object_class_install_property(object_class, PROP_RUNNING,
+ g_param_spec_boolean("running", _("Running"),
+ _("Whether there is a program currently running"),
+ FALSE,
+ G_PARAM_READABLE | G_PARAM_STATIC_STRINGS) );
+
+ /* Private data */
g_type_class_add_private(klass, sizeof(ChimaraGlkPrivate));
}
}
/**
- * chimara_glk_set_default_font_description:
+ * chimara_glk_set_css_to_default:
* @glk: a #ChimaraGlk widget
- * @font: a #PangoFontDescription
*
- * Sets @glk's default proportional font. See
- * #ChimaraGlk:default-font-description.
+ * 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_default_font_description(ChimaraGlk *glk, PangoFontDescription *font)
+void
+chimara_glk_set_css_to_default(ChimaraGlk *glk)
{
- g_return_if_fail(glk || CHIMARA_IS_GLK(glk));
- g_return_if_fail(font);
-
- ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk);
- pango_font_description_free(priv->default_font_desc);
- priv->default_font_desc = pango_font_description_copy(font);
- g_object_notify(G_OBJECT(glk), "default-font-description");
- /* TODO: Apply the font description to all the windows and recalculate the sizes */
+ reset_default_styles(glk);
}
/**
- * chimara_glk_set_default_font_string:
+ * chimara_glk_set_css_from_file:
* @glk: a #ChimaraGlk widget
- * @font: string representation of a font description
+ * @filename: path to a CSS file, or %NULL
+ * @error: location to store a <link
+ * linkend="glib-Error-Reporting">GError</link>, or %NULL
*
- * Sets @glk's default proportional font according to the string @font, which
- * must be a string in the form <quote><replaceable>FAMILY-LIST</replaceable>
- * [<replaceable>STYLE-OPTIONS</replaceable>]
- * [<replaceable>SIZE</replaceable>]</quote>, such as <quote>Charter,Utopia
- * Italic 12</quote> or <quote>Sans</quote>. See
- * #ChimaraGlk:default-font-description.
- */
-void
-chimara_glk_set_default_font_string(ChimaraGlk *glk, const gchar *font)
-{
- g_return_if_fail(glk || CHIMARA_IS_GLK(glk));
- g_return_if_fail(font || *font);
-
- PangoFontDescription *fontdesc = pango_font_description_from_string(font);
- g_return_if_fail(fontdesc);
-
- ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk);
- pango_font_description_free(priv->default_font_desc);
- priv->default_font_desc = fontdesc;
- g_object_notify(G_OBJECT(glk), "default-font-description");
-
- /* TODO: Apply the font description to all the windows and recalculate the sizes */
-}
-
-/**
- * chimara_glk_get_default_font_description:
- * @glk: a #ChimaraGlk widget
- *
- * Returns @glk's default proportional font.
+ * 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
+ * the styles are at the time this function is called; to reset the styles to
+ * their defaults, use chimara_glk_set_css_to_default().
*
- * Return value: a newly-allocated #PangoFontDescription which must be freed
- * using pango_font_description_free(), or %NULL on error.
+ * Returns: %TRUE on success, %FALSE if an error occurred, in which case @error
+ * will be set.
*/
-PangoFontDescription *
-chimara_glk_get_default_font_description(ChimaraGlk *glk)
+gboolean
+chimara_glk_set_css_from_file(ChimaraGlk *glk, const gchar *filename, GError **error)
{
- g_return_val_if_fail(glk || CHIMARA_IS_GLK(glk), NULL);
-
- ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk);
- return pango_font_description_copy(priv->default_font_desc);
-}
+ g_return_val_if_fail(glk || CHIMARA_IS_GLK(glk), FALSE);
+ g_return_val_if_fail(filename, FALSE);
+ g_return_val_if_fail(error == NULL || *error == NULL, FALSE);
+
+ int fd = open(filename, O_RDONLY);
+ if(fd == -1) {
+ if(error)
+ *error = g_error_new(G_IO_ERROR, g_io_error_from_errno(errno),
+ _("Error opening file \"%s\": %s"), filename, g_strerror(errno));
+ return FALSE;
+ }
-/**
- * chimara_glk_set_monospace_font_description:
- * @glk: a #ChimaraGlk widget
- * @font: a #PangoFontDescription
- *
- * Sets @glk's default monospace font. See
- * #ChimaraGlk:monospace-font-description.
- */
-void
-chimara_glk_set_monospace_font_description(ChimaraGlk *glk, PangoFontDescription *font)
-{
- g_return_if_fail(glk || CHIMARA_IS_GLK(glk));
- g_return_if_fail(font);
-
- ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk);
- pango_font_description_free(priv->monospace_font_desc);
- priv->monospace_font_desc = pango_font_description_copy(font);
- g_object_notify(G_OBJECT(glk), "monospace-font-description");
-
- /* TODO: Apply the font description to all the windows and recalculate the sizes */
+ GScanner *scanner = create_css_file_scanner();
+ g_scanner_input_file(scanner, fd);
+ scanner->input_name = filename;
+ scan_css_file(scanner, glk);
+
+ if(close(fd) == -1) {
+ if(error)
+ *error = g_error_new(G_IO_ERROR, g_io_error_from_errno(errno),
+ _("Error closing file \"%s\": %s"), filename, g_strerror(errno));
+ return FALSE;
+ }
+ return TRUE;
}
/**
- * chimara_glk_set_monospace_font_string:
+ * chimara_glk_set_css_from_string:
* @glk: a #ChimaraGlk widget
- * @font: string representation of a font description
+ * @css: a string containing CSS code
*
- * Sets @glk's default monospace font according to the string @font, which must
- * be a string in the form <quote><replaceable>FAMILY-LIST</replaceable>
- * [<replaceable>STYLE-OPTIONS</replaceable>]
- * [<replaceable>SIZE</replaceable>]</quote>, such as <quote>Courier
- * Bold 12</quote> or <quote>Monospace</quote>. See
- * #ChimaraGlk:monospace-font-description.
+ * 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_monospace_font_string(ChimaraGlk *glk, const gchar *font)
+chimara_glk_set_css_from_string(ChimaraGlk *glk, const gchar *css)
{
g_return_if_fail(glk || CHIMARA_IS_GLK(glk));
- g_return_if_fail(font || *font);
-
- PangoFontDescription *fontdesc = pango_font_description_from_string(font);
- g_return_if_fail(fontdesc);
+ g_return_if_fail(css || *css);
- ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk);
- pango_font_description_free(priv->monospace_font_desc);
- priv->monospace_font_desc = fontdesc;
- g_object_notify(G_OBJECT(glk), "monospace-font-description");
-
- /* TODO: Apply the font description to all the windows and recalculate the sizes */
-}
-
-/**
- * chimara_glk_get_monospace_font_description:
- * @glk: a #ChimaraGlk widget
- *
- * Returns @glk's default monospace font.
- *
- * Return value: a newly-allocated #PangoFontDescription which must be freed
- * using pango_font_description_free(), or %NULL on error.
- */
-PangoFontDescription *
-chimara_glk_get_monospace_font_description(ChimaraGlk *glk)
-{
- g_return_val_if_fail(glk || CHIMARA_IS_GLK(glk), NULL);
-
- ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk);
- return pango_font_description_copy(priv->monospace_font_desc);
+ GScanner *scanner = create_css_file_scanner();
+ g_scanner_input_text(scanner, css, strlen(css));
+ scanner->input_name = "<string>";
+ scan_css_file(scanner, glk);
}
/**
ChimaraGlkPrivate *glk_data;
};
-/* glk_enter() is the actual function called in the new thread in which glk_main() runs. */
+static void
+free_startup_data(struct StartupData *startup)
+{
+ int i = 0;
+ while(i < startup->args.argc)
+ g_free(startup->args.argv[i++]);
+ g_free(startup->args.argv);
+ g_slice_free(struct StartupData, startup);
+}
+
+/* glk_enter() is the actual function called in the new thread in which
+glk_main() runs. Takes ownership of @startup and will free it. */
static gpointer
glk_enter(struct StartupData *startup)
{
- extern GPrivate *glk_data_key;
- g_private_set(glk_data_key, startup->glk_data);
-
+ extern GPrivate glk_data_key;
+ g_private_set(&glk_data_key, startup->glk_data);
+
/* Acquire the Glk thread's references to the input queues */
g_async_queue_ref(startup->glk_data->char_input_queue);
g_async_queue_ref(startup->glk_data->line_input_queue);
-
+
/* Run startup function */
if(startup->glkunix_startup_code) {
startup->glk_data->in_startup = TRUE;
int result = startup->glkunix_startup_code(&startup->args);
startup->glk_data->in_startup = FALSE;
-
- int i = 0;
- while(i < startup->args.argc)
- g_free(startup->args.argv[i++]);
- g_free(startup->args.argv);
-
- if(!result)
+
+ if(!result) {
+ free_startup_data(startup);
return NULL;
+ }
}
-
+
/* Run main function */
glk_main_t glk_main = startup->glk_main;
-
- /* COMPAT: avoid usage of slices */
- g_free(startup);
- g_signal_emit_by_name(startup->glk_data->self, "started");
+
+ g_signal_emit_by_name(startup->glk_data->self, "started");
glk_main();
+ free_startup_data(startup);
glk_exit(); /* Run shutdown code in glk_exit() even if glk_main() returns normally */
g_assert_not_reached(); /* because glk_exit() calls g_thread_exit() */
- return NULL;
+ return NULL;
}
/**
* 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
{
g_return_val_if_fail(glk || CHIMARA_IS_GLK(glk), FALSE);
g_return_val_if_fail(plugin, FALSE);
+ g_return_val_if_fail(error == NULL || *error == NULL, FALSE);
+
if(chimara_glk_get_running(glk)) {
g_set_error(error, CHIMARA_ERROR, CHIMARA_PLUGIN_ALREADY_RUNNING, _("There was already a plugin running."));
return FALSE;
ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk);
- /* COMPAT: avoid usage of slices */
- struct StartupData *startup = g_new0(struct StartupData,1);
-
+ struct StartupData *startup = g_slice_new0(struct StartupData);
+
g_assert( g_module_supported() );
/* If there is already a module loaded, free it first -- you see, we want to
* keep modules loaded as long as possible to avoid crashes in stack unwinding */
- if( priv->program && !g_module_close(priv->program) )
- g_warning( "Error closing module :%s", g_module_error() );
+ chimara_glk_unload_plugin(glk);
/* Open the module to run */
priv->program = g_module_open(plugin, G_MODULE_BIND_LAZY);
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");
+
+ /* Set Glk styles to defaults */
+ style_reset_glk(glk);
+
/* Run in a separate thread */
- priv->thread = g_thread_create((GThreadFunc)glk_enter, startup, TRUE, error);
-
+ priv->thread = g_thread_try_new("glk", (GThreadFunc)glk_enter, startup, error);
+
return !(priv->thread == NULL);
}
+/**
+ * chimara_glk_run_file:
+ * @self: a #ChimaraGlk widget
+ * @plugin_file: a #GFile pointing to a plugin module compiled with <filename
+ * 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-Error-Reporting">GError</link>, or %NULL
+ *
+ * Opens a Glk program compiled as a plugin, from a #GFile. See
+ * chimara_glk_run() for details.
+ *
+ * Return value: %TRUE if the Glk program was started successfully.
+ */
+gboolean
+chimara_glk_run_file(ChimaraGlk *self, GFile *plugin_file, int argc, char *argv[], GError **error)
+{
+ g_return_val_if_fail(self || CHIMARA_IS_GLK(self), FALSE);
+ g_return_val_if_fail(plugin_file || G_IS_FILE(plugin_file), FALSE);
+ g_return_val_if_fail(error == NULL || *error == NULL, FALSE);
+
+ char *path = g_file_get_path(plugin_file);
+ gboolean retval = chimara_glk_run(self, path, argc, argv, error);
+ g_free(path);
+
+ return retval;
+}
+
/**
* chimara_glk_stop:
* @glk: a #ChimaraGlk widget
* Signals the Glk program running in @glk to abort. Note that if the program is
* caught in an infinite loop in which glk_tick() is not called, this may not
* work.
+ *
+ * This function does nothing if no Glk program is running.
*/
void
chimara_glk_stop(ChimaraGlk *glk)
if(!priv->running)
return;
- if(priv->abort_lock) {
- g_mutex_lock(priv->abort_lock);
+ if(!priv->after_finalize) {
+ g_mutex_lock(&priv->abort_lock);
priv->abort_signalled = TRUE;
- g_mutex_unlock(priv->abort_lock);
+ g_mutex_unlock(&priv->abort_lock);
/* Stop blocking on the event queue condition */
event_throw(glk, evtype_Abort, NULL, 0, 0);
/* Stop blocking on the shutdown key press condition */
- g_mutex_lock(priv->shutdown_lock);
- g_cond_signal(priv->shutdown_key_pressed);
- g_mutex_unlock(priv->shutdown_lock);
+ g_mutex_lock(&priv->shutdown_lock);
+ g_cond_signal(&priv->shutdown_key_pressed);
+ g_mutex_unlock(&priv->shutdown_lock);
}
}
*
* Holds up the main thread and waits for the Glk program running in @glk to
* finish.
+ *
+ * This function does nothing if no Glk program is running.
*/
void
chimara_glk_wait(ChimaraGlk *glk)
gdk_threads_enter();
}
+/**
+ * chimara_glk_unload_plugin:
+ * @glk: a #ChimaraGlk widget
+ *
+ * The plugin containing the Glk program is unloaded as late as possible before
+ * loading a new plugin, in order to prevent crashes while printing stack
+ * backtraces during debugging. Sometimes this behavior is not desirable. This
+ * function forces @glk to unload the plugin running in it.
+ *
+ * This function does nothing if there is no plugin loaded.
+ */
+void
+chimara_glk_unload_plugin(ChimaraGlk *glk)
+{
+ g_return_if_fail(glk || CHIMARA_IS_GLK(glk));
+ CHIMARA_GLK_USE_PRIVATE(glk, priv);
+ if( priv->program && !g_module_close(priv->program) )
+ g_warning( "Error closing module :%s", g_module_error() );
+ priv->program = NULL;
+}
+
/**
* chimara_glk_get_running:
* @glk: a #ChimaraGlk widget
* request. @text does not need to end with a newline. You can call this
* function even when no window has requested line input, in which case the text
* will be saved for the following window that requests line input. This has the
- * disadvantage that if more than one window has requested character input, it
- * is arbitrary which one gets the text.
+ * disadvantage that if more than one window has requested line input, it is
+ * arbitrary which one gets the text.
*/
void
chimara_glk_feed_line_input(ChimaraGlk *glk, const gchar *text)
g_async_queue_push(priv->line_input_queue, g_strdup(text));
event_throw(glk, evtype_ForcedLineInput, NULL, 0, 0);
}
+
+/**
+ * chimara_glk_is_char_input_pending:
+ * @glk: a #ChimaraGlk widget
+ *
+ * Use this function to tell if character input forced by
+ * chimara_glk_feed_char_input() has been passed to an input request or not.
+ *
+ * Returns: %TRUE if forced character input is pending, %FALSE otherwise.
+ */
+gboolean
+chimara_glk_is_char_input_pending(ChimaraGlk *glk)
+{
+ g_return_val_if_fail(glk || CHIMARA_IS_GLK(glk), FALSE);
+ CHIMARA_GLK_USE_PRIVATE(glk, priv);
+ return g_async_queue_length(priv->char_input_queue) > 0;
+}
+
+/**
+ * chimara_glk_is_line_input_pending:
+ * @glk: a #ChimaraGlk widget
+ *
+ * Use this function to tell if line input forced by
+ * chimara_glk_feed_line_input() has been passed to an input request or not.
+ *
+ * Returns: %TRUE if forced line input is pending, %FALSE otherwise.
+ */
+gboolean
+chimara_glk_is_line_input_pending(ChimaraGlk *glk)
+{
+ g_return_val_if_fail(glk || CHIMARA_IS_GLK(glk), FALSE);
+ CHIMARA_GLK_USE_PRIVATE(glk, priv);
+ return g_async_queue_length(priv->line_input_queue) > 0;
+}
+
+/**
+ * chimara_glk_get_tag:
+ * @glk: a #ChimaraGlk 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>
+ * </itemizedlist>
+ *
+ * Returns: (transfer none): The #GtkTextTag corresponding to @name in the
+ * styles of @window.
+ */
+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_names:
+ * @glk: a #ChimaraGlk widget
+ * @num_tags: Return location for the number of tag names retrieved.
+ *
+ * Retrieves the possible tag names to use in chimara_glk_get_tag().
+ *
+ * Returns: (transfer none) (array length=num_tags) (element-type utf8):
+ * Array of strings containing the tag names. This array is owned by Chimara,
+ * do not free it.
+ */
+const gchar **
+chimara_glk_get_tag_names(ChimaraGlk *glk, unsigned int *num_tags)
+{
+ g_return_val_if_fail(num_tags != NULL, NULL);
+
+ *num_tags = CHIMARA_NUM_STYLES;
+ return style_get_tag_names();
+}
+
+/**
+ * chimara_glk_set_resource_load_callback:
+ * @glk: a #ChimaraGlk widget
+ * @func: a function to call for loading resources, or %NULL
+ * @user_data: user data to pass to @func, or %NULL
+ * @destroy_user_data: a function to call for freeing @user_data, or %NULL
+ *
+ * Sometimes it is preferable to load image and sound resources from somewhere
+ * else than a Blorb file, for example while developing a game. Section 14 of
+ * the <ulink url="http://eblong.com/zarf/blorb/blorb.html#s14">Blorb
+ * specification</ulink> allows for this possibility. This function sets @func
+ * to be called when the Glk program requests loading an image or sound without
+ * a Blorb resource map having been loaded, optionally passing @user_data as an
+ * extra parameter.
+ *
+ * Note that @func is only called if no Blorb resource map has been set; having
+ * a resource map in place overrides this function.
+ *
+ * If you pass non-%NULL for @destroy_user_data, then @glk takes ownership of
+ * @user_data. When it is not needed anymore, it will be freed by calling
+ * @destroy_user_data on it. If you wish to retain ownership of @user_data, pass
+ * %NULL for @destroy_user_data.
+ *
+ * To deactivate the callback, call this function with @func set to %NULL.
+ */
+void
+chimara_glk_set_resource_load_callback(ChimaraGlk *glk, ChimaraResourceLoadFunc func, gpointer user_data, GDestroyNotify destroy_user_data)
+{
+ CHIMARA_GLK_USE_PRIVATE(glk, priv);
+
+ if(priv->resource_load_callback == func
+ && priv->resource_load_callback_data == user_data
+ && priv->resource_load_callback_destroy_data == destroy_user_data)
+ return;
+
+ if(priv->resource_load_callback_destroy_data)
+ priv->resource_load_callback_destroy_data(priv->resource_load_callback_data);
+
+ priv->resource_load_callback = func;
+ priv->resource_load_callback_data = user_data;
+ priv->resource_load_callback_destroy_data = destroy_user_data;
+}
projects / projects / chimara / chimara.git / blobdiff