filespec.h
上传用户:zhongxx05
上传日期:2007-06-06
资源大小:33641k
文件大小:8k
源码类别:

Symbian

开发平台:

C/C++

  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 ***** */ 
  35. #ifndef FILESPEC_H
  36. #define FILESPEC_H
  37. // include the platform-specific private data types
  38. #if defined(_MAC_UNIX)
  39. #include "platform/mac/filespecmac_carbon.h"
  40. #elif defined(_MACINTOSH)
  41. #ifdef _CARBON
  42. #include "platform/mac/filespecmac_carbon.h"
  43. #else
  44. #include "platform/mac/filespecmac.h"
  45. #endif
  46. #elif defined(_WINDOWS) || defined(_SYMBIAN)
  47. #include "platform/win/filespecwin.h"
  48. #elif defined _UNIX
  49. #include "platform/unix/filespecunix.h"
  50. #elif defined(_OPENWAVE)
  51. #include "platform/openwave/filespecopwave.h"
  52. #else
  53. #error implement for this platform
  54. #endif
  55. #include "hxstring.h"
  56. class CHXDirSpecifier; // forward declaration
  57. class CHXFileSpecifier // file specifier
  58. {
  59. public:
  60. // constructors
  61. CHXFileSpecifier();
  62. CHXFileSpecifier(const char* psz); // path in C-string
  63. CHXFileSpecifier(const CHXString &str);     // to fix a compile-time ambiguity coercing CHXStrings
  64. CHXFileSpecifier(const CHXFileSpecifier &other);
  65. ~CHXFileSpecifier();
  66. CHXFileSpecifier &operator=(const CHXFileSpecifier &other);
  67. CHXFileSpecifier &operator=(const char *other);
  68. CHXFileSpecifier &operator=(const CHXString& str);
  69. BOOL operator==(const CHXFileSpecifier &other);
  70. BOOL operator!=(const CHXFileSpecifier &other);
  71. void Unset();
  72. // accessors
  73. BOOL IsSet() const; // object has been set to a file (which may or may not exist)
  74. // moving up or down the tree
  75. CHXDirSpecifier GetParentDirectory() const;
  76. CHXDirSpecifier GetVolume() const; // get a specifier for the disk
  77. // display & paths
  78. CHXString GetName() const;   // get the file's name and extension (not path) like 'Foo.txt'
  79. CHXString GetTitle() const;  // gets the file's name (w/o extension)
  80. CHXString GetPathName() const;
  81. CHXString GetURL() const;
  82. CHXString GetExtension() const; // returns whatever is after the last dot, not including the dot
  83. // persistent string can be saved to preferences or
  84. // handed to another library
  85. CHXString GetPersistentString() const;
  86. HX_RESULT SetFromPersistentString(const char *pBuffer);
  87. HX_RESULT SetFromURL(const char *pBuffer);
  88. #if defined(_MACINTOSH) || defined(_MAC_UNIX)
  89. CHXFileSpecifier(const FSSpec &file); // Mac-specific
  90. CHXFileSpecifier(AliasHandle alias);
  91. CHXString GetRelativePersistentString(const CHXFileSpecifier& fromFileSpec) const;
  92. operator FSSpec() const;
  93. operator FSSpec*() const;
  94. #if defined(_CARBON) || defined(_MAC_UNIX)
  95. CHXFileSpecifier(const FSRef &ref);
  96. operator FSRef() const;
  97. operator FSRef*() const;
  98. CHXString GetPOSIXPath() const;
  99. HX_RESULT SetFromPOSIXPath(const char *pPosixPath);
  100. CHXString GetHFSPath() const;
  101. HX_RESULT SetFromHFSPath(const char *pHFSPath);
  102. HFSUniStr255 GetNameHFSUniStr255() const;
  103. FSVolumeRefNum GetVRefNum() const;
  104. friend class CHXDirSpecifier;
  105. #endif
  106. #endif
  107. private:
  108. // private data is platform-specific
  109. #if defined(_MACINTOSH) || defined(_MAC_UNIX)
  110. #if defined(_CARBON) || defined(_MAC_UNIX)
  111. CHXMacInternalSpec m_MacInternalSpec;
  112. mutable FSSpec* m_pTempSpec; // for (FSSpec*) only
  113. mutable FSRef* m_pTempRef; // for (FSRef*) only
  114. #else
  115. CAliasHandler m_macentity;
  116. mutable FSSpec* m_pTempSpec; // for (FSSpec*) only
  117. mutable void* m_pTempRef; 
  118. #endif
  119. #elif defined( _WINDOWS ) || defined( _UNIX ) || defined(_SYMBIAN)
  120. CHXPathParser m_parser;
  121. #endif
  122. };
  123. class CHXDirSpecifier // directory specifier
  124. {
  125. public:
  126. // constructors
  127. CHXDirSpecifier();
  128. CHXDirSpecifier(const char* psz); // path in C-string
  129. CHXDirSpecifier(const CHXString& str);     // to fix a compile-time ambiguity coercing CHXStrings
  130. CHXDirSpecifier(const CHXDirSpecifier &other);
  131. ~CHXDirSpecifier();
  132. CHXDirSpecifier &operator=(const CHXDirSpecifier& other);
  133. CHXDirSpecifier &operator=(const char *other);
  134. CHXDirSpecifier &operator=(const CHXString& str);
  135. BOOL operator==(const CHXDirSpecifier &other);
  136. BOOL operator!=(const CHXDirSpecifier &other);
  137. void Unset();
  138. // accessors
  139. BOOL IsVolume() const; // specifies a disk (or root directory)
  140. BOOL  IsSet() const; // object has been set to a directory (which may or may not exist)
  141. CHXString GetName() const;   // get the directory name
  142. // moving up or down the tree
  143. CHXDirSpecifier GetParentDirectory() const;
  144. CHXDirSpecifier GetVolume() const; // get a specifier for the disk
  145. // get specifiers for file or directory inside this one
  146. CHXFileSpecifier SpecifyChildFile(const char *child) const;
  147. CHXDirSpecifier SpecifyChildDirectory(const char *child) const;
  148. // display & paths
  149. CHXString GetPathName() const;
  150. CHXString GetURL() const;
  151. HX_RESULT SetFromURL(const char *pBuffer);
  152. // persistent string can be saved to preferences or
  153. // handed to another library
  154. CHXString GetPersistentString() const;
  155. HX_RESULT SetFromPersistentString(const char *pBuffer);
  156. #if defined(_MACINTOSH) || defined(_MAC_UNIX)
  157. // Mac-specific
  158. CHXDirSpecifier(const FSSpec &folder); // Mac-specific
  159. CHXDirSpecifier(AliasHandle dirAlias); // Mac-specific
  160. CHXFileSpecifier SpecifyChildFileStr255(ConstStr255Param child) const;
  161. CHXDirSpecifier SpecifyChildDirectoryStr255(ConstStr255Param child) const;
  162. long GetDirID() const;
  163. operator FSSpec() const; // note the parID is the folder's
  164. operator FSSpec*() const; //   parent's dirID, not the folder's dirID
  165. #if defined(_CARBON) || defined(_MAC_UNIX)
  166. CHXFileSpecifier SpecifyChildFileHFSUniStr255(HFSUniStr255 hfsUni) const;
  167. CHXDirSpecifier SpecifyChildDirectoryHFSUniStr255(HFSUniStr255 hfsUni) const;
  168. HFSUniStr255 GetNameHFSUniStr255() const;
  169. FSVolumeRefNum GetVRefNum() const;
  170. CHXDirSpecifier(const FSRef &ref); // Mac-specific
  171. operator FSRef() const;
  172. operator FSRef*() const;
  173. CHXString GetPOSIXPath() const;
  174. HX_RESULT SetFromPOSIXPath(const char *pPosixPath);
  175. CHXString GetHFSPath() const;
  176. HX_RESULT SetFromHFSPath(const char *pHFSPath);
  177. #endif
  178. #endif
  179. private:
  180. // private data is platform-specific
  181. #if defined(_MACINTOSH) || defined(_MAC_UNIX)
  182. #if defined(_CARBON) || defined(_MAC_UNIX)
  183. CHXMacInternalSpec m_MacInternalSpec;
  184. mutable FSSpec* m_pTempSpec; // for (FSSpec*) only
  185. mutable FSRef* m_pTempRef; // for (FSRef*) only
  186. #else
  187. CAliasHandler m_macentity;
  188. mutable FSSpec* m_pTempSpec; // for (FSSpec*) only
  189. mutable void* m_pTempRef; 
  190. #endif
  191. #ifndef USE_FSREFS
  192.         static OSErr FSpGetDirectoryID(const FSSpec *spec, long *theDirID, Boolean *isDirectory);
  193. #endif
  194. #elif defined( _WINDOWS ) || defined( _UNIX ) || defined(_SYMBIAN)
  195. CHXPathParser m_parser;
  196. #endif
  197. };
  198. #endif // FILESPEC_H