1 # This file is part of NIT ( http://www.nitlanguage.org ).
3 # This file is free software, which comes along with NIT. This software is
4 # distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
5 # without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
6 # PARTICULAR PURPOSE. You can modify it is you want, provided this header
7 # is kept unaltered, and a notification of the changes is added.
8 # You are allowed to redistribute it and sell it, alone or is a part of
11 # Abstract class for manipulation of sequences of characters
17 intrude import collection
::array
25 # High-level abstraction for all text representations
29 redef type OTHER: Text
31 # Type of self (used for factorization of several methods, ex : substring_from, empty...)
34 # Gets a view on the chars of the Text object
36 # assert "hello".chars.to_a == ['h', 'e', 'l', 'l', 'o']
37 fun chars
: SequenceRead[Char] is abstract
39 # Gets a view on the bytes of the Text object
41 # assert "hello".bytes.to_a == [104u8, 101u8, 108u8, 108u8, 111u8]
42 fun bytes
: SequenceRead[Byte] is abstract
44 # Number of characters contained in self.
46 # assert "12345".length == 5
47 # assert "".length == 0
48 # assert "あいうえお".length == 5
49 fun length
: Int is abstract
51 # Number of bytes in `self`
53 # assert "12345".bytelen == 5
54 # assert "あいうえお".bytelen == 15
55 fun bytelen
: Int is abstract
59 # assert "abcd".substring(1, 2) == "bc"
60 # assert "abcd".substring(-1, 2) == "a"
61 # assert "abcd".substring(1, 0) == ""
62 # assert "abcd".substring(2, 5) == "cd"
63 # assert "あいうえお".substring(1,3) == "いうえ"
65 # A `from` index < 0 will be replaced by 0.
66 # Unless a `count` value is > 0 at the same time.
67 # In this case, `from += count` and `count -= from`.
68 fun substring
(from
: Int, count
: Int): SELFTYPE is abstract
70 # Iterates on the substrings of self if any
71 fun substrings
: Iterator[FlatText] is abstract
73 # Is the current Text empty (== "")
76 # assert not "foo".is_empty
77 fun is_empty
: Bool do return self.length
== 0
79 # Returns an empty Text of the right type
81 # This method is used internally to get the right
82 # implementation of an empty string.
83 protected fun empty
: SELFTYPE is abstract
85 # Gets the first char of the Text
87 # DEPRECATED : Use self.chars.first instead
88 fun first
: Char do return self.chars
[0]
90 # Access a character at `index` in the string.
92 # assert "abcd"[2] == 'c'
94 # DEPRECATED : Use self.chars.[] instead
95 fun [](index
: Int): Char do return self.chars
[index
]
97 # Gets the index of the first occurence of 'c'
99 # Returns -1 if not found
101 # DEPRECATED : Use self.chars.index_of instead
102 fun index_of
(c
: Char): Int
104 return index_of_from
(c
, 0)
107 # Gets the last char of self
109 # DEPRECATED : Use self.chars.last instead
110 fun last
: Char do return self.chars
[length-1
]
112 # Gets the index of the first occurence of ´c´ starting from ´pos´
114 # Returns -1 if not found
116 # DEPRECATED : Use self.chars.index_of_from instead
117 fun index_of_from
(c
: Char, pos
: Int): Int
119 var iter
= self.chars
.iterator_from
(pos
)
121 if iter
.item
== c
then return iter
.index
127 # Gets the last index of char ´c´
129 # Returns -1 if not found
131 # DEPRECATED : Use self.chars.last_index_of instead
132 fun last_index_of
(c
: Char): Int
134 return last_index_of_from
(c
, length
- 1)
137 # Return a null terminated char *
138 fun to_cstring
: NativeString is abstract
140 # The index of the last occurrence of an element starting from pos (in reverse order).
142 # var s = "/etc/bin/test/test.nit"
143 # assert s.last_index_of_from('/', s.length-1) == 13
144 # assert s.last_index_of_from('/', 12) == 8
146 # Returns -1 if not found
148 # DEPRECATED : Use self.chars.last_index_of_from instead
149 fun last_index_of_from
(item
: Char, pos
: Int): Int do return chars
.last_index_of_from
(item
, pos
)
151 # Gets an iterator on the chars of self
153 # DEPRECATED : Use self.chars.iterator instead
154 fun iterator
: Iterator[Char]
156 return self.chars
.iterator
160 # Gets an Array containing the chars of self
162 # DEPRECATED : Use self.chars.to_a instead
163 fun to_a
: Array[Char] do return chars
.to_a
165 # Create a substring from `self` beginning at the `from` position
167 # assert "abcd".substring_from(1) == "bcd"
168 # assert "abcd".substring_from(-1) == "abcd"
169 # assert "abcd".substring_from(2) == "cd"
171 # As with substring, a `from` index < 0 will be replaced by 0
172 fun substring_from
(from
: Int): SELFTYPE
174 if from
>= self.length
then return empty
175 if from
< 0 then from
= 0
176 return substring
(from
, length
- from
)
179 # Does self have a substring `str` starting from position `pos`?
181 # assert "abcd".has_substring("bc",1) == true
182 # assert "abcd".has_substring("bc",2) == false
184 # Returns true iff all characters of `str` are presents
185 # at the expected index in `self.`
186 # The first character of `str` being at `pos`, the second
187 # character being at `pos+1` and so on...
189 # This means that all characters of `str` need to be inside `self`.
191 # assert "abcd".has_substring("xab", -1) == false
192 # assert "abcd".has_substring("cdx", 2) == false
194 # And that the empty string is always a valid substring.
196 # assert "abcd".has_substring("", 2) == true
197 # assert "abcd".has_substring("", 200) == true
198 fun has_substring
(str
: String, pos
: Int): Bool
200 if str
.is_empty
then return true
201 if pos
< 0 or pos
+ str
.length
> length
then return false
202 var myiter
= self.chars
.iterator_from
(pos
)
203 var itsiter
= str
.chars
.iterator
204 while myiter
.is_ok
and itsiter
.is_ok
do
205 if myiter
.item
!= itsiter
.item
then return false
209 if itsiter
.is_ok
then return false
213 # Is this string prefixed by `prefix`?
215 # assert "abcd".has_prefix("ab") == true
216 # assert "abcbc".has_prefix("bc") == false
217 # assert "ab".has_prefix("abcd") == false
218 fun has_prefix
(prefix
: String): Bool do return has_substring
(prefix
,0)
220 # Is this string suffixed by `suffix`?
222 # assert "abcd".has_suffix("abc") == false
223 # assert "abcd".has_suffix("bcd") == true
224 fun has_suffix
(suffix
: String): Bool do return has_substring
(suffix
, length
- suffix
.length
)
226 # Returns `self` as the corresponding integer
228 # assert "123".to_i == 123
229 # assert "-1".to_i == -1
230 # assert "0x64".to_i == 100
231 # assert "0b1100_0011".to_i== 195
232 # assert "--12".to_i == 12
234 # REQUIRE: `self`.`is_int`
235 fun to_i
: Int is abstract
237 # If `self` contains a float, return the corresponding float
239 # assert "123".to_f == 123.0
240 # assert "-1".to_f == -1.0
241 # assert "-1.2e-3".to_f == -0.0012
245 return to_s
.to_cstring
.atof
248 # If `self` contains only digits and alpha <= 'f', return the corresponding integer.
250 # assert "ff".to_hex == 255
251 fun to_hex
: Int do return a_to
(16)
253 # If `self` contains only digits <= '7', return the corresponding integer.
255 # assert "714".to_oct == 460
256 fun to_oct
: Int do return a_to
(8)
258 # If `self` contains only '0' et '1', return the corresponding integer.
260 # assert "101101".to_bin == 45
261 fun to_bin
: Int do return a_to
(2)
263 # If `self` contains only digits '0' .. '9', return the corresponding integer.
265 # assert "108".to_dec == 108
266 fun to_dec
: Int do return a_to
(10)
268 # If `self` contains only digits and letters, return the corresponding integer in a given base
270 # assert "120".a_to(3) == 15
271 fun a_to
(base
: Int) : Int
276 for j
in [0..length
[ do
298 # Returns `true` if the string contains only Numeric values (and one "," or one "." character)
300 # assert "123".is_numeric == true
301 # assert "1.2".is_numeric == true
302 # assert "1,2".is_numeric == true
303 # assert "1..2".is_numeric == false
306 var has_point_or_comma
= false
307 for i
in [0..length
[ do
309 if not c
.is_numeric
then
310 if (c
== '.' or c
== ',') and not has_point_or_comma
then
311 has_point_or_comma
= true
320 # Returns `true` if the string contains only Hex chars
322 # assert "048bf".is_hex == true
323 # assert "ABCDEF".is_hex == true
324 # assert "0G".is_hex == false
327 for i
in [0..length
[ do
329 if not (c
>= 'a' and c
<= 'f') and
330 not (c
>= 'A' and c
<= 'F') and
331 not (c
>= '0' and c
<= '9') then return false
336 # Returns `true` if the string contains only Binary digits
338 # assert "1101100".is_bin == true
339 # assert "1101020".is_bin == false
341 for i
in chars
do if i
!= '0' and i
!= '1' then return false
345 # Returns `true` if the string contains only Octal digits
347 # assert "213453".is_oct == true
348 # assert "781".is_oct == false
350 for i
in chars
do if i
< '0' or i
> '7' then return false
354 # Returns `true` if the string contains only Decimal digits
356 # assert "10839".is_dec == true
357 # assert "164F".is_dec == false
359 for i
in chars
do if i
< '0' or i
> '9' then return false
363 # Are all letters in `self` upper-case ?
365 # assert "HELLO WORLD".is_upper == true
366 # assert "%$&%!".is_upper == true
367 # assert "hello world".is_upper == false
368 # assert "Hello World".is_upper == false
371 for i
in [0..length
[ do
373 if char
.is_lower
then return false
378 # Are all letters in `self` lower-case ?
380 # assert "hello world".is_lower == true
381 # assert "%$&%!".is_lower == true
382 # assert "Hello World".is_lower == false
385 for i
in [0..length
[ do
387 if char
.is_upper
then return false
392 # Removes the whitespaces at the beginning of self
394 # assert " \n\thello \n\t".l_trim == "hello \n\t"
396 # `Char::is_whitespace` determines what is a whitespace.
399 var iter
= self.chars
.iterator
401 if not iter
.item
.is_whitespace
then break
404 if iter
.index
== length
then return self.empty
405 return self.substring_from
(iter
.index
)
408 # Removes the whitespaces at the end of self
410 # assert " \n\thello \n\t".r_trim == " \n\thello"
412 # `Char::is_whitespace` determines what is a whitespace.
415 var iter
= self.chars
.reverse_iterator
417 if not iter
.item
.is_whitespace
then break
420 if iter
.index
< 0 then return self.empty
421 return self.substring
(0, iter
.index
+ 1)
424 # Trims trailing and preceding white spaces
426 # assert " Hello World ! ".trim == "Hello World !"
427 # assert "\na\nb\tc\t".trim == "a\nb\tc"
429 # `Char::is_whitespace` determines what is a whitespace.
430 fun trim
: SELFTYPE do return (self.l_trim
).r_trim
432 # Is the string non-empty but only made of whitespaces?
434 # assert " \n\t ".is_whitespace == true
435 # assert " hello ".is_whitespace == false
436 # assert "".is_whitespace == false
438 # `Char::is_whitespace` determines what is a whitespace.
439 fun is_whitespace
: Bool
441 if is_empty
then return false
442 for c
in self.chars
do
443 if not c
.is_whitespace
then return false
448 # Returns `self` removed from its last line terminator (if any).
450 # assert "Hello\n".chomp == "Hello"
451 # assert "Hello".chomp == "Hello"
453 # assert "\n".chomp == ""
454 # assert "".chomp == ""
456 # Line terminators are `"\n"`, `"\r\n"` and `"\r"`.
457 # A single line terminator, the last one, is removed.
459 # assert "\r\n".chomp == ""
460 # assert "\r\n\n".chomp == "\r\n"
461 # assert "\r\n\r\n".chomp == "\r\n"
462 # assert "\r\n\r".chomp == "\r\n"
464 # Note: unlike with most IO methods like `Reader::read_line`,
465 # a single `\r` is considered here to be a line terminator and will be removed.
469 if len
== 0 then return self
470 var l
= self.chars
.last
472 return substring
(0, len-1
)
473 else if l
!= '\n' then
475 else if len
> 1 and self.chars
[len-2
] == '\r' then
476 return substring
(0, len-2
)
478 return substring
(0, len-1
)
482 # Justify a self in a space of `length`
484 # `left` is the space ratio on the left side.
485 # * 0.0 for left-justified (no space at the left)
486 # * 1.0 for right-justified (all spaces at the left)
487 # * 0.5 for centered (half the spaces at the left)
491 # assert "hello".justify(10, 0.0) == "hello "
492 # assert "hello".justify(10, 1.0) == " hello"
493 # assert "hello".justify(10, 0.5) == " hello "
495 # If `length` is not enough, `self` is returned as is.
497 # assert "hello".justify(2, 0.0) == "hello"
499 # REQUIRE: `left >= 0.0 and left <= 1.0`
500 # ENSURE: `self.length <= length implies result.length == length`
501 # ENSURE: `self.length >= length implies result == self`
502 fun justify
(length
: Int, left
: Float): String
504 var diff
= length
- self.length
505 if diff
<= 0 then return to_s
506 assert left
>= 0.0 and left
<= 1.0
507 var before
= (diff
.to_f
* left
).to_i
508 return " " * before
+ self + " " * (diff-before
)
511 # Mangle a string to be a unique string only made of alphanumeric characters and underscores.
513 # This method is injective (two different inputs never produce the same
514 # output) and the returned string always respect the following rules:
516 # * Contains only US-ASCII letters, digits and underscores.
517 # * Never starts with a digit.
518 # * Never ends with an underscore.
519 # * Never contains two contiguous underscores.
521 # assert "42_is/The answer!".to_cmangle == "_52d2_is_47dThe_32danswer_33d"
522 # assert "__".to_cmangle == "_95d_95d"
523 # assert "__d".to_cmangle == "_95d_d"
524 # assert "_d_".to_cmangle == "_d_95d"
525 # assert "_42".to_cmangle == "_95d42"
526 # assert "foo".to_cmangle == "foo"
527 # assert "".to_cmangle == ""
528 fun to_cmangle
: String
530 if is_empty
then return ""
532 var underscore
= false
536 if c
>= '0' and c
<= '9' then
538 res
.append
(c
.code_point
.to_s
)
542 for i
in [start
..length
[ do
544 if (c
>= 'a' and c
<= 'z') or (c
>='A' and c
<= 'Z') then
550 res
.append
('_'.code_point
.to_s
)
553 if c
>= '0' and c
<= '9' then
556 else if c
== '_' then
561 res
.append
(c
.code_point
.to_s
)
567 res
.append
('_'.code_point
.to_s
)
573 # Escape " \ ' and non printable characters using the rules of literal C strings and characters
575 # assert "abAB12<>&".escape_to_c == "abAB12<>&"
576 # assert "\n\"'\\".escape_to_c == "\\n\\\"\\'\\\\"
578 # Most non-printable characters (bellow ASCII 32) are escaped to an octal form `\nnn`.
579 # Three digits are always used to avoid following digits to be interpreted as an element
580 # of the octal sequence.
582 # assert "{0.code_point}{1.code_point}{8.code_point}{31.code_point}{32.code_point}".escape_to_c == "\\000\\001\\010\\037 "
584 # The exceptions are the common `\t` and `\n`.
585 fun escape_to_c
: String
588 for i
in [0..length
[ do
592 else if c
== '\t' then
594 else if c
== '"' then
596 else if c == '\'' then
598 else if c == '\\
' then
600 else if c.code_point < 32 then
602 var oct = c.code_point.to_base(8, false)
603 # Force 3 octal digits since it is the
604 # maximum allowed in the C specification
605 if oct.length == 1 then
608 else if oct.length == 2 then
619 # Escape additionnal characters
620 # The result might no be legal in C but be used in other languages
622 # assert "ab|\{\}".escape_more_to_c("|\{\}") == "ab\\|\\\{\\\}"
623 fun escape_more_to_c(chars: String): String
626 for c in escape_to_c.chars do
627 if chars.chars.has(c) then
635 # Escape to C plus braces
637 # assert "\n\"'\\\
{\}".escape_to_nit == "\\n\\\
"\\'\\\\\\\{\\\}"
638 fun escape_to_nit
: String do return escape_more_to_c
("\{\}")
640 # Escape to POSIX Shell (sh).
642 # Abort if the text contains a null byte.
644 # assert "\n\"'\\\{\}0".escape_to_sh == "'\n\"'\\''\\\{\}0'"
645 fun escape_to_sh
: String do
648 for i in [0..length[ do
653 assert without_null_byte
: c
!= '\0'
661 # Escape to include in a Makefile
663 # Unfortunately, some characters are not escapable in Makefile.
664 # These characters are `;`, `|`, `\`, and the non-printable ones.
665 # They will be rendered as `"?{hex}"`.
666 fun escape_to_mk: String do
668 for i in [0..length[ do
672 else if c == ':' or c == ' ' or c == '#' then
675 else if c
.code_point
< 32 or c
== ';' or c
== '|' or c
== '\\' or c
== '=' then
676 b
.append
("?{c.code_point.to_base(16, false)}")
684 # Return a string where Nit escape sequences are transformed.
687 # assert s.length == 2
688 # var u = s.unescape_nit
689 # assert u.length == 1
690 # assert u.chars[0].code_point == 10 # (the ASCII value of the "new line" character)
691 fun unescape_nit
: String
693 var res
= new Buffer.with_cap
(self.length
)
694 var was_slash
= false
695 for i
in [0..length
[ do
697 if not was_slash
then
708 else if c
== 'r' then
710 else if c
== 't' then
712 else if c
== '0' then
721 # Encode `self` to percent (or URL) encoding
723 # assert "aBc09-._~".to_percent_encoding == "aBc09-._~"
724 # assert "%()< >".to_percent_encoding == "%25%28%29%3c%20%3e"
725 # assert ".com/post?e=asdf&f=123".to_percent_encoding == ".com%2fpost%3fe%3dasdf%26f%3d123"
726 # assert "éあいう".to_percent_encoding == "%c3%a9%e3%81%82%e3%81%84%e3%81%86"
727 fun to_percent_encoding
: String
731 for i
in [0..length
[ do
733 if (c
>= '0' and c
<= '9') or
734 (c
>= 'a' and c
<= 'z') or
735 (c
>= 'A' and c
<= 'Z') or
736 c
== '-' or c
== '.' or
741 var bytes
= c
.to_s
.bytes
742 for b
in bytes
do buf
.append
"%{b.to_i.to_hex}"
749 # Decode `self` from percent (or URL) encoding to a clear string
751 # Replace invalid use of '%' with '?'.
753 # assert "aBc09-._~".from_percent_encoding == "aBc09-._~"
754 # assert "%25%28%29%3c%20%3e".from_percent_encoding == "%()< >"
755 # assert ".com%2fpost%3fe%3dasdf%26f%3d123".from_percent_encoding == ".com/post?e=asdf&f=123"
756 # assert "%25%28%29%3C%20%3E".from_percent_encoding == "%()< >"
757 # assert "incomplete %".from_percent_encoding == "incomplete ?"
758 # assert "invalid % usage".from_percent_encoding == "invalid ? usage"
759 # assert "%c3%a9%e3%81%82%e3%81%84%e3%81%86".from_percent_encoding == "éあいう"
760 fun from_percent_encoding
: String
763 var has_percent
= false
771 # If no transformation is needed, return self as a string
772 if not has_percent
then return to_s
774 var buf
= new NativeString(len
)
780 if i
+ 2 >= length
then
781 # What follows % has been cut off
785 var hex_s
= substring
(i
, 2)
787 var hex_i
= hex_s
.to_hex
791 # What follows a % is not Hex
796 else buf
[l
] = c
.ascii
802 return buf
.to_s_with_length
(l
)
805 # Escape the characters `<`, `>`, `&`, `"`, `'` and `/` as HTML/XML entity references.
807 # assert "a&b-<>\"x\"/'".html_escape == "a&b-<>"x"/'"
809 # SEE: <https://www.owasp.org/index.php/XSS_%28Cross_Site_Scripting%29_Prevention_Cheat_Sheet#RULE_.231_-_HTML_Escape_Before_Inserting_Untrusted_Data_into_HTML_Element_Content>
810 fun html_escape
: String
814 for i
in [0..length
[ do
818 else if c
== '<' then
820 else if c
== '>' then
822 else if c
== '"' then
824 else if c
== '\'' then
826 else if c == '/' then
835 # Two pieces of text are equals if thez have the same characters in the same order.
837 # assert "hello" == "hello"
838 # assert "hello" != "HELLO"
839 # assert "hello" == "hel"+"lo"
841 # Things that are not Text are not equal.
844 # assert "9" != ['9']
847 # assert "9".chars.first == '9' # equality of Char
848 # assert "9".chars == ['9'] # equality of Sequence
849 # assert "9".to_i == 9 # equality of Int
852 if o == null then return false
853 if not o isa Text then return false
854 if self.is_same_instance(o) then return true
855 if self.length != o.length then return false
856 return self.chars == o.chars
859 # Lexicographical comparaison
861 # assert "abc" < "xy"
862 # assert "ABC" < "abc"
865 var self_chars = self.chars.iterator
866 var other_chars = other.chars.iterator
868 while self_chars.is_ok and other_chars.is_ok do
869 if self_chars.item < other_chars.item then return true
870 if self_chars.item > other_chars.item then return false
875 if self_chars.is_ok then
882 # Escape string used in labels for graphviz
884 # assert ">><<".escape_to_dot == "\\>\\>\\<\\<"
885 fun escape_to_dot: String
887 return escape_more_to_c("|\{\}<>")
890 private var hash_cache: nullable Int = null
894 if hash_cache == null then
895 # djb2 hash algorithm
898 for i in [0..length[ do
900 h = (h << 5) + h + char.code_point
905 return hash_cache.as(not null)
908 # Gives the formatted string back as a Nit string with `args` in place
910 # assert "This %1 is a %2.".format("String", "formatted String") == "This String is a formatted String."
911 # assert "\\%1 This string".format("String") == "\\%1 This string"
912 fun format(args: Object...): String do
913 var s = new Array[Text]
917 # Skip escaped characters
918 if self[i] == '\\
' then
921 else if self[i] == '%' then
925 while i < length and self[i].is_numeric do
930 var ciph_len = fmt_end - ciph_st + 1
932 var arg_index = substring(ciph_st, ciph_len).to_i - 1
933 if arg_index >= args.length then continue
935 s.push substring(curr_st, fmt_st - curr_st)
936 s.push args[arg_index].to_s
941 s.push substring(curr_st, length - curr_st)
945 # Copies `n` bytes from `self` at `src_offset` into `dest` starting at `dest_offset`
947 # Basically a high-level synonym of NativeString::copy_to
949 # REQUIRE: `n` must be large enough to contain `len` bytes
951 # var ns = new NativeString(8)
952 # "Text is String".copy_to_native(ns, 8, 2, 0)
953 # assert ns.to_s_with_length(8) == "xt is St"
955 fun copy_to_native(dest: NativeString, n, src_offset, dest_offset: Int) do
956 var mypos = src_offset
957 var itspos = dest_offset
959 dest[itspos] = self.bytes[mypos]
968 # All kinds of array-based text representations.
969 abstract class FlatText
972 # Underlying C-String (`char*`)
974 # Warning : Might be void in some subclasses, be sure to check
975 # if set before using it.
976 private var items: NativeString is noinit
978 # Real items, used as cache for to_cstring is called
979 private var real_items: nullable NativeString = null
981 # Returns a char* starting at position `first_byte`
983 # WARNING: If you choose to use this service, be careful of the following.
985 # Strings and NativeString are *ideally* always allocated through a Garbage Collector.
986 # Since the GC tracks the use of the pointer for the beginning of the char*, it may be
987 # deallocated at any moment, rendering the pointer returned by this function invalid.
988 # Any access to freed memory may very likely cause undefined behaviour or a crash.
989 # (Failure to do so will most certainly result in long and painful debugging hours)
991 # The only safe use of this pointer is if it is ephemeral (e.g. read in a C function
992 # then immediately return).
994 # As always, do not modify the content of the String in C code, if this is what you want
995 # copy locally the char* as Nit Strings are immutable.
996 private fun fast_cstring: NativeString is abstract
1000 redef var bytelen = 0
1011 redef fun copy_to_native(dest, n, src_offset, dest_offset) do
1012 items.copy_to(dest, n, src_offset, dest_offset)
1016 # Abstract class for the SequenceRead compatible
1017 # views on the chars of any Text
1018 private abstract class StringCharView
1019 super SequenceRead[Char]
1023 var target: SELFTYPE
1025 redef fun is_empty do return target.is_empty
1027 redef fun length do return target.length
1029 redef fun iterator: IndexedIterator[Char] do return self.iterator_from(0)
1031 redef fun reverse_iterator do return self.reverse_iterator_from(self.length - 1)
1034 # Abstract class for the SequenceRead compatible
1035 # views on the bytes of any Text
1036 private abstract class StringByteView
1037 super SequenceRead[Byte]
1041 var target: SELFTYPE
1043 redef fun is_empty do return target.is_empty
1045 redef fun length do return target.bytelen
1047 redef fun iterator do return self.iterator_from(0)
1049 redef fun reverse_iterator do return self.reverse_iterator_from(target.bytelen - 1)
1052 # Immutable sequence of characters.
1054 # String objects may be created using literals.
1056 # assert "Hello World!" isa String
1057 abstract class String
1060 redef type SELFTYPE: String is fixed
1062 redef fun to_s do return self
1064 # Concatenates `o` to `self`
1066 # assert "hello" + "world" == "helloworld"
1067 # assert "" + "hello" + "" == "hello"
1068 fun +(o: Text): SELFTYPE is abstract
1070 # Concatenates self `i` times
1072 # assert "abc" * 4 == "abcabcabcabc"
1073 # assert "abc" * 1 == "abc"
1074 # assert "abc" * 0 == ""
1075 fun *(i: Int): SELFTYPE is abstract
1077 # Insert `s` at `pos`.
1079 # assert "helloworld".insert_at(" ", 5) == "hello world"
1080 fun insert_at(s: String, pos: Int): SELFTYPE is abstract
1082 redef fun substrings is abstract
1084 # Returns a reversed version of self
1086 # assert "hello".reversed == "olleh"
1087 # assert "bob".reversed == "bob"
1088 # assert "".reversed == ""
1089 fun reversed: SELFTYPE is abstract
1091 # A upper case version of `self`
1093 # assert "Hello World!".to_upper == "HELLO WORLD!"
1094 fun to_upper: SELFTYPE is abstract
1096 # A lower case version of `self`
1098 # assert "Hello World!".to_lower == "hello world!"
1099 fun to_lower : SELFTYPE is abstract
1101 # Takes a camel case `self` and converts it to snake case
1103 # assert "randomMethodId".to_snake_case == "random_method_id"
1105 # The rules are the following:
1107 # An uppercase is always converted to a lowercase
1109 # assert "HELLO_WORLD".to_snake_case == "hello_world"
1111 # An uppercase that follows a lowercase is prefixed with an underscore
1113 # assert "HelloTheWORLD".to_snake_case == "hello_the_world"
1115 # An uppercase that follows an uppercase and is followed by a lowercase, is prefixed with an underscore
1117 # assert "HelloTHEWorld".to_snake_case == "hello_the_world"
1119 # All other characters are kept as is; `self` does not need to be a proper CamelCased string.
1121 # assert "=-_H3ll0Th3W0rld_-=".to_snake_case == "=-_h3ll0th3w0rld_-="
1122 fun to_snake_case: SELFTYPE
1124 if self.is_lower then return self
1126 var new_str = new Buffer.with_cap(self.length)
1127 var prev_is_lower = false
1128 var prev_is_upper = false
1130 for i in [0..length[ do
1132 if char.is_lower then
1134 prev_is_lower = true
1135 prev_is_upper = false
1136 else if char.is_upper then
1137 if prev_is_lower then
1139 else if prev_is_upper and i+1 < length and chars[i+1].is_lower then
1142 new_str.add(char.to_lower)
1143 prev_is_lower = false
1144 prev_is_upper = true
1147 prev_is_lower = false
1148 prev_is_upper = false
1155 # Takes a snake case `self` and converts it to camel case
1157 # assert "random_method_id".to_camel_case == "randomMethodId"
1159 # If the identifier is prefixed by an underscore, the underscore is ignored
1161 # assert "_private_field".to_camel_case == "_privateField"
1163 # If `self` is upper, it is returned unchanged
1165 # assert "RANDOM_ID".to_camel_case == "RANDOM_ID"
1167 # If there are several consecutive underscores, they are considered as a single one
1169 # assert "random__method_id".to_camel_case == "randomMethodId"
1170 fun to_camel_case: SELFTYPE
1172 if self.is_upper then return self
1174 var new_str = new Buffer
1175 var is_first_char = true
1176 var follows_us = false
1178 for i in [0..length[ do
1180 if is_first_char then
1182 is_first_char = false
1183 else if char == '_
' then
1185 else if follows_us then
1186 new_str.add(char.to_upper)
1196 # Returns a capitalized `self`
1198 # Letters that follow a letter are lowercased
1199 # Letters that follow a non-letter are upcased.
1201 # SEE : `Char::is_letter` for the definition of letter.
1203 # assert "jAVASCRIPT".capitalized == "Javascript"
1204 # assert "i am root".capitalized == "I Am Root"
1205 # assert "ab_c -ab0c ab\nc".capitalized == "Ab_C -Ab0C Ab\nC"
1206 fun capitalized: SELFTYPE do
1207 if length == 0 then return self
1209 var buf = new Buffer.with_cap(length)
1211 var curr = chars[0].to_upper
1215 for i in [1 .. length[ do
1218 if prev.is_letter then
1219 buf[i] = curr.to_lower
1221 buf[i] = curr.to_upper
1229 # A mutable sequence of characters.
1230 abstract class Buffer
1233 # Returns an arbitrary subclass of `Buffer` with default parameters
1236 # Returns an instance of a subclass of `Buffer` with `i` base capacity
1237 new with_cap(i: Int) is abstract
1239 redef type SELFTYPE: Buffer is fixed
1241 # Specific implementations MUST set this to `true` in order to invalidate caches
1242 protected var is_dirty = true
1244 # Copy-On-Write flag
1246 # If the `Buffer` was to_s'd
, the next in-place altering
1247 # operation will cause the current `Buffer` to be re-allocated.
1249 # The flag will then be set at `false`.
1250 protected var written
= false
1252 # Modifies the char contained at pos `index`
1254 # DEPRECATED : Use self.chars.[]= instead
1255 fun []=(index
: Int, item
: Char) is abstract
1257 # Adds a char `c` at the end of self
1259 # DEPRECATED : Use self.chars.add instead
1260 fun add
(c
: Char) is abstract
1264 # var b = new Buffer
1266 # assert not b.is_empty
1269 fun clear
is abstract
1271 # Enlarges the subsequent array containing the chars of self
1272 fun enlarge
(cap
: Int) is abstract
1274 # Adds the content of text `s` at the end of self
1276 # var b = new Buffer
1279 # assert b == "helloworld"
1280 fun append
(s
: Text) is abstract
1282 # `self` is appended in such a way that `self` is repeated `r` times
1284 # var b = new Buffer
1287 # assert b == "hellohellohello"
1288 fun times
(r
: Int) is abstract
1290 # Reverses itself in-place
1292 # var b = new Buffer
1295 # assert b == "olleh"
1296 fun reverse
is abstract
1298 # Changes each lower-case char in `self` by its upper-case variant
1300 # var b = new Buffer
1301 # b.append("Hello World!")
1303 # assert b == "HELLO WORLD!"
1304 fun upper
is abstract
1306 # Changes each upper-case char in `self` by its lower-case variant
1308 # var b = new Buffer
1309 # b.append("Hello World!")
1311 # assert b == "hello world!"
1312 fun lower
is abstract
1314 # Capitalizes each word in `self`
1316 # Letters that follow a letter are lowercased
1317 # Letters that follow a non-letter are upcased.
1319 # SEE: `Char::is_letter` for the definition of a letter.
1321 # var b = new FlatBuffer.from("jAVAsCriPt")
1323 # assert b == "Javascript"
1324 # b = new FlatBuffer.from("i am root")
1326 # assert b == "I Am Root"
1327 # b = new FlatBuffer.from("ab_c -ab0c ab\nc")
1329 # assert b == "Ab_C -Ab0C Ab\nC"
1331 if length
== 0 then return
1332 var c
= self[0].to_upper
1335 for i
in [1 .. length
[ do
1338 if prev
.is_letter
then
1339 self[i
] = c
.to_lower
1341 self[i
] = c
.to_upper
1348 if is_dirty
then hash_cache
= null
1352 # In Buffers, the internal sequence of character is mutable
1353 # Thus, `chars` can be used to modify the buffer.
1354 redef fun chars
: Sequence[Char] is abstract
1357 # View for chars on Buffer objects, extends Sequence
1358 # for mutation operations
1359 private abstract class BufferCharView
1360 super StringCharView
1361 super Sequence[Char]
1363 redef type SELFTYPE: Buffer
1367 # View for bytes on Buffer objects, extends Sequence
1368 # for mutation operations
1369 private abstract class BufferByteView
1370 super StringByteView
1372 redef type SELFTYPE: Buffer
1376 # User readable representation of `self`.
1377 fun to_s
: String do return inspect
1379 # The class name of the object in NativeString format.
1380 private fun native_class_name
: NativeString is intern
1382 # The class name of the object.
1384 # assert 5.class_name == "Int"
1385 fun class_name
: String do return native_class_name
.to_s
1387 # Developer readable representation of `self`.
1388 # Usually, it uses the form "<CLASSNAME:#OBJECTID bla bla bla>"
1391 return "<{inspect_head}>"
1394 # Return "CLASSNAME:#OBJECTID".
1395 # This function is mainly used with the redefinition of the inspect method
1396 protected fun inspect_head
: String
1398 return "{class_name}:#{object_id.to_hex}"
1403 # assert true.to_s == "true"
1404 # assert false.to_s == "false"
1416 # C function to calculate the length of the `NativeString` to receive `self`
1417 private fun byte_to_s_len
: Int `{
1418 return snprintf(NULL, 0, "0x%02x", self);
1421 # C function to convert an nit Int to a NativeString (char*)
1422 private fun native_byte_to_s
(nstr
: NativeString, strlen
: Int) `{
1423 snprintf(nstr, strlen, "0x%02x", self);
1426 # Displayable byte in its hexadecimal form (0x..)
1428 # assert 1.to_b.to_s == "0x01"
1429 # assert (-123).to_b.to_s == "0x85"
1431 var nslen
= byte_to_s_len
1432 var ns
= new NativeString(nslen
+ 1)
1434 native_byte_to_s
(ns
, nslen
+ 1)
1435 return ns
.to_s_with_length
(nslen
)
1441 # Wrapper of strerror C function
1442 private fun strerror_ext
: NativeString `{ return strerror(self); `}
1444 # Returns a string describing error number
1445 fun strerror: String do return strerror_ext.to_s
1447 # Fill `s
` with the digits in base `base
` of `self` (and with the '-' sign if 'signed' and negative).
1448 # assume < to_c max const of char
1449 private fun fill_buffer(s: Buffer, base: Int, signed: Bool)
1456 else if self == 0 then
1463 var pos = digit_count(base) - 1
1464 while pos >= 0 and n > 0 do
1465 s.chars[pos] = (n % base).to_c
1471 # C function to calculate the length of the `NativeString` to receive `self`
1472 private fun int_to_s_len: Int `{
1473 return snprintf
(NULL, 0, "%ld", self);
1476 # C function to convert an nit Int to a NativeString (char*)
1477 private fun native_int_to_s(nstr: NativeString, strlen: Int) `{
1478 snprintf
(nstr
, strlen
, "%ld", self);
1481 # return displayable int in base base and signed
1482 fun to_base(base: Int, signed: Bool): String is abstract
1484 # return displayable int in hexadecimal
1486 # assert 1.to_hex == "1"
1487 # assert (-255).to_hex == "-ff"
1488 fun to_hex: String do return to_base(16,false)
1492 # Pretty representation of `self`, with decimals as needed from 1 to a maximum of 3
1494 # assert 12.34.to_s == "12.34"
1495 # assert (-0120.030).to_s == "-120.03"
1497 # see `to_precision
` for a custom precision.
1499 var str = to_precision( 3 )
1500 if is_inf != 0 or is_nan then return str
1501 var len = str.length
1502 for i in [0..len-1] do
1504 var c = str.chars[j]
1507 else if c == '.' then
1508 return str.substring( 0, j+2 )
1510 return str.substring( 0, j+1 )
1516 # `String` representation of `self` with the given number of `decimals
`
1518 # assert 12.345.to_precision(0) == "12"
1519 # assert 12.345.to_precision(3) == "12.345"
1520 # assert (-12.345).to_precision(3) == "-12.345"
1521 # assert (-0.123).to_precision(3) == "-0.123"
1522 # assert 0.999.to_precision(2) == "1.00"
1523 # assert 0.999.to_precision(4) == "0.9990"
1524 fun to_precision(decimals: Int): String
1526 if is_nan then return "nan"
1528 var isinf = self.is_inf
1531 else if isinf == -1 then
1535 if decimals == 0 then return self.to_i.to_s
1537 for i in [0..decimals[ do f = f * 10.0
1544 if i == 0 then return "0." + "0"*decimals
1546 # Prepare both parts of the float, before and after the "."
1551 if sl > decimals then
1552 # Has something before the "."
1553 p1 = s.substring(0, sl-decimals)
1554 p2 = s.substring(sl-decimals, decimals)
1557 p2 = "0"*(decimals-sl) + s
1560 if i < 0 then p1 = "-" + p1
1562 return p1 + "." + p2
1568 # Returns a sequence with the UTF-8 bytes of `self`
1570 # assert 'a'.bytes == [0x61u8]
1571 # assert 'ま'.bytes == [0xE3u8, 0x81u8, 0xBEu8]
1572 fun bytes: SequenceRead[Byte] do return to_s.bytes
1574 # Length of `self` in a UTF-8 String
1575 private fun u8char_len: Int do
1576 var c = self.code_point
1577 if c < 0x80 then return 1
1578 if c <= 0x7FF then return 2
1579 if c <= 0xFFFF then return 3
1580 if c <= 0x10FFFF then return 4
1581 # Bad character format
1585 # assert 'x'.to_s == "x"
1588 var ns = new NativeString(ln + 1)
1590 return ns.to_s_with_length(ln)
1593 private fun u8char_tos(r: NativeString, len: Int) `{
1600 r
[0] = 0xC0 | ((self & 0x7C0) >> 6);
1601 r
[1] = 0x80 | (self & 0x3F);
1604 r
[0] = 0xE0 | ((self & 0xF000) >> 12);
1605 r
[1] = 0x80 | ((self & 0xFC0) >> 6);
1606 r
[2] = 0x80 | (self & 0x3F);
1609 r
[0] = 0xF0 | ((self & 0x1C0000) >> 18);
1610 r
[1] = 0x80 | ((self & 0x3F000) >> 12);
1611 r
[2] = 0x80 | ((self & 0xFC0) >> 6);
1612 r
[3] = 0x80 | (self & 0x3F);
1617 # Returns true if the char is a numerical digit
1619 # assert '0'.is_numeric
1620 # assert '9'.is_numeric
1621 # assert not 'a'.is_numeric
1622 # assert not '?'.is_numeric
1624 # FIXME: Works on ASCII-range only
1625 fun is_numeric: Bool
1627 return self >= '0' and self <= '9'
1630 # Returns true if the char is an alpha digit
1632 # assert 'a'.is_alpha
1633 # assert 'Z'.is_alpha
1634 # assert not '0'.is_alpha
1635 # assert not '?'.is_alpha
1637 # FIXME: Works on ASCII-range only
1640 return (self >= 'a' and self <= 'z') or (self >= 'A' and self <= 'Z')
1643 # Returns true if the char is an alpha or a numeric digit
1645 # assert 'a'.is_alphanumeric
1646 # assert 'Z'.is_alphanumeric
1647 # assert '0'.is_alphanumeric
1648 # assert '9'.is_alphanumeric
1649 # assert not '?'.is_alphanumeric
1651 # FIXME: Works on ASCII-range only
1652 fun is_alphanumeric: Bool
1654 return self.is_numeric or self.is_alpha
1658 redef class Collection[E]
1659 # String representation of the content of the collection.
1661 # The standard representation is the list of elements separated with commas.
1664 # assert [1,2,3].to_s == "[1,2,3]"
1665 # assert [1..3].to_s == "[1,2,3]"
1666 # assert (new Array[Int]).to_s == "[]" # empty collection
1669 # Subclasses may return a more specific string representation.
1672 return "[" + join(",") + "]"
1675 # Concatenate elements without separators
1678 # assert [1,2,3].plain_to_s == "123"
1679 # assert [11..13].plain_to_s == "111213"
1680 # assert (new Array[Int]).plain_to_s == "" # empty collection
1682 fun plain_to_s: String
1685 for e in self do if e != null then s.append(e.to_s)
1689 # Concatenate and separate each elements with `separator
`.
1691 # Only concatenate if `separator
== null`.
1693 # assert [1, 2, 3].join(":") == "1:2:3"
1694 # assert [1..3].join(":") == "1:2:3"
1695 # assert [1..3].join == "123"
1696 fun join(separator: nullable Text): String
1698 if is_empty then return ""
1700 var s = new Buffer # Result
1705 if e != null then s.append(e.to_s)
1707 # Concat other items
1710 if separator != null then s.append(separator)
1712 if e != null then s.append(e.to_s)
1719 redef class Map[K,V]
1720 # Concatenate couples of key value.
1721 # Key and value are separated by `couple_sep
`.
1722 # Couples are separated by `sep
`.
1724 # var m = new HashMap[Int, String]
1727 # assert m.join("; ", "=") == "1=one; 10=ten"
1728 fun join(sep, couple_sep: String): String is abstract
1732 private var args_cache: nullable Sequence[String] = null
1734 # The arguments of the program as given by the OS
1735 fun program_args: Sequence[String]
1737 if _args_cache == null then init_args
1738 return _args_cache.as(not null)
1741 # The name of the program as given by the OS
1742 fun program_name: String
1744 return native_argv(0).to_s
1747 # Initialize `program_args
` with the contents of `native_argc
` and `native_argv
`.
1748 private fun init_args
1750 var argc = native_argc
1751 var args = new Array[String].with_capacity(0)
1754 args[i-1] = native_argv(i).to_s
1760 # First argument of the main C function.
1761 private fun native_argc: Int is intern
1763 # Second argument of the main C function.
1764 private fun native_argv(i: Int): NativeString is intern
1767 # Comparator that efficienlty use `to_s
` to compare things
1769 # The comparaison call `to_s
` on object and use the result to order things.
1771 # var a = [1, 2, 3, 10, 20]
1772 # (new CachedAlphaComparator).sort(a)
1773 # assert a == [1, 10, 2, 20, 3]
1775 # Internally the result of `to_s
` is cached in a HashMap to counter
1776 # uneficient implementation of `to_s
`.
1778 # Note: it caching is not usefull, see `alpha_comparator
`
1779 class CachedAlphaComparator
1781 redef type COMPARED: Object
1783 private var cache = new HashMap[Object, String]
1785 private fun do_to_s(a: Object): String do
1786 if cache.has_key(a) then return cache[a]
1792 redef fun compare(a, b) do
1793 return do_to_s(a) <=> do_to_s(b)
1797 # see `alpha_comparator
`
1798 private class AlphaComparator
1800 redef fun compare(a, b) do return a.to_s <=> b.to_s
1803 # Stateless comparator that naively use `to_s
` to compare things.
1805 # Note: the result of `to_s
` is not cached, thus can be invoked a lot
1806 # on a single instace. See `CachedAlphaComparator` as an alternative.
1808 # var a = [1, 2, 3, 10, 20]
1809 # alpha_comparator.sort(a)
1810 # assert a == [1, 10, 2, 20, 3]
1811 fun alpha_comparator: Comparator do return once new AlphaComparator
1813 # The arguments of the program as given by the OS
1814 fun args: Sequence[String]
1816 return sys.program_args
1819 redef class NativeString
1820 # Returns `self` as a new String.
1821 fun to_s_with_copy: String is abstract
1823 # Returns `self` as a String of `length
`.
1824 fun to_s_with_length(length: Int): String is abstract
1826 # Returns `self` as a String with `bytelen
` and `length
` set
1828 # SEE: `abstract_text
::Text` for more infos on the difference
1829 # between `Text::bytelen
` and `Text::length
`
1830 fun to_s_full(bytelen, unilen: Int): String is abstract
1833 redef class NativeArray[E]
1834 # Join all the elements using `to_s
`
1836 # REQUIRE: `self isa NativeArray[String]`
1837 # REQUIRE: all elements are initialized
1838 fun native_to_s: String is abstract