lldir.h
上传用户:king477883
上传日期:2021-03-01
资源大小:9553k
文件大小:9k
源码类别:

游戏引擎

开发平台:

C++ Builder

  1. /** 
  2.  * @file lldir.h
  3.  * @brief Definition of directory utilities class
  4.  *
  5.  * $LicenseInfo:firstyear=2000&license=viewergpl$
  6.  * 
  7.  * Copyright (c) 2000-2010, Linden Research, Inc.
  8.  * 
  9.  * Second Life Viewer Source Code
  10.  * The source code in this file ("Source Code") is provided by Linden Lab
  11.  * to you under the terms of the GNU General Public License, version 2.0
  12.  * ("GPL"), unless you have obtained a separate licensing agreement
  13.  * ("Other License"), formally executed by you and Linden Lab.  Terms of
  14.  * the GPL can be found in doc/GPL-license.txt in this distribution, or
  15.  * online at http://secondlifegrid.net/programs/open_source/licensing/gplv2
  16.  * 
  17.  * There are special exceptions to the terms and conditions of the GPL as
  18.  * it is applied to this Source Code. View the full text of the exception
  19.  * in the file doc/FLOSS-exception.txt in this software distribution, or
  20.  * online at
  21.  * http://secondlifegrid.net/programs/open_source/licensing/flossexception
  22.  * 
  23.  * By copying, modifying or distributing this software, you acknowledge
  24.  * that you have read and understood your obligations described above,
  25.  * and agree to abide by those obligations.
  26.  * 
  27.  * ALL LINDEN LAB SOURCE CODE IS PROVIDED "AS IS." LINDEN LAB MAKES NO
  28.  * WARRANTIES, EXPRESS, IMPLIED OR OTHERWISE, REGARDING ITS ACCURACY,
  29.  * COMPLETENESS OR PERFORMANCE.
  30.  * $/LicenseInfo$
  31.  */
  32. #ifndef LL_LLDIR_H
  33. #define LL_LLDIR_H
  34. #if LL_SOLARIS
  35. #include <sys/param.h>
  36. #define MAX_PATH MAXPATHLEN
  37. #endif
  38. // these numbers *may* get serialized (really??), so we need to be explicit
  39. typedef enum ELLPath
  40. {
  41. LL_PATH_NONE = 0,
  42. LL_PATH_USER_SETTINGS = 1,
  43. LL_PATH_APP_SETTINGS = 2,
  44. LL_PATH_PER_SL_ACCOUNT = 3, // returns/expands to blank string if we don't know the account name yet
  45. LL_PATH_CACHE = 4,
  46. LL_PATH_CHARACTER = 5,
  47. LL_PATH_HELP = 6,
  48. LL_PATH_LOGS = 7,
  49. LL_PATH_TEMP = 8,
  50. LL_PATH_SKINS = 9,
  51. LL_PATH_TOP_SKIN = 10,
  52. LL_PATH_CHAT_LOGS = 11,
  53. LL_PATH_PER_ACCOUNT_CHAT_LOGS = 12,
  54. LL_PATH_USER_SKIN = 14,
  55. LL_PATH_LOCAL_ASSETS = 15,
  56. LL_PATH_EXECUTABLE = 16,
  57. LL_PATH_DEFAULT_SKIN = 17,
  58. LL_PATH_FONTS = 18,
  59. LL_PATH_LAST
  60. } ELLPath;
  61. class LLDir
  62. {
  63.  public:
  64. LLDir();
  65. virtual ~LLDir();
  66. // app_name - Usually SecondLife, used for creating settings directories
  67. // in OS-specific location, such as C:Documents and Settings
  68. // app_read_only_data_dir - Usually the source code directory, used
  69. // for test applications to read newview data files.
  70. virtual void initAppDirs(const std::string &app_name, 
  71. const std::string& app_read_only_data_dir = "") = 0;
  72. virtual S32 deleteFilesInDir(const std::string &dirname, const std::string &mask);
  73. // pure virtual functions
  74. virtual U32 countFilesInDir(const std::string &dirname, const std::string &mask) = 0;
  75. virtual BOOL getNextFileInDir(const std::string &dirname, const std::string &mask, std::string &fname, BOOL wrap) = 0;
  76. virtual void getRandomFileInDir(const std::string &dirname, const std::string &mask, std::string &fname) = 0;
  77. virtual std::string getCurPath() = 0;
  78. virtual BOOL fileExists(const std::string &filename) const = 0;
  79. const std::string findFile(const std::string& filename, const std::vector<std::string> filenames) const; 
  80. const std::string findFile(const std::string& filename, const std::string& searchPath1 = "", const std::string& searchPath2 = "", const std::string& searchPath3 = "") const;
  81. virtual std::string getLLPluginLauncher() = 0; // full path and name for the plugin shell
  82. virtual std::string getLLPluginFilename(std::string base_name) = 0; // full path and name to the plugin DSO for this base_name (i.e. 'FOO' -> '/bar/baz/libFOO.so')
  83. const std::string &getExecutablePathAndName() const; // Full pathname of the executable
  84. const std::string &getAppName() const; // install directory under progams/ ie "SecondLife"
  85. const std::string &getExecutableDir() const; // Directory where the executable is located
  86. const std::string &getExecutableFilename() const;// Filename of .exe
  87. const std::string &getWorkingDir() const; // Current working directory
  88. const std::string &getAppRODataDir() const; // Location of read-only data files
  89. const std::string &getOSUserDir() const; // Location of the os-specific user dir
  90. const std::string &getOSUserAppDir() const; // Location of the os-specific user app dir
  91. const std::string &getLindenUserDir() const; // Location of the Linden user dir.
  92. const std::string &getChatLogsDir() const; // Location of the chat logs dir.
  93. const std::string &getPerAccountChatLogsDir() const; // Location of the per account chat logs dir.
  94. const std::string &getTempDir() const; // Common temporary directory
  95. const std::string  getCacheDir(bool get_default = false) const; // Location of the cache.
  96. const std::string &getOSCacheDir() const; // location of OS-specific cache folder (may be empty string)
  97. const std::string &getCAFile() const; // File containing TLS certificate authorities
  98. const std::string &getDirDelimiter() const; // directory separator for platform (ie. '' or '/' or ':')
  99. const std::string &getSkinDir() const; // User-specified skin folder.
  100. const std::string &getUserSkinDir() const; // User-specified skin folder with user modifications. e.g. c:documents and settingsusernameapplication datasecond lifeskinscurskin
  101. const std::string &getDefaultSkinDir() const; // folder for default skin. e.g. c:program filessecond lifeskinsdefault
  102. const std::string getSkinBaseDir() const; // folder that contains all installed skins (not user modifications). e.g. c:program filessecond lifeskins
  103. const std::string &getLLPluginDir() const; // Directory containing plugins and plugin shell
  104. // Expanded filename
  105. std::string getExpandedFilename(ELLPath location, const std::string &filename) const;
  106. std::string getExpandedFilename(ELLPath location, const std::string &subdir, const std::string &filename) const;
  107. std::string getExpandedFilename(ELLPath location, const std::string &subdir1, const std::string &subdir2, const std::string &filename) const;
  108. // Base and Directory name extraction
  109. std::string getBaseFileName(const std::string& filepath, bool strip_exten = false) const;
  110. std::string getDirName(const std::string& filepath) const;
  111. std::string getExtension(const std::string& filepath) const; // Excludes '.', e.g getExtension("foo.wav") == "wav"
  112. // these methods search the various skin paths for the specified file in the following order:
  113. // getUserSkinDir(), getSkinDir(), getDefaultSkinDir()
  114. std::string findSkinnedFilename(const std::string &filename) const;
  115. std::string findSkinnedFilename(const std::string &subdir, const std::string &filename) const;
  116. std::string findSkinnedFilename(const std::string &subdir1, const std::string &subdir2, const std::string &filename) const;
  117. // random filename in common temporary directory
  118. std::string getTempFilename() const;
  119. // For producing safe download file names from potentially unsafe ones
  120. static std::string getScrubbedFileName(const std::string uncleanFileName);
  121. static std::string getForbiddenFileChars();
  122. virtual void setChatLogsDir(const std::string &path); // Set the chat logs dir to this user's dir
  123. virtual void setPerAccountChatLogsDir(const std::string &first, const std::string &last); // Set the per user chat log directory.
  124. virtual void setLindenUserDir(const std::string &first, const std::string &last); // Set the linden user dir to this user's dir
  125. virtual void setSkinFolder(const std::string &skin_folder);
  126. virtual bool setCacheDir(const std::string &path);
  127. virtual void dumpCurrentDirectories();
  128. // Utility routine
  129. std::string buildSLOSCacheDir() const;
  130. protected:
  131. std::string mAppName;               // install directory under progams/ ie "SecondLife"   
  132. std::string mExecutablePathAndName; // full path + Filename of .exe
  133. std::string mExecutableFilename;    // Filename of .exe
  134. std::string mExecutableDir;    // Location of executable
  135. std::string mWorkingDir;    // Current working directory
  136. std::string mAppRODataDir;  // Location for static app data
  137. std::string mOSUserDir;  // OS Specific user directory
  138. std::string mOSUserAppDir;  // OS Specific user app directory
  139. std::string mLindenUserDir;  // Location for Linden user-specific data
  140. std::string mPerAccountChatLogsDir;  // Location for chat logs.
  141. std::string mChatLogsDir;  // Location for chat logs.
  142. std::string mCAFile;  // Location of the TLS certificate authority PEM file.
  143. std::string mTempDir;
  144. std::string mCacheDir; // cache directory as set by user preference
  145. std::string mDefaultCacheDir; // default cache diretory
  146. std::string mOSCacheDir; // operating system cache dir
  147. std::string mDirDelimiter;
  148. std::string mSkinBaseDir; // Base for skins paths.
  149. std::string mSkinDir; // Location for current skin info.
  150. std::string mDefaultSkinDir; // Location for default skin info.
  151. std::string mUserSkinDir; // Location for user-modified skin info.
  152. std::string mLLPluginDir; // Location for plugins and plugin shell
  153. };
  154. void dir_exists_or_crash(const std::string &dir_name);
  155. extern LLDir *gDirUtilp;
  156. #endif // LL_LLDIR_H