Dokumentacja klasy common::WCharReader
[Moduł Stream]

Nakładka przyspieszająca odczytująca ze strumienia pojedyncze znaki Unicode. Więcej...

#include <Stream.hpp>

Lista wszystkich składowych.

Metody publiczne
	WCharReader (Stream *a_Stream)
bool	End ()
	Czy jesteśmy na końcu danych?
bool	ReadChar (wchar_t *Out)
	Jeśli można odczytać następny znak, wczytuje go i zwraca true.
wchar_t	MustReadChar ()
	Jeśli można odczytać następny znak, wczytuje go.
bool	PeekChar (wchar_t *Out)
	Jeśli można odczytać następny znak, podgląda go zwracając przez Out i zwraca true. Nie przesuwa "kursora".
wchar_t	MustPeekChar ()
	Jeśli można odczytać następny znak, podgląda go zwracając. Nie przesuwa "kursora".
size_t	ReadString (wstring *Out, size_t MaxLength)
	Wczytuje co najwyżej MaxLength znaków do podanego stringa.
void	MustReadString (wstring *Out, size_t Length)
	Wczytuje Length znaków do podanego stringa.
size_t	ReadString (wchar_t *Out, size_t MaxLength)
	Wczytuje co najwyżej MaxLength znaków pod podany wskaźnik.
void	MustReadString (wchar_t *Out, size_t Length)
	Wczytuje Length znaków pod podany wskaźnik.
bool	SkipChar ()
	Jeśli jest następny znak do odczytania, pomija go i zwraca true.
void	MustSkipChar ()
	Jeśli jest następny znak do odczytania, pomija go.
size_t	Skip (size_t MaxLength)
	Pomija co najwyżej MaxLength znaków.
void	MustSkip (size_t Length)
	Pomija Length znaków.
bool	ReadLine (wstring *Out)
	Wczytuje linijkę tekstu i jeśli się udało, zwraca true.
void	MustReadLine (wstring *Out)
	Wczytuje linijkę tekstu.

---

Opis szczegółowy

Nakładka przyspieszająca odczytująca ze strumienia pojedyncze znaki Unicode.

Uwaga! Wersja Unicode nie posiada odczytywania surowych danych binarnych.

---

Dokumentacja konstruktora i destruktora

common::WCharReader::WCharReader

(

Stream *

a_Stream

)

[inline]

---

Dokumentacja funkcji składowych

bool common::WCharReader::End

(

)

[inline]

Czy jesteśmy na końcu danych?

bool common::WCharReader::ReadChar

(

wchar_t *

Out

)

[inline]

Jeśli można odczytać następny znak, wczytuje go i zwraca true.

Jeśli nie, nie zmienia Out i zwraca false. Oznacza to koniec strumienia.

wchar_t common::WCharReader::MustReadChar

(

)

[inline]

Jeśli można odczytać następny znak, wczytuje go.

Jeśli nie, rzuca wyjątek.

bool common::WCharReader::PeekChar

(

wchar_t *

Out

)

[inline]

Jeśli można odczytać następny znak, podgląda go zwracając przez Out i zwraca true. Nie przesuwa "kursora".

Jeśli nie, nie zmienia Out i zwraca false. Oznacza to koniec strumienia.

wchar_t common::WCharReader::MustPeekChar

(

)

[inline]

Jeśli można odczytać następny znak, podgląda go zwracając. Nie przesuwa "kursora".

Jeśli nie, rzuca wyjątek.

size_t common::WCharReader::ReadString	(	wstring *	Out,
		size_t	MaxLength
	)

Wczytuje co najwyżej MaxLength znaków do podanego stringa.

StringStream jest czyszczony - nie musi być pusty ani zaalokowany. (???)

Zwraca:

Zwraca liczbę odczytanych znaków. Mniej niż żądano oznacza koniec strumienia.

void common::WCharReader::MustReadString	(	wstring *	Out,
		size_t	Length
	)

Wczytuje Length znaków do podanego stringa.

StringStream jest czyszczony - nie musi być pusty ani zaalokowany. (???) Jeśli nie uda się odczytać wszystkich Length znaków, rzuca wyjątek.

size_t common::WCharReader::ReadString	(	wchar_t *	Out,
		size_t	MaxLength
	)

Wczytuje co najwyżej MaxLength znaków pod podany wskaźnik.

Parametry:

[out]

Out

musi być tablicą zaalokowaną do długości co najmniej MaxLength.

Zwraca:

Zwraca liczbę odczytanych znaków. Mniej niż żądano oznacza koniec strumienia.

void common::WCharReader::MustReadString	(	wchar_t *	Out,
		size_t	Length
	)

Wczytuje Length znaków pod podany wskaźnik.

Jeśli nie uda się odczytać wszystkich Length znaków, rzuca wyjątek.

Parametry:

[out]

Out

musi być tablicą zaalokowaną do długości co najmniej Length.

bool common::WCharReader::SkipChar

(

)

[inline]

Jeśli jest następny znak do odczytania, pomija go i zwraca true.

Jeśli nie, zwraca false. Oznacza to koniec strumienia.

void common::WCharReader::MustSkipChar

(

)

[inline]

Jeśli jest następny znak do odczytania, pomija go.

Jeśli nie, rzuca wyjątek.

size_t common::WCharReader::Skip

(

size_t

MaxLength

)

Pomija co najwyżej MaxLength znaków.

Zwraca:

Zwraca liczbę pominiętych znaków. Mniej niż żądano oznacza koniec strumienia.

void common::WCharReader::MustSkip

(

size_t

Length

)

Pomija Length znaków.

Jeśli nie uda się pominąć wszystkich Length znaków, rzuca wyjątek.

bool common::WCharReader::ReadLine

(

wstring *

Out

)

Wczytuje linijkę tekstu i jeśli się udało, zwraca true.

Jeśli nie udało się wczytać ani jednego znaku, bo to już koniec strumienia, zwraca false. Czyta znaki do napotkania końca strumienia lub końca wiersza, którym są "\r", "\n" i "\r\n". Koniec wiersza przeskakuje, ale nie dołącza go do Out.

void common::WCharReader::MustReadLine

(

wstring *

Out

)

Wczytuje linijkę tekstu.

Jeśli nie udało się wczytać ani jednego znaku, bo to już koniec strumienia, rzuca wyjątek. Czyta znaki do napotkania końca strumienia lub końca wiersza, którym są "\r", "\n" i "\r\n". Koniec wiersza przeskakuje, ale nie dołącza go do Out.

---

Dokumentacja dla tej klasy została wygenerowana z pliku:

• Stream.hpp