wyreply.3wy

一个不错

.\"
.\" Edited by I.J.Wang, 2004
.\"
.TH WyReply 3wy "libwy v0.31"
.SH NAME
WyReply \- class for identifying performed function
.SH SYNOPSIS
.B #include <wyret.h>
.PP
WyReply is a discardable pointer class for function to reply to identify
performed function.

All named errno's are mapped to predefined const WyReply objects.
Prefixing an errno name with "\fBWym_\fP" obtains the respective WyReply object.
For example: Wym_EINVAL, Wym_EPERM,... map to EINVAL, EPERM,...

Other predefined const WyReply objects are:
   Ok       ..... "Success"               (errno=0)
   Wym_...  .....  ...                    (up to 124 except 41,58)
   Wym_E41  ....  "Unknown error 41"      (errno=41)
   Wym_E58  ....  "Unknown error 58"      (errno=58)
   Wym_E125 ..... "Operation canceled"    (errno=125)
   Wym_E126 ..... "Unknown error 126"     (errno=126)
   Wym_E127 ..... "Unknown error 127"     (errno=127)

   Wym_ETHRDCAN . "Thread canceled"       (libwy defined)
   Wym_EDIVZERO . "Divisor is zero"       (libwy defined)
   Wym_EMATHNEG . "Math negation failed"  (libwy defined)
   Wym_EBADTYPE.. "Bad argument type"     (libwy defined)
.PP
Example for user defined WyReply:

  class AppRepInfo : public Wy_RepInfo 
    { /*...*/ };                      // see wy_repinfo.3wy(3)

  static AppRepInfo e1(45,"Bad input"); // define the information
                                        // object

  const WyReply BadInput(e1);         // BadInput points to e1
                                      // and is public for use

  Note: Be sure object is constructed before accessed.
.SH "PUBLIC MEMBERS"
 \fBWyReply\fP() throw()
 \fBWyReply\fP(const WyReply&) throw()
 explicit \fBWyReply\fP(int) throw()
 explicit \fBWyReply\fP(Wy_RepInfo&) throw()
 \fBWyReply\fP(WyReply&, Wy::ByMove_t) throw()
 bool \fBis_default\fP(void) const throw()
 Wy_RepInfo* \fBoperator->\fP() const throw()
 void \fBreset\fP(void) throw()
 void \fBreset\fP(const WyReply&) throw()
 int \fBreset\fP(int) throw()
 const WyReply& \fBoperator =\fP(const WyReply&) throw()
 const WyReply& \fBoperator =\fP(int) throw()
 bool \fBoperator ==\fP(const WyReply&) const throw()
 bool \fBoperator !=\fP(const WyReply&) const throw()
.SH "DESCRIPTION"
.\"--------------------------------------------
.PP
.BI "WyReply() throw()"
.PP
    Construct default object. 

      operator->()= pointer to the predefined Wy_RepInfo object
                    which is unique and inaccessible by name.
.\"--------------------------------------------
.PP
.BI "WyReply(const WyReply& " "em" ") throw()"
.PP
    Construct object by copy from \fIem\fP

      operator->() = \fIem\fP.operator->()
.\"--------------------------------------------
.PP
.BI "explicit WyReply(int " "en" ") throw()"
.PP
    Construct object to point to the predefined Wy_RepInfo object 
    which is for the errno \fIen\fP. If \fIen\fP is not in the range
    [0-Wy::_max_errno], default object is constructed.

      operator->() = pointer to the predefined Wy_RepInfo object
                     for errno \fIen\fP
.\"--------------------------------------------
.PP
.BI "explicit WyReply(Wy_RepInfo& " "ei" ") throw()"
.PP
    Construct object to point to the object \fIei\fP

      operator->() = &\fIei\fP
.\"--------------------------------------------
.PP
.BI "WyReply(WyReply& " "src" ", Wy::ByMove_t) throw()"
.PP
    Make the object \fIsrc\fP accessible at \fIthis\fP pointed address.

    See Wy_Array(Wy_Array&, Wy::ByMove_t) in wy_array(3wy)
    for definition of the move constructor.
.\"--------------------------------------------
.PP
.BI "bool is_default(void) const throw()"
.PP
    Is *this equivalent to the default object
.PP
    [\fBRet\fP] true= object is equivalent to WyReply()
         false= otherwise
.\"--------------------------------------------
.PP
.BI "Wy_RepInfo* operator->() const throw()"
.PP
    Get the Wy_RepInfo object pointer

    Note: Equivalence relation does not include equivalence
          of the object from dereferencing operator->().
.PP
    [\fBRet\fP] Wy_RepInfo object pointer of *this
.\"--------------------------------------------
.PP
.BI "void reset(void) throw()"
.PP
    Reconstruct *this to the state as WyReply()
.\"--------------------------------------------
.PP
.BI "void reset(const WyReply& " "em" ") throw()"
.PP
    Reconstruct *this to the state as WyReply(\fIem\fP)
.\"--------------------------------------------
.PP
.BI "int reset(int " "en" ") throw()"
.PP
    Reconstruct *this to the state as WyReply(\fIen\fP)
.PP
    [\fBRet\fP] The errno *this is mapped, or -1 and set *this 
          default if \fIen\fP is not in the range [0-Wy::_max_errno]
.\"--------------------------------------------
.PP
.BI "const WyReply& operator =(const WyReply& " "em" ") throw()"
.PP
    Assign *this to the state as WyReply(\fIem\fP)
.PP 
    [\fBRet\fP] Const reference of *this
.\"--------------------------------------------
.PP
.BI "const WyReply& operator =(int " "en" ") throw()"
.PP
    Assign *this to the state as WyReply(\fIen\fP)
.PP 
    [\fBRet\fP] Const reference of *this
.\"--------------------------------------------
.PP
.BI "bool operator ==(const WyReply& " "rhs" ") const throw()"
.PP
    Test equivalence of *this with \fIrhs\fP

    this->operator==(\fIrhs\fP) yields true iff
    this->operator->()==\fIrhs\fP.operator->()
.PP 
    [\fBRet\fP] true= *this is equivalent to \fIrhs\fP
         false= otherwise
.\"--------------------------------------------
.PP
.BI "bool operator !=(const WyReply& " "rhs" ") const throw()"
.PP
    Test equivalence of *this with \fIrhs\fP

    Note: Equivalence relation does not include equivalence
          of the object from dereferencing operator->().
.PP 
    [\fBRet\fP] true= *this is not equivalent to \fIrhs\fP
         false= otherwise
.\"--------------------------------------------
.SH "SEE ALSO"
.BR wy_repinfo
.BR wyret
.BR wy
.BR wy_thread
.BR wychrfile
.BR wy_array
.SH NOTE
Project is in development, http://sourceforge.net/projects/libwx