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

Parse context for use by `formatter::parse()` specializations.

== Synopsis

Declared in `<bslfmt_formatparsecontext.h>`

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

== Description

Provides access to iterators for the start and end of the remaining (unparsed) format string, as well as argument counters.

== 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`] 
| Advance the unparsed‐portion iterator to the specified position.
| 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 argument index is valid.
| xref:BloombergLP/bslfmt/basic_format_parse_context/end.adoc[`end`] 
| Return an iterator to the end 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.
|===



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