Update to Blorb protocol 1.5
[projects/chimara/chimara.git] / docs / reference / chimara-sections.txt
index 15b9828c05a4d354ad25a8897436563f3b4ee14a..09b2dcf352a8ce2f6ce1055d76471c24ed624692 100644 (file)
@@ -1,23 +1,39 @@
 <SECTION>
 <FILE>chimara-glk</FILE>
+<INCLUDE>libchimara/chimara-glk.h</INCLUDE>
 <TITLE>ChimaraGlk</TITLE>
 ChimaraGlk
+ChimaraError
+CHIMARA_ERROR
+chimara_error_quark
+ChimaraResourceLoadFunc
+ChimaraResourceType
+ChimaraGlkWindowType
 chimara_glk_new
 chimara_glk_set_interactive
 chimara_glk_get_interactive
 chimara_glk_set_protect
 chimara_glk_get_protect
-chimara_glk_set_default_font_description
-chimara_glk_set_default_font_string
-chimara_glk_get_default_font_description
-chimara_glk_set_monospace_font_description
-chimara_glk_set_monospace_font_string
-chimara_glk_get_monospace_font_description
+chimara_glk_set_spacing
+chimara_glk_get_spacing
+chimara_glk_set_css_to_default
+chimara_glk_set_css_from_file
+chimara_glk_set_css_from_string
 chimara_glk_run
+chimara_glk_run_file
 chimara_glk_stop
 chimara_glk_wait
+chimara_glk_unload_plugin
+chimara_glk_get_running
+chimara_glk_feed_char_input
+chimara_glk_feed_line_input
+chimara_glk_is_char_input_pending
+chimara_glk_is_line_input_pending
+chimara_glk_get_tag
+chimara_glk_get_tag_names
+chimara_glk_update_style
+chimara_glk_set_resource_load_callback
 <SUBSECTION Standard>
-ChimaraGlkClass
 CHIMARA_GLK
 CHIMARA_IS_GLK
 CHIMARA_TYPE_GLK
@@ -27,6 +43,33 @@ CHIMARA_IS_GLK_CLASS
 CHIMARA_GLK_GET_CLASS
 </SECTION>
 
+<SECTION>
+<FILE>chimara-if</FILE>
+<INCLUDE>libchimara/chimara-if.h</INCLUDE>
+ChimaraIFFormat
+ChimaraIFInterpreter
+ChimaraIFZmachineVersion
+<TITLE>ChimaraIF</TITLE>
+ChimaraIF
+chimara_if_new
+chimara_if_set_preferred_interpreter
+chimara_if_get_preferred_interpreter
+chimara_if_run_game
+chimara_if_run_game_file
+chimara_if_get_format
+chimara_if_get_interpreter
+<SUBSECTION Standard>
+CHIMARA_IF
+CHIMARA_IS_IF
+CHIMARA_TYPE_IF
+chimara_if_get_type
+CHIMARA_IF_CLASS
+CHIMARA_IS_IF_CLASS
+CHIMARA_IF_GET_CLASS
+</SECTION>
+
+<INCLUDE>libchimara/glk.h</INCLUDE>
+
 <SECTION>
 <FILE>glk-exiting</FILE>
 <TITLE>Exiting Your Program</TITLE>
@@ -68,25 +111,28 @@ schanid_t
 <TITLE>The Gestalt System</TITLE>
 glk_gestalt_ext
 glk_gestalt
-<SUBSECTION The Version Number>
+<SUBSECTION Constants>
 gestalt_Version
-<SUBSECTION Testing for Unicode Capabilities>
 gestalt_Unicode
 GLK_MODULE_UNICODE
-<SUBSECTION Output>
+gestalt_UnicodeNorm
+GLK_MODULE_UNICODE_NORM
 gestalt_CharOutput
 gestalt_CharOutput_CannotPrint
 gestalt_CharOutput_ApproxPrint
 gestalt_CharOutput_ExactPrint
-<SUBSECTION Line Input>
 gestalt_LineInput
-<SUBSECTION Character Input>
+gestalt_LineInputEcho
+GLK_MODULE_LINE_ECHO
+gestalt_LineTerminators
+GLK_MODULE_LINE_TERMINATORS
+gestalt_LineTerminatorKey
 gestalt_CharInput
-<SUBSECTION Constants>
 gestalt_MouseInput
 gestalt_Timer
 gestalt_Graphics
 gestalt_DrawImage
+gestalt_Sound2
 gestalt_Sound
 gestalt_SoundVolume
 gestalt_SoundNotify
@@ -94,6 +140,9 @@ gestalt_Hyperlinks
 gestalt_HyperlinkInput
 gestalt_SoundMusic
 gestalt_GraphicsTransparency
+gestalt_DateTime
+gestalt_ResourceStream
+GLK_MODULE_RESOURCE_STREAM
 </SECTION>
 
 <SECTION>
@@ -124,6 +173,7 @@ keycode_Func9
 keycode_Func10
 keycode_Func11
 keycode_Func12
+<SUBSECTION Private>
 keycode_MAXVAL
 </SECTION>
 
@@ -137,6 +187,13 @@ glk_buffer_to_upper_case_uni
 glk_buffer_to_title_case_uni
 </SECTION>
 
+<SECTION>
+<FILE>glk-normalize</FILE>
+<TITLE>Unicode String Normalization</TITLE>
+glk_buffer_canon_decompose_uni
+glk_buffer_canon_normalize_uni
+</SECTION>
+
 <SECTION>
 <FILE>glk-window-opening</FILE>
 <TITLE>Window Opening, Closing, and Constraints</TITLE>
@@ -145,11 +202,15 @@ winmethod_Left
 winmethod_Right
 winmethod_Above
 winmethod_Below
-winmethod_DirMask
 winmethod_Fixed
 winmethod_Proportional
-winmethod_DivisionMask
+winmethod_Border
+winmethod_NoBorder
 glk_window_close
+<SUBSECTION Private>
+winmethod_DirMask
+winmethod_DivisionMask
+winmethod_BorderMask
 </SECTION>
 
 <SECTION>
@@ -209,6 +270,7 @@ evtype_Arrange
 evtype_Redraw
 evtype_SoundNotify
 evtype_Hyperlink
+evtype_VolumeNotify
 </SECTION>
 
 <SECTION>
@@ -225,6 +287,8 @@ glk_cancel_char_event
 glk_request_line_event
 glk_request_line_event_uni
 glk_cancel_line_event
+glk_set_echo_line_event
+glk_set_terminators_line_event
 </SECTION>
 
 <SECTION>
@@ -303,12 +367,6 @@ seekmode_End
 <TITLE>Styles</TITLE>
 glk_set_style
 glk_set_style_stream
-<SUBSECTION Suggesting the Appearance of Styles>
-glk_stylehint_set
-glk_stylehint_clear
-<SUBSECTION Testing the Appearance of Styles>
-glk_style_distinguish
-glk_style_measure
 <SUBSECTION Constants>
 style_Normal
 style_Emphasized
@@ -321,7 +379,16 @@ style_BlockQuote
 style_Input
 style_User1
 style_User2
+<SUBSECTION Private>
 style_NUMSTYLES
+</SECTION>
+
+<SECTION>
+<FILE>glk-stylehints</FILE>
+<TITLE>Suggesting the Appearance of Styles</TITLE>
+glk_stylehint_set
+glk_stylehint_clear
+<SUBSECTION Constants>
 stylehint_Indentation
 stylehint_ParaIndentation
 stylehint_Justification
@@ -332,11 +399,19 @@ stylehint_Proportional
 stylehint_TextColor
 stylehint_BackColor
 stylehint_ReverseColor
-stylehint_NUMHINTS
 stylehint_just_LeftFlush
 stylehint_just_LeftRight
 stylehint_just_Centered
 stylehint_just_RightFlush
+<SUBSECTION Private>
+stylehint_NUMHINTS
+</SECTION>
+
+<SECTION>
+<FILE>glk-style-measure</FILE>
+<TITLE>Testing the Appearance of Styles</TITLE>
+glk_style_distinguish
+glk_style_measure
 </SECTION>
 
 <SECTION>
@@ -346,6 +421,8 @@ glk_stream_open_memory
 glk_stream_open_memory_uni
 glk_stream_open_file
 glk_stream_open_file_uni
+glk_stream_open_resource
+glk_stream_open_resource_uni
 </SECTION>
 
 <SECTION>
@@ -362,9 +439,10 @@ fileusage_Data
 fileusage_SavedGame
 fileusage_Transcript
 fileusage_InputRecord
-fileusage_TypeMask
 fileusage_TextMode
 fileusage_BinaryMode
+<SUBSECTION Private>
+fileusage_TypeMask
 </SECTION>
 
 <SECTION>
@@ -424,6 +502,7 @@ GLK_MODULE_IMAGE
 <FILE>glk-sound-channels</FILE>
 <TITLE>Creating and Destroying Sound Channels</TITLE>
 glk_schannel_create
+glk_schannel_create_ext
 glk_schannel_destroy
 </SECTION>
 
@@ -432,8 +511,12 @@ glk_schannel_destroy
 <TITLE>Playing Sounds</TITLE>
 glk_schannel_play
 glk_schannel_play_ext
+glk_schannel_play_multi
 glk_schannel_stop
+glk_schannel_pause
+glk_schannel_unpause
 glk_schannel_set_volume
+glk_schannel_set_volume_ext
 glk_sound_load_hint
 </SECTION>
 
@@ -448,6 +531,7 @@ glk_schannel_get_rock
 <FILE>glk-sound-testing</FILE>
 <TITLE>Testing for Sound Capabilities</TITLE>
 GLK_MODULE_SOUND
+GLK_MODULE_SOUND2
 </SECTION>
 
 <SECTION>
@@ -470,3 +554,178 @@ glk_cancel_hyperlink_event
 GLK_MODULE_HYPERLINKS
 </SECTION>
 
+<SECTION>
+<FILE>glk-clock</FILE>
+<TITLE>The System Clock</TITLE>
+glktimeval_t
+glk_current_time
+glk_current_simple_time
+</SECTION>
+
+<SECTION>
+<FILE>glk-clock-conversions</FILE>
+<TITLE>Time and Date Conversions</TITLE>
+glkdate_t
+glk_time_to_date_utc
+glk_time_to_date_local
+glk_simple_time_to_date_utc
+glk_simple_time_to_date_local
+glk_date_to_time_utc
+glk_date_to_time_local
+glk_date_to_simple_time_utc
+glk_date_to_simple_time_local
+</SECTION>
+
+<SECTION>
+<FILE>glk-clock-testing</FILE>
+<TITLE>Testing for Clock Capabilities</TITLE>
+GLK_MODULE_DATETIME
+</SECTION>
+
+<INCLUDE>libchimara/glk.h, libchimara/gi-dispa.h</INCLUDE>
+
+<SECTION>
+<FILE>dispatch-interrogating</FILE>
+<TITLE>Interrogating the Interface</TITLE>
+gidispatch_count_classes
+gidispatch_get_class
+gidispatch_count_intconst
+gidispatch_get_intconst
+gidispatch_intconst_t
+gidispatch_count_functions
+gidispatch_get_function
+gidispatch_function_t
+gidispatch_get_function_by_id
+<SUBSECTION Constants>
+gidisp_Class_Window
+gidisp_Class_Stream
+gidisp_Class_Fileref
+gidisp_Class_Schannel
+</SECTION>
+
+<SECTION>
+<FILE>dispatch-dispatching</FILE>
+<TITLE>Dispatching</TITLE>
+gidispatch_call
+gluniversal_t
+</SECTION>
+
+<SECTION>
+<FILE>dispatch-prototypes</FILE>
+<TITLE>Getting Argument Prototypes</TITLE>
+gidispatch_prototype
+</SECTION>
+
+<SECTION>
+<FILE>dispatch-library-functions</FILE>
+<TITLE>Functions the Library Must Provide</TITLE>
+gidispatch_set_object_registry
+gidispatch_rock_t
+gidispatch_get_objrock
+gidispatch_set_retained_registry
+</SECTION>
+
+<INCLUDE>libchimara/glk.h, libchimara/gi-blorb.h</INCLUDE>
+
+<SECTION>
+<FILE>blorb-program</FILE>
+<TITLE>What the Program Does</TITLE>
+giblorb_set_resource_map
+giblorb_get_resource_map
+giblorb_map_t
+</SECTION>
+
+<SECTION>
+<FILE>blorb-layer</FILE>
+<TITLE>What the Blorb Layer Does</TITLE>
+giblorb_create_map
+giblorb_destroy_map
+giblorb_result_t
+giblorb_load_chunk_by_type
+giblorb_load_chunk_by_number
+giblorb_unload_chunk
+giblorb_load_resource
+giblorb_count_resources
+<SUBSECTION Constants>
+giblorb_method_DontLoad
+giblorb_method_Memory
+giblorb_method_FilePos
+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>
+
+<SECTION>
+<FILE>blorb-errors</FILE>
+<TITLE>Blorb Errors</TITLE>
+giblorb_err_t
+<SUBSECTION Constants>
+giblorb_err_None
+giblorb_err_CompileTime
+giblorb_err_Alloc
+giblorb_err_Read
+giblorb_err_NotAMap
+giblorb_err_Format
+giblorb_err_NotFound
+</SECTION>
+
+<INCLUDE>libchimara/glk.h, libchimara/glkstart.h</INCLUDE>
+
+<SECTION>
+<FILE>glkext-startup</FILE>
+<TITLE>Startup Code</TITLE>
+glkunix_argumentlist_t
+glkunix_startup_t
+<SUBSECTION Constants>
+glkunix_arg_NoValue
+glkunix_arg_ValueFollows
+glkunix_arg_ValueCanFollow
+glkunix_arg_NumberValue
+glkunix_arg_End
+<SUBSECTION Private>
+glkunix_startup_code
+NULL
+</SECTION>
+
+<SECTION>
+<FILE>glkext-unix</FILE>
+<TITLE>Unix Extensions</TITLE>
+glkunix_stream_open_pathname_gen
+glkunix_stream_open_pathname
+glkunix_set_base_file
+</SECTION>
+
+<SECTION>
+<FILE>glkext-garglk</FILE>
+<TITLE>Gargoyle Extensions</TITLE>
+<INCLUDE>libchimara/glk.h, libchimara/garglk.h</INCLUDE>
+GARGLK
+<SUBSECTION Functions>
+garglk_fileref_get_name
+garglk_set_program_name
+garglk_set_program_info
+garglk_set_story_name
+garglk_set_story_title
+garglk_unput_string
+garglk_unput_string_uni
+garglk_set_zcolors
+garglk_set_zcolors_stream
+garglk_set_reversevideo
+garglk_set_reversevideo_stream
+<SUBSECTION Constants>
+zcolor_Current
+zcolor_Default
+zcolor_Cursor
+zcolor_Transparent
+keycode_Erase
+keycode_MouseWheelUp
+keycode_MouseWheelDown
+</SECTION>