KCodecs
Classes | |
class | Base64Codec |
class | BinaryCodec |
class | Codec |
class | Decoder |
class | EightBitCodec |
class | Encoder |
class | IdentityCodec |
class | QuotedPrintableCodec |
class | Rfc2047BEncodingCodec |
class | Rfc2047QEncodingCodec |
class | Rfc2231EncodingCodec |
class | SevenBitCodec |
class | UUCodec |
Enumerations | |
enum | CharsetOption { NoOption = 0, ForceDefaultCharset = 1 } |
Functions | |
KCODECS_EXPORT QByteArray | base45Decode (const QByteArray &in) |
KCODECS_EXPORT QByteArray | base64Decode (const QByteArray &in) |
KCODECS_EXPORT void | base64Decode (const QByteArray &in, QByteArray &out) |
KCODECS_EXPORT QByteArray | base64Encode (const QByteArray &in) |
KCODECS_EXPORT QByteArray | base64Encode (const QByteArray &in, bool insertLFs) |
KCODECS_EXPORT void | base64Encode (const QByteArray &in, QByteArray &out, bool insertLFs=false) |
static char | binToHex (uchar value) |
QByteArray | cachedCharset (const QByteArray &name) |
KCODECS_EXPORT QString | decodeRFC2047String (const QByteArray &src, QByteArray *usedCS, const QByteArray &defaultCS=QByteArray(), CharsetOption option=NoOption) |
KCODECS_EXPORT QString | decodeRFC2047String (const QString &text) |
QByteArray | encodeRFC2047String (const QString &src, const QByteArray &charset) |
static uchar | highNibble (uchar ch) |
static bool | keep (uchar ch) |
static uchar | lowNibble (uchar ch) |
bool | parseEncodedWord (const char *&, const char *, QString *, QByteArray *, QByteArray *, const QByteArray &, CharsetOption) |
KCODECS_EXPORT QByteArray | quotedPrintableDecode (const QByteArray &in) |
KCODECS_EXPORT void | quotedPrintableDecode (const QByteArray &in, QByteArray &out) |
static int | QuotedPrintableDecoder_maxDecodedSizeFor (int insize, Codec::NewlineType newline) |
KCODECS_EXPORT QByteArray | quotedPrintableEncode (const QByteArray &in, bool useCRLF=true) |
KCODECS_EXPORT void | quotedPrintableEncode (const QByteArray &in, QByteArray &out, bool useCRLF) |
QByteArray | updateEncodingCharset (const QByteArray ¤tCharset, const QByteArray &nextCharset) |
KCODECS_EXPORT QByteArray | uudecode (const QByteArray &in) |
KCODECS_EXPORT void | uudecode (const QByteArray &in, QByteArray &out) |
static uchar | uuDecode (uchar c) |
KCODECS_EXPORT QByteArray | uuencode (const QByteArray &in) |
KCODECS_EXPORT void | uuencode (const QByteArray &in, QByteArray &out) |
Variables | |
static QList< QByteArray > | charsetCache |
const uchar | eTextMap [16] = {0x00, 0x00, 0x00, 0x00, 0x40, 0x35, 0xFF, 0xC0, 0x7F, 0xFF, 0xFF, 0xE0, 0x7F, 0xFF, 0xFF, 0xE0} |
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.
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.
Enumeration Type Documentation
◆ CharsetOption
Function Documentation
◆ base45Decode()
QByteArray KCodecs::base45Decode | ( | const QByteArray & | in | ) |
Decodes the given data that was encoded using the base45 codec.
- Parameters
-
in data to be decoded.
- Returns
- decoded string.
- Since
- 5.84
Definition at line 25 of file kcodecsbase45.cpp.
◆ base64Decode() [1/2]
QByteArray KCodecs::base64Decode | ( | const QByteArray & | in | ) |
Decodes the given data that was encoded using the base64 algorithm.
- Parameters
-
in data to be decoded.
- Returns
- decoded string.
Definition at line 137 of file kcodecs.cpp.
◆ base64Decode() [2/2]
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.
- Parameters
-
in data to be decoded. out decoded data.
Definition at line 143 of file kcodecs.cpp.
◆ base64Encode() [1/3]
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.
- Parameters
-
in data to be encoded. insertLFs limit the number of characters per line.
- Returns
- base64 encoded string.
- Since
- 5.5
Definition at line 117 of file kcodecs.cpp.
◆ base64Encode() [2/3]
QByteArray KCodecs::base64Encode | ( | const QByteArray & | in, |
bool | insertLFs | ||
) |
KCodecs::base64Encode(QByteArray)
- Deprecated:
- Since 5.5, use KCodecs::base64Encode(QByteArray) instead.
Definition at line 124 of file kcodecs.cpp.
◆ base64Encode() [3/3]
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.
- Parameters
-
in data to be encoded. out encoded data. insertLFs limit the number of characters per line.
Definition at line 131 of file kcodecs.cpp.
◆ binToHex()
|
inlinestatic |
Converts a 4-bit value
into its hexadecimal characater representation.
So input of value [0,15] returns ['0','1',... 'F']. Input values greater than 15 will produce undesired results.
- Parameters
-
value is an unsigned character containing the 4-bit input value.
Definition at line 41 of file kcodecsqp.cpp.
◆ decodeRFC2047String() [1/2]
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?=
- Parameters
-
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
- Returns
- the decoded string.
- Since
- 5.5
Definition at line 380 of file kcodecs.cpp.
◆ decodeRFC2047String() [2/2]
Decodes string text
according to RFC2047, i.e., the construct =?charset?[qb]?encoded?=.
- Parameters
-
text source string
- Returns
- the decoded string
Definition at line 374 of file kcodecs.cpp.
◆ encodeRFC2047String()
KCODECS_EXPORT 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@"> would be encoded as <encoded word for "Jöhn Döe"> exam ple.c omjohn@, 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. exam ple.c om
- Parameters
-
src source string. charset charset to use. If it can't encode the string, UTF-8 will be used instead.
- Returns
- the encoded string.
- Since
- 5.5
Definition at line 441 of file kcodecs.cpp.
◆ highNibble()
|
inlinestatic |
Returns the high-order 4 bits of an 8-bit value in another 8-bit value.
- Parameters
-
ch is an unsigned character containing the 8-bit input value.
Definition at line 54 of file kcodecsqp.cpp.
◆ keep()
|
inlinestatic |
Returns true if the specified value is a not Control character or question mark; else true.
- Parameters
-
ch is an unsigned character containing the 8-bit input value.
Definition at line 73 of file kcodecsqp.cpp.
◆ lowNibble()
|
inlinestatic |
Returns the low-order 4 bits of an 8-bit value in another 8-bit value.
- Parameters
-
ch is an unsigned character containing the 8-bit input value.
Definition at line 63 of file kcodecsqp.cpp.
◆ quotedPrintableDecode() [1/2]
QByteArray KCodecs::quotedPrintableDecode | ( | const QByteArray & | in | ) |
Decodes a quoted-printable encoded data.
Accepts data with CRLF or standard unix line breaks.
- Parameters
-
in data to be decoded.
- Returns
- decoded string.
- Since
- 5.5
Definition at line 106 of file kcodecs.cpp.
◆ quotedPrintableDecode() [2/2]
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.
- Parameters
-
in data to be decoded. out decoded data.
Definition at line 112 of file kcodecs.cpp.
◆ quotedPrintableEncode() [1/2]
QByteArray KCodecs::quotedPrintableEncode | ( | const QByteArray & | in, |
bool | useCRLF = true |
||
) |
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 string.
Definition at line 95 of file kcodecs.cpp.
◆ quotedPrintableEncode() [2/2]
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.
- Parameters
-
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.
Definition at line 101 of file kcodecs.cpp.
◆ uudecode() [1/2]
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.
- Parameters
-
in data to be decoded.
- Returns
- decoded string.
Definition at line 163 of file kcodecs.cpp.
◆ uudecode() [2/2]
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.
- Parameters
-
in data to be decoded. out uudecoded data.
Definition at line 169 of file kcodecs.cpp.
◆ uuencode() [1/2]
QByteArray KCodecs::uuencode | ( | const QByteArray & | in | ) |
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 data to be uuencoded
- Returns
- uuencoded string.
- Deprecated:
- Not implemented, always returns an empty bytearray.
Definition at line 149 of file kcodecs.cpp.
◆ uuencode() [2/2]
void KCodecs::uuencode | ( | const QByteArray & | in, |
QByteArray & | out | ||
) |
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 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 uuencoded. out an empty byte array
- Deprecated:
- Not implemented, always set
out
to an empty bytearray.
Definition at line 157 of file kcodecs.cpp.
Documentation copyright © 1996-2023 The KDE developers.
Generated on Sun Dec 3 2023 04:10:34 by doxygen 1.8.17 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.