Main Page Class Hierarchy Compound List File List Compound Members File Members Related Pages

# cpl_vsi.h

Go to the documentation of this file.

    00001 /******************************************************************************
    00002  * Copyright (c) 1998, Frank Warmerdam
    00003  *
    00004  * Permission is hereby granted, free of charge, to any person obtaining a
    00005  * copy of this software and associated documentation files (the "Software"),
    00006  * to deal in the Software without restriction, including without limitation
    00007  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
    00008  * and/or sell copies of the Software, and to permit persons to whom the
    00009  * Software is furnished to do so, subject to the following conditions:
    00010  *
    00011  * The above copyright notice and this permission notice shall be included
    00012  * in all copies or substantial portions of the Software.
    00013  *
    00014  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
    00015  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    00016  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
    00017  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    00018  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
    00019  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
    00020  * DEALINGS IN THE SOFTWARE.
    00021  ******************************************************************************
    00022  *
    00023  * cpl_vsi.h
    00024  *
    00025  * Include file defining the Virtual System Interface (VSI) functions.  This
    00026  * should normally be included by all translators using VSI functions for
    00027  * accessing system services.  It is also used by the GDAL core, and can be
    00028  * used by higher level applications which adhere to VSI use.
    00029  *
    00030  * Most VSI functions are direct analogs of Posix C library functions.
    00031  * VSI exists to allow ``hooking'' these functions to provide application
    00032  * specific checking, io redirection and so on.
    00033  *
    00034  * $Log: cpl_vsi_h-source.html,v $
    00034  * Revision 1.8  2001/07/05 13:24:08  warmerda
    00034  * *** empty log message ***
    00034  *
    00035  * Revision 1.11  2001/04/30 18:19:06  warmerda
    00036  * avoid stat on macos_pre10
    00037  *
    00038  * Revision 1.10  2001/01/19 21:16:41  warmerda
    00039  * expanded tabs
    00040  *
    00041  * Revision 1.9  2001/01/03 17:41:44  warmerda
    00042  * added #define for VSIFFlushL
    00043  *
    00044  * Revision 1.8  2001/01/03 16:17:50  warmerda
    00045  * added large file API
    00046  *
    00047  * Revision 1.7  2000/12/14 18:29:48  warmerda
    00048  * added VSIMkdir
    00049  *
    00050  * Revision 1.6  2000/01/25 03:11:03  warmerda
    00051  * added unlink and mkdir
    00052  *
    00053  * Revision 1.5  1999/05/23 02:43:57  warmerda
    00054  * Added documentation block.
    00055  *
    00056  * Revision 1.4  1999/02/25 04:48:11  danmo
    00057  * Added VSIStat() macros specific to _WIN32 (for MSVC++)
    00058  *
    00059  * Revision 1.3  1999/01/28 18:31:25  warmerda
    00060  * Test on _WIN32 rather than WIN32.  It seems to be more reliably defined.
    00061  *
    00062  * Revision 1.2  1998/12/04 21:42:57  danmo
    00063  * Added #ifndef WIN32 arounf #include <unistd.h>
    00064  *
    00065  * Revision 1.1  1998/12/03 18:26:02  warmerda
    00066  * New
    00067  *
    00068  */
    00069
    00070 #ifndef CPL_VSI_H_INCLUDED
    00071 #define CPL_VSI_H_INCLUDED
    00072
    00073 #include "cpl_port.h"
    00093 /* -------------------------------------------------------------------- */
    00094 /*      We need access to ``struct stat''.                              */
    00095 /* -------------------------------------------------------------------- */
    00096 #ifndef _WIN32
    00097 #  include <unistd.h>
    00098 #endif
    00099 #if !defined(macos_pre10)
    00100 #  include <sys/stat.h>
    00101 #endif
    00102
    00103 CPL_C_START
    00104
    00105 /* ==================================================================== */
    00106 /*      stdio file access functions.                                    */
    00107 /* ==================================================================== */
    00108
    00109 FILE CPL_DLL *  VSIFOpen( const char *, const char * );
    00110 int CPL_DLL     VSIFClose( FILE * );
    00111 int CPL_DLL     VSIFSeek( FILE *, long, int );
    00112 long CPL_DLL    VSIFTell( FILE * );
    00113 void CPL_DLL    VSIRewind( FILE * );
    00114 void CPL_DLL    VSIFFlush( FILE * );
    00115
    00116 size_t CPL_DLL  VSIFRead( void *, size_t, size_t, FILE * );
    00117 size_t CPL_DLL  VSIFWrite( void *, size_t, size_t, FILE * );
    00118 char CPL_DLL   *VSIFGets( char *, int, FILE * );
    00119 int CPL_DLL     VSIFPuts( const char *, FILE * );
    00120 int CPL_DLL     VSIFPrintf( FILE *, const char *, ... );
    00121
    00122 int CPL_DLL     VSIFGetc( FILE * );
    00123 int CPL_DLL     VSIFPutc( int, FILE * );
    00124 int CPL_DLL     VSIUngetc( int, FILE * );
    00125 int CPL_DLL     VSIFEof( FILE * );
    00126
    00127 /* ==================================================================== */
    00128 /*      64bit stdio file access functions.  If we have a big size       */
    00129 /*      defined, then provide protypes for the large file API,          */
    00130 /*      otherwise redefine to use the regular api.                      */
    00131 /* ==================================================================== */
    00132 #ifdef VSI_LARGE_API_SUPPORTED
    00133
    00134 typedef GUIntBig vsi_l_offset;
    00135
    00136 FILE CPL_DLL *  VSIFOpenL( const char *, const char * );
    00137 int CPL_DLL     VSIFCloseL( FILE * );
    00138 int CPL_DLL     VSIFSeekL( FILE *, vsi_l_offset, int );
    00139 vsi_l_offset CPL_DLL VSIFTellL( FILE * );
    00140 void CPL_DLL    VSIRewindL( FILE * );
    00141 size_t CPL_DLL  VSIFReadL( void *, size_t, size_t, FILE * );
    00142 size_t CPL_DLL  VSIFWriteL( void *, size_t, size_t, FILE * );
    00143 int CPL_DLL     VSIFEofL( FILE * );
    00144 void CPL_DLL    VSIFFlushL( FILE * );
    00145
    00146 #else
    00147
    00148 typedef long vsi_l_offset;
    00149
    00150 #define vsi_l_offset long
    00151
    00152 #define VSIFOpenL      VSIFOpen
    00153 #define VSIFCloseL     VSIFClose
    00154 #define VSIFSeekL      VSIFSeek
    00155 #define VSIFTellL      VSIFTell
    00156 #define VSIFRewindL    VSIFRewind
    00157 #define VSIFReadL      VSIFRead
    00158 #define VSIFWriteL     VSIFWrite
    00159 #define VSIFEofL       VSIFEof
    00160 #define VSIFFlushL     VSIFFlush
    00161
    00162 #endif
    00163
    00164 /* ==================================================================== */
    00165 /*      VSIStat() related.                                              */
    00166 /* ==================================================================== */
    00167
    00168 typedef struct stat VSIStatBuf;
    00169 int CPL_DLL     VSIStat( const char *, VSIStatBuf * );
    00170
    00171 #ifdef _WIN32
    00172 #  define VSI_ISLNK(x)  ( 0 )            /* N/A on Windows */
    00173 #  define VSI_ISREG(x)  ((x) & S_IFREG)
    00174 #  define VSI_ISDIR(x)  ((x) & S_IFDIR)
    00175 #  define VSI_ISCHR(x)  ((x) & S_IFCHR)
    00176 #  define VSI_ISBLK(x)  ( 0 )            /* N/A on Windows */
    00177 #else
    00178 #  define VSI_ISLNK(x)  S_ISLNK(x)
    00179 #  define VSI_ISREG(x)  S_ISREG(x)
    00180 #  define VSI_ISDIR(x)  S_ISDIR(x)
    00181 #  define VSI_ISCHR(x)  S_ISCHR(x)
    00182 #  define VSI_ISBLK(x)  S_ISBLK(x)
    00183 #endif
    00184
    00185 /* ==================================================================== */
    00186 /*      Memory allocation                                               */
    00187 /* ==================================================================== */
    00188
    00189 void CPL_DLL   *VSICalloc( size_t, size_t );
    00190 void CPL_DLL   *VSIMalloc( size_t );
    00191 void CPL_DLL    VSIFree( void * );
    00192 void CPL_DLL   *VSIRealloc( void *, size_t );
    00193 char CPL_DLL   *VSIStrdup( const char * );
    00194
    00195 /* ==================================================================== */
    00196 /*      Other...                                                        */
    00197 /* ==================================================================== */
    00198
    00199 int CPL_DLL VSIMkdir( const char * pathname, long mode );
    00200 int CPL_DLL VSIRmdir( const char * pathname );
    00201 int CPL_DLL VSIUnlink( const char * pathname );
    00202
    00203 CPL_C_END
    00204
    00205 #endif /* ndef CPL_VSI_H_INCLUDED */