]> git.netwichtig.de Git - user/henk/code/inspircd.git/blob - include/inspstring.h
Deduplicate hex string creation code
[user/henk/code/inspircd.git] / include / inspstring.h
1 /*
2  * InspIRCd -- Internet Relay Chat Daemon
3  *
4  *   Copyright (C) 2007 Dennis Friis <peavey@inspircd.org>
5  *   Copyright (C) 2007 Craig Edwards <craigedwards@brainbox.cc>
6  *
7  * This file is part of InspIRCd.  InspIRCd is free software: you can
8  * redistribute it and/or modify it under the terms of the GNU General Public
9  * License as published by the Free Software Foundation, version 2.
10  *
11  * This program is distributed in the hope that it will be useful, but WITHOUT
12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
13  * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
14  * details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
18  */
19
20
21 #pragma once
22
23 // This (config) is needed as inspstring doesn't pull in the central header
24 #include "config.h"
25 #include <cstring>
26
27 /** Compose a hex string from raw data.
28  * @param raw The raw data to compose hex from (can be NULL if rawsize is 0)
29  * @param rawsize The size of the raw data buffer
30  * @return The hex string
31  */
32 CoreExport std::string BinToHex(const void* raw, size_t rawsize);
33
34 /** Base64 encode */
35 CoreExport std::string BinToBase64(const std::string& data, const char* table = NULL, char pad = 0);
36 /** Base64 decode */
37 CoreExport std::string Base64ToBin(const std::string& data, const char* table = NULL);
38
39 /** Compose a hex string from the data in a std::string.
40  * @param data The data to compose hex from
41  * @return The hex string.
42  */
43 inline std::string BinToHex(const std::string& data)
44 {
45         return BinToHex(data.data(), data.size());
46 }