Class: RBT::ConfigLogParser

Inherits:
Base show all
Defined in:
lib/rbt/utility_scripts/config_log_parser.rb

Overview

RBT::ConfigLogParser

Constant Summary collapse

THIS_FILE =
#

THIS_FILE

#
'config.log'
CHROOT_TARGET =
#

CHROOT_TARGET

#
'/Depot/Chroot/'
USR_INCLUDE =
#

USR_INCLUDE

#
'/usr/include/'
TRY_TO_AUTOCORRECT_HEADER_FILES =
#

TRY_TO_AUTOCORRECT_HEADER_FILES

If the following constant is set to true, then we will attempt to copy missing .h files into the /Depot/Chroot/usr/include/ hierarchy.

#
true
REGEX_FOR_MISSING_HEADER_FILES =
#

RBT::ConfigLogParser::REGEX_FOR_MISSING_HEADER_FILES

#
/error: (.+.h): No such file or directory/

Constants inherited from LeanPrototype

LeanPrototype::ALL_COLOUR_METHODS, LeanPrototype::ARRAY_KDE_KONSOLE_COLOURS_IN_USE, LeanPrototype::DAY_NAMES, LeanPrototype::NAMESPACE, LeanPrototype::SILENT_REDIRECTION

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Base

#cat, #cd_back_to_the_current_working_directory, #consider_reporting_how_many_programs_are_registered, #cookbook_files?, #copy_recursively, #delete_code_of_conduct?, #determine_appdir_prefix_from_this_input, #directory_validation?, #do_not_show_names, #fast_return_file_size_of_this_program, #file_last_symlinked_program?, #file_programs_version_url, #gem_version, #is_a_64bit_system?, #is_ccache_available?, #is_porg_available?, #is_this_binary_registered?, #is_this_program_included?, #make_command?, #make_install_command?, #new_cookbook_instance_for, #program_exists?, #publish_list_of_all_programs_version, #rcp, registered_binaries?, #remove_symlink, #rename_kde_konsole_tab, #repackage, #report_n_programs, #report_working_directory, #return_compile_time_statistics, #return_n_random_characters, #return_version_of_this_program, #run_make_then_make_install, #sanitize_url1_entry, #set_source_directory, #show_overview_over_available_utility_scripts, #symlink_all_files_from_this_directory_to_that_directory, #system_tags?, #upload_list_of_all_programs_version, #use_yaml_database_for_tags?, #warn_and_exit, #wget

Methods inherited from LeanPrototype

#a_or_an?, #abbreviations?, #absolute_path, #action, #add_to_the_commandline_arguments, #all_binaries?, #all_files_from, #all_libraries?, #allowed_cookbook_entries?, #appdir_location_of?, #append_onto_the_internal_hash, #append_what_into, #archive_type_of?, #available_programs?, #be_quiet?, #be_verbose?, #begins_with_a_comment?, #capitalize_first_alphabetical_character, #cd_to_the_log_directory, #cd_to_the_temp_directory, #change_directory, #change_permission, #cheering_person?, #chmod, #chop_off_archive, #clear_commandline_options, #cliner, #coloured_and_padded_e, #coloured_and_padded_esystem, #coloured_esystem, #colourize_directory_for_system_results, #colourize_this_error, #colourize_this_file_path, #colourize_this_warning, #commandline_arguments?, #commandline_arguments_without_hyphens?, #comment, #convert_dd_mm_yyyy_to_its_long_variant, #convert_env_variable, #copy_directory, #copy_files, #cpr, #create_directory, #current_hour?, #dd_mmm_yyy, #debug, #debug?, #directory_expanded_cookbooks?, #disable_colours, #display_md5sum?, #do_not_debug, #does_the_cookbook_include_this_program?, #does_this_expanded_cookbook_file_exist_for_this_program?, #does_this_file_exist?, #does_this_file_exist_and_is_it_a_file?, #e, #eblue, #ecomment, #ecrimson, #edir, #editor?, #efancy, #eimp, #enable_colours, #enable_debug, #ensure_main_encoding_for, #eparse, #esystem, #esystem_gold, #etomato, #ewarn, #exit_program, #expanded_cookbooks_directory_exists?, #extract_this_archive, #extract_to?, #file_compiled_programs?, #file_dirname_retaining_trailing_slash, #file_predefined_installation_instructions?, #file_specification_of_registered_cookbook_entries, #find_cookbook_alias_for, #find_this_yaml_file, #first_argument?, #first_non_hyphen_argument?, #get_all_directories_from, #get_all_files_from, #get_all_programs, #get_date, #get_extended_date, #get_files_and_directories_from, #go_to_base_dir, #home_dir?, #host_system?, #infer_the_namespace, #internal_hash?, #internal_hash_set_commandline_arguments, #is_an_archive?, #is_directory?, #is_file?, #is_github_url?, #is_make_available?, #is_on_gobolinux?, #is_on_windows?, #is_roebe?, #is_superuser?, #is_symlink?, #is_this_a_header?, #is_this_a_library?, #is_this_program_included?, #iso_encoding?, #load_dataset_from_this_expanded_cookbook, #load_yaml, #load_yaml_file_from_the_cookbook_directory_for_this_program, #log_directory?, #main_encoding?, #meson_build_file_exists?, #months?, #move_file, #n_programs_are_available?, #n_programs_available?, #namespace?, #no_directory_exists_at, #no_opn, #no_such_file_exists, #open_in_browser, #open_in_editor, #opncomment, #opne, #opnef, #opnerev, #opnerror, #opnesystem, #opnewarn, #opnfancy, #opnn, #packages_directory?, #path_to_this_expanded_cookbooks_dataset, #pkgconfig_directory?, #populate_the_internal_hash_with_default_values, #predefined_installation_instructions?, #prepend_this_commandline_argument, #program_version_of?, #project_base_directory?, #project_yaml_directory?, #query_path?, #rarrow?, #read_file, #read_file_in_default_encoding, #read_file_with_default_encoding, #readlines, #readlines_with_proper_encoding, #register_sigint, #registered_cookbook_entries?, #remove, #remove_archive_from_the_end, #remove_comments_from_each_line, #remove_directory, #remove_double_slashes, #remove_file, #remove_newlines, #remove_parens, #remove_symlink, #remove_this_commandline_argument, #remove_this_entry_from_the_commandline_arguments, #remove_trailing_ANSII_escape_code, #remove_unnecessary_data_from_url, #rename, #report_pwd, #require_the_rbt_aliases, #reset_the_internal_hash, #return_all_archives_from_this_directory, #return_appdir_prefix, #return_commandline_arguments_with_leading_hyphens, #return_current_hour_minutes_second, #return_date, #return_day_of_the_month_based_on_utc, #return_full_time, #return_hours_minutes_seconds_based_on_utc, #return_location_to_this_programs_yaml_file, #return_month_based_on_this_number, #return_month_based_on_utc, #return_opnn, #return_program_information, #return_program_name_for_gobolinux_systems, #return_pwd, #return_unicode_warning_symbol_or_empty_string, #return_utc, #return_utc_time_in_a_format_similar_to_slackware, #return_weekday_based_on_utc, #return_year_based_on_utc, #rev, #run_simulation=, #run_simulation?, #sdir, #sdir_return_pwd, #set_be_silent, #set_be_verbose, #set_first_commandline_argument, #set_namespace, #set_use_opn, #set_xorg_buffer, #sfancy, #sfile, #silent_redirection?, #silently_create_this_directory_if_it_does_not_yet_exist, #simp, #source_base_directory?, #ssym, #stderr, #store_into_this_directory?, #string_right_arrow?, #swarn, #symlink, #sysbin_directory?, #sysetc_directory?, #sysinclude_directory?, #syslib_directory?, #sysshare_directory?, #system_directory?, #temp_directory?, #to_bool, #to_camelcase, #to_iso_encoding, #to_unicode, #today?, #touch, #try_to_require_beautiful_url, #try_to_require_the_environment_information_gem, #try_to_require_the_extracter_gem, #try_to_require_the_open_gem, #try_to_require_the_xorg_buffer, #try_to_require_wget, #try_to_return_a_special_compile_component, #unicode_cliner, #unicode_middle_cliner, #use_colours=, #use_colours?, #use_opn=, #use_opn?, #utf_encoding?, #verbose_truth, #word_wrap, #write_what_into, #write_what_into_via_unicode, #yes_or_no

Constructor Details

#initialize(this_file = ARGV, run_already = true) ⇒ ConfigLogParser

#

initialize

#


63
64
65
66
67
68
69
70
71
72
# File 'lib/rbt/utility_scripts/config_log_parser.rb', line 63

def initialize(
    this_file   = ARGV,
    run_already = true
  )
  reset
  set_this_file(
    this_file
  )
  run if run_already
end

Class Method Details

.[](i = ARGV) ⇒ Object

#

RBT::ConfigLogParser[]

#


263
264
265
# File 'lib/rbt/utility_scripts/config_log_parser.rb', line 263

def self.[](i = ARGV)
  new(i)
end

Instance Method Details

#consider_copying_this_header_file(i = missing_header_files? ) ⇒ Object

#

consider_copying_this_header_file

#


162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
# File 'lib/rbt/utility_scripts/config_log_parser.rb', line 162

def consider_copying_this_header_file(
    i = missing_header_files?
  )
  if i.is_a? Array
    i.each {|entry| consider_copying_this_header_file(entry) }
  else
    if TRY_TO_AUTOCORRECT_HEADER_FILES
      regex = REGEX_FOR_MISSING_HEADER_FILES
      i =~ regex
      target = $1.to_s.dup
      from = "#{USR_INCLUDE}#{target}"
      to   = (CHROOT_TARGET+USR_INCLUDE+target).squeeze('/')
      unless File.exist? to
        if File.exist? from
          e "Trying to autocorrect this error next. "\
             "(From: #{sfile(from)} | To: #{sfile(to)})"
          copy_file(from, to, :be_verbose)
        else
          no_file_exists_at(from)
        end
      end
    end
  end
end

#missing_header_files?Boolean

#

missing_header_files?

#

Returns:

  • (Boolean)


155
156
157
# File 'lib/rbt/utility_scripts/config_log_parser.rb', line 155

def missing_header_files?
  @missing_header_files
end

#report_resultsObject Also known as: report

#

report_results

#


202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
# File 'lib/rbt/utility_scripts/config_log_parser.rb', line 202

def report_results
  # ======================================================================= #
  # First, check whether there are any missing header files.
  # ======================================================================= #
  unless @missing_header_files.empty?
    e rev+'These '+royalblue('header files')+' are missing:'; e
    @missing_header_files.each {|file|
      e "  #{sfile(file)}"
      consider_copying_this_header_file(file)
    }; e
  end
  # ======================================================================= #
  # === Report missing shared libraries next:
  # ======================================================================= #
  unless @missing_shared_libraries.empty?
    e rev+'These '+royalblue('shared libraries')+' appear to be missing:'
    e
    @missing_shared_libraries.each {|file|
      e '  '+sfile(file)
      # consider_copying_this_header_file(file)
    }; e
  end
end

#resetObject

#

reset (reset tag)

#


77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
# File 'lib/rbt/utility_scripts/config_log_parser.rb', line 77

def reset
  super()
  infer_the_namespace
  # ======================================================================= #
  # === @dataset
  # ======================================================================= #
  @dataset = nil
  # ======================================================================= #
  # === @missing_header_files
  # ======================================================================= #
  @missing_header_files = [] # Keep track of missing .h files.
  # ======================================================================= #
  # === @missing_shared_libraries
  # ======================================================================= #
  @missing_shared_libraries = []
end

#runObject

#

run (run tag)

#


229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
# File 'lib/rbt/utility_scripts/config_log_parser.rb', line 229

def run
  opnn { :no_trailing }
  e
  e
  _ = @this_file
  if _.nil?
    # ===================================================================== #
    # This, for now, can only happen if you input the instruction
    # :do_not_use_any_input_file is used. For now we do absolutely
    # nothing in this case.
    # ===================================================================== #
  else
    if File.exist? _ # The file is 'config.log'
      @dataset = File.readlines(_)
      # =================================================================== #
      # Ok, now we have the full dataset.
      # First, we scan for missing header files.
      # =================================================================== #
      scan_for_missing_header_files
      # =================================================================== #
      # Then we scan for missing shared libraries.
      # =================================================================== #
      scan_for_missing_shared_libraries
      scan_for_erroneous_assembler_messages
    else
      no_file_exists_at(_)
    end
    report_results
  end
end

#scan_for_erroneous_assembler_messagesObject

#

scan_for_erroneous_assembler_messages

These assembler-messages are typically generated by binutils.

#


192
193
194
195
196
197
# File 'lib/rbt/utility_scripts/config_log_parser.rb', line 192

def scan_for_erroneous_assembler_messages
  if @dataset.any? {|line| line.include? '.s: Assembler messages:' }
    e 'Some problem with Assembler-messages ('+
      steelblue('binutils')+')'
  end
end

#scan_for_missing_header_filesObject

#

scan_for_missing_header_files

This method will scan for missing .h files.

#


123
124
125
126
127
128
129
130
131
132
133
# File 'lib/rbt/utility_scripts/config_log_parser.rb', line 123

def scan_for_missing_header_files
  set_missing_header_files @dataset.select {|line|
    # ===================================================================== #
    # The next line is valid for entries such as:
    #   include/stdio.h:164:10: fatal error: bits/stdio_lim.h: No such file or directory
    # ===================================================================== #
    line.include?('.h') and
    line.include?('fatal error:') and
    line.include?('No such file or directory')
  }
end

#scan_for_missing_shared_librariesObject

#

scan_for_missing_shared_libraries

#


138
139
140
141
142
143
# File 'lib/rbt/utility_scripts/config_log_parser.rb', line 138

def scan_for_missing_shared_libraries
  _ = @dataset.select {|line|
    line.include?('error while loading shared libraries:')
  }
  @missing_shared_libraries = _
end

#set_missing_header_files(i) ⇒ Object

#

set_missing_header_files

#


148
149
150
# File 'lib/rbt/utility_scripts/config_log_parser.rb', line 148

def set_missing_header_files(i)
  @missing_header_files = i
end

#set_this_file(i = THIS_FILE) ⇒ Object

#

set_this_file

#


97
98
99
100
101
102
103
104
105
106
107
108
109
# File 'lib/rbt/utility_scripts/config_log_parser.rb', line 97

def set_this_file(
    i = THIS_FILE
  )
  i = i.first if i.is_a? Array
  i = THIS_FILE if i.nil?
  case i
  when :do_not_use_any_input_file
    @this_file = nil
  else
    i = i.to_s.dup
  end
  @this_file = i
end

#this_file?Boolean

#

this_file?

#

Returns:

  • (Boolean)


114
115
116
# File 'lib/rbt/utility_scripts/config_log_parser.rb', line 114

def this_file?
  @this_file
end