fileutil.h

Go to the documentation of this file.
00001 // $Id: fileutil.h 1461 2006-07-18 09:50:40Z luke $
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 // FileUtil - WinOil level file manipulation library
00099 
00100 
00101 #ifndef INC_FILEUTIL
00102 #define INC_FILEUTIL
00103 
00104 class PathName;
00105 
00106 
00107 /****************************************************************************
00108 
00109 >   class FileUtil
00110 
00111     Author:     Mike_Kenny (Xara Group Ltd) <camelotdev@xara.com>
00112     Created:    24/07/96
00113     Purpose:    This class contains a library of static functions for use
00114                 on Windows platforms. The functions perform general file
00115                 manipulation operations, rather than single file data IO.
00116                 If you want the size of a file, to locate a particular file
00117                 on disc etc, then here's where you'll find all those useful
00118                 routines to do it.
00119     SeeAlso:
00120 
00121 ****************************************************************************/
00122 
00123 class FileUtil
00124 {
00125 public:     // Scanning for specific files
00126     static BOOL FindResourceFile(TCHAR* SearchFile, TCHAR* FoundFile);
00127 
00128 
00129 public:     // Scanning through a set of particular files in a directory
00130     static BOOL StartFindingFiles(String_256 *FileSpecifier);
00131     static BOOL FindNextFile(String_256 *FoundFile);
00132     static void StopFindingFiles(void);
00133 
00134 public:     // Misc
00135     static BOOL GetLongFileName(LPTSTR lpszPath, LPTSTR lpszOutput, size_t cchMaxOutLen);
00136     static UINT32 GetTemporaryFileName(const TCHAR *PathName, const TCHAR *Prefix, UINT32 Unique, TCHAR *FileName);
00137     static DWORD GetTemporaryPath(UINT32 BufferLength,  TCHAR *Buffer);
00138 
00139     static PathName GetTemporaryPathName();
00140     static BOOL GetTemporaryPathName(const TCHAR *pExt, PathName *pTempPath);
00141     static BOOL DeleteFile(PathName *FileToRemove);
00142 
00143     static BOOL GetCurrentDirectory(String_256 * pCurrentPath);
00144     static BOOL SetCurrentDirectory(const PathName& NewCurrentPath);
00145     static BOOL SetCurrentDirectory(const String_256& NewCurrentPath);
00146 
00147     static BOOL RecursiveCreateDirectory( const String_256& strDirPath );
00148 
00149     //A straightforward wrapper for the MFC function GetFileAttributes
00150     static DWORD FindFileAttributes(LPCTSTR lpFileName)
00151     {
00152         TRACE( wxT("Warning - FileUtil::FindFileAttributes called\n") );
00153 #if defined(__WXMSW__)
00154         return GetFileAttributes( lpFileName );
00155 #else
00156         return 0;
00157 #endif
00158         }
00159 
00160 private:    // Private data
00161     static BOOL             SearchActive;
00162     static bool             s_fStarted;
00163     static String_256       SearchPath;
00164     static wxDir            s_dirSearch;
00165 };
00166 
00167 /****************************************************************************
00168 
00169 >   class FindFiles : public CC_CLASS_MEMDUMP
00170 
00171     Author:     Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com>
00172     Created:    09/01/97
00173     Purpose:    This class can be used for searching directories for files.
00174                 It is basically equivalent to the 
00175     SeeAlso:
00176 
00177 ****************************************************************************/
00178 
00179 class FindFiles : public CC_CLASS_MEMDUMP
00180 {
00181     // Declare the class for memory tracking
00182     CC_DECLARE_MEMDUMP(FindFiles);
00183 public:
00184     FindFiles() {};
00185 
00186 public:     // Scanning through a set of particular files in a directory
00187     BOOL StartFindingFiles(String_256 *FileSpecifier);
00188     BOOL FindNextFile(String_256 *FoundFile, BOOL *IsDirectory);
00189     BOOL StopFindingFiles();
00190 
00191 private:    // Private data
00192     String_256      m_SearchPath;
00193 #if defined(__WXMSW__)
00194     HANDLE          m_SearchHandle;
00195     WIN32_FIND_DATA m_SearchData;
00196 #endif
00197 };
00198 
00199 #endif
00200 

Generated on Sat Nov 10 03:48:28 2007 for Camelot by  doxygen 1.4.4