Class: RBT::QueryHeaderToPackage

Inherits:
Base
  • Object
show all
Defined in:
lib/rbt/utility_scripts/query_header_to_package.rb

Overview

RBT::QueryHeaderToPackage

Constant Summary collapse

NAMESPACE =
#

NAMESPACE

#
inspect

Constants inherited from Base

Base::ALL_COLOUR_METHODS, Base::ARRAY_KDE_KONSOLE_COLOURS_IN_USE, Base::KONSOLE

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Base

#abbreviations?, #add_to_the_commandline_arguments, #all_binaries?, #all_libraries?, #always_show_dependencies?, #appdir_location_of?, #append_what_into, #archive_type_of?, #available_programs?, #be_quiet?, #be_verbose?, #begins_with_a_comment?, #capitalize_first_alphabetical_character, #capitalize_program_names?, #cat, #cd_to_the_log_directory, #cd_to_the_temp_directory, #change_directory, #change_permission, #cheering_person?, #chmod, #chop_off_archive, #cliner, #colourize_directory_for_system_results, #colourize_this_error, #colourize_this_file_path, #colourize_this_warning, #commandline_arguments?, #commandline_arguments_without_hyphens?, #config?, #convert_env_variable, #cookbook_files?, #cookbooks_include_this_program?, #copy_directory, #copy_files, #copy_recursively, #cpr, #create_directory, #current_hour?, #dd_mmm_yyy, #debug, #debug?, #determine_appdir_prefix_from_this_input, #determine_archive_type, #directory_expanded_cookbooks?, #directory_validation?, #disable_colours, #display_md5sum?, #do_not_debug, #do_not_show_names, #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, #email?, #enable_colours, #enable_debug, #ensure_main_encoding_for, #eparse, #esystem, #esystem_gold, #etomato, #ewarn, #exit_on_unregistered_cookbook_entries?, #exit_program, #expanded_cookbooks_directory_exists?, #fast_return_file_size_of_this_program, #file_compiled_programs?, #file_last_symlinked_program?, #file_predefined_installation_instructions?, #file_programs_version_url, #file_specification_of_registered_cookbook_entries, #find_cookbook_alias_for, #find_this_yaml_file, #first_argument?, #gem_version, #get_all_directories_from, #get_all_files_from, #get_all_programs, #get_date, #get_files_and_directories_from, #go_to_base_dir, #home_dir?, #host_system?, #is_a_64bit_system?, #is_an_archive?, #is_ccache_available?, #is_file?, #is_on_gobolinux?, #is_on_windows?, #is_porg_available?, #is_roebe?, #is_this_a_header?, #is_this_a_library?, #is_this_program_included?, #load_dataset_from_this_expanded_cookbook, #load_yaml, #load_yaml_file_from_the_cookbook_directory_for_this_program, #log_directory?, #main_encoding?, #make_command?, make_command?, #make_install_command?, #move_file, #n_programs_available?, #new_cookbook_instance_for, #no_directory_exists_at, #no_opn, #no_such_file_exists, #open_in_browser, #open_in_editor, #opne, #opnef, #opnerror, #opnewarn, #opnn, #path_to_this_expanded_cookbooks_dataset, #play_song?, #predefined_installation_instructions?, #program_dir?, #program_exists?, #programs_dir?, #project_base_dir?, #project_yaml_directory?, #publish_list_of_all_programs_version, #rarrow?, #rbt_logs?, #read_file, #read_file_in_default_encoding, #readlines, #readlines_with_proper_encoding, #recipes_dir?, #register_sigint, registered_binaries?, #remove, #remove_archive_from_the_end, #remove_comments_from_each_line, #remove_directory, #remove_double_slashes, #remove_file, #remove_file_extension, #remove_newlines, #remove_parens, #remove_symlink, #remove_this_commandline_argument, #remove_trailing_ANSII_escape_code, #remove_unnecessary_data_from_url, #rename, #rename_kde_konsole_tab, #repackage, #report_n_programs, #report_pwd, #report_to_developers, #report_working_directory, #return_all_archives_from_this_directory, #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_n_random_characters, #return_opnn, #return_program_information, #return_program_name, #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_version_of_this_program, #return_weekday_based_on_utc, #return_year_based_on_utc, #rev, #run_ldconfig?, #run_make_then_make_install, #run_simulation=, #run_simulation?, #sanitize_url1_entry, #sdir, #sdir_return_pwd, #set_be_silent, #set_be_verbose, #set_source_directory, #set_use_opn, #set_xorg_buffer, #sfancy, #sfile, #show_overview_over_available_utility_scripts, #silently_create_this_directory_if_it_does_not_yet_exist, #simp, #source_base_directory?, #ssym, #stderr, #store_into_this_directory?, #swarn, #symlink, #symlink_all_files_from_this_directory_to_that_directory, #sysbin_directory?, #sysetc_directory?, #sysinclude_directory?, #syslib_directory?, #sysshare_directory?, #system_directory?, #system_tags?, #temp_directory?, #to_bool, #to_camelcase, #to_unicode, #today?, #touch, #unicode_cliner, #unicode_middle_cliner, #upload_list_of_all_programs_version, #use_ccache?, #use_colours=, #use_colours?, #use_mrxvt?, #use_opn=, #use_opn?, #use_porg?, #use_stow?, #use_tags?, #use_yaml_database_for_tags?, #verbose_truth, #warn_and_exit, #wget, #word_wrap, #write_what_into, #write_what_into_via_unicode, #yes_or_no

Constructor Details

#initialize(commandline_arguments = ARGV, run_already = true) ⇒ QueryHeaderToPackage

#

initialize

#

61
62
63
64
65
66
67
68
69
70
 
# File 'lib/rbt/utility_scripts/query_header_to_package.rb', line 61

def initialize(
    commandline_arguments = ARGV,
    run_already           = true
  )
  reset
  set_commandline_arguments(
    commandline_arguments
  )
  run if run_already
end

Class Method Details

.[](i = '') ⇒ Object

#

RBT::QueryHeaderToPackage[]

#

243
244
245
 
# File 'lib/rbt/utility_scripts/query_header_to_package.rb', line 243

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

Instance Method Details

#

menu (menu tag)

#

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
 
# File 'lib/rbt/utility_scripts/query_header_to_package.rb', line 135

def menu(
    i = commandline_arguments?
  )
  if i.is_a? Array
    i.each {|entry| menu(entry) }
  else
    case i # case tag
    # ===================================================================== #
    # === query_header_to_package /usr/include --filter_for=xextproto
    # ===================================================================== #
    when /^-?-?filter_for=(.+)/,
         /^-?-?filter=(.+)/
      @filter_for = $1.to_s.dup
    # ===================================================================== #
    # === query_header_to_package --unassigned
    # ===================================================================== #
    when /^-?-?unassigned$/
      @show_all_header_files = true
    # ===================================================================== #
    # === query_header_to_package --help
    # ===================================================================== #
    when /help/
      show_help
      exit
    else
      if i.is_a? Symbol
        set_use_this_directory(i)
      elsif File.exist?(i) and
            File.directory?(i)
       # ================================================================== #
       # Assign to this directory, if a valid path has been given to us:
       # ================================================================== #
       set_use_this_directory(i)
      end
    end
  end
end

#obtain_all_headers ⇒ Object

#

obtain_all_headers

This method will obtain all .h files from the target directoy.

#

226
227
228
229
 
# File 'lib/rbt/utility_scripts/query_header_to_package.rb', line 226

def obtain_all_headers
  _ = target_directory?
  @array_headers = Dir["#{_}**/**.h"]
end

#reset ⇒ Object

#

reset (reset tag)

#

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

def reset
  super()
  # ======================================================================= #
  # === @namespace
  # ======================================================================= #
  @namespace = NAMESPACE
  # ======================================================================= #
  # === @show_all_header_files
  # ======================================================================= #
  @show_all_header_files = false
  # ======================================================================= #
  # === @filter_for
  # ======================================================================= #
  @filter_for = nil # Whether to filter for an individual program only.
  set_target_directory # Must initialize it at the least once.
  set_commandline_arguments # Invoke it here because it is a bit different to regular @commandline_arguments.
end

#run ⇒ Object

#

run (run tag)

#

234
235
236
237
238
 
# File 'lib/rbt/utility_scripts/query_header_to_package.rb', line 234

def run
  menu # Must come before obtain_all_headers is invoked.
  obtain_all_headers # ← Obtain all .h files.
  try_to_process_the_available_headers
end

#set_commandline_arguments(i = ARGV) ⇒ Object

#

set_commandline_arguments

Keep track of the commandline arguments used.

#

98
99
100
101
102
 
# File 'lib/rbt/utility_scripts/query_header_to_package.rb', line 98

def set_commandline_arguments(i = ARGV)
  i = [i].flatten.compact
  i << return_pwd if i.empty?
  @commandline_arguments = i
end

#set_target_directory(i = return_pwd) ⇒ Object Also known as: set_use_this_directory

#

set_target_directory

#

107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'lib/rbt/utility_scripts/query_header_to_package.rb', line 107

def set_target_directory(
    i = return_pwd
  )
  i = i.first if i.is_a? Array
  i = return_pwd if i.nil?
  i = i.to_s.dup
  unless i.end_with? '/'
    i << '/'
  end
  if first_argument?.is_a? Symbol
    case first_argument?
    when :default
      i = '/usr/include/'
    end
  end if first_argument?
  @target_directory = i
end

#show_help ⇒ Object

#

show_help (help tag)

#

212
213
214
215
216
217
218
219
 
# File 'lib/rbt/utility_scripts/query_header_to_package.rb', line 212

def show_help
  opnn; e 'The following options are available:'
  e
  e '  --unassigned           # Show entries without an attribute as well.'
  e '  --filter_for=xextproto # Show only .h files belonging to '\
    'this program (e. g. xextproto in this example)'
  e
end

#target_directory? ⇒ Boolean Also known as: target?

#

target_directory?

#

Returns:

  • (Boolean) 

128
129
130
 
# File 'lib/rbt/utility_scripts/query_header_to_package.rb', line 128

def target_directory?
  @target_directory
end

#try_to_process_the_available_headers ⇒ Object

#

try_to_process_the_available_headers

We work through the discovered .h files.

#

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
 
# File 'lib/rbt/utility_scripts/query_header_to_package.rb', line 178

def try_to_process_the_available_headers
  ljust_value = 55
  if @filter_for
  end
  if @array_headers.empty?
    opnn; e 'No headers were found.'
  else
    @array_headers.each {|this_header|
      _ = this_header.sub(/\/usr\/include\//,'')
      # =================================================================== #
      # Query the big Hash next that includes all our .h files.
      # =================================================================== #
      if HASH_ALL_REGISTERED_HEADERS.has_key? _
        this_program = HASH_ALL_REGISTERED_HEADERS[_]
        if @filter_for and
           (@filter_for != this_program)
          # Filter for a specific program in this case.
        else
          e 'The header '+sfancy(this_header.ljust(ljust_value))+' belongs to '\
            'the program called `'+orange(this_program)+'`.'
        end
      else
        if @show_all_header_files
          e 'The header '+sfancy(this_header.ljust(ljust_value))+' is currently '\
            'unassigned. (An orphan header).'
        end
      end
    }
  end
end