Update to Blorb protocol 1.5
authorPhilip Chimento <philip.chimento@gmail.com>
Sat, 11 Feb 2012 21:47:17 +0000 (22:47 +0100)
committerPhilip Chimento <philip.chimento@gmail.com>
Sat, 11 Feb 2012 23:55:02 +0000 (00:55 +0100)
Update documentation of new Blorb constants

docs/reference/chimara-sections.txt
libchimara/doc.c
libchimara/gi_blorb.c
libchimara/gi_blorb.h

index 8668f3863cdc6e72a5c59d92af1740316e26150a..09b2dcf352a8ce2f6ce1055d76471c24ed624692 100644 (file)
@@ -650,12 +650,15 @@ giblorb_count_resources
 giblorb_method_DontLoad
 giblorb_method_Memory
 giblorb_method_FilePos
-giblorb_ID_Snd
 giblorb_ID_Exec
+giblorb_ID_Snd
 giblorb_ID_Pict
+giblorb_ID_Data
 giblorb_ID_Copyright
 giblorb_ID_AUTH
 giblorb_ID_ANNO
+giblorb_ID_TEXT
+giblorb_ID_BINA
 <SUBSECTION Private>
 giblorb_make_id
 </SECTION>
index ab842bbdf3c1022af06afc322ce80b6574482c01..c45859f7b5cb7e8535ed8aa3807158cc0d7bdad1 100644 (file)
  *   but it can also contain raw data files, which are accessed by
  *   glk_stream_open_resource() and glk_stream_open_resource_uni(). A data file
  *   is identified by number, not by a filename. The Blorb usage field will be
- *   <code>'Data'</code>. The chunk type will be <code>'TEXT'</code> for text
- *   resources, <code>'BINA'</code> for binary resources.
+ *   <code>'Data'</code>. The chunk type will be %giblorb_ID_TEXT for text
+ *   resources, %giblorb_ID_BINA for binary resources.
  * </para></note>
  *
  * <note><para>
  * Resource usage constant representing an image file.
  */
 
+/**
+ * giblorb_ID_Data:
+ *
+ * Resource usage constant representing a data file.
+ */
+
 /**
  * giblorb_ID_Copyright:
  *
  * Resource usage constant representing any textual annotation that the user or 
  * writing program sees fit to include.
  */ 
+
+/**
+ * giblorb_ID_TEXT:
+ *
+ * Resource usage constant representing a text data file.
+ */
+
+/**
+ * giblorb_ID_BINA:
+ *
+ * Resource usage constant representing a binary data file.
+ */
+
 /**
  * giblorb_map_t:
  *
index cdee5f7b35f586f84fd0c7283f56ed46d7d2db0a..3f947f92bf1776c8bab6817e12d5cdd39ddcd6b8 100644 (file)
@@ -1,9 +1,9 @@
 /* gi_blorb.c: Blorb library layer for Glk API.
-    gi_blorb version 1.4.
+    gi_blorb version 1.5.
     Designed by Andrew Plotkin <erkyrath@eblong.com>
-    http://www.eblong.com/zarf/glk/index.html
+    http://eblong.com/zarf/glk/
 
-    This file is copyright 1998-2000 by Andrew Plotkin. You may copy,
+    This file is copyright 1998-2010 by Andrew Plotkin. You may copy,
     distribute, and incorporate it into your own programs, by any means
     and under any conditions, as long as you do not modify it. You may
     also modify this file, incorporate it into your own programs,
index ddec1bd76435ba414dd0682feba34d3ad5c72aa2..4e051caab4e6d0714b650189463d8c6cd894e9ba 100644 (file)
@@ -2,11 +2,11 @@
 #define _GI_BLORB_H
 
 /* gi_blorb.h: Blorb library layer for Glk API.
-    gi_blorb version 1.4.
+    gi_blorb version 1.5.
     Designed by Andrew Plotkin <erkyrath@eblong.com>
-    http://www.eblong.com/zarf/glk/index.html
+    http://eblong.com/zarf/glk/
 
-    This file is copyright 1998-2000 by Andrew Plotkin. You may copy,
+    This file is copyright 1998-2012 by Andrew Plotkin. You may copy,
     distribute, and incorporate it into your own programs, by any means
     and under any conditions, as long as you do not modify it. You may
     also modify this file, incorporate it into your own programs,
@@ -35,12 +35,15 @@ typedef glui32 giblorb_err_t;
 #define giblorb_make_id(c1, c2, c3, c4)  \
     (((c1) << 24) | ((c2) << 16) | ((c3) << 8) | (c4))
 
-#define giblorb_ID_Snd       (giblorb_make_id('S', 'n', 'd', ' '))
 #define giblorb_ID_Exec      (giblorb_make_id('E', 'x', 'e', 'c'))
+#define giblorb_ID_Snd       (giblorb_make_id('S', 'n', 'd', ' '))
 #define giblorb_ID_Pict      (giblorb_make_id('P', 'i', 'c', 't'))
+#define giblorb_ID_Data      (giblorb_make_id('D', 'a', 't', 'a'))
 #define giblorb_ID_Copyright (giblorb_make_id('(', 'c', ')', ' '))
 #define giblorb_ID_AUTH      (giblorb_make_id('A', 'U', 'T', 'H'))
 #define giblorb_ID_ANNO      (giblorb_make_id('A', 'N', 'N', 'O'))
+#define giblorb_ID_TEXT      (giblorb_make_id('T', 'E', 'X', 'T'))
+#define giblorb_ID_BINA      (giblorb_make_id('B', 'I', 'N', 'A'))
 
 /* giblorb_map_t: Holds the complete description of an open Blorb 
     file. This type is opaque for normal interpreter use. */