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