rggen-c-header 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: bde50cf30f12147cac1bbe3b5d13ba5a1fadf7714d24f64a3fbe339708eadae4
+  data.tar.gz: e88709a2d9362c0d326e732a59ad910df61176d61a9acf55e2463e7505f44d3f
+SHA512:
+  metadata.gz: ff93ca1e266012860248b3df4a63c3fd1789ba6937761bd077c6bf53b456eded67b0a0fa19529910a36aea4843c44408941a0a4bb97fc6124ea71d5063a1644c
+  data.tar.gz: 97f87c1eed64dba48287b0645a5f93a0e4b34d3b14921f85fc7737825c86cbb3c7467e8c53fb59e68e21741ff24243cc863a51fc42a5c5f4029510108c45f6cf

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders 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, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at taichi730@gmail.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 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,59 @@
+[![Gem Version](https://badge.fury.io/rb/rggen-c-header.svg)](https://badge.fury.io/rb/rggen-c-header)
+[![CI](https://github.com/rggen/rggen-c-header/actions/workflows/ci.yml/badge.svg)](https://github.com/rggen/rggen-c-header/actions/workflows/ci.yml)
+[![Maintainability](https://api.codeclimate.com/v1/badges/abc9b4eea884c4b32805/maintainability)](https://codeclimate.com/github/rggen/rggen-c-header/maintainability)
+[![codecov](https://codecov.io/gh/rggen/rggen-c-header/branch/master/graph/badge.svg?token=kUhLlLvtv6)](https://codecov.io/gh/rggen/rggen-c-header)
+[![Gitter](https://badges.gitter.im/rggen/rggen.svg)](https://gitter.im/rggen/rggen?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
+
+# RgGen::CHeader
+
+RgGen::CHeader is a RgGen plugin to generate C header file.
+
+## Installation
+
+To install RgGen::CHeader, use the following command:
+
+```
+$ gem install rggen-c-header
+```
+
+## Usage
+
+You need to tell RgGen to load RgGen::CHeader plugin. There are two ways.
+
+### Using `--plugin` runtime option
+
+```
+$ rggen --plugin rggen-c-header your_register_map.yml
+```
+
+### Using `RGGEN_PLUGINS` environment variable
+
+```
+$ export RGGEN_PLUGINS=${RGGEN_PLUGINS}:rggen-c-header
+$ rggen your_register_map.yml
+```
+
+## Example
+
+You can find sample C header files generated from sample register map specifications from [this repository](https://github.com/rggen/rggen-sample).
+
+* https://github.com/rggen/rggen-sample/blob/master/block_0.h
+* https://github.com/rggen/rggen-sample/blob/master/block_1.h
+
+## Contact
+
+Feedbacks, bus reports, questions and etc. are welcome! You can post them bu using following ways:
+
+* [GitHub Issue Tracker](https://github.com/rggen/rggen/issues)
+* [GitHub Discussions](https://github.com/rggen/rggen/discussions)
+* [Chat Room](https://gitter.im/rggen/rggen)
+* [Mailing List](https://groups.google.com/d/forum/rggen)
+* [Mail](mailto:rggen@googlegroups.com)
+
+## Copyright & License
+
+Copyright © 2022 Taichi Ishitani. RgGen::CHeader is licensed under the [MIT License](https://opensource.org/licenses/MIT), see [LICENSE](LICENSE) for futher details.
+
+## Code of Conduct
+
+Everyone interacting in the RgGen::CHeader project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/rggen/rggen-c-header/blob/master/CODE_OF_CONDUCT.md).

data/lib/rggen/c_header/bit_field/c_header.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+RgGen.define_simple_feature(:bit_field, :c_header) do
+  c_header do
+    build do
+      define_macro("#{full_name}_bit_width", width)
+      define_macro("#{full_name}_bit_mask", mask)
+      define_offset_macro
+    end
+
+    private
+
+    def width
+      bit_field.width
+    end
+
+    def mask
+      hex((1 << width) - 1)
+    end
+
+    def define_offset_macro
+      if bit_field.sequential?
+        bit_field.sequence_size.times do |i|
+          define_macro("#{full_name}_bit_offset_#{i}", bit_field.lsb(i))
+        end
+      else
+        define_macro("#{full_name}_bit_offset", bit_field.lsb)
+      end
+    end
+  end
+end

data/lib/rggen/c_header/component.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module RgGen
+  module CHeader
+    class Component < Core::OutputBase::Component
+      def macro_definitions
+        [
+          @features.each_value.map(&:macro_definitions),
+          @children.map(&:macro_definitions)
+        ].flatten
+      end
+    end
+  end
+end

data/lib/rggen/c_header/factories.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module RgGen
+  module CHeader
+    class ComponentFactory < Core::OutputBase::SourceFileComponentFactory
+    end
+
+    class FeatureFactory < Core::OutputBase::FeatureFactory
+    end
+  end
+end

data/lib/rggen/c_header/feature.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module RgGen
+  module CHeader
+    class Feature < Core::OutputBase::Feature
+      include Utility
+
+      def macro_definitions
+        @macro_definitions ||= []
+      end
+
+      private
+
+      def define_macro(name, value = nil)
+        macro_definitions <<
+          Utility::MacroDefinition.new(name.upcase, value)
+      end
+
+      def full_name(separator = '_')
+        [register_block.name, component.full_name(separator)].join(separator)
+      end
+    end
+  end
+end

data/lib/rggen/c_header/register/c_header.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+RgGen.define_simple_feature(:register, :c_header) do
+  c_header do
+    pre_build do
+      if register.width > 64
+        message =
+          'register of which width is wider than 64 bits is not allowed: ' \
+          "#{full_name('.')} width #{register.width}"
+        raise RgGen::Core::RegisterMap::RegisterMapError.new(message)
+      end
+    end
+
+    build do
+      define_macro("#{full_name}_byte_width", byte_width)
+      define_macro("#{full_name}_byte_size", byte_size)
+      define_array_macros if array?
+      define_offset_address_macros
+    end
+
+    private
+
+    def byte_width
+      register.byte_width
+    end
+
+    def byte_size
+      array_size_upper_layer.inject(1, :*) * register.byte_size
+    end
+
+    def array?
+      register_files.any?(&:array?) || register.array?
+    end
+
+    def define_array_macros
+      size_list = array_size
+      define_macro("#{full_name}_array_dimension", size_list.size)
+      size_list.each_with_index do |size, i|
+        define_macro("#{full_name}_array_size_#{i}", size)
+      end
+    end
+
+    def define_offset_address_macros
+      if array?
+        address_list.zip(array_suffix) do |address, suffix|
+          define_macro("#{full_name}_byte_offset_#{suffix}", hex(address))
+        end
+      else
+        define_macro("#{full_name}_byte_offset", hex(address_list.first))
+      end
+    end
+
+    def address_list
+      upper_address_list = register_file&.expanded_offset_addresses || [0]
+      upper_address_list.product(local_address_list).map(&:sum)
+    end
+
+    def local_address_list
+      Array.new(register.count) do |i|
+        if register.settings[:support_shared_address]
+          register.offset_address
+        else
+          register.offset_address + register.byte_width * i
+        end
+      end
+    end
+
+    def array_suffix
+      index_list = array_size.map { |size| size.times.to_a }
+      index_list.first.product(*index_list[1..]).map { |index| index.join('_') }
+    end
+
+    def array_size_upper_layer
+      register_files.flat_map(&:array_size).compact
+    end
+
+    def array_size
+      [*register_files, register].flat_map(&:array_size).compact
+    end
+  end
+end

data/lib/rggen/c_header/register_block/c_header.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+RgGen.define_simple_feature(:register_block, :c_header) do
+  c_header do
+    write_file '<%= register_block.name %>.h' do |f|
+      f.include_guard
+      f.body do |code|
+        register_block.macro_definitions.each do |macro|
+          code << macro << nl
+        end
+      end
+    end
+  end
+end

data/lib/rggen/c_header/setup.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require 'rggen/c_header'
+
+RgGen.register_plugin RgGen::CHeader do |builder|
+  builder.enable :register_block, [:c_header]
+  builder.enable :register, [:c_header]
+  builder.enable :bit_field, [:c_header]
+end

data/lib/rggen/c_header/utility/macro_definition.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module RgGen
+  module CHeader
+    module Utility
+      class MacroDefinition
+        def initialize(name, value = nil)
+          @name = name
+          @value = value
+        end
+
+        def to_s
+          @value && "#define #{@name} #{@value}" || "#define #{@name}"
+        end
+      end
+    end
+  end
+end

data/lib/rggen/c_header/utility/source_file.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module RgGen
+  module CHeader
+    class SourceFile < Core::Utility::CodeUtility::SourceFile
+      ifndef_keyword '#ifndef'
+      endif_keyword '#endif'
+      define_keyword '#define'
+      include_keyword '#include'
+    end
+  end
+end

data/lib/rggen/c_header/utility.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module RgGen
+  module CHeader
+    module Utility
+      include Core::Utility::CodeUtility
+
+      def create_blank_file(path)
+        SourceFile.new(path)
+      end
+
+      private
+
+      def hex(value)
+        format('0x%x', value)
+      end
+    end
+  end
+end

data/lib/rggen/c_header/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module RgGen
+  module CHeader
+    VERSION = '0.1.0'
+  end
+end

data/lib/rggen/c_header.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require_relative 'c_header/version'
+require_relative 'c_header/utility/macro_definition'
+require_relative 'c_header/utility/source_file'
+require_relative 'c_header/utility'
+require_relative 'c_header/feature'
+require_relative 'c_header/component'
+require_relative 'c_header/factories'
+
+module RgGen
+  module CHeader
+    extend Core::Plugin
+
+    setup_plugin :'rggen-c-header' do |plugin|
+      plugin.register_component :c_header do
+        component Component, ComponentFactory
+        feature Feature, FeatureFactory
+      end
+
+      plugin.files [
+        'c_header/bit_field/c_header',
+        'c_header/register/c_header',
+        'c_header/register_block/c_header'
+      ]
+    end
+  end
+end

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification
+name: rggen-c-header
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Taichi Ishitani
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2022-06-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: C header file writer plugin for RgGen
+email:
+- rggen@googlegroups.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CODE_OF_CONDUCT.md
+- LICENSE
+- README.md
+- lib/rggen/c_header.rb
+- lib/rggen/c_header/bit_field/c_header.rb
+- lib/rggen/c_header/component.rb
+- lib/rggen/c_header/factories.rb
+- lib/rggen/c_header/feature.rb
+- lib/rggen/c_header/register/c_header.rb
+- lib/rggen/c_header/register_block/c_header.rb
+- lib/rggen/c_header/setup.rb
+- lib/rggen/c_header/utility.rb
+- lib/rggen/c_header/utility/macro_definition.rb
+- lib/rggen/c_header/utility/source_file.rb
+- lib/rggen/c_header/version.rb
+homepage: https://github.com/rggen/rggen-c-header
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: https://github.com/rggen/rggen-c-header/issues
+  mailing_list_uri: https://groups.google.com/d/forum/rggen
+  rubygems_mfa_required: 'true'
+  source_code_uri: https://github.com/rggen/rggen-c-header
+  wiki_uri: https://github.com/rggen/rggen/wiki
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.3
+signing_key: 
+specification_version: 4
+summary: rggen-c-header-0.1.0
+test_files: []