• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 // Copyright 2013 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 COMPONENTS_AUTOFILL_CORE_BROWSER_AUTOFILL_FIELD_H_
6 #define COMPONENTS_AUTOFILL_CORE_BROWSER_AUTOFILL_FIELD_H_
7 
8 #include <string>
9 
10 #include "base/basictypes.h"
11 #include "base/strings/string16.h"
12 #include "components/autofill/core/browser/field_types.h"
13 #include "components/autofill/core/common/form_field_data.h"
14 
15 namespace autofill {
16 
17 class AutofillType;
18 
19 class AutofillField : public FormFieldData {
20  public:
21   enum PhonePart {
22     IGNORED = 0,
23     PHONE_PREFIX = 1,
24     PHONE_SUFFIX = 2,
25   };
26 
27   AutofillField();
28   AutofillField(const FormFieldData& field, const base::string16& unique_name);
29   virtual ~AutofillField();
30 
unique_name()31   const base::string16& unique_name() const { return unique_name_; }
32 
section()33   const std::string& section() const { return section_; }
heuristic_type()34   ServerFieldType heuristic_type() const { return heuristic_type_; }
server_type()35   ServerFieldType server_type() const { return server_type_; }
html_type()36   HtmlFieldType html_type() const { return html_type_; }
html_mode()37   HtmlFieldMode html_mode() const { return html_mode_; }
possible_types()38   const ServerFieldTypeSet& possible_types() const { return possible_types_; }
phone_part()39   PhonePart phone_part() const { return phone_part_; }
40 
41   // Setters for the detected type and section for this field.
set_section(const std::string & section)42   void set_section(const std::string& section) { section_ = section; }
43   void set_heuristic_type(ServerFieldType type);
44   void set_server_type(ServerFieldType type);
set_possible_types(const ServerFieldTypeSet & possible_types)45   void set_possible_types(const ServerFieldTypeSet& possible_types) {
46     possible_types_ = possible_types;
47   }
48   void SetHtmlType(HtmlFieldType type, HtmlFieldMode mode);
49 
50   // This function automatically chooses between server and heuristic autofill
51   // type, depending on the data available.
52   AutofillType Type() const;
53 
54   // Returns true if the value of this field is empty.
55   bool IsEmpty() const;
56 
57   // The unique signature of this field, composed of the field name and the html
58   // input type in a 32-bit hash.
59   std::string FieldSignature() const;
60 
61   // Returns true if the field type has been determined (without the text in the
62   // field).
63   bool IsFieldFillable() const;
64 
set_default_value(const std::string & value)65   void set_default_value(const std::string& value) { default_value_ = value; }
default_value()66   const std::string& default_value() const { return default_value_; }
67 
set_credit_card_number_offset(size_t position)68   void set_credit_card_number_offset(size_t position) {
69     credit_card_number_offset_ = position;
70   }
credit_card_number_offset()71   size_t credit_card_number_offset() const {
72     return credit_card_number_offset_;
73   }
74 
75   // Set |field_data|'s value to |value|. Uses |field|, |address_language_code|,
76   // and |app_locale| as hints when filling exceptional cases like phone number
77   // values and <select> fields. Returns |true| if the field has been filled,
78   // |false| otherwise.
79   static bool FillFormField(const AutofillField& field,
80                             const base::string16& value,
81                             const std::string& address_language_code,
82                             const std::string& app_locale,
83                             FormFieldData* field_data);
84 
85   // Returns the phone number value for the given |field|. The returned value
86   // might be |number|, or could possibly be a prefix or suffix of |number|
87   // if that's appropriate for the field.
88   static base::string16 GetPhoneNumberValue(const AutofillField& field,
89                                             const base::string16& number,
90                                             const FormFieldData& field_data);
91 
92  private:
93   // The unique name of this field, generated by Autofill.
94   base::string16 unique_name_;
95 
96   // The unique identifier for the section (e.g. billing vs. shipping address)
97   // that this field belongs to.
98   std::string section_;
99 
100   // The type of the field, as determined by the Autofill server.
101   ServerFieldType server_type_;
102 
103   // The type of the field, as determined by the local heuristics.
104   ServerFieldType heuristic_type_;
105 
106   // The type of the field, as specified by the site author in HTML.
107   HtmlFieldType html_type_;
108 
109   // The "mode" of the field, as specified by the site author in HTML.
110   // Currently this is used to distinguish between billing and shipping fields.
111   HtmlFieldMode html_mode_;
112 
113   // The set of possible types for this field.
114   ServerFieldTypeSet possible_types_;
115 
116   // Used to track whether this field is a phone prefix or suffix.
117   PhonePart phone_part_;
118 
119   // The default value returned by the Autofill server.
120   std::string default_value_;
121 
122   // Used to hold the position of the first digit to be copied as a substring
123   // from credit card number.
124   size_t credit_card_number_offset_;
125 
126   DISALLOW_COPY_AND_ASSIGN(AutofillField);
127 };
128 
129 }  // namespace autofill
130 
131 #endif  // COMPONENTS_AUTOFILL_CORE_BROWSER_AUTOFILL_FIELD_H_
132