|
185
|
1 /* |
|
|
2 * Pack.h -- binary data serialization |
|
|
3 * |
|
|
4 * Copyright (c) 2013 David Demelier <markand@malikania.fr> |
|
|
5 * |
|
|
6 * Permission to use, copy, modify, and/or distribute this software for any |
|
|
7 * purpose with or without fee is hereby granted, provided that the above |
|
|
8 * copyright notice and this permission notice appear in all copies. |
|
|
9 * |
|
|
10 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES |
|
|
11 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF |
|
|
12 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR |
|
|
13 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES |
|
|
14 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN |
|
|
15 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF |
|
|
16 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. |
|
|
17 */ |
|
|
18 |
|
|
19 #ifndef _PACK_H_ |
|
|
20 #define _PACK_H_ |
|
|
21 |
|
|
22 #include <cstdint> |
|
|
23 #include <fstream> |
|
|
24 #include <stdexcept> |
|
|
25 #include <string> |
|
|
26 |
|
|
27 /** |
|
|
28 * @class Pack |
|
|
29 * @brief Serialize binary data to files |
|
|
30 * |
|
|
31 * This class write and read binary data from files. It currently |
|
|
32 * support: |
|
|
33 * uint8_t, |
|
|
34 * uint16_t, |
|
|
35 * uint32_t, |
|
|
36 * uint64_t |
|
|
37 */ |
|
|
38 class Pack { |
|
|
39 public: |
|
|
40 /** |
|
|
41 * @enum Endian |
|
|
42 * @brief Endian mode |
|
|
43 */ |
|
|
44 enum Endian { |
|
|
45 Little, //! Little endian |
|
|
46 Big //! Big endian |
|
|
47 }; |
|
|
48 |
|
|
49 public: |
|
219
|
50 /** |
|
|
51 * Host system endian mode. |
|
|
52 */ |
|
185
|
53 static const Endian mode; |
|
|
54 |
|
|
55 /** |
|
|
56 * @struct TypeInfo |
|
|
57 * @brief Type information |
|
|
58 * |
|
|
59 * Used for conversions. |
|
|
60 */ |
|
|
61 template <typename T> |
|
|
62 struct TypeInfo { |
|
|
63 static const bool supported = false; |
|
|
64 }; |
|
|
65 |
|
|
66 /** |
|
266
|
67 * Convert data only if the requested endian is different. |
|
185
|
68 * |
|
|
69 * @param value the value to convert if needed |
|
|
70 * @param endian the endian mode |
|
|
71 * @return the converted value |
|
|
72 */ |
|
|
73 template <typename T> |
|
266
|
74 static inline T convert(T value, Endian endian) |
|
|
75 { |
|
|
76 static_assert(TypeInfo<T>::supported, "unsupported type"); |
|
|
77 |
|
|
78 if (endian != mode) |
|
267
|
79 return TypeInfo<T>::convert(value); |
|
266
|
80 |
|
|
81 return value; |
|
|
82 } |
|
|
83 |
|
|
84 /** |
|
|
85 * Write nothing, stop recursion. |
|
|
86 */ |
|
|
87 static void write(std::ostream &, Endian) |
|
|
88 { |
|
|
89 } |
|
185
|
90 |
|
|
91 /** |
|
266
|
92 * Write binary data to the stream. |
|
|
93 * |
|
|
94 * @param out the output stream |
|
|
95 * @param endian the endian mode |
|
|
96 * @param args the arguments |
|
|
97 * @throw std::runtime_exception on error |
|
|
98 */ |
|
|
99 template <typename T, typename... Args> |
|
|
100 static void write(std::ostream &out, Endian endian, const T &value, const Args&... args) |
|
|
101 { |
|
268
|
102 auto ret = convert(value, endian); |
|
266
|
103 out.write(reinterpret_cast<const char *>(&ret), TypeInfo<T>::size); |
|
|
104 write(out, endian, args...); |
|
|
105 } |
|
|
106 |
|
|
107 /** |
|
|
108 * Read nothing, stop recursion. |
|
|
109 */ |
|
|
110 static void read(std::istream &, Endian) |
|
|
111 { |
|
185
|
112 } |
|
|
113 |
|
|
114 /** |
|
266
|
115 * Read binary data from the stream. |
|
|
116 * |
|
|
117 * @param in the input stream |
|
|
118 * @param endian the endian mode |
|
|
119 * @param args the arguments |
|
|
120 * @throw std::runtime_exception on error |
|
|
121 */ |
|
|
122 template <typename T, typename... Args> |
|
|
123 static void read(std::istream &in, Endian endian, T &value, Args&... args) |
|
|
124 { |
|
|
125 in.read(reinterpret_cast<char *>(&value), TypeInfo<T>::size); |
|
|
126 value = convert(value, endian); |
|
|
127 read(in, endian, args...); |
|
|
128 } |
|
|
129 |
|
|
130 /** |
|
268
|
131 * Read array and store it to the output iterator. Because the container |
|
|
132 * is not allocated, we use an integer based size to determine the |
|
|
133 * number of bytes to read. |
|
185
|
134 * |
|
268
|
135 * @param in the input stream |
|
185
|
136 * @param endian the endian mode |
|
268
|
137 * @param out the output it |
|
|
138 * @param count the number of bytes to read |
|
|
139 * @throw std::runtime_error on error |
|
185
|
140 */ |
|
268
|
141 template <typename OutputIt> |
|
|
142 static void readArray(std::istream &in, Endian endian, OutputIt out, unsigned count) |
|
185
|
143 { |
|
268
|
144 typename OutputIt::container_type::value_type byte; |
|
|
145 |
|
|
146 for (unsigned i = 0; i < count; ++i) { |
|
|
147 read(in, endian, byte); |
|
|
148 *out++ = byte; |
|
|
149 } |
|
|
150 } |
|
185
|
151 |
|
268
|
152 /** |
|
|
153 * Read a container from an input iterator and write it to output stream. |
|
|
154 * |
|
|
155 * @param out the output stream |
|
|
156 * @param endian the endian mode |
|
|
157 * @param in the input iterator |
|
|
158 * @param count the number of bytes to write |
|
|
159 * @throw std::runtime_error on error |
|
|
160 */ |
|
|
161 template <typename InputIt> |
|
|
162 static void writeArray(std::ostream &out, Endian endian, InputIt in, unsigned count) |
|
|
163 { |
|
|
164 typename std::iterator_traits<InputIt>::value_type byte; |
|
185
|
165 |
|
268
|
166 for (unsigned i = 0; i < count; ++i) { |
|
|
167 byte = *in++; |
|
|
168 write(out, endian, byte); |
|
|
169 } |
|
185
|
170 } |
|
|
171 }; |
|
|
172 |
|
|
173 template <> |
|
|
174 struct Pack::TypeInfo<uint8_t> { |
|
266
|
175 static constexpr const bool supported = true; |
|
|
176 static constexpr const size_t size = sizeof (uint8_t); |
|
|
177 |
|
267
|
178 static constexpr uint8_t convert(uint8_t v) |
|
266
|
179 { |
|
|
180 return v; |
|
|
181 } |
|
185
|
182 }; |
|
|
183 |
|
|
184 template <> |
|
|
185 struct Pack::TypeInfo<uint16_t> { |
|
266
|
186 static constexpr const bool supported = true; |
|
|
187 static constexpr const size_t size = sizeof (uint16_t); |
|
|
188 |
|
267
|
189 static constexpr uint16_t convert(uint16_t v) |
|
266
|
190 { |
|
|
191 return (((v >> 8) & 0x00FFL) | ((v << 8) & 0xFF00L)); |
|
|
192 } |
|
185
|
193 }; |
|
|
194 |
|
|
195 template <> |
|
|
196 struct Pack::TypeInfo<uint32_t> { |
|
266
|
197 static constexpr const bool supported = true; |
|
|
198 static constexpr const size_t size = sizeof (uint32_t); |
|
|
199 |
|
267
|
200 static constexpr uint32_t convert(uint32_t v) |
|
266
|
201 { |
|
|
202 return ((((v) >> 24) & 0x000000FFL) |
|
|
203 | (((v) >> 8) & 0x0000FF00L) |
|
|
204 | (((v) << 8) & 0x00FF0000L) |
|
|
205 | (((v) << 24) & 0xFF000000L)); |
|
|
206 } |
|
185
|
207 }; |
|
|
208 |
|
|
209 template <> |
|
|
210 struct Pack::TypeInfo<uint64_t> { |
|
266
|
211 static constexpr const bool supported = true; |
|
|
212 static constexpr const size_t size = sizeof (uint64_t); |
|
185
|
213 |
|
267
|
214 static constexpr uint64_t convert(uint64_t v) |
|
266
|
215 { |
|
185
|
216 return ((((v) & 0xff00000000000000ull) >> 56) |
|
|
217 | (((v) & 0x00ff000000000000ull) >> 40) |
|
|
218 | (((v) & 0x0000ff0000000000ull) >> 24) |
|
|
219 | (((v) & 0x000000ff00000000ull) >> 8 ) |
|
|
220 | (((v) & 0x00000000ff000000ull) << 8 ) |
|
|
221 | (((v) & 0x0000000000ff0000ull) << 24) |
|
|
222 | (((v) & 0x000000000000ff00ull) << 40) |
|
|
223 | (((v) & 0x00000000000000ffull) << 56)); |
|
266
|
224 } |
|
|
225 }; |
|
185
|
226 |
|
|
227 #endif // !_PACK_H_ |
