chrome/browser/character_encoding.h

   1 // Copyright (c) 2006-2008 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_BROWSER_CHARACTER_ENCODING_H_
   6 #define CHROME_BROWSER_CHARACTER_ENCODING_H_
   7
   8 #include <string>
   9 #include <vector>
  10
  11 #include "base/basictypes.h"
  12 #include "base/strings/string16.h"
  13
  14 class CharacterEncoding {
  15  public:
  16   // Enumeration of the types of Browser encoding name we
  17   // currently support. This is defined outside of Browser
  18   // to avoid cyclical dependencies.
  19
  20   // Structure to save encoding information.
  21   struct EncodingInfo {
  22     explicit EncodingInfo(int id);
  23     // Gets string key of EncodingInfo. With this method, we can use
  24     // l10n_util::SortVectorWithStringKey to sort the encoding menu items
  25     // by current locale character sequence. We need to keep the order within
  26     // encoding category name, that's why we use category name as key.
  27     const base::string16& GetStringKey() const { return encoding_category_name; }
  28
  29     // Encoding command id.
  30     int encoding_id;
  31     // Encoding display name.
  32     base::string16 encoding_display_name;
  33     // Encoding category name.
  34     base::string16 encoding_category_name;
  35   };
  36
  37   // Return canonical encoding name according to the command ID.
  38   // THIS FUNCTION IS NOT THREADSAFE. You must run this function
  39   // only in UI thread.
  40   static std::string GetCanonicalEncodingNameByCommandId(int id);
  41
  42   // Return display name of canonical encoding according to the command
  43   // ID. THIS FUNCTION IS NOT THREADSAFE. You must run this function
  44   // only in UI thread.
  45   static base::string16 GetCanonicalEncodingDisplayNameByCommandId(int id);
  46
  47   // Return count number of all supported canonical encoding.
  48   static int GetSupportCanonicalEncodingCount();
  49
  50   // Return canonical encoding name according to the index, which starts
  51   // from zero to GetSupportCanonicalEncodingCount() - 1. THIS FUNCTION
  52   // IS NOT THREADSAFE. You must run this function only in UI thread.
  53   static std::string GetCanonicalEncodingNameByIndex(int index);
  54
  55   // Return display name of canonical encoding according to the index,
  56   // which starts from zero to GetSupportCanonicalEncodingCount() - 1.
  57   // THIS FUNCTION IS NOT THREADSAFE. You must run this function
  58   // only in UI thread.
  59   static base::string16 GetCanonicalEncodingDisplayNameByIndex(int index);
  60
  61   // Return encoding command id according to the index, which starts from
  62   // zero to GetSupportCanonicalEncodingCount() - 1. Otherwise returns 0.
  63   static int GetEncodingCommandIdByIndex(int index);
  64
  65   // Return canonical encoding name according to the encoding alias name. THIS
  66   // FUNCTION IS NOT THREADSAFE. You must run this function only in UI thread.
  67   static std::string GetCanonicalEncodingNameByAliasName(
  68       const std::string& alias_name);
  69
  70   // Returns the pointer of a vector of EncodingInfos corresponding to
  71   // encodings to display in the encoding menu. The locale-dependent static
  72   // encodings come at the top of the list and recently selected encodings
  73   // come next. Finally, the rest of encodings are listed.
  74   // The vector will be created and destroyed by CharacterEncoding.
  75   // The returned std::vector is maintained by this class. The parameter
  76   // |locale| points to the current application (UI) locale. The parameter
  77   // |locale_encodings| is string of static encodings list which is from the
  78   // corresponding string resource that is stored in the resource bundle.
  79   // The parameter |recently_select_encodings| is string of encoding list which
  80   // is from user recently selected. THIS FUNCTION IS NOT THREADSAFE. You must
  81   // run this function only in UI thread.
  82   static const std::vector<EncodingInfo>* GetCurrentDisplayEncodings(
  83       const std::string& locale,
  84       const std::string& locale_encodings,
  85       const std::string& recently_select_encodings);
  86
  87   // This function is for updating |original_selected_encoding_list| with a
  88   // |new_selected_encoding_id|. If the encoding is already in the original
  89   // list, then returns false. Otherwise |selected_encoding_list| will return a
  90   // new string for user selected encoding short list and function returns true.
  91   static bool UpdateRecentlySelectedEncoding(
  92       const std::string& original_selected_encodings,
  93       int new_selected_encoding_id,
  94       std::string* selected_encodings);
  95
  96   // Get encoding command id according to input encoding name. If the name is
  97   // valid, return corresponding encoding command id. Otherwise return 0;
  98   static int GetCommandIdByCanonicalEncodingName(
  99       const std::string& encoding_name);
 100
 101  private:
 102   // Disallow instantiating it since this class only contains static methods.
 103   DISALLOW_IMPLICIT_CONSTRUCTORS(CharacterEncoding);
 104 };
 105
 106 #endif  // CHROME_BROWSER_CHARACTER_ENCODING_H_