KCodecs 5.109.0
|
A wrapper class for the most commonly used encoding and decoding algorithms. More...
Classes | |
class | Codec |
An abstract base class of codecs for common mail transfer encodings. More... | |
class | Decoder |
Stateful CTE decoder class. More... | |
class | Encoder |
Stateful encoder class. More... | |
Enumerations | |
enum | CharsetOption { NoOption = 0 , ForceDefaultCharset = 1 } |
Charset options for RFC2047 encoder. More... | |
Functions | |
QByteArray | base45Decode (const QByteArray &in) |
Decodes the given data that was encoded using the base45 codec. | |
QByteArray | base64Decode (const QByteArray &in) |
Decodes the given data that was encoded using the base64 algorithm. | |
void | base64Decode (const QByteArray &in, QByteArray &out) |
Decodes the given data that was encoded with the base64 algorithm. | |
QByteArray | base64Encode (const QByteArray &in) |
Encodes the given data using the base64 algorithm. | |
void | base64Encode (const QByteArray &in, QByteArray &out, bool insertLFs=false) |
Encodes the given data using the base64 algorithm. | |
QString | decodeRFC2047String (const QByteArray &src, QByteArray *usedCS, const QByteArray &defaultCS=QByteArray(), CharsetOption option=NoOption) |
Decodes string src according to RFC2047, i.e. | |
QString | decodeRFC2047String (const QString &text) |
Decodes string text according to RFC2047, i.e., the construct =?charset?[qb]?encoded?=. | |
QByteArray | encodeRFC2047String (const QString &src, const QByteArray &charset) |
Encodes string src according to RFC2047 using charset charset . | |
bool | parseEncodedWord (const char *&, const char *, QString *, QByteArray *, QByteArray *, const QByteArray &, CharsetOption) |
QByteArray | quotedPrintableDecode (const QByteArray &in) |
Decodes a quoted-printable encoded data. | |
void | quotedPrintableDecode (const QByteArray &in, QByteArray &out) |
Decodes a quoted-printable encoded data. | |
QByteArray | quotedPrintableEncode (const QByteArray &in, bool useCRLF=true) |
Encodes the given data using the quoted-printable algorithm. | |
void | quotedPrintableEncode (const QByteArray &in, QByteArray &out, bool useCRLF) |
Encodes the given data using the quoted-printable algorithm. | |
QByteArray | uudecode (const QByteArray &in) |
Decodes the given data using the uudecode algorithm. | |
void | uudecode (const QByteArray &in, QByteArray &out) |
Decodes the given data using the uudecode algorithm. | |
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.
Usage:
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.
A collection of commonly used encoding and decoding algorithms.
QByteArray KCodecs::base45Decode | ( | const QByteArray & | in | ) |
Decodes the given data that was encoded using the base45 codec.
in | data to be decoded. |
QByteArray KCodecs::base64Decode | ( | const QByteArray & | in | ) |
Decodes the given data that was encoded using the base64 algorithm.
in | data to be decoded. |
void KCodecs::base64Decode | ( | const QByteArray & | in, |
QByteArray & | out | ||
) |
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.
in | data to be decoded. |
out | decoded data. |
QByteArray KCodecs::base64Encode | ( | const QByteArray & | in | ) |
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.
in | data to be encoded. |
insertLFs | limit the number of characters per line. |
void KCodecs::base64Encode | ( | const QByteArray & | in, |
QByteArray & | out, | ||
bool | insertLFs = false |
||
) |
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.
in | data to be encoded. |
out | encoded data. |
insertLFs | limit the number of characters per line. |
QString KCodecs::decodeRFC2047String | ( | const QByteArray & | src, |
QByteArray * | usedCS, | ||
const QByteArray & | defaultCS = QByteArray() , |
||
CharsetOption | option = NoOption |
||
) |
Decodes string src
according to RFC2047, i.e.
the construct =?charset?[qb]?encoded?=
src | source string. |
usedCS | the name of any detected charset or, in case of multiple different ones, "UTF-8" as that of a super charset is returned here |
defaultCS | the charset to use in case the detected one isn't known to us. |
option | options for the encoder |
QString KCodecs::decodeRFC2047String | ( | const QString & | text | ) |
Decodes string text
according to RFC2047, i.e., the construct =?charset?[qb]?encoded?=.
text | source string |
QByteArray KCodecs::encodeRFC2047String | ( | const QString & | src, |
const QByteArray & | charset | ||
) |
Encodes string src
according to RFC2047 using charset charset
.
This function also makes commas, quotes and other characters part of the encoded name, for example the string "Jöhn Döe" <john@.nosp@m.exam.nosp@m.ple.c.nosp@m.om"> would be encoded as <encoded word for "Jöhn Döe"> john@.nosp@m.exam.nosp@m.ple.c.nosp@m.om, i.e. the opening and closing quote mark would be part of the encoded word. Therefore don't use this function for input strings that contain semantically meaningful characters, like the quoting marks in this example.
src | source string. |
charset | charset to use. If it can't encode the string, UTF-8 will be used instead. |
QByteArray KCodecs::quotedPrintableDecode | ( | const QByteArray & | in | ) |
Decodes a quoted-printable encoded data.
Accepts data with CRLF or standard unix line breaks.
in | data to be decoded. |
void KCodecs::quotedPrintableDecode | ( | const QByteArray & | in, |
QByteArray & | out | ||
) |
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.
in | data to be decoded. |
out | decoded data. |
QByteArray KCodecs::quotedPrintableEncode | ( | const QByteArray & | in, |
bool | useCRLF = true |
||
) |
Encodes the given data using the quoted-printable algorithm.
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. |
void KCodecs::quotedPrintableEncode | ( | const QByteArray & | in, |
QByteArray & | out, | ||
bool | useCRLF | ||
) |
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.
in | data to be encoded. |
out | encoded data. |
useCRLF | if true the input data is expected to have CRLF line breaks and the output will have CRLF line breaks, too. |
QByteArray KCodecs::uudecode | ( | const QByteArray & | in | ) |
Decodes the given data using the uudecode algorithm.
Any 'begin' and 'end' lines like those generated by the utilities in unix and unix-like OS will be automatically ignored.
in | data to be decoded. |
void KCodecs::uudecode | ( | const QByteArray & | in, |
QByteArray & | out | ||
) |
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.
in | data to be decoded. |
out | uudecoded data. |