#
# Ronin - A Ruby platform for exploit development and security research.
#
# Copyright (c) 2006-2010 Hal Brodigan (postmodern.mod3 at gmail.com)
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
#

require 'ronin/ui/output/output'

module Ronin
  module UI
    module Output
      module Helpers
        #
        # Writes data unless output has been silenced.
        #
        # @param [String, Object] data
        #   The data to write.
        #
        # @return [Integer, nil]
        #   The number of bytes writen.
        #
        # @since 1.0.0
        #
        def write(data)
          unless Output.silent?
            data = data.to_s

            Output.handler.write(data)
            return data.length
          end
        end

        #
        # Prints a character.
        #
        # @param [String, Integer] data
        #   The character or byte to print.
        #
        # @return [String, Integer]
        #   The byte or character.
        #
        # @since 1.0.0
        #
        def putc(data)
          char = data.chr if data.kind_of?(Integer)

          write(data)
          return data
        end

        #
        # Prints one or more messages.
        #
        # @param [Array] messages
        #   The messages to print.
        #
        # @example
        #   puts 'some data'
        #
        # @since 0.3.0
        #
        def puts(*messages)
          unless messages.empty?
            messages.each { |message| write("#{message}#{$/}") }
          else
            write($/)
          end

          return nil
        end

        #
        # Prints formatted data.
        #
        # @param [String] format
        #   The format string.
        #
        # @param [Array] data
        #   The data to format.
        #
        # @return [nil]
        # 
        # @since 1.0.0
        #
        def printf(format,*data)
          write(format % data)
          return nil
        end

        #
        # Prints one or more messages as `info` output.
        #
        # @param [Array] messages
        #   The messages to print.
        #
        # @return [Boolean]
        #   Specifies whether the messages were successfully printed.
        #
        # @example
        #   print_info 'Connecting ...'
        #
        # @since 0.3.0
        #
        def print_info(*messages)
          unless Output.silent?
            Output.handler.print_info(*messages)
            return true
          end

          return false
        end

        #
        # Prints one or more messages as `debug` output.
        #
        # @param [Array] messages
        #   The messages to print.
        #
        # @return [Boolean]
        #   Specifies whether the messages were successfully printed.
        #
        # @example
        #   print_debug "var1: #{var1.inspect}"
        #
        # @since 0.3.0
        #
        def print_debug(*messages)
          if (Output.verbose? && !(Output.silent?))
            Output.handler.print_debug(*messages)
            return true
          end

          return false
        end

        #
        # Prints one or more messages as `warning` output.
        #
        # @param [Array] messages
        #   The messages to print.
        #
        # @return [Boolean]
        #   Specifies whether the messages were successfully printed.
        #
        # @example
        #   print_warning 'Detecting a restricted character in the buffer'
        #
        # @since 0.3.0
        #
        def print_warning(*messages)
          if (Output.verbose? && !(Output.silent?))
            Output.handler.print_warning(*messages)
            return true
          end
          
          return false
        end

        #
        # Prints one or more messages as `error` output.
        #
        # @param [Array] messages
        #   The messages to print.
        #
        # @return [Boolean]
        #   Specifies whether the messages were successfully printed.
        #
        # @example
        #   print_error 'Could not connect!'
        #
        # @since 0.3.0
        #
        def print_error(*messages)
          unless Output.silent?
            Output.handler.print_error(*messages)
            return true
          end

          return false
        end
      end
    end
  end
end