GCC Code Coverage Report

Directory: libs/url/
File: include/boost/url/impl/encode.hpp
Date: 2025-11-12 22:47:45
Exec Total Coverage
Lines: 113 113 100.0%
Functions: 17 20 85.0%
Branches: 78 100 78.0%
Line Branch Exec Source
1 //
2 // Copyright (c) 2019 Vinnie Falco (vinnie.falco@gmail.com)
3 //
4 // Distributed under the Boost Software License, Version 1.0. (See accompanying
5 // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
6 //
7 // Official repository: https://github.com/boostorg/url
8 //
9
10 #ifndef BOOST_URL_IMPL_ENCODE_HPP
11 #define BOOST_URL_IMPL_ENCODE_HPP
12
13 #include "boost/url/grammar/token_rule.hpp"
14 #include <boost/assert.hpp>
15 #include <boost/core/detail/static_assert.hpp>
16 #include <boost/url/detail/encode.hpp>
17 #include <boost/url/detail/except.hpp>
18 #include <boost/url/encoding_opts.hpp>
19 #include <boost/url/grammar/charset.hpp>
20 #include <boost/url/grammar/hexdig_chars.hpp>
21 #include <boost/url/grammar/string_token.hpp>
22 #include <boost/url/grammar/type_traits.hpp>
23
24 namespace boost {
25 namespace urls {
26
27 //------------------------------------------------
28
29 template<BOOST_URL_CONSTRAINT(grammar::CharSet) CS>
30 std::size_t
31 925 encoded_size(
32 core::string_view s,
33 CS const& allowed,
34 encoding_opts opt) noexcept
35 {
36 /*
37 If you get a compilation error here, it
38 means that the value you passed does
39 not meet the requirements stated in
40 the documentation.
41 */
42 BOOST_CORE_STATIC_ASSERT(
43 grammar::is_charset<CS>::value);
44
45 925 std::size_t n = 0;
46 925 auto it = s.data();
47 925 auto const last = it + s.size();
48
49
2/2
✓ Branch 0 taken 685 times.
✓ Branch 1 taken 192 times.
 925 if (!opt.space_as_plus)
50 {
51
2/2
✓ Branch 0 taken 2625 times.
✓ Branch 1 taken 685 times.
 3371 while (it != last)
52 {
53 2663 char const c = *it;
54
2/2
✓ Branch 1 taken 2501 times.
✓ Branch 2 taken 124 times.
 2663 if (allowed(c))
55 {
56 2520 ++n;
57 }
58 else
59 {
60 143 n += 3;
61 }
62 2663 ++it;
63 }
64 }
65 else
66 {
67 // '+' is always encoded (thus
68 // spending 3 chars) even if
69 // allowed because "%2B" and
70 // "+" have different meanings
71 // when space as plus is enabled
72 using FNT = bool (*)(CS const& allowed, char);
73 217 FNT takes_one_char =
74
2/2
✓ Branch 1 taken 190 times.
✓ Branch 2 taken 2 times.
 434 allowed('+') ?
75
2/2
✓ Branch 1 taken 1 times.
✓ Branch 2 taken 189 times.
 213 (allowed(' ') ?
76
0/4
✗ Branch 2 not taken.
✗ Branch 3 not taken.
✗ Branch 4 not taken.
✗ Branch 5 not taken.
 5 FNT([](CS const& allowed, char c){ return allowed(c) && c != '+'; }) :
77
6/6
✓ Branch 2 taken 41 times.
✓ Branch 3 taken 1358 times.
✓ Branch 4 taken 17 times.
✓ Branch 5 taken 24 times.
✓ Branch 6 taken 1367 times.
✓ Branch 7 taken 8 times.
 1642 FNT([](CS const& allowed, char c){ return (allowed(c) || c == ' ') && c != '+'; })) :
78
2/2
✓ Branch 1 taken 1 times.
✓ Branch 2 taken 1 times.
 4 (allowed(' ') ?
79 5 FNT([](CS const& allowed, char c){ return allowed(c); }) :
80
0/4
✗ Branch 2 not taken.
✗ Branch 3 not taken.
✗ Branch 4 not taken.
✗ Branch 5 not taken.
 5 FNT([](CS const& allowed, char c){ return allowed(c) || c == ' '; }));
81
2/2
✓ Branch 0 taken 1440 times.
✓ Branch 1 taken 192 times.
 1698 while (it != last)
82 {
83 1481 char const c = *it;
84
2/2
✓ Branch 1 taken 1394 times.
✓ Branch 2 taken 46 times.
 1481 if (takes_one_char(allowed, c))
85 {
86 1421 ++n;
87 }
88 else
89 {
90 60 n += 3;
91 }
92 1481 ++it;
93 }
94 }
95 925 return n;
96 }
97
98 //------------------------------------------------
99
100 template<BOOST_URL_CONSTRAINT(grammar::CharSet) CS>
101 std::size_t
102 617 encode(
103 char* dest,
104 std::size_t size,
105 core::string_view s,
106 CS const& allowed,
107 encoding_opts opt)
108 {
109 /* If you get a compilation error here, it
110 means that the value you passed does
111 not meet the requirements stated in
112 the documentation.
113 */
114 BOOST_CORE_STATIC_ASSERT(
115 grammar::is_charset<CS>::value);
116
117 // '%' must be reserved
118
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 560 times.
 617 BOOST_ASSERT(!allowed('%'));
119
120 617 char const* const hex =
121 617 detail::hexdigs[opt.lower_case];
122 732 auto const encode = [hex](
123 char*& dest,
124 unsigned char c) noexcept
125 {
126 115 *dest++ = '%';
127 115 *dest++ = hex[c>>4];
128 115 *dest++ = hex[c&0xf];
129 };
130
131 617 auto it = s.data();
132 617 auto const end = dest + size;
133 617 auto const last = it + s.size();
134 617 auto const dest0 = dest;
135 617 auto const end3 = end - 3;
136
137
2/2
✓ Branch 0 taken 368 times.
✓ Branch 1 taken 192 times.
 617 if (!opt.space_as_plus)
138 {
139
2/2
✓ Branch 0 taken 1481 times.
✓ Branch 1 taken 350 times.
 1903 while(it != last)
140 {
141 1540 char const c = *it;
142
2/2
✓ Branch 1 taken 1389 times.
✓ Branch 2 taken 92 times.
 1540 if (allowed(c))
143 {
144
2/2
✓ Branch 0 taken 3 times.
✓ Branch 1 taken 1386 times.
 1419 if(dest == end)
145 6 return dest - dest0;
146 1413 *dest++ = c;
147 1413 ++it;
148 1413 continue;
149 }
150
2/2
✓ Branch 0 taken 15 times.
✓ Branch 1 taken 77 times.
 121 if (dest > end3)
151 30 return dest - dest0;
152 91 encode(dest, c);
153 91 ++it;
154 }
155 363 return dest - dest0;
156 }
157 else
158 {
159
2/2
✓ Branch 0 taken 1424 times.
✓ Branch 1 taken 178 times.
 1654 while (it != last)
160 {
161 1464 char const c = *it;
162
2/2
✓ Branch 0 taken 25 times.
✓ Branch 1 taken 1399 times.
 1464 if (c == ' ')
163 {
164
2/2
✓ Branch 0 taken 2 times.
✓ Branch 1 taken 23 times.
 34 if(dest == end)
165 4 return dest - dest0;
166 30 *dest++ = '+';
167 30 ++it;
168 30 continue;
169 }
170 2792 else if (
171
6/6
✓ Branch 1 taken 1360 times.
✓ Branch 2 taken 39 times.
✓ Branch 3 taken 1352 times.
✓ Branch 4 taken 8 times.
✓ Branch 5 taken 1352 times.
✓ Branch 6 taken 47 times.
 1430 allowed(c) &&
172 c != '+')
173 {
174
2/2
✓ Branch 0 taken 3 times.
✓ Branch 1 taken 1349 times.
 1368 if(dest == end)
175 6 return dest - dest0;
176 1362 *dest++ = c;
177 1362 ++it;
178 1362 continue;
179 }
180
2/2
✓ Branch 0 taken 9 times.
✓ Branch 1 taken 38 times.
 62 if(dest > end3)
181 18 return dest - dest0;
182 44 encode(dest, c);
183 44 ++it;
184 }
185 }
186 190 return dest - dest0;
187 }
188
189 //------------------------------------------------
190
191 // unsafe encode just
192 // asserts on the output buffer
193 //
194 template<BOOST_URL_CONSTRAINT(grammar::CharSet) CS>
195 std::size_t
196 202 encode_unsafe(
197 char* dest,
198 std::size_t size,
199 core::string_view s,
200 CS const& allowed,
201 encoding_opts opt)
202 {
203 BOOST_CORE_STATIC_ASSERT(
204 grammar::is_charset<CS>::value);
205
206 // '%' must be reserved
207
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 181 times.
 202 BOOST_ASSERT(!allowed('%'));
208
209 202 auto it = s.data();
210 202 auto const last = it + s.size();
211 202 auto const end = dest + size;
212 ignore_unused(end);
213
214 202 char const* const hex =
215 202 detail::hexdigs[opt.lower_case];
216 304 auto const encode = [end, hex](
217 char*& dest,
218 unsigned char c) noexcept
219 {
220 51 ignore_unused(end);
221 51 *dest++ = '%';
222
5/10
✗ Branch 0 not taken.
✓ Branch 1 taken 36 times.
✗ Branch 3 not taken.
✓ Branch 4 taken 1 times.
✗ Branch 6 not taken.
✓ Branch 7 taken 1 times.
✗ Branch 9 not taken.
✓ Branch 10 taken 1 times.
✗ Branch 12 not taken.
✓ Branch 13 taken 12 times.
 51 BOOST_ASSERT(dest != end);
223 51 *dest++ = hex[c>>4];
224
5/10
✗ Branch 0 not taken.
✓ Branch 1 taken 36 times.
✗ Branch 3 not taken.
✓ Branch 4 taken 1 times.
✗ Branch 6 not taken.
✓ Branch 7 taken 1 times.
✗ Branch 9 not taken.
✓ Branch 10 taken 1 times.
✗ Branch 12 not taken.
✓ Branch 13 taken 12 times.
 51 BOOST_ASSERT(dest != end);
225 51 *dest++ = hex[c&0xf];
226 };
227
228 202 auto const dest0 = dest;
229
2/2
✓ Branch 0 taken 168 times.
✓ Branch 1 taken 13 times.
 202 if (!opt.space_as_plus)
230 {
231
2/2
✓ Branch 0 taken 455 times.
✓ Branch 1 taken 168 times.
 646 while(it != last)
232 {
233
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 455 times.
 469 BOOST_ASSERT(dest != end);
234 469 char const c = *it;
235
2/2
✓ Branch 1 taken 412 times.
✓ Branch 2 taken 43 times.
 469 if(allowed(c))
236 {
237 418 *dest++ = c;
238 }
239 else
240 {
241 51 encode(dest, c);
242 }
243 469 ++it;
244 }
245 }
246 else
247 {
248
2/2
✓ Branch 0 taken 40 times.
✓ Branch 1 taken 13 times.
 90 while(it != last)
249 {
250
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 40 times.
 65 BOOST_ASSERT(dest != end);
251 65 char const c = *it;
252
2/2
✓ Branch 0 taken 9 times.
✓ Branch 1 taken 31 times.
 65 if (c == ' ')
253 {
254 17 *dest++ = '+';
255 }
256 48 else if (
257
6/6
✓ Branch 1 taken 26 times.
✓ Branch 2 taken 5 times.
✓ Branch 3 taken 23 times.
✓ Branch 4 taken 3 times.
✓ Branch 5 taken 23 times.
✓ Branch 6 taken 8 times.
 48 allowed(c) &&
258 c != '+')
259 {
260 32 *dest++ = c;
261 }
262 else
263 {
264 16 encode(dest, c);
265 }
266 65 ++it;
267 }
268 }
269 202 return dest - dest0;
270 }
271
272 //------------------------------------------------
273
274 template<
275 BOOST_URL_CONSTRAINT(string_token::StringToken) StringToken,
276 BOOST_URL_CONSTRAINT(grammar::CharSet) CS>
277 BOOST_URL_STRTOK_RETURN
278 28 encode(
279 core::string_view s,
280 CS const& allowed,
281 encoding_opts opt,
282 StringToken&& token) noexcept
283 {
284 BOOST_CORE_STATIC_ASSERT(
285 grammar::is_charset<CS>::value);
286
287 28 auto const n = encoded_size(
288 s, allowed, opt);
289 28 auto p = token.prepare(n);
290 28 if(n > 0)
291 26 encode_unsafe(
292 p, n, s, allowed, opt);
293 28 return token.result();
294 }
295
296 } // urls
297 } // boost
298
299 #endif
300