nwn-lib 0.4.3 → 0.4.4

data/CHANGELOG

@@ -136,3 +136,14 @@ Bernhard Stoeckner <elven@swordcoast.net> (2):
       NWN::Erf: basic reading/writing library + tar-like binary
       add tlk.rb to nwn/all.rb
       0.4.3-rel
+
+=== 0.4.4
+Bernhard Stoeckner (7):
+      bin/nwn-gff: guess outfile format based on extension
+      erf: do not fail on misaligned strings, print warning instead
+      bin/nwn-erf: compat mode with tar, options can be without dashes
+      API: Add some helpers for creating Gff elements
+      scripting: satisfy: return object as-is when no conditions are given
+      bin/nwn-erf: -vt: move column type before filename
+      erf: fix loctable reading breaking on more than one locstr
+      0.4.4-rel

data/Rakefile

@@ -9,7 +9,7 @@ include FileUtils
 # Configuration
 ##############################################################################
 NAME = "nwn-lib"
-VERS = "0.4.3"
+VERS = "0.4.4"
 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/bin/nwn-erf

@@ -10,6 +10,9 @@ $type = 'ERF'
 $allow_duplicates = false
 $descriptions = {}
 
+# tar-compat mode: first argument is options if no dash is specified.
+ARGV[0] = "-" + ARGV[0] if ARGV.size > 0 && ARGV[0][0] != ?-
+
 begin OptionParser.new do |o|
   o.banner = "Usage: nwn-erf <options> [FILEs] ..."
 
@@ -80,7 +83,6 @@ begin OptionParser.new do |o|
 end.parse!
 rescue => ee
   $stderr.puts ee.to_s
-  $stderr.puts ee.backtrace.join("\n")
   exit 1
 end
 
@@ -105,15 +107,15 @@ case $action
   when :t
     input {|f|
       erf = NWN::Erf::Erf.new(f)
-      $stderr.puts "# %-4s %14s %16s %-10s %s" % %w{type offset size date filename} if $verbose
+      $stderr.puts "# %14s %16s %-10s %-4s %s" % %w{offset size date type filename} if $verbose
       erf.content.each {|c|
         if !$verbose
           $stderr.puts "%s" % [c.filename]
         else
-          $stderr.puts "%4d %16d %16d %10s %s" % [
-            c.res_type, c.offset, c.size,
+          $stderr.puts "%16d %16d %10s %4d %s" % [
+            c.offset, c.size,
             Date.ordinal(1900 + erf.year, erf.day_of_year).strftime("%Y-%m-%d"),
-            c.filename
+            c.res_type, c.filename
           ]
         end
       }

data/bin/nwn-gff

@@ -36,7 +36,7 @@ begin OptionParser.new do |o|
   end
   o.on "-k", "--outfile-format FORMAT", [:in, :none] + NWN::Gff::FileFormats,
       "Output format (#{([:none, :in] + NWN::Gff::FileFormats).join(', ')})",
-      "(default: in - same as input)" do |f|
+      "(default: in when stdout, try to guess based on extension otherwise)" do |f|
     $options[:outformat] = f
   end
 
@@ -107,7 +107,13 @@ if :auto == $options[:informat]
     $options[:informat]
 end
 
-$options[:outformat] = $options[:informat] if :in == $options[:outformat]
+if $options[:outfile] == "-"
+  $options[:outformat] = $options[:informat] if :in == $options[:outformat]
+elsif :in == $options[:outformat]
+  $options[:outformat] = NWN::Gff.guess_file_format($options[:outfile])
+  fail "Cannot guess outfile format from filename, specify with -k." unless
+    $options[:outformat]
+end
 
 vputs "Reading: #{$options[:infile]}"
 data_in = $options[:infile] == '-' ? $stdin.read : IO.read($options[:infile])

data/lib/nwn/erf.rb

@@ -235,14 +235,16 @@ module NWN
         raise IOError, "Cannot read locstr list" unless
           locstr.size == locstr_size
 
-        locstrs = locstr.unpack("V V/a*" * locstr_count)
-        locstrs.each_slice(3) {|lid, strsz, str|
-          raise IOError,
-            "Cannot read localized strings table: string size not met (want: #{strsz}, got #{str.size})" if
-              str.size != strsz
+        for lstr in 0...locstr_count do
+          lid, strsz = locstr.unpack("V V")
+          str = locstr.unpack("a#{strsz}")[0]
+          $stderr.puts "Expected string size does not match actual string size (want: #{strsz}, got #{str.size} of #{str.inspect})" if
+            strsz != str.size
           @localized_strings[lid] = str
-        }
-
+          locstr = locstr[8 + str.size .. -1]
+          raise IOError, "locstr table does not contain enough entries (want: #{locstr_count}, got: #{lstr + 1})" if locstr.nil? &&
+            lstr + 1 < locstr_count
+        end
 
         keylist_entry_size = @filename_length + 4 + 2 + 2
         keylist = @io.read(keylist_entry_size * entry_count)

data/lib/nwn/gff/field.rb

@@ -16,6 +16,14 @@ module NWN::Gff::Field
   # This is set internally by Gff::Reader on load.
   attr_accessor :parent
 
+  # Create a new NWN::Gff::Field
+  def self.new label, type, value
+    s = {}.extend(self)
+    s['label'], s['type'], s['value'] = label, type, value
+    s.extend_meta_classes
+    s
+  end
+
   def field_type
     self['type']
   end

data/lib/nwn/gff/list.rb

@@ -1,2 +1,53 @@
 module NWN::Gff::List
+
+  # Add a new struct member to this list.
+  # You can either add an existing struct to this list
+  # (which will reparent it by setting .element), or specify
+  # a new struct with a block, or both:
+  #
+  #   root = Gff::Struct.new 0xffffffff, "UTI", "V3.2"
+  #   list = root.add_list 'test', []
+  #   list.add_struct 1 do |l|
+  #     l.add_byte 'inner_test', 5
+  #     l.add_cexolocstr 'exolocstr', { 0 => 'Hello', 4 => 'Hallo' }
+  #   end
+  #   y root
+  #
+  # results in:
+  #   --- !nwn-lib.elv.es,2008-12/struct
+  #   __data_type: UTI
+  #   __struct_id: 4294967295
+  #   test:
+  #   type: :list
+  #     value:
+  #     - !nwn-lib.elv.es,2008-12/struct
+  #       __data_type: UTI/test
+  #       __struct_id: 1
+  #       exolocstr:
+  #         type: :cexolocstr
+  #         value:
+  #           0: Hello
+  #           4: Hallo
+  #       inner_test: {type: :byte, value: 5}}
+  def add_struct struct_id_or_struct = 0, &block
+    struct = case struct_id_or_struct
+      when Integer
+        s = NWN::Gff::Struct.new
+        s.struct_id = struct_id_or_struct
+        s
+
+      when NWN::Gff::Struct
+        struct_id_or_struct
+
+      else
+        raise ArgumentError, "specify either a struct_id or an existing struct"
+    end
+
+    struct.element = self
+
+    yield(struct) if block_given?
+
+    self.v << struct
+    struct
+  end
 end

data/lib/nwn/gff/struct.rb

@@ -18,17 +18,68 @@ module NWN::Gff::Struct
   # The field this struct is value of.
   # It is most likely a Field of :list, or
   # :nil if it is the root struct.
-  attr_accessor :element
+  # Setting this to a value detaches this struct from
+  # the old parent (though the old parent Field may still
+  # point to this object).
+  attr_reader :element
 
   # Returns the path to this struct (which is usually __data_type)
   def path
     @data_type.to_s
   end
 
+  def element= e #:nodoc:
+    @element = e
+    @data_type = self.element.parent.path + "/" + self.element.l
+  end
+
   # Dump this struct as GFF binary data.
   #
   # Optionally specify data_type and data_version
   def to_gff data_type = nil
     NWN::Gff::Writer.dump(self, data_type)
   end
+
+  # Create a new struct.
+  # Usually, you can leave out data_type and data_version for non-root structs,
+  # because that will be guess-inherited based on the existing associations.
+  def self.new struct_id = 0xffffffff, data_type = nil, data_version = nil
+    s = {}.extend(self)
+    s.struct_id = struct_id
+    s.data_type = data_type
+    s.data_version = data_version
+    s
+  end
+
+  # Create a new field.
+  # Alternatively, you can use the shorthand methods:
+  #   add_#{type} - add_int, add_byte, ..
+  # For example:
+  #  some_struct.add_field 'ID', :byte, 5
+  # is equivalent to:
+  #  some_struct.add_byte 'ID', 5
+  def add_field label, type, value, &block
+    self[label] = NWN::Gff::Field.new(label, type, value)
+    self[label].parent = self
+    if block_given?
+      yield(self[label])
+    end
+    self[label]
+  end
+
+  #:nodoc:
+  def method_missing meth, *av, &block
+    if meth.to_s =~ /^add_(.+)$/
+      if NWN::Gff::Types.index($1.to_sym)
+        av.size == 2 or super
+        t = $1.to_sym
+        f = add_field(av[0], t, av[1], &block)
+        return f
+      else
+        super
+      end
+    end
+
+    super
+  end
 end

data/lib/nwn/scripting.rb

@@ -76,6 +76,9 @@ module NWN::Gff::Scripting
   #
   # Returns the object that satisfies the asked-for conditions,
   # or nil if none can be given.
+  #
+  # If only a filename/string is given and no further arguments,
+  # the read object will be returned as-is.
   def satisfy *what
     if $standalone
       fn = what.shift
@@ -95,6 +98,8 @@ module NWN::Gff::Scripting
       obj = self
     end
 
+    return obj if what.size == 1
+
     what.each {|w|
       case w
         when Class, Module
@@ -108,7 +113,6 @@ module NWN::Gff::Scripting
               return obj if obj.field_type.to_sdowncase == w.to_s.downcase
           end
       end
-
     }
 
     return nil

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: nwn-lib
 version: !ruby/object:Gem::Version 
-  version: 0.4.3
+  version: 0.4.4
 platform: ruby
 authors: 
 - Bernhard Stoeckner
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-02-06 00:00:00 +01:00
+date: 2009-03-09 00:00:00 +01:00
 default_executable: 
 dependencies: []