X-Git-Url: http://nitlanguage.org diff --git a/lib/core/text/abstract_text.nit b/lib/core/text/abstract_text.nit index cb6f281..71021ab 100644 --- a/lib/core/text/abstract_text.nit +++ b/lib/core/text/abstract_text.nit @@ -25,6 +25,7 @@ in "C" `{ # High-level abstraction for all text representations abstract class Text super Comparable + super Cloneable redef type OTHER: Text @@ -82,6 +83,9 @@ abstract class Text # implementation of an empty string. protected fun empty: SELFTYPE is abstract + # Returns a copy of `self` as a Buffer + fun to_buffer: Buffer is abstract + # Gets the first char of the Text # # DEPRECATED : Use self.chars.first instead @@ -135,7 +139,7 @@ abstract class Text end # Return a null terminated char * - fun to_cstring: NativeString is abstract + fun to_cstring: CString is abstract # The index of the last occurrence of an element starting from pos (in reverse order). # @@ -148,6 +152,12 @@ abstract class Text # DEPRECATED : Use self.chars.last_index_of_from instead fun last_index_of_from(item: Char, pos: Int): Int do return chars.last_index_of_from(item, pos) + # Concatenates `o` to `self` + # + # assert "hello" + "world" == "helloworld" + # assert "" + "hello" + "" == "hello" + fun +(o: Text): SELFTYPE is abstract + # Gets an iterator on the chars of self # # DEPRECATED : Use self.chars.iterator instead @@ -856,7 +866,7 @@ abstract class Text # If no transformation is needed, return self as a string if not has_percent then return to_s - var buf = new NativeString(len) + var buf = new CString(len) var i = 0 var l = 0 while i < length do @@ -1098,15 +1108,15 @@ abstract class Text # Copies `n` bytes from `self` at `src_offset` into `dest` starting at `dest_offset` # - # Basically a high-level synonym of NativeString::copy_to + # Basically a high-level synonym of CString::copy_to # # REQUIRE: `n` must be large enough to contain `len` bytes # - # var ns = new NativeString(8) + # var ns = new CString(8) # "Text is String".copy_to_native(ns, 8, 2, 0) # assert ns.to_s_unsafe(8) == "xt is St" # - fun copy_to_native(dest: NativeString, n, src_offset, dest_offset: Int) do + fun copy_to_native(dest: CString, n, src_offset, dest_offset: Int) do var mypos = src_offset var itspos = dest_offset while n > 0 do @@ -1150,6 +1160,108 @@ abstract class Text end return retarr.reversed end + + # Concatenates self `i` times + # + #~~~nit + # assert "abc" * 4 == "abcabcabcabc" + # assert "abc" * 1 == "abc" + # assert "abc" * 0 == "" + # var b = new Buffer + # b.append("天地") + # b = b * 4 + # assert b == "天地天地天地天地" + #~~~ + fun *(i: Int): SELFTYPE is abstract + + # Insert `s` at `pos`. + # + #~~~nit + # assert "helloworld".insert_at(" ", 5) == "hello world" + # var b = new Buffer + # b.append("Hello世界") + # b = b.insert_at(" beautiful ", 5) + # assert b == "Hello beautiful 世界" + #~~~ + fun insert_at(s: String, pos: Int): SELFTYPE is abstract + + # Returns a reversed version of self + # + # assert "hello".reversed == "olleh" + # assert "bob".reversed == "bob" + # assert "".reversed == "" + fun reversed: SELFTYPE is abstract + + # A upper case version of `self` + # + # assert "Hello World!".to_upper == "HELLO WORLD!" + fun to_upper: SELFTYPE is abstract + + # A lower case version of `self` + # + # assert "Hello World!".to_lower == "hello world!" + fun to_lower : SELFTYPE is abstract + + # Takes a camel case `self` and converts it to snake case + # + # assert "randomMethodId".to_snake_case == "random_method_id" + # + # The rules are the following: + # + # An uppercase is always converted to a lowercase + # + # assert "HELLO_WORLD".to_snake_case == "hello_world" + # + # An uppercase that follows a lowercase is prefixed with an underscore + # + # assert "HelloTheWORLD".to_snake_case == "hello_the_world" + # + # An uppercase that follows an uppercase and is followed by a lowercase, is prefixed with an underscore + # + # assert "HelloTHEWorld".to_snake_case == "hello_the_world" + # + # All other characters are kept as is; `self` does not need to be a proper CamelCased string. + # + # assert "=-_H3ll0Th3W0rld_-=".to_snake_case == "=-_h3ll0th3w0rld_-=" + fun to_snake_case: SELFTYPE is abstract + + # Takes a snake case `self` and converts it to camel case + # + # assert "random_method_id".to_camel_case == "randomMethodId" + # + # If the identifier is prefixed by an underscore, the underscore is ignored + # + # assert "_private_field".to_camel_case == "_privateField" + # + # If `self` is upper, it is returned unchanged + # + # assert "RANDOM_ID".to_camel_case == "RANDOM_ID" + # + # If there are several consecutive underscores, they are considered as a single one + # + # assert "random__method_id".to_camel_case == "randomMethodId" + fun to_camel_case: SELFTYPE is abstract + + # Returns a capitalized `self` + # + # Letters that follow a letter are lowercased + # Letters that follow a non-letter are upcased. + # + # If `keep_upper = true`, already uppercase letters are not lowercased. + # + # SEE : `Char::is_letter` for the definition of letter. + # + # assert "jAVASCRIPT".capitalized == "Javascript" + # assert "i am root".capitalized == "I Am Root" + # assert "ab_c -ab0c ab\nc".capitalized == "Ab_C -Ab0C Ab\nC" + # assert "preserve my ACRONYMS".capitalized(keep_upper=true) == "Preserve My ACRONYMS" + fun capitalized(keep_upper: nullable Bool): SELFTYPE do + if length == 0 then return self + + var buf = new Buffer.with_cap(length) + buf.capitalize(keep_upper=keep_upper, src=self) + return buf.to_s + end end # All kinds of array-based text representations. @@ -1160,13 +1272,13 @@ abstract class FlatText # # Warning : Might be void in some subclasses, be sure to check # if set before using it. - var items: NativeString is noinit + var items: CString is noinit # Returns a char* starting at position `first_byte` # # WARNING: If you choose to use this service, be careful of the following. # - # Strings and NativeString are *ideally* always allocated through a Garbage Collector. + # Strings and CString are *ideally* always allocated through a Garbage Collector. # Since the GC tracks the use of the pointer for the beginning of the char*, it may be # deallocated at any moment, rendering the pointer returned by this function invalid. # Any access to freed memory may very likely cause undefined behaviour or a crash. @@ -1177,7 +1289,7 @@ abstract class FlatText # # As always, do not modify the content of the String in C code, if this is what you want # copy locally the char* as Nit Strings are immutable. - fun fast_cstring: NativeString is abstract + fun fast_cstring: CString is abstract redef var length = 0 @@ -1245,157 +1357,26 @@ abstract class String redef fun to_s do return self - # Concatenates `o` to `self` - # - # assert "hello" + "world" == "helloworld" - # assert "" + "hello" + "" == "hello" - fun +(o: Text): SELFTYPE is abstract - - # Concatenates self `i` times - # - # assert "abc" * 4 == "abcabcabcabc" - # assert "abc" * 1 == "abc" - # 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 is abstract - - # Returns a reversed version of self - # - # assert "hello".reversed == "olleh" - # assert "bob".reversed == "bob" - # assert "".reversed == "" - fun reversed: SELFTYPE is abstract - - # A upper case version of `self` - # - # assert "Hello World!".to_upper == "HELLO WORLD!" - fun to_upper: SELFTYPE is abstract + redef fun clone do return self - # A lower case version of `self` - # - # assert "Hello World!".to_lower == "hello world!" - fun to_lower : SELFTYPE is abstract + redef fun to_buffer do return new Buffer.from_text(self) - # Takes a camel case `self` and converts it to snake case - # - # assert "randomMethodId".to_snake_case == "random_method_id" - # - # The rules are the following: - # - # An uppercase is always converted to a lowercase - # - # assert "HELLO_WORLD".to_snake_case == "hello_world" - # - # An uppercase that follows a lowercase is prefixed with an underscore - # - # assert "HelloTheWORLD".to_snake_case == "hello_the_world" - # - # An uppercase that follows an uppercase and is followed by a lowercase, is prefixed with an underscore - # - # assert "HelloTHEWorld".to_snake_case == "hello_the_world" - # - # All other characters are kept as is; `self` does not need to be a proper CamelCased string. - # - # assert "=-_H3ll0Th3W0rld_-=".to_snake_case == "=-_h3ll0th3w0rld_-=" - fun to_snake_case: SELFTYPE - do - if self.is_lower then return self - - var new_str = new Buffer.with_cap(self.length) - var prev_is_lower = false - var prev_is_upper = false - - for i in [0..length[ do - var char = chars[i] - if char.is_lower then - new_str.add(char) - prev_is_lower = true - prev_is_upper = false - else if char.is_upper then - if prev_is_lower then - new_str.add('_') - else if prev_is_upper and i+1 < length and chars[i+1].is_lower then - new_str.add('_') - end - new_str.add(char.to_lower) - prev_is_lower = false - prev_is_upper = true - else - new_str.add(char) - prev_is_lower = false - prev_is_upper = false - end - end - - return new_str.to_s - end - - # Takes a snake case `self` and converts it to camel case - # - # assert "random_method_id".to_camel_case == "randomMethodId" - # - # If the identifier is prefixed by an underscore, the underscore is ignored - # - # assert "_private_field".to_camel_case == "_privateField" - # - # If `self` is upper, it is returned unchanged - # - # assert "RANDOM_ID".to_camel_case == "RANDOM_ID" - # - # If there are several consecutive underscores, they are considered as a single one - # - # assert "random__method_id".to_camel_case == "randomMethodId" - fun to_camel_case: SELFTYPE - do + redef fun to_camel_case do if self.is_upper then return self - var new_str = new Buffer - var is_first_char = true - var follows_us = false - - for i in [0..length[ do - var char = chars[i] - if is_first_char then - new_str.add(char) - is_first_char = false - else if char == '_' then - follows_us = true - else if follows_us then - new_str.add(char.to_upper) - follows_us = false - else - new_str.add(char) - end - end - + var new_str = new Buffer.with_cap(length) + new_str.append self + new_str.camel_case return new_str.to_s end - # Returns a capitalized `self` - # - # Letters that follow a letter are lowercased - # Letters that follow a non-letter are upcased. - # - # If `keep_upper = true`, already uppercase letters are not lowercased. - # - # SEE : `Char::is_letter` for the definition of letter. - # - # assert "jAVASCRIPT".capitalized == "Javascript" - # assert "i am root".capitalized == "I Am Root" - # assert "ab_c -ab0c ab\nc".capitalized == "Ab_C -Ab0C Ab\nC" - # assert "preserve my ACRONYMS".capitalized(keep_upper=true) == "Preserve My ACRONYMS" - fun capitalized(keep_upper: nullable Bool): SELFTYPE do - if length == 0 then return self + redef fun to_snake_case do + if self.is_lower then return self - var buf = new Buffer.with_cap(length) - buf.capitalize(keep_upper=keep_upper, src=self) - return buf.to_s + var new_str = new Buffer.with_cap(self.length) + new_str.append self + new_str.snake_case + return new_str.to_s end end @@ -1409,6 +1390,13 @@ abstract class Buffer # Returns an instance of a subclass of `Buffer` with `i` base capacity new with_cap(i: Int) is abstract + # Returns an instance of a subclass of `Buffer` with `t` as content + new from_text(t: Text) do + var ret = new Buffer.with_cap(t.byte_length) + ret.append t + return ret + end + redef type SELFTYPE: Buffer is fixed # Copy-On-Write flag @@ -1424,6 +1412,20 @@ abstract class Buffer # DEPRECATED : Use self.chars.[]= instead fun []=(index: Int, item: Char) is abstract + redef fun to_buffer do return clone + + #~~~nit + # var b = new Buffer + # b.append("Buffer!") + # var c = b.clone + # assert b == c + #~~~ + redef fun clone do + var cln = new Buffer.with_cap(byte_length) + cln.append self + return cln + end + # Adds a char `c` at the end of self # # DEPRECATED : Use self.chars.add instead @@ -1569,11 +1571,152 @@ abstract class Buffer # NOTE: Use only if sure about `from` and `length`, no checks # or bound recalculation is done fun append_substring_impl(s: Text, from, length: Int) do - var pos = from - for i in [0 .. length[ do - self.add s[pos] + var max = from + length + for i in [from .. max[ do add s[i] + end + + redef fun *(i) do + var ret = new Buffer.with_cap(byte_length * i) + for its in [0 .. i[ do ret.append self + return ret + end + + redef fun insert_at(s, pos) do + var obuf = new Buffer.with_cap(byte_length + s.byte_length) + obuf.append_substring(self, 0, pos) + obuf.append s + obuf.append_substring(self, pos, length - pos) + return obuf + end + + # Inserts `s` at position `pos` + # + #~~~nit + # var b = new Buffer + # b.append "美しい世界" + # b.insert(" nit ", 3) + # assert b == "美しい nit 世界" + #~~~ + fun insert(s: Text, pos: Int) is abstract + + # Inserts `c` at position `pos` + # + #~~~nit + # var b = new Buffer + # b.append "美しい世界" + # b.insert_char(' ', 3) + # assert b == "美しい 世界" + #~~~ + fun insert_char(c: Char, pos: Int) is abstract + + # Removes a substring from `self` at position `pos` + # + # NOTE: `length` defaults to 1, expressed in chars + # + #~~~nit + # var b = new Buffer + # b.append("美しい 世界") + # b.remove_at(3) + # assert b == "美しい世界" + # b.remove_at(1, 2) + # assert b == "美世界" + #~~~ + fun remove_at(pos: Int, length: nullable Int) is abstract + + redef fun reversed do + var ret = clone + ret.reverse + return ret + end + + redef fun to_upper do + var ret = clone + ret.upper + return ret + end + + redef fun to_lower do + var ret = clone + ret.lower + return ret + end + + redef fun to_snake_case do + var ret = clone + ret.snake_case + return ret + end + + # Takes a camel case `self` and converts it to snake case + # + # SEE: `to_snake_case` + fun snake_case do + if self.is_lower then return + var prev_is_lower = false + var prev_is_upper = false + + var i = 0 + while i < length do + var char = chars[i] + if char.is_lower then + prev_is_lower = true + prev_is_upper = false + else if char.is_upper then + if prev_is_lower then + insert_char('_', i) + i += 1 + else if prev_is_upper and i + 1 < length and self[i + 1].is_lower then + insert_char('_', i) + i += 1 + end + self[i] = char.to_lower + prev_is_lower = false + prev_is_upper = true + else + prev_is_lower = false + prev_is_upper = false + end + i += 1 + end + end + + redef fun to_camel_case + do + var new_str = clone + new_str.camel_case + return new_str + end + + # Takes a snake case `self` and converts it to camel case + # + # SEE: `to_camel_case` + fun camel_case do + if is_upper then return + + var underscore_count = 0 + + var pos = 1 + while pos < length do + var char = self[pos] + if char == '_' then + underscore_count += 1 + else if underscore_count > 0 then + pos -= underscore_count + remove_at(pos, underscore_count) + self[pos] = char.to_upper + underscore_count = 0 + end pos += 1 end + if underscore_count > 0 then remove_at(pos - underscore_count - 1, underscore_count) + end + + redef fun capitalized(keep_upper) do + if length == 0 then return self + + var buf = new Buffer.with_cap(byte_length) + buf.capitalize(keep_upper=keep_upper, src=self) + return buf end end @@ -1599,8 +1742,8 @@ redef class Object # User readable representation of `self`. fun to_s: String do return inspect - # The class name of the object in NativeString format. - private fun native_class_name: NativeString is intern + # The class name of the object in CString format. + private fun native_class_name: CString is intern # The class name of the object. # @@ -1636,13 +1779,13 @@ redef class Bool end redef class Byte - # C function to calculate the length of the `NativeString` to receive `self` + # C function to calculate the length of the `CString` to receive `self` private fun byte_to_s_len: Int `{ return snprintf(NULL, 0, "0x%02x", self); `} - # C function to convert an nit Int to a NativeString (char*) - private fun native_byte_to_s(nstr: NativeString, strlen: Int) `{ + # C function to convert an nit Int to a CString (char*) + private fun native_byte_to_s(nstr: CString, strlen: Int) `{ snprintf(nstr, strlen, "0x%02x", self); `} @@ -1652,7 +1795,7 @@ redef class Byte # assert (-123).to_b.to_s == "0x85" redef fun to_s do var nslen = byte_to_s_len - var ns = new NativeString(nslen + 1) + var ns = new CString(nslen + 1) ns[nslen] = 0u8 native_byte_to_s(ns, nslen + 1) return ns.to_s_unsafe(nslen) @@ -1662,7 +1805,7 @@ end redef class Int # Wrapper of strerror C function - private fun strerror_ext: NativeString `{ return strerror((int)self); `} + private fun strerror_ext: CString `{ return strerror((int)self); `} # Returns a string describing error number fun strerror: String do return strerror_ext.to_s @@ -1691,13 +1834,13 @@ redef class Int end end - # C function to calculate the length of the `NativeString` to receive `self` + # C function to calculate the length of the `CString` to receive `self` private fun int_to_s_len: Int `{ return snprintf(NULL, 0, "%ld", self); `} - # C function to convert an nit Int to a NativeString (char*) - private fun native_int_to_s(nstr: NativeString, strlen: Int) `{ + # C function to convert an nit Int to a CString (char*) + private fun native_int_to_s(nstr: CString, strlen: Int) `{ snprintf(nstr, strlen, "%ld", self); `} @@ -1842,7 +1985,7 @@ redef class Char # assert 'x'.to_s == "x" redef fun to_s do var ln = u8char_len - var ns = new NativeString(ln + 1) + var ns = new CString(ln + 1) u8char_tos(ns, ln) return ns.to_s_unsafe(ln) end @@ -1887,7 +2030,7 @@ redef class Char return buf.to_s end - private fun u8char_tos(r: NativeString, len: Int) `{ + private fun u8char_tos(r: CString, len: Int) `{ r[len] = '\0'; switch(len){ case 1: @@ -2091,7 +2234,7 @@ redef class Sys private fun native_argc: Int is intern # Second argument of the main C function. - private fun native_argv(i: Int): NativeString is intern + private fun native_argv(i: Int): CString is intern end # Comparator that efficienlty use `to_s` to compare things @@ -2151,7 +2294,7 @@ do return sys.program_args end -redef class NativeString +redef class CString # Get a `String` from the data at `self` copied into Nit memory # # Require: `self` is a null-terminated string.