eea52be389bda98a60b5a4731e28f52877e6f8b0
1 # This file is part of NIT ( http://www.nitlanguage.org ).
3 # Copyright 2004-2008 Jean Privat <jean@pryen.org>
4 # Copyright 2006-2008 Floréal Morandat <morandat@lirmm.fr>
6 # This file is free software, which comes along with NIT. This software is
7 # distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
8 # without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
9 # PARTICULAR PURPOSE. You can modify it is you want, provided this header
10 # is kept unaltered, and a notification of the changes is added.
11 # You are allowed to redistribute it and sell it, alone or is a part of
14 # Basic manipulations of strings of characters
18 intrude import collection
# FIXME should be collection::array
25 ###############################################################################
27 ###############################################################################
29 # High-level abstraction for all text representations
34 redef type OTHER: Text
36 # Type of self (used for factorization of several methods, ex : substring_from, empty...)
39 # Gets a view on the chars of the Text object
41 # assert "hello".chars.to_a == ['h', 'e', 'l', 'l', 'o']
42 fun chars
: SequenceRead[Char] is abstract
44 # Number of characters contained in self.
46 # assert "12345".length == 5
47 # assert "".length == 0
48 fun length
: Int is abstract
52 # assert "abcd".substring(1, 2) == "bc"
53 # assert "abcd".substring(-1, 2) == "a"
54 # assert "abcd".substring(1, 0) == ""
55 # assert "abcd".substring(2, 5) == "cd"
57 # A `from` index < 0 will be replaced by 0.
58 # Unless a `count` value is > 0 at the same time.
59 # In this case, `from += count` and `count -= from`.
60 fun substring
(from
: Int, count
: Int): SELFTYPE is abstract
62 # Iterates on the substrings of self if any
63 fun substrings
: Iterator[Text] is abstract
65 # Is the current Text empty (== "")
68 # assert not "foo".is_empty
69 fun is_empty
: Bool do return self.length
== 0
71 # Returns an empty Text of the right type
73 # This method is used internally to get the right
74 # implementation of an empty string.
75 protected fun empty
: SELFTYPE is abstract
77 # Gets the first char of the Text
79 # DEPRECATED : Use self.chars.first instead
80 fun first
: Char do return self.chars
[0]
82 # Access a character at `index` in the string.
84 # assert "abcd"[2] == 'c'
86 # DEPRECATED : Use self.chars.[] instead
87 fun [](index
: Int): Char do return self.chars
[index
]
89 # Gets the index of the first occurence of 'c'
91 # Returns -1 if not found
93 # DEPRECATED : Use self.chars.index_of instead
94 fun index_of
(c
: Char): Int
96 return index_of_from
(c
, 0)
99 # Gets the last char of self
101 # DEPRECATED : Use self.chars.last instead
102 fun last
: Char do return self.chars
[length-1
]
104 # Gets the index of the first occurence of ´c´ starting from ´pos´
106 # Returns -1 if not found
108 # DEPRECATED : Use self.chars.index_of_from instead
109 fun index_of_from
(c
: Char, pos
: Int): Int
111 var iter
= self.chars
.iterator_from
(pos
)
113 if iter
.item
== c
then return iter
.index
119 # Gets the last index of char ´c´
121 # Returns -1 if not found
123 # DEPRECATED : Use self.chars.last_index_of instead
124 fun last_index_of
(c
: Char): Int
126 return last_index_of_from
(c
, length
- 1)
129 # Return a null terminated char *
130 fun to_cstring
: NativeString do return flatten
.to_cstring
132 # The index of the last occurrence of an element starting from pos (in reverse order).
134 # var s = "/etc/bin/test/test.nit"
135 # assert s.last_index_of_from('/', s.length-1) == 13
136 # assert s.last_index_of_from('/', 12) == 8
138 # Returns -1 if not found
140 # DEPRECATED : Use self.chars.last_index_of_from instead
141 fun last_index_of_from
(item
: Char, pos
: Int): Int
143 var iter
= self.chars
.reverse_iterator_from
(pos
)
145 if iter
.item
== item
then return iter
.index
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
159 # Is 'c' contained in self ?
161 # DEPRECATED : Use self.chars.has instead
162 fun has
(c
: Char): Bool
164 return self.chars
.has
(c
)
167 # Gets an Array containing the chars of self
169 # DEPRECATED : Use self.chars.to_a instead
170 fun to_a
: Array[Char] do return chars
.to_a
172 # Create a substring from `self` beginning at the `from` position
174 # assert "abcd".substring_from(1) == "bcd"
175 # assert "abcd".substring_from(-1) == "abcd"
176 # assert "abcd".substring_from(2) == "cd"
178 # As with substring, a `from` index < 0 will be replaced by 0
179 fun substring_from
(from
: Int): SELFTYPE
181 if from
> self.length
then return empty
182 if from
< 0 then from
= 0
183 return substring
(from
, length
- from
)
186 # Does self have a substring `str` starting from position `pos`?
188 # assert "abcd".has_substring("bc",1) == true
189 # assert "abcd".has_substring("bc",2) == false
190 fun has_substring
(str
: String, pos
: Int): Bool
192 var myiter
= self.chars
.iterator_from
(pos
)
193 var itsiter
= str
.chars
.iterator
194 while myiter
.is_ok
and itsiter
.is_ok
do
195 if myiter
.item
!= itsiter
.item
then return false
199 if itsiter
.is_ok
then return false
203 # Is this string prefixed by `prefix`?
205 # assert "abcd".has_prefix("ab") == true
206 # assert "abcbc".has_prefix("bc") == false
207 # assert "ab".has_prefix("abcd") == false
208 fun has_prefix
(prefix
: String): Bool do return has_substring
(prefix
,0)
210 # Is this string suffixed by `suffix`?
212 # assert "abcd".has_suffix("abc") == false
213 # assert "abcd".has_suffix("bcd") == true
214 fun has_suffix
(suffix
: String): Bool do return has_substring
(suffix
, length
- suffix
.length
)
216 # If `self` contains only digits, return the corresponding integer
218 # assert "123".to_i == 123
219 # assert "-1".to_i == -1
223 return to_s
.to_cstring
.atoi
226 # If `self` contains a float, return the corresponding float
228 # assert "123".to_f == 123.0
229 # assert "-1".to_f == -1.0
230 # assert "-1.2e-3".to_f == -0.0012
234 return to_s
.to_cstring
.atof
237 # If `self` contains only digits and alpha <= 'f', return the corresponding integer.
239 # assert "ff".to_hex == 255
240 fun to_hex
: Int do return a_to
(16)
242 # If `self` contains only digits and letters, return the corresponding integer in a given base
244 # assert "120".a_to(3) == 15
245 fun a_to
(base
: Int) : Int
272 # Returns `true` if the string contains only Numeric values (and one "," or one "." character)
274 # assert "123".is_numeric == true
275 # assert "1.2".is_numeric == true
276 # assert "1,2".is_numeric == true
277 # assert "1..2".is_numeric == false
280 var has_point_or_comma
= false
285 if (i
== '.' or i
== ',') and not has_point_or_comma
287 has_point_or_comma
= true
296 # Are all letters in `self` upper-case ?
298 # assert "HELLO WORLD".is_upper == true
299 # assert "%$&%!".is_upper == true
300 # assert "hello world".is_upper == false
301 # assert "Hello World".is_upper == false
304 for char
in self.chars
do
305 if char
.is_lower
then return false
310 # Are all letters in `self` lower-case ?
312 # assert "hello world".is_lower == true
313 # assert "%$&%!".is_lower == true
314 # assert "Hello World".is_lower == false
317 for char
in self.chars
do
318 if char
.is_upper
then return false
323 # Removes the whitespaces at the beginning of self
325 # assert " \n\thello \n\t".l_trim == "hello \n\t"
327 # A whitespace is defined as any character which ascii value is less than or equal to 32
330 var iter
= self.chars
.iterator
332 if iter
.item
.ascii
> 32 then break
335 if iter
.index
== length
then return self.empty
336 return self.substring_from
(iter
.index
)
339 # Removes the whitespaces at the end of self
341 # assert " \n\thello \n\t".r_trim == " \n\thello"
343 # A whitespace is defined as any character which ascii value is less than or equal to 32
346 var iter
= self.chars
.reverse_iterator
348 if iter
.item
.ascii
> 32 then break
351 if iter
.index
== length
then return self.empty
352 return self.substring
(0, iter
.index
+ 1)
355 # Trims trailing and preceding white spaces
356 # A whitespace is defined as any character which ascii value is less than or equal to 32
358 # assert " Hello World ! ".trim == "Hello World !"
359 # assert "\na\nb\tc\t".trim == "a\nb\tc"
360 fun trim
: SELFTYPE do return (self.l_trim
).r_trim
362 # Mangle a string to be a unique string only made of alphanumeric characters
363 fun to_cmangle
: String
365 var res
= new FlatBuffer
366 var underscore
= false
367 for c
in self.chars
do
368 if (c
>= 'a' and c
<= 'z') or (c
>='A' and c
<= 'Z') then
374 res
.append
('_'.ascii
.to_s
)
377 if c
>= '0' and c
<= '9' then
380 else if c
== '_' then
385 res
.append
(c
.ascii
.to_s
)
393 # Escape " \ ' and non printable characters using the rules of literal C strings and characters
395 # assert "abAB12<>&".escape_to_c == "abAB12<>&"
396 # assert "\n\"'\\".escape_to_c == "\\n\\\"\\'\\\\"
397 fun escape_to_c
: String
399 var b
= new FlatBuffer
400 for c
in self.chars
do
403 else if c
== '\0' then
405 else if c
== '"' then
407 else if c == '\'' then
409 else if c == '\\
' then
411 else if c.ascii < 32 then
412 b.append("\\{c.ascii.to_base(8, false)}")
420 # Escape additionnal characters
421 # The result might no be legal in C but be used in other languages
423 # assert "ab|\{\}".escape_more_to_c("|\{\}") == "ab\\|\\\{\\\}"
424 fun escape_more_to_c(chars: String): String
426 var b = new FlatBuffer
427 for c in escape_to_c.chars do
428 if chars.chars.has(c) then
436 # Escape to C plus braces
438 # assert "\n\"'\\\
{\}".escape_to_nit == "\\n\\\
"\\'\\\\\\\{\\\}"
439 fun escape_to_nit
: String do return escape_more_to_c
("\{\}")
441 # Return a string where Nit escape sequences are transformed.
444 # assert s.length == 2
445 # var u = s.unescape_nit
446 # assert u.length == 1
447 # assert u.chars[0].ascii == 10 # (the ASCII value of the "new line" character)
448 fun unescape_nit
: String
450 var res
= new FlatBuffer.with_capacity
(self.length
)
451 var was_slash
= false
453 if not was_slash
then
464 else if c
== 'r' then
466 else if c
== 't' then
468 else if c
== '0' then
478 # Two pieces of text are equals if thez have the same characters in the same order.
480 # assert "hello" == "hello"
481 # assert "hello" != "HELLO"
482 # assert "hello" == "hel"+"lo"
484 # Things that are not Text are not equal.
487 # assert "9" != ['9']
490 # assert "9".chars.first == '9' # equality of Char
491 # assert "9".chars == ['9'] # equality of Sequence
492 # assert "9".to_i == 9 # equality of Int
495 if o
== null then return false
496 if not o
isa Text then return false
497 if self.is_same_instance
(o
) then return true
498 if self.length
!= o
.length
then return false
499 return self.chars
== o
.chars
502 # Lexicographical comparaison
504 # assert "abc" < "xy"
505 # assert "ABC" < "abc"
508 var self_chars
= self.chars
.iterator
509 var other_chars
= other
.chars
.iterator
511 while self_chars
.is_ok
and other_chars
.is_ok
do
512 if self_chars
.item
< other_chars
.item
then return true
513 if self_chars
.item
> other_chars
.item
then return false
518 if self_chars
.is_ok
then
525 # Flat representation of self
526 fun flatten
: FlatText is abstract
528 private var hash_cache
: nullable Int = null
532 if hash_cache
== null then
533 # djb2 hash algorithm
536 for char
in self.chars
do
537 h
= h
.lshift
(5) + h
+ char
.ascii
542 return hash_cache
.as(not null)
547 # All kinds of array-based text representations.
548 abstract class FlatText
551 private var items
: NativeString
553 # Real items, used as cache for to_cstring is called
554 private var real_items
: nullable NativeString = null
556 redef var length
: Int = 0
569 redef fun flatten
do return self
572 # Abstract class for the SequenceRead compatible
573 # views on String and Buffer objects
574 private abstract class StringCharView
575 super SequenceRead[Char]
579 private var target
: SELFTYPE
581 private init(tgt
: SELFTYPE)
586 redef fun is_empty
do return target
.is_empty
588 redef fun length
do return target
.length
590 redef fun iterator
: IndexedIterator[Char] do return self.iterator_from
(0)
592 redef fun reverse_iterator
do return self.reverse_iterator_from
(self.length
- 1)
595 # View on Buffer objects, extends Sequence
596 # for mutation operations
597 private abstract class BufferCharView
601 redef type SELFTYPE: Buffer
605 abstract class String
608 redef type SELFTYPE: String
610 redef fun to_s
do return self
612 # Concatenates `o` to `self`
614 # assert "hello" + "world" == "helloworld"
615 # assert "" + "hello" + "" == "hello"
616 fun +(o
: Text): SELFTYPE is abstract
618 # Concatenates self `i` times
620 # assert "abc" * 4 == "abcabcabcabc"
621 # assert "abc" * 1 == "abc"
622 # assert "abc" * 0 == ""
623 fun *(i
: Int): SELFTYPE is abstract
625 fun insert_at
(s
: String, pos
: Int): SELFTYPE is abstract
627 # Returns a reversed version of self
629 # assert "hello".reversed == "olleh"
630 # assert "bob".reversed == "bob"
631 # assert "".reversed == ""
632 fun reversed
: SELFTYPE is abstract
634 # A upper case version of `self`
636 # assert "Hello World!".to_upper == "HELLO WORLD!"
637 fun to_upper
: SELFTYPE is abstract
639 # A lower case version of `self`
641 # assert "Hello World!".to_lower == "hello world!"
642 fun to_lower
: SELFTYPE is abstract
645 private class FlatSubstringsIter
646 super Iterator[FlatText]
648 var tgt
: nullable FlatText
650 init(tgt
: FlatText) do self.tgt
= tgt
654 return tgt
.as(not null)
657 redef fun is_ok
do return tgt
!= null
659 redef fun next
do tgt
= null
662 # Immutable strings of characters.
667 # Index in _items of the start of the string
668 private var index_from
: Int
670 # Indes in _items of the last item of the string
671 private var index_to
: Int
673 redef var chars
: SequenceRead[Char] = new FlatStringCharView(self)
675 ################################################
676 # AbstractString specific methods #
677 ################################################
681 var native
= calloc_string
(self.length
+ 1)
682 var length
= self.length
683 var items
= self.items
686 while pos
< length
do
687 native
[pos
] = items
[ipos
]
691 return native
.to_s_with_length
(self.length
)
694 redef fun substring
(from
, count
)
700 if count
< 0 then count
= 0
704 var realFrom
= index_from
+ from
706 if (realFrom
+ count
) > index_to
then return new FlatString.with_infos
(items
, index_to
- realFrom
+ 1, realFrom
, index_to
)
708 if count
== 0 then return empty
710 var to
= realFrom
+ count
- 1
712 return new FlatString.with_infos
(items
, to
- realFrom
+ 1, realFrom
, to
)
715 redef fun empty
do return "".as(FlatString)
719 var outstr
= calloc_string
(self.length
+ 1)
722 var myitems
= self.items
723 var index_from
= self.index_from
724 var max
= self.index_to
726 while index_from
<= max
do
727 outstr
[out_index
] = myitems
[index_from
].to_upper
732 outstr
[self.length
] = '\0'
734 return outstr
.to_s_with_length
(self.length
)
739 var outstr
= calloc_string
(self.length
+ 1)
742 var myitems
= self.items
743 var index_from
= self.index_from
744 var max
= self.index_to
746 while index_from
<= max
do
747 outstr
[out_index
] = myitems
[index_from
].to_lower
752 outstr
[self.length
] = '\0'
754 return outstr
.to_s_with_length
(self.length
)
759 var i
= self.index_from
760 var imax
= self.index_to
767 ##################################################
768 # String Specific Methods #
769 ##################################################
771 private init with_infos
(items
: NativeString, len
: Int, from
: Int, to
: Int)
779 redef fun to_cstring
: NativeString
781 if real_items
!= null then return real_items
.as(not null)
782 if index_from
> 0 or index_to
!= items
.cstring_length
- 1 then
783 var newItems
= calloc_string
(length
+ 1)
784 self.items
.copy_to
(newItems
, length
, index_from
, 0)
785 newItems
[length
] = '\0'
786 self.real_items
= newItems
794 if not other
isa FlatString then return super
796 if self.object_id
== other
.object_id
then return true
798 var my_length
= length
800 if other
.length
!= my_length
then return false
802 var my_index
= index_from
803 var its_index
= other
.index_from
805 var last_iteration
= my_index
+ my_length
807 var itsitems
= other
.items
808 var myitems
= self.items
810 while my_index
< last_iteration
do
811 if myitems
[my_index
] != itsitems
[its_index
] then return false
821 if not other
isa FlatString then return super
823 if self.object_id
== other
.object_id
then return false
825 var my_curr_char
: Char
826 var its_curr_char
: Char
828 var curr_id_self
= self.index_from
829 var curr_id_other
= other
.index_from
831 var my_items
= self.items
832 var its_items
= other
.items
834 var my_length
= self.length
835 var its_length
= other
.length
837 var max_iterations
= curr_id_self
+ my_length
839 while curr_id_self
< max_iterations
do
840 my_curr_char
= my_items
[curr_id_self
]
841 its_curr_char
= its_items
[curr_id_other
]
843 if my_curr_char
!= its_curr_char
then
844 if my_curr_char
< its_curr_char
then return true
852 return my_length
< its_length
857 var my_length
= self.length
858 var its_length
= s
.length
860 var total_length
= my_length
+ its_length
862 var target_string
= calloc_string
(my_length
+ its_length
+ 1)
864 self.items
.copy_to
(target_string
, my_length
, index_from
, 0)
865 if s
isa FlatString then
866 s
.items
.copy_to
(target_string
, its_length
, s
.index_from
, my_length
)
867 else if s
isa FlatBuffer then
868 s
.items
.copy_to
(target_string
, its_length
, 0, my_length
)
870 var curr_pos
= my_length
872 target_string
[curr_pos
] = i
877 target_string
[total_length
] = '\0'
879 return target_string
.to_s_with_length
(total_length
)
886 var my_length
= self.length
888 var final_length
= my_length
* i
890 var my_items
= self.items
892 var target_string
= calloc_string
((final_length
) + 1)
894 target_string
[final_length
] = '\0'
898 for iteration
in [1 .. i
] do
899 my_items
.copy_to
(target_string
, my_length
, 0, current_last
)
900 current_last
+= my_length
903 return target_string
.to_s_with_length
(final_length
)
908 if hash_cache
== null then
909 # djb2 hash algorithm
915 while i
<= index_to
do
916 h
= h
.lshift
(5) + h
+ myitems
[i
].ascii
923 return hash_cache
.as(not null)
926 redef fun substrings
do return new FlatSubstringsIter(self)
929 private class FlatStringReverseIterator
930 super IndexedIterator[Char]
932 var target
: FlatString
934 var target_items
: NativeString
938 init with_pos
(tgt
: FlatString, pos
: Int)
941 target_items
= tgt
.items
942 curr_pos
= pos
+ tgt
.index_from
945 redef fun is_ok
do return curr_pos
>= 0
947 redef fun item
do return target_items
[curr_pos
]
949 redef fun next
do curr_pos
-= 1
951 redef fun index
do return curr_pos
- target
.index_from
955 private class FlatStringIterator
956 super IndexedIterator[Char]
958 var target
: FlatString
960 var target_items
: NativeString
964 init with_pos
(tgt
: FlatString, pos
: Int)
967 target_items
= tgt
.items
968 curr_pos
= pos
+ target
.index_from
971 redef fun is_ok
do return curr_pos
<= target
.index_to
973 redef fun item
do return target_items
[curr_pos
]
975 redef fun next
do curr_pos
+= 1
977 redef fun index
do return curr_pos
- target
.index_from
981 private class FlatStringCharView
984 redef type SELFTYPE: FlatString
988 # Check that the index (+ index_from) is not larger than indexTo
989 # In other terms, if the index is valid
991 var target
= self.target
992 assert (index
+ target
.index_from
) <= target
.index_to
993 return target
.items
[index
+ target
.index_from
]
996 redef fun iterator_from
(start
) do return new FlatStringIterator.with_pos
(target
, start
)
998 redef fun reverse_iterator_from
(start
) do return new FlatStringReverseIterator.with_pos
(target
, start
)
1002 abstract class Buffer
1005 redef type SELFTYPE: Buffer
1007 # Specific implementations MUST set this to `true` in order to invalidate caches
1008 protected var is_dirty
= true
1010 # Modifies the char contained at pos `index`
1012 # DEPRECATED : Use self.chars.[]= instead
1013 fun []=(index
: Int, item
: Char) is abstract
1015 # Adds a char `c` at the end of self
1017 # DEPRECATED : Use self.chars.add instead
1018 fun add
(c
: Char) is abstract
1022 # var b = new FlatBuffer
1024 # assert not b.is_empty
1027 fun clear
is abstract
1029 # Enlarges the subsequent array containing the chars of self
1030 fun enlarge
(cap
: Int) is abstract
1032 # Adds the content of text `s` at the end of self
1034 # var b = new FlatBuffer
1037 # assert b == "helloworld"
1038 fun append
(s
: Text) is abstract
1040 # `self` is appended in such a way that `self` is repeated `r` times
1042 # var b = new FlatBuffer
1045 # assert b == "hellohellohello"
1046 fun times
(r
: Int) is abstract
1048 # Reverses itself in-place
1050 # var b = new FlatBuffer
1053 # assert b == "olleh"
1054 fun reverse
is abstract
1056 # Changes each lower-case char in `self` by its upper-case variant
1058 # var b = new FlatBuffer
1059 # b.append("Hello World!")
1061 # assert b == "HELLO WORLD!"
1062 fun upper
is abstract
1064 # Changes each upper-case char in `self` by its lower-case variant
1066 # var b = new FlatBuffer
1067 # b.append("Hello World!")
1069 # assert b == "hello world!"
1070 fun lower
is abstract
1074 if is_dirty
then hash_cache
= null
1078 # In Buffers, the internal sequence of character is mutable
1079 # Thus, `chars` can be used to modify the buffer.
1080 redef fun chars
: Sequence[Char] is abstract
1083 # Mutable strings of characters.
1088 redef type SELFTYPE: FlatBuffer
1090 redef var chars
: Sequence[Char] = new FlatBufferCharView(self)
1092 private var capacity
: Int = 0
1094 redef fun substrings
do return new FlatSubstringsIter(self)
1096 redef fun []=(index
, item
)
1099 if index
== length
then
1103 assert index
>= 0 and index
< length
1110 if capacity
<= length
then enlarge
(length
+ 5)
1120 redef fun empty
do return new FlatBuffer
1122 redef fun enlarge
(cap
)
1125 if cap
<= c
then return
1126 while c
<= cap
do c
= c
* 2 + 2
1127 var a
= calloc_string
(c
+1)
1128 if length
> 0 then items
.copy_to
(a
, length
, 0, 0)
1133 redef fun to_s
: String
1135 return to_cstring
.to_s_with_length
(length
)
1138 redef fun to_cstring
1141 var new_native
= calloc_string
(length
+ 1)
1142 new_native
[length
] = '\0'
1143 if length
> 0 then items
.copy_to
(new_native
, length
, 0, 0)
1144 real_items
= new_native
1147 return real_items
.as(not null)
1150 # Create a new empty string.
1155 capacity
= s
.length
+ 1
1157 items
= calloc_string
(capacity
)
1158 if s
isa FlatString then
1159 s
.items
.copy_to
(items
, length
, s
.index_from
, 0)
1160 else if s
isa FlatBuffer then
1161 s
.items
.copy_to
(items
, length
, 0, 0)
1171 # Create a new empty string with a given capacity.
1172 init with_capacity
(cap
: Int)
1175 # _items = new NativeString.calloc(cap)
1176 items
= calloc_string
(cap
+1)
1183 if s
.is_empty
then return
1186 if capacity
< length
+ sl
then enlarge
(length
+ sl
)
1187 if s
isa FlatString then
1188 s
.items
.copy_to
(items
, sl
, s
.index_from
, length
)
1189 else if s
isa FlatBuffer then
1190 s
.items
.copy_to
(items
, sl
, 0, length
)
1192 var curr_pos
= self.length
1201 # Copies the content of self in `dest`
1202 fun copy
(start
: Int, len
: Int, dest
: Buffer, new_start
: Int)
1204 var self_chars
= self.chars
1205 var dest_chars
= dest
.chars
1206 for i
in [0..len-1
] do
1207 dest_chars
[new_start
+i
] = self_chars
[start
+i
]
1211 redef fun substring
(from
, count
)
1215 if from
< 0 then from
= 0
1216 if count
> length
then count
= length
1217 if from
< count
then
1218 var r
= new FlatBuffer.with_capacity
(count
- from
)
1219 while from
< count
do
1220 r
.chars
.push
(items
[from
])
1225 return new FlatBuffer
1231 var ns
= calloc_string
(capacity
)
1243 redef fun times
(repeats
)
1245 var x
= new FlatString.with_infos
(items
, length
, 0, length
- 1)
1246 for i
in [1..repeats
[ do
1256 it
[id
] = it
[id
].to_upper
1266 it
[id
] = it
[id
].to_lower
1272 private class FlatBufferReverseIterator
1273 super IndexedIterator[Char]
1275 var target
: FlatBuffer
1277 var target_items
: NativeString
1281 init with_pos
(tgt
: FlatBuffer, pos
: Int)
1284 if tgt
.length
> 0 then target_items
= tgt
.items
1288 redef fun index
do return curr_pos
1290 redef fun is_ok
do return curr_pos
>= 0
1292 redef fun item
do return target_items
[curr_pos
]
1294 redef fun next
do curr_pos
-= 1
1298 private class FlatBufferCharView
1299 super BufferCharView
1302 redef type SELFTYPE: FlatBuffer
1304 redef fun [](index
) do return target
.items
[index
]
1306 redef fun []=(index
, item
)
1308 assert index
>= 0 and index
<= length
1309 if index
== length
then
1313 target
.items
[index
] = item
1326 fun enlarge
(cap
: Int)
1333 var my_items
= target
.items
1334 var s_length
= s
.length
1335 if target
.capacity
< s
.length
then enlarge
(s_length
+ target
.length
)
1338 redef fun iterator_from
(pos
) do return new FlatBufferIterator.with_pos
(target
, pos
)
1340 redef fun reverse_iterator_from
(pos
) do return new FlatBufferReverseIterator.with_pos
(target
, pos
)
1344 private class FlatBufferIterator
1345 super IndexedIterator[Char]
1347 var target
: FlatBuffer
1349 var target_items
: NativeString
1353 init with_pos
(tgt
: FlatBuffer, pos
: Int)
1356 if tgt
.length
> 0 then target_items
= tgt
.items
1360 redef fun index
do return curr_pos
1362 redef fun is_ok
do return curr_pos
< target
.length
1364 redef fun item
do return target_items
[curr_pos
]
1366 redef fun next
do curr_pos
+= 1
1370 ###############################################################################
1372 ###############################################################################
1375 # User readable representation of `self`.
1376 fun to_s
: String do return inspect
1378 # The class name of the object in NativeString format.
1379 private fun native_class_name
: NativeString is intern
1381 # The class name of the object.
1383 # assert 5.class_name == "Int"
1384 fun class_name
: String do return native_class_name
.to_s
1386 # Developer readable representation of `self`.
1387 # Usually, it uses the form "<CLASSNAME:#OBJECTID bla bla bla>"
1390 return "<{inspect_head}>"
1393 # Return "CLASSNAME:#OBJECTID".
1394 # This function is mainly used with the redefinition of the inspect method
1395 protected fun inspect_head
: String
1397 return "{class_name}:#{object_id.to_hex}"
1400 protected fun args
: Sequence[String]
1407 # assert true.to_s == "true"
1408 # assert false.to_s == "false"
1421 # Wrapper of strerror C function
1422 private fun strerror_ext
: NativeString is extern `{
1423 return strerror(recv);
1426 # Returns a string describing error number
1427 fun strerror
: String do return strerror_ext
.to_s
1429 # Fill `s` with the digits in base `base` of `self` (and with the '-' sign if 'signed' and negative).
1430 # assume < to_c max const of char
1431 private fun fill_buffer
(s
: Buffer, base
: Int, signed
: Bool)
1438 else if self == 0 then
1445 var pos
= digit_count
(base
) - 1
1446 while pos
>= 0 and n
> 0 do
1447 s
.chars
[pos
] = (n
% base
).to_c
1453 # C function to convert an nit Int to a NativeString (char*)
1454 private fun native_int_to_s
(len
: Int): NativeString is extern "native_int_to_s"
1456 # return displayable int in base 10 and signed
1458 # assert 1.to_s == "1"
1459 # assert (-123).to_s == "-123"
1461 var len
= digit_count
(10)
1462 return native_int_to_s
(len
).to_s_with_length
(len
)
1465 # return displayable int in hexadecimal
1467 # assert 1.to_hex == "1"
1468 # assert (-255).to_hex == "-ff"
1469 fun to_hex
: String do return to_base
(16,false)
1471 # return displayable int in base base and signed
1472 fun to_base
(base
: Int, signed
: Bool): String
1474 var l
= digit_count
(base
)
1475 var s
= new FlatBuffer.from
(" " * l
)
1476 fill_buffer
(s
, base
, signed
)
1482 # Pretty print self, print needoed decimals up to a max of 3.
1484 # assert 12.34.to_s == "12.34"
1485 # assert (-0120.03450).to_s == "-120.035"
1487 # see `to_precision` for a different precision.
1489 var str
= to_precision
( 3 )
1490 if is_inf
!= 0 or is_nan
then return str
1491 var len
= str
.length
1492 for i
in [0..len-1
] do
1494 var c
= str
.chars
[j
]
1497 else if c
== '.' then
1498 return str
.substring
( 0, j
+2 )
1500 return str
.substring
( 0, j
+1 )
1506 # `self` representation with `nb` digits after the '.'.
1508 # assert 12.345.to_precision(1) == "12.3"
1509 # assert 12.345.to_precision(2) == "12.35"
1510 # assert 12.345.to_precision(3) == "12.345"
1511 # assert 12.345.to_precision(4) == "12.3450"
1512 fun to_precision
(nb
: Int): String
1514 if is_nan
then return "nan"
1516 var isinf
= self.is_inf
1519 else if isinf
== -1 then
1523 if nb
== 0 then return self.to_i
.to_s
1525 for i
in [0..nb
[ do f
= f
* 10.0
1532 if i
== 0 then return "0.0"
1536 var p1
= s
.substring
(0, s
.length-nb
)
1537 var p2
= s
.substring
(s
.length-nb
, nb
)
1538 return p1
+ "." + p2
1540 return "0." + ("0"*(nb-sl
)) + s
1544 # `self` representation with `nb` digits after the '.'.
1546 # assert 12.345.to_precision_native(1) == "12.3"
1547 # assert 12.345.to_precision_native(2) == "12.35"
1548 # assert 12.345.to_precision_native(3) == "12.345"
1549 # assert 12.345.to_precision_native(4) == "12.3450"
1550 fun to_precision_native
(nb
: Int): String import NativeString.to_s
`{
1554 size = snprintf(NULL, 0, "%.*f", (int)nb, recv);
1555 str = malloc(size + 1);
1556 sprintf(str, "%.*f", (int)nb, recv );
1558 return NativeString_to_s( str );
1563 # assert 'x'.to_s == "x"
1566 var s
= new FlatBuffer.with_capacity
(1)
1571 # Returns true if the char is a numerical digit
1573 # assert '0'.is_numeric
1574 # assert '9'.is_numeric
1575 # assert not 'a'.is_numeric
1576 # assert not '?'.is_numeric
1577 fun is_numeric
: Bool
1579 return self >= '0' and self <= '9'
1582 # Returns true if the char is an alpha digit
1584 # assert 'a'.is_alpha
1585 # assert 'Z'.is_alpha
1586 # assert not '0'.is_alpha
1587 # assert not '?'.is_alpha
1590 return (self >= 'a' and self <= 'z') or (self >= 'A' and self <= 'Z')
1593 # Returns true if the char is an alpha or a numeric digit
1595 # assert 'a'.is_alphanumeric
1596 # assert 'Z'.is_alphanumeric
1597 # assert '0'.is_alphanumeric
1598 # assert '9'.is_alphanumeric
1599 # assert not '?'.is_alphanumeric
1600 fun is_alphanumeric
: Bool
1602 return self.is_numeric
or self.is_alpha
1606 redef class Collection[E
]
1607 # Concatenate elements.
1610 var s
= new FlatBuffer
1611 for e
in self do if e
!= null then s
.append
(e
.to_s
)
1615 # Concatenate and separate each elements with `sep`.
1617 # assert [1, 2, 3].join(":") == "1:2:3"
1618 # assert [1..3].join(":") == "1:2:3"
1619 fun join
(sep
: Text): String
1621 if is_empty
then return ""
1623 var s
= new FlatBuffer # Result
1628 if e
!= null then s
.append
(e
.to_s
)
1630 # Concat other items
1635 if e
!= null then s
.append
(e
.to_s
)
1642 redef class Array[E
]
1643 # Fast implementation
1646 var s
= new FlatBuffer
1651 if e
!= null then s
.append
(e
.to_s
)
1658 redef class Map[K
,V
]
1659 # Concatenate couple of 'key value'.
1660 # key and value are separated by `couple_sep`.
1661 # each couple is separated each couple with `sep`.
1663 # var m = new ArrayMap[Int, String]
1666 # assert m.join("; ", "=") == "1=one; 10=ten"
1667 fun join
(sep
: String, couple_sep
: String): String
1669 if is_empty
then return ""
1671 var s
= new FlatBuffer # Result
1677 s
.append
("{k}{couple_sep}{e or else "<null>"}")
1679 # Concat other items
1685 s
.append
("{k}{couple_sep}{e or else "<null>"}")
1692 ###############################################################################
1694 ###############################################################################
1696 # Native strings are simple C char *
1697 extern class NativeString `{ char* `}
1700 fun [](index: Int): Char is intern
1701 fun []=(index: Int, item: Char) is intern
1702 fun copy_to(dest: NativeString, length: Int, from: Int, to: Int) is intern
1704 # Position of the first nul character.
1705 fun cstring_length: Int
1708 while self[l] != '\0' do l += 1
1711 fun atoi: Int is intern
1712 fun atof: Float is extern "atof"
1716 return to_s_with_length(cstring_length)
1719 fun to_s_with_length(length: Int): FlatString
1722 return new FlatString.with_infos(self, length, 0, length - 1)
1725 fun to_s_with_copy: FlatString
1727 var length = cstring_length
1728 var new_self = calloc_string(length + 1)
1729 copy_to(new_self, length, 0, 0)
1730 return new FlatString.with_infos(new_self, length, 0, length - 1)
1734 # StringCapable objects can create native strings
1735 interface StringCapable
1736 protected fun calloc_string(size: Int): NativeString is intern
1740 var _args_cache: nullable Sequence[String]
1742 redef fun args: Sequence[String]
1744 if _args_cache == null then init_args
1745 return _args_cache.as(not null)
1748 # The name of the program as given by the OS
1749 fun program_name: String
1751 return native_argv(0).to_s
1754 # Initialize `args
` with the contents of `native_argc
` and `native_argv
`.
1755 private fun init_args
1757 var argc = native_argc
1758 var args = new Array[String].with_capacity(0)
1761 args[i-1] = native_argv(i).to_s
1767 # First argument of the main C function.
1768 private fun native_argc: Int is intern
1770 # Second argument of the main C function.
1771 private fun native_argv(i: Int): NativeString is intern
1774 # Comparator that efficienlty use `to_s
` to compare things
1776 # The comparaison call `to_s
` on object and use the result to order things.
1778 # var a = [1, 2, 3, 10, 20]
1779 # (new CachedAlphaComparator).sort(a)
1780 # assert a == [1, 10, 2, 20, 3]
1782 # Internally the result of `to_s
` is cached in a HashMap to counter
1783 # uneficient implementation of `to_s
`.
1785 # Note: it caching is not usefull, see `alpha_comparator
`
1786 class CachedAlphaComparator
1787 super Comparator[Object]
1789 private var cache = new HashMap[Object, String]
1791 private fun do_to_s(a: Object): String do
1792 if cache.has_key(a) then return cache[a]
1798 redef fun compare(a, b) do
1799 return do_to_s(a) <=> do_to_s(b)
1803 # see `alpha_comparator
`
1804 private class AlphaComparator
1805 super Comparator[Object]
1806 redef fun compare(a, b) do return a.to_s <=> b.to_s
1809 # Stateless comparator that naively use `to_s
` to compare things.
1811 # Note: the result of `to_s
` is not cached, thus can be invoked a lot
1812 # on a single instace. See `CachedAlphaComparator` as an alternative.
1814 # var a = [1, 2, 3, 10, 20]
1815 # alpha_comparator.sort(a)
1816 # assert a == [1, 10, 2, 20, 3]
1817 fun alpha_comparator: Comparator[Object] do return once new AlphaComparator