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

== Synopsis

Declared in `<bslfmt_mockparsecontext.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
template<class t_CHAR>
class MockParseContext;
----

== Type Aliases

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


== Enums

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


== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bslfmt/MockParseContext/2constructor.adoc[`MockParseContext`]         [.small]#[constructor]#
| Create an object having the specified `fmt` as a format specification and the specified `numArgs`.
| xref:BloombergLP/bslfmt/MockParseContext/advance_to.adoc[`advance_to`] 
| Update the held iterator to the unparsed portion of the format string to be the specified `it`. Subsequent calls to `begin` will return this value.
| xref:BloombergLP/bslfmt/MockParseContext/begin.adoc[`begin`] 
| Return an iterator to the beginning of the format specification.
| xref:BloombergLP/bslfmt/MockParseContext/check_arg_id.adoc[`check_arg_id`] 
| Check whether the specified `id` is in range of number of arguments and enter manual indexing mode. Throw `bslfmt::format_error` if this object has already entered automatic indexing mode.
| xref:BloombergLP/bslfmt/MockParseContext/end.adoc[`end`] 
| Return an iterator to the end of the format specification.
| xref:BloombergLP/bslfmt/MockParseContext/indexingMode-08.adoc[`indexingMode`] 
| Return the current indexing mode.
| xref:BloombergLP/bslfmt/MockParseContext/next_arg_id.adoc[`next_arg_id`] 
| Enter automatic indexing mode and return the next argument index. Throw `bslfmt::format_error` if this object has already entered manual indexing mode.
|===



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