Class: Origen::Application::Configuration

Inherits:
Object
  • Object
show all
Defined in:
lib/origen/application/configuration.rb

Constant Summary

ATTRS_THAT_DEPEND_ON_TARGET =

Mark any attributes that are likely to depend on properties of the target here, this will raise an error if they are ever accessed before the target has been instantiated (a concern for Origen core developers only).

These attributes will also receive an enhanced accessor that accepts a block, see below for more details on this.

[
  :output_directory, :reference_directory, :pattern_postfix, :pattern_prefix,
  :pattern_header, :release_directory, :pattern_name_translator, :pattern_directory, :pattern_output_directory,
  :proceed_with_pattern, :test_program_output_directory, :test_program_source_directory,
  :test_program_template_directory, :referenced_pattern_list, :program_prefix, :web_directory,
  :web_domain
]
ATTRS_THAT_DONT_DEPEND_ON_TARGET =

Any attributes that want to accept a block, but not necessarily require the target can be added here

[
  :release_instructions, :history_file, :log_directory, :copy_command,
  :diff_command, :remotes,
  :external_app_dirs
]
ATTRS_THAT_CURRENT_PLUGIN_CAN_OVERRIDE =

If a current plugin is present then its value for these attributes will be used instead of that from the current application

[
  :pattern_prefix, :pattern_postfix, :program_prefix, :pattern_header, :pattern_output_directory,
  :output_directory, :reference_directory, :test_program_output_directory,
  :test_program_template_directory, :referenced_pattern_list
]

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(app) ⇒ Configuration

Returns a new instance of Configuration


60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
# File 'lib/origen/application/configuration.rb', line 60

def initialize(app)
  @app = app
  @name = 'Unknown'
  @initials = 'NA'
  @semantically_version = false
  @compile_only_dot_erb_files = true
  # Functions used here since Origen.root is not available when this is first instantiated
  @output_directory = -> { "#{Origen.root}/output" }
  @reference_directory = lambda do
    if Origen.config.output_directory.to_s =~ /(\\|\/)output(\\|\/)/
      Origen.config.output_directory.to_s.sub(/(\\|\/)output(\\|\/)/, '\1.ref\2')
    else
      "#{Origen.root}/.ref"
    end
  end
  @release_directory = -> { Origen.root }
  @release_email_subject = false
  @log_directory = -> { "#{Origen.root}/log" }
  @pattern_name_translator = ->(name) { name }
  @pattern_directory = -> { "#{Origen.root}/pattern" }
  @pattern_output_directory = -> { Origen.app.config.output_directory }
  @history_file = -> { "#{Origen.root}/doc/history" }
  @default_lsf_action = :clear
  @proceed_with_pattern = ->(_name) { true }
  @erb_trim_mode = '%'
  @referenced_pattern_list = -> { "#{Origen.root}/list/referenced.list" }
  @copy_command = -> { Origen.running_on_windows? ? 'copy' : 'cp' }
  @diff_command = -> { Origen.running_on_windows? ? 'start winmerge' : 'tkdiff' }
  @imports = []
  @imports_dev = []
  @external_app_dirs = []
  @unmanaged_dirs = []
  @unmanaged_files = []
  @remotes = []
  @lint_test = {}
  @user_aliases = {}
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method

#method_missing(method, *_args, &_block) ⇒ Object

Prevent a new attribute from a future version of Origen from dying before the user can be prompted to upgrade


196
197
198
199
# File 'lib/origen/application/configuration.rb', line 196

def method_missing(method, *_args, &_block)
  method = method.to_s.sub('=', '')
  Origen.log.warning "WARNING - unknown configuration attribute in #{app.name}: #{method}"
end

Instance Attribute Details

#appObject (readonly)

Returns the configuration's application instance


7
8
9
# File 'lib/origen/application/configuration.rb', line 7

def app
  @app
end

#compile_only_dot_erb_filesObject

Returns the value of attribute compile_only_dot_erb_files


9
10
11
# File 'lib/origen/application/configuration.rb', line 9

def compile_only_dot_erb_files
  @compile_only_dot_erb_files
end

#copy_commandObject

Returns the value of attribute copy_command


9
10
11
# File 'lib/origen/application/configuration.rb', line 9

def copy_command
  @copy_command
end

#default_lsf_actionObject

Returns the value of attribute default_lsf_action


9
10
11
# File 'lib/origen/application/configuration.rb', line 9

def default_lsf_action
  @default_lsf_action
end

#diff_commandObject

Returns the value of attribute diff_command


9
10
11
# File 'lib/origen/application/configuration.rb', line 9

def diff_command
  @diff_command
end

#disqus_shortnameObject

Returns the value of attribute disqus_shortname


9
10
11
# File 'lib/origen/application/configuration.rb', line 9

def disqus_shortname
  @disqus_shortname
end

#erb_trim_modeObject

Returns the value of attribute erb_trim_mode


9
10
11
# File 'lib/origen/application/configuration.rb', line 9

def erb_trim_mode
  @erb_trim_mode
end

#external_app_dirsObject

Returns the value of attribute external_app_dirs


9
10
11
# File 'lib/origen/application/configuration.rb', line 9

def external_app_dirs
  @external_app_dirs
end

#gem_nameObject

Returns the value of attribute gem_name


9
10
11
# File 'lib/origen/application/configuration.rb', line 9

def gem_name
  @gem_name
end

#history_fileObject

Returns the value of attribute history_file


9
10
11
# File 'lib/origen/application/configuration.rb', line 9

def history_file
  @history_file
end

#initialsObject

Returns the value of attribute initials


9
10
11
# File 'lib/origen/application/configuration.rb', line 9

def initials
  @initials
end

#instructionsObject

Returns the value of attribute instructions


9
10
11
# File 'lib/origen/application/configuration.rb', line 9

def instructions
  @instructions
end

#lint_testObject

Returns the value of attribute lint_test


9
10
11
# File 'lib/origen/application/configuration.rb', line 9

def lint_test
  @lint_test
end

#log_directoryObject

Returns the value of attribute log_directory


9
10
11
# File 'lib/origen/application/configuration.rb', line 9

def log_directory
  @log_directory
end

#nameObject

Returns the value of attribute name


9
10
11
# File 'lib/origen/application/configuration.rb', line 9

def name
  @name
end

#output_directoryObject

Returns the value of attribute output_directory


9
10
11
# File 'lib/origen/application/configuration.rb', line 9

def output_directory
  @output_directory
end

#pattern_directoryObject

Returns the value of attribute pattern_directory


9
10
11
# File 'lib/origen/application/configuration.rb', line 9

def pattern_directory
  @pattern_directory
end

#pattern_headerObject

Returns the value of attribute pattern_header


9
10
11
# File 'lib/origen/application/configuration.rb', line 9

def pattern_header
  @pattern_header
end

#pattern_name_translator(name = nil, &block) ⇒ Object

Returns the value of attribute pattern_name_translator


9
10
11
# File 'lib/origen/application/configuration.rb', line 9

def pattern_name_translator
  @pattern_name_translator
end

#pattern_output_directoryObject

Returns the value of attribute pattern_output_directory


9
10
11
# File 'lib/origen/application/configuration.rb', line 9

def pattern_output_directory
  @pattern_output_directory
end

#pattern_postfixObject

Returns the value of attribute pattern_postfix


9
10
11
# File 'lib/origen/application/configuration.rb', line 9

def pattern_postfix
  @pattern_postfix
end

#pattern_prefixObject

Returns the value of attribute pattern_prefix


9
10
11
# File 'lib/origen/application/configuration.rb', line 9

def pattern_prefix
  @pattern_prefix
end

#proceed_with_pattern(name = nil, &block) ⇒ Object

Returns the value of attribute proceed_with_pattern


9
10
11
# File 'lib/origen/application/configuration.rb', line 9

def proceed_with_pattern
  @proceed_with_pattern
end

#production_targetsObject

Returns the value of attribute production_targets


9
10
11
# File 'lib/origen/application/configuration.rb', line 9

def production_targets
  @production_targets
end

#program_prefixObject

Returns the value of attribute program_prefix


9
10
11
# File 'lib/origen/application/configuration.rb', line 9

def program_prefix
  @program_prefix
end

#rc_urlObject

Returns the value of attribute rc_url


9
10
11
# File 'lib/origen/application/configuration.rb', line 9

def rc_url
  @rc_url
end

#rc_workflowObject

Returns the value of attribute rc_workflow


9
10
11
# File 'lib/origen/application/configuration.rb', line 9

def rc_workflow
  @rc_workflow
end

#reference_directoryObject

Returns the value of attribute reference_directory


9
10
11
# File 'lib/origen/application/configuration.rb', line 9

def reference_directory
  @reference_directory
end

#referenced_pattern_listObject

Returns the value of attribute referenced_pattern_list


9
10
11
# File 'lib/origen/application/configuration.rb', line 9

def referenced_pattern_list
  @referenced_pattern_list
end

#release_directoryObject

Returns the value of attribute release_directory


9
10
11
# File 'lib/origen/application/configuration.rb', line 9

def release_directory
  @release_directory
end

#release_email_subjectObject

Returns the value of attribute release_email_subject


9
10
11
# File 'lib/origen/application/configuration.rb', line 9

def release_email_subject
  @release_email_subject
end

#release_externallyObject

Returns the value of attribute release_externally


9
10
11
# File 'lib/origen/application/configuration.rb', line 9

def release_externally
  @release_externally
end

#release_instructionsObject

Returns the value of attribute release_instructions


9
10
11
# File 'lib/origen/application/configuration.rb', line 9

def release_instructions
  @release_instructions
end

#remotesObject

Returns the value of attribute remotes


9
10
11
# File 'lib/origen/application/configuration.rb', line 9

def remotes
  @remotes
end

#semantically_versionObject

Returns the value of attribute semantically_version


9
10
11
# File 'lib/origen/application/configuration.rb', line 9

def semantically_version
  @semantically_version
end

#sharedObject

Returns the value of attribute shared


9
10
11
# File 'lib/origen/application/configuration.rb', line 9

def shared
  @shared
end

#strict_errorsObject

Returns the value of attribute strict_errors


9
10
11
# File 'lib/origen/application/configuration.rb', line 9

def strict_errors
  @strict_errors
end

#test_program_output_directoryObject

Returns the value of attribute test_program_output_directory


9
10
11
# File 'lib/origen/application/configuration.rb', line 9

def test_program_output_directory
  @test_program_output_directory
end

#test_program_source_directoryObject

Returns the value of attribute test_program_source_directory


9
10
11
# File 'lib/origen/application/configuration.rb', line 9

def test_program_source_directory
  @test_program_source_directory
end

#test_program_template_directoryObject

Returns the value of attribute test_program_template_directory


9
10
11
# File 'lib/origen/application/configuration.rb', line 9

def test_program_template_directory
  @test_program_template_directory
end

#unmanaged_dirsObject

Returns the value of attribute unmanaged_dirs


9
10
11
# File 'lib/origen/application/configuration.rb', line 9

def unmanaged_dirs
  @unmanaged_dirs
end

#unmanaged_filesObject

Returns the value of attribute unmanaged_files


9
10
11
# File 'lib/origen/application/configuration.rb', line 9

def unmanaged_files
  @unmanaged_files
end

#user_aliasesObject

Returns the value of attribute user_aliases


9
10
11
# File 'lib/origen/application/configuration.rb', line 9

def user_aliases
  @user_aliases
end

#vaultObject

Returns the value of attribute vault


9
10
11
# File 'lib/origen/application/configuration.rb', line 9

def vault
  @vault
end

#web_directoryObject

Returns the value of attribute web_directory


9
10
11
# File 'lib/origen/application/configuration.rb', line 9

def web_directory
  @web_directory
end

#web_domainObject

Returns the value of attribute web_domain


9
10
11
# File 'lib/origen/application/configuration.rb', line 9

def web_domain
  @web_domain
end

#yammer_groupObject

Returns the value of attribute yammer_group


9
10
11
# File 'lib/origen/application/configuration.rb', line 9

def yammer_group
  @yammer_group
end

Class Method Details

.add_attribute(name, options = {}) ⇒ Object

This defines an enhanced accessor for these attributes that allows them to be assigned to an anonymous function to calculate the value based on some property of the target objects.

Without this the objects from the target could not be referenced in config/application.rb because they don't exist yet, for example this will not work because $dut has not yet been instantiated:

# config/application.rb

config.output_directory = "#{Origen.root}/output/#{$dut.class}"

However this accessor provides a way to do that via the following syntax:

# config/application.rb

config.output_directory do
  "#{Origen.root}/output/#{$dut.class}"
end

Or on one line:

# config/application.rb

config.output_directory { "#{Origen.root}/output/#{$dut.class}" }

Or if you prefer the more explicit:

# config/application.rb

config.output_directory = ->{ "#{Origen.root}/output/#{$dut.class}" }

125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
# File 'lib/origen/application/configuration.rb', line 125

def self.add_attribute(name, options = {})
  options = {
    depend_on_target: true
  }.merge(options)
  attr_writer name
  define_method name do |override = true, &block|
    if block # _given?
      instance_variable_set("@#{name}".to_sym, block)
    else
      if override && ATTRS_THAT_CURRENT_PLUGIN_CAN_OVERRIDE.include?(name) &&
         app.current? && Origen.app.plugins.current
        var = Origen.app.plugins.current.config.send(name, override: false)
      end
      var ||= instance_variable_get("@#{name}".to_sym) || options[:default]
      if var.respond_to?('call')
        if options[:depend_on_target]
          # If an attempt has been made to access this attribute before the target has
          # been instantiated raise an error
          # Note Origen.app here instead of just app to ensure we are talking to the top level application,
          # that is the only one that has a target
          unless Origen.app.target_instantiated?
            fail "You have attempted to access Origen.config.#{name} before instantiating the target"
          end
        end
        var.call
      else
        var
      end
    end
  end
end

Instance Method Details

#log_deprecationsObject


54
55
56
57
58
# File 'lib/origen/application/configuration.rb', line 54

def log_deprecations
  # unless imports.empty?
  #  Origen.deprecate "App #{app.name} uses config.imports this will be removed in Origen V3 and a Gemfile/.gemspec should be used instead"
  # end
end

#lsfObject


190
191
192
# File 'lib/origen/application/configuration.rb', line 190

def lsf
  app.lsf.configuration
end

#pattern_iterator {|Origen.generator.create_iterator| ... } ⇒ Object

Add a new pattern iterator

Yields:

  • (Origen.generator.create_iterator)

186
187
188
# File 'lib/origen/application/configuration.rb', line 186

def pattern_iterator
  yield Origen.generator.create_iterator
end