CCDiskFile Class Reference

Represents a file class that can offer buffered disk file I/O in both text and binary modes. Derived from the CCLexFile class so you can use lexical analysis functions on it. More...

#include <ccfile.h>

Inheritance diagram for CCDiskFile:

List of all members.

Public Member Functions
	CCDiskFile (UINT32 bufferSize=(1024), BOOL ErrorReporting=TRUE, BOOL ExceptionThrowing=FALSE)
	Default constructor.
	CCDiskFile (fstream *pfstream, UINT32 bufferSize=(1024), BOOL ErrorReporting=TRUE, BOOL ExceptionThrowing=FALSE)
	Default constructor.
	CCDiskFile (PathName fPath, INT32 fileMode, INT32 fileAccess=0, UINT32 bufferSize=(1024), BOOL ErrorReporting=TRUE, BOOL ExceptionThrowing=FALSE)
	Constructs a CCDiskFile object and opens the file specified by the Path over it.
	CCDiskFile (fstream *pfstream, PathName fPath, INT32 fileMode, INT32 fileAccess=0, UINT32 bufferSize=(1024), BOOL ErrorReporting=TRUE, BOOL ExceptionThrowing=FALSE)
	Constructs a CCDiskFile object and opens the file specified by the Path over it.
virtual BOOL	open (PathName fPath, INT32 fileMode, INT32 fileAccess=0)
	opens file specified by the path.
virtual BOOL	setMode (INT32 fileMode=0)
	Changes the file's mode from text.
virtual BOOL	isOpen () const
	Determines whether file is open.
virtual void	close ()
	To close the file.
virtual size_t	Size ()
virtual BOOL	GetName (StringBase *name) const
	Given a CCDiskFile*, you can ask for some sort of name which is associated with that file. For filenames it might be a filename, or a pathname, for resource files it might be "Default Bitmap" etc. These names could then be used for making error messages have some extra useful information in.
virtual PathName	GetPathName () const
	To find out the name of the file.
virtual filedesc	GetFileHandle () const
	Given an instance of a CCDiskFile, you can ask for the actual file handle that describes the associated file. Required for the external filters.
Protected Member Functions
fstream &	GetFileStream ()
const fstream &	GetFileStream () const
Protected Attributes
PathName	filePath
Private Member Functions
	CC_DECLARE_DYNAMIC (CCDiskFile)

---

Detailed Description

Represents a file class that can offer buffered disk file I/O in both text and binary modes. Derived from the CCLexFile class so you can use lexical analysis functions on it.

Author:

Mario_Shamtani (Xara Group Ltd) <camelotdev@xara.com>

Date:

31/8/1993

Definition at line 759 of file ccfile.h.

---

Constructor & Destructor Documentation

CCDiskFile::CCDiskFile (  UINT32  bufferSize = (1024), BOOL  ErrorReporting = TRUE, BOOL  ExceptionThrowing = FALSE )

Default constructor. Author: Mario_Shamtani (Xara Group Ltd) <camelotdev@xara.com> (Altered by Neville 01/09/94) Date: 1/9/93 Parameters: bufferSize  - Size of the fixed size buffer (default = 1024) [INPUTS] if size > 0 then create a buffer of the specified size if size = 0 then create a file without a buffer ReportErrors flag ThrowException flag See also: fstream::setbuf() Definition at line 4381 of file ccfile.cpp. : CCStreamFile(new fstream, bufferSize, ErrorReporting, ExceptionThrowing) { // TRACEUSER( "JustinF", _T("In CCDiskFile::CCDiskFile\n")); }

CCDiskFile::CCDiskFile (  fstream *  pfstream, UINT32  bufferSize = (1024), BOOL  ErrorReporting = TRUE, BOOL  ExceptionThrowing = FALSE )

Default constructor. Author: Mario_Shamtani (Xara Group Ltd) <camelotdev@xara.com> (Altered by Neville 01/09/94) Date: 1/9/93 Parameters: bufferSize  - Size of the fixed size buffer (default = 1024) [INPUTS] if size > 0 then create a buffer of the specified size if size = 0 then create a file without a buffer ReportErrors flag ThrowException flag See also: fstream::setbuf() Definition at line 4407 of file ccfile.cpp. : CCStreamFile(pfstream, bufferSize, ErrorReporting, ExceptionThrowing) { // Empty. }

CCDiskFile::CCDiskFile (  PathName  fPath, INT32  fileMode, INT32  fileAccess = 0, UINT32  bufferSize = (1024), BOOL  ErrorReporting = TRUE, BOOL  ExceptionThrowing = FALSE )

Constructs a CCDiskFile object and opens the file specified by the Path over it. Author: Mario_Shamtani (Xara Group Ltd) <camelotdev@xara.com> (Altered by Neville 01/09/94) Date: 1/9/93 Parameters: fPath  - PathName for file to be opened [INPUTS] fileMode - Mode in which file is to be opened - use ios flags fileAccess - file access flag(s) as specified by the filebuf flags bufferSize - Size of the fixed size buffer (default = 1024) if size > 0 then create a buffer of the specified size if size = 0 then create a file without a buffer ReportErrors flag ThrowExceptions flag See also: fstream::setbuf() fstream::open() Definition at line 4503 of file ccfile.cpp. : CCStreamFile(new fstream, bufferSize, ErrorReporting, ExceptionThrowing) { // Set up Path name // TRACEUSER( "JustinF", _T("In CCDiskFile::CCDiskFile\n")); filePath = fPath; ModeOfFile = fileMode; // note current state // Check if the base class setup OK. if (!IsInited()) return; // Open the file #if 0 != wxUSE_UNICODE { size_t cch = camWcstombs( NULL, (const TCHAR *)filePath.GetPath(), 0 ) + 1; PSTR pszFileName = PSTR( alloca( cch ) ); camWcstombs( pszFileName, (const TCHAR *)filePath.GetPath(), cch ); GetFileStream().open( pszFileName, ios_base::openmode(fileMode) ); } #else GetFileStream().open( filePath.GetPath(), ios_base::openmode(fileMode) ); #endif // If file not opened properly report error if (IOFile->fail() || !GetFileStream().is_open()) { GotError(_R(IDE_OPEN_ERROR)); StreamFileInitialised = FALSE; } }

CCDiskFile::CCDiskFile (  fstream *  pfstream, PathName  fPath, INT32  fileMode, INT32  fileAccess = 0, UINT32  bufferSize = (1024), BOOL  ErrorReporting = TRUE, BOOL  ExceptionThrowing = FALSE )

Constructs a CCDiskFile object and opens the file specified by the Path over it. Author: Mario_Shamtani (Xara Group Ltd) <camelotdev@xara.com> (Altered by Neville 01/09/94) Date: 1/9/93 Parameters: fPath  - PathName for file to be opened [INPUTS] fileMode - Mode in which file is to be opened - use ios flags fileAccess - file access flag(s) as specified by the filebuf flags bufferSize - Size of the fixed size buffer (default = 1024) if size > 0 then create a buffer of the specified size if size = 0 then create a file without a buffer ReportErrors flag ThrowExceptions flag See also: fstream::setbuf() fstream::open() Definition at line 4439 of file ccfile.cpp. : CCStreamFile(pfstream, bufferSize, ErrorReporting, ExceptionThrowing) { // Set up Path name filePath = fPath; ModeOfFile = fileMode; // note current state // Check if the base class setup OK. if (!IsInited()) return; // Open the file #if 0 != wxUSE_UNICODE { size_t cch = camWcstombs( NULL, (const TCHAR *)filePath.GetPath(), 0 ) + 1; PSTR pszFileName = PSTR( alloca( cch ) ); camWcstombs( pszFileName, (const TCHAR *)filePath.GetPath(), cch ); GetFileStream().open( pszFileName, ios_base::openmode(fileMode) ); } #else GetFileStream().open( filePath.GetPath(), ios_base::openmode(fileMode) ); #endif // If file not opened properly report error if (IOFile->fail() || !GetFileStream().is_open()) { String_256 ErrorMsg(_R(IDE_OPEN_ERROR)); ErrorMsg += filePath.GetFileName(); GotError(_R(IDE_OPEN_ERROR), ErrorMsg); StreamFileInitialised = FALSE; } }

---

Member Function Documentation

CCDiskFile::CC_DECLARE_DYNAMIC (  CCDiskFile   )  [private]

void CCDiskFile::close (   )  [virtual]

To close the file. Author: Justin_Flude (Xara Group Ltd) <camelotdev@xara.com> Date: 1/9/93 See also: fstream::close() Reimplemented from CCStreamFile. Definition at line 4618 of file ccfile.cpp. { GetFileStream().close(); }

filedesc CCDiskFile::GetFileHandle (   )  const [virtual]

Given an instance of a CCDiskFile, you can ask for the actual file handle that describes the associated file. Required for the external filters. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 22/09/94 Parameters: None  [INPUTS] None  [OUTPUTS] Returns: The file handle (descriptor) for this file (really an INT32). Errors: None See also: CCDiskFile::Size Reimplemented from CCStreamFile. Definition at line 137 of file filehndl.cpp. { PORTNOTETRACE("other","CCDiskFile::GetFileHandle - do nothing"); #ifndef EXCLUDE_FROM_XARALX // Need to convert this into a real file handle rather than the descriptor. // At present there seems to be no legal way of doing this. return _get_osfhandle(GetFileStream().fd()); #endif return 0; }

const fstream& CCDiskFile::GetFileStream (   )  const [inline, protected]

Definition at line 772 of file ccfile.h. { return (const fstream&) *IOFile; }

fstream& CCDiskFile::GetFileStream (   )  [inline, protected]

Definition at line 771 of file ccfile.h. { return (fstream&) *IOFile; }

BOOL CCDiskFile::GetName (  StringBase *  name  )  const [virtual]

Given a CCDiskFile*, you can ask for some sort of name which is associated with that file. For filenames it might be a filename, or a pathname, for resource files it might be "Default Bitmap" etc. These names could then be used for making error messages have some extra useful information in. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 22/09/94 Parameters: Pointer  to a CCFile name [INPUTS] None  [OUTPUTS] Returns: True if a name has been set otherwise False. At present always returns False. Errors: None Reimplemented from CCFile. Definition at line 4689 of file ccfile.cpp. { // Work out how much space we have INT32 MaxLen = name->MaxLength(); filePath.GetPath(); // Now fit our name into this space String_256 Pathname = filePath.GetPath(); if (MaxLen < Pathname.Length()) { // Use just the filename Pathname = filePath.GetFileName(); // If it is still too long, turn it into the form "...ffff.ext", i.e. have an // ellipsis followed by as much of the filename as we can fit into the string. // (We use the last segment of the filename, i.e. we throw away characters from // the beginning). INT32 FilenameLen = Pathname.Length(); if (MaxLen < FilenameLen) { // Shuffle pathname down to fit into buffer Pathname.Remove(0, FilenameLen - MaxLen); // Put the ellipsis at the front TCHAR *Buf = (TCHAR *) Pathname; Buf[0] = '.'; Buf[1] = '.'; Buf[2] = '.'; } } // Copy into output parameter *name = Pathname; // Successful return TRUE; }

PathName CCDiskFile::GetPathName (   )  const [virtual]

To find out the name of the file. Author: Rik_Heywood (Xara Group Ltd) <camelotdev@xara.com> Date: 1/2/95 Returns: The pathname we have associated with the CCDiskFile Reimplemented from CCFile. Definition at line 4741 of file ccfile.cpp. { return filePath; }

BOOL CCDiskFile::isOpen (   )  const [virtual]

Determines whether file is open. Author: Mario_Shamtani (Xara Group Ltd) <camelotdev@xara.com> Date: 2/9/93 Returns: TRUE if file is open and FALSE otherwize. See also: fstream::is_open() Reimplemented from CCStreamFile. Definition at line 4665 of file ccfile.cpp. { return CCStreamFile::isOpen() && const_cast<std::fstream &>(GetFileStream()).is_open(); }

BOOL CCDiskFile::open (  PathName  fPath, INT32  fileMode, INT32  fileAccess = 0 )  [virtual]

opens file specified by the path. Author: Mario_Shamtani (Xara Group Ltd) <camelotdev@xara.com> Date: 1/9/93 Parameters: fPath  - PathName for file to be opened [INPUTS] fileMode - Mode in which file is to be opened - use ios flags fileAccess - file access flag(s) as specified by the filebuf flags Returns: TRUE if file is opened ok or FALSE otherwize See also: fstream::open() Note: It would appear that calling this with ios::in | ios::out | ios::binary on NT on an existing file truncates the file, whereas on Windows 95 it does not truncate the file. Exporting bitmap and eps files was failing as the data was appended to the end of the file on Windows 95. OpMenuExport::DoWithParam fixed by adding a ios::trunc to the open call. Definition at line 4561 of file ccfile.cpp. { // First check that the constructor went ok if (!StreamFileInitialised) { // Did not construct ok, error should have been reported, so just fail return FALSE; } // Nuke any existing open error states that might exist IOFile->clear(IOFile->goodbit); // If we are not opening this file for writing then set the ios::nocreate // flag due to a bug in the iostream classes (but not if the ios::out flag is specified // as well. If this is not set we can not open files on read-only mounts shared by windows 95. // if ((fileMode & ios::in) && !(fileMode & ios::out)) fileMode |= ios::nocreate; // Set up file pathname filePath = fPath; ModeOfFile = fileMode; // note current state // Open file #if 0 != wxUSE_UNICODE { size_t cch = camWcstombs( NULL, (const TCHAR *)filePath.GetPath(), 0 ) + 1; PSTR pszFileName = PSTR( alloca( cch ) ); camWcstombs( pszFileName, (const TCHAR *)filePath.GetPath(), cch ); GetFileStream().open( pszFileName, ios_base::openmode(fileMode) ); } #else GetFileStream().open( filePath.GetPath(), ios_base::openmode(fileMode) ); #endif // If error on opening file report it! if (IOFile->fail() || !GetFileStream().is_open()) { GotError(_R(IDE_OPEN_ERROR)); return FALSE; } return TRUE; }

BOOL CCDiskFile::setMode (  INT32  fileMode = 0  )  [virtual]

Changes the file's mode from text. Author: Mario_Shamtani (Xara Group Ltd) <camelotdev@xara.com> Date: 1/9/93 Parameters: fileMode  - Text or Binary (default is text) [INPUTS] Returns: TRUE if the mode has changed and FALSE otherwize. See also: fstream::setmode() Reimplemented from CCStreamFile. Definition at line 4638 of file ccfile.cpp. { // This might cause problems in compressed mode so error if called in this mode ERROR3IF(CompressData, "DiskFile set mode called when compressed"); PORTNOTE("other","ios::setmode not suppport anymore") #ifndef EXCLUDE_FROM_XARALX return GetFileStream().setmode(fileMode) >= 0; #else return true; #endif }

size_t CCDiskFile::Size (   )  [virtual]

Author: Justin_Flude (Xara Group Ltd) <camelotdev@xara.com> Date: 13/8/96 Returns: The size of the attached stream, in bytes. Reimplemented from CCStreamFile. Reimplemented in CCAsynchDiskFile. Definition at line 114 of file filesize.cpp. { ENSURE(isOpen(), "Must open a CCDiskFile before calling Size()!\n"); /* CFileStatus fs; if (!CFile::GetStatus((const TCHAR*)filePath.GetPath(), fs)) { #ifdef _DEBUG if (IsUserName("JustinF")) TRACE( _T("Attempt to read size of non-existent file\n")); #endif // _DEBUG return -1; } return fs.m_size;*/ // [A quick story from richard] // Whilst writing the library gallery code I came to much grief using MFC functions // to check for a file's existance and its size... In the end I resorted to writing // some functions of my own which did the same job, only better, and didn't hinder // timings that much. The above code was found to have problems with certain files. // Basically if the file has invalid datestamps, MFC goes tits-up... We found quite // a few files in this catagory... The below call is known to work, and has been // tested beyond belief whilst writing gallery stuff... size_t FileSize = 0; #if defined(__WXMSW__) || 0 == wxUSE_UNICODE FILE *FP = _tfopen((const TCHAR *)filePath.GetPath(), _T("rb")); #else // GNU\Linux seems to have no unicode filesystem name support, so we // just get on and do the needed conversion as efficiently as possible size_t cchTmp = camWcstombs( NULL, filePath.GetPath(), 0 ) + 1; PSTR pszTmp = PSTR( alloca( cchTmp ) ); camWcstombs( pszTmp, filePath.GetPath(), cchTmp ); FILE *FP = fopen( pszTmp, "rb" ); #endif if(FP != NULL) { fseek(FP,0,SEEK_END); FileSize = ftell(FP); fclose(FP); } return FileSize; }

---

Member Data Documentation

PathName CCDiskFile::filePath [protected]

Definition at line 767 of file ccfile.h.

---

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

• Kernel/ccfile.h (r1785/r1492)
• Kernel/ccfile.cpp (r1785/r1607)
• wxOil/filehndl.cpp (r1785/r1282)
• wxOil/filesize.cpp (r1785/r1282)

---