[#BloombergLP-bslfmt-MockParseContext]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/bslfmt.adoc[bslfmt]::MockParseContext
:relfileprefix: ../../
:mrdocs:

This class template provides an access to the format specification current parsing state&period;

== Synopsis

Declared in `&lt;bslfmt&lowbar;mockparsecontext&period;h&gt;`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
template&lt;class t&lowbar;CHAR&gt;
class MockParseContext;
----

== Type Aliases

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bslfmt/MockParseContext/char_type.adoc[`char&lowbar;type`] 
| Character type of the format specification&period;
| xref:BloombergLP/bslfmt/MockParseContext/const_iterator.adoc[`const&lowbar;iterator`] 
| Constant iterator over the format specification&period;
| xref:BloombergLP/bslfmt/MockParseContext/iterator.adoc[`iterator`] 
| Iterator over the format specification (same as `const&lowbar;iterator`)&period;
|===


== Enums

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bslfmt/MockParseContext/IndexingMode-0d.adoc[`IndexingMode`] 
| Argument indexing mode&period;
|===


== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bslfmt/MockParseContext/2constructor.adoc[`MockParseContext`]         [.small]#[constructor]#
| Create a mock parse context for the specified format string and argument count&period;
| xref:BloombergLP/bslfmt/MockParseContext/advance_to.adoc[`advance&lowbar;to`] 
| Update the held iterator to the unparsed portion of the format string to be the specified `it`&period;
| xref:BloombergLP/bslfmt/MockParseContext/begin.adoc[`begin`] 
| Return an iterator to the beginning of the format specification&period;
| xref:BloombergLP/bslfmt/MockParseContext/check_arg_id.adoc[`check&lowbar;arg&lowbar;id`] 
| Check that the specified argument index is valid and enter manual indexing mode&period;
| xref:BloombergLP/bslfmt/MockParseContext/end.adoc[`end`] 
| Return an iterator to the end of the format specification&period;
| xref:BloombergLP/bslfmt/MockParseContext/indexingMode-08.adoc[`indexingMode`] 
| Return the current indexing mode&period;
| xref:BloombergLP/bslfmt/MockParseContext/next_arg_id.adoc[`next&lowbar;arg&lowbar;id`] 
| Enter automatic indexing mode and return the next argument index&period; Throw `bslfmt&colon;&colon;format&lowbar;error` if this object has already entered manual indexing mode&period;
|===



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