blob: a44af264803b8e797b1ab26959c0d55e356c72c2 [file] [log] [blame]
Jeff Thompson47eecfc2013-07-07 22:56:46 -07001/**
2 * @author: Jeff Thompson
Jeff Thompsone5b37a52013-07-08 15:39:01 -07003 * Derived from BinaryXMLDecoder.js by Meki Cheraoui.
Jeff Thompson47eecfc2013-07-07 22:56:46 -07004 * See COPYING for copyright and distribution information.
Jeff Thompson76317aa2013-06-25 19:11:48 -07005 */
6
7#include "BinaryXML.h"
8#include "BinaryXMLDecoder.h"
9
Jeff Thompsonb4ee4002013-06-28 13:41:43 -070010/**
11 * Return the octet at self->offset, converting to unsigned int. Increment self->offset.
12 * This does not check for reading past the end of the input, so this is called "unsafe".
13 */
Jeff Thompsonf0fea002013-07-30 17:22:42 -070014static inline unsigned int unsafeReadOctet(struct ndn_BinaryXmlDecoder *self)
Jeff Thompsonb4ee4002013-06-28 13:41:43 -070015{
16 return (unsigned int)(self->input[self->offset++] & 0xff);
17}
18
19/**
20 * Return the octet at self->offset, converting to unsigned int. Do not increment self->offset.
21 * This does not check for reading past the end of the input, so this is called "unsafe".
22 */
Jeff Thompsonf0fea002013-07-30 17:22:42 -070023static inline unsigned int unsafeGetOctet(struct ndn_BinaryXmlDecoder *self)
Jeff Thompsonb4ee4002013-06-28 13:41:43 -070024{
25 return (unsigned int)(self->input[self->offset] & 0xff);
26}
27
Jeff Thompson167ca5a2013-07-07 20:45:43 -070028/**
29 * Parse the value as a decimal unsigned integer. This does not check for whitespace or + sign.
30 * If valueLength is 0, this succeeds with resultOut 0.
31 * @param value
32 * @param valueLength
33 * @param resultOut output the parsed integer.
Jeff Thompson8b666002013-07-08 01:16:26 -070034 * @return 0 for success, else an error code, including if an element of value is not a decimal digit.
Jeff Thompson167ca5a2013-07-07 20:45:43 -070035 */
Jeff Thompson8b666002013-07-08 01:16:26 -070036static ndn_Error parseUnsignedDecimalInt(unsigned char *value, unsigned int valueLength, unsigned int *resultOut)
Jeff Thompson167ca5a2013-07-07 20:45:43 -070037{
38 unsigned int result = 0;
39
40 unsigned int i;
41 for (i = 0; i < valueLength; ++i) {
42 unsigned char digit = value[i];
43 if (!(digit >= '0' && digit <= '9'))
Jeff Thompson8b666002013-07-08 01:16:26 -070044 return NDN_ERROR_element_of_value_is_not_a_decimal_digit;
Jeff Thompson167ca5a2013-07-07 20:45:43 -070045
46 result *= 10;
47 result += (unsigned int)(digit - '0');
48 }
49
50 *resultOut = result;
51 return 0;
52}
53
Jeff Thompsonf0fea002013-07-30 17:22:42 -070054ndn_Error ndn_BinaryXmlDecoder_decodeTypeAndValue(struct ndn_BinaryXmlDecoder *self, unsigned int *type, unsigned int *valueOut)
Jeff Thompson82222e82013-06-26 19:32:59 -070055{
Jeff Thompson76317aa2013-06-25 19:11:48 -070056 unsigned int value = 0;
Jeff Thompson38cbd572013-06-28 14:01:10 -070057 int gotFirstOctet = 0;
Jeff Thompson76317aa2013-06-25 19:11:48 -070058
59 while (1) {
Jeff Thompsonf7316692013-06-26 21:31:42 -070060 if (self->offset >= self->inputLength)
Jeff Thompson8b666002013-07-08 01:16:26 -070061 return NDN_ERROR_read_past_the_end_of_the_input;
Jeff Thompson76317aa2013-06-25 19:11:48 -070062
Jeff Thompsonb4ee4002013-06-28 13:41:43 -070063 unsigned int octet = unsafeReadOctet(self);
Jeff Thompson76317aa2013-06-25 19:11:48 -070064
Jeff Thompson38cbd572013-06-28 14:01:10 -070065 if (!gotFirstOctet) {
66 if (octet == 0)
Jeff Thompson8b666002013-07-08 01:16:26 -070067 return NDN_ERROR_the_first_header_octet_may_not_be_zero;
Jeff Thompson38cbd572013-06-28 14:01:10 -070068
69 gotFirstOctet = 1;
70 }
71
Jeff Thompsonf0fea002013-07-30 17:22:42 -070072 if (octet & ndn_BinaryXml_TT_FINAL) {
Jeff Thompson76317aa2013-06-25 19:11:48 -070073 // Finished.
Jeff Thompsonf0fea002013-07-30 17:22:42 -070074 *type = octet & ndn_BinaryXml_TT_MASK;
75 value = (value << ndn_BinaryXml_TT_VALUE_BITS) | ((octet >> ndn_BinaryXml_TT_BITS) & ndn_BinaryXml_TT_VALUE_MASK);
Jeff Thompson76317aa2013-06-25 19:11:48 -070076 break;
77 }
78
Jeff Thompsonf0fea002013-07-30 17:22:42 -070079 value = (value << ndn_BinaryXml_REGULAR_VALUE_BITS) | (octet & ndn_BinaryXml_REGULAR_VALUE_MASK);
Jeff Thompson76317aa2013-06-25 19:11:48 -070080 }
81
82 *valueOut = value;
Jeff Thompsonb4ee4002013-06-28 13:41:43 -070083 return 0;
Jeff Thompson76317aa2013-06-25 19:11:48 -070084}
Jeff Thompson179d0502013-06-28 11:36:00 -070085
Jeff Thompsonf0fea002013-07-30 17:22:42 -070086ndn_Error ndn_BinaryXmlDecoder_readElementStartDTag(struct ndn_BinaryXmlDecoder *self, unsigned int expectedTag)
Jeff Thompson179d0502013-06-28 11:36:00 -070087{
Jeff Thompson8b666002013-07-08 01:16:26 -070088 ndn_Error error;
Jeff Thompson179d0502013-06-28 11:36:00 -070089 unsigned int type;
90 unsigned int value;
Jeff Thompsonf0fea002013-07-30 17:22:42 -070091 if (error = ndn_BinaryXmlDecoder_decodeTypeAndValue(self, &type, &value))
Jeff Thompson179d0502013-06-28 11:36:00 -070092 return error;
93
Jeff Thompsonf0fea002013-07-30 17:22:42 -070094 if (type != ndn_BinaryXml_DTAG)
Jeff Thompson8b666002013-07-08 01:16:26 -070095 return NDN_ERROR_header_type_is_not_a_DTAG;
Jeff Thompson179d0502013-06-28 11:36:00 -070096
Jeff Thompson74ab0812013-06-28 12:25:04 -070097 if (value != expectedTag)
Jeff Thompson8b666002013-07-08 01:16:26 -070098 return NDN_ERROR_did_not_get_the_expected_DTAG;
Jeff Thompson179d0502013-06-28 11:36:00 -070099
Jeff Thompsonb4ee4002013-06-28 13:41:43 -0700100 return 0;
Jeff Thompson74ab0812013-06-28 12:25:04 -0700101}
102
Jeff Thompsonf0fea002013-07-30 17:22:42 -0700103ndn_Error ndn_BinaryXmlDecoder_readElementClose(struct ndn_BinaryXmlDecoder *self)
Jeff Thompson74ab0812013-06-28 12:25:04 -0700104{
105 if (self->offset >= self->inputLength)
Jeff Thompson8b666002013-07-08 01:16:26 -0700106 return NDN_ERROR_read_past_the_end_of_the_input;
Jeff Thompson74ab0812013-06-28 12:25:04 -0700107
Jeff Thompsonf0fea002013-07-30 17:22:42 -0700108 if (unsafeReadOctet(self) != ndn_BinaryXml_CLOSE)
Jeff Thompson8b666002013-07-08 01:16:26 -0700109 return NDN_ERROR_did_not_get_the_expected_element_close;
Jeff Thompson74ab0812013-06-28 12:25:04 -0700110
Jeff Thompsonb4ee4002013-06-28 13:41:43 -0700111 return 0;
Jeff Thompson74ab0812013-06-28 12:25:04 -0700112}
113
Jeff Thompsonf0fea002013-07-30 17:22:42 -0700114ndn_Error ndn_BinaryXmlDecoder_peekDTag(struct ndn_BinaryXmlDecoder *self, unsigned int expectedTag, int *gotExpectedTag)
Jeff Thompson74ab0812013-06-28 12:25:04 -0700115{
116 // Default to 0.
117 *gotExpectedTag = 0;
Jeff Thompson6d17b6e2013-06-28 14:04:01 -0700118
119 // First check if it is an element close (which cannot be the expected tag).
120 if (self->offset >= self->inputLength)
Jeff Thompson8b666002013-07-08 01:16:26 -0700121 return NDN_ERROR_read_past_the_end_of_the_input;
Jeff Thompson6d17b6e2013-06-28 14:04:01 -0700122 if (unsafeGetOctet(self) == 0)
123 return 0;
124
Jeff Thompson74ab0812013-06-28 12:25:04 -0700125 unsigned int type;
126 unsigned int value;
127 unsigned int saveOffset = self->offset;
Jeff Thompsonf0fea002013-07-30 17:22:42 -0700128 ndn_Error error = ndn_BinaryXmlDecoder_decodeTypeAndValue(self, &type, &value);
Jeff Thompsonb4ee4002013-06-28 13:41:43 -0700129 // Restore offset.
Jeff Thompson74ab0812013-06-28 12:25:04 -0700130 self->offset = saveOffset;
131
132 if (error)
133 return error;
134
Jeff Thompsonf0fea002013-07-30 17:22:42 -0700135 if (type == ndn_BinaryXml_DTAG && value == expectedTag)
Jeff Thompson74ab0812013-06-28 12:25:04 -0700136 *gotExpectedTag = 1;
137
Jeff Thompsonb4ee4002013-06-28 13:41:43 -0700138 return 0;
139}
140
Jeff Thompsonf0fea002013-07-30 17:22:42 -0700141ndn_Error ndn_BinaryXmlDecoder_readBinaryDTagElement
142 (struct ndn_BinaryXmlDecoder *self, unsigned int expectedTag, int allowNull, unsigned char **value, unsigned int *valueLength)
Jeff Thompsonb4ee4002013-06-28 13:41:43 -0700143{
Jeff Thompson8b666002013-07-08 01:16:26 -0700144 ndn_Error error;
Jeff Thompsonf0fea002013-07-30 17:22:42 -0700145 if (error = ndn_BinaryXmlDecoder_readElementStartDTag(self, expectedTag))
Jeff Thompsonb4ee4002013-06-28 13:41:43 -0700146 return error;
147
148 if (allowNull) {
149 if (self->offset >= self->inputLength)
Jeff Thompson8b666002013-07-08 01:16:26 -0700150 return NDN_ERROR_read_past_the_end_of_the_input;
Jeff Thompsonb4ee4002013-06-28 13:41:43 -0700151
Jeff Thompsonf0fea002013-07-30 17:22:42 -0700152 if (unsafeGetOctet(self) == ndn_BinaryXml_CLOSE) {
Jeff Thompsonb4ee4002013-06-28 13:41:43 -0700153 // The binary item is missing, and this is allowed, so read the element close and return a null value.
154 ++self->offset;
155 *value = 0;
Jeff Thompson033d7fd2013-07-11 10:44:03 -0700156 *valueLength = 0;
Jeff Thompsonb4ee4002013-06-28 13:41:43 -0700157 return 0;
158 }
159 }
160
161 unsigned int itemType;
Jeff Thompsonf0fea002013-07-30 17:22:42 -0700162 if (error = ndn_BinaryXmlDecoder_decodeTypeAndValue(self, &itemType, valueLength))
Jeff Thompsonb4ee4002013-06-28 13:41:43 -0700163 return error;
164 // Ignore itemType.
165 *value = self->input + self->offset;
Jeff Thompson033d7fd2013-07-11 10:44:03 -0700166 self->offset += *valueLength;
Jeff Thompsonb4ee4002013-06-28 13:41:43 -0700167
Jeff Thompsonf0fea002013-07-30 17:22:42 -0700168 if (error = ndn_BinaryXmlDecoder_readElementClose(self))
Jeff Thompsonb4ee4002013-06-28 13:41:43 -0700169 return error;
170
171 return 0;
172}
Jeff Thompson167ca5a2013-07-07 20:45:43 -0700173
Jeff Thompsonf0fea002013-07-30 17:22:42 -0700174ndn_Error ndn_BinaryXmlDecoder_readOptionalBinaryDTagElement
175 (struct ndn_BinaryXmlDecoder *self, unsigned int expectedTag, int allowNull, unsigned char **value, unsigned int *valueLength)
Jeff Thompson033d7fd2013-07-11 10:44:03 -0700176{
177 ndn_Error error;
178 int gotExpectedTag;
Jeff Thompsonf0fea002013-07-30 17:22:42 -0700179 if (error = ndn_BinaryXmlDecoder_peekDTag(self, expectedTag, &gotExpectedTag))
Jeff Thompson033d7fd2013-07-11 10:44:03 -0700180 return error;
181 if (gotExpectedTag) {
Jeff Thompsonf0fea002013-07-30 17:22:42 -0700182 if (error = ndn_BinaryXmlDecoder_readBinaryDTagElement(self, expectedTag, allowNull, value, valueLength))
Jeff Thompson033d7fd2013-07-11 10:44:03 -0700183 return error;
184 }
185 else {
186 *value = 0;
187 *valueLength = 0;
188 }
189
190 return 0;
191}
192
Jeff Thompsonf0fea002013-07-30 17:22:42 -0700193ndn_Error ndn_BinaryXmlDecoder_readUDataDTagElement
194 (struct ndn_BinaryXmlDecoder *self, unsigned int expectedTag, unsigned char **value, unsigned int *valueLength)
Jeff Thompson167ca5a2013-07-07 20:45:43 -0700195{
Jeff Thompson8b666002013-07-08 01:16:26 -0700196 ndn_Error error;
Jeff Thompsonf0fea002013-07-30 17:22:42 -0700197 if (error = ndn_BinaryXmlDecoder_readElementStartDTag(self, expectedTag))
Jeff Thompson167ca5a2013-07-07 20:45:43 -0700198 return error;
199
200 unsigned int itemType;
Jeff Thompsonf0fea002013-07-30 17:22:42 -0700201 if (error = ndn_BinaryXmlDecoder_decodeTypeAndValue(self, &itemType, valueLength))
Jeff Thompson167ca5a2013-07-07 20:45:43 -0700202 return error;
Jeff Thompsonf0fea002013-07-30 17:22:42 -0700203 if (itemType != ndn_BinaryXml_UDATA)
Jeff Thompson8b666002013-07-08 01:16:26 -0700204 return NDN_ERROR_item_is_not_UDATA;
Jeff Thompson167ca5a2013-07-07 20:45:43 -0700205 *value = self->input + self->offset;
Jeff Thompson033d7fd2013-07-11 10:44:03 -0700206 self->offset += *valueLength;
Jeff Thompson167ca5a2013-07-07 20:45:43 -0700207
Jeff Thompsonf0fea002013-07-30 17:22:42 -0700208 if (error = ndn_BinaryXmlDecoder_readElementClose(self))
Jeff Thompson167ca5a2013-07-07 20:45:43 -0700209 return error;
210
211 return 0;
212}
213
Jeff Thompsonf0fea002013-07-30 17:22:42 -0700214ndn_Error ndn_BinaryXmlDecoder_readUnsignedIntegerDTagElement
215 (struct ndn_BinaryXmlDecoder *self, unsigned int expectedTag, unsigned int *value)
Jeff Thompson167ca5a2013-07-07 20:45:43 -0700216{
217 unsigned char *udataValue;
218 unsigned int udataValueLength;
Jeff Thompson8b666002013-07-08 01:16:26 -0700219 ndn_Error error;
Jeff Thompsonf0fea002013-07-30 17:22:42 -0700220 if (error = ndn_BinaryXmlDecoder_readUDataDTagElement(self, expectedTag, &udataValue, &udataValueLength))
Jeff Thompson167ca5a2013-07-07 20:45:43 -0700221 return error;
222
223 if (error = parseUnsignedDecimalInt(udataValue, udataValueLength, value))
224 return error;
225
226 return 0;
227}
228
Jeff Thompsonf0fea002013-07-30 17:22:42 -0700229ndn_Error ndn_BinaryXmlDecoder_readOptionalUnsignedIntegerDTagElement
230 (struct ndn_BinaryXmlDecoder *self, unsigned int expectedTag, int *value)
Jeff Thompson167ca5a2013-07-07 20:45:43 -0700231{
232 int gotExpectedTag;
Jeff Thompson8b666002013-07-08 01:16:26 -0700233 ndn_Error error;
Jeff Thompsonf0fea002013-07-30 17:22:42 -0700234 if (error = ndn_BinaryXmlDecoder_peekDTag(self, expectedTag, &gotExpectedTag))
Jeff Thompson167ca5a2013-07-07 20:45:43 -0700235 return error;
236
237 if (!gotExpectedTag) {
Jeff Thompson5abaaca2013-07-07 21:16:04 -0700238 *value = -1;
Jeff Thompson167ca5a2013-07-07 20:45:43 -0700239 return 0;
240 }
241
242 unsigned int unsignedValue;
Jeff Thompsonf0fea002013-07-30 17:22:42 -0700243 if (error = ndn_BinaryXmlDecoder_readUnsignedIntegerDTagElement(self, expectedTag, &unsignedValue))
Jeff Thompson167ca5a2013-07-07 20:45:43 -0700244 return error;
245
246 *value = (int)unsignedValue;
247 return 0;
248}
Jeff Thompson5abaaca2013-07-07 21:16:04 -0700249
Jeff Thompsonf0fea002013-07-30 17:22:42 -0700250ndn_Error ndn_BinaryXmlDecoder_readTimeMillisecondsDTagElement
251 (struct ndn_BinaryXmlDecoder *self, unsigned int expectedTag, double *milliseconds)
Jeff Thompson9693d392013-07-11 14:58:53 -0700252{
253 ndn_Error error;
254 unsigned char *bytes;
255 unsigned int bytesLength;
Jeff Thompsonf0fea002013-07-30 17:22:42 -0700256 if (error = ndn_BinaryXmlDecoder_readBinaryDTagElement(self, expectedTag, 0, &bytes, &bytesLength))
Jeff Thompson9693d392013-07-11 14:58:53 -0700257 return error;
258
Jeff Thompsonf0fea002013-07-30 17:22:42 -0700259 *milliseconds = 1000.0 * ndn_BinaryXmlDecoder_unsignedBigEndianToDouble(bytes, bytesLength) / 4096.0;
Jeff Thompson9693d392013-07-11 14:58:53 -0700260 return 0;
261}
262
Jeff Thompsonf0fea002013-07-30 17:22:42 -0700263ndn_Error ndn_BinaryXmlDecoder_readOptionalTimeMillisecondsDTagElement
264 (struct ndn_BinaryXmlDecoder *self, unsigned int expectedTag, double *milliseconds)
Jeff Thompson9693d392013-07-11 14:58:53 -0700265{
266 int gotExpectedTag;
267 ndn_Error error;
Jeff Thompsonf0fea002013-07-30 17:22:42 -0700268 if (error = ndn_BinaryXmlDecoder_peekDTag(self, expectedTag, &gotExpectedTag))
Jeff Thompson9693d392013-07-11 14:58:53 -0700269 return error;
270
271 if (!gotExpectedTag) {
Jeff Thompsone32dc5d2013-07-11 17:56:57 -0700272 *milliseconds = -1.0;
Jeff Thompson9693d392013-07-11 14:58:53 -0700273 return 0;
274 }
275
Jeff Thompsonf0fea002013-07-30 17:22:42 -0700276 if (error = ndn_BinaryXmlDecoder_readTimeMillisecondsDTagElement(self, expectedTag, milliseconds))
Jeff Thompson9693d392013-07-11 14:58:53 -0700277 return error;
278
279 return 0;
280}
281
Jeff Thompsonf0fea002013-07-30 17:22:42 -0700282double ndn_BinaryXmlDecoder_unsignedBigEndianToDouble(unsigned char *bytes, unsigned int bytesLength)
Jeff Thompson5abaaca2013-07-07 21:16:04 -0700283{
Jeff Thompson5553d992013-07-11 14:35:45 -0700284 double result = 0.0;
Jeff Thompson5abaaca2013-07-07 21:16:04 -0700285 unsigned int i;
286 for (i = 0; i < bytesLength; ++i) {
Jeff Thompson5553d992013-07-11 14:35:45 -0700287 result *= 256.0;
288 result += (double)bytes[i];
Jeff Thompson5abaaca2013-07-07 21:16:04 -0700289 }
290
291 return result;
292}