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

A general mechanism to parse and validate a Standard format specification string for a given argument type.

== Synopsis

Declared in `<bslfmt_standardformatspecification.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
template<class t_CHAR>
class StandardFormatSpecification
    : public xref:BloombergLP/bslfmt/FormatSpecificationParserEnums.adoc[FormatSpecificationParserEnums]
----

== Base Classes

[cols="1,4"]
|===
| Name| Description
| `xref:BloombergLP/bslfmt/FormatSpecificationParserEnums.adoc[FormatSpecificationParserEnums]`
| Namespace struct holding enums used for parsing.
|===

== Enums

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bslfmt/FormatSpecificationParserEnums/Alignment.adoc[`Alignment`] 
| Alignment options parsed from a format specification.
| xref:BloombergLP/bslfmt/StandardFormatSpecification/Category.adoc[`Category`] 
| Format category enumeration.
| xref:BloombergLP/bslfmt/StandardFormatSpecification/FormatType-01.adoc[`FormatType`] 
| Format type enumeration.
| xref:BloombergLP/bslfmt/FormatSpecificationParserEnums/ProcessingState.adoc[`ProcessingState`] 
| Parser processing states for a format specification.
| xref:BloombergLP/bslfmt/FormatSpecificationParserEnums/Sections.adoc[`Sections`] 
| Bit flags indicating which format‐spec sections were parsed.
| xref:BloombergLP/bslfmt/FormatSpecificationParserEnums/Sign.adoc[`Sign`] 
| Sign options parsed from a format specification.
|===


== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bslfmt/StandardFormatSpecification/2constructor.adoc[`StandardFormatSpecification`]         [.small]#[constructor]#
| Create an uninitialized `StandardFormatSpecification` object.
| xref:BloombergLP/bslfmt/StandardFormatSpecification/alignment.adoc[`alignment`] 
| Return the requested alignment enumerator.
| xref:BloombergLP/bslfmt/StandardFormatSpecification/alternativeFlag.adoc[`alternativeFlag`] 
| Return whether alternative formatting was requested.
| xref:BloombergLP/bslfmt/StandardFormatSpecification/filler.adoc[`filler`] 
| Return a pointer to the parsed filler character storage.
| xref:BloombergLP/bslfmt/StandardFormatSpecification/fillerCodePointDisplayWidth.adoc[`fillerCodePointDisplayWidth`] 
| Return the display width of the filler code point.
| xref:BloombergLP/bslfmt/StandardFormatSpecification/formatType-0a.adoc[`formatType`] 
| Return the requested format‐type enumerator.
| xref:BloombergLP/bslfmt/StandardFormatSpecification/localeSpecificFlag.adoc[`localeSpecificFlag`] 
| Return whether a locale‐specific formatting flag was present.
| xref:BloombergLP/bslfmt/StandardFormatSpecification/numFillerCharacters.adoc[`numFillerCharacters`] 
| Return the number of characters in the filler storage.
| xref:BloombergLP/bslfmt/StandardFormatSpecification/parse.adoc[`parse`] 
| Parse a Standard format specification from `context`.
| xref:BloombergLP/bslfmt/StandardFormatSpecification/postprocess.adoc[`postprocess`] 
| Resolve nested width and precision from `context` arguments.
| xref:BloombergLP/bslfmt/StandardFormatSpecification/postprocessedPrecision.adoc[`postprocessedPrecision`] 
| Return the postprocessed format precision, if any.
| xref:BloombergLP/bslfmt/StandardFormatSpecification/postprocessedWidth.adoc[`postprocessedWidth`] 
| Return the postprocessed format width, if any.
| xref:BloombergLP/bslfmt/StandardFormatSpecification/processingState.adoc[`processingState`] 
| Return the current processing state of this specification.
| xref:BloombergLP/bslfmt/StandardFormatSpecification/sign.adoc[`sign`] 
| Return the requested sign‐treatment enumerator.
| xref:BloombergLP/bslfmt/StandardFormatSpecification/zeroPaddingFlag.adoc[`zeroPaddingFlag`] 
| Return whether zero padding was requested.
|===



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