file_io.h

Go to the documentation of this file.

/* SPDX-License-Identifier: MIT */
#ifndef AJA_FILE_IO_H
#define AJA_FILE_IO_H
 
#include "ajabase/common/types.h"
#include "ajabase/common/public.h"
#include "ajabase/system/system.h"
#include <vector>
#include <string>
 
#if defined(AJA_WINDOWS)
    const char AJA_PATHSEP = '\\';
    const wchar_t AJA_PATHSEP_WIDE = L'\\';
#else
    const char AJA_PATHSEP = '/';
    const wchar_t AJA_PATHSEP_WIDE = L'/';
#endif
 
typedef enum
{
    eAJACreateAlways     = 1,
    eAJACreateNew        = 2,
    eAJATruncateExisting = 4,
 
    eAJAReadOnly         = 8,
    eAJAWriteOnly        = 16,
    eAJAReadWrite        = 32
} AJAFileCreationFlags;
 
 
typedef enum
{
    eAJABuffered         = 1,
    eAJAUnbuffered       = 2,
    eAJANoCaching        = 4
} AJAFileProperties;
 
 
typedef enum
{
    eAJASeekSet,
    eAJASeekCurrent,
    eAJASeekEnd
} AJAFileSetFlag;
    
    
typedef enum
{
    eAJAIoDefault,
    eAJAIoAlternate
} AJAIOModel;
 
 
class  AJA_EXPORT AJAFileIO
{
public:
    AJAFileIO();
    ~AJAFileIO();
 
    AJAStatus Open(
                const std::string &     fileName,
                const int               flags,
                const int               properties);
 
    AJAStatus Open(
                const std::wstring &    fileName,
                const int               flags,
                const int               properties);
 
    AJAStatus Close();
 
    bool IsOpen();
 
    uint32_t Read(uint8_t* pBuffer, const uint32_t length);
 
    uint32_t Read(std::string& buffer, const uint32_t length);
    
    uint32_t Write(const uint8_t* pBuffer, const uint32_t length) const;
 
    uint32_t Write(const std::string& buffer) const;
 
    AJAStatus Sync();
 
    AJAStatus Truncate(int32_t offset);
 
    int64_t Tell();
 
    AJAStatus Seek(const int64_t distance, const AJAFileSetFlag flag) const;
 
    AJAStatus FileInfo(int64_t& createTime, int64_t& modTime, int64_t& size);
    AJAStatus FileInfo(int64_t& createTime, int64_t& modTime, int64_t& size, std::string& filePath);
 
    static bool FileExists(const std::wstring& fileName);
    static bool FileExists(const std::string& fileName);
 
    static AJAStatus Delete(const std::string& fileName);
    static AJAStatus Delete(const std::wstring& fileName);
 
    static AJAStatus ReadDirectory(
                const std::string&   directory,
                const std::string&   filePattern,
                std::vector<std::string>& fileContainer);
 
    static AJAStatus ReadDirectory(
                const std::wstring&   directory,
                const std::wstring&   filePattern,
                std::vector<std::wstring>& fileContainer);
 
    static AJAStatus DoesDirectoryContain(
                const std::string& directory,
                const std::string& filePattern);
 
    static AJAStatus DoesDirectoryContain(
                const std::wstring& directory,
                const std::wstring& filePattern);
 
    static AJAStatus DoesDirectoryExist(const std::string& directory);
    static AJAStatus DoesDirectoryExist(const std::wstring& directory);
 
    static bool DirectoryExists(const std::string& directory);
    static bool DirectoryExists(const std::wstring& directory);
 
    static AJAStatus IsDirectoryEmpty(const std::string& directory);
    static AJAStatus IsDirectoryEmpty(const std::wstring& directory);
 
    static AJAStatus TempDirectory(std::string& directory);     //  New in SDK 16.0
    static AJAStatus TempDirectory(std::wstring& directory);    //  New in SDK 16.0
 
    static AJAStatus GetWorkingDirectory(std::string& directory);   //  New in SDK 16.0
    static AJAStatus GetWorkingDirectory(std::wstring& directory);  //  New in SDK 16.0
 
    static AJAStatus GetDirectoryName(const std::string& path, std::string& directory);     //  New in SDK 16.0
    static AJAStatus GetDirectoryName(const std::wstring& path, std::wstring& directory);   //  New in SDK 16.0
 
    static AJAStatus GetFileName(const std::string& path, std::string& filename);   //  New in SDK 16.0
    static AJAStatus GetFileName(const std::wstring& path, std::wstring& filename); //  New in SDK 16.0
 
    static AJAStatus GetExecutablePath(std::string& path); // New in SDK 16.2
    static AJAStatus GetExecutablePath(std::wstring& path); // New in SDK 16.2
 
    void    SetHandle(FILE *fp);
 
#if defined(AJA_WINDOWS)
    void     *GetHandle(void) {return mFileDescriptor;}
#else
    void     *GetHandle(void) {return mpFile;}
#endif
 
private:
 
#if defined(AJA_WINDOWS)
    HANDLE      mFileDescriptor;
#else
    FILE*       mpFile;
#endif
    AJAIOModel  mIoModel;
};
 
#endif // AJA_FILE_IO_H