class KCodecs

Public Static Methods

• static QCString  quotedPrintableEncode (const QByteArray & in)
• static QCString  quotedPrintableEncode (const QByteArray & in, bool useCRLF)
• static QByteArray  quotedPrintableDecode (const QCString & in)
• static QCString  uuencode ( const QByteArray& in )
• static void  uuencode ( const QByteArray& in, QByteArray& out )
• static QCString  uuencode ( const QCString& str )
• static QCString  uudecode ( const QByteArray& in )
• static void  uudecode ( const QByteArray& in, QByteArray& out )
• static QCString  uudecode ( const QCString& str )
• static QCString  base64Encode ( const QByteArray& in, bool insertLFs )
• static QCString  base64Encode ( const QByteArray& in )
• static void  base64Encode ( const QByteArray& in, QByteArray& out, bool insertLFs )
• static void  base64Encode ( const QByteArray& in, QByteArray& out )
• static QCString  base64Encode ( const QCString& str, bool insertLFs )
• static QCString  base64Encode ( const QCString& str )
• static QCString  base64Decode ( const QByteArray& in )
• static void  base64Decode ( const QByteArray& in, QByteArray& out )
• static QCString  base64Decode ( const QCString& str )
• static QString  base64Encode ( const QString& str )
• static QString  base64Decode ( const QString& str )
• static QString  uuencode ( const QString& str )
• static QString  uudecode ( const QString& str )
• static QString  encodeString ( const QString& data )
• static QString  decodeString ( const QString& data )

Detailed Description

A wrapper class for the most commonly used encoding and decoding algorithms. Currently there is support for encoding and decoding input using base64, uu and the quoted-printable specifications.

Useage:

The convienence functions are well suited for encoding and decoding a relatively small input.

 QCString input = "Aladdin:open sesame";
 QCString result = KCodecs::base64Encode(input);
 printf ("Result: %c", result.data());

 Output should be
 Result: QWxhZGRpbjpvcGVuIHNlc2FtZQ==

[static]

Encodes the given data using the quoted-printable algorithm. Equivalent to quotedPrintableEncode(in, true).

Parameters:

in	data to be encoded.

Returns: quoted-printable encoded data.

[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.

[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.

[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.

[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 opertation that have to be performed in the process.

NOTE: the output array is always first reset for sanity and then resized appropriatly. Hence, any data that is present in the output array will be lost.

Parameters:

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

[static]

Encodes the given string using the uuencode algorithm.

Parameters:

str	the string to be uuencoded.

Returns: a uuencoded string.

[static]

Decodes the given data using the uuencode algorithm.

Any 'begin' and 'end' lines liks those generated by *nix utilities will automatically be ignored.

Parameters:

in	the data uuencoded data to be decoded.

Returns: the decoded data.

[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 and cut down the number of copy opertation that have to be performed in the process.

Any 'begin' and 'end' lines liks those generated by *nix utilities will automatically be ignored.

IMPORTANT: the output array is first reset and then resized appropriately. Hence, any data that is present in the output array will be lost.

Parameters:

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

[static]

Decodes a uuencoded string.

Parameters:

str	the string to be decoded.

Returns: a uudecoded string.

[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 data.

[static]

Use base64Encode(const QByteArray&, bool) with the boolean argument set to false.

[static]

Encodes the given data using the base64 algorithm.

Use this function whenever you are dealing with very large data or a stream of 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 always first reset for sanity and then resized appropriatly. Hence, any data that is present in the output array will be lost.

Parameters:

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

[static]

Use base64Encode(const QByteArray&, QByteArray&, bool) with the boolean argument set to false.

[static]

Encodes the given string 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:

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

Returns: the decoded string.

[static]

Use base64Encode(const QCString&, bool) with the boolean argument set to false.

[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.

[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 and cut down the number of copy opertation that have to be performed in the process.

IMPORTANT: the output array is first reset and then resized appropriately. Hence, any data that is present in the output array will be lost.

Parameters:

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

[static]

Decodes a string encoded with the base64 algorithm.

Parameters:

str	the base64-encoded string.

Returns: the decoded string.

[static]

Encodes the QString data using the base64 algorithm.

NOTE: This function is ONLY provided for convenience and backward compatability! Using it can result in an incorrectly encoded data since the conversion of the QString input to latin-1 can and will result in data loss if the input data contains non- latin1 characters. As such it is highly recommended that you avoid this function unless you are absolutely certain that your input does not contain any non-latin1 character!!

[static]

Decodes the encoded QString data using the base64 algorithm.

NOTE: This function is ONLY provided for convenience and backward compatability! Using it can result in an incorrectly decoded data since the conversion of the QString input to latin-1 can and will result in data loss if the input data contains non- latin1 characters. As such it is highly recommended that you avoid this function unless you are absolutely certain that your input does not contain any non-latin1 character!!

[static]

Encodes the QString data using the uuencode algorithm.

NOTE: This function is ONLY provided for convenience and backward compatability! Using it can result in an incorrectly encoded data since the conversion of the QString input to latin-1 can and will result in data loss if the input data contains non- latin1 characters. As such it is highly recommended that you avoid this function unless you are absolutely certain that your input does not contain any non-latin1 character!!

[static]

Decodes the QString data using the uuencode algorithm.

NOTE: This function is ONLY provided for convenience and backward compatability! Using it can result in an incorrectly decoded data since the conversion of the QString input to latin-1 can and will result in data loss if the input data contains non- latin1 characters. As such it is highly recommended that you avoid this function unless you are absolutely certain that your input does not contain any non-latin1 character!!

[static]

[static]

• Author: Rik Hemsley
• Generated: dfaure on kde.faure.org on Thu Jan 17 22:15:01 2002, using kdoc 2.0a53.