note description: "Interface for character output streams" library: "Gobo Eiffel Kernel Library" copyright: "Copyright (c) 2001-2016, Eric Bezault and others" license: "MIT License" date: "$Date: 2017-04-11 18:34:55 +0000 (Tue, 11 Apr 2017) $" revision: "$Revision: 100137 $" deferred class KI_CHARACTER_OUTPUT_STREAM feature {NONE} -- Initialization default_create -- Process instances of classes with no creation clause. -- (Default: do nothing.) -- (from ANY) do end feature -- Access generating_type: TYPE [detachable KI_CHARACTER_OUTPUT_STREAM] -- 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 name: STRING_8 -- Name of output stream -- (from KI_OUTPUT_STREAM) deferred ensure -- from KI_OUTPUT_STREAM name_not_void: Result /= Void end feature {NONE} -- Access String_: KL_STRING_ROUTINES -- Routines that ought to be in class STRING -- (from KL_IMPORTED_STRING_ROUTINES) once create Result ensure -- from KL_IMPORTED_STRING_ROUTINES instance_free: class string_routines_not_void: Result /= Void 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 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 frozen is_deep_equal (other: KI_CHARACTER_OUTPUT_STREAM): 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: KI_CHARACTER_OUTPUT_STREAM): BOOLEAN -- Is other attached to an object considered -- equal to current object? -- (from ANY) require -- from ANY other_not_void: other /= Void external "built_in" ensure -- from ANY symmetric: Result implies other ~ Current consistent: standard_is_equal (other) implies Result 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 (other: KI_CHARACTER_OUTPUT_STREAM): 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 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 is_closable: BOOLEAN -- Can current output stream be closed? -- (from KI_OUTPUT_STREAM) do Result := False ensure -- from KI_OUTPUT_STREAM is_open: Result implies is_open_write end is_open_write: BOOLEAN -- Can items be written to output stream? -- (from KI_OUTPUT_STREAM) deferred 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 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: KI_CHARACTER_OUTPUT_STREAM) -- 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: KI_CHARACTER_OUTPUT_STREAM) -- 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: KI_CHARACTER_OUTPUT_STREAM -- 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 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: KI_CHARACTER_OUTPUT_STREAM) -- 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: KI_CHARACTER_OUTPUT_STREAM -- 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 frozen twin: KI_CHARACTER_OUTPUT_STREAM -- 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 KI_CHARACTER_OUTPUT_STREAM 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 close -- Try to close output stream if it is closable. Set -- is_open_write to false if operation was successful. -- (from KI_OUTPUT_STREAM) require -- from KI_OUTPUT_STREAM is_closable: is_closable do end frozen default: detachable KI_CHARACTER_OUTPUT_STREAM -- 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 flush -- Flush buffered data to disk. require is_open_write: is_open_write deferred end feature {NONE} -- Implementation False_constant: STRING_8 = "False" -- String representation of boolean value 'False' True_constant: STRING_8 = "True" -- String representation of boolean value 'True' feature -- Output append (an_input_stream: KI_INPUT_STREAM [CHARACTER_8]) -- Read items of an_input_stream until the end -- of input is reached, and write these items to -- current output stream. require -- from KI_OUTPUT_STREAM is_open_write: is_open_write an_input_stream_not_void: an_input_stream /= Void an_input_stream_open_read: an_input_stream.is_open_read do if attached {KI_CHARACTER_INPUT_STREAM} an_input_stream as a_character_input then from if not a_character_input.end_of_input then a_character_input.read_string (512) end until a_character_input.end_of_input loop put_string (a_character_input.last_string) a_character_input.read_string (512) end else Precursor (an_input_stream) end ensure -- from KI_OUTPUT_STREAM end_of_input: an_input_stream.end_of_input end 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) do if o /= Void then Io.put_string (o.out) end ensure -- from ANY instance_free: class end put_character (v: CHARACTER_8) -- Write v to output stream. -- (from KI_OUTPUT_STREAM) require -- from KI_OUTPUT_STREAM is_open_write: is_open_write deferred end put_boolean (b: BOOLEAN) -- Write "True" to output stream if -- b is true, "False" otherwise. require is_open_write: is_open_write do if b then put_string (True_constant) else put_string (False_constant) end end put_integer (i: INTEGER_32) -- Write decimal representation -- of i to output stream. -- Regexp: 0|(-?[1-9][0-9]*) require is_open_write: is_open_write do put_integer_64 (i.to_integer_64) end put_integer_16 (i: INTEGER_16) -- Write decimal representation -- of i to output stream. -- Regexp: 0|(-?[1-9][0-9]*) require is_open_write: is_open_write do put_integer_64 (i.to_integer_64) end put_integer_32 (i: INTEGER_32) -- Write decimal representation -- of i to output stream. -- Regexp: 0|(-?[1-9][0-9]*) require is_open_write: is_open_write do put_integer_64 (i.to_integer_64) end put_integer_64 (i: INTEGER_64) -- Write decimal representation -- of i to output stream. -- Regexp: 0|(-?[1-9][0-9]*) require is_open_write: is_open_write local k, j: INTEGER_64 do if i = 0 then put_character ('0') elseif i < 0 then put_character ('-') k := - (i + 1) j := k // 10 inspect k \\ 10 when 0 then if j /= 0 then put_integer_64 (j) end put_character ('1') when 1 then if j /= 0 then put_integer_64 (j) end put_character ('2') when 2 then if j /= 0 then put_integer_64 (j) end put_character ('3') when 3 then if j /= 0 then put_integer_64 (j) end put_character ('4') when 4 then if j /= 0 then put_integer_64 (j) end put_character ('5') when 5 then if j /= 0 then put_integer_64 (j) end put_character ('6') when 6 then if j /= 0 then put_integer_64 (j) end put_character ('7') when 7 then if j /= 0 then put_integer_64 (j) end put_character ('8') when 8 then if j /= 0 then put_integer_64 (j) end put_character ('9') when 9 then put_integer_64 (j + 1) put_character ('0') end else k := i j := k // 10 if j /= 0 then put_integer_64 (j) end inspect k \\ 10 when 0 then put_character ('0') when 1 then put_character ('1') when 2 then put_character ('2') when 3 then put_character ('3') when 4 then put_character ('4') when 5 then put_character ('5') when 6 then put_character ('6') when 7 then put_character ('7') when 8 then put_character ('8') when 9 then put_character ('9') end end end put_integer_8 (i: INTEGER_8) -- Write decimal representation -- of i to output stream. -- Regexp: 0|(-?[1-9][0-9]*) require is_open_write: is_open_write do put_integer_64 (i.to_integer_64) end put_natural_16 (i: NATURAL_16) -- Write decimal representation -- of i to output stream. -- Regexp: 0|([1-9][0-9]*) require is_open_write: is_open_write do put_natural_64 (i.to_natural_64) end put_natural_32 (i: NATURAL_32) -- Write decimal representation -- of i to output stream. -- Regexp: 0|([1-9][0-9]*) require is_open_write: is_open_write do put_natural_64 (i.to_natural_64) end put_natural_64 (i: NATURAL_64) -- Write decimal representation -- of i to output stream. -- Regexp: 0|([1-9][0-9]*) require is_open_write: is_open_write local k, j: NATURAL_64 do if i = 0 then put_character ('0') else k := i j := k // 10 if j /= 0 then put_natural_64 (j) end inspect k \\ 10 when 0 then put_character ('0') when 1 then put_character ('1') when 2 then put_character ('2') when 3 then put_character ('3') when 4 then put_character ('4') when 5 then put_character ('5') when 6 then put_character ('6') when 7 then put_character ('7') when 8 then put_character ('8') when 9 then put_character ('9') end end end put_natural_8 (i: NATURAL_8) -- Write decimal representation -- of i to output stream. -- Regexp: 0|([1-9][0-9]*) require is_open_write: is_open_write do put_natural_64 (i.to_natural_64) end put_string (a_string: STRING_8) -- Write a_string to output stream. require is_open_write: is_open_write a_string_not_void: a_string /= Void deferred end put_substring (a_string: STRING_8; s, e: INTEGER_32) -- Write substring of a_string between indexes -- s and e to output stream. require is_open_write: is_open_write a_string_not_void: a_string /= Void s_large_enough: s >= 1 e_small_enough: e <= a_string.count valid_interval: s <= e + 1 do if s <= e then put_string (a_string.substring (s, e)) end 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_8 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: ") create l_exc l_msg.append (generating_type.name) l_exc.raise_retrieval_exception (l_msg) end end invariant -- from ANY reflexive_equality: standard_is_equal (Current) reflexive_conformance: conforms_to (Current) end -- class KI_CHARACTER_OUTPUT_STREAM
Generated by ISE EiffelStudio