Automatic generation produced by ISE Eiffel
note description: "References to objects containing a character value" library: "Free implementation of ELKS library" status: "See notice at end of class." legal: "See notice at end of class." date: "$Date: 2021-03-10 07:50:01 -0900 (Wed, 10 Mar 2021) $" revision: "$Revision: 105217 $" class interface CHARACTER_8_REF create default_create -- Process instances of classes with no creation clause. -- (Default: do nothing.) -- (from ANY) feature -- Access generating_type: TYPE [detachable CHARACTER_8_REF] -- 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 ensure -- from HASHABLE good_hash_value: Result >= 0 item: CHARACTER_8 -- Character value Max_ascii_value: INTEGER_32 = 127 -- Bounds for integer representation of characters (ASCII) Max_value: INTEGER_32 = 255 Min_value: INTEGER_32 = 0 natural_32_code: NATURAL_32 -- Associated natural value 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 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) 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 instance_free: class definition: Result = (a = Void and b = Void) or else ((a /= Void and b /= Void) and then a.is_equal (b)) frozen is_deep_equal alias "≡≡≡" (other: CHARACTER_8_REF): 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: like Current): BOOLEAN -- Is other attached to an object of the same type -- as current object and identical to it? 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: CHARACTER_8_REF): 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 ">=" alias "≥" (other: CHARACTER_8_REF): 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: like Current): BOOLEAN -- Is other greater than current character? require -- from PART_COMPARABLE other_exists: other /= Void ensure then -- from COMPARABLE asymmetric: Result implies not (other < Current) ensure then definition: Result = (natural_32_code < other.natural_32_code) is_less_equal alias "<=" alias "≤" (other: CHARACTER_8_REF): 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 alias "∨" (other: CHARACTER_8_REF): CHARACTER_8_REF -- 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 alias "∧" (other: CHARACTER_8_REF): CHARACTER_8_REF -- 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 instance_free: class 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 alias "≜" (other: CHARACTER_8_REF): 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 alias "⋚" (other: CHARACTER_8_REF): 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 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 is_alpha: BOOLEAN -- Is `item` alphabetic? -- Alphabetic is `is_upper` or `is_lower` is_alpha_numeric: BOOLEAN -- Is `item` alphabetic or a digit? is_control: BOOLEAN -- Is `item` a control character? is_digit: BOOLEAN -- Is `item` a digit? -- A digit is one of 0123456789 is_graph: BOOLEAN -- Is `item` a printable character except space? is_hashable: BOOLEAN -- May current object be hashed? -- (True by default.) -- (from HASHABLE) is_hexa_digit: BOOLEAN -- Is `item` an hexadecimal digit? -- A digit is one of 0123456789ABCDEFabcedf is_lower: BOOLEAN -- Is `item` lowercase? is_printable: BOOLEAN -- Is `item` a printable character including space? is_punctuation: BOOLEAN -- Is `item` a punctuation? is_space: BOOLEAN -- Is `item` a white space? is_upper: BOOLEAN -- Is `item` uppercase? 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)) feature -- Element change set_item (c: CHARACTER_8) -- Make c the `item` value. feature -- Conversion as_lower: CHARACTER_8 -- Lowercase value of `item` -- Returns `item` if not `is_upper` -- Was declared in {CHARACTER_8_REF} as synonym of `lower`. as_upper: CHARACTER_8 -- Uppercase value of `item`. -- Returns `item` if not `is_lower`. -- Caveat: not all upper-case values fit into CHARACTER_8. Use CHARACTER_32 instead. -- Was declared in {CHARACTER_8_REF} as synonym of `upper`. lower: CHARACTER_8 -- Lowercase value of `item` -- Returns `item` if not `is_upper` -- Was declared in {CHARACTER_8_REF} as synonym of `as_lower`. to_character_32: CHARACTER_32 -- Associated character in 32 bit version to_character_8: CHARACTER_8 -- Associated character in 8 bit version to_hexa_digit: NATURAL_8 -- Convert a hexadecimal unicode digit character to the corresponding numeric value. require is_hexa_digit ensure range: 0 <= Result.to_integer_32 and Result < 16 value: ("0123456789ABCDEF") [Result + 1.to_integer_32] = as_upper to_reference: CHARACTER_8_REF -- Associated reference of Current ensure to_reference_not_void: Result /= Void upper: CHARACTER_8 -- Uppercase value of `item`. -- Returns `item` if not `is_lower`. -- Caveat: not all upper-case values fit into CHARACTER_8. Use CHARACTER_32 instead. -- Was declared in {CHARACTER_8_REF} as synonym of `as_upper`. feature -- Duplication copy (other: CHARACTER_8_REF) -- 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) ensure -- from ANY is_equal: Current ~ other frozen deep_copy (other: CHARACTER_8_REF) -- Effect equivalent to that of: -- `copy` (other . `deep_twin`) -- (from ANY) require -- from ANY other_not_void: other /= Void ensure -- from ANY deep_equal: deep_equal (Current, other) frozen deep_twin: CHARACTER_8_REF -- 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_copy (other: CHARACTER_8_REF) -- 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) ensure -- from ANY is_standard_equal: standard_is_equal (other) frozen standard_twin: CHARACTER_8_REF -- 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) frozen twin: CHARACTER_8_REF -- New object equal to Current -- `twin` calls `copy`; to change copying/twinning semantics, redefine `copy`. -- (from ANY) ensure -- from ANY twin_not_void: Result /= Void is_equal: Result ~ Current feature -- Basic operations frozen default: detachable CHARACTER_8_REF -- 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) ensure -- from ANY instance_free: class default_rescue -- Process exception for routines with no Rescue clause. -- (Default: do nothing.) -- (from ANY) frozen do_nothing -- Execute a null action. -- (from ANY) ensure -- from ANY instance_free: class feature -- Basic routines difference alias "|-|" (other: CHARACTER_8): INTEGER_32 -- Difference between the codes of `item` and other ensure valid_result: other + Result = item minus alias "-" alias "−" (decr: INTEGER_32): CHARACTER_8 -- Subtract decr from the code of `item` require valid_decrement: (item.code - decr).is_valid_character_8_code ensure valid_result: item |-| Result = decr next: CHARACTER_8 -- Next character require valid_character: (item.code + 1).is_valid_character_8_code ensure valid_result: Result |-| item = 1 plus alias "+" (incr: INTEGER_32): CHARACTER_8 -- Add incr to the code of `item` require valid_increment: (item.code + incr).is_valid_character_8_code ensure valid_result: Result |-| item = incr previous: CHARACTER_8 -- Previous character require valid_character: (item.code - 1).is_valid_character_8_code ensure valid_result: Result |-| item = -1 feature -- Output Io: STD_FILES -- Handle to standard file setup -- (from ANY) ensure -- from ANY instance_free: class io_not_void: Result /= Void out: STRING_8 -- Printable representation of character ensure -- from ANY out_not_void: Result /= Void print (o: detachable ANY) -- Write terse external representation of o -- on standard output. -- (from ANY) ensure -- from ANY instance_free: class 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 instance_free: class 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-2021, 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 CHARACTER_8_REF -- Generated by Eiffel Studio --
For more details: eiffel.org