5a2a287752
* *
* partial sync with the 3.4 fork codebase. These are the things
synces for the most part:
- copyright headers
- grammar/typos in comments and some readmes
- comment/whitespace/decorations
- variable scoping in C files
- DO CASE/SWITCH and some other alternate syntax usage
- minimal amount of human readable text in strings
- minor code updates
- HB_TRACE() void * casts for pointers and few other changes to
avoid C compiler warnings
- various other, minor code cleanups
- only Harbour/C code/headers were touched in src, utils, contrib,
include. No 3rd party code, no make files, and with just a few
exceptions, no 'tests' code was touched.
- certain components were not touched were 3.4 diverged too much
already, like f.e. hbmk2, hbssl, hbcurl, hbexpat
- the goal was that no actual program logic should be altered by
these changes. Except some possible minor exceptions, any such
change is probably a bug in this patch.
It's a massive patch, if you find anything broken after it, please
open an Issue with the details. Build test was done on macOS.
The goal is make it easier to see what actual code/logic was changed
in 3.4 compared to 3.2 and to make patches easier to apply in both
ways.
158 lines
7.0 KiB
Plaintext
158 lines
7.0 KiB
Plaintext
/*
|
|
* Header file for file management functions
|
|
*
|
|
* Copyright 1999 David G. Holm <dholm@jsd-llc.com>
|
|
*
|
|
* 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 program; see the file LICENSE.txt. If not, write to
|
|
* the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
|
|
* Boston, MA 02110-1301 USA (or visit https://www.gnu.org/licenses/).
|
|
*
|
|
* 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.
|
|
*
|
|
*/
|
|
|
|
/* NOTE: This file is also used by C code. */
|
|
|
|
#ifndef _FILEIO_CH
|
|
#define _FILEIO_CH
|
|
|
|
/* File create flags */
|
|
#define FC_NORMAL 0 /* No file attributes are set */
|
|
#define FC_READONLY 1 /* Read-only file attribute is set */
|
|
#define FC_HIDDEN 2 /* Hidden file attribute is set */
|
|
#define FC_SYSTEM 4 /* System file attribute is set */
|
|
|
|
/* File attributes flags */
|
|
#define HB_FA_ALL 0x00000000
|
|
|
|
#define HB_FA_READONLY 0x00000001 /* R */
|
|
#define HB_FA_HIDDEN 0x00000002 /* H */
|
|
#define HB_FA_SYSTEM 0x00000004 /* S */
|
|
#define HB_FA_LABEL 0x00000008 /* V */
|
|
#define HB_FA_DIRECTORY 0x00000010 /* D | S_ISDIR() */
|
|
#define HB_FA_ARCHIVE 0x00000020 /* A | S_ISREG() */
|
|
#define HB_FA_DEVICE 0x00000040 /* I | S_ISBLK() */
|
|
#define HB_FA_NORMAL 0x00000080 /* */
|
|
|
|
#define HB_FA_ANY ( HB_FA_READONLY + HB_FA_HIDDEN + HB_FA_SYSTEM + HB_FA_DIRECTORY + HB_FA_ARCHIVE )
|
|
|
|
#define HB_FA_TEMPORARY 0x00000100 /* T | S_ISFIFO()??? */
|
|
#define HB_FA_SPARSE 0x00000200 /* P | S_ISSOCK()??? */
|
|
#define HB_FA_REPARSE 0x00000400 /* L | S_ISLNK() */
|
|
#define HB_FA_COMPRESSED 0x00000800 /* C | S_ISCHR()??? */
|
|
#define HB_FA_OFFLINE 0x00001000 /* O */
|
|
#define HB_FA_NOTINDEXED 0x00002000 /* X */
|
|
#define HB_FA_ENCRYPTED 0x00004000 /* E */
|
|
#define HB_FA_VOLCOMP 0x00008000 /* M volume supports compression. */
|
|
|
|
/* POSIX file permission */
|
|
#define HB_FA_SUID 0x08000000 /* 4000 set user ID on execution */
|
|
#define HB_FA_SGID 0x04000000 /* 2000 set group ID on execution */
|
|
#define HB_FA_SVTX 0x02000000 /* 1000 sticky bit */
|
|
#define HB_FA_RUSR 0x01000000 /* 0400 read by owner */
|
|
#define HB_FA_WUSR 0x00800000 /* 0200 write by owner */
|
|
#define HB_FA_XUSR 0x00400000 /* 0100 execute/search by owner */
|
|
#define HB_FA_RGRP 0x00200000 /* 0040 read by group */
|
|
#define HB_FA_WGRP 0x00100000 /* 0020 write by group */
|
|
#define HB_FA_XGRP 0x00080000 /* 0010 execute/search by group */
|
|
#define HB_FA_ROTH 0x00040000 /* 0004 read by others */
|
|
#define HB_FA_WOTH 0x00020000 /* 0002 write by others */
|
|
#define HB_FA_XOTH 0x00010000 /* 0001 execute/search by others */
|
|
|
|
/* File access flags */
|
|
#define FO_READ 0 /* File is opened for reading */
|
|
#define FO_WRITE 1 /* File is opened for writing */
|
|
#define FO_READWRITE 2 /* File is opened for reading and writing */
|
|
|
|
/* File open flags */
|
|
#define HB_FO_CREAT 0x0100 /* create and open file */
|
|
#define HB_FO_TRUNC 0x0200 /* open with truncation */
|
|
#define HB_FO_EXCL 0x0400 /* create and open only if file doesn't exist */
|
|
#define HB_FO_DEFAULTS 0x1000 /* Use SET command defaults */
|
|
|
|
/* Constants breaking Cl*pper namespace.
|
|
Leaving it here for compatibility */
|
|
#define FO_CREAT HB_FO_CREAT /* Harbour extension */
|
|
#define FO_TRUNC HB_FO_TRUNC /* Harbour extension */
|
|
#define FO_EXCL HB_FO_EXCL /* Harbour extension */
|
|
#define FO_DEFAULTS HB_FO_DEFAULTS /* Use SET command defaults */
|
|
|
|
/* File sharing flags */
|
|
#define FO_COMPAT 0 /* No sharing specified */
|
|
#define FO_EXCLUSIVE 16 /* Deny further attempts to open the file */
|
|
#define FO_DENYWRITE 32 /* Deny further attempts to open the file for writing */
|
|
#define FO_DENYREAD 48 /* Deny further attempts to open the file for reading */
|
|
#define FO_DENYNONE 64 /* Do not deny any further attempts to open the file */
|
|
#define FO_SHARED FO_DENYNONE
|
|
|
|
/* File seek mode flags */
|
|
#define FS_SET 0 /* Seek from beginning of file */
|
|
#define FS_RELATIVE 1 /* Seek from current file pointer */
|
|
#define FS_END 2 /* Seek from end of file */
|
|
|
|
/* File mode flags */
|
|
#define FD_BINARY 1 /* Binary mode (raw) */
|
|
#define FD_RAW FD_BINARY
|
|
#define FD_TEXT 2 /* Text mode (cooked) */
|
|
#define FD_COOKED FD_TEXT
|
|
#define FD_ASCII FD_TEXT
|
|
|
|
/* File system error codes */
|
|
#define F_ERROR ( -1 ) /* Unspecified error */
|
|
|
|
/* hb_FLock() extended file locking flags */
|
|
#define HB_FLX_EXCLUSIVE 0x0000 /* Exclusive lock */
|
|
#define HB_FLX_SHARED 0x0100 /* Shared lock */
|
|
#define HB_FLX_NO_WAIT 0x0000 /* Do not wait for successful lock */
|
|
#define HB_FLX_WAIT 0x0200 /* Wait for lock until success */
|
|
|
|
/* hb_DiskSpace() types */
|
|
#define HB_DISK_AVAIL 0
|
|
#define HB_DISK_FREE 1
|
|
#define HB_DISK_USED 2
|
|
#define HB_DISK_TOTAL 3
|
|
|
|
/* hb_vfConfig() settings */
|
|
#define HB_VF_TIMEOUT 1
|
|
#define HB_VF_PORT 2
|
|
#define HB_VF_EOF 3
|
|
#define HB_VF_SHUTDOWN 4
|
|
#define HB_VF_RDHANDLE 5
|
|
#define HB_VF_WRHANDLE 6
|
|
#define HB_VF_IONAME 7
|
|
|
|
#endif /* _FILEIO_CH */
|