Automatic generation produced by ISE Eiffel
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: 2012-05-23 21:13:10 -0700 (Wed, 23 May 2012) $" revision: "$Revision: 559 $" deferred class interface READABLE_STRING_GENERAL feature -- Access code (i: INTEGER_32): NATURAL_32 -- Code at position `i' require valid_index: valid_index (i) 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) ensure -- from ANY generating_type_not_void: Result /= Void generator: STRING_8 -- Name of current object's generating class -- (base class of the type of which it is a direct instance) -- (from ANY) ensure -- from ANY generator_not_void: Result /= Void generator_not_empty: not Result.is_empty hash_code: INTEGER_32 -- Hash code value -- (from HASHABLE) ensure -- from HASHABLE good_hash_value: Result >= 0 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 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) True_constant: STRING_8 = "true" -- Constant string "true" 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) ensure -- from ANY 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) 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) ensure -- from ANY definition: Result = (a = Void and b = Void) or else ((a /= Void and b /= Void) and then a.is_equal (b)) frozen is_deep_equal (other: attached READABLE_STRING_GENERAL): BOOLEAN -- Are `Current' and `other' attached to isomorphic object structures? -- (from ANY) require -- from ANY other_not_void: other /= Void 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) is_equal (other: attached 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 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)) is_greater alias ">" (other: attached READABLE_STRING_GENERAL): BOOLEAN -- Is current object greater than `other'? -- (from COMPARABLE) require -- from PART_COMPARABLE other_exists: other /= Void ensure then -- from COMPARABLE definition: Result = (other < Current) is_greater_equal alias ">=" (other: attached READABLE_STRING_GENERAL): BOOLEAN -- Is current object greater than or equal to `other'? -- (from COMPARABLE) require -- from PART_COMPARABLE other_exists: other /= Void ensure then -- from COMPARABLE definition: Result = (other <= Current) is_less alias "<" (other: attached READABLE_STRING_GENERAL): BOOLEAN -- Is current object less than `other'? -- (from COMPARABLE) require -- from PART_COMPARABLE other_exists: other /= Void ensure then -- from COMPARABLE asymmetric: Result implies not (other < Current) is_less_equal alias "<=" (other: attached READABLE_STRING_GENERAL): BOOLEAN -- Is current object less than or equal to `other'? -- (from COMPARABLE) require -- from PART_COMPARABLE other_exists: other /= Void ensure then -- from COMPARABLE definition: Result = ((Current < other) or (Current ~ other)) max (other: attached READABLE_STRING_GENERAL): attached READABLE_STRING_GENERAL -- The greater of current object and `other' -- (from COMPARABLE) require -- from COMPARABLE other_exists: other /= Void ensure -- from COMPARABLE current_if_not_smaller: Current >= other implies Result = Current other_if_smaller: Current < other implies Result = other min (other: attached READABLE_STRING_GENERAL): attached READABLE_STRING_GENERAL -- The smaller of current object and `other' -- (from COMPARABLE) require -- from COMPARABLE other_exists: other /= Void ensure -- from COMPARABLE current_if_not_greater: Current <= other implies Result = Current other_if_greater: Current > other implies Result = other 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) ensure -- from ANY definition: Result = (a = Void and b = Void) or else ((a /= Void and b /= Void) and then a.standard_is_equal (b)) frozen standard_is_equal (other: attached 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 ensure -- from ANY same_type: Result implies same_type (other) symmetric: Result implies other.standard_is_equal (Current) three_way_comparison (other: attached 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 ensure -- from COMPARABLE equal_zero: (Result = 0) = (Current ~ other) smaller_negative: (Result = -1) = (Current < other) greater_positive: (Result = 1) = (Current > other) feature -- Status report capacity: INTEGER_32 -- Number of characters allocated in Current ensure capacity_non_negative: Result >= 0 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 count: INTEGER_32 -- Number of characters in Current ensure count_non_negative: Result >= 0 ends_with (s: READABLE_STRING_GENERAL): BOOLEAN -- Does string finish with `s'? require argument_not_void: s /= Void ensure definition: Result = s.same_string (substring (count - s.count + 1, count)) 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 has_code (c: like code): BOOLEAN -- Does string include `c'? 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)) has_substring (other: READABLE_STRING_GENERAL): BOOLEAN -- Does `Current' contain `other'? require other_not_void: other /= Void 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)) is_boolean: BOOLEAN -- Does `Current' represent a BOOLEAN? ensure is_boolean: Result = (True_constant.same_string (as_lower.as_string_8) or False_constant.same_string (as_lower.as_string_8)) is_double: BOOLEAN -- Does `Current' represent a REAL_64? -- Was declared in READABLE_STRING_GENERAL as synonym of is_real_64. is_empty: BOOLEAN -- Is structure empty? is_hashable: BOOLEAN -- May current object be hashed? -- (True by default.) -- (from HASHABLE) is_immutable: BOOLEAN -- Can the character sequence of `Current' be not changed? is_integer: BOOLEAN -- Does `Current' represent an INTEGER_32? -- Was declared in READABLE_STRING_GENERAL as synonym of is_integer_32. is_integer_16: BOOLEAN -- Does `Current' represent an INTEGER_16? is_integer_32: BOOLEAN -- Does `Current' represent an INTEGER_32? -- Was declared in READABLE_STRING_GENERAL as synonym of is_integer. is_integer_64: BOOLEAN -- Does `Current' represent an INTEGER_64? is_integer_8: BOOLEAN -- Does `Current' represent an INTEGER_8? is_natural: BOOLEAN -- Does `Current' represent a NATURAL_32? -- Was declared in READABLE_STRING_GENERAL as synonym of is_natural_32. is_natural_16: BOOLEAN -- Does `Current' represent a NATURAL_16? is_natural_32: BOOLEAN -- Does `Current' represent a NATURAL_32? -- Was declared in READABLE_STRING_GENERAL as synonym of is_natural. is_natural_64: BOOLEAN -- Does `Current' represent a NATURAL_64? is_natural_8: BOOLEAN -- Does `Current' represent a NATURAL_8? is_number_sequence: BOOLEAN -- Does `Current' represent a number sequence? is_real: BOOLEAN -- Does `Current' represent a REAL_32? -- Was declared in READABLE_STRING_GENERAL as synonym of is_real_32. is_real_32: BOOLEAN -- Does `Current' represent a REAL_32? -- Was declared in READABLE_STRING_GENERAL as synonym of is_real. is_real_64: BOOLEAN -- Does `Current' represent a REAL_64? -- Was declared in READABLE_STRING_GENERAL as synonym of is_double. is_real_sequence: BOOLEAN -- Does `Current' represent a real sequence? is_string_32: BOOLEAN -- Is `Current' a sequence of CHARACTER_32? is_string_8: BOOLEAN -- Is `Current' a sequence of CHARACTER_8? is_valid_as_string_8: BOOLEAN -- Is `Current' convertible to a sequence of CHARACTER_8 without information loss? same_string (a_other: READABLE_STRING_GENERAL): BOOLEAN -- Does `a_other' represent the same string as `Current'? require a_other_not_void: a_other /= Void 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 ensure -- from ANY definition: Result = (conforms_to (other) and other.conforms_to (Current)) starts_with (s: READABLE_STRING_GENERAL): BOOLEAN -- Does string begin with `s'? require argument_not_void: s /= Void ensure definition: Result = s.same_string (substring (1, s.count)) 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 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) 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 ensure correct_place: Result > 0 implies other.same_string (substring (Result, Result + other.count - 1)) valid_code (v: like code): BOOLEAN -- Is `v' a valid code for Current? valid_index (i: INTEGER_32): BOOLEAN -- Is `i' within the bounds of the string? ensure definition: Result = (1 <= i and i <= count) feature -- Element change plus alias "+" (s: READABLE_STRING_GENERAL): like Current require argument_not_void: s /= Void compatible_strings: is_string_8 implies s.is_valid_as_string_8 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) feature -- Conversion as_lower: like Current -- New object with all letters in lower case. require is_valid_as_string_8: is_valid_as_string_8 ensure as_lower_attached: Result /= Void length: Result.count = count anchor: count > 0 implies Result.code (1).to_character_8 = code (1).to_character_8.as_lower recurse: count > 1 implies Result.substring (2, count) ~ substring (2, count).as_lower as_string_32: STRING_32 -- Convert `Current' as a STRING_32. -- Was declared in READABLE_STRING_GENERAL as synonym of to_string_32. 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) as_string_8: STRING_8 -- 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. ensure as_string_8_not_void: Result /= Void identity: (conforms_to ("") and Result = Current) or (not conforms_to ("") and Result /= Current) as_upper: like Current -- New object with all letters in upper case require is_valid_as_string_8: is_valid_as_string_8 ensure as_upper_attached: Result /= Void length: Result.count = count anchor: count > 0 implies Result.code (1).to_character_8 = code (1).to_character_8.as_upper recurse: count > 1 implies Result.substring (2, count) ~ substring (2, count).as_upper to_boolean: BOOLEAN -- Boolean value; -- "True" yields `True', "False" yields `False' -- (case-insensitive) require is_boolean: is_boolean ensure to_boolean: (Result = as_lower.same_string (True_constant)) or (not Result = as_lower.same_string (False_constant)) 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 ensure to_cil_not_void: Result /= Void 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 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 to_integer_16: INTEGER_16 -- 16-bit integer value require is_integer_16: is_integer_16 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 to_integer_64: INTEGER_64 -- 64-bit integer value require is_integer_64: is_integer_64 to_integer_8: INTEGER_8 -- 8-bit integer value require is_integer_8: is_integer_8 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 to_natural_16: NATURAL_16 -- 16-bit natural value require is_natural_16: is_natural_16 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 to_natural_64: NATURAL_64 -- 64-bit natural value require is_natural_64: is_natural_64 to_natural_8: NATURAL_8 -- 8-bit natural value require is_natural_8: is_natural_8 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 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 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 to_string_32: STRING_32 -- Convert `Current' as a STRING_32. -- Was declared in READABLE_STRING_GENERAL as synonym of as_string_32. 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) to_string_8: STRING_8 -- Convert `Current' as a STRING_8. require is_valid_as_string_8: is_valid_as_string_8 ensure as_string_8_not_void: Result /= Void identity: (conforms_to ("") and Result = Current) or (not conforms_to ("") and Result /= Current) feature -- Duplication frozen deep_twin: attached READABLE_STRING_GENERAL -- New object structure recursively duplicated from Current. -- (from ANY) ensure -- from ANY deep_twin_not_void: Result /= Void deep_equal: deep_equal (Current, Result) frozen standard_twin: attached READABLE_STRING_GENERAL -- New object field-by-field identical to `other'. -- Always uses default copying semantics. -- (from ANY) ensure -- from ANY standard_twin_not_void: Result /= Void equal: standard_equal (Result, Current) substring (start_index, end_index: INTEGER_32): like Current -- Copy of substring containing all characters at indices -- between `start_index' and `end_index' 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.code (1) = code (start_index) recurse: Result.count > 0 implies Result.substring (2, Result.count) ~ substring (start_index + 1, end_index) frozen twin: attached READABLE_STRING_GENERAL -- New object equal to `Current' -- twin calls copy; to change copying/twining semantics, redefine copy. -- (from ANY) ensure -- from ANY twin_not_void: Result /= Void is_equal: Result ~ Current feature -- Basic operations frozen as_attached: attached READABLE_STRING_GENERAL -- Attached version of Current -- (Can be used during transitional period to convert -- non-void-safe classes to void-safe ones.) -- (from ANY) frozen default: detachable READABLE_STRING_GENERAL -- Default value of object's type -- (from ANY) frozen default_pointer: POINTER -- Default value of type `POINTER' -- (Avoid the need to write `p'.default for -- some `p' of type `POINTER'.) -- (from ANY) default_rescue -- Process exception for routines with no Rescue clause. -- (Default: do nothing.) -- (from ANY) frozen do_nothing -- Execute a null action. -- (from ANY) feature -- Output Io: STD_FILES -- Handle to standard file setup -- (from ANY) ensure -- from ANY io_not_void: Result /= Void out: STRING_8 -- New string containing terse printable representation -- of current object -- (from ANY) ensure -- from ANY out_not_void: Result /= Void print (o: detachable ANY) -- Write terse external representation of `o' -- on standard output. -- (from ANY) frozen tagged_out: STRING_8 -- New string containing terse printable representation -- of current object -- (from ANY) ensure -- from ANY tagged_out_not_void: Result /= Void feature -- Platform Operating_environment: OPERATING_ENVIRONMENT -- Objects available from the operating system -- (from ANY) ensure -- from ANY operating_environment_not_void: Result /= Void 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-2012, 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 Eiffel Studio --
For more details: docs.eiffel.com