X-Git-Url: http://nitlanguage.org diff --git a/lib/standard/string.nit b/lib/standard/string.nit index 3eede86..62d5ddc 100644 --- a/lib/standard/string.nit +++ b/lib/standard/string.nit @@ -30,7 +30,6 @@ intrude import collection::array # High-level abstraction for all text representations abstract class Text super Comparable - super StringCapable redef type OTHER: Text @@ -181,8 +180,25 @@ abstract class Text # # assert "abcd".has_substring("bc",1) == true # assert "abcd".has_substring("bc",2) == false + # + # Returns true iff all characters of `str` are presents + # at the expected index in `self.` + # The first character of `str` being at `pos`, the second + # character being at `pos+1` and so on... + # + # This means that all characters of `str` need to be inside `self`. + # + # assert "abcd".has_substring("xab", -1) == false + # assert "abcd".has_substring("cdx", 2) == false + # + # And that the empty string is always a valid substring. + # + # assert "abcd".has_substring("", 2) == true + # assert "abcd".has_substring("", 200) == true fun has_substring(str: String, pos: Int): Bool do + if str.is_empty then return true + if pos < 0 or pos + str.length > length then return false var myiter = self.chars.iterator_from(pos) var itsiter = str.chars.iterator while myiter.is_ok and itsiter.is_ok do @@ -369,6 +385,33 @@ abstract class Text # assert "\na\nb\tc\t".trim == "a\nb\tc" fun trim: SELFTYPE do return (self.l_trim).r_trim + # Justify a self in a space of `length` + # + # `left` is the space ratio on the left side. + # * 0.0 for left-justified (no space at the left) + # * 1.0 for right-justified (all spaces at the left) + # * 0.5 for centered (half the spaces at the left) + # + # assert "hello".justify(10, 0.0) == "hello " + # assert "hello".justify(10, 1.0) == " hello" + # assert "hello".justify(10, 0.5) == " hello " + # + # If `length` is not enough, `self` is returned as is. + # + # assert "hello".justify(2, 0.0) == "hello" + # + # REQUIRE: left >= 0.0 and left <= 1.0 + # ENSURE: `self.length <= length implies result.length == length` + # ENSURE: `self.length >= length implies result == self + fun justify(length: Int, left: Float): SELFTYPE + do + var diff = length - self.length + if diff <= 0 then return self + assert left >= 0.0 and left <= 1.0 + var before = (diff.to_f * left).to_i + return " " * before + self + " " * (diff-before) + end + # Mangle a string to be a unique string only made of alphanumeric characters fun to_cmangle: String do @@ -450,6 +493,50 @@ abstract class Text # assert "\n\"'\\\{\}".escape_to_nit == "\\n\\\"\\'\\\\\\\{\\\}" fun escape_to_nit: String do return escape_more_to_c("\{\}") + # Escape to POSIX Shell (sh). + # + # Abort if the text contains a null byte. + # + # assert "\n\"'\\\{\}0".escape_to_sh == "'\n\"'\\''\\\{\}0'" + fun escape_to_sh: String do + var b = new FlatBuffer + b.chars.add '\'' + for i in [0..length[ do + var c = chars[i] + if c == '\'' then + b.append("'\\''") + else + assert without_null_byte: c != '\0' + b.add(c) + end + end + b.chars.add '\'' + return b.to_s + end + + # Escape to include in a Makefile + # + # Unfortunately, some characters are not escapable in Makefile. + # These characters are `;`, `|`, `\`, and the non-printable ones. + # They will be rendered as `"?{hex}"`. + fun escape_to_mk: String do + var b = new FlatBuffer + for i in [0..length[ do + var c = chars[i] + if c == '$' then + b.append("$$") + else if c == ':' or c == ' ' or c == '#' then + b.add('\\') + b.add(c) + else if c.ascii < 32 or c == ';' or c == '|' or c == '\\' or c == '=' then + b.append("?{c.ascii.to_base(16, false)}") + else + b.add(c) + end + end + return b.to_s + end + # Return a string where Nit escape sequences are transformed. # # var s = "\\n" @@ -670,8 +757,6 @@ abstract class FlatText redef var length: Int = 0 - init do end - redef fun output do var i = 0 @@ -691,12 +776,7 @@ private abstract class StringCharView type SELFTYPE: Text - private var target: SELFTYPE - - private init(tgt: SELFTYPE) - do - target = tgt - end + var target: SELFTYPE redef fun is_empty do return target.is_empty @@ -717,6 +797,11 @@ private abstract class BufferCharView end +# A `String` holds and manipulates an arbitrary sequence of characters. +# +# String objects may be created using literals. +# +# assert "Hello World!" isa String abstract class String super Text @@ -737,8 +822,13 @@ abstract class String # assert "abc" * 0 == "" fun *(i: Int): SELFTYPE is abstract + # Insert `s` at `pos`. + # + # assert "helloworld".insert_at(" ", 5) == "hello world" fun insert_at(s: String, pos: Int): SELFTYPE is abstract + redef fun substrings: Iterator[String] is abstract + # Returns a reversed version of self # # assert "hello".reversed == "olleh" @@ -869,8 +959,6 @@ private class FlatSubstringsIter var tgt: nullable FlatText - init(tgt: FlatText) do self.tgt = tgt - redef fun item do assert is_ok return tgt.as(not null) @@ -909,7 +997,7 @@ class FlatString redef fun reversed do - var native = calloc_string(self.length + 1) + var native = new NativeString(self.length + 1) var length = self.length var items = self.items var pos = 0 @@ -947,7 +1035,7 @@ class FlatString redef fun to_upper do - var outstr = calloc_string(self.length + 1) + var outstr = new NativeString(self.length + 1) var out_index = 0 var myitems = self.items @@ -967,7 +1055,7 @@ class FlatString redef fun to_lower do - var outstr = calloc_string(self.length + 1) + var outstr = new NativeString(self.length + 1) var out_index = 0 var myitems = self.items @@ -1012,7 +1100,7 @@ class FlatString if real_items != null then return real_items.as(not null) else - var newItems = calloc_string(length + 1) + var newItems = new NativeString(length + 1) self.items.copy_to(newItems, length, index_from, 0) newItems[length] = '\0' self.real_items = newItems @@ -1090,7 +1178,7 @@ class FlatString var total_length = my_length + its_length - var target_string = calloc_string(my_length + its_length + 1) + var target_string = new NativeString(my_length + its_length + 1) self.items.copy_to(target_string, my_length, index_from, 0) if s isa FlatString then @@ -1121,7 +1209,7 @@ class FlatString var my_items = self.items - var target_string = calloc_string((final_length) + 1) + var target_string = new NativeString(final_length + 1) target_string[final_length] = '\0' @@ -1231,6 +1319,7 @@ private class FlatStringCharView end +# A mutable sequence of characters. abstract class Buffer super Text @@ -1316,7 +1405,7 @@ abstract class Buffer # # SEE: `Char::is_letter` for the definition of a letter. # - # var b = new FlatBuffer.from("jAVAsCriPt")" + # var b = new FlatBuffer.from("jAVAsCriPt") # b.capitalize # assert b == "Javascript" # b = new FlatBuffer.from("i am root") @@ -1419,7 +1508,7 @@ class FlatBuffer # The COW flag can be set at false here, since # it does a copy of the current `Buffer` written = false - var a = calloc_string(c+1) + var a = new NativeString(c+1) if length > 0 then items.copy_to(a, length, 0, 0) items = a capacity = c @@ -1435,7 +1524,7 @@ class FlatBuffer redef fun to_cstring do if is_dirty then - var new_native = calloc_string(length + 1) + var new_native = new NativeString(length + 1) new_native[length] = '\0' if length > 0 then items.copy_to(new_native, length, 0, 0) real_items = new_native @@ -1447,11 +1536,12 @@ class FlatBuffer # Create a new empty string. init do end + # Create a new string copied from `s`. init from(s: Text) do capacity = s.length + 1 length = s.length - items = calloc_string(capacity) + items = new NativeString(capacity) if s isa FlatString then s.items.copy_to(items, length, s.index_from, 0) else if s isa FlatBuffer then @@ -1471,7 +1561,7 @@ class FlatBuffer do assert cap >= 0 # _items = new NativeString.calloc(cap) - items = calloc_string(cap+1) + items = new NativeString(cap+1) capacity = cap length = 0 end @@ -1528,7 +1618,7 @@ class FlatBuffer redef fun reverse do written = false - var ns = calloc_string(capacity) + var ns = new NativeString(capacity) var si = length - 1 var ni = 0 var it = items @@ -1599,7 +1689,6 @@ end private class FlatBufferCharView super BufferCharView - super StringCapable redef type SELFTYPE: FlatBuffer @@ -1632,7 +1721,6 @@ private class FlatBufferCharView redef fun append(s) do - var my_items = target.items var s_length = s.length if target.capacity < s.length then enlarge(s_length + target.length) end @@ -1775,12 +1863,12 @@ redef class Int end redef class Float - # Pretty print self, print needoed decimals up to a max of 3. + # Pretty representation of `self`, with decimals as needed from 1 to a maximum of 3 # - # assert 12.34.to_s == "12.34" - # assert (-0120.03450).to_s == "-120.035" + # assert 12.34.to_s == "12.34" + # assert (-0120.030).to_s == "-120.03" # - # see `to_precision` for a different precision. + # see `to_precision` for a custom precision. redef fun to_s do var str = to_precision( 3 ) if is_inf != 0 or is_nan then return str @@ -1799,13 +1887,15 @@ redef class Float return str end - # `self` representation with `nb` digits after the '.'. + # `String` representation of `self` with the given number of `decimals` # - # assert 12.345.to_precision(1) == "12.3" - # assert 12.345.to_precision(2) == "12.35" - # assert 12.345.to_precision(3) == "12.345" - # assert 12.345.to_precision(4) == "12.3450" - fun to_precision(nb: Int): String + # assert 12.345.to_precision(0) == "12" + # assert 12.345.to_precision(3) == "12.345" + # assert (-12.345).to_precision(3) == "-12.345" + # assert (-0.123).to_precision(3) == "-0.123" + # assert 0.999.to_precision(2) == "1.00" + # assert 0.999.to_precision(4) == "0.9990" + fun to_precision(decimals: Int): String do if is_nan then return "nan" @@ -1816,25 +1906,34 @@ redef class Float return "-inf" end - if nb == 0 then return self.to_i.to_s + if decimals == 0 then return self.to_i.to_s var f = self - for i in [0..nb[ do f = f * 10.0 + for i in [0..decimals[ do f = f * 10.0 if self > 0.0 then f = f + 0.5 else f = f - 0.5 end var i = f.to_i - if i == 0 then return "0.0" - var s = i.to_s + if i == 0 then return "0." + "0"*decimals + + # Prepare both parts of the float, before and after the "." + var s = i.abs.to_s var sl = s.length - if sl > nb then - var p1 = s.substring(0, s.length-nb) - var p2 = s.substring(s.length-nb, nb) - return p1 + "." + p2 + var p1 + var p2 + if sl > decimals then + # Has something before the "." + p1 = s.substring(0, sl-decimals) + p2 = s.substring(sl-decimals, decimals) else - return "0." + ("0"*(nb-sl)) + s + p1 = "0" + p2 = "0"*(decimals-sl) + s end + + if i < 0 then p1 = "-" + p1 + + return p1 + "." + p2 end # `self` representation with `nb` digits after the '.'. @@ -2024,11 +2123,16 @@ end # Native strings are simple C char * extern class NativeString `{ char* `} - super StringCapable # Creates a new NativeString with a capacity of `length` new(length: Int) is intern + + # Get char at `index`. fun [](index: Int): Char is intern + + # Set char `item` at index. fun []=(index: Int, item: Char) is intern + + # Copy `self` to `dest`. fun copy_to(dest: NativeString, length: Int, from: Int, to: Int) is intern # Position of the first nul character. @@ -2038,7 +2142,11 @@ extern class NativeString `{ char* `} while self[l] != '\0' do l += 1 return l end + + # Parse `self` as an Int. fun atoi: Int is intern + + # Parse `self` as a Float. fun atof: Float is extern "atof" redef fun to_s @@ -2046,30 +2154,27 @@ extern class NativeString `{ char* `} return to_s_with_length(cstring_length) end + # Returns `self` as a String of `length`. fun to_s_with_length(length: Int): FlatString do assert length >= 0 var str = new FlatString.with_infos(self, length, 0, length - 1) - str.real_items = self return str end + # Returns `self` as a new String. fun to_s_with_copy: FlatString do var length = cstring_length - var new_self = calloc_string(length + 1) + var new_self = new NativeString(length + 1) copy_to(new_self, length, 0, 0) var str = new FlatString.with_infos(new_self, length, 0, length - 1) - str.real_items = self + new_self[length] = '\0' + str.real_items = new_self return str end end -# StringCapable objects can create native strings -interface StringCapable - protected fun calloc_string(size: Int): NativeString is intern -end - redef class Sys private var args_cache: nullable Sequence[String] @@ -2119,7 +2224,8 @@ end # # Note: it caching is not usefull, see `alpha_comparator` class CachedAlphaComparator - super Comparator[Object] + super Comparator + redef type COMPARED: Object private var cache = new HashMap[Object, String] @@ -2137,7 +2243,7 @@ end # see `alpha_comparator` private class AlphaComparator - super Comparator[Object] + super Comparator redef fun compare(a, b) do return a.to_s <=> b.to_s end @@ -2149,7 +2255,7 @@ end # var a = [1, 2, 3, 10, 20] # alpha_comparator.sort(a) # assert a == [1, 10, 2, 20, 3] -fun alpha_comparator: Comparator[Object] do return once new AlphaComparator +fun alpha_comparator: Comparator do return once new AlphaComparator # The arguments of the program as given by the OS fun args: Sequence[String]