environment_information 1.4.124 → 1.5.5

data/lib/environment_information/query/misc.rb

@@ -0,0 +1,2006 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# ============================================================================ #
+# require 'environment_information/query/misc.rb'
+# ============================================================================ #
+require 'environment_information/base/base.rb'
+
+module EnvironmentInformation
+
+class Query < ::EnvironmentInformation::Base # === EnvironmentInformation::Query
+
+  # ========================================================================== #
+  # === 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 add_everything
+    add(:everything) # Simply add everything.
+  end; alias do_show_full_information add_everything # === do_show_full_information
+       alias show_full_information    add_everything # === show_full_information
+       alias do_show_everything       add_everything # === do_show_everything
+
+  # ========================================================================== #
+  # === check_for_nil_values
+  # ========================================================================== #
+  def check_for_nil_values(
+      i,
+      this_program = nil
+    )
+    case i
+    # ======================================================================== #
+    # Register some errors next:
+    # ======================================================================== #
+    when nil,'',
+         /: command not found/,
+         /^options$/,
+         /was not found in the pkg-?config search path./,
+         /was not found in the pkg-?conf/,
+         /error while loading shared libraries/
+      i = NOT_FOUND
+      ::EnvironmentInformation.register_this_component_is_missing(this_program)
+    end
+    return i
+  end
+
+  # ========================================================================== #
+  # === display_this_component
+  #
+  # This method may NOT work on Arrays.
+  #
+  # This method is allowed to make modifications to the given input.
+  # ========================================================================== #
+  def display_this_component(
+      name_of_the_component,
+      hash        = the_primary_hash?,
+      use_padding = true
+    )
+    version = hash[name_of_the_component.to_sym].strip
+    original_version = version.to_s.dup.strip
+    # ======================================================================== #
+    # This used to be called "report_left_right". The right side
+    # constitutes the program-version, shortened towards just "version".
+    # ======================================================================== #
+    case name_of_the_component
+    # ======================================================================== #
+    # === cpuinfo
+    # ======================================================================== #
+    when :cpuinfo,
+         /^cpuinfo$/i
+      name_of_the_component = 'CPU Model'
+    # ======================================================================== #
+    # === :operating_system
+    # ======================================================================== #
+    when :operating_system,
+         /^operating(_|-)?system$/i,
+         /^operating(_|-)?system(_|-)?in(_|-)?use$/i
+      name_of_the_component = 'Operating system'
+    # ======================================================================== #
+    # === operating_system_bit_type
+    # ======================================================================== #
+    when :operating_system_bit_type,
+         /^operating(_|-)?system(_|-)?bit(_|-)?type$/i
+      name_of_the_component = 'Operating system bit type'
+    # ======================================================================== #
+    # === :ram
+    # ======================================================================== #
+    when :ram, /^ram$/i
+      name_of_the_component = 'RAM'
+    # ======================================================================== #
+    # === :cflags
+    # ======================================================================== #
+    when :cflags,
+         /^cflags$/i
+      name_of_the_component = 'CFLAGS in use'
+    # ======================================================================== #
+    # === screen_resolution
+    #
+    # This is a bit "special" in the sense that this class will colourize
+    # the middle 'x', if found, and if colours are used.
+    # ======================================================================== #
+    when :screen_resolution,
+         /^screen( |_)?resolution$/i
+      name_of_the_component = 'Screen Resolution:'
+      if use_padding
+        name_of_the_component = name_of_the_component.ljust(N_LEFT_PAD)
+      end
+      if version.include?('x') and use_colours?
+        splitted = version.split('x')
+        version = colourize_this_in_the_right_side_colour(splitted.first)+
+                  royalblue('x')+
+                  colourize_this_in_the_right_side_colour(splitted.last)
+      end
+    end
+    if name_of_the_component.is_a?(String) and name_of_the_component.include?(':')
+      the_left_side = "#{name_of_the_component}"
+    else
+      the_left_side = "#{name_of_the_component}:"
+    end
+    if use_padding
+      the_left_side = the_left_side.ljust(N_LEFT_PAD)
+    end
+    if version.include?(NOT_FOUND)
+      version = lightseagreen(version, use_colours?)
+    else
+      version = right_side(version)
+    end
+    the_right_side = version.dup.strip
+    # ======================================================================== #
+    # === @internal_hash[:report_the_remote_urls]
+    #
+    # Next, honour @internal_hash[:report_the_remote_urls] if it is
+    # set to true.
+    # ======================================================================== #
+    if report_the_remote_urls? and
+       is_rbt_available? and
+       RBT.respond_to?(:remote_url_for?)
+      _ = this_component.to_s.delete('-').downcase.strip.to_sym
+      # ====================================================================== #
+      # Query whether RBT keeps track of that program:
+      # ====================================================================== #
+      if RBT.does_include?(_)
+        # ==================================================================== #
+        # Next we will obtain the remote URL:
+        # ==================================================================== #
+        remote_URL = RBT.remote_url_for?(_, :return_as_string)
+        if is_a_registered_component? _
+          the_right_side = the_right_side.ljust(58, ' ')
+          the_right_side << " #{olive('→')} #{lightgreen(remote_URL)}" # Colourize the URL in olive.
+        end
+      end
+    end
+    # ======================================================================== #
+    # Next compare the program versions with the local versions.
+    # ======================================================================== #
+    if compare_program_versions? and
+       is_rbt_available_and_may_we_try_to_use_rbt? and
+       RBT.respond_to?(:swift_return_version_of_this_program) and
+       RBT.does_include?(name_of_the_component.to_s.strip.delete(':'))
+      # ====================================================================== #
+      # Example:
+      #
+      #   RBT.swift_return_version_of_this_program(:gettext)
+      #
+      # ====================================================================== #
+      registered_local_version = RBT.swift_return_version_of_this_program(
+        name_of_the_component.to_s.strip.delete(':').to_sym
+      ).to_s
+      # ====================================================================== #
+      # We ignore gtk2 when it comes to the version-check.
+      # ====================================================================== #
+      return if name_of_the_component.to_sym == :gtk2
+      # ====================================================================== #
+      # Next use Gem::Version to compare them, but not if the version
+      # is nil.
+      # ====================================================================== #
+      unless version.nil? or (version.to_s.include?(NOT_FOUND))
+        # ==================================================================== #
+        # The .delete('v') is specifically for libuv or node.
+        # ==================================================================== #
+        registered_local_version = registered_local_version.to_s.dup.
+                                   delete('v').
+                                   tr('_','.')
+        a = compare_via_gem_version(registered_local_version)
+        b = compare_via_gem_version(original_version)
+        if a and b and (a > b)
+          result = ''.dup
+          if use_one_line_to_show_the_result?
+            result << mediumaquamarine(' ← ')
+          else # else this is the default.
+            result << lightblue('     ^^^^ ')
+          end
+          result << slateblue('This program could be '\
+                    'upgraded, to the version ')+
+                    steelblue(registered_local_version)+
+                    ' (original_version was: '+original_version.to_s+')'
+          e result
+        end if registered_local_version =~ /\d+/
+      end
+    end
+    display_left_side_then_the_right_side(
+      the_left_side,
+      the_right_side
+    )
+  end; alias do_report_this_component display_this_component # === do_report_this_component
+
+  # ========================================================================== #
+  # === display_left_side_then_the_right_side
+  #
+  # This method will simply display what is passed into it. It is NOT
+  # allowed to do ANY modifications to the given input.
+  # ========================================================================== #
+  def display_left_side_then_the_right_side(
+      the_left_side  = nil,
+      the_right_side = nil
+    )
+    e "#{left_side(the_left_side)}#{the_right_side}"
+  end
+
+  # ========================================================================== #
+  # === display_these_components                                  (report tag)
+  #
+  # This method operates on an Array at all times.
+  # ========================================================================== #
+  def display_these_components(
+      array = array_work_on_these_components?
+    )
+    unless do_exit_the_program?
+      # ====================================================================== #
+      # === Report step
+      #
+      # We may only display the components if display_result? is true.
+      # ====================================================================== #
+      return unless display_result?
+      array = [array].flatten.compact
+      if array.empty?
+        notify_the_user_that_there_are_no_components_that_can_be_displayed # And this ends here.
+      else    
+        array.each {|name_of_the_program|
+          display_this_component(name_of_the_program)
+        }
+      end
+    end
+  end; alias do_work_through_all_the_specified_components            display_these_components # === do_work_through_all_the_specified_components
+       alias report                                                  display_these_components # === report
+       alias report_result                                           display_these_components # === report_result
+       alias build_up_the_main_string                                display_these_components # === build_up_the_main_string
+       alias register_the_available_components_and_show_them_at_once display_these_components # === register_the_available_components_and_show_them_at_once
+       alias display_the_components                                  display_these_components # === display_the_components
+       alias display_the_dataset                                     display_these_components # === display_the_dataset
+       alias display_the_main_components                             display_these_components # === build_up_the_main_string
+       alias report_the_findings_from_this                           display_these_components # === report_the_findings_from_this
+
+
+  def ___report_the_findings_from_this
+    hash.each_pair {|name, version|
+      do_report_this_component(name, hash, use_padding)
+      case the_left_side.to_s
+      when /^RAM:/
+        # ================================================================== #
+        # Append 'MB RAM' in orange colour next, with some padding.
+        # This is just a small visual "enhancement" that I quite like.
+        # ================================================================== #
+        the_right_side = the_right_side.dup if the_right_side.frozen?
+        # the_right_side = (the_right_side.to_f / 1028.0).round(0).to_s # If we want GB.
+        the_right_side << orange(' MB RAM')
+      end
+      display_left_side_then_the_right_side(the_left_side, the_right_side)
+    }
+  end
+
+  # ========================================================================== #
+  # === return_operating_system_bit_type
+  #
+  # We could also use "lscpu" and check for the substring 'CPU op-mode'.
+  # ========================================================================== #
+  def return_operating_system_bit_type
+    return ::EnvironmentInformation.operating_system_bit_type_information
+  end; alias bit_type? return_operating_system_bit_type # === bit_type?
+     
+  # ========================================================================== #
+  # === add                                                          (add tag)
+  #
+  # This method can be used to add individual entries to the main Hash
+  # called @internal_hash[:the_primary_hash].
+  #
+  # The format for add() works on both Symbols as well as Arrays as
+  # input. This will be shown on the left side, and denotes the name of
+  # the program or component that we wish to query, such as "php" or
+  # "ruby" and so forth.
+  #
+  # Some Symbols will be used as a "pointer" towards an Array of 
+  # registered programs.
+  #
+  # Note that (1) will be converted into a Symbol if it is a String.
+  #
+  # If the second entry (2) is nil, then the version will be inferred
+  # at "runtime" within the method display(). Otherwise display()
+  # will simply use the passed version (which should be a String in
+  # that case, then).
+  #
+  # Before we can add an entry to the main dataset, we have to check
+  # whether it is a registered entry altogether. If it is not
+  # registered, the user has to be notified about this fact.
+  # This notification will ONLY happen if the associated version is nil;
+  # if a specific version is supplied then this method will assume
+  # that the program should be displayed anyway.
+  #
+  # An Array can also be supplied to this method, if necessary.
+  #
+  # On 11.04.2024 the behaviour of this method changed. It will now always
+  # register the correct version in the primary hash.
+  # ========================================================================== #
+  def add(
+      i            = nil,
+      primary_hash = primary_hash?
+    )
+    if i
+      case i
+      # ====================================================================== #
+      # === :everything
+      #
+      # This entry point will add every available component.
+      # ====================================================================== #
+      when :everything
+        add(return_all_available_components)
+      # ====================================================================== #
+      # === :pkgconfig_entries
+      # ====================================================================== #
+      when :pkgconfig_entries
+        add(::EnvironmentInformation.return_pkgconfig_based_programs)
+      # ====================================================================== #
+      # === :all_xorg_components
+      # ====================================================================== #
+      when :all_xorg_components
+        add(return_all_xorg_components)
+      # ====================================================================== #
+      # === envi --science
+      # ====================================================================== #
+      when :science_cluster
+        add(science_cluster?)
+      # ====================================================================== #
+      # === envi --lfs_core_programs
+      # ====================================================================== #
+      when :lfs,
+           :lfs_core_programs
+        add(::EnvironmentInformation.lfs_core_programs?)
+      # ====================================================================== #
+      # === :linux_kernel
+      # ====================================================================== #
+      when :linux_kernel
+        add(:linux)
+      else
+        result = nil
+        # ====================================================================== #
+        # === Handle Arrays as input first
+        # ====================================================================== #
+        if i.is_a? Array
+          i.flatten.compact.each {|this_component|
+            add(this_component, primary_hash)
+          }
+        # ====================================================================== #
+        # === Handle Strings containing ',' next
+        # ====================================================================== #
+        elsif i.is_a?(String) and i.include?(',')
+          # ==================================================================== #
+          # Strings containing ',' will be split accordingly.
+          # ==================================================================== #
+          entry = i.split(',')
+          add(entry)
+        else
+          # ==================================================================== #
+          # === Handle Strings containing '-' next
+          # ==================================================================== #
+          if i.is_a?(String) and i.include?('-')
+            i = i.dup if i.frozen?
+            i.delete!('-')  
+          end
+          i = i.to_sym unless i.is_a?(Symbol) # i will always be a Symbol past this point.
+          unless primary_hash.has_key?(i)
+            case i
+            # ================================================================== #
+            # === :rubygems_installation_directory
+            # ================================================================== #
+            when :rubygems_installation_directory,
+                 /^rubygems( |_)?installation( |_)?directory\??$/i
+              result = return_rubygems_installation_directory
+            # ================================================================== #
+            # === :operating_system_bit_type
+            # ================================================================== #
+            when :operating_system_bit_type,
+                 /^operating(_|-| )?system(_|-| )?bit(_|-| )?type$/i
+              result = return_operating_system_bit_type
+            # ================================================================== #
+            # === :operating_system
+            # ================================================================== #
+            when :operating_system,
+                 /^Operating(_|-| )?system$/i,
+                 /^operating(_|-)?system(_|-)?in(_|-)?use$/i
+              result = return_operating_system
+            # ================================================================== #
+            # === :ram
+            # ================================================================== #
+            when :ram,
+                 /^RAM$/i
+              result = ram?
+            # ================================================================== #
+            # === :cflags
+            # ================================================================== #
+            when :cflags,
+                 /^cflags$/i,
+                 /^cflags(_|-| )?in(_|-| )?use$/i
+              result = cflags_in_use?
+            # ================================================================== #
+            # === :cpuinfo
+            # ================================================================== #
+            when :cpuinfo,
+                 /^cpuinfo$/i,
+                 /^CPU(_|-| )?Model/
+              result = return_cpuinfo
+            # ================================================================== #
+            # === :screen_resolution
+            # ================================================================== #
+            when :screen_resolution,
+                 /^screen( |_)?resolution$/i
+              result = screen_resolution?
+            else
+              i = ::EnvironmentInformation.return_alias_to(i)
+              cmd = QUERY_TO_USE_FOR_ALL_COMPONENTS[i.to_s]
+              case cmd.to_s # case tag
+              # ================================================================ #
+              # === special_entry_for_doubleconversion
+              # ================================================================ #
+              when /special_entry_for_doubleconversion/
+                result = ::EnvironmentInformation.return_version_of_doubleconversion
+              # ================================================================ #
+              # === custom_boost
+              # ================================================================ #
+              when 'custom_boost'
+                result = ::EnvironmentInformation.return_version_of_boost
+              # ================================================================ #
+              # === custom_mpc
+              # ================================================================ #
+              when 'custom_mpc'
+                result = ::EnvironmentInformation.return_version_of_mpc
+              # ================================================================ #
+              # === short_version
+              # ================================================================ #
+              when 'short_version'
+                result = silent_query("#{i} -v")
+              # ================================================================ #
+              # === custom_xvid
+              # ================================================================ #
+              when /custom_xvid/
+                result = return_xvid_version
+              # ================================================================ #
+              # === custom_busybox
+              # ================================================================ #
+              when 'custom_busybox'
+                result = ::EnvironmentInformation.return_version_of_busybox
+              # ================================================================ #
+              # === custom_xrandr
+              # ================================================================ #
+              when /custom_xrandr/
+                result = ::EnvironmentInformation.return_version_of_xrandr
+              # ================================================================ #
+              # === pkgconfig
+              # ================================================================ #
+              when /pkgconfig$/
+                # ============================================================== #
+                # In this case we do a default pkgconfig run, using the name
+                # of the entry at hand.
+                # ============================================================== #
+                intermediate_result = ::EnvironmentInformation.query_pkgconfig_version_for(i)
+                result = intermediate_result.strip
+                # ============================================================== #
+                # And we can "exit" here, aka call the next element.
+                # ============================================================== #
+              # ================================================================ #
+              # === version
+              #
+              # This is, for instance, "ruby --version".
+              # ================================================================ #
+              when /^version$/i
+                intermediate_result = silent_query("#{i} --version")
+                result = sanitize_this_version_string(intermediate_result)
+              else
+                result = sanitize_this_version_string(silent_query(cmd))
+              end
+              # ================================================================ #
+              # Do some post-processing next:
+              # ================================================================ #
+              if result.include?("\n")
+                splitted = result.split("\n")
+                if splitted.first == "\n"
+                  result = splitted[1 .. -1].join("\n")
+                end
+              end
+              if result.include? 'no version information available (required by '
+                # ============================================================== #
+                # In this case we have some external problem which will be
+                # ignored by environment_information.
+                # ============================================================== #
+                splitted = result.split("\n")
+                splitted.reject! {|entry| entry.include? 'no version information available (required by ' }
+                result = splitted.join("\n")
+              end
+              result = ::EnvironmentInformation.sanitize_this_program_version(result)
+              if result.include? 'ruby '
+                new_match = result.scan(/ruby (\d{1,2}\.\d{1,2}\.\d{1,2})/).flatten.first
+                result = new_match if new_match
+              end
+              if result.include? 'RELION version: '
+                result = result.split(/RELION version: /).flatten.last
+              end
+              if result.include? 'Make'
+                result.sub!(/Make/,'')
+              end
+              if result.include? "#{entry}-" # The entry includes itself and a '-'.
+                result.sub!(/#{entry.to_s}-/,'')
+              elsif result.include? entry.to_s # The entry includes itself.
+                result.sub!(/#{entry.to_s}/,'')
+              end
+              if result.count("\n") > 0
+                result = result.split("\n").first
+              end
+              if result.include? ', version' # This is specifically for Bash.'
+                # GNU bash, version 5.2.21(1)-release (x86_64-pc-linux-gnu)
+                new_value = result.scan(
+                          /, version (\d{1,2}\.\d{1,2}\.\d{1,2})/ # See: https://rubular.com/r/t3Ma5fpSPyGjqR
+                        ).flatten.first
+                result = new_value if new_value
+              end
+              if result.include?('(') and result.include?(')')
+                result = result.split(')').last
+              end
+              if result.include?('(') # Such as for 'XTerm(390'
+                result = result.split('(').last
+              end
+              if result.include? 'paper '
+                result.sub!(/paper /,'')
+              end
+              if result.include? 'version '
+                result.sub!(/version/,'')
+              end
+              if result.include? ' - ' # For lighttpd.
+                result = result.split(/ - /).first
+              end
+              if result.include? '--'
+                result.delete!('-')
+              end
+              if result.include? '/' # e. g. "nginx/1.24.0"
+                result = result.split('/').last
+              end
+              result[0,1] = '' if result.start_with?('/')
+              result.rstrip!
+              result = check_for_nil_values(result, i)
+            end
+            if result
+              # if result.include?(' ')
+              #   result = result.split(' ').last
+              # end
+              i = i.to_sym
+              # ============================================================== #
+              # Always register it directly here:
+              # ============================================================== #
+              @internal_hash[:the_primary_hash][i] = result
+              if display_the_results_at_once?
+                display_this_component(i)
+              end
+            end
+          end
+        end
+      end
+    end
+  end; alias show_these_entries         add # === show_these_entries
+       alias set_additional             add # === set_additional
+       alias update_version_for         add # === update_version_for
+       alias append                     add # === append
+       alias append_this_to_main_string add # === append_this_to_main_string
+
+  # ========================================================================== #
+  # === check_this_hash_for_unavailable_programs
+  # ========================================================================== #
+  def check_this_hash_for_unavailable_programs(
+      hash
+    )
+    # ======================================================================== #
+    # Register that this program is not available.
+    # ======================================================================== #
+    register_unavailable_program(
+      hash.select {|key, value|
+        value.include?(NOT_FOUND)
+      }.keys
+    )
+  end
+
+  # ========================================================================== #
+  # === remove_these_components
+  #
+  # This method can be used to remove registered components again.
+  # ========================================================================== #
+  def remove_these_components(
+      i
+    )
+    # ======================================================================== #
+    # === Handle Strings containing ',' first
+    # ======================================================================== #
+    if i.is_a?(String) and i.include?(',')
+      splitted = i.split(',')
+      remove_these_components(splitted)
+    # ======================================================================== #
+    # === Handle Arrays next
+    # ======================================================================== #
+    elsif i.is_a? Array
+      i.flatten.each {|entry|
+        remove_these_components(entry)
+      }
+    else
+      i = i.to_sym
+      primary_hash = primary_hash?
+      if primary_hash.has_key? i
+        primary_hash.delete(i)
+      end
+    end
+  end
+
+  # ========================================================================== #
+  # === right_side
+  # ========================================================================== #
+  def right_side(i)
+    if use_colours?
+      return send(::EnvironmentInformation.colour_for_the_right_side, i)
+    else
+      return i
+    end
+  end; alias colourize_this_in_the_right_side_colour right_side # === colourize_this_in_the_right_side_colour
+
+  # ========================================================================== #
+  # === clear_hash_and_missing_components
+  # ========================================================================== #
+  def clear_hash_and_missing_components
+    clear_toplevel_hash
+    clear_missing_components
+  end
+
+  # ========================================================================== #
+  # === show_the_registered_components
+  # ========================================================================== #
+  def show_the_registered_components(
+      i = tracked_programs?
+    )
+    e
+    e "#{rev}The following components are currently tracked:"
+    e
+    use_one_line_to_show_the_result = use_one_line_to_show_the_result?
+    i.each_with_index {|this_program, index| index += 1
+      if use_one_line_to_show_the_result
+        padded_index = index.to_s+') '
+      else
+        padded_index = '  '+(index.to_s+') ').rjust(5)
+      end
+      colourized_and_padded_index = seagreen(padded_index)
+      e colourized_and_padded_index+
+        steelblue(this_program)
+    }
+    e
+  end
+
+  # ========================================================================== #
+  # === consider_storing_which_programs_are_not_up_to_date
+  # ========================================================================== #
+  def consider_storing_which_programs_are_not_up_to_date(
+      temp_dir                               = temp_dir?,
+      array_programs_that_are_not_up_to_date = array_these_programs_not_up_to_date?
+    )
+    if shall_we_really_store_which_programs_are_not_up_to_date? # This also checks for a roebe-system.
+      into = FILE_THESE_PROGRAMS_CAN_BE_UPGRADED
+      what = YAML.dump(array_programs_that_are_not_up_to_date)
+      if File.directory?(temp_dir)
+        into = "#{temp_dir}#{File.basename(into)}"
+      else
+        into = "#{temp_dir}#{File.basename(into)}"
+      end
+      opne "#{rev}We will also store which programs are not up to date."
+      opne "These will be stored into the file "\
+           "at `#{sfile(into)}#{rev}`."
+      ::EnvironmentInformation.write_what_into(what, into)
+    end
+  end
+
+  # ========================================================================== #
+  # === do_not_run_already
+  # ========================================================================== #
+  def do_not_run_already
+    @internal_hash[:run_already] = false
+  end; alias do_not_run do_not_run_already # === do_not_run
+
+  # ========================================================================== #
+  # === run_already?
+  # ========================================================================== #
+  def run_already?
+    @internal_hash[:run_already]
+  end
+
+  # ========================================================================== #
+  # === set_array_work_on_these_components
+  # ========================================================================== #
+  def set_array_work_on_these_components(
+      i
+    )
+    hash = primary_hash?
+    i = [i].flatten
+    i.each {|this_entry|
+      hash[this_entry.to_sym] = nil
+    }
+  end; alias set_main_array                             set_array_work_on_these_components # === set_main_array
+       alias set_display_these_components               set_array_work_on_these_components # === set_display_these_components
+       alias set_use_this_as_main_input                 set_array_work_on_these_components # === set_use_this_as_main_input
+       alias set_report_these_programs                  set_array_work_on_these_components # === set_report_these_programs
+       alias show_only_the_components_from_this_dataset set_array_work_on_these_components # === show_only_the_components_from_this_dataset
+
+  # ========================================================================== #
+  # === 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(
+      i = work_on_which_components?
+    )
+    _ = i.sort_by {|name, version| name.to_s }
+    set_main_array(_)
+  end
+
+  # ========================================================================== #
+  # === query_this_version
+  # ========================================================================== #
+  def query_this_version(
+      i,
+      query_hash = return_hash_query_to_use_for_all_components
+    )
+    use_this_query = query_hash[i]
+    # ======================================================================== #
+    # Next, feed it to the main query-code:
+    # ======================================================================== #
+    result = silent_query(use_this_query)
+    if result
+      result.strip
+    else
+      nil
+    end
+  end
+
+  # ========================================================================== #
+  # === main_hash?
+  # ========================================================================== #
+  def main_hash?
+    ::EnvironmentInformation.hash?
+  end
+
+  # ========================================================================== #
+  # === generate_a_html_file?
+  # ========================================================================== #
+  def generate_a_html_file?
+    @internal_hash[:generate_a_html_file]
+  end
+
+  # ========================================================================== #
+  # === do_generate_a_html_file                                    (html tag)
+  #
+  # The action-method that will generate the html file. This depends
+  # on the gem html_tags, with module HtmlTags though.
+  #
+  # To invoke this method, do:
+  #
+  #   envi --generate-html-file
+  #
+  # ========================================================================== #
+  def do_generate_a_html_file(
+      styling_instructions = :none
+    )
+    # ======================================================================== #
+    # === Ensure that the html_tags project is available
+    # ======================================================================== #
+    unless Object.const_defined? :HtmlTags
+      begin
+        require 'html_tags'
+      rescue LoadError
+        e 'html_tags is not available. Considering installing it via:'
+        e
+        e '  gem install html_tags'
+        e
+      end
+    end
+    # ======================================================================== #
+    # === Define where to store the .html file in question
+    # ======================================================================== #
+    this_html_file = "#{temp_directory?}environment_information.html"
+    # ======================================================================== #
+    # Obtain the main dataset next.
+    # ======================================================================== #
+    what = dataset_as_string
+    case styling_instructions
+    # ======================================================================== #
+    # === :bold
+    # ======================================================================== #
+    when :bold
+      what = HtmlTags.b(what)
+    end
+    what = HtmlTags.html(
+      HtmlTags.title('Information about the local environment')+
+      HtmlTags.body(
+        HtmlTags.h1(
+          'Your environment',
+          css_style: 'margin-top: 0.5em; margin-bottom: 0.5em; '\
+                     'padding: 2px;'
+        )+
+        HtmlTags.pre(
+          what,
+          css_style: 'font-weight: bold; font-size: 2em; '\
+                     'padding-left: 1.0em; margin-top:2px;'
+        )
+      )
+    )
+    ::EnvironmentInformation.write_what_into(what, this_html_file)
+    # ======================================================================== #
+    # Notify the user what has been done.
+    # ======================================================================== #
+    if File.exist? this_html_file
+      opne "#{rev}Generated a HTML file at"
+      opne "`#{sfile(this_html_file)}#{rev}`."
+    end
+  end
+
+  # ========================================================================== #
+  # === do_really_create_a_html_file
+  # ========================================================================== #
+  def do_really_create_a_html_file
+    @internal_hash[:generate_a_html_file] = true
+  end
+
+  # ========================================================================== #
+  # === store_this_hash_into_a_local_file
+  # ========================================================================== #
+  def store_this_hash_into_a_local_file(
+      hash      = the_primary_hash?,
+      this_file = ::EnvironmentInformation.return_path_to_all_programs_file
+    )
+    unless hash.empty?
+      e
+      e "#{rev}Storing these results into the local file at"
+      e "`#{sfile(this_file)}#{rev}`."
+      e
+      ::EnvironmentInformation.store_this_hash_into_a_local_file(hash, this_file)
+    end
+  end; alias consider_storing_the_components_that_were_displayed store_this_hash_into_a_local_file # === consider_storing_the_components_that_were_displayed
+       alias consider_storing_which_components_were_displayed    store_this_hash_into_a_local_file # === consider_storing_which_components_were_displayed
+
+  # ========================================================================== #
+  # === clear_the_main_dataset
+  # ========================================================================== #
+  def clear_the_main_dataset
+    clear_the_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
+
+  # ========================================================================== #
+  # === 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
+
+  # ========================================================================== #
+  # === open_this_file_in_editor
+  # ========================================================================== #
+  def open_this_file_in_editor
+    _ = "geany #{THIS_FILE}"
+    e _; system _; exit
+  end
+
+  # ========================================================================== #
+  # === cflags_in_use?
+  # ========================================================================== #
+  def cflags_in_use?
+    ::EnvironmentInformation.cflags?
+  end; alias cflags? cflags_in_use? # === cflags?
+
+  # ========================================================================== #
+  # === 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?
+
+  # ========================================================================== #
+  # === 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
+
+  # ========================================================================== #
+  # === screen_resolution?
+  # ========================================================================== #
+  def screen_resolution?
+    ::EnvironmentInformation.screen_resolution?
+  end
+
+  # ========================================================================== #
+  # === return_hash_query_to_use_for_all_components
+  # ========================================================================== #
+  def return_hash_query_to_use_for_all_components
+    _ = QUERY_TO_USE_FOR_ALL_COMPONENTS
+    _.transform_keys! {|entry| entry.to_sym }
+    return _
+  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
+
+  # ========================================================================== #
+  # === do_not_save_anything
+  # ========================================================================== #
+  def do_not_save_anything
+    do_not_store_anything_into_a_local_file
+    # ======================================================================== #
+    # We will also avoid saving the results into a local yaml file.
+    # ======================================================================== #
+    do_not_store_anything_into_a_local_file
+  end; alias do_not_store_anything do_not_save_anything # === do_not_store_anything
+
+  # ========================================================================== #
+  # === disable_colours
+  #
+  # Call this method when you wish to disable the colours. Note that
+  # this will disable colours on the toplevel.
+  # ========================================================================== #
+  def disable_colours
+    super()
+    ::EnvironmentInformation.use_colours = false
+  end; alias no_colours disable_colours # === no_colours()
+
+  # ========================================================================== #
+  # === enable_colours
+  # ========================================================================== #
+  def enable_colours
+    super()
+    ::EnvironmentInformation.use_colours = true
+  end
+
+  # ========================================================================== #
+  # === clear_the_main_hash
+  # ========================================================================== #
+  def clear_the_main_hash
+    @internal_hash[:the_primary_hash].clear
+  end
+
+  # ========================================================================== #
+  # === add_this_to_the_toplevel_hash
+  # ========================================================================== #
+  def add_this_to_the_toplevel_hash(a, b)
+    a = a.to_sym unless a.is_a? Symbol
+    ::EnvironmentInformation.hash?[a] = b
+  end; alias register_onto_the_main_hash add_this_to_the_toplevel_hash # === register_onto_the_main_hash
+
+  # ========================================================================== #
+  # === return_all_available_components
+  # ========================================================================== #
+  def return_all_available_components
+    _ = dataset_containing_all_tracked_programs?
+    # ======================================================================== #
+    # === 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.
+      # ====================================================================== #
+      array = RBT.return_mate_desktop_version_array
+      array.each {|a,b|
+        # array << [a, b]
+        _ << a
+        the_primary_hash?[a.to_sym] = b
+      }
+    end
+    result = _.flatten
+    return result
+  end; alias return_every_registered_component return_all_available_components # === return_every_registered_component
+
+  # ========================================================================== #
+  # === clear_missing_components
+  # ========================================================================== #
+  def clear_missing_components
+    ::EnvironmentInformation.clear_missing_components
+  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
+
+  # ========================================================================== #
+  # === array_these_programs_not_up_to_date?
+  # ========================================================================== #
+  def array_these_programs_not_up_to_date?
+    @internal_hash[:array_these_programs_not_up_to_date]
+  end
+
+  # ========================================================================== #
+  # === store_the_results_into_local_files?
+  # ========================================================================== #
+  def store_the_results_into_local_files?
+    @internal_hash[:store_the_results_into_local_files]
+  end; alias shall_we_store_the_main_hash_into_a_local_file? store_the_results_into_local_files? # === alias shall_we_store_the_main_hash_into_a_local_file?
+       alias store_the_results_into_local_files?             store_the_results_into_local_files? # === store_the_results_into_local_files?
+
+  # ========================================================================== #
+  # === dataset_as_string
+  #
+  # This method must return the dataset in String format. That String
+  # must already be properly "formatted".
+  # ========================================================================== #
+  def dataset_as_string(
+      main_hash = the_primary_hash?
+    )
+    _ = ''.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 main_hash.has_key?(entry.to_sym)
+        _ << "  #{entry}: #{main_hash[entry.to_sym]}#{N}" 
+      elsif ::EnvironmentInformation.respond_to? use_this_method
+        program_version = ::EnvironmentInformation.send(
+          use_this_method
+        )
+        entry = "  #{entry}:"
+        _ << "#{entry} #{program_version}#{N}"
+      else # Try a self-query here
+        case entry.to_sym
+        when 'pkgconfig'
+          entry = ::EnvironmentInformation.query_pkgconfig_version_for(entry)
+        end
+        result = query_this_version(entry.to_sym)
+        if result and !result.empty?
+          entry = "  #{entry}:"
+          _ << "#{entry} #{result}#{N}"
+        end
+      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
+
+  # ========================================================================== #
+  # === compare_via_gem_version
+  # ========================================================================== #
+  def compare_via_gem_version(i)
+    begin
+      Gem::Version.new(i)
+    rescue ArgumentError => error
+      e Colours.tomato(error)
+      e "#{rev}We will continue nonetheless (#{i})"
+      return nil
+    end
+  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
+    @internal_hash[:do_exit_the_program] = true
+  end
+
+  # ========================================================================== #
+  # === 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
+
+  # ========================================================================== #
+  # === display_the_results_at_once?
+  # ========================================================================== #
+  def display_the_results_at_once?
+    @internal_hash[:display_the_results_at_once]
+  end; alias insta_show? display_the_results_at_once? # === insta_show?
+
+  # ========================================================================== #
+  # === can_we_query_the_mate_desktop?
+  # ========================================================================== #
+  def can_we_query_the_mate_desktop?
+    is_rbt_available? and
+    RBT.const_defined?(:Action) and 
+    RBT::Action.const_defined?(:ReportMateDesktopVersion)
+  end
+
+  # ========================================================================== #
+  # === report_the_installed_KDE_software_suite                      (KDE tag)
+  # ========================================================================== #
+  def report_the_installed_KDE_software_suite
+    begin
+      require 'rbt/toplevel_methods/toplevel_methods.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 "#{rev}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"
+          version = swift_query(cmd_to_use)
+          if version.include?(NOT_FOUND) or version.include?('not found')
+            version = NOT_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! unless version.frozen?
+          if version.include?('The program is not installed') or
+             version.include?(NOT_FOUND)
+            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
+
+  # ========================================================================== #
+  # === sync_the_primary_hash_onto_the_toplevel_hash
+  # ========================================================================== #
+  def sync_the_primary_hash_onto_the_toplevel_hash(
+      i = the_primary_hash?
+    )
+    ::EnvironmentInformation.clear_hash
+    i.each_pair {|key, value|
+      ::EnvironmentInformation.add_to_hash(key, value.to_s.strip)
+    }
+  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 = false
+    )
+    if be_verbose
+      e "#{rev}The program versions will also be compared."
+    end
+    @internal_hash[:compare_program_versions] = true
+  end
+
+  # ========================================================================== #
+  # === start_the_sinatra_interface
+  # ========================================================================== #
+  def start_the_sinatra_interface
+    require 'environment_information/www/sinatra_interface.rb'
+    ::EnvironmentInformation.start_sinatra_interface
+  end
+
+  # ========================================================================== #
+  # === clear_toplevel_hash
+  # ========================================================================== #
+  def clear_toplevel_hash
+    ::EnvironmentInformation.clear_hash
+  end
+
+  # ========================================================================== #
+  # === the_primary_hash?
+  # ========================================================================== #
+  def the_primary_hash?
+    @internal_hash[:the_primary_hash]
+  end; alias primary_hash? the_primary_hash? # === primary_hash?
+
+  # ========================================================================== #
+  # === work_on_these_components?
+  # ========================================================================== #
+  def work_on_these_components?
+    primary_hash?.keys
+  end; alias components?                     work_on_these_components? # === components?
+       alias main_dataset?                   work_on_these_components? # === main_dataset?
+       alias main_entry?                     work_on_these_components? # === main_entry?
+       alias dataset?                        work_on_these_components? # === dataset?
+       alias result                          work_on_these_components? # === result
+       alias result?                         work_on_these_components? # === result?
+       alias array_obtain_these_programs?    work_on_these_components? # === array_obtain_these_programs?
+       alias array_with_entries?             work_on_these_components? # === array_with_entries?
+       alias main_array?                     work_on_these_components? # === main_array?
+       alias programs?                       work_on_these_components? # === programs?
+       alias show_these_components?          work_on_these_components? # === show_these_components?
+       alias array_display_these_components  work_on_these_components? # === array_display_these_components
+       alias array_work_on_these_components? work_on_these_components? # === array_work_on_these_components?
+       alias display_these_components?       work_on_these_components? # === display_these_components?
+       alias display_which_components?       work_on_these_components? # === display_which_components?
+       alias display                         work_on_these_components? # === display
+       alias work_on_which_components?       work_on_these_components? # === work_on_which_components?
+
+  # ========================================================================== #
+  # === set_runmode_gui
+  # ========================================================================== #
+  def set_runmode_gui
+    @internal_hash[:runmode] = :gui
+  end
+
+  # ========================================================================== #
+  # === set_runmode_html
+  # ========================================================================== #
+  def set_runmode_html
+    @internal_hash[:runmode] = :html
+  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
+
+  # ========================================================================== #
+  # === runmode?
+  # ========================================================================== #
+  def runmode?
+    @internal_hash[:runmode]
+  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
+
+  # ========================================================================== #
+  # === do_report_the_remote_urls
+  #
+  # This method will enable the reporting of the remote URLs, if
+  # available.
+  # ========================================================================== #
+  def do_report_the_remote_urls
+    @internal_hash[:report_the_remote_urls] = true
+  end
+
+  # ========================================================================== #
+  # === report_the_remote_urls?
+  # ========================================================================== #
+  def report_the_remote_urls?
+    @internal_hash[:report_the_remote_urls]
+  end
+
+  # ========================================================================== #
+  # === dont_show_ruby_stuff
+  #
+  # Disable showing ruby + gem information.
+  # ========================================================================== #
+  def dont_show_ruby_stuff # Dont show ruby stuff.
+    @internal_hash[:show_ruby_version_and_gem_version] = false
+  end; alias show_no_ruby                       dont_show_ruby_stuff # === show_no_ruby
+       alias do_not_show_the_ruby_components    dont_show_ruby_stuff # === do_not_show_the_ruby_components
+       alias do_not_display_the_ruby_components dont_show_ruby_stuff # === do_not_display_the_ruby_components
+
+  # ========================================================================== #
+  # === return_rubygems_installation_directory
+  # ========================================================================== #
+  def return_rubygems_installation_directory
+    return ::EnvironmentInformation.rubygems_installation_directory
+  end; alias rubygems_installation_directory? return_rubygems_installation_directory # === rubygems_installation_directory?
+
+  # ========================================================================== #
+  # === return_version_of_rubygems?
+  #
+  # This method will return the rubygems-version at hand.
+  # ========================================================================== #
+  def return_version_of_rubygems?
+    ::EnvironmentInformation.send(__method__)
+  end; alias return_version_of_rubygems return_version_of_rubygems? # == return_version_of_rubygems
+
+  # ========================================================================== #
+  # === return_version_of_ruby?
+  # ========================================================================== #
+  def return_version_of_ruby?
+    ::EnvironmentInformation.send(__method__)
+  end; alias return_version_of_ruby return_version_of_ruby? # == return_version_of_ruby
+
+  # ========================================================================== #
+  # === may_we_try_to_use_rbt?
+  # ========================================================================== #
+  def may_we_try_to_use_rbt?
+    @internal_hash[:may_we_try_to_use_rbt]
+  end
+
+  # ========================================================================== #
+  # === show_n_registered_entries
+  #
+  # Invoke this via:
+  #
+  #   envi --n_entries
+  #
+  # ========================================================================== #
+  def show_n_registered_entries
+    e "#{true_rev}The EnvironmentInformation project contains "\
+      "#{sfancy(tracked_programs?.size)} "\
+      "#{true_rev}registered entries."
+  end
+
+  # ========================================================================== #
+  # === program_not_found
+  # ========================================================================== #
+  def program_not_found(
+      i,
+      use_colours = use_colours?
+    )
+    if use_colours
+      return send(::EnvironmentInformation.colour_for_program_not_found, i)
+    else
+      return i
+    end
+  end
+
+  # ========================================================================== #
+  # === RAM?
+  # ========================================================================== #
+  def RAM?
+    return ::EnvironmentInformation.ram?
+  end; alias ram? RAM? # === ram?
+
+  # ========================================================================== #
+  # === return_xvid_version
+  # ========================================================================== #
+  def return_xvid_version
+    ::EnvironmentInformation.return_version_of_xvid
+  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
+
+  # ========================================================================== #
+  # === return_operating_system
+  # ========================================================================== #
+  def return_operating_system
+    return ::EnvironmentInformation.operating_system
+  end; alias operating_system?                  return_operating_system # === operating_system?
+       alias return_version_of_operating_system return_operating_system # === return_version_of_operating_system
+
+  # ========================================================================== #
+  # === return_cpuinfo
+  #
+  # This is also known as the "cpu model".
+  # ========================================================================== #
+  def return_cpuinfo
+    return ::EnvironmentInformation.cpuinfo?
+  end; alias cpu_model? return_cpuinfo # === cpu_model?
+
+  # ========================================================================== #
+  # === left_side
+  # ========================================================================== #
+  def left_side(
+      i,
+      use_colours = use_colours?
+    )
+    if use_colours
+      return send(::EnvironmentInformation.colour_for_the_left_side, i)
+    else
+      return i
+    end
+  end
+
+  # ========================================================================== #
+  # === 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
+
+  # ========================================================================== #
+  # === dataset_containing_all_tracked_programs?
+  # ========================================================================== #
+  def dataset_containing_all_tracked_programs?
+    @internal_hash[:dataset_containing_all_tracked_programs]
+  end
+
+  # ========================================================================== #
+  # === do_exit_the_program?
+  # ========================================================================== #
+  def do_exit_the_program?
+    @internal_hash[:do_exit_the_program]
+  end
+
+  # ========================================================================== #
+  # === register_unavailable_program
+  #
+  # Programs that were not be found can be registered through this method.
+  # ========================================================================== #
+  def register_unavailable_program(
+      i,
+      array = array_unavailable_programs?
+    )
+    if i.is_a? Array
+      i.flatten.each {|entry|
+        register_unavailable_program(entry, array)
+      }
+    else
+      i = i.to_sym # Let's store only Symbols.
+      array << i unless array.include?(i)
+    end
+  end; alias register_not_found register_unavailable_program # === register_not_found
+
+  # ========================================================================== #
+  # === 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
+    @internal_hash[:display_everything_in_short_format] = true
+  end
+
+  # ========================================================================== #
+  # === consider_adding_the_ruby_components
+  #
+  # This method can be used to consider adding the ruby-components,
+  # which means "ruby" itself, rubygems "gem", and the rubygems
+  # installation directory.
+  # ========================================================================== #
+  def consider_adding_the_ruby_components
+    if show_ruby_version_and_gem_version?
+      add(
+        return_all_ruby_components # Combine three calls into one here - all related to ruby.
+      )
+    end
+  end
+
+  # ========================================================================== #
+  # === show_ruby_version_and_gem_version?
+  # ========================================================================== #
+  def show_ruby_version_and_gem_version?
+    @internal_hash[:show_ruby_version_and_gem_version]
+  end
+
+  # ========================================================================== #
+  # === return_all_ruby_components
+  #
+  # Combine three calls into one here - all related to ruby.
+  # ========================================================================== #
+  def return_all_ruby_components
+    %i(
+      ruby
+      rubygems
+      rubygems_installation_directory
+    )
+  end
+
+  # ========================================================================== #
+  # === array_unavailable_programs?
+  # ========================================================================== #
+  def array_unavailable_programs?
+    @internal_hash[:array_unavailable_programs]
+  end
+
+  # ========================================================================== #
+  # === enable_sort_alphabetically
+  # ========================================================================== #
+  def enable_sort_alphabetically
+    @internal_hash[:sort_alphabetically] = true
+  end
+
+  # ========================================================================== #
+  # === opnn
+  # ========================================================================== #
+  def opnn
+    if TRY_TO_MAKE_USE_OF_THE_OPN_GEM_IF_IT_IS_AVAILABLE and
+       Object.const_defined?(:Opn)
+      Opn.opn({
+        namespace:   NAMESPACE,
+        use_colours: use_colours?
+      })
+    end
+  end; alias opn opnn # === opn
+
+  # ========================================================================== #
+  # === add_the_default_programs_on_a_linux_computer
+  # ========================================================================== #
+  def add_the_default_programs_on_a_linux_computer
+    # ======================================================================== #
+    # Add the default programs on a linux computer.
+    # ======================================================================== #
+    add(
+      return_default_programs_on_a_linux_computer
+    )
+  end; alias add_default_linux_programs add_the_default_programs_on_a_linux_computer # === add_default_linux_programs
+
+  # ========================================================================== #
+  # === add_the_commandline_arguments
+  # ========================================================================== #
+  def add_the_commandline_arguments(
+      i = commandline_arguments?
+    )
+    i.compact.each {|entry|
+      add(entry) unless entry.start_with?('--')
+    }
+  end
+
+  # ========================================================================== #
+  # === notify_the_user_that_there_are_no_components_that_can_be_displayed
+  # ========================================================================== #
+  def notify_the_user_that_there_are_no_components_that_can_be_displayed
+    opne 'There are no components that can be displayed.'
+  end
+
+  # ========================================================================== #
+  # === do_exit_the_program
+  # ========================================================================== #
+  def do_exit_the_program
+    @internal_hash[:do_exit_the_program] = true
+  end
+
+  # ========================================================================== #
+  # === 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
+
+  # ========================================================================== #
+  # === report_version
+  # ========================================================================== #
+  def report_version
+    ::EnvironmentInformation.report_version
+    @internal_hash[:do_exit_the_program] = true
+  end
+
+  # ========================================================================== #
+  # === e                                                             (e tag)
+  #
+  # The e() method is the general output-method for this class.
+  # ========================================================================== #
+  def e(
+      i = ''
+    )
+    if be_verbose?
+      if use_one_line_to_show_the_result? # This will just use "print".
+        ::EnvironmentInformation.ee(i)
+      else
+        ::EnvironmentInformation.e(
+          i,
+          display_everything_in_short_format: display_everything_in_short_format?
+        )
+      end
+    end
+  end
+
+  # ========================================================================== #
+  # === add_ruby_and_rubygems
+  # ========================================================================== #
+  def add_ruby_and_rubygems
+    add(:ruby)
+    add(:rubygems)
+    add(:rubygems_installation_directory)
+  end
+
+  # ========================================================================== #
+  # === show_everything?
+  # ========================================================================== #
+  def show_everything?
+    @internal_hash[: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
+
+  # ========================================================================== #
+  # === 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
+
+  # ========================================================================== #
+  # === compare_program_versions?
+  # ========================================================================== #
+  def compare_program_versions?
+    @internal_hash[:compare_program_versions]
+  end; alias compare_program_version? compare_program_versions? # === compare_program_version?
+
+  # ========================================================================== #
+  # === do_store_the_results_into_local_files
+  # ========================================================================== #
+  def do_store_the_results_into_local_files
+    @internal_hash[:store_the_results_into_local_files] = true
+  end
+
+  # ========================================================================== #
+  # === do_not_store_anything_into_a_local_file
+  # ========================================================================== #
+  def do_not_store_anything_into_a_local_file
+    @internal_hash[:shall_we_store_the_main_hash_into_a_local_file] = false
+  end
+
+  # ========================================================================== #
+  # === set_use_colours
+  # ========================================================================== #
+  def set_use_colours(
+      i = true
+    )
+    super()
+    ::EnvironmentInformation.set_use_colours(i)
+  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
+
+  # ========================================================================== #
+  # === 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_not_display_the_result
+  # ========================================================================== #
+  def do_not_display_the_result
+    @internal_hash[:display_result] = false
+  end
+
+  # ========================================================================== #
+  # === display_result?
+  # ========================================================================== #
+  def display_result?
+    @internal_hash[:display_result]
+  end
+
+  # ========================================================================== #
+  # === xorg_components?
+  # ========================================================================== #
+  def xorg_components?
+    ::EnvironmentInformation.xorg_components?
+  end; alias return_all_xorg_components xorg_components? # === return_all_xorg_components
+
+  # ========================================================================== #
+  # === clear_old_dataset
+  # ========================================================================== #
+  def clear_old_dataset
+    work_on_these_components?.clear
+  end; alias clear_the_old_dataset clear_old_dataset # === clear_the_old_dataset
+
+  # ========================================================================== #
+  # === 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
+
+  # ========================================================================== #
+  # === display_everything_in_short_format?
+  # ========================================================================== #
+  def display_everything_in_short_format?
+    @internal_hash[:display_everything_in_short_format]
+  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
+    @internal_hash[:table] = table ['Name', 'Version']
+    @internal_hash[:table].style = {
+      padding_left:  2,
+      width:       110 # Set the width here.
+    }
+    @internal_hash[:use_ascii_table] = true
+  end
+
+  # ========================================================================== #
+  # === sort_alphabetically?
+  # ========================================================================== #
+  def sort_alphabetically?
+    @internal_hash[:sort_alphabetically]
+  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
+
+  # ========================================================================== #
+  # === version?
+  # ========================================================================== #
+  def version?(
+      key = the_primary_hash?.keys.first
+    )
+    the_primary_hash?[key]
+  end
+
+  # ========================================================================== #
+  # === EnvironmentInformation.colourize_and_pad_the_left_side
+  # ========================================================================== #
+  def self.colourize_and_pad_the_left_side(i)
+    left_side = i.to_s.ljust(32) # Pad to the left-hand side.
+    if use_colours?
+      "  #{Colours.send(::EnvironmentInformation.colour_for_the_left_side,  left_side)}"
+    else
+      "  #{left_side}"
+    end
+  end; self.instance_eval { alias prepare_left_side colourize_and_pad_the_left_side } # === EnvironmentInformation.prepare_left_side
+
+end; end