class RBT::MapThisInputToThatRegisteredProgram

Public Class Methods

[](i = '') click to toggle source
#

RBT::MapThisInputToThatRegisteredProgram[]

This method will return nil if no registered program has been found for the given input. Otherwise it will return the real name of the program at hand.

.h files work as input as well.

Usage examples:

x = RBT::MapThisInputToThatRegisteredProgram[:php]
x = RBT::MapThisInputToThatRegisteredProgram[:gee]
x = RBT::MapThisInputToThatRegisteredProgram[:foobar]
x = RBT::MapThisInputToThatRegisteredProgram['stdio.h']
x = RBT::MapThisInputToThatRegisteredProgram[:soxi] # => "sox"
#
# File lib/rbt/misc/map_this_input_to_that_registered_program.rb, line 338
def self.[](i = '')
  new(i) { :be_quiet }.real_program_name?
end
new( commandline_arguments = nil, run_already = true ) { || ... } click to toggle source
#

initialize

#
# File lib/rbt/misc/map_this_input_to_that_registered_program.rb, line 44
def initialize(
    commandline_arguments = nil,
    run_already           = true
  )
  reset
  set_commandline_arguments(
    commandline_arguments
  )
  # ======================================================================= #
  # === Handle blocks next:
  # ======================================================================= #
  if block_given?
    yielded = yield
    case yielded
    # ===================================================================== #
    # === :be_quiet
    # ===================================================================== #
    when :be_quiet
      @be_verbose = false
    end
  end
  run if run_already
end

Public Instance Methods

clear()
Alias for: reset
commandline_arguments?() click to toggle source
#

commandline_arguments?

#
# File lib/rbt/misc/map_this_input_to_that_registered_program.rb, line 102
def commandline_arguments?
  @commandline_arguments
end
first_argument?() click to toggle source
#

first_argument?

#
# File lib/rbt/misc/map_this_input_to_that_registered_program.rb, line 109
def first_argument?
  @commandline_arguments.first
end
real_program_name?() click to toggle source
#

real_program_name?

#
# File lib/rbt/misc/map_this_input_to_that_registered_program.rb, line 316
def real_program_name?
  @real_program_name
end
Also aliased as: return_possible_match
reset() click to toggle source
#

reset (reset tag)

#
# File lib/rbt/misc/map_this_input_to_that_registered_program.rb, line 71
def reset
  # ======================================================================= #
  # === @be_verbose
  # ======================================================================= #
  @be_verbose = true
  # ======================================================================= #
  # === @real_program_name
  #
  # This is always nil on startup.
  # ======================================================================= #
  @real_program_name = nil
  # ======================================================================= #
  # === @type
  #
  # @type can be :abbreviation, :library, :header, :pkgconfig_file,
  # :partial_header or a similar entry.
  # ======================================================================= #
  @type = nil
end
Also aliased as: clear
return_possible_match()
Alias for: real_program_name?
run() click to toggle source
#

run (run tag)

#
# File lib/rbt/misc/map_this_input_to_that_registered_program.rb, line 133
def run
  i = first_argument?.to_s # Must work on a String.
  # ======================================================================= #
  # === Handle the real names
  # ======================================================================= #
  if RBT.is_this_a_registered_program?(i)
    @real_program_name = i
    if @be_verbose
      e "#{i} is a registered program."
    end
  # ======================================================================= #
  # === Handle input that incorrectly starts with "lib".
  #
  # Next, we handle input given to this class like "libcryptsetup",
  # which should really just be "cryptsetup" instead.
  # ======================================================================= #
  elsif i.start_with?('lib') and RBT.is_this_a_registered_program?(i.sub(/^lib/,''))
    @real_program_name = i.sub(/^lib/,'')
    if @be_verbose
      e "#{i} is a registered program, if the leading 'lib' prefix is dropped."
    end
    set_type :program
  # ======================================================================= #
  # === Handle abbreviations next
  # ======================================================================= #
  elsif RBT.is_this_a_registered_abbreviation?(i)
    @real_program_name = RBT.hash_aliases_to_the_available_programs?[i]
    if @be_verbose
      e "#{i} is a registered abbreviation."
      e "It points to the program called `#{@real_program_name}`." 
    end
    set_type :abbreviation
  # ======================================================================= #
  # === Handle binaries next
  #
  # Commandline usage example:
  #
  #   map_this_input_to_that_registered_program soxi
  #
  # ======================================================================= #
  elsif RBT.is_this_a_registered_binary?(i)
    @real_program_name = RBT.hash_all_binaries[i]
    if @be_verbose
      e "#{i} is a registered binary (executable)."
      e "It points to the program called `#{@real_program_name}`." 
    end
    set_type :binary
  # ======================================================================= #
  # === Handle binaries next, downcasing the input
  #
  # This entry point will find all registered binaries for all
  # available programs.
  #
  # Commandline usage example:
  #
  #   map_this_input_to_that_registered_program soxi
  #
  # ======================================================================= #
  elsif RBT.is_this_a_registered_binary?(i.downcase)
    @real_program_name = RBT.hash_all_binaries[i.downcase]
    if @be_verbose
      e "#{i.downcase} is a registered binary (executable)."
      e "It points to the program called `#{@real_program_name}`." 
    end
    set_type :binary
  # ======================================================================= #
  # === Handle binaries next, downcasing the input
  #
  # This entry point will find all registered binaries for all
  # available programs.
  #
  # Commandline usage example:
  #
  #   map_this_input_to_that_registered_program soxi
  #
  # ======================================================================= #
  elsif RBT.is_this_a_registered_binary?(i.downcase, :deep_check)
    @real_program_name = RBT.hash_all_binaries[i.downcase]
    if @be_verbose
      e "#{i.downcase} is a registered binary (executable)."
      e "It points to the program called `#{@real_program_name}`." 
    end
    set_type :binary
  # ======================================================================= #
  # === Handle libraries next
  #
  # Example:
  #
  #   map_this_input_to_that_registered_program libc.so
  #
  # ======================================================================= #
  elsif ::RBT.is_this_library_included?(i)
    this_library = RBT.this_library_to_that_program(i)
    @real_program_name = this_library
    if @be_verbose
      e "#{i} is a registered library."
      e "It points to the program called `#{@real_program_name}`." 
    end
    set_type :library
  # ======================================================================= #
  # === Handle headers next
  #
  # Commandline usage example:
  #
  #    map_this_input_to_that_registered_program udev.h
  #    map_this_input_to_that_registered_program wrap_init.h
  #
  # ======================================================================= #
  elsif RBT.is_this_header_included?(i)
    @real_program_name = RBT.all_headers?[i]
    if @be_verbose
      e "#{i} is a registered header file."
      e "It points to the program called `#{@real_program_name}`." 
    end
    set_type :header
  # ======================================================================= #
  # === Handle partial headers next
  #
  # Commandline usage example:
  #
  #    map_this_input_to_that_registered_program SMlib.h
  #
  # ======================================================================= #
  elsif RBT.is_this_partial_header_included?(i)
    selection = RBT.all_headers?.transform_keys {|entry|
      File.basename(entry)
    }
    if selection.has_key? i
      @real_program_name = selection[i]
      if @be_verbose
        e "#{i} is a registered partial header file - this means it"
        e "is in a subdirectory."
        e "It points to the program called `#{@real_program_name}`." 
      end
      set_type :partial_header
    else
      opnn; e 'The header '+steelblue(i)+' was not found, oddly enough.'
    end
  # ======================================================================= #
  # === Handle .pc pkgconfig-entries next
  #
  # Commandline usage example:
  #
  #    map_this_input_to_that_registered_program xau.pc
  #
  # ======================================================================= #
  elsif RBT.is_this_pkgconfig_file_included?(i)
    @real_program_name = RBT.return_the_associated_program_for_this_pkgconfig_file(i)
    if @be_verbose
      e "#{i} is a registered .pc pkg-config file."
      e "It points to the program called `#{@real_program_name}`." 
    end
    set_type :pkgconfig_file
  # ======================================================================= #
  # === Handle partial headers next
  #
  # Commandline usage example:
  #
  #    map_this_input_to_that_registered_program wrap_init.h
  #
  # ======================================================================= #
  elsif RBT.is_this_partial_header_included?(i)
    _ = RBT.all_headers?
    # ===================================================================== #
    # Must find any partial match next.
    # ===================================================================== #
    possible_matches = _.select {|key, value| key.include?(i) }
    @real_program_name = possible_matches.first.last
    if @be_verbose
      e "#{i} is a registered header file."
      e "It points to the program called `#{@real_program_name}`." 
    end
    set_type :header
  else
    if @be_verbose
      e "#{i} is not registered."
    end
  end
end
set_commandline_arguments(i = '') click to toggle source
#

set_commandline_arguments

#
# File lib/rbt/misc/map_this_input_to_that_registered_program.rb, line 94
def set_commandline_arguments(i = '')
  i = [i].flatten.compact # .map(&:downcase) # No longer downcase it.
  @commandline_arguments = i
end
set_type(i = :abbreviation) click to toggle source
#

set_type

Type can be at the least :abbreviation and :program, but probably more than that.

#
# File lib/rbt/misc/map_this_input_to_that_registered_program.rb, line 119
def set_type(i = :abbreviation)
  @type = i
end
type?() click to toggle source
#

type?

#
# File lib/rbt/misc/map_this_input_to_that_registered_program.rb, line 126
def type?
  @type.to_s
end