// Copyright 2016 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef COMPONENTS_AUTOFILL_CORE_BROWSER_DATA_QUALITY_AUTOFILL_DATA_UTIL_H_
#define COMPONENTS_AUTOFILL_CORE_BROWSER_DATA_QUALITY_AUTOFILL_DATA_UTIL_H_

#include <stdint.h>

#include <string>
#include <string_view>

#include "components/autofill/core/browser/country_type.h"
#include "components/autofill/core/browser/field_types.h"

namespace autofill {

class AutofillProfile;
class FormStructure;

namespace data_util {

struct NameParts {
  std::u16string given;
  std::u16string middle;
  std::u16string family;
};

namespace bit_field_type_groups {

// Bits for FieldTypeGroup options.
// The form has a field associated with the kName or kNameBilling
// FieldTypeGroups.
constexpr uint32_t kName = 1 << 0;
// The form has a field associated with the :kAddressHome or kAddressBilling
// FieldTypeGroups.
constexpr uint32_t kAddress = 1 << 1;
// The form has a field associated with the kEmail FieldTypeGroup.
constexpr uint32_t kEmail = 1 << 2;
// The form has a field associated with the kPhoneHome or kPhoneBilling
// FieldTypeGroups.
constexpr uint32_t kPhone = 1 << 3;

}  // namespace bit_field_type_groups

// Returns true if kName is set in `groups`.
bool ContainsName(uint32_t groups);

// Returns true if kAddress is set in `groups`.
bool ContainsAddress(uint32_t groups);

// Returns true if kEmail is set in `groups`.
bool ContainsEmail(uint32_t groups);

// Returns true if kPhone is set in `groups`.
bool ContainsPhone(uint32_t groups);

// Returns a bitmask indicating which of the name, address, email address, and
// phone number FieldTypeGroups are associated with the given `form`'s storable
// types or `types`, respectively.
uint32_t DetermineGroups(const FormStructure& form);
uint32_t DetermineGroups(const FieldTypeSet& types);

// Returns true if a form has address fields or has least two supported
// non-address fields.
bool IsSupportedFormType(uint32_t groups);

// Returns the histogram suffix corresponding to the given `bitmask`.
std::string_view GetSuffixForProfileFormType(uint32_t bitmask);

// Truncates a string to the nearest UTF-8 character that will leave
// the string less than or equal to the specified byte size.
std::string TruncateUTF8(std::string_view data);

bool IsCreditCardExpirationType(FieldType type);

// Used to map Chrome card issuer networks to Payment Request API basic card
// payment spec issuer networks and icons.
// https://w3c.github.io/webpayments-methods-card/#method-id
struct PaymentRequestData {
  const char* issuer_network;
  const char* basic_card_issuer_network;
  const int icon_resource_id;
  const int a11y_label_resource_id;
};

// Returns true if `name` looks like a CJK name (or some kind of mish-mash of
// the three, at least).
bool IsCJKName(std::u16string_view name);

// Returns true if `text` contains at least one Katakana character.
bool HasKatakanaCharacter(std::u16string_view text);

// TODO(crbug.com/41239336): Investigate the use of app_locale to do better name
// splitting.
// Returns the different name parts (given, middle and family names) of the full
// `name` passed as a parameter.
NameParts SplitName(std::u16string_view name);

// Concatenates the name parts together in the correct order (based on script),
// and returns the result.
std::u16string JoinNameParts(std::u16string_view given,
                             std::u16string_view middle,
                             std::u16string_view family);

// Returns the Payment Request API basic card payment spec data for the provided
// autofill credit card `network`.  Will set the network and the icon to
// "generic" for any unrecognized type.
const PaymentRequestData& GetPaymentRequestData(
    std::string_view issuer_network);

// Returns the autofill credit card issuer network string for the provided
// Payment Request API basic card payment spec `basic_card_card_issuer_network`.
const char* GetIssuerNetworkForBasicCardIssuerNetwork(
    std::string_view basic_card_issuer_network);

// Returns whether the specified `country_code` is a valid country code.
bool IsValidCountryCode(std::string_view country_code);
bool IsValidCountryCode(std::u16string_view country_code);

// Returns a country code to be used when validating this profile. If the
// profile has a valid country code set, it is returned. If not, a country code
// associated with `app_locale` is used as a fallback.
std::string GetCountryCodeWithFallback(const AutofillProfile& profile,
                                       std::string_view app_locale);

// Returns true if `country_code1` and `country_code2` are the same, or if at
// least one of them is invalid.
bool HaveNonConflictingCountryCodes(const AddressCountryCode& country_code1,
                                    const AddressCountryCode& country_code2);

}  // namespace data_util
}  // namespace autofill

#endif  // COMPONENTS_AUTOFILL_CORE_BROWSER_DATA_QUALITY_AUTOFILL_DATA_UTIL_H_