chrome/browser/ui/autofill/data_model_wrapper.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_BROWSER_UI_AUTOFILL_DATA_MODEL_WRAPPER_H_
   6 #define CHROME_BROWSER_UI_AUTOFILL_DATA_MODEL_WRAPPER_H_
   7
   8 #include <vector>
   9
  10 #include "base/compiler_specific.h"
  11 #include "base/strings/string16.h"
  12 #include "chrome/browser/ui/autofill/autofill_dialog_types.h"
  13 #include "components/autofill/content/browser/wallet/wallet_items.h"
  14 #include "components/autofill/core/browser/detail_input.h"
  15 #include "components/autofill/core/browser/field_types.h"
  16 #include "components/autofill/core/browser/form_structure.h"
  17
  18 namespace gfx {
  19 class Image;
  20 }
  21
  22 namespace i18n {
  23 namespace addressinput {
  24 struct AddressData;
  25 }
  26 }
  27
  28 namespace autofill {
  29
  30 class AutofillDataModel;
  31 class AutofillProfile;
  32 class AutofillType;
  33 class CreditCard;
  34 class FormStructure;
  35
  36 namespace wallet {
  37 class Address;
  38 class FullWallet;
  39 }
  40
  41 // A glue class that allows uniform interactions with autocomplete data sources,
  42 // regardless of their type. Implementations are intended to be lightweight and
  43 // copyable, only holding weak references to their backing model.
  44 class DataModelWrapper {
  45  public:
  46   virtual ~DataModelWrapper();
  47
  48   // Fills in |inputs| with the data that this model contains (|inputs| is an
  49   // out-param).
  50   void FillInputs(DetailInputs* inputs);
  51
  52   // Returns the data for a specific autocomplete type in a format for filling
  53   // into a web form.
  54   virtual base::string16 GetInfo(const AutofillType& type) const = 0;
  55
  56   // Returns the data for a specified type in a format optimized for displaying
  57   // to the user.
  58   virtual base::string16 GetInfoForDisplay(const AutofillType& type) const;
  59
  60   // Returns the icon, if any, that represents this model.
  61   virtual gfx::Image GetIcon();
  62
  63   // Gets text to display to the user to summarize this data source. The
  64   // default implementation assumes this is an address. Both params are required
  65   // to be non-NULL and will be filled in with text that is vertically compact
  66   // (but may take up a lot of horizontal space) and horizontally compact (but
  67   // may take up a lot of vertical space) respectively. The return value will
  68   // be true and the outparams will be filled in only if the data represented is
  69   // complete and valid.
  70   virtual bool GetDisplayText(base::string16* vertically_compact,
  71                               base::string16* horizontally_compact);
  72
  73   // Returns the BCP 47 language code that should be used for formatting the
  74   // data for display.
  75   virtual const std::string& GetLanguageCode() const = 0;
  76
  77   // Fills in |form_structure| with the data that this model contains. |inputs|
  78   // and |comparator| are used to determine whether each field in the
  79   // FormStructure should be filled in or left alone. Returns whether any fields
  80   // in |form_structure| were found to be matching.
  81   bool FillFormStructure(
  82       const std::vector<ServerFieldType>& types,
  83       const FormStructure::InputFieldComparator& compare,
  84       FormStructure* form_structure) const;
  85
  86  protected:
  87   DataModelWrapper();
  88
  89  private:
  90   DISALLOW_COPY_AND_ASSIGN(DataModelWrapper);
  91 };
  92
  93 // A DataModelWrapper for Autofill profiles.
  94 class AutofillProfileWrapper : public DataModelWrapper {
  95  public:
  96   explicit AutofillProfileWrapper(const AutofillProfile* profile);
  97   AutofillProfileWrapper(const AutofillProfile* profile,
  98                          const AutofillType& variant_type,
  99                          size_t variant);
 100   ~AutofillProfileWrapper() override;
 101
 102   base::string16 GetInfo(const AutofillType& type) const override;
 103   base::string16 GetInfoForDisplay(const AutofillType& type) const override;
 104   const std::string& GetLanguageCode() const override;
 105
 106  protected:
 107   // Returns the variant that should be used when dealing with an element that
 108   // has the given |type|.
 109   size_t GetVariantForType(const AutofillType& type) const;
 110
 111  private:
 112   const AutofillProfile* profile_;
 113
 114   // The profile variant. |variant_| describes which variant of |variant_group_|
 115   // to use in the profile.
 116   FieldTypeGroup variant_group_;
 117   size_t variant_;
 118
 119   DISALLOW_COPY_AND_ASSIGN(AutofillProfileWrapper);
 120 };
 121
 122 // A DataModelWrapper specifically for shipping address profiles.
 123 class AutofillShippingAddressWrapper : public AutofillProfileWrapper {
 124  public:
 125   explicit AutofillShippingAddressWrapper(const AutofillProfile* profile);
 126   ~AutofillShippingAddressWrapper() override;
 127
 128   base::string16 GetInfo(const AutofillType& type) const override;
 129
 130  private:
 131   DISALLOW_COPY_AND_ASSIGN(AutofillShippingAddressWrapper);
 132 };
 133
 134 // A DataModelWrapper specifically for Autofill CreditCard data.
 135 class AutofillCreditCardWrapper : public DataModelWrapper {
 136  public:
 137   explicit AutofillCreditCardWrapper(const CreditCard* card);
 138   ~AutofillCreditCardWrapper() override;
 139
 140   base::string16 GetInfo(const AutofillType& type) const override;
 141   gfx::Image GetIcon() override;
 142   bool GetDisplayText(base::string16* vertically_compact,
 143                       base::string16* horizontally_compact) override;
 144   const std::string& GetLanguageCode() const override;
 145
 146  private:
 147   const CreditCard* card_;
 148
 149   DISALLOW_COPY_AND_ASSIGN(AutofillCreditCardWrapper);
 150 };
 151
 152 // A DataModelWrapper for Wallet addresses.
 153 class WalletAddressWrapper : public DataModelWrapper {
 154  public:
 155   explicit WalletAddressWrapper(const wallet::Address* address);
 156   ~WalletAddressWrapper() override;
 157
 158   base::string16 GetInfo(const AutofillType& type) const override;
 159   base::string16 GetInfoForDisplay(const AutofillType& type) const override;
 160   bool GetDisplayText(base::string16* vertically_compact,
 161                       base::string16* horizontally_compact) override;
 162   const std::string& GetLanguageCode() const override;
 163
 164  private:
 165   const wallet::Address* address_;
 166
 167   DISALLOW_COPY_AND_ASSIGN(WalletAddressWrapper);
 168 };
 169
 170 // A DataModelWrapper for Wallet instruments.
 171 class WalletInstrumentWrapper : public DataModelWrapper {
 172  public:
 173   explicit WalletInstrumentWrapper(
 174       const wallet::WalletItems::MaskedInstrument* instrument);
 175   ~WalletInstrumentWrapper() override;
 176
 177   base::string16 GetInfo(const AutofillType& type) const override;
 178   base::string16 GetInfoForDisplay(const AutofillType& type) const override;
 179   gfx::Image GetIcon() override;
 180   bool GetDisplayText(base::string16* vertically_compact,
 181                       base::string16* horizontally_compact) override;
 182   const std::string& GetLanguageCode() const override;
 183
 184  private:
 185   const wallet::WalletItems::MaskedInstrument* instrument_;
 186
 187   DISALLOW_COPY_AND_ASSIGN(WalletInstrumentWrapper);
 188 };
 189
 190 // A DataModelWrapper for FullWallet billing data.
 191 class FullWalletBillingWrapper : public DataModelWrapper {
 192  public:
 193   explicit FullWalletBillingWrapper(wallet::FullWallet* full_wallet);
 194   ~FullWalletBillingWrapper() override;
 195
 196   base::string16 GetInfo(const AutofillType& type) const override;
 197   bool GetDisplayText(base::string16* vertically_compact,
 198                       base::string16* horizontally_compact) override;
 199   const std::string& GetLanguageCode() const override;
 200
 201  private:
 202   wallet::FullWallet* full_wallet_;
 203
 204   DISALLOW_COPY_AND_ASSIGN(FullWalletBillingWrapper);
 205 };
 206
 207 // A DataModelWrapper for FullWallet shipping data.
 208 class FullWalletShippingWrapper : public DataModelWrapper {
 209  public:
 210   explicit FullWalletShippingWrapper(wallet::FullWallet* full_wallet);
 211   ~FullWalletShippingWrapper() override;
 212
 213   base::string16 GetInfo(const AutofillType& type) const override;
 214   const std::string& GetLanguageCode() const override;
 215
 216  private:
 217   wallet::FullWallet* full_wallet_;
 218
 219   DISALLOW_COPY_AND_ASSIGN(FullWalletShippingWrapper);
 220 };
 221
 222 // A DataModelWrapper for ::i18n::addressinput::AddressData objects.
 223 class I18nAddressDataWrapper : public DataModelWrapper {
 224  public:
 225   explicit I18nAddressDataWrapper(
 226       const ::i18n::addressinput::AddressData* address);
 227   ~I18nAddressDataWrapper() override;
 228
 229   base::string16 GetInfo(const AutofillType& type) const override;
 230   const std::string& GetLanguageCode() const override;
 231
 232  private:
 233   const ::i18n::addressinput::AddressData* address_;
 234
 235   DISALLOW_COPY_AND_ASSIGN(I18nAddressDataWrapper);
 236 };
 237
 238 }  // namespace autofill
 239
 240 #endif  // CHROME_BROWSER_UI_AUTOFILL_DATA_MODEL_WRAPPER_H_