note description: "References to objects containing a unicode character value" library: "Free implementation of ELKS library" status: "See notice at end of class." legal: "See notice at end of class." date: "$Date: 2020-04-15 18:06:04 +0000 (Wed, 15 Apr 2020) $" revision: "$Revision: 104046 $" class interface CHARACTER_32_REF create default_create -- Process instances of classes with no creation clause. -- (Default: do nothing.) -- (from ANY) feature -- Access generating_type: TYPE [detachable CHARACTER_32_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_32 -- Unicode character value Max_unicode_value: NATURAL_32 = 1114109 -- Maximum Unicode characters. Max_value: NATURAL_32 = 4294967295 -- Bounds for integer representation of CHARACTER_32 Min_value: NATURAL_32 = 0 natural_32_code: NATURAL_32 -- Associated natural value ensure natural_32_code_in_range: Result >= Min_value and Result <= Max_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_32_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_32_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_32_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_32_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_32_REF): CHARACTER_32_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_32_REF): CHARACTER_32_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_32_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_32_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_character_8: BOOLEAN -- Can current be represented on a CHARACTER_8? is_control: BOOLEAN -- Is item a control character? is_digit: BOOLEAN -- Is item a decimal digit as expected for ASCII characters? -- A digit is one of 0123456789. is_hashable: BOOLEAN -- May current object be hashed? -- (True by default.) -- (from HASHABLE) is_hexa_digit: BOOLEAN -- Is item a hexadecimal digit as expected for ASCII characters? -- A digit is one of 0123456789ABCDEFabcedf. is_lower: BOOLEAN -- Is item lowercase? is_punctuation: BOOLEAN -- Is item a punctuation? is_space: BOOLEAN -- Is item a white space? is_unicode_digit: BOOLEAN -- Is item a decimal digit as expected for Unicode characters? 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_32) -- Make c the item value. feature -- Conversion as_lower: CHARACTER_32 -- Lowercase value of item. -- Returns item if not is_upper. -- Was declared in CHARACTER_32_REF as synonym of lower. as_upper: CHARACTER_32 -- Uppercase value of item. -- Returns item if not is_lower. -- Was declared in CHARACTER_32_REF as synonym of upper. lower: CHARACTER_32 -- Lowercase value of item. -- Returns item if not is_upper. -- Was declared in CHARACTER_32_REF as synonym of as_lower. to_character_32: CHARACTER_32 -- Convert current to CHARACTER_32. to_character_8: CHARACTER_8 -- Convert current to CHARACTER_8. require is_character_8_compatible: is_character_8 to_reference: CHARACTER_32_REF -- Associated reference of Current. ensure to_reference_not_void: Result /= Void upper: CHARACTER_32 -- Uppercase value of item. -- Returns item if not is_lower. -- Was declared in CHARACTER_32_REF as synonym of as_upper. feature -- Duplication copy (other: CHARACTER_32_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_32_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_32_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_32_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_32_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_32_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_32_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_32): INTEGER_64 -- Difference between the codes of item and other. ensure valid_non_negative_result: Result >= 0 implies ((other + Result.to_natural_32) = item) valid_negative_result: Result < 0 implies (other = (item + Result.to_natural_32)) minus alias "-" alias "−" (decr: NATURAL_32): CHARACTER_32 -- Subtract decr from the code of item. require valid_decrement: (item.natural_32_code.to_integer_64 - decr.to_integer_64).is_valid_character_32_code ensure valid_result: item |-| Result = decr.to_integer_64 next: CHARACTER_32 -- Next character. require valid_character: (item.natural_32_code.to_natural_64 + 1).is_valid_character_32_code ensure valid_result: Result |-| item = 1 plus alias "+" (incr: NATURAL_32): CHARACTER_32 -- Add incr to the code of item. require valid_increment: (item.natural_32_code.to_natural_64 + incr.to_natural_64).is_valid_character_32_code ensure valid_result: Result |-| item = incr.to_integer_64 previous: CHARACTER_32 -- Previous character. require valid_character: (item.natural_32_code.to_natural_64 - 1).is_valid_character_32_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 wide 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-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 CHARACTER_32_REF
Generated by ISE EiffelStudio