ctypes 0.2.0

data/lib/ctypes.rb

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+
+# SPDX-FileCopyrightText: 2025 Cisco
+# SPDX-License-Identifier: MIT
+
+require "dry-types"
+require "pp" # standard:disable Lint/RedundantRequireStatement
+
+require_relative "ctypes/version"
+require_relative "ctypes/type"
+require_relative "ctypes/int"
+require_relative "ctypes/helpers"
+require_relative "ctypes/pretty_print_helpers"
+require_relative "ctypes/enum"
+require_relative "ctypes/bitmap"
+require_relative "ctypes/struct"
+require_relative "ctypes/string"
+require_relative "ctypes/array"
+require_relative "ctypes/terminated"
+require_relative "ctypes/union"
+require_relative "ctypes/bitfield"
+require_relative "ctypes/exporter"
+require_relative "ctypes/pad"
+
+# Manipulate binary data in ruby using C-like data types
+module CTypes
+  class Error < StandardError; end
+
+  class TruncatedValueError < Error; end
+
+  class UnknownAttributeError < Error; end
+
+  class UnknownMemberError < Error; end
+
+  class UnknownFieldError < Error; end
+
+  class TerminatorNotFoundError < Error; end
+
+  # @api private
+  Endian = Dry::Types["coercible.symbol"].enum(*%i[big little])
+
+  # set the endian for any datatype that does not have an explicit endian set
+  #
+  # @param value [Symbol] endian, :big or little
+  #
+  # @example big endian
+  #   CTypes.default_endian = :big
+  #   t = CTypes::UInt32
+  #   t.pack(0xdeadbeef)                  # => "\xde\xad\xbe\xef"
+  #   t.pack(0xdeadbeef, endian: :little) # => "\xef\xbe\xad\xde"
+  #
+  #   # create a type that overrides the default endian
+  #   l = CTypes::UInt32.with_endian(:little)
+  #   l.pack(0xdeadbeef)                  # => "\xef\xbe\xad\xde"
+  #
+  # @example little endian
+  #   CTypes.default_endian = :little
+  #   t = CTypes::UInt32
+  #   t.pack(0xdeadbeef)                  # => "\xef\xbe\xad\xde"
+  #   t.pack(0xdeadbeef, endian: :big)    # => "\xde\xad\xbe\xef"
+  #
+  def self.default_endian=(value)
+    @endian = Endian[value]
+  end
+
+  # get the default endian for the system; defaults to native endian
+  def self.default_endian
+    @endian ||= host_endian
+  end
+
+  # get the endian of the system this code is running on
+  def self.host_endian
+    @host_endian ||= ("\xde\xad".unpack1("S") == 0xDEAD) ? :big : :little
+  end
+
+  # set a unknown type lookup method to use in the layout blocks of
+  # `Ctypes::Struct` and `CTypes::Union`.
+  #
+  # Note: the current implementation is not thread-safe.
+  #
+  # @example
+  #   @my_types = { id_t: uint32 }
+  #   my_struct = CTypes.using_type_lookup(->(n) { @my_types[n] }) do
+  #     struct do
+  #       attribute id, id_t
+  #     end
+  #   end
+  def self.using_type_lookup(lookup)
+    @type_lookup ||= []
+    @type_lookup.push(lookup)
+    yield
+  ensure
+    @type_lookup.pop
+  end
+
+  # @api private
+  def self.type_lookup # :nodoc:
+    @type_lookup && @type_lookup[-1]
+  end
+end
+
+require_relative "ctypes/missing_bytes_error"

data/sig/ctypes.rbs

@@ -0,0 +1,4 @@
+module CTypes
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification
+name: ctypes
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- David M. Lary
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2025-02-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dry-struct
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description:
+email:
+- dmlary@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".standard.yml"
+- CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
+- Gemfile
+- LICENSE.txt
+- MAINTAINERS.md
+- README.md
+- Rakefile
+- SECURITY.md
+- ctypes.gemspec
+- lib/ctypes.rb
+- lib/ctypes/array.rb
+- lib/ctypes/bitfield.rb
+- lib/ctypes/bitfield/builder.rb
+- lib/ctypes/bitmap.rb
+- lib/ctypes/enum.rb
+- lib/ctypes/enum/builder.rb
+- lib/ctypes/exporter.rb
+- lib/ctypes/helpers.rb
+- lib/ctypes/importers.rb
+- lib/ctypes/importers/castxml.rb
+- lib/ctypes/importers/castxml/loader.rb
+- lib/ctypes/int.rb
+- lib/ctypes/missing_bytes_error.rb
+- lib/ctypes/pad.rb
+- lib/ctypes/pretty_print_helpers.rb
+- lib/ctypes/string.rb
+- lib/ctypes/struct.rb
+- lib/ctypes/struct/builder.rb
+- lib/ctypes/terminated.rb
+- lib/ctypes/type.rb
+- lib/ctypes/union.rb
+- lib/ctypes/union/builder.rb
+- lib/ctypes/version.rb
+- sig/ctypes.rbs
+homepage: https://github.com/cisco-open/ruby-ctypes
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: Manipulate common C types in Ruby
+test_files: []