std::time_get::get_monthname, std::time_get::do_get_monthname

 

C++

Language

Standard library headers

Concepts

Utilities library

Strings library

Containers library

Algorithms library

Iterators library

Numerics library

Input/output library

Localizations library

Regular expressions library (C++11)

Atomic operations library (C++11)

Thread support library (C++11)

 

Localizations library

Locales and facets
locale
use_facet	has_facet
Character classification
isspace isblank (C++11) iscntrl isupper islower isalpha	isdigit ispunct isxdigit isalnum isprint isgraph
Conversions
toupper tolower	wstring_convert (C++11) wbuffer_convert (C++11)
Facet category base classes
ctype_base codecvt_base messages_base	time_base money_base
Facet categories
ctype ctype<char> codecvt collate messages time_get time_put	num_get num_put numpunct money_get money_put moneypunct
Locale-specific facets
ctype_byname ctype_byname<char> codecvt_byname messages_byname collate_byname	time_get_byname time_put_byname numpunct_byname moneypunct_byname
Code conversion facets
codecvt_utf8 (C++11) codecvt_utf16 (C++11)	codecvt_utf8_utf16 (C++11) codecvt_mode (C++11)
C locale
setlocale localeconv lconv	LC_ALL LC_COLLATE LC_CTYPE LC_MONETARY LC_NUMERIC LC_TIME

 

std::time_get

Member functions

time_get::time_get

time_get::~time_get

time_get::date_order time_get::do_date_order

time_get::get_time time_get::do_get_time

time_get::get_date time_get::do_get_date

time_get::get_weekday time_get::do_get_weekday

time_get::get_monthname time_get::do_get_monthname

time_get::get_year time_get::do_get_year

time_get::get time_get::do_get

 

Defined in header <locale>
public: iter_type get_monthname( iter_type beg, iter_type end, std::ios_base& str,                          std::ios_base::iostate& err, std::tm* t) const;	(1)
protected: virtual iter_type do_get_monthname( iter_type beg, iter_type end, std::ios_base& str,                                     std::ios_base::iostate& err, std::tm* t) const;	(2)

1) public member function, calls the protected virtual member function do_get_monthname of the most derived class.

2) Reads successive characters from the sequence [beg, end) and parses out the month name (possibly abbreviated), using the default format for month names expected by this locale, which is the same format as "%b" as used by the functions std::get_time, time_get::get, and the POSIX function strptime()

If it finds abbreviated name, followed by the characters that are valid for the full name, it continues reading until it consumes all the characters for the full name or finds a character that isn't expected, in which case parsing fails even if the first few characters were a valid abbreviation.

The parsed month is stored in the std::tm field t->tm_mon.

If the end iterator is reached before a valid month name is read, the function sets std::ios_base::eofbit in err. If a parsing error is encountered, the function sets std::ios_base::failbit in err.

Parameters

beg	-	iterator designating the start of the sequence to parse
end	-	one past the end iterator for the sequence to parse
str	-	a stream object that this function uses to obtain locale facets when needed, e.g. std::ctype to skip whitespace or std::collate to compare strings
err	-	stream error flags object that is modified by this function to indicate errors
t	-	pointer to the std::tm object that will hold the result of this function call

Return value

Iterator pointing one past the last character in [beg, end) that was recognized as a part of a valid month name.

Notes

This function is usually case-insensitive.

If a parsing error is encountered, most implementations of this function leave *t unmodified.

Example

run this code

#include <iostream>
#include <locale>
#include <sstream>
#include <iterator>
#include <ctime>
 
void try_get_mon(const std::string& s)
{
    std::cout << "Parsing the month out of '" << s <<
                 "' in the locale " << std::locale().name() << '\n';
    std::istringstream str(s);
    std::ios_base::iostate err = std::ios_base::goodbit;
 
    std::tm t;
    std::istreambuf_iterator<char> ret =
        std::use_facet<std::time_get<char>>(str.getloc()).get_monthname(
            std::istreambuf_iterator<char>(str),
            std::istreambuf_iterator<char>(),
            str, err, &t
        );
    str.setstate(err);
    if(str) {
        std::cout << "Successfully parsed, month number is " << t.tm_mon;
        if(ret != std::istreambuf_iterator<char>()) {
            std::cout << ". Remaining content: ";
            std::copy(ret, std::istreambuf_iterator<char>(),
                      std::ostreambuf_iterator<char>(std::cout));
        } else {
            std::cout << ". The input was fully consumed";
        }
    } else {
        std::cout << "Parse failed. Unparsed string: ";
        std::copy(ret, std::istreambuf_iterator<char>(),
                  std::ostreambuf_iterator<char>(std::cout));
    }
    std::cout << '\n';
}
int main()
{
    std::locale::global(std::locale("ja_JP.utf8"));
    try_get_mon("2月");
    std::locale::global(std::locale("th_TH.utf8"));
    try_get_mon("กุมภาพันธ์");
    std::locale::global(std::locale("el_GR.utf8"));
    try_get_mon("Φεβ");
    try_get_mon("Φεβρουάριος");
    std::locale::global(std::locale("en_US.utf8"));
    try_get_mon("Febrile");
}

Output:

Parsing the month out of '2月' in the locale ja_JP.utf8
Successfully parsed, month number is 1. The input was fully consumed
Parsing the month out of 'กุมภาพันธ์' in the locale th_TH.utf8
Successfully parsed, month number is 1. The input was fully consumed
Parsing the month out of 'Φεβ' in the locale el_GR.utf8
Successfully parsed, month number is 1. The input was fully consumed
Parsing the month out of 'Φεβρουάριος' in the locale el_GR.utf8
Successfully parsed, month number is 1. The input was fully consumed
Parsing the month out of 'Febrile' in the locale en_US.utf8
Parse failed. Unparsed string: ile

See also

get_time (C++11)	parses a date/time value of specified format (function template)