Move Base32_encode from packet-fc00.c to wsutil (as ws_base32_decode)
[metze/wireshark/wip.git] / wsutil / base32.h
1 /* base32.h
2  * Base-32 conversion
3  *
4  * Wireshark - Network traffic analyzer
5  * By Gerald Combs <gerald@wireshark.org>
6  * Copyright 1998 Gerald Combs
7  *
8  * This program is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU General Public License
10  * as published by the Free Software Foundation; either version 2
11  * of the License, or (at your option) any later version.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with this program; if not, write to the Free Software
20  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
21  */
22 #ifndef __BASE32_H__
23 #define __BASE32_H__
24
25 #include "ws_symbol_export.h"
26
27 #ifdef __cplusplus
28 extern "C" {
29 #endif /* __cplusplus */
30
31 /** Returned by base32_decode() if the input is not valid base32. */
32 #define Base32_BAD_INPUT -1
33 /** Returned by base32_decode() if the output buffer is too small. */
34 #define Base32_TOO_BIG -2
35
36 /* Encoding of a base32 byte array */
37 WS_DLL_PUBLIC
38 int ws_base32_decode(guint8* output, const guint32 outputLength,
39                                                 const guint8* in, const guint32 inputLength);
40
41 #ifdef __cplusplus
42 }
43 #endif /* __cplusplus */
44
45 #endif /* __BASE32_H__ */
46
47 /*
48  * Editor modelines  -  https://www.wireshark.org/tools/modelines.html
49  *
50  * Local variables:
51  * c-basic-offset: 4
52  * tab-width: 8
53  * indent-tabs-mode: nil
54  * End:
55  *
56  * vi: set shiftwidth=4 tabstop=8 expandtab:
57  * :indentSize=4:tabSize=8:noTabs=true:
58  */