annotate tools/map/base64.hpp @ 86:cbdd3302998c

Tools: implement basic mlk-map, closes #620
author David Demelier <markand@malikania.fr>
date Tue, 31 Jan 2017 11:23:21 +0100
parents
children 4b292c20124c
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
86
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
1 /*
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
2 * base64.hpp -- base64 encoding and decoding
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
3 *
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
4 * Copyright (c) 2013-2017 David Demelier <markand@malikania.fr>
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
5 *
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
6 * Permission to use, copy, modify, and/or distribute this software for any
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
7 * purpose with or without fee is hereby granted, provided that the above
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
8 * copyright notice and this permission notice appear in all copies.
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
9 *
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
10 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
11 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
12 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
13 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
14 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
15 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
16 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
17 */
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
18
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
19 #ifndef MALIKANIA_BASE64_HPP
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
20 #define MALIKANIA_BASE64_HPP
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
21
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
22 /**
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
23 * \file base64.hpp
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
24 * \brief Base64 encoding and decoding.
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
25 * \author David Demelier <markand@malikania.fr>
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
26 * \version 2.0.0-dev
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
27 */
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
28
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
29 /**
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
30 * \page Base64 Base64
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
31 * \brief Base64 encoding and decoding.
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
32 *
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
33 * The %base64 library let you encode and decode %base64 data from std::string
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
34 * and iterators.
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
35 *
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
36 * ## Encoding
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
37 *
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
38 * You can encode like this:
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
39 *
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
40 * ````cpp
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
41 * std::string b64 = base64::encode("Hello world!");
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
42 * ````
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
43 *
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
44 * ## Decoding
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
45 *
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
46 * And you can decode like this:
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
47 *
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
48 * ````
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
49 * try {
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
50 * std::string text = base64::decode(msg);
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
51 * } catch (const std::exception &ex) {
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
52 * std::cerr << ex.what() << std::endl;
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
53 * }
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
54 * ````
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
55 */
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
56
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
57 #include <cassert>
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
58 #include <cctype>
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
59 #include <stdexcept>
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
60 #include <string>
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
61
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
62 namespace mlk {
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
63
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
64 /**
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
65 * \brief main %base64 namespace.
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
66 */
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
67 namespace base64 {
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
68
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
69 /**
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
70 * Check if the character is a %base64 character, A-Za-z0-9 and +/.
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
71 *
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
72 * \param ch the character to test
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
73 * \return true if valid
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
74 */
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
75 inline bool is_base64(char ch) noexcept
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
76 {
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
77 return std::isalnum(ch) != 0 || ch == '+' || ch == '/';
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
78 }
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
79
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
80 /**
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
81 * Check if the given character is a valid character in %base64 string,
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
82 * including '='.
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
83 *
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
84 * \param ch the character
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
85 * \return true if the character is valid
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
86 */
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
87 inline bool is_valid(char ch) noexcept
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
88 {
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
89 return is_base64(ch) || ch == '=';
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
90 }
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
91
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
92 /**
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
93 * Get the %base64 character from the 6-bits value.
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
94 *
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
95 * \pre value must be valid (< 64)
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
96 * \param value the value
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
97 * \return the %base64 character for value
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
98 */
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
99 inline char lookup(unsigned char value) noexcept
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
100 {
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
101 static const char *table = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
102
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
103 assert(value < 64);
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
104
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
105 return table[value];
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
106 }
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
107
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
108 /**
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
109 * Get the integer value from the %base64 character.
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
110 *
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
111 * \pre is_base64(ch)
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
112 * \param ch the %base64 character
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
113 * \return the integer value for the %base64 character ch
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
114 * ````
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
115 * auto b64 = base64::rlookup('D') // 3
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
116 * ````
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
117 */
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
118 inline unsigned char rlookup(char ch) noexcept
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
119 {
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
120 assert(is_base64(ch));
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
121
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
122 if (ch >= '0' && ch <= '9')
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
123 return static_cast<unsigned char>(ch + 4);
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
124 if (ch >= 'A' && ch <= 'Z')
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
125 return static_cast<unsigned char>(ch - 65);
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
126 if (ch >= 'a' && ch <= 'z')
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
127 return static_cast<unsigned char>(ch - 71);
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
128
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
129 return (ch == '+') ? 62U : 63U;
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
130 }
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
131
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
132 /**
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
133 * Encode the input to the output.
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
134 *
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
135 * Requirements:
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
136 * - **InputIt** must be [InputIterator](http://en.cppreference.com/w/cpp/concept/InputIterator)
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
137 * - **OutputIt** must be [OutputIterator](http://en.cppreference.com/w/cpp/concept/OutputIterator)
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
138 *
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
139 * \param input the beginning
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
140 * \param end the end of the data
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
141 * \param output the output destination
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
142 * \return output
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
143 */
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
144 template <typename InputIt, typename OutputIt>
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
145 OutputIt encode(InputIt input, InputIt end, OutputIt output)
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
146 {
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
147 while (input != end) {
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
148 char inputbuf[3] = { 0, 0, 0 };
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
149 int count;
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
150
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
151 for (count = 0; count < 3 && input != end; ++count)
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
152 inputbuf[count] = *input++;
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
153
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
154 *output++ = lookup(inputbuf[0] >> 2 & 0x3f);
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
155 *output++ = lookup((inputbuf[0] << 4 & 0x3f) | (inputbuf[1] >> 4 & 0x0f));
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
156 *output++ = (count < 2) ? '=' : lookup((inputbuf[1] << 2 & 0x3c) | (inputbuf[2] >> 6 & 0x03));
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
157 *output++ = (count < 3) ? '=' : lookup(inputbuf[2] & 0x3f);
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
158 }
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
159
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
160 return output;
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
161 }
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
162
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
163 /**
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
164 * Decode the input to the output.
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
165 *
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
166 * Requirements:
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
167 * - **InputIt** must be [InputIterator](http://en.cppreference.com/w/cpp/concept/InputIterator)
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
168 * - **OutputIt** must be [OutputIterator](http://en.cppreference.com/w/cpp/concept/OutputIterator)
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
169 *
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
170 * \param input the beginning
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
171 * \param end the end of the data
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
172 * \param output the output destination
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
173 * \return output
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
174 * \throw std::invalid_argument on bad %base64 string
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
175 */
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
176 template <typename InputIt, typename OutputIt>
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
177 OutputIt decode(InputIt input, InputIt end, OutputIt output)
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
178 {
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
179 while (input != end) {
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
180 char inputbuf[4] = { -1, -1, -1, -1 };
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
181 int count;
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
182
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
183 for (count = 0; count < 4 && input != end; ++count) {
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
184 // Check if the character is valid and get its value.
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
185 if ((*input == '=' && count <= 1) || !is_valid(*input))
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
186 throw std::invalid_argument("invalid base64 string");
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
187 if (is_base64(*input))
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
188 inputbuf[count] = static_cast<char>(rlookup(*input));
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
189
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
190 input++;
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
191 }
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
192
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
193 if (count != 4)
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
194 throw std::invalid_argument("truncated string");
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
195
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
196 *output++ = static_cast<char>(((inputbuf[0] << 2) & 0xfc) | ((inputbuf[1] >> 4) & 0x03));
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
197
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
198 if (inputbuf[2] != -1)
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
199 *output++ = static_cast<char>(((inputbuf[1] << 4) & 0xf0) | ((inputbuf[2] >> 2) & 0x0f));
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
200 if (inputbuf[3] != -1) {
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
201 // "XY=Z" is not allowed.
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
202 if (inputbuf[2] == -1)
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
203 throw std::invalid_argument("invalid base64 string");
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
204
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
205 *output++ = static_cast<char>(((inputbuf[2] << 6) & 0xc0) | (inputbuf[3] & 0x3f));
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
206 }
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
207 }
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
208
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
209 return output;
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
210 }
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
211
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
212 /**
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
213 * Encode a string.
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
214 *
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
215 * \param input the input string
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
216 * \return the %base64 formatted string
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
217 */
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
218 inline std::string encode(const std::string &input)
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
219 {
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
220 std::string result;
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
221
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
222 encode(input.begin(), input.end(), std::back_inserter(result));
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
223
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
224 return result;
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
225 }
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
226
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
227 /**
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
228 * Decode a string.
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
229 *
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
230 * \param input the %base64 formatted string
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
231 * \return the original string
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
232 * \throw std::invalid_argument on bad %base64 string
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
233 */
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
234 inline std::string decode(const std::string &input)
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
235 {
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
236 std::string result;
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
237
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
238 decode(input.begin(), input.end(), std::back_inserter(result));
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
239
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
240 return result;
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
241 }
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
242
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
243 } // !base64
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
244
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
245 } // !mlk
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
246
cbdd3302998c Tools: implement basic mlk-map, closes #620
David Demelier <markand@malikania.fr>
parents:
diff changeset
247 #endif // !MALIKANIA_BASE64_HPP