Class: RBT::Action::SimpleAppdirConfigure

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

Overview

RBT::Action::SimpleAppdirConfigure

Direct Known Subclasses

MesonAppdirConfigure, Ntrad

Constant Summary collapse

BUILD_DIRECTORY =
#

BUILD_DIRECTORY

#
'BUILD_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 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(i = nil, run_already = true, &block) ⇒ SimpleAppdirConfigure

#

initialize

#


35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
 
# File 'lib/rbt/actions/individual_actions/simple_appdir_configure/simple_appdir_configure.rb', line 35

def initialize(
    i           = nil,
    run_already = true,
    &block
  )
  reset
  set_commandline_arguments(i)
  case run_already
  # ======================================================================= #
  # === :do_not_run_yet
  # ======================================================================= #
  when :do_not_run_yet
    run_already = false
  end
  run if run_already
end

Class Method Details

.[](i = ARGV) ⇒ Object

#

RBT::Action::SimpleAppdirConfigure[]

#


330
331
332
 
# File 'lib/rbt/actions/individual_actions/simple_appdir_configure/simple_appdir_configure.rb', line 330

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

Instance Method Details

#do_use_a_build_directory ⇒ Object

#

do_use_a_build_directory

This method will enable the use of a build directory, as-is.

#


73
74
75
 
# File 'lib/rbt/actions/individual_actions/simple_appdir_configure/simple_appdir_configure.rb', line 73

def do_use_a_build_directory
  @internal_hash[:use_a_build_directory] = true
end

#make_use_of_meson ⇒ Object

#

make_use_of_meson

#


111
112
113
 
# File 'lib/rbt/actions/individual_actions/simple_appdir_configure/simple_appdir_configure.rb', line 111

def make_use_of_meson
  @cmd = 'meson'.dup
end

#menu(i = commandline_arguments? ) ⇒ Object

#

menu (menu tag)

#


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
 
# File 'lib/rbt/actions/individual_actions/simple_appdir_configure/simple_appdir_configure.rb', line 131

def menu(
    i = commandline_arguments?
  )
  if i.is_a? Array
    i.each {|entry| menu(entry) }
  else
    case i # (case tag)
    # ===================================================================== #
    # === sappconf --builddir
    # ===================================================================== #
    when /^-?-?build(_|-| )?dir$/i
      do_use_a_build_directory
    # ===================================================================== #
    # === sappconf --down
    #
    # This entry point may be for an argument such as:
    #
    #   ["/Depot/j/glibc-2.27/BUILD/", "--down"]
    #
    # The entry point will instantly modify this.
    # ===================================================================== #
    when /^-?-?down$/,
         :down
      @cmd.prepend('.') # from[0] = File.dirname(return_pwd)
    # ===================================================================== #
    # === sappconf --help
    # ===================================================================== #
    when /^-?-?help$/i
      show_help
      exit
    # ===================================================================== #
    # === sappconf --use-meson
    # ===================================================================== #
    when /^-?-?use(_|-| )?meson$/i,
         /^-?-?meson$/i
      remove_this_entry_from_the_commandline_arguments(i)
      make_use_of_meson
    # ===================================================================== #
    # === sappconf --use-cmake
    # ===================================================================== #
    when /^-?-?use(_|-| )?cmake$/i,
         /^-?-?cmake$/i
      @cmd = 'cmake'.dup
    end
  end
end

#padded_esystem(cmd) ⇒ Object

#

padded_esystem

#


87
88
89
90
91
92
 
# File 'lib/rbt/actions/individual_actions/simple_appdir_configure/simple_appdir_configure.rb', line 87

def padded_esystem(cmd)
  e
  e slateblue(cmd)
  e
  system cmd
end

#reset ⇒ Object

#

reset (reset tag)

#


55
56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/rbt/actions/individual_actions/simple_appdir_configure/simple_appdir_configure.rb', line 55

def reset
  super()
  infer_the_namespace
  # ======================================================================= #
  # === @cmd
  # ======================================================================= #
  @cmd = './configure'.dup
  # ======================================================================= #
  # === :use_a_build_directory
  # ======================================================================= #
  @internal_hash[:use_a_build_directory] = false
end

#run ⇒ Object

#

run (run tag)

#


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
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
 
# File 'lib/rbt/actions/individual_actions/simple_appdir_configure/simple_appdir_configure.rb', line 181

def run
  menu
  # ======================================================================= #
  # Establish the cmd to use early on.
  # ======================================================================= # 
  cmd = @cmd # ← This is the command that will be used.
  from = return_pwd # Default.
  _ = first_non_hyphen_argument?
  case _
  # ======================================================================= #
  # === :pwd
  # ======================================================================= #
  when :pwd
    _ = return_pwd
  end
  _ = _.to_s.dup # Work on a copy here, anyway.
  unless _.empty?
    from = _.dup
  end
  from = File.basename(from)
  if File.exist?(from) and File.file?(from)
    # ===================================================================== #
    # Extract the archive in this case.
    #
    # Usage example:
    #
    #   
    #
    # ===================================================================== #
    e "#{rev}Extracting the archive #{sdir(from)} #{rev}next."
    action(:extract_what_to, from)
    to = log_dir?+
         remove_archive_from_the_end(File.basename(from))+'/'
    opne "#{rev}Entering the directory "\
         "#{sdir(File.absolute_path(to))} #{rev}next."
    cd to
  end
  if File.exist?(from) and !File.directory?(from)
    opne swarn('Currently this code only works on already '\
         'extracted directories.')
    exit
  end
  append_these_configure_options = ''.dup
  commandline_arguments = commandline_arguments?
  commandline_arguments.reject! {|entry|
    entry == _ or
    entry.start_with?('--down') or
    entry.start_with?('--builddir')
  }
  these_arguments = hyphen_arguments(
    commandline_arguments
  ).join(' ')
  unless these_arguments.rstrip.empty?
    append_these_configure_options << these_arguments.rstrip
  end
  # ======================================================================= #
  # Obtain the program-name and program-version next:
  # ======================================================================= #
  program_name    = ProgramInformation.return_short_name(from).delete('-')
  program_version = ProgramInformation.return_version(from)
  # ======================================================================= #
  # === Determine the correct prefix next
  #
  # Next we must determine the proper prefix-target for PROGRAMS.
  # ======================================================================= #
  use_this_as_the_target_prefix = programs_directory?+
                                  program_name.capitalize+'/'+
                                  program_version+'/'
  # ======================================================================= #
  # We will pass this into RBT::CreateAppDirSkeleton next:
  # ======================================================================= #
  action(:create_appdir_skeleton, use_this_as_the_target_prefix)
  # ======================================================================= #
  # === Handle cmake next
  # ======================================================================= #
  if File.exist?('CMakeLists.txt') and !File.exist?('configure') and
    cmd.include?('configure')
    # ===================================================================== #
    # In this case there is no GNU configure script; only a cmake file
    # available, so use that.
    # ===================================================================== #
    cmd = 'cmake'
  # ======================================================================= #
  # Run the three sys-commands next, starting with "./configure". If
  # the working directory does NOT include a file called "configure",
  # but it DOES contain a file called 'autogen.sh' then we will first
  # invoke autogen before continuing.
  # ======================================================================= #
  elsif File.exist?('autogen.sh') and
       !File.exist?('configure') and
        cmd.include?('configure')
    e
    opne rev+'No '+sfile('configure')+rev+' file was found, but a file called'
    opne rev+sfile('autogen.sh')+
         "#{rev} was found. Thus, invoking autogen next."
    e
    padded_esystem 'sh autogen.sh'
  end
  cmd = cmd.dup if cmd.frozen?
  if cmd.include? 'cmake'
    # ===================================================================== #
    # Add the proper prefix.
    # ===================================================================== #
    cmd << ' -DCMAKE_INSTALL_PREFIX='+use_this_as_the_target_prefix
  else
    # ===================================================================== #
    # This part is valid for both GNU configure as well as meson.
    # ===================================================================== #
    cmd << ' --prefix='+use_this_as_the_target_prefix
  end
  unless cmd.include? append_these_configure_options
    cmd << " #{append_these_configure_options}" unless append_these_configure_options.empty?
  end
  if File.exist?('meson.build') and !File.exist?('configure')
    do_use_a_build_directory
    _ = "meson --prefix=#{use_this_as_the_target_prefix}".dup
    if append_these_configure_options and !append_these_configure_options.empty?
      _ << " #{append_these_configure_options}"
    end
    _ << " #{BUILD_DIRECTORY}" if use_a_build_directory?
    padded_esystem _
    cd BUILD_DIRECTORY if use_a_build_directory?
    run_ninja_command
    run_ninja_install_command
    return
  else
    # ===================================================================== #
    # Run the cmd via esystem() next:
    # ===================================================================== #
    if use_build_directory?
      mkdir(BUILD_DIRECTORY) unless File.directory?(BUILD_DIRECTORY)
      cd(BUILD_DIRECTORY) unless return_pwd.include?(BUILD_DIRECTORY)
    end
    padded_esystem cmd
    if cmd.start_with? 'meson'
      run_ninja_command
      run_ninja_install_command
    else # This clause is valid for GNU configure and cmake.
      cmd = 'make'
      padded_esystem(cmd)
      cmd = 'make install'
      padded_esystem(cmd)
    end
  end
end

#run_ninja_command ⇒ Object

#

run_ninja_command

#


97
98
99
 
# File 'lib/rbt/actions/individual_actions/simple_appdir_configure/simple_appdir_configure.rb', line 97

def run_ninja_command
  padded_esystem 'ninja'
end

#run_ninja_install_command ⇒ Object

#

run_ninja_install_command

#


104
105
106
 
# File 'lib/rbt/actions/individual_actions/simple_appdir_configure/simple_appdir_configure.rb', line 104

def run_ninja_install_command
  padded_esystem 'ninja install'
end

#show_help ⇒ Object

#

show_help (help tag)

#


118
119
120
121
122
123
124
125
126
 
# File 'lib/rbt/actions/individual_actions/simple_appdir_configure/simple_appdir_configure.rb', line 118

def show_help
  opne "#{rev}These options are currently available:"
  e
  e steelblue('  --down          # pass one "." to the configure or cmake or meson script')
  e steelblue('  --builddir      # use a build directory')
  e steelblue('  --use-cmake')
  e steelblue('  --use-meson')
  e rev
end

#use_a_build_directory? ⇒ Boolean Also known as: use_build_directory?

#

use_a_build_directory?

#

Returns:

  • (Boolean) 


80
81
82
 
# File 'lib/rbt/actions/individual_actions/simple_appdir_configure/simple_appdir_configure.rb', line 80

def use_a_build_directory?
  @internal_hash[:use_a_build_directory]
end