wycseg.3wy

一个不错

.PP
    Move the one-past-the-last pointer by adding offset \fIoff\fP to it
.PP
    [\fBThrow\fP] Reply
            Wym_EINVAL      -\fIoff\fP > this->size(), or the result
                            would not be representable
.PP
    [\fBRet\fP] this->end()
.\"--------------------------------------------
.PP
.BI "const char& operator [](size_t " "idx" ") const throw(Reply)"
.PP
    Get character reference at position \fIidx\fP of the target
    array
.PP
    [\fBThrow\fP] Reply
            Wym_EINVAL      \fIidx\fP>=this->size()
.PP
    [\fBRet\fP] Character reference at position \fIidx\fP
.\"--------------------------------------------
.PP
.BI "const WyCSeg cseg(size_t " "idx" ") const throw(Reply)"
.PP
    Get sub-array of *this pointed array from position \fIidx\fP
    till the end
.PP
    [\fBThrow\fP] Reply
            Wym_EINVAL      \fIidx\fP>this->size()
.PP
    [\fBRet\fP] WyCSeg pointing to sub-array of *this
.\"--------------------------------------------
.PP
.BI "const WyCSeg cseg(size_t " "idx" ", size_t " "num" ") const throw(Reply)"
.PP
    Get sub-array of *this pointed array from position \fIidx\fP
    ,at most \fInum\fP length
.PP
    [\fBThrow\fP] Reply
            Wym_EINVAL      \fIidx\fP>this->size()
.PP
    [\fBRet\fP] WyCSeg pointing to sub-array of *this
.\"--------------------------------------------
.PP
.BI "bool find(size_t* " "res" ", size_t " "idx" ", const WyCSeg " "cs" ") const throw()"
.PP
    Find the minimal position of occurrence of the sub-array
    pointed by \fIcs\fP in the range from \fIidx\fP to size()-1, reset *\fIres\fP
    with the position found if \fIres\fP is not NULL.
.PP
    [\fBRet\fP] true= found, *\fIres\fP contains the position found
         false= otherwise, *\fIres\fP intact.
.PP
    [\fBRefer\fP] ::memcmp(void*,void*,size_t)
.\"--------------------------------------------
.PP
.BI "bool findc(size_t* " "res" ", size_t " "idx" ", char " "ch" ") const throw()"
.PP
    Find the minimal position from \fIidx\fP to this->size()-1 for
    the character \fIch\fP, and reset *\fIres\fP with the position found if
    \fIres\fP is not NULL.
.PP
    [\fBRet\fP] true= found, *\fIres\fP contains the position found
         false= otherwise, *\fIres\fP intact.
.PP
    [\fBRefer\fP] ::memchr(void*,int,size_t)
.\"--------------------------------------------
.PP
.BI "bool findc(size_t* " "res" ", size_t " "idx" ", const WyCSeg& " "cs" ") const throw()"
.PP
    Find the minimal position from \fIidx\fP to this->size()-1 for
    the character which is also in those pointed by \fIcs\fP. If \fIres\fP
    is not NULL, *\fIres\fP is reset with the position of the character
    which is found in \fIcs\fP.
.PP
    [\fBRet\fP] true= found, *\fIres\fP contains the position found
         false= otherwise, *\fIres\fP intact.
.PP
    [\fBRefer\fP] ::memchr(void*,int,size_t)
.\"--------------------------------------------
.PP
.BI "bool findc_not(size_t* " "res" ", size_t " "idx" ", char " "ch" ") const throw()"
.PP
    Find the minimal position from \fIidx\fP to this->size()-1 for
    the character which is not \fIch\fP, reset *\fIres\fP with the position
    found if \fIres\fP is not NULL.
.PP
    [\fBRet\fP] true= found, *\fIres\fP contains the position found
         false= otherwise, *\fIres\fP intact.
.\"--------------------------------------------
.PP
.BI "bool findc_not(size_t* " "res" ", size_t " "idx" ", const WyCSeg& " "cs" ") const throw()"
.PP
    Find the minimal position from \fIidx\fP to this->size()-1 for
    the character which is not in those pointed by \fIcs\fP. If \fIres\fP
    is not NULL, *\fIres\fP is reset with the position of the character
    which is found not in \fIcs\fP.
.PP
    [\fBRet\fP] true= found, *\fIres\fP contains the position found
         false= otherwise, *\fIres\fP intact.
.PP
    [\fBRefer\fP] ::memchr(void*,int,size_t)
.\"--------------------------------------------
.PP
.BI "bool rfind(size_t* " "res" ", size_t " "idx" ", const WyCSeg& " "cs" ") const throw()"
.PP
    Find the maximum position of occurrence of the sub-array
    pointed by \fIcs\fP in the range from \fIidx\fP to 0, reset *\fIres\fP with 
    the position found if \fIres\fP is not NULL.
.PP
    [\fBRet\fP] true= found, *\fIres\fP contains the position found
         false= otherwise, *\fIres\fP intact.
.PP
    [\fBRefer\fP] ::memcmp(void*,void*,size_t)
.\"--------------------------------------------
.PP
.BI "bool rfindc(size_t* " "res" ", size_t " "idx" ", char " "ch" ") const throw()"
.PP
    Find the maximum position of occurrence \fIch\fP in the range
    from \fIidx\fP to 0, and reset *\fIres\fP with the position found 
    if \fIres\fP is not NULL.
.PP
    [\fBRet\fP] true= found, *\fIres\fP contains the position found
         false= otherwise, *\fIres\fP intact.
.PP
    [\fBRefer\fP] ::memrchr(void*,int,size_t)
.\"--------------------------------------------
.PP
.BI "bool rfindc(size_t* " "res" ", size_t " "idx" ", const WyCSeg& " "cs" ") const throw()"
.PP
    Find the maximal position from \fIidx\fP to 0 for the character
    which is also in those pointed by \fIcs\fP. If \fIres\fP is not NULL,
    *\fIres\fP is reset with the position of the character which is 
    found in \fIcs\fP.
.PP
    [\fBRet\fP] true= found, *\fIres\fP contains the position found
         false= otherwise, *\fIres\fP intact.
.PP
    [\fBRefer\fP] ::memchr(void*,int,size_t)
.\"--------------------------------------------
.PP
.BI "bool rfindc_not(size_t* " "res" ", size_t " "idx" ", char " "ch" ") const throw()"
.PP
    Find the maximum position from \fIidx\fP to 0 for of the character
    which is not \fIch\fP, reset *\fIres\fP with the position found if \fIres\fP
    is not NULL.
.PP
    [\fBRet\fP] true= found, *\fIres\fP contains the position found
         false= otherwise, *\fIres\fP intact.
.\"--------------------------------------------
.PP
.BI "bool rfindc_not(size_t* " "res" ", size_t " "idx" ", const WyCSeg& " "cs" ") const throw()"
.PP
    Find the maximal position from \fIidx\fP to 0 for the character
    which is not in those pointed by \fIcs\fP. If \fIres\fP is not NULL,
    *\fIres\fP is reset with the position of the character which is
    found not in \fIcs\fP.
.PP
    [\fBRet\fP] true= found, *\fIres\fP contains the position found
         false= otherwise, *\fIres\fP intact.
.PP
    [\fBRefer\fP] ::memchr(void*,int,size_t)
.\"--------------------------------------------
.PP
.BI "bool is_overlap(const WyCSeg& " "cs" ") const throw()"
.PP
    Test whether or not *this and \fIcs\fP pointed array overlap

    Two WyCSeg objects \fBa\fP and \fBb\fP is considered overlap iff there
    exists one character in both the range of \fBa\fP and \fBb\fP pointed
    array.
.PP
    [\fBRet\fP] true= *this and \fIcs\fP pointed array overlap
         false= otherwise
.\"--------------------------------------------
.PP
.BI "int _strcmp(const WyCSeg& " "cs" ") const throw()"
.PP
    Compare lexicographical order of *this and \fIcs\fP pointed
    sub-array(string).
.PP
    [\fBRet\fP]  0, this string is equal to \fIcs\fP
          >0, this string is greater than \fIcs\fP
          <0, this string is lesser than \fIcs\fP
.PP 
    [\fBRefer\fP] ::memcmp(void*,void*,size_t)
.\"--------------------------------------------
.PP
.BI "int _strcmp(const char* " "cstr" ") const"
.PP
    Compare lexicographical order of *this and \fIcstr\fP pointed
    zero-terminated sub-array(string).
.PP
    [\fBRet\fP]  0, this string is equal to \fIcstr\fP
          >0, this string is greater than \fIcstr\fP
          <0, this string is lesser than \fIcstr\fP
.PP 
    [\fBRefer\fP] ::memcmp(void*,void*,size_t)
.\"--------------------------------------------
.PP
.BI "bool operator ==(const WyCSeg& " "rhs" ") const throw()"
.PP
.BI "bool operator !=(const WyCSeg& " "rhs" ") const throw()"
.PP
    Test equivalence of *this with \fIrhs\fP

    For WyCSeg objects \fBa\fP,\fBb\fP, \fBa\fP==\fBb\fP yields true iff \fBa\fP.size()==\fBb\fP.size()
    and for all valid position i, \fBa\fP[i]==\fBb\fP[i] also yield true.

    Note: Addresses of pointed character arrays need not be equal,
          e.g. the value returned by begin() or end() is irrelevant.

    Note: Valid position of *this is from 0 to size()-1. If
          size()==0, the object is equivalent to a default object.
.PP
    [\fBRet\fP] true= relation holds
         false= otherwise
.PP 
    [\fBRefer\fP] ::memcmp(void*,void*,size_t)
.\"--------------------------------------------
.PP
.BI "bool operator ==(const char* " "cstr" ") const"
.PP
.BI "bool operator !=(const char* " "cstr" ") const"
.PP
    Test equivalence of *this with WyCSeg(\fIcstr\fP)

    Note: These are function overloads for efficiency
          See operator ==(const WyCSeg&). and
              operator !=(const WyCSeg&)
.PP
    [\fBThrow\fP] Reply
            Wym_EFAULT      \fIcstr\fP is NULL
.PP
    [\fBRet\fP] true= relation holds
         false= otherwise
.PP 
    [\fBRefer\fP] ::memcmp(void*,void*,size_t)
.\"--------------------------------------------
.SH "AUXILIARY FUNCTIONS"
.PP
.BI "bool operator ==(const char* " "cstr" ", const WyCSeg& " "cs" ")"
.PP
.BI "bool operator !=(const char* " "cstr" ", const WyCSeg& " "cs" ")"
.PP
    Test equivalence of WyCSeg(\fIcstr\fP) with \fIrhs\fP

    Note: These are function overloads for efficiency
          See operator ==(const WyCSeg&). and
              operator !=(const WyCSeg&)
.PP
    [\fBThrow\fP] WyCSeg::Reply
            Wym_EFAULT      \fIcstr\fP is NULL
.PP
    [\fBRet\fP] true= relation holds
         false= otherwise
.PP 
    [\fBRefer\fP] ::memcmp(void*,void*,size_t)
.\"--------------------------------------------
.PP
.SH "SEE ALSO"
.BR wyret
.BR wystr
.BR wytimespec
.BR wy_dirfile
.BR wychrfile
.BR wyregfile
.BR wymutex
.SH NOTE
Project is in development, http://sourceforge.net/projects/libwx