rbt 0.10.215 → 0.11.90

data/lib/rbt/compile/show_report_and_feedback.rb

@@ -1,1587 +0,0 @@
-#!/usr/bin/ruby -w
-# Encoding: UTF-8
-# frozen_string_literal: true
-# =========================================================================== #
-# require 'rbt/compile/show_report_and_feedback.rb'
-# =========================================================================== #
-module RBT
-
-class Compile < ::RBT::CompileBase # === RBT::Compile
-
-  # ========================================================================= #
-  # === report_all_programs_that_make_use_of_a_build_directory
-  #
-  # This method can report all programs that make use of a build
-  # directory. Note that this presently depends on the existance
-  # of the directory expanded_cookbooks.
-  # ========================================================================= #
-  def report_all_programs_that_make_use_of_a_build_directory
-    opne 'Trying to determine all programs that use '\
-         'a build-directory ...'
-    opne 'This may take a moment ...'
-    use_this_key = :use_build_directory # It is stored as a Symbol.
-    if expanded_directory_exists?
-      # ===================================================================== #
-      # Find all cookbooks in the expanded-cookbook-directory next:
-      # ===================================================================== #
-      target = directory_expanded_cookbooks?
-      all_files = Dir["#{target}*.yml"]
-      all_files.select! {|entry|
-        dataset = YAML.load_file(entry)
-        dataset[use_this_key] and (dataset[use_this_key] == true)  # Obtain all entries with this key here.
-      }
-      all_files.map! {|entry|
-        File.basename(entry).sub(/\.yml$/,'')
-      }
-      if all_files.empty?
-        opne 'No cookbook recipe makes use of a build directory.'
-      else
-        opne "The following #{slateblue(all_files.size.to_s)} programs "\
-             "make use of a build directory:"
-        all_files.each_with_index {|this_program, index| index += 1
-          padded_index = index.to_s.rjust(4).ljust(6)
-          colourized_and_padded_index = royalblue(padded_index)
-          e colourized_and_padded_index+
-            lightblue(this_program)
-        }
-      end
-    else
-      # ===================================================================== #
-      # else notify the user how to create the relevant directory.
-      # ===================================================================== #
-      opne 'The expanded directory does not exist. You can (re)create it'
-      opne 'by issuing:'
-      e
-      e '  rbt --create-expanded-directory'
-      e
-    end
-  end
-
-  # ========================================================================= #
-  # === display_the_oldest_programs
-  #
-  # This method will report, on the commandline, the oldest programs.
-  # ========================================================================= #
-  def display_the_oldest_programs
-    require 'rbt/cookbooks/show_last_updated.rb'
-    RBT::Cookbooks::ShowLastUpdated.new('--sort-by-oldest')
-  end
-
-  # ========================================================================= #
-  # === show_last_updated
-  #
-  # This method will show the last updated programs.
-  #
-  # Invocation example:
-  #
-  #   ry --last_update
-  #
-  # ========================================================================= #
-  def show_last_updated(
-      shall_we_exit = true
-    )
-    require 'rbt/cookbooks/show_last_updated.rb'
-    RBT::Cookbooks::ShowLastUpdated.new # bl $RUBY_COOKBOOKS/lib/cookbooks/show_last_updated.rb
-    exit_program if shall_we_exit
-  end
-
-  # ========================================================================= #
-  # === feedback_prefix_in_use?
-  #
-  # Use this method to feedback which prefix is in use.
-  #
-  # Usage examples:
-  #
-  #   ry allegro --prefix?
-  #   ry openmpi --prefix?
-  #   ry htop    prefix?
-  #
-  # ========================================================================= #
-  def feedback_prefix_in_use?(
-      shall_we_exit = true
-    )
-    program_name = compile_which_program?.dup
-    if cookbook_dataset?.nil?
-      ensure_proper_dataset_for(program_name)
-    end
-    e "#{rev}The prefix in use for #{lightgreen(program_name)} will be:"
-    e "  #{sfancy(prefix?)}"
-    exit_program if shall_we_exit
-  end; alias feedback_prefix_in_use feedback_prefix_in_use? # === feedback_prefix_in_use
-
-  require 'rbt/toplevel_methods/report_how_many_binaries_are_registered.rb'
-  # ========================================================================= #
-  # === either_report_the_total_amount_of_binaries_or_how_many_binaries_this_program_will_install
-  # ========================================================================= #
-  def either_report_the_total_amount_of_binaries_or_how_many_binaries_this_program_will_install
-    if a_program_has_been_initialized?
-      report_the_amount_of_binaries
-    else
-      RBT.report_how_many_binaries_are_registered
-    end
-  end
-
-  # ========================================================================= #
-  # === show_configuration_options
-  # ========================================================================= #
-  def show_configuration_options
-    ShowConfigurationOptions.new # This is automatically required.
-  end
-
-  require 'rbt/registered/registered_binaries.rb'
-  # ========================================================================= #
-  # === feedback_all_registered_binaries_of_all_programs
-  #
-  # This method will show, on the commandline, all registered binaries
-  # of all the programs together.
-  #
-  # Invocation example:
-  #
-  #   rbt --all-binaries
-  #
-  # ========================================================================= #
-  def feedback_all_registered_binaries_of_all_programs
-    _ = RBT.registered_binaries?
-    opne 'These '+royalblue(_.size.to_s)+' binaries are registered:'
-    e
-    _.each_with_index {|this_binary, index| index += 1
-      padded_index = (index.to_s+') ').rjust(5)
-      e "  #{lightgreen(padded_index)}"\
-        "#{slateblue(this_binary)}"
-    }
-    e
-  end
-
-  require 'rbt/requires/require_the_cookbook_class.rb'
-  # ========================================================================= #
-  # === feedback_program_description
-  #
-  # We feedback the description here, by tapping into the method
-  # feedback_description() from class Cookbooks.
-  # ========================================================================= #
-  def feedback_program_description(
-      i = program_name?
-    )
-    e
-    RBT.feedback_description_of(i)
-    e
-  end; alias feedback_description feedback_program_description # === feedback_description
-
-  # ========================================================================= #
-  # === show_programs_with_this_as_dependency
-  #
-  # Invocation example:
-  #
-  #   rbt --show-programs-with-this-as-dependency=cmake
-  #
-  # ========================================================================= #
-  def show_programs_with_this_as_dependency(i)
-    use_this_key = :required_deps_on
-    e rev+'Next trying to find all programs that depend on '+steelblue(i)+':'
-    e
-    array_these_programs_depend_on_the_given_input = []
-    available_programs?.each {|this_program|
-      expanded_cookbook_dataset = return_dataset_from_this_expanded_cookbook(this_program)
-      if expanded_cookbook_dataset
-        required_deps_on = expanded_cookbook_dataset[use_this_key]
-        if required_deps_on.include? i
-          array_these_programs_depend_on_the_given_input << this_program
-          e " - #{this_program}"
-        end
-      end
-    }
-    e
-    e "#{rev}A total of "+
-      royalblue(array_these_programs_depend_on_the_given_input.size.to_s)+
-      rev+' registered programs depend on '+steelblue(i)+'.'
-    e
-  end
-
-  # ========================================================================= #
-  # === show_information_about_blfs
-  #
-  # We show some information about BLFS webpages.
-  #
-  # To invoke this method, you can issue a command such as this here:
-  #
-  #   rbt binutils --lfs
-  #
-  # ========================================================================= #
-  def show_information_about_blfs(
-      use_this_key = :blfs
-    )
-    ensure_that_this_key_has_a_dataset(use_this_key)
-    dataset = cookbook_dataset?
-    if dataset.has_key?(use_this_key) and
-      !dataset?.blfs?.empty? # .empty? will assume this to be a String.
-      url = dataset?.blfs?
-      if url.is_a? Array
-        url = url.first
-      end
-      e "Url is: #{sfancy(url)}"
-      set_xorg_buffer(url) if is_roebe?
-    else
-      opne "The program #{royalblue(compile_which_program?)} has no blfs entry."
-    end
-  end
-
-  # ========================================================================= #
-  # === show_last_compiled_program
-  #
-  # Use this method to show the last compiled program.
-  # ========================================================================= #
-  def show_last_compiled_program(
-      shall_we_exit = false
-    )
-    shall_we_exit = true if shall_we_exit == :then_exit
-    opne 'The last compiled program was `'+
-          sfancy(last_compiled_program?)+'` (as registered'
-    opne "in the file #{sfile(RBT.file_compiled_programs)})."
-    exit if shall_we_exit
-  end
-
-  # ========================================================================= #
-  # === show_which_compiler_will_be_used
-  #
-  # This method will show which compiler will be used.
-  #
-  # Commandline invocation:
-  #
-  #   rbt --compiler?
-  #
-  # ========================================================================= #
-  def show_which_compiler_will_be_used
-    opne "The compiler that will be used for compiling "\
-         "programs is `#{slateblue(use_which_compiler?)}`."
-  end
-
-  # ========================================================================= #
-  # === report_whether_porg_is_available
-  # ========================================================================= #
-  def report_whether_porg_is_available
-    e rev+'Is porg available? '+
-      sfancy(verbose_truth(is_porg_available?))
-  end
-
-  # ========================================================================= #
-  # === report_status_information
-  #
-  # Invocation example:
-  #
-  #   rbt --report-status
-  #
-  # ========================================================================= #
-  def report_status_information
-    e
-    e 'The source directory is at:                      '+sdir(RBT.source_dir?)
-    e 'The temp directory is at:                        '+sdir(RBT.temp_dir?)
-    report_where_archives_will_be_extracted_into
-    e
-  end
-
-  # ========================================================================= #
-  # === report_which_libraries_are_missing
-  #
-  # Report which libraries are missing.
-  #
-  # Invocation example:
-  #
-  #   ry --not-found
-  #
-  # ========================================================================= #
-  def report_which_libraries_are_missing
-     require 'rbt/utility_scripts/not_found_libraries.rb'
-     RBT::NotFoundLibraries.new
-  end
-
-  # ========================================================================= #
-  # === show_the_recipes_directory
-  # ========================================================================= #
-  def show_the_recipes_directory(
-      i = recipes_dir?
-    )
-    e sfancy(i) # In $RBT/base/base.rb
-  end
-
-  # ========================================================================= #
-  # === show_build_systems_priorities
-  #
-  # Invocation example:
-  #
-  #   rbt --prioritize?
-  #
-  # ========================================================================= #
-  def show_build_systems_priorities
-    array = return_build_systems_priorities
-    e
-    e lightgreen(
-        'The build system priority is the following '\
-        '(first one has higher priority):'
-      )
-    e
-    array.each_with_index {|content, index| index += 1
-      e slateblue(("(#{index}) ").rjust(6))+
-        orange(content)
-    }
-    e
-    e 'Remember that the per-yaml setting "'+
-       steelblue('use_this_build_system')+'" cat'
-    e 'overrule this.'
-    e
-  end
-
-  # ========================================================================= #
-  # === report_which_programs_can_be_compiled_statically
-  # ========================================================================= #
-  def report_which_programs_can_be_compiled_statically
-    use_this_key = :can_be_compiled_statically
-    selection = available_programs?.select {|this_program|
-      if does_this_expanded_cookbook_file_exist_for_this_program?(this_program)
-        dataset = load_dataset_from_this_expanded_cookbook(this_program)
-        _ = dataset[use_this_key]
-        (_ == 'yes') or (_.to_s == 'true')
-      else
-        false
-      end
-    }
-    if selection.empty?
-      opne 'No program that can be compiled statically was found.'
-      opne 'This is an incorrect result, though. Have you expanded'
-      opne 'your local dataset already?'
-      opne 'If not, run:'
-      e
-      e '  rbt --expand-dataset'
-      e
-    else
-      opne 'The following programs can be compiled statically:'
-      e
-      selection.each_with_index {|this_program, index| index += 1
-        e royalblue("  #{index.to_s.rjust(3)}) ")+
-          steelblue("#{this_program}")
-      }
-      e
-    end
-  end
-
-  # ========================================================================= #
-  # === show_which_files_will_be_installed
-  #
-  # This method will show to the user which files will be installed.
-  #
-  # Invocation examples:
-  #
-  #   ry htop ifiles
-  #   ry htop --installed-files
-  #   ry ruby --installed-files
-  #
-  # ========================================================================= #
-  def show_which_files_will_be_installed(
-      i = compile_which_program?
-    )
-    file = static_appdir_prefix?+'yaml/registered_files.yml'
-    if File.exist? file
-      opne 'The following files will be installed by '\
-           'the program `'+simp(i)+'`:'
-      dataset = YAML.load_file(file).sort
-      e; dataset.each {|entry| e "  #{entry}" }; e
-    else
-      opne "The file #{sfile('registered_files.yml')}"\
-           " could not be found,"
-      opne 'thus we can not show which files are installed.'
-    end
-  end
-
-  # ========================================================================= #
-  # === report_whether_this_program_is_included_or_whether_it_is_not
-  #
-  # This method will notify the user as to whether the given program
-  # passed into this method is registered, as part of the RBT
-  # project, or whether it is not.
-  # ========================================================================= #
-  def report_whether_this_program_is_included_or_whether_it_is_not(
-      i = program?
-    )
-    e teal("Is #{program} included in the RBT project?: ")+
-      verbose_truth(
-        is_this_program_included?(i, :be_quiet)
-      )
-  end; alias verbose_include? report_whether_this_program_is_included_or_whether_it_is_not # === verbose_include?
-
-  # ========================================================================= #
-  # === report_where_we_store_then_exit
-  # ========================================================================= #
-  def report_where_we_store_then_exit
-    report_where_we_will_store_logs
-    exit_program
-  end
-
-  # ========================================================================= #
-  # === show_where_the_base_directory_can_be_found
-  #
-  # To test this method, do:
-  #
-  #   ry htop base_dir?
-  #
-  # ========================================================================= #
-  def show_where_the_base_directory_can_be_found
-    e
-    opne 'The base directory is at: '.ljust(36)+
-          sfancy(temp_directory?)
-    unless extract_to?.to_s.empty?
-      opne "We will extract to this directory:  "\
-           "#{sfancy(extract_to?.to_s)}"
-    end
-    e
-  end
-
-  # ========================================================================= #
-  # === show_temp_directory
-  #
-  # To invoke this from the commandline, do:
-  #
-  #   ry --tempdir?
-  #
-  # ========================================================================= #
-  def show_temp_directory
-    opne "The temporary directory resides at `#{sdir(temp_directory?)}`."
-  end
-
-  # ========================================================================= #
-  # === show_how_to_compile_kde
-  #
-  # This method will provide some hints on the commandline as to how
-  # to batch-compile the various KDE components.
-  #
-  # Invocation example:
-  #
-  #   rbt --show-how-to-compile-kde
-  #
-  # ========================================================================= #
-  def show_how_to_compile_kde
-    e
-    e '  rbt --batch-compile=kde5_foundation'
-    e '  rbt --batch-compile=kde5_plasma'
-    e '  rbt --batch-compile=kde5_porting_aids'
-    e '  rbt --batch-compile=kde5_applications'
-    e
-  end
-
-  # ========================================================================= #
-  # === show_how_to_batch_compile
-  #
-  # This method will notify the user in how to batch-compile programs
-  # via RBT.
-  #
-  # Invocation example:
-  #
-  #   rbt --show_how_to_batch_compile
-  #
-  # ========================================================================= #
-  def show_how_to_batch_compile
-    show_available_batch_compile_options
-    e
-    e 'In order to batch-compile one of these, issue a command such as:'
-    e
-    e '  rbt --batch-compile=mate'
-    e '  rbt --batch-compile=vid_base'
-    e '  rbt --batch-compile=terminals'
-    e
-  end
-
-  # ========================================================================= #
-  # === show_available_batch_compile_options
-  # ========================================================================= #
-  def show_available_batch_compile_options(
-      this_file = RBT.file_cookbook_chained_programs
-    )
-    if File.exist? this_file
-      dataset = YAML.load_file(this_file)
-      keys = dataset.keys
-      opne "These #{teal(keys.size)} entries exist:"; e
-      keys.each {|this_entry_point|
-        e "  #{sfancy(this_entry_point)}"
-      }; e
-    else
-      opnn; no_such_file_exists(this_file)
-    end
-  end
-
-  # ========================================================================= #
-  # === report_the_amount_of_binaries
-  #
-  # Invocation example:
-  #
-  #   ry glib --n-binaries?
-  #
-  # ========================================================================= #
-  def report_the_amount_of_binaries(
-      i = compile_which_program?
-    )
-    ensure_proper_dataset_for(i) if cookbook_dataset?.nil?
-    _ = binaries?
-    opne 'The program '+sfancy(i)+' will '\
-         'install '+sfancy(_.size.to_s)+' binaries.'
-  end
-
-  # ========================================================================= #
-  # === report_whether_a_build_directory_will_be_used_for_this_program
-  # ========================================================================= #
-  def report_whether_a_build_directory_will_be_used_for_this_program
-    opne 'Will a '+teal('build directory')+' be used for the program '+
-          sfancy(compile_which_program?)+'? '+
-          simp(
-            verbose_truth(use_build_directory?).delete('.')
-          )+'.'
-  end
-
-  # ========================================================================= #
-  # === report_where_archives_will_be_extracted_into
-  # ========================================================================= #
-  def report_where_archives_will_be_extracted_into
-    e "Archives will be extracted into this directory: "\
-      "#{sdir(extract_to?)}"
-  end
-
-  # ========================================================================= #
-  # === show_installation_procedure_file
-  #
-  # Show the content of the file called installation_procedure.yml
-  #
-  # To invoke this method, try:
-  #
-  #   rbt --installation-procedure
-  #
-  # ========================================================================= #
-  def show_installation_procedure_file(
-      this_file = BeautifulUrl['installation_procedere']
-    )
-    begin
-      require 'beautiful_url' unless Object.const_defined? :BeautifulUrl
-    rescue LoadError; end
-    this_file = this_file.first if this_file.is_a? Array
-    if File.exist? this_file
-      e File.read(this_file)
-    else
-      opne 'No file called '+sfile(this_file)+' was found.'
-    end
-  end
-
-  # ========================================================================= #
-  # === show_the_last_configure_option_for_this_program
-  #
-  # This method will make use of the file configure_command_database.yml.
-  # Obviously, the file has to exist in order for this to work.
-  #
-  # Invocation example:
-  #
-  #   ry attica --show-last-configure-option-for-this-program
-  #
-  # ========================================================================= #
-  def show_the_last_configure_option_for_this_program(
-      this_program = compile_which_program?
-    )
-    _ = RBT.file_configure_database
-    if File.exist? _
-      dataset = YAML.load_file(_)
-      if dataset.has_key? this_program
-        result = dataset[this_program]
-        opne "The program #{sfancy(this_program)} has "\
-             "been compiled with this command:"
-        e
-        e "  #{sfancy(result)}" # Display it without opnn.
-        e
-      else
-        opne "The program #{sfancy(this_program)} has not "\
-             "been registered/compiled yet."
-      end
-    else
-      opne "No file exists at `#{sfile(_)}` so we can not proceed."
-      opne 'Nota bene: You should first compile some programs, before'
-      opne 'making use of this method.'
-    end
-  end
-
-  # ========================================================================= #
-  # === show_gobolinux_instructions
-  #
-  # To invoke this method do:
-  #
-  #   rbt --show-gobo-instructions
-  #
-  # ========================================================================= #
-  def show_gobolinux_instructions
-    _ = RUBY_SRC_DIR+'rbt/doc/instructions_for_gobolinux.md'
-    if File.exist? _
-      e File.read(_)
-    else
-      opnn; no_file_exists_at(_)
-    end
-  end
-
-  # ========================================================================= #
-  # === feedback_whether_we_will_strip_or_whether_we_will_not
-  #
-  # Feedback whether we will run the "strip" binary or whether we
-  # will not.
-  #
-  # Invocation example:
-  #
-  #   ry --strip?
-  #
-  # ========================================================================= #
-  def feedback_whether_we_will_strip_or_whether_we_will_not
-    _ = strip_binaries?
-    case _
-    when true
-      opne 'Yes, we will run "'+slateblue('strip')+'" on the resulting '\
-           'binaries of'
-      opne 'the given program at hand.'
-    when false
-      opne "No, we will #{swarn('NOT')} run \"strip\" on the "\
-           "resulting binaries of"
-      opne 'the given program at hand.'
-    else
-      e 'Unknown value: '+steelblue(_.class.to_s)
-    end
-  end
-
-  # ========================================================================= #
-  # === feedback_make_options
-  #
-  # To trigger this method, do e. g.:
-  #
-  #   ry ruby make_opts
-  #   ry binutils make_opts
-  #
-  # ========================================================================= #
-  def feedback_make_options(
-      i = compile_which_program?
-    )
-    _ = cookbook_dataset_make_options?
-    _ = _.first if _.is_a? Array
-    e
-    e royalblue(_)
-    e
-  end
-
-  # ========================================================================= #
-  # === feedback_licenses
-  #
-  # This will feedback all licenses, or apply a filter.
-  #
-  # Usage example:
-  #
-  #   ry htop flicenses
-  #
-  # ========================================================================= #
-  def feedback_licenses(
-      filter_for_licenses = '*'
-    )
-    RBT::Cookbooks::FeedbackLicenses.new(filter_for_licenses) # bl $RUBY_COOKBOOKS/lib/cookbooks/feedback_licenses.rb
-  end
-
-  # ========================================================================= #
-  # === feedback_programs_dir
-  # ========================================================================= #
-  def feedback_programs_dir
-    opne "The programs directory is at #{sfile(programs_dir?)}"
-  end
-
-  begin
-    require 'case_parser'
-  rescue LoadError; end
-  # ========================================================================= #
-  # === feedback_all_case_options_of_the_main_menu
-  # ========================================================================= #
-  def feedback_all_case_options_of_the_main_menu
-    _ = THIS_FILE
-    if File.exist? _
-      if Object.const_defined? :CaseParser
-        _ = CaseParser.parse(_)
-        _.each {|entry|
-          e entry
-        }
-      else
-        opne 'The project case_parser is not available. Please install it.'
-        e
-        opne sfancy('  gem install case_parser')
-        e
-      end
-    else # Else the file does not exist.
-      opne "No file at #{sfile(_)} could be found. We "\
-           "thus can not use CaseParser."
-    end
-  end
-
-  # ========================================================================= #
-  # === feedback_all
-  # ========================================================================= #
-  def feedback_all(
-      i = compile_which_program?
-    )
-    require 'rbt/cookbooks/display_cookbook_dataset/feedback/feedback.rb'
-    RBT::Cookbooks::DisplayCookbookDataset::Feedback.feedback_all(i)
-  end
-
-  # ========================================================================= #
-  # === feedback_various_versions
-  #
-  # This actually will only feedback the RBT version in use, since we
-  # have merged the different projects together in September 2018.
-  #
-  # To invoke this method, do:
-  #
-  #   ry htop feedback_version
-  #
-  # ========================================================================= #
-  def feedback_various_versions(
-      optional_use_opn = true,
-      ljust            = 45
-    )
-    case optional_use_opn
-    when :do_not_use_opn
-      optional_use_opn = false
-    end
-    feedback_rbt_version(ljust, optional_use_opn)
-  end
-
-  # ========================================================================= #
-  # === feedback_sanitize_dataset_version
-  # ========================================================================= #
-  def feedback_sanitize_dataset_version(
-      ljust = 35, use_opn = true
-    )
-    opnn if use_opn
-    e sfancy('RBT::Cookbooks::SanitizeCookbook version: '.ljust(ljust))+
-      simp(RBT.version?)
-  end
-
-  # ========================================================================= #
-  # === feedback_rbt_version
-  # ========================================================================= #
-  def feedback_rbt_version(
-      ljust = 35, use_opn = true
-    )
-    opnn if use_opn
-    e sfancy('RBT Version: '.ljust(ljust))+
-      simp(RBT.version?)
-  end
-
-  # ========================================================================= #
-  # === feedback_main_config
-  #
-  # In order to invoke this method, do:
-  #
-  #   rbt config?
-  #
-  # ========================================================================= #
-  def feedback_main_config
-    opne 'We will show the configuration options set for the '\
-         'RBT project next.'
-    cliner {
-      hash = RBT.configuration?._ # Delegate to the config.
-      hash.each_pair {|key, value|
-        case key.to_s.strip
-        when 'email'
-          value = crimson(value.to_s.ljust(10))
-        else
-          value = slateblue(value.to_s.ljust(10))
-        end
-        key = lightgoldenrodyellow( ((key.to_s+':').ljust(46)) )
-        e '  '+key+' '+value
-      }
-    }
-  end
-
-  # ========================================================================= #
-  # === feedback_main_config_then_exit
-  # ========================================================================= #
-  def feedback_main_config_then_exit
-    feedback_main_config
-    exit_program
-  end
-
-  # ========================================================================= #
-  # === feedback_what_we_are_currently_compiling?
-  #
-  # This method will feedback what we are currently compiling.
-  #
-  # To invoke this method, do:
-  #
-  #   rbt --what-are-we-currently-compiling?
-  #
-  # ========================================================================= #
-  def feedback_what_we_are_currently_compiling?(
-      status_file = FILE_STATUS
-    )
-    if File.exist? status_file
-      dataset = YAML.load_file(status_file)
-    end
-    this_key = 'currently_compiling_these_programs'
-    if dataset.has_key?(this_key) and
-       !dataset[this_key].empty? # This should work because it is an Array.
-      these_programs_are_currently_compiled = dataset[this_key]
-      opne 'The following programs are currently compiled:'
-      e
-      these_programs_are_currently_compiled.each {|this_program|
-        e "  #{sfancy(this_program)}"
-      }; e
-    else
-      opne 'No program is being currently compiled.'
-    end
-  end
-
-  # ========================================================================= #
-  # === feedback_configure_options
-  #
-  # To test this method, try something like this:
-  #
-  #   ry htop configure_options?
-  #   ry gcc configure_options?
-  #
-  # ========================================================================= #
-  def feedback_configure_options(i = compile_this_program?)
-    opne 'The configure options for the program '+sfancy(i)+' are:'
-    if dataset?.nil?
-      ensure_that_we_have_a_dataset(i)
-    end
-    _ = configure_options?
-    e
-    e "  #{sfancy(_)}"
-    e
-  end
-
-  # ========================================================================= #
-  # === feedback_extra_description
-  #
-  # To trigger this method, do:
-  #
-  #    ry php edesc
-  #
-  # ========================================================================= #
-  def feedback_extra_description(
-      of_this_program = program?
-    )
-    RBT::Cookbooks::DisplayCookbookDataset::Feedback.feedback_extra_description(of_this_program)
-  end
-
-  # ========================================================================= #
-  # === feedback_all_libraries_and_all_binaries
-  #
-  # Invoke this method by issuing:
-  #
-  #   ry htop installs_what?
-  #
-  # ========================================================================= #
-  def feedback_all_libraries_and_all_binaries(
-      of_this_program = compile_which_program?
-    )
-    feedback_all_binaries(of_this_program)
-    feedback_all_libraries(of_this_program)
-  end
-
-  # ========================================================================= #
-  # === feedback_all_libraries
-  #
-  # Feedback all libraries from a given program.
-  # ========================================================================= #
-  def feedback_all_libraries(
-      from_this_program = program?
-    )
-    RBT::Cookbooks::DisplayCookbookDataset::Feedback.feedback_all_libraries(from_this_program)
-  end
-
-  # ========================================================================= #
-  # === feedback_default_values_of_the_internal_hash
-  #
-  # Invocation example from the commandline:
-  #
-  #   ry --feedback-the-default-values-of-the-internal-hash
-  #
-  # ========================================================================= #
-  def feedback_default_values_of_the_internal_hash
-    dataset = return_default_internal_hash
-    e
-    e "The following #{lightblue(dataset.keys.size.to_s)} entries are known:"
-    e
-    dataset.each_pair {|key, value|
-      if value.nil?
-        value = 'nil'
-      end
-      e "  #{slateblue(key)}: #{lightgreen(value)}"
-    }; e
-  end
-
-  # ========================================================================= #
-  # === feedback_whether_we_will_use_stow
-  #
-  # To invoke this, do:
-  #
-  #   ry --use-stow?
-  #
-  # ========================================================================= #
-  def feedback_whether_we_will_use_stow
-    opne "Will we use stow? #{royalblue(verbose_truth(use_stow?))}"
-  end
-
-  # ========================================================================= #
-  # === feedback_local_location
-  #
-  # Invoke this like:
-  #   ry htop feedback_local_location
-  # ========================================================================= #
-  def feedback_local_location(
-      i = compile_which_program?
-    )
-    RBT::Cookbooks::DisplayCookbookDataset::Feedback.feedback_local_location(i)
-  end
-
-  # ========================================================================= #
-  # === feedback_local_base
-  #
-  # Feedback which local base directory is used for a particular program.
-  # ========================================================================= #
-  def feedback_local_base(
-      i = compile_which_program?
-    )
-    RBT::Cookbooks::DisplayCookbookDataset.feedback_local_base(i)
-  end
-
-  # ========================================================================= #
-  # === feedback_last_compiled
-  #
-  # There are several ways how to invoke this method.
-  # We thus need to be rather flexible about feedbacking this to the
-  # user.
-  #
-  # One of the first distinctions will be whether we have a '=' token
-  # in the input or whether we do not.
-  #
-  # Examples:
-  #
-  #   rbt --last-compiled?
-  #   rbt --last-5-compiled?
-  #   rbt --last-five-compiled?
-  #   rbt --last-compiled?=5
-  #   rbt --last-compiled?=6
-  #
-  # ========================================================================= #
-  def feedback_last_compiled(
-      i = :all_of_them
-    )
-    i = i.first if i.is_a? Array # Grab the first entry.
-    # ======================================================================= #
-    # Next, we determine the dataset of which programs have been compiled.
-    # ======================================================================= #
-    dataset = compiled_programs?
-    dataset = dataset.keys if dataset.respond_to? :keys
-    case i
-    when :all_of_them
-      i = dataset.size
-    end
-    unless dataset
-      opne 'No dataset was found in this file: '+sfile(file_compiled_programs?)
-      return
-    end
-    show_n_programs = 1 # This is the default.
-    if i.to_s =~ /^\d+$/
-      show_n_programs = i.to_i
-    end
-    if i and i.to_s.include?('=')
-      splitted = i.split('=')
-      show_n_programs = splitted.last.to_i
-    elsif (show_n_programs > 1)
-      # pass through in this case
-    else # Else it does not include a '='.
-      regex_to_use = /--last(-\d+-)compiled\?/
-      i =~ regex_to_use
-      show_n_programs = $1.to_s.dup.delete('-').to_i if $1
-      array = HASH_ENGLISH_NUMBERS.keys
-      if array.any? {|entry| i.include? entry }
-        result = array.select {|entry| i.include? entry }
-        result = result.first unless result.empty?
-        # =================================================================== #
-        # Now we must convert this:
-        # =================================================================== #
-        result = HASH_ENGLISH_NUMBERS[result]
-        show_n_programs = result.to_i
-      end
-    end
-    # ======================================================================= #
-    # Narrow our dataset down.
-    # ======================================================================= #
-    if show_n_programs > dataset.size
-      opne 'We have not kept track of that many ('+
-            sfancy(show_n_programs.to_s)+') registered programs, so'
-      opne "only #{dataset.size.to_s} programs will be shown instead."
-      show_n_programs = dataset.size
-    end
-    dataset = dataset.reverse[0 .. (show_n_programs - 1)].reverse
-    e
-    opne "The last #{simp(show_n_programs.to_s)} compiled "\
-         "programs (most recent one comes first) were:"
-    # ======================================================================= #
-    # Now we can report this dataset, which contains our programs.
-    # ======================================================================= #
-    e; dataset.reverse.each {|key|
-      e "  #{sfancy(key)}"
-    }; e
-  end
-
-  # ========================================================================= #
-  # === feedback_dependencies_of_this_program
-  #
-  # Feedback the dependencies of a given program through this method.
-  #
-  # Invocation example:
-  #
-  #   ry pango --feedback_dependencies_of_this_program
-  #
-  # ========================================================================= #
-  def feedback_dependencies_of_this_program(
-      i = compile_which_program?
-    )
-    if dataset?.nil?
-      ensure_proper_dataset(i)
-    end
-    dependencies = dataset?.deps_on?
-    unless dependencies.empty?
-      cliner
-      opne 'The following dependencies were found for `'+sfancy(i)+'`:'
-      e
-      # =================================================================== #
-      # We will next assume that dependencies is an Array.
-      # =================================================================== #
-      dependencies.each {|dep|
-        e "  A dependency on: #{olivedrab(dep)}"
-      }
-      e
-      cliner
-    else
-      opne "No dependency was found for `#{sfancy(i)}`."
-    end
-  end; alias feedback_dependencies                feedback_dependencies_of_this_program # === feedback_dependencies
-       alias feedback_dependencies_of_the_program feedback_dependencies_of_this_program # === feedback_dependencies_of_the_program
-
-  # ========================================================================= #
-  # === feedback_program_version
-  # ========================================================================= #
-  def feedback_program_version
-    RBT::Cookbooks::DisplayCookbookDataset::Feedback.feedback_program_version(program?)
-  end
-
-  # ========================================================================= #
-  # === feedback_whether_the_cookbook_will_modify_env_variables
-  # ========================================================================= #
-  def feedback_whether_the_cookbook_will_modify_env_variables(
-      compile_this_program = compile_which_program?
-    )
-    _ = set_env_variables?
-    if is_this_program_registered?(compile_this_program)
-      if _.nil?
-        opne "The program #{sfancy(compile_this_program)} does not "\
-             "set any ENV variable."
-      else
-        opne 'The program '+sfancy(compile_this_program)+' will '\
-             'modify at the least one ENV variable.'
-        opne 'Displaying these next:'
-        e
-        set_these_env_variables(_, :report_only)
-        e
-      end
-    else
-      opne 'No program with that name is known.'
-    end
-  end
-
-  # ========================================================================= #
-  # === do_extensively_report_the_build_statistics
-  # ========================================================================= #
-  def do_extensively_report_the_build_statistics
-    report_the_compile_strategies
-    unless RBT.respond_to? :show_how_many_files_are_tracked
-      require 'rbt/statistics/show_how_many_files_are_tracked.rb'
-    end
-    # ======================================================================= #
-    # Since as of July 2020 we will also show how many files are tracked.
-    # ======================================================================= #
-    RBT.show_how_many_files_are_tracked
-  end
-
-  # ========================================================================= #
-  # === show_all_binaries_of_this_program
-  #
-  # Use this method to show the registered binaries of the input-argument,
-  # the given program at hand. This will display these binaries in one
-  # line, as a "Hash".
-  #
-  # Invocation example:
-  #
-  #   rbt binutils --binaries-as-one-line?
-  #
-  # ========================================================================= #
-  def show_all_binaries_of_this_program(
-      this_program = compile_which_program?,
-      report_how   = :one_line_per_program # The only other mode is :report_in_one_line
-    )
-    case this_program
-    # ======================================================================= #
-    # === :default
-    # ======================================================================= #
-    when :default
-      this_program = compile_which_program?
-    end
-    if dataset?.nil?
-      ensure_that_a_dataset_exists_for_this_program(this_program)
-    end
-    _ = binaries? # Grab the registered binaries here.
-    if _.empty?
-      opne "No binaries/executables appear to be registered for "\
-           "the program `#{sfancy(this_program)}`."
-    else
-      case report_how
-      when :one_line_per_program,
-           :default
-        e; _.each_with_index {|this_binary, index| index += 1
-          index = "  #{slateblue((index.to_s+') ').rjust(5))}"
-          e "#{index}#{sfancy(this_binary)}"
-        }; e
-      else # else we use another mode.
-        result = '{'.dup
-        result << _.join(',')
-        result << '}'
-        e result
-      end
-    end
-  end; alias feedback_all_binaries show_all_binaries_of_this_program # === feedback_all_binaries
-
-  require 'rbt/utility_scripts/blfs.rb'
-  # ========================================================================= #
-  # === report_all_blfs_entries
-  # ========================================================================= #
-  def report_all_blfs_entries
-    RBT::Blfs.new(:run_everything)
-  end
-
-  require 'rbt/utility_scripts/url.rb'
-  # ========================================================================= #
-  # === feedback_url
-  #
-  # Wrapper around Cookbooks functionality.
-  #
-  # Usage example:
-  #
-  #   rbt htop url?
-  #
-  # ========================================================================= #
-  def feedback_url(
-      i = compile_which_program?
-    )
-    RBT::Cookbooks::Url.new(i)
-    # ======================================================================= #
-    # The next line of code has been commented out at 21.09.2018:
-    # ======================================================================= #
-    # ::RBT::Cookbooks::DisplayCookbookDataset.feedback_url.feedback_url(compile_which_program?)
-    # ======================================================================= #
-    # The next part may be controversial, as it sets the xorg buffer.
-    # As of May 2014 it was disabled.
-    # ======================================================================= #
-    #   result = @cookbooks.feedback_url
-    #   set_xorg_buffer(result)
-  end
-
-  require 'rbt/misc/reverse_dependencies.rb'
-  # ========================================================================= #
-  # === feedback_expanded_dependencies_of_this_program
-  # ========================================================================= #
-  def feedback_expanded_dependencies_of_this_program(
-      i = compile_which_program?
-    )
-    e rev+'The expanded dependencies for '+steelblue(i)+' are:'
-    e
-    RBT::ReverseDependencies.dependencies?(i).each {|entry|
-      e "  #{entry}"
-    }
-    e
-  end
-
-  # ========================================================================= #
-  # === feedback_all_available_formats
-  #
-  # Invocation example:
-  #
-  #   ry --feedback_all_available_formats
-  #
-  # ========================================================================= #  
-  def feedback_all_available_formats
-    require 'rbt/requires/require_the_cookbook_class.rb'
-    RBT::Cookbooks::SanitizeCookbook.feedback_all_available_formats
-  end
-
-  # ========================================================================= #
-  # === show_pc_files_installed_by_this_program
-  #
-  # Invocation example:
-  #
-  #   ry samba --pkgconfig-files?#
-  # ========================================================================= #
-  def show_pc_files_installed_by_this_program(
-      i = compile_which_program?
-    )
-    _ = pc_files?
-    if _.empty?
-      opne 'The program '+simp(i)+' will not install any .pc file.'
-    else
-      opne "The program #{gold(i)} will install "\
-           "the following #{sfancy(_.size.to_s)} .pc file(s):"
-      e; _.each {|this_pc_file|
-        e "  #{sfancy(this_pc_file)}"
-      }; e
-    end
-  end
-
-  # ========================================================================= #
-  # === show_n_largest_local_programs
-  #
-  # Show the largest local programs with this method.
-  #
-  # Invocation example:
-  #
-  #   ry --show_highest
-  #
-  # ========================================================================= #
-  def show_n_largest_local_programs(
-      i = :default
-    )
-    require 'rbt/cookbooks/highest.rb'
-    case i
-    when :default
-      i = 50
-    end
-    RBT::Cookbooks::Highest.new(i)
-    exit_program
-  end
-
-  # ========================================================================= #
-  # === show_all_about_this_dir
-  # ========================================================================= #
-  def show_all_about_this_dir(
-      i = return_pwd
-    )
-    _ = File.basename(i)
-    _ = program_information_return_short_name(i).delete('-')
-    show_all_about(_) # Delegate to that method here.
-  end
-
-  begin # On my system only so far.
-    require 'roebe/toplevel_methods/human_readable.rb'
-  rescue LoadError; end
-  # ========================================================================= #
-  # === report_size_of_these_programs
-  #
-  # This method will report the size of the issued programs.
-  #
-  # The programs are to be given as the first argument to this method,
-  # ideally as an Array.
-  # ========================================================================= #
-  def report_size_of_these_programs(
-      i, size_of_the_programs = 0
-    )
-    if i.is_a? String and i.include?('=')
-      i = i.to_s.dup if i.frozen?
-      i.gsub!(/--size=/,'')
-      i = i.split(',') if i.include? ','
-    end
-    i = [i] unless i.is_a? Array
-    i.each {|entry|
-      dataset = self.new(entry)
-      unless use_colours?
-        dataset.disable_colours
-      end
-      size = dataset.size?.to_i
-      opnn; e "Now working on #{sfancy(entry.rjust(8))}"\
-              " (Size: #{size.to_s.rjust(8)} bytes)"
-      size_of_the_programs += size
-    }
-    e
-    opnn; e 'The size of the programs '+sfancy(i.join(','))+' is:'
-    e
-    if Object.const_defined?(:Roebe) and
-       Roebe.const_defined?(:HumanReadable)
-      size_of_the_programs = Roebe::HumanReadable[size_of_the_programs]
-    end
-    result = "  #{simp(size_of_the_programs.to_s)}".dup
-    result << ' bytes' unless size_of_the_programs.to_s.strip.end_with? 'B'
-    opnn; e result
-    e
-  end
-
-  # ========================================================================= #
-  # === show_path_to_the_source_directory_yaml_file
-  #
-  # This method will simply show the path to the source_dir.yml
-  # file.
-  #
-  # Usage example:
-  #
-  #   rbt --path_to_source_directory?
-  #
-  # ========================================================================= #
-  def show_path_to_the_source_directory_yaml_file
-    _ = RBT.project_yaml_directory?+'configuration/source_dir.yml'
-    e sfile(_)
-  end
-
-  # ========================================================================= #
-  # === show_the_n_last_updated_programs
-  # ========================================================================= #
-  def show_the_n_last_updated_programs(
-      i = 875
-    )
-    require 'rbt/cookbooks/show_last_updated.rb'
-    RBT::Cookbooks::ShowLastUpdated.new(display_n_programs: i)        
-  end
-
-  # ========================================================================= #
-  # === show_components
-  #
-  # Invocation example:
-  #
-  #   ry --show-components=xfce
-  #
-  # ========================================================================= #
-  def show_components(i)
-    i = i.to_s # Just in case.
-    chained_programs = return_chained_programs
-    if chained_programs.has_key? i
-      _ = chained_programs[i]
-      e
-      e "#{rev}These components belong to #{steelblue(i)}:"
-      e
-      _.each_with_index {|this_program, index| index += 1
-        e lightgreen("  #{index}) ".rjust(6))+
-          steelblue(this_program)
-      }
-      e
-    else
-      opne 'No component with that name could be found.'
-      opne 'Available keys are:'
-      e
-      e royalblue(
-          chained_programs.keys.join(', ').strip.chop
-        )
-      e
-    end
-  end
-
-  require 'rbt/utility_scripts/show_compile_chain.rb'
-  # ========================================================================= #
-  # === show_compile_chain
-  #
-  # Show all members of a particular compile-chain.
-  #
-  # Invocation examples:
-  #
-  #   ry --show-chain=plasma
-  #   ry --show-compile-chain-of=kde5_plasma
-  #   ry --compile-chain-of=kde5_plasma
-  #   ry --view=kde5_plasma
-  #   ry --view=xfce
-  #
-  # ========================================================================= #
-  def show_compile_chain(i)
-    ShowCompileChain.of(i)
-  end
-
-  # ========================================================================= #
-  # === show_all_locally_available_programs
-  #
-  # Invocation example:
-  #
-  #    rbt --locally-available-programs?
-  #
-  # ========================================================================= #
-  def show_all_locally_available_programs(
-      slice_n_chunks = 3
-    )
-    programs_dir = programs_dir?
-    all_dirs = Dir[programs_dir+'*'].select {|entry| File.directory? entry }
-    all_dirs.map! {|entry|
-      use_this_regex = /^#{programs_dir}/
-      entry = entry.sub(use_this_regex,'')
-      entry # .downcase # To downcase or not to downcase.
-    }
-    n_programs = all_dirs.size.to_s
-    opne "The locally available `#{orange(n_programs)}` programs are:"
-    sliced = all_dirs.each_slice(slice_n_chunks)
-    result = '  '.dup
-    sliced.each {|inner_group_array|
-      joined = inner_group_array.map {|entry|
-        (entry+',').ljust(25)
-      }.join
-      result << '  '+sfancy(joined.strip).delete(',')+N
-    }
-    result = result.strip.chop.chomp.strip
-    result.sub!(/,\e\[0;37$/, '.') # Reformat it.
-    e
-    e result
-    e
-  end
-
-  # ========================================================================= #
-  # === show_rbt_intro
-  #
-  # Invocation example:
-  #
-  #   ry --show-rbt-intro
-  #   ry --intro
-  #
-  # ========================================================================= #
-  def show_rbt_intro
-    e
-    e 'Here are some hints to get you started with RBT.'
-    e
-    e "You can compile a program by issuing #{orange('rbt <name>')}."
-    e
-    e 'Example:'
-    e
-    e sfancy('  rbt php')
-    e
-    e 'You can also compile into a standalone app-dir:'
-    e
-    e sfancy('  rbt php ntrad')
-    e sfancy('  rbt php --app-dir')
-    e
-    e 'Both variants are synonymous. If in doubt, using the variants'
-    e 'that start with '+teal('--')+' is recommended.'
-    e
-    e 'To speed-up looking for the dataset stored in the various .yml'
-    e 'files you can also issue the following command:'
-    e
-    e sfancy('  rbt --expand')
-    e
-    e 'This command will expand the dataset into a "sanitized" variant'
-    e 'that requires less pre-processing before it can be used for'
-    e 'compiling/installing programs from source.'
-    e
-  end
-
-  # ========================================================================= #
-  # === report_n_programs
-  #
-  # Report how many programs (cookbook files) are currently registered in
-  # the RBT project.
-  #
-  # Commandline-invocation example:
-  #
-  #   rbt --report-n-programs
-  #
-  # ========================================================================= #
-  def report_n_programs
-    RBT.report_the_registered_programs
-  end
-
-  # ========================================================================= #
-  # === report_finished_installing_this_program
-  #
-  # Report that we have finished compiling the program.
-  # ========================================================================= #
-  def report_finished_installing_this_program(
-      i = compile_this_program?
-    )
-    unless do_not_compile?
-      unless problem? || an_error_has_occurred?
-        opne "Finished installing the program `#{sfancy(i)}`."
-      end
-    end
-  end
-
-  # ========================================================================= #
-  # === report_where_we_will_store_logs
-  #
-  # This will ask where we store our BT-Related files. The Config object
-  # defines that.
-  #
-  # To trigger this, do:
-  #
-  #   ry --store_where?
-  #
-  # ========================================================================= #
-  def report_where_we_will_store_logs
-    opne "Log-files will be stored into the directory `"\
-         "#{sdir(log_dir?)}`."
-  end; alias store_where? report_where_we_will_store_logs # === store_where?
-
-  # ========================================================================= #
-  # === show_success_or_failure_status (success tag, failure tag, status tag)
-  #
-  # This method will report some things, aka the success or failure status
-  # of a program.
-  # ========================================================================= #
-  def show_success_or_failure_status
-    # ======================================================================= #
-    # Report the following only if the program has been installed
-    # successfully.
-    # ======================================================================= #
-    if has_the_program_been_installed_successfully?
-      opne "The host system architecture was: "\
-           "#{slateblue(host_system?)}"
-      if is_a_gem?
-        # =================================================================== #
-        # If it is a .gem file then we will not report as much information.
-        # =================================================================== #
-        opne teal('The program ')+
-             lightgreen(compile_which_program?)+
-             teal(' has been installed successfully.')
-      else
-        _ = return_full_configure_command
-        if _.nil? or _.empty?
-          # ================================================================= #
-          # This entry-point is specifically for e. g. perl-addons and
-          # similar programs.
-          # ================================================================= #
-          opne teal('The program ')+lightgreen(compile_which_program?)+
-               teal(' has been installed successfully.')
-        else
-          opne teal('The program ')+lightgreen(compile_which_program?)+
-               teal(' has been installed successfully, into the prefix')
-          opne plum(prefix?.to_s)+
-               teal('. The full configure command was:')
-          e
-          e "  #{slateblue(return_full_configure_command)}"
-          e
-        end
-      end
-    else
-      # ===================================================================== #
-      # Else the program has failed during compilation/installation.
-      # ===================================================================== #
-      opne crimson(
-             return_unicode_warning_symbol_or_empty_string+' The program `'
-           )+
-           teal(compile_which_program?)+
-           crimson(
-             '` could not be installed. '+
-             return_unicode_warning_symbol_or_empty_string
-           )
-    end
-  end; alias report_status show_success_or_failure_status # === report_status
-
-  # ========================================================================= #
-  # === show_all_about
-  #
-  # This method will show the full content of a specific .yml file.
-  #
-  # To invoke this method, do something like the following:
-  #
-  #   ry htop show_all
-  #
-  # ========================================================================= #
-  def show_all_about(
-      show_this_program = search_for_this_program? # or internal_program_name?
-    )
-    require 'rbt/utility_scripts/show_all_about.rb'
-    RBT::ShowAllAbout.new(show_this_program)
-  end; alias show_all show_all_about # === show_all
-
-end; end