ccbhfile.h

Go to the documentation of this file.
00001 // $Id: ccbhfile.h 1282 2006-06-09 09:46:49Z alex $
00002 /* @@tag:xara-cn@@ DO NOT MODIFY THIS LINE
00003 ================================XARAHEADERSTART===========================
00004  
00005                Xara LX, a vector drawing and manipulation program.
00006                     Copyright (C) 1993-2006 Xara Group Ltd.
00007        Copyright on certain contributions may be held in joint with their
00008               respective authors. See AUTHORS file for details.
00009 
00010 LICENSE TO USE AND MODIFY SOFTWARE
00011 ----------------------------------
00012 
00013 This file is part of Xara LX.
00014 
00015 Xara LX is free software; you can redistribute it and/or modify it
00016 under the terms of the GNU General Public License version 2 as published
00017 by the Free Software Foundation.
00018 
00019 Xara LX and its component source files are distributed in the hope
00020 that it will be useful, but WITHOUT ANY WARRANTY; without even the
00021 implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
00022 See the GNU General Public License for more details.
00023 
00024 You should have received a copy of the GNU General Public License along
00025 with Xara LX (see the file GPL in the root directory of the
00026 distribution); if not, write to the Free Software Foundation, Inc., 51
00027 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
00028 
00029 
00030 ADDITIONAL RIGHTS
00031 -----------------
00032 
00033 Conditional upon your continuing compliance with the GNU General Public
00034 License described above, Xara Group Ltd grants to you certain additional
00035 rights. 
00036 
00037 The additional rights are to use, modify, and distribute the software
00038 together with the wxWidgets library, the wxXtra library, and the "CDraw"
00039 library and any other such library that any version of Xara LX relased
00040 by Xara Group Ltd requires in order to compile and execute, including
00041 the static linking of that library to XaraLX. In the case of the
00042 "CDraw" library, you may satisfy obligation under the GNU General Public
00043 License to provide source code by providing a binary copy of the library
00044 concerned and a copy of the license accompanying it.
00045 
00046 Nothing in this section restricts any of the rights you have under
00047 the GNU General Public License.
00048 
00049 
00050 SCOPE OF LICENSE
00051 ----------------
00052 
00053 This license applies to this program (XaraLX) and its constituent source
00054 files only, and does not necessarily apply to other Xara products which may
00055 in part share the same code base, and are subject to their own licensing
00056 terms.
00057 
00058 This license does not apply to files in the wxXtra directory, which
00059 are built into a separate library, and are subject to the wxWindows
00060 license contained within that directory in the file "WXXTRA-LICENSE".
00061 
00062 This license does not apply to the binary libraries (if any) within
00063 the "libs" directory, which are subject to a separate license contained
00064 within that directory in the file "LIBS-LICENSE".
00065 
00066 
00067 ARRANGEMENTS FOR CONTRIBUTION OF MODIFICATIONS
00068 ----------------------------------------------
00069 
00070 Subject to the terms of the GNU Public License (see above), you are
00071 free to do whatever you like with your modifications. However, you may
00072 (at your option) wish contribute them to Xara's source tree. You can
00073 find details of how to do this at:
00074   http://www.xaraxtreme.org/developers/
00075 
00076 Prior to contributing your modifications, you will need to complete our
00077 contributor agreement. This can be found at:
00078   http://www.xaraxtreme.org/developers/contribute/
00079 
00080 Please note that Xara will not accept modifications which modify any of
00081 the text between the start and end of this header (marked
00082 XARAHEADERSTART and XARAHEADEREND).
00083 
00084 
00085 MARKS
00086 -----
00087 
00088 Xara, Xara LX, Xara X, Xara X/Xtreme, Xara Xtreme, the Xtreme and Xara
00089 designs are registered or unregistered trademarks, design-marks, and/or
00090 service marks of Xara Group Ltd. All rights in these marks are reserved.
00091 
00092 
00093       Xara Group Ltd, Gaddesden Place, Hemel Hempstead, HP2 6EX, UK.
00094                         http://www.xara.com/
00095 
00096 =================================XARAHEADEREND============================
00097  */
00098 
00099 #ifndef INC_CCBHFILE
00100 #define INC_CCBHFILE
00101 
00102 //#include "ccfile.h" - in camtypes.h [AUTOMATICALLY REMOVED]
00103 
00104 const UINT32 BinHexMaxLineLength = 100;
00105 
00106 /********************************************************************************************
00107 
00108 >   class CCBinHexFile : public CCLexFile
00109 
00110     Author:     Gerry_Iles (Xara Group Ltd) <camelotdev@xara.com>
00111     Created:    16/7/97
00112     Base Class: CCLexFile
00113     Purpose:    Translates data from binary to BinHex format.
00114 
00115     Notes:      This class only checks pCCFile in debug builds
00116 
00117 ********************************************************************************************/
00118 
00119 class CCBinHexFile : public CCLexFile
00120 {                                   
00121     CC_DECLARE_DYNAMIC(CCBinHexFile);
00122 public:
00123     // Constructor with default parameters 
00124     CCBinHexFile(CCLexFile* pCCFile, BOOL ErrorReporting = TRUE, BOOL ExceptionThrowing = FALSE)
00125         : CCLexFile(ErrorReporting, ExceptionThrowing), m_pFile(pCCFile) { /* empty */ };
00126     virtual ~CCBinHexFile() { /* empty */ }
00127     
00128     // Switch between text and binary modes.
00129     virtual BOOL  setMode(INT32 fileMode = 0)
00130     {
00131         return(m_pFile->setMode(fileMode));
00132     };
00133 
00134     // Check if the file is open or not.
00135     virtual BOOL     isOpen() const { return(m_pFile->isOpen()); };
00136 
00137     // File pointer access/control.
00138     virtual CCFile&  seekIn(FilePos Pos) { return(m_pFile->seekIn(Pos)); };
00139     virtual CCFile&  seekIn(INT32 Offset, ios::seekdir Dir)
00140     {
00141         return(m_pFile->seekIn(Offset, Dir));
00142     };
00143     virtual FilePos  tellIn() { return(m_pFile->tellIn()); };
00144     virtual CCFile&  seek(FilePos pos) { return(m_pFile->seek(pos)); };
00145     virtual FilePos  tell() { return(m_pFile->tell()); };
00146 
00147     // Read functions.
00148     virtual CCFile&  read(void *buf, UINT32 length = 1)
00149     {
00150         return(m_pFile->read(buf, length));
00151     };
00152     virtual CCFile&  read(StringBase *buf)
00153     {
00154         return(m_pFile->read(buf));
00155     };
00156     virtual CCFile&  read(char& buf)
00157     {
00158         return(m_pFile->read(buf));
00159     };
00160                                     
00161     // Write functions.
00162     virtual CCFile&  write(const void *buf, UINT32 length = 1);
00163     virtual CCFile&  write(const StringBase& buf, UINT32 length = 0);
00164     virtual CCFile&  write(char& buf);
00165 
00166     // Get the size of an open file in bytes.
00167     virtual size_t   Size() { return(m_pFile->Size()); };
00168 
00169     // Status functions.
00170     virtual BOOL     eof() const { return(m_pFile->eof()); };
00171 
00172     // Close the file.
00173     virtual void     close() { m_pFile->close(); };
00174 
00175     // Non-pure status functions.
00176     virtual BOOL     good() const { return(m_pFile->good()); };
00177     virtual BOOL     bad() const { return(m_pFile->bad()); };
00178     virtual BOOL     fail() const { return(m_pFile->fail()); };
00179 
00180     // Pure status setting functions.
00181     virtual void    SetBadState() { m_pFile->SetBadState(); };
00182     virtual void    SetGoodState() { m_pFile->SetGoodState(); };
00183 
00184     // Allows access to the underlying fstream, is so required.
00185     // Mainly required for PNG/ZLib bits
00186     // All non-disk file classes just return NULL
00187     virtual iostream* GetIOFile() { return(m_pFile->GetIOFile()); };
00188 
00189     // Flush the file object's buffer (if any).
00190     virtual CCFile&  flush() { return(m_pFile->flush()); };
00191 
00192     // Get access to the file descriptor or handle for the file
00193     virtual filedesc GetFileHandle() const { return(m_pFile->GetFileHandle()); };
00194 
00195     // Allow setting of compression of output data
00196     virtual BOOL IsCompressionSet( ) { return(FALSE); };
00197     virtual BOOL SetCompression( BOOL ) { return(FALSE); };
00198 
00199     virtual BOOL InitCompression(BOOL Header = FALSE) { return(TRUE); };
00200     virtual BOOL StartCompression() { return(TRUE); };
00201     virtual BOOL StopCompression() { return(TRUE); };
00202 
00203 protected:
00204     void ByteToHex(BYTE b, char* pPtr);
00205 
00206 protected:
00207     CCLexFile* m_pFile;
00208 
00209     BYTE m_Buffer[BinHexMaxLineLength];
00210 };
00211 
00212 #endif  // INC_CCBHFILE

Generated on Sat Nov 10 03:44:38 2007 for Camelot by  doxygen 1.4.4