开通博客赚积分
发布资源赚积分
分类

源码开发语言/平台
当前位置：首页 > 源码/资料 > 通讯/手机编程 > Symbian > 查看源码
filespecutils.h
资源名称：helix.src.0812.rar　[点击查看]
上传用户：zhongxx05
上传日期：2007-06-06
资源大小：33641k
文件大小：8k
源码类别：

Symbian

开发平台：

C/C++

filespecutils.h：源码内容
  1. /* ***** BEGIN LICENSE BLOCK ***** 
  2.  * Version: RCSL 1.0/RPSL 1.0 
  3.  *  
  4.  * Portions Copyright (c) 1995-2002 RealNetworks, Inc. All Rights Reserved. 
  5.  *      
  6.  * The contents of this file, and the files included with this file, are 
  7.  * subject to the current version of the RealNetworks Public Source License 
  8.  * Version 1.0 (the "RPSL") available at 
  9.  * http://www.helixcommunity.org/content/rpsl unless you have licensed 
  10.  * the file under the RealNetworks Community Source License Version 1.0 
  11.  * (the "RCSL") available at http://www.helixcommunity.org/content/rcsl, 
  12.  * in which case the RCSL will apply. You may also obtain the license terms 
  13.  * directly from RealNetworks.  You may not use this file except in 
  14.  * compliance with the RPSL or, if you have a valid RCSL with RealNetworks 
  15.  * applicable to this file, the RCSL.  Please see the applicable RPSL or 
  16.  * RCSL for the rights, obligations and limitations governing use of the 
  17.  * contents of the file.  
  18.  *  
  19.  * This file is part of the Helix DNA Technology. RealNetworks is the 
  20.  * developer of the Original Code and owns the copyrights in the portions 
  21.  * it created. 
  22.  *  
  23.  * This file, and the files included with this file, is distributed and made 
  24.  * available on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER 
  25.  * EXPRESS OR IMPLIED, AND REALNETWORKS HEREBY DISCLAIMS ALL SUCH WARRANTIES, 
  26.  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY, FITNESS 
  27.  * FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT. 
  28.  * 
  29.  * Technology Compatibility Kit Test Suite(s) Location: 
  30.  *    http://www.helixcommunity.org/content/tck 
  31.  * 
  32.  * Contributor(s): 
  33.  *  
  34.  * ***** END LICENSE BLOCK ***** */ 
  36. #ifndef FILESPECUTILS_H
  37. #define FILESPECUTILS_H
  39. #include "hxstring.h"
  40. #include "hxbuffer.h"
  41. #include "filespec.h"
  43. class CHXFileSpecUtils
  44. {
  46. public:
  47. // disk utilities
  48. static HX_RESULT GetFreeSpaceOnDisk(const CHXDirSpecifier& volSpec, INT64& freeSpace);
  49. static HX_RESULT GetTotalSpaceOnDisk(const CHXDirSpecifier& volSpec, INT64& totalSpace);
  50. static BOOL IsDiskEjectable(const CHXDirSpecifier& volSpec);
  51. static BOOL IsDiskWritable(const CHXDirSpecifier& volSpec);
  53. // IsLocal returns TRUE if the file or directory is on a local volume
  54. // (not on a server)
  55. static BOOL IsDiskLocal(const CHXDirSpecifier& volSpec);
  57. // file/dir utilities
  59. static HX_RESULT GetFileSize(const CHXFileSpecifier& fileSpec, INT64& fSize);
  60. static HX_RESULT GetDirectorySize(const CHXDirSpecifier& dirSpec, BOOL shouldDescend, INT64& fSize);
  62. static BOOL FileExists(const CHXFileSpecifier& fileSpec); // returns TRUE only if exists & is a file
  63. static BOOL DirectoryExists(const CHXDirSpecifier& dirSpec); // returns TRUE only if exists & is a directory
  65. static HX_RESULT CreateDir(const CHXDirSpecifier& dirSpec);
  67. static HX_RESULT RemoveDir(const CHXDirSpecifier& dirSpec); // deletes an empty directory
  68. static HX_RESULT RemoveFile(const CHXFileSpecifier& fileSpec);
  70. #if defined(_MACINTOSH) || defined(_MAC_UNIX)
  71. // these should be implemented on other platforms too, eventually
  72. static HX_RESULT MakeFileReadOnly(const CHXFileSpecifier& fileSpec);
  73. static HX_RESULT MakeFileNotReadOnly(const CHXFileSpecifier& fileSpec);
  74. static HX_RESULT RenameMoveFile(CHXFileSpecifier& fileSpec, const char* pNewNameIfAny, const CHXDirSpecifier* pNewDirectoryIfAny);
  75. #endif
  77. // file read & write
  78. //
  79. // on Mac, the file spec may be updated when the file is written out, so it's not a const parameter
  81. static HX_RESULT ReadTextFile(const CHXFileSpecifier& fileSpec, CHXString& outStr);
  82. static HX_RESULT ReadBinaryFile(const CHXFileSpecifier& fileSpec, IHXBuffer*& pOutBuffer);
  84. static HX_RESULT WriteTextFile(CHXFileSpecifier& fileSpec, const CHXString& inStr, BOOL bReplaceExistingFile);
  85. static HX_RESULT WriteBinaryFile(CHXFileSpecifier& fileSpec, IHXBuffer* inBuffer, BOOL bReplaceExistingFile);
  88. // unique file name utilities
  89. //
  90. // These returns a file spec with a unique filename in the specified directory
  91. //
  92. // pszTemplate is of the form "filenameWILDCARD.ext", with the wildcard to
  93. //   be replaced by a 1-4 digit number greater than or equal to 2
  94. //   For example, "MyFile%%.txt" with the wildcard "%%" can become MyFile2.txt
  95. //
  96. // GetUniqueFileSpec checks if pszNameFirst is available and uses that; if the name
  97. //   is not available, it substitutes 2, 3, 4, etc. for the wildcard in the template
  98. //   to create a unique name.
  99. //   For example:  pszNameFirst="MyFile.txt" pszTemplate="MyFile_%%.txt" pszWildcard="%%"
  100. //
  101. // GetUniqueTempFileSpec tries with a random number initially, and increments that
  102. //   number until it has a unique name
  103. //
  104. // Note: all of these strings should come from resources to enable localizers to
  105. //       customize the creation of file names
  107. static CHXFileSpecifier GetUniqueFileSpec(const CHXDirSpecifier& locationSpec, 
  108. const char *pszNameFirst, 
  109. const char *pszTemplate, const char *pszWildcard);
  111. static CHXFileSpecifier GetUniqueTempFileSpec(const CHXDirSpecifier& locationSpec, 
  112. const char *pszTemplate, const char *pszWildcard);
  114. // temporary directory
  116. static CHXDirSpecifier GetSystemTempDirectory(void);
  118. // replace any illegal file/dir name characters; returns true if a change was made
  119. static BOOL MakeNameLegal(char *pszName);
  122. // application utilities
  124. static CHXFileSpecifier GetCurrentApplication(void);
  125. static CHXDirSpecifier GetCurrentApplicationDir(void);
  127. static CHXDirSpecifier GetAppDataDir(const char* szAppName);
  129. // Macintosh-specific utilities
  130. #if defined(_MACINTOSH) || defined(_MAC_UNIX)
  131. static FOURCC GetFileType(const CHXFileSpecifier& fileSpec);
  133. static CHXDirSpecifier MacFindFolder(short vRefNum, FolderType foldType);
  135. static CHXFileSpecifier SpecifyFileWithMacFindFolder(short vRefNum, FolderType foldType, const char *pszChildFile);
  136. static CHXDirSpecifier SpecifyFolderWithMacFindFolder(short vRefNum, FolderType foldType, const char *pszChildFolder);
  138. // Resolve will change the specifiers in place if they happened to point
  139. // to an alias file
  140. static HX_RESULT ResolveFileSpecifierAlias(CHXFileSpecifier& fileSpec);
  141. static HX_RESULT ResolveDirSpecifierAlias(CHXDirSpecifier& dirSpec);
  143. // MoveFileToTrash, MoveFolderToTrash
  145. // These move the file to the trash if possible, or else delete the file.
  147. static HX_RESULT MoveFileToTrash(const CHXFileSpecifier& fileSpec);
  148. static HX_RESULT MoveFolderToTrash(const CHXDirSpecifier& dirSpec);
  150. // MoveFileToCleaupAtStartup, MoveFolderToCleaupAtStartup
  152. // These move the file to the trash if possible, or else delete the file.
  153. // Non-const version updates the specifier after the file is moved
  155. static HX_RESULT MoveFileToCleanupAtStartup(const CHXFileSpecifier& fileSpec, BOOL bDeleteIfCantMove = TRUE);
  156. static HX_RESULT MoveFolderToCleanupAtStartup(const CHXDirSpecifier& dirSpec, BOOL bDeleteIfCantMove = TRUE);
  158. static HX_RESULT MoveFileToCleanupAtStartup(CHXFileSpecifier& fileSpec, BOOL bDeleteIfCantMove = TRUE);
  159. static HX_RESULT MoveFolderToCleanupAtStartup(CHXDirSpecifier& dirSpec, BOOL bDeleteIfCantMove = TRUE);
  161. // MoveFileToFolderWithRenaming, MoveFolderToFolderWithRenaming
  163. // These move the item to the target folder, renaming the item if necessary. For example,
  164. // if the file is called "filename" and the destination already has a "filename", the file
  165. // is renamed "filename_2".
  167. static HX_RESULT MoveFileToFolderWithRenaming(CHXFileSpecifier& fileSpec, const CHXDirSpecifier& targetSpec, BOOL bDeleteIfCantMove);
  168. static HX_RESULT MoveFolderToFolderWithRenaming(CHXDirSpecifier& dirSpec, const CHXDirSpecifier& targetSpec, BOOL bDeleteIfCantMove);
  170. #ifdef _DEBUG
  171. static void TestMacFileSpecUtils();
  172. #endif
  174. #endif // _MACINTOSH
  176. };
  178. #endif // FILESPECUTILS_H