OLD | NEW |
1 // Copyright (c) 2011 The Chromium Authors. All rights reserved. | 1 // Copyright (c) 2011 The Chromium Authors. All rights reserved. |
2 // Use of this source code is governed by a BSD-style license that can be | 2 // Use of this source code is governed by a BSD-style license that can be |
3 // found in the LICENSE file. | 3 // found in the LICENSE file. |
4 | 4 |
5 #ifndef BASE_STRING_SPLIT_H_ | 5 #ifndef BASE_STRING_SPLIT_H_ |
6 #define BASE_STRING_SPLIT_H_ | 6 #define BASE_STRING_SPLIT_H_ |
7 #pragma once | 7 #pragma once |
8 | 8 |
9 #include <string> | 9 #include <string> |
10 #include <utility> | 10 #include <utility> |
11 #include <vector> | 11 #include <vector> |
12 | 12 |
13 #include "base/base_api.h" | 13 #include "base/base_export.h" |
14 #include "base/string16.h" | 14 #include "base/string16.h" |
15 | 15 |
16 namespace base { | 16 namespace base { |
17 | 17 |
18 // Splits |str| into a vector of strings delimited by |s|. Append the results | 18 // Splits |str| into a vector of strings delimited by |s|. Append the results |
19 // into |r| as they appear. If several instances of |s| are contiguous, or if | 19 // into |r| as they appear. If several instances of |s| are contiguous, or if |
20 // |str| begins with or ends with |s|, then an empty string is inserted. | 20 // |str| begins with or ends with |s|, then an empty string is inserted. |
21 // | 21 // |
22 // Every substring is trimmed of any leading or trailing white space. | 22 // Every substring is trimmed of any leading or trailing white space. |
23 // NOTE: |c| must be in BMP (Basic Multilingual Plane) | 23 // NOTE: |c| must be in BMP (Basic Multilingual Plane) |
24 BASE_API void SplitString(const string16& str, | 24 BASE_EXPORT void SplitString(const string16& str, |
25 char16 c, | 25 char16 c, |
26 std::vector<string16>* r); | 26 std::vector<string16>* r); |
27 // |str| should not be in a multi-byte encoding like Shift-JIS or GBK in which | 27 // |str| should not be in a multi-byte encoding like Shift-JIS or GBK in which |
28 // the trailing byte of a multi-byte character can be in the ASCII range. | 28 // the trailing byte of a multi-byte character can be in the ASCII range. |
29 // UTF-8, and other single/multi-byte ASCII-compatible encodings are OK. | 29 // UTF-8, and other single/multi-byte ASCII-compatible encodings are OK. |
30 // Note: |c| must be in the ASCII range. | 30 // Note: |c| must be in the ASCII range. |
31 BASE_API void SplitString(const std::string& str, | 31 BASE_EXPORT void SplitString(const std::string& str, |
32 char c, | 32 char c, |
33 std::vector<std::string>* r); | 33 std::vector<std::string>* r); |
34 | 34 |
35 BASE_API bool SplitStringIntoKeyValues( | 35 BASE_EXPORT bool SplitStringIntoKeyValues( |
36 const std::string& line, | 36 const std::string& line, |
37 char key_value_delimiter, | 37 char key_value_delimiter, |
38 std::string* key, std::vector<std::string>* values); | 38 std::string* key, std::vector<std::string>* values); |
39 | 39 |
40 BASE_API bool SplitStringIntoKeyValuePairs( | 40 BASE_EXPORT bool SplitStringIntoKeyValuePairs( |
41 const std::string& line, | 41 const std::string& line, |
42 char key_value_delimiter, | 42 char key_value_delimiter, |
43 char key_value_pair_delimiter, | 43 char key_value_pair_delimiter, |
44 std::vector<std::pair<std::string, std::string> >* kv_pairs); | 44 std::vector<std::pair<std::string, std::string> >* kv_pairs); |
45 | 45 |
46 // The same as SplitString, but use a substring delimiter instead of a char. | 46 // The same as SplitString, but use a substring delimiter instead of a char. |
47 BASE_API void SplitStringUsingSubstr(const string16& str, | 47 BASE_EXPORT void SplitStringUsingSubstr(const string16& str, |
48 const string16& s, | 48 const string16& s, |
49 std::vector<string16>* r); | 49 std::vector<string16>* r); |
50 BASE_API void SplitStringUsingSubstr(const std::string& str, | 50 BASE_EXPORT void SplitStringUsingSubstr(const std::string& str, |
51 const std::string& s, | 51 const std::string& s, |
52 std::vector<std::string>* r); | 52 std::vector<std::string>* r); |
53 | 53 |
54 // The same as SplitString, but don't trim white space. | 54 // The same as SplitString, but don't trim white space. |
55 // NOTE: |c| must be in BMP (Basic Multilingual Plane) | 55 // NOTE: |c| must be in BMP (Basic Multilingual Plane) |
56 BASE_API void SplitStringDontTrim(const string16& str, | 56 BASE_EXPORT void SplitStringDontTrim(const string16& str, |
57 char16 c, | 57 char16 c, |
58 std::vector<string16>* r); | 58 std::vector<string16>* r); |
59 // |str| should not be in a multi-byte encoding like Shift-JIS or GBK in which | 59 // |str| should not be in a multi-byte encoding like Shift-JIS or GBK in which |
60 // the trailing byte of a multi-byte character can be in the ASCII range. | 60 // the trailing byte of a multi-byte character can be in the ASCII range. |
61 // UTF-8, and other single/multi-byte ASCII-compatible encodings are OK. | 61 // UTF-8, and other single/multi-byte ASCII-compatible encodings are OK. |
62 // Note: |c| must be in the ASCII range. | 62 // Note: |c| must be in the ASCII range. |
63 BASE_API void SplitStringDontTrim(const std::string& str, | 63 BASE_EXPORT void SplitStringDontTrim(const std::string& str, |
64 char c, | 64 char c, |
65 std::vector<std::string>* r); | 65 std::vector<std::string>* r); |
66 | 66 |
67 // WARNING: this uses whitespace as defined by the HTML5 spec. If you need | 67 // WARNING: this uses whitespace as defined by the HTML5 spec. If you need |
68 // a function similar to this but want to trim all types of whitespace, then | 68 // a function similar to this but want to trim all types of whitespace, then |
69 // factor this out into a function that takes a string containing the characters | 69 // factor this out into a function that takes a string containing the characters |
70 // that are treated as whitespace. | 70 // that are treated as whitespace. |
71 // | 71 // |
72 // Splits the string along whitespace (where whitespace is the five space | 72 // Splits the string along whitespace (where whitespace is the five space |
73 // characters defined by HTML 5). Each contiguous block of non-whitespace | 73 // characters defined by HTML 5). Each contiguous block of non-whitespace |
74 // characters is added to result. | 74 // characters is added to result. |
75 BASE_API void SplitStringAlongWhitespace(const std::wstring& str, | 75 BASE_EXPORT void SplitStringAlongWhitespace(const std::wstring& str, |
76 std::vector<std::wstring>* result); | 76 std::vector<std::wstring>* result); |
77 BASE_API void SplitStringAlongWhitespace(const string16& str, | 77 BASE_EXPORT void SplitStringAlongWhitespace(const string16& str, |
78 std::vector<string16>* result); | 78 std::vector<string16>* result); |
79 BASE_API void SplitStringAlongWhitespace(const std::string& str, | 79 BASE_EXPORT void SplitStringAlongWhitespace(const std::string& str, |
80 std::vector<std::string>* result); | 80 std::vector<std::string>* result); |
81 | 81 |
82 } // namespace base | 82 } // namespace base |
83 | 83 |
84 #endif // BASE_STRING_SPLIT_H | 84 #endif // BASE_STRING_SPLIT_H |
OLD | NEW |