31 Input/output library [input.output]

31.7 Formatting and manipulators [iostream.format]

31.7.5 Input streams [input.streams]

31.7.5.4 Unformatted input functions [istream.unformatted]

1
#
Each unformatted input function begins execution by constructing an object of type ios_base​::​iostate, termed the local error state, and initializing it to ios_base​::​goodbit.
It then creates an object of class sentry with the default argument noskipws (second) argument true.
If the sentry object returns true, when converted to a value of type bool, the function endeavors to obtain the requested input.
Otherwise, if the sentry constructor exits by throwing an exception or if the sentry object produces false, when converted to a value of type bool, the function returns without attempting to obtain any input.
In either case the number of extracted characters is set to 0; unformatted input functions taking a character array of nonzero size as an argument shall also store a null character (using charT()) in the first location of the array.
If rdbuf()->sbumpc() or rdbuf()->sgetc() returns traits​::​eof(), then ios_base​::​eofbit is set in the local error state and the input function stops trying to obtain the requested input.
If an exception is thrown during input then ios_base​::​badbit is set in the local error state, *this's error state is set to the local error state, and the exception is rethrown if (exceptions() & badbit) != 0.
If no exception has been thrown it stores the number of characters extracted in a member object.
After extraction is done, the input function calls setstate, which sets *this's error state to the local error state, and may throw an exception.
In any event the sentry object is destroyed before leaving the unformatted input function.
🔗
streamsize gcount() const;
2
#
Effects: None.
This member function does not behave as an unformatted input function (as described above).
3
#
Returns: The number of characters extracted by the last unformatted input member function called for the object.
If the number cannot be represented, returns numeric_limits<streamsize>​::​max().
🔗
int_type get();
4
#
Effects: Behaves as an unformatted input function (as described above).
After constructing a sentry object, extracts a character c, if one is available.
Otherwise, ios_base​::​failbit is set in the input function's local error state before setstate is called.
5
#
Returns: c if available, otherwise traits​::​eof().
🔗
basic_istream& get(char_type& c);
6
#
Effects: Behaves as an unformatted input function (as described above).
After constructing a sentry object, extracts a character, if one is available, and assigns it to c.285
Otherwise, ios_base​::​failbit is set in the input function's local error state before setstate is called.
7
#
Returns: *this.
🔗
basic_istream& get(char_type* s, streamsize n, char_type delim);
8
#
Effects: Behaves as an unformatted input function (as described above).
After constructing a sentry object, extracts characters and stores them into successive locations of an array whose first element is designated by s.286
Characters are extracted and stored until any of the following occurs:
  • (8.1)
    n is less than one or n - 1 characters are stored;
  • (8.2)
    end-of-file occurs on the input sequence;
  • (8.3)
    traits​::​eq(c, delim) for the next available input character c (in which case c is not extracted).
9
#
If the function stores no characters, ios_base​::​failbit is set in the input function's local error state before setstate is called.
In any case, if n is greater than zero it then stores a null character into the next successive location of the array.
10
#
Returns: *this.
🔗
basic_istream& get(char_type* s, streamsize n);
11
#
Effects: Calls get(s, n, widen('\n')).
12
#
Returns: Value returned by the call.
🔗
basic_istream& get(basic_streambuf<char_type, traits>& sb, char_type delim);
13
#
Effects: Behaves as an unformatted input function (as described above).
After constructing a sentry object, extracts characters and inserts them in the output sequence controlled by sb.
Characters are extracted and inserted until any of the following occurs:
  • (13.1)
    end-of-file occurs on the input sequence;
  • (13.2)
    inserting in the output sequence fails (in which case the character to be inserted is not extracted);
  • (13.3)
    traits​::​eq(c, delim) for the next available input character c (in which case c is not extracted);
  • (13.4)
    an exception occurs (in which case, the exception is caught but not rethrown).
14
#
If the function inserts no characters, ios_base​::​failbit is set in the input function's local error state before setstate is called.
15
#
Returns: *this.
🔗
basic_istream& get(basic_streambuf<char_type, traits>& sb);
16
#
Effects: Calls get(sb, widen('\n')).
17
#
Returns: Value returned by the call.
🔗
basic_istream& getline(char_type* s, streamsize n, char_type delim);
18
#
Effects: Behaves as an unformatted input function (as described above).
After constructing a sentry object, extracts characters and stores them into successive locations of an array whose first element is designated by s.287
Characters are extracted and stored until one of the following occurs:
1.end-of-file occurs on the input sequence;
2.traits​::​eq(c, delim) for the next available input character c (in which case the input character is extracted but not stored);288
3.n is less than one or n - 1 characters are stored (in which case the function calls setstate(​failbit)).
19
#
These conditions are tested in the order shown.289
20
#
If the function extracts no characters, ios_base​::​failbit is set in the input function's local error state before setstate is called.290
21
#
In any case, if n is greater than zero, it then stores a null character (using charT()) into the next successive location of the array.
22
#
Returns: *this.
23
#
[Example 1: #include <iostream> int main() { using namespace std; const int line_buffer_size = 100; char buffer[line_buffer_size]; int line_number = 0; while (cin.getline(buffer, line_buffer_size, '\n') || cin.gcount()) { int count = cin.gcount(); if (cin.eof()) cout << "Partial final line"; // cin.fail() is false else if (cin.fail()) { cout << "Partial long line"; cin.clear(cin.rdstate() & ~ios_base::failbit); } else { count--; // Don't include newline in count cout << "Line " << ++line_number; } cout << " (" << count << " chars): " << buffer << endl; } } — end example]
🔗
basic_istream& getline(char_type* s, streamsize n);
24
#
Returns: getline(s, n, widen('\n'))
🔗
basic_istream& ignore(streamsize n = 1, int_type delim = traits::eof());
25
#
Effects: Behaves as an unformatted input function (as described above).
After constructing a sentry object, extracts characters and discards them.
Characters are extracted until any of the following occurs:
  • (25.1)
    n != numeric_limits<streamsize>​::​max() ([numeric.limits]) and n characters have been extracted so far
  • (25.2)
    end-of-file occurs on the input sequence (in which case the function calls setstate(eofbit), which may throw ios_base​::​failure ([iostate.flags]));
  • (25.3)
    traits​::​eq_int_type(traits​::​to_int_type(c), delim) for the next available input character c (in which case c is extracted).
[Note 1: 
The last condition will never occur if traits​::​eq_int_type(delim, traits​::​eof()).
— end note]
26
#
Returns: *this.
🔗
int_type peek();
27
#
Effects: Behaves as an unformatted input function (as described above).
After constructing a sentry object, reads but does not extract the current input character.
28
#
Returns: traits​::​eof() if good() is false.
Otherwise, returns rdbuf()->sgetc().
🔗
basic_istream& read(char_type* s, streamsize n);
29
#
Effects: Behaves as an unformatted input function (as described above).
After constructing a sentry object, if !good() calls setstate(failbit) which may throw an exception, and return.
Otherwise extracts characters and stores them into successive locations of an array whose first element is designated by s.291
Characters are extracted and stored until either of the following occurs:
  • (29.1)
    n characters are stored;
  • (29.2)
    end-of-file occurs on the input sequence (in which case the function calls setstate(failbit | eofbit), which may throw ios_base​::​failure ([iostate.flags])).
30
#
Returns: *this.
🔗
streamsize readsome(char_type* s, streamsize n);
31
#
Effects: Behaves as an unformatted input function (as described above).
After constructing a sentry object, if !good() calls setstate(failbit) which may throw an exception, and return.
Otherwise extracts characters and stores them into successive locations of an array whose first element is designated by s.
If rdbuf()->in_avail() == -1, calls setstate(eofbit) (which may throw ios_base​::​failure ([iostate.flags])), and extracts no characters;
  • (31.1)
    If rdbuf()->in_avail() == 0, extracts no characters
  • (31.2)
    If rdbuf()->in_avail() > 0, extracts min(rdbuf()->in_avail(), n)).
32
#
Returns: The number of characters extracted.
🔗
basic_istream& putback(char_type c);
33
#
Effects: Behaves as an unformatted input function (as described above), except that the function first clears eofbit.
After constructing a sentry object, if !good() calls setstate(failbit) which may throw an exception, and return.
If rdbuf() is not null, calls rdbuf()->sputbackc(c).
If rdbuf() is null, or if sputbackc returns traits​::​eof(), calls setstate(badbit) (which may throw ios_base​::​failure ([iostate.flags])).
[Note 2: 
This function extracts no characters, so the value returned by the next call to gcount() is 0.
— end note]
34
#
Returns: *this.
🔗
basic_istream& unget();
35
#
Effects: Behaves as an unformatted input function (as described above), except that the function first clears eofbit.
After constructing a sentry object, if !good() calls setstate(failbit) which may throw an exception, and return.
If rdbuf() is not null, calls rdbuf()->sungetc().
If rdbuf() is null, or if sungetc returns traits​::​eof(), calls setstate(badbit) (which may throw ios_base​::​failure ([iostate.flags])).
[Note 3: 
This function extracts no characters, so the value returned by the next call to gcount() is 0.
— end note]
36
#
Returns: *this.
🔗
int sync();
37
#
Effects: Behaves as an unformatted input function (as described above), except that it does not count the number of characters extracted and does not affect the value returned by subsequent calls to gcount().
After constructing a sentry object, if rdbuf() is a null pointer, returns -1.
Otherwise, calls rdbuf()->pubsync() and, if that function returns -1 calls setstate(badbit) (which may throw ios_base​::​failure ([iostate.flags]), and returns -1.
Otherwise, returns zero.
🔗
pos_type tellg();
38
#
Effects: Behaves as an unformatted input function (as described above), except that it does not count the number of characters extracted and does not affect the value returned by subsequent calls to gcount().
39
#
Returns: After constructing a sentry object, if fail() != false, returns pos_type(-1) to indicate failure.
Otherwise, returns rdbuf()->pubseekoff(0, cur, in).
🔗
basic_istream& seekg(pos_type pos);
40
#
Effects: Behaves as an unformatted input function (as described above), except that the function first clears eofbit, it does not count the number of characters extracted, and it does not affect the value returned by subsequent calls to gcount().
After constructing a sentry object, if fail() != true, executes rdbuf()->pubseekpos(pos, ios_base​::​in).
In case of failure, the function calls setstate(failbit) (which may throw ios_base​::​failure).
41
#
Returns: *this.
🔗
basic_istream& seekg(off_type off, ios_base::seekdir dir);
42
#
Effects: Behaves as an unformatted input function (as described above), except that the function first clears eofbit, does not count the number of characters extracted, and does not affect the value returned by subsequent calls to gcount().
After constructing a sentry object, if fail() != true, executes rdbuf()->pubseekoff(off, dir, ios_base​::​in).
In case of failure, the function calls setstate(​failbit) (which may throw ios_base​::​failure).
43
#
Returns: *this.
285)285)
Note that this function is not overloaded on types signed char and unsigned char.
286)286)
Note that this function is not overloaded on types signed char and unsigned char.
287)287)
Note that this function is not overloaded on types signed char and unsigned char.
288)288)
Since the final input character is “extracted”, it is counted in the gcount(), even though it is not stored.
289)289)
This allows an input line which exactly fills the buffer, without setting failbit.
This is different behavior than the historical AT&T implementation.
290)290)
This implies an empty input line will not cause failbit to be set.
291)291)
Note that this function is not overloaded on types signed char and unsigned char.