chrome/common/chrome_paths.h

   1 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #ifndef CHROME_COMMON_CHROME_PATHS_H__
   6 #define CHROME_COMMON_CHROME_PATHS_H__
   7
   8 #include "build/build_config.h"
   9
  10 namespace base {
  11 class FilePath;
  12 }
  13
  14 // This file declares path keys for the chrome module.  These can be used with
  15 // the PathService to access various special directories and files.
  16
  17 namespace chrome {
  18
  19 enum {
  20   PATH_START = 1000,
  21
  22   DIR_APP = PATH_START,         // Directory where dlls and data reside.
  23   DIR_LOGS,                     // Directory where logs should be written.
  24   DIR_USER_DATA,                // Directory where user data can be written.
  25   DIR_CRASH_DUMPS,              // Directory where crash dumps are written.
  26 #if defined(OS_WIN)
  27   DIR_WATCHER_DATA,             // Directory where the Chrome watcher stores
  28                                 // data.
  29 #endif
  30   DIR_RESOURCES,                // Directory containing separate file resources
  31                                 // used by Chrome at runtime.
  32   DIR_INSPECTOR,                // Directory where web inspector is located.
  33   DIR_APP_DICTIONARIES,         // Directory where the global dictionaries are.
  34   DIR_USER_DOCUMENTS,           // Directory for a user's "My Documents".
  35   DIR_USER_MUSIC,               // Directory for a user's music.
  36   DIR_USER_PICTURES,            // Directory for a user's pictures.
  37   DIR_USER_VIDEOS,              // Directory for a user's videos.
  38   DIR_DEFAULT_DOWNLOADS_SAFE,   // Directory for a user's
  39                                 // "My Documents/Downloads", (Windows) or
  40                                 // "Downloads". (Linux)
  41   DIR_DEFAULT_DOWNLOADS,        // Directory for a user's downloads.
  42   DIR_INTERNAL_PLUGINS,         // Directory where internal plugins reside.
  43 #if defined(OS_POSIX) && !defined(OS_MACOSX)
  44   DIR_POLICY_FILES,             // Directory for system-wide read-only
  45                                 // policy files that allow sys-admins
  46                                 // to set policies for chrome. This directory
  47                                 // contains subdirectories.
  48 #endif
  49 #if defined(OS_MACOSX) && !defined(OS_IOS)
  50   DIR_USER_APPLICATIONS,        // ~/Applications
  51   DIR_USER_LIBRARY,             // ~/Library
  52 #endif
  53 #if defined(OS_CHROMEOS) || (defined(OS_LINUX) && defined(CHROMIUM_BUILD)) || \
  54     (defined(OS_MACOSX) && !defined(OS_IOS))
  55   DIR_USER_EXTERNAL_EXTENSIONS,  // Directory for per-user external extensions
  56                                  // on Chrome Mac and Chromium Linux.
  57                                  // On Chrome OS, this path is used for OEM
  58                                  // customization. Getting this path does not
  59                                  // create it.
  60 #endif
  61
  62 #if defined(OS_LINUX)
  63   DIR_STANDALONE_EXTERNAL_EXTENSIONS,  // Directory for 'per-extension'
  64                                        // definition manifest files that
  65                                        // describe extensions which are to be
  66                                        // installed when chrome is run.
  67 #endif
  68   DIR_EXTERNAL_EXTENSIONS,      // Directory where installer places .crx files.
  69
  70   DIR_DEFAULT_APPS,             // Directory where installer places .crx files
  71                                 // to be installed when chrome is first run.
  72   DIR_PEPPER_FLASH_PLUGIN,      // Directory to the bundled Pepper Flash plugin,
  73                                 // containing the plugin and the manifest.
  74   DIR_COMPONENT_UPDATED_PEPPER_FLASH_PLUGIN,  // Base directory of the Pepper
  75                                               // Flash plugins downloaded by the
  76                                               // component updater.
  77   FILE_RESOURCE_MODULE,         // Full path and filename of the module that
  78                                 // contains embedded resources (version,
  79                                 // strings, images, etc.).
  80   FILE_LOCAL_STATE,             // Path and filename to the file in which
  81                                 // machine/installation-specific state is saved.
  82   FILE_RECORDED_SCRIPT,         // Full path to the script.log file that
  83                                 // contains recorded browser events for
  84                                 // playback.
  85   FILE_PEPPER_FLASH_PLUGIN,     // Full path to the bundled Pepper Flash plugin
  86                                 // file.
  87   FILE_PEPPER_FLASH_SYSTEM_PLUGIN,  // Full path to the system version of the
  88                                     // Pepper Flash plugin, downloadable from
  89                                     // Adobe website. Querying this path might
  90                                     // succeed no matter the file exists or not.
  91   FILE_FLASH_SYSTEM_PLUGIN,     // Full path to the system version of NPAPI
  92                                 // Flash plugin, downloadable from Adobe
  93                                 // website. Querying this path might succeed no
  94                                 // matter the file exists or not.
  95   FILE_NACL_PLUGIN,             // Full path to the internal NaCl plugin file.
  96   DIR_PNACL_BASE,               // Full path to the base dir for PNaCl.
  97   DIR_PNACL_COMPONENT,          // Full path to the latest PNaCl version
  98                                 // (subdir of DIR_PNACL_BASE).
  99   DIR_COMPONENT_WIDEVINE_CDM,   // Directory that contains component-updated
 100                                 // Widevine CDM files.
 101   FILE_WIDEVINE_CDM_ADAPTER,    // Full path to the Widevine CDM adapter file.
 102   FILE_RESOURCES_PACK,          // Full path to the .pak file containing
 103                                 // binary data (e.g., html files and images
 104                                 // used by internal pages).
 105   DIR_RESOURCES_EXTENSION,      // Full path to extension resources.
 106 #if defined(OS_CHROMEOS)
 107   DIR_CHROMEOS_WALLPAPERS,      // Directory where downloaded chromeos
 108                                 // wallpapers reside.
 109   DIR_CHROMEOS_WALLPAPER_THUMBNAILS,  // Directory where downloaded chromeos
 110                                       // wallpaper thumbnails reside.
 111   DIR_CHROMEOS_CUSTOM_WALLPAPERS,     // Directory where custom wallpapers
 112                                       // reside.
 113 #endif
 114   DIR_SUPERVISED_USERS_DEFAULT_APPS,  // Directory where installer places .crx
 115                                       // files to be installed when managed user
 116                                       // session starts.
 117   DIR_SUPERVISED_USER_INSTALLED_WHITELISTS,  // Directory where sanitized
 118                                              // supervised user whitelists are
 119                                              // installed.
 120 #if defined(OS_LINUX) || (defined(OS_MACOSX) && !defined(OS_IOS))
 121   DIR_NATIVE_MESSAGING,         // System directory where native messaging host
 122                                 // manifest files are stored.
 123   DIR_USER_NATIVE_MESSAGING,    // Directory with Native Messaging Hosts
 124                                 // installed per-user.
 125 #endif
 126 #if !defined(OS_ANDROID)
 127   DIR_GLOBAL_GCM_STORE,         // Directory where the global GCM instance
 128                                 // stores its data.
 129 #endif
 130 #if defined(OS_ANDROID)
 131   DIR_OFFLINE_PAGE_METADATA,    // Directory where offline page metadata is
 132                                 // stored.
 133 #endif
 134
 135   // Valid only in development environment; TODO(darin): move these
 136   DIR_GEN_TEST_DATA,            // Directory where generated test data resides.
 137   DIR_TEST_DATA,                // Directory where unit test data resides.
 138   DIR_TEST_TOOLS,               // Directory where unit test tools reside.
 139 #if defined(OS_LINUX)
 140   FILE_COMPONENT_FLASH_HINT,    // A file in a known location that points to
 141                                 // the component updated flash plugin.
 142 #endif // defined(OS_LINUX)
 143
 144   PATH_END
 145 };
 146
 147 // Call once to register the provider for the path keys defined above.
 148 void RegisterPathProvider();
 149
 150 // Get or set the invalid user data dir that was originally specified.
 151 void SetInvalidSpecifiedUserDataDir(const base::FilePath& user_data_dir);
 152 const base::FilePath& GetInvalidSpecifiedUserDataDir();
 153
 154 }  // namespace chrome
 155
 156 #endif  // CHROME_COMMON_CHROME_PATHS_H__