stdlib/strings: Abstracted functions common to all Text representations.
[nit.git] / lib / standard / string.nit
index d808851..f348b75 100644 (file)
@@ -28,6 +28,7 @@ intrude import collection # FIXME should be collection::array
 # High-level abstraction for all text representations
 abstract class Text
        super Comparable
+       super StringCapable
 
        redef type OTHER: Text
 
@@ -38,7 +39,7 @@ abstract class Text
        type SELFTYPE: Text
 
        # Gets a view on the chars of the Text object
-       fun chars: StringCharView is abstract
+       fun chars: SELFVIEW is abstract
 
        # Number of characters contained in self.
        fun length: Int is abstract
@@ -53,13 +54,22 @@ abstract class Text
        # A `from` index < 0 will be replaced by 0.
        # Unless a `count` value is > 0 at the same time.
        # In this case, `from += count` and `count -= from`.
-       fun substring(from: Int, count: Int): String is abstract
+       fun substring(from: Int, count: Int): SELFTYPE is abstract
+
+       # Concatenates `o` to `self`
+       fun +(o: Text): SELFTYPE is abstract
+
+       # Auto-concatenates self `i` times
+       fun *(i: Int): SELFTYPE is abstract
 
        # Is the current Text empty (== "")
        #       assert "".is_empty
        #       assert not "foo".is_empty
        fun is_empty: Bool do return self.length == 0
 
+       # Returns an empty Text of the right type
+       fun empty: SELFTYPE is abstract
+
        # Gets the first char of the Text
        #
        # DEPRECATED : Use self.chars.first instead
@@ -157,7 +167,7 @@ abstract class Text
        #     assert "abcd".substring_from(2)    ==  "cd"
        #
        # As with substring, a `from` index < 0 will be replaced by 0
-       fun substring_from(from: Int): String
+       fun substring_from(from: Int): SELFTYPE
        do
                assert from < length
                return substring(from, length - from)
@@ -274,21 +284,35 @@ abstract class Text
        # A upper case version of `self`
        #
        #     assert "Hello World!".to_upper     == "HELLO WORLD!"
-       fun to_upper: String
-       do
-               var s = new FlatBuffer.with_capacity(length)
-               for i in self.chars do s.add(i.to_upper)
-               return s.to_s
-       end
+       fun to_upper: SELFTYPE is abstract
 
        # A lower case version of `self`
        #
        #     assert "Hello World!".to_lower     == "hello world!"
-       fun to_lower : String
+       fun to_lower : SELFTYPE is abstract
+
+       # Removes the whitespaces at the beginning of self
+       fun l_trim: SELFTYPE
        do
-               var s = new FlatBuffer.with_capacity(length)
-               for i in self.chars do s.add(i.to_lower)
-               return s.to_s
+               var iter = self.chars.iterator
+               while iter.is_ok do
+                       if iter.item.ascii > 32 then break
+                       iter.next
+               end
+               if iter.index == length then return self.empty
+               return self.substring_from(iter.index)
+       end
+
+       # Removes the whitespaces at the end of self
+       fun r_trim: SELFTYPE
+       do
+               var iter = self.chars.reverse_iterator
+               while iter.is_ok do
+                       if iter.item.ascii > 32 then break
+                       iter.next
+               end
+               if iter.index == length then return self.empty
+               return self.substring(0, iter.index + 1)
        end
 
        # Trims trailing and preceding white spaces
@@ -296,23 +320,7 @@ abstract class Text
        #
        #     assert "  Hello  World !  ".trim   == "Hello  World !"
        #     assert "\na\nb\tc\t".trim          == "a\nb\tc"
-       fun trim: String
-       do
-               if self.length == 0 then return self.to_s
-               # find position of the first non white space char (ascii < 32) from the start of the string
-               var start_pos = 0
-               while self.chars[start_pos].ascii <= 32 do
-                       start_pos += 1
-                       if start_pos == length then return ""
-               end
-               # find position of the first non white space char from the end of the string
-               var end_pos = length - 1
-               while self.chars[end_pos].ascii <= 32 do
-                       end_pos -= 1
-                       if end_pos == start_pos then return self.chars[start_pos].to_s
-               end
-               return self.substring(start_pos, end_pos - start_pos + 1)
-       end
+       fun trim: SELFTYPE do return (self.l_trim).r_trim
 
        # Mangle a string to be a unique string only made of alphanumeric characters
        fun to_cmangle: String
@@ -578,7 +586,6 @@ end
 # Immutable strings of characters.
 class String
        super FlatText
-       super StringCapable
 
        redef type SELFTYPE: String
        redef type SELFVIEW: FlatStringCharView
@@ -589,7 +596,7 @@ class String
        # Indes in _items of the last item of the string
        private var index_to: Int
 
-       redef var chars: StringCharView = new FlatStringCharView(self)
+       redef var chars: SELFVIEW = new FlatStringCharView(self)
 
        ################################################
        #       AbstractString specific methods        #
@@ -603,7 +610,7 @@ class String
                return items[index + index_from]
        end
 
-       redef fun substring(from: Int, count: Int): String
+       redef fun substring(from, count)
        do
                assert count >= 0
 
@@ -624,7 +631,9 @@ class String
                return new String.with_infos(items, to - realFrom + 1, realFrom, to)
        end
 
-       redef fun to_upper: String
+       redef fun empty do return "".as(String)
+
+       redef fun to_upper
        do
                var outstr = calloc_string(self.length + 1)
                var out_index = 0
@@ -644,7 +653,7 @@ class String
                return outstr.to_s_with_length(self.length)
        end
 
-       redef fun to_lower : String
+       redef fun to_lower
        do
                var outstr = calloc_string(self.length + 1)
                var out_index = 0
@@ -664,26 +673,6 @@ class String
                return outstr.to_s_with_length(self.length)
        end
 
-       redef fun trim: String
-       do
-               if self.length == 0 then return self
-               # find position of the first non white space char (ascii < 32) from the start of the string
-               var start_pos = self.index_from
-               while items[start_pos].ascii <= 32 do
-                       start_pos += 1
-                       if start_pos == index_to + 1 then return ""
-               end
-               # find position of the first non white space char from the end of the string
-               var end_pos = index_to
-               while items[end_pos].ascii <= 32 do
-                       end_pos -= 1
-                       if end_pos == start_pos then return items[start_pos].to_s
-               end
-               start_pos -= index_from
-               end_pos -= index_from
-               return self.substring(start_pos, end_pos - start_pos + 1)
-       end
-
        redef fun output
        do
                var i = self.index_from
@@ -787,7 +776,7 @@ class String
        # The concatenation of `self` with `s`
        #
        #     assert "hello " + "world!"         == "hello world!"
-       fun +(s: String): String
+       redef fun +(s)
        do
                var my_length = self.length
                var its_length = s.length
@@ -797,19 +786,27 @@ class String
                var target_string = calloc_string(my_length + its_length + 1)
 
                self.items.copy_to(target_string, my_length, index_from, 0)
-               s.items.copy_to(target_string, its_length, s.index_from, my_length)
+               if s isa String then
+                       s.items.copy_to(target_string, its_length, s.index_from, my_length)
+               else if s isa FlatBuffer then
+                       s.items.copy_to(target_string, its_length, 0, my_length)
+               else
+                       var curr_pos = my_length
+                       for i in s.chars do
+                               target_string[curr_pos] = i
+                               curr_pos += 1
+                       end
+               end
 
                target_string[total_length] = '\0'
 
                return target_string.to_s_with_length(total_length)
        end
 
-       # `i` repetitions of `self`
-       #
        #     assert "abc"*3           == "abcabcabc"
        #     assert "abc"*1           == "abc"
        #     assert "abc"*0           == ""
-       fun *(i: Int): String
+       redef fun *(i)
        do
                assert i >= 0
 
@@ -952,19 +949,17 @@ abstract class Buffer
        # Adds the content of string `s` at the end of self
        fun append(s: String) is abstract
 
-       redef fun chars: BufferCharView is abstract
 end
 
 # Mutable strings of characters.
 class FlatBuffer
        super FlatText
-       super StringCapable
        super Buffer
 
        redef type SELFVIEW: FlatBufferCharView
        redef type SELFTYPE: FlatBuffer
 
-       redef var chars: FlatBufferCharView = new FlatBufferCharView(self)
+       redef var chars: SELFVIEW = new FlatBufferCharView(self)
 
        var capacity: Int
 
@@ -987,6 +982,8 @@ class FlatBuffer
 
        redef fun clear do length = 0
 
+       redef fun empty do return new FlatBuffer
+
        redef fun enlarge(cap)
        do
                var c = capacity
@@ -1065,10 +1062,27 @@ class FlatBuffer
                                r.chars.push(items[from])
                                from += 1
                        end
-                       return r.to_s
+                       return r
                else
-                       return ""
+                       return new FlatBuffer
+               end
+       end
+
+       redef fun +(other)
+       do
+               var new_buf = new FlatBuffer.with_capacity(self.length + other.length)
+               new_buf.append(self)
+               new_buf.append(other)
+               return new_buf
+       end
+
+       redef fun *(repeats)
+       do
+               var new_buf = new FlatBuffer.with_capacity(self.length * repeats)
+               for i in [0..repeats[ do
+                       new_buf.append(self)
                end
+               return new_buf
        end
 end