filemgr.h

Go to the documentation of this file.

/******************************************************************************
 *
 * filemgr.h -  class FileMgr: encapsulates all file IO and
 *      platform-specific eccentricities.
 *
 * $Id: filemgr.h 3812 2020-10-15 17:32:41Z scribe $
 *
 * Copyright 1998-2013 CrossWire Bible Society (http://www.crosswire.org)
 *  CrossWire Bible Society
 *  P. O. Box 2528
 *  Tempe, AZ  85280-2528
 *
 * 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 version 2.
 *
 * 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.
 *
 */

#ifndef FILEMGR_H
#define FILEMGR_H

#include <sys/stat.h>
#include <fcntl.h>

#include <defs.h>
#include <swcacher.h>
#include <swbuf.h>
#include <vector>

SWORD_NAMESPACE_START

class SWDLLEXPORT FileDesc;

struct SWDLLEXPORT DirEntry {
public:
    SWBuf name;
    unsigned long size;
    bool isDirectory;
};

class SWDLLEXPORT FileMgr : public SWCacher {

    friend class FileDesc;
    friend class __staticsystemFileMgr;

    FileDesc *files;
    int sysOpen(FileDesc * file);
protected:
    static FileMgr *systemFileMgr;
public:
    static unsigned int CREAT;
    static unsigned int APPEND;
    static unsigned int TRUNC;
    static unsigned int RDONLY;
    static unsigned int RDWR;
    static unsigned int WRONLY;
    static unsigned int IREAD;
    static unsigned int IWRITE;

    int maxFiles;

    static FileMgr *getSystemFileMgr();
    static void setSystemFileMgr(FileMgr *newFileMgr);

    FileMgr(int maxFiles = 35);

    ~FileMgr();

    FileDesc *open(const char *path, int mode, bool tryDowngrade);
    FileDesc *open(const char *path, unsigned int mode, bool tryDowngrade) { return this->open(path, (int)mode, tryDowngrade); }

    FileDesc *open(const char *path, unsigned int mode, unsigned int perms = IREAD | IWRITE, bool tryDowngrade = false) { return this->open(path, (int)mode, (int)perms, tryDowngrade); }
    FileDesc *open(const char *path, int mode, int perms = IREAD | IWRITE, bool tryDowngrade = false);

    void close(FileDesc *file);

    virtual void flush();
    virtual long resourceConsumption();

    static SWBuf getEnvValue(const char *variableName);

    static bool hasAccess(const char *path, int mode);

    static signed char existsFile(const char *ipath, const char *ifileName = 0);

    static signed char existsDir(const char *ipath, const char *idirName = 0);

    static std::vector<struct DirEntry> getDirList(const char *dirPath, bool includeSize = false, bool includeIsDirectory = true);


    signed char trunc(FileDesc *file);

    static char isDirectory(const char *path);
    static long getFileSize(const char *path);
    static int createParent(const char *pName);
    static int createPathAndFile(const char *fName);

    static int openFile(const char *fName, int mode, int perms);
    static int openFileReadOnly(const char *fName);
    static void closeFile(int fd);
    static long write(int fd, const void *buf, long count);

    static int copyFile(const char *srcFile, const char *destFile);
    static int copyDir(const char *srcDir, const char *destDir);
    static int removeDir(const char *targetDir);
    static int removeFile(const char *fName);
    static char getLine(FileDesc *fDesc, SWBuf &line);

    SWBuf getHomeDir();

};

class SWDLLEXPORT FileDesc {

    friend class FileMgr;

    long offset;
    int fd;         // -77 closed;
    FileMgr *parent;
    FileDesc *next;

    FileDesc(FileMgr * parent, const char *path, int mode, int perms, bool tryDowngrade);
    virtual ~FileDesc();

public:
    inline int getFd() {
        if (fd == -77)
            fd = parent->sysOpen(this);
//      if ((fd < -1) && (fd != -77))  // kludge to handle ce
//          return 777;
        return fd;
    }

    long seek(long offset, int whence);
    long read(void *buf, long count);
    long write(const void *buf, long count);

    char *path;
    int mode;
    int perms;
    bool tryDowngrade;
};


SWORD_NAMESPACE_END
#endif