Class: RBT::UseFlags

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

Constant Summary collapse

REGISTERED_COMPILE_FLAGS =
#

REGISTERED_COMPILE_FLAGS

bl $RBT/YAML/registered_compile_flags.yml Right now it is hardcoded.

#
YAML.load_file(
  "#{RBT.yaml_directory?}registered_compile_flags/registered_compile_flags.yml"
)

Constants inherited from LeanPrototype

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

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_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, #otomato, #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_name, #return_program_name_for_gobolinux_systems, #return_program_name_via_program_information, #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, #rpn, #run_simulation=, #run_simulation?, #sdir, #sdir_return_pwd, #set_be_silent, #set_be_verbose, #set_first_commandline_argument, #set_namespace, #set_use_colours, #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(run_already = true) ⇒ UseFlags

#

initialize

Note: the constant USE_FLAGS can be found in the shared code part, in a yaml file. REGISTERED_COMPILE_FLAGS can be found in RBT_Base.rb

#


42
43
44
45
46
47
 
# File 'lib/rbt/utility_scripts/use_flags.rb', line 42

def initialize(
    run_already = true
  )
  reset
  run if run_already
end

Instance Method Details

#check_for_environment ⇒ Object

#

check_for_environment

Here, we must check if the user did set to use a specific USE environment flag.

#


88
89
90
 
# File 'lib/rbt/utility_scripts/use_flags.rb', line 88

def check_for_environment
  @environment_use_flags = ENV['USE'].dup if ENV['USE']
end

#environment_use_flags? ⇒ Boolean Also known as: environment_use_flags

#

environment_use_flags?

Stores ENV stuff.

#

Returns:

  • (Boolean) 


106
107
108
 
# File 'lib/rbt/utility_scripts/use_flags.rb', line 106

def environment_use_flags?
  @environment_use_flags
end

#is_included?(this_use_flag = use_flags? ) ⇒ Boolean

#

is_included?

Find out if the use-flag we want to use is already registered.

#

Returns:

  • (Boolean) 


115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
 
# File 'lib/rbt/utility_scripts/use_flags.rb', line 115

def is_included?(
    this_use_flag = use_flags?
  )
  @string = ''.dup # Empty it again here.
  if @registered_compile_flags.keys.include? this_use_flag
    @string << " #{@registered_compile_flags[this_use_flag]}"
  elsif this_use_flag.include? ' '
    this_use_flag.split(' ').each { |splitted|
      if @registered_compile_flags.keys.include? splitted
        @string << ' '+@registered_compile_flags[splitted]
      end
    }
  else # Else it may be enable or disable
       # We keep that consistent.
    if    this_use_flag.include? 'enable'
      is_included? value.gsub(/enable/,'with')
    elsif this_use_flag.include? 'disable'
      is_included? value.gsub(/disable/,'without')
    end
  end
  @string.strip!
end

#reset ⇒ Object

#

reset

#


52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/rbt/utility_scripts/use_flags.rb', line 52

def reset
  super()
  # ======================================================================= #
  # === @environment_use_flags
  # ======================================================================= #
  @environment_use_flags = nil
  dataset = YAML.load_file(FILE_USE_FLAGS) if File.exist?(FILE_USE_FLAGS)
  # ======================================================================= #
  # === @use_flags
  # ======================================================================= #
  @use_flags = dataset['USE'].strip # {"USE"=>"-arts +mp3 +ogg"}
  # ======================================================================= #
  # === @registered_compile_flags
  # ======================================================================= #
  @registered_compile_flags = REGISTERED_COMPILE_FLAGS
end

#run ⇒ Object

#

run (run tag)

#


148
149
150
151
152
 
# File 'lib/rbt/utility_scripts/use_flags.rb', line 148

def run
  sanitize_registered_compile_flags    
  check_for_environment
  is_included?
end

#sanitize_registered_compile_flags ⇒ Object

#

sanitize_registered_compile_flags

This is needed to make proper default values for the ‘+’ use flags.

It is run once on startup. Afterwards it does not need to be run again.

#


76
77
78
79
80
 
# File 'lib/rbt/utility_scripts/use_flags.rb', line 76

def sanitize_registered_compile_flags
  @registered_compile_flags.dup.each_pair { |k, v|
    @registered_compile_flags[ k[1..-1] ] = v if k.include? '+' # k[1..-1] includes all but leading +
  }
end

#string? ⇒ Boolean Also known as: string

#

string?

#

Returns:

  • (Boolean) 


141
142
143
 
# File 'lib/rbt/utility_scripts/use_flags.rb', line 141

def string?
  @string # Use this string as the return value.
end

#use_flags? ⇒ Boolean

#

use_flags?

This will simply return all flags that are available. (Rarely used.)

#

Returns:

  • (Boolean) 


97
98
99
 
# File 'lib/rbt/utility_scripts/use_flags.rb', line 97

def use_flags?
  @use_flags
end