rggen 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0dee9380fac0315414a76aa4bdf305528fe30335
+  data.tar.gz: 82cba15bcfa8788bb719d703ae549e32e5b381d2
+SHA512:
+  metadata.gz: 552c1a13e87dcb9d97d472268f026392bb16d2e40cba50b7f5b5f12c10b2b7867f86d0118fb432c7307d1fde1078d7d9273b2be902355810380e8d289fa5c8e2
+  data.tar.gz: e72990eab0ef33aa739d915b83949756feb45278e2cc17a463426e9a17e6365fcd4013b18bd5dbe60c795108ac791ae99d2e7ddf12d27b6a7e3142945e2d9c63

data/.rubocop.yml

@@ -0,0 +1,7 @@
+inherit_from: .rubocop_todo.yml
+
+AllCops:
+  Exclude:
+    - 'sample/*'
+    - 'setup/*'
+    - 'spec/**/*'

data/.rubocop_todo.yml

@@ -0,0 +1,91 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2015-12-27 19:46:19 +0900 using RuboCop version 0.35.1.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 2
+Lint/FormatParameterMismatch:
+  Exclude:
+    - 'lib/rgen/core_components/rtl/item.rb'
+
+# Offense count: 3
+Metrics/AbcSize:
+  Max: 18
+
+# Offense count: 1
+Metrics/CyclomaticComplexity:
+  Max: 7
+
+# Offense count: 8
+# Configuration parameters: AllowURI, URISchemes.
+Metrics/LineLength:
+  Max: 142
+
+# Offense count: 1
+# Configuration parameters: CountComments.
+Metrics/MethodLength:
+  Max: 11
+
+# Offense count: 72
+# Configuration parameters: Exclude.
+Style/Documentation:
+  Enabled: false
+
+# Offense count: 56
+# Cop supports --auto-correct.
+# Configuration parameters: AllowForAlignment.
+Style/ExtraSpacing:
+  Enabled: false
+
+# Offense count: 2
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles, UseHashRocketsWithSymbolValues.
+Style/HashSyntax:
+  Enabled: false
+
+# Offense count: 33
+# Cop supports --auto-correct.
+Style/SingleSpaceBeforeFirstArg:
+  Exclude:
+    - 'lib/rgen/builtins/register_block/apb.rb'
+    - 'lib/rgen/core_components/configuration/setup.rb'
+    - 'lib/rgen/core_components/register_map/generic_map.rb'
+    - 'lib/rgen/core_components/register_map/setup.rb'
+    - 'lib/rgen/core_components/rtl/setup.rb'
+    - 'lib/rgen/output_base/line.rb'
+
+# Offense count: 28
+# Cop supports --auto-correct.
+# Configuration parameters: MultiSpaceAllowedForOperators.
+Style/SpaceAroundOperators:
+  Enabled: false
+
+# Offense count: 42
+# Cop supports --auto-correct.
+Style/SpaceBeforeComma:
+  Exclude:
+    - 'lib/rgen/builder/list_item_entry.rb'
+    - 'lib/rgen/builtins/bit_field/type.rb'
+    - 'lib/rgen/builtins/register_block/apb.rb'
+    - 'lib/rgen/builtins/register_block/clock_reset.rb'
+    - 'lib/rgen/builtins/register_block/host_if.rb'
+    - 'lib/rgen/builtins/register_block/response_mux.rb'
+    - 'lib/rgen/commands.rb'
+    - 'lib/rgen/core_extensions/forwardable.rb'
+    - 'rgen.gemspec'
+
+# Offense count: 5
+# Cop supports --auto-correct.
+Style/SpaceInsideBrackets:
+  Exclude:
+    - 'lib/rgen/commands.rb'
+
+# Offense count: 2
+# Cop supports --auto-correct.
+Style/SpaceInsideParens:
+  Exclude:
+    - 'lib/rgen/builder/category.rb'
+

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at taichi730@jf6.so-net.ne.jp. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 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
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,31 @@
+[![Build Status](https://travis-ci.org/taichi-ishitani/rggen.svg?branch=master)](https://travis-ci.org/taichi-ishitani/rggen)
+[![Code Climate](https://codeclimate.com/github/taichi-ishitani/rggen/badges/gpa.svg)](https://codeclimate.com/github/taichi-ishitani/rggen)
+[![Test Coverage](https://codeclimate.com/github/taichi-ishitani/rggen/badges/coverage.svg)](https://codeclimate.com/github/taichi-ishitani/rggen/coverage)
+
+# RgGen
+
+RgGen is a code generation tool for SoC designers. You can automatically generate soruce code for control registers in a SoC design, e.g. RTL, UVM RAL model, from its register map document. You can also customize RgGen, so you can build your specific generation tool.
+
+## Installation
+
+TODO: Write installation command here
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/taichi-ishitani/rggen. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+Copyright © 2015-2016 [Taichi Ishitani](mailto:taichi730@gmail.com).
+RgGen is available as open source under the terms of the [MIT License](LICENSE.txt).

data/bin/rggen

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.unshift(File.join(__dir__, '../lib'))
+
+require 'rggen'
+RgGen::Generator.new.run(ARGV)

data/lib/rggen/base/component.rb

@@ -0,0 +1,27 @@
+module RgGen
+  module Base
+    class Component
+      include SingleForwardable
+
+      def initialize(parent)
+        @parent   = parent
+        @children = []
+        @level    = (parent && parent.level + 1) || 0
+        @items    = []
+      end
+
+      attr_reader :parent
+      attr_reader :children
+      attr_reader :level
+      attr_reader :items
+
+      def add_child(child)
+        @children << child
+      end
+
+      def add_item(item)
+        items << item
+      end
+    end
+  end
+end

data/lib/rggen/base/component_factory.rb

@@ -0,0 +1,46 @@
+module RgGen
+  module Base
+    class ComponentFactory
+      def initialize
+        @root_factory = false
+      end
+
+      attr_writer :target_component
+      attr_writer :item_factories
+      attr_writer :child_factory
+
+      def create(*args)
+        parent  = (child_factory? && args.shift) || nil
+        sources = args
+        create_component(parent, *sources).tap do |component|
+          create_items(component, *sources) if @item_factories
+          parent.add_child(component) unless @root_factory
+          create_children(component, *sources) if @child_factory
+        end
+      end
+
+      def root_factory
+        @root_factory = true
+      end
+
+      private
+
+      def child_factory?
+        !@root_factory
+      end
+
+      def create_component(parent, *_sources)
+        @target_component.new(parent)
+      end
+
+      def create_item(item_factory, component, *sources)
+        item  = item_factory.create(component, *sources)
+        component.add_item(item)
+      end
+
+      def create_child(component, *sources)
+        @child_factory.create(component, *sources)
+      end
+    end
+  end
+end

data/lib/rggen/base/hierarchical_accessors.rb

@@ -0,0 +1,87 @@
+module RgGen
+  module Base
+    module HierarchicalAccessors
+      module RegisterMap
+        def hierarchy
+          :register_map
+        end
+
+        def register_blocks
+          children
+        end
+
+        def registers
+          register_blocks.flat_map(&:children)
+        end
+
+        def bit_fields
+          registers.flat_map(&:children)
+        end
+      end
+
+      module RegisterBlock
+        def hierarchy
+          :register_block
+        end
+
+        def register_map
+          parent
+        end
+
+        def registers
+          children
+        end
+
+        def bit_fields
+          registers.flat_map(&:children)
+        end
+      end
+
+      module Register
+        def hierarchy
+          :register
+        end
+
+        def register_map
+          register_block.parent
+        end
+
+        def register_block
+          parent
+        end
+
+        def bit_fields
+          children
+        end
+      end
+
+      module BitField
+        def hierarchy
+          :bit_field
+        end
+
+        def register_map
+          register_block.parent
+        end
+
+        def register_block
+          register.parent
+        end
+
+        def register
+          parent
+        end
+      end
+
+      private
+
+      EXTENSIONS  = [
+        RegisterMap, RegisterBlock, Register, BitField
+      ].freeze
+
+      def define_hierarchical_accessors
+        extend EXTENSIONS[level]
+      end
+    end
+  end
+end

data/lib/rggen/base/hierarchical_item_accessors.rb

@@ -0,0 +1,79 @@
+module RgGen
+  module Base
+    module HierarchicalItemAccessors
+      module RegisterMap
+        def hierarchy
+          :register_map
+        end
+
+        def register_map
+          @owner
+        end
+      end
+
+      module RegisterBlock
+        def hierarchy
+          :register_block
+        end
+
+        def register_map
+          register_block.parent
+        end
+
+        def register_block
+          @owner
+        end
+      end
+
+      module Register
+        def hierarchy
+          :register
+        end
+
+        def register_map
+          register_block.parent
+        end
+
+        def register_block
+          register.parent
+        end
+
+        def register
+          @owner
+        end
+      end
+
+      module BitField
+        def hierarchy
+          :bit_field
+        end
+
+        def register_map
+          register_block.parent
+        end
+
+        def register_block
+          register.parent
+        end
+
+        def register
+          bit_field.parent
+        end
+
+        def bit_field
+          @owner
+        end
+      end
+
+      private
+
+      EXTENSIONS  = [
+        RegisterMap, RegisterBlock, Register, BitField
+      ].freeze
+
+      def define_hierarchical_item_accessors
+        extend EXTENSIONS[@owner.level]
+      end
+    end
+  end
+end

data/lib/rggen/base/item.rb

@@ -0,0 +1,24 @@
+module RgGen
+  module Base
+    class Item
+      extend Forwardable
+
+      def initialize(owner)
+        @owner  = owner
+      end
+
+      attr_reader :owner
+
+      def self.define_helpers(&body)
+        singleton_class.class_exec(&body) if block_given?
+      end
+
+      def self.inherit_class_instance_variable(variable_name, parent_class, &block)
+        return unless parent_class.instance_variable_defined?(variable_name)
+        v = parent_class.instance_variable_get(variable_name)
+        v = block.call(v) if block_given?
+        instance_variable_set(variable_name, v)
+      end
+    end
+  end
+end

data/lib/rggen/base/item_factory.rb

@@ -0,0 +1,20 @@
+module RgGen
+  module Base
+    class ItemFactory
+      attr_writer :target_items
+      attr_writer :target_item
+
+      def create(owner, *args)
+        create_item(owner, *args)
+      end
+
+      private
+
+      def create_item(owner, *args)
+        klass ||= @target_items && select_target_item(*args)
+        klass ||= @target_item
+        klass.new(owner)
+      end
+    end
+  end
+end

data/lib/rggen/builder/builder.rb

@@ -0,0 +1,69 @@
+module RgGen
+  module Builder
+    class Builder
+      INITIAL_CATEGORIES  = [
+        :global,
+        :register_block,
+        :register,
+        :bit_field
+      ].freeze
+
+      def initialize
+        @stores = Hash.new do |_, component_name|
+          fail RgGen::BuilderError, "unknown component: #{component_name}"
+        end
+        @categories = Hash.new do |_, category_name|
+          fail RgGen::BuilderError, "unknown category: #{category_name}"
+        end
+        INITIAL_CATEGORIES.each do |category_name|
+          @categories[category_name]  = Category.new
+        end
+      end
+
+      attr_reader :categories
+
+      def input_component_store(component_name, &body)
+        component_store(InputComponentStore, component_name, body)
+      end
+
+      def output_component_store(component_name, &body)
+        component_store(OutputComponentStore, component_name, body)
+      end
+
+      def stored_output_components
+        @stores.keys.select do |component_name|
+          @stores[component_name].is_a?(OutputComponentStore)
+        end
+      end
+
+      def define_loader(component_name, type_or_types, &body)
+        @stores[component_name].define_loader(type_or_types, &body)
+      end
+
+      def build_factory(component_name)
+        @stores[component_name].build_factory
+      end
+
+      def define_simple_item(category_name, item_name, &body)
+        @categories[category_name].define_simple_item(item_name, &body)
+      end
+
+      def define_list_item(category_name, list_name, item_name = nil, &body)
+        @categories[category_name].define_list_item(list_name, item_name, &body)
+      end
+
+      def enable(category_name, *args)
+        @categories[category_name].enable(*args)
+      end
+
+      private
+
+      def component_store(klass, component_name, body)
+        unless @stores.key?(component_name)
+          @stores[component_name] = klass.new(self, component_name)
+        end
+        @stores[component_name].instance_exec(&body)
+      end
+    end
+  end
+end

data/lib/rggen/builder/category.rb

@@ -0,0 +1,52 @@
+module RgGen
+  module Builder
+    class Category
+      def initialize
+        @item_stores  = {}
+      end
+
+      def add_item_store(component_name, item_store)
+        return if @item_stores.key?(component_name)
+        @item_stores[component_name]  = item_store
+        define_definition_method(component_name)
+      end
+
+      def define_simple_item(item_name, &body)
+        do_definition(:define_simple_item, item_name, &body)
+      end
+
+      def define_list_item(list_name, item_name = nil, &body)
+        do_definition(:define_list_item, list_name, item_name, &body)
+      end
+
+      def shared_context(&body)
+        @shared_context ||= Object.new
+        @shared_context.singleton_class.class_exec(&body) if block_given?
+      end
+
+      def enable(*args)
+        @item_stores.each_value do |item_registry|
+          item_registry.enable(*args)
+        end
+      end
+
+      private
+
+      def define_definition_method(component_name)
+        define_singleton_method(component_name) do |&body|
+          item_store  = @item_stores[component_name]
+          item_store.__send__(@definition_method, @shared_context, *@arguments, &body)
+        end
+      end
+
+      def do_definition(register_method, *arguments, &body)
+        @definition_method  = register_method
+        @arguments          = arguments
+        instance_exec(&body)
+        remove_instance_variable(:@definition_method)
+        remove_instance_variable(:@arguments        )
+        remove_instance_variable(:@shared_context   ) if @shared_context
+      end
+    end
+  end
+end

data/lib/rggen/builder/component_entry.rb

@@ -0,0 +1,50 @@
+module RgGen
+  module Builder
+    class ComponentEntry
+      class << self
+        private
+
+        def rggen_class_setter(class_type)
+          variable_name = class_type.variablize
+          define_method(class_type) do |base_class = nil, options = {}, &body|
+            if base_class && !instance_variable_defined?(variable_name)
+              klass = define_rggen_class(base_class, options, body)
+              instance_variable_set(variable_name, klass)
+            end
+            instance_variable_get(variable_name)
+          end
+        end
+      end
+
+      rggen_class_setter :component_class
+      rggen_class_setter :component_factory
+      rggen_class_setter :item_base
+      rggen_class_setter :item_factory
+
+      def item_store
+        return nil unless item_base && item_factory
+        @item_store ||= ItemStore.new(item_base, item_factory)
+      end
+
+      def build_factory
+        component_factory.new.tap do |f|
+          f.target_component  = component_class
+          f.item_factories    = item_store.build_factories if item_store
+        end
+      end
+
+      private
+
+      def define_rggen_class(base_class, options, body)
+        if options.key?(:include) || body
+          Class.new(base_class) do
+            include(*Array(options[:include])) if options.key?(:include)
+            class_exec(&body) if body
+          end
+        else
+          base_class
+        end
+      end
+    end
+  end
+end