1 /*
2 * Copyright (C) 2018 Max Kellermann <max.kellermann@gmail.com>
3 *
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions
6 * are met:
7 *
8 * - Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 *
11 * - Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the
14 * distribution.
15 *
16 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
17 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
18 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
19 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
20 * FOUNDATION OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
21 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
22 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
23 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
25 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
26 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
27 * OF THE POSSIBILITY OF SUCH DAMAGE.
28 */
29
30 #ifndef HEX_FORMAT_HXX
31 #define HEX_FORMAT_HXX
32
33 #include "ConstBuffer.hxx"
34 #include "StringBuffer.hxx"
35
36 #include <cstddef>
37 #include <cstdint>
38
39 /**
40 * Format the given byte sequence into a null-terminated hexadecimal
41 * string.
42 *
43 * @param dest the destination buffer; must be large enough to hold
44 * all hex digits plus the null terminator
45 * @return a pointer to the generated null terminator
46 */
47 char *
48 HexFormat(char *dest, ConstBuffer<uint8_t> src) noexcept;
49
50 /**
51 * Like HexFormat(), but return a #StringBuffer with exactly the
52 * required size.
53 */
54 template<size_t size>
55 [[gnu::pure]]
56 auto
HexFormatBuffer(const uint8_t * src)57 HexFormatBuffer(const uint8_t *src) noexcept
58 {
59 StringBuffer<size * 2 + 1> dest;
60 HexFormat(dest.data(), {src, size});
61 return dest;
62 }
63
64 #endif
65