opengl-registry 1.0.0

data/lib/opengl/registry/token.rb

@@ -0,0 +1,29 @@
+module GL
+  class Registry
+
+    ##
+    # @abstract Base class for OpenGL registry defined items.
+    class Token
+
+      ##
+      # @return [String?] an arbitrary comment associated with this object.
+      attr_reader :comment
+
+      ##
+      # Creates a new instance of the {Token} class.
+      #
+      # @param node [Ox::Element] The XML element defining the instance.
+      def initialize(node)
+        raise ArgumentError, 'item node cannot be nil' unless node
+
+        @comment = node[Words::COMMENT]
+      end
+
+      ##
+      # @return [String] the string representation of this object.
+      def to_s
+        @name || super
+      end
+    end
+  end
+end

data/lib/opengl/registry/version.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module GL
+  class Registry
+
+    ##
+    # The current version of the `opengl-registry` gem.
+    VERSION = '1.0.0'
+  end
+end

data/lib/opengl/registry/words.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module GL
+
+  class Registry
+
+    ##
+    # Strongly-typed values for common XML element/attribute names.
+    module Words
+
+      ENUM = 'enum'
+      COMMAND = 'command'
+      REGISTRY = 'registry'
+      COMMENT = 'comment'
+      NAMESPACE = 'namespace'
+      GROUP = 'group'
+      NAME = 'name'
+      RANGE_START = 'start'
+      RANGE_END = 'end'
+      API = 'api'
+      ALIAS = 'alias'
+      TYPE = 'type'
+      VENDOR = 'vendor'
+      VALUE = 'value'
+      PROTO = 'proto'
+      PTYPE = 'ptype'
+      PARAM = 'param'
+      GLX = 'glx'
+      VECTOR_EQUIVALENT = 'vecequiv'
+      LENGTH = 'len'
+      NUMBER = 'number'
+      PROFILE = 'profile'
+      SUPPORTED = 'supported'
+      U_LONG = 'u'
+      U_LONG_LONG = 'ull'
+      BITMASK = 'bitmask'
+    end
+  end
+end

data/lib/opengl/spec.rb

@@ -0,0 +1,176 @@
+module GL
+
+  ##
+  # Describes a specific subset of the OpenGL registry, targeting an API, version, profile, etc.
+  # 
+  # Automatically filters all results bu the specified criteria, only returning results that are
+  # used in the specification.
+  class Spec
+
+    ##
+    # @return [Registry] the registry instance the specification uses for reference.
+    attr_accessor :registry
+
+    ##
+    # @return [Symbol] the OpenGL API name.
+    attr_reader :api
+
+    ##
+    # @return [String] the OpenGL version number for the specification.
+    attr_reader :version
+
+    ##
+    # @return [Symbol] the OpenGL profile name for the specification.
+    attr_reader :profile
+
+    ##
+    # @return [Array<String>] an array of extension names.
+    attr_reader :extensions
+
+    ##
+    # Creates a new instance of the {Spec} class.
+    #
+    # @param registry [Registry] An registry instance to use for definition referencing.
+    # @param api [Symbol,String] The OpenGL API name.
+    # @param version [String,Float] The OpenGL version number for the specification.
+    # @param profile [Symbol,String] The OpenGL profile name for the specification.
+    # @param extensions [Array<String>] Names of extensions name to include definitions for.
+    def initialize(registry, api, version, profile, *extensions)
+      @registry = registry
+      @api = api.to_sym
+      @profile = profile.to_sym
+      @version = Float(version).to_s
+      @extensions = extensions&.uniq || []
+    end
+
+    ##
+    # Retrieves a complete list of all OpenGL types that this specification must have defined. Any type not included
+    # here does not need to be mapped.
+    #
+    # @param groups [Boolean] `true` to include group (enumeration) names, otherwise `false`
+    #
+    # @return [Array<Symbol>] a collection of OpenGL types.
+    # @note The values are re-calculated each time this method is invoked, so consider caching the result if reusing.
+    def types(groups = false)
+
+      values = {}
+      functions.each do |func|
+
+        values[func.type.base] = true
+        values[func.type.group] = true if groups && func.type.group
+
+        func.arguments.each do |arg|
+          values[arg.type.base] = true
+          values[arg.type.group] = true if groups && arg.type.group
+        end
+      end
+
+      #noinspection RubyYardReturnMatch
+      values.keys.map(&:to_sym)
+    end
+
+    ##
+    # Retrieves a complete list of all OpenGL functions that this specification defines.
+    #
+    # @return [Array<Registry::Function>] a collection of {Registry::Function} instances.
+    # @note The values are re-calculated each time this method is invoked, so consider caching the result if reusing.
+    def functions
+      items(:function, @registry.functions)
+    end
+
+    ##
+    # Retrieves a complete list of all OpenGL enumeration values that this specification defines.
+    #
+    # @return [Array<Registry::Enum>] a collection of {Registry::Enum} instances.
+    # @note The values are re-calculated each time this method is invoked, so consider caching the result if reusing.
+    def enums
+      items(:enum, @registry.enums)
+    end
+
+    ##
+    # Retrieves a complete list of all OpenGL group names that this specification uses.
+    #
+    # @return [Array<String>] a collection of group (enumeration) names.
+    # @note The values are re-calculated each time this method is invoked, so consider caching the result if reusing.
+    def used_groups
+
+      names = {}
+      functions.each do |func|
+
+        names[func.type.group] = true if func.type.group
+        func.arguments.each do |arg|
+          group = arg.type.group
+          next unless group
+
+          names[group] = true
+        end
+      end
+      names.keys
+    end
+
+    ##
+    # @return [String] the string representation of this object.
+    def to_s
+      if profile != :none
+        return "Open#{@api.to_s.upcase} #{@version} (#{@profile} profile)"
+      end
+      "Open#{@api.to_s.upcase} #{@version}"
+    end
+
+    private
+
+    def items(type, definitions)
+      raise 'registry is nil' unless @registry
+
+      values = []
+
+      # Enumerate through each feature group
+      @registry.features.each do |group|
+
+        # Skip unless this group implements the specified API and version
+        next if group.api != @api
+        next if group.version > @version
+
+        # Enumerator through item this group implements
+        group.additions.each do |feature|
+          # Skip if this is not the specified type of not within the profile
+          next if feature.type != type
+          next unless feature.profile == :none || feature.profile == @profile
+
+          # Add the definition this feature represents
+          values << definitions.find { |item| item.name == feature.name }
+        end
+
+        # Enumerate through any "removed item" for this group
+        group.removals.each do |feature|
+          # Skip if this is not the specified type of not within the profile
+          next unless feature.type == type
+          next unless feature.profile == :none || feature.profile == @profile
+
+          # Remove the definition this feature represents
+          values.delete_if { |item| item.name == feature.name }
+        end
+      end
+
+      # Enumerate through each extension
+      @extensions.each do |name|
+        # Find the extension definition, skipping unless supported by the API
+        ext = @registry.extensions.find { |e| e.name == name }
+        next unless ext && ext.supported.include?(@api)
+
+        # Enumerate through each feature this extension implements
+        ext.additions.each do |feature|
+          # Skip if this is not the specified type of not within the profile
+          next if feature.type != type
+          next unless feature.profile == :none || feature.profile == @profile
+
+          # Add the definition this feature represents
+          values << definitions.find { |item| item.name == feature.name }
+        end
+      end
+
+      # Return results
+      values
+    end
+  end
+end

data/opengl-registry.gemspec

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require_relative 'lib/opengl/registry/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'opengl-registry'
+  spec.version       = GL::Registry::VERSION
+  spec.authors       = ['ForeverZer0']
+  spec.email         = ['efreed09@gmail.com']
+
+  spec.summary      = 'OpenGL Registry parser for generating API specifications'
+  spec.description  = <<-EOS
+  Parses the Khronos OpenGL registry into a standardized and user-friendly data structure that can be walked through,
+  providing an essential need for tools that generate code to create an OpenGL wrapper/bindings, for any language. Given
+  an API name, version, and profile, is capable of filtering and grouping data structures that cover that specific
+  subset of definitions, using a typical Ruby object-oriented approach.
+  EOS
+  spec.homepage     = 'https://github.com/ForeverZer0/opengl-registry'
+  spec.license      = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
+
+  spec.metadata['homepage_uri']    = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/ForeverZer0/opengl-registry'
+  spec.metadata['changelog_uri']   = 'https://github.com/ForeverZer0/opengl-registry/CHANGELOG.md'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'rake', '~> 12.0'
+  spec.add_runtime_dependency 'ox', '~> 2.13'
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: opengl-registry
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- ForeverZer0
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-05-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: ox
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.13'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.13'
+description: |2
+    Parses the Khronos OpenGL registry into a standardized and user-friendly data structure that can be walked through,
+    providing an essential need for tools that generate code to create an OpenGL wrapper/bindings, for any language. Given
+    an API name, version, and profile, is capable of filtering and grouping data structures that cover that specific
+    subset of definitions, using a typical Ruby object-oriented approach.
+email:
+- efreed09@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- ".yardopts"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/opengl/registry.rb
+- lib/opengl/registry/argument.rb
+- lib/opengl/registry/enum.rb
+- lib/opengl/registry/extension.rb
+- lib/opengl/registry/feature.rb
+- lib/opengl/registry/feature_group.rb
+- lib/opengl/registry/feature_provider.rb
+- lib/opengl/registry/function.rb
+- lib/opengl/registry/group.rb
+- lib/opengl/registry/native_type.rb
+- lib/opengl/registry/token.rb
+- lib/opengl/registry/version.rb
+- lib/opengl/registry/words.rb
+- lib/opengl/spec.rb
+- opengl-registry.gemspec
+homepage: https://github.com/ForeverZer0/opengl-registry
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/ForeverZer0/opengl-registry
+  source_code_uri: https://github.com/ForeverZer0/opengl-registry
+  changelog_uri: https://github.com/ForeverZer0/opengl-registry/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: OpenGL Registry parser for generating API specifications
+test_files: []