Class: RBT::Action::MapThisInputToThatRegisteredProgram

Inherits:
RBT::Action show all
Defined in:
lib/rbt/actions/individual_actions/map_this_input_to_that_registered_program/map_this_input_to_that_registered_program.rb

Overview

RBT::Action::MapThisInputToThatRegisteredProgram

Constant Summary

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 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_arguments, #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_meson_installed?, #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_directory_was_found_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_the_first_commandline_argument, #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(commandline_arguments = nil, run_already = true) ⇒ MapThisInputToThatRegisteredProgram

#

initialize

#


48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/rbt/actions/individual_actions/map_this_input_to_that_registered_program/map_this_input_to_that_registered_program.rb', line 48

def initialize(
    commandline_arguments = nil,
    run_already           = true
  )
  reset
  set_commandline_arguments(
    commandline_arguments
  )
  # ======================================================================= #
  # === Handle blocks next:
  # ======================================================================= #
  if block_given?
    yielded = yield
    case yielded
    # ===================================================================== #
    # === :be_quiet
    # ===================================================================== #
    when :be_quiet
      set_be_quiet
    end
  end
  run if run_already
end

Class Method Details

.[](i = ARGV) ⇒ Object

#

RBT::Action::MapThisInputToThatRegisteredProgram[]

This method will return nil if no registered program has been found for the given input. Otherwise it will return the real name of the program at hand.

.h files work as input as well.

Usage examples:

x = RBT::Action::MapThisInputToThatRegisteredProgram[:php]
x = RBT::Action::MapThisInputToThatRegisteredProgram[:gee]
x = RBT::Action::MapThisInputToThatRegisteredProgram[:foobar]
x = RBT::Action::MapThisInputToThatRegisteredProgram['stdio.h']
x = RBT::Action::MapThisInputToThatRegisteredProgram[:soxi] # => "sox"
#


322
323
324
 
# File 'lib/rbt/actions/individual_actions/map_this_input_to_that_registered_program/map_this_input_to_that_registered_program.rb', line 322

def self.[](i = ARGV)
  new(i) { :be_quiet }.real_program_name?
end

Instance Method Details

#real_program_name? ⇒ Boolean Also known as: return_possible_match

#

real_program_name?

#

Returns:

  • (Boolean) 


300
301
302
 
# File 'lib/rbt/actions/individual_actions/map_this_input_to_that_registered_program/map_this_input_to_that_registered_program.rb', line 300

def real_program_name?
  @real_program_name
end

#reset ⇒ Object Also known as: clear

#

reset (reset tag)

#


75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/rbt/actions/individual_actions/map_this_input_to_that_registered_program/map_this_input_to_that_registered_program.rb', line 75

def reset
  super()
  infer_the_namespace
  # ======================================================================= #
  # === :be_verbose
  # ======================================================================= #
  set_be_verbose
  # ======================================================================= #
  # === @real_program_name
  #
  # This is always nil on startup.
  # ======================================================================= #
  @real_program_name = nil
  # ======================================================================= #
  # === @type
  #
  # @type can be :abbreviation, :library, :header, :pkgconfig_file,
  # :partial_header or a similar entry.
  # ======================================================================= #
  @type = nil
end

#run ⇒ Object

#

run (run tag)

#


117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
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
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
 
# File 'lib/rbt/actions/individual_actions/map_this_input_to_that_registered_program/map_this_input_to_that_registered_program.rb', line 117

def run
  i = first_argument?.to_s # Must work on a String.
  # ======================================================================= #
  # === Handle the real names
  # ======================================================================= #
  if RBT.is_this_a_registered_program?(i)
    @real_program_name = i
    if be_verbose?
      e "#{i} is a registered program."
    end
  # ======================================================================= #
  # === Handle input that incorrectly starts with "lib".
  #
  # Next, we handle input given to this class like "libcryptsetup",
  # which should really just be "cryptsetup" instead.
  # ======================================================================= #
  elsif i.start_with?('lib') and RBT.is_this_a_registered_program?(i.sub(/^lib/,''))
    @real_program_name = i.sub(/^lib/,'')
    if be_verbose?
      e "#{i} is a registered program, if the leading 'lib' prefix is dropped."
    end
    set_type :program
  # ======================================================================= #
  # === Handle abbreviations next
  # ======================================================================= #
  elsif RBT.is_this_a_registered_abbreviation?(i)
    @real_program_name = RBT.hash_aliases_to_the_available_programs?[i]
    if be_verbose?
      e "#{i} is a registered abbreviation."
      e "It points to the program called `#{@real_program_name}`." 
    end
    set_type :abbreviation
  # ======================================================================= #
  # === Handle binaries next
  #
  # Commandline usage example:
  #
  #   map_this_input_to_that_registered_program soxi
  #
  # ======================================================================= #
  elsif RBT.is_this_a_registered_binary?(i)
    @real_program_name = RBT.hash_all_binaries[i]
    if be_verbose?
      e "#{i} is a registered binary (executable)."
      e "It points to the program called `#{@real_program_name}`." 
    end
    set_type :binary
  # ======================================================================= #
  # === Handle binaries next, downcasing the input
  #
  # This entry point will find all registered binaries for all
  # available programs.
  #
  # Commandline usage example:
  #
  #   map_this_input_to_that_registered_program soxi
  #
  # ======================================================================= #
  elsif RBT.is_this_a_registered_binary?(i.downcase)
    @real_program_name = RBT.hash_all_binaries[i.downcase]
    if be_verbose?
      e "#{i.downcase} is a registered binary (executable)."
      e "It points to the program called `#{@real_program_name}`." 
    end
    set_type :binary
  # ======================================================================= #
  # === Handle binaries next, downcasing the input
  #
  # This entry point will find all registered binaries for all
  # available programs.
  #
  # Commandline usage example:
  #
  #   map_this_input_to_that_registered_program soxi
  #
  # ======================================================================= #
  elsif RBT.is_this_a_registered_binary?(i.downcase, :deep_check)
    @real_program_name = RBT.hash_all_binaries[i.downcase]
    if be_verbose?
      e "#{i.downcase} is a registered binary (executable)."
      e "It points to the program called `#{@real_program_name}`." 
    end
    set_type :binary
  # ======================================================================= #
  # === Handle libraries next
  #
  # Example:
  #
  #   map_this_input_to_that_registered_program libc.so
  #
  # ======================================================================= #
  elsif ::RBT.is_this_library_included?(i)
    this_library = RBT.this_library_to_that_program(i)
    @real_program_name = this_library
    if be_verbose?
      e "#{i} is a registered library."
      e "It points to the program called `#{@real_program_name}`." 
    end
    set_type :library
  # ======================================================================= #
  # === Handle headers next
  #
  # Commandline usage example:
  #
  #    map_this_input_to_that_registered_program udev.h
  #    map_this_input_to_that_registered_program wrap_init.h
  #
  # ======================================================================= #
  elsif RBT.is_this_header_included?(i)
    @real_program_name = RBT.all_headers?[i]
    if be_verbose?
      e "#{i} is a registered header file."
      e "It points to the program called `#{@real_program_name}`." 
    end
    set_type :header
  # ======================================================================= #
  # === Handle partial headers next
  #
  # Commandline usage example:
  #
  #    map_this_input_to_that_registered_program SMlib.h
  #
  # ======================================================================= #
  elsif RBT.is_this_partial_header_included?(i)
    selection = RBT.all_headers?.transform_keys {|entry|
      File.basename(entry)
    }
    if selection.has_key? i
      @real_program_name = selection[i]
      if be_verbose?
        e "#{i} is a registered partial header file - this means it"
        e "is in a subdirectory."
        e "It points to the program called `#{@real_program_name}`." 
      end
      set_type :partial_header
    else
      opne "#{rev}The header #{steelblue(i)} was not found, oddly enough."
    end
  # ======================================================================= #
  # === Handle .pc pkgconfig-entries next
  #
  # Commandline usage example:
  #
  #    map_this_input_to_that_registered_program xau.pc
  #
  # ======================================================================= #
  elsif RBT.is_this_pkgconfig_file_included?(i)
    @real_program_name = RBT.return_the_associated_program_for_this_pkgconfig_file(i)
    if be_verbose?
      e "#{i} is a registered .pc pkg-config file."
      e "It points to the program called `#{@real_program_name}`." 
    end
    set_type :pkgconfig_file
  # ======================================================================= #
  # === Handle partial headers next
  #
  # Commandline usage example:
  #
  #    map_this_input_to_that_registered_program wrap_init.h
  #
  # ======================================================================= #
  elsif RBT.is_this_partial_header_included?(i)
    _ = RBT.all_headers?
    # ===================================================================== #
    # Must find any partial match next.
    # ===================================================================== #
    possible_matches = _.select {|key, value| key.include?(i) }
    @real_program_name = possible_matches.first.last
    if be_verbose?
      e "#{i} is a registered header file."
      e "It points to the program called `#{@real_program_name}`." 
    end
    set_type :header
  else
    if be_verbose?
      e "#{sfancy(i)} #{rev}is not registered."
    end
  end
end

#set_type(i = :abbreviation) ⇒ Object

#

set_type

Type can be at the least :abbreviation and :program, but probably more than that.

#


103
104
105
 
# File 'lib/rbt/actions/individual_actions/map_this_input_to_that_registered_program/map_this_input_to_that_registered_program.rb', line 103

def set_type(i = :abbreviation)
  @type = i
end

#type? ⇒ Boolean

#

type?

#

Returns:

  • (Boolean) 


110
111
112
 
# File 'lib/rbt/actions/individual_actions/map_this_input_to_that_registered_program/map_this_input_to_that_registered_program.rb', line 110

def type?
  @type.to_s
end