chrome/common/channel_info.h

   1 // Copyright (c) 2011 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_CHANNEL_INFO_H_
   6 #define CHROME_COMMON_CHANNEL_INFO_H_
   7
   8 #include <string>
   9
  10 namespace version_info {
  11 enum class Channel;
  12 }
  13
  14 namespace chrome {
  15
  16 // Returns a version string to be displayed in "About Chromium" dialog.
  17 std::string GetVersionString();
  18
  19 // Returns a human-readable modifier for the version string. For a branded
  20 // build, this modifier is the channel ("canary", "dev", or "beta", but ""
  21 // for stable). On Windows, this may be modified with additional information
  22 // after a hyphen. For multi-user installations, it will return "canary-m",
  23 // "dev-m", "beta-m", and for a stable channel multi-user installation, "m".
  24 // In branded builds, when the channel cannot be determined, "unknown" will
  25 // be returned. In unbranded builds, the modifier is usually an empty string
  26 // (""), although on Linux, it may vary in certain distributions.
  27 // GetChannelString() is intended to be used for display purposes.
  28 // To simply test the channel, use GetChannel().
  29 std::string GetChannelString();
  30
  31 // Returns the channel for the installation. In branded builds, this will be
  32 // version_info::Channel::{STABLE,BETA,DEV,CANARY}. In unbranded builds, or
  33 // in branded builds when the channel cannot be determined, this will be
  34 // version_info::Channel::UNKNOWN.
  35 version_info::Channel GetChannel();
  36
  37 #if defined(OS_CHROMEOS)
  38 // Sets channel before use.
  39 void SetChannel(const std::string& channel);
  40 #endif
  41
  42 }  // namespace chrome
  43
  44 #endif  // CHROME_COMMON_CHANNEL_INFO_H_