environment_information 1.4.89

data/lib/environment_information/class/misc.rb

@@ -0,0 +1,897 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'environment_information/class/misc.rb'
+# =========================================================================== #
+require 'environment_information/base/base.rb'
+
+module EnvironmentInformation
+
+class EnvironmentInformation < ::EnvironmentInformation::Base # === EnvironmentInformation::EnvironmentInformation
+
+  # ========================================================================= #
+  # === THE_PROGRAM_IS_NOT_INSTALLED_OR_COULD_NOT_BE_FOUND
+  # ========================================================================= #
+  THE_PROGRAM_IS_NOT_INSTALLED_OR_COULD_NOT_BE_FOUND =
+    '[The program is not installed or could not be found.]'.dup
+
+  require 'environment_information/constants/array_tracked_components.rb'
+  require 'environment_information/constants/misc.rb'
+  require 'environment_information/class/add.rb'
+  require 'environment_information/class/show_display_and_report.rb'
+  require 'environment_information/toplevel_methods/misc.rb'
+  require 'environment_information/toplevel_methods/write_what_into.rb'
+  require 'environment_information/version/version.rb'
+
+  # ========================================================================= #
+  # === report_the_installed_KDE_software_suite
+  # ========================================================================= #
+  def report_the_installed_KDE_software_suite
+    begin
+      require 'rbt/toplevel_methods/misc.rb'
+      require 'rbt/toplevel_methods/try_to_return_a_special_compile_component.rb'
+      require 'rbt/toplevel_methods/swift_return_version_of_this_program.rb'
+      array = RBT.return_kde_apps
+      append_this = ''.dup
+      if array and !array.empty?
+        e 'Now working through all registered KDE applications, trying to'
+        e 'show their version on the commandline:'
+        e
+        array.each {|this_program|
+          append_this.clear
+          # ================================================================= #
+          # The next line of code was added in August 2022 because ksmoothdock
+          # is misbehaving. At a later time we may have to review this;
+          # ideally we should not need any such ad-hoc exceptions ever.
+          # ================================================================= #
+          next if this_program == 'ksmoothdock'
+          print gold(
+            ('  '+this_program+':').ljust(40)
+          )
+          cmd_to_use = "#{this_program} --version 2>&1"
+          version = `#{cmd_to_use}`
+          if version.include? "command not found\n"
+            version = THE_PROGRAM_IS_NOT_INSTALLED_OR_COULD_NOT_BE_FOUND
+          else
+            if version
+              # Remove the name of the program here e. g. "kcachegrind 21.12.1"
+              version.sub!(/#{this_program}/,'')
+              most_recent_version = ::RBT.swift_return_version_of_this_program(this_program.strip.downcase)
+              if RBT.is_this_version_higher_than_that_version?(
+                  most_recent_version.to_s,
+                  version.to_s,
+                  :do_not_report_any_errors
+                )
+                append_this << orange(
+                  "\n      ^^^ This program could "\
+                  "be updated to version "+
+                  most_recent_version.to_s
+                )
+              end
+            end
+          end
+          version.strip!
+          if version.include? 'The program is not installed'
+            e lightblue(version)+append_this
+          else
+            e steelblue(version)+append_this
+          end
+        }
+        e
+      else
+        e 'The array appears to be empty.'
+      end
+      exit
+    rescue LoadError; end
+  end
+
+  # ========================================================================= #
+  # === is_a_registered_component?
+  # ========================================================================= #
+  def is_a_registered_component?(i)
+    ::EnvironmentInformation.is_this_component_included?(i)
+  end; alias is_an_allowed_entry? is_a_registered_component? # === is_an_allowed_entry?
+
+  # ========================================================================= #
+  # === tracked_programs?
+  # ========================================================================= #
+  def tracked_programs?
+    ARRAY_TRACKED_PROGRAMS
+  end
+
+  # ========================================================================= #
+  # === return_default_programs_on_linux
+  #
+  # This method should return the "main" programs on a linux computer,
+  # the most important entries.
+  # ========================================================================= #
+  def return_default_programs_on_linux
+    ARRAY_DEFAULT_PROGRAMS_ON_LINUX
+  end; alias return_default_programs_on_a_linux_computer return_default_programs_on_linux # === return_default_programs_on_a_linux_computer
+       alias return_default_programs                     return_default_programs_on_linux # === return_default_programs
+
+  # ========================================================================= #
+  # === do_show_almost_everything_excluding_the_default_linux_programs
+  #
+  # This is similar to do_show_everything() but it will not show
+  # the default linux programs.
+  # ========================================================================= #
+  def do_show_almost_everything_excluding_the_default_linux_programs
+    these_programs   = return_every_registered_component
+    default_programs = return_default_programs
+    # ======================================================================= #
+    # Next subtract those that are part in the default_programs.
+    # ======================================================================= #
+    these_programs.reject! {|entry|
+      default_programs.include? entry
+    }
+    add(these_programs)
+  end
+
+  # ========================================================================= #
+  # === do_show_everything                         (everything tag, full tag)
+  #
+  # This method can be used when the user wishes to enable seeing
+  # full information about his local environment (on the computer).
+  #
+  # This will always display EVERY registered component.
+  #
+  # Commandline invocation:
+  #
+  #   envi --everything
+  #
+  # ========================================================================= #
+  def do_show_everything
+    add(:everything) # Simply add everything.
+  end; alias do_show_full_information do_show_everything # === do_show_full_information
+       alias show_full_information    do_show_everything # === show_full_information
+
+  # ========================================================================= #
+  # === consider_storing_the_components_that_were_displayed
+  # ========================================================================= #
+  def consider_storing_the_components_that_were_displayed
+    if store_the_results_into_local_files?
+      ::EnvironmentInformation.consider_storing_these_results_into_a_local_file
+    end
+  end; alias consider_storing_which_components_were_displayed consider_storing_the_components_that_were_displayed # === consider_storing_which_components_were_displayed
+
+  # ========================================================================= #
+  # === store_the_results_into_local_files?
+  # ========================================================================= #
+  def store_the_results_into_local_files?
+    @internal_hash[:store_the_results_into_local_files]
+  end
+
+  # ========================================================================= #
+  # === do_show_only_the_operating_system
+  #
+  # To invoke this method, try:
+  #
+  #    envi --os?
+  #
+  # ========================================================================= #
+  def do_show_only_the_operating_system
+    clear_old_dataset
+    add(:operating_system)
+  end
+
+  # ========================================================================= #
+  # === can_we_query_the_mate_desktop?
+  # ========================================================================= #
+  def can_we_query_the_mate_desktop?
+    is_rbt_available? and RBT.const_defined?(:ReportMateDesktopVersion)
+  end
+
+  # ========================================================================= #
+  # === show_n_registered_entries
+  #
+  # Invoke this via:
+  #
+  #   envi --n_entries
+  #
+  # ========================================================================= #
+  def show_n_registered_entries
+    e "#{true_rev}The EnvironmentInformation project contains "\
+      "#{sfancy(::EnvironmentInformation.tracked_programs?.size)} "\
+      "#{true_rev}registered entries."
+  end
+
+  # ========================================================================= #
+  # === assign_components_for_the_short_format
+  #
+  # We will only display 6 components when we use the short variant.
+  # ========================================================================= #
+  def assign_components_for_the_short_format
+    clear_old_dataset
+    dont_show_ruby_stuff
+    add(%i(
+      operating_system
+      operating_system_bit_type
+      cpuinfo
+      cflags
+      RAM
+      screen_resolution
+    ))
+  end
+
+  # ========================================================================= #
+  # === may_we_try_to_use_rbt?
+  # ========================================================================= #
+  def may_we_try_to_use_rbt?
+    @may_we_try_to_use_rbt
+  end
+
+  # ========================================================================= #
+  # === write_what_into
+  # ========================================================================= #
+  def write_what_into(what, into)
+    ::EnvironmentInformation.write_what_into(what, into)
+  end
+
+  # ========================================================================= #
+  # === work_on_the_programs_directory_only
+  #
+  # This works on the /home/Programs/ directory directly.
+  #
+  # Invocation example:
+  #
+  #   envi --work-on-programs-directory-only
+  #
+  # ========================================================================= #
+  def work_on_the_programs_directory_only(
+      use_this_as_programs_directory = '/home/Programs/'
+    )
+    # ======================================================================= #
+    # 1) First, we have to determine which programs are available.
+    # ======================================================================= #
+    e "#{rev}Determining which programs are available at the prefix "\
+      "#{steelblue(use_this_as_programs_directory)}:"
+    array_these_programs_are_available = []
+    tracked_programs?.each {|entry|
+      target = "#{use_this_as_programs_directory}#{entry.capitalize}"
+      if File.directory?(target)
+        # =================================================================== #
+        # In this case we know that this target exists.
+        # =================================================================== #
+        array_these_programs_are_available << entry
+      end
+    }
+    # ======================================================================= #
+    # 2) Checking these programs next.
+    # ======================================================================= #
+    clear_main_dataset
+    add(array_these_programs_are_available)
+    ::EnvironmentInformation.set_prefix_to_use(use_this_as_programs_directory)
+  end
+
+  # ========================================================================= #
+  # === set_main_array
+  # ========================================================================= #
+  def set_main_array(i)
+    @array_report_these_programs = i
+  end; alias set_display_these_components               set_main_array # === set_display_these_components
+       alias set_use_this_as_main_input                 set_main_array # === set_use_this_as_main_input
+       alias set_report_these_programs                  set_main_array # === set_report_these_programs
+       alias show_only_the_components_from_this_dataset set_main_array # === show_only_the_components_from_this_dataset
+
+  # ========================================================================= #
+  # === set_runmode_gui
+  # ========================================================================= #
+  def set_runmode_gui
+    @runmode = :gui
+  end
+
+  # ========================================================================= #
+  # === set_runmode_html
+  # ========================================================================= #
+  def set_runmode_html
+    @runmode = :html
+  end
+
+  # ========================================================================= #
+  # === do_exit_the_program
+  # ========================================================================= #
+  def do_exit_the_program
+    @do_exit_the_program = true
+  end
+
+  # ========================================================================= #
+  # === gui?
+  # ========================================================================= #
+  def gui?
+    @runmode == :gui
+  end
+
+  # ========================================================================= #
+  # === commandline?
+  #
+  # Whether we run in the "commandline mode" or whether we run in the
+  # GUI or WWW/HTML mode.
+  # ========================================================================= #
+  def commandline?
+    @runmode == :commandline
+  end
+
+  # ========================================================================= #
+  # === be_silent
+  # ========================================================================= #
+  def be_silent
+    @be_silent = true
+  end
+
+  # ========================================================================= #
+  # === set_be_silent
+  # ========================================================================= #
+  def set_be_silent(i = true)
+    @be_silent = i
+  end
+
+  # ========================================================================= #
+  # === be_silent?
+  # ========================================================================= #
+  def be_silent?
+    @be_silent
+  end
+
+  # ========================================================================= #
+  # === start_the_sinatra_interface
+  # ========================================================================= #
+  def start_the_sinatra_interface
+    require 'environment_information/www/sinatra_interface.rb'
+    ::EnvironmentInformation.start_sinatra_interface
+  end
+
+  # ========================================================================= #
+  # === do_not_display_the_result
+  # ========================================================================= #
+  def do_not_display_the_result
+    @display_result = false
+  end
+
+  # ========================================================================= #
+  # === do_rename_kde_konsole
+  #
+  # This will attempt to rename the KDE Konsole tab, but only if we are
+  # on roebe.
+  # ========================================================================= #
+  def do_rename_kde_konsole(
+      use_this_title = 'Environment Information'
+    )
+    begin
+      require 'roebe/requires/require_kde_konsole.rb'
+    rescue LoadError; end  
+    if try_to_rename_the_kde_konsole_tab? and
+       is_on_roebe? and
+       Object.const_defined?(:Roebe) and
+       Roebe.const_defined?(:KdeKonsole)
+      Roebe.rename_konsole(use_this_title)
+    end
+  end
+
+  # ========================================================================= #
+  # === use_ascii_table
+  #
+  # We will display in ascii-table format here.
+  # ========================================================================= #
+  def use_ascii_table
+    disable_colours # Can't use colours right now. Perhaps at a later time.
+    extend Terminal::Table::TableHelper
+    @table = table ['Name', 'Version']
+    @table.style = {
+      padding_left:  2,
+      width:       110 # Set the width here.
+    }
+    @use_ascii_table = true
+  end
+
+  # ========================================================================= #
+  # === show_everything?
+  # ========================================================================= #
+  def show_everything?
+    @show_everything
+  end
+
+  # ========================================================================= #
+  # === try_to_rename_the_kde_konsole_tab?
+  # ========================================================================= #
+  def try_to_rename_the_kde_konsole_tab?
+    @internal_hash[:try_to_rename_the_kde_konsole_tab]
+  end
+
+  # ========================================================================= #
+  # === do_not_run_already
+  # ========================================================================= #
+  def do_not_run_already
+    @run_already = false
+  end; alias do_not_run do_not_run_already # === do_not_run
+
+  # ========================================================================= #
+  # === open_this_file_in_editor
+  # ========================================================================= #
+  def open_this_file_in_editor
+    _ = "bluefish #{THIS_FILE}"
+    e _; system _; exit
+  end
+
+  # ========================================================================= #
+  # === xorg_components?
+  # ========================================================================= #
+  def xorg_components?
+    ::EnvironmentInformation.xorg_components?
+  end; alias return_all_xorg_components xorg_components? # === return_all_xorg_components
+
+  # ========================================================================= #
+  # === do_show_only_the_xorg_components
+  #
+  # This method will essentially clear the old dataset before adding
+  # all xorg-components to the display-part of this class.
+  #
+  # The components that are appended here, are defined in the file
+  # constants/array_tracked_components.rb - so if you wish to add
+  # new xorg-related entries, you should modify the entries in that
+  # .rb file.
+  # ========================================================================= #
+  def do_show_only_the_xorg_components
+    clear_old_dataset
+    do_not_show_the_ruby_components
+    add(:all_xorg_components)
+  end
+
+  # ========================================================================= #
+  # === clear_old_dataset
+  # ========================================================================= #
+  def clear_old_dataset
+    @array_report_these_programs.clear
+  end
+
+  # ========================================================================= #
+  # === shall_we_really_store_which_programs_are_not_up_to_date?
+  #
+  # This method will also honour whether the user is on a roebe-like
+  # system or whether the user is not.
+  # ========================================================================= #
+  def shall_we_really_store_which_programs_are_not_up_to_date?
+    is_on_roebe? and !@array_these_programs_not_up_to_date.empty?
+  end
+
+  # ========================================================================= #
+  # === result_as_array
+  #
+  # The lines that we will have inside of this method, may look like this:
+  #
+  #   "  operating_system:                 GNU/Linux\n"
+  #
+  # ========================================================================= #
+  def result_as_array
+    _ = dataset_as_string
+    splitted = _.split("\n")
+    splitted.map! {|inner_line|
+      inner_line.split(': ').map {|entry| entry.strip }
+    }
+    return splitted
+  end; alias result result_as_array # === result
+
+  # ========================================================================= #
+  # === use_one_line_to_show_the_result?
+  # ========================================================================= #
+  def use_one_line_to_show_the_result?
+    @internal_hash[:use_one_line_to_show_the_result]
+  end
+
+  # ========================================================================= #
+  # === clear_the_main_dataset
+  # ========================================================================= #
+  def clear_the_main_dataset
+    clear_old_dataset
+    do_not_display_the_ruby_components
+  end; alias clear_main_dataset clear_the_main_dataset # === clear_main_dataset
+       alias empty_main_dataset clear_the_main_dataset # === empty_main_dataset
+       alias empty_main_array   clear_the_main_dataset # === empty_main_array
+
+  # ========================================================================= #
+  # === clear_toplevel_hash
+  # ========================================================================= #
+  def clear_toplevel_hash
+    ::EnvironmentInformation.clear_hash
+  end
+
+  # ========================================================================= #
+  # === dataset_as_string
+  #
+  # This method must return the dataset in String format. That String
+  # must already be properly "formatted".
+  # ========================================================================= #
+  def dataset_as_string
+    _ = ''.dup # Put the information onto that String here.
+    main_dataset?.each {|entry|
+      if entry.is_a? Array
+        entry = entry.first # The second entry is ignored in that event.
+      end
+      # ===================================================================== #
+      # Before we can use .send() we have to check whether EnvironmentInformation
+      # actually responds to that method. If not then we will simply skip
+      # this snippet for now; but this may have to be changed at some
+      # point in the future, to more elegantly handle failure. (Sep 2019).
+      # ===================================================================== #
+      use_this_method = "return_version_of_#{entry}".to_sym
+      if ::EnvironmentInformation.respond_to? use_this_method
+        program_version = ::EnvironmentInformation.send(
+          use_this_method
+        )
+        entry = "  #{entry}:"
+        _ << "#{entry} #{program_version}#{N}"
+      end
+    }
+    return _ # And return the generated String.
+  end; alias string?      dataset_as_string # === string?
+       alias string       dataset_as_string # === string
+       alias main_string? dataset_as_string # === main_string?
+       alias stringified  dataset_as_string # === stringified
+
+  # ========================================================================= #
+  # === return_version_of_awk?
+  # ========================================================================= #
+  def return_version_of_awk?
+    ::EnvironmentInformation.send(__method__)
+  end; alias return_version_of_awk return_version_of_awk? # == return_version_of_awk
+
+  # ========================================================================= #
+  # === return_version_of_binutils?
+  # ========================================================================= #
+  def return_version_of_binutils?
+    ::EnvironmentInformation.send(__method__)
+  end; alias return_version_of_binutils return_version_of_binutils? # == return_version_of_binutils
+
+  # ========================================================================= #
+  # === return_version_of_coreutils?
+  # ========================================================================= #
+  def return_version_of_coreutils?
+    ::EnvironmentInformation.send(__method__)
+  end; alias return_version_of_coreutils return_version_of_coreutils? # == return_version_of_coreutils
+
+  # ========================================================================= #
+  # === return_version_of_diffutils?
+  # ========================================================================= #
+  def return_version_of_diffutils?
+    ::EnvironmentInformation.send(__method__)
+  end; alias return_version_of_diffutils return_version_of_diffutils? # == return_version_of_diffutils
+
+  # ========================================================================= #
+  # === return_version_of_gcc?
+  # ========================================================================= #
+  def return_version_of_gcc?
+    ::EnvironmentInformation.send(__method__)
+  end; alias return_version_of_gcc return_version_of_gcc? # == return_version_of_gcc
+
+  # ========================================================================= #
+  # === return_version_of_linux_kernel?
+  # ========================================================================= #
+  def return_version_of_linux_kernel?
+    ::EnvironmentInformation.send(__method__)
+  end; alias return_version_of_linux_kernel return_version_of_linux_kernel? # == return_version_of_linux_kernel
+
+  # ========================================================================= #
+  # === is_this_program_included?
+  # ========================================================================= #
+  def is_this_program_included?(i)
+    ::EnvironmentInformation.is_this_program_included?(i)
+  end
+
+  # ========================================================================= #
+  # === return_version_of_glibc?
+  # ========================================================================= #
+  def return_version_of_glibc?
+    ::EnvironmentInformation.send(__method__)
+  end; alias return_version_of_glibc return_version_of_glibc? # == return_version_of_glibc
+
+  # ========================================================================= #
+  # === return_version_of_intltool?
+  # ========================================================================= #
+  def return_version_of_intltool?
+    ::EnvironmentInformation.send(__method__)
+  end; alias return_version_of_intltool return_version_of_intltool? # == return_version_of_intltool
+
+  # ========================================================================= #
+  # === return_version_of_grep?
+  # ========================================================================= #
+  def return_version_of_grep?
+    ::EnvironmentInformation.send(__method__)
+  end; alias return_version_of_grep return_version_of_grep? # == return_version_of_grep
+
+  # ========================================================================= #
+  # === return_version_of_gnupg?
+  # ========================================================================= #
+  def return_version_of_gnupg?
+    ::EnvironmentInformation.send(__method__)
+  end; alias return_version_of_gnupg return_version_of_gnupg? # == return_version_of_gnupg
+
+  # ========================================================================= #
+  # === return_version_of_bison?
+  # ========================================================================= #
+  def return_version_of_bison?
+    ::EnvironmentInformation.send(__method__)
+  end; alias return_version_of_bison return_version_of_bison? # == return_version_of_bison
+
+  # ========================================================================= #
+  # === return_version_of_flex?
+  # ========================================================================= #
+  def return_version_of_flex?
+    ::EnvironmentInformation.send(__method__)
+  end; alias return_version_of_flex return_version_of_flex? # == return_version_of_flex
+
+  # ========================================================================= #
+  # === operating_system?
+  #
+  # To quickly test this method, try:
+  #
+  #   EnvironmentInformation::EnvironmentInformation.new { :do_not_run_yet }.operating_system?
+  #
+  # ========================================================================= #
+  def operating_system?
+    ::EnvironmentInformation.send(__method__)
+  end; alias return_version_of_operating_system operating_system? # === return_version_of_operating_system
+
+  # ========================================================================= #
+  # === load_dataset_from_this_file
+  #
+  # This method can be used to read which programs will be displayed
+  # from a local file, rather than rely on the pre-set default.
+  # ========================================================================= #
+  def load_dataset_from_this_file(i)
+    if File.exist? i
+      File.readlines(i).map {|entry|
+        entry.delete('-').strip # ← Clean up the input a little bit.
+      }
+    else
+      opnn; e "No file exists at `#{sfile(i)}`."
+    end
+  end; alias try_to_load_dataset_from_this_file load_dataset_from_this_file # === try_to_load_dataset_from_this_file
+       alias try_to_read_content_from_this_file load_dataset_from_this_file # === try_to_read_content_from_this_file
+
+  # ========================================================================= #
+  # === consider_storing_which_programs_are_not_up_to_date
+  # ========================================================================= #
+  def consider_storing_which_programs_are_not_up_to_date
+    if shall_we_really_store_which_programs_are_not_up_to_date?
+      into = FILE_THESE_PROGRAMS_CAN_BE_UPGRADED
+      what = YAML.dump(@array_these_programs_not_up_to_date)
+      if File.directory?('/home/Temp/rbt/')
+        into = "/home/Temp/rbt/#{File.basename(into)}"
+      else
+        into = "#{log_dir?}#{File.basename(into)}"
+      end
+      opnn; e 'We will also store which programs are not up to date.'
+      opnn; e "These will be stored into the file at `#{sfile(into)}`."
+      ::EnvironmentInformation.write_what_into(what, into)
+    end
+  end
+
+  require 'environment_information/misc_components/operating_system_bit_type.rb'
+  # ========================================================================= #
+  # === bit_type?
+  # ========================================================================= #
+  def bit_type?
+    ::EnvironmentInformation.operating_system_bit_type
+  end
+
+  # ========================================================================= #
+  # === register_unavailable_program
+  #
+  # Programs that were not be found can be registered through this method.
+  # ========================================================================= #
+  def register_unavailable_program(i)
+    i = i.to_sym # Let's store only Symbols.
+    @array_unavailable_programs << i
+  end; alias register_not_found register_unavailable_program # === register_not_found
+
+  require 'environment_information/misc_components/cpuinfo.rb'
+  # ========================================================================= #
+  # === cpu_model?
+  # ========================================================================= #
+  def cpu_model?
+    ::EnvironmentInformation.cpuinfo?
+  end
+
+  require 'environment_information/misc_components/ram.rb'
+  # ========================================================================= #
+  # === ram?
+  # ========================================================================= #
+  def ram?
+    ::EnvironmentInformation.ram?
+  end
+
+  require 'environment_information/misc_components/screen_resolution.rb'
+  # ========================================================================= #
+  # === screen_resolution?
+  # ========================================================================= #
+  def screen_resolution?
+    ::EnvironmentInformation.screen_resolution?
+  end
+
+  require 'environment_information/misc_components/cflags.rb'
+  # ========================================================================= #
+  # === cflags_in_use?
+  # ========================================================================= #
+  def cflags_in_use?
+    ::EnvironmentInformation.cflags_in_use?
+  end
+
+  # ========================================================================= #
+  # === return_every_registered_component
+  # ========================================================================= #
+  def return_every_registered_component
+    array = ::EnvironmentInformation.tracked_programs?+
+            ::EnvironmentInformation.tracked_non_programs?+
+            ::EnvironmentInformation.science_cluster?+
+            ::EnvironmentInformation.xorg_components?
+    array = array.flatten.uniq
+    # ======================================================================= #
+    # === The mate-desktop
+    #
+    # Since as of 31.03.2019 we will also try to show the mate-desktop
+    # components if the RBT project is available/installed.
+    # ======================================================================= #
+    if can_we_query_the_mate_desktop?
+      # ===================================================================== #
+      # Keep in mind that this Array is nested, so the name is
+      # included as well as the version.
+      # ===================================================================== #
+      _ = RBT.return_mate_desktop_version_array
+      _.each {|a,b|
+        # array << [a, b]
+        array << a
+        register_onto_the_main_hash(a, b)
+      }
+    end
+    return array # Return our findings.
+  end
+
+  # ========================================================================= #
+  # === clear_hash_and_missing_components
+  # ========================================================================= #
+  def clear_hash_and_missing_components
+    clear_toplevel_hash
+    clear_missing_components
+  end
+
+  # ========================================================================= #
+  # === clear_missing_components
+  # ========================================================================= #
+  def clear_missing_components
+    ::EnvironmentInformation.clear_missing_components
+  end
+
+  # ========================================================================= #
+  # === return_remote_gtk2_version
+  #
+  # Be wary when using this method, as it may slow down the whole
+  # application, due to making remote web-based queries.
+  # ========================================================================= #
+  def return_remote_gtk2_version
+    ::EnvironmentInformation.return_remote_gtk2_version
+  end
+
+  # ========================================================================= #
+  # === do_compare_the_program_version
+  #
+  # This method can be used if the user wishes to also compare the
+  # program version of the installed programs. This functionality
+  # depends on the rbt gem, and the RBT namespace.
+  # ========================================================================= #
+  def do_compare_the_program_version(
+      be_verbose = true
+    )
+    if be_verbose
+      @array_show_this_to_the_user <<
+        'The program versions will also be compared.'
+    end
+    @internal_hash[:compare_program_versions] = true
+  end
+
+  # ========================================================================= #
+  # === compare_program_versions?
+  # ========================================================================= #
+  def compare_program_versions?
+    @internal_hash[:compare_program_versions]
+  end; alias compare_program_version? compare_program_versions? # === compare_program_version?
+
+  # ========================================================================= #
+  # === is_rbt_available_and_may_we_try_to_use_rbt?
+  # ========================================================================= #
+  def is_rbt_available_and_may_we_try_to_use_rbt?
+    is_rbt_available? and may_we_try_to_use_rbt?
+  end
+
+  # ========================================================================= #
+  # === report_the_remote_urls?
+  # ========================================================================= #
+  def report_the_remote_urls?
+    @internal_hash[:report_the_remote_urls]
+  end
+
+  # ========================================================================= #
+  # === return_version_of_busyboxy?
+  # ========================================================================= #
+  def return_version_of_busyboxy?
+    ::EnvironmentInformation.send(__method__)
+  end; alias return_version_of_busyboxy return_version_of_busyboxy? # == return_version_of_busyboxy
+
+  # ========================================================================= #
+  # === return_version_of_boost?
+  # ========================================================================= #
+  def return_version_of_boost?
+    ::EnvironmentInformation.send(__method__)
+  end; alias return_version_of_boost return_version_of_boost? # == return_version_of_boost
+
+  # ========================================================================= #
+  # === return_version_of_xvid?
+  # ========================================================================= #
+  def return_version_of_xvid?
+    ::EnvironmentInformation.send(__method__)
+  end; alias return_version_of_xvid return_version_of_xvid? # == return_version_of_xvid
+
+  # ========================================================================= #
+  # === start_gtk_component
+  #
+  # To invoke this method from the commandline, do:
+  #
+  #   envi --start-gtk
+  #
+  # ========================================================================= #
+  def start_gtk_component
+    require 'environment_information/gui/gtk3/environment_information.rb'
+    ::EnvironmentInformation.run_gtk
+    @do_exit_the_program = true
+  end
+
+  # ========================================================================= #
+  # === do_sort_alphabetically                                     (sort tag)
+  #
+  # Some entries are Symbols, which is why we have to call .to_s in the
+  # method here.
+  # ========================================================================= #
+  def do_sort_alphabetically(
+      display_these_components = display_which_components?
+    )
+    _ = display_these_components.sort_by {|name, version| name.to_s }
+    set_main_array(_)
+  end
+
+  # ========================================================================= #
+  # === do_not_save_anything
+  # ========================================================================= #
+  def do_not_save_anything
+    @shall_the_results_be_saved = false
+    # ======================================================================= #
+    # We will also avoid saving the results into a local yaml file.
+    # ======================================================================= #
+    @internal_hash[:store_the_results_into_local_files] = false
+  end; alias do_not_store_anything do_not_save_anything # === do_not_store_anything
+
+  # ========================================================================= #
+  # === do_display_in_a_short_format
+  #
+  # The short-format means that we will use only a compact set of
+  # programs to display. For example, "make" and "bash" will not be
+  # displayed, neither "binutils" or "ruby".
+  # ========================================================================= #
+  def do_display_in_a_short_format
+    @display_everything_in_short_format = true
+  end
+
+  # ========================================================================= #
+  # === sort_alphabetically?
+  # ========================================================================= #
+  def sort_alphabetically?
+    @internal_hash[:sort_alphabetically]
+  end
+
+  # ========================================================================= #
+  # === enable_sort_alphabetically
+  # ========================================================================= #
+  def enable_sort_alphabetically
+    @internal_hash[:sort_alphabetically] = true
+  end
+
+end; end