origen 0.34.3 → 0.52.0

data/lib/origen/commands/generate.rb

@@ -21,6 +21,7 @@ opt_parser = OptionParser.new do |opts|
   opts.on('--doc', 'Generate into doc format') { options[:doc] = true }
   opts.on('--html', 'Generate into html format') { options[:html] = true }
   opts.on('--nocom', 'No comments in the generated pattern') { options[:no_comments] = true }
+  opts.on('-seq', '--sequence NAME', String, 'Generate multiple patterns into a single concurrent pattern sequence') { |o| options[:sequence] = o }
   opts.on('-d', '--debugger', 'Enable the debugger') {  options[:debugger] = true }
   opts.on('-m', '--mode MODE', Origen::Mode::MODES, 'Force the Origen operating mode:', '  ' + Origen::Mode::MODES.join(', ')) { |_m| }
   # Apply any application option extensions to the OptionParser

data/lib/origen/commands/lint.rb

@@ -32,7 +32,12 @@ if ARGV.empty?
   if Origen.config.lint_test[:files]
     files = Origen.config.lint_test[:files].map { |f| "#{Origen.root}/#{f}" }.join(' ')
   else
-    files = "#{Origen.root}/lib"
+    files = []
+    ['lib', 'app/lib', 'app/blocks'].each do |sub_dir|
+      dir = "#{Origen.root}/#{sub_dir}"
+      files << dir if File.exist?(dir)
+    end
+    files = files.join(' ')
   end
 else
   files = ARGV.join(' ')

data/lib/origen/commands/new.rb

@@ -62,10 +62,15 @@ else
   end
 end
 
-generators = [['http://rubygems.org', 'origen_app_generators']] + Array(Origen.site_config.app_generators)
+generators = [['https://rubygems.org', 'origen_app_generators']] + Array(Origen.site_config.app_generators)
+
+def use_packaged_generators
+  puts "Using origen_app_generators that was packaged with Origen #{Origen.version}"
+  FileUtils.cp_r Origen.top.join('origen_app_generators').to_s, '.'
+  FileUtils.mv 'origen_app_generators', '0'
+end
 
 if update_required
-  puts 'Fetching the latest app generators...'
   FileUtils.rm_rf(generators_dir) if File.exist?(generators_dir)
   FileUtils.mkdir_p(generators_dir)
 
@@ -73,47 +78,66 @@ if update_required
     generators.each_with_index do |gen, i|
       # If a reference to a gem from a gem server
       if gen.is_a?(Array)
-        response = HTTParty.get("#{gen[0]}/api/v1/dependencies.json?gems=#{gen[1]}")
+        begin
+          print "Determining the latest version of #{gen[1]}..."
+          response = HTTParty.get("#{gen[0]}/api/v1/dependencies.json?gems=#{gen[1]}", timeout: 2)
 
-        if response.success?
-          latest_version = JSON.parse(response.body).map { |v| v['number'] }.max
-
-          response = HTTParty.get("#{gen[0]}/gems/#{gen[1]}-#{latest_version}.gem")
           if response.success?
-            File.open("#{gen[1]}-#{latest_version}.gem", 'wb') do |f|
-              f.write response.parsed_response
+            latest_version = JSON.parse(response.body).map { |v| v['number'] }.max
+            puts latest_version.to_s
+
+            url = "#{gen[0]}/gems/#{gen[1]}-#{latest_version}.gem"
+            print "Fetching #{url}..."
+            response = HTTParty.get(url, timeout: 5)
+            if response.success?
+              puts 'SUCCESS'
+              File.open("#{gen[1]}-#{latest_version}.gem", 'wb') do |f|
+                f.write response.parsed_response
+              end
+
+              `gem unpack #{gen[1]}-#{latest_version}.gem`
+              FileUtils.rm_rf("#{gen[1]}-#{latest_version}.gem")
+              FileUtils.mv("#{gen[1]}-#{latest_version}", i.to_s)
+            else
+              puts 'FAILED'
+              use_packaged_generators if i == 0
             end
           else
-            puts "Sorry, could not find generator #{gen[1]} version #{latest_version}"
+            puts 'FAILED'
+            use_packaged_generators if i == 0
           end
-
-          `gem unpack #{gen[1]}-#{latest_version}.gem`
-          FileUtils.rm_rf("#{gen[1]}-#{latest_version}.gem")
-          FileUtils.mv("#{gen[1]}-#{latest_version}", i.to_s)
-
-        else
-          puts "Failed to get generator #{gen[1]}, the response from the server was:"
-          puts response.body
+        rescue
+          puts 'FAILED'
+          use_packaged_generators if i == 0
         end
 
       # If a reference to a git repo
       elsif gen.to_s =~ /\.git$/
-        Origen::RevisionControl.new(remote: gen, local: i.to_s).checkout(version: 'master', force: true)
+        begin
+          print "Fetching #{gen}..."
+          Origen::RevisionControl.new(remote: gen, local: i.to_s).checkout(version: 'master', force: true)
+          puts 'SUCCESS'
+        rescue
+          puts 'FAILED'
+        end
 
       # Assume a reference to a folder
       else
-        if File.exist?(gen)
-          FileUtils.cp_r(gen, i.to_s)
-        else
-          puts "Failed to find generator at #{gen}"
+        begin
+          FileUtils.cp_r(gen, i.to_s) if File.exist?(gen)
+          puts 'SUCCESS'
+        rescue
+          puts 'FAILED'
         end
-
       end
     end
 
     Origen.session.app_generators[generators_dir] = Time.now
   end
+else
+  puts 'Using cached app generators, run again with -f if you want to force a refresh'
 end
+puts
 
 generators.each_with_index do |gen, i|
   lib = "#{generators_dir}/#{i}/lib"

data/lib/origen/commands/new_resource.rb

@@ -0,0 +1,41 @@
+# require 'optparse'
+# require 'origen/commands/helpers'
+#
+# options = {}
+#
+## App options are options that the application can supply to extend this command
+# app_options = @application_options || []
+# opt_parser = OptionParser.new do |opts|
+#  opts.banner = 'Usage: origen new RESOURCE_TYPE RESOURCE_NAME [options]'
+#  opts.on('-d', '--debugger', 'Enable the debugger') {  options[:debugger] = true }
+#  # Apply any application option extensions to the OptionParser
+#  Origen::CommandHelpers.extend_options(opts, app_options, options)
+#  opts.separator ''
+#  opts.on('-h', '--help', 'Show this message') { puts opts; exit }
+# end
+#
+# opt_parser.parse! ARGV
+#
+# command = ARGV.shift
+#
+# case command
+# when "model"
+#
+#
+# else
+#  puts "Unknown resource type, must be one of: model"
+#  exit 1
+# end
+
+require 'origen/code_generators'
+
+# if no argument/-h/--help is passed to origen add command, then
+# it generates the help associated.
+if [nil, '-h', '--help'].include?(ARGV.first)
+  Origen::CodeGenerators.help 'new'
+  exit
+end
+
+name = ARGV.shift
+
+Origen::CodeGenerators.invoke name, ARGV # , behavior: :invoke, destination_root: Origen.root

data/lib/origen/commands/site.rb

@@ -0,0 +1,52 @@
+require 'optparse'
+require 'pathname'
+require 'origen/commands/helpers'
+
+module Origen
+  options = {}
+
+  # App options are options that the application can supply to extend this command
+  app_options = @application_options || []
+  opt_parser = OptionParser.new do |opts|
+    opts.banner = <<-END
+  env [filters...] Shows the current site environment configuration. Analogous to 'env' for shell environment.
+                  In other words, lists all the site config variables and their values.
+                  Aliased to 'environment'.
+
+  configs         Shows the current config files used and their indexes.
+
+  inspect_config [config_indexes...] Inspects the configuration(s) at each index given.
+                                     Indexes can be found from 'origen site configs'
+                                     If no indexes are given, all configs are printed.
+
+  inspect_variable [variable_names...] Inspects and traces the variable(s) through the various sites configs.
+
+  refresh         Forces a refresh of the centralized site config. This will reset the timer for the next automatc refresh.
+    END
+
+    # Apply any application option extensions to the OptionParser
+    Origen::CommandHelpers.extend_options(opts, app_options, options)
+    opts.separator ''
+    opts.on('-h', '--help', 'Show this message') { puts opts; exit }
+  end
+  opt_parser.parse! ARGV
+
+  if ARGV[0]
+    case ARGV.shift
+    when 'env', 'environment'
+      Origen.site_config.pretty_print_env(*ARGV)
+    when 'configs'
+      Origen.site_config.pretty_print_configs
+    when 'inspect_config', 'inspect_configs'
+      Origen.site_config.inspect_config(*ARGV)
+    when 'inspect_variable', 'inspect_variables'
+      Origen.site_config.inspect_variable(*ARGV)
+    when 'refresh'
+      Origen.site_config.refresh
+    else
+      puts "Unknown command, see 'origen site -h' for a list of commands"
+    end
+  else
+    puts "You must supply a command, see 'origen site -h' for a list of commands"
+  end
+end

data/lib/origen/commands/web.rb

@@ -19,7 +19,7 @@ The following commands are available:
   serve           Start a webserver from the current directory
 
   compile [FILE]  Compile all web templates and start a server to view them, optionally supply a
-                  file argument to only update a single page e.g. 'origen web compile templates/web/index.md.erb'
+                  file argument to only update a single page e.g. 'origen web compile app/templates/web/index.md.erb'
                   Use the --remote option to copy the compiled files to a remote web server directory (the
                   location of which should be specified via Origen.config.web_directory). In this case when no
                   FILE argument is specified the entire site will be copied over to a fresh web server
@@ -104,7 +104,7 @@ The following options are available:
     puts "Web server directory created at: #{dir}"
     puts ''
     puts "Compile any files you want to test into the #{dir}/content directory, e.g.:"
-    puts "  origen c templates/file.md.erb -o #{dir}/content"
+    puts "  origen c app/templates/file.md.erb -o #{dir}/content"
     puts ''
     puts 'To turn them into web pages:'
     puts "  cd #{dir}"
@@ -149,9 +149,12 @@ The following options are available:
           Origen.app.listeners_for(:before_web_compile).each do |listener|
             listener.before_web_compile(options)
           end
-          Origen.app.runner.launch action: :compile,
-                                   files:  'templates/web',
-                                   output: 'web/content'
+          templates_web_dir = 'app/templates/web'
+          templates_web_dir = 'templates/web' unless File.exist?("#{Origen.root}/#{templates_web_dir}")
+          templates_web_dir =
+        Origen.app.runner.launch action: :compile,
+                                 files:  templates_web_dir,
+                                 output: 'web/content'
           Origen.app.listeners_for(:after_web_compile).each do |listener|
             listener.after_web_compile(options)
           end
@@ -168,7 +171,9 @@ The following options are available:
         ARGV.each do |file|
           path = Origen.file_handler.clean_path_to(file)
           if path.to_s =~ /origen_guides/
-            output = Origen.file_handler.sub_dir_of(path, "#{Origen.root}/templates/origen_guides")
+            origen_guides_dir = 'app/templates/origen_guides'
+            origen_guides_dir = 'templates/origen_guides' unless File.exist?("#{Origen.root}/#{origen_guides_dir}")
+            output = Origen.file_handler.sub_dir_of(path, "#{Origen.root}/#{origen_guides_dir}")
           else
             output = Origen.file_handler.sub_dir_of(path, "#{Origen.root}/templates/web")
           end

data/lib/origen/commands_global.rb

@@ -70,11 +70,7 @@ if ARGV.delete('-d') || ARGV.delete('--debug')
       caller[0] =~ /.*\/(\w+\.rb):(\d+).*/
       puts 'The debugger gem is not installed, add the following to your Gemfile:'
       puts
-      puts "if RUBY_VERSION >= '2.0.0'"
-      puts "  gem 'byebug', '~>3.5'"
-      puts 'else'
-      puts "  gem 'debugger', '~>1.6'"
-      puts 'end'
+      puts "  gem 'byebug', '~>8'"
       puts
     end
   end
@@ -88,14 +84,18 @@ end
 
 case @command
 
-when 'new'
-  require 'origen/commands/new'
+when 'new', 'extract'
+  require "origen/commands/#{@command}"
   exit 0
 
 when '--version', '-v'
   require 'origen/commands/version'
   exit 0
 
+when 'site'
+  require 'origen/commands/site'
+  exit 0
+
 # when 'fetch', 'f'
 #  require 'origen/commands/fetch'
 #  exit 0
@@ -115,6 +115,8 @@ The following commands are available:
               new origen application workspace in "./my_app"
  interactive  Start an interactive Origen console (short-cut alias: "i"), this is just
               IRB with the 'origen' lib loaded automatically
+ extract      Extract an Origen application archive (.origen file created with the archive command)
+ site         Monitor and manage the Origen site configuration
   EOT
   cmds.split(/\n/).each do |line|
     puts Origen.clean_help_line(line)

data/lib/origen/core_ext/numeric.rb

@@ -187,4 +187,24 @@ class Numeric
       self / 1_000_000_000_000.0
     end
   end
+
+  # Shorthand for tester.wait(time_in_ns: 100), e.g. 100.ns!
+  def ns!
+    Origen.app.tester.wait time_in_ns: self
+  end
+
+  # Shorthand for tester.wait(time_in_us: 100), e.g. 100.us!
+  def us!
+    Origen.app.tester.wait time_in_us: self
+  end
+
+  # Shorthand for tester.wait(time_in_ms: 100), e.g. 100.ms!
+  def ms!
+    Origen.app.tester.wait time_in_ms: self
+  end
+
+  # Shorthand for tester.wait(time_in_s: 100), e.g. 100.s!
+  def s!
+    Origen.app.tester.wait time_in_s: self
+  end
 end

data/lib/origen/file_handler.rb

@@ -15,7 +15,10 @@ module Origen
     # This will also take care of recursively expanding any embedded
     # list references.
     def expand_list(files, options = {})
-      [files].flatten.map do |file|
+      options = {
+        preserve_duplicates: tester && tester.try(:sim?)
+      }.merge(options)
+      list_of_files = [files].flatten.map do |file|
         f = file.strip
         # Takes care of blank or comment lines in a list file
         if f.empty? || f =~ /^\s*#/
@@ -28,7 +31,12 @@ module Origen
         else
           f
         end
-      end.flatten.compact.uniq
+      end.flatten.compact
+      if options[:preserve_duplicates]
+        list_of_files
+      else
+        list_of_files.uniq
+      end
     end
 
     # Returns the contents of the given list file in an array, if it
@@ -92,7 +100,7 @@ module Origen
     def clean_path_to(file, options = {})
       # Allow individual calls to this method to specify additional custom load paths to consider
       if options[:load_paths]
-        [options[:load_paths]].each do |root|
+        Array(options[:load_paths]).each do |root|
           if File.exist?("#{root}/#{file}")
             return Pathname.new("#{root}/#{file}")
           end
@@ -214,7 +222,7 @@ module Origen
       begin
         # Allow relative references to templates/web when compiling a web template
         if Origen.lsf.current_command == 'web' || web_file
-          clean_path_to(file, load_paths: "#{Origen.root}/templates/web")
+          clean_path_to(file, load_paths: ["#{Origen.root}/app/templates/web", "#{Origen.root}/templates/web"])
         else
           clean_path_to(file)
         end
@@ -222,7 +230,7 @@ module Origen
         # Try again without .erb
         file = file.gsub('.erb', '')
         if Origen.lsf.current_command == 'web' || web_file
-          clean_path_to(file, load_paths: "#{Origen.root}/templates/web")
+          clean_path_to(file, load_paths: ["#{Origen.root}/app/templates/web", "#{Origen.root}/templates/web"])
         else
           clean_path_to(file)
         end
@@ -256,7 +264,11 @@ module Origen
             if import_name == :origen || import_name == :origen_core
               path.sub! 'origen', "#{Origen.top}/templates/shared"
             else
-              path.sub! Regexp.last_match[1], "#{root}/templates/shared"
+              if File.exist?("#{root}/app/templates/shared")
+                path.sub! Regexp.last_match[1], "#{root}/app/templates/shared"
+              else
+                path.sub! Regexp.last_match[1], "#{root}/templates/shared"
+              end
             end
           else
             fail 'Unknown import path type!'

data/lib/origen/generator.rb

@@ -1,15 +1,20 @@
 module Origen
   class Generator
-    autoload :Pattern,         'origen/generator/pattern'
-    autoload :Flow,            'origen/generator/flow'
-    autoload :Resources,       'origen/generator/resources'
-    autoload :Job,             'origen/generator/job'
-    autoload :PatternFinder,   'origen/generator/pattern_finder'
-    autoload :PatternIterator, 'origen/generator/pattern_iterator'
-    autoload :Stage,           'origen/generator/stage'
-    autoload :Compiler,        'origen/generator/compiler'
-    autoload :Comparator,      'origen/generator/comparator'
-    autoload :Renderer,        'origen/generator/renderer'
+    autoload :Pattern,          'origen/generator/pattern'
+    autoload :Flow,             'origen/generator/flow'
+    autoload :Resources,        'origen/generator/resources'
+    autoload :Job,              'origen/generator/job'
+    autoload :PatternFinder,    'origen/generator/pattern_finder'
+    autoload :PatternIterator,  'origen/generator/pattern_iterator'
+    autoload :PatternSequencer, 'origen/generator/pattern_sequencer'
+    autoload :PatternSequence,  'origen/generator/pattern_sequence'
+    autoload :PatternThread,    'origen/generator/pattern_thread'
+    autoload :Stage,            'origen/generator/stage'
+    autoload :Compiler,         'origen/generator/compiler'
+    autoload :Comparator,       'origen/generator/comparator'
+    autoload :Renderer,         'origen/generator/renderer'
+
+    class AbortError < StandardError; end
 
     def pattern
       @pattern ||= Pattern.new
@@ -28,6 +33,10 @@ module Origen
     end
 
     def generate_pattern(file, options)
+      if options[:sequence]
+        options[:patterns] = file
+        file = options[:sequence]
+      end
       Job.new(file, options).run
     end