CStdFile Class Reference

#include <CStdFile.h>

Inheritance diagram for CStdFile:

Collaboration diagram for CStdFile:

Public Member Functions
	CStdFile ()
	~CStdFile () override
bool	Create (const char *szFileName, bool fCompressed=false, bool fExecutable=false, bool fMemory=false)
bool	Open (const char *szFileName, bool fCompressed=false)
bool	Append (const char *szFilename, bool text=false)
bool	Close (StdBuf **ppMemory=nullptr)
bool	Default ()
bool	Read (void *pBuffer, size_t iSize) override
bool	Read (void *pBuffer, size_t iSize, size_t *ipFSize)
bool	Write (const void *pBuffer, int iSize)
bool	WriteString (const char *szStr)
bool	Rewind ()
bool	Advance (int iOffset) override
int	Seek (long int offset, int whence)
long int	Tell ()
bool	IsOpen () const
bool	Flush ()
size_t	AccessedEntrySize () const override

Public Attributes
bool	Status
char	Name [_MAX_PATH_LEN]

Protected Member Functions
void	ClearBuffer ()
int	LoadBuffer ()
bool	SaveBuffer ()

Protected Attributes
FILE *	hFile
gzFile	hgzFile
StdBuf *	pMemory
int	MemoryPtr
BYTE	Buffer [CStdFileBufSize]
int	BufferLoad
int	BufferPtr
bool	ModeWrite
StdThreadCheck	thread_check

Detailed Description

Definition at line 38 of file CStdFile.h.

Constructor & Destructor Documentation

CStdFile()

CStdFile::CStdFile

(

)

Definition at line 32 of file CStdFile.cpp.

{
    thread_check.Set();
    Status=false;
    hFile=nullptr;
    hgzFile=nullptr;
    pMemory=nullptr;
    ClearBuffer();
    ModeWrite=false;
    Name[0]=0;
}

References ClearBuffer(), hFile, hgzFile, ModeWrite, Name, pMemory, StdThreadCheck::Set(), Status, and thread_check.

Here is the call graph for this function:

~CStdFile()

CStdFile::~CStdFile ( )

override

Definition at line 44 of file CStdFile.cpp.

{
    Close();
}

References Close().

Here is the call graph for this function:

Member Function Documentation

AccessedEntrySize()

size_t CStdFile::AccessedEntrySize ( ) const

overridevirtual

Implements CStdStream.

Definition at line 347 of file CStdFile.cpp.

{
    if (hFile)
        return FileSize(fileno(hFile));
    assert(!hgzFile);
    return 0;
}

References FileSize(), hFile, and hgzFile.

Here is the call graph for this function:

Advance()

bool CStdFile::Advance ( int  iOffset )

overridevirtual

Implements CStdStream.

Definition at line 285 of file CStdFile.cpp.

{
    thread_check.Check();
    if (ModeWrite) return false;
    while (iOffset > 0)
    {
        // Valid data in the buffer: Transfer as much as possible
        if (BufferLoad > BufferPtr)
        {
            int transfer = std::min(BufferLoad-BufferPtr,iOffset);
            BufferPtr += transfer;
            iOffset -= transfer;
        }
        // Buffer empty: Load or skip
        else
        {
            if (hFile) return !fseek(hFile, iOffset, SEEK_CUR); // uncompressed: Just skip
            if (LoadBuffer()<=0) return false; // compressed: Read...
        }
    }
    return true;
}

References BufferLoad, BufferPtr, StdThreadCheck::Check(), hFile, LoadBuffer(), ModeWrite, and thread_check.

Here is the call graph for this function:

Append()

bool CStdFile::Append	(	const char *	szFilename,
		bool	text = false
	)

Definition at line 132 of file CStdFile.cpp.

{
    SCopy(szFilename,Name,_MAX_PATH);
    thread_check.Set();
    // Set modes
    ModeWrite=true;
    // Open standard file
#ifdef _WIN32
    if (!(hFile = _wfopen(GetWideChar(Name), text ? L"at" : L"ab"))) return false;
#else
    if (!(hFile=fopen(Name,text ? "at" : "ab"))) return false;
#endif
    // Reset buffer
    ClearBuffer();
    // Set status
    Status=true;
    return true;
}

References _MAX_PATH, ClearBuffer(), GetWideChar(), hFile, ModeWrite, Name, SCopy(), StdThreadCheck::Set(), Status, C4ScriptGuiWindowPropertyName::text, and thread_check.

Referenced by C4TableGraph::DumpToFile(), and C4MessageInput::ProcessCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

ClearBuffer()

void CStdFile::ClearBuffer ( )

protected

Definition at line 234 of file CStdFile.cpp.

{
    thread_check.Check();
    BufferLoad=BufferPtr=0;
}

References BufferLoad, BufferPtr, StdThreadCheck::Check(), and thread_check.

Referenced by Append(), Create(), CStdFile(), Open(), and Rewind().

Here is the call graph for this function:

Here is the caller graph for this function:

Close()

bool CStdFile::Close

(

StdBuf **

ppMemory = nullptr

)

Definition at line 151 of file CStdFile.cpp.

{
    thread_check.Check();
    bool rval=true;
    Status=false;
    Name[0]=0;
    // Save buffer if in write mode
    if (ModeWrite && BufferLoad) if (!SaveBuffer()) rval=false;
    // Close file(s)
    if (hgzFile) if (c4_gzclose(hgzFile)!=Z_OK) rval=false;
    if (hFile) if (fclose(hFile)!=0) rval=false;
    if (pMemory)
    {
        if (ppMemory)
            { *ppMemory = pMemory; pMemory = nullptr; }
        else
            delete pMemory;
    }
    MemoryPtr=0;
    hgzFile=nullptr; hFile=nullptr;
    return !!rval;
}

References BufferLoad, c4_gzclose(), StdThreadCheck::Check(), hFile, hgzFile, MemoryPtr, ModeWrite, Name, pMemory, SaveBuffer(), Status, and thread_check.

Referenced by C4Playback::Clear(), C4ConfigGeneral::CreateSaveFolder(), C4UpdatePackage::Execute(), C4Group::ExtractEntry(), GetFileCRC(), GetFileSHA1(), main(), C4UpdatePackage::MakeUpdate(), C4Group::Open(), C4MessageInput::ProcessCommand(), C4Group::Save(), C4PXSSystem::Save(), CSurface8::Save(), C4Record::Stop(), and ~CStdFile().

Here is the call graph for this function:

Here is the caller graph for this function:

Create()

bool CStdFile::Create	(	const char *	szFileName,
		bool	fCompressed = false,
		bool	fExecutable = false,
		bool	fMemory = false
	)

Definition at line 49 of file CStdFile.cpp.

{
    thread_check.Set();
    // Set modes
    ModeWrite=true;
    // Open in memory?
    if (fMemory)
    {
        if (!(pMemory = new StdBuf())) return false;
        MemoryPtr = 0;
 
        StdStrBuf buf;
        buf.Format("<%p>", pMemory);
        SCopy(buf.getData(), Name, _MAX_PATH);
    }
    // Open standard file
    else
    {
        SCopy(szFilename,Name,_MAX_PATH);
        int flags = _O_BINARY|O_CLOEXEC|O_CREAT|O_WRONLY|O_TRUNC;
#ifdef _WIN32
        int mode = _S_IREAD|_S_IWRITE;
        int fd = _wopen(GetWideChar(Name), flags, mode);
#else
        mode_t mode = S_IRUSR|S_IWUSR|S_IRGRP|S_IWGRP|S_IROTH|S_IWOTH;
        if (fExecutable)
            mode |= S_IXUSR|S_IXGRP|S_IXOTH;
        int fd = open(Name, flags, mode);
#endif
        if (fd == -1) return false;
        if (fCompressed)
        {
            if (!(hgzFile = c4_gzdopen(fd,"wb1"))) return false;
        }
        else
        {
            if (!(hFile = fdopen(fd,"wb"))) return false;
        }
    }
    // Reset buffer
    ClearBuffer();
    // Set status
    Status=true;
    return true;
}

References _MAX_PATH, _O_BINARY, c4_gzdopen(), ClearBuffer(), StdStrBuf::Format(), StdStrBuf::getData(), GetWideChar(), hFile, hgzFile, MemoryPtr, ModeWrite, Name, O_CLOEXEC, pMemory, SCopy(), StdThreadCheck::Set(), Status, and thread_check.

Referenced by C4ConfigGeneral::CreateSaveFolder(), C4TableGraph::DumpToFile(), C4UpdatePackage::Execute(), C4Group::ExtractEntry(), main(), C4UpdatePackage::MakeUpdate(), C4Playback::Open(), C4Group::Open(), C4Group::Save(), C4PXSSystem::Save(), CSurface8::Save(), and C4Record::Start().

Here is the call graph for this function:

Here is the caller graph for this function:

Default()

bool CStdFile::Default

(

)

Definition at line 174 of file CStdFile.cpp.

{
    Status=false;
    Name[0]=0;
    hgzFile=nullptr;
    hFile=nullptr;
    pMemory=nullptr;
    MemoryPtr=0;
    BufferLoad=BufferPtr=0;
    thread_check.Set();
    return true;
}

References BufferLoad, BufferPtr, hFile, hgzFile, MemoryPtr, Name, pMemory, StdThreadCheck::Set(), Status, and thread_check.

Here is the call graph for this function:

Flush()

bool CStdFile::Flush ( )

inline

Definition at line 70 of file CStdFile.h.

{ if (ModeWrite && BufferLoad) return SaveBuffer(); else return true; }

References BufferLoad, ModeWrite, and SaveBuffer().

Referenced by LogSilent(), C4Record::Rec(), and C4UpdatePackage::WriteLog().

Here is the call graph for this function:

Here is the caller graph for this function:

IsOpen()

bool CStdFile::IsOpen ( ) const

inline

Definition at line 68 of file CStdFile.h.

{ return hFile || hgzFile; }

References hFile, and hgzFile.

LoadBuffer()

int CStdFile::LoadBuffer ( )

protected

Definition at line 213 of file CStdFile.cpp.

{
    thread_check.Check();
    if (hFile) BufferLoad = fread(Buffer,1,CStdFileBufSize,hFile);
    if (hgzFile) BufferLoad = c4_gzread(hgzFile, Buffer,CStdFileBufSize);
    BufferPtr=0;
    return BufferLoad;
}

References Buffer, BufferLoad, BufferPtr, c4_gzread(), StdThreadCheck::Check(), CStdFileBufSize, hFile, hgzFile, and thread_check.

Referenced by Advance(), and Read().

Here is the call graph for this function:

Here is the caller graph for this function:

Open()

bool CStdFile::Open	(	const char *	szFileName,
		bool	fCompressed = false
	)

Definition at line 95 of file CStdFile.cpp.

{
    SCopy(szFilename,Name,_MAX_PATH);
    thread_check.Set();
    // Set modes
    ModeWrite=false;
    int flags = _O_BINARY|O_CLOEXEC|O_RDONLY;
#ifdef _WIN32
    int mode = _S_IREAD|_S_IWRITE;
    int fd = _wopen(GetWideChar(Name), flags, mode);
#else
    mode_t mode = S_IRUSR|S_IWUSR|S_IRGRP|S_IWGRP|S_IROTH|S_IWOTH;
    int fd = open(Name, flags, mode);
#endif
    if(fd == -1) return false;
    if (fCompressed)
    {
        if (!(hgzFile = c4_gzdopen(fd,"rb"))) { close(fd); return false; }
        /* Reject uncompressed files */
        if(c4_gzdirect(hgzFile))
        {
            c4_gzclose(hgzFile);
            hgzFile = nullptr;
            return false;
        }
    }
    else
    { 
        if (!(hFile = fdopen(fd,"rb"))) return false;
    }
    // Reset buffer
    ClearBuffer();
    // Set status
    Status=true;
    return true;
}

References _MAX_PATH, _O_BINARY, c4_gzclose(), c4_gzdirect(), c4_gzdopen(), ClearBuffer(), GetWideChar(), hFile, hgzFile, ModeWrite, Name, O_CLOEXEC, SCopy(), StdThreadCheck::Set(), Status, and thread_check.

Referenced by GetFileCRC(), GetFileSHA1(), main(), and C4Playback::Open().

Here is the call graph for this function:

Here is the caller graph for this function:

Read() [1/2]

bool CStdFile::Read ( void *  pBuffer, size_t  iSize  )

inlineoverridevirtual

Implements CStdStream.

Definition at line 60 of file CStdFile.h.

{ return Read(pBuffer, iSize, nullptr); }

References iSize, and Read().

Referenced by C4Playback::Check(), GetFileCRC(), GetFileSHA1(), main(), C4Playback::NextSequentialChunk(), and Read().

Here is the call graph for this function:

Here is the caller graph for this function:

Read() [2/2]

bool CStdFile::Read	(	void *	pBuffer,
		size_t	iSize,
		size_t *	ipFSize
	)

Definition at line 187 of file CStdFile.cpp.

{
    thread_check.Check();
    int transfer;
    if (!pBuffer) return false;
    if (ModeWrite) return false;
    BYTE *bypBuffer= (BYTE*) pBuffer;
    if (ipFSize) *ipFSize = 0;
    while (iSize>0)
    {
        // Valid data in the buffer: Transfer as much as possible
        if (BufferLoad>BufferPtr)
        {
            transfer=std::min<size_t>(BufferLoad-BufferPtr,iSize);
            memmove(bypBuffer, Buffer+BufferPtr, transfer);
            BufferPtr+=transfer;
            bypBuffer+=transfer;
            iSize-=transfer;
            if (ipFSize) *ipFSize += transfer;
        }
        // Buffer empty: Load
        else if (LoadBuffer()<=0) return false;
    }
    return true;
}

References Buffer, BufferLoad, BufferPtr, StdThreadCheck::Check(), iSize, LoadBuffer(), ModeWrite, and thread_check.

Here is the call graph for this function:

Rewind()

bool CStdFile::Rewind

(

)

Definition at line 275 of file CStdFile.cpp.

{
    thread_check.Check();
    if (ModeWrite) return false;
    ClearBuffer();
    if (hFile) rewind(hFile);
    if (hgzFile) c4_gzrewind(hgzFile);
    return true;
}

References c4_gzrewind(), StdThreadCheck::Check(), ClearBuffer(), hFile, hgzFile, ModeWrite, and thread_check.

Here is the call graph for this function:

SaveBuffer()

bool CStdFile::SaveBuffer ( )

protected

Definition at line 222 of file CStdFile.cpp.

{
    thread_check.Check();
    int saved = 0;
    if (hFile) saved=fwrite(Buffer,1,BufferLoad,hFile);
    if (hgzFile) saved=c4_gzwrite(hgzFile,Buffer,BufferLoad);
    if (pMemory) { pMemory->Append(Buffer, BufferLoad); saved = BufferLoad; }
    if (saved!=BufferLoad) return false;
    BufferLoad=0;
    return true;
}

References StdBuf::Append(), Buffer, BufferLoad, c4_gzwrite(), StdThreadCheck::Check(), hFile, hgzFile, pMemory, and thread_check.

Referenced by Close(), Flush(), and Write().

Here is the call graph for this function:

Here is the caller graph for this function:

Seek()

int CStdFile::Seek	(	long int	offset,
		int	whence
	)

Definition at line 308 of file CStdFile.cpp.

{
    // seek in file by offset and stdio-style SEEK_* constants. Only implemented for uncompressed files.
    assert(!hgzFile);
    return fseek(hFile, offset, whence);
}

References hFile, and hgzFile.

Tell()

long int CStdFile::Tell

(

)

Definition at line 315 of file CStdFile.cpp.

{
    // get current file pos. Only implemented for uncompressed files.
    assert(!hgzFile);
    return ftell(hFile);
}

References hFile, and hgzFile.

Write()

bool CStdFile::Write	(	const void *	pBuffer,
		int	iSize
	)

Definition at line 240 of file CStdFile.cpp.

{
    thread_check.Check();
    int transfer;
    if (!pBuffer) return false;
    if (!ModeWrite) return false;
    const BYTE *bypBuffer= (const BYTE*) pBuffer;
    while (iSize>0)
    {
        // Space in buffer: Transfer as much as possible
        if (BufferLoad<CStdFileBufSize)
        {
            transfer=std::min(CStdFileBufSize-BufferLoad,iSize);
            memcpy(Buffer+BufferLoad,bypBuffer,transfer);
            BufferLoad+=transfer;
            bypBuffer+=transfer;
            iSize-=transfer;
        }
        // Buffer full: Save
        else if (!SaveBuffer()) return false;
    }
    return true;
}

References Buffer, BufferLoad, StdThreadCheck::Check(), CStdFileBufSize, iSize, ModeWrite, SaveBuffer(), and thread_check.

Referenced by C4Playback::Check(), C4UpdatePackage::Execute(), C4Group::ExtractEntry(), LogSilent(), main(), C4UpdatePackage::MakeUpdate(), C4Record::Rec(), C4Group::Save(), C4PXSSystem::Save(), CSurface8::Save(), C4Record::Stop(), C4UpdatePackage::WriteLog(), and WriteString().

Here is the call graph for this function:

Here is the caller graph for this function:

WriteString()

bool CStdFile::WriteString

(

const char *

szStr

)

Definition at line 264 of file CStdFile.cpp.

{
    thread_check.Check();
    BYTE nl[2]={0x0D,0x0A};
    if (!szStr) return false;
    int size=SLen(szStr);
    if (!Write((const void*)szStr,size)) return false;
    if (!Write(nl,2)) return false;
    return true;
}

References StdThreadCheck::Check(), SLen(), thread_check, and Write().

Referenced by C4ConfigGeneral::CreateSaveFolder(), C4TableGraph::DumpToFile(), and C4MessageInput::ProcessCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

Buffer

BYTE CStdFile::Buffer[CStdFileBufSize]

protected

Definition at line 50 of file CStdFile.h.

Referenced by LoadBuffer(), Read(), SaveBuffer(), and Write().

BufferLoad

int CStdFile::BufferLoad

protected

Definition at line 51 of file CStdFile.h.

Referenced by Advance(), ClearBuffer(), Close(), Default(), Flush(), LoadBuffer(), Read(), SaveBuffer(), and Write().

BufferPtr

int CStdFile::BufferPtr

protected

Definition at line 51 of file CStdFile.h.

Referenced by Advance(), ClearBuffer(), Default(), LoadBuffer(), and Read().

hFile

FILE* CStdFile::hFile

protected

Definition at line 46 of file CStdFile.h.

Referenced by AccessedEntrySize(), Advance(), Append(), Close(), Create(), CStdFile(), Default(), IsOpen(), LoadBuffer(), Open(), Rewind(), SaveBuffer(), Seek(), and Tell().

hgzFile

gzFile CStdFile::hgzFile

protected

Definition at line 47 of file CStdFile.h.

Referenced by AccessedEntrySize(), Close(), Create(), CStdFile(), Default(), IsOpen(), LoadBuffer(), Open(), Rewind(), SaveBuffer(), Seek(), and Tell().

MemoryPtr

int CStdFile::MemoryPtr

protected

Definition at line 49 of file CStdFile.h.

Referenced by Close(), Create(), and Default().

ModeWrite

bool CStdFile::ModeWrite

protected

Definition at line 52 of file CStdFile.h.

Referenced by Advance(), Append(), Close(), Create(), CStdFile(), Flush(), Open(), Read(), Rewind(), and Write().

Name

char CStdFile::Name[_MAX_PATH_LEN]

Definition at line 44 of file CStdFile.h.

Referenced by Append(), Close(), Create(), CStdFile(), Default(), and Open().

pMemory

StdBuf* CStdFile::pMemory

protected

Definition at line 48 of file CStdFile.h.

Referenced by Close(), Create(), CStdFile(), Default(), and SaveBuffer().

Status

bool CStdFile::Status

Definition at line 43 of file CStdFile.h.

Referenced by Append(), Close(), Create(), CStdFile(), Default(), and Open().

thread_check

StdThreadCheck CStdFile::thread_check

protected

Definition at line 53 of file CStdFile.h.

Referenced by Advance(), Append(), ClearBuffer(), Close(), Create(), CStdFile(), Default(), LoadBuffer(), Open(), Read(), Rewind(), SaveBuffer(), Write(), and WriteString().

---

The documentation for this class was generated from the following files:

• CStdFile.h
• CStdFile.cpp