rggen-core 0.33.0 → 0.34.0

data/lib/rggen/core/output_base/code_generatable.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+module RgGen
+  module Core
+    module OutputBase
+      module CodeGeneratable
+        CODE_PHASES = [
+          :pre_code, :main_code, :post_code
+        ].freeze
+
+        VARIABLE_NAMES =
+          CODE_PHASES
+            .to_h { |phase| [phase, :"@#{phase}_blocks"] }
+            .freeze
+
+        module Extension
+          private
+
+          CODE_PHASES.each do |phase|
+            define_method(phase) do |kind, **options, &body|
+              regiter_code_block(__method__, kind, **options, &body)
+            end
+          end
+
+          def regiter_code_block(phase, kind, **options, &body)
+            block =
+              if options[:from_template]
+                path = extract_template_path(options)
+                location = caller_locations(2, 1).first
+                -> { process_template(path, location) }
+              else
+                body
+              end
+            return unless block
+
+            variable_name = VARIABLE_NAMES[phase]
+            feature_hash_array_variable_push(variable_name, kind, block)
+          end
+
+          def extract_template_path(options)
+            path = options[:from_template]
+            path.equal?(true) ? nil : path
+          end
+
+          def template_engine(engine)
+            @template_engine = engine.instance
+          end
+        end
+
+        def self.included(klass)
+          klass.extend(Extension)
+        end
+
+        def generate_code(code, phase, kind)
+          blocks = feature_hash_array_variable_get(VARIABLE_NAMES[phase])
+          return unless blocks
+
+          blocks[kind]&.each do |block|
+            if block.arity.zero?
+              code << instance_exec(&block)
+            else
+              instance_exec(code, &block)
+            end
+          end
+        end
+
+        private
+
+        def process_template(path = nil, caller_location = nil)
+          caller_location ||= caller_locations(1, 1).first
+          template_engine = feaure_scala_variable_get(:@template_engine)
+          template_engine.process_template(self, path, caller_location)
+        end
+      end
+    end
+  end
+end

data/lib/rggen/core/output_base/feature.rb

@@ -5,89 +5,32 @@ module RgGen
     module OutputBase
       class Feature < Base::Feature
         include Base::FeatureLayerExtension
+        include CodeGeneratable
         include RaiseError
 
         class << self
-          attr_reader :pre_builders
-          attr_reader :builders
-
-          def code_generators
-            @code_generators ||= {}
-          end
-
-          def template_engine(engine = nil)
-            @template_engine = engine.instance if engine
-            @template_engine
-          end
-
-          attr_reader :file_writer
-
           def exported_methods
-            @exported_methods ||= []
+            feature_array_variable_get(:@exported_methods)
           end
 
           private
 
           def pre_build(&body)
-            @pre_builders ||= []
-            @pre_builders << body
+            feature_array_variable_push(:@pre_builders, body)
           end
 
           def build(&body)
-            @builders ||= []
-            @builders << body
-          end
-
-          [:pre_code, :main_code, :post_code].each do |phase|
-            define_method(phase) do |kind, **options, &body|
-              register_code_generator(__method__, kind, **options, &body)
-            end
-          end
-
-          def register_code_generator(phase, kind, **options, &body)
-            block =
-              if options[:from_template]
-                path = extract_template_path(options)
-                location = caller_locations(2, 1).first
-                -> { process_template(path, location) }
-              else
-                body
-              end
-            (code_generators[phase] ||= CodeGenerator.new)
-              .register(kind, &block)
-          end
-
-          def extract_template_path(options)
-            path = options[:from_template]
-            path.equal?(true) ? nil : path
+            feature_array_variable_push(:@builders, body)
           end
 
-          def write_file(file_name_pattern, &body)
-            @file_writer = FileWriter.new(file_name_pattern, &body)
+          def write_file(file_name_pattern, &)
+            @file_writer = FileWriter.new(file_name_pattern, &)
           end
 
           def export(*methods)
             methods.each do |method|
-              exported_methods.include?(method) ||
-                (exported_methods << method)
-            end
-          end
-        end
-
-        class << self
-          def inherited(subclass)
-            super
-            export_instance_variable(:@pre_builders, subclass, &:dup)
-            export_instance_variable(:@builders, subclass, &:dup)
-            export_instance_variable(:@template_engine, subclass)
-            export_instance_variable(:@file_writer, subclass)
-            export_instance_variable(:@exported_methods, subclass, &:dup)
-            copy_code_generators(subclass)
-          end
-
-          def copy_code_generators(subclass)
-            @code_generators&.each do |phase, generator|
-              subclass.code_generators[phase] = generator.copy
+              exported_methods&.include?(method) ||
+                feature_array_variable_push(:@exported_methods, method)
             end
           end
         end
@@ -97,22 +40,20 @@ module RgGen
         end
 
         def pre_build
-          helper
-            .pre_builders
+          feature_array_variable_get(:@pre_builders)
             &.each { |body| instance_exec(&body) }
         end
 
         def build
-          helper
-            .builders
+          feature_array_variable_get(:@builders)
             &.each { |body| instance_exec(&body) }
         end
 
         def export(*methods)
           methods.each do |method|
-            unless exported_methods(:class).include?(method) ||
-                   exported_methods(:object).include?(method)
-              exported_methods(:object) << method
+            unless exported_methods(:class)&.include?(method) ||
+                   exported_methods(:object)&.include?(method)
+              (@exported_methods ||= []) << method
             end
           end
         end
@@ -121,18 +62,13 @@ module RgGen
           if scope == :class
             self.class.exported_methods
           else
-            @exported_methods ||= []
+            @exported_methods
           end
         end
 
-        def generate_code(code, phase, kind)
-          generator = self.class.code_generators[phase]
-          generator&.generate(self, code, kind)
-        end
-
         def write_file(directory = nil)
-          file_writer = self.class.file_writer
-          file_writer&.write_file(self, directory)
+          feaure_scala_variable_get(:@file_writer)
+            &.write_file(self, directory)
         end
 
         private
@@ -140,12 +76,6 @@ module RgGen
         def configuration
           component.configuration
         end
-
-        def process_template(path = nil, caller_location = nil)
-          caller_location ||= caller_locations(1, 1).first
-          template_engine = self.class.template_engine
-          template_engine.process_template(self, path, caller_location)
-        end
       end
     end
   end

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

@@ -4,16 +4,14 @@ module RgGen
   module Core
     module RegisterMap
       class ComponentFactory < InputBase::ComponentFactory
-        include RaiseError
-
         private
 
         def select_actual_sources(configuration, *_)
           configuration
         end
 
-        def create_input_data(configuration, &block)
-          InputData.new(:root, valid_value_lists, configuration, &block)
+        def create_input_data(configuration, &)
+          InputData.new(:root, valid_value_lists, configuration, &)
         end
 
         def find_child_factory(_configuration, register_map)

data/lib/rggen/core/register_map/feature.rb

@@ -5,7 +5,6 @@ module RgGen
     module RegisterMap
       class Feature < InputBase::Feature
         include Base::FeatureLayerExtension
-        include RaiseError
 
         private
 

data/lib/rggen/core/register_map/feature_factory.rb

@@ -4,7 +4,6 @@ module RgGen
   module Core
     module RegisterMap
       class FeatureFactory < InputBase::FeatureFactory
-        include RaiseError
       end
     end
   end

data/lib/rggen/core/register_map/input_data.rb

@@ -5,24 +5,24 @@ module RgGen
     module RegisterMap
       class InputData < InputBase::InputData
         module Root
-          def register_block(value_list = nil, &block)
-            child(:register_block, value_list, &block)
+          def register_block(value_list = nil, &)
+            child(:register_block, value_list, &)
           end
         end
 
         module RegisterBlockRegisterFile
-          def register_file(value_list = nil, &block)
-            child(:register_file, value_list, &block)
+          def register_file(value_list = nil, &)
+            child(:register_file, value_list, &)
           end
 
-          def register(value_list = nil, &block)
-            child(:register, value_list, &block)
+          def register(value_list = nil, &)
+            child(:register, value_list, &)
           end
         end
 
         module Register
-          def bit_field(value_list = nil, &block)
-            child(:bit_field, value_list, &block)
+          def bit_field(value_list = nil, &)
+            child(:bit_field, value_list, &)
           end
         end
 
@@ -48,8 +48,13 @@ module RgGen
 
         private
 
-        def create_child_data(layer, &block)
-          super(layer, @configuration, &block)
+        def create_child_data(layer, &)
+          super(layer, @configuration, &)
+        end
+
+        def raise_unknown_field_error(field_name, position)
+          message = "unknown register map field is given: #{field_name}"
+          error(message, position)
         end
       end
     end

data/lib/rggen/core/utility/attribute_setter.rb

@@ -5,16 +5,14 @@ module RgGen
     module Utility
       module AttributeSetter
         module Extension
-          def attributes
-            @attributes ||= []
-          end
+          attr_reader :attributes
 
           private
 
           DEFAULT_VALUE = Object.new.freeze
 
           def define_attribute(name, default_value = nil)
-            attributes << name.to_sym
+            (@attributes ||= []) << name.to_sym
             variable_name = "@#{name}"
             define_method(name) do |value = DEFAULT_VALUE|
               if value.equal?(DEFAULT_VALUE)
@@ -24,11 +22,6 @@ module RgGen
               end
             end
           end
-
-          def inherited(subclass)
-            super
-            export_instance_variable(:@attributes, subclass, &:dup)
-          end
         end
 
         def self.included(class_or_module)
@@ -37,7 +30,7 @@ module RgGen
 
         def apply_attributes(**attributes)
           attributes.each do |name, value|
-            __send__(name, value) if self.class.attributes.include?(name)
+            __send__(name, value) if attribute?(name)
           end
         end
 
@@ -52,6 +45,16 @@ module RgGen
             default_value
           end
         end
+
+        def attribute?(name)
+          klass = self.class
+          while klass.respond_to?(:attributes)
+            return true if klass.attributes&.include?(name)
+            klass = klass.superclass
+          end
+
+          false
+        end
       end
     end
   end

data/lib/rggen/core/utility/code_utility/source_file.rb

@@ -120,7 +120,7 @@ module RgGen
           end
 
           def include_guard_footer
-            @guard_macro && (-> { self.class.endif_keyword })
+            @guard_macro && -> { self.class.endif_keyword }
           end
         end
       end

data/lib/rggen/core/utility/code_utility.rb

@@ -42,8 +42,8 @@ module RgGen
           [name, *size&.map { |s| "[#{s}]" }].join
         end
 
-        def code_block(indent = 0, &body)
-          CodeBlock.new(indent, &body)
+        def code_block(indent = 0, &)
+          CodeBlock.new(indent, &)
         end
 
         def indent(code, indent_size)

data/lib/rggen/core/utility/regexp_patterns.rb

@@ -12,7 +12,7 @@ module RgGen
 
         private
 
-        VARIABLE_NAME_PATTERN = /[a-z_]\w*/i
+        VARIABLE_NAME_PATTERN = /[a-z]\w+/i
 
         def variable_name
           VARIABLE_NAME_PATTERN

data/lib/rggen/core/version.rb

@@ -2,7 +2,7 @@
 
 module RgGen
   module Core
-    VERSION = '0.33.0'
+    VERSION = '0.34.0'
     MAJOR, MINOR, PATCH = VERSION.split('.').map(&:to_i)
   end
 end

data/lib/rggen/core.rb

@@ -5,12 +5,13 @@ require 'docile'
 require 'erubi'
 require 'fileutils'
 require 'forwardable'
-require 'json'
 require 'optparse'
 require 'pathname'
 require 'singleton'
-require 'tomlrb'
-require 'yaml'
+
+autoload :JSON, 'json'
+autoload :Psych, 'yaml'
+autoload :Tomlrb, 'tomlrb'
 
 require_relative 'core/version'
 
@@ -30,6 +31,7 @@ require_relative 'core/utility/type_checker'
 
 require_relative 'core/exceptions'
 
+require_relative 'core/base/feature_variable'
 require_relative 'core/base/internal_struct'
 require_relative 'core/base/shared_context'
 require_relative 'core/base/component'
@@ -39,10 +41,10 @@ require_relative 'core/base/feature'
 require_relative 'core/base/feature_factory'
 require_relative 'core/base/feature_layer_extension'
 
+require_relative 'core/input_base/error'
 require_relative 'core/input_base/input_value'
 require_relative 'core/input_base/input_data'
 require_relative 'core/input_base/input_value_extractor'
-require_relative 'core/input_base/error'
 require_relative 'core/input_base/conversion_utility'
 require_relative 'core/input_base/loader'
 require_relative 'core/input_base/json_loader'
@@ -61,7 +63,6 @@ require_relative 'core/input_base/hash_list_parser'
 require_relative 'core/input_base/feature_factory'
 
 require_relative 'core/configuration/input_data'
-require_relative 'core/configuration/error'
 require_relative 'core/configuration/component'
 require_relative 'core/configuration/component_factory'
 require_relative 'core/configuration/feature'
@@ -75,7 +76,6 @@ require_relative 'core/configuration/yaml_loader'
 require_relative 'core/configuration'
 
 require_relative 'core/register_map/input_data'
-require_relative 'core/register_map/error'
 require_relative 'core/register_map/component'
 require_relative 'core/register_map/component_factory'
 require_relative 'core/register_map/feature'
@@ -90,8 +90,8 @@ require_relative 'core/register_map'
 
 require_relative 'core/output_base/template_engine'
 require_relative 'core/output_base/erb_engine'
-require_relative 'core/output_base/code_generator'
 require_relative 'core/output_base/file_writer'
+require_relative 'core/output_base/code_generatable'
 require_relative 'core/output_base/raise_error'
 require_relative 'core/output_base/component'
 require_relative 'core/output_base/component_factory'

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: rggen-core
 version: !ruby/object:Gem::Version
-  version: 0.33.0
+  version: 0.34.0
 platform: ruby
 authors:
 - Taichi Ishitani
-autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-01-22 00:00:00.000000000 Z
+date: 2025-01-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: docile
@@ -91,6 +90,7 @@ files:
 - lib/rggen/core/base/feature.rb
 - lib/rggen/core/base/feature_factory.rb
 - lib/rggen/core/base/feature_layer_extension.rb
+- lib/rggen/core/base/feature_variable.rb
 - lib/rggen/core/base/internal_struct.rb
 - lib/rggen/core/base/shared_context.rb
 - lib/rggen/core/builder.rb
@@ -112,7 +112,6 @@ files:
 - lib/rggen/core/configuration.rb
 - lib/rggen/core/configuration/component.rb
 - lib/rggen/core/configuration/component_factory.rb
-- lib/rggen/core/configuration/error.rb
 - lib/rggen/core/configuration/feature.rb
 - lib/rggen/core/configuration/feature_factory.rb
 - lib/rggen/core/configuration/hash_loader.rb
@@ -149,7 +148,7 @@ files:
 - lib/rggen/core/input_base/verifier.rb
 - lib/rggen/core/input_base/yaml_loader.rb
 - lib/rggen/core/options.rb
-- lib/rggen/core/output_base/code_generator.rb
+- lib/rggen/core/output_base/code_generatable.rb
 - lib/rggen/core/output_base/component.rb
 - lib/rggen/core/output_base/component_factory.rb
 - lib/rggen/core/output_base/document_component_factory.rb
@@ -164,7 +163,6 @@ files:
 - lib/rggen/core/register_map.rb
 - lib/rggen/core/register_map/component.rb
 - lib/rggen/core/register_map/component_factory.rb
-- lib/rggen/core/register_map/error.rb
 - lib/rggen/core/register_map/feature.rb
 - lib/rggen/core/register_map/feature_factory.rb
 - lib/rggen/core/register_map/hash_loader.rb
@@ -193,7 +191,6 @@ metadata:
   rubygems_mfa_required: 'true'
   source_code_uri: https://github.com/rggen/rggen-core
   wiki_uri: https://github.com/rggen/rggen/wiki
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -201,15 +198,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.0.0
+      version: 3.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.3
-signing_key: 
+rubygems_version: 3.6.2
 specification_version: 4
-summary: rggen-core-0.33.0
+summary: rggen-core-0.34.0
 test_files: []

data/lib/rggen/core/configuration/error.rb

@@ -1,20 +0,0 @@
-# frozen_string_literal: true
-
-module RgGen
-  module Core
-    module Configuration
-      class ConfigurationError < Core::RuntimeError
-      end
-
-      module RaiseError
-        include InputBase::RaiseError
-
-        private
-
-        def error_exception
-          ConfigurationError
-        end
-      end
-    end
-  end
-end

data/lib/rggen/core/output_base/code_generator.rb

@@ -1,45 +0,0 @@
-# frozen_string_literal: true
-
-module RgGen
-  module Core
-    module OutputBase
-      class CodeGenerator
-        def register(kind, &block)
-          block_given? && (code_blocks[kind] << block)
-        end
-
-        def generate(context, code, kind)
-          code_blocks[kind].each do |block|
-            execute_code_block(context, code, &block)
-          end
-        end
-
-        def copy
-          generator = CodeGenerator.new
-          generator.copy_code_blocks(@code_blocks) if @code_blocks
-          generator
-        end
-
-        private
-
-        def code_blocks
-          @code_blocks ||= Hash.new { |blocks, kind| blocks[kind] = [] }
-        end
-
-        def execute_code_block(context, code, &block)
-          if block.arity.zero?
-            code << context.instance_exec(&block)
-          else
-            context.instance_exec(code, &block)
-          end
-        end
-
-        protected
-
-        def copy_code_blocks(original_blocks)
-          original_blocks.each { |kind, blocks| code_blocks[kind] = blocks.dup }
-        end
-      end
-    end
-  end
-end

data/lib/rggen/core/register_map/error.rb

@@ -1,20 +0,0 @@
-# frozen_string_literal: true
-
-module RgGen
-  module Core
-    module RegisterMap
-      class RegisterMapError < Core::RuntimeError
-      end
-
-      module RaiseError
-        include InputBase::RaiseError
-
-        private
-
-        def error_exception
-          RegisterMapError
-        end
-      end
-    end
-  end
-end