#include <cScriptFile.h>

Inheritance diagram for GrayLib::cScriptFileReader:

Public Member Functions
	cScriptFileReader ()

virtual	~cScriptFileReader ()

virtual HRESULT	OpenX (cStringF sFilePath="", OF_FLAGS_t nOpenFlags=OF_READ\|OF_TEXT)

bool	FindNextSection (cScriptSection *pSection, bool bStripped=false)

bool	FindSection (cScriptSection *pSection, cStringA sName, OF_FLAGS_t nOpenFlags=0)

	UNITTEST2_PREDEF (cScriptFile)

Public Member Functions inherited from Gray::cFileText
	cFileText ()

	cFileText (cStringF sFilePath, OF_FLAGS_t nOpenFlags)

virtual	~cFileText ()

virtual bool	isFileOpen () const override

bool	isEOF () const

HRESULT	GetStreamError () const

virtual void	Close (void) override

HRESULT	OpenFileHandle (HANDLE h, OF_FLAGS_t nOpenFlags)

FILE *	DetachFileStream ()

virtual STREAM_SEEKRET_t	Seek (STREAM_OFFSET_t offset=0, SEEK_ORIGIN_TYPE eSeekOrigin=SEEK_Set) override

virtual STREAM_POS_t	GetPosition () const override

virtual HRESULT	FlushX () override

virtual HRESULT	ReadX (void *pBuffer, size_t nSizeMax) override

virtual HRESULT	WriteX (const void *pData, size_t nDataSize) override

virtual HRESULT	WriteString (const char *pszStr) override

virtual HRESULT	WriteString (const wchar_t *pszStr) override

virtual HRESULT	ReadStringLine (char *pBuffer, StrLen_t nSizeMax) override

virtual HRESULT	ReadStringLine (wchar_t *pszBuffer, StrLen_t iSizeMax) override

HRESULT	ReadStringLineA (cStringA &r)

BOOL	ReadString (CString &rString)

bool	put_TextPos (const cTextPos &rPos)

cTextPos	get_TextPos () const

ITERATE_t	get_CurrentLineNumber () const noexcept

FILE *	get_FileStream () const noexcept

Public Member Functions inherited from Gray::cFile
	cFile ()

	cFile (cStringF sFilePath, OF_FLAGS_t nOpenFlags)

virtual	~cFile ()

virtual bool	isValidCheck () const noexcept
	< memory allocation and structure definitions are valid. More...

virtual STREAM_POS_t	GetLength () const override

int	Read (void *pData, size_t nDataSize)

void	Write (const void *pData, size_t nDataSize)

cStringF	get_FilePath () const

cStringF	get_FileTitleX () const

cStringF	get_FileExt () const

bool	IsFileExt (const FILECHAR_t *pszExt) const

OF_FLAGS_t	get_Mode () const noexcept

OF_FLAGS_t	get_ModeFlags () const noexcept

bool	isModeWrite () const noexcept

bool	isModeRead () const noexcept

HANDLE	DetachFileHandle ()

HRESULT	OpenWait (cStringF sFilePath="", OF_FLAGS_t nOpenFlags=OF_READ\|OF_SHARE_DENY_NONE, TIMESYSD_t nWaitTime=100)

HRESULT	OpenCreate (cStringF sFilePath="", OF_FLAGS_t nOpenFlags=OF_CREATE\|OF_WRITE, _SECURITY_ATTRIBUTES *pSa=nullptr)

bool	SetFileTime (const cTimeFile lpCreationTime, const cTimeFile lpAccessTime, const cTimeFile *lpLastWriteTime)

bool	SetFileTime (cTimeInt timeCreation, cTimeInt timeLastWrite)

HRESULT	GetFileStatus (OUT cFileStatus &attr) const

Public Member Functions inherited from Gray::CFile
virtual	~CFile ()

virtual void	SetLength (STREAM_SEEKRET_t dwNewLen)

HRESULT	Write (const void *pData, size_t nDataSize)

HRESULT	Read (void *pData, size_t nDataSize)

Public Member Functions inherited from Gray::CObject
virtual	~CObject ()

virtual void	AssertValid () const
	< memory allocation and structure definitions are valid. More...

virtual void	Serialize (cArchive &a)

Public Member Functions inherited from Gray::cStream
void	SeekToBegin ()

STREAM_POS_t	SeekToEnd ()

Public Member Functions inherited from Gray::cStreamInput
	cStreamInput () noexcept

virtual	~cStreamInput ()

virtual size_t	SetSeekSizeMin (size_t nSizeMin=k_FILE_BLOCK_SIZE)

virtual HRESULT	ReadX (OUT void *pData, size_t nDataSize)

HRESULT	ReadAll (OUT cHeapBlock &block, size_t nSizeExtra=0)

virtual HRESULT	ReadStringLine (OUT char *pszBuffer, StrLen_t iSizeMax)

virtual HRESULT	ReadStringLine (OUT wchar_t *pszBuffer, StrLen_t iSizeMax)

HRESULT	ReadT (OUT void *pVal, size_t nSize)

template<typename TYPE >
HRESULT	ReadT (OUT TYPE &val)

template<typename TYPE >
HRESULT	ReadTN (OUT TYPE &val)

HRESULT	ReadSize (OUT size_t &nSize)

template<typename TYPE >
HRESULT	ReadSizeT (OUT TYPE &n)

HRESULT	ReadHashCode (OUT UINT32 &nHashCode)

HRESULT	ReadHashCode (OUT UINT64 &nHashCode)

HRESULT	ReadN (OUT BYTE *pBuffer, size_t nSizeMax)

template<typename _CH >
HRESULT	ReadStringN (OUT _CH *pszStr, StrLen_t iSizeMax)

virtual HRESULT	ReadPeek (void *pData, size_t nDataSize)

Public Member Functions inherited from Gray::cStreamBase
virtual	~cStreamBase ()

void	SeekToBegin ()

STREAM_POS_t	SeekToEnd ()

Public Member Functions inherited from Gray::cStreamOutput
	cStreamOutput () noexcept

virtual	~cStreamOutput ()

HRESULT	WriteT (const void *pVal, size_t nDataSize)

template<typename TYPE >
HRESULT	WriteT (TYPE val)

HRESULT	WriteSize (size_t nSize)

HRESULT	WriteHashCode (HASHCODE_t nHashCode)

HRESULT	WriteN (const void *pBuffer, size_t nSize)

template<typename _CH >
HRESULT	WriteStringN (const _CH *pszStr)

template<typename _CH >
HRESULT	WriteCharRepeat (_CH nChar, int nCount=1)

StrLen_t	VPrintf (const char *pszFormat, va_list args)

StrLen_t	VPrintf (const wchar_t *pszFormat, va_list args)

StrLen_t _cdecl	Printf (const char *pszFormat,...)

StrLen_t _cdecl	Printf (const wchar_t *pszFormat,...)

HRESULT	WriteStream (cStreamInput &sInp, STREAM_POS_t nSizeMax=k_FILE_BLOCK_SIZE, IStreamProgressCallback *pProgress=nullptr, TIMESYSD_t nTimeout=0)
	Copy cStreamInput to this stream. More...

Friends
class	cScriptSection

Additional Inherited Members
Static Public Member Functions inherited from Gray::cFile
static HRESULT __stdcall	DeletePath (const FILECHAR_t *pszFileName)

static HRESULT __stdcall	DeletePathX (const FILECHAR_t *pszFilePath, DWORD nFileFlags=0)

static HRESULT __stdcall	LoadFile (const FILECHAR_t *pszFilePath, OUT cHeapBlock &block, size_t nSizeExtra=0)

Static Public Member Functions inherited from Gray::cIniReader
static bool __stdcall	IsSectionHeader (const IniChar_t *pszLine)

static bool __stdcall	IsLineComment (const IniChar_t *pszLine)

static IniChar_t *__stdcall	FindLineArg (const IniChar_t *pszLine, bool bAllowSpace=false)

static StrLen_t __stdcall	FindScriptLineEnd (const IniChar_t *pLineStr)

static cStringI __stdcall	GetLineParse2 (const IniChar_t pszLine, IniChar_t *ppszArgs=nullptr)

static cStringI __stdcall	GetLineParse3 (const IniChar_t *pszLine, OUT cStringI &rsArgs)

Public Attributes inherited from Gray::CFile
cOSHandle	m_hFile
	OSHandle for the open file. More...

Static Public Attributes inherited from Gray::cStreamBase
static const BYTE	k_SIZE_MASK = 0x80
	Used for WriteSize() More...

static const size_t	k_FILE_BLOCK_SIZE = (32 * 1024)
	default arbitrary transfer block size. more than this is NOT more efficient. More...

Protected Member Functions inherited from Gray::cFile
HRESULT	OpenSetup (cStringF sFilePath, OF_FLAGS_t uModeFlags)

Protected Member Functions inherited from Gray::CFile
bool	isFileOpen () const noexcept

HRESULT	OpenCreate (cStringF sFilePath="", OF_FLAGS_t nOpenFlags=OF_CREATE\|OF_WRITE, _SECURITY_ATTRIBUTES *pSa=nullptr)

Protected Attributes inherited from Gray::cFileText
FILE *	m_pStream
	the current open script/text type file. named as MFC CStdioFile. More...

Protected Attributes inherited from Gray::cFile
OF_FLAGS_t	m_nOpenFlags
	MMSYSTEM uses high bits of 32 bit flags. OF_FLAGS_TYPE_ OF_READ etc. More...

Protected Attributes inherited from Gray::CFile
cStringF	m_strFileName
	store a copy of the full file path. MFC defined name. More...

Static Protected Attributes inherited from Gray::cFile
static ITERATE_t	sm_iFilesOpen = 0
	global count of all open files for this process. More...

Detailed Description

A text file containing lines of script. MIME_EXT_scp

Constructor & Destructor Documentation

◆ cScriptFileReader()

GrayLib::cScriptFileReader::cScriptFileReader ( )

◆ ~cScriptFileReader()

GrayLib::cScriptFileReader::~cScriptFileReader ( )

virtual

Member Function Documentation

◆ FindNextSection()

bool GrayLib::cScriptFileReader::FindNextSection	(	cScriptSection *	pSection,
		bool	bStripped = `false`
	)

Returns: false = EOF. get_ArgStr() = the section name

◆ FindSection()

bool GrayLib::cScriptFileReader::FindSection	(	cScriptSection *	pSection,
		cStringA	sName,
		OF_FLAGS_t	nOpenFlags = `0`
	)

Find (and read) a section in the current script Only used for testing purposes. nOpenFlags = OF_NONCRIT

Returns: true = success

◆ OpenX()

HRESULT GrayLib::cScriptFileReader::OpenX	(	cStringF	sFilePath = `""`,
		OF_FLAGS_t	nOpenFlags = `OF_READ \| OF_TEXT`
	)

virtual

If we are in read mode and we have no script file.

nOpenFlags = OF_READ, OF_CACHE_SEQ, OF_NONCRIT etc
Returns
S_OK = success.

Reimplemented from Gray::cFileText.

◆ UNITTEST2_PREDEF()

GrayLib::cScriptFileReader::UNITTEST2_PREDEF ( cScriptFile )

Friends And Related Function Documentation

◆ cScriptSection

friend class cScriptSection

friend

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

c:/Dennis/Source/Gray/GrayLib/include/ScriptExec/cScriptFile.h
c:/Dennis/Source/Gray/GrayLib/src/ScriptExec/cScriptFile.cpp

Public Member Functions

Friends

Additional Inherited Members