subversion/include/svn_quoprint.h

   1 /**
   2  * @copyright
   3  * ====================================================================
   4  * Copyright (c) 2000-2004 CollabNet.  All rights reserved.
   5  *
   6  * This software is licensed as described in the file COPYING, which
   7  * you should have received as part of this distribution.  The terms
   8  * are also available at http://subversion.tigris.org/license-1.html.
   9  * If newer versions of this license are posted there, you may use a
  10  * newer version instead, at your option.
  11  *
  12  * This software consists of voluntary contributions made by many
  13  * individuals.  For exact contribution history, see the revision
  14  * history and logs, available at http://subversion.tigris.org/.
  15  * ====================================================================
  16  * @endcopyright
  17  *
  18  * @file svn_quoprint.h
  19  * @brief quoted-printable encoding and decoding functions.
  20  */
  21
  22
  23 #ifndef SVN_QUOPRINT_H
  24 #define SVN_QUOPRINT_H
  25
  26 #include "svn_io.h"
  27
  28 #ifdef __cplusplus
  29 extern "C" {
  30 #endif /* __cplusplus */
  31
  32 /** Return a writable generic stream which will encode binary data in
  33  * quoted-printable format and write the encoded data to @a output.  Be
  34  * sure to close the stream when done writing in order to squeeze out
  35  * the last bit of encoded data.
  36  */
  37 svn_stream_t *svn_quoprint_encode(svn_stream_t *output, apr_pool_t *pool);
  38
  39 /** Return a writable generic stream which will decode binary data in
  40  * quoted-printable format and write the decoded data to @a output.  Be
  41  * sure to close the stream when done writing in order to squeeze out
  42  * the last bit of encoded data.
  43  */
  44 svn_stream_t *svn_quoprint_decode(svn_stream_t *output, apr_pool_t *pool);
  45
  46
  47 /** Simpler interface for encoding quoted-printable data assuming we have all
  48  * of it present at once.  The returned string will be allocated from @a pool.
  49  */
  50 svn_stringbuf_t *svn_quoprint_encode_string(svn_stringbuf_t *str,
  51                                             apr_pool_t *pool);
  52
  53 /** Simpler interface for decoding quoted-printable data assuming we have all
  54  * of it present at once.  The returned string will be allocated from @a pool.
  55  */
  56 svn_stringbuf_t *svn_quoprint_decode_string(svn_stringbuf_t *str,
  57                                             apr_pool_t *pool);
  58
  59
  60 #ifdef __cplusplus
  61 }
  62 #endif /* __cplusplus */
  63
  64 #endif /* SVN_QUOPRINT_H */