#
#--
# Ronin - A Ruby platform designed for information security and data
# exploration tasks.
#
# Copyright (c) 2006-2008 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/command_line/options'
require 'ronin/ui/command_line/command_line'
require 'ronin/extensions/meta'

module Ronin
  module UI
    module CommandLine
      class Command

        # The options for the command
        attr_reader :options

        #
        # Creates a new Command object.
        #
        def initialize
          Options.command('ronin',self.class.command_name) do |opts|
            define_options(opts)

            @options = opts
          end
        end

        #
        # Returns the name of the command.
        #
        def self.command_name
          nil
        end

        #
        # Returns the short names of the command.
        #
        def self.command_short_names
          []
        end

        #
        # Returns all the names of the command.
        #
        def self.command_names
          ([self.command_name] + self.command_short_names).compact
        end

        #
        # Creates a new command object and runs it with the given _args_.
        #
        def self.run(*args)
          cmd = self.new

          cmd.arguments(*(cmd.options.parse(args)))
          return nil
        end

        #
        # Prints the help information for the command.
        #
        def self.help
          self.new.help
        end

        #
        # Prints the help information for the command.
        #
        def help
          @options.help
          return self
        end

        #
        # Returns the String form of the command.
        #
        def to_s
          names.join(', ')
        end

        protected

        #
        # Registers the command with the specified _name_ and the given
        # _short_names_.
        #
        def self.command(name,*short_names)
          name = name.to_s
          short_names = short_names.map { |short_name| short_name.to_s }

          meta_def(:command_name) { name }
          meta_def(:command_short_names) { short_names }

          unless CommandLine.commands.include?(self)
            # register the command
            CommandLine.commands << self
          end

          # register the command by name
          CommandLine.commands_by_name[name] = self

          # register the command by it's short_names
          short_names.each do |short_name|
            CommandLine.commands_by_name[short_name] = self
          end

          return self
        end

        #
        # See CommandLine.error.
        #
        def error(message)
          CommandLine.error("#{self.class.command_name}: #{message}")
        end

        #
        # See CommandLine.success.
        #
        def success(&block)
          CommandLine.success(&block)
        end

        #
        # See CommandLine.fail.
        #
        def fail(message,&block)
          CommandLine.fail("#{self.class.command_name}: #{message}",&block)
        end

        #
        # Define the command-line options for the command.
        #
        def define_options(opts)
        end

        #
        # Processes the additional arguments specified by _args_.
        #
        def arguments(*args)
        end

      end
    end
  end
end