docs/reference/chimara-sections.txt

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