Reusable librock_base64enc - Encode binary data as MIME base 64 (deprecated. See librock

Home

License Awareness

Highly Reusable Software

By activity
Professions, Sciences, Humanities, Business, ...

User Interface
Text-based, GUI, Audio, Video, Keyboards, Mouse, Images,...

Text Strings
Conversions, tests, processing, manipulation,...

Math
Integer, Floating point, Matrix, Statistics, Boolean, ...

Processing
Algorithms, Memory, Process control, Debugging, ...

Stored Data
Data storage, Integrity, Encryption, Compression, ...

Communications
Networks, protocols, Interprocess, Remote, Client Server, ...

Hard World
Timing, Calendar and Clock, Audio, Video, Printer, Controls...

File System
Management, Filtering, File & Directory access, Viewers, ...

NAME

librock_base64enc - Encode binary data as MIME base 64 (deprecated. See librock_base64encN)

#License - #Source code - #Example Use -

SYNOPSIS

#include <librock/parse.h>

int
librock_base64enc(char *wptr, /* Output.  Must have room to store 4 bytes */
         long *paccum, /* Accumulator.  NOTE: Initialize to 0 or 1*/
         int ch) /* Byte to encode in range 0-0xff, or -1 to pad at end */

DESCRIPTION

This function performs MIME Base64 encoding. An accumulator is used to collect 3 bytes on successive calls, which are then encoded and written to wptr. To end the encoding, call with ch == -1, which will pad if necessary.

Inserting NUL termination and newlines in the output is up to the caller.

This function returns the number of characters written at pointer, either 0, or 4.

To encode more than one byte, see librock_base64encN instead.

Typical use is

#ifdef librock_TYPICAL_USE_base64enc
    #include <stdlib.h>

    const char *ptr = "Some string to encode.";
    long accum = 0; /* Must initialize */
    char *out = malloc(strlen(ptr) * 4/3+9); /* at least 4 bytes for every 3,

                                                       plus 4 bytes extra plus '\0' end*/
    char *wptr = out;
    if (!wptr) {
        /* Error handling */
    }
    while(*ptr) {
        wptr += librock_base64enc(wptr,&accum,*ptr & 0xff);
        ptr++;
    }
    wptr += librock_base64enc(wptr,&accum,-1);
    *wptr = '\0';
    printf("%s\n",out);
#endif

USES

// No external calls

LICENSE

  Copyright 1998-2002 Forrest J. Cavalier III, http://www.mibsoftware.com
  Licensed under BSD-ish license, NO WARRANTY. Copies must retain this block.
  License text in <librock/license/librock.txt> librock_LIDESC_HC=12440211096131f5976d36be0cddca4cd9152e45

Source Code

./comm/person/email/base64.c (implementation, plus source of this manual page)

Tests and Supported Platform Types

This is a representative sample. Librock code is highly portable. For a particular platform not reported here, request paid support

librock_base64enc passed tests in tbase64 (Unix/Linux/BSD: 2002/08/08 sys=FreeBSD using gcc)
librock_base64enc passed tests in tbase64 (WIN32: 2002/08/08 sys=NT 4.0 using MSVC)

This software is part of Librock

Rapid reuse, without rework.

Source code which is Open-source, Free (Libre) and free (no cost)
Namespace limited. All compile-time macros and names visible at link time are prefixed by "librock_". Integrate into your project and expect no name collisions.
Stable API means new functions get new names so that there is no risk that updating a source file will break existing applications.
Highly portable, cross-platform, and multithread compatible. Works with many machines, compilers, and operating systems (gcc/MSVC/Windows/Linux/BSD).

Details

Verbatim copying and distribution of this generated page is permitted in any medium provided that no changes are made.
(The source of this manual page may be covered by a more permissive license which allows modifications.)

Want to help? We welcome comments, patches. -- Need help? Request paid support.