nwn-lib 0.4.7 → 0.4.8

data/CHANGELOG

@@ -204,6 +204,7 @@ Bernhard Stoeckner <elven@swordcoast.net> (26):
 
       Please browse the commit log for a full list of changes.
 
+=== 0.4.7
 Bernhard Stoeckner <elven@swordcoast.net> (25):
       bin/*: do not require rubygems explicitly
       remove obsolete Gff::Helpers module
@@ -238,3 +239,15 @@ Bernhard Stoeckner <elven@swordcoast.net> (25):
       putting wrong offsets for files created with nwn-erf.
 
       Please browse the commit log for a full list of changes.
+
+=== 0.4.8
+Bernhard Stoeckner <elven@swordcoast.net> (6):
+      IO: add special e_read call to wrap size checks with custom exception msgs
+      NWN.setting: generic setting get/set mechanism
+      NWN.log_debug: messages always print unless explicitly turned off
+      Field :resref validate: warn when too long and not explicitly turned off
+      nwn-gff: fix reading from stdin throwing an exception
+      0.4.8-rel
+
+      Another bugfix and compatibility release. This adds real NWN2 support
+      to gff reading, adds a few new SETTINGS, and adds proper IO reading.

data/Rakefile

@@ -9,7 +9,7 @@ include FileUtils
 # Configuration
 ##############################################################################
 NAME = "nwn-lib"
-VERS = "0.4.7"
+VERS = "0.4.8"
 CLEAN.include ["**/.*.sw?", "pkg", ".config", "rdoc", "coverage"]
 RDOC_OPTS = ["--quiet", "--line-numbers", "--inline-source", '--title', \
   'nwn-lib: a ruby library for accessing NWN resource files', \

data/SETTINGS

@@ -4,9 +4,33 @@ There are various environment variables you can configure to adjust various part
 
 Under linux, just add them to your shell environment (usually .bashrc), like so:
 
-  export NWN_LIB_FILTER_EMPTY_EXOLOCSTR=1
+  export NWN_LIB_DEBUG=0
 
 
+== NWN_LIB_DEBUG
+
+nwn-lib prints, by default, various informational and warning messages to stderr.
+This is a non-optimal solution, but needed to indicate various problems or misshapes with
+resource files you are working with.
+
+If you want to suppress them for some reason, set NWN_LIB_DEBUG to "0" or "off". Any
+other value will indicate that you want to see the messages.
+
+== NWN_LIB_RESREF16
+
+Set this to "1" if you are sure that you are only working with NWN1 files. This will
+make nwn-lib fail hard (Exception) on invalid resref lengths, and might save you some
+time tracking things down.
+
+Note that nwn-lib takes a parameter that can force a specific NWN version.
+
+=== NWN_LIB_RESREF32
+
+Set this to "1" if you are working with NWN2 files and do not want to see the warnings
+generated by too long resref values.
+
+Note that nwn-lib takes a parameter that can force a specific NWN version.
+
 == NWN_LIB_2DA_LOCATION
 
 Set to a path containing all 2da files to initialize the 2da cache. This is needed for

data/bin/nwn-gff

@@ -49,6 +49,15 @@ begin OptionParser.new do |o|
     $options[:backup] = b.nil? ? true : b
   end
 
+  o.on "-1", "--nwn1", "Allow 16 byte resrefs." do
+    ENV['NWN_LIB_RESREF32'] = nil
+    ENV['NWN_LIB_RESREF16'] = "1"
+  end
+  o.on "-2", "--nwn2", "Allow 32 byte resrefs. This is needed for NWN2 files." do
+    ENV['NWN_LIB_RESREF32'] = "1"
+    ENV['NWN_LIB_RESREF16'] = nil
+  end
+
   o.on "--force", "Force write even when the resulting data would be the same" do
     $options[:force] = true
   end
@@ -116,7 +125,7 @@ elsif :in == $options[:outformat]
 end
 
 vputs "Reading: #{$options[:infile]}"
-data_in = $options[:infile] == '-' ? $stdin.read : File.open($options[:infile], "rb")
+data_in = $options[:infile] == '-' ? $stdin : File.open($options[:infile], "rb")
 data_in = NWN::Gff.read(data_in, $options[:informat])
 
 # verify that we read a GFF struct

data/lib/nwn/all.rb

@@ -1,3 +1,5 @@
+require 'stringio'
+require 'nwn/io'
 require 'nwn/twoda'
 require 'nwn/res'
 require 'nwn/gff'

data/lib/nwn/erf.rb

@@ -57,17 +57,13 @@ module NWN
 
 
       def read_from io
-        header = @io.read(160)
-        raise IOError, "Cannot read header: Not a erf file?" unless
-          header && header.size == 160
-
         @file_type, @file_version,
         locstr_count, locstr_size,
         entry_count,
         offset_to_locstr, offset_to_keys,
         offset_to_res,
-        @year, @day_of_year, @description_str_ref = header.
-          unpack("A4 A4 VV VV VV VV V a116")
+        @year, @day_of_year, @description_str_ref =
+          @io.read(160, "header").unpack("A4 A4 VV VV VV VV V a116")
 
         raise IOError, "Cannot read erf stream: invalid type #{@file_type.inspect}" unless
           NWN::Erf::ValidTypes.index(@file_type)
@@ -75,7 +71,7 @@ module NWN
         fnlen = filename_length @file_version
 
         @io.seek(offset_to_locstr)
-        locstr = @io.read(locstr_size)
+        locstr = @io.e_read(locstr_size, "locstr_size")
 
         for lstr in 0...locstr_count do
           if locstr.nil? || locstr.size == 0
@@ -107,8 +103,7 @@ module NWN
 
         keylist_entry_size = fnlen + 4 + 2 + 2
         @io.seek(offset_to_keys)
-        keylist = @io.read(keylist_entry_size * entry_count)
-        raise IOError, "keylist too short" if keylist.size != keylist_entry_size * entry_count
+        keylist = @io.e_read(keylist_entry_size * entry_count, "keylist")
         keylist = keylist.unpack("A#{fnlen} V v v" * entry_count)
         keylist.each_slice(4) {|resref, res_id, res_type, unused|
           @content << NWN::Resources::ContentObject.new(resref, res_type, @io)
@@ -116,8 +111,7 @@ module NWN
 
         resourcelist_entry_size = 4 + 4
         @io.seek(offset_to_res)
-        resourcelist = @io.read(resourcelist_entry_size * entry_count)
-        raise IOError, "resource list too short" if resourcelist.size != resourcelist_entry_size * entry_count
+        resourcelist = @io.e_read(resourcelist_entry_size * entry_count, "reslist")
         resourcelist = resourcelist.unpack("I I" * entry_count)
         _index = -1
         resourcelist.each_slice(2) {|offset, size|

data/lib/nwn/gff/field.rb

@@ -126,7 +126,16 @@ module NWN::Gff::Field
         value.is_a?(Float)
 
       when :resref
-        value.is_a?(String) && (0..16).member?(value.size)
+        if !NWN.setting(:resref32) && value.is_a?(String) && value.size > 16
+          NWN.log_debug("Warning: :resref too long for NWN1, set env NWN_LIB_RESREF32=1 to turn off warning for NWN2.")
+          NWN.log_debug("  Value found: #{value.inspect}")
+        end
+
+        if NWN.setting(:resref16)
+          value.is_a?(String) && (0..16).member?(value.size)
+        else
+          value.is_a?(String) && (0..32).member?(value.size)
+        end
 
       when :cexostr
         value.is_a?(String)

data/lib/nwn/gff/reader.rb

@@ -20,10 +20,6 @@ class NWN::Gff::Reader
   private
 
   def read_all
-    header = @io.read(160)
-    raise IOError, "Cannot read header" unless header &&
-      header.size == 160
-
     type, version,
     struct_offset, struct_count,
     field_offset, field_count,
@@ -31,7 +27,7 @@ class NWN::Gff::Reader
     field_data_offset, field_data_count,
     field_indices_offset, field_indices_count,
     list_indices_offset, list_indices_count =
-      header.unpack("a4a4 VV VV VV VV VV VV")
+      @io.e_read(160, "header").unpack("a4a4 VV VV VV VV VV VV")
 
     raise GffError, "Unknown version #{version}; not a gff?" unless
       version == "V3.2"
@@ -44,32 +40,26 @@ class NWN::Gff::Reader
     label_len  = label_count * 16
 
     @io.seek(struct_offset)
-    @structs = @io.read(struct_len)
-    raise IOError, "cannot read structs" unless @structs && @structs.size == struct_len
+    @structs = @io.e_read(struct_len, "structs")
     @structs = @structs.unpack("V*")
 
     @io.seek(field_offset)
-    @fields  = @io.read(field_len)
-    raise IOError, "cannot read fields" unless @fields && @fields.size == field_len
+    @fields  = @io.e_read(field_len, "fields")
     @fields  = @fields.unpack("V*")
 
     @io.seek(label_offset)
-    @labels  = @io.read(label_len)
-    raise IOError, "cannot read labels" unless @labels && @labels.size == label_len
+    @labels  = @io.e_read(label_len, "labels")
     @labels = @labels.unpack("A16" * label_count)
 
     @io.seek(field_data_offset)
-    @field_data = @io.read(field_data_count)
-    raise IOError, "cannot read field_data" unless @field_data && @field_data.size == field_data_count
+    @field_data = @io.e_read(field_data_count, "field_data")
 
     @io.seek(field_indices_offset)
-    @field_indices = @io.read(field_indices_count)
-    raise IOError, "cannot read field_indices" unless @field_indices && @field_indices.size == field_indices_count
+    @field_indices = @io.e_read(field_indices_count, "field_indices")
     @field_indices = @field_indices.unpack("V*")
 
     @io.seek(list_indices_offset)
-    @list_indices = @io.read(list_indices_count)
-    raise IOError, "cannot read list_indices" unless @list_indices && @list_indices.size == list_indices_count
+    @list_indices = @io.e_read(list_indices_count, "list_indices")
     @list_indices = @list_indices.unpack("V*")
 
     @root_struct = read_struct 0, type.strip, version

data/lib/nwn/io.rb

@@ -0,0 +1,35 @@
+# This is a loose adaption of readbytes.rb, but with more flexibility and
+# StringIO support.
+
+# MissingDataError is raised when IO#readbytes fails to read enough data.
+class MissingDataError < IOError
+  def initialize(mesg, data) # :nodoc:
+    @data = data
+    super(mesg)
+  end
+
+  # The read portion of an IO#e_read attempt.
+  attr_reader :data
+end
+
+
+[IO, StringIO].each {|klass|
+  klass.class_eval do
+    # Reads exactly +n+ bytes.
+    #
+    # If the data read is nil an EOFError is raised.
+    #
+    # If the data read is too short a MissingDataError is raised and the read
+    # data is obtainable via its #data method.
+    def e_read(n, mesg = nil)
+      str = read(n)
+      if str == nil
+        raise EOFError, "End of file reached"
+      end
+      if str.size < n
+        raise MissingDataError.new("data truncated" + (mesg ? ": " + mesg : nil), str)
+      end
+      str
+    end
+  end
+}

data/lib/nwn/res.rb

@@ -42,11 +42,7 @@ module NWN
       def get
         if @io.respond_to?(:read)
           @io.seek(@offset ? @offset : 0)
-          d = @io.read(self.size)
-          raise IOError,
-            "not enough data available while reading #{self.filename}" if
-              d.size != self.size
-          d
+          @io.e_read(self.size, "filename = #{filename}")
         else
           IO.read(@io)
         end

data/lib/nwn/settings.rb

@@ -1,15 +1,37 @@
 module NWN
 
-  # This writes a debug message to stderr if the environment
-  # variable +NWN_LIB_DEBUG+ is set to non-nil or $DEBUG is
-  # true (ruby -d).
+  # This writes a internal warnings and debug messages to stderr.
+  #
+  # Leaving this on is recommended, since it usually points to
+  # (fixable) errors in your resource files. You can turn this off
+  # anyways by setting the environment variable +NWN_LIB_DEBUG+
+  # to "0" or "off".
+  #
+  # Will return true when printed, false otherwise.
   def self.log_debug msg
-    return false unless ENV['NWN_LIB_DEBUG'] || $DEBUG
-    $stderr.puts "(nwn-lib debug) %s: %s" % [caller[0].to_s, msg]
+    # Do not print debug messages if explicitly turned off
+    return false if [false, "off"].index(setting(:debug))
+
+    pa = caller[0].to_s
+    pa = pa[(pa.size - 36) .. -1] if pa.size > 36
+    $stderr.puts "(nwn-lib) %s: %s" % [pa, msg]
     true
   end
-end
 
-if ENV['NWN_LIB_2DA_LOCATION'] && ENV['NWN_LIB_2DA_LOCATION'] != ""
-  NWN::TwoDA::Cache.setup ENV['NWN_LIB_2DA_LOCATION']
+  # Get or set a ENV var setting.
+  # Returns false for "0" values.
+  # Returns the old value for new assignments.
+  def self.setting sym, value = :_invalid_
+    name = "NWN_LIB_#{sym.to_s.upcase}"
+    if value != :_invalid_
+      ret = ENV[name] == "0" ? false : ENV[name]
+      ENV[name] = value.to_s if value != :_invalid_
+      ret
+    else
+      ENV[name] == "0" ? false : ENV[name]
+    end
+  end
 end
+
+NWN::TwoDA::Cache.setup NWN.setting("2da_location") if
+  NWN.setting("2da_location")

data/lib/nwn/tlk.rb

@@ -35,7 +35,7 @@ module NWN
         # Read the header
         @file_type, @file_version, language_id,
           string_count, string_entries_offset =
-            @io.read(HEADER_SIZE).unpack("A4 A4 I I I")
+            @io.e_read(HEADER_SIZE, "header").unpack("A4 A4 I I I")
 
         raise IOError, "The given IO does not describe a valid tlk table" unless
           @file_type == "TLK" && @file_version == "V3.0"
@@ -62,18 +62,14 @@ module NWN
         raise ArgumentError, "No such string ID: #{id.inspect}" if id > self.highest_id || id < 0
         seek_to = HEADER_SIZE + (id) * DATA_ELEMENT_SIZE
         @io.seek(seek_to)
-        data = @io.read(DATA_ELEMENT_SIZE)
-
-        raise IOError, "Cannot read TLK file, missing string header data." if !data || data.size != 40
+        data = @io.e_read(DATA_ELEMENT_SIZE, "tlk entry = #{id}")
 
         flags, sound_resref, v_variance, p_variance, offset,
           size, sound_length = data.unpack("I A16 I I I I f")
         flags = flags.to_i
 
         @io.seek(@entries_offset + offset)
-        text = @io.read(size)
-
-        raise IOError, "Cannot read TLK file, missing string text data." if !text || text.size != size
+        text = @io.e_read(size, "tlk entry = #{id}, offset = #{@entries_offset + offset}")
 
         text = flags & 0x1 > 0 ? text : ""
         sound = flags & 0x2 > 0 ? sound_resref : ""

data/lib/nwn/twoda.rb

@@ -285,8 +285,8 @@ module NWN
         # Append an empty newline.
         ret << ""
 
-        ret.join(case ENV['NWN_LIB_2DA_NEWLINE']
-          when "0"
+        ret.join(case NWN.setting("2da_newline")
+          when "0", false
             "\r\n"
           when "1"
             "\n"

data/spec/erf_spec.rb

@@ -41,13 +41,17 @@ describe "Erf::Erf", :shared => true do
   end
 
   it "reads ERF with locstr_size = 0 and locstr_count > 0" do
+    old_debug = NWN.setting(:debug, "0")
     @erf[12,4] = [0].pack("V")
     wellformed_verify @erf, false
+    NWN.setting(:debug, old_debug)
   end
 
   it "reads ERF with locstr_size > 0 and locstr_count = 0" do
+    old_debug = NWN.setting(:debug, "0")
     @erf[8,4] = [0].pack("V")
     wellformed_verify @erf, false
+    NWN.setting(:debug, old_debug)
   end
 end
 

data/spec/field_spec.rb

@@ -13,9 +13,11 @@ describe "Gff::Field" do
     end
 
     it "rejects bad values for type '#{t.inspect}'" do
+      NWN.setting(:resref16, "1")
       invalid.each do |v|
         Gff::Field.valid_for?(v, t).should == false
       end
+      NWN.setting(:resref16, nil)
     end
   end
 end

data/spec/gff_spec.rb

@@ -58,8 +58,9 @@ describe "Gff::*" do
   end
 
   it "fails on not enough data" do
-    proc {wellformed_verify WELLFORMED_GFF[0 .. -2] }.should
-      raise_error IOError, "cannot read list_indices"
+    proc {
+      wellformed_verify WELLFORMED_GFF[0 .. -2]
+    }.should raise_error IOError
   end
 
 end

data/spec/twoda_spec.rb

@@ -1,6 +1,12 @@
 require File.join(File.dirname(__FILE__), 'spec_helper')
 
 describe TwoDA::Table do
+  before do
+    NWN.setting(:debug, "0")
+  end
+  after do
+    NWN.setting(:debug, nil)
+  end
 
   it "parses wellformed files" do
     proc { subject.parse(TWODA_WELLFORMED) }.should_not raise_error ArgumentError

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: nwn-lib
 version: !ruby/object:Gem::Version 
-  version: 0.4.7
+  version: 0.4.8
 platform: ruby
 authors: 
 - Bernhard Stoeckner
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-05-26 00:00:00 +02:00
+date: 2009-06-30 00:00:00 +02:00
 default_executable: 
 dependencies: []
 
@@ -35,57 +35,58 @@ files:
 - CHANGELOG
 - README
 - Rakefile
-- bin/nwn-dsl
 - bin/nwn-gff
-- bin/nwn-irb
+- bin/nwn-dsl
 - bin/nwn-erf
-- spec/wellformed_gff.bic
+- bin/nwn-irb
+- spec/bin_dsl_spec.rb
 - spec/gff_spec.rb
-- spec/res_spec.rb
-- spec/spec.opts
-- spec/erf_spec.rb
+- spec/bin_gff_spec.rb
+- spec/bin_erf_spec.rb
 - spec/field_spec.rb
 - spec/cexolocstr_spec.rb
+- spec/erf_spec.rb
 - spec/struct_spec.rb
-- spec/spec_helper.rb
+- spec/spec.opts
+- spec/res_spec.rb
 - spec/tlk_spec.rb
-- spec/bin_dsl_spec.rb
-- spec/bin_gff_spec.rb
 - spec/rcov.opts
-- spec/bin_erf_spec.rb
 - spec/twoda_spec.rb
-- lib/nwn
-- lib/nwn/scripting.rb
-- lib/nwn/yaml.rb
-- lib/nwn/twoda.rb
+- spec/spec_helper.rb
+- spec/wellformed_gff.bic
 - lib/nwn/erf.rb
+- lib/nwn/io.rb
 - lib/nwn/settings.rb
-- lib/nwn/gff.rb
-- lib/nwn/tlk.rb
+- lib/nwn/yaml.rb
+- lib/nwn/all.rb
 - lib/nwn/res.rb
+- lib/nwn/twoda.rb
+- lib/nwn/tlk.rb
+- lib/nwn/gff.rb
 - lib/nwn/kivinen.rb
-- lib/nwn/all.rb
-- lib/nwn/gff
-- lib/nwn/gff/field.rb
-- lib/nwn/gff/reader.rb
-- lib/nwn/gff/cexolocstr.rb
+- lib/nwn/scripting.rb
+- lib/nwn/gff/api.rb
+- lib/nwn/gff/writer.rb
 - lib/nwn/gff/struct.rb
 - lib/nwn/gff/list.rb
-- lib/nwn/gff/writer.rb
-- lib/nwn/gff/api.rb
+- lib/nwn/gff/reader.rb
+- lib/nwn/gff/cexolocstr.rb
+- lib/nwn/gff/field.rb
 - tools/verify.sh
 - tools/migrate_03x_to_04x.sh
 - scripts/truncate_floats.rb
-- scripts/reformat_2da
 - scripts/clean_locstrs.rb
-- scripts/extract_all_items.rb
 - scripts/debug_check_objid.rb
+- scripts/extract_all_items.rb
+- scripts/reformat_2da
 - BINARIES
 - SCRIPTING
 - SETTINGS
 - CHEATSHEET
 has_rdoc: true
 homepage: http://nwn-lib.elv.es
+licenses: []
+
 post_install_message: 
 rdoc_options: 
 - --quiet
@@ -114,9 +115,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: nwn-lib
-rubygems_version: 1.3.0
+rubygems_version: 1.3.4
 signing_key: 
-specification_version: 2
+specification_version: 3
 summary: a ruby library for accessing Neverwinter Nights resource files
 test_files: []