uudecode

KCodecs(3)                  Library Functions Manual                  KCodecs(3)



NAME
       KCodecs - A wrapper class for the most commonly used encoding and
       decoding algorithms. A collection of commonly used encoding and decoding
       algorithms.


SYNOPSIS
       #include <kmdcodec.h>

   Static Public Member Functions
       QCString quotedPrintableEncode (const  QByteArray &in, bool useCRLF=true)
           Encodes the given data using the quoted-printable algorithm.
       QCString quotedPrintableEncode (const  QCString &str, bool useCRLF=true)
       void quotedPrintableEncode (const  QByteArray &in, QByteArray &out, bool
           useCRLF)
           Encodes the given data using the quoted-printable algorithm.
       QCString quotedPrintableDecode (const  QByteArray &in)
           Decodes a quoted-printable encoded string.
       QCString quotedPrintableDecode (const  QCString &str)
       void quotedPrintableDecode (const  QByteArray &in, QByteArray &out)
           Decodes a quoted-printable encoded data.
       QCString uuencode (const  QByteArray &in)
           Encodes the given data using the uuencode algorithm.
       QCString uuencode (const  QCString &str)
       void uuencode (const  QByteArray &in, QByteArray &out)
           Encodes the given data using the uuencode algorithm.
       QCString uudecode (const  QByteArray &in)
           Decodes the given data using the uuencode algorithm.
       QCString uudecode (const  QCString &str)
       void uudecode (const  QByteArray &in, QByteArray &out)
           Decodes the given data using the uudecode algorithm.
       QCString base64Encode (const  QByteArray &in, bool insertLFs=false)
           Encodes the given data using the base64 algorithm.
       QCString base64Encode (const  QCString &str, bool insertLFs=false)
       void base64Encode (const  QByteArray &in, QByteArray &out, bool
           insertLFs=false)
           Encodes the given data using the base64 algorithm.
       QCString base64Decode (const  QByteArray &in)
           Decodes the given data that was encoded using the base64 algorithm.
       QCString base64Decode (const  QCString &str)
       void base64Decode (const  QByteArray &in, QByteArray &out)
           Decodes the given data that was encoded with the base64 algorithm.

Detailed Description
       A wrapper class for the most commonly used encoding and decoding
       algorithms. A collection of commonly used encoding and decoding
       algorithms.

       Currently there is support for encoding and decoding input using base64,
       uu and the quoted-printable specifications.

        Usage:

        QCString input = 'Aladdin:open sesame';
        QCString result = KCodecs::base64Encode(input);
        cout << 'Result: ' << result.data() << endl;

        Output should be
        Result: QWxhZGRpbjpvcGVuIHNlc2FtZQ==


        The above example makes use of the convenience functions (ones that accept/return null-terminated strings) to encode/decode a string. If what you need is to encode or decode binary data, then it is highly recommended that you use the functions that take an input and output QByteArray as arguments. These functions are specifically tailored for encoding and decoding binary data.

       Author:
           Dawit Alemayehu <adawit@kde.org>

           Rik Hemsley <rik@kde.org>

       Definition at line 71 of file kmdcodec.h.

Member Function Documentation
   QCString KCodecs::quotedPrintableEncode (const QByteArray & in, bool useCRLF
       = true) [static]
       Encodes the given data using the quoted-printable algorithm. Parameters:
           in data to be encoded.
           useCRLF if true the input data is expected to have CRLF line breaks
           and the output will have CRLF line breaks, too.

       Returns:
           quoted-printable encoded data.

       Definition at line 150 of file kmdcodec.cpp.

       Referenced by quotedPrintableEncode().

   QCString KCodecs::quotedPrintableEncode (const QCString & str, bool useCRLF =
       true) [static]
       This is an overloaded member function, provided for convenience. It
       differs from the above function only in what argument(s) it accepts.

       Same as above except it accepts a null terminated string instead an
       array.

       Parameters:
           str data to be encoded.
           useCRLF if true the input data is expected to have CRLF line breaks
           and the output will have CRLF line breaks, too.

       Returns:
           quoted-printable encoded data.

       Definition at line 157 of file kmdcodec.cpp.

       References QCString::isEmpty(), QCString::length(), and
       quotedPrintableEncode().

   void KCodecs::quotedPrintableEncode (const QByteArray & in, QByteArray & out,
       bool useCRLF) [static]
       Encodes the given data using the quoted-printable algorithm. Use this
       function if you want the result of the encoding to be placed in another
       array which cuts down the number of copy operation that have to be
       performed in the process. This is also the preferred method for encoding
       binary data.

       NOTE: the output array is first reset and then resized appropriately
       before use, hence, all data stored in the output array will be lost.

       Parameters:
           in data to be encoded.
           out decoded data.
           useCRLF if true the input data is expected to have CRLF line breaks
           and the output will have CRLF line breaks, too.

       Returns:
           quoted-printable encoded data.

       Definition at line 167 of file kmdcodec.cpp.

       References KStdAccel::end().

   QCString KCodecs::quotedPrintableDecode (const QByteArray & in) [static]
       Decodes a quoted-printable encoded string. Accepts data with CRLF or
       standard unix line breaks.

       Parameters:
           in the data to be decoded.

       Returns:
           decoded data.

       Definition at line 283 of file kmdcodec.cpp.

       Referenced by quotedPrintableDecode().

   QCString KCodecs::quotedPrintableDecode (const QCString & str) [static]
       This is an overloaded member function, provided for convenience. It
       differs from the above function only in what argument(s) it accepts.

       Same as above except it accepts a null terminated string instead an
       array.

       Parameters:
           str the data to be decoded.

       Returns:
           decoded data.

       Definition at line 290 of file kmdcodec.cpp.

       References QCString::isEmpty(), QCString::length(), and
       quotedPrintableDecode().

   void KCodecs::quotedPrintableDecode (const QByteArray & in, QByteArray & out)
       [static]
       Decodes a quoted-printable encoded data. Accepts data with CRLF or
       standard unix line breaks. Use this function if you want the result of
       the decoding to be placed in another array which cuts down the number of
       copy operation that have to be performed in the process. This is also the
       preferred method for decoding an encoded binary data.

       NOTE: the output array is first reset and then resized appropriately
       before use, hence, all data stored in the output array will be lost.

       Parameters:
           in data to be encoded.
           out decoded data.

       Returns:
           quoted-printable encoded data.

       Definition at line 300 of file kmdcodec.cpp.

   QCString KCodecs::uuencode (const QByteArray & in) [static]
       Encodes the given data using the uuencode algorithm. The output is split
       into lines starting with the number of encoded octets in the line and
       ending with a newline. No line is longer than 45 octets (60 characters),
       excluding the line terminator.

       Parameters:
           in the data to be uuencoded

       Returns:
           a uuencoded data.

       Definition at line 556 of file kmdcodec.cpp.

       Referenced by uuencode().

   QCString KCodecs::uuencode (const QCString & str) [static]
       This is an overloaded member function, provided for convenience. It
       differs from the above function only in what argument(s) it accepts.

       Same as the above functions except it accepts a null terminated string
       instead an array.

       Parameters:
           str the string to be uuencoded.

       Returns:
           the encoded string.

       Definition at line 545 of file kmdcodec.cpp.

       References QCString::isEmpty(), QCString::length(), and uuencode().

   void KCodecs::uuencode (const QByteArray & in, QByteArray & out) [static]
       Encodes the given data using the uuencode algorithm. Use this function if
       you want the result of the encoding to be placed in another array and cut
       down the number of copy operation that have to be performed in the
       process. This is the preffered method for encoding binary data.

       NOTE: the output array is first reset and then resized appropriately
       before use, hence, all data stored in the output array will be lost.

       Parameters:
           in the data to be uuencoded.
           out the container for the uudecoded data.

       Definition at line 563 of file kmdcodec.cpp.

       References KStdAccel::end().

   QCString KCodecs::uudecode (const QByteArray & in) [static]
       Decodes the given data using the uuencode algorithm. Any 'begin' and
       'end' lines like those generated by the utilities in unix and unix-like
       OS will be automatically ignored.

       Parameters:
           in the data uuencoded data to be decoded.

       Returns:
           a decoded string.

       Definition at line 653 of file kmdcodec.cpp.

       Referenced by uudecode().

   QCString KCodecs::uudecode (const QCString & str) [static]
       This is an overloaded member function, provided for convenience. It
       differs from the above function only in what argument(s) it accepts.

       Same as the above functions except it accepts a null terminated string
       instead an array.

       Parameters:
           str the string to be decoded.

       Returns:
           a uudecoded string.

       Definition at line 642 of file kmdcodec.cpp.

       References QCString::isEmpty(), QCString::length(), and uudecode().

   void KCodecs::uudecode (const QByteArray & in, QByteArray & out) [static]
       Decodes the given data using the uudecode algorithm. Use this function if
       you want the result of the decoding to be placed in another array which
       cuts down the number of copy operation that have to be performed in the
       process. This is the preferred method for decoding binary data.

       Any 'begin' and 'end' lines like those generated by the utilities in unix
       and unix-like OS will be automatically ignored.

       NOTE: the output array is first reset and then resized appropriately
       before use, hence, all data stored in the output array will be lost.

       Parameters:
           in the uuencoded-data to be decoded.
           out the container for the uudecoded data.

       Definition at line 660 of file kmdcodec.cpp.

       References KStdAccel::end().

   QCString KCodecs::base64Encode (const QByteArray & in, bool insertLFs =
       false) [static]
       Encodes the given data using the base64 algorithm. The boolean argument
       determines if the encoded data is going to be restricted to 76 characters
       or less per line as specified by RFC 2045. If insertLFs is true, then
       there will be 76 characters or less per line.

       Parameters:
           in the data to be encoded.
           insertLFs limit the number of characters per line.

       Returns:
           a base64 encoded string.

       Definition at line 368 of file kmdcodec.cpp.

       Referenced by KMD5::base64Digest(), and base64Encode().

   QCString KCodecs::base64Encode (const QCString & str, bool insertLFs = false)
       [static]
       This is an overloaded member function, provided for convenience. It
       differs from the above function only in what argument(s) it accepts.

       Same as the above functions except it accepts a null terminated string
       instead an array.

       Parameters:
           str the string to be encoded.
           insertLFs limit the number of characters per line.

       Returns:
           the decoded string.

       Definition at line 358 of file kmdcodec.cpp.

       References base64Encode(), QCString::isEmpty(), and QCString::length().

   void KCodecs::base64Encode (const QByteArray & in, QByteArray & out, bool
       insertLFs = false) [static]
       Encodes the given data using the base64 algorithm. Use this function if
       you want the result of the encoding to be placed in another array which
       cuts down the number of copy operation that have to be performed in the
       process. This is also the preferred method for encoding binary data.

       The boolean argument determines if the encoded data is going to be
       restricted to 76 characters or less per line as specified by RFC 2045. If
       insertLFs is true, then there will be 76 characters or less per line.

       NOTE: the output array is first reset and then resized appropriately
       before use, hence, all data stored in the output array will be lost.

       Parameters:
           in the data to be encoded using base64.
           out the container for the encoded data.
           insertLFs limit the number of characters per line.

       Definition at line 375 of file kmdcodec.cpp.

   QCString KCodecs::base64Decode (const QByteArray & in) [static]
       Decodes the given data that was encoded using the base64 algorithm.
       Parameters:
           in the base64-encoded data to be decoded.

       Returns:
           the decoded data.

       Definition at line 457 of file kmdcodec.cpp.

       Referenced by base64Decode().

   QCString KCodecs::base64Decode (const QCString & str) [static]
       This is an overloaded member function, provided for convenience. It
       differs from the above function only in what argument(s) it accepts.

       Same as the above functions except it accepts a null terminated string
       instead an array.

       Parameters:
           str the base64-encoded string.

       Returns:
           the decoded string.

       Definition at line 447 of file kmdcodec.cpp.

       References base64Decode(), QCString::isEmpty(), and QCString::length().

   void KCodecs::base64Decode (const QByteArray & in, QByteArray & out) [static]
       Decodes the given data that was encoded with the base64 algorithm. Use
       this function if you want the result of the decoding to be placed in
       another array which cuts down the number of copy operation that have to
       be performed in the process. This is also the preferred method for
       decoding an encoded binary data.

       NOTE: the output array is first reset and then resized appropriately
       before use, hence, all data stored in the output array will be lost.

       Parameters:
           in the encoded data to be decoded.
           out the container for the decoded data.

       Definition at line 464 of file kmdcodec.cpp.


Author
       Generated automatically by Doxygen for kdecore Library from the source
       code.




kdecore Library                    28 Jan 2004                        KCodecs(3)