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 interface
	KI_CHARACTER_OUTPUT_STREAM

feature -- Access

	generating_type: TYPE [detachable KI_CHARACTER_OUTPUT_STREAM]
			-- 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

	name: STRING_8
			-- Name of output stream
			-- (from KI_OUTPUT_STREAM)
		ensure -- from KI_OUTPUT_STREAM
			name_not_void: Result /= Void
	
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 (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
		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: 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
		ensure -- from ANY
			symmetric: Result implies other ~ Current
			consistent: standard_is_equal (other) implies Result

	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 (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
		ensure -- from ANY
			same_type: Result implies same_type (other)
			symmetric: Result implies other.standard_is_equal (Current)
	
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_closable: BOOLEAN
			-- Can current output stream be closed?
			-- (from KI_OUTPUT_STREAM)
		ensure -- from KI_OUTPUT_STREAM
			is_open: Result implies is_open_write

	is_open_write: BOOLEAN
			-- Can items be written to output stream?
			-- (from KI_OUTPUT_STREAM)

	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 -- Duplication

	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)
		ensure -- from ANY
			is_equal: Current ~ other

	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
		ensure -- from ANY
			deep_equal: deep_equal (Current, other)

	frozen deep_twin: KI_CHARACTER_OUTPUT_STREAM
			-- 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: 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)
		ensure -- from ANY
			is_standard_equal: standard_is_equal (other)

	frozen standard_twin: KI_CHARACTER_OUTPUT_STREAM
			-- 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: KI_CHARACTER_OUTPUT_STREAM
			-- 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

	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

	frozen default: detachable KI_CHARACTER_OUTPUT_STREAM
			-- 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

	flush
			-- Flush buffered data to disk.
		require
			is_open_write: is_open_write
	
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
		ensure -- from KI_OUTPUT_STREAM
			end_of_input: an_input_stream.end_of_input

	Io: STD_FILES
			-- Handle to standard file setup
			-- (from ANY)
		ensure -- from ANY
			instance_free: class
			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)
		ensure -- from ANY
			instance_free: class

	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

	put_boolean (b: BOOLEAN)
			-- Write "True" to output stream if
			-- b is true, "False" otherwise.
		require
			is_open_write: is_open_write

	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

	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

	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

	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

	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

	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

	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

	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

	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

	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

	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

	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 ANY
	reflexive_equality: standard_is_equal (Current)
	reflexive_conformance: conforms_to (Current)

end -- class KI_CHARACTER_OUTPUT_STREAM

Generated by ISE EiffelStudio