-- This file is part of a Liberty Eiffel library.
-- See the full copyright at the end.
--
class STD_OUTPUT
   --
   -- To use the standard output file. As for UNIX, the default standard output is the screen.
   --
   -- Note: only one instance of this class should be necessary.  Access it through ANY.std_output.
   --
   -- See also STANDARD_STREAMS, STD_INPUT_OUTPUT
   --

inherit
   TERMINAL_OUTPUT_STREAM
      redefine put_natively_stored_string, dispose
      end

insert
   REDIRECTION_TOOLS
      rename
         restore_default as restore_default_output
      redefine
         restore_default_output
      end

create {ANY}
   make

feature {ANY}
   is_connected: BOOLEAN True

   disconnect
      do
         filter := Void
      end

feature {}
   make
      do
         buffer := buffer.calloc(4096)
         capacity := 4096
      end

feature {FILTER_OUTPUT_STREAM}
   filtered_put_character (c: CHARACTER)
      do
         if buffer_position >= 4096 then
            write_buffer
         end
         buffer.put(c, buffer_position)
         buffer_position := buffer_position + 1
         if c = '%N' then
            write_buffer
         end
      end

   filtered_flush
      do
         if buffer_position > 0 then
            write_buffer
         end
         io_flush(stdout)
      end

feature {ABSTRACT_STRING}
   put_natively_stored_string (s: NATIVELY_STORED_STRING)
      local
         unused_result: INTEGER
         fs: FIXED_STRING
      do
         write_buffer
         if fs ?:= s then
            fs ::= s
            --|*** TODO: replace by an io_fwrite_slice
            if fs.is_shared then
               fs.unshare
            end
         end
         unused_result := io_fwrite(s.storage, s.count, stdout)
      end

feature {FILTER}
   filtered_descriptor: INTEGER
      do
         Result := sequencer_descriptor(stdout)
      end

   filtered_has_descriptor: BOOLEAN True

   filtered_stream_pointer: POINTER
      do
         Result := stdout
      end

   filtered_has_stream_pointer: BOOLEAN True

feature {STREAM_HANDLER}
   redirect_to (file_name: STRING)
         -- Redirect standard output to `file_name' instead of the default standard output.  If `file_name'
         -- does not exist, it is created.  If it exists, its previous content is erased.
         --
         -- See also `redirection_succeeded'
      do
         redirect(open_descriptor_for_create(file_name.to_external))
      end

   redirect_append_to (file_name: STRING)
         -- Redirect standard output to `file_name' instead of the default standard output.  If `file_name'
         -- does not exist, it is created.  If it exists, the new output is appended to it.
         --
         -- See also `redirection_succeeded'
      do
         redirect(open_descriptor_for_append(file_name.to_external))
      end

   restore_default_output
         -- Restore standard output to go to the default standard output.
      do
         Precursor
      end

feature {}
   buffer_position: INTEGER

   buffer: NATIVE_ARRAY[CHARACTER]

   capacity: INTEGER

   write_buffer
      local
         unused_result: INTEGER
      do
         if buffer_position > 0 then
            unused_result := io_fwrite(buffer, buffer_position, stdout)
            buffer_position := 0
         end
      end

   stdout: POINTER
      external "plug_in"
      alias "{
         location: "${sys}/plugins"
         module_name: "io"
         feature_name: "stdout"
         }"
      end

   dispose
      do
         check
            std_output = Current
         end
         -- Nothing to dispose for `std_output'.
      end

end -- class STD_OUTPUT
--
-- Copyright (C) 2009-2017: by all the people cited in the AUTHORS file.
--
-- Permission is hereby granted, free of charge, to any person obtaining a copy
-- of this software and associated documentation files (the "Software"), to deal
-- in the Software without restriction, including without limitation the rights
-- to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-- copies of the Software, and to permit persons to whom the Software is
-- furnished to do so, subject to the following conditions:
--
-- The above copyright notice and this permission notice shall be included in
-- all copies or substantial portions of the Software.
--
-- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-- IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-- FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-- AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-- LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-- OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-- THE SOFTWARE.