chiark - git - mdw - mLib/blob - base32.h

   1 /* -*-c-*-
   2  *
   3  * Base32 encoding and decoding
   4  *
   5  * (c) 1997 Straylight/Edgeware
   6  */
   7
   8 /*----- Licensing notice --------------------------------------------------*
   9  *
  10  * This file is part of the mLib utilities library.
  11  *
  12  * mLib is free software; you can redistribute it and/or modify
  13  * it under the terms of the GNU Library General Public License as
  14  * published by the Free Software Foundation; either version 2 of the
  15  * License, or (at your option) any later version.
  16  *
  17  * mLib is distributed in the hope that it will be useful,
  18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  20  * GNU Library General Public License for more details.
  21  *
  22  * You should have received a copy of the GNU Library General Public
  23  * License along with mLib; if not, write to the Free
  24  * Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
  25  * MA 02111-1307, USA.
  26  */
  27
  28 #ifndef MLIB_BASE32_H
  29 #define MLIB_BASE32_H
  30
  31 #ifdef __cplusplus
  32   extern "C" {
  33 #endif
  34
  35 /*----- Header files ------------------------------------------------------*/
  36
  37 #include "dstr.h"
  38
  39 /*----- Data structures ---------------------------------------------------*/
  40
  41 typedef struct base32_ctx {
  42   unsigned long accl, acch;             /* Accumulator for output data */
  43   unsigned qsz;                         /* Length of data queued */
  44   unsigned lnlen;                       /* Length of the current line */
  45   const char *indent;                   /* Newline-and-indent string */
  46   unsigned maxline;                     /* Maximum permitted line length */
  47 } base32_ctx;
  48
  49 /*----- Functions provided ------------------------------------------------*/
  50
  51 /* --- @base32_encode@ --- *
  52  *
  53  * Arguments:   @base32_ctx *ctx@ = pointer to a context block
  54  *              @const void *p@ = pointer to a source buffer
  55  *              @size_t sz@ = size of the source buffer
  56  *              @dstr *d@ = pointer to destination string
  57  *
  58  * Returns:     ---
  59  *
  60  * Use:         Encodes a binary string in base32.  To flush out the final
  61  *              few characters (if necessary), pass a null source pointer.
  62  */
  63
  64 extern void base32_encode(base32_ctx */*ctx*/,
  65                           const void */*p*/, size_t /*sz*/,
  66                           dstr */*d*/);
  67
  68 /* --- @base32_decode@ --- *
  69  *
  70  * Arguments:   @base32_ctx *ctx@ = pointer to a context block
  71  *              @const void *p@ = pointer to a source buffer
  72  *              @size_t sz@ = size of the source buffer
  73  *              @dstr *d@ = pointer to destination string
  74  *
  75  * Returns:     ---
  76  *
  77  * Use:         Decodes a binary string in base32.  To flush out the final
  78  *              few characters (if necessary), pass a null source pointer.
  79  */
  80
  81 extern void base32_decode(base32_ctx */*ctx*/,
  82                           const void */*p*/, size_t /*sz*/,
  83                           dstr */*d*/);
  84
  85 /* --- @base32_init@ --- *
  86  *
  87  * Arguments:   @base32_ctx *ctx@ = pointer to context block to initialize
  88  *
  89  * Returns:     ---
  90  *
  91  * Use:         Initializes a base32 context properly.
  92  */
  93
  94 extern void base32_init(base32_ctx */*ctx*/);
  95
  96 /*----- That's all, folks -------------------------------------------------*/
  97
  98 #ifdef __cplusplus
  99   }
 100 #endif
 101
 102 #endif