Changeset 25783 in project


Ignore:
Timestamp:
01/07/12 22:20:40 (9 years ago)
Author:
svnwiki
Message:

Anonymous wiki edit for IP [70.71.179.201]: Fixed markup

File:
1 edited

Legend:

Unmodified
Added
Removed
  • wiki/eggref/4/physfs

    r25782 r25783  
    9999Fetches the opaque pointer contained within the file struct.
    100100
    101 ==== <type>archive-info</type>
     101==== Archives
     102
     103<type>archive-info</type>
    102104
    103105Information on various PhysicsFS-supported archives.
     
    105107This structure gives you details on what sort of archives are supported by this implementation of PhysicsFS. Archives tend to be things like ZIP files and such.
    106108
    107 * <procedure>(make-archive-info)</procedure> : Constructs an archive-info record, not that you should ever need to.
    108 * <procedure>(archive-info? archive-info)</procedure> : Tests if an object is an archive-info.
    109 * <procedure>(archive-info-extension archive-info)</procedure> : Archive file extension: "ZIP", for example.
    110 * <procedure>(archive-info-description archive-info)</procedure> : Human-readable archive description.
    111 * <procedure>(archive-info-author archive-info)</procedure> : Person who did support for this archive.
    112 * <procedure>(archive-info-url archive-info)</procedure> : URL related to this archive
    113 
    114 ==== <type>version</type>
     109<procedure>(make-archive-info)</procedure>
     110Constructs an archive-info record, not that you should ever need to.
     111
     112<procedure>(archive-info? archive-info)</procedure>
     113Tests if an object is an archive-info.
     114
     115<procedure>(archive-info-extension archive-info)</procedure>
     116Archive file extension: "ZIP", for example.
     117
     118<procedure>(archive-info-description archive-info)</procedure>
     119Human-readable archive description.
     120
     121<procedure>(archive-info-author archive-info)</procedure>
     122Person who did support for this archive.
     123
     124<procedure>(archive-info-url archive-info)</procedure>
     125URL related to this archive
     126
     127==== Versioning
     128
     129<type>version</type>
    115130
    116131Information the version of PhysicsFS in use.
     
    118133Represents the library's version as three levels: major revision (increments with massive changes, additions, and enhancements), minor revision (increments with backwards-compatible changes to the major revision), and patchlevel (increments with fixes to the minor revision).
    119134
    120 * <procedure>(make-version)</procedure> : Constructs a version record, not that you should ever need to.
    121 * <procedure>(version? version)</procedure> : Tests if an object is a version.
    122 * <procedure>(version-major version)</procedure> : major revision
    123 * <procedure>(version-minor version)</procedure> : minor revision
    124 * <procedure>(version-patch version)</procedure> : patch level
     135<procedure>(make-version)</procedure>
     136Constructs a version record, not that you should ever need to.
     137
     138<procedure>(version? version)</procedure>
     139Tests if an object is a version.
     140
     141<procedure>(version-major version)</procedure>
     142Fetches major revision.
     143
     144<procedure>(version-minor version)</procedure>
     145Fetches minor revision.
     146
     147<procedure>(version-patch version)</procedure>
     148Fetches patch level.
    125149
    126150=== PhysicsFS state
    127151
    128 ==== <procedure>(get-linked-version)</procedure>
     152<procedure>(get-linked-version)</procedure>
    129153
    130154Get the version of PhysicsFS that is linked against your program.
     
    134158This function may be called safely at any time, even before PHYSFS_init().
    135159
    136 ==== <procedure>(init)</procedure>
     160<procedure>(init)</procedure>
    137161
    138162 Initialize the PhysicsFS library.
     
    144168Returns nonzero on success, zero on error. Specifics of the error can be gleaned from (getLastError).
    145169
    146 ==== <procedure>(deinit)</procedure>
     170<procedure>(deinit)</procedure>
    147171
    148172Deinitialize the PhysicsFS library.
     
    156180Returns nonzero on success, zero on error. Specifics of the error can be gleaned from (getLastError). If failure, state of PhysFS is undefined, and probably badly screwed up.
    157181
    158 ==== <procedure>(supported-archive-types)</procedure>
     182<procedure>(supported-archive-types)</procedure>
    159183
    160184Get a list of supported archive types.
     
    164188The returned value is a list of ArchiveInfo records.
    165189
    166 ==== <procedure>(get-last-error)</procedure>
     190<procedure>(get-last-error)</procedure>
    167191
    168192Get human-readable error information.
     
    172196It is not wise to expect a specific string of characters here, since the error message may be localized into an unfamiliar language. These strings are meant to be passed on directly to the user.
    173197
    174 ==== <procedure>(get-dir-separator)</procedure>
     198<procedure>(get-dir-separator)</procedure>
    175199
    176200Get platform-dependent dir separator string.
     
    178202This returns "\\" on win32, "/" on Unix, and ":" on MacOS. It may be more than one character, depending on the platform, and your code should take that into account. Note that this is only useful for setting up the search/write paths, since access into those dirs always use '/' (platform-independent notation) to separate directories. This is also handy for getting platform-independent access when using stdio calls.
    179203
    180 ==== <procedure>(permit-symbolic-links bool)</procedure>
     204<procedure>(permit-symbolic-links bool)</procedure>
    181205
    182206Enable or disable following of symbolic links.
     
    192216Symbolic link permission can be enabled or disabled at any time after you've called (init), and is disabled by default.
    193217
    194 ==== <procedure>(get-cdrom-dirs)</procedure>
     218<procedure>(get-cdrom-dirs)</procedure>
    195219
    196220Get an array of paths to available CD-ROM drives.
     
    202226This call may block while drives spin up. Be forewarned.
    203227
    204 ==== <procedure>(get-base-dir)</procedure>
     228<procedure>(get-base-dir)</procedure>
    205229
    206230Get the path where the application resides.
     
    212236You should probably use the base dir in your search path.
    213237
    214 ==== <procedure>(get-user-dir)</procedure>
     238<procedure>(get-user-dir)</procedure>
    215239
    216240Get the path where user's home directory resides.
     
    222246You should probably use the user dir as the basis for your write dir, and also put it near the beginning of your search path.
    223247
    224 ==== <procedure>(get-write-dir)</procedure>
     248<procedure>(get-write-dir)</procedure>
    225249
    226250Get path where PhysicsFS will allow file writing.
     
    228252Get the current write dir. The default write dir is NULL.
    229253
    230 ==== <procedure>(set-write-dir dir)</procedure>
     254<procedure>(set-write-dir dir)</procedure>
    231255
    232256Tell PhysicsFS where it may write files.
     
    236260This call will fail (and fail to change the write dir) if the current write dir still has files open in it.
    237261
    238 ==== <procedure>(add-to-search-path newDir appendToPath)</procedure>
     262<procedure>(add-to-search-path newDir appendToPath)</procedure>
    239263
    240264Add an archive or directory to the search path.
     
    244268You must use this and not (mount) if binary compatibility with PhysicsFS 1.0 is important (which it may not be for many people).
    245269
    246 ==== <procedure>(remove-from-search-path oldDir)</procedure>
     270<procedure>(remove-from-search-path oldDir)</procedure>
    247271
    248272Remove a directory or archive from the search path.
     
    252276This call will fail (and fail to remove from the path) if the element still has files open in it.
    253277
    254 ==== <procedure>(get-search-path)</procedure>
     278<procedure>(get-search-path)</procedure>
    255279
    256280Get the current search path.
     
    258282The default search path is an empty list.
    259283
    260 ==== <procedure>(set-sane-config organization appName archiveExt includeCdRoms archivesFirst)</procedure>
     284<procedure>(set-sane-config organization appName archiveExt includeCdRoms archivesFirst)</procedure>
    261285
    262286Set up sane, default paths.
     
    279303=== Directory Management
    280304
    281 ==== <procedure>(mkdir dirName)</procedure>
     305<procedure>(mkdir dirName)</procedure>
    282306
    283307Create a directory.
     
    287311So if you've got the write dir set to "C:\mygame\writedir" and call (mkdir "downloads/maps") then the directories "C:\mygame\writedir\downloads" and "C:\mygame\writedir\downloads\maps" will be created if possible. If the creation of "maps" fails after we have successfully created "downloads", then the function leaves the created directory behind and reports failure.
    288312
    289 ==== <procedure>(delete filename)</procedure>
     313<procedure>(delete filename)</procedure>
    290314
    291315Delete a file or directory.
     
    303327Chances are, the bits that make up the file still exist, they are just made available to be written over at a later point. Don't consider this a security method or anything.  :)
    304328
    305 ==== <procedure>(get-real-dir filename)</procedure>
     329<procedure>(get-real-dir filename)</procedure>
    306330
    307331Figure out where in the search path a file resides.
     
    315339If you specify a fake directory that only exists as a mount point, it'll be associated with the first archive mounted there, even though that directory isn't necessarily contained in a real archive.
    316340
    317 ==== <procedure>(enumerate-files dir)</procedure>
     341<procedure>(enumerate-files dir)</procedure>
    318342
    319343Get a file listing of a search path's directory.
     
    323347Feel free to sort the list however you like. We only promise there will be no duplicates, but not what order the final list will come back in.
    324348
    325 ==== <procedure>(exists filename)</procedure>
     349<procedure>(exists filename)</procedure>
    326350
    327351Determine if a file exists in the search path.
     
    331355Note that entries that are symlinks are ignored if (permitSymbolicLinks #t) hasn't been called, so you might end up further down in the search path than expected.
    332356
    333 ==== <procedure>(directory? filename)</procedure>
     357<procedure>(directory? filename)</procedure>
    334358
    335359Determine if a file in the search path is really a directory.
     
    339363Note that entries that are symlinks are ignored if (permitSymbolicLinks #t) hasn't been called, so you might end up further down in the search path than expected.
    340364
    341 ==== <procedure>(symbolic-link? filename)</procedure>
     365<procedure>(symbolic-link? filename)</procedure>
    342366
    343367Determine if a file in the search path is really a symbolic link.
     
    347371Note that entries that are symlinks are ignored if (permitSymbolicLinks #t) hasn't been called, and as such, this function will always return 0 in that case.
    348372
    349 ==== <procedure>(get-last-mod-time filename)</procedure>
     373<procedure>(get-last-mod-time filename)</procedure>
    350374
    351375Get the last modification time of a file.
     
    355379=== Input/Output
    356380
    357 ==== <procedure>(open-write filename)</procedure>
     381<procedure>(open-write filename)</procedure>
    358382
    359383Open a file for writing.
     
    363387Note that entries that are symlinks are ignored if (permitSymbolicLinks #t) hasn't been called, and opening a symlink with this function will fail in such a case.
    364388
    365 ==== <procedure>(open-append filename)</procedure>
     389<procedure>(open-append filename)</procedure>
    366390
    367391Open a file for appending.
     
    371395Note that entries that are symlinks are ignored if (permitSymbolicLinks #t) hasn't been called, and opening a symlink with this function will fail in such a case.
    372396
    373 ==== <procedure>(open-read filename)</procedure>
     397<procedure>(open-read filename)</procedure>
    374398
    375399Open a file for reading.
     
    379403Note that entries that are symlinks are ignored if (permitSymbolicLinks #t) hasn't been called, and opening a symlink with this function will fail in such a case.
    380404
    381 ==== <procedure>(close handle)</procedure>
     405<procedure>(close handle)</procedure>
    382406
    383407Close a PhysicsFS filehandle.
     
    385409This call is capable of failing if the operating system was buffering writes to the physical media, and, now forced to write those changes to physical media, can not store the data for some reason. In such a case, the filehandle stays open. A well-written program should ALWAYS check the return value from the close call in addition to every writing call!
    386410
    387 ==== <procedure>(read handle buffer objSize objCount)</procedure>
     411<procedure>(read handle buffer objSize objCount)</procedure>
    388412
    389413Read data from a PhysicsFS filehandle
     
    391415The file must be opened for reading.
    392416
    393 ==== <procedure>(write handle buffer objSize objCount)</procedure>
     417<procedure>(write handle buffer objSize objCount)</procedure>
    394418
    395419Write data to a PhysicsFS filehandle
     
    399423=== File Positioning
    400424
    401 ==== <procedure>(eof handle)</procedure>
     425<procedure>(eof handle)</procedure>
    402426
    403427Check for end-of-file state on a PhysicsFS filehandle.
     
    405429Determine if the end of file has been reached in a PhysicsFS filehandle.
    406430
    407 ==== <procedure>(tell handle)</procedure>
     431<procedure>(tell handle)</procedure>
    408432
    409433Determine current position within a PhysicsFS filehandle.
    410434
    411 ==== <procedure>(seek handle pos)</procedure>
     435<procedure>(seek handle pos)</procedure>
    412436
    413437Seek to a new position within a PhysicsFS filehandle.
     
    415439The next read or write will occur at that place. Seeking past the beginning or end of the file is not allowed, and causes an error.
    416440
    417 ==== <procedure>(file-length handle)</procedure>
     441<procedure>(file-length handle)</procedure>
    418442
    419443Get total length of a file in bytes.
     
    423447=== Buffering
    424448
    425 ==== <procedure>(set-buffer handle bufsize)</procedure>
     449<procedure>(set-buffer handle bufsize)</procedure>
    426450
    427451Set up buffering for a PhysicsFS file handle.
     
    441465Please check the return value of this function! Failures can include not being able to seek backwards in a read-only file when removing the buffer, not being able to allocate the buffer, and not being able to flush the buffer to disk, among other unexpected problems.
    442466
    443 ==== <procedure>(flush handle)</procedure>
     467<procedure>(flush handle)</procedure>
    444468
    445469Flush a buffered PhysicsFS file handle.
     
    451475=== Byte Ordering
    452476
    453 ==== <procedure>(swap-sle16 val)</procedure>
     477<procedure>(swap-sle16 val)</procedure>
    454478
    455479Swap littleendian signed 16 to platform's native byte order.
     
    457481Take a 16-bit signed value in littleendian format and convert it to the platform's native byte order.
    458482
    459 ==== <procedure>(swap-ule16 val)</procedure>
     483<procedure>(swap-ule16 val)</procedure>
    460484
    461485Swap littleendian unsigned 16 to platform's native byte order.
     
    463487Take a 16-bit unsigned value in littleendian format and convert it to the platform's native byte order.
    464488
    465 ==== <procedure>(swap-sle32 val)</procedure>
     489<procedure>(swap-sle32 val)</procedure>
    466490
    467491Swap littleendian signed 32 to platform's native byte order.
     
    469493Take a 32-bit signed value in littleendian format and convert it to the platform's native byte order.
    470494
    471 ==== <procedure>(swap-ule32 val)</procedure>
     495<procedure>(swap-ule32 val)</procedure>
    472496
    473497Swap littleendian unsigned 32 to platform's native byte order.
     
    475499Take a 32-bit unsigned value in littleendian format and convert it to the platform's native byte order.
    476500
    477 ==== <procedure>(swap-sle64 val)</procedure>
     501<procedure>(swap-sle64 val)</procedure>
    478502
    479503Swap littleendian signed 64 to platform's native byte order.
     
    481505Take a 64-bit signed value in littleendian format and convert it to the platform's native byte order.
    482506
    483 ==== <procedure>(swap-ule64 val)</procedure>
     507<procedure>(swap-ule64 val)</procedure>
    484508
    485509Swap littleendian unsigned 64 to platform's native byte order.
     
    487511Take a 64-bit unsigned value in littleendian format and convert it to the platform's native byte order.
    488512
    489 ==== <procedure>(swap-sbe16 val)</procedure>
     513<procedure>(swap-sbe16 val)</procedure>
    490514
    491515Swap bigendian signed 16 to platform's native byte order.
     
    493517Take a 16-bit signed value in bigendian format and convert it to the platform's native byte order.
    494518
    495 ==== <procedure>(swap-ube16 val)</procedure>
     519<procedure>(swap-ube16 val)</procedure>
    496520
    497521Swap bigendian unsigned 16 to platform's native byte order.
     
    499523Take a 16-bit unsigned value in bigendian format and convert it to the platform's native byte order.
    500524
    501 ==== <procedure>(swap-sbe32 val)</procedure>
     525<procedure>(swap-sbe32 val)</procedure>
    502526
    503527Swap bigendian signed 32 to platform's native byte order.
     
    505529Take a 32-bit signed value in bigendian format and convert it to the platform's native byte order.
    506530
    507 ==== <procedure>(swap-ube32 val)</procedure>
     531<procedure>(swap-ube32 val)</procedure>
    508532
    509533Swap bigendian unsigned 32 to platform's native byte order.
     
    511535Take a 32-bit unsigned value in bigendian format and convert it to the platform's native byte order.
    512536
    513 ==== <procedure>(swap-sbe64 val)</procedure>
     537<procedure>(swap-sbe64 val)</procedure>
    514538
    515539Swap bigendian signed 64 to platform's native byte order.
     
    517541Take a 64-bit signed value in bigendian format and convert it to the platform's native byte order.
    518542
    519 ==== <procedure>(swap-ube64 val)</procedure>
     543<procedure>(swap-ube64 val)</procedure>
    520544
    521545Swap bigendian unsigned 64 to platform's native byte order.
     
    523547Take a 64-bit unsigned value in bigendian format and convert it to the platform's native byte order.
    524548
    525 ==== <procedure>(read-sle16 file)</procedure>
     549<procedure>(read-sle16 file)</procedure>
    526550
    527551Read and convert a signed 16-bit littleendian value.
     
    529553Convenience function. Read a signed 16-bit littleendian value from a file and convert it to the platform's native byte order.
    530554
    531 ==== <procedure>(read-ule16 file)</procedure>
     555<procedure>(read-ule16 file)</procedure>
    532556
    533557Read and convert an unsigned 16-bit littleendian value.
     
    535559Convenience function. Read an unsigned 16-bit littleendian value from a file and convert it to the platform's native byte order.
    536560
    537 ==== <procedure>(read-sbe16 file)</procedure>
     561<procedure>(read-sbe16 file)</procedure>
    538562
    539563Read and convert a signed 16-bit bigendian value.
     
    541565Convenience function. Read a signed 16-bit bigendian value from a file and convert it to the platform's native byte order.
    542566
    543 ==== <procedure>(read-ube16 file)</procedure>
     567<procedure>(read-ube16 file)</procedure>
    544568
    545569Read and convert an unsigned 16-bit bigendian value.
     
    547571Convenience function. Read an unsigned 16-bit bigendian value from a file and convert it to the platform's native byte order.
    548572
    549 ==== <procedure>(read-sle32 file)</procedure>
     573<procedure>(read-sle32 file)</procedure>
    550574
    551575Read and convert a signed 32-bit littleendian value.
     
    553577Convenience function. Read a signed 32-bit littleendian value from a file and convert it to the platform's native byte order.
    554578
    555 ==== <procedure>(read-ule32 file)</procedure>
     579<procedure>(read-ule32 file)</procedure>
    556580
    557581Read and convert an unsigned 32-bit littleendian value.
     
    559583Convenience function. Read an unsigned 32-bit littleendian value from a file and convert it to the platform's native byte order.
    560584
    561 ==== <procedure>(read-sbe32 file)</procedure>
     585<procedure>(read-sbe32 file)</procedure>
    562586
    563587Read and convert a signed 32-bit bigendian value.
     
    565589Convenience function. Read a signed 32-bit bigendian value from a file and convert it to the platform's native byte order.
    566590
    567 ==== <procedure>(read-ube32 file)</procedure>
     591<procedure>(read-ube32 file)</procedure>
    568592
    569593Read and convert an unsigned 32-bit bigendian value.
     
    571595Convenience function. Read an unsigned 32-bit bigendian value from a file and convert it to the platform's native byte order.
    572596
    573 ==== <procedure>(read-sle64 file)</procedure>
     597<procedure>(read-sle64 file)</procedure>
    574598
    575599Read and convert a signed 64-bit littleendian value.
     
    577601Convenience function. Read a signed 64-bit littleendian value from a file and convert it to the platform's native byte order.
    578602
    579 ==== <procedure>(read-ule64 file)</procedure>
     603<procedure>(read-ule64 file)</procedure>
    580604
    581605Read and convert an unsigned 64-bit littleendian value.
     
    583607Convenience function. Read an unsigned 64-bit littleendian value from a file and convert it to the platform's native byte order.
    584608
    585 ==== <procedure>(read-sbe64 file)</procedure>
     609<procedure>(read-sbe64 file)</procedure>
    586610
    587611Read and convert a signed 64-bit bigendian value.
     
    589613Convenience function. Read a signed 64-bit bigendian value from a file and convert it to the platform's native byte order.
    590614
    591 ==== <procedure>(read-ube64 file)</procedure>
     615<procedure>(read-ube64 file)</procedure>
    592616
    593617Read and convert an unsigned 64-bit bigendian value.
     
    595619Convenience function. Read an unsigned 64-bit bigendian value from a file and convert it to the platform's native byte order.
    596620
    597 ==== <procedure>(write-sle16 file val)</procedure>
     621<procedure>(write-sle16 file val)</procedure>
    598622
    599623Convert and write a signed 16-bit littleendian value.
     
    601625Convenience function. Convert a signed 16-bit value from the platform's native byte order to littleendian and write it to a file.
    602626
    603 ==== <procedure>(write-ule16 file val)</procedure>
     627<procedure>(write-ule16 file val)</procedure>
    604628
    605629Convert and write an unsigned 16-bit littleendian value.
     
    607631Convenience function. Convert an unsigned 16-bit value from the platform's native byte order to littleendian and write it to a file.
    608632
    609 ==== <procedure>(write-sbe16 file val)</procedure>
     633<procedure>(write-sbe16 file val)</procedure>
    610634
    611635Convert and write a signed 16-bit bigendian value.
     
    613637Convenience function. Convert a signed 16-bit value from the platform's native byte order to bigendian and write it to a file.
    614638
    615 ==== <procedure>(write-ube16 file val)</procedure>
     639<procedure>(write-ube16 file val)</procedure>
    616640
    617641Convert and write an unsigned 16-bit bigendian value.
     
    619643Convenience function. Convert an unsigned 16-bit value from the platform's native byte order to bigendian and write it to a file.
    620644
    621 ==== <procedure>(write-sle32 file val)</procedure>
     645<procedure>(write-sle32 file val)</procedure>
    622646
    623647Convert and write a signed 32-bit littleendian value.
     
    625649Convenience function. Convert a signed 32-bit value from the platform's native byte order to littleendian and write it to a file.
    626650
    627 ==== <procedure>(write-ule32 file val)</procedure>
     651<procedure>(write-ule32 file val)</procedure>
    628652
    629653Convert and write an unsigned 32-bit littleendian value.
     
    631655Convenience function. Convert an unsigned 32-bit value from the platform's native byte order to littleendian and write it to a file.
    632656
    633 ==== <procedure>(write-sbe32 file val)</procedure>
     657<procedure>(write-sbe32 file val)</procedure>
    634658
    635659Convert and write a signed 32-bit bigendian value.
     
    637661Convenience function. Convert a signed 32-bit value from the platform's native byte order to bigendian and write it to a file.
    638662
    639 ==== <procedure>(write-ube32 file val)</procedure>
     663<procedure>(write-ube32 file val)</procedure>
    640664
    641665Convert and write an unsigned 32-bit bigendian value.
     
    643667Convenience function. Convert an unsigned 32-bit value from the platform's native byte order to bigendian and write it to a file.
    644668
    645 ==== <procedure>(write-sle64 file val)</procedure>
     669<procedure>(write-sle64 file val)</procedure>
    646670
    647671Convert and write a signed 64-bit littleendian value.
     
    649673Convenience function. Convert a signed 64-bit value from the platform's native byte order to littleendian and write it to a file.
    650674
    651 ==== <procedure>(write-ule64 file val)</procedure>
     675<procedure>(write-ule64 file val)</procedure>
    652676
    653677Convert and write an unsigned 64-bit littleendian value.
     
    655679Convenience function. Convert an unsigned 64-bit value from the platform's native byte order to littleendian and write it to a file.
    656680
    657 ==== <procedure>(write-sbe64 file val)</procedure>
     681<procedure>(write-sbe64 file val)</procedure>
    658682
    659683Convert and write a signed 64-bit bigending value.
     
    661685Convenience function. Convert a signed 64-bit value from the platform's native byte order to bigendian and write it to a file.
    662686
    663 ==== <procedure>(write-ube64 file val)</procedure>
     687<procedure>(write-ube64 file val)</procedure>
    664688
    665689Convert and write an unsigned 64-bit bigendian value.
     
    669693== PhysicsFS 2.0 Functionality
    670694
    671 ==== <procedure>(init?)</procedure>
     695<procedure>(init?)</procedure>
    672696
    673697Determine if the PhysicsFS library is initialized.
     
    675699Once (init) returns successfully, this will return non-zero. Before a successful (init) and after (deinit) returns successfully, this will return zero. This function is safe to call at any time.
    676700
    677 ==== <procedure>(symbolic-links-permitted)</procedure>
     701<procedure>(symbolic-links-permitted)</procedure>
    678702
    679703Determine if the symbolic links are permitted.
     
    681705This reports the setting from the last call to (permit-symbolic-links). If (permitSymbolicLinks) hasn't been called since the library was last initialized, symbolic links are implicitly disabled.
    682706
    683 ==== <procedure>(mount newDir mountPoint appendToPath)</procedure>
     707<procedure>(mount newDir mountPoint appendToPath)</procedure>
    684708
    685709Add an archive or directory to the search path.
     
    691715The mountpoint does not need to exist prior to mounting, which is different than those familiar with the Unix concept of "mounting" may not expect. As well, more than one archive can be mounted to the same mountpoint, or mountpoints and archive contents can overlap...the interpolation mechanism still functions as usual.
    692716
    693 ==== <procedure>(getMountPoint dir)</procedure>
     717<procedure>(getMountPoint dir)</procedure>
    694718
    695719Determine a mounted archive's mountpoint.
     
    699723=== UTF8 Functions
    700724
    701 ==== <procedure>(utf8-from-ucs4 src len)</procedure>
     725<procedure>(utf8-from-ucs4 src len)</procedure>
    702726
    703727Convert a UCS-4 string to a UTF-8 string.
     
    705729UCS-4 strings are 32-bits per character: \c wchar_t on Unix.
    706730
    707 ==== <procedure>(utf8-to-ucs4 src len)</procedure>
     731<procedure>(utf8-to-ucs4 src len)</procedure>
    708732
    709733Convert a UTF-8 string to a UCS-4 string.
     
    711735UCS-4 strings are 32-bits per character: \c wchar_t on Unix.
    712736
    713 ==== <procedure>(utf8-from-ucs2 src len)</procedure>
     737<procedure>(utf8-from-ucs2 src len)</procedure>
    714738
    715739Convert a UCS-2 string to a UTF-8 string.
     
    719743Please note that UCS-2 is not UTF-16; we do not support the "surrogate" values at this time.
    720744
    721 ==== <procedure>(utf8-to-ucs2 src len)</procedure>
     745<procedure>(utf8-to-ucs2 src len)</procedure>
    722746
    723747Convert a UTF-8 string to a UCS-2 string.
     
    727751Please note that UCS-2 is not UTF-16; we do not support the "surrogate" values at this time.
    728752
    729 ==== <procedure>(utf8-from-latin1 src len)</procedure>
     753<procedure>(utf8-from-latin1 src len)</procedure>
    730754
    731755Convert a UTF-8 string to a Latin1 string.
     
    737761=== Convenience Functions
    738762
    739 ==== <procedure>(read-from-file file-name)</procedure>
     763<procedure>(read-from-file file-name)</procedure>
    740764
    741765Assuming that PhysicsFS has been initialized and that a location has been mounted, this function will read an entire file into a <type>blob</type>.
     
    743767Throws errors if the parameter is not a string, or if the declared file name cannot be found, or if PhysicsFS is not initialized.
    744768
    745 ==== <procedure>(write-to-file file-name data)</procedure>
     769<procedure>(write-to-file file-name data)</procedure>
    746770
    747771Assuming that PhysicsFS has been initialized and that a mount point is available; given a file name and a <type>blob</type> this function will write the entire contents of the blob to the file.
Note: See TracChangeset for help on using the changeset viewer.