[#BloombergLP-bdlde-QuotedPrintableDecoder]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/bdlde.adoc[bdlde]::QuotedPrintableDecoder
:relfileprefix: ../../
:mrdocs:

This class implements a mechanism capable of converting data of arbitrary length from its corresponding Quoted&hyphen;Printable representation&period;

== Synopsis

Declared in `&lt;bdlde&lowbar;quotedprintabledecoder&period;h&gt;`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
class QuotedPrintableDecoder;
----

== Enums

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bdlde/QuotedPrintableDecoder/EquivalenceClasses.adoc[`EquivalenceClasses`] 
| Input character equivalence classes used by the decoder state machine&period; Underscored enumerators apply in strict mode&semi; others apply in relaxed mode where noted&period;
| xref:BloombergLP/bdlde/QuotedPrintableDecoder/LineBreakMode-08.adoc[`LineBreakMode`] 
| Configuration governing how hard line breaks (`&quot;rn&quot;`) are decoded&period;
|===


== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bdlde/QuotedPrintableDecoder/2constructor.adoc[`QuotedPrintableDecoder`]         [.small]#[constructor]#
| Create a Quoted&hyphen;Printable decoder in the initial state&period;
| xref:BloombergLP/bdlde/QuotedPrintableDecoder/2destructor.adoc[`&#126;QuotedPrintableDecoder`] [.small]#[destructor]#
| Destroy this object&period;
| xref:BloombergLP/bdlde/QuotedPrintableDecoder/convert.adoc[`convert`] 
| Decode Quoted&hyphen;Printable characters from `&lsqb;begin, end)&rsqb;` into `out`&period;
| xref:BloombergLP/bdlde/QuotedPrintableDecoder/endConvert.adoc[`endConvert`] 
| Complete decoding and flush any retained output to `out`&period;
| xref:BloombergLP/bdlde/QuotedPrintableDecoder/isAccepting.adoc[`isAccepting`] 
| Return whether the input so far is syntactically complete&period;
| xref:BloombergLP/bdlde/QuotedPrintableDecoder/isDone.adoc[`isDone`] 
| Return whether decoding is finished and no further input is allowed&period;
| xref:BloombergLP/bdlde/QuotedPrintableDecoder/isError.adoc[`isError`] 
| Return whether this decoder has encountered an irrecoverable error&period;
| xref:BloombergLP/bdlde/QuotedPrintableDecoder/isInitialState.adoc[`isInitialState`] 
| Return `true` if this decoder is in the initial state (i&period;e&period;, as if no input had been consumed) and `false` otherwise&period;
| xref:BloombergLP/bdlde/QuotedPrintableDecoder/isMaximal.adoc[`isMaximal`] 
| Return whether the input to this decoder is maximal&period;
| xref:BloombergLP/bdlde/QuotedPrintableDecoder/isUnrecognizedAnError.adoc[`isUnrecognizedAnError`] 
| Return `true` if this decoder is currently configured to detect an error when an unrecognizable encoding is encountered, and `false` otherwise&period;
| xref:BloombergLP/bdlde/QuotedPrintableDecoder/lineBreakMode-02.adoc[`lineBreakMode`] 
| Return the line break mode specified for this decoder&period;
| xref:BloombergLP/bdlde/QuotedPrintableDecoder/numOutputPending.adoc[`numOutputPending`] 
| Return the number of output bytes retained by this decoder and not emitted because `maxNumOut` has been reached&period;
| xref:BloombergLP/bdlde/QuotedPrintableDecoder/outputLength.adoc[`outputLength`] 
| Return the total length of the output emitted thus far&period;
| xref:BloombergLP/bdlde/QuotedPrintableDecoder/reset.adoc[`reset`] 
| Reset this decoder to its initial state (i&period;e&period;, as if no input had been consumed)&period;
|===


== Static Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bdlde/QuotedPrintableDecoder/lineBreakModeToAscii.adoc[`lineBreakModeToAscii`] 
| Return the ASCII name of the specified line&hyphen;break `mode`&period;
|===


== Data Members

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bdlde/QuotedPrintableDecoder/d_buffer.adoc[`d&lowbar;buffer`] 
| Pending input characters awaiting further decoding&period;
| xref:BloombergLP/bdlde/QuotedPrintableDecoder/d_bufferLength.adoc[`d&lowbar;bufferLength`] 
| Number of valid characters currently stored in `d&lowbar;buffer`&period;
| xref:BloombergLP/bdlde/QuotedPrintableDecoder/d_equivClass_p.adoc[`d&lowbar;equivClass&lowbar;p`] 
| Map of `unsigned char` to input equivalence class&semi; dynamically allocated because there is no default complete configuration&period;
| xref:BloombergLP/bdlde/QuotedPrintableDecoder/d_hexBuffer.adoc[`d&lowbar;hexBuffer`] 
| First hex digit buffered while decoding an `&equals;XX` escape sequence&period;
| xref:BloombergLP/bdlde/QuotedPrintableDecoder/d_lineBreakMode.adoc[`d&lowbar;lineBreakMode`] 
| How hard line breaks are decoded&period;
| xref:BloombergLP/bdlde/QuotedPrintableDecoder/d_outputLength.adoc[`d&lowbar;outputLength`] 
| Total number of output characters produced so far&period;
| xref:BloombergLP/bdlde/QuotedPrintableDecoder/d_state.adoc[`d&lowbar;state`] 
| Current decoder state&hyphen;machine state&period;
| xref:BloombergLP/bdlde/QuotedPrintableDecoder/d_unrecognizedIsErrorFlag.adoc[`d&lowbar;unrecognizedIsErrorFlag`] 
| If `true`, unrecognized characters are treated as errors&period;
|===


== Static Data Members

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bdlde/QuotedPrintableDecoder/s_componentName.adoc[`s&lowbar;componentName`] 
| Name of component used when reporting errors&period;
| xref:BloombergLP/bdlde/QuotedPrintableDecoder/s_decodingMap_p.adoc[`s&lowbar;decodingMap&lowbar;p`] 
| Character map used for converting an ASCII character to the hexadecimal value it is representing&period;
| xref:BloombergLP/bdlde/QuotedPrintableDecoder/s_defaultEquivClassCRLF_p.adoc[`s&lowbar;defaultEquivClassCRLF&lowbar;p`] 
| Default map of `unsigned char` to equivalence class for CRLF line break mode
| xref:BloombergLP/bdlde/QuotedPrintableDecoder/s_defaultEquivClassStrict_p.adoc[`s&lowbar;defaultEquivClassStrict&lowbar;p`] 
| Default map of `unsigned char` to equivalence class for strict mode
| xref:BloombergLP/bdlde/QuotedPrintableDecoder/s_defaultMaxLineLength.adoc[`s&lowbar;defaultMaxLineLength`] 
| Default maximum line length used when configuring the decoder&period;
| xref:BloombergLP/bdlde/QuotedPrintableDecoder/s_defaultUnrecognizedIsErrorFlag.adoc[`s&lowbar;defaultUnrecognizedIsErrorFlag`] 
| Default error reporting mode
| xref:BloombergLP/bdlde/QuotedPrintableDecoder/s_lineBreakModeName.adoc[`s&lowbar;lineBreakModeName`] 
| ASCII names corresponding to `LineBreakMode` enumerators&period;
|===



[.small]#Created with https://www.mrdocs.com[MrDocs]#
