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