note description: "[ Sequences of 8-bit characters, accessible through integer indices in a contiguous range. Read-only interface. ]" library: "Free implementation of ELKS library" status: "See notice at end of class." legal: "See notice at end of class." date: "$Date: 2020-05-19 14:32:38 +0000 (Tue, 19 May 2020) $" revision: "$Revision: 104260 $" deferred class READABLE_STRING_8 inherit READABLE_STRING_GENERAL rename ends_with as ends_with_general, has as character_32_has, index_of as character_32_index_of, is_case_insensitive_equal as is_case_insensitive_equal_general, item as character_32_item, last_index_of as character_32_last_index_of, occurrences as character_32_occurrences, plus as plus_general, same_caseless_characters as same_caseless_characters_general, same_characters as same_characters_general, same_string as same_string_general, starts_with as starts_with_general redefine copy, is_equal, out end READABLE_INDEXABLE [CHARACTER_8] rename upper as count redefine copy, is_equal, new_cursor, out end convert to_cil: {SYSTEM_STRING}, as_string_8: {STRING_8}, as_readable_string_32: {READABLE_STRING_32}, as_string_32: {STRING_32} feature {NONE} -- Initialization make (n: INTEGER_32) -- Allocate space for at least n characters. do count := 0 internal_hash_code := 0 internal_case_insensitive_hash_code := 0 create area.make_filled ('%U', n + 1) end make_filled (c: CHARACTER_8; n: INTEGER_32) -- Create string of length n filled with c. require valid_count: n >= 0 do make (n) fill_character (c) ensure count_set: count = n area_allocated: capacity >= n filled: occurrences (c) = count end make_from_string (s: READABLE_STRING_8) -- Initialize from the characters of s. require string_exists: s /= Void do area := s.area count := s.count internal_hash_code := 0 internal_case_insensitive_hash_code := 0 if Current /= s then create area.make_empty (count + 1); area.copy_data (s.area, s.area_lower, 0, count + 1) end ensure not_shared_implementation: Current /= s implies not shared_with (s) initialized: same_string (s) end make_from_c (c_string: POINTER) -- Initialize from contents of c_string, -- a string created by some C function. require c_string_exists: c_string /= default_pointer local l_count: INTEGER_32 do C_string_provider.set_shared_from_pointer (c_string) l_count := C_string_provider.count create area.make_filled ('%U', l_count + 1) count := l_count internal_hash_code := 0 internal_case_insensitive_hash_code := 0; C_string_provider.read_substring_into_character_8_area (area, 1, l_count) end make_from_c_byte_array (a_byte_array: POINTER; a_character_count: INTEGER_32) -- Initialize from contents of a_byte_array for a length of a_character_count, -- given that each character is encoded in 1 single byte. -- ex: (char*) "abc" for STRING_8 "abc" require a_byte_array_exists: not a_byte_array.is_default_pointer do C_string_provider.set_shared_from_pointer_and_count (a_byte_array, a_character_count) create area.make_filled ('%U', a_character_count + 1) count := a_character_count internal_hash_code := 0; C_string_provider.read_substring_into_character_8_area (area, 1, a_character_count) end make_from_c_substring (c_string: POINTER; start_pos, end_pos: INTEGER_32) -- Initialize from substring of c_string, -- between start_pos and end_pos, -- c_string created by some C function. require c_string_exists: c_string /= default_pointer start_position_big_enough: start_pos >= 1 end_position_big_enough: start_pos <= end_pos + 1 local l_count: INTEGER_32 do l_count := end_pos - start_pos + 1; C_string_provider.set_shared_from_pointer_and_count (c_string + (start_pos - 1), l_count) create area.make_filled ('%U', l_count + 1) count := l_count internal_hash_code := 0 internal_case_insensitive_hash_code := 0; C_string_provider.read_substring_into_character_8_area (area, 1, l_count) end make_from_c_pointer (c_string: POINTER) obsolete "Use `make_from_c' instead. [2017-05-31]" -- Create new instance from contents of c_string, -- a string created by some C function. require c_string_exists: c_string /= default_pointer do make_from_c (c_string) end make_from_cil (a_system_string: detachable SYSTEM_STRING) -- Initialize Current with a_system_string. require is_dotnet: {PLATFORM}.is_dotnet deferred end make_from_separate (other: separate READABLE_STRING_8) -- Initialize current string from other. require other_not_void: other /= Void local i, nb: INTEGER_32 l_area: like area do nb := other.count make (nb) from l_area := area i := 0 until i = nb loop l_area.put (other.area.item (i), i) i := i + 1 end count := nb ensure same_string: end feature -- Access item alias "[]" (i: INTEGER_32): CHARACTER_8 -- Character at position i. -- Was declared in READABLE_STRING_8 as synonym of at. deferred end at alias "@" (i: INTEGER_32): CHARACTER_8 -- Character at position i. -- Was declared in READABLE_STRING_8 as synonym of item. deferred end item_code (i: INTEGER_32): INTEGER_32 obsolete "For consistency with Unicode string handling, use `code (i)' instead. [2017-05-31]" -- Numeric code of character at position i. require index_small_enough: i <= count index_large_enough: i > 0 deferred end shared_with (other: READABLE_STRING_8): BOOLEAN -- Does string share the text of other? do Result := (other /= Void) and then (area = other.area) end index_of (c: CHARACTER_8; start_index: INTEGER_32): INTEGER_32 -- Position of first occurrence of c at or after start_index; -- 0 if none. require start_large_enough: start_index >= 1 start_small_enough: start_index <= count + 1 local a: like area i, nb, l_lower_area: INTEGER_32 do nb := count if start_index <= nb then from l_lower_area := area_lower i := start_index - 1 + l_lower_area nb := nb + l_lower_area a := area until i = nb or else a.item (i) = c loop i := i + 1 end if i < nb then Result := i + 1 - l_lower_area end end ensure valid_result: Result = 0 or (start_index <= Result and Result <= count) zero_if_absent: (Result = 0) = not substring (start_index, count).has (c) found_if_present: substring (start_index, count).has (c) implies item (Result) = c none_before: substring (start_index, count).has (c) implies not substring (start_index, Result - 1).has (c) end last_index_of (c: CHARACTER_8; start_index_from_end: INTEGER_32): INTEGER_32 -- Position of last occurrence of c, -- 0 if none. require start_index_small_enough: start_index_from_end <= count start_index_large_enough: start_index_from_end >= 1 local a: like area i, l_lower_area: INTEGER_32 do from l_lower_area := area_lower i := start_index_from_end - 1 + l_lower_area a := area until i < l_lower_area or else a.item (i) = c loop i := i - 1 end Result := i + 1 - l_lower_area ensure valid_result: 0 <= Result and Result <= start_index_from_end zero_if_absent: (Result = 0) = not substring (1, start_index_from_end).has (c) found_if_present: substring (1, start_index_from_end).has (c) implies item (Result) = c none_after: substring (1, start_index_from_end).has (c) implies not substring (Result + 1, start_index_from_end).has (c) end substring_index_in_bounds (other: READABLE_STRING_GENERAL; start_pos, end_pos: INTEGER_32): INTEGER_32 -- Position of first occurrence of other at or after start_pos -- and to or before end_pos; -- 0 if none. do Result := String_searcher.substring_index (Current, other, start_pos, end_pos) end string: STRING_8 -- New STRING_8 having same character sequence as Current. do create Result.make_from_string (Current) ensure string_not_void: Result /= Void string_type: Result.same_type (create {STRING_8}.make_empty) first_item: count > 0 implies Result.item (1) = item (1) recurse: count > 1 implies Result.substring (2, count) ~ substring (2, count).string end string_representation: STRING_8 -- Similar to string but only create a new object if Current is not of dynamic type STRING_8. do if same_type (create {STRING_8}.make_empty) and then attached {STRING_8} Current as l_s8 then Result := l_s8 else Result := string end ensure result_not_void: Result /= Void correct_type: Result.same_type (create {STRING_8}.make_empty) first_item: count > 0 implies Result.item (1) = item (1) recurse: count > 1 implies Result.substring (2, count) ~ substring (2, count).string end substring_index (other: READABLE_STRING_GENERAL; start_index: INTEGER_32): INTEGER_32 -- Index of first occurrence of other at or after start_index; -- 0 if none do Result := String_searcher.substring_index (Current, other, start_index, count) end fuzzy_index (other: READABLE_STRING_GENERAL; start: INTEGER_32; fuzz: INTEGER_32): INTEGER_32 -- Position of first occurrence of other at or after start -- with 0..fuzz mismatches between the string and other. -- 0 if there are no fuzzy matches do Result := String_searcher.fuzzy_index (Current, other, start, count, fuzz) end new_cursor: STRING_8_ITERATION_CURSOR -- Fresh cursor associated with current structure do create Result.make (Current) end feature -- Measurement capacity: INTEGER_32 -- Number of characters allocated in Current do Result := area.count - 1 end count: INTEGER_32 -- Actual number of characters making up the string. occurrences (c: CHARACTER_8): INTEGER_32 -- Number of times c appears in the string. local i, nb: INTEGER_32 a: SPECIAL [CHARACTER_8] do from i := area_lower nb := count + i a := area until i = nb loop if a.item (i) = c then Result := Result + 1 end i := i + 1 end ensure then zero_if_empty: count = 0 implies Result = 0 recurse_if_not_found_at_first_position: (count > 0 and then item (1) /= c) implies Result = substring (2, count).occurrences (c) recurse_if_found_at_first_position: (count > 0 and then item (1) = c) implies Result = 1 + substring (2, count).occurrences (c) end Lower: INTEGER_32 = 1 -- Minimum index. feature -- Comparison is_equal (other: like Current): BOOLEAN -- Is string made of same character sequence as other -- (possibly with a different capacity)? local nb: INTEGER_32 l_hash, l_other_hash: like internal_hash_code do if other = Current then Result := True else nb := count if nb = other.count then l_hash := internal_hash_code l_other_hash := other.internal_hash_code if l_hash = 0 or else l_other_hash = 0 or else l_hash = l_other_hash then Result := area.same_items (other.area, other.area_lower, area_lower, nb) end end end end is_case_insensitive_equal (other: READABLE_STRING_8): BOOLEAN -- Is string made of same character sequence as other regardless of casing -- (possibly with a different capacity)? require other_not_void: other /= Void local nb: INTEGER_32 do if other = Current then Result := True else nb := count if nb = other.count then Result := nb = 0 or else same_caseless_characters (other, 1, nb, 1) end end ensure symmetric: Result implies other.is_case_insensitive_equal (Current) consistent: attached {like Current} other as l_other implies (standard_is_equal (l_other) implies Result) valid_result: as_lower.same_string (other.as_lower) implies Result end same_caseless_characters (other: READABLE_STRING_8; start_pos, end_pos, index_pos: INTEGER_32): BOOLEAN -- Are characters of other within bounds start_pos and end_pos -- caseless identical to characters of current string starting at index index_pos. require other_not_void: other /= Void valid_start_pos: other.valid_index (start_pos) valid_end_pos: other.valid_index (end_pos) valid_bounds: (start_pos <= end_pos) or (start_pos = end_pos + 1) valid_index_pos: valid_index (index_pos) local i, j, nb: INTEGER_32 l_area, l_other_area: like area c1, c2: CHARACTER_8 do nb := end_pos - start_pos + 1 if nb <= count - index_pos + 1 then from l_area := area l_other_area := other.area Result := True i := area_lower + index_pos - 1 j := other.area_lower + start_pos - 1 nb := nb + i variant increasing_index: l_area.upper - i + 1 until i = nb loop c1 := l_area.item (i) c2 := l_other_area.item (j) if c1 /= c2 and then c1.as_lower /= c2.as_lower then Result := False i := nb - 1 end i := i + 1 j := j + 1 end end ensure same_characters: Result = substring (index_pos, index_pos + end_pos - start_pos).is_case_insensitive_equal (other.substring (start_pos, end_pos)) end same_string (other: READABLE_STRING_8): BOOLEAN -- Do Current and other have same character sequence? require other_not_void: other /= Void local nb: INTEGER_32 do if other = Current then Result := True else nb := count if nb = other.count then Result := nb = 0 or else same_characters (other, 1, nb, 1) end end ensure definition: Result = (string ~ other.string) end same_characters (other: READABLE_STRING_8; start_pos, end_pos, index_pos: INTEGER_32): BOOLEAN -- Are characters of other within bounds start_pos and end_pos -- identical to characters of current string starting at index index_pos. require other_not_void: other /= Void valid_start_pos: other.valid_index (start_pos) valid_end_pos: other.valid_index (end_pos) valid_bounds: (start_pos <= end_pos) or (start_pos = end_pos + 1) valid_index_pos: valid_index (index_pos) local nb: INTEGER_32 do nb := end_pos - start_pos + 1 if nb <= count - index_pos + 1 then Result := area.same_items (other.area, other.area_lower + start_pos - 1, area_lower + index_pos - 1, nb) end ensure same_characters: Result = substring (index_pos, index_pos + end_pos - start_pos).same_string (other.substring (start_pos, end_pos)) end is_less alias "<" (other: like Current): BOOLEAN -- Is string lexicographically lower than other? local other_count: INTEGER_32 current_count: INTEGER_32 do if other /= Current then other_count := other.count current_count := count if other_count = current_count then Result := str_strict_cmp (other.area, area, other.area_lower, area_lower, other_count) > 0 else if current_count < other_count then Result := str_strict_cmp (other.area, area, other.area_lower, area_lower, current_count) >= 0 else Result := str_strict_cmp (other.area, area, other.area_lower, area_lower, other_count) > 0 end end end end feature -- Status report Is_string_8: BOOLEAN = True -- Is Current a sequence of CHARACTER_8? Is_string_32: BOOLEAN = False -- Is Current a sequence of CHARACTER_32? Is_valid_as_string_8: BOOLEAN = True -- Is Current convertible to a sequence of CHARACTER_8 without information loss? is_substring_whitespace (start_index, end_index: INTEGER_32): BOOLEAN -- Is substring between start_index and end_index containing only whitespace characters? local i, n: INTEGER_32 l_area: like area do from l_area := area i := area_lower + start_index - 1 n := area_lower + end_index - 1 until i > n or not l_area.item (i).is_space loop i := i + 1 end Result := i > n end has (c: CHARACTER_8): BOOLEAN -- Does string include c? local i, nb: INTEGER_32 l_area: like area do nb := count if nb > 0 then from i := area_lower l_area := area nb := nb + i until i = nb or else (l_area.item (i) = c) loop i := i + 1 end Result := i < nb end ensure false_if_empty: count = 0 implies not Result true_if_first: count > 0 and then item (1) = c implies Result recurse: (count > 0 and then item (1) /= c) implies (Result = substring (2, count).has (c)) end starts_with (s: READABLE_STRING_8): BOOLEAN -- Does string begin with s? require argument_not_void: s /= Void local i, j, nb: INTEGER_32 l_area, l_s_area: like area do if Current = s then Result := True else i := s.count if i <= count then from l_area := area l_s_area := s.area j := area_lower + i i := s.area_upper + 1 nb := s.area_lower Result := True until i = nb loop i := i - 1 j := j - 1 if l_area.item (j) /= l_s_area.item (i) then Result := False i := nb end end end end ensure definition: Result = s.same_string (substring (1, s.count)) end ends_with (s: READABLE_STRING_8): BOOLEAN -- Does string finish with s? require argument_not_void: s /= Void local i, j, nb: INTEGER_32 l_area, l_s_area: like area do if Current = s then Result := True else i := s.count j := count if i <= j then from l_area := area l_s_area := s.area j := area_upper + 1 i := s.area_upper + 1 nb := s.area_lower Result := True until i = nb loop i := i - 1 j := j - 1 if l_area.item (j) /= l_s_area.item (i) then Result := False i := nb end end end end ensure definition: Result = s.same_string (substring (count - s.count + 1, count)) end valid_code (v: NATURAL_32): BOOLEAN -- Is v a valid code for a CHARACTER_32? do Result := v <= {CHARACTER_8}.max_value.to_natural_32 end is_boolean: BOOLEAN -- Does Current represent a BOOLEAN? local nb: INTEGER_32 l_area: like area i: INTEGER_32 do nb := count if nb = 4 then l_area := area i := area_lower Result := l_area.item (i).lower = 't' and then l_area.item (i + 1).lower = 'r' and then l_area.item (i + 2).lower = 'u' and then l_area.item (i + 3).lower = 'e' elseif nb = 5 then l_area := area i := area_lower Result := l_area.item (i).lower = 'f' and then l_area.item (i + 1).lower = 'a' and then l_area.item (i + 2).lower = 'l' and then l_area.item (i + 3).lower = 's' and then l_area.item (i + 4).lower = 'e' end end feature -- Duplication copy (other: like Current) -- Reinitialize by copying the characters of other. -- (This is also used by twin.) local old_area: like area do if other /= Current then old_area := area standard_copy (other) if old_area = Void or else old_area = other.area or else old_area.count <= count then area := area.resized_area (count + 1) else old_area.copy_data (area, 0, 0, count) area := old_area end internal_hash_code := 0 internal_case_insensitive_hash_code := 0 end ensure then new_result_count: count = other.count end feature -- Basic operations plus alias "+" (s: READABLE_STRING_8): like Current -- Concatenation with s. require argument_attached: attached s deferred ensure plus_attached: attached Result new_count: Result.count = count + s.count initial: Elks_checking implies Result.substring (1, count) ~ Current final: Elks_checking implies Result.substring (count + 1, count + s.count).same_string (s) end feature {NONE} -- Element change fill_character (c: CHARACTER_8) -- Fill with capacity characters all equal to c. local l_cap: like capacity do l_cap := capacity if l_cap /= 0 then area.fill_with (c, 0, l_cap - 1) count := l_cap internal_hash_code := 0 internal_case_insensitive_hash_code := 0 end ensure filled: count = capacity same_size: capacity = old capacity end feature -- Conversion mirrored: like Current -- Mirror image of string; -- Result for "Hello world" is "dlrow olleH". deferred ensure same_count: Result.count = count end feature -- Duplication substring (start_index, end_index: INTEGER_32): like Current -- Copy of substring containing all characters at indices -- between start_index and end_index deferred end feature -- Output out: STRING_8 -- New string containing terse printable representation -- of current object do create Result.make (count); Result.append_string_general (Current) ensure then out_not_void: Result /= Void same_items: same_type ("") implies Result.same_string_general (Current) end feature {NONE} -- Implementation String_searcher: STRING_8_SEARCHER -- String searcher specialized for READABLE_STRING_8 instances. once create Result.make end str_strict_cmp (this, other: like area; this_index, other_index, n: INTEGER_32): INTEGER_32 -- Compare n characters from this starting at this_index with -- n characters from and other starting at other_index. -- 0 if equal, < 0 if this < other, -- > 0 if this > other require this_not_void: this /= Void other_not_void: other /= Void n_non_negative: n >= 0 n_valid: n <= (this.upper - this_index + 1) and n <= (other.upper - other_index + 1) local i, j, nb, l_current_code, l_other_code: INTEGER_32 do from i := this_index nb := i + n j := other_index until i = nb loop l_current_code := this.item (i).code l_other_code := other.item (j).code if l_current_code /= l_other_code then Result := l_current_code - l_other_code i := nb - 1 end i := i + 1 j := j + 1 end end to_lower_area (a: like area; start_index, end_index: INTEGER_32) -- Replace all characters in a between start_index and end_index -- with their lower version. require a_not_void: a /= Void start_index_non_negative: start_index >= 0 start_index_not_too_big: start_index <= end_index + 1 end_index_valid: end_index < a.count local i: INTEGER_32 do from i := start_index until i > end_index loop a.put (a.item (i).lower, i) i := i + 1 end end to_upper_area (a: like area; start_index, end_index: INTEGER_32) -- Replace all characters in a between start_index and end_index -- with their upper version. require a_not_void: a /= Void start_index_non_negative: start_index >= 0 start_index_not_too_big: start_index <= end_index + 1 end_index_valid: end_index < a.count local i: INTEGER_32 do from i := start_index until i > end_index loop a.put (a.item (i).upper, i) i := i + 1 end end mirror_area (a: like area; start_index, end_index: INTEGER_32) -- Mirror all characters in a between start_index and end_index. require a_not_void: a /= Void start_index_non_negative: start_index >= 0 start_index_not_too_big: start_index <= end_index + 1 end_index_valid: end_index < a.count local c: CHARACTER_8 i, j: INTEGER_32 do from i := end_index until i <= j loop c := a.item (i); a.put (a.item (j), i); a.put (c, j) i := i - 1 j := j + 1 end end feature {READABLE_STRING_8, READABLE_STRING_32, STRING_8_SEARCHER, STRING_32_SEARCHER, HEXADECIMAL_STRING_TO_INTEGER_CONVERTER, STRING_TO_INTEGER_CONVERTOR, STRING_TO_REAL_CONVERTOR, STRING_8_ITERATION_CURSOR, IO_MEDIUM} -- Implementation area: SPECIAL [CHARACTER_8] -- Storage for characters. area_lower: INTEGER_32 -- Minimum index. do ensure area_lower_non_negative: Result >= 0 area_lower_valid: Result <= area.upper end area_upper: INTEGER_32 -- Maximum index. do Result := area_lower + count - 1 ensure area_upper_valid: Result <= area.upper area_upper_in_bound: area_lower <= Result + 1 end invariant area_not_void: area /= Void note copyright: "Copyright (c) 1984-2020, Eiffel Software and others" license: "Eiffel Forum License v2 (see http://www.eiffel.com/licensing/forum.txt)" source: "[ Eiffel Software 5949 Hollister Ave., Goleta, CA 93117 USA Telephone 805-685-1006, Fax 805-685-6869 Website http://www.eiffel.com Customer support http://support.eiffel.com ]" end -- class READABLE_STRING_8
Generated by ISE EiffelStudio