jbangert-bindata 1.5.0

data/.gitignore

@@ -0,0 +1 @@
+Gemfile.lock

data/BSDL

@@ -0,0 +1,22 @@
+Copyright (C) 2007-2012 Dion Mendel. All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions
+are met:
+1. Redistributions of source code must retain the above copyright
+notice, this list of conditions and the following disclaimer.
+2. Redistributions in binary form must reproduce the above copyright
+notice, this list of conditions and the following disclaimer in the
+documentation and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+SUCH DAMAGE.

data/COPYING

@@ -0,0 +1,52 @@
+BinData is copyrighted free software by Dion Mendel <dion@lostrealm.com>.
+You can redistribute it and/or modify it under either the terms of the
+2-clause BSDL (see the file BSDL), or the conditions below:
+
+  1. You may make and give away verbatim copies of the source form of the
+     software without restriction, provided that you duplicate all of the
+     original copyright notices and associated disclaimers.
+
+  2. You may modify your copy of the software in any way, provided that
+     you do at least ONE of the following:
+
+       a) place your modifications in the Public Domain or otherwise
+          make them Freely Available, such as by posting said
+	  modifications to Usenet or an equivalent medium, or by allowing
+	  the author to include your modifications in the software.
+
+       b) use the modified software only within your corporation or
+          organization.
+
+       c) give non-standard binaries non-standard names, with
+          instructions on where to get the original software distribution.
+
+       d) make other distribution arrangements with the author.
+
+  3. You may distribute the software in object code or binary form,
+     provided that you do at least ONE of the following:
+
+       a) distribute the binaries and library files of the software,
+	  together with instructions (in the manual page or equivalent)
+	  on where to get the original distribution.
+
+       b) accompany the distribution with the machine-readable source of
+	  the software.
+
+       c) give non-standard binaries non-standard names, with
+          instructions on where to get the original software distribution.
+
+       d) make other distribution arrangements with the author.
+
+  4. You may modify and include the part of the software into any other
+     software (possibly commercial).
+
+  5. The scripts and library files supplied as input to or produced as 
+     output from the software do not automatically fall under the
+     copyright of the software, but belong to whomever generated them, 
+     and may be sold commercially, and may be aggregated with this
+     software.
+
+  6. THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR
+     IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
+     WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+     PURPOSE.

data/ChangeLog.rdoc

@@ -0,0 +1,204 @@
+= BinData Changelog
+
+== Version 1.5.1 (2013-xx-xx)
+
+* Rework build system and include .gemspec.  Requested by Simon Shortman.
+* Fixed bug when Choice#clear didn't clear everything.  Thanks to Simon
+  Shortman for the bug report.
+* Moved BinData::VERSION into its own file.  Thanks to John Van Enk.
+
+== Version 1.5.0 (2013-05-21)
+
+* Moved to github.
+* Updated to Ruby 2.0
+* Arrays now accept BinData object factories for :type (feature request by
+  Matt Dainty).
+* Dynamically generated BinData objects can use the :name parameter to
+  register themselves.
+* Remove functionality that has been deprecated for two years.
+
+== Version 1.4.5 (2012-07-24)
+
+* Added the :pad_front option for padding to occur at the front of a String.
+  (suggested by Eduardo Mourão).
+
+== Version 1.4.4 (2012-06-21)
+
+* Fixed bug where user defined boolean primitive wouldn't set its
+  value to false (reported by Frank Roland).
+* Fixed infinite looping bug caused by nested Choices.
+* Renamed String parameter :pad_char to :pad_byte.
+* Updated manual.
+
+== Version 1.4.3 (2011-10-01)
+
+* Exceptions no longer ignored inside lambdas when reading until eof 
+  in an array (thanks John Labovitz).
+* Fixed interaction bug between choices and records (reported by
+  Refrigerator Johnny).
+
+== Version 1.4.2 (2011-08-06)
+
+* \=~ now works for strings.
+
+== Version 1.4.1 (2011-06-20)
+
+* Added :default option for Choices.
+* Added count_bytes_remaining keyword.
+* Increased speed of lazy evaluation.
+
+== Version 1.4.0 (2011-06-14)
+
+* Record#snapshot now returns fields in order.
+* Removed the need to call #register_self in subclasses.
+* Wrapper is now deprecated.  Use subclassing instead.
+* Updated license to mimic changes to the Ruby License.
+* Refactoring to reduce memory usage.
+
+== Version 1.3.1 (2011-01-25)
+
+* Fixed file permissions problem.
+
+== Version 1.3.0 (2011-01-25)
+
+* BinData objects can now assign values when instantiating.
+* Improved support for bit-based alignment.
+* Updated reference manual.
+* Added examples for declaring recursive structures.
+* Objects deriving from BinData::Base should no longer override #initialize.
+* Added BinData::Base(#new, #initialize_instance) to speed up
+  instantiation of multiple objects.
+* Updated specs to rspec-1.3.0
+* BinData::Struct.hide now expects symbols instead of strings.
+
+== Version 1.2.2 (2010-12-14)
+
+* Added Base.bindata_name method.
+* Removed Base#done_read to reduce memory usage and cpu usage.
+* Derived classes should now use do_read et al, instead of _do_read.
+* Added predefinition of record fields to improve speed.
+* Made compatible with ruby 1.9.2.  Thanks to Andrew Watts.
+
+== Version 1.2.1 (2010-07-20)
+
+* Updated specs to be compatible with ruby 1.9.1
+
+== Version 1.2.0 (2010-07-09)
+
+* Deprecated Base#register. Use #register_self or #register_subclasses instead.
+* Syntax improvement.  Array, Structs and Choices can now use blocks to
+  specify fields.
+* Reduced startup time (suggestion courtesy of Mike Ryan).
+
+== Version 1.1.0 (2009-11-24)
+
+* Allow anonymous fields in Records and Primitives.
+* Add the ability to skip over unused data.
+* Allow Records, Primitives and Wrappers to be derived from.
+* Classes for integers are now defined on demand.
+
+== Version 1.0.0 (2009-09-13)
+
+* Is now compatible with Ruby 1.9
+* Added reference manual.
+* Added #rel_offset to Base.
+* Removed support for deprecated functionality.
+
+== Version 0.11.1 (2009-08-28)
+
+* Allow wrapped types to work with struct's :onlyif parameter
+* Use Array#index instead of #find_index for compatibility with Ruby 1.8.6
+  (patch courtesy of Joe Rozner).
+
+== Version 0.11.0 (2009-06-28)
+
+* Sanitizing code was refactored for speed.
+* Arbitrary sized integers and bit fields are now automatically instantiated.
+* Add ability to wrap existing types and override their parameters.
+
+== Version 0.10.0 (2009-04-17)
+
+* Arbitrary byte sized integers are now supported (e.g. 24bit, 808bit).
+* Renamed String :trim_value parameter to :trim_padding.
+* BinData::Array now behaves more like Ruby's Array.
+* Added debug_name
+* Added ability to trace reading
+* Primitives now behave as their value.  Calling #value is no longer needed.
+* Renamed #to_s -> #to_binary_s to avoid confusion with Ruby's #to_s.
+* Added #assign as the generic way to assign values to objects.
+* Added :copy_on_change parameter to Choice.
+* Implement #offset for all objects.
+* Renamed Single -> BasePrimitive.
+* Renamed SingleValue -> Primitive.
+* Renamed MultiValue -> Record.
+* The :onlyif parameter now only applies to fields inside Structs.
+* LazyEvaluator can now supply arguments when invoking methods
+
+== Version 0.9.3 (2008-12-03)
+
+* Arrays can now :read_until => :eof
+* TCPSocket and UDPSocket can now be used as input streams (patch courtesy
+  of Peter Suschlik).
+* Added 128 bit integers.
+* Significant memory usage reduction.
+* Added custom mandatory and default parameters for user defined MultiValues.
+
+== Version 0.9.2 (2008-07-18)
+
+* Added lazy instantiation to allow recursive definitions.
+* Array elements can be appended at any position.
+* Deprecated the :readwrite parameter.
+* Removed feature where Struct fields names could be nil.
+* Reworked sanitizing system.
+
+== Version 0.9.1 (2008-06-15)
+
+* Implemented bit fields.
+* Added :onlyif parameter to Base for specifying optional fields.
+* Fixed IO offset bug with SingleValues.
+
+== Version 0.9.0 (2008-06-02)
+
+* Added :adjust_offset option to automatically seek to a given offset.
+* Modified #read to accept strings as well as IO streams.
+* Choice now accepts sparse arrays and hashes as :choice.
+* Added BinData::Rest to help with debugging.
+* Major internal restructuring - memory usage is much better.
+* Improved documentation.
+
+== Version 0.8.1 (2008-01-14)
+
+* Reduced memory consumption.
+* Increased execution speed.
+* Deprecated BinData::Base.parameters.
+* Fixed spec syntax (thanks to David Goodlad).
+
+== Version 0.8.0 (2007-10-14)
+
+* Add reserved field names to Struct.
+* Prevent warnings about method redefinition.
+* Allow Struct to masquerade as one of its fields.
+* Renamed String param :initial_length to :read_length.
+* BinData::Array now behaves more like the internal Ruby array.
+
+== Version 0.7.0 (2007-08-26)
+
+* Arrays now support terminating conditions as well as fixed length reads.
+* Updated specs to new rspec syntax (0.9).
+* Added scoped resolution of variables in lambdas.
+* Added ability to append elements to arrays.
+
+== Version 0.6.0 (2007-03-28)
+
+* Added 64 bit integers.
+* Added floating point numbers.
+* Added endian keyword to Struct to reduce the amount of typing needed.
+
+== Version 0.5.1 (2007-03-21)
+
+* Updated documentation.
+* Struct now raises an error if a field name shadows an existing method.
+
+== Version 0.5.0 (2007-03-14)
+
+* Initial public release.

data/Gemfile

@@ -0,0 +1,2 @@
+source "https://rubygems.org"
+gemspec

data/INSTALL

@@ -0,0 +1,11 @@
+This package is designed to be installed with rubygems.  If you don't
+have rubygems installed on your system, the older setup.rb is
+included as a convenience.
+
+  ($ su)
+  # ruby setup.rb
+
+This simple step installs bindata under the default location for Ruby
+libraries.  You can also customize the installation by supplying some
+options to setup.rb.
+Try "ruby setup.rb --help".

data/NEWS.rdoc

@@ -0,0 +1,164 @@
+= 1.5.0
+
+Finally moved the source code to github.
+
+Deprecated functionality has been removed to cleanup the codebase.
+
+= 1.4.4
+
+== Deprecations
+
+The BinData::String parameter :pad_char has been renamed to :pad_byte.  This
+aids readibilty as Ruby 1.9 characters are not necessarily one byte.
+
+= 1.4.0
+
+== Deprecations
+
+There is no longer any need to call #register_self when inheriting from
+BinData::Base.
+
+BinData::Wrapper is deprecated.  You should use direct inheritance instead.
+
+If your code looks like:
+    class Uint8Array < BinData::Wrapper
+      default_parameter :initial_element_value => 0
+  
+      array :initial_length => 2 do
+        uint8 :initial_value => :initial_element_value
+      end
+    end
+
+It should be changed to:
+    class Uint8Array < BinData::Array
+      default_parameter :initial_element_value => 0
+      default_parameter :initial_length => 2
+  
+      uint8 :initial_value => :initial_element_value
+    end
+
+See http://bindata.rubyforge.org/manual.html#extending_existing_types for details.
+
+= 1.3.0
+
+== New features
+
+You can now assign values to BinData objects when instantiating them.
+
+Previously:
+    obj = BinData::Stringz.new(:max_length => 10)
+    obj.assign("abc")
+
+Now:
+    obj = BinData::Stringz.new("abc", :max_length => 10)
+
+== Backwards incompatible changes
+
+This version makes some backwards incompatible changes for more advanced
+users of BinData.
+
+This only affects you if you have created your own custom types by
+subclassing BinData::Base or BinData::BasePrimitive.
+
+All instance variables must now be initialized in #initialize_instance.
+Implementing #initialize is no longer allowed.
+
+Run your existing code in $VERBOSE mode ("ruby -w"), and BinData will
+inform you of any changes you need to make to your code.
+
+If your code previously looked like:
+
+    class MyType < BinData::Base
+      register_self
+
+      def initialize(parameters = {}, parent = nil)
+        super
+
+        @var1 = ...
+        @var2 = ...
+      end
+      ...
+    end
+
+You must change it to look like:
+
+    class MyType < BinData::Base
+      register_self
+
+      def initialize_instance
+        @var1 = ...
+        @var2 = ...
+      end
+      ...
+    end
+
+= 1.0.0
+
+Version 1.0.0 removes all deprecated features.  If you are upgrading from a
+version prior to 0.10.0 you will need to make changes to your code before it
+will work with BinData 1.0.0 or later.
+
+It is recommended to first upgrade to 0.11.1, and run your code with the -w
+command line switch.  This will turn on warning messages that should give you
+hints about which parts of your code need changing.  See the NEWS for 0.10.0
+for details of the deprecated features.
+
+= 0.10.0
+
+There are several new features in this release.  The major ones are:
+
+* Debugging declarations is now easier with the ability to trace values when
+  reading.
+
+      BinData::trace_reading(STDERR) do
+        obj_not_quite_working_correctly.read(io)
+      end
+
+  Will result in a debugging trace written to STDERR.
+
+* Support for arbitrary sized integers and bit fields.
+
+* Struct/Array field/element access now returns a BinData object, rather than
+  the underlying Fixnum or String.  The BinData object will behave like it's
+  underlying primitive so existing code should continue to work.  This allows
+  for an improved syntax in your declarations.
+
+  If your code requires access to the underlying primitive, you can access it
+  with the #value method.
+
+There are several deprecations and one backwards incompatible change in this
+release.  Turn on $VERBOSE mode (-w command line switch) to see warnings
+regarding these deprecations.
+
+== IMPORTANT - Ruby does not warn you about this change!
+
+* The #to_s method for getting the binary string representation of a data
+  object has been renamed to #to_binary_s.  If you use this method you must
+  manually change your code or you will get strange results.
+
+== Deprecations.  Ruby will warn you of these when in $VERBOSE mode.
+
+Code using these deprecated features will still work in this release but will
+fail to work in some future release.  Change your code now.
+
+* BinData::SingleValue has been renamed to BinData::Primitive.
+
+* BinData::MultiValue has been renamed to BinData::Record.
+
+* String :trim_value parameter has been renamed to :trim_padding.
+
+* Registry.instance should be replaced with RegisteredClasses.
+
+* struct.offset_of("field") should be replaced with struct.field.offset.
+
+* struct.clear("field") should be replaced with struct.field.clear.
+
+* struct.clear?("field") should be replaced with struct.field.clear?.
+
+* struct.num_bytes("field") should be replaced with struct.field.num_bytes.
+
+* array.clear(n) should be replaced with array[n].clear.
+
+* array.clear?(n) should be replaced with array[n].clear?.
+
+* array.num_bytes(n) should be replaced with array[n].num_bytes.