fsystem.h

Go to the documentation of this file.

//& *** (c) 2006-2011 The HPGCC3 Team ***
//& Claudio Lapilli
//& Ingo Blank
//&
//& This file is licensed under the terms and conditions of the
//& HPGCC3 license that is included with the source distribution.
//& *** (c) 2006-2011 The HPGCC3 Team ***

// $Header: fsystem.h,r42 2006-02-18 04:23:47 ingo $


#ifndef _FSYSTEM_H

#define _FSYSTEM_H

#ifndef _HPTIME_H
#include <time.h>
#endif
// FILE SYSTEM PUBLIC HEADER FILE
// CONSTANTS

// FILE ATTRIBUTES
#define FSATTR_RDONLY 1

#define FSATTR_HIDDEN 2

#define FSATTR_SYSTEM 4

#define FSATTR_VOLUME 8

#define FSATTR_DIR    16

#define FSATTR_ARCHIVE 32

#define FSATTR_LONGNAME 0xf

#define FSATTR_LONGMASK 0x3f


// OPEN MODES
#define FSMODE_READ      0    // READ PERMISSION (DEFAULT)

#define FSMODE_WRITE     2    // WRITE PERMISSION

#define FSMODE_APPEND    4    // ONLY ALLOW WRITING AFTER EOF

#define FSMODE_MODIFY    8    // WRITE TO ANY POSITION WITHIN FILE

#define FSMODE_NOGROW   16    // DON'T ALLOW FILE TO GROW

#define FSMODE_NOCREATE 32    // DON'T CREATE IF FILE DOESN'T EXIST



// ERRORS RETURNED BY USER-LEVEL FUNCTIONS
#define FS_OK             1

#define FS_ERROR      0             // UNKNOWN ERROR (OR FUNCTION DOESN'T CARE)

#define FS_EOF       -1                 // END OF FILE

#define FS_BADNAME   -2                 // INVALID FILE NAME

#define FS_BADVOLUME -3                 // INVALID DRIVE

#define FS_NOTFOUND  -4                 // FILE NOT FOUND

#define FS_CANTWRITE -5                 // WRITE FAILED

#define FS_NOCARD    -6                 // NO CARD INSERTED

#define FS_CHANGED   -7                 // CARD HAS CHANGED

#define FS_MAXFILES  -8                 // MAXIMUM NUMBER OF FILES OPEN WAS EXCEEDED

#define FS_OPENDIR   -9                 // NAME IS AN ALREADY OPEN DIRECTORY

#define FS_OPENFILE  -9                 // NAME IS AN ALREADY OPEN FILE

#define FS_USED      -9                 // FILE/DIRECTORY IS BEING USED

#define FS_DISKFULL  -10                // DISK IS FULL

#define FS_EXIST     -11                // FILE ALREADY EXISTS

#define FS_INVHANDLE -12                // HANDLE IS NOT VALID




// CASE SENSITIVITY MODES
#define FSCASE_SENS   0                 // CASE SENSITIVE (RAW NAMES)

#define FSCASE_SENSHP 1                 // CASE SENSITIVE (W/SEMICOLON STRIPPING)

#define FSCASE_INSENS 2                 // CASE INSENSITIVE

#define FSCASE_SENSHPTRUE 3             // CASE SENSITIVE W/SEMICOLONS BUT RETURNS TRUE NAMES

// FILENAME ANALYSIS RESULT FLAGS (FSGetNameType())
#define FSNAME_HASVOL    1              // 1 == Name include drive

#define FSNAME_HASPATH   2              // 2 == Name include path

#define FSNAME_ABSPATH   4              // 4 == Path is absolute

#define FSNAME_ENDSLASH  8              // 8 == name ends in slash

#define FSNAME_VOLHP    16              // 16== Drive is HP style (:x:)

#define FSNAME_EMPTY    32              // 32== Name is empty

#define FSNAME_INVALID  -1

// BITS 16-31 = DEPTH OF PATH (0=CURRENT DIR OR ROOT)
// NEGATIVE RESULT ==> INVALID FILENAME 


// CASE INSENSITIVITY MACRO
#define __ICASE(a) ( ((a>96)&&(a<123))? (a&0xdf):a)
#define __UPPER(a) ( ((a>96)&&(a<123))? (a&0xdf):a)
#define __LOWER(a) ( ((a>64)&&(a<91))? (a|0x20):a)


// TYPE DEFINITIONS

struct __frag;
typedef struct __frag FS_FRAGMENT;
struct __buffer;
typedef struct __buffer FS_BUFFER;
struct __file;
typedef struct __file FS_FILE;


struct __frag {
int StartAddr,EndAddr;
FS_FRAGMENT *NextFragment;
};

struct __buffer {
char *Data;
int Offset,Used;
};


// MAIN FILE STRUCTURE
struct __file {
char *Name;
unsigned Volume:8,
          Mode:8,
          Attr:8;
unsigned NTRes:8,
          CrtTmTenth:8,
                  LastAccDate:16;
unsigned int CreatTimeDate;
unsigned int WriteTimeDate;
int FirstCluster;
unsigned int FileSize;
unsigned int CurrentOffset;
int DirEntryOffset,
    DirEntryNum;
FS_FILE *Dir;
FS_FRAGMENT Chain;
FS_BUFFER RdBuffer,WrBuffer;
};



// INITIALIZATION FUNCTIONS

extern int FSShutdown();

extern int FSRestart();

extern void FSSleep();

extern void FSWakeUp();

// VOLUME FUNCTIONS

extern int FSVolumeMounted(int VolNumber);


extern int FSVolumeInserted(int VolNumber);

extern int FSSetCurrentVolume(int VolNumber);

extern int FSGetCurrentVolume();

extern int FSGetVolumeSize(int Volnumber);
extern int FSGetVolumeFree(int Volnumber);

// DIRECTORY ACCESS FUNCTIONS

extern int FSMkdir(char *name);

extern int FSRmdir(char *name);

extern int FSChdir(char *name);

extern char *FSGetcwd(int Volume);


extern int FSOpenDir(char *name,FS_FILE **fileptr);

extern int FSGetNextEntry(FS_FILE *entry,FS_FILE *dir);


extern void FSReleaseEntry(FS_FILE *file);

// FILE ACCESS FUNCTIONS
extern int FSCreate(char *name,int attr,FS_FILE **fileptr);
extern int FSOpen(char *name, int mode, FS_FILE **fileptr);
extern int FSClose(FS_FILE *file);

extern int FSCloseAndDelete(FS_FILE *file);

extern int FSSeek(FS_FILE *file,int Offset,int position);

extern int FSTell(FS_FILE *file);



extern int FSRead(char *buffer,int nbytes,FS_FILE *file);
extern int FSWrite(char *buffer,int nbytes,FS_FILE *file);
extern int FSEof(FS_FILE *file);
extern int FSDelete(char *name);
extern int FSRename(char *oldname,char *newname);


// NAME PROCESSING FUNCTIONS
extern int FSNameCompare(char *name1,char *name2,int caseflags);

extern char *FSGetFileName(FS_FILE *file,int pathflags);

extern int FSGetNameType(char *name);

extern void FSStripSemi(char *name);

extern char *FSGetErrorMsg(int errornum);

extern int FSChMode(FS_FILE *file,int newmode);

extern int FSChAttr(FS_FILE *file,int newattr);

extern int FSAttr(FS_FILE *file);

extern int FSFileLength(FS_FILE *file);

extern void FSSetCaseMode(int casemode);

extern void FSGetCreatTime(FS_FILE *file,struct tm *timedate);

extern void FSGetWriteTime(FS_FILE *file,struct tm *timedate);


extern void FSGetAccessDate(FS_FILE *file,struct tm *timedate);

extern int FSGetHandle(FS_FILE *file);

extern int FSGetFileFromHandle(int handle,FS_FILE **fileptr);


#endif