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.
5
#ifndef BASE_STRINGS_STRING_NUMBER_CONVERSIONS_H_
6
#define BASE_STRINGS_STRING_NUMBER_CONVERSIONS_H_
11
#include "base/base_export.h"
12
#include "base/basictypes.h"
13
#include "base/strings/string16.h"
14
#include "base/strings/string_piece.h"
16
// ----------------------------------------------------------------------------
17
// IMPORTANT MESSAGE FROM YOUR SPONSOR
19
// This file contains no "wstring" variants. New code should use string16. If
20
// you need to make old code work, use the UTF8 version and convert. Please do
21
// not add wstring variants.
23
// Please do not add "convenience" functions for converting strings to integers
24
// that return the value and ignore success/failure. That encourages people to
25
// write code that doesn't properly handle the error conditions.
26
// ----------------------------------------------------------------------------
30
// Number -> string conversions ------------------------------------------------
32
BASE_EXPORT std::string IntToString(int value);
33
BASE_EXPORT string16 IntToString16(int value);
35
BASE_EXPORT std::string UintToString(unsigned value);
36
BASE_EXPORT string16 UintToString16(unsigned value);
38
BASE_EXPORT std::string Int64ToString(int64 value);
39
BASE_EXPORT string16 Int64ToString16(int64 value);
41
BASE_EXPORT std::string Uint64ToString(uint64 value);
42
BASE_EXPORT string16 Uint64ToString16(uint64 value);
44
// DoubleToString converts the double to a string format that ignores the
45
// locale. If you want to use locale specific formatting, use ICU.
46
BASE_EXPORT std::string DoubleToString(double value);
48
// String -> number conversions ------------------------------------------------
50
// Perform a best-effort conversion of the input string to a numeric type,
51
// setting |*output| to the result of the conversion. Returns true for
52
// "perfect" conversions; returns false in the following cases:
53
// - Overflow. |*output| will be set to the maximum value supported
55
// - Underflow. |*output| will be set to the minimum value supported
57
// - Trailing characters in the string after parsing the number. |*output|
58
// will be set to the value of the number that was parsed.
59
// - Leading whitespace in the string before parsing the number. |*output| will
60
// be set to the value of the number that was parsed.
61
// - No characters parseable as a number at the beginning of the string.
62
// |*output| will be set to 0.
63
// - Empty string. |*output| will be set to 0.
64
BASE_EXPORT bool StringToInt(const StringPiece& input, int* output);
65
BASE_EXPORT bool StringToInt(const StringPiece16& input, int* output);
67
BASE_EXPORT bool StringToUint(const StringPiece& input, unsigned* output);
68
BASE_EXPORT bool StringToUint(const StringPiece16& input, unsigned* output);
70
BASE_EXPORT bool StringToInt64(const StringPiece& input, int64* output);
71
BASE_EXPORT bool StringToInt64(const StringPiece16& input, int64* output);
73
BASE_EXPORT bool StringToUint64(const StringPiece& input, uint64* output);
74
BASE_EXPORT bool StringToUint64(const StringPiece16& input, uint64* output);
76
BASE_EXPORT bool StringToSizeT(const StringPiece& input, size_t* output);
77
BASE_EXPORT bool StringToSizeT(const StringPiece16& input, size_t* output);
79
// For floating-point conversions, only conversions of input strings in decimal
80
// form are defined to work. Behavior with strings representing floating-point
81
// numbers in hexadecimal, and strings representing non-fininte values (such as
82
// NaN and inf) is undefined. Otherwise, these behave the same as the integral
83
// variants. This expects the input string to NOT be specific to the locale.
84
// If your input is locale specific, use ICU to read the number.
85
BASE_EXPORT bool StringToDouble(const std::string& input, double* output);
87
// Hex encoding ----------------------------------------------------------------
89
// Returns a hex string representation of a binary buffer. The returned hex
90
// string will be in upper case. This function does not check if |size| is
91
// within reasonable limits since it's written with trusted data in mind. If
92
// you suspect that the data you want to format might be large, the absolute
93
// max size for |size| should be is
94
// std::numeric_limits<size_t>::max() / 2
95
BASE_EXPORT std::string HexEncode(const void* bytes, size_t size);
97
// Best effort conversion, see StringToInt above for restrictions.
98
// Will only successful parse hex values that will fit into |output|, i.e.
99
// -0x80000000 < |input| < 0x7FFFFFFF.
100
BASE_EXPORT bool HexStringToInt(const StringPiece& input, int* output);
102
// Best effort conversion, see StringToInt above for restrictions.
103
// Will only successful parse hex values that will fit into |output|, i.e.
104
// 0x00000000 < |input| < 0xFFFFFFFF.
105
// The string is not required to start with 0x.
106
BASE_EXPORT bool HexStringToUInt(const StringPiece& input, uint32* output);
108
// Best effort conversion, see StringToInt above for restrictions.
109
// Will only successful parse hex values that will fit into |output|, i.e.
110
// -0x8000000000000000 < |input| < 0x7FFFFFFFFFFFFFFF.
111
BASE_EXPORT bool HexStringToInt64(const StringPiece& input, int64* output);
113
// Best effort conversion, see StringToInt above for restrictions.
114
// Will only successful parse hex values that will fit into |output|, i.e.
115
// 0x0000000000000000 < |input| < 0xFFFFFFFFFFFFFFFF.
116
// The string is not required to start with 0x.
117
BASE_EXPORT bool HexStringToUInt64(const StringPiece& input, uint64* output);
119
// Similar to the previous functions, except that output is a vector of bytes.
120
// |*output| will contain as many bytes as were successfully parsed prior to the
121
// error. There is no overflow, but input.size() must be evenly divisible by 2.
122
// Leading 0x or +/- are not allowed.
123
BASE_EXPORT bool HexStringToBytes(const std::string& input,
124
std::vector<uint8>* output);
128
#endif // BASE_STRINGS_STRING_NUMBER_CONVERSIONS_H_