origen_doc_helpers 0.8.0 → 0.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e38c7e090bcb00c720933266cbf06095d99d817206d105a88fa2a3792f9dfd71
-  data.tar.gz: '076904f8fedfcbecab07c948341ffc529f68357d02106d235dbdebf8db6496d1'
+  metadata.gz: cc64bf452050bf339559fae81af5f84ec6a1110b7f961603c01216054544b724
+  data.tar.gz: 339aea6eed91ca04ae9878c588d99d5686dd0bdb7a7782648574e72cf6bf44b4
 SHA512:
-  metadata.gz: 0bb5c8624309ad1e3d5f3261c0e9b5fecc6f30e899a45ef8694d24992b7f6813aadc29bfaebd3ca33bd3915cd44ab5e2319c7c92a300a9e93379fe2aeae8f1ee
-  data.tar.gz: e6cc432dcef4200b37cbc045eec8c2777f327f055cb5e3d36366cefd0ee508996a5864a7a0c09c1f09c2f30c746c51f498e1fac13808dcce8730fb8ea2c79e6a
+  metadata.gz: c6fcb507a0332cdb0770b34992d4fcd21f25feafe50f44e6d96232364108edfcb98309e24a1eecb89db31450aad5503d9a14f6dddc120a77172831bfe6f19040
+  data.tar.gz: e88f2858f3a3d9fb6971b64a8b9afd1adf275d326f495213c5bca23d56a0253b8a6fad5c8ef785fc34d4ef78db5b6d2f82236c7e5a91f432c2d754cfec38e4ef

data/config/version.rb

@@ -1,8 +1,7 @@
 module OrigenDocHelpers
   MAJOR = 0
   MINOR = 8
-  BUGFIX = 0
+  BUGFIX = 1
   DEV = nil
-
   VERSION = [MAJOR, MINOR, BUGFIX].join(".") + (DEV ? ".pre#{DEV}" : '')
 end

data/lib/origen_doc_helpers/html_flow_formatter.rb

@@ -1,7 +1,11 @@
-require 'atp'
+begin
+  require 'origen_testers/atp'
+rescue LoadError
+  require 'atp'
+end
 require 'kramdown'
 module OrigenDocHelpers
-  class HtmlFlowFormatter < ATP::Formatter
+  class HtmlFlowFormatter < (defined?(OrigenTesters::ATP) ? OrigenTesters::ATP::Formatter : ATP::Formatter)
     include Origen::Generator::Compiler::DocHelpers::TestFlowHelpers
 
     attr_reader :html

data/lib/origen_doc_helpers/list_flow_formatter.rb

@@ -1,6 +1,10 @@
-require 'atp'
+begin
+  require 'origen_testers/atp'
+rescue LoadError
+  require 'atp'
+end
 module OrigenDocHelpers
-  class ListFlowFormatter < ATP::Formatter
+  class ListFlowFormatter < (defined?(OrigenTesters::ATP) ? OrigenTesters::ATP::Formatter : ATP::Formatter)
     attr_reader :html
 
     def format(node, options = {})

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: origen_doc_helpers
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.8.1
 platform: ruby
 authors:
 - Stephen McGinty
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-12-13 00:00:00.000000000 Z
+date: 2019-07-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: origen
@@ -31,7 +31,6 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- bin/fix_my_workspace
 - config/application.rb
 - config/boot.rb
 - config/commands.rb
@@ -57,7 +56,6 @@ files:
 - templates/model_page.md.erb
 - templates/pdf/topic_wrapper.html
 - templates/shared/_register.html.erb
-- templates/shared/_register.html.erb~
 - templates/shared/_searchable.html.erb
 - templates/shared/_spec.html.erb
 - templates/shared/test/_flow.md.erb

data/bin/fix_my_workspace

@@ -1,100 +0,0 @@
-#!/usr/bin/env ruby
-$VERBOSE = nil  # Don't care about world writable dir warnings and the like
-
-if $_fix_my_workspace_version_check
-  $_fix_my_workspace_version = '0.7.0'
-else
-  if File.exist?(File.expand_path('../../lib/origen.rb', __FILE__))
-    # If this script is being run from within an origen-core workspace, use that Origen-core,
-    # not the system-installed origen-core version.
-    $LOAD_PATH.unshift(File.expand_path('../../lib', __FILE__))
-    require 'origen'
-  else
-    # Use system-installed Origen (the gem in system Ruby)
-    require 'origen'
-  end
-
-  if !Origen.site_config.gem_manage_bundler
-    puts 'Sorry but you have opted to manage Bundler yourself via your Origen site config, and this means'
-    puts 'that I cannot make certain assumptions about how your workspace is configured.'
-    puts 'You will need to either resolve this problem yourself, or else change the value of'
-    puts 'gem_mange_bundler to true.'
-    puts 'See here for more details on how to do that: http://origen-sdk.org/origen/guides/starting/company/'
-
-  else
-    ENV['BUNDLE_GEMFILE'] = File.join(Origen.root, 'Gemfile')
-    ENV['BUNDLE_PATH'] = File.expand_path(Origen.site_config.gem_install_dir)
-    ENV['BUNDLE_BIN'] = File.join(Origen.root, 'lbin')
-
-    # Force copy system gems to local gems
-    if Origen.site_config.gem_use_from_system
-      local_gem_dir = "#{ENV['BUNDLE_PATH']}/ruby/#{Pathname.new(Gem.dir).basename}"
-      gem_dir = Pathname.new(Gem.dir)
-
-      Origen.site_config.gem_use_from_system.each do |gem, version|
-        begin
-          # This will raise an error if the system doesn't have this gem installed, that
-          # will be rescued below
-          spec = Gem::Specification.find_by_name(gem, version)
-
-          local_dir = File.join(local_gem_dir, Pathname.new(spec.gem_dir).relative_path_from(gem_dir))
-          FileUtils.mkdir_p local_dir
-          FileUtils.cp_r("#{spec.gem_dir}/.", local_dir)
-
-          local_file = Pathname.new(File.join(local_gem_dir, Pathname.new(spec.cache_file).relative_path_from(gem_dir)))
-          FileUtils.mkdir_p local_file.dirname
-          FileUtils.cp(spec.cache_file, local_file)
-
-          if spec.extension_dir && File.exist?(spec.extension_dir)
-            local_dir = File.join(local_gem_dir, Pathname.new(spec.extension_dir).relative_path_from(gem_dir))
-            FileUtils.mkdir_p local_dir
-            FileUtils.cp_r("#{spec.extension_dir}/.", local_dir)
-          end
-
-          local_file = Pathname.new(File.join(local_gem_dir, Pathname.new(spec.spec_file).relative_path_from(gem_dir)))
-          FileUtils.mkdir_p local_file.dirname
-          FileUtils.cp(spec.spec_file, local_file)
-
-        rescue Gem::LoadError
-          # This just means that one of the gems that should be copied from the system
-          # was not actually installed in the system, so nothing we can do about that here
-        end
-      end
-    end
-
-    # Delete lbin
-    FileUtils.rm_rf(ENV['BUNDLE_BIN']) if File.exist?(ENV['BUNDLE_BIN'])
-
-    # Run bundler with correct switches
-    cmd = "bundle install --gemfile #{ENV['BUNDLE_GEMFILE']} --binstubs #{ENV['BUNDLE_BIN']} --path #{ENV['BUNDLE_PATH']}"
-    `chmod o-w #{Origen.root}` # Stops some annoying world writable warnings during install
-    `chmod o-w #{Origen.root}/bin` if File.exist?("#{Origen.root}/bin")
-    `chmod o-w #{Origen.root}/.bin` if File.exist?("#{Origen.root}/.bin")
-
-    # Try again, this time updating the bundle
-    if system(cmd)
-      fixed = true
-    elsif system 'bundle update'
-      fixed = true
-    end
-
-    if File.exist?(ENV['BUNDLE_BIN'])
-      `chmod o-w #{ENV['BUNDLE_BIN']}`
-
-      # Make .bat versions of all executables, Bundler should really be doing this when running
-      # on windows
-      if Origen.os.windows?
-        Dir.glob("#{ENV['BUNDLE_BIN']}/*").each do |bin|
-          unless bin =~ /.bat$/
-            bat = "#{bin}.bat"
-            unless File.exist?(bat)
-              File.open(bat, 'w') { |f| f.write('@"ruby.exe" "%~dpn0" %*') }
-            end
-          end
-        end
-      end
-    end
-
-    system 'origen -v' if fixed
-  end
-end

data/templates/shared/_register.html.erb~

@@ -1,368 +0,0 @@
-% reg = options[:reg]
-% order_is_lsb0 = true
-% order_is_lsb0 = false if reg.bit_order == :msb0 || reg.bit_order == 'msb0'
-% include_data = false
-
-<div class="register">
-<a class="anchor" name="<%= "#{reg.name}" %>"></a>
-
-<a href='#<%= reg.name %>'>
-% if options[:origen_path] && !options[:origen_path].empty?
-%   reg_path = options[:origen_path] + "." + reg.name.to_s
-%   reg_path = "#{reg.name} - #{reg_path}"
-% else
-%   reg_path = reg.name
-% end
-% if reg.full_name
-<h4>0x<%= reg.address.to_s(16).upcase %> - <%= reg.full_name %> (<%= reg_path %>)</h4>
-% else
-<h4>0x<%= reg.address.to_s(16).upcase %> - <%= reg_path %></h4>
-% end
-</a>
-
-% if options[:current_value]
-%   if reg.size <= 8
-<h4><font style="background-color: #66FF66">Current Value: <%= sprintf("0x%02X",reg.value) %></font></h4>
-%   elsif reg.size <= 16
-<h4><font style="background-color: #66FF66">Current Value: <%= sprintf("0x%04X",reg.value) %></font></h4>
-%   elsif reg.size <= 24
-<h4><font style="background-color: #66FF66">Current Value: <%= sprintf("0x%06X",reg.value) %></font></h4>
-%   elsif reg.size <= 32
-<h4><font style="background-color: #66FF66">Current Value: <%= sprintf("0x%08X",reg.value) %></font></h4>
-%   end
-% end
-
-% if options[:descriptions]
-<div markdown="1" style="margin: 0 0 20px 0">
-
-% reg.description(:include_name => false).each do |line|
-<%= line.gsub("\\'", "'") %>
-% end
-
-</div>
-% end
-
-% if !order_is_lsb0
-<table class="reg table table-condensed ljust" style="margin-bottom: 0; table-layout: fixed;">
-  <thead>
-    <tr class="bit-positions">
-      <b><tr class = "heading"><%= reg_path%> <span class="msb0_specific" style="color:gray;">(<%= reg_path %>.with_msb0)</span></tr></b>
-    </tr>
-  </thead>
-</table>
-% end
-
-% num_bytes = (reg.size / 8.0).ceil
-% num_bytes.times do |byte_index|
-%   # Need to add support for little endian regs here?
-%   byte_number = num_bytes - byte_index
-%   max_bit = (byte_number * 8) - 1
-%   min_bit = max_bit - 8 + 1
-%   partial_byte = max_bit > (reg.size - 1)
-
-<table class="reg table table-condensed <%= 'rjust' %><%= partial_byte ? ' partial' : '' %>" style="margin-bottom: 0; table-layout: fixed;">
-  <thead>
-    <tr class="bit-positions">
-% if order_is_lsb0
-      <th class="spacer"></th>
-% else
-      <td class="heading">LSB0<span class="msb0_specific" style="color:gray;"> (MSB0)</span></td>
-% end
-
-% 8.times do |i|
-%   bit_num = (byte_number * 8) - i - 1
-%   if bit_num > reg.size - 1
-      <th class="spacer"></th>
-%   else
-%     if order_is_lsb0
-      <th class="bit-position"><%= bit_num %></th>
-%     else
-      <th class="bit-position"><%= bit_num %><span class="msb0_specific" style="color:gray;"> (<%= reg.size - bit_num -1%>)</span></th>
-%     end
-%   end
-% end
-    </tr>
-  </thead>
-  <tbody>
-
-%#############################################    
-%#  Read Row
-%#############################################    
-    <tr class="read">
-% if order_is_lsb0
-      <td class="heading">R</td>
-% else
-      <td class="heading"><span class="msb0_specific" style="color:gray;">[LSB0] </span>R</td>
-% end
-
-% alignment_done = false
-% reg.named_bits :include_spacers => true do |name, bit|
-%  if _bit_in_range?(bit, max_bit, min_bit)
-%   if max_bit > (reg.size - 1) && !alignment_done
-%     (max_bit - (reg.size - 1)).times do
-        <td class="spacer"></td>
-%     end
-%     alignment_done = true
-%   end
-%   if bit.size > 1
-%     if name
-%       if bit.readable?
-%         bit_name = "#{name}[#{bit.size - 1}:0]"
-      <td class="<%= _bit_rw(bit) %>" colspan="<%= _num_bits_in_range(bit, max_bit, min_bit) %>">
-% if options[:descriptions] && !bit.description.empty?
-         <span title="<%= name %>"><a href="#<%= "#{reg.name}_#{name}_#{bit.position}" %>"><%= bit_name %></a></span>
-% else
-         <span title="<%= name %>"><%= bit_name %></span>
-% end
-      </td>
-%       else
-%         if bit.access == :worz
-      <td class="<%= _bit_rw(bit) %>" colspan="<%= _num_bits_in_range(bit, max_bit, min_bit) %>">
-         <span>0</span>
-      </td>
-%         else
-      <td class="<%= _bit_rw(bit) %>" colspan="<%= _num_bits_in_range(bit, max_bit, min_bit) %>"></td>
-%         end
-%       end
-%     else
-%       bit.shift_out_left do |bit|
-%         if _index_in_range?(bit.position, max_bit, min_bit)
-      <td>0</td> 
-%         end
-%       end
-%     end
-%   else
-%     if name
-%       if bit.readable?
-%         if name.size > 10
-%           bit_name = "#{name[0..2]}...#{name[-3..-1]}"
-%#           bit_name = "bit#{bit.position}*"
-%         else
-%           bit_name = name
-%         end
-%         if options[:descriptions] && !bit.description.empty?
-      <td class="<%= _bit_rw(bit) %>"><span title="<%= name %>"><a href="#<%= "#{reg.name}_#{name}_#{bit.position}" %>"><%= bit_name %></a></span></td>
-%         else
-      <td class="<%= _bit_rw(bit) %>"><span title="<%= name %>"><%= bit_name %></span></td>
-%         end
-%       else
-      <td class="<%= _bit_rw(bit) %>"></td>
-%       end
-%     else
-      <td>0</td> 
-%     end
-%   end
-%  end
-% end
-    </tr>
-
-%#############################################    
-%#  Write Row
-%#############################################    
-    <tr class="write">
-      <td class="heading">W</td>
-% alignment_done = false
-% reg.named_bits :include_spacers => true do |name, bit|
-%  if _bit_in_range?(bit, max_bit, min_bit)
-%   if max_bit > (reg.size - 1) && !alignment_done
-%     (max_bit - (reg.size - 1)).times do
-      <td class="spacer"></td>
-%     end
-%     alignment_done = true
-%   end
-%   if bit.size > 1
-%     if name
-%       if !bit.readable?
-%         bit_name = "#{name}[#{bit.size - 1}:0]"
-      <td class="<%= _bit_rw(bit) %>" colspan="<%= _num_bits_in_range(bit, max_bit, min_bit) %>">
-% if options[:descriptions] && !bit.description.empty?
-         <span title="<%= name %>"><a href="#<%= "#{reg.name}_#{name}_#{bit.position}" %>"><%= bit_name %></a></span>
-% else
-         <span title="<%= name %>"><%= bit_name %></span>
-% end
-      </td>
-%       else
-      <td class="<%= _bit_rw(bit) %>" colspan="<%= _num_bits_in_range(bit, max_bit, min_bit) %>"></td>
-%       end
-%     else
-%       bit.shift_out_left do |bit|
-%         if _index_in_range?(bit.position, max_bit, min_bit)
-      <td class="not-writable"></td> 
-%         end
-%       end
-%     end
-%   else
-%     if name
-%       if !bit.readable?
-%         if name.size > 10
-%           bit_name = "#{name[0..2]}...#{name[-3..-1]}"
-%#           bit_name = "bit#{bit.position}*"
-%         else
-%           bit_name = name
-%         end
-%         if options[:descriptions] && !bit.description.empty?
-      <td class="<%= _bit_rw(bit) %>"><span title="<%= name %>"><a href="#<%= "#{reg.name}_#{name}_#{bit.position}" %>"><%= bit_name %></a></span></td>
-%         else
-      <td class="<%= _bit_rw(bit) %>"><span title="<%= name %>"><%= bit_name %></span></td>
-%         end
-%       else
-      <td class="<%= _bit_rw(bit) %>"></td>
-%       end
-%     else
-      <td class="not-writable"></td> 
-%     end
-%   end
-%  end
-% end
-    </tr>
-
-% if options[:current_value]
-    <tr class="current_value">
-      <td class="heading">Current Value (Hex)</td>
-%   alignment_done = !order_is_lsb0
-%   reg.named_bits :include_spacers => true do |name, bit|
-%     if _bit_in_range?(bit, max_bit, min_bit)
-%       if max_bit > (reg.size - 1) && !alignment_done
-%         (max_bit - (reg.size - 1)).times do
-      <td class="spacer"></td>
-%       end
-%       alignment_done = true
-%     end
-%     if bit.size > 1
-%       if name
-%         if bit.nvm_dep != 0 || bit.data == :memory
-            <td colspan="<%= _num_bits_in_range(bit, max_bit, min_bit) %>">M</td>
-%         elsif bit.data == :undefined
-            <td colspan="<%= _num_bits_in_range(bit, max_bit, min_bit) %>">X</td>
-%         else
-            <td colspan="<%= _num_bits_in_range(bit, max_bit, min_bit) %>"><%= bit.data[_max_bit_in_range(bit, max_bit, min_bit).._min_bit_in_range(bit, max_bit, min_bit)].to_s(16).upcase %></td>
-%         end
-%       else
-%         bit.shift_out_left do |bit|
-%           if _index_in_range?(bit.position, max_bit, min_bit)
-      <td></td> 
-%           end
-%         end
-%       end
-%     else
-%       if bit.nvm_dep != 0 || bit.reset_val == :memory
-        <td>M</td>
-%       elsif bit.data == :undefined
-        <td>X</td>
-%       else
-        <td><%= bit.data.to_s(16).upcase %></td>
-%       end
-%     end
-%    end
-%   end
-    </tr>
-% else
-%#############################################    
-%#  Reset Row
-%#############################################    
-    <tr class="reset">
-      <td class="heading">Reset</td>
-%   alignment_done = false
-%   reg.named_bits :include_spacers => true do |name, bit|
-%   if _bit_in_range?(bit, max_bit, min_bit)
-%     if max_bit > (reg.size - 1) && !alignment_done
-%       (max_bit - (reg.size - 1)).times do
-      <td class="spacer"></td>
-%       end
-%       alignment_done = true
-%     end
-%     if bit.size > 1
-%       if name
-%         if bit.nvm_dep != 0 || bit.reset_val == :memory
-            <td colspan="<%= _num_bits_in_range(bit, max_bit, min_bit) %>">M</td>
-%         elsif bit.reset_val == :undefined
-            <td colspan="<%= _num_bits_in_range(bit, max_bit, min_bit) %>">X</td>
-%         else
-            <td colspan="<%= _num_bits_in_range(bit, max_bit, min_bit) %>"><%= bit.reset_val[_max_bit_in_range(bit, max_bit, min_bit).._min_bit_in_range(bit, max_bit, min_bit)].to_s(16).upcase %></td>
-%         end
-%       else
-%         bit.shift_out_left do |bit|
-%           if _index_in_range?(bit.position, max_bit, min_bit)
-      <td></td> 
-%           end
-%         end
-%       end
-%     else
-%       if bit.nvm_dep != 0 || bit.reset_val == :memory
-        <td>M</td>
-%       elsif bit.reset_val == :undefined
-        <td>X</td>
-%       else
-        <td><%= bit.reset_val.to_s(16).upcase %></td>
-%       end
-%     end
-%    end
-% end
-    </tr>
-% end
-  </tbody>
-</table>
-
-% end # Byte index loop
-
-% if options[:descriptions] && reg.named_bits.any? { |name, bits| !bits.description.empty? }
-<table class="bit-descriptions table table-condensed table-bordered" style="margin: 20px 0 0 0">
-  <thead>
-    <tr>
-      <th>Bit</th>
-      <th>Description</th>
-    </tr>
-  </thead>
-  <tbody>
-% reg.named_bits do |name, bits| 
-    <tr>
-      <td>
-        <p>
-          <a class="anchor" name="<%= "#{reg.name}_#{name}_#{bits.position}" %>"></a>
-% if bits.size == 1        
-          <%= bits.position %><%= order_is_lsb0 ? '' : "<span class="msb0_specific" style="color:gray;"> (#{reg.size - bits.position - 1})</span>" %>
-% else
-          <%= bits.position + bits.size - 1 %>-<%= bits.position %><%= order_is_lsb0 ? '' : "<span class="msb0_specific" style="color:gray;"> (#{reg.size - bits.position - bits.size}-#{reg.size - bits.position - 1})</span>" %>
-% end
-        </p>
-        <p>
-% if bits.size == 1        
-          <%= name %>
-% else
-          <%= name %>[<%= bits.size - 1 %>:0]<%= order_is_lsb0 ? '' : "<span class="msb0_specific" style="color:gray;"> ([0:#{bits.size - 1}])</span>" %>
-% end
-        </p>
-      </td>
-<td markdown="1">
-% bit_val_str = ''
-% start_bit = bits.position
-% end_bit = bits.position + bits.size - 1
-% (start_bit..end_bit).each do |b|
-%  bit_val_str << reg.bits[b].data.to_s
-% end
-% bit_val_str.reverse!
-% bits.description.each do |line|
-%   if options[:current_value]
-%     if line =~ /^\d{#{bit_val_str.length}}/ 
-%       if line =~ /^#{bit_val_str}/
-<span style="background-color: #66FF66"> <%=        line.gsub("\\'", "'") %>
-</span><br/>
-%       else
-<%=        line.gsub("\\'", "'") %><br/>
-%       end
-%     else
-<%=        line.gsub("\\'", "'") %>
-%     end
-%   else
-<%= line.gsub("\\'", "'") %>
-%   end
-% end
-
-</td>
-    </tr>  
-% end
-  </tbody>
-</table>  
-% end    
-
-</div>