module ProgramInformation

# File lib/program_information/program_information.rb, line 558
def self.[](i)
  ::ProgramInformation::ProgramInformation.new(i)
end

# File lib/program_information/toplevel_methods/e.rb, line 10
def self.e(i = '')
  puts i
end

# File lib/program_information/www/embeddable_interface.rb, line 55
def self.embeddable_interface
  object = Object.new
  object.extend(::ProgramInformation::EmbeddableInterface)
  return object
end

# File lib/program_information/toplevel_methods/opnn.rb, line 18
def self.opnn(
    i = 'ProgramInformation'
  )
  if i.is_a? String
    i = { namespace: i }
  end
  Opn.opn(i) if Object.const_defined? :Opn
end

# File lib/program_information/project/project_base_directory.rb, line 18
def self.project_base_dir?
  PROJECT_BASE_DIRECTORY
end

# File lib/program_information/toplevel_methods/remove_archive_type.rb, line 15
def self.remove_archive_type(i)
  i = i.dup if i.frozen?
  i.sub!(/\.tar\.gz$/,'')
  i.sub!(/\.tar\.xz$/,'')
  i.sub!(/\.tar\.bz2$/,'')
  i.sub!(/\.run$/,'')     if i.end_with? '.run'
  i.sub!(/\.bz2$/,'')     if i.end_with? '.bz2'
  i.sub!(/\.tar\.lz$/,'') if i.end_with? '.tar.lz'
  i.sub!(/\.gem$/,'')
  i.sub!(/\.tgz$/,'')
  i.sub!(/\.zip$/,'')
  i.sub!(/\.jar$/,'')
  i.sub!(/\.js$/,'')
  i.sub!(/\.stable$/,'')
  return i
end

# File lib/program_information/toplevel_methods.rb, line 104
def self.return_array_name_and_version(i)
  array = [
    ::ProgramInformation.return_short_name(i),
    ::ProgramInformation.return_program_version(i)
  ]
  return array
end

# File lib/program_information/toplevel_methods.rb, line 34
def self.return_program_version(of_this_program = '')
  if of_this_program.nil? or of_this_program.empty?
    opnn; e 'Please provide some input to the method '\
            'ProgramInformation.return_program_version.'
  else
    _ = ::ProgramInformation::ProgramInformation.new(of_this_program)
    _.program_version?
  end 
end

# File lib/program_information/toplevel_methods/return_proper_pipe_token_to_this_input.rb, line 21
def self.return_proper_pipe_token_to_this_input(
    entry
  )
  if entry.is_a? Array
    entry = entry.first
  end
  entry = remove_archive_type(entry)
  use_this_replacement_token = '|'
  return if entry.to_s.empty?
  begin
    # ===================================================================== #
    # === Check for input such as 'unieject-6', containing one '-' and 0 '_'
    # ===================================================================== #
    if (entry.count('-') == 1) and
       (entry.count('_') == 0)
      entry[entry.index('-'),1] = use_this_replacement_token
    # ===================================================================== #
    # === Check for input such as 'p7zip_16.02_src_all.tar.bz2' with
    #     3 '_' and at the least one '.' and no '-'
    # ===================================================================== #
    elsif (entry.count('_') == 3) and
          (entry.count('.') > 0) and
          (!entry.include?('-'))
      entry[entry.index('_'),1] = use_this_replacement_token
    # ===================================================================== #
    # === Input such as 'mod_python_3.3.1', with two '_' and no '-'.
    # ===================================================================== #
    elsif (entry.count('_') == 2) and
          (entry.count('-') == 0)
      entry[entry.rindex('_'),1] = use_this_replacement_token
    # ===================================================================== #
    # === Input such as 'unzip60' without any '-' or '_'
    # ===================================================================== #
    elsif (entry.count('-') == 0) and
          (entry.count('_') == 0) and
          (!entry.include?('.'))
      entry[entry.index(/\d/), 0] = '|'
    # ===================================================================== #
    # === Check for input such as 'artemis_v16.0.11' or 'dpkg_1.18.22'
    #     with one '_' and no '-'.
    # ===================================================================== #
    elsif (entry.count('_') == 1) and
          (entry.count('-') == 0)
      entry[entry.index('_'),1] = use_this_replacement_token
    # ===================================================================== #
    # === Input such as 'sendmail.8.15.2' or 'expect5.45.3', without
    #     any '-' or '_'.
    # ===================================================================== #
    elsif (entry.count('-') == 0) and
          (entry.count('_') == 0) and
          (entry.include?('.'))
      entry =~ REGEX_FOR_INPUT_HAVING_ONLY_DOTS
      entry = $1.to_s.dup+use_this_replacement_token+$2.to_s.dup
    # ===================================================================== #
    # For input such as 'boost-1_54_0' or 'ncbi_cxx-12_0_0' or
    # 'boost_1.56.6'. So it contains exactly one '-' character.
    # ===================================================================== #
    elsif ((entry.count('-') == 1) and
          (entry.count('_') > 1) and # More than 1 '_'
          (entry =~ REGEX_FOR_BOOST_LIKE_INPUT)) or # or the second condition.
          ((entry.count('_') == 3) and
          (entry.count('-') == 0) and
          (entry =~ REGEX_FOR_BOOST_LIKE_INPUT))
      entry =~ REGEX_FOR_BOOST_LIKE_INPUT
      # =================================================================== #
      # We here need only the first and the third match.
      # =================================================================== #
      entry = "#{$1.to_s.dup}#{use_this_replacement_token}#{$3.to_s.dup}"
    # ===================================================================== #
    # For input such as 'acl_2.2.47-1' or 'e_dbus-1.7.10' or
    # 'SDL2_gfx-1.0.1' or 'domain_name-0.5.20170404.gem' or
    # 'libatomic_ops-7.4.2' or 'icu4c-62_1'.
    # ===================================================================== #
    elsif (entry.count('_') == 1) and
          (entry.count('-') == 1) and
          (entry =~ REGEX_FOR_ACL_LIKE_INPUT)
      regex_to_use = REGEX_FOR_ACL_LIKE_INPUT
      entry =~ regex_to_use
      # =================================================================== #
      # Here we also only need to match towards the first and the third
      # entry.
      # =================================================================== #
      entry = $1.to_s.dup+use_this_replacement_token+$3.to_s.dup
    # ===================================================================== #
    # === Input such as 'did_you_mean-1.1.2' with one '-' and two '_'
    # ===================================================================== #
    elsif (entry.count('-') == 1) and
          (entry.count('_') == 2)
      entry[entry.index('-'),1] = use_this_replacement_token
    # ===================================================================== #
    # === Input such as 'ntfs-3g_ntfsprogs-2017.3.23' for 2 '-' and
    #     1 '_'.
    # ===================================================================== #
    elsif (entry.count('-') == 2) and
          (entry.count('_') == 1)
      regex_to_use = REGEX_FOR_INPUT_CONTAINING_TWO_HYPHENS_AND_ONE_UNDERSCORE
      entry =~ regex_to_use
      entry = $1.to_s.dup+use_this_replacement_token+$3.to_s.dup
    # ===================================================================== #
    # For input such as 'lynx-2.8.8-rel2' or 'subtle-0.11.3224-xi' or
    # 'gobject-introspection-1.53.4' or 'dvd+rw-tools-7.1' or
    # 'Archive-Zip-1.46' or 'b43-fwcutter-015' or 'wcd-6.0.1-beta3'
    # or 'oxygen-icons5-5.37.0'. These entries have two '-' and zero
    # '_'.
    # ===================================================================== #
    elsif (entry.count('-') == 2) and
          (entry.count('_') == 0)
      regex_to_use = REGEX_FOR_TWO_HYPHENS
      entry =~ regex_to_use
      entry = $1.to_s.dup+use_this_replacement_token+$2.to_s.dup
    # ===================================================================== #
    # For input such as 'polkit-qt-1-0.112.0' or
    # 'font-bitstream-75dpi-1.0.3' or 'boost-build-2014-10' or
    # 'xf86-video-i810-1.7.4' or 'gnome-internet-radio-locator-0.9.0'
    # or 'mime-types-data-3.2016.0521' or 'polkit-kde-agent-1-5.15.2'
    # or 'xf86-video-amd-2.7.7.7'.
    #
    # This input will NOT have any '_' token; and at the least 3
    # '-' tokens.
    # ===================================================================== #
    elsif (!entry.include?('_')) and
          (entry.count('-') >= 3)
      regex_to_use = REGEX_FOR_THREE_OR_MORE_HYPHENS
      entry =~ regex_to_use
      entry = $1.to_s.dup+
              use_this_replacement_token+
              $2.to_s.dup
    else
      e 'ERROR in program_information.rb! This should never happen.'
      e "The input was: #{entry}"
    end
  rescue Exception => error
    opnn; e 'An error happened (line: '+__LINE__.to_s+'), for '\
            'the entry `'+entry.to_s+'`.'
    pp error
    pp error.class
    opnn; e 'The caller stack was:'
    pp caller()
  end
  return entry
end

# File lib/program_information/toplevel_methods.rb, line 56
def self.return_real_short_name(of_this_program = '')
  if of_this_program.nil? or of_this_program.empty?
    opnn; e 'Please provide some input to the method '\
            'ProgramInformation.return_real_short_name.'
  else
    _ = ::ProgramInformation::ProgramInformation.new(of_this_program)
    _.real_short_name?
  end
end

# File lib/program_information/toplevel_methods.rb, line 123
def self.return_real_short_name_and_version(
    i, optional_downcase = false
  )
  case optional_downcase
  when :downcase
    optional_downcase = true
  end
  real_short_name = ::ProgramInformation.return_real_short_name(i)
  if optional_downcase
    real_short_name.downcase!
  end
  program_version = ::ProgramInformation.return_program_version(i)
  return [
    real_short_name, program_version
  ]
end

# File lib/program_information/toplevel_methods/return_short_name.rb, line 25
def self.return_short_name(
    of_this_program = ''
  )
  if of_this_program.nil? or of_this_program.empty?
    opnn; e 'Please provide some input to the method '\
            'ProgramInformation.return_short_name.'
  else
    _ = ::ProgramInformation::ProgramInformation.new(of_this_program)
    _.short_name?
  end 
end

# File lib/program_information/toplevel_methods.rb, line 75
def self.return_short_name_and_program_version(
    i,
    replace_input = true
  )
  case replace_input
  when :do_not_modify_input
    replace_input = false
  end
  _ = ::ProgramInformation::ProgramInformation.new(i, :dont_run_yet)
  _.do_not_replace_anything unless replace_input
  _.run
  # ======================================================================= #
  # Assemble the Array here.
  # ======================================================================= #
  array = [ _.short_name?, _.program_version? ]
  return array
end