hex.h

/*
    ​​​SPDX-License-Identifier: GPL-3.0-or-later
    Copyright © 2015-2022 Amebis
    Copyright © 2016 GÉANT
*/
 
#pragma once
 
#include "common.h"
 
#include <codeanalysis\warnings.h>
#pragma warning(push)
#pragma warning(disable: WXWIDGETS_CODE_ANALYSIS_WARNINGS)
#include <wx/string.h>
#include <wx/buffer.h>
#pragma warning(pop)
 
 
// ----------------------------------------------------------------------------
// Encoding Functions
// ----------------------------------------------------------------------------
 
 
inline constexpr size_t wxHexEncodedSize(size_t len) noexcept
{
    return 2*len;
}
 
 
size_t WXEXTEND_API wxHexEncode(char *dst, size_t dstLen, const void *src, size_t srcLen);
 
 
inline wxString wxHexEncode(const void *src, size_t srcLen)
{
    const size_t dstLen = wxHexEncodedSize(srcLen);
    wxCharBuffer dst(dstLen);
    wxHexEncode(dst.data(), dstLen, src, srcLen);
 
    return dst;
}
 
 
inline wxString wxHexEncode(const wxMemoryBuffer& buf)
{
    return wxHexEncode(buf.GetData(), buf.GetDataLen());
}
 
 
// ----------------------------------------------------------------------------
// Decoding Functions
// ----------------------------------------------------------------------------
 
enum class wxHexDecodeMode
{
    Strict,     
    SkipWS,     
    Relaxed,    
};
 
 
inline constexpr size_t wxHexDecodedSize(size_t len) noexcept
{
    return (len + 1)/2;
}
 
size_t WXEXTEND_API wxHexDecode(void *dst, size_t dstLen, const char *src, size_t srcLen = wxNO_LEN, wxHexDecodeMode mode = wxHexDecodeMode::Strict, size_t *posErr = NULL);
 
 
inline size_t wxHexDecode(void *dst, size_t dstLen, const wxString& src, wxHexDecodeMode mode = wxHexDecodeMode::Strict, size_t *posErr = NULL)
{
    // don't use str.length() here as the ASCII buffer is shorter than it is for
    // strings with embedded NULs
    return wxHexDecode(dst, dstLen, src.ToAscii(), wxNO_LEN, mode, posErr);
}
 
 
wxMemoryBuffer WXEXTEND_API wxHexDecode(const char *src, size_t srcLen = wxNO_LEN, wxHexDecodeMode mode = wxHexDecodeMode::Strict, size_t *posErr = NULL);
 
 
inline wxMemoryBuffer wxHexDecode(const wxString& src, wxHexDecodeMode mode = wxHexDecodeMode::Strict, size_t *posErr = NULL)
{
    // don't use str.length() here as the ASCII buffer is shorter than it for
    // strings with embedded NULs
    return wxHexDecode(src.ToAscii(), wxNO_LEN, mode, posErr);
}