nwn-lib 0.3.4 → 0.3.5

data/BINARIES

@@ -1,28 +1,38 @@
 == nwn-gff-print
 
- Usage: nwn-gff-print [options] file/- [path]
-    -y, --yaml                       Dump as yaml
-    -k, --kivinen                    Dump as kivinens dump format (like the perl tools)
-    -f, --kivinen-full-path          Print the full path (implies -k)
-    -m, --marshal                    Native ruby marshalling. Warning: raw bytes
-    -t, --types                      Dump types as well (only applies to -k, for now)
-        --type filetype              Override the file type (implies --struct 0xffffffff)
-        --struct id                  Override struct id (as hex, please)
-
-This prints out the given file (or stdin, if -) as the specified format (-k, -f, -y, -m).
+ Usage: nwn-gff-print [options] file/- [file, file, ..]
+     -y, --yaml                       Dump as yaml
+     -k, --kivinen                    Dump as kivinens dump format (like the perl tools)
+         --kivinen-full-path          Print the full path (implies -k)
+     -b, --print-basename             Prefix the file basename to the output
+     -f, --print-filename             Prefix the full filename to the output
+     -t, --print-types                Print types as well
+     -m, --marshal                    Native ruby marshalling. Warning: raw bytes
+         --postfix P                  Write output to file postfixed with P instead of stdout
+         --float_rounding F           Round floating point numbers to the specified number of righthand digits
+         --type filetype              Override the file type (implies --struct 0xffffffff)
+         --struct id                  Override struct id (as hex, please)
+     -p, --path path                  Only print the given path
+     -v, --verbose                    Be verbose
+
+This prints out the given file(s) (or stdin, if -) as the specified format (-y, -k, -m)
 [-k] is the same as gffprint.pl
-[-f] is the same as gffprint.pl -t
-[-m] is the native ruby marshal format (_Marshal.dump(obj)_)
+[-kt] is the same as gffprint.pl -t
+[-m] is the native ruby marshal format (see Marshal.dump(obj))
 [-y] is standard YAML
+[--postfix] will write out each processed file to the same directory as the infile, with the given postfix appended
+[--float_rounding] can be used to truncate FPs to the given precision.
+[-p] will print out a given path within the GFF data (for example <tt>/ItemList[2]</tt>)
 
 == nwn-gff-import
 
- Usage: nwn-gff-import [options] file/- outfile/-
-    -y, --yaml                       Import as yaml
-    -m, --marshal                    Import as native ruby marshal data
+ Usage: nwn-gff-import [options] file/- [file, file, file]
+     -y, --yaml                       Import as yaml
+     -m, --marshal                    Import as native ruby marshal data
+     -o, --outfile F                  Write to outfile instead of stdout
+         --postfix P                  Strip the given postfix from file and write to that instead of stdout (overrides -o)
 
-This is the equivalent to gffencode.pl, and takes all output formats that nwn-gff-print
-provides. This can be used to transform marshalled gff data back into gff binary data.
+This is the equivalent to gffencode.pl. This can be used to transform marshalled gff data back into gff binary data.
 
 Example (save to run on a shell, prints out hex data):
 

data/CHANGELOG

@@ -84,3 +84,12 @@ Bernhard Stoeckner <elven@swordcoast.net> (7):
       struct to yaml: inline small structs
       CHEATSHEET: add some hints for nwn-gff-import
       0.3.4-rel
+
+=== 0.3.5
+Bernhard Stoeckner <elven@swordcoast.net> (6):
+      NWN::Gff::Gff.get_or_set: remove stray debug puts
+      add option for fp precision to Gff::Reader, add cli opt to nwn-gff-print
+      nwn-gff-print: minor speedup when dumping to yaml without prefixes
+      doc: update BINARIES, CHEATSHEET
+      nwn-gff-import: fix reading stdin as -
+      0.3.5-rel

data/CHEATSHEET

@@ -1,6 +1,6 @@
 ==== Extract item from creature inventory
 
- nwn-gff-print --type UTI -k -t creature.bic 'ItemList[12]' | gffencode.pl -o item.uti
+ nwn-gff-print --type UTI -kt -p 'ItemList[12]' creature.bic | gffencode.pl -o item.uti
 
 ==== Convert all item files in the current directory to yaml
 

data/Rakefile

@@ -9,7 +9,7 @@ include FileUtils
 # Configuration
 ##############################################################################
 NAME = "nwn-lib"
-VERS = "0.3.4"
+VERS = "0.3.5"
 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-gff-import

@@ -46,8 +46,7 @@ ARGV.each do |infile|
     outfile = File.new(outfile, "w")
   end
 
-  infile = $stdin if infile == "-"
-  inbytes = IO.read(infile)
+  inbytes = infile == "-" ? $stdin.read : IO.read(infile)
 
   case format
     when :yaml

data/bin/nwn-gff-print

@@ -15,6 +15,7 @@ path = nil
 prefix = :none
 postfix = nil
 verbose = false
+options = {}
 
 OptionParser.new do |o|
   o.banner = "Usage: nwn-gff-print [options] file/- [file, file, ..]"
@@ -50,6 +51,10 @@ OptionParser.new do |o|
     postfix = p
   end
 
+  o.on "--float_rounding F", "Round floating point numbers to the specified number of righthand digits" do |fr|
+    options[:float_rounding] = fr.to_i
+  end
+
   o.on "--type filetype", "Override the file type (implies --struct 0xffffffff)" do |t|
     if t.size != 3
       $stderr.puts "Invalid type #{t} passwd."
@@ -84,7 +89,7 @@ ARGV.each {|file|
     bytes = IO.read(file)
   end
 
-  g = NWN::Gff::Reader.read(bytes)
+  g = NWN::Gff::Reader.read(bytes, options)
 
   if path
     begin
@@ -108,7 +113,11 @@ ARGV.each {|file|
   $stderr.puts "Processing `#{file}`" if verbose
   case format
     when :yaml
-      write_to.puts g.to_yaml.split("\n").map {|ln| my_prefix + ln }.join("\n")
+      if prefix == :none
+        write_to.puts g.to_yaml
+      else
+        write_to.puts g.to_yaml.split("\n").map {|ln| my_prefix + ln }.join("\n")
+      end
     when :kivinen
       NWN::Gff.kivinen_format g, my_prefix + "/", types_too, full, file_type, struct_id do |label, value|
         write_to.puts "%s:\t%s" % [label, value]

data/lib/nwn/gff.rb

@@ -194,7 +194,6 @@ class NWN::Gff::Gff
       path << v
 
       if current_value.is_a?(Gff::Element) && current_value.type == :list # && v =~ /\[(\d+)\]$/
-        puts "value = #{$1}"
         current_value = current_value.value[$1.to_i]
       end
 
@@ -506,16 +505,31 @@ class NWN::Gff::Reader
   attr_reader :hash
   attr_reader :gff
 
+  # This is a hash containing the following options:
+  # [+float_rounding+]
+  #  Round floating numbers to this many righthand positions.
+  #  Defaults to nil (for no rounding). This can be set to prevent
+  #  minor toolset fiddlings from showing up in diffs.
+  #  Note that this is somewhat experimental and may introduce
+  #  accumulating rounding errors over periods of time.
+  #  Suggested values:
+  #   *.git: 4
+  attr_accessor :options
+
   # Create a new Reader with the given +bytes+ and immediately parse it.
   # This is not needed usually; use Reader.read instead.
-  def initialize bytes
+  def initialize bytes, options = {}
     @bytes = bytes
+    @options = {
+      :float_rounding => nil,
+    }.merge(options)
+
     read_all
   end
 
   # Reads +bytes+ as gff data and returns a NWN::Gff:Gff object.
-  def self.read bytes
-    self.new(bytes).gff
+  def self.read bytes, options = {}
+    self.new(bytes, options).gff
   end
 
   private
@@ -622,7 +636,8 @@ class NWN::Gff::Reader
         [data_or_offset].pack("I").unpack("i")[0]
 
       when :float
-        [data_or_offset].pack("V").unpack("f")[0]
+        vsx = [data_or_offset].pack("V").unpack("f")[0]
+        @options[:float_rounding] ? ("%.#{@options[:float_rounding]}f" % vsx).to_f : vsx
 
       when :dword64
         len = 8

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.0
 specification_version: 1
 name: nwn-lib
 version: !ruby/object:Gem::Version 
-  version: 0.3.4
-date: 2008-08-08 00:00:00 +02:00
+  version: 0.3.5
+date: 2008-08-11 00:00:00 +02:00
 summary: a ruby library for accessing Neverwinter Nights resource files
 require_paths: 
 - lib