nwn-lib 0.2 → 0.2.1

data/CHANGELOG

@@ -1,7 +1,17 @@
+=== 0.2.1
+
+* TwoDA allows creation of tables and proper writing, HAS NEW API. (sorry!)
+* NWN::Gff.kivinen_print takes more options, compatibility updates.
+* nwn-gff-print takes option --type: override file type, prints a custom header.
+* nwn-gff-print takes option -f: print full path. (formerly -k)
+* nwn-gff-print takes option --struct: override struct id
+* Added CHEATSHEET
+
 === 0.2
 
 * Add TwoDA reading/writing support.
 * nwn-gff-print supports kivinen-style ____type printing.
+
 === 0.1
 
 * Add basic functionality for reading and writing arbitary gff files.

data/Rakefile

@@ -9,7 +9,7 @@ include FileUtils
 # Configuration
 ##############################################################################
 NAME = "nwn-lib"
-VERS = "0.2"
+VERS = "0.2.1"
 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', \
@@ -18,7 +18,7 @@ RDOC_OPTS = ["--quiet", "--line-numbers", "--inline-source", '--title', \
 Rake::RDocTask.new do |rdoc|
   rdoc.rdoc_dir = "rdoc"
   rdoc.options += RDOC_OPTS
-  rdoc.rdoc_files.add ["README", "CHANGELOG", "COPYING", "doc/*.rdoc", "lib/**/*.rb"]
+  rdoc.rdoc_files.add ["README", "CHEATSHEET", "CHANGELOG", "COPYING", "doc/*.rdoc", "lib/**/*.rb"]
 end
 
 desc "Packages up nwn-lib"

data/bin/nwn-gff-print

@@ -6,6 +6,9 @@ require 'yaml'
 
 format = nil
 types_too = false
+full = false
+file_type = nil
+struct_id = nil
 
 OptionParser.new do |o|
   o.banner = "Usage: nwn-gff-print [options] file/- [path]"
@@ -15,9 +18,24 @@ OptionParser.new do |o|
   o.on "-k", "--kivinen", "Dump as kivinens dump format (like the perl tools)" do
     format = :kivinen
   end
+  o.on "-f", "--kivinen-full-path", "Print the full path (implies -k)" do
+  format = :kivinen
+    full = true
+  end
   o.on "-t", "--types", "Dump types as well (only applies to -k, for now)" do
     types_too = true
   end
+  o.on "--type filetype", "Override the file type (implies --struct 0xffffffff)" do |t|
+    if t.size != 3
+      $stderr.puts "Invalid type #{t} passwd."
+      exit 1
+    end
+    file_type = t.upcase + " "
+    struct_id = 0xffffffff
+  end
+  o.on "--struct id", "Override struct id (as hex, please)" do |s|
+    struct_id = s.hex
+  end
 end.parse!
 
 file = ARGV.shift or begin
@@ -48,7 +66,7 @@ case format
   when :yaml
     y g
   when :kivinen
-    NWN::Gff.kivinen_format g, "/", types_too do |label, value|
+    NWN::Gff.kivinen_format g, "/", types_too, full, file_type, struct_id do |label, value|
       puts "%s:\t%s" % [label, value]
     end
   else

data/lib/nwn/gff.rb

@@ -58,27 +58,38 @@ module NWN
 
     # Parses +s+ as an arbitary GFF object and yields for each field found,
     # with the proper prefix.
-    def self.kivinen_format s, prefix = "/", types_too = false, &block
+    #
+    # [+s+]          The gff object to yield pairs for; can be one of NWN::Gff::Gff, NWN::Gff::Struct, Array (for lists), or NWN::Gff::Element.
+    # [+prefix+]     Supply a prefix to add to the output.
+    # [+types_too+]  Yield type definitions as well (gffprint.pl -t).
+    # [+add_prefix+] Add a prefix <tt>(unknown type)</tt> of no type information can be derived from the input.
+    # [+file_type+]  File type override. If non-null, add a global struct header with the given file type (useful for passing to gffencode.pl)
+    # [+struct_id+]  Provide a struct_id override (if printing a struct).
+    def self.kivinen_format s, prefix = "/", types_too = false, add_prefix = true, file_type = nil, struct_id = nil, &block
       if s.is_a?(NWN::Gff::Gff)
         if types_too
-          yield("/ ____file_type", s.type)
+          yield("/", "")
+          yield("/ ____file_type", file_type.nil? ? s.type : file_type)
           yield("/ ____file_version", s.version)
         end
         s = NWN::Gff::Element.new("", :struct, s.root_struct)
+      elsif file_type != nil
+        yield("/", "")
+        yield("/ ____file_type", file_type)
+        yield("/ ____file_version", "V3.2")
       end
 
       if s.is_a?(Array)
-        v = NWN::Gff::Element.new("(unlabeled list)", :list, s)
+        v = NWN::Gff::Element.new(add_prefix ? "(unlabeled list)" : "", :list, s)
       end
 
       if s.is_a?(NWN::Gff::Struct)
-        yield(prefix + " ____struct_type", s.struct_id) if types_too
-        s = NWN::Gff::Element.new("(unlabeled struct)", :struct, s)
+        s = NWN::Gff::Element.new(add_prefix ? "(unlabeled struct)" : "", :struct, s)
       end
 
       case s.type
         when :struct
-          yield(prefix + " ____struct_type", s.value.struct_id) if types_too
+          yield(prefix + " ____struct_type", struct_id.nil? ? s.value.struct_id : struct_id) if types_too
           s.value.each {|k,v|
             kivinen_format v, prefix + s.label + (s.label == "" ? "" : "/"), types_too do |l,v|
               yield(l, v)
@@ -88,18 +99,24 @@ module NWN
         when :cexolocstr
 
           s.value.each {|vv|
-            yield(prefix + s.label + "/" + vv.language.to_s, vv.text)
+            yield(prefix + s.label + "/" + vv.language.to_s, vv.text.gsub(/([\000-\037\177-\377%])/) {|v| "%" + v.unpack("H2")[0] })
           }
-          yield(prefix + s.label + ". ___string_ref", s._str_ref)
+          yield(prefix + s.label + ". ____string_ref", s._str_ref)
 
         when :list
           s.value.each_with_index {|vv, idx|
+            if types_too
+              yield(prefix + s.label + "[#{idx}]/", prefix + s.label + "[#{idx}]")
+              yield(prefix + s.label + "[#{idx}]/" + " ____struct_type", 0)
+            end
             vv.each {|kkk, vvv|
               kivinen_format vvv, prefix + s.label + "[#{idx}]/", types_too do |l,v|
                 yield(l,v)
               end
             }
           }
+        when :cexostr
+          yield(prefix + s.label, s.value.gsub(/([\000-\037\177-\377%])/) {|v| "%" + v.unpack("H2")[0] })
         else
           yield(prefix + s.label, s.value)
       end
@@ -158,7 +175,6 @@ class NWN::Gff::Gff
   #  gff['/PropertiesList[0]'] = 'Test'
   #    This will raise an error (obviously)
   def get_or_set k, new_value = nil, new_type = nil, new_label = nil, new_str_ref = nil
-    puts "get_or_set(#{k} = #{new_value})"
     h = self.root_struct
     path = []
     value_path = [h]
@@ -274,10 +290,12 @@ class NWN::Gff::Gff
     old_value
   end
 
+  # A alias for get_or_set(key).
   def [] k
     get_or_set k
   end
 
+  # A alias for get_or_set(key, value).
   def []= k, v
     get_or_set k, v
   end
@@ -299,7 +317,7 @@ class NWN::Gff::Element
   def initialize label = nil, type = nil, value = nil
     @label, @type, @value = label, type, value
   end
-  
+
   def validate path_prefix = "/"
     raise NWN::Gff::GffTypeError, "#{path_prefix}#{self.label}: New value #{self.value} is not compatible with the current type #{self.type}" unless
       self.class.valid_for?(self.value, self.type)

data/lib/nwn/twoda.rb

@@ -5,22 +5,40 @@ module NWN
     class Table
 
       # An array of all column names present in this 2da table.
-      attr_reader :columns
+      attr_accessor :columns
 
       # An array of row arrays, without headers.
-      attr_reader :rows
+      attr_accessor :rows
 
+      # Create a new, empty 2da table.
+      def initialize
+        @columns = []
+        @rows = []
+      end
 
-      # Creates a new Table object from a given file.
+      # Creates a new Table object from a given IO source.
       #
-      # [+file+] A readable, valid .2da file.
-      def self.new_from_file file
-        self.new IO.read(file)
+      # [+file+] A IO object pointing to a 2da file.
+      def self.read_from io
+        self.parse io.read()
+      end
+
+      # Dump this table to a IO object.
+      def write_to io
+        io.write(self.to_2da)
       end
 
+      # Parse a existing string containing a full 2da table.
+      # Returns a TwoDA::Table.
+      def self.parse bytes
+        obj = self.new
+        obj.parse bytes
+        obj
+      end
 
       # Parses a string that represents a valid 2da definition.
-      def initialize bytes
+      # Replaces any content this table may already have.
+      def parse bytes
         magic, empty, header, *data = *bytes.split(/\r?\n/).map {|v| v.strip }
 
         raise ArgumentError, "Not valid 2da: No valid header found" if

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.0
 specification_version: 1
 name: nwn-lib
 version: !ruby/object:Gem::Version 
-  version: "0.2"
-date: 2008-06-29 00:00:00 +02:00
+  version: 0.2.1
+date: 2008-07-03 00:00:00 +02:00
 summary: a ruby library for accessing Neverwinter Nights resource files
 require_paths: 
 - lib