extensions/common/constants.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 EXTENSIONS_COMMON_CONSTANTS_H_
   6 #define EXTENSIONS_COMMON_CONSTANTS_H_
   7
   8 #include "base/basictypes.h"
   9 #include "base/files/file_path.h"
  10 #include "ui/base/layout.h"
  11
  12 namespace extensions {
  13
  14 // Scheme we serve extension content from.
  15 extern const char kExtensionScheme[];
  16
  17 // Canonical schemes you can use as input to GURL.SchemeIs().
  18 extern const char kExtensionResourceScheme[];
  19
  20 // The name of the manifest inside an extension.
  21 extern const base::FilePath::CharType kManifestFilename[];
  22
  23 // The name of locale folder inside an extension.
  24 extern const base::FilePath::CharType kLocaleFolder[];
  25
  26 // The name of the messages file inside an extension.
  27 extern const base::FilePath::CharType kMessagesFilename[];
  28
  29 // The base directory for subdirectories with platform-specific code.
  30 extern const base::FilePath::CharType kPlatformSpecificFolder[];
  31
  32 // A directory reserved for metadata, generated either by the webstore
  33 // or chrome.
  34 extern const base::FilePath::CharType kMetadataFolder[];
  35
  36 // Name of the verified contents file within the metadata folder.
  37 extern const base::FilePath::CharType kVerifiedContentsFilename[];
  38
  39 // Name of the computed hashes file within the metadata folder.
  40 extern const base::FilePath::CharType kComputedHashesFilename[];
  41
  42 // The name of the directory inside the profile where extensions are
  43 // installed to.
  44 extern const char kInstallDirectoryName[];
  45
  46 // The name of a temporary directory to install an extension into for
  47 // validation before finalizing install.
  48 extern const char kTempExtensionName[];
  49
  50 // The file to write our decoded images to, relative to the extension_path.
  51 extern const char kDecodedImagesFilename[];
  52
  53 // The file to write our decoded message catalogs to, relative to the
  54 // extension_path.
  55 extern const char kDecodedMessageCatalogsFilename[];
  56
  57 // The filename to use for a background page generated from
  58 // background.scripts.
  59 extern const char kGeneratedBackgroundPageFilename[];
  60
  61 // Path to imported modules.
  62 extern const char kModulesDir[];
  63
  64 // The file extension (.crx) for extensions.
  65 extern const base::FilePath::CharType kExtensionFileExtension[];
  66
  67 // The file extension (.pem) for private key files.
  68 extern const base::FilePath::CharType kExtensionKeyFileExtension[];
  69
  70 // Default frequency for auto updates, if turned on.
  71 extern const int kDefaultUpdateFrequencySeconds;
  72
  73 // The name of the directory inside the profile where per-app local settings
  74 // are stored.
  75 extern const char kLocalAppSettingsDirectoryName[];
  76
  77 // The name of the directory inside the profile where per-extension local
  78 // settings are stored.
  79 extern const char kLocalExtensionSettingsDirectoryName[];
  80
  81 // The name of the directory inside the profile where per-app synced settings
  82 // are stored.
  83 extern const char kSyncAppSettingsDirectoryName[];
  84
  85 // The name of the directory inside the profile where per-extension synced
  86 // settings are stored.
  87 extern const char kSyncExtensionSettingsDirectoryName[];
  88
  89 // The name of the directory inside the profile where per-extension persistent
  90 // managed settings are stored.
  91 extern const char kManagedSettingsDirectoryName[];
  92
  93 // The name of the database inside the profile where chrome-internal
  94 // extension state resides.
  95 extern const char kStateStoreName[];
  96
  97 // The name of the database inside the profile where declarative extension
  98 // rules are stored.
  99 extern const char kRulesStoreName[];
 100
 101 // The URL query parameter key corresponding to multi-login user index.
 102 extern const char kAuthUserQueryKey[];
 103
 104 // Mime type strings
 105 extern const char kMimeTypeJpeg[];
 106 extern const char kMimeTypePng[];
 107
 108 // The extension id of the Web Store component application.
 109 extern const char kWebStoreAppId[];
 110
 111 // Enumeration of possible app launch sources.
 112 // Note the enumeration is used in UMA histogram so entries
 113 // should not be re-ordered or removed.
 114 enum AppLaunchSource {
 115   SOURCE_UNTRACKED = 0,  // Should be used in test.
 116   SOURCE_APP_LAUNCHER,
 117   SOURCE_NEW_TAB_PAGE,
 118   SOURCE_RELOAD,
 119   SOURCE_RESTART,
 120   SOURCE_LOAD_AND_LAUNCH,
 121   SOURCE_COMMAND_LINE,
 122   SOURCE_FILE_HANDLER,
 123   SOURCE_URL_HANDLER,
 124   SOURCE_SYSTEM_TRAY,
 125   SOURCE_ABOUT_PAGE,
 126   SOURCE_KEYBOARD,
 127   SOURCE_EXTENSIONS_PAGE,
 128   SOURCE_MANAGEMENT_API,
 129   SOURCE_EPHEMERAL_APP,
 130   SOURCE_BACKGROUND,
 131   SOURCE_KIOSK,
 132   SOURCE_CHROME_INTERNAL,
 133
 134   NUM_APP_LAUNCH_SOURCES
 135 };
 136
 137 // This enum is used for the launch type the user wants to use for an
 138 // application.
 139 // Do not remove items or re-order this enum as it is used in preferences
 140 // and histograms.
 141 enum LaunchType {
 142   LAUNCH_TYPE_INVALID = -1,
 143   LAUNCH_TYPE_FIRST = 0,
 144   LAUNCH_TYPE_PINNED = LAUNCH_TYPE_FIRST,
 145   LAUNCH_TYPE_REGULAR = 1,
 146   LAUNCH_TYPE_FULLSCREEN = 2,
 147   LAUNCH_TYPE_WINDOW = 3,
 148   NUM_LAUNCH_TYPES,
 149
 150   // Launch an app in the in the way a click on the NTP would,
 151   // if no user pref were set.  Update this constant to change
 152   // the default for the NTP and chrome.management.launchApp().
 153   LAUNCH_TYPE_DEFAULT = LAUNCH_TYPE_REGULAR
 154 };
 155
 156 // Don't remove items or change the order of this enum.  It's used in
 157 // histograms and preferences.
 158 enum LaunchContainer {
 159   LAUNCH_CONTAINER_WINDOW,
 160   LAUNCH_CONTAINER_PANEL,
 161   LAUNCH_CONTAINER_TAB,
 162   // For platform apps, which don't actually have a container (they just get a
 163   // "onLaunched" event).
 164   LAUNCH_CONTAINER_NONE
 165 };
 166
 167 }  // namespace extensions
 168
 169 namespace extension_misc {
 170
 171 // Matches chrome.windows.WINDOW_ID_NONE.
 172 const int kUnknownWindowId = -1;
 173
 174 // Matches chrome.windows.WINDOW_ID_CURRENT.
 175 const int kCurrentWindowId = -2;
 176
 177 // NOTE: If you change this list, you should also change kExtensionIconSizes
 178 // in cc file.
 179 enum ExtensionIcons {
 180   EXTENSION_ICON_GIGANTOR = 512,
 181   EXTENSION_ICON_EXTRA_LARGE = 256,
 182   EXTENSION_ICON_LARGE = 128,
 183   EXTENSION_ICON_MEDIUM = 48,
 184   EXTENSION_ICON_SMALL = 32,
 185   EXTENSION_ICON_SMALLISH = 24,
 186   EXTENSION_ICON_ACTION = 19,
 187   EXTENSION_ICON_BITTY = 16,
 188   EXTENSION_ICON_INVALID = 0,
 189 };
 190
 191 // List of sizes for extension icons that can be defined in the manifest.
 192 extern const int kExtensionIconSizes[];
 193 extern const size_t kNumExtensionIconSizes;
 194
 195 struct IconRepresentationInfo {
 196   // Size in pixels.
 197   const int size;
 198   // Size as a string that will be used to retrieve representation value from
 199   // ExtensionAction SetIcon function arguments.
 200   const char* const size_string;
 201   // Scale factor for which the representation should be used.
 202   const ui::ScaleFactor scale;
 203 };
 204
 205 // The icon representations for extension actions.
 206 extern const IconRepresentationInfo kExtensionActionIconSizes[];
 207 const size_t kNumExtensionActionIconSizes = 2u;
 208
 209 }  // namespace extension_misc
 210
 211 #endif  // EXTENSIONS_COMMON_CONSTANTS_H_