NAVFoundation.Amx/Encoding/NAVFoundation.Encoding.Base32.h.axi at master · Norgate-AV/NAVFoundation.Amx · GitHub

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
PROGRAM_NAME='NAVFoundation.Encoding.Base32.h'

/*
 _   _                       _          ___     __
| \ | | ___  _ __ __ _  __ _| |_ ___   / \ \   / /
|  \| |/ _ \| '__/ _` |/ _` | __/ _ \ / _ \ \ / /
| |\  | (_) | | | (_| | (_| | ||  __// ___ \ V /
|_| \_|\___/|_|  \__, |\__,_|\__\___/_/   \_\_/
                 |___/

MIT License

Copyright (c) 2010-2026 Norgate AV

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
*/

#IF_NOT_DEFINED __NAV_FOUNDATION_ENCODING_BASE32_H__
#DEFINE __NAV_FOUNDATION_ENCODING_BASE32_H__ 'NAVFoundation.Encoding.Base32.h'


DEFINE_CONSTANT

/**
 * @constant NAV_BASE32_MAP
 * @description Standard Base32 encoding character set as defined in RFC 4648.
 * Contains the 32 characters used in Base32 encoding (A-Z, 2-7).
 *
 * @note The index in this array (1-based) corresponds to the 5-bit value being encoded plus 1
 * @note Array is 1-indexed to match NetLinx array indexing (first element at position 1)
 */
constant char NAV_BASE32_MAP[] = {
                                    'A', 'B', 'C', 'D', 'E', 'F', 'G', 'H',
                                    'I', 'J', 'K', 'L', 'M', 'N', 'O', 'P',
                                    'Q', 'R', 'S', 'T', 'U', 'V', 'W', 'X',
                                    'Y', 'Z', '2', '3', '4', '5', '6', '7'
                                 }

/**
 * @constant NAV_BASE32_PADDING_CHAR
 * @description The character used for padding in Base32 encoding ('=')
 *
 * @note Padding is used when the input length is not divisible by 5
 */
constant char NAV_BASE32_PADDING_CHAR = '='

/**
 * @constant NAV_BASE32_INVALID_VALUE
 * @description Value indicating an invalid Base32 character
 *
 * @note Used as a return value from NAVBase32GetCharValue for error handling
 */
constant sinteger NAV_BASE32_INVALID_VALUE = -1

#END_IF // __NAV_FOUNDATION_ENCODING_BASE32_H__