1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376
/*
==--==--==--==--==--==--==--==--==--==--==--==--==--==--==--==--
Binn-IR
Copyright (C) 2018-2023 Anonymous
There are several releases over multiple years,
they are listed as ranges, such as: "2018-2023".
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public License
along with this program. If not, see <https://www.gnu.org/licenses/>.
::--::--::--::--::--::--::--::--::--::--::--::--::--::--::--::--
*/
//! # Specification
//!
//! > Below is a copy of [Binn]'s specification, with some minor changes of formatting.
//!
//! > - License: [Apache License, Version 2.0][Binn:License]
//! > - Commit: <https://github.com/liteserver/binn/commit/29f3be8bb9d1014cabe8bd72ef53d2cfa6d443d8>
//! > - Date: `Tue Jun 9 16:58:46 2015 -0300`
//!
//! ---
//!
//! Binn Specification
//! ==============
//!
//! Format
//! --------
//! Each value is stored with 4 possible parameters:
//!
//! ```Text
//! [type][size][count][data]
//! ```
//!
//! But most are optional. Only the type parameter is used in all of them. Here is a list of used parameters for basic data types:
//! ```Text
//! boolean, null:
//! [type]
//!
//! int, float (storage: byte, word, dword or qword):
//! [type][data]
//!
//! string, blob:
//! [type][size][data]
//!
//! list, object, map:
//! [type][size][count][data]
//! ```
//!
//! Each parameter can be stored with polymorphic size:
//!
//! Parameter | Size
//! ------- | ----
//! `[type]` | 1 or 2 bytes
//! `[size]` | 1 or 4 bytes
//! `[count]` | 1 or 4 bytes
//! `[data]` | n bytes
//!
//!
//! `[Type]`
//! --------
//! Each value is stored starting with the data type. It can use 1 or 2 bytes. The first byte is divided as follows:
//!
//! ```Text
//! +-------- Storage type
//! | +----- Sub-type size
//! | | +-- Sub-type
//! 000 0 0000
//! ```
//! #### Storage
//!
//! The 3 most significant bits are used for the **storage type**. It has information about how many bytes the data will use. The storage
//! type can be any of:
//!
//! * No additional bytes
//! * 1 Byte
//! * Word (2 bytes, big endian)
//! * Dword (4 bytes, big endian)
//! * Qword (8 bytes, big endian)
//! * String (UTF-8, null terminated)
//! * Blob
//! * Container
//!
//! And the constants are:
//!
//! Storage | Bits | Hex | Dec
//! ------- | --------- | ---- | ---:
//! NOBYTES | **000** 0 0000 | 0x00 | 0
//! BYTE | **001** 0 0000 | 0x20 | 32
//! WORD | **010** 0 0000 | 0x40 | 64
//! DWORD | **011** 0 0000 | 0x60 | 96
//! QWORD | **100** 0 0000 | 0x80 | 128
//! STRING | **101** 0 0000 | 0xA0 | 160
//! BLOB | **110** 0 0000 | 0xC0 | 192
//! CONTAINER | **111** 0 0000 | 0xE0 | 224
//!
//! #### Sub-type size
//!
//! The next bit informs if the type uses 1 or 2 bytes.
//!
//! If the bit is 0, the type uses only 1 byte, and the sub-type has 4 bits (0 to 15)
//! ```Text
//! +-------- Storage type
//! | +----- Sub-type size
//! | | +-- Sub-type
//! 000 0 0000
//! ```
//! When the bit is 1, another byte is used for the type and the sub-type has 12 bits (up to 4096)
//! ```Text
//! +-------- Storage type
//! | +----- Sub-type size
//! | |
//! 000 1 0000 0000 0000
//! | Sub-type |
//! +-------------+
//! ```
//!
//! #### Sub-type
//!
//! Each storage can have up to 4096 sub-types. They hold what kind of value is stored in that storage space.
//!
//! > **Example:** a DWORD can contain a signed integer, an unsigned integer, a single precision floating point number, and many more... even
//! > user defined types
//!
//! Here are the values for basic data types, with the sub-type highlighted:
//!
//! Type | Storage | Bits | Hex | Dec
//! ----- | ------- | -------- | ---- | ---:
//! Null | NOBYTES | 0000 **0000** | 0x00 | 0
//! True | NOBYTES | 0000 **0001** | 0x01 | 1
//! False | NOBYTES | 0000 **0010** | 0x02 | 2
//! UInt8 | BYTE | 0010 **0000** | 0x20 | 32
//! Int8 | BYTE | 0010 **0001** | 0x21 | 33
//! UInt16 | WORD | 0100 **0000** | 0x40 | 64
//! Int16 | WORD | 0100 **0001** | 0x41 | 65
//! UInt32 | DWORD | 0110 **0000** | 0x60 | 96
//! Int32 | DWORD | 0110 **0001** | 0x61 | 97
//! Float | DWORD | 0110 **0010** | 0x62 | 98
//! UInt64 | QWORD | 1000 **0000** | 0x80 |128
//! Int64 | QWORD | 1000 **0001** | 0x81 |129
//! Double | QWORD | 1000 **0010** | 0x82 |130
//! Text | STRING | 1010 **0000** | 0xA0 |160
//! DateTime | STRING | 1010 **0001** | 0xA1 |161
//! Date | STRING | 1010 **0010** | 0xA2 |162
//! Time | STRING | 1010 **0011** | 0xA3 |163
//! DecimalStr | STRING | 1010 **0100** | 0xA4 |164
//! Blob | BLOB | 1100 **0000** | 0xC0 |192
//! List | CONTAINER | 1110 **0000** | 0xE0 |224
//! Map | CONTAINER | 1110 **0001** | 0xE1 |225
//! Object | CONTAINER | 1110 **0010**| 0xE2|226
//!
//! ### User Defined Types
//!
//! An application can use a different DateTime type and store the value in a DWORD or QWORD.
//!
//! >Storage = QWORD (0x80)<br/>
//! >Sub-type = 5 (0x05) [choose any unused]
//! >
//! >Type DateTime = (0x80 | 0x05 => 0x85)
//!
//! An application can send HTML inside a Binn structure and can define a type to differ from plain text.
//!
//! >Storage = STRING (0xA0)<br/>
//! >Sub-type = 9 (0x09) [choose any unused]
//! >
//! >Type HTML = (0xA0 | 0x09 => 0xA9)
//!
//! If the sub-type is greater than 15, a new byte must be used, and the sub-type size bit must be set:
//!
//! >Storage = STRING (0xA000)<br/>
//! >Sub-type size = (0x0100)<br/>
//! >Sub-type = 21 (0x0015)
//! >
//! >Type HTML = (0xA000 | 0x1000 | 0x0015 => 0xB015)
//!
//! The created type parameter must be stored as big-endian.
//!
//! `[Size]`
//! --------
//! This parameter is used in strings, blobs and containters. It can have 1 or 4 bytes.
//!
//! If the first bit of size is 0, it uses only 1 byte. So when the data size is up to 127 (0x7F) bytes the size parameter will use only 1
//! byte.
//!
//! Otherwise a 4 byte size parameter is used, with the msb 1. Leaving us with a high limit of 2 GigaBytes (0x7FFFFFFF).
//!
//! Data size | Size Parameter Uses
//! ---|--:
//! <= 127 bytes | 1 byte
//! > 127 bytes | 4 bytes
//!
//! There is no problem if a small size is stored using 4 bytes. The reader must accept both.
//!
//! For *strings*, the size parameter does not include the null terminator.
//!
//! For *containers*, the size parameter includes the type parameter. It stores the size of the whole structure.
//!
//! `[Count]`
//! ---------
//! This parameter is used only in containers to inform the number of items inside them. It can have 1 or 4 bytes, formatted exactly as the
//! size parameter.
//!
//! Count | Count Parameter Uses
//! ---|--:
//! <= 127 items | 1 byte
//! > 127 items | 4 bytes
//!
//!
//! Containers
//! -------------
//!
//! #### **List**
//! Lists are containers that store values one after another.
//!
//! The count parameter informs the number of values inside the container.
//!
//! >[123, "test", 2.5, true]
//!
//! #### **Map**
//! Maps are associative arrays using **integer numbers** for the keys.
//!
//! The keys are stored using a big-endian DWORD (4 bytes) that are read as a signed integer.
//!
//! So the current limits are from INT32_MIN to INT32_MAX. But there is room for increase if needed.
//!
//! The count parameter informs the number of key/value pairs inside the container.
//!
//! >{**1:** 10, **5:** "the value", **7:** true}
//!
//! #### **Object**
//! Objects are associative arrays using **text** for the keys.
//!
//! The keys are not null terminated and the limit is 255 bytes long.
//!
//! The keys are stored preceded by the key length using a single byte for it.
//!
//! The count parameter informs the number of key/value pairs inside the container.
//!
//! >{**"id":** 1, **"name":** "John", **"points":** 30.5, **"active":** true}
//!
//!
//! Limits
//! -------
//!
//! Type | Min | Max
//! -----|-----|----
//! Integers | INT64_MIN | UINT64_MAX
//! Floating point numbers | IEEE 754 |
//! Strings | 0 | 2 GB
//! Blobs | 0 | 2 GB
//! Containers | 4 | 2 GB
//!
//! Associative Arrays
//!
//! Key type | Min | Max
//! ---------|-----|-----
//! Number | INT32_MIN | INT32_MAX
//! Text | 0 | 255 bytes
//!
//! Sub-types: up to 4096 for each storage type
//!
//!
//! Example Structures
//! -----------------------
//! #### A json data such as {"hello":"world"} is serialized as:
//!
//! **Binn:** (17 bytes)
//! ```Text
//! \xE2 // [type] object (container)
//! \x11 // [size] container total size
//! \x01 // [count] key/value pairs
//! \x05hello // key
//! \xA0 // [type] = string
//! \x05 // [size]
//! world\x00 // [data] (null terminated)
//! ```
//!
//! #### A list of 3 integers:
//!
//! **Json:** (14 bytes)
//! >[123, -456, 789]
//!
//! **Binn:** (11 bytes)
//! ```Text
//! \xE0 // [type] list (container)
//! \x0B // [size] container total size
//! \x03 // [count] items
//! \x20 // [type] = uint8
//! \x7B // [data] (123)
//! \x41 // [type] = int16
//! \xFE\x38 // [data] (-456)
//! \x40 // [type] = uint16
//! \x03\x15 // [data] (789)
//! ```
//!
//! #### A list inside a map:
//!
//! **Json:** (25 bytes)
//! >{1: "add", 2: [-12345, 6789]}
//!
//! **Binn:** (26 bytes)
//! ```Text
//! \xE1 // [type] map (container)
//! \x1A // [size] container total size
//! \x02 // [count] key/value pairs
//! \x00\x00\x00\x01 // key
//! \xA0 // [type] = string
//! \x03 // [size]
//! add\x00 // [data] (null terminated)
//! \x00\x00\x00\x02 // key
//! \xE0 // [type] list (container)
//! \x09 // [size] container total size
//! \x02 // [count] items
//! \x41 // [type] = int16
//! \xCF\xC7 // [data] (-12345)
//! \x40 // [type] = uint16
//! \x1A\x85 // [data] (6789)
//! ```
//!
//!
//! #### A list of objects:
//!
//! **Json:** (47 bytes)
//! >[
//! {"id": 1, "name": "John"},
//! {"id": 2, "name": "Eric"}
//! ]
//!
//! **Binn:** (43 bytes)
//! ```Text
//! \xE0 // [type] list (container)
//! \x2B // [size] container total size
//! \x02 // [count] items
//!
//! \xE2 // [type] object (container)
//! \x14 // [size] container total size
//! \x02 // [count] key/value pairs
//!
//! \x02id // key
//! \x20 // [type] = uint8
//! \x01 // [data] (1)
//!
//! \x04name // key
//! \xA0 // [type] = string
//! \x04 // [size]
//! John\x00 // [data] (null terminated)
//!
//! \xE2 // [type] object (container)
//! \x14 // [size] container total size
//! \x02 // [count] key/value pairs
//!
//! \x02id // key
//! \x20 // [type] = uint8
//! \x02 // [data] (2)
//!
//! \x04name // key
//! \xA0 // [type] = string
//! \x04 // [size]
//! Eric\x00 // [data] (null terminated)
//! ```
//!
//! [Binn]: https://github.com/liteserver/binn
//! [Binn:License]: https://github.com/liteserver/binn/blob/master/LICENSE