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

A format context for use by `formatter::parse()` partial specialization. It provides access to iterators for the start and end of the remaining (unparsed) format string, as well as argument counters.

== Synopsis

Declared in `<bslfmt_formatparsecontext.h>`

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

== Type Aliases

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bslfmt/basic_format_parse_context/char_type.adoc[`char_type`] 
| This `typedef` is an alias for the character type `t_CHAR`.
| xref:BloombergLP/bslfmt/basic_format_parse_context/const_iterator.adoc[`const_iterator`] 
| This `typedef` is an alias for a constant iterator over the format string.
| xref:BloombergLP/bslfmt/basic_format_parse_context/iterator.adoc[`iterator`] 
| This `typedef` is an alias for `const_iterator`.
|===


== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bslfmt/basic_format_parse_context/2constructor-07.adoc[`basic_format_parse_context`]         [.small]#[constructor]#
| Constructors
| xref:BloombergLP/bslfmt/basic_format_parse_context/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. The behavior is undefined unless `it` is a valid iterator to the format string used in construction of this context.
| xref:BloombergLP/bslfmt/basic_format_parse_context/begin.adoc[`begin`] 
| Return an iterator to the start of the unparsed portion of the format string.
| xref:BloombergLP/bslfmt/basic_format_parse_context/check_arg_id.adoc[`check_arg_id`] 
| Check that the specified `id` is a valid argument index. If the indexing mode is unset, the indexing mode is set to `e_MANUAL`. If the indexing mode is `e_AUTOMATIC`, caused by a previous call to `next_arg_id` then an exception of type `format_error` is thrown. If `id` is not less than the number of arguments then an exception of type `format_error` is thrown.
| xref:BloombergLP/bslfmt/basic_format_parse_context/end.adoc[`end`] 
| Return an iterator to the start of the unparsed portion of the format string.
| xref:BloombergLP/bslfmt/basic_format_parse_context/next_arg_id.adoc[`next_arg_id`] 
| Return the index of the next‐unused argument. If the indexing mode is unset, the indexing mode is set to `e_AUTOMATIC`. If the indexing mode is `e_MANUAL`, caused by a previous call to `check_arg_id` then an exception of type `format_error` is thrown. If there are no remaining unused arguments then an exception of type `format_error` is thrown.
|===



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