Class: Roebe::IcewmKeysGenerator

Inherits:
Base show all
Defined in:
lib/roebe/classes/icewm/icewm_keys_generator.rb

Overview

Roebe::IcewmKeysGenerator

Constant Summary collapse

FILE_KEYS =
#

FILE_KEYS

#
'/home/x/DATA/PC/OS/LINUX/yaml/keys.yml'

Constants inherited from Base

Base::COLOURS, Base::HOME_DIRECTORY_OF_USER_X, Base::N, Base::NAMESPACE

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Base

#actions, #append_this_onto_that_file, #append_what_into, #be_silent, #be_verbose?, #beautiful_url, #burlywood, #call_next, #chdir, #cheerful_guy, #cliner, #complex_esystem, #convert_global_env, #copy_directory, #copy_file, #cornflowerblue, #create_directory, #crimson, #current_month?, #current_time?, #current_year?, #cyan, #darkcyan, #darkgreen, #darkkhaki, #darkslateblue, #deeppink, #delete_symlink, #do_not_use_the_base_colours, #do_use_the_base_colours, #e, #ecomment, #editor_to_use?, #efancy, #eimp, #emphasis, #ensure_main_encoding, #ensure_utf_encoding, #eparse, #erev, #esteelblue, #etomato, #ewarn, #exit_program, #firebrick, #get_current_day, #get_current_month, #get_files_and_directories, #get_files_from, #get_german_name_for_this_weekday, #gold, #green, #grey, #hh_mm_ss, #hh_mm_ss_day_month_year, #home_dir?, #home_directory_of_user_x?, #infer_the_namespace, #internal_hash?, #is_a_directory?, #is_a_file?, #is_a_jpg_file?, #is_an_image_file?, #is_archive?, #is_audio_file?, #is_in_studium_dir?, #is_multimedia_file?, #is_on_roebe?, #is_on_windows?, #is_studium_available?, #is_symlink?, #is_this_a_ruby_file?, #is_video_file?, #iso_encoding?, #le, #left_colour, #lightblue, #lightgreen, #lightseagreen, #lightsteelblue, #lime, #limegreen, #localhost_to_data, #log_directory?, #main_encoding?, #mediumorchid, #mediumpurple, #mediumseagreen, #mediumslateblue, #mediumspringgreen, #mediumturquoise, #mkdir_p, #mv, #n_days_in_this_month, #n_pages_in_this_pdf_file?, #namespace?, #no_file_exists_at, #ogrey, #olive, #olivedrab, #open_in_browser, #opne, #opnesystem, #opnn, #orange, #orchid, #orev, #palegoldenrod, #palevioletred, #pink, #powderblue, #programs_dir?, #project_base_dir?, #random_html_colour, #rds, #read_file_in_iso_encoding, #read_file_via_the_default_encoding, #read_lines_via_iso_encoding, #readlines_with_main_encoding, #red, #register_sigint, #remove, #remove_directory, #remove_file, #rename_kde_konsole_tab, #replace_localhost_with_data, #report_pwd, #require_rescue, #reset_the_internal_hash, #return_all_directories_from_this_directory, #return_all_files_from_this_directory, #return_current_directory, #return_dd_mm_yyyy, #return_file_or_directory_of, #return_files_from_pwd, #return_last_part_of_the_current_directory, #return_utc, #rev, #right_arrow?, #right_colour, #roebe_log_directory?, #rosybrown, #royalblue, #ruby_base_directory?, #run_in_background, #run_rcfiles_then_run_ata_via_qdbus, #sandybrown, #sdir, #seagreen, #set_be_verbose, #set_xorg_buffer, #sfancy, #sfile, #show_help, #silent_redirection?, #simp, #simple_esystem, #skyblue, #slateblue, #slategray, #springgreen, #steelblue, #string_italic, #swarn, #symlink, #teal, #temp_dir?, #to_camelcase, #to_counted_hash, #tomato, #touch, #try_to_require_the_beautiful_url_gem, #try_to_require_the_html_template, #try_to_require_the_open_gem, #try_to_require_the_program_information_gem, #try_to_require_the_xorg_buffer, #use_colours?, #verbose_truth, #weekday?, #word_wrap, #write_what_into, #yellow

Methods included from Base::CommandlineArguments

#append_onto_the_commandline_arguments, #clear_commandline_arguments, #commandline_arguments?, #commandline_arguments_as_string?, #commandline_arguments_without_leading_hyphens?, #first_argument?, #first_argument_without_leading_hyphens?, #has_an_argument_been_passed?, #remove_hyphened_arguments_from_the_commandline_arguments, #return_commandline_arguments_with_leading_hyphens, #second_argument?, #set_commandline_arguments

Constructor Details

#initialize(commandline_arguments = nil, run_already = true) ⇒ IcewmKeysGenerator

#

initialize

#


30
31
32
33
34
35
36
37
38
39
 
# File 'lib/roebe/classes/icewm/icewm_keys_generator.rb', line 30

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

Class Method Details

.[](i = '') ⇒ Object

#

Roebe::IcewmKeysGenerator[]

#


154
155
156
 
# File 'lib/roebe/classes/icewm/icewm_keys_generator.rb', line 154

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

Instance Method Details

#do_generate_the_icewm_keys_file ⇒ Object

#

do_generate_the_icewm_keys_file

Note that we will only generate the string-parts that were stored in the instance variable @hash_create_these_keys, so if you want to make use of the original dataset, make sure that the Hash is populated correctly.

#


116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
 
# File 'lib/roebe/classes/icewm/icewm_keys_generator.rb', line 116

def do_generate_the_icewm_keys_file
  _ = ''.dup
  @hash_create_these_keys.each_pair {|key, value|
    # ===================================================================== #
    # We need entries like this here:
    #
    #   key "Super+KP_Add"          amixer sset Master 5%+
    #
    # ===================================================================== #
    _ << ('key "'+key.to_s+'"').ljust(32)
    _ << value.to_s+N
  }
  into = store_where?
  opne 'Storing into the file '+sfile(into)+' next.'
  write_what_into(_, into)
end

#obtain_the_main_dataset ⇒ Object

#

obtain_the_main_dataset

#


95
96
97
 
# File 'lib/roebe/classes/icewm/icewm_keys_generator.rb', line 95

def obtain_the_main_dataset
  @dataset = YAML.load_file(FILE_KEYS)
end

#reset ⇒ Object

#

reset (reset tag)

#


44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/roebe/classes/icewm/icewm_keys_generator.rb', line 44

def reset
  super()
  infer_the_namespace
  # ======================================================================= #
  # === @hash_create_these_keys
  #
  # The following hash contains which keys we will generate. The key
  # must contain the key-combination to use, and the value will
  # contain which particular action shall be done.
  #
  # The windows-key is called "Super".
  #
  # Valid modifiers in general are:
  #
  #   - "Alt"
  #   - "Ctrl"
  #   - "Shift"
  #   - "Meta"
  #   - "Super"
  #   - "Hyper"
  #
  # Example:
  #
  #   key "Super+KP_Add"          amixer sset Master 5%+
  #
  # You can combine keys via + such as in:
  #
  #   key "Alt+Ctrl+x"            xterm
  #
  # For control+shift, use something like this:
  #
  #   key "Ctrl+Shift+r"      pkill -x -HUP icewm
  #
  # ======================================================================= #
  @hash_create_these_keys = {}
  # ======================================================================= #
  # === @store_into_this_file
  # ======================================================================= #
  @store_into_this_file = ENV['HOME']+'/icewm_keys'
end

#run ⇒ Object

#

run (run tag)

#


102
103
104
105
106
 
# File 'lib/roebe/classes/icewm/icewm_keys_generator.rb', line 102

def run
  obtain_the_main_dataset
  work_through_the_main_dataset
  do_generate_the_icewm_keys_file
end

#store_into_this_file? ⇒ Boolean Also known as: store_where?

#

store_into_this_file?

#

Returns:

  • (Boolean) 


88
89
90
 
# File 'lib/roebe/classes/icewm/icewm_keys_generator.rb', line 88

def store_into_this_file?
  @store_into_this_file
end

#work_through_the_main_dataset ⇒ Object

#

work_through_the_main_dataset

#


136
137
138
139
140
141
142
143
144
145
146
147
148
149
 
# File 'lib/roebe/classes/icewm/icewm_keys_generator.rb', line 136

def work_through_the_main_dataset
  @dataset.each_pair {|key, value|
    if key.start_with? 'win'
      @hash_create_these_keys[key.sub(/win/,'Super')] = value
    elsif key.start_with? 'alt'
      @hash_create_these_keys[key.sub(/^alt/,'Alt')] = value
    elsif key.start_with? 'strg'
      @hash_create_these_keys[key.sub(/^strg/,'Ctrl')] = value
    else
      e tomato('Unhandled case: ')+
        steelblue(key)
    end
  }
end