BasicChar< T > Class Template Reference

A class representing a character. More...

#include <BasicChar.h++>

List of all members.

Public Member Functions
	BasicChar (T c=BasicCharTraits< T >::nul())
	Constructor.
	BasicChar (const BasicChar &other)
	Copy constructor.
virtual	~BasicChar () throw ()
	Destructor.
bool	isAlpha () const throw ()
	Test if the character is alphabetic.
bool	isAlphaNumeric () const throw ()
	Test if the character is alphanumeric.
bool	isWhitespace () const throw ()
	Test if the character is whitespace.
bool	isPrintable () const throw ()
	Test if the character is printable.
bool	isGraphical () const throw ()
	Test if the character is graphical.
bool	isNul () const throw ()
	Test if the character is NUL.
bool	isControl () const throw ()
	Test if the character is a control character.
bool	isDigit () const throw ()
	Test if the character is a decimal digit.
bool	isHexDigit () const throw ()
	Test if the character is a hexadecimal digit.
bool	isLowerCase () const throw ()
	Test if the character is lowercase.
bool	isUpperCase () const throw ()
	Test if the character is uppercase.
bool	isASCII () const throw ()
	Test if the character is low (7-bit) ASCII.
bool	isHighASCII () const throw ()
	Test if the character is high (8-bit) ASCII.
BasicChar< T >	upperCase () const throw ()
	Return the uppercase form of this character.
BasicChar< T >	lowerCase () const throw ()
	Return the lowercase form of this character.
BasicChar< T > &	toUpperCase () throw ()
	Convert the character to uppercase.
BasicChar< T > &	toLowerCase () throw ()
	Convert the character to lowercase.
BasicChar< T > &	operator++ () throw ()
	Increment operator (prefix).
BasicChar< T >	operator++ (int) throw ()
	Increment operator (postfix).
BasicChar< T > &	operator-- () throw ()
	Decrement operator (prefix).
BasicChar< T >	operator-- (int) throw ()
	Decrement operator (postfix).
BasicChar< T > &	operator= (T other) throw ()
	Assignment operator.
BasicChar< T > &	operator= (int other) throw ()
	Assignment operator.
bool	operator== (T other) const throw ()
bool	operator!= (T other) const throw ()
bool	operator< (T other) const throw ()
bool	operator> (T other) const throw ()
bool	operator<= (T other) const throw ()
bool	operator>= (T other) const throw ()
bool	operator== (const BasicChar< T > &other) const throw ()
bool	operator!= (const BasicChar< T > &other) const throw ()
bool	operator< (const BasicChar< T > &other) const throw ()
bool	operator> (const BasicChar< T > &other) const throw ()
bool	operator<= (const BasicChar< T > &other) const throw ()
bool	operator>= (const BasicChar< T > &other) const throw ()
bool	operator! () const throw ()
	Not operator.
	operator T () const throw ()
	Cast operator.
T	toCharType () const throw ()
	Return the char for this character.
template<>
const BasicChar< char >	EndOfFile
template<>
const BasicChar< char >	Bell
template<>
const BasicChar< char >	Backspace
template<>
const BasicChar< char >	Tab
template<>
const BasicChar< char >	NewLine
template<>
const BasicChar< char >	VTab
template<>
const BasicChar< char >	FormFeed
template<>
const BasicChar< char >	Return
template<>
const BasicChar< char >	Escape
template<>
const BasicChar< char >	Space
template<>
const BasicChar< char >	Delete
template<>
const BasicChar< wchar_t >	EndOfFile
template<>
const BasicChar< wchar_t >	Bell
template<>
const BasicChar< wchar_t >	Backspace
template<>
const BasicChar< wchar_t >	Tab
template<>
const BasicChar< wchar_t >	NewLine
template<>
const BasicChar< wchar_t >	VTab
template<>
const BasicChar< wchar_t >	FormFeed
template<>
const BasicChar< wchar_t >	Return
template<>
const BasicChar< wchar_t >	Escape
template<>
const BasicChar< wchar_t >	Space
template<>
const BasicChar< wchar_t >	Delete
Static Public Attributes
static COMMONCPP_API const BasicChar< T >	EndOfFile
	The end of file (EOF) character.
static COMMONCPP_API const BasicChar< T >	Bell
	The bell character.
static COMMONCPP_API const BasicChar< T >	Backspace
	The backspace character.
static COMMONCPP_API const BasicChar< T >	Tab
	The tab character.
static COMMONCPP_API const BasicChar< T >	NewLine
	The newline character.
static COMMONCPP_API const BasicChar< T >	VTab
	The vertical tab character.
static COMMONCPP_API const BasicChar< T >	FormFeed
	The form feed character.
static COMMONCPP_API const BasicChar< T >	Return
	The carriage return character.
static COMMONCPP_API const BasicChar< T >	Escape
	The escape character.
static COMMONCPP_API const BasicChar< T >	Space
	The space character.
static COMMONCPP_API const BasicChar< T >	Delete
	The delete character.

---

Detailed Description

template<typename T>
class ccxx::BasicChar< T >

A class representing a character.

Author:

Mark Lindner

---

Constructor & Destructor Documentation

BasicChar

(

T

c = BasicCharTraits<T>::nul()

)

[inline]

Constructor.

BasicChar

(

const BasicChar< T > &

other

)

[inline]

Copy constructor.

virtual ~BasicChar

(

)

throw () [inline, virtual]

Destructor.

---

Member Function Documentation

const BasicChar< wchar_t > Backspace

(

)

[inline]

const BasicChar< char > Backspace

(

)

[inline]

const BasicChar< wchar_t > Bell

(

)

[inline]

const BasicChar< char > Bell

(

)

[inline]

const BasicChar< wchar_t > Delete

(

)

[inline]

const BasicChar< char > Delete

(

)

[inline]

const BasicChar< wchar_t > EndOfFile

(

)

[inline]

const BasicChar< char > EndOfFile

(

)

[inline]

const BasicChar< wchar_t > Escape

(

)

[inline]

const BasicChar< char > Escape

(

)

[inline]

const BasicChar< wchar_t > FormFeed

(

)

[inline]

const BasicChar< char > FormFeed

(

)

[inline]

bool isAlpha

(

)

const throw () [inline]

Test if the character is alphabetic.

bool isAlphaNumeric

(

)

const throw () [inline]

Test if the character is alphanumeric.

bool isASCII

(

)

const throw () [inline]

Test if the character is low (7-bit) ASCII.

bool isControl

(

)

const throw () [inline]

Test if the character is a control character.

bool isDigit

(

)

const throw () [inline]

Test if the character is a decimal digit.

bool isGraphical

(

)

const throw () [inline]

Test if the character is graphical.

bool isHexDigit

(

)

const throw () [inline]

Test if the character is a hexadecimal digit.

bool isHighASCII

(

)

const throw () [inline]

Test if the character is high (8-bit) ASCII.

bool isLowerCase

(

)

const throw () [inline]

Test if the character is lowercase.

bool isNul

(

)

const throw () [inline]

Test if the character is NUL.

bool isPrintable

(

)

const throw () [inline]

Test if the character is printable.

bool isUpperCase

(

)

const throw () [inline]

Test if the character is uppercase.

bool isWhitespace

(

)

const throw () [inline]

Test if the character is whitespace.

BasicChar<T> lowerCase

(

)

const throw () [inline]

Return the lowercase form of this character.

const BasicChar< wchar_t > NewLine

(

)

[inline]

const BasicChar< char > NewLine

(

)

[inline]

operator T

(

)

const throw () [inline]

Cast operator.

bool operator!

(

)

const throw () [inline]

Not operator.

Returns:

true if the character is NUL, false otherwise.

bool operator!=

(

const BasicChar< T > &

other

)

const throw () [inline]

bool operator!=

(

T

other

)

const throw () [inline]

BasicChar<T> operator++

(

int

)

throw () [inline]

Increment operator (postfix).

BasicChar<T>& operator++

(

)

throw () [inline]

Increment operator (prefix).

BasicChar<T> operator--

(

int

)

throw () [inline]

Decrement operator (postfix).

BasicChar<T>& operator--

(

)

throw () [inline]

Decrement operator (prefix).

bool operator<

(

const BasicChar< T > &

other

)

const throw () [inline]

bool operator<

(

T

other

)

const throw () [inline]

bool operator<=

(

const BasicChar< T > &

other

)

const throw () [inline]

bool operator<=

(

T

other

)

const throw () [inline]

BasicChar<T>& operator=

(

int

other

)

throw () [inline]

Assignment operator.

BasicChar<T>& operator=

(

T

other

)

throw () [inline]

Assignment operator.

bool operator==

(

const BasicChar< T > &

other

)

const throw () [inline]

bool operator==

(

T

other

)

const throw () [inline]

bool operator>

(

const BasicChar< T > &

other

)

const throw () [inline]

bool operator>

(

T

other

)

const throw () [inline]

bool operator>=

(

const BasicChar< T > &

other

)

const throw () [inline]

bool operator>=

(

T

other

)

const throw () [inline]

const BasicChar< wchar_t > Return

(

)

[inline]

const BasicChar< char > Return

(

)

[inline]

const BasicChar< wchar_t > Space

(

)

[inline]

const BasicChar< char > Space

(

)

[inline]

const BasicChar< wchar_t > Tab

(

)

[inline]

const BasicChar< char > Tab

(

)

[inline]

T toCharType

(

)

const throw () [inline]

Return the char for this character.

BasicChar<T>& toLowerCase

(

)

throw () [inline]

Convert the character to lowercase.

BasicChar<T>& toUpperCase

(

)

throw () [inline]

Convert the character to uppercase.

BasicChar<T> upperCase

(

)

const throw () [inline]

Return the uppercase form of this character.

const BasicChar< wchar_t > VTab

(

)

[inline]

const BasicChar< char > VTab

(

)

[inline]

---

Member Data Documentation

COMMONCPP_API const BasicChar<T> Backspace [static]

The backspace character.

COMMONCPP_API const BasicChar<T> Bell [static]

The bell character.

COMMONCPP_API const BasicChar<T> Delete [static]

The delete character.

COMMONCPP_API const BasicChar<T> EndOfFile [static]

The end of file (EOF) character.

COMMONCPP_API const BasicChar<T> Escape [static]

The escape character.

COMMONCPP_API const BasicChar<T> FormFeed [static]

The form feed character.

COMMONCPP_API const BasicChar<T> NewLine [static]

The newline character.

COMMONCPP_API const BasicChar<T> Return [static]

The carriage return character.

COMMONCPP_API const BasicChar<T> Space [static]

The space character.

COMMONCPP_API const BasicChar<T> Tab [static]

The tab character.

COMMONCPP_API const BasicChar<T> VTab [static]

The vertical tab character.

---

The documentation for this class was generated from the following file:

• BasicChar.h++