From: Philip Chimento Date: Wed, 20 May 2009 23:10:48 +0000 (+0000) Subject: - In the documentation, replaced by |[...]| for... X-Git-Url: https://git.stderr.nl/gitweb?a=commitdiff_plain;ds=inline;h=e962e1889909fd7c4e89b8f613d15457987bcbc6;p=rodin%2Fchimara.git - In the documentation, replaced by |[...]| for readability. - Removed mouse pointer from fig11.png. git-svn-id: http://lassie.dyndns-server.com/svn/gargoyle-gtk@58 ddfedd41-794f-dd11-ae45-00112f111e67 --- diff --git a/docs/reference/images/fig11.png b/docs/reference/images/fig11.png index 04baff6..b763c70 100644 Binary files a/docs/reference/images/fig11.png and b/docs/reference/images/fig11.png differ diff --git a/src/chimara-glk.c b/src/chimara-glk.c index 3e2dabe..7ad1f81 100644 --- a/src/chimara-glk.c +++ b/src/chimara-glk.c @@ -27,11 +27,11 @@ * On Linux systems, this is a file with a name like * plugin.so. For portability, you can use libtool and * automake: - * + * |[ * pkglib_LTLIBRARIES = plugin.la * plugin_la_SOURCES = plugin.c foo.c bar.c * plugin_la_LDFLAGS = -module -shared -avoid-version -export-symbols-regex "^glk_main$$" - * + * ]| * This will produce plugin.la which is a text file * containing the correct plugin file to open (see the relevant section of the * * For each class of opaque objects, there is an iterate function, which you can * use to obtain a list of all existing objects of that class. It takes the form - * + * |[ * CLASSid_t glk_CLASS_iterate(CLASSid_t obj, #glui32 *rockptr); - * + * ]| * ...where CLASS represents one of the * opaque object classes. * @@ -202,13 +202,13 @@ * * * You usually use this as follows: - * + * |[ * obj = glk_CLASS_iterate(NULL, NULL); * while (obj) { * /* ...do something with obj... */ * obj = glk_CLASS_iterate(obj, NULL); * } - * + * ]| * * * If you create or destroy objects inside this loop, obviously, the results are @@ -772,10 +772,10 @@ * * For an example of the gestalt mechanism, consider the selector * #gestalt_Version. If you do - * + * |[ * #glui32 res; * res = #glk_gestalt(#gestalt_Version, 0); - * + * ]| * res will be set to a 32-bit number which encodes the version of * the Glk spec which the library implements. The upper 16 bits stores the major * version number; the next 8 bits stores the minor version number; the low 8 @@ -788,10 +788,10 @@ * The current Glk specification version is 0.7.0, so this selector will return * 0x00000700. * - * + * |[ * #glui32 res; * res = #glk_gestalt_ext(#gestalt_Version, 0, NULL, 0); - * + * ]| * does exactly the same thing. Note that, in either case, the second argument * is not used; so you should always pass 0 to avoid future surprises. */ @@ -801,10 +801,10 @@ * * If you set ch to a character code, or a special code (from * 0xFFFFFFFF down), and call - * + * |[ * #glui32 res; * res = #glk_gestalt(#gestalt_CharInput, ch); - * + * ]| * then res will be %TRUE (1) if that character can be typed by * the player in character input, and %FALSE (0) if not. See Character Input. @@ -814,10 +814,10 @@ * gestalt_LineInput: * * If you set ch to a character code, and call - * + * |[ * #glui32 res; * res = #glk_gestalt(#gestalt_LineInput, ch); - * + * ]| * then res will be %TRUE (1) if that character can be typed by the * player in line input, and %FALSE (0) if not. Note that if ch is * a nonprintable Latin-1 character (0 to 31, 127 to 159), then this is @@ -829,10 +829,10 @@ * gestalt_CharOutput: * * If you set ch to a character code (Latin-1 or higher), and call - * + * |[ * #glui32 res, len; * res = #glk_gestalt_ext(#gestalt_CharOutput, ch, &len, 1); - * + * ]| * then res will be one of #gestalt_CharOutput_CannotPrint, * #gestalt_CharOutput_ExactPrint, or #gestalt_CharOutput_ApproxPrint (see * below.) @@ -859,15 +859,11 @@ * Make sure you do not get confused by signed byte values. If you set a * char variable ch to 0xFE, the * small-thorn character (þ), and then call - * - * res = #glk_gestalt(#gestalt_CharOutput, ch); - * + * |[ res = #glk_gestalt(#gestalt_CharOutput, ch); ]| * then (by the definition of C/C++) ch will be sign-extended to * 0xFFFFFFFE, which is not a legitimate character, even in Unicode. You * should write - * - * res = #glk_gestalt(#gestalt_CharOutput, (unsigned char)ch); - * + * |[ res = #glk_gestalt(#gestalt_CharOutput, (unsigned char)ch); ]| * instead. * * @@ -915,10 +911,10 @@ * The basic text functions will be available in every Glk library. The Unicode * functions may or may not be available. Before calling them, you should use * the following gestalt selector: - * + * |[ * glui32 res; * res = #glk_gestalt(#gestalt_Unicode, 0); - * + * ]| * * This returns 1 if the Unicode functions are available. If it returns 0, you * should not try to call them. They may print nothing, print gibberish, or diff --git a/src/main.c b/src/main.c index 496f1b2..c34e4c5 100644 --- a/src/main.c +++ b/src/main.c @@ -118,7 +118,7 @@ main(int argc, char *argv[]) g_object_unref( G_OBJECT(builder) ); - if( !chimara_glk_run(CHIMARA_GLK(glk), ".libs/splittest.so", &error) ) { + if( !chimara_glk_run(CHIMARA_GLK(glk), ".libs/first.so", &error) ) { error_dialog(GTK_WINDOW(window), error, "Error starting Glk library: "); return 1; } diff --git a/src/stream.c b/src/stream.c index 358d06b..42d77ba 100644 --- a/src/stream.c +++ b/src/stream.c @@ -154,10 +154,10 @@ glk_put_char_uni(glui32 ch) * * Prints a null-terminated string to the current stream. It is exactly * equivalent to - * + * |[ * for (ptr = @s; *ptr; ptr++) * #glk_put_char(*ptr); - * + * ]| * However, it may be more efficient. */ void @@ -189,10 +189,10 @@ glk_put_string_uni(glui32 *s) * * Prints a block of characters to the current stream. It is exactly equivalent * to: - * + * |[ * for (i = 0; i < @len; i++) * #glk_put_char(@buf[i]); - * + * ]| * However, it may be more efficient. */ void diff --git a/src/window.c b/src/window.c index cd0961c..719816f 100644 --- a/src/window.c +++ b/src/window.c @@ -211,15 +211,11 @@ glk_window_get_root() * * So to create a text buffer window which takes the top 40% of the original * window's space, you would execute - * - * newwin = #glk_window_open(win, #winmethod_Above | #winmethod_Proportional, 40, #wintype_TextBuffer, 0); - * + * |[ newwin = #glk_window_open(win, #winmethod_Above | #winmethod_Proportional, 40, #wintype_TextBuffer, 0); ]| * * To create a text grid which is always five lines high, at the bottom of the * original window, you would do - * - * newwin = #glk_window_open(win, #winmethod_Below | #winmethod_Fixed, 5, #wintype_TextGrid, 0); - * + * |[ newwin = #glk_window_open(win, #winmethod_Below | #winmethod_Fixed, 5, #wintype_TextGrid, 0); ]| * * Note that the meaning of the @size argument depends on the @method argument. * If the method is #winmethod_Fixed, it also depends on the @wintype argument. @@ -563,7 +559,6 @@ glk_window_open(winid_t split, glui32 method, glui32 size, glui32 wintype, /* Set the window as a child of the Glk widget */ gtk_widget_set_parent(win->frame, GTK_WIDGET(glk_data->self)); gtk_widget_queue_resize(GTK_WIDGET(glk_data->self)); - gdk_window_process_all_updates(); gdk_threads_leave();