Class: UdbGen::GenIsaExplorerOptions

Inherits:
SubcommandWithCommonOptions show all
Includes:
TTY::Exit, TemplateHelpers
Defined in:
lib/udb-gen/generators/isa_explorer/generator.rb

Constant Summary collapse

NAME = 
"isa-explorer"

Constants included from TemplateHelpers

TemplateHelpers::LinkableObj

Instance Attribute Summary

Attributes inherited from Subcommand

#desc, #name

Instance Method Summary collapse

Methods included from TemplateHelpers

#anchor_for, #convert_monospace_to_links, #link_name, #link_to, #partial, #resolve_intermediate_links

Methods included from AdocHelpers

#state_preamble_adoc, #state_revmark

Methods inherited from SubcommandWithCommonOptions

#cfg_arch, #resolve_cfg_arg, #resolver

Constructor Details

#initialize ⇒ GenIsaExplorerOptions

Returns a new instance of GenIsaExplorerOptions.



28
29
30
 
# File 'lib/udb-gen/generators/isa_explorer/generator.rb', line 28

def initialize
  super(name: NAME, desc: "Create ISA explorer tables / sites")
end

Instance Method Details

#gen_csr_browser ⇒ Object 



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
 
# File 'lib/udb-gen/generators/isa_explorer/generator.rb', line 141

def gen_csr_browser
  FileUtils.mkdir_p params[:output_dir]

  target_html_fn = params[:output_dir] / "csr-explorer.html"

  # Delete target file if already present.
  if target_html_fn.exist?
    begin
      File.delete(target_html_fn)
    rescue StandardError => e
      raise "Can't delete '#{target_html_fn}': #{e.message}"
    end
  end

  builder = IsaExplorer::TableBuilder.new(cfg_arch, params[:skip])
  writer  = IsaExplorer::JsXlsxWriter.new
  js_table = writer.js_table(builder.csr_table, "csr_table")

  template_path = Pathname.new(Gem.loaded_specs["udb-gen"].full_gem_path) / "templates" / "isa_explorer" / "csr-browser.html.erb"

  erb = ERB.new(template_path.read, trim_mode: "-")
  erb.filename = template_path.to_s

  Udb.logger.info "SUCCESS: Writing result to #{target_html_fn}"
  target_html_fn.write erb.result(binding)
end

#gen_ext_browser ⇒ Object 



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'lib/udb-gen/generators/isa_explorer/generator.rb', line 85

def gen_ext_browser
  FileUtils.mkdir_p params[:output_dir]

  target_html_fn = params[:output_dir] / "ext-explorer.html"

  # Delete target file if already present.
  if target_html_fn.exist?
    begin
      File.delete(target_html_fn)
    rescue StandardError => e
      raise "Can't delete '#{target_html_fn}': #{e.message}"
    end
  end

  builder = IsaExplorer::TableBuilder.new(cfg_arch, params[:skip])
  writer  = IsaExplorer::JsXlsxWriter.new
  js_table = writer.js_table(builder.ext_table, "ext_table")

  template_path = Pathname.new(Gem.loaded_specs["udb-gen"].full_gem_path) / "templates" / "isa_explorer" / "ext-browser.html.erb"

  erb = ERB.new(template_path.read, trim_mode: "-")
  erb.filename = template_path.to_s

  Udb.logger.info "SUCCESS: Writing result to #{target_html_fn}"
  target_html_fn.write erb.result(binding)
end

#gen_inst_browser ⇒ Object 



113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
 
# File 'lib/udb-gen/generators/isa_explorer/generator.rb', line 113

def gen_inst_browser
  FileUtils.mkdir_p params[:output_dir]

  target_html_fn = params[:output_dir] / "inst-explorer.html"

  # Delete target file if already present.
  if target_html_fn.exist?
    begin
      File.delete(target_html_fn)
    rescue StandardError => e
      raise "Can't delete '#{target_html_fn}': #{e.message}"
    end
  end

  builder = IsaExplorer::TableBuilder.new(cfg_arch, params[:skip])
  writer  = IsaExplorer::JsXlsxWriter.new
  js_table = writer.js_table(builder.inst_table, "inst_table")

  template_path = Pathname.new(Gem.loaded_specs["udb-gen"].full_gem_path) / "templates" / "isa_explorer" / "inst-browser.html.erb"

  erb = ERB.new(template_path.read, trim_mode: "-")
  erb.filename = template_path.to_s

  Udb.logger.info "SUCCESS: Writing result to #{target_html_fn}"
  target_html_fn.write erb.result(binding)
end

#gen_xlsx ⇒ Object 



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
 
# File 'lib/udb-gen/generators/isa_explorer/generator.rb', line 169

def gen_xlsx
  FileUtils.mkdir_p params[:output_dir]

  target_xlsx_fn = params[:output_dir] / "isa_explorer.xlsx"

  # Delete target file if already present.
  if target_xlsx_fn.exist?
    begin
      File.delete(target_xlsx_fn)
    rescue StandardError => e
      raise "Can't delete '#{target_xlsx_fn}': #{e.message}"
    end
  end

  builder = IsaExplorer::TableBuilder.new(cfg_arch, params[:skip])
  writer  = IsaExplorer::JsXlsxWriter.new

  # Create a new Excel workbook
  Udb.logger.info "Creating Excel workboook #{target_xlsx_fn}"
  workbook = WriteXLSX.new(target_xlsx_fn)

  # Extension worksheet
  Udb.logger.info "Creating extension table data structure"
  ext_worksheet = workbook.add_worksheet("Extensions")
  Udb.logger.info "Adding extension table to worksheet #{ext_worksheet.name}"
  writer.xlsx_table(builder.ext_table, workbook, ext_worksheet)

  # Instruction worksheet
  Udb.logger.info "Creating instruction table data structure"
  inst_worksheet = workbook.add_worksheet("Instructions")
  Udb.logger.info "Adding instruction table to worksheet #{inst_worksheet.name}"
  writer.xlsx_table(builder.inst_table, workbook, inst_worksheet)

  # CSR worksheet
  Udb.logger.info "Creating CSR table data structure"
  csr_worksheet = workbook.add_worksheet("CSRs")
  Udb.logger.info "Adding CSR table to worksheet #{csr_worksheet.name}"
  writer.xlsx_table(builder.csr_table, workbook, csr_worksheet)

  workbook.close

  Udb.logger.info "SUCCESS: Wrote result to #{target_xlsx_fn}"
end

#run(argv) ⇒ Object 



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
 
# File 'lib/udb-gen/generators/isa_explorer/generator.rb', line 214

def run(argv)
  parse(argv)

  if params[:help]
    print help
    exit_with(:success)
  end

  if params.errors.any?
    exit_with(:usage_error, "#{params.errors.summary}\n\n#{help}")
  end

  unless params.remaining.empty?
    exit_with(:usage_error, "Unknown arguments: #{params.remaining}\n")
  end

  case params[:type]
  when "ext-browser"
    gen_ext_browser
  when "inst-browser"
    gen_inst_browser
  when "csr-browser"
    gen_csr_browser
  when "xlsx"
    gen_xlsx
  else
    Udb.logger.error "Unknown target type: #{params[:type]}"
  end

  exit_with(:success)
end