snow-data 1.0.0

data/lib/snow-data/memory.rb

@@ -0,0 +1,92 @@
+# This file is part of ruby-snowdata.
+# Copyright (c) 2013 Noel Raymond Cower. All rights reserved.
+# See COPYING for license details.
+
+require 'snow-data/snowdata_bindings'
+
+module Snow ; end
+
+
+#
+# A class for representing blocks of memory. You can either allocate memory
+# using ::malloc or wrap existing blocks of memory using ::new or ::wrap (or
+# ::__wrap__ if a subclass has extended ::wrap and ::new).
+#
+# If wrapping an existing block of memory, note that the Memory object does not
+# take ownership of the block. As such, freeing it is the responsibility of its
+# allocator. Only a block allocated by ::malloc will be freed by a Memory
+# object, either by calling #free! or when the GC collects the object.
+#
+# When subclassing Memory, which is fine to do, you'll likely want to override
+# Memory::new and possibly Memory::wrap. It is also possible to override
+# Memory::malloc, but it's recommended you never do this. If you do, keep in
+# mind that __malloc__ exists as an alias of malloc and you must never try to
+# override it, as this could result in very strange behavior. Similarly, new is
+# aliased as both wrap and __wrap__, the latter of which you should must never
+# override either. Again, it may result in undesirable behavior, crashes, and
+# angry responses to any issues you create on GitHub as a result.
+#
+class Snow::Memory
+
+  class <<self
+    alias_method :wrap, :new
+    alias_method :__wrap__, :new
+    alias_method :[], :malloc
+    alias_method :__malloc__, :malloc
+  end
+
+
+  #
+  # The size in bytes of a memory block.
+  #
+  def bytesize
+    @__bytesize__
+  end
+
+
+  #
+  # The alignment in bytes of a memory block.
+  #
+  def alignment
+    @__alignment__
+  end
+
+
+  #
+  # Returns whether the memory block is pointing to a null address.
+  #
+  def null?
+    self.address == 0
+  end
+
+
+  #
+  # Returns whether this and another block are equal in terms of their
+  # properties -- that is, whether they have the address and bytesize. If true,
+  # the objects refer to teh same block of memory. If false, they might still
+  # overlap, refer to different chunks of memory, one might be null, etc.
+  #
+  def ==(other)
+    self.address == other.address && self.bytesize == other.bytesize
+  end
+
+
+  #
+  # Returns a string showing the memory block's classname, object ID, address,
+  # size, and alignment.
+  #
+  def inspect
+    "<#{self.class}:0x#{__id__.to_s(16).rjust(14, ?0)} *0x#{self.address.to_s(16).rjust(14, ?0)}:#{self.bytesize}:#{self.alignment}>"
+  end
+
+
+  #
+  # Creates a new block of memory with the same class, size, and alignment;
+  # copies the receiver's data to the new block; and returns the new block.
+  #
+  def dup
+    new_self = self.class.__malloc__(self.bytesize, self.alignment)
+    new_self.copy!(self, 0, 0, self.bytesize)
+  end
+
+end

data/lib/snow-data/version.rb

@@ -0,0 +1,12 @@
+# This file is part of ruby-snowdata.
+# Copyright (c) 2013 Noel Raymond Cower. All rights reserved.
+# See COPYING for license details.
+
+module Snow
+
+  #
+  # The snow-data version string.
+  #
+  SNOW_DATA_VERSION = '1.0.0'.freeze
+
+end

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification
+name: snow-data
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Noel Raymond Cower
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-17 00:00:00.000000000 Z
+dependencies: []
+description: |
+  Snow-Data is a gem for allocating memory and working with existing blocks of
+  memory in a moderately safe but still technically really, really unsafe way. It
+  also provides functionality for defining C-struct classes, including those with
+  other structs as members.
+email: ncower@gmail.com
+executables: []
+extensions:
+- ext/extconf.rb
+extra_rdoc_files:
+- ext/snow-data/snow-data.c
+- README.md
+- COPYING
+files:
+- lib/snow-data/c_struct.rb
+- lib/snow-data/memory.rb
+- lib/snow-data/version.rb
+- lib/snow-data.rb
+- ext/snow-data/snow-data.c
+- ext/extconf.rb
+- COPYING
+- README.md
+homepage: https://github.com/nilium/ruby-snowdata
+licenses:
+- Simplified BSD
+metadata: {}
+post_install_message: 
+rdoc_options:
+- --title
+- snow-data -- C Data Types
+- --main
+- README.md
+- --markup=markdown
+- --line-numbers
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.5
+signing_key: 
+specification_version: 4
+summary: 'Snow-Data: for working with memory like you''ve got nothing to lose.'
+test_files: []
+has_rdoc: true