[category.time] (original) (raw)

28.3.4.6.2.1 General [locale.time.get.general]

namespace std { class time_base { public: enum dateorder { no_order, dmy, mdy, ymd, ydm };};template<class charT, class InputIterator = istreambuf_iterator<charT>> class time_get : public locale::facet, public time_base { public: using char_type = charT;using iter_type = InputIterator;explicit time_get(size_t refs = 0); dateorder date_order() const { return do_date_order(); } iter_type get_time(iter_type s, iter_type end, ios_base& f, ios_base::iostate& err, tm* t) const; iter_type get_date(iter_type s, iter_type end, ios_base& f, ios_base::iostate& err, tm* t) const; iter_type get_weekday(iter_type s, iter_type end, ios_base& f, ios_base::iostate& err, tm* t) const; iter_type get_monthname(iter_type s, iter_type end, ios_base& f, ios_base::iostate& err, tm* t) const; iter_type get_year(iter_type s, iter_type end, ios_base& f, ios_base::iostate& err, tm* t) const; iter_type get(iter_type s, iter_type end, ios_base& f, ios_base::iostate& err, tm* t, char format, char modifier = 0) const; iter_type get(iter_type s, iter_type end, ios_base& f, ios_base::iostate& err, tm* t, const char_type* fmt,const char_type* fmtend) const;static locale::id id;protected: ~time_get();virtual dateorder do_date_order() const;virtual iter_type do_get_time(iter_type s, iter_type end, ios_base&, ios_base::iostate& err, tm* t) const;virtual iter_type do_get_date(iter_type s, iter_type end, ios_base&, ios_base::iostate& err, tm* t) const;virtual iter_type do_get_weekday(iter_type s, iter_type end, ios_base&, ios_base::iostate& err, tm* t) const;virtual iter_type do_get_monthname(iter_type s, iter_type end, ios_base&, ios_base::iostate& err, tm* t) const;virtual iter_type do_get_year(iter_type s, iter_type end, ios_base&, ios_base::iostate& err, tm* t) const;virtual iter_type do_get(iter_type s, iter_type end, ios_base& f, ios_base::iostate& err, tm* t, char format, char modifier) const;};}

time_get is used to parse a character sequence, extracting components of a time or date into a tm object.

Each get member parses a format as produced by a corresponding format specifier totime_put<>​::​put.

If the sequence being parsed matches the correct format, the corresponding members of thetmargument are set to the values used to produce the sequence; otherwise either an error is reported or unspecified values are assigned.228

If the end iterator is reached during parsing by any of theget()member functions, the member setsios_base​::​eofbitin err.

28.3.4.6.2.2 Members [locale.time.get.members]

dateorder date_order() const;

Returns: do_date_order().

iter_type get_time(iter_type s, iter_type end, ios_base& str, ios_base::iostate& err, tm* t) const;

Returns: do_get_time(s, end, str, err, t).

iter_type get_date(iter_type s, iter_type end, ios_base& str, ios_base::iostate& err, tm* t) const;

Returns: do_get_date(s, end, str, err, t).

iter_type get_weekday(iter_type s, iter_type end, ios_base& str, ios_base::iostate& err, tm* t) const; iter_type get_monthname(iter_type s, iter_type end, ios_base& str, ios_base::iostate& err, tm* t) const;

Returns: do_get_weekday(s, end, str, err, t)ordo_get_monthname(s, end, str, err, t).

iter_type get_year(iter_type s, iter_type end, ios_base& str, ios_base::iostate& err, tm* t) const;

Returns: do_get_year(s, end, str, err, t).

iter_type get(iter_type s, iter_type end, ios_base& f, ios_base::iostate& err, tm* t, char format, char modifier = 0) const;

Returns: do_get(s, end, f, err, t, format, modifier).

iter_type get(iter_type s, iter_type end, ios_base& f, ios_base::iostate& err, tm* t, const char_type* fmt, const char_type* fmtend) const;

Preconditions: [fmt, fmtend) is a valid range.

Effects: The function starts by evaluating err = ios_base​::​goodbit.

It then enters a loop, reading zero or more characters from s at each iteration.

Unless otherwise specified below, the loop terminates when the first of the following conditions holds:

• The expression fmt == fmtend evaluates to true.
• The expression err == ios_base​::​goodbit evaluates to false.
• The expression s == end evaluates to true, in which case the function evaluates err = ios_base​::​eofbit | ios_base​::​failbit.
• The next element of fmt is equal to '%', optionally followed by a modifier character, followed by a conversion specifier character, format, together forming a conversion specification valid for the POSIX function strptime.
  If the number of elements in the range [fmt, fmtend) is not sufficient to unambiguously determine whether the conversion specification is complete and valid, the function evaluates err = ios_base​::​failbit.
  Otherwise, the function evaluates s = do_get(s, end, f, err, t, format, modifier), where the value of modifier is '\0'when the optional modifier is absent from the conversion specification.
  If err == ios_base​::​goodbit holds after the evaluation of the expression, the function increments fmtto point just past the end of the conversion specification and continues looping.
• The expression isspace(*fmt, f.getloc()) evaluates to true, in which case the function first increments fmt untilfmt == fmtend || !isspace(*fmt, f.getloc()) evaluates to true, then advances suntil s == end || !isspace(*s, f.getloc()) is true, and finally resumes looping.
• The next character read from smatches the element pointed to by fmt in a case-insensitive comparison, in which case the function evaluates ++fmt, ++s and continues looping.
  Otherwise, the function evaluates err = ios_base​::​failbit.

[Note 1:

The function uses the ctype<charT> facet installed in f's locale to determine valid whitespace characters.

It is unspecified by what means the function performs case-insensitive comparison or whether multi-character sequences are considered while doing so.

— _end note_]

28.3.4.6.2.3 Virtual functions [locale.time.get.virtuals]

dateorder do_date_order() const;

Returns: An enumeration value indicating the preferred order of components for those date formats that are composed of day, month, and year.229

Returns no_order if the date format specified by 'x'contains other variable components (e.g., Julian day, week number, week day).

iter_type do_get_time(iter_type s, iter_type end, ios_base& str, ios_base::iostate& err, tm* t) const;

Effects: Reads characters starting at suntil it has extracted those tm members, and remaining format characters, used by time_put<>​::​putto produce the format specified by "%H:%M:%S", or until it encounters an error or end of sequence.

Returns: An iterator pointing immediately beyond the last character recognized as possibly part of a valid time.

iter_type do_get_date(iter_type s, iter_type end, ios_base& str, ios_base::iostate& err, tm* t) const;

Effects: Reads characters starting at suntil it has extracted those tm members and remaining format characters used by time_put<>​::​putto produce one of the following formats, or until it encounters an error.

The format depends on the value returned by date_order()as shown in Table 100.

An implementation may also accept additionalimplementation-defined formats.

Returns: An iterator pointing immediately beyond the last character recognized as possibly part of a valid date.

iter_type do_get_weekday(iter_type s, iter_type end, ios_base& str, ios_base::iostate& err, tm* t) const; iter_type do_get_monthname(iter_type s, iter_type end, ios_base& str, ios_base::iostate& err, tm* t) const;

Effects: Reads characters starting at suntil it has extracted the (perhaps abbreviated) name of a weekday or month.

If it finds an abbreviation that is followed by characters that can match a full name, it continues reading until it matches the full name or fails.

It sets the appropriate tm member accordingly.

Returns: An iterator pointing immediately beyond the last character recognized as part of a valid name.

iter_type do_get_year(iter_type s, iter_type end, ios_base& str, ios_base::iostate& err, tm* t) const;

Effects: Reads characters starting at suntil it has extracted an unambiguous year identifier.

It isimplementation-defined whether two-digit year numbers are accepted, and (if so) what century they are assumed to lie in.

Sets the t->tm_year member accordingly.

Returns: An iterator pointing immediately beyond the last character recognized as part of a valid year identifier.

iter_type do_get(iter_type s, iter_type end, ios_base& f, ios_base::iostate& err, tm* t, char format, char modifier) const;

Preconditions: t points to an object.

Effects: The function starts by evaluating err = ios_base​::​goodbit.

It then reads characters starting at s until it encounters an error, or until it has extracted and assigned those tm members, and any remaining format characters, corresponding to a conversion specification appropriate for the POSIX function strptime, formed by concatenating '%', the modifier character, when non-NUL, and the format character.

When the concatenation fails to yield a complete valid directive the function leaves the object pointed to by t unchanged and evaluates err |= ios_base​::​failbit.

When s == end evaluates to true after reading a character the function evaluates err |= ios_base​::​eofbit.

For complex conversion specifications such as %c, %x, or %X, or conversion specifications that involve the optional modifiers E or O, when the function is unable to unambiguously determine some or all tm members from the input sequence [s, end), it evaluates err |= ios_base​::​eofbit.

In such cases the values of those tm members are unspecified and may be outside their valid range.

Returns: An iterator pointing immediately beyond the last character recognized as possibly part of a valid input sequence for the given format and modifier.

Remarks: It is unspecified whether multiple calls to do_get()with the address of the same tm object will update the current contents of the object or simply overwrite its members.

Portable programs should zero out the object before invoking the function.