|
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 private: |
|
223
|
50 static void writeFile(std::ofstream &, Endian) |
|
185
|
51 { |
|
|
52 // dummy, stop recursion |
|
|
53 } |
|
|
54 |
|
|
55 template <typename T, typename... Args> |
|
|
56 static void writeFile(std::ofstream &out, Endian endian, const T &value, Args&... args) |
|
|
57 { |
|
|
58 static_assert(TypeInfo<T>::supported, "unsupported type"); |
|
|
59 |
|
|
60 T ret = convert(value, endian); |
|
223
|
61 out.write(reinterpret_cast<const char *>(&ret), TypeInfo<T>::size); |
|
185
|
62 writeFile(out, endian, args...); |
|
|
63 } |
|
|
64 |
|
223
|
65 static void readFile(std::ifstream &, Endian) |
|
185
|
66 { |
|
|
67 // dummy, stop recursion |
|
|
68 } |
|
|
69 |
|
|
70 template <typename T, typename... Args> |
|
|
71 static void readFile(std::ifstream &in, Endian endian, T &value, Args&&... args) |
|
|
72 { |
|
|
73 static_assert(TypeInfo<T>::supported, "unsupported type"); |
|
|
74 |
|
223
|
75 in.read(reinterpret_cast<char *>(&value), TypeInfo<T>::size); |
|
185
|
76 value = convert(value, endian); |
|
|
77 readFile(in, endian, args...); |
|
|
78 } |
|
|
79 |
|
|
80 public: |
|
219
|
81 /** |
|
|
82 * Host system endian mode. |
|
|
83 */ |
|
185
|
84 static const Endian mode; |
|
|
85 |
|
|
86 /** |
|
|
87 * @struct TypeInfo |
|
|
88 * @brief Type information |
|
|
89 * |
|
|
90 * Used for conversions. |
|
|
91 */ |
|
|
92 template <typename T> |
|
|
93 struct TypeInfo { |
|
|
94 static const bool supported = false; |
|
|
95 static const size_t size = 0; |
|
|
96 }; |
|
|
97 |
|
|
98 /** |
|
|
99 * Convert data. |
|
|
100 * |
|
|
101 * @param value the value to convert if needed |
|
|
102 * @param endian the endian mode |
|
|
103 * @return the converted value |
|
|
104 */ |
|
|
105 template <typename T> |
|
|
106 static T convert(T value, Endian endian); |
|
|
107 |
|
|
108 /** |
|
|
109 * Write binary data to the file |
|
|
110 * |
|
|
111 * @param path the path to the file |
|
|
112 * @param endian the endian mode |
|
|
113 * @param args the arguments |
|
|
114 * @throw std::runtime_exception on error |
|
|
115 */ |
|
|
116 template <typename... Args> |
|
|
117 static void write(const std::string &path, |
|
|
118 Endian endian, |
|
|
119 Args&&... args) |
|
|
120 { |
|
|
121 std::ofstream out; |
|
|
122 |
|
|
123 out.open(path, std::ios_base::binary); |
|
|
124 if (!out.is_open()) |
|
|
125 throw std::runtime_error("Can't open file for writing"); |
|
|
126 |
|
|
127 writeFile(out, endian, std::forward<Args>(args)...); |
|
|
128 } |
|
|
129 |
|
|
130 /** |
|
|
131 * Read binary data from the file |
|
|
132 * |
|
|
133 * @param path the path to the file |
|
|
134 * @param endian the endian mode |
|
|
135 * @param args the arguments |
|
|
136 * @throw std::runtime_exception on error |
|
|
137 */ |
|
|
138 template <typename... Args> |
|
|
139 static void read(const std::string &path, |
|
|
140 Endian endian, |
|
|
141 Args&&... args) |
|
|
142 { |
|
|
143 std::ifstream in; |
|
|
144 |
|
|
145 in.open(path, std::ios_base::binary); |
|
|
146 if (!in.is_open()) |
|
|
147 throw std::runtime_error("Can't open file for reading"); |
|
|
148 |
|
|
149 readFile(in, endian, std::forward<Args>(args)...); |
|
|
150 } |
|
|
151 }; |
|
|
152 |
|
|
153 template <> |
|
|
154 struct Pack::TypeInfo<uint8_t> { |
|
|
155 static const bool supported = true; |
|
|
156 static const size_t size = 1; |
|
|
157 }; |
|
|
158 |
|
|
159 template <> |
|
|
160 struct Pack::TypeInfo<uint16_t> { |
|
|
161 static const bool supported = true; |
|
|
162 static const size_t size = 2; |
|
|
163 }; |
|
|
164 |
|
|
165 template <> |
|
|
166 struct Pack::TypeInfo<uint32_t> { |
|
|
167 static const bool supported = true; |
|
|
168 static const size_t size = 4; |
|
|
169 }; |
|
|
170 |
|
|
171 template <> |
|
|
172 struct Pack::TypeInfo<uint64_t> { |
|
|
173 static const bool supported = true; |
|
|
174 static const size_t size = 8; |
|
|
175 }; |
|
|
176 |
|
|
177 template <> |
|
223
|
178 inline uint8_t Pack::convert(uint8_t v, Endian) |
|
185
|
179 { |
|
|
180 return v; |
|
|
181 } |
|
|
182 |
|
|
183 template <> |
|
223
|
184 inline uint16_t Pack::convert(uint16_t v, Endian endian) |
|
185
|
185 { |
|
|
186 if (mode != endian) |
|
|
187 return (((v >> 8) & 0x00FFL) | ((v << 8) & 0xFF00L)); |
|
|
188 |
|
|
189 return v; |
|
|
190 } |
|
|
191 |
|
|
192 template <> |
|
223
|
193 inline uint32_t Pack::convert(uint32_t v, Endian endian) |
|
185
|
194 { |
|
|
195 if (mode != endian) |
|
|
196 return ((((v) >> 24) & 0x000000FFL) |
|
|
197 | (((v) >> 8) & 0x0000FF00L) |
|
|
198 | (((v) << 8) & 0x00FF0000L) |
|
|
199 | (((v) << 24) & 0xFF000000L)); |
|
|
200 |
|
|
201 return v; |
|
|
202 } |
|
|
203 |
|
|
204 template <> |
|
223
|
205 inline uint64_t Pack::convert(uint64_t v, Endian endian) |
|
185
|
206 { |
|
|
207 if (mode != endian) |
|
|
208 return ((((v) & 0xff00000000000000ull) >> 56) |
|
|
209 | (((v) & 0x00ff000000000000ull) >> 40) |
|
|
210 | (((v) & 0x0000ff0000000000ull) >> 24) |
|
|
211 | (((v) & 0x000000ff00000000ull) >> 8 ) |
|
|
212 | (((v) & 0x00000000ff000000ull) << 8 ) |
|
|
213 | (((v) & 0x0000000000ff0000ull) << 24) |
|
|
214 | (((v) & 0x000000000000ff00ull) << 40) |
|
|
215 | (((v) & 0x00000000000000ffull) << 56)); |
|
|
216 |
|
|
217 return v; |
|
|
218 } |
|
|
219 |
|
|
220 #endif // !_PACK_H_ |
