09566a5c88
* harbour/include/hbapifs.h
! default usage of BSD locks in *BSD systems for emulating
DOS/Windows DENY_* flags has been disabled because tests
on FreeBSD 6.2 and MacOSX shows that this implementation
can create self deadlock when used simultaneously with
POSIX locks - thanks to Phil and Lorenzo for locating the
problem and tests.
247 lines
12 KiB
C
247 lines
12 KiB
C
/*
|
|
* $Id$
|
|
*/
|
|
|
|
/*
|
|
* Harbour Project source code:
|
|
* Header file for the Filesys API
|
|
*
|
|
* Copyright 1999 David G. Holm <dholm@jsd-llc.com>
|
|
* www - http://www.harbour-project.org
|
|
*
|
|
* This program is free software; you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation; either version 2, or (at your option)
|
|
* any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with this software; see the file COPYING. If not, write to
|
|
* the Free Software Foundation, Inc., 59 Temple Place, Suite 330,
|
|
* Boston, MA 02111-1307 USA (or visit the web site http://www.gnu.org/).
|
|
*
|
|
* As a special exception, the Harbour Project gives permission for
|
|
* additional uses of the text contained in its release of Harbour.
|
|
*
|
|
* The exception is that, if you link the Harbour libraries with other
|
|
* files to produce an executable, this does not by itself cause the
|
|
* resulting executable to be covered by the GNU General Public License.
|
|
* Your use of that executable is in no way restricted on account of
|
|
* linking the Harbour library code into it.
|
|
*
|
|
* This exception does not however invalidate any other reasons why
|
|
* the executable file might be covered by the GNU General Public License.
|
|
*
|
|
* This exception applies only to the code released by the Harbour
|
|
* Project under the name Harbour. If you copy code from other
|
|
* Harbour Project or Free Software Foundation releases into a copy of
|
|
* Harbour, as the General Public License permits, the exception does
|
|
* not apply to the code that you add in this way. To avoid misleading
|
|
* anyone as to the status of such modified files, you must delete
|
|
* this exception notice from them.
|
|
*
|
|
* If you write modifications of your own for Harbour, it is your choice
|
|
* whether to permit this exception to apply to your modifications.
|
|
* If you do not wish that, delete this exception notice.
|
|
*
|
|
*/
|
|
|
|
#ifndef HB_APIFS_H_
|
|
#define HB_APIFS_H_
|
|
|
|
#include "hbapi.h"
|
|
#include "fileio.ch"
|
|
|
|
HB_EXTERN_BEGIN
|
|
|
|
#define FS_ERROR F_ERROR
|
|
|
|
/* File locking flags */
|
|
#define FL_LOCK 0x0000 /* Lock a region */
|
|
#define FL_UNLOCK 0x0001 /* Unlock a region */
|
|
#define FL_MASK 0x00FF /* Mask for lock type */
|
|
|
|
/* Extended file locking flags */
|
|
#define FLX_EXCLUSIVE 0x0000 /* Exclusive lock */
|
|
#define FLX_SHARED 0x0100 /* Shared lock */
|
|
#define FLX_WAIT 0x0200 /* Wait for lock until success */
|
|
|
|
/* File inheritance flags */
|
|
#define FO_INHERITED 0x0000 /* Spawned processes can inherit this file handle */
|
|
#define FO_PRIVATE 0x0080 /* Spawned processes can not inherit this file handle */
|
|
|
|
/* Extended file open mode flags */
|
|
#define FXO_TRUNCATE 0x0100 /* Create (truncate if exists) */
|
|
#define FXO_APPEND 0x0200 /* Create (append if exists) */
|
|
#define FXO_UNIQUE 0x0400 /* Create unique file FO_EXCL ??? */
|
|
#define FXO_FORCEEXT 0x0800 /* Force default extension */
|
|
#define FXO_DEFAULTS 0x1000 /* Use SET command defaults */
|
|
#define FXO_DEVICERAW 0x2000 /* Open devices in raw mode */
|
|
/* xHarbour extension */
|
|
#define FXO_SHARELOCK 0x4000 /* emulate DOS SH_DENY* mode in POSIX OS */
|
|
#define FXO_COPYNAME 0x8000 /* copy final szPath into pFilename */
|
|
|
|
/* File attributes flags */
|
|
#define HB_FA_ALL 0
|
|
#define HB_FA_READONLY 1
|
|
#define HB_FA_HIDDEN 2
|
|
#define HB_FA_SYSTEM 4
|
|
#define HB_FA_LABEL 8
|
|
#define HB_FA_DIRECTORY 16
|
|
#define HB_FA_ARCHIVE 32
|
|
#define HB_FA_DEVICE 64
|
|
#define HB_FA_NORMAL 128
|
|
#define HB_FA_TEMPORARY 256
|
|
#define HB_FA_SPARSE 512
|
|
#define HB_FA_REPARSE 1024
|
|
#define HB_FA_COMPRESSED 2048
|
|
#define HB_FA_OFFLINE 4096
|
|
#define HB_FA_NOTINDEXED 8192
|
|
#define HB_FA_ENCRYPTED 16384
|
|
#define HB_FA_VOLCOMP 32768 /* volume supports compression. */
|
|
|
|
|
|
extern HB_EXPORT BOOL hb_fsChDir ( BYTE * pszDirName ); /* change working directory */
|
|
extern HB_EXPORT USHORT hb_fsChDrv ( BYTE nDrive ); /* change working drive */
|
|
extern HB_EXPORT void hb_fsClose ( FHANDLE hFileHandle ); /* close a file */
|
|
extern HB_EXPORT void hb_fsCommit ( FHANDLE hFileHandle ); /* commit updates of a file */
|
|
extern HB_EXPORT FHANDLE hb_fsCreate ( BYTE * pszFileName, USHORT uiAttr ); /* create a file */
|
|
extern HB_EXPORT FHANDLE hb_fsCreateEx ( BYTE * pszFilename, USHORT uiAttr, USHORT uiFlags ); /* create a file, with specific open mode */
|
|
extern HB_EXPORT FHANDLE hb_fsCreateTemp ( const BYTE * pszDir, const BYTE * pszPrefix, USHORT uiAttr, BYTE * pszName ); /* create a temporary file from components */
|
|
extern HB_EXPORT BYTE * hb_fsCurDir ( USHORT uiDrive ); /* retrieve a static pointer containing current directory for specified drive */
|
|
extern HB_EXPORT USHORT hb_fsCurDirBuff ( USHORT uiDrive, BYTE * pbyBuffer, ULONG ulLen ); /* copy current directory for given drive into a buffer */
|
|
extern HB_EXPORT BYTE hb_fsCurDrv ( void ); /* retrieve current drive number */
|
|
extern HB_EXPORT BOOL hb_fsDelete ( BYTE * pszFileName ); /* delete a file */
|
|
extern HB_EXPORT BOOL hb_fsEof ( FHANDLE hFileHandle ); /* determine if an open file is position at end-of-file */
|
|
extern HB_EXPORT USHORT hb_fsError ( void ); /* retrieve file system error */
|
|
extern HB_EXPORT USHORT hb_fsOsError ( void ); /* retrieve system dependant file system error */
|
|
extern HB_EXPORT BOOL hb_fsFile ( BYTE * pszFileName ); /* determine if a file exists */
|
|
extern HB_EXPORT BOOL hb_fsIsDirectory( BYTE * pFilename );
|
|
extern HB_EXPORT HB_FOFFSET hb_fsFSize ( BYTE * pszFileName, BOOL bUseDirEntry ); /* determine the size of a file */
|
|
extern HB_EXPORT FHANDLE hb_fsExtOpen ( BYTE * pszFileName, BYTE * pDefExt,
|
|
USHORT uiFlags, BYTE * pPaths, PHB_ITEM pError ); /* open a file using default extension and a list of paths */
|
|
extern HB_EXPORT USHORT hb_fsIsDrv ( BYTE nDrive ); /* determine if a drive number is a valid drive */
|
|
extern HB_EXPORT BOOL hb_fsIsDevice ( FHANDLE hFileHandle ); /* determine if a file is attached to a device (console?) */
|
|
extern HB_EXPORT BOOL hb_fsLock ( FHANDLE hFileHandle, ULONG ulStart, ULONG ulLength, USHORT uiMode ); /* request a lock on a portion of a file */
|
|
extern HB_EXPORT BOOL hb_fsLockLarge ( FHANDLE hFileHandle, HB_FOFFSET ulStart,
|
|
HB_FOFFSET ulLength, USHORT uiMode ); /* request a lock on a portion of a file using 64bit API */
|
|
extern HB_EXPORT BOOL hb_fsMkDir ( BYTE * pszDirName ); /* create a directory */
|
|
extern HB_EXPORT FHANDLE hb_fsOpen ( BYTE * pszFileName, USHORT uiFlags ); /* open a file */
|
|
extern HB_EXPORT USHORT hb_fsRead ( FHANDLE hFileHandle, BYTE * pBuff, USHORT ulCount ); /* read contents of a file into a buffer (<=64K) */
|
|
extern HB_EXPORT ULONG hb_fsReadLarge ( FHANDLE hFileHandle, BYTE * pBuff, ULONG ulCount ); /* read contents of a file into a buffer (>64K) */
|
|
extern HB_EXPORT BOOL hb_fsRmDir ( BYTE * pszDirName ); /* remove a directory */
|
|
extern HB_EXPORT BOOL hb_fsRename ( BYTE * pszOldName, BYTE * pszNewName ); /* rename a file */
|
|
extern HB_EXPORT ULONG hb_fsSeek ( FHANDLE hFileHandle, LONG lOffset, USHORT uiMode ); /* reposition an open file */
|
|
extern HB_EXPORT HB_FOFFSET hb_fsSeekLarge( FHANDLE hFileHandle, HB_FOFFSET llOffset, USHORT uiFlags ); /* reposition an open file using 64bit API */
|
|
extern HB_EXPORT ULONG hb_fsTell ( FHANDLE hFileHandle ); /* retrieve the current position of a file */
|
|
extern HB_EXPORT BOOL hb_fsSetDevMode ( FHANDLE hFileHandle, USHORT uiDevMode ); /* change the device mode of a file (text/binary) */
|
|
extern HB_EXPORT void hb_fsSetError ( USHORT uiError ); /* set the file system DOS error number */
|
|
extern HB_EXPORT void hb_fsSetIOError ( BOOL fResult, USHORT uiOperation ); /* set the file system error number after IO operation */
|
|
extern HB_EXPORT USHORT hb_fsWrite ( FHANDLE hFileHandle, const BYTE * pBuff, USHORT ulCount ); /* write to an open file from a buffer (<=64K) */
|
|
extern HB_EXPORT ULONG hb_fsWriteLarge ( FHANDLE hFileHandle, const BYTE * pBuff, ULONG ulCount ); /* write to an open file from a buffer (>64K) */
|
|
extern HB_EXPORT FHANDLE hb_fsPOpen ( BYTE * pFilename, BYTE * pMode );
|
|
extern HB_EXPORT FHANDLE hb_fsGetOsHandle( FHANDLE hFileHandle );
|
|
extern HB_EXPORT USHORT hb_fsGetFError ( void ); /* get FERROR() flag */
|
|
extern HB_EXPORT void hb_fsSetFError ( USHORT uiError ); /* set FERROR() flag */
|
|
extern HB_EXPORT BOOL hb_fsFileExists ( const char * pszFileName ); /* check if a file exists (wildcard chars not accepted). */
|
|
extern HB_EXPORT BOOL hb_fsDirExists ( const char * pszDirName ); /* check if a directory exists (wildcard chars not accepted). */
|
|
|
|
#define hb_fsFLock( h, s, l ) hb_fsLock( h, s, l, FL_LOCK )
|
|
#define hb_fsFUnlock( h, s, l ) hb_fsLock( h, s, l, FL_UNLOCK )
|
|
|
|
#if defined( OS_UNIX_COMPATIBLE ) && !defined( HB_USE_SHARELOCKS_OFF )
|
|
# define HB_USE_SHARELOCKS
|
|
# define HB_SHARELOCK_POS 0x7fffffffUL
|
|
# define HB_SHARELOCK_SIZE 0x1UL
|
|
# if defined( HB_USE_BSDLOCKS_OFF )
|
|
# undef HB_USE_BSDLOCKS
|
|
# elif defined( HB_OS_LINUX ) && \
|
|
!defined( __WATCOMC__ ) && !defined( HB_USE_BSDLOCKS )
|
|
/* default usage of BSD locks in *BSD systems for emulating
|
|
* DOS/Windows DENY_* flags has been disabled because tests
|
|
* on FreeBSD 6.2 and MacOSX shows that this implementation
|
|
* can create self deadlock when used simultaneously with
|
|
* POSIX locks - thanks to Phil and Lorenzo for locating the
|
|
* problem and tests [druzus]
|
|
*/
|
|
# define HB_USE_BSDLOCKS
|
|
# endif
|
|
#endif
|
|
|
|
#define HB_MAX_DRIVE_LENGTH 10
|
|
#define HB_MAX_FILE_EXT 10
|
|
|
|
/* Filename support */
|
|
typedef struct
|
|
{
|
|
char * szPath;
|
|
char * szName;
|
|
char * szExtension;
|
|
char * szDrive;
|
|
char szBuffer[ _POSIX_PATH_MAX + HB_MAX_DRIVE_LENGTH + 4 ];
|
|
} HB_FNAME, * PHB_FNAME, * HB_FNAME_PTR;
|
|
|
|
extern HB_EXPORT PHB_FNAME hb_fsFNameSplit( const char * pszFileName ); /* Split given filename into path, name and extension */
|
|
extern HB_EXPORT char * hb_fsFNameMerge( char * pszFileName, PHB_FNAME pFileName ); /* This function joins path, name and extension into a string with a filename */
|
|
|
|
/* Searchable path support */
|
|
typedef struct _HB_PATHNAMES
|
|
{
|
|
char * szPath;
|
|
struct _HB_PATHNAMES * pNext;
|
|
BOOL fFree;
|
|
} HB_PATHNAMES;
|
|
|
|
extern HB_EXPORT void hb_fsAddSearchPath( const char * szPath, HB_PATHNAMES ** pSearchList );
|
|
extern HB_EXPORT void hb_fsFreeSearchPath( HB_PATHNAMES * pSearchList );
|
|
|
|
extern HB_EXPORT BOOL hb_spFile( BYTE * pFilename, BYTE * pRetPath );
|
|
extern HB_EXPORT FHANDLE hb_spOpen( BYTE * pFilename, USHORT uiFlags );
|
|
extern HB_EXPORT FHANDLE hb_spCreate( BYTE * pFilename, USHORT uiAttr );
|
|
extern HB_EXPORT FHANDLE hb_spCreateEx( BYTE * pFilename, USHORT uiAttr, USHORT uiFlags );
|
|
|
|
/* File Find API structure */
|
|
typedef struct
|
|
{
|
|
char szName[ _POSIX_PATH_MAX + 1 ];
|
|
LONG lDate;
|
|
char szDate[ 9 ]; /* in YYYYMMDD format */
|
|
char szTime[ 9 ]; /* in HH:MM:SS format */
|
|
USHORT attr;
|
|
HB_FOFFSET size;
|
|
|
|
/* Private */
|
|
|
|
const char * pszFileMask;
|
|
USHORT attrmask;
|
|
BOOL bFirst;
|
|
|
|
void * info; /* Pointer to the platform specific find info */
|
|
|
|
} HB_FFIND, * PHB_FFIND;
|
|
|
|
/* File Find API functions */
|
|
extern HB_EXPORT PHB_FFIND hb_fsFindFirst( const char * pszFileName, USHORT uiAttr );
|
|
extern HB_EXPORT BOOL hb_fsFindNext( PHB_FFIND ffind );
|
|
extern HB_EXPORT void hb_fsFindClose( PHB_FFIND ffind );
|
|
|
|
/* Misc helper functions */
|
|
extern USHORT hb_fsAttrFromRaw( ULONG raw_attr );
|
|
extern ULONG hb_fsAttrToRaw( USHORT uiAttr );
|
|
extern USHORT hb_fsAttrEncode( const char * szAttr );
|
|
extern char * hb_fsAttrDecode( USHORT uiAttr, char * szAttr );
|
|
extern HB_EXPORT BYTE * hb_fsNameConv( BYTE * szFileName, BOOL * pfFree );
|
|
extern HB_EXPORT BYTE * hb_fileNameConv( char *str );
|
|
extern HB_EXPORT BOOL hb_fsMaxFilesError( void );
|
|
|
|
/* wrapper to fopen() which calls hb_fsNameConv() */
|
|
extern FILE * hb_fopen( const char *path, const char *mode );
|
|
|
|
HB_EXTERN_END
|
|
|
|
#endif /* HB_APIFS_H_ */
|