#include <bslfmt_standardformatspecification.h>
Detailed Description
class bslfmt::StandardFormatSpecification< t_CHAR >
A general mechanism to parse and validate a Standard format specification string for a given argument type.
Public Types inherited from Member Enumeration Documentation
◆ Category
| enum bslfmt::StandardFormatSpecification::Category |
◆ FormatType
| enum bslfmt::StandardFormatSpecification::FormatType |
Constructor & Destructor Documentation
◆ StandardFormatSpecification()
| BSLS_KEYWORD_CONSTEXPR_CPP20 bslfmt::StandardFormatSpecification< t_CHAR >::StandardFormatSpecification | ( | ) |
Create an uninitialized StandardFormatSpecification object.
Member Function Documentation
◆ alignment()
| BSLS_KEYWORD_CONSTEXPR_CPP20 StandardFormatSpecification< t_CHAR >::Alignment bslfmt::StandardFormatSpecification< t_CHAR >::alignment | ( | ) | const |
Return the enumerator representing the requested alignment unless the status is not at least e_STATE_PARSED in which case throw a bsl::format_error exception indicating that error.
◆ alternativeFlag()
| BSLS_KEYWORD_CONSTEXPR_CPP20 bool bslfmt::StandardFormatSpecification< t_CHAR >::alternativeFlag | ( | ) | const |
Return a boolean indicating if alternative formatting was requested unless the status is not at least e_STATE_PARSED in which case throw a bsl::format_error exception indicating that error.
◆ filler()
| BSLS_KEYWORD_CONSTEXPR_CPP20 const t_CHAR * bslfmt::StandardFormatSpecification< t_CHAR >::filler | ( | ) | const |
Return a pointer to the character array that stores the parsed filler character that may be a multibyte code point or just a single character unless the status is not e_STATE_PARSED or e_STATE_POSTPROCESSED in which case throw a bsl::format_error exception indicating that error. See also numFillerCharacters() that provides the number of characters in the array returned by this function (at least one).
◆ fillerCodePointDisplayWidth()
| BSLS_KEYWORD_CONSTEXPR_CPP20 int bslfmt::StandardFormatSpecification< t_CHAR >::fillerCodePointDisplayWidth | ( | ) | const |
Return the display width of the code point represented by the array returned by filler() unless the status is not e_STATE_PARSED or e_STATE_POSTPROCESSED in which case throw a bsl::format_error exception indicating that error.
◆ formatType()
| BSLS_KEYWORD_CONSTEXPR_CPP20 StandardFormatSpecification< t_CHAR >::FormatType bslfmt::StandardFormatSpecification< t_CHAR >::formatType | ( | ) | const |
Return the enumerator representing the requested format type unless the status is not at least e_STATE_PARSED in which case throw a bsl::format_error exception indicating that error.
◆ localeSpecificFlag()
| BSLS_KEYWORD_CONSTEXPR_CPP20 bool bslfmt::StandardFormatSpecification< t_CHAR >::localeSpecificFlag | ( | ) | const |
Return a boolean indicating if the locale specific flag was present in the format specification unless the status is not at least e_STATE_PARSED in which case throw a bsl::format_error exception indicating that error.
- Note
- Note that the locale specific flag is not yet supported hence the attempt to format with a specification that has this flags set will result in an exception indicating that.
◆ numFillerCharacters()
| BSLS_KEYWORD_CONSTEXPR_CPP20 int bslfmt::StandardFormatSpecification< t_CHAR >::numFillerCharacters | ( | ) | const |
Return the number of filler characters in the array returned by filler() unless the status is not e_STATE_PARSED or e_STATE_POSTPROCESSED in which case throw a bsl::format_error exception indicating that error.
◆ parse()
| BSLS_KEYWORD_CONSTEXPR_CPP20 void bslfmt::StandardFormatSpecification< t_CHAR >::parse | ( | t_PARSE_CONTEXT * | context, |
| Category | category | ||
| ) |
Parse a format string using the iterator-range from the specified context assuming it is a Standard format specification for arguments of the specified category and if successful update this object with the parsing result, as well as set the status to e_PARSED; otherwise, if the format specification denoted by the context iterator-range is not a valid Standard format specification for arguments of category category throw a bsl::format_error exception.
◆ postprocess()
| void bslfmt::StandardFormatSpecification< t_CHAR >::postprocess | ( | const t_FORMAT_CONTEXT & | context | ) |
Update the corresponding attributes of this object using the argument values provided by the specified context to fill in the values of nested width or precision parameters if such nested parameters exist and set the status of this object to e_STATE_POSTPROCESSED. By nested format parameters we mean parameters whose value comes from an argument to the formatter function, and not an literal integer value within the format string. In case of an error throw a bsl::format_error exception.
◆ postprocessedPrecision()
| BSLS_KEYWORD_CONSTEXPR_CPP20 const FormatterSpecificationNumericValue bslfmt::StandardFormatSpecification< t_CHAR >::postprocessedPrecision | ( | ) | const |
Return an optional value representing the requested precision unless the status is not e_STATE_POSTPROCESSED in which case throw a bsl::format_error exception indicating that error.
- Note
- Note that the returned type is capable of representing more than just an optional integer, but after preprocessing it will have only two possible states: no value, or an integer value.
◆ postprocessedWidth()
| BSLS_KEYWORD_CONSTEXPR_CPP20 const FormatterSpecificationNumericValue bslfmt::StandardFormatSpecification< t_CHAR >::postprocessedWidth | ( | ) | const |
Return an optional value representing the requested width unless the status is not e_STATE_POSTPROCESSED in which case throw a bsl::format_error exception indicating that error.
- Note
- Note that the returned type is capable of representing more than just an optional integer, but after preprocessing it will have only two possible states: no value, or an integer value.
◆ processingState()
| BSLS_KEYWORD_CONSTEXPR_CPP20 FormatSpecificationParserEnums::ProcessingState bslfmt::StandardFormatSpecification< t_CHAR >::processingState | ( | ) | const |
Return the current processing state of this specification.
◆ sign()
| BSLS_KEYWORD_CONSTEXPR_CPP20 StandardFormatSpecification< t_CHAR >::Sign bslfmt::StandardFormatSpecification< t_CHAR >::sign | ( | ) | const |
Return the enumerator representing the requested sign-treatment option unless the status is not at least e_STATE_PARSED in which case throw a bsl::format_error exception indicating that error.
◆ zeroPaddingFlag()
| BSLS_KEYWORD_CONSTEXPR_CPP20 bool bslfmt::StandardFormatSpecification< t_CHAR >::zeroPaddingFlag | ( | ) | const |
Return a boolean indicating if zero padding was requested unless the status is not at least e_STATE_PARSED in which case throw a bsl::format_error exception indicating that error.
The documentation for this class was generated from the following file:
