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
151 var iter
= self.chars
.reverse_iterator_from
(pos
)
153 if iter
.item
== item
then return iter
.index
159 # Gets an iterator on the chars of self
161 # DEPRECATED : Use self.chars.iterator instead
162 fun iterator
: Iterator[Char]
164 return self.chars
.iterator
168 # Gets an Array containing the chars of self
170 # DEPRECATED : Use self.chars.to_a instead
171 fun to_a
: Array[Char] do return chars
.to_a
173 # Create a substring from `self` beginning at the `from` position
175 # assert "abcd".substring_from(1) == "bcd"
176 # assert "abcd".substring_from(-1) == "abcd"
177 # assert "abcd".substring_from(2) == "cd"
179 # As with substring, a `from` index < 0 will be replaced by 0
180 fun substring_from
(from
: Int): SELFTYPE
182 if from
>= self.length
then return empty
183 if from
< 0 then from
= 0
184 return substring
(from
, length
- from
)
187 # Does self have a substring `str` starting from position `pos`?
189 # assert "abcd".has_substring("bc",1) == true
190 # assert "abcd".has_substring("bc",2) == false
192 # Returns true iff all characters of `str` are presents
193 # at the expected index in `self.`
194 # The first character of `str` being at `pos`, the second
195 # character being at `pos+1` and so on...
197 # This means that all characters of `str` need to be inside `self`.
199 # assert "abcd".has_substring("xab", -1) == false
200 # assert "abcd".has_substring("cdx", 2) == false
202 # And that the empty string is always a valid substring.
204 # assert "abcd".has_substring("", 2) == true
205 # assert "abcd".has_substring("", 200) == true
206 fun has_substring
(str
: String, pos
: Int): Bool
208 if str
.is_empty
then return true
209 if pos
< 0 or pos
+ str
.length
> length
then return false
210 var myiter
= self.chars
.iterator_from
(pos
)
211 var itsiter
= str
.chars
.iterator
212 while myiter
.is_ok
and itsiter
.is_ok
do
213 if myiter
.item
!= itsiter
.item
then return false
217 if itsiter
.is_ok
then return false
221 # Is this string prefixed by `prefix`?
223 # assert "abcd".has_prefix("ab") == true
224 # assert "abcbc".has_prefix("bc") == false
225 # assert "ab".has_prefix("abcd") == false
226 fun has_prefix
(prefix
: String): Bool do return has_substring
(prefix
,0)
228 # Is this string suffixed by `suffix`?
230 # assert "abcd".has_suffix("abc") == false
231 # assert "abcd".has_suffix("bcd") == true
232 fun has_suffix
(suffix
: String): Bool do return has_substring
(suffix
, length
- suffix
.length
)
234 # Returns a copy of `self` minus all occurences of `c`
236 # assert "__init__".remove_all('_') == "init"
237 fun remove_all
(c
: Char): String do
239 for i
in chars
do if i
!= c
then b
.add i
243 # Returns `self` as the corresponding integer
245 # assert "123".to_i == 123
246 # assert "-1".to_i == -1
247 # assert "0x64".to_i == 100
248 # assert "0b1100_0011".to_i== 195
249 # assert "--12".to_i == 12
251 # REQUIRE: `self`.`is_int`
252 fun to_i
: Int is abstract
254 # If `self` contains a float, return the corresponding float
256 # assert "123".to_f == 123.0
257 # assert "-1".to_f == -1.0
258 # assert "-1.2e-3".to_f == -0.0012
262 return to_s
.to_cstring
.atof
265 # If `self` contains only digits and alpha <= 'f', return the corresponding integer.
267 # assert "ff".to_hex == 255
268 fun to_hex
: Int do return a_to
(16)
270 # If `self` contains only digits <= '7', return the corresponding integer.
272 # assert "714".to_oct == 460
273 fun to_oct
: Int do return a_to
(8)
275 # If `self` contains only '0' et '1', return the corresponding integer.
277 # assert "101101".to_bin == 45
278 fun to_bin
: Int do return a_to
(2)
280 # If `self` contains only digits '0' .. '9', return the corresponding integer.
282 # assert "108".to_dec == 108
283 fun to_dec
: Int do return a_to
(10)
285 # If `self` contains only digits and letters, return the corresponding integer in a given base
287 # assert "120".a_to(3) == 15
288 fun a_to
(base
: Int) : Int
293 for j
in [0..length
[ do
315 # Returns `true` if the string contains only Numeric values (and one "," or one "." character)
317 # assert "123".is_numeric == true
318 # assert "1.2".is_numeric == true
319 # assert "1,2".is_numeric == true
320 # assert "1..2".is_numeric == false
323 var has_point_or_comma
= false
324 for i
in [0..length
[ do
326 if not c
.is_numeric
then
327 if (c
== '.' or c
== ',') and not has_point_or_comma
then
328 has_point_or_comma
= true
337 # Returns `true` if the string contains only Hex chars
339 # assert "048bf".is_hex == true
340 # assert "ABCDEF".is_hex == true
341 # assert "0G".is_hex == false
344 for i
in [0..length
[ do
346 if not (c
>= 'a' and c
<= 'f') and
347 not (c
>= 'A' and c
<= 'F') and
348 not (c
>= '0' and c
<= '9') then return false
353 # Returns `true` if the string contains only Binary digits
355 # assert "1101100".is_bin == true
356 # assert "1101020".is_bin == false
358 for i
in chars
do if i
!= '0' and i
!= '1' then return false
362 # Returns `true` if the string contains only Octal digits
364 # assert "213453".is_oct == true
365 # assert "781".is_oct == false
367 for i
in chars
do if i
< '0' or i
> '7' then return false
371 # Returns `true` if the string contains only Decimal digits
373 # assert "10839".is_dec == true
374 # assert "164F".is_dec == false
376 for i
in chars
do if i
< '0' or i
> '9' then return false
380 # Are all letters in `self` upper-case ?
382 # assert "HELLO WORLD".is_upper == true
383 # assert "%$&%!".is_upper == true
384 # assert "hello world".is_upper == false
385 # assert "Hello World".is_upper == false
388 for i
in [0..length
[ do
390 if char
.is_lower
then return false
395 # Are all letters in `self` lower-case ?
397 # assert "hello world".is_lower == true
398 # assert "%$&%!".is_lower == true
399 # assert "Hello World".is_lower == false
402 for i
in [0..length
[ do
404 if char
.is_upper
then return false
409 # Removes the whitespaces at the beginning of self
411 # assert " \n\thello \n\t".l_trim == "hello \n\t"
413 # `Char::is_whitespace` determines what is a whitespace.
416 var iter
= self.chars
.iterator
418 if not iter
.item
.is_whitespace
then break
421 if iter
.index
== length
then return self.empty
422 return self.substring_from
(iter
.index
)
425 # Removes the whitespaces at the end of self
427 # assert " \n\thello \n\t".r_trim == " \n\thello"
429 # `Char::is_whitespace` determines what is a whitespace.
432 var iter
= self.chars
.reverse_iterator
434 if not iter
.item
.is_whitespace
then break
437 if iter
.index
< 0 then return self.empty
438 return self.substring
(0, iter
.index
+ 1)
441 # Trims trailing and preceding white spaces
443 # assert " Hello World ! ".trim == "Hello World !"
444 # assert "\na\nb\tc\t".trim == "a\nb\tc"
446 # `Char::is_whitespace` determines what is a whitespace.
447 fun trim
: SELFTYPE do return (self.l_trim
).r_trim
449 # Is the string non-empty but only made of whitespaces?
451 # assert " \n\t ".is_whitespace == true
452 # assert " hello ".is_whitespace == false
453 # assert "".is_whitespace == false
455 # `Char::is_whitespace` determines what is a whitespace.
456 fun is_whitespace
: Bool
458 if is_empty
then return false
459 for c
in self.chars
do
460 if not c
.is_whitespace
then return false
465 # Returns `self` removed from its last line terminator (if any).
467 # assert "Hello\n".chomp == "Hello"
468 # assert "Hello".chomp == "Hello"
470 # assert "\n".chomp == ""
471 # assert "".chomp == ""
473 # Line terminators are `"\n"`, `"\r\n"` and `"\r"`.
474 # A single line terminator, the last one, is removed.
476 # assert "\r\n".chomp == ""
477 # assert "\r\n\n".chomp == "\r\n"
478 # assert "\r\n\r\n".chomp == "\r\n"
479 # assert "\r\n\r".chomp == "\r\n"
481 # Note: unlike with most IO methods like `Reader::read_line`,
482 # a single `\r` is considered here to be a line terminator and will be removed.
486 if len
== 0 then return self
487 var l
= self.chars
.last
489 return substring
(0, len-1
)
490 else if l
!= '\n' then
492 else if len
> 1 and self.chars
[len-2
] == '\r' then
493 return substring
(0, len-2
)
495 return substring
(0, len-1
)
499 # Justify a self in a space of `length`
501 # `left` is the space ratio on the left side.
502 # * 0.0 for left-justified (no space at the left)
503 # * 1.0 for right-justified (all spaces at the left)
504 # * 0.5 for centered (half the spaces at the left)
508 # assert "hello".justify(10, 0.0) == "hello "
509 # assert "hello".justify(10, 1.0) == " hello"
510 # assert "hello".justify(10, 0.5) == " hello "
512 # If `length` is not enough, `self` is returned as is.
514 # assert "hello".justify(2, 0.0) == "hello"
516 # REQUIRE: `left >= 0.0 and left <= 1.0`
517 # ENSURE: `self.length <= length implies result.length == length`
518 # ENSURE: `self.length >= length implies result == self`
519 fun justify
(length
: Int, left
: Float): String
521 var diff
= length
- self.length
522 if diff
<= 0 then return to_s
523 assert left
>= 0.0 and left
<= 1.0
524 var before
= (diff
.to_f
* left
).to_i
525 return " " * before
+ self + " " * (diff-before
)
528 # Mangle a string to be a unique string only made of alphanumeric characters and underscores.
530 # This method is injective (two different inputs never produce the same
531 # output) and the returned string always respect the following rules:
533 # * Contains only US-ASCII letters, digits and underscores.
534 # * Never starts with a digit.
535 # * Never ends with an underscore.
536 # * Never contains two contiguous underscores.
538 # assert "42_is/The answer!".to_cmangle == "_52d2_is_47dThe_32danswer_33d"
539 # assert "__".to_cmangle == "_95d_95d"
540 # assert "__d".to_cmangle == "_95d_d"
541 # assert "_d_".to_cmangle == "_d_95d"
542 # assert "_42".to_cmangle == "_95d42"
543 # assert "foo".to_cmangle == "foo"
544 # assert "".to_cmangle == ""
545 fun to_cmangle
: String
547 if is_empty
then return ""
549 var underscore
= false
553 if c
>= '0' and c
<= '9' then
555 res
.append
(c
.ascii
.to_s
)
559 for i
in [start
..length
[ do
561 if (c
>= 'a' and c
<= 'z') or (c
>='A' and c
<= 'Z') then
567 res
.append
('_'.ascii
.to_s
)
570 if c
>= '0' and c
<= '9' then
573 else if c
== '_' then
578 res
.append
(c
.ascii
.to_s
)
584 res
.append
('_'.ascii
.to_s
)
590 # Escape " \ ' and non printable characters using the rules of literal C strings and characters
592 # assert "abAB12<>&".escape_to_c == "abAB12<>&"
593 # assert "\n\"'\\".escape_to_c == "\\n\\\"\\'\\\\"
595 # Most non-printable characters (bellow ASCII 32) are escaped to an octal form `\nnn`.
596 # Three digits are always used to avoid following digits to be interpreted as an element
597 # of the octal sequence.
599 # assert "{0.ascii}{1.ascii}{8.ascii}{31.ascii}{32.ascii}".escape_to_c == "\\000\\001\\010\\037 "
601 # The exceptions are the common `\t` and `\n`.
602 fun escape_to_c
: String
605 for i
in [0..length
[ do
609 else if c
== '\t' then
611 else if c
== '\0' then
613 else if c
== '"' then
615 else if c == '\'' then
617 else if c == '\\
' then
619 else if c.ascii < 32 then
621 var oct = c.ascii.to_base(8, false)
622 # Force 3 octal digits since it is the
623 # maximum allowed in the C specification
624 if oct.length == 1 then
627 else if oct.length == 2 then
638 # Escape additionnal characters
639 # The result might no be legal in C but be used in other languages
641 # assert "ab|\{\}".escape_more_to_c("|\{\}") == "ab\\|\\\{\\\}"
642 fun escape_more_to_c(chars: String): String
645 for c in escape_to_c.chars do
646 if chars.chars.has(c) then
654 # Escape to C plus braces
656 # assert "\n\"'\\\
{\}".escape_to_nit == "\\n\\\
"\\'\\\\\\\{\\\}"
657 fun escape_to_nit
: String do return escape_more_to_c
("\{\}")
659 # Escape to POSIX Shell (sh).
661 # Abort if the text contains a null byte.
663 # assert "\n\"'\\\{\}0".escape_to_sh == "'\n\"'\\''\\\{\}0'"
664 fun escape_to_sh
: String do
667 for i in [0..length[ do
672 assert without_null_byte
: c
!= '\0'
680 # Escape to include in a Makefile
682 # Unfortunately, some characters are not escapable in Makefile.
683 # These characters are `;`, `|`, `\`, and the non-printable ones.
684 # They will be rendered as `"?{hex}"`.
685 fun escape_to_mk: String do
687 for i in [0..length[ do
691 else if c == ':' or c == ' ' or c == '#' then
694 else if c
.ascii
< 32 or c
== ';' or c
== '|' or c
== '\\' or c
== '=' then
695 b
.append
("?{c.ascii.to_base(16, false)}")
703 # Return a string where Nit escape sequences are transformed.
706 # assert s.length == 2
707 # var u = s.unescape_nit
708 # assert u.length == 1
709 # assert u.chars[0].ascii == 10 # (the ASCII value of the "new line" character)
710 fun unescape_nit
: String
712 var res
= new Buffer.with_cap
(self.length
)
713 var was_slash
= false
714 for i
in [0..length
[ do
716 if not was_slash
then
727 else if c
== 'r' then
729 else if c
== 't' then
731 else if c
== '0' then
740 # Encode `self` to percent (or URL) encoding
742 # assert "aBc09-._~".to_percent_encoding == "aBc09-._~"
743 # assert "%()< >".to_percent_encoding == "%25%28%29%3c%20%3e"
744 # assert ".com/post?e=asdf&f=123".to_percent_encoding == ".com%2fpost%3fe%3dasdf%26f%3d123"
745 fun to_percent_encoding
: String
749 for i
in [0..length
[ do
751 if (c
>= '0' and c
<= '9') or
752 (c
>= 'a' and c
<= 'z') or
753 (c
>= 'A' and c
<= 'Z') or
754 c
== '-' or c
== '.' or
758 else buf
.append
"%{c.ascii.to_hex}"
764 # Decode `self` from percent (or URL) encoding to a clear string
766 # Replace invalid use of '%' with '?'.
768 # assert "aBc09-._~".from_percent_encoding == "aBc09-._~"
769 # assert "%25%28%29%3c%20%3e".from_percent_encoding == "%()< >"
770 # assert ".com%2fpost%3fe%3dasdf%26f%3d123".from_percent_encoding == ".com/post?e=asdf&f=123"
771 # assert "%25%28%29%3C%20%3E".from_percent_encoding == "%()< >"
772 # assert "incomplete %".from_percent_encoding == "incomplete ?"
773 # assert "invalid % usage".from_percent_encoding == "invalid ? usage"
774 fun from_percent_encoding
: String
782 if i
+ 2 >= length
then
783 # What follows % has been cut off
787 var hex_s
= substring
(i
, 2)
789 var hex_i
= hex_s
.to_hex
793 # What follows a % is not Hex
806 # Escape the characters `<`, `>`, `&`, `"`, `'` and `/` as HTML/XML entity references.
808 # assert "a&b-<>\"x\"/'".html_escape == "a&b-<>"x"/'"
810 # 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>
811 fun html_escape
: String
815 for i
in [0..length
[ do
819 else if c
== '<' then
821 else if c
== '>' then
823 else if c
== '"' then
825 else if c
== '\'' then
827 else if c == '/' then
836 # Two pieces of text are equals if thez have the same characters in the same order.
838 # assert "hello" == "hello"
839 # assert "hello" != "HELLO"
840 # assert "hello" == "hel"+"lo"
842 # Things that are not Text are not equal.
845 # assert "9" != ['9']
848 # assert "9".chars.first == '9' # equality of Char
849 # assert "9".chars == ['9'] # equality of Sequence
850 # assert "9".to_i == 9 # equality of Int
853 if o == null then return false
854 if not o isa Text then return false
855 if self.is_same_instance(o) then return true
856 if self.length != o.length then return false
857 return self.chars == o.chars
860 # Lexicographical comparaison
862 # assert "abc" < "xy"
863 # assert "ABC" < "abc"
866 var self_chars = self.chars.iterator
867 var other_chars = other.chars.iterator
869 while self_chars.is_ok and other_chars.is_ok do
870 if self_chars.item < other_chars.item then return true
871 if self_chars.item > other_chars.item then return false
876 if self_chars.is_ok then
883 # Escape string used in labels for graphviz
885 # assert ">><<".escape_to_dot == "\\>\\>\\<\\<"
886 fun escape_to_dot: String
888 return escape_more_to_c("|\{\}<>")
891 private var hash_cache: nullable Int = null
895 if hash_cache == null then
896 # djb2 hash algorithm
899 for i in [0..length[ do
901 h = (h << 5) + h + char.ascii
906 return hash_cache.as(not null)
909 # Gives the formatted string back as a Nit string with `args` in place
911 # assert "This %1 is a %2.".format("String", "formatted String") == "This String is a formatted String."
912 # assert "\\%1 This string".format("String") == "\\%1 This string"
913 fun format(args: Object...): String do
914 var s = new Array[Text]
918 # Skip escaped characters
919 if self[i] == '\\
' then
922 else if self[i] == '%' then
926 while i < length and self[i].is_numeric do
931 var ciph_len = fmt_end - ciph_st + 1
933 var arg_index = substring(ciph_st, ciph_len).to_i - 1
934 if arg_index >= args.length then continue
936 s.push substring(curr_st, fmt_st - curr_st)
937 s.push args[arg_index].to_s
942 s.push substring(curr_st, length - curr_st)
946 # Copies `n` bytes from `self` at `src_offset` into `dest` starting at `dest_offset`
948 # Basically a high-level synonym of NativeString::copy_to
950 # REQUIRE: `n` must be large enough to contain `len` bytes
952 # var ns = new NativeString(8)
953 # "Text is String".copy_to_native(ns, 8, 2, 0)
954 # assert ns.to_s_with_length(8) == "xt is St"
956 fun copy_to_native(dest: NativeString, n, src_offset, dest_offset: Int) do
957 var mypos = src_offset
958 var itspos = dest_offset
960 dest[itspos] = self.bytes[mypos]
969 # All kinds of array-based text representations.
970 abstract class FlatText
973 # Underlying C-String (`char*`)
975 # Warning : Might be void in some subclasses, be sure to check
976 # if set before using it.
977 private var items: NativeString is noinit
979 # Real items, used as cache for to_cstring is called
980 private var real_items: nullable NativeString = null
982 # Returns a char* starting at position `first_byte`
984 # WARNING: If you choose to use this service, be careful of the following.
986 # Strings and NativeString are *ideally* always allocated through a Garbage Collector.
987 # Since the GC tracks the use of the pointer for the beginning of the char*, it may be
988 # deallocated at any moment, rendering the pointer returned by this function invalid.
989 # Any access to freed memory may very likely cause undefined behaviour or a crash.
990 # (Failure to do so will most certainly result in long and painful debugging hours)
992 # The only safe use of this pointer is if it is ephemeral (e.g. read in a C function
993 # then immediately return).
995 # As always, do not modify the content of the String in C code, if this is what you want
996 # copy locally the char* as Nit Strings are immutable.
997 private fun fast_cstring: NativeString is abstract
1001 redef var bytelen = 0
1012 redef fun copy_to_native(dest, n, src_offset, dest_offset) do
1013 items.copy_to(dest, n, src_offset, dest_offset)
1017 # Abstract class for the SequenceRead compatible
1018 # views on the chars of any Text
1019 private abstract class StringCharView
1020 super SequenceRead[Char]
1024 var target: SELFTYPE
1026 redef fun is_empty do return target.is_empty
1028 redef fun length do return target.length
1030 redef fun iterator: IndexedIterator[Char] do return self.iterator_from(0)
1032 redef fun reverse_iterator do return self.reverse_iterator_from(self.length - 1)
1035 # Abstract class for the SequenceRead compatible
1036 # views on the bytes of any Text
1037 private abstract class StringByteView
1038 super SequenceRead[Byte]
1042 var target: SELFTYPE
1044 redef fun is_empty do return target.is_empty
1046 redef fun length do return target.length
1048 redef fun iterator do return self.iterator_from(0)
1050 redef fun reverse_iterator do return self.reverse_iterator_from(target.bytelen - 1)
1053 # Immutable sequence of characters.
1055 # String objects may be created using literals.
1057 # assert "Hello World!" isa String
1058 abstract class String
1061 redef type SELFTYPE: String is fixed
1063 redef fun to_s do return self
1065 # Concatenates `o` to `self`
1067 # assert "hello" + "world" == "helloworld"
1068 # assert "" + "hello" + "" == "hello"
1069 fun +(o: Text): SELFTYPE is abstract
1071 # Concatenates self `i` times
1073 # assert "abc" * 4 == "abcabcabcabc"
1074 # assert "abc" * 1 == "abc"
1075 # assert "abc" * 0 == ""
1076 fun *(i: Int): SELFTYPE is abstract
1078 # Insert `s` at `pos`.
1080 # assert "helloworld".insert_at(" ", 5) == "hello world"
1081 fun insert_at(s: String, pos: Int): SELFTYPE is abstract
1083 redef fun substrings is abstract
1085 # Returns a reversed version of self
1087 # assert "hello".reversed == "olleh"
1088 # assert "bob".reversed == "bob"
1089 # assert "".reversed == ""
1090 fun reversed: SELFTYPE is abstract
1092 # A upper case version of `self`
1094 # assert "Hello World!".to_upper == "HELLO WORLD!"
1095 fun to_upper: SELFTYPE is abstract
1097 # A lower case version of `self`
1099 # assert "Hello World!".to_lower == "hello world!"
1100 fun to_lower : SELFTYPE is abstract
1102 # Takes a camel case `self` and converts it to snake case
1104 # assert "randomMethodId".to_snake_case == "random_method_id"
1106 # The rules are the following:
1108 # An uppercase is always converted to a lowercase
1110 # assert "HELLO_WORLD".to_snake_case == "hello_world"
1112 # An uppercase that follows a lowercase is prefixed with an underscore
1114 # assert "HelloTheWORLD".to_snake_case == "hello_the_world"
1116 # An uppercase that follows an uppercase and is followed by a lowercase, is prefixed with an underscore
1118 # assert "HelloTHEWorld".to_snake_case == "hello_the_world"
1120 # All other characters are kept as is; `self` does not need to be a proper CamelCased string.
1122 # assert "=-_H3ll0Th3W0rld_-=".to_snake_case == "=-_h3ll0th3w0rld_-="
1123 fun to_snake_case: SELFTYPE
1125 if self.is_lower then return self
1127 var new_str = new Buffer.with_cap(self.length)
1128 var prev_is_lower = false
1129 var prev_is_upper = false
1131 for i in [0..length[ do
1133 if char.is_lower then
1135 prev_is_lower = true
1136 prev_is_upper = false
1137 else if char.is_upper then
1138 if prev_is_lower then
1140 else if prev_is_upper and i+1 < length and chars[i+1].is_lower then
1143 new_str.add(char.to_lower)
1144 prev_is_lower = false
1145 prev_is_upper = true
1148 prev_is_lower = false
1149 prev_is_upper = false
1156 # Takes a snake case `self` and converts it to camel case
1158 # assert "random_method_id".to_camel_case == "randomMethodId"
1160 # If the identifier is prefixed by an underscore, the underscore is ignored
1162 # assert "_private_field".to_camel_case == "_privateField"
1164 # If `self` is upper, it is returned unchanged
1166 # assert "RANDOM_ID".to_camel_case == "RANDOM_ID"
1168 # If there are several consecutive underscores, they are considered as a single one
1170 # assert "random__method_id".to_camel_case == "randomMethodId"
1171 fun to_camel_case: SELFTYPE
1173 if self.is_upper then return self
1175 var new_str = new Buffer
1176 var is_first_char = true
1177 var follows_us = false
1179 for i in [0..length[ do
1181 if is_first_char then
1183 is_first_char = false
1184 else if char == '_
' then
1186 else if follows_us then
1187 new_str.add(char.to_upper)
1197 # Returns a capitalized `self`
1199 # Letters that follow a letter are lowercased
1200 # Letters that follow a non-letter are upcased.
1202 # SEE : `Char::is_letter` for the definition of letter.
1204 # assert "jAVASCRIPT".capitalized == "Javascript"
1205 # assert "i am root".capitalized == "I Am Root"
1206 # assert "ab_c -ab0c ab\nc".capitalized == "Ab_C -Ab0C Ab\nC"
1207 fun capitalized: SELFTYPE do
1208 if length == 0 then return self
1210 var buf = new Buffer.with_cap(length)
1212 var curr = chars[0].to_upper
1216 for i in [1 .. length[ do
1219 if prev.is_letter then
1220 buf[i] = curr.to_lower
1222 buf[i] = curr.to_upper
1230 # A mutable sequence of characters.
1231 abstract class Buffer
1234 # Returns an arbitrary subclass of `Buffer` with default parameters
1237 # Returns an instance of a subclass of `Buffer` with `i` base capacity
1238 new with_cap(i: Int) is abstract
1240 redef type SELFTYPE: Buffer is fixed
1242 # Specific implementations MUST set this to `true` in order to invalidate caches
1243 protected var is_dirty = true
1245 # Copy-On-Write flag
1247 # If the `Buffer` was to_s'd
, the next in-place altering
1248 # operation will cause the current `Buffer` to be re-allocated.
1250 # The flag will then be set at `false`.
1251 protected var written
= false
1253 # Modifies the char contained at pos `index`
1255 # DEPRECATED : Use self.chars.[]= instead
1256 fun []=(index
: Int, item
: Char) is abstract
1258 # Adds a char `c` at the end of self
1260 # DEPRECATED : Use self.chars.add instead
1261 fun add
(c
: Char) is abstract
1265 # var b = new Buffer
1267 # assert not b.is_empty
1270 fun clear
is abstract
1272 # Enlarges the subsequent array containing the chars of self
1273 fun enlarge
(cap
: Int) is abstract
1275 # Adds the content of text `s` at the end of self
1277 # var b = new Buffer
1280 # assert b == "helloworld"
1281 fun append
(s
: Text) is abstract
1283 # `self` is appended in such a way that `self` is repeated `r` times
1285 # var b = new Buffer
1288 # assert b == "hellohellohello"
1289 fun times
(r
: Int) is abstract
1291 # Reverses itself in-place
1293 # var b = new Buffer
1296 # assert b == "olleh"
1297 fun reverse
is abstract
1299 # Changes each lower-case char in `self` by its upper-case variant
1301 # var b = new Buffer
1302 # b.append("Hello World!")
1304 # assert b == "HELLO WORLD!"
1305 fun upper
is abstract
1307 # Changes each upper-case char in `self` by its lower-case variant
1309 # var b = new Buffer
1310 # b.append("Hello World!")
1312 # assert b == "hello world!"
1313 fun lower
is abstract
1315 # Capitalizes each word in `self`
1317 # Letters that follow a letter are lowercased
1318 # Letters that follow a non-letter are upcased.
1320 # SEE: `Char::is_letter` for the definition of a letter.
1322 # var b = new FlatBuffer.from("jAVAsCriPt")
1324 # assert b == "Javascript"
1325 # b = new FlatBuffer.from("i am root")
1327 # assert b == "I Am Root"
1328 # b = new FlatBuffer.from("ab_c -ab0c ab\nc")
1330 # assert b == "Ab_C -Ab0C Ab\nC"
1332 if length
== 0 then return
1333 var c
= self[0].to_upper
1336 for i
in [1 .. length
[ do
1339 if prev
.is_letter
then
1340 self[i
] = c
.to_lower
1342 self[i
] = c
.to_upper
1349 if is_dirty
then hash_cache
= null
1353 # In Buffers, the internal sequence of character is mutable
1354 # Thus, `chars` can be used to modify the buffer.
1355 redef fun chars
: Sequence[Char] is abstract
1358 # View for chars on Buffer objects, extends Sequence
1359 # for mutation operations
1360 private abstract class BufferCharView
1361 super StringCharView
1362 super Sequence[Char]
1364 redef type SELFTYPE: Buffer
1368 # View for bytes on Buffer objects, extends Sequence
1369 # for mutation operations
1370 private abstract class BufferByteView
1371 super StringByteView
1373 redef type SELFTYPE: Buffer
1377 # User readable representation of `self`.
1378 fun to_s
: String do return inspect
1380 # The class name of the object in NativeString format.
1381 private fun native_class_name
: NativeString is intern
1383 # The class name of the object.
1385 # assert 5.class_name == "Int"
1386 fun class_name
: String do return native_class_name
.to_s
1388 # Developer readable representation of `self`.
1389 # Usually, it uses the form "<CLASSNAME:#OBJECTID bla bla bla>"
1392 return "<{inspect_head}>"
1395 # Return "CLASSNAME:#OBJECTID".
1396 # This function is mainly used with the redefinition of the inspect method
1397 protected fun inspect_head
: String
1399 return "{class_name}:#{object_id.to_hex}"
1404 # assert true.to_s == "true"
1405 # assert false.to_s == "false"
1417 # C function to calculate the length of the `NativeString` to receive `self`
1418 private fun byte_to_s_len
: Int `{
1419 return snprintf(NULL, 0, "0x%02x", self);
1422 # C function to convert an nit Int to a NativeString (char*)
1423 private fun native_byte_to_s
(nstr
: NativeString, strlen
: Int) `{
1424 snprintf(nstr, strlen, "0x%02x", self);
1427 # Displayable byte in its hexadecimal form (0x..)
1429 # assert 1.to_b.to_s == "0x01"
1430 # assert (-123).to_b.to_s == "0x85"
1432 var nslen
= byte_to_s_len
1433 var ns
= new NativeString(nslen
+ 1)
1435 native_byte_to_s
(ns
, nslen
+ 1)
1436 return ns
.to_s_with_length
(nslen
)
1442 # Wrapper of strerror C function
1443 private fun strerror_ext
: NativeString `{ return strerror(self); `}
1445 # Returns a string describing error number
1446 fun strerror: String do return strerror_ext.to_s
1448 # Fill `s
` with the digits in base `base
` of `self` (and with the '-' sign if 'signed' and negative).
1449 # assume < to_c max const of char
1450 private fun fill_buffer(s: Buffer, base: Int, signed: Bool)
1457 else if self == 0 then
1464 var pos = digit_count(base) - 1
1465 while pos >= 0 and n > 0 do
1466 s.chars[pos] = (n % base).to_c
1472 # C function to calculate the length of the `NativeString` to receive `self`
1473 private fun int_to_s_len: Int `{
1474 return snprintf
(NULL, 0, "%ld", self);
1477 # C function to convert an nit Int to a NativeString (char*)
1478 private fun native_int_to_s(nstr: NativeString, strlen: Int) `{
1479 snprintf
(nstr
, strlen
, "%ld", self);
1482 # return displayable int in base base and signed
1483 fun to_base(base: Int, signed: Bool): String is abstract
1485 # return displayable int in hexadecimal
1487 # assert 1.to_hex == "1"
1488 # assert (-255).to_hex == "-ff"
1489 fun to_hex: String do return to_base(16,false)
1493 # Pretty representation of `self`, with decimals as needed from 1 to a maximum of 3
1495 # assert 12.34.to_s == "12.34"
1496 # assert (-0120.030).to_s == "-120.03"
1498 # see `to_precision
` for a custom precision.
1500 var str = to_precision( 3 )
1501 if is_inf != 0 or is_nan then return str
1502 var len = str.length
1503 for i in [0..len-1] do
1505 var c = str.chars[j]
1508 else if c == '.' then
1509 return str.substring( 0, j+2 )
1511 return str.substring( 0, j+1 )
1517 # `String` representation of `self` with the given number of `decimals
`
1519 # assert 12.345.to_precision(0) == "12"
1520 # assert 12.345.to_precision(3) == "12.345"
1521 # assert (-12.345).to_precision(3) == "-12.345"
1522 # assert (-0.123).to_precision(3) == "-0.123"
1523 # assert 0.999.to_precision(2) == "1.00"
1524 # assert 0.999.to_precision(4) == "0.9990"
1525 fun to_precision(decimals: Int): String
1527 if is_nan then return "nan"
1529 var isinf = self.is_inf
1532 else if isinf == -1 then
1536 if decimals == 0 then return self.to_i.to_s
1538 for i in [0..decimals[ do f = f * 10.0
1545 if i == 0 then return "0." + "0"*decimals
1547 # Prepare both parts of the float, before and after the "."
1552 if sl > decimals then
1553 # Has something before the "."
1554 p1 = s.substring(0, sl-decimals)
1555 p2 = s.substring(sl-decimals, decimals)
1558 p2 = "0"*(decimals-sl) + s
1561 if i < 0 then p1 = "-" + p1
1563 return p1 + "." + p2
1569 # Length of `self` in a UTF-8 String
1570 private fun u8char_len: Int do
1572 if c < 0x80 then return 1
1573 if c <= 0x7FF then return 2
1574 if c <= 0xFFFF then return 3
1575 if c <= 0x10FFFF then return 4
1576 # Bad character format
1580 # assert 'x'.to_s == "x"
1583 var ns = new NativeString(ln + 1)
1585 return ns.to_s_with_length(ln)
1588 private fun u8char_tos(r: NativeString, len: Int) `{
1595 r
[0] = 0xC0 | ((self & 0x7C0) >> 6);
1596 r
[1] = 0x80 | (self & 0x3F);
1599 r
[0] = 0xE0 | ((self & 0xF000) >> 12);
1600 r
[1] = 0x80 | ((self & 0xFC0) >> 6);
1601 r
[2] = 0x80 | (self & 0x3F);
1604 r
[0] = 0xF0 | ((self & 0x1C0000) >> 18);
1605 r
[1] = 0x80 | ((self & 0x3F000) >> 12);
1606 r
[2] = 0x80 | ((self & 0xFC0) >> 6);
1607 r
[3] = 0x80 | (self & 0x3F);
1612 # Returns true if the char is a numerical digit
1614 # assert '0'.is_numeric
1615 # assert '9'.is_numeric
1616 # assert not 'a'.is_numeric
1617 # assert not '?'.is_numeric
1619 # FIXME: Works on ASCII-range only
1620 fun is_numeric: Bool
1622 return self >= '0' and self <= '9'
1625 # Returns true if the char is an alpha digit
1627 # assert 'a'.is_alpha
1628 # assert 'Z'.is_alpha
1629 # assert not '0'.is_alpha
1630 # assert not '?'.is_alpha
1632 # FIXME: Works on ASCII-range only
1635 return (self >= 'a' and self <= 'z') or (self >= 'A' and self <= 'Z')
1638 # Returns true if the char is an alpha or a numeric digit
1640 # assert 'a'.is_alphanumeric
1641 # assert 'Z'.is_alphanumeric
1642 # assert '0'.is_alphanumeric
1643 # assert '9'.is_alphanumeric
1644 # assert not '?'.is_alphanumeric
1646 # FIXME: Works on ASCII-range only
1647 fun is_alphanumeric: Bool
1649 return self.is_numeric or self.is_alpha
1653 redef class Collection[E]
1654 # String representation of the content of the collection.
1656 # The standard representation is the list of elements separated with commas.
1659 # assert [1,2,3].to_s == "[1,2,3]"
1660 # assert [1..3].to_s == "[1,2,3]"
1661 # assert (new Array[Int]).to_s == "[]" # empty collection
1664 # Subclasses may return a more specific string representation.
1667 return "[" + join(",") + "]"
1670 # Concatenate elements without separators
1673 # assert [1,2,3].plain_to_s == "123"
1674 # assert [11..13].plain_to_s == "111213"
1675 # assert (new Array[Int]).plain_to_s == "" # empty collection
1677 fun plain_to_s: String
1680 for e in self do if e != null then s.append(e.to_s)
1684 # Concatenate and separate each elements with `separator
`.
1686 # Only concatenate if `separator
== null`.
1688 # assert [1, 2, 3].join(":") == "1:2:3"
1689 # assert [1..3].join(":") == "1:2:3"
1690 # assert [1..3].join == "123"
1691 fun join(separator: nullable Text): String
1693 if is_empty then return ""
1695 var s = new Buffer # Result
1700 if e != null then s.append(e.to_s)
1702 # Concat other items
1705 if separator != null then s.append(separator)
1707 if e != null then s.append(e.to_s)
1714 redef class Map[K,V]
1715 # Concatenate couples of key value.
1716 # Key and value are separated by `couple_sep
`.
1717 # Couples are separated by `sep
`.
1719 # var m = new HashMap[Int, String]
1722 # assert m.join("; ", "=") == "1=one; 10=ten"
1723 fun join(sep, couple_sep: String): String is abstract
1727 private var args_cache: nullable Sequence[String] = null
1729 # The arguments of the program as given by the OS
1730 fun program_args: Sequence[String]
1732 if _args_cache == null then init_args
1733 return _args_cache.as(not null)
1736 # The name of the program as given by the OS
1737 fun program_name: String
1739 return native_argv(0).to_s
1742 # Initialize `program_args
` with the contents of `native_argc
` and `native_argv
`.
1743 private fun init_args
1745 var argc = native_argc
1746 var args = new Array[String].with_capacity(0)
1749 args[i-1] = native_argv(i).to_s
1755 # First argument of the main C function.
1756 private fun native_argc: Int is intern
1758 # Second argument of the main C function.
1759 private fun native_argv(i: Int): NativeString is intern
1762 # Comparator that efficienlty use `to_s
` to compare things
1764 # The comparaison call `to_s
` on object and use the result to order things.
1766 # var a = [1, 2, 3, 10, 20]
1767 # (new CachedAlphaComparator).sort(a)
1768 # assert a == [1, 10, 2, 20, 3]
1770 # Internally the result of `to_s
` is cached in a HashMap to counter
1771 # uneficient implementation of `to_s
`.
1773 # Note: it caching is not usefull, see `alpha_comparator
`
1774 class CachedAlphaComparator
1776 redef type COMPARED: Object
1778 private var cache = new HashMap[Object, String]
1780 private fun do_to_s(a: Object): String do
1781 if cache.has_key(a) then return cache[a]
1787 redef fun compare(a, b) do
1788 return do_to_s(a) <=> do_to_s(b)
1792 # see `alpha_comparator
`
1793 private class AlphaComparator
1795 redef fun compare(a, b) do return a.to_s <=> b.to_s
1798 # Stateless comparator that naively use `to_s
` to compare things.
1800 # Note: the result of `to_s
` is not cached, thus can be invoked a lot
1801 # on a single instace. See `CachedAlphaComparator` as an alternative.
1803 # var a = [1, 2, 3, 10, 20]
1804 # alpha_comparator.sort(a)
1805 # assert a == [1, 10, 2, 20, 3]
1806 fun alpha_comparator: Comparator do return once new AlphaComparator
1808 # The arguments of the program as given by the OS
1809 fun args: Sequence[String]
1811 return sys.program_args
1814 redef class NativeString
1815 # Returns `self` as a new String.
1816 fun to_s_with_copy: String is abstract
1818 # Returns `self` as a String of `length
`.
1819 fun to_s_with_length(length: Int): String is abstract
1822 redef class NativeArray[E]
1823 # Join all the elements using `to_s
`
1825 # REQUIRE: `self isa NativeArray[String]`
1826 # REQUIRE: all elements are initialized
1827 fun native_to_s: String is abstract