/* $Id: base64.h $ */
/** @file
 * IPRT - Base64, MIME content transfer encoding, internal header.
 */

/*
 * Copyright (C) 2009-2025 Oracle and/or its affiliates.
 *
 * This file is part of VirtualBox base platform packages, as
 * available from https://www.virtualbox.org.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation, in version 3 of the
 * License.
 *
 * 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
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, see <https://www.gnu.org/licenses>.
 *
 * The contents of this file may alternatively be used under the terms
 * of the Common Development and Distribution License Version 1.0
 * (CDDL), a copy of it is provided in the "COPYING.CDDL" file included
 * in the VirtualBox distribution, in which case the provisions of the
 * CDDL are applicable instead of those of the GPL.
 *
 * You may elect to license modified versions of this file under the
 * terms and conditions of either the GPL or the CDDL or both.
 *
 * SPDX-License-Identifier: GPL-3.0-only OR CDDL-1.0
 */

#ifndef IPRT_INCLUDED_SRC_common_string_base64_h
#define IPRT_INCLUDED_SRC_common_string_base64_h
#ifndef RT_WITHOUT_PRAGMA_ONCE
# pragma once
#endif


/*********************************************************************************************************************************
*   Defined Constants And Macros                                                                                                 *
*********************************************************************************************************************************/
/** The line length used for encoding. */
#define RTBASE64_LINE_LEN   64

/** @name Special g_au8rtBase64CharToVal values
 * @{ */
#define BASE64_SPACE        0xc0
#define BASE64_PAD          0xe0
#define BASE64_NULL         0xfe
#define BASE64_INVALID      0xff
/** @} */


/*********************************************************************************************************************************
*   Global Variables                                                                                                             *
*********************************************************************************************************************************/
extern DECL_HIDDEN_DATA(const uint8_t)  g_au8rtBase64CharToVal[256];
extern DECL_HIDDEN_DATA(const char)     g_szrtBase64ValToChar[64+1];
extern DECL_HIDDEN_DATA(const size_t)   g_acchrtBase64EolStyles[RTBASE64_FLAGS_EOL_STYLE_MASK + 1];
extern DECL_HIDDEN_DATA(const char)     g_aachrtBase64EolStyles[RTBASE64_FLAGS_EOL_STYLE_MASK + 1][2];


/*********************************************************************************************************************************
*   Internal Functions                                                                                                           *
*********************************************************************************************************************************/
#ifdef RT_STRICT
DECLHIDDEN(void) rtBase64Sanity(void);
#endif


/**
 * Recalcs 6-bit to 8-bit and adjust for padding.
 */
DECLINLINE(ssize_t) rtBase64DecodedSizeRecalc(uint32_t c6Bits, unsigned cbPad)
{
   size_t cb;
   if (c6Bits * 3 / 3 == c6Bits)
   {
       if ((c6Bits * 3 % 4) != 0)
           return -1;
       cb = c6Bits * 3 / 4;
   }
   else
   {
       if ((c6Bits * (uint64_t)3 % 4) != 0)
           return -1;
       cb = c6Bits * (uint64_t)3 / 4;
   }

   if (cb < cbPad)
       return -1;
   cb -= cbPad;
   return cb;
}

#endif /* !IPRT_INCLUDED_SRC_common_string_base64_h */
