]> git.wincent.com - walrat.git/blob - lib/walrat/string_enumerator.rb
Initial import (extraction from Walrus repo, commit 0c9d44c)
[walrat.git] / lib / walrat / string_enumerator.rb
1 # Copyright 2007-2010 Wincent Colaiuta. All rights reserved.
2 # Redistribution and use in source and binary forms, with or without
3 # modification, are permitted provided that the following conditions are met:
4 #
5 # 1. Redistributions of source code must retain the above copyright notice,
6 #    this list of conditions and the following disclaimer.
7 # 2. Redistributions in binary form must reproduce the above copyright notice,
8 #    this list of conditions and the following disclaimer in the documentation
9 #    and/or other materials provided with the distribution.
10 #
11 # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
12 # AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
13 # IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
14 # ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
15 # LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
16 # CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
17 # SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
18 # INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
19 # CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
20 # ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
21 # POSSIBILITY OF SUCH DAMAGE.
22
23 require 'strscan'
24 require 'walrat'
25
26 module Walrat
27   # Unicode-aware (UTF-8) string enumerator.
28   # For Unicode support $KCODE must be set to 'U' (UTF-8).
29   class StringEnumerator
30     # Returns the char most recently scanned before the last "next" call, or
31     # nil if nothing previously scanned.
32     attr_reader :last
33
34     def initialize string
35       raise ArgumentError, 'nil string' if string.nil?
36       @scanner  = StringScanner.new string
37       @current  = nil
38       @last     = nil
39     end
40
41     # This method will only work as expected if $KCODE is set to 'U' (UTF-8).
42     def next
43       @last     = @current
44       @current  = @scanner.scan(/./m) # must use multiline mode or "." won't match newlines
45     end
46   end # class StringEnumerator
47 end # module Walrus