source/lib/base32.h

   1 /* Copyright (C) 2010 Wildfire Games.
   2  *
   3  * Permission is hereby granted, free of charge, to any person obtaining
   4  * a copy of this software and associated documentation files (the
   5  * "Software"), to deal in the Software without restriction, including
   6  * without limitation the rights to use, copy, modify, merge, publish,
   7  * distribute, sublicense, and/or sell copies of the Software, and to
   8  * permit persons to whom the Software is furnished to do so, subject to
   9  * the following conditions:
  10  *
  11  * The above copyright notice and this permission notice shall be included
  12  * in all copies or substantial portions of the Software.
  13  *
  14  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  15  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  16  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
  17  * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
  18  * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
  19  * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
  20  * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  21  */
  22
  23 /*
  24  * base32 conversion
  25  */
  26
  27 #ifndef INCLUDED_BASE32
  28 #define INCLUDED_BASE32
  29
  30 /**
  31  * generate the base32 textual representation of a buffer.
  32  *
  33  * @param len Size [bytes] of input
  34  * @param in Big-endian input data (assumed to be integral number of bytes)
  35  * @param out Output string; zero-terminated. must be big enough
  36  * (i.e. at least ceil(len*CHAR_BIT/5) + 1 chars)
  37  **/
  38 extern void base32(const size_t len, const u8* in, u8* out);
  39
  40 #endif  // #ifndef INCLUDED_BASE32