4.06.2013 - Version 0.3.4 - PIOBJECT() macro, ethernet improvement, documentation based on Doxygen

pichar.h

@@ -1,3 +1,6 @@
+/*! \file pichar.h
+ * \brief Unicode char
+*/
 /*
     PIP - Platform Independent Primitives
     Unicode char
@@ -21,24 +24,41 @@
 #define PICHAR_H
 
 #include "pibytearray.h"
-
-class PIChar
+/*! \brief Unicode char
+ * \details This class is wrapper around \c "uint".
+ * There are many contructors and information functions;
+ */
+class PIP_EXPORT PIChar
 {
 	friend class PIString;
 	friend PIByteArray & operator <<(PIByteArray & s, const PIChar & v);
 	friend PIByteArray & operator >>(PIByteArray & s, PIChar & v);
 public:
+	//! Contructs ascii symbol
 	PIChar(const char c) {ch = c; ch &= 0xFF;}
+
+	//! Contructs 2-bytes symbol
 	PIChar(const short c) {ch = c; ch &= 0xFFFF;}
-	PIChar(const int c = 0) {ch = c;}
+
+	//! Contructs 4-bytes symbol
+	PIChar(const int c) {ch = c;}
+
+	//! Contructs ascii symbol
 	PIChar(const uchar c) {ch = c; ch &= 0xFF;}
+
+	//! Contructs 2-bytes symbol
 	PIChar(const ushort c) {ch = c; ch &= 0xFFFF;}
-	PIChar(const uint c) {ch = c;}
+
+	//! Default constructor. Contructs 4-bytes symbol
+	PIChar(const uint c = 0) {ch = c;}
+
+	//! Contructs symbol from no more than 4 bytes of string
 	PIChar(const char * c) {ch = *reinterpret_cast<const int * >(c);}
 
 	//inline operator const int() {return static_cast<const int>(ch);}
 	//inline operator const char() {return toAscii();}
 
+	//! Copy operator
 	PIChar & operator =(const char v) {ch = v; return *this;}
 	/*inline PIChar & operator =(const short v) {ch = v; return *this;}
 	inline PIChar & operator =(const int v) {ch = v; return *this;}
@@ -46,6 +66,7 @@ public:
 	inline PIChar & operator =(const ushort v) {ch = v; return *this;}
 	inline PIChar & operator =(const uint v) {ch = v; return *this;}*/
 
+	//! Compare operator
 	bool operator ==(const PIChar & o) const {return strcmp(o.toCharPtr(), toCharPtr()) == 0;}
 	/*inline bool operator ==(const PIChar & o) const {if (o.isAscii() ^ isAscii()) return false;
 													if (isAscii()) return (o.toAscii() == toAscii());
@@ -57,6 +78,7 @@ public:
 	inline bool operator ==(const ushort o) const {return (PIChar(o) == *this);}
 	inline bool operator ==(const uint o) const {return (PIChar(o) == *this);}*/
 
+	//! Compare operator
 	bool operator !=(const PIChar & o) const {return !(o == *this);}
 	/*inline bool operator !=(const char o) const {return (PIChar(o) != *this);}
 	inline bool operator !=(const short o) const {return (PIChar(o) != *this);}
@@ -65,62 +87,134 @@ public:
 	inline bool operator !=(const ushort o) const {return (PIChar(o) != *this);}
 	inline bool operator !=(const uint o) const {return (PIChar(o) != *this);}*/
 
+	//! Compare operator
 	bool operator >(const PIChar & o) const {return strcmp(o.toCharPtr(), toCharPtr()) < 0;}
+
+	//! Compare operator
 	bool operator <(const PIChar & o) const {return strcmp(o.toCharPtr(), toCharPtr()) > 0;}
+
+	//! Compare operator
 	bool operator >=(const PIChar & o) const {return strcmp(o.toCharPtr(), toCharPtr()) <= 0;}
+
+	//! Compare operator
 	bool operator <=(const PIChar & o) const {return strcmp(o.toCharPtr(), toCharPtr()) >= 0;}
 
+	//! Return \b true if symbol is digit ('0' to '9')
 	bool isDigit() const {return isdigit(ch) != 0;}
+	
+	//! Return \b true if symbol is HEX digit ('0' to '9', 'a' to 'f', 'A' to 'F')
 	bool isHex() const {return isxdigit(ch) != 0;}
+	
+	//! Return \b true if symbol is drawable (without space)
 	bool isGraphical() const {return isgraph(ch) != 0;}
+	
+	//! Return \b true if symbol is control byte (< 32 or 127)
 	bool isControl() const {return iscntrl(ch) != 0;}
+	
+	//! Return \b true if symbol is in lower case
 	bool isLower() const {return islower(ch) != 0;}
+	
+	//! Return \b true if symbol is in upper case
 	bool isUpper() const {return isupper(ch) != 0;}
+	
+	//! Return \b true if symbol is printable (with space)
 	bool isPrint() const {return isprint(ch) != 0;}
+	
+	//! Return \b true if symbol is space or tab
 	bool isSpace() const {return isspace(ch) != 0;}
+	
+	//! Return \b true if symbol is alphabetical letter
 	bool isAlpha() const {return isalpha(ch) != 0;}
+	
+	//! Return \b true if symbol is ascii (< 128)
 	bool isAscii() const {return isascii(ch) != 0;}
 
-	int toInt() const {return static_cast<const int>(ch);}
-	const wchar_t * toWCharPtr() const {return &ch;}
+	int toInt() const {return int(ch);}
+	const wchar_t * toWCharPtr() const {return reinterpret_cast<const wchar_t * >(&ch);}
+	
+	//! Return as <tt>"char * "</tt> string
 	const char * toCharPtr() const {return reinterpret_cast<const char * >(&ch);}
-	wchar_t toWChar() const {return ch;}
+	
+	wchar_t toWChar() const {return wchar_t(ch);}
 	char toAscii() const {return ch % 256;}
 	int unicode16Code() const {wchar_t wc; if (mbtowc(&wc, toCharPtr(), 4) > 0) return wc; return 0;}
 //#ifdef WINDOWS
 //	inline PIChar toUpper() const __attribute__ ((optimize(0))) {return PIChar(toupper(ch));}
 //	inline PIChar toLower() const __attribute__ ((optimize(0))) {return PIChar(tolower(ch));}
 //#else
+	
+	//! Return symbol in upper case
 	PIChar toUpper() const {return PIChar(toupper(ch));}
+	
+	//! Return symbol in lower case
 	PIChar toLower() const {return PIChar(tolower(ch));}
 //#endif
 
 private:
-	wchar_t ch;
+	uint ch;
 
 };
 
+
+//! Output operator to \c std::ostream
 inline std::ostream & operator <<(std::ostream & s, const PIChar & v) {s << v.toCharPtr(); return s;}
 
+//! Output operator to \a PICout
+inline PICout operator <<(PICout s, const PIChar & v) {s.space(); s.setControl(0, true); s << v.toCharPtr(); s.restoreControl(); return s;}
+
+
+//! Write operator to \c PIByteArray
 inline PIByteArray & operator <<(PIByteArray & s, const PIChar & v) {s << uint(v.ch); return s;}
+
+//! Read operator from \c PIByteArray
 inline PIByteArray & operator >>(PIByteArray & s, PIChar & v) {uint i; s >> i; v.ch = wchar_t(i); return s;}
 
+
+//! Compare operator
 inline bool operator ==(const char v, const PIChar & c) {return (PIChar(v) == c);}
+
+//! Compare operator
 inline bool operator >(const char v, const PIChar & c) {return (PIChar(v) > c);}
+
+//! Compare operator
 inline bool operator <(const char v, const PIChar & c) {return (PIChar(v) < c);}
+
+//! Compare operator
 inline bool operator >=(const char v, const PIChar & c) {return (PIChar(v) >= c);}
+
+//! Compare operator
 inline bool operator <=(const char v, const PIChar & c) {return (PIChar(v) <= c);}
 
+
+//! Compare operator
 inline bool operator ==(const char * v, const PIChar & c) {return (PIChar(v) == c);}
+
+//! Compare operator
 inline bool operator >(const char * v, const PIChar & c) {return (PIChar(v) > c);}
+
+//! Compare operator
 inline bool operator <(const char * v, const PIChar & c) {return (PIChar(v) < c);}
+
+//! Compare operator
 inline bool operator >=(const char * v, const PIChar & c) {return (PIChar(v) >= c);}
+
+//! Compare operator
 inline bool operator <=(const char * v, const PIChar & c) {return (PIChar(v) <= c);}
 
+
+//! Compare operator
 inline bool operator ==(const int v, const PIChar & c) {return (PIChar(v) == c);}
+
+//! Compare operator
 inline bool operator >(const int v, const PIChar & c) {return (PIChar(v) > c);}
+
+//! Compare operator
 inline bool operator <(const int v, const PIChar & c) {return (PIChar(v) < c);}
+
+//! Compare operator
 inline bool operator >=(const int v, const PIChar & c) {return (PIChar(v) >= c);}
+
+//! Compare operator
 inline bool operator <=(const int v, const PIChar & c) {return (PIChar(v) <= c);}
 
 #endif // PICHAR_H