plugins/vfswad/vfs.h

   1 /*
   2    Copyright (c) 2001, Loki software, inc.
   3    All rights reserved.
   4
   5    Redistribution and use in source and binary forms, with or without modification,
   6    are permitted provided that the following conditions are met:
   7
   8    Redistributions of source code must retain the above copyright notice, this list
   9    of conditions and the following disclaimer.
  10
  11    Redistributions in binary form must reproduce the above copyright notice, this
  12    list of conditions and the following disclaimer in the documentation and/or
  13    other materials provided with the distribution.
  14
  15    Neither the name of Loki software nor the names of its contributors may be used
  16    to endorse or promote products derived from this software without specific prior
  17    written permission.
  18
  19    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS ``AS IS''
  20    AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  21    IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  22    DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE FOR ANY
  23    DIRECT,INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  24    (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  25    LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
  26    ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  27    (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  28    SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  29  */
  30
  31 #ifndef _VFS_H_
  32 #define _VFS_H_
  33
  34 #define VFS_MAXDIRS 8
  35
  36 void vfsInitDirectory( const char *path );
  37 void vfsShutdown();
  38 void vfsFreeFile( void *p );
  39 GSList* vfsGetFileList( const char *dir, const char *ext );
  40 GSList* vfsGetDirList( const char *dir );
  41 void vfsClearFileDirList( GSList **lst );
  42 int vfsGetFileCount( const char *filename, int flag );
  43 int vfsLoadFile( const char *filename, void **buffer, int index = 0 );
  44 int vfsLoadFullPathFile( const char *filename, void **buffer );
  45
  46 // some useful functions
  47 // clean a file name to a unique representation
  48 // very usefull if you have to do some weird manips on the files
  49 // works on regular files and dirs
  50 // will convert to lowercase, unix path ('/' filename seperator)
  51 // on win32, will build the short path name
  52 // directories will be cleaned, no ending filename seperator
  53 // we modify the entry directly, the size of the string can only go down
  54 void vfsCleanFileName( char * );
  55 // these return a static char*, doesn't need to be freed or anything
  56 // get the base path to use when raising file dialogs
  57 // we manually add "maps/" or "sounds/" or "mapobjects/models/" etc.
  58 const char* vfsBasePromptPath();
  59 // extract the relative path from a full path
  60 // will match against any of the base paths we have
  61 // returns NULL if not found
  62 char* vfsExtractRelativePath( const char *in );
  63 // returns the full path (in a static buff) to a file given it's relative path
  64 // returns the first file in the list or NULL if not found
  65 // see ifilesystem.h for more notes
  66 char* vfsGetFullPath( const char*, int index = 0, int flag = 0 );
  67
  68
  69 #endif // _VFS_H_