physfs.h
author Ryan C. Gordon <icculus@icculus.org>
Sun, 24 Mar 2002 19:47:33 +0000
changeset 132 b53fa5093749
parent 128 31f754165105
child 137 66bddb94b6e0
permissions -rw-r--r--
Added typedefs and platform-specific i/o.
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
1
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
     1
/**
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
     2
 * PhysicsFS; a portable, flexible file i/o abstraction.
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
     3
 *
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
     4
 * This API gives you access to a system file system in ways superior to the
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
     5
 *  stdio or system i/o calls. The brief benefits:
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
     6
 *
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
     7
 *   - It's portable.
2
24ba671694af Fixed typos, expanded documentation, added init and deinit functions, and
Ryan C. Gordon <icculus@icculus.org>
parents: 1
diff changeset
     8
 *   - It's safe. No file access is permitted outside the specified dirs.
1
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
     9
 *   - It's flexible. Archives (.ZIP files) can be used transparently as
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    10
 *      directory structures.
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    11
 *
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    12
 * This system is largely inspired by Quake 3's PK3 files and the related
2
24ba671694af Fixed typos, expanded documentation, added init and deinit functions, and
Ryan C. Gordon <icculus@icculus.org>
parents: 1
diff changeset
    13
 *  fs_* cvars. If you've ever tinkered with these, then this API will be
1
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    14
 *  familiar to you.
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    15
 *
6
3662cbc014ef More updates, corrections, clarifications...
Ryan C. Gordon <icculus@icculus.org>
parents: 3
diff changeset
    16
 * With PhysicsFS, you have a single writing directory and multiple
3662cbc014ef More updates, corrections, clarifications...
Ryan C. Gordon <icculus@icculus.org>
parents: 3
diff changeset
    17
 *  directories (the "search path") for reading. You can think of this as a
3662cbc014ef More updates, corrections, clarifications...
Ryan C. Gordon <icculus@icculus.org>
parents: 3
diff changeset
    18
 *  filesystem within a filesystem. If (on Windows) you were to set the
3662cbc014ef More updates, corrections, clarifications...
Ryan C. Gordon <icculus@icculus.org>
parents: 3
diff changeset
    19
 *  writing directory to "C:\MyGame\MyWritingDirectory", then no PHYSFS calls
3662cbc014ef More updates, corrections, clarifications...
Ryan C. Gordon <icculus@icculus.org>
parents: 3
diff changeset
    20
 *  could touch anything above this directory, including the "C:\MyGame" and
3662cbc014ef More updates, corrections, clarifications...
Ryan C. Gordon <icculus@icculus.org>
parents: 3
diff changeset
    21
 *  "C:\" directories. This prevents an application's internal scripting
3662cbc014ef More updates, corrections, clarifications...
Ryan C. Gordon <icculus@icculus.org>
parents: 3
diff changeset
    22
 *  language from piddling over c:\config.sys, for example. If you'd rather
3662cbc014ef More updates, corrections, clarifications...
Ryan C. Gordon <icculus@icculus.org>
parents: 3
diff changeset
    23
 *  give PHYSFS full access to the system's REAL file system, set the writing
3662cbc014ef More updates, corrections, clarifications...
Ryan C. Gordon <icculus@icculus.org>
parents: 3
diff changeset
    24
 *  dir to "C:\", but that's generally A Bad Thing for several reasons.
1
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    25
 *
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    26
 * Drive letters are hidden in PhysicsFS once you set up your initial paths.
6
3662cbc014ef More updates, corrections, clarifications...
Ryan C. Gordon <icculus@icculus.org>
parents: 3
diff changeset
    27
 *  The search path creates a single, hierarchical directory structure.
1
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    28
 *  Not only does this lend itself well to general abstraction with archives,
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    29
 *  it also gives better support to operating systems like MacOS and Unix.
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    30
 *  Generally speaking, you shouldn't ever hardcode a drive letter; not only
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    31
 *  does this hurt portability to non-Microsoft OSes, but it limits your win32
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    32
 *  users to a single drive, too. Use the PhysicsFS abstraction functions and
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    33
 *  allow user-defined configuration options, too. When opening a file, you
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    34
 *  specify it like it was on a Unix filesystem: if you want to write to
6
3662cbc014ef More updates, corrections, clarifications...
Ryan C. Gordon <icculus@icculus.org>
parents: 3
diff changeset
    35
 *  "C:\MyGame\MyConfigFiles\game.cfg", then you might set the write dir to
1
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    36
 *  "C:\MyGame" and then open "MyConfigFiles/game.cfg". This gives an
2
24ba671694af Fixed typos, expanded documentation, added init and deinit functions, and
Ryan C. Gordon <icculus@icculus.org>
parents: 1
diff changeset
    37
 *  abstraction across all platforms. Specifying a file in this way is termed
6
3662cbc014ef More updates, corrections, clarifications...
Ryan C. Gordon <icculus@icculus.org>
parents: 3
diff changeset
    38
 *  "platform-independent notation" in this documentation. Specifying a
3662cbc014ef More updates, corrections, clarifications...
Ryan C. Gordon <icculus@icculus.org>
parents: 3
diff changeset
    39
 *  a filename in a form such as "C:\mydir\myfile" or
3662cbc014ef More updates, corrections, clarifications...
Ryan C. Gordon <icculus@icculus.org>
parents: 3
diff changeset
    40
 *  "MacOS hard drive:My Directory:My File" is termed "platform-dependent
3662cbc014ef More updates, corrections, clarifications...
Ryan C. Gordon <icculus@icculus.org>
parents: 3
diff changeset
    41
 *  notation". The only time you use platform-dependent notation is when
3662cbc014ef More updates, corrections, clarifications...
Ryan C. Gordon <icculus@icculus.org>
parents: 3
diff changeset
    42
 *  setting up your write directory and search path; after that, all file
3662cbc014ef More updates, corrections, clarifications...
Ryan C. Gordon <icculus@icculus.org>
parents: 3
diff changeset
    43
 *  access into those directories are done with platform-independent notation.
1
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    44
 *
6
3662cbc014ef More updates, corrections, clarifications...
Ryan C. Gordon <icculus@icculus.org>
parents: 3
diff changeset
    45
 * All files opened for writing are opened in relation to the write directory,
1
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    46
 *  which is the root of the writable filesystem. When opening a file for
6
3662cbc014ef More updates, corrections, clarifications...
Ryan C. Gordon <icculus@icculus.org>
parents: 3
diff changeset
    47
 *  reading, PhysicsFS goes through the search path. This is NOT the
1
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    48
 *  same thing as the PATH environment variable. An application using
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    49
 *  PhysicsFS specifies directories to be searched which may be actual
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    50
 *  directories, or archive files that contain files and subdirectories of
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    51
 *  their own. See the end of these docs for currently supported archive
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    52
 *  formats.
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    53
 *
6
3662cbc014ef More updates, corrections, clarifications...
Ryan C. Gordon <icculus@icculus.org>
parents: 3
diff changeset
    54
 * Once the search path is defined, you may open files for reading. If you've
1
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    55
 *  got the following search path defined (to use a win32 example again):
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    56
 *
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    57
 *    C:\mygame
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    58
 *    C:\mygame\myuserfiles
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    59
 *    D:\mygamescdromdatafiles
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    60
 *    C:\mygame\installeddatafiles.zip
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    61
 *
6
3662cbc014ef More updates, corrections, clarifications...
Ryan C. Gordon <icculus@icculus.org>
parents: 3
diff changeset
    62
 * Then a call to PHYSFS_openRead("textfiles/myfile.txt") (note the directory
2
24ba671694af Fixed typos, expanded documentation, added init and deinit functions, and
Ryan C. Gordon <icculus@icculus.org>
parents: 1
diff changeset
    63
 *  separator, lack of drive letter, and lack of dir separator at the start of
24ba671694af Fixed typos, expanded documentation, added init and deinit functions, and
Ryan C. Gordon <icculus@icculus.org>
parents: 1
diff changeset
    64
 *  the string; this is platform-independent notation) will check for
24ba671694af Fixed typos, expanded documentation, added init and deinit functions, and
Ryan C. Gordon <icculus@icculus.org>
parents: 1
diff changeset
    65
 *  C:\mygame\textfiles\myfile.txt, then
1
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    66
 *  C:\mygame\myuserfiles\textfiles\myfile.txt, then
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    67
 *  D:\mygamescdromdatafiles\textfiles\myfile.txt, then, finally, for
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    68
 *  textfiles\myfile.txt inside of C:\mygame\installeddatafiles.zip. Remember
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    69
 *  that most archive types and platform filesystems store their filenames in
2
24ba671694af Fixed typos, expanded documentation, added init and deinit functions, and
Ryan C. Gordon <icculus@icculus.org>
parents: 1
diff changeset
    70
 *  a case-sensitive manner, so you should be careful to specify it correctly.
1
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    71
 *
6
3662cbc014ef More updates, corrections, clarifications...
Ryan C. Gordon <icculus@icculus.org>
parents: 3
diff changeset
    72
 * Files opened through PhysicsFS may NOT contain "." or ".." or ":" as dir
3662cbc014ef More updates, corrections, clarifications...
Ryan C. Gordon <icculus@icculus.org>
parents: 3
diff changeset
    73
 *  elements. Not only are these meaningless on MacOS and/or Unix, they are a
3662cbc014ef More updates, corrections, clarifications...
Ryan C. Gordon <icculus@icculus.org>
parents: 3
diff changeset
    74
 *  security hole. Also, symbolic links (which can be found in some archive
3662cbc014ef More updates, corrections, clarifications...
Ryan C. Gordon <icculus@icculus.org>
parents: 3
diff changeset
    75
 *  types and directly in the filesystem on Unix platforms) are NOT followed
3662cbc014ef More updates, corrections, clarifications...
Ryan C. Gordon <icculus@icculus.org>
parents: 3
diff changeset
    76
 *  until you call PHYSFS_permitSymbolicLinks(). That's left to your own
3662cbc014ef More updates, corrections, clarifications...
Ryan C. Gordon <icculus@icculus.org>
parents: 3
diff changeset
    77
 *  discretion, as following a symlink can allow for access outside the write
3662cbc014ef More updates, corrections, clarifications...
Ryan C. Gordon <icculus@icculus.org>
parents: 3
diff changeset
    78
 *  dir and search paths. There is no mechanism for creating new symlinks in
3662cbc014ef More updates, corrections, clarifications...
Ryan C. Gordon <icculus@icculus.org>
parents: 3
diff changeset
    79
 *  PhysicsFS.
1
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    80
 *
6
3662cbc014ef More updates, corrections, clarifications...
Ryan C. Gordon <icculus@icculus.org>
parents: 3
diff changeset
    81
 * The write dir is not included in the search path unless you specifically
3662cbc014ef More updates, corrections, clarifications...
Ryan C. Gordon <icculus@icculus.org>
parents: 3
diff changeset
    82
 *  add it. While you CAN change the write dir as many times as you like,
3662cbc014ef More updates, corrections, clarifications...
Ryan C. Gordon <icculus@icculus.org>
parents: 3
diff changeset
    83
 *  you should probably set it once and stick to it. Remember that your
3662cbc014ef More updates, corrections, clarifications...
Ryan C. Gordon <icculus@icculus.org>
parents: 3
diff changeset
    84
 *  program will not have permission to write in every directory on Unix and
3662cbc014ef More updates, corrections, clarifications...
Ryan C. Gordon <icculus@icculus.org>
parents: 3
diff changeset
    85
 *  NT systems.
1
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    86
 *
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    87
 * All files are opened in binary mode; there is no endline conversion for
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    88
 *  textfiles. Other than that, PhysicsFS has some convenience functions for
3
0dd785321345 Boatloads of updates to the spec.
Ryan C. Gordon <icculus@icculus.org>
parents: 2
diff changeset
    89
 *  platform-independence. There is a function to tell you the current
6
3662cbc014ef More updates, corrections, clarifications...
Ryan C. Gordon <icculus@icculus.org>
parents: 3
diff changeset
    90
 *  platform's dir separator ("\\" on windows, "/" on Unix, ":" on MacOS),
3
0dd785321345 Boatloads of updates to the spec.
Ryan C. Gordon <icculus@icculus.org>
parents: 2
diff changeset
    91
 *  which is needed only to set up your search/write paths. There is a
0dd785321345 Boatloads of updates to the spec.
Ryan C. Gordon <icculus@icculus.org>
parents: 2
diff changeset
    92
 *  function to tell you what CD-ROM drives contain accessible discs, and a
0dd785321345 Boatloads of updates to the spec.
Ryan C. Gordon <icculus@icculus.org>
parents: 2
diff changeset
    93
 *  function to recommend a good search path, etc.
1
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    94
 *
6
3662cbc014ef More updates, corrections, clarifications...
Ryan C. Gordon <icculus@icculus.org>
parents: 3
diff changeset
    95
 * A recommended order for the search path is the write dir, then the base dir,
3662cbc014ef More updates, corrections, clarifications...
Ryan C. Gordon <icculus@icculus.org>
parents: 3
diff changeset
    96
 *  then the cdrom dir, then any archives discovered. Quake 3 does something
3
0dd785321345 Boatloads of updates to the spec.
Ryan C. Gordon <icculus@icculus.org>
parents: 2
diff changeset
    97
 *  like this, but moves the archives to the start of the search path. Build
0dd785321345 Boatloads of updates to the spec.
Ryan C. Gordon <icculus@icculus.org>
parents: 2
diff changeset
    98
 *  Engine games, like Duke Nukem 3D and Blood, place the archives last, and
6
3662cbc014ef More updates, corrections, clarifications...
Ryan C. Gordon <icculus@icculus.org>
parents: 3
diff changeset
    99
 *  use the base dir for both searching and writing. There is a helper
3662cbc014ef More updates, corrections, clarifications...
Ryan C. Gordon <icculus@icculus.org>
parents: 3
diff changeset
   100
 *  function (PHYSFS_setSaneConfig()) that puts together a basic configuration
3
0dd785321345 Boatloads of updates to the spec.
Ryan C. Gordon <icculus@icculus.org>
parents: 2
diff changeset
   101
 *  for you, based on a few parameters. Also see the comments on
6
3662cbc014ef More updates, corrections, clarifications...
Ryan C. Gordon <icculus@icculus.org>
parents: 3
diff changeset
   102
 *  PHYSFS_getBaseDir(), and PHYSFS_getUserDir() for info on what those
3662cbc014ef More updates, corrections, clarifications...
Ryan C. Gordon <icculus@icculus.org>
parents: 3
diff changeset
   103
 *  are and how they can help you determine an optimal search path.
3662cbc014ef More updates, corrections, clarifications...
Ryan C. Gordon <icculus@icculus.org>
parents: 3
diff changeset
   104
 *
3662cbc014ef More updates, corrections, clarifications...
Ryan C. Gordon <icculus@icculus.org>
parents: 3
diff changeset
   105
 * PhysicsFS is (sort of) NOT thread safe! The error messages returned by
3662cbc014ef More updates, corrections, clarifications...
Ryan C. Gordon <icculus@icculus.org>
parents: 3
diff changeset
   106
 *  PHYSFS_getLastError are unique by thread, but that's it. Generally
3662cbc014ef More updates, corrections, clarifications...
Ryan C. Gordon <icculus@icculus.org>
parents: 3
diff changeset
   107
 *  speaking, we'd have to request a mutex at the start of each function,
3662cbc014ef More updates, corrections, clarifications...
Ryan C. Gordon <icculus@icculus.org>
parents: 3
diff changeset
   108
 *  and release it before returning. Not only is this REALLY slow, it requires
3662cbc014ef More updates, corrections, clarifications...
Ryan C. Gordon <icculus@icculus.org>
parents: 3
diff changeset
   109
 *  a thread lock portability layer to be written. All that work is only
3662cbc014ef More updates, corrections, clarifications...
Ryan C. Gordon <icculus@icculus.org>
parents: 3
diff changeset
   110
 *  necessary as a safety if the calling application is poorly written.
3662cbc014ef More updates, corrections, clarifications...
Ryan C. Gordon <icculus@icculus.org>
parents: 3
diff changeset
   111
 *  Generally speaking, it is safe to call most functions that don't set state
3662cbc014ef More updates, corrections, clarifications...
Ryan C. Gordon <icculus@icculus.org>
parents: 3
diff changeset
   112
 *  simultaneously; you can read and write and open and close different files
3662cbc014ef More updates, corrections, clarifications...
Ryan C. Gordon <icculus@icculus.org>
parents: 3
diff changeset
   113
 *  at the same time in different threads, but trying to set the write path in
3662cbc014ef More updates, corrections, clarifications...
Ryan C. Gordon <icculus@icculus.org>
parents: 3
diff changeset
   114
 *  one thread while opening a file for writing in another will, at best,
3662cbc014ef More updates, corrections, clarifications...
Ryan C. Gordon <icculus@icculus.org>
parents: 3
diff changeset
   115
 *  cause a polite error, but depending on the race condition results, you may
3662cbc014ef More updates, corrections, clarifications...
Ryan C. Gordon <icculus@icculus.org>
parents: 3
diff changeset
   116
 *  get a segfault and crash, too. Use your head, and implement you own thread
3662cbc014ef More updates, corrections, clarifications...
Ryan C. Gordon <icculus@icculus.org>
parents: 3
diff changeset
   117
 *  locks where needed. Also, consider if you REALLY need a multithreaded
3662cbc014ef More updates, corrections, clarifications...
Ryan C. Gordon <icculus@icculus.org>
parents: 3
diff changeset
   118
 *  solution in the first place.
1
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   119
 *
3
0dd785321345 Boatloads of updates to the spec.
Ryan C. Gordon <icculus@icculus.org>
parents: 2
diff changeset
   120
 * While you CAN use stdio/syscall file access in a program that has PHYSFS_*
0dd785321345 Boatloads of updates to the spec.
Ryan C. Gordon <icculus@icculus.org>
parents: 2
diff changeset
   121
 *  calls, doing so is not recommended, and you can not use system
1
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   122
 *  filehandles with PhysicsFS filehandles and vice versa.
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   123
 *
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   124
 * Note that archives need not be named as such: if you have a ZIP file and
3
0dd785321345 Boatloads of updates to the spec.
Ryan C. Gordon <icculus@icculus.org>
parents: 2
diff changeset
   125
 *  rename it with a .PKG extension, the file will still be recognized as a
1
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   126
 *  ZIP archive by PhysicsFS; the file's contents are used to determine its
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   127
 *  type.
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   128
 *
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   129
 * Currently supported archive types:
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   130
 *   - .ZIP (pkZip/WinZip/Info-ZIP compatible)
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   131
 *
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   132
 * Please see the file LICENSE in the source's root directory.
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   133
 *
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   134
 *  This file written by Ryan C. Gordon.
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   135
 */
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   136
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   137
#ifndef _INCLUDE_PHYSFS_H_
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   138
#define _INCLUDE_PHYSFS_H_
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   139
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   140
#ifdef __cplusplus
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   141
extern "C" {
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   142
#endif
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   143
74
a4a5066fb640 Compiles and runs on Visual C. What an uphill climb THAT was.
Ryan C. Gordon <icculus@icculus.org>
parents: 69
diff changeset
   144
#if (defined _MSC_VER)
a4a5066fb640 Compiles and runs on Visual C. What an uphill climb THAT was.
Ryan C. Gordon <icculus@icculus.org>
parents: 69
diff changeset
   145
#define __EXPORT__ __declspec(dllexport)
a4a5066fb640 Compiles and runs on Visual C. What an uphill climb THAT was.
Ryan C. Gordon <icculus@icculus.org>
parents: 69
diff changeset
   146
#else
a4a5066fb640 Compiles and runs on Visual C. What an uphill climb THAT was.
Ryan C. Gordon <icculus@icculus.org>
parents: 69
diff changeset
   147
#define __EXPORT__
a4a5066fb640 Compiles and runs on Visual C. What an uphill climb THAT was.
Ryan C. Gordon <icculus@icculus.org>
parents: 69
diff changeset
   148
#endif
a4a5066fb640 Compiles and runs on Visual C. What an uphill climb THAT was.
Ryan C. Gordon <icculus@icculus.org>
parents: 69
diff changeset
   149
1
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   150
132
b53fa5093749 Added typedefs and platform-specific i/o.
Ryan C. Gordon <icculus@icculus.org>
parents: 128
diff changeset
   151
/* !!! FIXME: This is not universal. */
b53fa5093749 Added typedefs and platform-specific i/o.
Ryan C. Gordon <icculus@icculus.org>
parents: 128
diff changeset
   152
typedef unsigned char         PHYSFS_uint8;
b53fa5093749 Added typedefs and platform-specific i/o.
Ryan C. Gordon <icculus@icculus.org>
parents: 128
diff changeset
   153
typedef signed char           PHYSFS_sint8;
b53fa5093749 Added typedefs and platform-specific i/o.
Ryan C. Gordon <icculus@icculus.org>
parents: 128
diff changeset
   154
typedef unsigned short        PHYSFS_uint16;
b53fa5093749 Added typedefs and platform-specific i/o.
Ryan C. Gordon <icculus@icculus.org>
parents: 128
diff changeset
   155
typedef signed short          PHYSFS_sint16;
b53fa5093749 Added typedefs and platform-specific i/o.
Ryan C. Gordon <icculus@icculus.org>
parents: 128
diff changeset
   156
typedef unsigned int          PHYSFS_uint32;
b53fa5093749 Added typedefs and platform-specific i/o.
Ryan C. Gordon <icculus@icculus.org>
parents: 128
diff changeset
   157
typedef signed int            PHYSFS_sint32;
b53fa5093749 Added typedefs and platform-specific i/o.
Ryan C. Gordon <icculus@icculus.org>
parents: 128
diff changeset
   158
b53fa5093749 Added typedefs and platform-specific i/o.
Ryan C. Gordon <icculus@icculus.org>
parents: 128
diff changeset
   159
#ifdef PHYSFS_NO_64BIT_SUPPORT  /* oh well. */
b53fa5093749 Added typedefs and platform-specific i/o.
Ryan C. Gordon <icculus@icculus.org>
parents: 128
diff changeset
   160
typedef PHYSFS_uint32         PHYSFS_uint64;
b53fa5093749 Added typedefs and platform-specific i/o.
Ryan C. Gordon <icculus@icculus.org>
parents: 128
diff changeset
   161
typedef PHYSFS_sint32         PHYSFS_sint64;
b53fa5093749 Added typedefs and platform-specific i/o.
Ryan C. Gordon <icculus@icculus.org>
parents: 128
diff changeset
   162
#else
b53fa5093749 Added typedefs and platform-specific i/o.
Ryan C. Gordon <icculus@icculus.org>
parents: 128
diff changeset
   163
typedef unsigned long long    PHYSFS_uint64;
b53fa5093749 Added typedefs and platform-specific i/o.
Ryan C. Gordon <icculus@icculus.org>
parents: 128
diff changeset
   164
typedef signed long long      PHYSFS_sint64;
b53fa5093749 Added typedefs and platform-specific i/o.
Ryan C. Gordon <icculus@icculus.org>
parents: 128
diff changeset
   165
#endif
b53fa5093749 Added typedefs and platform-specific i/o.
Ryan C. Gordon <icculus@icculus.org>
parents: 128
diff changeset
   166
b53fa5093749 Added typedefs and platform-specific i/o.
Ryan C. Gordon <icculus@icculus.org>
parents: 128
diff changeset
   167
/* Make sure the types really have the right sizes */
b53fa5093749 Added typedefs and platform-specific i/o.
Ryan C. Gordon <icculus@icculus.org>
parents: 128
diff changeset
   168
#define PHYSFS_COMPILE_TIME_ASSERT(name, x)               \
b53fa5093749 Added typedefs and platform-specific i/o.
Ryan C. Gordon <icculus@icculus.org>
parents: 128
diff changeset
   169
       typedef int PHYSFS_dummy_ ## name[(x) * 2 - 1]
b53fa5093749 Added typedefs and platform-specific i/o.
Ryan C. Gordon <icculus@icculus.org>
parents: 128
diff changeset
   170
b53fa5093749 Added typedefs and platform-specific i/o.
Ryan C. Gordon <icculus@icculus.org>
parents: 128
diff changeset
   171
PHYSFS_COMPILE_TIME_ASSERT(uint8, sizeof(PHYSFS_uint8) == 1);
b53fa5093749 Added typedefs and platform-specific i/o.
Ryan C. Gordon <icculus@icculus.org>
parents: 128
diff changeset
   172
PHYSFS_COMPILE_TIME_ASSERT(sint8, sizeof(PHYSFS_sint8) == 1);
b53fa5093749 Added typedefs and platform-specific i/o.
Ryan C. Gordon <icculus@icculus.org>
parents: 128
diff changeset
   173
PHYSFS_COMPILE_TIME_ASSERT(uint16, sizeof(PHYSFS_uint16) == 2);
b53fa5093749 Added typedefs and platform-specific i/o.
Ryan C. Gordon <icculus@icculus.org>
parents: 128
diff changeset
   174
PHYSFS_COMPILE_TIME_ASSERT(sint16, sizeof(PHYSFS_sint16) == 2);
b53fa5093749 Added typedefs and platform-specific i/o.
Ryan C. Gordon <icculus@icculus.org>
parents: 128
diff changeset
   175
PHYSFS_COMPILE_TIME_ASSERT(uint32, sizeof(PHYSFS_uint32) == 4);
b53fa5093749 Added typedefs and platform-specific i/o.
Ryan C. Gordon <icculus@icculus.org>
parents: 128
diff changeset
   176
PHYSFS_COMPILE_TIME_ASSERT(sint32, sizeof(PHYSFS_sint32) == 4);
b53fa5093749 Added typedefs and platform-specific i/o.
Ryan C. Gordon <icculus@icculus.org>
parents: 128
diff changeset
   177
b53fa5093749 Added typedefs and platform-specific i/o.
Ryan C. Gordon <icculus@icculus.org>
parents: 128
diff changeset
   178
#ifndef PHYSFS_NO_64BIT_SUPPORT
b53fa5093749 Added typedefs and platform-specific i/o.
Ryan C. Gordon <icculus@icculus.org>
parents: 128
diff changeset
   179
PHYSFS_COMPILE_TIME_ASSERT(uint64, sizeof(PHYSFS_uint64) == 8);
b53fa5093749 Added typedefs and platform-specific i/o.
Ryan C. Gordon <icculus@icculus.org>
parents: 128
diff changeset
   180
PHYSFS_COMPILE_TIME_ASSERT(sint64, sizeof(PHYSFS_sint64) == 8);
b53fa5093749 Added typedefs and platform-specific i/o.
Ryan C. Gordon <icculus@icculus.org>
parents: 128
diff changeset
   181
#endif
b53fa5093749 Added typedefs and platform-specific i/o.
Ryan C. Gordon <icculus@icculus.org>
parents: 128
diff changeset
   182
b53fa5093749 Added typedefs and platform-specific i/o.
Ryan C. Gordon <icculus@icculus.org>
parents: 128
diff changeset
   183
#undef PHYSFS_COMPILE_TIME_ASSERT
b53fa5093749 Added typedefs and platform-specific i/o.
Ryan C. Gordon <icculus@icculus.org>
parents: 128
diff changeset
   184
b53fa5093749 Added typedefs and platform-specific i/o.
Ryan C. Gordon <icculus@icculus.org>
parents: 128
diff changeset
   185
b53fa5093749 Added typedefs and platform-specific i/o.
Ryan C. Gordon <icculus@icculus.org>
parents: 128
diff changeset
   186
3
0dd785321345 Boatloads of updates to the spec.
Ryan C. Gordon <icculus@icculus.org>
parents: 2
diff changeset
   187
typedef struct __PHYSFS_FILE__
0dd785321345 Boatloads of updates to the spec.
Ryan C. Gordon <icculus@icculus.org>
parents: 2
diff changeset
   188
{
6
3662cbc014ef More updates, corrections, clarifications...
Ryan C. Gordon <icculus@icculus.org>
parents: 3
diff changeset
   189
    void *opaque;
3
0dd785321345 Boatloads of updates to the spec.
Ryan C. Gordon <icculus@icculus.org>
parents: 2
diff changeset
   190
} PHYSFS_file;
0dd785321345 Boatloads of updates to the spec.
Ryan C. Gordon <icculus@icculus.org>
parents: 2
diff changeset
   191
0dd785321345 Boatloads of updates to the spec.
Ryan C. Gordon <icculus@icculus.org>
parents: 2
diff changeset
   192
typedef struct __PHYSFS_ARCHIVEINFO__
0dd785321345 Boatloads of updates to the spec.
Ryan C. Gordon <icculus@icculus.org>
parents: 2
diff changeset
   193
{
0dd785321345 Boatloads of updates to the spec.
Ryan C. Gordon <icculus@icculus.org>
parents: 2
diff changeset
   194
    const char *extension;
0dd785321345 Boatloads of updates to the spec.
Ryan C. Gordon <icculus@icculus.org>
parents: 2
diff changeset
   195
    const char *description;
29
91b45664ec85 Added more fields to the ArchiveInfo struct: author and url.
Ryan C. Gordon <icculus@icculus.org>
parents: 28
diff changeset
   196
    const char *author;
91b45664ec85 Added more fields to the ArchiveInfo struct: author and url.
Ryan C. Gordon <icculus@icculus.org>
parents: 28
diff changeset
   197
    const char *url;
3
0dd785321345 Boatloads of updates to the spec.
Ryan C. Gordon <icculus@icculus.org>
parents: 2
diff changeset
   198
} PHYSFS_ArchiveInfo;
0dd785321345 Boatloads of updates to the spec.
Ryan C. Gordon <icculus@icculus.org>
parents: 2
diff changeset
   199
0dd785321345 Boatloads of updates to the spec.
Ryan C. Gordon <icculus@icculus.org>
parents: 2
diff changeset
   200
1
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   201
/* functions... */
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   202
6
3662cbc014ef More updates, corrections, clarifications...
Ryan C. Gordon <icculus@icculus.org>
parents: 3
diff changeset
   203
typedef struct __PHYSFS_VERSION__
3662cbc014ef More updates, corrections, clarifications...
Ryan C. Gordon <icculus@icculus.org>
parents: 3
diff changeset
   204
{
132
b53fa5093749 Added typedefs and platform-specific i/o.
Ryan C. Gordon <icculus@icculus.org>
parents: 128
diff changeset
   205
    PHYSFS_uint8 major;
b53fa5093749 Added typedefs and platform-specific i/o.
Ryan C. Gordon <icculus@icculus.org>
parents: 128
diff changeset
   206
    PHYSFS_uint8 minor;
b53fa5093749 Added typedefs and platform-specific i/o.
Ryan C. Gordon <icculus@icculus.org>
parents: 128
diff changeset
   207
    PHYSFS_uint8 patch;
6
3662cbc014ef More updates, corrections, clarifications...
Ryan C. Gordon <icculus@icculus.org>
parents: 3
diff changeset
   208
} PHYSFS_Version;
3662cbc014ef More updates, corrections, clarifications...
Ryan C. Gordon <icculus@icculus.org>
parents: 3
diff changeset
   209
3662cbc014ef More updates, corrections, clarifications...
Ryan C. Gordon <icculus@icculus.org>
parents: 3
diff changeset
   210
#define PHYSFS_VER_MAJOR 0
3662cbc014ef More updates, corrections, clarifications...
Ryan C. Gordon <icculus@icculus.org>
parents: 3
diff changeset
   211
#define PHYSFS_VER_MINOR 1
99
5a5a0d60cbf1 Updated version from 0.1.3 to 0.1.4.
Ryan C. Gordon <icculus@icculus.org>
parents: 80
diff changeset
   212
#define PHYSFS_VER_PATCH 4
6
3662cbc014ef More updates, corrections, clarifications...
Ryan C. Gordon <icculus@icculus.org>
parents: 3
diff changeset
   213
3662cbc014ef More updates, corrections, clarifications...
Ryan C. Gordon <icculus@icculus.org>
parents: 3
diff changeset
   214
#define PHYSFS_VERSION(x) { \
33
313a6bc49a46 Fixed bug in PHYSFS_VERSION macro.
Ryan C. Gordon <icculus@icculus.org>
parents: 29
diff changeset
   215
                            (x)->major = PHYSFS_VER_MAJOR; \
313a6bc49a46 Fixed bug in PHYSFS_VERSION macro.
Ryan C. Gordon <icculus@icculus.org>
parents: 29
diff changeset
   216
                            (x)->minor = PHYSFS_VER_MINOR; \
313a6bc49a46 Fixed bug in PHYSFS_VERSION macro.
Ryan C. Gordon <icculus@icculus.org>
parents: 29
diff changeset
   217
                            (x)->patch = PHYSFS_VER_PATCH; \
6
3662cbc014ef More updates, corrections, clarifications...
Ryan C. Gordon <icculus@icculus.org>
parents: 3
diff changeset
   218
                          }
3662cbc014ef More updates, corrections, clarifications...
Ryan C. Gordon <icculus@icculus.org>
parents: 3
diff changeset
   219
3662cbc014ef More updates, corrections, clarifications...
Ryan C. Gordon <icculus@icculus.org>
parents: 3
diff changeset
   220
/**
3662cbc014ef More updates, corrections, clarifications...
Ryan C. Gordon <icculus@icculus.org>
parents: 3
diff changeset
   221
 * Get the version of PhysicsFS that is linked against your program. If you
3662cbc014ef More updates, corrections, clarifications...
Ryan C. Gordon <icculus@icculus.org>
parents: 3
diff changeset
   222
 *  are using a shared library (DLL) version of PhysFS, then it is possible
3662cbc014ef More updates, corrections, clarifications...
Ryan C. Gordon <icculus@icculus.org>
parents: 3
diff changeset
   223
 *  that it will be different than the version you compiled against.
3662cbc014ef More updates, corrections, clarifications...
Ryan C. Gordon <icculus@icculus.org>
parents: 3
diff changeset
   224
 *
3662cbc014ef More updates, corrections, clarifications...
Ryan C. Gordon <icculus@icculus.org>
parents: 3
diff changeset
   225
 * This is a real function; the macro PHYSFS_VERSION tells you what version
3662cbc014ef More updates, corrections, clarifications...
Ryan C. Gordon <icculus@icculus.org>
parents: 3
diff changeset
   226
 *  of PhysFS you compiled against:
3662cbc014ef More updates, corrections, clarifications...
Ryan C. Gordon <icculus@icculus.org>
parents: 3
diff changeset
   227
 *
3662cbc014ef More updates, corrections, clarifications...
Ryan C. Gordon <icculus@icculus.org>
parents: 3
diff changeset
   228
 * PHYSFS_Version compiled;
3662cbc014ef More updates, corrections, clarifications...
Ryan C. Gordon <icculus@icculus.org>
parents: 3
diff changeset
   229
 * PHYSFS_Version linked;
3662cbc014ef More updates, corrections, clarifications...
Ryan C. Gordon <icculus@icculus.org>
parents: 3
diff changeset
   230
 *
3662cbc014ef More updates, corrections, clarifications...
Ryan C. Gordon <icculus@icculus.org>
parents: 3
diff changeset
   231
 * PHYSFS_VERSION(&compiled);
3662cbc014ef More updates, corrections, clarifications...
Ryan C. Gordon <icculus@icculus.org>
parents: 3
diff changeset
   232
 * PHYSFS_getLinkedVersion(&linked);
3662cbc014ef More updates, corrections, clarifications...
Ryan C. Gordon <icculus@icculus.org>
parents: 3
diff changeset
   233
 * printf("We compiled against PhysFS version %d.%d.%d ...\n",
3662cbc014ef More updates, corrections, clarifications...
Ryan C. Gordon <icculus@icculus.org>
parents: 3
diff changeset
   234
 *           compiled.major, compiled.minor, compiled.patch);
3662cbc014ef More updates, corrections, clarifications...
Ryan C. Gordon <icculus@icculus.org>
parents: 3
diff changeset
   235
 * printf("But we linked against PhysFS version %d.%d.%d.\n",
3662cbc014ef More updates, corrections, clarifications...
Ryan C. Gordon <icculus@icculus.org>
parents: 3
diff changeset
   236
 *           linked.major, linked.minor, linked.patch);
3662cbc014ef More updates, corrections, clarifications...
Ryan C. Gordon <icculus@icculus.org>
parents: 3
diff changeset
   237
 *
3662cbc014ef More updates, corrections, clarifications...
Ryan C. Gordon <icculus@icculus.org>
parents: 3
diff changeset
   238
 * This function may be called safely at any time, even before PHYSFS_init().
3662cbc014ef More updates, corrections, clarifications...
Ryan C. Gordon <icculus@icculus.org>
parents: 3
diff changeset
   239
 */
74
a4a5066fb640 Compiles and runs on Visual C. What an uphill climb THAT was.
Ryan C. Gordon <icculus@icculus.org>
parents: 69
diff changeset
   240
__EXPORT__ void PHYSFS_getLinkedVersion(PHYSFS_Version *ver);
6
3662cbc014ef More updates, corrections, clarifications...
Ryan C. Gordon <icculus@icculus.org>
parents: 3
diff changeset
   241
3662cbc014ef More updates, corrections, clarifications...
Ryan C. Gordon <icculus@icculus.org>
parents: 3
diff changeset
   242
2
24ba671694af Fixed typos, expanded documentation, added init and deinit functions, and
Ryan C. Gordon <icculus@icculus.org>
parents: 1
diff changeset
   243
/**
24ba671694af Fixed typos, expanded documentation, added init and deinit functions, and
Ryan C. Gordon <icculus@icculus.org>
parents: 1
diff changeset
   244
 * Initialize PhysicsFS. This must be called before any other PhysicsFS
3
0dd785321345 Boatloads of updates to the spec.
Ryan C. Gordon <icculus@icculus.org>
parents: 2
diff changeset
   245
 *  function.
2
24ba671694af Fixed typos, expanded documentation, added init and deinit functions, and
Ryan C. Gordon <icculus@icculus.org>
parents: 1
diff changeset
   246
 *
23
bd6ba9c8717c Initial debugging: dropped PhysicsFS routines into the Build engine,
Ryan C. Gordon <icculus@icculus.org>
parents: 15
diff changeset
   247
 * This should be called prior to any attempts to change your process's
bd6ba9c8717c Initial debugging: dropped PhysicsFS routines into the Build engine,
Ryan C. Gordon <icculus@icculus.org>
parents: 15
diff changeset
   248
 *  current working directory.
bd6ba9c8717c Initial debugging: dropped PhysicsFS routines into the Build engine,
Ryan C. Gordon <icculus@icculus.org>
parents: 15
diff changeset
   249
 *
2
24ba671694af Fixed typos, expanded documentation, added init and deinit functions, and
Ryan C. Gordon <icculus@icculus.org>
parents: 1
diff changeset
   250
 *   @param argv0 the argv[0] string passed to your program's mainline.
24ba671694af Fixed typos, expanded documentation, added init and deinit functions, and
Ryan C. Gordon <icculus@icculus.org>
parents: 1
diff changeset
   251
 *  @return nonzero on success, zero on error. Specifics of the error can be
24ba671694af Fixed typos, expanded documentation, added init and deinit functions, and
Ryan C. Gordon <icculus@icculus.org>
parents: 1
diff changeset
   252
 *          gleaned from PHYSFS_getLastError().
24ba671694af Fixed typos, expanded documentation, added init and deinit functions, and
Ryan C. Gordon <icculus@icculus.org>
parents: 1
diff changeset
   253
 */
74
a4a5066fb640 Compiles and runs on Visual C. What an uphill climb THAT was.
Ryan C. Gordon <icculus@icculus.org>
parents: 69
diff changeset
   254
__EXPORT__ int PHYSFS_init(const char *argv0);
2
24ba671694af Fixed typos, expanded documentation, added init and deinit functions, and
Ryan C. Gordon <icculus@icculus.org>
parents: 1
diff changeset
   255
24ba671694af Fixed typos, expanded documentation, added init and deinit functions, and
Ryan C. Gordon <icculus@icculus.org>
parents: 1
diff changeset
   256
24ba671694af Fixed typos, expanded documentation, added init and deinit functions, and
Ryan C. Gordon <icculus@icculus.org>
parents: 1
diff changeset
   257
/**
24ba671694af Fixed typos, expanded documentation, added init and deinit functions, and
Ryan C. Gordon <icculus@icculus.org>
parents: 1
diff changeset
   258
 * Shutdown PhysicsFS. This closes any files opened via PhysicsFS, blanks the
3
0dd785321345 Boatloads of updates to the spec.
Ryan C. Gordon <icculus@icculus.org>
parents: 2
diff changeset
   259
 *  search/write paths, frees memory, and invalidates all of your handles.
2
24ba671694af Fixed typos, expanded documentation, added init and deinit functions, and
Ryan C. Gordon <icculus@icculus.org>
parents: 1
diff changeset
   260
 *
15
418eacc97ac8 Tons of updates. Mostly implemented. Mostly compiling.
Ryan C. Gordon <icculus@icculus.org>
parents: 8
diff changeset
   261
 * Note that this call can FAIL if there's a file open for writing that
418eacc97ac8 Tons of updates. Mostly implemented. Mostly compiling.
Ryan C. Gordon <icculus@icculus.org>
parents: 8
diff changeset
   262
 *  refuses to close (for example, the underlying operating system was
418eacc97ac8 Tons of updates. Mostly implemented. Mostly compiling.
Ryan C. Gordon <icculus@icculus.org>
parents: 8
diff changeset
   263
 *  buffering writes to network filesystem, and the fileserver has crashed,
418eacc97ac8 Tons of updates. Mostly implemented. Mostly compiling.
Ryan C. Gordon <icculus@icculus.org>
parents: 8
diff changeset
   264
 *  or a hard drive has failed, etc). It is usually best to close all write
418eacc97ac8 Tons of updates. Mostly implemented. Mostly compiling.
Ryan C. Gordon <icculus@icculus.org>
parents: 8
diff changeset
   265
 *  handles yourself before calling this function, so that you can gracefully
418eacc97ac8 Tons of updates. Mostly implemented. Mostly compiling.
Ryan C. Gordon <icculus@icculus.org>
parents: 8
diff changeset
   266
 *  handle a specific failure.
2
24ba671694af Fixed typos, expanded documentation, added init and deinit functions, and
Ryan C. Gordon <icculus@icculus.org>
parents: 1
diff changeset
   267
 *
15
418eacc97ac8 Tons of updates. Mostly implemented. Mostly compiling.
Ryan C. Gordon <icculus@icculus.org>
parents: 8
diff changeset
   268
 * Once successfully deinitialized, PHYSFS_init() can be called again to
418eacc97ac8 Tons of updates. Mostly implemented. Mostly compiling.
Ryan C. Gordon <icculus@icculus.org>
parents: 8
diff changeset
   269
 *  restart the subsystem. All defaults API states are restored at this
418eacc97ac8 Tons of updates. Mostly implemented. Mostly compiling.
Ryan C. Gordon <icculus@icculus.org>
parents: 8
diff changeset
   270
 *  point.
6
3662cbc014ef More updates, corrections, clarifications...
Ryan C. Gordon <icculus@icculus.org>
parents: 3
diff changeset
   271
 *
2
24ba671694af Fixed typos, expanded documentation, added init and deinit functions, and
Ryan C. Gordon <icculus@icculus.org>
parents: 1
diff changeset
   272
 *  @return nonzero on success, zero on error. Specifics of the error can be
24ba671694af Fixed typos, expanded documentation, added init and deinit functions, and
Ryan C. Gordon <icculus@icculus.org>
parents: 1
diff changeset
   273
 *          gleaned from PHYSFS_getLastError(). If failure, state of PhysFS is
24ba671694af Fixed typos, expanded documentation, added init and deinit functions, and
Ryan C. Gordon <icculus@icculus.org>
parents: 1
diff changeset
   274
 *          undefined, and probably badly screwed up.
24ba671694af Fixed typos, expanded documentation, added init and deinit functions, and
Ryan C. Gordon <icculus@icculus.org>
parents: 1
diff changeset
   275
 */
74
a4a5066fb640 Compiles and runs on Visual C. What an uphill climb THAT was.
Ryan C. Gordon <icculus@icculus.org>
parents: 69
diff changeset
   276
__EXPORT__ int PHYSFS_deinit(void);
2
24ba671694af Fixed typos, expanded documentation, added init and deinit functions, and
Ryan C. Gordon <icculus@icculus.org>
parents: 1
diff changeset
   277
1
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   278
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   279
/**
3
0dd785321345 Boatloads of updates to the spec.
Ryan C. Gordon <icculus@icculus.org>
parents: 2
diff changeset
   280
 * Get a list of archive types supported by this implementation of PhysicFS.
0dd785321345 Boatloads of updates to the spec.
Ryan C. Gordon <icculus@icculus.org>
parents: 2
diff changeset
   281
 *  These are the file formats usable for search path entries. This is for
0dd785321345 Boatloads of updates to the spec.
Ryan C. Gordon <icculus@icculus.org>
parents: 2
diff changeset
   282
 *  informational purposes only. Note that the extension listed is merely
0dd785321345 Boatloads of updates to the spec.
Ryan C. Gordon <icculus@icculus.org>
parents: 2
diff changeset
   283
 *  convention: if we list "ZIP", you can open a PkZip-compatible archive
0dd785321345 Boatloads of updates to the spec.
Ryan C. Gordon <icculus@icculus.org>
parents: 2
diff changeset
   284
 *  with an extension of "XYZ", if you like.
0dd785321345 Boatloads of updates to the spec.
Ryan C. Gordon <icculus@icculus.org>
parents: 2
diff changeset
   285
 *
6
3662cbc014ef More updates, corrections, clarifications...
Ryan C. Gordon <icculus@icculus.org>
parents: 3
diff changeset
   286
 * The returned value is an array of pointers to PHYSFS_ArchiveInfo structures,
3662cbc014ef More updates, corrections, clarifications...
Ryan C. Gordon <icculus@icculus.org>
parents: 3
diff changeset
   287
 *  with a NULL entry to signify the end of the list:
3
0dd785321345 Boatloads of updates to the spec.
Ryan C. Gordon <icculus@icculus.org>
parents: 2
diff changeset
   288
 *
0dd785321345 Boatloads of updates to the spec.
Ryan C. Gordon <icculus@icculus.org>
parents: 2
diff changeset
   289
 * PHYSFS_ArchiveInfo **i;
0dd785321345 Boatloads of updates to the spec.
Ryan C. Gordon <icculus@icculus.org>
parents: 2
diff changeset
   290
 *
0dd785321345 Boatloads of updates to the spec.
Ryan C. Gordon <icculus@icculus.org>
parents: 2
diff changeset
   291
 * for (i = PHYSFS_supportedArchiveTypes(); *i != NULL; i++)
0dd785321345 Boatloads of updates to the spec.
Ryan C. Gordon <icculus@icculus.org>
parents: 2
diff changeset
   292
 * {
0dd785321345 Boatloads of updates to the spec.
Ryan C. Gordon <icculus@icculus.org>
parents: 2
diff changeset
   293
 *     printf("Supported archive: [%s], which is [%s].\n",
0dd785321345 Boatloads of updates to the spec.
Ryan C. Gordon <icculus@icculus.org>
parents: 2
diff changeset
   294
 *              i->extension, i->description);
0dd785321345 Boatloads of updates to the spec.
Ryan C. Gordon <icculus@icculus.org>
parents: 2
diff changeset
   295
 * }
0dd785321345 Boatloads of updates to the spec.
Ryan C. Gordon <icculus@icculus.org>
parents: 2
diff changeset
   296
 *
0dd785321345 Boatloads of updates to the spec.
Ryan C. Gordon <icculus@icculus.org>
parents: 2
diff changeset
   297
 * The return values are pointers to static internal memory, and should
0dd785321345 Boatloads of updates to the spec.
Ryan C. Gordon <icculus@icculus.org>
parents: 2
diff changeset
   298
 *  be considered READ ONLY, and never freed.
0dd785321345 Boatloads of updates to the spec.
Ryan C. Gordon <icculus@icculus.org>
parents: 2
diff changeset
   299
 *
0dd785321345 Boatloads of updates to the spec.
Ryan C. Gordon <icculus@icculus.org>
parents: 2
diff changeset
   300
 *   @return READ ONLY Null-terminated array of READ ONLY structures.
0dd785321345 Boatloads of updates to the spec.
Ryan C. Gordon <icculus@icculus.org>
parents: 2
diff changeset
   301
 */
74
a4a5066fb640 Compiles and runs on Visual C. What an uphill climb THAT was.
Ryan C. Gordon <icculus@icculus.org>
parents: 69
diff changeset
   302
__EXPORT__ const PHYSFS_ArchiveInfo **PHYSFS_supportedArchiveTypes(void);
3
0dd785321345 Boatloads of updates to the spec.
Ryan C. Gordon <icculus@icculus.org>
parents: 2
diff changeset
   303
0dd785321345 Boatloads of updates to the spec.
Ryan C. Gordon <icculus@icculus.org>
parents: 2
diff changeset
   304
0dd785321345 Boatloads of updates to the spec.
Ryan C. Gordon <icculus@icculus.org>
parents: 2
diff changeset
   305
/**
0dd785321345 Boatloads of updates to the spec.
Ryan C. Gordon <icculus@icculus.org>
parents: 2
diff changeset
   306
 * Certain PhysicsFS functions return lists of information that are
0dd785321345 Boatloads of updates to the spec.
Ryan C. Gordon <icculus@icculus.org>
parents: 2
diff changeset
   307
 *  dynamically allocated. Use this function to free those resources.
0dd785321345 Boatloads of updates to the spec.
Ryan C. Gordon <icculus@icculus.org>
parents: 2
diff changeset
   308
 *
0dd785321345 Boatloads of updates to the spec.
Ryan C. Gordon <icculus@icculus.org>
parents: 2
diff changeset
   309
 *   @param list List of information specified as freeable by this function.
0dd785321345 Boatloads of updates to the spec.
Ryan C. Gordon <icculus@icculus.org>
parents: 2
diff changeset
   310
 */
128
31f754165105 Patched to fix a namespace issue.
Ryan C. Gordon <icculus@icculus.org>
parents: 126
diff changeset
   311
__EXPORT__ void PHYSFS_freeList(void *listVar);
3
0dd785321345 Boatloads of updates to the spec.
Ryan C. Gordon <icculus@icculus.org>
parents: 2
diff changeset
   312
0dd785321345 Boatloads of updates to the spec.
Ryan C. Gordon <icculus@icculus.org>
parents: 2
diff changeset
   313
0dd785321345 Boatloads of updates to the spec.
Ryan C. Gordon <icculus@icculus.org>
parents: 2
diff changeset
   314
/**
1
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   315
 * Get the last PhysicsFS error message as a null-terminated string.
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   316
 *  This will be NULL if there's been no error since the last call to this
6
3662cbc014ef More updates, corrections, clarifications...
Ryan C. Gordon <icculus@icculus.org>
parents: 3
diff changeset
   317
 *  function. The pointer returned by this call points to an internal buffer.
3662cbc014ef More updates, corrections, clarifications...
Ryan C. Gordon <icculus@icculus.org>
parents: 3
diff changeset
   318
 *  Each thread has a unique error state associated with it, but each time
3662cbc014ef More updates, corrections, clarifications...
Ryan C. Gordon <icculus@icculus.org>
parents: 3
diff changeset
   319
 *  a new error message is set, it will overwrite the previous one associated
3662cbc014ef More updates, corrections, clarifications...
Ryan C. Gordon <icculus@icculus.org>
parents: 3
diff changeset
   320
 *  with that thread. It is safe to call this function at anytime, even
3662cbc014ef More updates, corrections, clarifications...
Ryan C. Gordon <icculus@icculus.org>
parents: 3
diff changeset
   321
 *  before PHYSFS_init().
1
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   322
 *
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   323
 *   @return READ ONLY string of last error message.
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   324
 */
74
a4a5066fb640 Compiles and runs on Visual C. What an uphill climb THAT was.
Ryan C. Gordon <icculus@icculus.org>
parents: 69
diff changeset
   325
__EXPORT__ const char *PHYSFS_getLastError(void);
1
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   326
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   327
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   328
/**
6
3662cbc014ef More updates, corrections, clarifications...
Ryan C. Gordon <icculus@icculus.org>
parents: 3
diff changeset
   329
 * Get a platform-dependent dir separator. This is "\\" on win32, "/" on Unix,
1
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   330
 *  and ":" on MacOS. It may be more than one character, depending on the
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   331
 *  platform, and your code should take that into account. Note that this is
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   332
 *  only useful for setting up the search/write paths, since access into those
6
3662cbc014ef More updates, corrections, clarifications...
Ryan C. Gordon <icculus@icculus.org>
parents: 3
diff changeset
   333
 *  dirs always use '/' (platform-independent notation) to separate
2
24ba671694af Fixed typos, expanded documentation, added init and deinit functions, and
Ryan C. Gordon <icculus@icculus.org>
parents: 1
diff changeset
   334
 *  directories. This is also handy for getting platform-independent access
24ba671694af Fixed typos, expanded documentation, added init and deinit functions, and
Ryan C. Gordon <icculus@icculus.org>
parents: 1
diff changeset
   335
 *  when using stdio calls.
1
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   336
 *
6
3662cbc014ef More updates, corrections, clarifications...
Ryan C. Gordon <icculus@icculus.org>
parents: 3
diff changeset
   337
 *   @return READ ONLY null-terminated string of platform's dir separator.
1
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   338
 */
74
a4a5066fb640 Compiles and runs on Visual C. What an uphill climb THAT was.
Ryan C. Gordon <icculus@icculus.org>
parents: 69
diff changeset
   339
__EXPORT__ const char *PHYSFS_getDirSeparator(void);
1
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   340
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   341
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   342
/**
15
418eacc97ac8 Tons of updates. Mostly implemented. Mostly compiling.
Ryan C. Gordon <icculus@icculus.org>
parents: 8
diff changeset
   343
 * Enable symbolic links. Some physical filesystems and archives contain
418eacc97ac8 Tons of updates. Mostly implemented. Mostly compiling.
Ryan C. Gordon <icculus@icculus.org>
parents: 8
diff changeset
   344
 *  files that are just pointers to other files. On the physical filesystem,
418eacc97ac8 Tons of updates. Mostly implemented. Mostly compiling.
Ryan C. Gordon <icculus@icculus.org>
parents: 8
diff changeset
   345
 *  opening such a link will (transparently) open the file that is pointed to.
418eacc97ac8 Tons of updates. Mostly implemented. Mostly compiling.
Ryan C. Gordon <icculus@icculus.org>
parents: 8
diff changeset
   346
 *
418eacc97ac8 Tons of updates. Mostly implemented. Mostly compiling.
Ryan C. Gordon <icculus@icculus.org>
parents: 8
diff changeset
   347
 * By default, PhysicsFS will check if a file is really a symlink during open
418eacc97ac8 Tons of updates. Mostly implemented. Mostly compiling.
Ryan C. Gordon <icculus@icculus.org>
parents: 8
diff changeset
   348
 *  calls and fail if it is. Otherwise, the link could take you outside the
418eacc97ac8 Tons of updates. Mostly implemented. Mostly compiling.
Ryan C. Gordon <icculus@icculus.org>
parents: 8
diff changeset
   349
 *  write and search paths, and compromise security.
418eacc97ac8 Tons of updates. Mostly implemented. Mostly compiling.
Ryan C. Gordon <icculus@icculus.org>
parents: 8
diff changeset
   350
 *
418eacc97ac8 Tons of updates. Mostly implemented. Mostly compiling.
Ryan C. Gordon <icculus@icculus.org>
parents: 8
diff changeset
   351
 * If you want to take that risk, call this function with a non-zero parameter.
418eacc97ac8 Tons of updates. Mostly implemented. Mostly compiling.
Ryan C. Gordon <icculus@icculus.org>
parents: 8
diff changeset
   352
 *  Note that this is more for sandboxing a program's scripting language, in
418eacc97ac8 Tons of updates. Mostly implemented. Mostly compiling.
Ryan C. Gordon <icculus@icculus.org>
parents: 8
diff changeset
   353
 *  case untrusted scripts try to compromise the system. Generally speaking,
418eacc97ac8 Tons of updates. Mostly implemented. Mostly compiling.
Ryan C. Gordon <icculus@icculus.org>
parents: 8
diff changeset
   354
 *  a user could very well have a legitimate reason to set up a symlink, so
418eacc97ac8 Tons of updates. Mostly implemented. Mostly compiling.
Ryan C. Gordon <icculus@icculus.org>
parents: 8
diff changeset
   355
 *  unless you feel there's a specific danger in allowing them, you should
418eacc97ac8 Tons of updates. Mostly implemented. Mostly compiling.
Ryan C. Gordon <icculus@icculus.org>
parents: 8
diff changeset
   356
 *  permit them.
418eacc97ac8 Tons of updates. Mostly implemented. Mostly compiling.
Ryan C. Gordon <icculus@icculus.org>
parents: 8
diff changeset
   357
 *
39
bc29e1ee7ef6 Lots of bugfixes, enhancements, and corrections due to the work on
Ryan C. Gordon <icculus@icculus.org>
parents: 33
diff changeset
   358
 * Symlinks are only explicitly checked when dealing with filenames
bc29e1ee7ef6 Lots of bugfixes, enhancements, and corrections due to the work on
Ryan C. Gordon <icculus@icculus.org>
parents: 33
diff changeset
   359
 *  in platform-independent notation. That is, when setting up your
bc29e1ee7ef6 Lots of bugfixes, enhancements, and corrections due to the work on
Ryan C. Gordon <icculus@icculus.org>
parents: 33
diff changeset
   360
 *  search and write paths, etc, symlinks are never checked for.
bc29e1ee7ef6 Lots of bugfixes, enhancements, and corrections due to the work on
Ryan C. Gordon <icculus@icculus.org>
parents: 33
diff changeset
   361
 *
15
418eacc97ac8 Tons of updates. Mostly implemented. Mostly compiling.
Ryan C. Gordon <icculus@icculus.org>
parents: 8
diff changeset
   362
 * Symbolic link permission can be enabled or disabled at any time, and is
418eacc97ac8 Tons of updates. Mostly implemented. Mostly compiling.
Ryan C. Gordon <icculus@icculus.org>
parents: 8
diff changeset
   363
 *  disabled by default.
418eacc97ac8 Tons of updates. Mostly implemented. Mostly compiling.
Ryan C. Gordon <icculus@icculus.org>
parents: 8
diff changeset
   364
 *
418eacc97ac8 Tons of updates. Mostly implemented. Mostly compiling.
Ryan C. Gordon <icculus@icculus.org>
parents: 8
diff changeset
   365
 *   @param allow nonzero to permit symlinks, zero to deny linking.
418eacc97ac8 Tons of updates. Mostly implemented. Mostly compiling.
Ryan C. Gordon <icculus@icculus.org>
parents: 8
diff changeset
   366
 */
74
a4a5066fb640 Compiles and runs on Visual C. What an uphill climb THAT was.
Ryan C. Gordon <icculus@icculus.org>
parents: 69
diff changeset
   367
__EXPORT__ void PHYSFS_permitSymbolicLinks(int allow);
15
418eacc97ac8 Tons of updates. Mostly implemented. Mostly compiling.
Ryan C. Gordon <icculus@icculus.org>
parents: 8
diff changeset
   368
418eacc97ac8 Tons of updates. Mostly implemented. Mostly compiling.
Ryan C. Gordon <icculus@icculus.org>
parents: 8
diff changeset
   369
418eacc97ac8 Tons of updates. Mostly implemented. Mostly compiling.
Ryan C. Gordon <icculus@icculus.org>
parents: 8
diff changeset
   370
/**
6
3662cbc014ef More updates, corrections, clarifications...
Ryan C. Gordon <icculus@icculus.org>
parents: 3
diff changeset
   371
 * Get an array of dirs to available CD-ROM drives.
1
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   372
 *
6
3662cbc014ef More updates, corrections, clarifications...
Ryan C. Gordon <icculus@icculus.org>
parents: 3
diff changeset
   373
 * The dirs returned are platform-dependent ("D:\" on Win32, "/cdrom" or
3662cbc014ef More updates, corrections, clarifications...
Ryan C. Gordon <icculus@icculus.org>
parents: 3
diff changeset
   374
 *  whatnot on Unix). Dirs are only returned if there is a disc ready and
1
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   375
 *  accessible in the drive. So if you've got two drives (D: and E:), and only
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   376
 *  E: has a disc in it, then that's all you get. If the user inserts a disc
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   377
 *  in D: and you call this function again, you get both drives. If, on a
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   378
 *  Unix box, the user unmounts a disc and remounts it elsewhere, the next
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   379
 *  call to this function will reflect that change. Fun.
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   380
 *
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   381
 * The returned value is an array of strings, with a NULL entry to signify the
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   382
 *  end of the list:
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   383
 *
8
41e4c6031535 Typo fixes, clarifications, and corrections.
Ryan C. Gordon <icculus@icculus.org>
parents: 6
diff changeset
   384
 * char **cds = PHYSFS_getCdRomDirs();
1
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   385
 * char **i;
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   386
 *
8
41e4c6031535 Typo fixes, clarifications, and corrections.
Ryan C. Gordon <icculus@icculus.org>
parents: 6
diff changeset
   387
 * for (i = cds; *i != NULL; i++)
6
3662cbc014ef More updates, corrections, clarifications...
Ryan C. Gordon <icculus@icculus.org>
parents: 3
diff changeset
   388
 *     printf("cdrom dir [%s] is available.\n", *i);
1
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   389
 *
8
41e4c6031535 Typo fixes, clarifications, and corrections.
Ryan C. Gordon <icculus@icculus.org>
parents: 6
diff changeset
   390
 * PHYSFS_freeList(cds);
41e4c6031535 Typo fixes, clarifications, and corrections.
Ryan C. Gordon <icculus@icculus.org>
parents: 6
diff changeset
   391
 *
1
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   392
 * This call may block while drives spin up. Be forewarned.
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   393
 *
3
0dd785321345 Boatloads of updates to the spec.
Ryan C. Gordon <icculus@icculus.org>
parents: 2
diff changeset
   394
 * When you are done with the returned information, you may dispose of the
0dd785321345 Boatloads of updates to the spec.
Ryan C. Gordon <icculus@icculus.org>
parents: 2
diff changeset
   395
 *  resources by calling PHYSFS_freeList() with the returned pointer.
0dd785321345 Boatloads of updates to the spec.
Ryan C. Gordon <icculus@icculus.org>
parents: 2
diff changeset
   396
 *
0dd785321345 Boatloads of updates to the spec.
Ryan C. Gordon <icculus@icculus.org>
parents: 2
diff changeset
   397
 *   @return Null-terminated array of null-terminated strings.
1
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   398
 */
74
a4a5066fb640 Compiles and runs on Visual C. What an uphill climb THAT was.
Ryan C. Gordon <icculus@icculus.org>
parents: 69
diff changeset
   399
__EXPORT__ char **PHYSFS_getCdRomDirs(void);
1
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   400
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   401
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   402
/**
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   403
 * Helper function.
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   404
 *
6
3662cbc014ef More updates, corrections, clarifications...
Ryan C. Gordon <icculus@icculus.org>
parents: 3
diff changeset
   405
 * Get the "base dir". This is the directory where the application was run
3
0dd785321345 Boatloads of updates to the spec.
Ryan C. Gordon <icculus@icculus.org>
parents: 2
diff changeset
   406
 *  from, which is probably the installation directory, and may or may not
0dd785321345 Boatloads of updates to the spec.
Ryan C. Gordon <icculus@icculus.org>
parents: 2
diff changeset
   407
 *  be the process's current working directory.
1
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   408
 *
6
3662cbc014ef More updates, corrections, clarifications...
Ryan C. Gordon <icculus@icculus.org>
parents: 3
diff changeset
   409
 * You should probably use the base dir in your search path.
1
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   410
 *
6
3662cbc014ef More updates, corrections, clarifications...
Ryan C. Gordon <icculus@icculus.org>
parents: 3
diff changeset
   411
 *  @return READ ONLY string of base dir in platform-dependent notation.
1
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   412
 */
74
a4a5066fb640 Compiles and runs on Visual C. What an uphill climb THAT was.
Ryan C. Gordon <icculus@icculus.org>
parents: 69
diff changeset
   413
__EXPORT__ const char *PHYSFS_getBaseDir(void);
1
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   414
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   415
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   416
/**
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   417
 * Helper function.
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   418
 *
6
3662cbc014ef More updates, corrections, clarifications...
Ryan C. Gordon <icculus@icculus.org>
parents: 3
diff changeset
   419
 * Get the "user dir". This is meant to be a suggestion of where a specific
1
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   420
 *  user of the system can store files. On Unix, this is her home directory.
3
0dd785321345 Boatloads of updates to the spec.
Ryan C. Gordon <icculus@icculus.org>
parents: 2
diff changeset
   421
 *  On systems with no concept of multiple home directories (MacOS, win95),
6
3662cbc014ef More updates, corrections, clarifications...
Ryan C. Gordon <icculus@icculus.org>
parents: 3
diff changeset
   422
 *  this will default to something like "C:\mybasedir\users\username"
3
0dd785321345 Boatloads of updates to the spec.
Ryan C. Gordon <icculus@icculus.org>
parents: 2
diff changeset
   423
 *  where "username" will either be the login name, or "default" if the
0dd785321345 Boatloads of updates to the spec.
Ryan C. Gordon <icculus@icculus.org>
parents: 2
diff changeset
   424
 *  platform doesn't support multiple users, either.
1
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   425
 *
6
3662cbc014ef More updates, corrections, clarifications...
Ryan C. Gordon <icculus@icculus.org>
parents: 3
diff changeset
   426
 * You should probably use the user dir as the basis for your write dir, and
1
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   427
 *  also put it near the beginning of your search path.
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   428
 *
6
3662cbc014ef More updates, corrections, clarifications...
Ryan C. Gordon <icculus@icculus.org>
parents: 3
diff changeset
   429
 *  @return READ ONLY string of user dir in platform-dependent notation.
1
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   430
 */
74
a4a5066fb640 Compiles and runs on Visual C. What an uphill climb THAT was.
Ryan C. Gordon <icculus@icculus.org>
parents: 69
diff changeset
   431
__EXPORT__ const char *PHYSFS_getUserDir(void);
1
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   432
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   433
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   434
/**
6
3662cbc014ef More updates, corrections, clarifications...
Ryan C. Gordon <icculus@icculus.org>
parents: 3
diff changeset
   435
 * Get the current write dir. The default write dir is NULL.
1
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   436
 *
6
3662cbc014ef More updates, corrections, clarifications...
Ryan C. Gordon <icculus@icculus.org>
parents: 3
diff changeset
   437
 *  @return READ ONLY string of write dir in platform-dependent notation,
1
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   438
 *           OR NULL IF NO WRITE PATH IS CURRENTLY SET.
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   439
 */
74
a4a5066fb640 Compiles and runs on Visual C. What an uphill climb THAT was.
Ryan C. Gordon <icculus@icculus.org>
parents: 69
diff changeset
   440
__EXPORT__ const char *PHYSFS_getWriteDir(void);
1
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   441
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   442
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   443
/**
6
3662cbc014ef More updates, corrections, clarifications...
Ryan C. Gordon <icculus@icculus.org>
parents: 3
diff changeset
   444
 * Set a new write dir. This will override the previous setting. If the
1
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   445
 *  directory or a parent directory doesn't exist in the physical filesystem,
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   446
 *  PhysicsFS will attempt to create them as needed.
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   447
 *
6
3662cbc014ef More updates, corrections, clarifications...
Ryan C. Gordon <icculus@icculus.org>
parents: 3
diff changeset
   448
 * This call will fail (and fail to change the write dir) if the current
3662cbc014ef More updates, corrections, clarifications...
Ryan C. Gordon <icculus@icculus.org>
parents: 3
diff changeset
   449
 *  write dir still has files open in it.
1
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   450
 *
6
3662cbc014ef More updates, corrections, clarifications...
Ryan C. Gordon <icculus@icculus.org>
parents: 3
diff changeset
   451
 *   @param newDir The new directory to be the root of the write dir,
3
0dd785321345 Boatloads of updates to the spec.
Ryan C. Gordon <icculus@icculus.org>
parents: 2
diff changeset
   452
 *                   specified in platform-dependent notation. Setting to NULL
6
3662cbc014ef More updates, corrections, clarifications...
Ryan C. Gordon <icculus@icculus.org>
parents: 3
diff changeset
   453
 *                   disables the write dir, so no files can be opened for
1
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   454
 *                   writing via PhysicsFS.
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   455
 *  @return non-zero on success, zero on failure. All attempts to open a file
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   456
 *           for writing via PhysicsFS will fail until this call succeeds.
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   457
 *           Specifics of the error can be gleaned from PHYSFS_getLastError().
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   458
 *
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   459
 */
74
a4a5066fb640 Compiles and runs on Visual C. What an uphill climb THAT was.
Ryan C. Gordon <icculus@icculus.org>
parents: 69
diff changeset
   460
__EXPORT__ int PHYSFS_setWriteDir(const char *newDir);
1
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   461
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   462
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   463
/**
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   464
 * Add a directory or archive to the search path. If this is a duplicate, the
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   465
 *  entry is not added again, even though the function succeeds.
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   466
 *
6
3662cbc014ef More updates, corrections, clarifications...
Ryan C. Gordon <icculus@icculus.org>
parents: 3
diff changeset
   467
 *   @param newDir directory or archive to add to the path, in
1
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   468
 *                   platform-dependent notation.
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   469
 *   @param appendToPath nonzero to append to search path, zero to prepend.
6
3662cbc014ef More updates, corrections, clarifications...
Ryan C. Gordon <icculus@icculus.org>
parents: 3
diff changeset
   470
 *  @return nonzero if added to path, zero on failure (bogus archive, dir
1
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   471
 *                   missing, etc). Specifics of the error can be
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   472
 *                   gleaned from PHYSFS_getLastError().
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   473
 */
74
a4a5066fb640 Compiles and runs on Visual C. What an uphill climb THAT was.
Ryan C. Gordon <icculus@icculus.org>
parents: 69
diff changeset
   474
__EXPORT__ int PHYSFS_addToSearchPath(const char *newDir, int appendToPath);
1
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   475
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   476
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   477
/**
2
24ba671694af Fixed typos, expanded documentation, added init and deinit functions, and
Ryan C. Gordon <icculus@icculus.org>
parents: 1
diff changeset
   478
 * Remove a directory or archive from the search path.
1
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   479
 *
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   480
 * This must be a (case-sensitive) match to a dir or archive already in the
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   481
 *  search path, specified in platform-dependent notation.
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   482
 *
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   483
 * This call will fail (and fail to remove from the path) if the element still
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   484
 *  has files open in it.
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   485
 *
6
3662cbc014ef More updates, corrections, clarifications...
Ryan C. Gordon <icculus@icculus.org>
parents: 3
diff changeset
   486
 *    @param oldDir dir/archive to remove.
1
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   487
 *   @return nonzero on success, zero on failure.
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   488
 *            Specifics of the error can be gleaned from PHYSFS_getLastError().
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   489
 */
74
a4a5066fb640 Compiles and runs on Visual C. What an uphill climb THAT was.
Ryan C. Gordon <icculus@icculus.org>
parents: 69
diff changeset
   490
__EXPORT__ int PHYSFS_removeFromSearchPath(const char *oldDir);
1
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   491
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   492
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   493
/**
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   494
 * Get the current search path. The default search path is an empty list.
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   495
 *
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   496
 * The returned value is an array of strings, with a NULL entry to signify the
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   497
 *  end of the list:
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   498
 *
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   499
 * char **i;
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   500
 *
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   501
 * for (i = PHYSFS_getSearchPath(); *i != NULL; i++)
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   502
 *     printf("[%s] is in the search path.\n", *i);
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   503
 *
3
0dd785321345 Boatloads of updates to the spec.
Ryan C. Gordon <icculus@icculus.org>
parents: 2
diff changeset
   504
 * When you are done with the returned information, you may dispose of the
0dd785321345 Boatloads of updates to the spec.
Ryan C. Gordon <icculus@icculus.org>
parents: 2
diff changeset
   505
 *  resources by calling PHYSFS_freeList() with the returned pointer.
1
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   506
 *
6
3662cbc014ef More updates, corrections, clarifications...
Ryan C. Gordon <icculus@icculus.org>
parents: 3
diff changeset
   507
 *   @return Null-terminated array of null-terminated strings. NULL if there
3662cbc014ef More updates, corrections, clarifications...
Ryan C. Gordon <icculus@icculus.org>
parents: 3
diff changeset
   508
 *            was a problem (read: OUT OF MEMORY).
1
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   509
 */
74
a4a5066fb640 Compiles and runs on Visual C. What an uphill climb THAT was.
Ryan C. Gordon <icculus@icculus.org>
parents: 69
diff changeset
   510
__EXPORT__ char **PHYSFS_getSearchPath(void);
1
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   511
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   512
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   513
/**
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   514
 * Helper function.
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   515
 *
6
3662cbc014ef More updates, corrections, clarifications...
Ryan C. Gordon <icculus@icculus.org>
parents: 3
diff changeset
   516
 * Set up sane, default paths. The write dir will be set to
101
bd18e17ad6ad Changed PHYSFS_setSaneConfig()'s behaviour. API BREAKAGE.
Ryan C. Gordon <icculus@icculus.org>
parents: 99
diff changeset
   517
 *  "userdir/.organization/appName", which is created if it doesn't exist.
1
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   518
 *
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   519
 * The above is sufficient to make sure your program's configuration directory
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   520
 *  is separated from other clutter, and platform-independent. The period
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   521
 *  before "mygame" even hides the directory on Unix systems.
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   522
 *
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   523
 *  The search path will be:
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   524
 *
6
3662cbc014ef More updates, corrections, clarifications...
Ryan C. Gordon <icculus@icculus.org>
parents: 3
diff changeset
   525
 *    - The Write Dir (created if it doesn't exist)
3662cbc014ef More updates, corrections, clarifications...
Ryan C. Gordon <icculus@icculus.org>
parents: 3
diff changeset
   526
 *    - The Base Dir (PHYSFS_getBaseDir())
3662cbc014ef More updates, corrections, clarifications...
Ryan C. Gordon <icculus@icculus.org>
parents: 3
diff changeset
   527
 *    - All found CD-ROM dirs (optionally)
1
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   528
 *
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   529
 * These directories are then searched for files ending with the extension
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   530
 *  (archiveExt), which, if they are valid and supported archives, will also
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   531
 *  be added to the search path. If you specified "PKG" for (archiveExt), and
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   532
 *  there's a file named data.PKG in the base dir, it'll be checked. Archives
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   533
 *  can either be appended or prepended to the search path in alphabetical
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   534
 *  order, regardless of which directories they were found in.
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   535
 *
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   536
 * All of this can be accomplished from the application, but this just does it
2
24ba671694af Fixed typos, expanded documentation, added init and deinit functions, and
Ryan C. Gordon <icculus@icculus.org>
parents: 1
diff changeset
   537
 *  all for you. Feel free to add more to the search path manually, too.
1
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   538
 *
101
bd18e17ad6ad Changed PHYSFS_setSaneConfig()'s behaviour. API BREAKAGE.
Ryan C. Gordon <icculus@icculus.org>
parents: 99
diff changeset
   539
 *    @param organization Name of your company/group/etc to be used as a
bd18e17ad6ad Changed PHYSFS_setSaneConfig()'s behaviour. API BREAKAGE.
Ryan C. Gordon <icculus@icculus.org>
parents: 99
diff changeset
   540
 *                         dirname, so keep it small, and no-frills.
bd18e17ad6ad Changed PHYSFS_setSaneConfig()'s behaviour. API BREAKAGE.
Ryan C. Gordon <icculus@icculus.org>
parents: 99
diff changeset
   541
 *
1
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   542
 *    @param appName Program-specific name of your program, to separate it
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   543
 *                   from other programs using PhysicsFS.
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   544
 *
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   545
 *    @param archiveExt File extention used by your program to specify an
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   546
 *                      archive. For example, Quake 3 uses "pk3", even though
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   547
 *                      they are just zipfiles. Specify NULL to not dig out
8
41e4c6031535 Typo fixes, clarifications, and corrections.
Ryan C. Gordon <icculus@icculus.org>
parents: 6
diff changeset
   548
 *                      archives automatically. Do not specify the '.' char;
41e4c6031535 Typo fixes, clarifications, and corrections.
Ryan C. Gordon <icculus@icculus.org>
parents: 6
diff changeset
   549
 *                      If you want to look for ZIP files, specify "ZIP" and
41e4c6031535 Typo fixes, clarifications, and corrections.
Ryan C. Gordon <icculus@icculus.org>
parents: 6
diff changeset
   550
 *                      not ".ZIP" ... the archive search is case-insensitive.
1
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   551
 *
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   552
 *    @param includeCdRoms Non-zero to include CD-ROMs in the search path, and
2
24ba671694af Fixed typos, expanded documentation, added init and deinit functions, and
Ryan C. Gordon <icculus@icculus.org>
parents: 1
diff changeset
   553
 *                         (if (archiveExt) != NULL) search them for archives.
24ba671694af Fixed typos, expanded documentation, added init and deinit functions, and
Ryan C. Gordon <icculus@icculus.org>
parents: 1
diff changeset
   554
 *                         This may cause a significant amount of blocking
24ba671694af Fixed typos, expanded documentation, added init and deinit functions, and
Ryan C. Gordon <icculus@icculus.org>
parents: 1
diff changeset
   555
 *                         while discs are accessed, and if there are no discs
24ba671694af Fixed typos, expanded documentation, added init and deinit functions, and
Ryan C. Gordon <icculus@icculus.org>
parents: 1
diff changeset
   556
 *                         in the drive (or even not mounted on Unix systems),
24ba671694af Fixed typos, expanded documentation, added init and deinit functions, and
Ryan C. Gordon <icculus@icculus.org>
parents: 1
diff changeset
   557
 *                         then they may not be made available anyhow. You may
24ba671694af Fixed typos, expanded documentation, added init and deinit functions, and
Ryan C. Gordon <icculus@icculus.org>
parents: 1
diff changeset
   558
 *                         want to specify zero and handle the disc setup
24ba671694af Fixed typos, expanded documentation, added init and deinit functions, and
Ryan C. Gordon <icculus@icculus.org>
parents: 1
diff changeset
   559
 *                         yourself.
1
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   560
 *
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   561
 *    @param archivesFirst Non-zero to prepend the archives to the search path.
2
24ba671694af Fixed typos, expanded documentation, added init and deinit functions, and
Ryan C. Gordon <icculus@icculus.org>
parents: 1
diff changeset
   562
 *                          Zero to append them. Ignored if !(archiveExt).
101
bd18e17ad6ad Changed PHYSFS_setSaneConfig()'s behaviour. API BREAKAGE.
Ryan C. Gordon <icculus@icculus.org>
parents: 99
diff changeset
   563
 *
8
41e4c6031535 Typo fixes, clarifications, and corrections.
Ryan C. Gordon <icculus@icculus.org>
parents: 6
diff changeset
   564
 *  @return nonzero on success, zero on error. Specifics of the error can be
41e4c6031535 Typo fixes, clarifications, and corrections.
Ryan C. Gordon <icculus@icculus.org>
parents: 6
diff changeset
   565
 *          gleaned from PHYSFS_getLastError().
1
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   566
 */
101
bd18e17ad6ad Changed PHYSFS_setSaneConfig()'s behaviour. API BREAKAGE.
Ryan C. Gordon <icculus@icculus.org>
parents: 99
diff changeset
   567
__EXPORT__ int PHYSFS_setSaneConfig(const char *organization,
bd18e17ad6ad Changed PHYSFS_setSaneConfig()'s behaviour. API BREAKAGE.
Ryan C. Gordon <icculus@icculus.org>
parents: 99
diff changeset
   568
                                    const char *appName,
74
a4a5066fb640 Compiles and runs on Visual C. What an uphill climb THAT was.
Ryan C. Gordon <icculus@icculus.org>
parents: 69
diff changeset
   569
                                    const char *archiveExt,
a4a5066fb640 Compiles and runs on Visual C. What an uphill climb THAT was.
Ryan C. Gordon <icculus@icculus.org>
parents: 69
diff changeset
   570
                                    int includeCdRoms,
a4a5066fb640 Compiles and runs on Visual C. What an uphill climb THAT was.
Ryan C. Gordon <icculus@icculus.org>
parents: 69
diff changeset
   571
                                    int archivesFirst);
1
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   572
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   573
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   574
/**
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   575
 * Create a directory. This is specified in platform-independent notation in
6
3662cbc014ef More updates, corrections, clarifications...
Ryan C. Gordon <icculus@icculus.org>
parents: 3
diff changeset
   576
 *  relation to the write dir. All missing parent directories are also
1
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   577
 *  created if they don't exist.
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   578
 *
6
3662cbc014ef More updates, corrections, clarifications...
Ryan C. Gordon <icculus@icculus.org>
parents: 3
diff changeset
   579
 * So if you've got the write dir set to "C:\mygame\writedir" and call
1
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   580
 *  PHYSFS_mkdir("downloads/maps") then the directories
6
3662cbc014ef More updates, corrections, clarifications...
Ryan C. Gordon <icculus@icculus.org>
parents: 3
diff changeset
   581
 *  "C:\mygame\writedir\downloads" and "C:\mygame\writedir\downloads\maps"
3
0dd785321345 Boatloads of updates to the spec.
Ryan C. Gordon <icculus@icculus.org>
parents: 2
diff changeset
   582
 *  will be created if possible. If the creation of "maps" fails after we
0dd785321345 Boatloads of updates to the spec.
Ryan C. Gordon <icculus@icculus.org>
parents: 2
diff changeset
   583
 *  have successfully created "downloads", then the function leaves the
0dd785321345 Boatloads of updates to the spec.
Ryan C. Gordon <icculus@icculus.org>
parents: 2
diff changeset
   584
 *  created directory behind and reports failure.
1
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   585
 *
6
3662cbc014ef More updates, corrections, clarifications...
Ryan C. Gordon <icculus@icculus.org>
parents: 3
diff changeset
   586
 *   @param dirname New dir to create.
1
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   587
 *  @return nonzero on success, zero on error. Specifics of the error can be
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   588
 *          gleaned from PHYSFS_getLastError().
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   589
 */
74
a4a5066fb640 Compiles and runs on Visual C. What an uphill climb THAT was.
Ryan C. Gordon <icculus@icculus.org>
parents: 69
diff changeset
   590
__EXPORT__ int PHYSFS_mkdir(const char *dirName);
1
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   591
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   592
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   593
/**
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   594
 * Delete a file or directory. This is specified in platform-independent
6
3662cbc014ef More updates, corrections, clarifications...
Ryan C. Gordon <icculus@icculus.org>
parents: 3
diff changeset
   595
 *  notation in relation to the write dir.
1
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   596
 *
3
0dd785321345 Boatloads of updates to the spec.
Ryan C. Gordon <icculus@icculus.org>
parents: 2
diff changeset
   597
 * A directory must be empty before this call can delete it.
1
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   598
 *
6
3662cbc014ef More updates, corrections, clarifications...
Ryan C. Gordon <icculus@icculus.org>
parents: 3
diff changeset
   599
 * So if you've got the write dir set to "C:\mygame\writedir" and call
1
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   600
 *  PHYSFS_delete("downloads/maps/level1.map") then the file
6
3662cbc014ef More updates, corrections, clarifications...
Ryan C. Gordon <icculus@icculus.org>
parents: 3
diff changeset
   601
 *  "C:\mygame\writedir\downloads\maps\level1.map" is removed from the
1
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   602
 *  physical filesystem, if it exists and the operating system permits the
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   603
 *  deletion.
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   604
 *
2
24ba671694af Fixed typos, expanded documentation, added init and deinit functions, and
Ryan C. Gordon <icculus@icculus.org>
parents: 1
diff changeset
   605
 * Note that on Unix systems, deleting a file may be successful, but the
24ba671694af Fixed typos, expanded documentation, added init and deinit functions, and
Ryan C. Gordon <icculus@icculus.org>
parents: 1
diff changeset
   606
 *  actual file won't be removed until all processes that have an open
24ba671694af Fixed typos, expanded documentation, added init and deinit functions, and
Ryan C. Gordon <icculus@icculus.org>
parents: 1
diff changeset
   607
 *  filehandle to it (including your program) close their handles.
24ba671694af Fixed typos, expanded documentation, added init and deinit functions, and
Ryan C. Gordon <icculus@icculus.org>
parents: 1
diff changeset
   608
 *
1
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   609
 *   @param filename Filename to delete.
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   610
 *  @return nonzero on success, zero on error. Specifics of the error can be
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   611
 *          gleaned from PHYSFS_getLastError().
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   612
 */
74
a4a5066fb640 Compiles and runs on Visual C. What an uphill climb THAT was.
Ryan C. Gordon <icculus@icculus.org>
parents: 69
diff changeset
   613
__EXPORT__ int PHYSFS_delete(const char *filename);
1
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   614
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   615
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   616
/**
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   617
 * Figure out where in the search path a file resides. The file is specified
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   618
 *  in platform-independent notation. The returned filename will be the
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   619
 *  element of the search path where the file was found, which may be a
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   620
 *  directory, or an archive. Even if there are multiple matches in different
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   621
 *  parts of the search path, only the first one found is used, just like
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   622
 *  when opening a file.
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   623
 *
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   624
 * So, if you look for "maps/level1.map", and C:\mygame is in your search
3
0dd785321345 Boatloads of updates to the spec.
Ryan C. Gordon <icculus@icculus.org>
parents: 2
diff changeset
   625
 *  path and C:\mygame\maps\level1.map exists, then "C:\mygame" is returned.
1
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   626
 *
15
418eacc97ac8 Tons of updates. Mostly implemented. Mostly compiling.
Ryan C. Gordon <icculus@icculus.org>
parents: 8
diff changeset
   627
 * If a any part of a match is a symbolic link, and you've not explicitly
418eacc97ac8 Tons of updates. Mostly implemented. Mostly compiling.
Ryan C. Gordon <icculus@icculus.org>
parents: 8
diff changeset
   628
 *  permitted symlinks, then it will be ignored, and the search for a match
418eacc97ac8 Tons of updates. Mostly implemented. Mostly compiling.
Ryan C. Gordon <icculus@icculus.org>
parents: 8
diff changeset
   629
 *  will continue.
2
24ba671694af Fixed typos, expanded documentation, added init and deinit functions, and
Ryan C. Gordon <icculus@icculus.org>
parents: 1
diff changeset
   630
 *
1
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   631
 *     @param filename file to look for.
3
0dd785321345 Boatloads of updates to the spec.
Ryan C. Gordon <icculus@icculus.org>
parents: 2
diff changeset
   632
 *    @return READ ONLY string of element of search path containing the
0dd785321345 Boatloads of updates to the spec.
Ryan C. Gordon <icculus@icculus.org>
parents: 2
diff changeset
   633
 *             the file in question. NULL if not found.
1
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   634
 */
74
a4a5066fb640 Compiles and runs on Visual C. What an uphill climb THAT was.
Ryan C. Gordon <icculus@icculus.org>
parents: 69
diff changeset
   635
__EXPORT__ const char *PHYSFS_getRealDir(const char *filename);
3
0dd785321345 Boatloads of updates to the spec.
Ryan C. Gordon <icculus@icculus.org>
parents: 2
diff changeset
   636
0dd785321345 Boatloads of updates to the spec.
Ryan C. Gordon <icculus@icculus.org>
parents: 2
diff changeset
   637
0dd785321345 Boatloads of updates to the spec.
Ryan C. Gordon <icculus@icculus.org>
parents: 2
diff changeset
   638
0dd785321345 Boatloads of updates to the spec.
Ryan C. Gordon <icculus@icculus.org>
parents: 2
diff changeset
   639
/**
0dd785321345 Boatloads of updates to the spec.
Ryan C. Gordon <icculus@icculus.org>
parents: 2
diff changeset
   640
 * Get a file listing of a search path's directory. Matching directories are
6
3662cbc014ef More updates, corrections, clarifications...
Ryan C. Gordon <icculus@icculus.org>
parents: 3
diff changeset
   641
 *  interpolated. That is, if "C:\mydir" is in the search path and contains a
3
0dd785321345 Boatloads of updates to the spec.
Ryan C. Gordon <icculus@icculus.org>
parents: 2
diff changeset
   642
 *  directory "savegames" that contains "x.sav", "y.sav", and "z.sav", and
6
3662cbc014ef More updates, corrections, clarifications...
Ryan C. Gordon <icculus@icculus.org>
parents: 3
diff changeset
   643
 *  there is also a "C:\userdir" in the search path that has a "savegames"
3
0dd785321345 Boatloads of updates to the spec.
Ryan C. Gordon <icculus@icculus.org>
parents: 2
diff changeset
   644
 *  subdirectory with "w.sav", then the following code:
0dd785321345 Boatloads of updates to the spec.
Ryan C. Gordon <icculus@icculus.org>
parents: 2
diff changeset
   645
 *
0dd785321345 Boatloads of updates to the spec.
Ryan C. Gordon <icculus@icculus.org>
parents: 2
diff changeset
   646
 * ------------------------------------------------
0dd785321345 Boatloads of updates to the spec.
Ryan C. Gordon <icculus@icculus.org>
parents: 2
diff changeset
   647
 * char **rc = PHYSFS_enumerateFiles("savegames");
0dd785321345 Boatloads of updates to the spec.
Ryan C. Gordon <icculus@icculus.org>
parents: 2
diff changeset
   648
 * char **i;
0dd785321345 Boatloads of updates to the spec.
Ryan C. Gordon <icculus@icculus.org>
parents: 2
diff changeset
   649
 *
0dd785321345 Boatloads of updates to the spec.
Ryan C. Gordon <icculus@icculus.org>
parents: 2
diff changeset
   650
 * for (i = rc; *i != NULL; i++)
0dd785321345 Boatloads of updates to the spec.
Ryan C. Gordon <icculus@icculus.org>
parents: 2
diff changeset
   651
 *     printf("We've got [%s].\n", *i);
0dd785321345 Boatloads of updates to the spec.
Ryan C. Gordon <icculus@icculus.org>
parents: 2
diff changeset
   652
 *
0dd785321345 Boatloads of updates to the spec.
Ryan C. Gordon <icculus@icculus.org>
parents: 2
diff changeset
   653
 * PHYSFS_freeList(rc);
0dd785321345 Boatloads of updates to the spec.
Ryan C. Gordon <icculus@icculus.org>
parents: 2
diff changeset
   654
 * ------------------------------------------------
0dd785321345 Boatloads of updates to the spec.
Ryan C. Gordon <icculus@icculus.org>
parents: 2
diff changeset
   655
 *
0dd785321345 Boatloads of updates to the spec.
Ryan C. Gordon <icculus@icculus.org>
parents: 2
diff changeset
   656
 *  ...will print:
0dd785321345 Boatloads of updates to the spec.
Ryan C. Gordon <icculus@icculus.org>
parents: 2
diff changeset
   657
 *
0dd785321345 Boatloads of updates to the spec.
Ryan C. Gordon <icculus@icculus.org>
parents: 2
diff changeset
   658
 * ------------------------------------------------
0dd785321345 Boatloads of updates to the spec.
Ryan C. Gordon <icculus@icculus.org>
parents: 2
diff changeset
   659
 * We've got [x.sav].
0dd785321345 Boatloads of updates to the spec.
Ryan C. Gordon <icculus@icculus.org>
parents: 2
diff changeset
   660
 * We've got [y.sav].
0dd785321345 Boatloads of updates to the spec.
Ryan C. Gordon <icculus@icculus.org>
parents: 2
diff changeset
   661
 * We've got [z.sav].
0dd785321345 Boatloads of updates to the spec.
Ryan C. Gordon <icculus@icculus.org>
parents: 2
diff changeset
   662
 * We've got [w.sav].
0dd785321345 Boatloads of updates to the spec.
Ryan C. Gordon <icculus@icculus.org>
parents: 2
diff changeset
   663
 * ------------------------------------------------
0dd785321345 Boatloads of updates to the spec.
Ryan C. Gordon <icculus@icculus.org>
parents: 2
diff changeset
   664
 *
6
3662cbc014ef More updates, corrections, clarifications...
Ryan C. Gordon <icculus@icculus.org>
parents: 3
diff changeset
   665
 * Feel free to sort the list however you like. We only promise there will
3662cbc014ef More updates, corrections, clarifications...
Ryan C. Gordon <icculus@icculus.org>
parents: 3
diff changeset
   666
 *  be no duplicates, but not what order the final list will come back in.
3662cbc014ef More updates, corrections, clarifications...
Ryan C. Gordon <icculus@icculus.org>
parents: 3
diff changeset
   667
 *
3
0dd785321345 Boatloads of updates to the spec.
Ryan C. Gordon <icculus@icculus.org>
parents: 2
diff changeset
   668
 * Don't forget to call PHYSFS_freeList() with the return value from this
0dd785321345 Boatloads of updates to the spec.
Ryan C. Gordon <icculus@icculus.org>
parents: 2
diff changeset
   669
 *  function when you are done with it.
0dd785321345 Boatloads of updates to the spec.
Ryan C. Gordon <icculus@icculus.org>
parents: 2
diff changeset
   670
 *
6
3662cbc014ef More updates, corrections, clarifications...
Ryan C. Gordon <icculus@icculus.org>
parents: 3
diff changeset
   671
 *    @param dir directory in platform-independent notation to enumerate.
3
0dd785321345 Boatloads of updates to the spec.
Ryan C. Gordon <icculus@icculus.org>
parents: 2
diff changeset
   672
 *   @return Null-terminated array of null-terminated strings.
0dd785321345 Boatloads of updates to the spec.
Ryan C. Gordon <icculus@icculus.org>
parents: 2
diff changeset
   673
 */
74
a4a5066fb640 Compiles and runs on Visual C. What an uphill climb THAT was.
Ryan C. Gordon <icculus@icculus.org>
parents: 69
diff changeset
   674
__EXPORT__ char **PHYSFS_enumerateFiles(const char *dir);
1
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   675
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   676
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   677
/**
15
418eacc97ac8 Tons of updates. Mostly implemented. Mostly compiling.
Ryan C. Gordon <icculus@icculus.org>
parents: 8
diff changeset
   678
 * Determine if there is an entry anywhere in the search path by the
418eacc97ac8 Tons of updates. Mostly implemented. Mostly compiling.
Ryan C. Gordon <icculus@icculus.org>
parents: 8
diff changeset
   679
 *  name of (fname).
418eacc97ac8 Tons of updates. Mostly implemented. Mostly compiling.
Ryan C. Gordon <icculus@icculus.org>
parents: 8
diff changeset
   680
 *
418eacc97ac8 Tons of updates. Mostly implemented. Mostly compiling.
Ryan C. Gordon <icculus@icculus.org>
parents: 8
diff changeset
   681
 * Note that entries that are symlinks are ignored if
418eacc97ac8 Tons of updates. Mostly implemented. Mostly compiling.
Ryan C. Gordon <icculus@icculus.org>
parents: 8
diff changeset
   682
 *  PHYSFS_permitSymbolicLinks(1) hasn't been called, so you
418eacc97ac8 Tons of updates. Mostly implemented. Mostly compiling.
Ryan C. Gordon <icculus@icculus.org>
parents: 8
diff changeset
   683
 *  might end up further down in the search path than expected.
418eacc97ac8 Tons of updates. Mostly implemented. Mostly compiling.
Ryan C. Gordon <icculus@icculus.org>
parents: 8
diff changeset
   684
 *
418eacc97ac8 Tons of updates. Mostly implemented. Mostly compiling.
Ryan C. Gordon <icculus@icculus.org>
parents: 8
diff changeset
   685
 *    @param fname filename in platform-independent notation.
418eacc97ac8 Tons of updates. Mostly implemented. Mostly compiling.
Ryan C. Gordon <icculus@icculus.org>
parents: 8
diff changeset
   686
 *   @return non-zero if filename exists. zero otherwise.
418eacc97ac8 Tons of updates. Mostly implemented. Mostly compiling.
Ryan C. Gordon <icculus@icculus.org>
parents: 8
diff changeset
   687
 */
74
a4a5066fb640 Compiles and runs on Visual C. What an uphill climb THAT was.
Ryan C. Gordon <icculus@icculus.org>
parents: 69
diff changeset
   688
__EXPORT__ int PHYSFS_exists(const char *fname);
15
418eacc97ac8 Tons of updates. Mostly implemented. Mostly compiling.
Ryan C. Gordon <icculus@icculus.org>
parents: 8
diff changeset
   689
418eacc97ac8 Tons of updates. Mostly implemented. Mostly compiling.
Ryan C. Gordon <icculus@icculus.org>
parents: 8
diff changeset
   690
418eacc97ac8 Tons of updates. Mostly implemented. Mostly compiling.
Ryan C. Gordon <icculus@icculus.org>
parents: 8
diff changeset
   691
/**
418eacc97ac8 Tons of updates. Mostly implemented. Mostly compiling.
Ryan C. Gordon <icculus@icculus.org>
parents: 8
diff changeset
   692
 * Determine if the first occurence of (fname) in the search path is
418eacc97ac8 Tons of updates. Mostly implemented. Mostly compiling.
Ryan C. Gordon <icculus@icculus.org>
parents: 8
diff changeset
   693
 *  really a directory entry.
418eacc97ac8 Tons of updates. Mostly implemented. Mostly compiling.
Ryan C. Gordon <icculus@icculus.org>
parents: 8
diff changeset
   694
 *
418eacc97ac8 Tons of updates. Mostly implemented. Mostly compiling.
Ryan C. Gordon <icculus@icculus.org>
parents: 8
diff changeset
   695
 * Note that entries that are symlinks are ignored if
418eacc97ac8 Tons of updates. Mostly implemented. Mostly compiling.
Ryan C. Gordon <icculus@icculus.org>
parents: 8
diff changeset
   696
 *  PHYSFS_permitSymbolicLinks(1) hasn't been called, so you
418eacc97ac8 Tons of updates. Mostly implemented. Mostly compiling.
Ryan C. Gordon <icculus@icculus.org>
parents: 8
diff changeset
   697
 *  might end up further down in the search path than expected.
418eacc97ac8 Tons of updates. Mostly implemented. Mostly compiling.
Ryan C. Gordon <icculus@icculus.org>
parents: 8
diff changeset
   698
 *
418eacc97ac8 Tons of updates. Mostly implemented. Mostly compiling.
Ryan C. Gordon <icculus@icculus.org>
parents: 8
diff changeset
   699
 *    @param fname filename in platform-independent notation.
418eacc97ac8 Tons of updates. Mostly implemented. Mostly compiling.
Ryan C. Gordon <icculus@icculus.org>
parents: 8
diff changeset
   700
 *   @return non-zero if filename exists and is a directory.  zero otherwise.
418eacc97ac8 Tons of updates. Mostly implemented. Mostly compiling.
Ryan C. Gordon <icculus@icculus.org>
parents: 8
diff changeset
   701
 */
74
a4a5066fb640 Compiles and runs on Visual C. What an uphill climb THAT was.
Ryan C. Gordon <icculus@icculus.org>
parents: 69
diff changeset
   702
__EXPORT__ int PHYSFS_isDirectory(const char *fname);
15
418eacc97ac8 Tons of updates. Mostly implemented. Mostly compiling.
Ryan C. Gordon <icculus@icculus.org>
parents: 8
diff changeset
   703
418eacc97ac8 Tons of updates. Mostly implemented. Mostly compiling.
Ryan C. Gordon <icculus@icculus.org>
parents: 8
diff changeset
   704
418eacc97ac8 Tons of updates. Mostly implemented. Mostly compiling.
Ryan C. Gordon <icculus@icculus.org>
parents: 8
diff changeset
   705
/**
418eacc97ac8 Tons of updates. Mostly implemented. Mostly compiling.
Ryan C. Gordon <icculus@icculus.org>
parents: 8
diff changeset
   706
 * Determine if the first occurence of (fname) in the search path is
418eacc97ac8 Tons of updates. Mostly implemented. Mostly compiling.
Ryan C. Gordon <icculus@icculus.org>
parents: 8
diff changeset
   707
 *  really a symbolic link.
418eacc97ac8 Tons of updates. Mostly implemented. Mostly compiling.
Ryan C. Gordon <icculus@icculus.org>
parents: 8
diff changeset
   708
 *
418eacc97ac8 Tons of updates. Mostly implemented. Mostly compiling.
Ryan C. Gordon <icculus@icculus.org>
parents: 8
diff changeset
   709
 * Note that entries that are symlinks are ignored if
418eacc97ac8 Tons of updates. Mostly implemented. Mostly compiling.
Ryan C. Gordon <icculus@icculus.org>
parents: 8
diff changeset
   710
 *  PHYSFS_permitSymbolicLinks(1) hasn't been called, and as such,
418eacc97ac8 Tons of updates. Mostly implemented. Mostly compiling.
Ryan C. Gordon <icculus@icculus.org>
parents: 8
diff changeset
   711
 *  this function will always return 0 in that case.
418eacc97ac8 Tons of updates. Mostly implemented. Mostly compiling.
Ryan C. Gordon <icculus@icculus.org>
parents: 8
diff changeset
   712
 *
418eacc97ac8 Tons of updates. Mostly implemented. Mostly compiling.
Ryan C. Gordon <icculus@icculus.org>
parents: 8
diff changeset
   713
 *    @param fname filename in platform-independent notation.
418eacc97ac8 Tons of updates. Mostly implemented. Mostly compiling.
Ryan C. Gordon <icculus@icculus.org>
parents: 8
diff changeset
   714
 *   @return non-zero if filename exists and is a symlink.  zero otherwise.
418eacc97ac8 Tons of updates. Mostly implemented. Mostly compiling.
Ryan C. Gordon <icculus@icculus.org>
parents: 8
diff changeset
   715
 */
74
a4a5066fb640 Compiles and runs on Visual C. What an uphill climb THAT was.
Ryan C. Gordon <icculus@icculus.org>
parents: 69
diff changeset
   716
__EXPORT__ int PHYSFS_isSymbolicLink(const char *fname);
15
418eacc97ac8 Tons of updates. Mostly implemented. Mostly compiling.
Ryan C. Gordon <icculus@icculus.org>
parents: 8
diff changeset
   717
418eacc97ac8 Tons of updates. Mostly implemented. Mostly compiling.
Ryan C. Gordon <icculus@icculus.org>
parents: 8
diff changeset
   718
418eacc97ac8 Tons of updates. Mostly implemented. Mostly compiling.
Ryan C. Gordon <icculus@icculus.org>
parents: 8
diff changeset
   719
/**
1
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   720
 * Open a file for writing, in platform-independent notation and in relation
6
3662cbc014ef More updates, corrections, clarifications...
Ryan C. Gordon <icculus@icculus.org>
parents: 3
diff changeset
   721
 *  to the write dir as the root of the writable filesystem. The specified
1
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   722
 *  file is created if it doesn't exist. If it does exist, it is truncated to
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   723
 *  zero bytes, and the writing offset is set to the start.
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   724
 *
15
418eacc97ac8 Tons of updates. Mostly implemented. Mostly compiling.
Ryan C. Gordon <icculus@icculus.org>
parents: 8
diff changeset
   725
 * Note that entries that are symlinks are ignored if
418eacc97ac8 Tons of updates. Mostly implemented. Mostly compiling.
Ryan C. Gordon <icculus@icculus.org>
parents: 8
diff changeset
   726
 *  PHYSFS_permitSymbolicLinks(1) hasn't been called, and opening a
418eacc97ac8 Tons of updates. Mostly implemented. Mostly compiling.
Ryan C. Gordon <icculus@icculus.org>
parents: 8
diff changeset
   727
 *  symlink with this function will fail in such a case.
418eacc97ac8 Tons of updates. Mostly implemented. Mostly compiling.
Ryan C. Gordon <icculus@icculus.org>
parents: 8
diff changeset
   728
 *
1
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   729
 *   @param filename File to open.
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   730
 *  @return A valid PhysicsFS filehandle on success, NULL on error. Specifics
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   731
 *           of the error can be gleaned from PHYSFS_getLastError().
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   732
 */
74
a4a5066fb640 Compiles and runs on Visual C. What an uphill climb THAT was.
Ryan C. Gordon <icculus@icculus.org>
parents: 69
diff changeset
   733
__EXPORT__ PHYSFS_file *PHYSFS_openWrite(const char *filename);
1
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   734
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   735
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   736
/**
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   737
 * Open a file for writing, in platform-independent notation and in relation
6
3662cbc014ef More updates, corrections, clarifications...
Ryan C. Gordon <icculus@icculus.org>
parents: 3
diff changeset
   738
 *  to the write dir as the root of the writable filesystem. The specified
1
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   739
 *  file is created if it doesn't exist. If it does exist, the writing offset
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   740
 *  is set to the end of the file, so the first write will be the byte after
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   741
 *  the end.
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   742
 *
15
418eacc97ac8 Tons of updates. Mostly implemented. Mostly compiling.
Ryan C. Gordon <icculus@icculus.org>
parents: 8
diff changeset
   743
 * Note that entries that are symlinks are ignored if
418eacc97ac8 Tons of updates. Mostly implemented. Mostly compiling.
Ryan C. Gordon <icculus@icculus.org>
parents: 8
diff changeset
   744
 *  PHYSFS_permitSymbolicLinks(1) hasn't been called, and opening a
418eacc97ac8 Tons of updates. Mostly implemented. Mostly compiling.
Ryan C. Gordon <icculus@icculus.org>
parents: 8
diff changeset
   745
 *  symlink with this function will fail in such a case.
418eacc97ac8 Tons of updates. Mostly implemented. Mostly compiling.
Ryan C. Gordon <icculus@icculus.org>
parents: 8
diff changeset
   746
 *
1
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   747
 *   @param filename File to open.
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   748
 *  @return A valid PhysicsFS filehandle on success, NULL on error. Specifics
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   749
 *           of the error can be gleaned from PHYSFS_getLastError().
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   750
 */
74
a4a5066fb640 Compiles and runs on Visual C. What an uphill climb THAT was.
Ryan C. Gordon <icculus@icculus.org>
parents: 69
diff changeset
   751
__EXPORT__ PHYSFS_file *PHYSFS_openAppend(const char *filename);
1
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   752
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   753
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   754
/**
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   755
 * Open a file for reading, in platform-independent notation. The search path
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   756
 *  is checked one at a time until a matching file is found, in which case an
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   757
 *  abstract filehandle is associated with it, and reading may be done.
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   758
 *  The reading offset is set to the first byte of the file.
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   759
 *
15
418eacc97ac8 Tons of updates. Mostly implemented. Mostly compiling.
Ryan C. Gordon <icculus@icculus.org>
parents: 8
diff changeset
   760
 * Note that entries that are symlinks are ignored if
418eacc97ac8 Tons of updates. Mostly implemented. Mostly compiling.
Ryan C. Gordon <icculus@icculus.org>
parents: 8
diff changeset
   761
 *  PHYSFS_permitSymbolicLinks(1) hasn't been called, and opening a
418eacc97ac8 Tons of updates. Mostly implemented. Mostly compiling.
Ryan C. Gordon <icculus@icculus.org>
parents: 8
diff changeset
   762
 *  symlink with this function will fail in such a case.
418eacc97ac8 Tons of updates. Mostly implemented. Mostly compiling.
Ryan C. Gordon <icculus@icculus.org>
parents: 8
diff changeset
   763
 *
1
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   764
 *   @param filename File to open.
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   765
 *  @return A valid PhysicsFS filehandle on success, NULL on error. Specifics
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   766
 *           of the error can be gleaned from PHYSFS_getLastError().
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   767
 */
74
a4a5066fb640 Compiles and runs on Visual C. What an uphill climb THAT was.
Ryan C. Gordon <icculus@icculus.org>
parents: 69
diff changeset
   768
__EXPORT__ PHYSFS_file *PHYSFS_openRead(const char *filename);
1
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   769
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   770
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   771
/**
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   772
 * Close a PhysicsFS filehandle. This call is capable of failing if the
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   773
 *  operating system was buffering writes to this file, and (now forced to
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   774
 *  write those changes to physical media) can not store the data for any
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   775
 *  reason. In such a case, the filehandle stays open. A well-written program
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   776
 *  should ALWAYS check the return value from the close call in addition to
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   777
 *  every writing call!
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   778
 *
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   779
 *   @param handle handle returned from PHYSFS_open*().
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   780
 *  @return nonzero on success, zero on error. Specifics of the error can be
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   781
 *          gleaned from PHYSFS_getLastError().
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   782
 */
74
a4a5066fb640 Compiles and runs on Visual C. What an uphill climb THAT was.
Ryan C. Gordon <icculus@icculus.org>
parents: 69
diff changeset
   783
__EXPORT__ int PHYSFS_close(PHYSFS_file *handle);
1
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   784
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   785
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   786
/**
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   787
 * Read data from a PhysicsFS filehandle. The file must be opened for reading.
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   788
 *
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   789
 *   @param handle handle returned from PHYSFS_openRead().
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   790
 *   @param buffer buffer to store read data into.
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   791
 *   @param objSize size in bytes of objects being read from (handle).
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   792
 *   @param objCount number of (objSize) objects to read from (handle).
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   793
 *  @return number of objects read. PHYSFS_getLastError() can shed light on
3
0dd785321345 Boatloads of updates to the spec.
Ryan C. Gordon <icculus@icculus.org>
parents: 2
diff changeset
   794
 *           the reason this might be < (objCount), as can PHYSFS_eof().
8
41e4c6031535 Typo fixes, clarifications, and corrections.
Ryan C. Gordon <icculus@icculus.org>
parents: 6
diff changeset
   795
 *            -1 if complete failure.
1
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   796
 */
132
b53fa5093749 Added typedefs and platform-specific i/o.
Ryan C. Gordon <icculus@icculus.org>
parents: 128
diff changeset
   797
__EXPORT__ PHYSFS_sint64 PHYSFS_read(PHYSFS_file *handle,
b53fa5093749 Added typedefs and platform-specific i/o.
Ryan C. Gordon <icculus@icculus.org>
parents: 128
diff changeset
   798
                                     void *buffer,
b53fa5093749 Added typedefs and platform-specific i/o.
Ryan C. Gordon <icculus@icculus.org>
parents: 128
diff changeset
   799
                                     PHYSFS_uint32 objSize,
b53fa5093749 Added typedefs and platform-specific i/o.
Ryan C. Gordon <icculus@icculus.org>
parents: 128
diff changeset
   800
                                     PHYSFS_uint32 objCount);
1
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   801
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   802
/**
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   803
 * Write data to a PhysicsFS filehandle. The file must be opened for writing.
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   804
 *
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   805
 *   @param handle retval from PHYSFS_openWrite() or PHYSFS_openAppend().
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   806
 *   @param buffer buffer to store read data into.
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   807
 *   @param objSize size in bytes of objects being read from (handle).
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   808
 *   @param objCount number of (objSize) objects to read from (handle).
8
41e4c6031535 Typo fixes, clarifications, and corrections.
Ryan C. Gordon <icculus@icculus.org>
parents: 6
diff changeset
   809
 *  @return number of objects written. PHYSFS_getLastError() can shed light on
41e4c6031535 Typo fixes, clarifications, and corrections.
Ryan C. Gordon <icculus@icculus.org>
parents: 6
diff changeset
   810
 *           the reason this might be < (objCount). -1 if complete failure.
1
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   811
 */
132
b53fa5093749 Added typedefs and platform-specific i/o.
Ryan C. Gordon <icculus@icculus.org>
parents: 128
diff changeset
   812
__EXPORT__ PHYSFS_sint64 PHYSFS_write(PHYSFS_file *handle,
b53fa5093749 Added typedefs and platform-specific i/o.
Ryan C. Gordon <icculus@icculus.org>
parents: 128
diff changeset
   813
                                      const void *buffer,
b53fa5093749 Added typedefs and platform-specific i/o.
Ryan C. Gordon <icculus@icculus.org>
parents: 128
diff changeset
   814
                                      PHYSFS_uint32 objSize,
b53fa5093749 Added typedefs and platform-specific i/o.
Ryan C. Gordon <icculus@icculus.org>
parents: 128
diff changeset
   815
                                      PHYSFS_uint32 objCount);
1
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   816
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   817
/**
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   818
 * Determine if the end of file has been reached in a PhysicsFS filehandle.
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   819
 *
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   820
 *   @param handle handle returned from PHYSFS_openRead().
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   821
 *  @return nonzero if EOF, zero if not.
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   822
 */
74
a4a5066fb640 Compiles and runs on Visual C. What an uphill climb THAT was.
Ryan C. Gordon <icculus@icculus.org>
parents: 69
diff changeset
   823
__EXPORT__ int PHYSFS_eof(PHYSFS_file *handle);
1
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   824
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   825
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   826
/**
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   827
 * Determine current position within a PhysicsFS filehandle.
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   828
 *
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   829
 *   @param handle handle returned from PHYSFS_open*().
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   830
 *  @return offset in bytes from start of file. -1 if error occurred.
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   831
 *           Specifics of the error can be gleaned from PHYSFS_getLastError().
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   832
 */
132
b53fa5093749 Added typedefs and platform-specific i/o.
Ryan C. Gordon <icculus@icculus.org>
parents: 128
diff changeset
   833
__EXPORT__ PHYSFS_sint64 PHYSFS_tell(PHYSFS_file *handle);
1
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   834
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   835
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   836
/**
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   837
 * Seek to a new position within a PhysicsFS filehandle. The next read or write
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   838
 *  will occur at that place. Seeking past the beginning or end of the file is
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   839
 *  not allowed.
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   840
 *
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   841
 *   @param handle handle returned from PHYSFS_open*().
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   842
 *   @param pos number of bytes from start of file to seek to.
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   843
 *  @return nonzero on success, zero on error. Specifics of the error can be
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   844
 *          gleaned from PHYSFS_getLastError().
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   845
 */
132
b53fa5093749 Added typedefs and platform-specific i/o.
Ryan C. Gordon <icculus@icculus.org>
parents: 128
diff changeset
   846
__EXPORT__ int PHYSFS_seek(PHYSFS_file *handle, PHYSFS_uint64 pos);
2
24ba671694af Fixed typos, expanded documentation, added init and deinit functions, and
Ryan C. Gordon <icculus@icculus.org>
parents: 1
diff changeset
   847
28
529214f57d1b Added PHYSFS_fileLength(). Bleh.
Ryan C. Gordon <icculus@icculus.org>
parents: 23
diff changeset
   848
529214f57d1b Added PHYSFS_fileLength(). Bleh.
Ryan C. Gordon <icculus@icculus.org>
parents: 23
diff changeset
   849
/**
529214f57d1b Added PHYSFS_fileLength(). Bleh.
Ryan C. Gordon <icculus@icculus.org>
parents: 23
diff changeset
   850
 * Get total length of a file in bytes. Note that if the file size can't
529214f57d1b Added PHYSFS_fileLength(). Bleh.
Ryan C. Gordon <icculus@icculus.org>
parents: 23
diff changeset
   851
 *  be determined (since the archive is "streamed" or whatnot) than this
126
f5135b499c0c const correctness fixes.
Ryan C. Gordon <icculus@icculus.org>
parents: 101
diff changeset
   852
 *  will report (-1). Also note that if another process/thread is writing
28
529214f57d1b Added PHYSFS_fileLength(). Bleh.
Ryan C. Gordon <icculus@icculus.org>
parents: 23
diff changeset
   853
 *  to this file at the same time, then the information this function
529214f57d1b Added PHYSFS_fileLength(). Bleh.
Ryan C. Gordon <icculus@icculus.org>
parents: 23
diff changeset
   854
 *  supplies could be incorrect before you get it. Use with caution, or
529214f57d1b Added PHYSFS_fileLength(). Bleh.
Ryan C. Gordon <icculus@icculus.org>
parents: 23
diff changeset
   855
 *  better yet, don't use at all.
529214f57d1b Added PHYSFS_fileLength(). Bleh.
Ryan C. Gordon <icculus@icculus.org>
parents: 23
diff changeset
   856
 *
529214f57d1b Added PHYSFS_fileLength(). Bleh.
Ryan C. Gordon <icculus@icculus.org>
parents: 23
diff changeset
   857
 *   @param handle handle returned from PHYSFS_open*().
529214f57d1b Added PHYSFS_fileLength(). Bleh.
Ryan C. Gordon <icculus@icculus.org>
parents: 23
diff changeset
   858
 *  @return size in bytes of the file. -1 if can't be determined.
529214f57d1b Added PHYSFS_fileLength(). Bleh.
Ryan C. Gordon <icculus@icculus.org>
parents: 23
diff changeset
   859
 */
132
b53fa5093749 Added typedefs and platform-specific i/o.
Ryan C. Gordon <icculus@icculus.org>
parents: 128
diff changeset
   860
__EXPORT__ PHYSFS_sint64 PHYSFS_fileLength(PHYSFS_file *handle);
28
529214f57d1b Added PHYSFS_fileLength(). Bleh.
Ryan C. Gordon <icculus@icculus.org>
parents: 23
diff changeset
   861
1
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   862
#ifdef __cplusplus
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   863
}
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   864
#endif
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   865
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   866
#endif  /* !defined _INCLUDE_PHYSFS_H_ */
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   867
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   868
/* end of physfs.h ... */
b5ce9d35fdb4 Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   869