note description: "Common ancestors to all STRING classes. 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-12 20:58:01 +0000 (Tue, 12 May 2020) $" revision: "$Revision: 104181 $" deferred class READABLE_STRING_GENERAL convert as_string_32: {READABLE_STRING_32, STRING_32} feature {NONE} -- Initialization default_create -- Process instances of classes with no creation clause. -- (Default: do nothing.) -- (from ANY) do end make (n: INTEGER_32) require non_negative_size: n >= 0 deferred ensure empty_string: count = 0 area_allocated: capacity >= n end make_empty -- Create empty string. do make (0) ensure empty: count = 0 area_allocated: capacity >= 0 end feature -- Access case_insensitive_hash_code: INTEGER_32 -- Hash code value of the lower case version of Current. local l_props: like Character_properties i, nb: INTEGER_32 do Result := internal_case_insensitive_hash_code if Result = 0 then from i := 1 nb := count l_props := Character_properties until i > nb loop Result := ((Result \\ 8388593) |<< 8) + l_props.to_lower (item (i)).code i := i + 1 end internal_case_insensitive_hash_code := Result end ensure consistent: Result = as_lower.case_insensitive_hash_code end code (i: INTEGER_32): NATURAL_32 -- Code at position i require valid_index: valid_index (i) deferred end False_constant: STRING_8 = "false" -- Constant string "false" generating_type: TYPE [detachable READABLE_STRING_GENERAL] -- Type of current object -- (type of which it is a direct instance) -- (from ANY) external "built_in" ensure -- from ANY generating_type_not_void: Result /= Void end generator: STRING_8 -- Name of current object's generating class -- (base class of the type of which it is a direct instance) -- (from ANY) external "built_in" ensure -- from ANY generator_not_void: Result /= Void generator_not_empty: not Result.is_empty end hash_code: INTEGER_32 -- Hash code value local i, nb: INTEGER_32 do Result := internal_hash_code if Result = 0 then from i := 1 nb := count until i > nb loop Result := ((Result \\ 8388593) |<< 8) + item (i).code i := i + 1 end internal_hash_code := Result end ensure -- from HASHABLE good_hash_value: Result >= 0 end index_of (c: like item; 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 i, nb: INTEGER_32 do nb := count if start_index <= nb then from i := start_index until i > nb or else item (i) = c loop i := i + 1 end if i <= nb then Result := i 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 index_of_code (c: like code; 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 i, nb: INTEGER_32 do nb := count if start_index <= nb then from i := start_index until i > nb or else code (i) = c loop i := i + 1 end if i <= nb then Result := i 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_code (c) found_if_present: substring (start_index, count).has_code (c) implies code (Result) = c none_before: substring (start_index, count).has_code (c) implies not substring (start_index, Result - 1).has_code (c) end item alias "[]" (i: INTEGER_32): CHARACTER_32 -- Character at position i. require valid_index: valid_index (i) deferred end last_index_of (c: like item; 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 do from Result := start_index_from_end until Result <= 0 or else item (Result) = c loop Result := Result - 1 end 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 last_index_of_code (c: like code; 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 do from Result := start_index_from_end until Result <= 0 or else code (Result) = c loop Result := Result - 1 end ensure valid_result: 0 <= Result and Result <= start_index_from_end zero_if_absent: (Result = 0) = not substring (1, start_index_from_end).has_code (c) found_if_present: substring (1, start_index_from_end).has_code (c) implies code (Result) = c none_after: substring (1, start_index_from_end).has_code (c) implies not substring (Result + 1, start_index_from_end).has_code (c) end True_constant: STRING_8 = "true" -- Constant string "true" feature -- Measurement capacity: INTEGER_32 -- Number of characters allocated in Current deferred ensure capacity_non_negative: Result >= 0 end count: INTEGER_32 -- Number of characters in Current deferred ensure count_non_negative: Result >= 0 end occurrences (c: CHARACTER_32): INTEGER_32 -- Number of times c appears in the string local i, nb: INTEGER_32 do nb := count if nb > 0 then from i := 1 until i > nb loop if item (i) = c then Result := Result + 1 end i := i + 1 end 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 feature -- Comparison frozen deep_equal (a: detachable ANY; b: like arg #1): BOOLEAN -- Are a and b either both void -- or attached to isomorphic object structures? -- (from ANY) do if a = Void then Result := b = Void else Result := b /= Void and then a.is_deep_equal (b) end ensure -- from ANY instance_free: class shallow_implies_deep: standard_equal (a, b) implies Result both_or_none_void: (a = Void) implies (Result = (b = Void)) same_type: (Result and (a /= Void)) implies (b /= Void and then a.same_type (b)) symmetric: Result implies deep_equal (b, a) end ends_with (s: READABLE_STRING_GENERAL): BOOLEAN -- Does string finish with s? require argument_not_void: s /= Void local i, j: INTEGER_32 do if Current = s then Result := True else i := s.count j := count if i <= j then from Result := True until i = 0 loop if code (j) /= s.code (i) then Result := False i := 1 end i := i - 1 j := j - 1 end end end ensure definition: Result = s.same_string (substring (count - s.count + 1, count)) end frozen equal (a: detachable ANY; b: like arg #1): BOOLEAN -- Are a and b either both void or attached -- to objects considered equal? -- (from ANY) do if a = Void then Result := b = Void else Result := b /= Void and then a.is_equal (b) end ensure -- from ANY instance_free: class definition: Result = (a = Void and b = Void) or else ((a /= Void and b /= Void) and then a.is_equal (b)) 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 require other_exists: other /= Void other_not_empty: not other.is_empty start_large_enough: start >= 1 start_small_enough: start <= count acceptable_fuzzy: fuzz <= other.count deferred end has_substring (other: READABLE_STRING_GENERAL): BOOLEAN -- Does Current contain other? require other_not_void: other /= Void do if other = Current then Result := True elseif other.count <= count then Result := substring_index (other, 1) > 0 end ensure false_if_too_small: count < other.count implies not Result true_if_initial: (count >= other.count and then other.same_string (substring (1, other.count))) implies Result recurse: (count >= other.count and then not other.same_string (substring (1, other.count))) implies (Result = substring (2, count).has_substring (other)) end is_case_insensitive_equal (other: READABLE_STRING_GENERAL): BOOLEAN -- Is string made of same character sequence as other regardless of casing -- (possibly with a different capacity)? 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 ~ other.as_lower implies Result end frozen is_deep_equal alias "≡≡≡" (other: READABLE_STRING_GENERAL): BOOLEAN -- Are Current and other attached to isomorphic object structures? -- (from ANY) require -- from ANY other_not_void: other /= Void external "built_in" ensure -- from ANY shallow_implies_deep: standard_is_equal (other) implies Result same_type: Result implies same_type (other) symmetric: Result implies other.is_deep_equal (Current) end is_equal (other: READABLE_STRING_GENERAL): BOOLEAN -- Is other attached to an object of the same type -- as current object and identical to it? -- (from COMPARABLE) require -- from ANY other_not_void: other /= Void do Result := not (Current < other) and not (other < Current) ensure -- from ANY symmetric: Result implies other ~ Current consistent: standard_is_equal (other) implies Result ensure then -- from COMPARABLE trichotomy: Result = (not (Current < other) and not (other < Current)) end is_greater alias ">" (other: READABLE_STRING_GENERAL): BOOLEAN -- Is current object greater than other? -- (from COMPARABLE) require -- from PART_COMPARABLE other_exists: other /= Void do Result := other < Current ensure then -- from COMPARABLE definition: Result = (other < Current) end is_greater_equal alias ">=" alias "≥" (other: READABLE_STRING_GENERAL): BOOLEAN -- Is current object greater than or equal to other? -- (from COMPARABLE) require -- from PART_COMPARABLE other_exists: other /= Void do Result := not (Current < other) ensure then -- from COMPARABLE definition: Result = (other <= Current) end is_less alias "<" (other: READABLE_STRING_GENERAL): BOOLEAN -- Is current object less than other? -- (from COMPARABLE) require -- from PART_COMPARABLE other_exists: other /= Void deferred ensure then -- from COMPARABLE asymmetric: Result implies not (other < Current) end is_less_equal alias "<=" alias "≤" (other: READABLE_STRING_GENERAL): BOOLEAN -- Is current object less than or equal to other? -- (from COMPARABLE) require -- from PART_COMPARABLE other_exists: other /= Void do Result := not (other < Current) ensure then -- from COMPARABLE definition: Result = ((Current < other) or (Current ~ other)) end max alias "∨" (other: READABLE_STRING_GENERAL): READABLE_STRING_GENERAL -- The greater of current object and other -- (from COMPARABLE) require -- from COMPARABLE other_exists: other /= Void do if Current >= other then Result := Current else Result := other end ensure -- from COMPARABLE current_if_not_smaller: Current >= other implies Result = Current other_if_smaller: Current < other implies Result = other end min alias "∧" (other: READABLE_STRING_GENERAL): READABLE_STRING_GENERAL -- The smaller of current object and other -- (from COMPARABLE) require -- from COMPARABLE other_exists: other /= Void do if Current <= other then Result := Current else Result := other end ensure -- from COMPARABLE current_if_not_greater: Current <= other implies Result = Current other_if_greater: Current > other implies Result = other end same_caseless_characters (other: READABLE_STRING_GENERAL; 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_prop: like Character_properties c1, c2: like item do nb := end_pos - start_pos + 1 if nb <= count - index_pos + 1 then from l_prop := Character_properties Result := True i := index_pos j := start_pos nb := nb + i variant increasing_index: nb - i + 1 until i = nb loop c1 := item (i) c2 := other.item (j) if c1 /= c2 and then l_prop.to_lower (c1) /= l_prop.to_lower (c2) 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_characters (other: READABLE_STRING_GENERAL; 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 i, j, nb: INTEGER_32 do nb := end_pos - start_pos + 1 if nb <= count - index_pos + 1 then from Result := True i := index_pos j := start_pos nb := nb + i variant increasing_index: nb - i + 1 until i = nb loop if item (i) /= other.item (j) 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).same_string (other.substring (start_pos, end_pos)) end same_string (other: READABLE_STRING_GENERAL): BOOLEAN -- Does other represent the same string as Current? 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 end frozen standard_equal (a: detachable ANY; b: like arg #1): BOOLEAN -- Are a and b either both void or attached to -- field-by-field identical objects of the same type? -- Always uses default object comparison criterion. -- (from ANY) do if a = Void then Result := b = Void else Result := b /= Void and then a.standard_is_equal (b) end ensure -- from ANY instance_free: class definition: Result = (a = Void and b = Void) or else ((a /= Void and b /= Void) and then a.standard_is_equal (b)) end frozen standard_is_equal alias "≜" (other: READABLE_STRING_GENERAL): BOOLEAN -- Is other attached to an object of the same type -- as current object, and field-by-field identical to it? -- (from ANY) require -- from ANY other_not_void: other /= Void external "built_in" ensure -- from ANY same_type: Result implies same_type (other) symmetric: Result implies other.standard_is_equal (Current) end starts_with (s: READABLE_STRING_GENERAL): BOOLEAN -- Does string begin with s? require argument_not_void: s /= Void local i: INTEGER_32 do if Current = s then Result := True else i := s.count if i <= count then from Result := True until i = 0 loop if code (i) /= s.code (i) then Result := False i := 1 end i := i - 1 end end end ensure definition: Result = s.same_string (substring (1, s.count)) 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 require other_not_void: other /= Void valid_start_index: start_index >= 1 and start_index <= count + 1 deferred ensure valid_result: Result = 0 or else (start_index <= Result and Result <= count - other.count + 1) zero_if_absent: (Result = 0) = not substring (start_index, count).has_substring (other) at_this_index: Result >= start_index implies other.same_string (substring (Result, Result + other.count - 1)) none_before: Result > start_index implies not substring (start_index, Result + other.count - 2).has_substring (other) 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. require other_nonvoid: other /= Void other_notempty: not other.is_empty start_pos_large_enough: start_pos >= 1 start_pos_small_enough: start_pos <= count end_pos_large_enough: end_pos >= start_pos end_pos_small_enough: end_pos <= count deferred ensure correct_place: Result > 0 implies other.same_string (substring (Result, Result + other.count - 1)) end three_way_comparison alias "⋚" (other: READABLE_STRING_GENERAL): INTEGER_32 -- If current object equal to other, 0; -- if smaller, -1; if greater, 1 -- (from COMPARABLE) require -- from COMPARABLE other_exists: other /= Void do if Current < other then Result := -1 elseif other < Current then Result := 1 end ensure -- from COMPARABLE equal_zero: (Result = 0) = (Current ~ other) smaller_negative: (Result = -1) = (Current < other) greater_positive: (Result = 1) = (Current > other) end feature -- Status report conforms_to (other: ANY): BOOLEAN -- Does type of current object conform to type -- of other (as per Eiffel: The Language, chapter 13)? -- (from ANY) require -- from ANY other_not_void: other /= Void external "built_in" end has (c: like item): BOOLEAN -- Does string include c? local i, nb: INTEGER_32 do nb := count if nb > 0 then from i := 1 until i > nb or else (item (i) = c) loop i := i + 1 end Result := i <= nb end ensure then 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 has_code (c: like code): BOOLEAN -- Does string include c? local i, nb: INTEGER_32 do nb := count if nb > 0 then from i := 1 until i > nb or else (code (i) = c) loop i := i + 1 end Result := i <= nb end ensure then false_if_empty: count = 0 implies not Result true_if_first: count > 0 and then code (1) = c implies Result recurse: (count > 0 and then code (1) /= c) implies (Result = substring (2, count).has_code (c)) end is_boolean: BOOLEAN -- Does Current represent a BOOLEAN? deferred ensure is_boolean: Result = (True_constant.same_string_general (as_lower) or False_constant.same_string_general (as_lower)) end is_double: BOOLEAN -- Does Current represent a REAL_64? -- Was declared in READABLE_STRING_GENERAL as synonym of is_real_64. local l_convertor: like Ctor_convertor do l_convertor := Ctor_convertor; l_convertor.parse_string_with_type (Current, {NUMERIC_INFORMATION}.type_double) Result := l_convertor.is_integral_double end is_empty: BOOLEAN -- Is structure empty? deferred end is_hashable: BOOLEAN -- May current object be hashed? -- (True by default.) -- (from HASHABLE) do Result := True end is_immutable: BOOLEAN -- Can the character sequence of Current be not changed? do Result := False end is_integer: BOOLEAN -- Does Current represent an INTEGER_32? -- Was declared in READABLE_STRING_GENERAL as synonym of is_integer_32. do Result := is_valid_integer_or_natural ({NUMERIC_INFORMATION}.type_integer_32) end is_integer_16: BOOLEAN -- Does Current represent an INTEGER_16? do Result := is_valid_integer_or_natural ({NUMERIC_INFORMATION}.type_integer_16) end is_integer_32: BOOLEAN -- Does Current represent an INTEGER_32? -- Was declared in READABLE_STRING_GENERAL as synonym of is_integer. do Result := is_valid_integer_or_natural ({NUMERIC_INFORMATION}.type_integer_32) end is_integer_64: BOOLEAN -- Does Current represent an INTEGER_64? do Result := is_valid_integer_or_natural ({NUMERIC_INFORMATION}.type_integer_64) end is_integer_8: BOOLEAN -- Does Current represent an INTEGER_8? do Result := is_valid_integer_or_natural ({NUMERIC_INFORMATION}.type_integer_8) end is_natural: BOOLEAN -- Does Current represent a NATURAL_32? -- Was declared in READABLE_STRING_GENERAL as synonym of is_natural_32. do Result := is_valid_integer_or_natural ({NUMERIC_INFORMATION}.type_natural_32) end is_natural_16: BOOLEAN -- Does Current represent a NATURAL_16? do Result := is_valid_integer_or_natural ({NUMERIC_INFORMATION}.type_natural_16) end is_natural_32: BOOLEAN -- Does Current represent a NATURAL_32? -- Was declared in READABLE_STRING_GENERAL as synonym of is_natural. do Result := is_valid_integer_or_natural ({NUMERIC_INFORMATION}.type_natural_32) end is_natural_64: BOOLEAN -- Does Current represent a NATURAL_64? do Result := is_valid_integer_or_natural ({NUMERIC_INFORMATION}.type_natural_64) end is_natural_8: BOOLEAN -- Does Current represent a NATURAL_8? do Result := is_valid_integer_or_natural ({NUMERIC_INFORMATION}.type_natural_8) end is_number_sequence: BOOLEAN -- Does Current represent a number sequence? do Result := is_valid_integer_or_natural ({NUMERIC_INFORMATION}.type_no_limitation) end is_real: BOOLEAN -- Does Current represent a REAL_32? -- Was declared in READABLE_STRING_GENERAL as synonym of is_real_32. local l_convertor: like Ctor_convertor do l_convertor := Ctor_convertor; l_convertor.parse_string_with_type (Current, {NUMERIC_INFORMATION}.type_real) Result := l_convertor.is_integral_real end is_real_32: BOOLEAN -- Does Current represent a REAL_32? -- Was declared in READABLE_STRING_GENERAL as synonym of is_real. local l_convertor: like Ctor_convertor do l_convertor := Ctor_convertor; l_convertor.parse_string_with_type (Current, {NUMERIC_INFORMATION}.type_real) Result := l_convertor.is_integral_real end is_real_64: BOOLEAN -- Does Current represent a REAL_64? -- Was declared in READABLE_STRING_GENERAL as synonym of is_double. local l_convertor: like Ctor_convertor do l_convertor := Ctor_convertor; l_convertor.parse_string_with_type (Current, {NUMERIC_INFORMATION}.type_double) Result := l_convertor.is_integral_double end is_real_sequence: BOOLEAN -- Does Current represent a real sequence? local l_convertor: like Ctor_convertor do l_convertor := Ctor_convertor; l_convertor.parse_string_with_type (Current, {NUMERIC_INFORMATION}.type_no_limitation) Result := l_convertor.is_integral_double end is_string_32: BOOLEAN -- Is Current a sequence of CHARACTER_32? deferred end is_string_8: BOOLEAN -- Is Current a sequence of CHARACTER_8? deferred end is_substring_whitespace (start_index, end_index: INTEGER_32): BOOLEAN -- Is substring between start_index and end_index containing only whitespace characters? require start_index_big_enough: 1 <= start_index end_index_small_enough: end_index <= count consistent_indexes: start_index - 1 <= end_index deferred end is_valid_as_string_8: BOOLEAN -- Is Current convertible to a sequence of CHARACTER_8 without information loss? deferred end is_whitespace: BOOLEAN -- Is structure containing only whitespace characters? do Result := is_substring_whitespace (1, count) end same_type (other: ANY): BOOLEAN -- Is type of current object identical to type of other? -- (from ANY) require -- from ANY other_not_void: other /= Void external "built_in" ensure -- from ANY definition: Result = (conforms_to (other) and other.conforms_to (Current)) end valid_code (v: like code): BOOLEAN -- Is v a valid code for Current? deferred end valid_index (i: INTEGER_32): BOOLEAN -- Is i within the bounds of the string? do Result := (i > 0) and (i <= count) ensure definition: Result = (1 <= i and i <= count) end feature -- Element change plus alias "+" (s: READABLE_STRING_GENERAL): like Current obsolete "Use `plus` on sized variants of string classes. [2020-05-31]" -- Concatenation of the current string with s. require argument_not_void: s /= Void compatible_strings: is_string_8 implies s.is_valid_as_string_8 deferred ensure plus_not_void: Result /= Void 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 -- Conversion as_lower: like Current -- New object with all letters in lower case. deferred ensure as_lower_attached: Result /= Void length: Result.count = count anchor: count > 0 implies Result.item (1) = item (1).as_lower recurse: count > 1 implies Result.substring (2, count) ~ substring (2, count).as_lower end as_readable_string_32: READABLE_STRING_32 obsolete "Use explicit conversion `to_string_32`, or, better use READABLE_STRING_32 and descendants instead. [2017-05-31]" -- Equivalent to as_string_32 with a different name. do Result := as_string_32 end as_readable_string_8: READABLE_STRING_8 obsolete "Use explicit conversion `to_string_8' with a test that the string is made of ASCII characters only. [2017-05-31]" -- Convert Current as a READABLE_STRING_8. If a code of Current is -- not a valid code for a READABLE_STRING_8 it is replaced with the null -- character. do Result := as_string_8 end as_string_32: STRING_32 -- Convert Current as a STRING_32. -- Was declared in READABLE_STRING_GENERAL as synonym of to_string_32. local i, nb: INTEGER_32 do if attached {STRING_32} Current as l_result then Result := l_result else nb := count create Result.make (nb); Result.set_count (nb) from i := 1 until i > nb loop Result.put_code (code (i), i) i := i + 1 end end ensure as_string_32_not_void: Result /= Void identity: (conforms_to (create {STRING_32}.make_empty) and Result = Current) or (not conforms_to (create {STRING_32}.make_empty) and Result /= Current) end as_string_32_conversion: STRING_32 obsolete "Update target of call to use READABLE_STRING_32 and descendants instead. [2017-05-31]" -- Equivalent to as_string_32 with a different name. -- To be used for migrating existing code to Unicode -- when you get a compiler error but cannot or do not have -- the time yet to address the source of the string to be -- a READABLE_STRING_32 or descendants. do Result := as_string_32 end as_string_8: STRING_8 obsolete "[ For 32-bit strings: - use explicit conversion `to_string_8` with a test that the string is made of ASCII characters only. For 8-bit strings: - consider changing the type of reattachmanet target to READABLE_STRING_8 or - use explicit conversion `to_string_8` to avoid implicit performance penalty. [2019-11-30] ]" -- Convert Current as a STRING_8. If a code of Current is -- not a valid code for a STRING_8 it is replaced with the null -- character. local i, nb: INTEGER_32 l_code: like code do if attached {STRING_8} Current as l_result then Result := l_result else nb := count create Result.make (nb); Result.set_count (nb) from i := 1 until i > nb loop l_code := code (i) if Result.valid_code (l_code) then Result.put_code (l_code, i) else Result.put_code (0, i) end i := i + 1 end end ensure as_string_8_not_void: Result /= Void identity: (conforms_to ("") and Result = Current) or (not conforms_to ("") and Result /= Current) end as_string_8_conversion: STRING_8 obsolete "Update recipient of call to use READABLE_STRING_32 and descendants instead. [2017-05-31]" -- Equivalent to as_string_8 with a different name. -- To be used for migrating existing code to Unicode -- when you get a compiler error but cannot or do not have -- the time yet to address the target recipient of the string to be -- a READABLE_STRING_32 or descendants. do Result := as_string_8 end as_upper: like Current -- New object with all letters in upper case deferred ensure as_upper_attached: Result /= Void length: Result.count = count anchor: count > 0 implies Result.item (1) = item (1).as_upper recurse: count > 1 implies Result.substring (2, count) ~ substring (2, count).as_upper end split (a_separator: CHARACTER_32): LIST [like Current] -- Split on a_separator. local l_list: ARRAYED_LIST [like Current] i, j, c: INTEGER_32 do c := count create l_list.make (c + 1) if c > 0 then from i := 1 until i > c loop j := index_of (a_separator, i) if j = 0 then j := c + 1 end; l_list.extend (substring (i, j - 1)) i := j + 1 end if j = c then check last_character_is_a_separator: item (j) = a_separator end; l_list.extend (new_string (0)) end else l_list.extend (new_string (0)) end Result := l_list check l_list.count = occurrences (a_separator) + 1 end ensure Result /= Void end to_boolean: BOOLEAN -- Boolean value; -- "True" yields True, "False" yields False -- (case-insensitive) require is_boolean: is_boolean do check True_constant.count = 4 end if count = 4 then Result := True end ensure to_boolean: (Result = as_lower.same_string (True_constant)) or (not Result = as_lower.same_string (False_constant)) end frozen to_cil: SYSTEM_STRING -- Create an instance of SYSTEM_STRING using characters -- of Current between indices 1 and count. require is_dotnet: {PLATFORM}.is_dotnet do Result := Dotnet_convertor.from_string_to_system_string (Current) ensure to_cil_not_void: Result /= Void end to_double: REAL_64 -- "Double" value; -- for example, when applied to "123.0", will yield 123.0 (double) -- Was declared in READABLE_STRING_GENERAL as synonym of to_real_64. require represents_a_double: is_double local l_convertor: like Ctor_convertor do l_convertor := Ctor_convertor; l_convertor.parse_string_with_type (Current, {NUMERIC_INFORMATION}.type_no_limitation) Result := l_convertor.parsed_double end to_integer: INTEGER_32 -- 32-bit integer value -- Was declared in READABLE_STRING_GENERAL as synonym of to_integer_32. require is_integer: is_integer_32 local l_convertor: like Ctoi_convertor do l_convertor := Ctoi_convertor; l_convertor.parse_string_with_type (Current, {NUMERIC_INFORMATION}.type_no_limitation) Result := l_convertor.parsed_integer end to_integer_16: INTEGER_16 -- 16-bit integer value require is_integer_16: is_integer_16 local l_convertor: like Ctoi_convertor do l_convertor := Ctoi_convertor; l_convertor.parse_string_with_type (Current, {NUMERIC_INFORMATION}.type_no_limitation) Result := l_convertor.parsed_integer_16 end to_integer_32: INTEGER_32 -- 32-bit integer value -- Was declared in READABLE_STRING_GENERAL as synonym of to_integer. require is_integer: is_integer_32 local l_convertor: like Ctoi_convertor do l_convertor := Ctoi_convertor; l_convertor.parse_string_with_type (Current, {NUMERIC_INFORMATION}.type_no_limitation) Result := l_convertor.parsed_integer end to_integer_64: INTEGER_64 -- 64-bit integer value require is_integer_64: is_integer_64 local l_convertor: like Ctoi_convertor do l_convertor := Ctoi_convertor; l_convertor.parse_string_with_type (Current, {NUMERIC_INFORMATION}.type_no_limitation) Result := l_convertor.parsed_integer_64 end to_integer_8: INTEGER_8 -- 8-bit integer value require is_integer_8: is_integer_8 local l_convertor: like Ctoi_convertor do l_convertor := Ctoi_convertor; l_convertor.parse_string_with_type (Current, {NUMERIC_INFORMATION}.type_no_limitation) Result := l_convertor.parsed_integer_8 end to_natural: NATURAL_32 -- 32-bit natural value -- Was declared in READABLE_STRING_GENERAL as synonym of to_natural_32. require is_natural: is_natural_32 local l_convertor: like Ctoi_convertor do l_convertor := Ctoi_convertor; l_convertor.parse_string_with_type (Current, {NUMERIC_INFORMATION}.type_no_limitation) Result := l_convertor.parsed_natural_32 end to_natural_16: NATURAL_16 -- 16-bit natural value require is_natural_16: is_natural_16 local l_convertor: like Ctoi_convertor do l_convertor := Ctoi_convertor; l_convertor.parse_string_with_type (Current, {NUMERIC_INFORMATION}.type_no_limitation) Result := l_convertor.parsed_natural_16 end to_natural_32: NATURAL_32 -- 32-bit natural value -- Was declared in READABLE_STRING_GENERAL as synonym of to_natural. require is_natural: is_natural_32 local l_convertor: like Ctoi_convertor do l_convertor := Ctoi_convertor; l_convertor.parse_string_with_type (Current, {NUMERIC_INFORMATION}.type_no_limitation) Result := l_convertor.parsed_natural_32 end to_natural_64: NATURAL_64 -- 64-bit natural value require is_natural_64: is_natural_64 local l_convertor: like Ctoi_convertor do l_convertor := Ctoi_convertor; l_convertor.parse_string_with_type (Current, {NUMERIC_INFORMATION}.type_no_limitation) Result := l_convertor.parsed_natural_64 end to_natural_8: NATURAL_8 -- 8-bit natural value require is_natural_8: is_natural_8 local l_convertor: like Ctoi_convertor do l_convertor := Ctoi_convertor; l_convertor.parse_string_with_type (Current, {NUMERIC_INFORMATION}.type_no_limitation) Result := l_convertor.parsed_natural_8 end to_real: REAL_32 -- Real value; -- for example, when applied to "123.0", will yield 123.0 -- Was declared in READABLE_STRING_GENERAL as synonym of to_real_32. require represents_a_real: is_real do Result := to_double.truncated_to_real end to_real_32: REAL_32 -- Real value; -- for example, when applied to "123.0", will yield 123.0 -- Was declared in READABLE_STRING_GENERAL as synonym of to_real. require represents_a_real: is_real do Result := to_double.truncated_to_real end to_real_64: REAL_64 -- "Double" value; -- for example, when applied to "123.0", will yield 123.0 (double) -- Was declared in READABLE_STRING_GENERAL as synonym of to_double. require represents_a_double: is_double local l_convertor: like Ctor_convertor do l_convertor := Ctor_convertor; l_convertor.parse_string_with_type (Current, {NUMERIC_INFORMATION}.type_no_limitation) Result := l_convertor.parsed_double end to_string_32: STRING_32 -- Convert Current as a STRING_32. -- Was declared in READABLE_STRING_GENERAL as synonym of as_string_32. local i, nb: INTEGER_32 do if attached {STRING_32} Current as l_result then Result := l_result else nb := count create Result.make (nb); Result.set_count (nb) from i := 1 until i > nb loop Result.put_code (code (i), i) i := i + 1 end end ensure as_string_32_not_void: Result /= Void identity: (conforms_to (create {STRING_32}.make_empty) and Result = Current) or (not conforms_to (create {STRING_32}.make_empty) and Result /= Current) end to_string_8: STRING_8 -- Convert Current as a STRING_8. require is_valid_as_string_8: is_valid_as_string_8 local i, nb: INTEGER_32 do if attached {STRING_8} Current as s then Result := s else nb := count create Result.make (nb); Result.set_count (nb) from i := 1 until i > nb loop check from_precondition: Result.valid_code (code (i)) end; Result.put_code (code (i), i) i := i + 1 end end ensure as_string_8_not_void: Result /= Void identity: (conforms_to ("") and Result = Current) or (not conforms_to ("") and Result /= Current) end feature -- Duplication frozen clone (other: detachable ANY): like other obsolete "Use `twin' instead. [2017-05-31]" -- Void if other is void; otherwise new object -- equal to other -- -- For non-void other, clone calls copy; -- to change copying/cloning semantics, redefine copy. -- (from ANY) do if other /= Void then Result := other.twin end ensure -- from ANY instance_free: class equal: Result ~ other end copy (other: READABLE_STRING_GENERAL) -- Update current object using fields of object attached -- to other, so as to yield equal objects. -- (from ANY) require -- from ANY other_not_void: other /= Void type_identity: same_type (other) external "built_in" ensure -- from ANY is_equal: Current ~ other end frozen deep_clone (other: detachable ANY): like other obsolete "Use `deep_twin' instead. [2017-05-31]" -- Void if other is void: otherwise, new object structure -- recursively duplicated from the one attached to other -- (from ANY) do if other /= Void then Result := other.deep_twin end ensure -- from ANY instance_free: class deep_equal: deep_equal (other, Result) end frozen deep_copy (other: READABLE_STRING_GENERAL) -- Effect equivalent to that of: -- copy (other . deep_twin) -- (from ANY) require -- from ANY other_not_void: other /= Void do copy (other.deep_twin) ensure -- from ANY deep_equal: deep_equal (Current, other) end frozen deep_twin: READABLE_STRING_GENERAL -- New object structure recursively duplicated from Current. -- (from ANY) external "built_in" ensure -- from ANY deep_twin_not_void: Result /= Void deep_equal: deep_equal (Current, Result) end head (n: INTEGER_32): like Current -- Prefix, retaining first n characters (or as many as available). require non_negative_argument: n >= 0 do if n > count then Result := twin else Result := substring (1, n) end ensure same_count: count = old count new_count: Result.count = n.min (count) end frozen standard_clone (other: detachable ANY): like other obsolete "Use `standard_twin' instead. [2017-05-31]" -- Void if other is void; otherwise new object -- field-by-field identical to other. -- Always uses default copying semantics. -- (from ANY) do if other /= Void then Result := other.standard_twin end ensure -- from ANY instance_free: class equal: standard_equal (Result, other) end frozen standard_copy (other: READABLE_STRING_GENERAL) -- Copy every field of other onto corresponding field -- of current object. -- (from ANY) require -- from ANY other_not_void: other /= Void type_identity: same_type (other) external "built_in" ensure -- from ANY is_standard_equal: standard_is_equal (other) end frozen standard_twin: READABLE_STRING_GENERAL -- New object field-by-field identical to other. -- Always uses default copying semantics. -- (from ANY) external "built_in" ensure -- from ANY standard_twin_not_void: Result /= Void equal: standard_equal (Result, Current) end substring (start_index, end_index: INTEGER_32): like Current -- Copy of substring containing all characters at indices -- between start_index and end_index deferred ensure substring_not_void: Result /= Void substring_count: Result.count = end_index - start_index + 1 or Result.count = 0 first_code: Result.count > 0 implies Result.item (1) = item (start_index) recurse: Result.count > 0 implies Result.substring (2, Result.count) ~ substring (start_index + 1, end_index) end tail (n: INTEGER_32): like Current -- Suffix, retaining last n characters (or as many as available). require non_negative_argument: n >= 0 do if n > count then Result := twin else Result := substring (count - n + 1, count) end ensure same_count: count = old count new_count: Result.count = n.min (count) end frozen twin: READABLE_STRING_GENERAL -- New object equal to Current -- twin calls copy; to change copying/twinning semantics, redefine copy. -- (from ANY) external "built_in" ensure -- from ANY twin_not_void: Result /= Void is_equal: Result ~ Current end feature -- Basic operations frozen as_attached: attached READABLE_STRING_GENERAL obsolete "Remove calls to this feature. [2017-05-31]" -- Attached version of Current. -- (Can be used during transitional period to convert -- non-void-safe classes to void-safe ones.) -- (from ANY) do Result := Current end frozen default: detachable READABLE_STRING_GENERAL -- Default value of object's type -- (from ANY) do end frozen default_pointer: POINTER -- Default value of type POINTER -- (Avoid the need to write p.default for -- some p of type POINTER.) -- (from ANY) do ensure -- from ANY instance_free: class end default_rescue -- Process exception for routines with no Rescue clause. -- (Default: do nothing.) -- (from ANY) do end frozen do_nothing -- Execute a null action. -- (from ANY) do ensure -- from ANY instance_free: class end feature {NONE} -- Implementation C_string_provider: C_STRING -- To create Eiffel strings from C string. once create Result.make_empty (0) ensure c_string_provider_not_void: Result /= Void end Character_properties: CHARACTER_PROPERTY -- Access to Unicode character properties once create Result.make end Ctoi_convertor: STRING_TO_INTEGER_CONVERTOR -- Convertor used to convert string to integer or natural once create Result.make; Result.set_leading_separators (" "); Result.set_trailing_separators (" "); Result.set_leading_separators_acceptable (True); Result.set_trailing_separators_acceptable (True) ensure ctoi_convertor_not_void: Result /= Void end Ctor_convertor: STRING_TO_REAL_CONVERTOR -- Convertor used to convert string to real or double once create Result.make; Result.set_leading_separators (" "); Result.set_trailing_separators (" "); Result.set_leading_separators_acceptable (True); Result.set_trailing_separators_acceptable (True) ensure ctor_convertor_not_void: Result /= Void end Dotnet_convertor: SYSTEM_STRING_FACTORY -- Convertor used to convert from and to SYSTEM_STRING. once create Result ensure dotnet_convertor_not_void: Result /= Void end is_valid_integer_or_natural (type: INTEGER_32): BOOLEAN -- Is Current a valid number according to given type? local l_convertor: like Ctoi_convertor do l_convertor := Ctoi_convertor; l_convertor.reset (type); l_convertor.parse_string_with_type (Current, type) Result := l_convertor.is_integral_integer end new_string (n: INTEGER_32): like Current -- New instance of current with space for at least n characters. require n_non_negative: n >= 0 deferred ensure new_string_not_void: Result /= Void new_string_empty: Result.is_empty new_string_area_big_enough: Result.capacity >= n end string_searcher: STRING_SEARCHER -- Facilities to search string in another string. deferred ensure string_searcher_not_void: Result /= Void end feature {READABLE_STRING_GENERAL} -- Implementation internal_case_insensitive_hash_code: INTEGER_32 -- Cash for case_insensitive_hash_code. internal_hash_code: INTEGER_32 -- Cache for hash_code. feature -- Access: Cursor new_character_32_cursor: STRING_ITERATION_CURSOR -- Fresh cursor for this string that iterates over code points (see code) -- exposed as CHARACTER_32. do create Result.make (Current); Result.start end feature {NONE} -- Assertion helper Elks_checking: BOOLEAN = False -- Are ELKS checkings verified? Must be True when changing implementation of STRING_GENERAL or descendant. feature -- Output Io: STD_FILES -- Handle to standard file setup -- (from ANY) once create Result; Result.set_output_default ensure -- from ANY instance_free: class io_not_void: Result /= Void end out: STRING_8 -- New string containing terse printable representation -- of current object -- (from ANY) do Result := tagged_out ensure -- from ANY out_not_void: Result /= Void end print (o: detachable ANY) -- Write terse external representation of o -- on standard output. -- (from ANY) local s: READABLE_STRING_8 do if attached o then s := o.out if attached {READABLE_STRING_32} s as s32 then Io.put_string_32 (s32) elseif attached {READABLE_STRING_8} s as s8 then Io.put_string (s8) else Io.put_string_32 (s.as_string_32) end end ensure -- from ANY instance_free: class end frozen tagged_out: STRING_8 -- New string containing terse printable representation -- of current object -- (from ANY) external "built_in" ensure -- from ANY tagged_out_not_void: Result /= Void end feature -- Platform Operating_environment: OPERATING_ENVIRONMENT -- Objects available from the operating system -- (from ANY) once create Result ensure -- from ANY instance_free: class operating_environment_not_void: Result /= Void end feature {NONE} -- Retrieval frozen internal_correct_mismatch -- Called from runtime to perform a proper dynamic dispatch on correct_mismatch -- from MISMATCH_CORRECTOR. -- (from ANY) local l_msg: STRING_32 l_exc: EXCEPTIONS do if attached {MISMATCH_CORRECTOR} Current as l_corrector then l_corrector.correct_mismatch else create l_msg.make_from_string ("Mismatch: ".as_string_32) create l_exc; l_msg.append (generating_type.name_32); l_exc.raise_retrieval_exception (l_msg) end end invariant -- from COMPARABLE irreflexive_comparison: not (Current < Current) -- from ANY reflexive_equality: standard_is_equal (Current) reflexive_conformance: conforms_to (Current) 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_GENERAL
Generated by ISE EiffelStudio