origen 0.34.3 → 0.52.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: fb9589bd8d0179a20919b1adf594cd400fa7f882
-  data.tar.gz: e898d8031d277cc479d1c84ebc36c775f15b419e
+SHA256:
+  metadata.gz: 66da9dd0e7daf45df9ed1b3296be702222ccfbdd9a7daa9d4258e13b8170a2d9
+  data.tar.gz: d4e0594b55959d9d98a8971f08e87d2fd62074f72076c21a5a75b3d667996638
 SHA512:
-  metadata.gz: 54571cf52125b281cd1613800dde84b6c8ddb639076b7dd89328ebaed4c32e6d3e45c27723b4fb7b179c72ca59d278f986ff7b8b3da721542e27d06483fb7fa8
-  data.tar.gz: fefb815678df5803d5f9f6b76de81ce52254455c3b7fd2a1e7d47e475bf99c98ac41611abbcd8a48fc1bffc765b76c8fdd7d4d4a63015a55dffcb9254631ac7a
+  metadata.gz: 25583f8f1033819423e649ddd3743e7b7a4a523b12724985e34b2b06d5dd83d3495e8eae9949cd5e6049b94548374a2c2ee3f9088815667a85c1d3e17633787a
+  data.tar.gz: e4d661a56516345b15ad2fa812fdb11ed171a3a067d6b5c86dc837bf4429c11244ab43ebe7677f9db16f442bf882aafbb7dcf2091cf4b14cfb0f14c86627e676

data/bin/origen

@@ -1,232 +1,2 @@
 #!/usr/bin/env ruby
-$VERBOSE = nil  # Don't care about world writable dir warnings and the like
-
-require 'pathname'
-require 'fileutils'
-#require 'byebug' # Un-comment to debug this file
-
-class OrigenBootError < StandardError
-end
-
-# Keep a note of the pwd at the time when Origen was first loaded, this is initially used
-# by the site_config lookup.
-$_origen_invocation_pwd ||= Pathname.pwd
-
-load File.expand_path('../../lib/origen/operating_systems.rb', __FILE__)
-load File.expand_path('../../lib/origen/site_config.rb', __FILE__)
-
-# This will be referenced later in ruby_version_check, the origen used to launch
-# the process is different than the one that actually runs under bundler
-$origen_launch_root = Pathname.new(File.dirname(__FILE__)).parent
-
-# Override any influence from $LANG in the users environment
-Encoding.default_external = Encoding::UTF_8
-Encoding.default_internal = Encoding::UTF_8
-ENV['LC_ALL'] = nil
-ENV['LANG'] = nil
-ENV['LANG'] = 'en_US.UTF-8'
-
-# Work out what Origen.root is if we are running inside an Origen application, this will be
-# later used to execute from that app's bundle even if the origen executable lives somewhere
-# else (e.g. in the tools repository)
-app_config = File.join('config', 'application.rb')
-if File.exist?(app_config)
-  origen_root = Dir.pwd
-else
-  path = Pathname.new(Dir.pwd)
-  until path.root? || origen_root
-    if File.exist?(File.join(path, app_config))
-      origen_root = path.to_s
-    else
-      path = path.parent
-    end
-  end
-end
-
-# If running inside an application workspace
-if origen_root
-  # Force everyone to have a consistent way of installing gems with bundler
-  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')
-
-  # If it looks like a bundled binstub of origen exists, and we have not been invoked through that,
-  # then run that instead.
-  if Origen.site_config.gem_manage_bundler && File.exist?("#{origen_root}/lbin/origen") && !ENV['BUNDLE_BIN_PATH'] &&
-     File.exist?(File.expand_path(Origen.site_config.gem_install_dir))
-    exec Gem.ruby, "#{origen_root}/lbin/origen", *ARGV
-    exit 0
-  end
-  
-  boot_app = true
-
-# If running outside an application and a user or central tool Origen bundle is to be used
-elsif Origen.site_config.gem_manage_bundler && (Origen.site_config.user_install_enable || Origen.site_config.tool_repo_install_dir)
-  # Force everyone to have a consistent way of installing gems with bundler.
-  # In this case, we aren't running from an Origen application, so build everything at Origen.home instead
-  # Have two options here: if user_install_enable is true, use user_install_dir. Otherwise, use the tool_repo_install_dir
-  Origen.site_config.user_install_enable ? origen_root = File.expand_path(Origen.site_config.user_install_dir) : origen_root = File.expand_path(Origen.site_config.tool_repo_install_dir)
-  unless Dir.exists?(origen_root)
-    load File.expand_path('../../lib/origen/utility/input_capture.rb', __FILE__)
-    include Origen::Utility::InputCapture
-    
-    puts "Root directory '#{origen_root}' does not exist. Would you like to create it?"
-    if get_text(confirm: :return_boolean)
-      FileUtils.mkdir(origen_root)
-    else
-      puts "Exiting with creating Origen install"
-      exit!
-    end
-  end
-  
-  gemfile = File.join(origen_root, 'Gemfile')
-  unless File.exists?(gemfile)
-    # Create a default Gemfile that can be further customized by the user.
-    # Initial Gemfile only requires Origen. Nothing else. Essentially a blank installation.
-    Dir.chdir(origen_root) do
-      `bundle init`
-    end
-    # The above will give a general Gemfile from Bundler. We'll just append "gem 'origen' to the end.
-    File.open(gemfile, 'a') do |f|
-     f << "gem 'origen'\n"
-    end
-  end
-  ENV['BUNDLE_GEMFILE'] = gemfile
-  ENV['BUNDLE_PATH'] = File.expand_path(Origen.site_config.gem_install_dir)
-  ENV['BUNDLE_BIN'] = File.join(origen_root, 'lbin')
-
-  origen_exec = File.join(ENV['BUNDLE_BIN'], 'origen')
-
-  # If the user/tool bundle already exists but we have not been invoked through that, abort this thread
-  # and re-launch under the required bundler environment
-  if File.exist?(origen_exec) && !ENV['BUNDLE_BIN_PATH'] && File.exist?(ENV['BUNDLE_PATH'])
-    exec Gem.ruby, origen_exec, *ARGV
-    exit 0
-  else
-    boot_app = false
-  end
-end
-
-if origen_root && File.exist?(ENV['BUNDLE_GEMFILE']) && Origen.site_config.gem_manage_bundler && (boot_app || Origen.site_config.user_install_enable || Origen.site_config.tool_repo_install_dir)
-  # Overriding bundler here so that bundle install can be automated as required
-  require 'bundler/shared_helpers'
-  if Bundler::SharedHelpers.in_bundle?
-    require 'bundler'
-    if STDOUT.tty?
-      begin
-        fail OrigenBootError unless File.exist?(ENV['BUNDLE_BIN'])
-        Bundler.setup
-        fail OrigenBootError unless File.exist?(ENV['BUNDLE_BIN'])
-      rescue Gem::LoadError, Bundler::BundlerError, OrigenBootError => e
-        cmd = "bundle install --gemfile #{ENV['BUNDLE_GEMFILE']} --binstubs #{ENV['BUNDLE_BIN']} --path #{ENV['BUNDLE_PATH']}"
-        # puts cmd
-        puts 'Installing required gems...'
-        puts
-        `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")
-        result = false
-
-        Bundler.with_clean_env do
-          if Origen.os.unix?
-            if Origen.site_config.gem_build_switches
-              Origen.site_config.gem_build_switches.each do |switches|
-                `bundle config build.#{switches}`
-              end
-            end
-          end
-          result = system(cmd)
-        end
-        `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?
-          bat_present = File.exist? "#{origen_root}/lbin/origen.bat"
-          Dir.glob("#{origen_root}/lbin/*").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
-          if !bat_present && !result
-            puts 'Some Windows specific updates to your workspace were required, please re-run the last command'
-            exit 0
-          end
-        end
-        if result
-          exec "origen #{ARGV.join(' ')}"
-          exit 0
-        else
-          puts
-          puts "If you have just updated a gem version and are now getting an error that Bundler cannot find compatible versions for it then first try running 'bundle update <gemname>'."
-          puts "For example if you have just changed the version of origen_core run 'bundle update origen_core'."
-          exit 1
-        end
-      end
-    else
-      Bundler.setup
-    end
-  end
-  require 'bundler/setup'
-  require 'origen'
-else
-  $LOAD_PATH.unshift "#{File.expand_path(File.dirname(__FILE__))}/../lib"
-  require 'origen'
-end
-
-begin
-  # If this script has been invoked from within an Origen application then open
-  # up all commands, if not then only allow the command to create a new Origen
-  # application.
-  if origen_root && boot_app
-    require 'origen/commands'
-  else
-    require 'origen/commands_global'
-  end
-rescue Exception => e
-  # A formatted stack dump will not be printed if the application ends via 'exit 0' or 'exit 1'. In that
-  # case the application code is responsible for printing a helpful error message.
-  # This will intercept all other exits, e.g. via 'fail "Something has done wrong"', and split the stack
-  # dump to separate all in-application references from Origen core/plugin references.
-  if e.is_a?(SystemExit)
-    exit e.status
-  else
-    puts
-    if Origen.app_loaded?
-      puts 'COMPLETE CALL STACK'
-      puts '-------------------'
-      puts e.message unless e.is_a?(SystemExit)
-      puts e.backtrace
-
-      puts
-      puts 'APPLICATION CALL STACK'
-      puts '----------------------'
-      puts e.message unless e.is_a?(SystemExit)
-      # Only print out the application stack trace by default, if verbose logging is
-      # enabled then output the full thing
-      e.backtrace.each do |line|
-        path = Pathname.new(line)
-        if path.absolute?
-          if line =~ /^#{Origen.root}/ && line !~ /^#{Origen.root}\/lbin/
-            puts line
-          end
-        else
-          puts line unless line =~ /^.\/lbin/
-        end
-      end
-    else
-      puts 'COMPLETE CALL STACK'
-      puts '-------------------'
-      puts e.message unless e.is_a?(SystemExit)
-      puts e.backtrace
-    end
-    exit 1
-  end
-ensure
-  if Origen.app_loaded?
-    Origen.app.listeners_for(:on_origen_shutdown).each(&:on_origen_shutdown)
-    Origen.app.runner.shutdown
-  end
-end
+load File.expand_path('../../lib/origen/boot.rb', __FILE__)

data/config/application.rb

@@ -38,7 +38,8 @@ class OrigenCoreApplication < Origen::Application
 
   #config.lsf.project = "origen core"
   
-  config.web_directory = "git@github.com:Origen-SDK/Origen-SDK.github.io.git/origen"
+  config.web_directory = "https://github.com/Origen-SDK/Origen-SDK.github.io.git/origen"
+  #config.web_directory = "git@github.com:Origen-SDK/Origen-SDK.github.io.git/origen"
   config.web_domain = "http://origen-sdk.org/origen"
   
   config.pattern_prefix = "nvm"
@@ -78,13 +79,13 @@ class OrigenCoreApplication < Origen::Application
     iterator.key = :by_block
 
     iterator.loop do |&pattern|
-      $nvm.blocks.each do |block|
+      dut.nvm.blocks.each do |block|
         pattern.call(block)
       end
     end
 
     iterator.setup do |block|
-      blk = $nvm.find_block_by_id(block.id)
+      blk = dut.nvm.find_block_by_id(block.id)
       blk.select
       blk
     end
@@ -119,6 +120,14 @@ class OrigenCoreApplication < Origen::Application
     end
   end
 
+  def before_release_gem
+    Dir.chdir Origen.root do
+      FileUtils.rm_rf('origen_app_generators') if File.exist?('origen_app_generators')
+      FileUtils.cp_r(Origen.app(:origen_app_generators).root, 'origen_app_generators')
+      FileUtils.rm_rf(File.join('origen_app_generators', '.git'))
+    end
+  end
+
   # Ensure that all tests pass before allowing a release to continue
   def validate_release
     if !system("origen specs") || !system("origen examples")

data/config/boot.rb

@@ -1,8 +1,3 @@
-# Interfaces must be required, can't autoload
-require "c99/ate_interface"
-# The majority of this class is defined in the support application,
-# this is to test that the importing application can override and
-# extend imported classes.
-require_relative "../lib/c99/nvm"
-
 require_relative "../helpers/guides"
+
+require "#{Origen.root(:origen_sim)}/config/boot"

data/config/commands.rb

@@ -15,83 +15,12 @@ when "tags"
   exit 0
 
 when "specs"
+  Origen.app.session.origen_core[:mode] = 'debug'
   require "rspec"
-
-  options = {}
-  opt_parser = OptionParser.new do |opts|
-    opts.banner = [
-      'Run the specs unit tests',
-      'Usage: origen specs [filename_substrings...] [options]',
-      "Note: all files must reside in #{Origen.app.root}/specs for filename substrings",
-      "E.g.: origen specs site_config #=> runs only specs in filenames matching 'site_config'"
-    ].join("\n")
-    opts.on('-h', '--help', 'Show this help message') do |h|
-      puts opt_parser
-      exit!
-    end
-  end
-  opt_parser.parse! ARGV
-
-  # Search for the filenames given. 
-  spec_files = ARGV.map do |file|
-    f = Pathname.new(file)
-    dir = Origen.app.root.join('spec')
-
-    # Find any files that match the name. Include all these files.
-    # Note that this will map a string to an array, so we'll flatten the array later.
-    # Also, we'll only search for .rb files in spec. Append that to the glob if no file ext is provided.
-    if f.exist? && f.extname == '.rb'
-      # This is a hard-coded path. Don't glob this, just make sure its witin the spec directory.
-      File.expand_path(f)
-    elsif f.extname == '.rb'
-      # Search includes the extension, so don't add it.
-      # (limited to .rb files)
-      Dir.glob(dir.join("**/*#{f}"))
-    else
-      # Search for matching ruby files.
-      # (limited to .rb files)
-      Dir.glob(dir.join("**/*#{f}*.rb"))
-    end
-  end
-  spec_files.flatten!
-
-  if ARGV.empty?
-    # No filename substrings given. Run all *_spec files in spec/ directory
-    spec_files = ['spec']
-  elsif spec_files.empty? && !ARGV.empty?
-    # The spec files to run is empty, but file substring were given.
-    # Report that no files were found and exit.
-    Origen.app!.fail!(message: "No matching spec files could be found at #{Origen.app.root}/spec for patterns: #{ARGV.join(', ')}")
-  else
-    # Filename substrings were given and matching files were found. List the files just for user awareness.
-    Origen.log.info "Found matching specs files for patterns: #{ARGV.join(', ')}"
-    spec_files.each { |f| Origen.log.info(f) }
-  end
-
-  current_mode = Origen.mode.instance_variable_get(:@current_mode)
-  Origen.mode = :debug
-  Origen.app.session.origen_core[:mode] = Origen.mode.to_s
-  begin
-    status = RSpec::Core::Runner.run(spec_files)
-  rescue SystemExit => e
-    Origen.log.error "Unexpected SystemExit reached. Reporting failure status..."
-    status = 1
-  end
-  Origen.mode = current_mode
-  Origen.app.session.origen_core[:mode] = Origen.mode.to_s
-  
-  # One kind of confusing thing is that Specs can still print the 'pass'/'success' verbiage even when it actually failed.
-  # This is due to rspec itself catching the errors, so there's no exception to catch from outside Rspec.
-  # Most likely the user will see red and see that nothing was actually run, but print a reassuring message from Origen saying that the specs actually failed,
-  # despite what Rspec's verbiage says.
-  if status == 1
-    Origen.log.error "Some errors occurred outside of the examples: received exit status 1 (failure). Please review RSpec output for details."
-  end
-
-  exit(status)
+  exit RSpec::Core::Runner.run(['spec'])
 
 when "examples", "test"  
-  Origen.load_application
+  Origen.app.session.origen_core[:mode] = 'debug'
   status = 0
   Dir["#{Origen.root}/examples/*.rb"].each do |example|
     require example

data/config/rubocop/easy_disabled.yml

@@ -269,3 +269,7 @@ Rails/ScopeArgs:
 Rails/Validation:
   Description: 'Use validates :attribute, hash of validations.'
   Enabled: false
+
+Style/ClassAndModuleChildren:
+  Description: 'Checks style of children classes and modules.'
+  Enabled: false

data/config/rubocop/easy_enabled.yml

@@ -78,10 +78,6 @@ Style/CharacterLiteral:
   StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-character-literals'
   Enabled: true
 
-Style/ClassAndModuleChildren:
-  Description: 'Checks style of children classes and modules.'
-  Enabled: true
-
 Style/ClassCheck:
   Description: 'Enforces consistent use of `Object#is_a?` or `Object#kind_of?`.'
   Enabled: true

data/config/rubocop/strict_disabled.yml

@@ -245,3 +245,7 @@ Rails/ScopeArgs:
 Rails/Validation:
   Description: 'Use validates :attribute, hash of validations.'
   Enabled: false
+
+Style/ClassAndModuleChildren:
+  Description: 'Checks style of children classes and modules.'
+  Enabled: false

data/config/rubocop/strict_enabled.yml

@@ -88,10 +88,6 @@ Style/CharacterLiteral:
   StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-character-literals'
   Enabled: true
 
-Style/ClassAndModuleChildren:
-  Description: 'Checks style of children classes and modules.'
-  Enabled: true
-
 Style/ClassCheck:
   Description: 'Enforces consistent use of `Object#is_a?` or `Object#kind_of?`.'
   Enabled: true

data/config/version.rb

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

data/lib/origen.rb

@@ -12,8 +12,10 @@ unless defined? RGen::ORIGENTRANSITION
   # by the site_config lookup.
   $_origen_invocation_pwd ||= Pathname.pwd
   require 'fileutils'
-  require 'origen/site_config'
-  require 'origen/operating_systems'
+  # Force these to re-load since they could have been loaded from an earlier version of Origen during boot
+  load 'origen/loader.rb'
+  load 'origen/site_config.rb'
+  load 'origen/operating_systems.rb'
   require 'origen/core_ext'
   require 'origen/acronyms'
   require 'origen/callbacks'
@@ -24,11 +26,13 @@ unless defined? RGen::ORIGENTRANSITION
   require 'origen/remote_manager'
   require 'origen/utility'
   require 'origen/logger_methods'
-  require 'option_parser/optparse'
+  require 'origen/core_ext/option_parser/optparse'
   require 'bundler'
   require 'origen/undefined'
   require 'origen/componentable'
 
+  autoload :PatSeq,              'origen/generator/pattern_sequencer'
+
   module Origen
     autoload :Features,          'origen/features'
     autoload :Bugs,              'origen/bugs'
@@ -74,17 +78,14 @@ unless defined? RGen::ORIGENTRANSITION
 
     APP_CONFIG = File.join('config', 'application.rb')
 
-    class OrigenError < StandardError
-      def self.status_code(code)
-        define_method(:status_code) { code }
-      end
-    end
-
-    class PerforceError < OrigenError;  status_code(11); end
-    class GitError < OrigenError; status_code(11); end
-    class DesignSyncError < OrigenError; status_code(12); end
-    class RevisionControlUninitializedError < OrigenError; status_code(13); end
-    class SyntaxError < OrigenError; status_code(14); end
+    class OrigenError < StandardError; end
+    class PerforceError < OrigenError; end
+    class GitError < OrigenError; end
+    class DesignSyncError < OrigenError; end
+    class RevisionControlUninitializedError < OrigenError; end
+    class SyntaxError < OrigenError; end
+    class BinStrValError < OrigenError; end
+    class HexStrValError < OrigenError; end
 
     class << self
       include Origen::Utility::TimeAndDate
@@ -290,6 +291,7 @@ unless defined? RGen::ORIGENTRANSITION
 
       # Returns true if Origen is running in an application workspace
       def in_app_workspace?
+        return @in_app_workspace if defined? @in_app_workspace
         @in_app_workspace ||= begin
           path = Pathname.new(Dir.pwd)
           until path.root? || File.exist?(File.join(path, APP_CONFIG))
@@ -660,6 +662,10 @@ unless defined? RGen::ORIGENTRANSITION
         @running_remotely = val
       end
 
+      def running_simulation?
+        !!(defined?(OrigenSim) && Origen.tester && Origen.tester.sim?)
+      end
+
       # Returns true if Origen is running interactively. That is, the command was 'origen i'
       def running_interactively?
         !!@running_interactively
@@ -776,6 +782,13 @@ unless defined? RGen::ORIGENTRANSITION
         end
       end
 
+      # OS agnostic split of a caller line into file and line number
+      def split_caller_line(line)
+        arr = line.split(':')
+        arr[0] = arr[0] + ':' + arr.delete_at(1) if Origen.os.windows?
+        arr
+      end
+
       private
 
       def current_command=(val)