docs/reference/chimara-sections.txt

   1 <SECTION>
   2 <FILE>chimara-glk</FILE>
   3 <INCLUDE>libchimara/chimara-glk.h</INCLUDE>
   4 <TITLE>ChimaraGlk</TITLE>
   5 ChimaraGlk
   6 ChimaraError
   7 CHIMARA_ERROR
   8 chimara_error_quark
   9 ChimaraResourceLoadFunc
  10 ChimaraResourceType
  11 ChimaraGlkWindowType
  12 chimara_glk_new
  13 chimara_glk_set_interactive
  14 chimara_glk_get_interactive
  15 chimara_glk_set_protect
  16 chimara_glk_get_protect
  17 chimara_glk_set_spacing
  18 chimara_glk_get_spacing
  19 chimara_glk_set_css_to_default
  20 chimara_glk_set_css_from_file
  21 chimara_glk_set_css_from_string
  22 chimara_glk_run
  23 chimara_glk_run_file
  24 chimara_glk_stop
  25 chimara_glk_wait
  26 chimara_glk_unload_plugin
  27 chimara_glk_get_running
  28 chimara_glk_feed_char_input
  29 chimara_glk_feed_line_input
  30 chimara_glk_is_char_input_pending
  31 chimara_glk_is_line_input_pending
  32 chimara_glk_get_tag
  33 chimara_glk_get_tag_names
  34 chimara_glk_update_style
  35 chimara_glk_set_resource_load_callback
  36 <SUBSECTION Standard>
  37 CHIMARA_GLK
  38 CHIMARA_IS_GLK
  39 CHIMARA_TYPE_GLK
  40 chimara_glk_get_type
  41 CHIMARA_GLK_CLASS
  42 CHIMARA_IS_GLK_CLASS
  43 CHIMARA_GLK_GET_CLASS
  44 </SECTION>
  45
  46 <SECTION>
  47 <FILE>chimara-if</FILE>
  48 <INCLUDE>libchimara/chimara-if.h</INCLUDE>
  49 ChimaraIFFormat
  50 ChimaraIFInterpreter
  51 ChimaraIFZmachineVersion
  52 <TITLE>ChimaraIF</TITLE>
  53 ChimaraIF
  54 chimara_if_new
  55 chimara_if_set_preferred_interpreter
  56 chimara_if_get_preferred_interpreter
  57 chimara_if_run_game
  58 chimara_if_run_game_file
  59 chimara_if_get_format
  60 chimara_if_get_interpreter
  61 <SUBSECTION Standard>
  62 CHIMARA_IF
  63 CHIMARA_IS_IF
  64 CHIMARA_TYPE_IF
  65 chimara_if_get_type
  66 CHIMARA_IF_CLASS
  67 CHIMARA_IS_IF_CLASS
  68 CHIMARA_IF_GET_CLASS
  69 </SECTION>
  70
  71 <INCLUDE>libchimara/glk.h</INCLUDE>
  72
  73 <SECTION>
  74 <FILE>glk-exiting</FILE>
  75 <TITLE>Exiting Your Program</TITLE>
  76 glk_exit
  77 <SUBSECTION Private>
  78 glk_main
  79 </SECTION>
  80
  81 <SECTION>
  82 <FILE>glk-interrupt</FILE>
  83 <TITLE>The Interrupt Handler</TITLE>
  84 glk_set_interrupt_handler
  85 </SECTION>
  86
  87 <SECTION>
  88 <FILE>glk-tick</FILE>
  89 <TITLE>The Tick Thing</TITLE>
  90 glk_tick
  91 </SECTION>
  92
  93 <SECTION>
  94 <FILE>glk-types</FILE>
  95 <TITLE>Basic Types</TITLE>
  96 glui32
  97 glsi32
  98 </SECTION>
  99
 100 <SECTION>
 101 <FILE>glk-opaque-objects</FILE>
 102 <TITLE>Opaque Objects</TITLE>
 103 winid_t
 104 strid_t
 105 frefid_t
 106 schanid_t
 107 </SECTION>
 108
 109 <SECTION>
 110 <FILE>glk-gestalt</FILE>
 111 <TITLE>The Gestalt System</TITLE>
 112 glk_gestalt_ext
 113 glk_gestalt
 114 <SUBSECTION Constants>
 115 gestalt_Version
 116 gestalt_Unicode
 117 GLK_MODULE_UNICODE
 118 gestalt_UnicodeNorm
 119 GLK_MODULE_UNICODE_NORM
 120 gestalt_CharOutput
 121 gestalt_CharOutput_CannotPrint
 122 gestalt_CharOutput_ApproxPrint
 123 gestalt_CharOutput_ExactPrint
 124 gestalt_LineInput
 125 gestalt_LineInputEcho
 126 GLK_MODULE_LINE_ECHO
 127 gestalt_LineTerminators
 128 GLK_MODULE_LINE_TERMINATORS
 129 gestalt_LineTerminatorKey
 130 gestalt_CharInput
 131 gestalt_MouseInput
 132 gestalt_Timer
 133 gestalt_Graphics
 134 gestalt_DrawImage
 135 gestalt_Sound2
 136 gestalt_Sound
 137 gestalt_SoundVolume
 138 gestalt_SoundNotify
 139 gestalt_Hyperlinks
 140 gestalt_HyperlinkInput
 141 gestalt_SoundMusic
 142 gestalt_GraphicsTransparency
 143 gestalt_DateTime
 144 </SECTION>
 145
 146 <SECTION>
 147 <FILE>glk-character-input</FILE>
 148 <TITLE>Character Input</TITLE>
 149 keycode_Unknown
 150 keycode_Left
 151 keycode_Right
 152 keycode_Up
 153 keycode_Down
 154 keycode_Return
 155 keycode_Delete
 156 keycode_Escape
 157 keycode_Tab
 158 keycode_PageUp
 159 keycode_PageDown
 160 keycode_Home
 161 keycode_End
 162 keycode_Func1
 163 keycode_Func2
 164 keycode_Func3
 165 keycode_Func4
 166 keycode_Func5
 167 keycode_Func6
 168 keycode_Func7
 169 keycode_Func8
 170 keycode_Func9
 171 keycode_Func10
 172 keycode_Func11
 173 keycode_Func12
 174 <SUBSECTION Private>
 175 keycode_MAXVAL
 176 </SECTION>
 177
 178 <SECTION>
 179 <FILE>glk-case</FILE>
 180 <TITLE>Upper and Lower Case</TITLE>
 181 glk_char_to_lower
 182 glk_char_to_upper
 183 glk_buffer_to_lower_case_uni
 184 glk_buffer_to_upper_case_uni
 185 glk_buffer_to_title_case_uni
 186 </SECTION>
 187
 188 <SECTION>
 189 <FILE>glk-normalize</FILE>
 190 <TITLE>Unicode String Normalization</TITLE>
 191 glk_buffer_canon_decompose_uni
 192 glk_buffer_canon_normalize_uni
 193 </SECTION>
 194
 195 <SECTION>
 196 <FILE>glk-window-opening</FILE>
 197 <TITLE>Window Opening, Closing, and Constraints</TITLE>
 198 glk_window_open
 199 winmethod_Left
 200 winmethod_Right
 201 winmethod_Above
 202 winmethod_Below
 203 winmethod_Fixed
 204 winmethod_Proportional
 205 winmethod_Border
 206 winmethod_NoBorder
 207 glk_window_close
 208 <SUBSECTION Private>
 209 winmethod_DirMask
 210 winmethod_DivisionMask
 211 winmethod_BorderMask
 212 </SECTION>
 213
 214 <SECTION>
 215 <FILE>glk-window-constraints</FILE>
 216 <TITLE>Changing Window Constraints</TITLE>
 217 glk_window_get_size
 218 glk_window_set_arrangement
 219 glk_window_get_arrangement
 220 </SECTION>
 221
 222 <SECTION>
 223 <FILE>glk-window-types</FILE>
 224 <TITLE>The Types of Windows</TITLE>
 225 wintype_Blank
 226 wintype_Pair
 227 wintype_TextBuffer
 228 wintype_TextGrid
 229 glk_window_move_cursor
 230 wintype_Graphics
 231 wintype_AllTypes
 232 </SECTION>
 233
 234 <SECTION>
 235 <FILE>glk-echo-streams</FILE>
 236 <TITLE>Echo Streams</TITLE>
 237 glk_window_set_echo_stream
 238 glk_window_get_echo_stream
 239 </SECTION>
 240
 241 <SECTION>
 242 <FILE>glk-window-other</FILE>
 243 <TITLE>Other Window Functions</TITLE>
 244 glk_window_iterate
 245 glk_window_get_rock
 246 glk_window_get_type
 247 glk_window_get_parent
 248 glk_window_get_sibling
 249 glk_window_get_root
 250 glk_window_clear
 251 glk_window_get_stream
 252 glk_set_window
 253 </SECTION>
 254
 255 <SECTION>
 256 <FILE>glk-events</FILE>
 257 <TITLE>Events</TITLE>
 258 glk_select
 259 event_t
 260 glk_select_poll
 261 <SUBSECTION Constants>
 262 evtype_None
 263 evtype_Timer
 264 evtype_CharInput
 265 evtype_LineInput
 266 evtype_MouseInput
 267 evtype_Arrange
 268 evtype_Redraw
 269 evtype_SoundNotify
 270 evtype_Hyperlink
 271 evtype_VolumeNotify
 272 </SECTION>
 273
 274 <SECTION>
 275 <FILE>glk-character-input-events</FILE>
 276 <TITLE>Character Input Events</TITLE>
 277 glk_request_char_event
 278 glk_request_char_event_uni
 279 glk_cancel_char_event
 280 </SECTION>
 281
 282 <SECTION>
 283 <FILE>glk-line-input-events</FILE>
 284 <TITLE>Line Input Events</TITLE>
 285 glk_request_line_event
 286 glk_request_line_event_uni
 287 glk_cancel_line_event
 288 glk_set_echo_line_event
 289 glk_set_terminators_line_event
 290 </SECTION>
 291
 292 <SECTION>
 293 <FILE>glk-mouse-events</FILE>
 294 <TITLE>Mouse Input Events</TITLE>
 295 glk_request_mouse_event
 296 glk_cancel_mouse_event
 297 </SECTION>
 298
 299 <SECTION>
 300 <FILE>glk-timer-events</FILE>
 301 <TITLE>Timer Events</TITLE>
 302 glk_request_timer_events
 303 </SECTION>
 304
 305 <SECTION>
 306 <FILE>glk-streams</FILE>
 307 <TITLE>Streams</TITLE>
 308 glk_stream_set_current
 309 glk_stream_get_current
 310 <SUBSECTION Constants>
 311 filemode_Write
 312 filemode_Read
 313 filemode_ReadWrite
 314 filemode_WriteAppend
 315 </SECTION>
 316
 317 <SECTION>
 318 <FILE>glk-print</FILE>
 319 <TITLE>How to Print</TITLE>
 320 glk_put_char
 321 glk_put_string
 322 glk_put_buffer
 323 glk_put_char_stream
 324 glk_put_string_stream
 325 glk_put_buffer_stream
 326 glk_put_char_uni
 327 glk_put_string_uni
 328 glk_put_buffer_uni
 329 glk_put_char_stream_uni
 330 glk_put_string_stream_uni
 331 glk_put_buffer_stream_uni
 332 </SECTION>
 333
 334 <SECTION>
 335 <FILE>glk-read</FILE>
 336 <TITLE>How to Read</TITLE>
 337 glk_get_char_stream
 338 glk_get_buffer_stream
 339 glk_get_line_stream
 340 glk_get_char_stream_uni
 341 glk_get_buffer_stream_uni
 342 glk_get_line_stream_uni
 343 </SECTION>
 344
 345 <SECTION>
 346 <FILE>glk-closing-streams</FILE>
 347 <TITLE>Closing Streams</TITLE>
 348 glk_stream_close
 349 stream_result_t
 350 </SECTION>
 351
 352 <SECTION>
 353 <FILE>glk-stream-positions</FILE>
 354 <TITLE>Stream Positions</TITLE>
 355 glk_stream_set_position
 356 glk_stream_get_position
 357 <SUBSECTION Constants>
 358 seekmode_Start
 359 seekmode_Current
 360 seekmode_End
 361 </SECTION>
 362
 363 <SECTION>
 364 <FILE>glk-styles</FILE>
 365 <TITLE>Styles</TITLE>
 366 glk_set_style
 367 glk_set_style_stream
 368 <SUBSECTION Constants>
 369 style_Normal
 370 style_Emphasized
 371 style_Preformatted
 372 style_Header
 373 style_Subheader
 374 style_Alert
 375 style_Note
 376 style_BlockQuote
 377 style_Input
 378 style_User1
 379 style_User2
 380 <SUBSECTION Private>
 381 style_NUMSTYLES
 382 </SECTION>
 383
 384 <SECTION>
 385 <FILE>glk-stylehints</FILE>
 386 <TITLE>Suggesting the Appearance of Styles</TITLE>
 387 glk_stylehint_set
 388 glk_stylehint_clear
 389 <SUBSECTION Constants>
 390 stylehint_Indentation
 391 stylehint_ParaIndentation
 392 stylehint_Justification
 393 stylehint_Size
 394 stylehint_Weight
 395 stylehint_Oblique
 396 stylehint_Proportional
 397 stylehint_TextColor
 398 stylehint_BackColor
 399 stylehint_ReverseColor
 400 stylehint_just_LeftFlush
 401 stylehint_just_LeftRight
 402 stylehint_just_Centered
 403 stylehint_just_RightFlush
 404 <SUBSECTION Private>
 405 stylehint_NUMHINTS
 406 </SECTION>
 407
 408 <SECTION>
 409 <FILE>glk-style-measure</FILE>
 410 <TITLE>Testing the Appearance of Styles</TITLE>
 411 glk_style_distinguish
 412 glk_style_measure
 413 </SECTION>
 414
 415 <SECTION>
 416 <FILE>glk-stream-types</FILE>
 417 <TITLE>The Types of Streams</TITLE>
 418 glk_stream_open_memory
 419 glk_stream_open_memory_uni
 420 glk_stream_open_file
 421 glk_stream_open_file_uni
 422 </SECTION>
 423
 424 <SECTION>
 425 <FILE>glk-stream-other</FILE>
 426 <TITLE>Other Stream Functions</TITLE>
 427 glk_stream_iterate
 428 glk_stream_get_rock
 429 </SECTION>
 430
 431 <SECTION>
 432 <FILE>glk-fileref</FILE>
 433 <TITLE>File References</TITLE>
 434 fileusage_Data
 435 fileusage_SavedGame
 436 fileusage_Transcript
 437 fileusage_InputRecord
 438 fileusage_TextMode
 439 fileusage_BinaryMode
 440 <SUBSECTION Private>
 441 fileusage_TypeMask
 442 </SECTION>
 443
 444 <SECTION>
 445 <FILE>glk-fileref-types</FILE>
 446 <TITLE>The Types of File References</TITLE>
 447 glk_fileref_create_temp
 448 glk_fileref_create_by_prompt
 449 glk_fileref_create_by_name
 450 glk_fileref_create_from_fileref
 451 </SECTION>
 452
 453 <SECTION>
 454 <FILE>glk-fileref-other</FILE>
 455 <TITLE>Other File Reference Functions</TITLE>
 456 glk_fileref_destroy
 457 glk_fileref_iterate
 458 glk_fileref_get_rock
 459 glk_fileref_delete_file
 460 glk_fileref_does_file_exist
 461 </SECTION>
 462
 463 <SECTION>
 464 <FILE>glk-image-resources</FILE>
 465 <TITLE>Image Resources</TITLE>
 466 glk_image_get_info
 467 glk_image_draw
 468 glk_image_draw_scaled
 469 </SECTION>
 470
 471 <SECTION>
 472 <FILE>glk-graphics-windows</FILE>
 473 <TITLE>Graphics in Graphics Windows</TITLE>
 474 glk_window_set_background_color
 475 glk_window_fill_rect
 476 glk_window_erase_rect
 477 </SECTION>
 478
 479 <SECTION>
 480 <FILE>glk-graphics-text</FILE>
 481 <TITLE>Graphics in Text Buffer Windows</TITLE>
 482 glk_window_flow_break
 483 <SUBSECTION Constants>
 484 imagealign_InlineUp
 485 imagealign_InlineDown
 486 imagealign_InlineCenter
 487 imagealign_MarginLeft
 488 imagealign_MarginRight
 489 </SECTION>
 490
 491 <SECTION>
 492 <FILE>glk-graphics-testing</FILE>
 493 <TITLE>Testing for Graphics Capabilities</TITLE>
 494 GLK_MODULE_IMAGE
 495 </SECTION>
 496
 497 <SECTION>
 498 <FILE>glk-sound-channels</FILE>
 499 <TITLE>Creating and Destroying Sound Channels</TITLE>
 500 glk_schannel_create
 501 glk_schannel_create_ext
 502 glk_schannel_destroy
 503 </SECTION>
 504
 505 <SECTION>
 506 <FILE>glk-playing-sounds</FILE>
 507 <TITLE>Playing Sounds</TITLE>
 508 glk_schannel_play
 509 glk_schannel_play_ext
 510 glk_schannel_play_multi
 511 glk_schannel_stop
 512 glk_schannel_pause
 513 glk_schannel_unpause
 514 glk_schannel_set_volume
 515 glk_schannel_set_volume_ext
 516 glk_sound_load_hint
 517 </SECTION>
 518
 519 <SECTION>
 520 <FILE>glk-sound-other</FILE>
 521 <TITLE>Other Sound Channel Functions</TITLE>
 522 glk_schannel_iterate
 523 glk_schannel_get_rock
 524 </SECTION>
 525
 526 <SECTION>
 527 <FILE>glk-sound-testing</FILE>
 528 <TITLE>Testing for Sound Capabilities</TITLE>
 529 GLK_MODULE_SOUND
 530 GLK_MODULE_SOUND2
 531 </SECTION>
 532
 533 <SECTION>
 534 <FILE>glk-creating-hyperlinks</FILE>
 535 <TITLE>Creating Hyperlinks</TITLE>
 536 glk_set_hyperlink
 537 glk_set_hyperlink_stream
 538 </SECTION>
 539
 540 <SECTION>
 541 <FILE>glk-accepting-hyperlinks</FILE>
 542 <TITLE>Accepting Hyperlink Events</TITLE>
 543 glk_request_hyperlink_event
 544 glk_cancel_hyperlink_event
 545 </SECTION>
 546
 547 <SECTION>
 548 <FILE>glk-hyperlinks-testing</FILE>
 549 <TITLE>Testing for Hyperlink Capabilities</TITLE>
 550 GLK_MODULE_HYPERLINKS
 551 </SECTION>
 552
 553 <SECTION>
 554 <FILE>glk-clock</FILE>
 555 <TITLE>The System Clock</TITLE>
 556 glktimeval_t
 557 glk_current_time
 558 glk_current_simple_time
 559 </SECTION>
 560
 561 <SECTION>
 562 <FILE>glk-clock-conversions</FILE>
 563 <TITLE>Time and Date Conversions</TITLE>
 564 glkdate_t
 565 glk_time_to_date_utc
 566 glk_time_to_date_local
 567 glk_simple_time_to_date_utc
 568 glk_simple_time_to_date_local
 569 glk_date_to_time_utc
 570 glk_date_to_time_local
 571 glk_date_to_simple_time_utc
 572 glk_date_to_simple_time_local
 573 </SECTION>
 574
 575 <SECTION>
 576 <FILE>glk-clock-testing</FILE>
 577 <TITLE>Testing for Clock Capabilities</TITLE>
 578 GLK_MODULE_DATETIME
 579 </SECTION>
 580
 581 <INCLUDE>libchimara/glk.h, libchimara/gi-dispa.h</INCLUDE>
 582
 583 <SECTION>
 584 <FILE>dispatch-interrogating</FILE>
 585 <TITLE>Interrogating the Interface</TITLE>
 586 gidispatch_count_classes
 587 gidispatch_get_class
 588 gidispatch_count_intconst
 589 gidispatch_get_intconst
 590 gidispatch_intconst_t
 591 gidispatch_count_functions
 592 gidispatch_get_function
 593 gidispatch_function_t
 594 gidispatch_get_function_by_id
 595 <SUBSECTION Constants>
 596 gidisp_Class_Window
 597 gidisp_Class_Stream
 598 gidisp_Class_Fileref
 599 gidisp_Class_Schannel
 600 </SECTION>
 601
 602 <SECTION>
 603 <FILE>dispatch-dispatching</FILE>
 604 <TITLE>Dispatching</TITLE>
 605 gidispatch_call
 606 gluniversal_t
 607 </SECTION>
 608
 609 <SECTION>
 610 <FILE>dispatch-prototypes</FILE>
 611 <TITLE>Getting Argument Prototypes</TITLE>
 612 gidispatch_prototype
 613 </SECTION>
 614
 615 <SECTION>
 616 <FILE>dispatch-library-functions</FILE>
 617 <TITLE>Functions the Library Must Provide</TITLE>
 618 gidispatch_set_object_registry
 619 gidispatch_rock_t
 620 gidispatch_get_objrock
 621 gidispatch_set_retained_registry
 622 </SECTION>
 623
 624 <INCLUDE>libchimara/glk.h, libchimara/gi-blorb.h</INCLUDE>
 625
 626 <SECTION>
 627 <FILE>blorb-program</FILE>
 628 <TITLE>What the Program Does</TITLE>
 629 giblorb_set_resource_map
 630 giblorb_get_resource_map
 631 giblorb_map_t
 632 </SECTION>
 633
 634 <SECTION>
 635 <FILE>blorb-layer</FILE>
 636 <TITLE>What the Blorb Layer Does</TITLE>
 637 giblorb_create_map
 638 giblorb_destroy_map
 639 giblorb_result_t
 640 giblorb_load_chunk_by_type
 641 giblorb_load_chunk_by_number
 642 giblorb_unload_chunk
 643 giblorb_load_resource
 644 giblorb_count_resources
 645 <SUBSECTION Constants>
 646 giblorb_method_DontLoad
 647 giblorb_method_Memory
 648 giblorb_method_FilePos
 649 giblorb_ID_Snd
 650 giblorb_ID_Exec
 651 giblorb_ID_Pict
 652 giblorb_ID_Copyright
 653 giblorb_ID_AUTH
 654 giblorb_ID_ANNO
 655 <SUBSECTION Private>
 656 giblorb_make_id
 657 </SECTION>
 658
 659 <SECTION>
 660 <FILE>blorb-errors</FILE>
 661 <TITLE>Blorb Errors</TITLE>
 662 giblorb_err_t
 663 <SUBSECTION Constants>
 664 giblorb_err_None
 665 giblorb_err_CompileTime
 666 giblorb_err_Alloc
 667 giblorb_err_Read
 668 giblorb_err_NotAMap
 669 giblorb_err_Format
 670 giblorb_err_NotFound
 671 </SECTION>
 672
 673 <INCLUDE>libchimara/glk.h, libchimara/glkstart.h</INCLUDE>
 674
 675 <SECTION>
 676 <FILE>glkext-startup</FILE>
 677 <TITLE>Startup Code</TITLE>
 678 glkunix_argumentlist_t
 679 glkunix_startup_t
 680 <SUBSECTION Constants>
 681 glkunix_arg_NoValue
 682 glkunix_arg_ValueFollows
 683 glkunix_arg_ValueCanFollow
 684 glkunix_arg_NumberValue
 685 glkunix_arg_End
 686 <SUBSECTION Private>
 687 glkunix_startup_code
 688 NULL
 689 </SECTION>
 690
 691 <SECTION>
 692 <FILE>glkext-unix</FILE>
 693 <TITLE>Unix Extensions</TITLE>
 694 glkunix_stream_open_pathname_gen
 695 glkunix_stream_open_pathname
 696 glkunix_set_base_file
 697 </SECTION>
 698
 699 <SECTION>
 700 <FILE>glkext-garglk</FILE>
 701 <TITLE>Gargoyle Extensions</TITLE>
 702 <INCLUDE>libchimara/glk.h, libchimara/garglk.h</INCLUDE>
 703 GARGLK
 704 <SUBSECTION Functions>
 705 garglk_fileref_get_name
 706 garglk_set_program_name
 707 garglk_set_program_info
 708 garglk_set_story_name
 709 garglk_set_story_title
 710 garglk_unput_string
 711 garglk_unput_string_uni
 712 garglk_set_zcolors
 713 garglk_set_zcolors_stream
 714 garglk_set_reversevideo
 715 garglk_set_reversevideo_stream
 716 <SUBSECTION Constants>
 717 zcolor_Current
 718 zcolor_Default
 719 zcolor_Cursor
 720 zcolor_Transparent
 721 keycode_Erase
 722 keycode_MouseWheelUp
 723 keycode_MouseWheelDown
 724 </SECTION>