Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(13)

Side by Side Diff: url/url_util.h

Issue 15805003: Make the copy of GURL in src/url buildable as a component build. (try 2) (Closed) Base URL: svn://chrome-svn/chrome/trunk/src/
Patch Set: Created 7 years, 6 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View unified diff | Download patch | Annotate | Revision Log
« url/url_export.h ('K') | « url/url_parse.h ('k') | no next file » | no next file with comments »
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
OLDNEW
1 // Copyright 2013 The Chromium Authors. All rights reserved. 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 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 URL_URL_UTIL_H_ 5 #ifndef URL_URL_UTIL_H_
6 #define URL_URL_UTIL_H_ 6 #define URL_URL_UTIL_H_
7 7
8 #include <string> 8 #include <string>
9 9
10 #include "base/string16.h" 10 #include "base/string16.h"
11 #include "url/url_canon.h" 11 #include "url/url_canon.h"
12 #include "url/url_export.h"
12 #include "url/url_parse.h" 13 #include "url/url_parse.h"
13 14
14 namespace url_util { 15 namespace url_util {
15 16
16 // Init ------------------------------------------------------------------------ 17 // Init ------------------------------------------------------------------------
17 18
18 // Initialization is NOT required, it will be implicitly initialized when first 19 // Initialization is NOT required, it will be implicitly initialized when first
19 // used. However, this implicit initialization is NOT threadsafe. If you are 20 // used. However, this implicit initialization is NOT threadsafe. If you are
20 // using this library in a threaded environment and don't have a consistent 21 // using this library in a threaded environment and don't have a consistent
21 // "first call" (an example might be calling "AddStandardScheme" with your 22 // "first call" (an example might be calling "AddStandardScheme" with your
22 // special application-specific schemes) then you will want to call initialize 23 // special application-specific schemes) then you will want to call initialize
23 // before spawning any threads. 24 // before spawning any threads.
24 // 25 //
25 // It is OK to call this function more than once, subsequent calls will simply 26 // It is OK to call this function more than once, subsequent calls will simply
26 // "noop", unless Shutdown() was called in the mean time. This will also be a 27 // "noop", unless Shutdown() was called in the mean time. This will also be a
27 // "noop" if other calls to the library have forced an initialization 28 // "noop" if other calls to the library have forced an initialization
28 // beforehand. 29 // beforehand.
29 void Initialize(); 30 URL_EXPORT void Initialize();
30 31
31 // Cleanup is not required, except some strings may leak. For most user 32 // Cleanup is not required, except some strings may leak. For most user
32 // applications, this is fine. If you're using it in a library that may get 33 // applications, this is fine. If you're using it in a library that may get
33 // loaded and unloaded, you'll want to unload to properly clean up your 34 // loaded and unloaded, you'll want to unload to properly clean up your
34 // library. 35 // library.
35 void Shutdown(); 36 URL_EXPORT void Shutdown();
36 37
37 // Schemes -------------------------------------------------------------------- 38 // Schemes --------------------------------------------------------------------
38 39
39 // Adds an application-defined scheme to the internal list of "standard" URL 40 // Adds an application-defined scheme to the internal list of "standard" URL
40 // schemes. This function is not threadsafe and can not be called concurrently 41 // schemes. This function is not threadsafe and can not be called concurrently
41 // with any other url_util function. It will assert if the list of standard 42 // with any other url_util function. It will assert if the list of standard
42 // schemes has been locked (see LockStandardSchemes). 43 // schemes has been locked (see LockStandardSchemes).
43 void AddStandardScheme(const char* new_scheme); 44 URL_EXPORT void AddStandardScheme(const char* new_scheme);
44 45
45 // Sets a flag to prevent future calls to AddStandardScheme from succeeding. 46 // Sets a flag to prevent future calls to AddStandardScheme from succeeding.
46 // 47 //
47 // This is designed to help prevent errors for multithreaded applications. 48 // This is designed to help prevent errors for multithreaded applications.
48 // Normal usage would be to call AddStandardScheme for your custom schemes at 49 // Normal usage would be to call AddStandardScheme for your custom schemes at
49 // the beginning of program initialization, and then LockStandardSchemes. This 50 // the beginning of program initialization, and then LockStandardSchemes. This
50 // prevents future callers from mistakenly calling AddStandardScheme when the 51 // prevents future callers from mistakenly calling AddStandardScheme when the
51 // program is running with multiple threads, where such usage would be 52 // program is running with multiple threads, where such usage would be
52 // dangerous. 53 // dangerous.
53 // 54 //
54 // We could have had AddStandardScheme use a lock instead, but that would add 55 // We could have had AddStandardScheme use a lock instead, but that would add
55 // some platform-specific dependencies we don't otherwise have now, and is 56 // some platform-specific dependencies we don't otherwise have now, and is
56 // overkill considering the normal usage is so simple. 57 // overkill considering the normal usage is so simple.
57 void LockStandardSchemes(); 58 URL_EXPORT void LockStandardSchemes();
58 59
59 // Locates the scheme in the given string and places it into |found_scheme|, 60 // Locates the scheme in the given string and places it into |found_scheme|,
60 // which may be NULL to indicate the caller does not care about the range. 61 // which may be NULL to indicate the caller does not care about the range.
61 // 62 //
62 // Returns whether the given |compare| scheme matches the scheme found in the 63 // Returns whether the given |compare| scheme matches the scheme found in the
63 // input (if any). The |compare| scheme must be a valid canonical scheme or 64 // input (if any). The |compare| scheme must be a valid canonical scheme or
64 // the result of the comparison is undefined. 65 // the result of the comparison is undefined.
65 bool FindAndCompareScheme(const char* str, 66 URL_EXPORT bool FindAndCompareScheme(const char* str,
66 int str_len, 67 int str_len,
67 const char* compare, 68 const char* compare,
68 url_parse::Component* found_scheme); 69 url_parse::Component* found_scheme);
69 bool FindAndCompareScheme(const char16* str, 70 URL_EXPORT bool FindAndCompareScheme(const char16* str,
70 int str_len, 71 int str_len,
71 const char* compare, 72 const char* compare,
72 url_parse::Component* found_scheme); 73 url_parse::Component* found_scheme);
73 inline bool FindAndCompareScheme(const std::string& str, 74 inline bool FindAndCompareScheme(const std::string& str,
74 const char* compare, 75 const char* compare,
75 url_parse::Component* found_scheme) { 76 url_parse::Component* found_scheme) {
76 return FindAndCompareScheme(str.data(), static_cast<int>(str.size()), 77 return FindAndCompareScheme(str.data(), static_cast<int>(str.size()),
77 compare, found_scheme); 78 compare, found_scheme);
78 } 79 }
79 inline bool FindAndCompareScheme(const string16& str, 80 inline bool FindAndCompareScheme(const string16& str,
80 const char* compare, 81 const char* compare,
81 url_parse::Component* found_scheme) { 82 url_parse::Component* found_scheme) {
82 return FindAndCompareScheme(str.data(), static_cast<int>(str.size()), 83 return FindAndCompareScheme(str.data(), static_cast<int>(str.size()),
83 compare, found_scheme); 84 compare, found_scheme);
84 } 85 }
85 86
86 // Returns true if the given string represents a standard URL. This means that 87 // Returns true if the given string represents a standard URL. This means that
87 // either the scheme is in the list of known standard schemes. 88 // either the scheme is in the list of known standard schemes.
88 bool IsStandard(const char* spec, 89 URL_EXPORT bool IsStandard(const char* spec,
89 const url_parse::Component& scheme); 90 const url_parse::Component& scheme);
90 bool IsStandard(const char16* spec, 91 URL_EXPORT bool IsStandard(const char16* spec,
91 const url_parse::Component& scheme); 92 const url_parse::Component& scheme);
92 93
93 // TODO(brettw) remove this. This is a temporary compatibility hack to avoid 94 // TODO(brettw) remove this. This is a temporary compatibility hack to avoid
94 // breaking the WebKit build when this version is synced via Chrome. 95 // breaking the WebKit build when this version is synced via Chrome.
95 inline bool IsStandard(const char* spec, int spec_len, 96 inline bool IsStandard(const char* spec, int spec_len,
96 const url_parse::Component& scheme) { 97 const url_parse::Component& scheme) {
97 return IsStandard(spec, scheme); 98 return IsStandard(spec, scheme);
98 } 99 }
99 100
100 // URL library wrappers ------------------------------------------------------- 101 // URL library wrappers -------------------------------------------------------
101 102
102 // Parses the given spec according to the extracted scheme type. Normal users 103 // Parses the given spec according to the extracted scheme type. Normal users
103 // should use the URL object, although this may be useful if performance is 104 // should use the URL object, although this may be useful if performance is
104 // critical and you don't want to do the heap allocation for the std::string. 105 // critical and you don't want to do the heap allocation for the std::string.
105 // 106 //
106 // As with the url_canon::Canonicalize* functions, the charset converter can 107 // As with the url_canon::Canonicalize* functions, the charset converter can
107 // be NULL to use UTF-8 (it will be faster in this case). 108 // be NULL to use UTF-8 (it will be faster in this case).
108 // 109 //
109 // Returns true if a valid URL was produced, false if not. On failure, the 110 // Returns true if a valid URL was produced, false if not. On failure, the
110 // output and parsed structures will still be filled and will be consistent, 111 // output and parsed structures will still be filled and will be consistent,
111 // but they will not represent a loadable URL. 112 // but they will not represent a loadable URL.
112 bool Canonicalize(const char* spec, 113 URL_EXPORT bool Canonicalize(const char* spec,
113 int spec_len, 114 int spec_len,
114 url_canon::CharsetConverter* charset_converter, 115 url_canon::CharsetConverter* charset_converter,
115 url_canon::CanonOutput* output, 116 url_canon::CanonOutput* output,
116 url_parse::Parsed* output_parsed); 117 url_parse::Parsed* output_parsed);
117 bool Canonicalize(const char16* spec, 118 URL_EXPORT bool Canonicalize(const char16* spec,
118 int spec_len, 119 int spec_len,
119 url_canon::CharsetConverter* charset_converter, 120 url_canon::CharsetConverter* charset_converter,
120 url_canon::CanonOutput* output, 121 url_canon::CanonOutput* output,
121 url_parse::Parsed* output_parsed); 122 url_parse::Parsed* output_parsed);
122 123
123 // Resolves a potentially relative URL relative to the given parsed base URL. 124 // Resolves a potentially relative URL relative to the given parsed base URL.
124 // The base MUST be valid. The resulting canonical URL and parsed information 125 // The base MUST be valid. The resulting canonical URL and parsed information
125 // will be placed in to the given out variables. 126 // will be placed in to the given out variables.
126 // 127 //
127 // The relative need not be relative. If we discover that it's absolute, this 128 // The relative need not be relative. If we discover that it's absolute, this
128 // will produce a canonical version of that URL. See Canonicalize() for more 129 // will produce a canonical version of that URL. See Canonicalize() for more
129 // about the charset_converter. 130 // about the charset_converter.
130 // 131 //
131 // Returns true if the output is valid, false if the input could not produce 132 // Returns true if the output is valid, false if the input could not produce
132 // a valid URL. 133 // a valid URL.
133 bool ResolveRelative(const char* base_spec, 134 URL_EXPORT bool ResolveRelative(const char* base_spec,
134 int base_spec_len, 135 int base_spec_len,
135 const url_parse::Parsed& base_parsed, 136 const url_parse::Parsed& base_parsed,
136 const char* relative, 137 const char* relative,
137 int relative_length, 138 int relative_length,
138 url_canon::CharsetConverter* charset_converter, 139 url_canon::CharsetConverter* charset_converter,
139 url_canon::CanonOutput* output, 140 url_canon::CanonOutput* output,
140 url_parse::Parsed* output_parsed); 141 url_parse::Parsed* output_parsed);
141 bool ResolveRelative(const char* base_spec, 142 URL_EXPORT bool ResolveRelative(const char* base_spec,
142 int base_spec_len, 143 int base_spec_len,
143 const url_parse::Parsed& base_parsed, 144 const url_parse::Parsed& base_parsed,
144 const char16* relative, 145 const char16* relative,
145 int relative_length, 146 int relative_length,
146 url_canon::CharsetConverter* charset_converter, 147 url_canon::CharsetConverter* charset_converter,
147 url_canon::CanonOutput* output, 148 url_canon::CanonOutput* output,
148 url_parse::Parsed* output_parsed); 149 url_parse::Parsed* output_parsed);
149 150
150 // Replaces components in the given VALID input url. The new canonical URL info 151 // Replaces components in the given VALID input url. The new canonical URL info
151 // is written to output and out_parsed. 152 // is written to output and out_parsed.
152 // 153 //
153 // Returns true if the resulting URL is valid. 154 // Returns true if the resulting URL is valid.
154 bool ReplaceComponents( 155 URL_EXPORT bool ReplaceComponents(
155 const char* spec, 156 const char* spec,
156 int spec_len, 157 int spec_len,
157 const url_parse::Parsed& parsed, 158 const url_parse::Parsed& parsed,
158 const url_canon::Replacements<char>& replacements, 159 const url_canon::Replacements<char>& replacements,
159 url_canon::CharsetConverter* charset_converter, 160 url_canon::CharsetConverter* charset_converter,
160 url_canon::CanonOutput* output, 161 url_canon::CanonOutput* output,
161 url_parse::Parsed* out_parsed); 162 url_parse::Parsed* out_parsed);
162 bool ReplaceComponents( 163 URL_EXPORT bool ReplaceComponents(
163 const char* spec, 164 const char* spec,
164 int spec_len, 165 int spec_len,
165 const url_parse::Parsed& parsed, 166 const url_parse::Parsed& parsed,
166 const url_canon::Replacements<char16>& replacements, 167 const url_canon::Replacements<char16>& replacements,
167 url_canon::CharsetConverter* charset_converter, 168 url_canon::CharsetConverter* charset_converter,
168 url_canon::CanonOutput* output, 169 url_canon::CanonOutput* output,
169 url_parse::Parsed* out_parsed); 170 url_parse::Parsed* out_parsed);
170 171
171 // String helper functions ---------------------------------------------------- 172 // String helper functions ----------------------------------------------------
172 173
173 // Compare the lower-case form of the given string against the given ASCII 174 // Compare the lower-case form of the given string against the given ASCII
174 // string. This is useful for doing checking if an input string matches some 175 // string. This is useful for doing checking if an input string matches some
175 // token, and it is optimized to avoid intermediate string copies. 176 // token, and it is optimized to avoid intermediate string copies.
176 // 177 //
177 // The versions of this function that don't take a b_end assume that the b 178 // The versions of this function that don't take a b_end assume that the b
178 // string is NULL terminated. 179 // string is NULL terminated.
179 bool LowerCaseEqualsASCII(const char* a_begin, 180 URL_EXPORT bool LowerCaseEqualsASCII(const char* a_begin,
180 const char* a_end, 181 const char* a_end,
181 const char* b); 182 const char* b);
182 bool LowerCaseEqualsASCII(const char* a_begin, 183 URL_EXPORT bool LowerCaseEqualsASCII(const char* a_begin,
183 const char* a_end, 184 const char* a_end,
184 const char* b_begin, 185 const char* b_begin,
185 const char* b_end); 186 const char* b_end);
186 bool LowerCaseEqualsASCII(const char16* a_begin, 187 URL_EXPORT bool LowerCaseEqualsASCII(const char16* a_begin,
187 const char16* a_end, 188 const char16* a_end,
188 const char* b); 189 const char* b);
189 190
190 // Unescapes the given string using URL escaping rules. 191 // Unescapes the given string using URL escaping rules.
191 void DecodeURLEscapeSequences(const char* input, int length, 192 URL_EXPORT void DecodeURLEscapeSequences(const char* input, int length,
192 url_canon::CanonOutputW* output); 193 url_canon::CanonOutputW* output);
193 194
194 // Escapes the given string as defined by the JS method encodeURIComponent. See 195 // Escapes the given string as defined by the JS method encodeURIComponent. See
195 // https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/encodeUR IComponent 196 // https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/encodeUR IComponent
196 void EncodeURIComponent(const char* input, int length, 197 URL_EXPORT void EncodeURIComponent(const char* input, int length,
197 url_canon::CanonOutput* output); 198 url_canon::CanonOutput* output);
198 199
199 200
200 } // namespace url_util 201 } // namespace url_util
201 202
202 #endif // URL_URL_UTIL_H_ 203 #endif // URL_URL_UTIL_H_
OLDNEW
« url/url_export.h ('K') | « url/url_parse.h ('k') | no next file » | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698