kotovalexarian-likes-github/ruby--ruby
1
0
Fork 0
mirror of https://github.com/ruby/ruby.git synced 2022-11-09 12:17:21 -05:00
Code Releases Activity

* ext/strscan/strscan.c: improved documentation

Browse source 
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@5781 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
This commit is contained in:
gsinclair 2004-02-19 12:32:09 +00:00
parent ea5679c979
commit a077e7cec4
2 changed files with 39 additions and 30 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
ChangeLog
View file

@ -1,3 +1,7 @@
Thu Feb 19 18:08:18 2004 Gavin Sinclair <gsinclair@soyabean.com.au>
* ext/strscan/strscan.c: improved documentation
Thu Feb 19 18:08:18 2004 Nobuyoshi Nakada <nobu@ruby-lang.org>
* win32/win32.c, win32/win32.h: fixed prototypes.

65
ext/strscan/strscan.c
View file

@ -1169,6 +1169,8 @@ inspect2(p)
======================================================================= */
/*
* Document-class: StringScanner
*
* StringScanner provides for lexical scanning operations on a String. Here is
* an example of its usage:
*
@ -1194,8 +1196,9 @@ inspect2(p)
* p s.scan(/\w+/) # -> nil
*
* Scanning a string means remembering the position of a <i>scan pointer</i>,
* which is just an index. The scan pointer effectively points _between_
* characters. (XXX: get this right - is it between or not?)
* which is just an index. The point of scanning is to move forward a bit at
* a time, so matches are sought after the scan pointer; usually immediately
* after it.
*
* Given the string "test string", here are the pertinent scan pointer
* positions:
@ -1220,49 +1223,51 @@ inspect2(p)
*
* === Advancing the Scan Pointer
*
* getch
* getbyte
* scan
* scan_until
* skip
* skip_until
* - #getch
* - #getbyte
* - #scan
* - #scan_until
* - #skip
* - #skip_until
*
* === Looking Ahead
*
* check
* check_until
* exist?
* match?
* peek
* - #check
* - #check_until
* - #exist?
* - #match?
* - #peek
*
* === Finding Where we Are
*
* bol?
* eos?
* pos
* - #bol?
* - #eos?
* - #rest?
* - #rest_size
* - #pos
*
* === Setting Where we Are
*
* reset
* terminate
* pos=
* - #reset
* - #terminate
* - #pos=
*
* === Match Data
*
* matched
* matched?
* matched_size
* []
* pre_match
* post_match
* - #matched
* - #matched?
* - #matched_size
* - []
* - #pre_match
* - #post_match
*
* === Miscellaneous
*
* <<
* concat
* string
* string=
* unscan
* - <<
* - #concat
* - #string
* - #string=
* - #unscan
*
* There are aliases to several of the methods.
*/