rggen-core 0.21.0 → 0.25.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 135125b25bc30e8eb74fa97644c356afd817cda2a84a810a401efbcde7d2a647
-  data.tar.gz: c4cb605aaa49801ff0f70458148f1349a220de2c41b6f7ed614e98466e425668
+  metadata.gz: 57e33c7b563198efa0e1d2c20adcb0b6896d72d4575673c9f64761aeca93779a
+  data.tar.gz: 61e593cab9704bdc330a3767791afc9e6373020809777c7cd4f67ac18adb7b92
 SHA512:
-  metadata.gz: 122340fafae09f08a604c54b3f21e8428a0d03af5ef81b37f4211f881a99186c2f0a45e50cad9367406a75f784041eabc0ef87ebf692946a2dfbec5221135e8f
-  data.tar.gz: fb87835adc54ec4416f5811126ff65355ada76e05cc46d89eedbe87e2899fd16665d26caf66e41a9919a074824f51ef97fd6dee9abc2aa959b42d83b9c4dd35c
+  metadata.gz: 40b23ff5bd0eca3b9a53cda4cb37a220bd8e7a5648bfce598c1404031bfb43421eda997eb8a7c37868e31418a54c7267d336f72631d29522106c20dc3752433a
+  data.tar.gz: 6918ad93d019dd22e4af13205eb5c8529b1ae8b7c71cd50352b183ae84d3c5a54682189e606859adcd7e70cd292f42d11b8621997cff95ac2e89e2b47f876d1f

data/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2017-2020 Taichi Ishitani
+Copyright (c) 2017-2021 Taichi Ishitani
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -13,6 +13,7 @@ RgGen::Core is a core library of RgGen tool and provides features listed below:
 * Basic loaders for configuration file and register map documents
     * Ruby with APIs for description
     * YAML
+    * TOML
     * JSON
 * Structure and APIs for defining output file writers
 * Building RgGen tool up by linking defined above features
@@ -43,7 +44,7 @@ Feedbacks, bug reports, questions and etc. are wellcome! You can post them by us
 
 ## Copyright & License
 
-Copyright © 2017-2020 Taichi Ishitani. RgGen::Core is licensed under the [MIT License](https://opensource.org/licenses/MIT), see [LICENSE](LICENSE) for futher details.
+Copyright © 2017-2021 Taichi Ishitani. RgGen::Core is licensed under the [MIT License](https://opensource.org/licenses/MIT), see [LICENSE](LICENSE) for futher details.
 
 ## Code of Conduct
 

data/exe/rggen

@@ -8,6 +8,6 @@ begin
   cli = RgGen::Core::CLI.new
   cli.run(ARGV)
 rescue ScriptError, StandardError => e
-  abort RgGen::Core::Utility::ErrorUtility
-          .compose_error_message(e, cli.options[:print_backtrace])
+  options = [cli.options[:print_verbose_info], cli.options[:print_backtrace]]
+  abort RgGen::Core::Utility::ErrorUtility.compose_error_message(e, *options)
 end

data/lib/rggen/core.rb

@@ -8,6 +8,7 @@ require 'json'
 require 'optparse'
 require 'pathname'
 require 'singleton'
+require 'tomlrb'
 require 'yaml'
 
 require_relative 'core/version'
@@ -26,7 +27,6 @@ require_relative 'core/utility/regexp_patterns'
 
 require_relative 'core/exceptions'
 
-require_relative 'core/base/proxy_call'
 require_relative 'core/base/internal_struct'
 require_relative 'core/base/shared_context'
 require_relative 'core/base/component'
@@ -41,6 +41,7 @@ require_relative 'core/input_base/input_data'
 require_relative 'core/input_base/input_value_extractor'
 require_relative 'core/input_base/loader'
 require_relative 'core/input_base/json_loader'
+require_relative 'core/input_base/toml_loader'
 require_relative 'core/input_base/yaml_loader'
 require_relative 'core/input_base/component'
 require_relative 'core/input_base/component_factory'
@@ -60,6 +61,7 @@ require_relative 'core/configuration/loader'
 require_relative 'core/configuration/ruby_loader'
 require_relative 'core/configuration/hash_loader'
 require_relative 'core/configuration/json_loader'
+require_relative 'core/configuration/toml_loader'
 require_relative 'core/configuration/yaml_loader'
 require_relative 'core/configuration'
 
@@ -73,6 +75,7 @@ require_relative 'core/register_map/loader'
 require_relative 'core/register_map/ruby_loader'
 require_relative 'core/register_map/hash_loader'
 require_relative 'core/register_map/json_loader'
+require_relative 'core/register_map/toml_loader'
 require_relative 'core/register_map/yaml_loader'
 require_relative 'core/register_map'
 
@@ -83,6 +86,8 @@ require_relative 'core/output_base/file_writer'
 require_relative 'core/output_base/raise_error'
 require_relative 'core/output_base/component'
 require_relative 'core/output_base/component_factory'
+require_relative 'core/output_base/source_file_component_factory'
+require_relative 'core/output_base/document_component_factory'
 require_relative 'core/output_base/feature'
 require_relative 'core/output_base/feature_factory'
 
@@ -95,10 +100,12 @@ require_relative 'core/builder/simple_feature_entry'
 require_relative 'core/builder/list_feature_entry'
 require_relative 'core/builder/feature_registry'
 require_relative 'core/builder/layer'
-require_relative 'core/builder/plugins'
+require_relative 'core/builder/plugin_spec'
+require_relative 'core/builder/plugin_manager'
 require_relative 'core/builder/builder'
 require_relative 'core/builder'
 
+require_relative 'core/plugin'
 require_relative 'core/printers'
 require_relative 'core/options'
 require_relative 'core/dsl'

data/lib/rggen/core/base/component.rb

@@ -70,15 +70,14 @@ module RgGen
 
         def define_proxy_calls(receiver, methods)
           Array(methods)
-            .map(&:to_sym)
             .each { |method| define_proxy_call(receiver, method) }
         end
 
-        def define_proxy_call(receiver, method)
-          @proxy_calls ||= {}
-          @proxy_calls[method] = ProxyCall.new(receiver, method)
-          define_singleton_method(method) do |*args, &block|
-            @proxy_calls[__method__].call(*args, &block)
+        def define_proxy_call(receiver, method_name)
+          (@proxy_receivers ||= {})[method_name.to_sym] = receiver
+          define_singleton_method(method_name) do |*args, &block|
+            name = __method__
+            @proxy_receivers[name].__send__(name, *args, &block)
           end
         end
       end

data/lib/rggen/core/base/component_factory.rb

@@ -43,11 +43,15 @@ module RgGen
 
         def create_component(parent, sources, &block)
           actual_sources = Array(select_actual_sources(*sources))
-          @target_component
-            .new(parent, component_name, layer, *actual_sources, &block)
+          create_component?(*actual_sources) &&
+            @target_component.new(parent, component_name, layer, *actual_sources, &block)
         end
 
-        def select_actual_sources(*sources)
+        def select_actual_sources(*_sources)
+        end
+
+        def create_component?(*_sources)
+          true
         end
 
         def build_component(parent, component, sources)
@@ -88,8 +92,7 @@ module RgGen
         end
 
         def create_child(component, *args)
-          factory = find_child_factory(*args)
-          factory.create(component, *args)
+          find_child_factory(*args).create(component, *args)
         end
       end
     end

data/lib/rggen/core/builder/builder.rb

@@ -4,20 +4,22 @@ module RgGen
   module Core
     module Builder
       class Builder
+        extend Forwardable
+
         def initialize
           initialize_component_registries
           initialize_layers
-          @plugins = Plugins.new
+          @plugin_manager = PluginManager.new(self)
         end
 
-        attr_reader :plugins
+        attr_reader :plugin_manager
 
         def input_component_registry(name, &body)
-          component_registry(:input, name, body)
+          component_registry(:input, name, &body)
         end
 
         def output_component_registry(name, &body)
-          component_registry(:output, name, body)
+          component_registry(:output, name, &body)
         end
 
         [
@@ -30,6 +32,10 @@ module RgGen
           end
         end
 
+        def register_map_layers
+          REGISTER_MAP_LAYERS
+        end
+
         def add_feature_registry(name, target_layer, registry)
           target_layers =
             if target_layer
@@ -37,9 +43,8 @@ module RgGen
             else
               @layers.values
             end
-          target_layers.each do |layer|
-            layer.add_feature_registry(name, registry)
-          end
+          target_layers
+            .each { |layer| layer.add_feature_registry(name, registry) }
         end
 
         [
@@ -73,8 +78,7 @@ module RgGen
             if targets.empty?
               @component_registries[type]
             else
-              @component_registries[type]
-                .select { |name, _| targets.include?(name) }
+              @component_registries[type].slice(*targets)
             end
           registries.each_value.map(&:build_factory)
         end
@@ -88,23 +92,9 @@ module RgGen
           RegisterMap.setup(self)
         end
 
-        def setup(name, module_or_version = nil, &block)
-          plugins.add(name, module_or_version, &block)
-        end
-
-        def activate_plugins(**options)
-          plugins.activate(self, **options)
-        end
-
-        def load_setup_file(file, activation = true)
-          (file.nil? || file.empty?) &&
-            (raise Core::LoadError.new('no setup file is given'))
-          File.readable?(file) ||
-            (raise Core::LoadError.new("cannot load such setup file: #{file}"))
-          RgGen.builder(self)
-          load(file)
-          activation && activate_plugins
-        end
+        def_delegator :plugin_manager, :load_plugin
+        def_delegator :plugin_manager, :load_plugins
+        def_delegator :plugin_manager, :register_plugin
 
         private
 
@@ -117,26 +107,30 @@ module RgGen
           end
         end
 
+        REGISTER_MAP_LAYERS = [
+          :root, :register_block, :register_file, :register, :bit_field
+        ].freeze
+
+        ALL_LAYERS = [
+          :global, *REGISTER_MAP_LAYERS
+        ].freeze
+
         def initialize_layers
           @layers = Hash.new do |_, layer_name|
             raise BuilderError.new("unknown layer: #{layer_name}")
           end
-          [
-            :global, :root, :register_block, :register_file, :register, :bit_field
-          ].each do |layer|
-            @layers[layer] = Layer.new(layer)
-          end
+          ALL_LAYERS.each { |layer| @layers[layer] = Layer.new(layer) }
         end
 
         COMPONENT_REGISTRIES = {
           input: InputComponentRegistry, output: OutputComponentRegistry
         }.freeze
 
-        def component_registry(type, name, body)
+        def component_registry(type, name, &body)
           registries = @component_registries[type]
-          klass = COMPONENT_REGISTRIES[type]
-          registries.key?(name) || (registries[name] = klass.new(name, self))
-          Docile.dsl_eval(registries[name], &body)
+          registries.key?(name) ||
+            (registries[name] = COMPONENT_REGISTRIES[type].new(name, self))
+          body && Docile.dsl_eval(registries[name], &body) || registries[name]
         end
       end
     end

data/lib/rggen/core/builder/component_registry.rb

@@ -11,22 +11,22 @@ module RgGen
         end
 
         def register_component(layers = nil, &block)
-          if layers
-            Array(layers).each do |layer|
-              @entries << create_new_entry(layer, block)
-            end
-          else
-            @entries << create_new_entry(nil, block)
+          Array(layers || @builder.register_map_layers).each do |layer|
+            @entries << create_new_entry(layer, &block)
           end
         end
 
+        def register_global_component(&block)
+          @entries << create_new_entry(nil, &block)
+        end
+
         def build_factory
           build_factories.first.tap(&:root_factory)
         end
 
         private
 
-        def create_new_entry(layer, block)
+        def create_new_entry(layer, &block)
           entry = ComponentEntry.new(@component_name, layer)
           Docile.dsl_eval(entry, layer, &block)
           add_feature_registry(layer, entry.feature_registry)
@@ -35,8 +35,7 @@ module RgGen
 
         def add_feature_registry(layer, feature_registry)
           feature_registry &&
-            @builder
-              .add_feature_registry(@component_name, layer, feature_registry)
+            @builder.add_feature_registry(@component_name, layer, feature_registry)
         end
 
         def build_factories

data/lib/rggen/core/builder/feature_registry.rb

@@ -11,22 +11,19 @@ module RgGen
           @enabled_features = {}
         end
 
-        def define_simple_feature(names, context = nil, &body)
-          Array(names)
-            .each { |name| create_new_entry(:simple, name, context, body) }
+        def define_simple_feature(name, context = nil, &body)
+          create_new_entry(:simple, name, context, &body)
         end
 
-        def define_list_feature(list_names, context = nil, &body)
-          Array(list_names)
-            .each { |name| create_new_entry(:list, name, context, body) }
+        def define_list_feature(list_name, context = nil, &body)
+          create_new_entry(:list, list_name, context, &body)
         end
 
-        def define_list_item_feature(list_name, feature_names, context = nil, &body)
+        def define_list_item_feature(list_name, feature_name, context = nil, &body)
           entry = @feature_entries[list_name]
           entry&.match_entry_type?(:list) ||
             (raise BuilderError.new("unknown list feature: #{list_name}"))
-          Array(feature_names)
-            .each { |name| entry.define_feature(name, context, &body) }
+          entry.define_feature(feature_name, context, &body)
         end
 
         def enable(feature_or_list_names, feature_names = nil)
@@ -91,10 +88,9 @@ module RgGen
         end
 
         def build_factories
-          @enabled_features
-            .select { |n, _| @feature_entries.key?(n) }
-            .map { |n, f| [n, @feature_entries[n].build_factory(f)] }
-            .to_h
+          @feature_entries
+            .slice(*@enabled_features.keys)
+            .transform_values(&method(:build_factory))
         end
 
         private
@@ -103,9 +99,9 @@ module RgGen
           simple: SimpleFeatureEntry, list: ListFeatureEntry
         }.freeze
 
-        def create_new_entry(type, name, context, body)
+        def create_new_entry(type, name, context, &body)
           entry = FEATURE_ENTRIES[type].new(self, name)
-          entry.setup(@base_feature, @factory, context, body)
+          entry.setup(@base_feature, @factory, context, &body)
           @feature_entries[name] = entry
         end
 
@@ -120,6 +116,10 @@ module RgGen
                                 .feature?(feature_name)
           @enabled_features[list_name].include?(feature_name)
         end
+
+        def build_factory(entry)
+          entry.build_factory(@enabled_features[entry.name])
+        end
       end
     end
   end

data/lib/rggen/core/builder/layer.rb

@@ -11,16 +11,8 @@ module RgGen
 
           attr_setter :body
           attr_setter :method_name
-          attr_setter :list_names
-          attr_setter :feature_names
-
-          def shared_context(&body)
-            if block_given?
-              @shared_context ||= Object.new
-              @shared_context.instance_eval(&body)
-            end
-            @shared_context
-          end
+          attr_setter :list_name
+          attr_setter :feature_name
 
           def register_execution(registry, &body)
             @executions ||= []
@@ -29,15 +21,14 @@ module RgGen
 
           def execute(layer)
             Docile.dsl_eval(layer, &body)
-            @executions&.each(&method(:call_execution))
+            @executions&.each { |execution| call_execution(layer, execution) }
           end
 
           private
 
-          def call_execution(execution)
-            args = [list_names, feature_names, shared_context].compact
-            execution[:registry]
-              .__send__(method_name, *args, &execution[:body])
+          def call_execution(layer, execution)
+            args = [list_name, feature_name, layer.shared_context].compact
+            execution[:registry].__send__(method_name, *args, &execution[:body])
           end
         end
 
@@ -52,31 +43,44 @@ module RgGen
         end
 
         def shared_context(&body)
-          block_given? && @proxy&.shared_context(&body)
+          return unless @proxy
+
+          if block_given?
+            context = current_shared_context(true)
+            context.singleton_exec(&body)
+          end
+
+          current_shared_context(false)
         end
 
         def define_simple_feature(feature_names, &body)
-          do_proxy_call do |proxy|
-            proxy.body(body)
-            proxy.method_name(__method__)
-            proxy.feature_names(feature_names)
+          Array(feature_names).each do |feature_name|
+            do_proxy_call do |proxy|
+              proxy.body(body)
+              proxy.method_name(__method__)
+              proxy.feature_name(feature_name)
+            end
           end
         end
 
         def define_list_feature(list_names, &body)
-          do_proxy_call do |proxy|
-            proxy.body(body)
-            proxy.method_name(__method__)
-            proxy.list_names(list_names)
+          Array(list_names).each do |list_name|
+            do_proxy_call do |proxy|
+              proxy.body(body)
+              proxy.method_name(__method__)
+              proxy.list_name(list_name)
+            end
           end
         end
 
         def define_list_item_feature(list_name, feature_names, &body)
-          do_proxy_call do |proxy|
-            proxy.body(body)
-            proxy.method_name(__method__)
-            proxy.list_names(list_name)
-            proxy.feature_names(feature_names)
+          Array(feature_names).each do |feature_name|
+            do_proxy_call do |proxy|
+              proxy.body(body)
+              proxy.method_name(__method__)
+              proxy.list_name(list_name)
+              proxy.feature_name(feature_name)
+            end
           end
         end
 
@@ -111,6 +115,17 @@ module RgGen
           @proxy.execute(self)
           remove_instance_variable(:@proxy)
         end
+
+        def current_shared_context(allocate)
+          list_name = @proxy.list_name || @proxy.feature_name
+          feature_name = @proxy.feature_name
+          allocate && (shared_contexts[list_name][feature_name] ||= Object.new)
+          shared_contexts[list_name][feature_name]
+        end
+
+        def shared_contexts
+          @shared_contexts ||= Hash.new { |h, k| h[k] = {} }
+        end
       end
     end
   end