ifmapper 0.9.6 → 0.9.7

data/HISTORY.txt

@@ -1,3 +1,60 @@
+v0.9.7  What's new:
+	- IFM exporting was incorrectly exporting
+	      map "";
+	  for sections that were unnamed and also when there was only one
+	  section.
+	  Now, IFM exporting will not export map name if only one section
+	  is present.  And if multiple sections are present but are unnamed,
+	  sections will be given the default name of "Section #".
+	  [Bug Report: Eric Forgeot]
+
+	- Improved name finding for Classic transcripts, by actually dealing
+	  with parenthesis in short names a tad more strictly.
+
+	- Added support for reading GUEMap maps (.gmp format).
+	  For both, GUEMap v1.0+ and GUEMap v2.0 (beta).
+	  Comments in GUEmaps will be placed in the task section of rooms.
+	  As GUEmaps supports placing rooms with a finer grid, IFMapper will
+	  try to translate grid positions, but may not always be entirely
+	  successful.
+
+	- Fixed a crashing bug that could occur very rarely when loading
+	  multiple maps due to the canvas not being created.
+
+	- Fixed my email in the README.txt.
+
+	- Improved warning box to allow for multi-line messages.
+	  This helps with telling user about errors when reading from
+	  a file.
+
+	- Rewrote a big chunk of the map readers (inform/tads).  Reason was
+	  two-fold:
+		* make the code smaller and simpler
+		* fix a logic problem in the layout algorithm which was 
+		  leading to maps being laid out much bigger when map had 
+		  a lot of one way connections.  Now room layout is much, much
+		  improved.
+		    [Bug Report: Greg Boettcher]
+		* sped up the creation of map code a tad.
+
+        - Inform reader now understands most special international character
+	  sequences (@:a, etc).
+
+	- TADS reader was marking some one way door exits as normal exits.
+	  Fixed.
+
+	- TADS reader was not dealing with @location notation properly.
+	  It was sometimes placing objects in the wrong room, or completely
+	  ignoring them.
+
+	- TADS reader now handles exits that are <<replaceAction(Enter,*)>>
+
+	- Inform and TADS readers will now extract the name of the map from the
+	  Story constant.
+
+	- Inform reader is a tad smarter about locating objects.
+
+
 v0.9.6  What's new:
 
 	- IFM exporting had gotten broken around v0.9 due to a refactoring

data/IFMapper.gemspec

@@ -2,7 +2,7 @@ require "rubygems"
 
 spec = Gem::Specification.new do |spec|
 	spec.name = "ifmapper"
-	spec.version = '0.9.6'
+	spec.version = '0.9.7'
 	spec.author = "Gonzalo Garramuno" 
 	spec.email = 'ggarram@advance.dsl.com.ar'
 	spec.homepage = 'http://www.rubyforge.org/projects/ifmapper/'

data/lib/IFMapper/AStar.rb

@@ -170,7 +170,7 @@ end
 
 
 #
-# Simple class used as a
+# Simple class used as an adapter for our FXMap<->AStar
 #
 class MapNode
   attr_reader :x, :y

data/lib/IFMapper/Connection.rb

@@ -98,6 +98,16 @@ class Connection
     @exitText = [0, 0]
   end
 
+  #
+  # Given a room, return the opposite room in the connection.
+  # If room passed is not present in connection, raise an exception.
+  #
+  def opposite(room)
+    idx = self.index(room)
+    raise "Room #{room} not part of connection #{c}" unless idx
+    return @room[idx ^ 1]
+  end
+
   #
   # Given a room, return the index of that room in the room[] array
   # If room is not present in connection, return nil.

data/lib/IFMapper/FXDCPostscript.rb

@@ -2,8 +2,8 @@
 
 #
 # Class used to do Postscript printing.  This class has only the basic
-# functionality needed for doing so and replaces the still somewhat buggy version of
-# Fox's 1.2 FXDCPrint
+# functionality needed for doing so and replaces the still somewhat buggy 
+# version of Fox's 1.2 FXDCPrint
 #
 class FXDCPostscript < FXDC
   @@printcmd = 'lpr -P%s -o l -' # -#%d'

data/lib/IFMapper/FXMap.rb

@@ -1867,7 +1867,7 @@ class FXMap < Map
   # Draw map
   #
   def draw(sender = nil, sel = nil, event = nil)
-    return if @mutex.locked?
+    return if @mutex.locked? or not @canvas.created?
 
     if not @image.created?
       puts "Image was not created.  Try again"
@@ -1901,7 +1901,6 @@ class FXMap < Map
     dc.end
     
 
-
     # Blit the off-screen image into canvas
     dc = FXDCWindow.new(@canvas)
     dc.setClipRectangle( cx, cy, w, h)

data/lib/IFMapper/FXMapFileDialog.rb

@@ -8,7 +8,7 @@ class FXMapFileDialog < FXFileDialog
   @@last_path = nil
 
   KNOWN_EXTENSIONS = [
-    "Map Files (*.map,*.ifm,*.inf,*.t,*.t3m)",
+    "Map Files (*.map,*.gmp,*.ifm,*.inf,*.t,*.t3m)",
     "All Files (*)",
   ]
 

data/lib/IFMapper/FXMapperWindow.rb

@@ -59,7 +59,7 @@ require 'IFMapper/FXRoomList'
 class FXMapperWindow < FXMainWindow
 
   PROGRAM_NAME = "Interactive Fiction Mapper"
-  VERSION      = '0.9.6'
+  VERSION      = '0.9.7'
   AUTHOR       = "Gonzalo Garramuno"
   TITLE = "#{PROGRAM_NAME} v#{VERSION} - Written by #{AUTHOR}"
 
@@ -94,7 +94,7 @@ class FXMapperWindow < FXMainWindow
     begin
       TADSReader.new(file, map)
     rescue => e
-      return "#{e} #{e.backtrace}"
+      return "#{e}"
     end
     return map
   end
@@ -104,7 +104,17 @@ class FXMapperWindow < FXMainWindow
     begin
       InformReader.new(file, map)
     rescue => e
-      return "#{e} #{e.backtrace}"
+      return "#{e}"
+    end
+    return map
+  end
+
+  def open_guemap(file, map)
+    require 'IFMapper/GUEReader'
+    begin
+      GUEReader.new(file, map)
+    rescue => e
+      return "#{e}"
     end
     return map
   end
@@ -174,13 +184,18 @@ class FXMapperWindow < FXMainWindow
       tmp = open_inform(file, map)
     elsif file =~ /\.t$/i or file =~ /\.t3m$/
       tmp = open_tads(file, map)
+    elsif file =~ /\.gmp$/
+      tmp = open_guemap(file, map)
     else
       tmp = open_map(file)
     end
 
     if not tmp.kind_of?(Map) and not tmp.kind_of?(FXMap)
       $stderr.puts tmp
-      status "Could not load '#{file}'. Error: #{tmp}." 
+      w = FXWarningBox.new( self, 
+			   "#{tmp}")
+      w.execute
+      status "Could not load '#{file}'." 
       if make_new_map
 	if map.close_cb
 	  @maps.delete(map)

data/lib/IFMapper/FXSpline.rb

@@ -1,6 +1,8 @@
 
 
-
+#
+# Class used to evaluate a bspline.
+#
 class FXSpline
   OS = 1.0 / 6.0
   FS = 4.0 / 6.0

data/lib/IFMapper/FXWarningBox.rb

@@ -20,7 +20,12 @@ class FXWarningBox < FXDialogBox
       oops.borderColor = 'white'
       oops.font = font
 
-      FXLabel.new(f, text, nil, 0)
+      t = FXText.new(f)
+      t.text = text
+      t.visibleRows = 4
+      t.visibleColumns = 80
+      t.backColor = f.backColor
+      t.disable
 
       # Separator
       FXHorizontalSeparator.new(s,

data/lib/IFMapper/GUEReader.rb

@@ -0,0 +1,445 @@
+
+require "IFMapper/Map"
+
+class FXMap; end
+
+#
+# Class that allows importing a GUE map file.
+#
+class GUEReader
+
+  class ParseError < StandardError; end
+  class MapError < StandardError; end
+
+  # This is the GUEmap magic number/ID at the beginning of the file.
+  GUE_MAGIC = "\307U\305m\341p"
+
+  DIRS = { 
+    0 => 0, # n
+    1 => 4, # s
+    2 => 2, # e
+    3 => 6, # w
+    4 => 1, # ne
+    5 => 7, # nw
+    6 => 3, # se
+    7 => 5, # sw
+
+    # GUE Map also supports connections to the sides of centers
+    #
+    #  -*--*-
+    #  |    |
+    #  -*--*-
+    #
+    # We translate these as corner connections.
+    #
+    8  => [0, 1], #   ----*-
+    9  => [0, 7],
+    10 => [4, 3], #   ----*-
+    11 => [4, 5],
+
+    # DOT directions
+    # 12 => 4,
+  }
+
+
+  class Complex
+    attr_accessor :roomA, :dirA, :roomB, :dirB
+  end
+
+
+  attr_reader :map
+
+  @@debug = nil
+
+  def debug(x)
+    if @@debug.to_i > 0
+      $stderr.puts x
+    end
+  end
+
+  #
+  # Read GUEMap header from file stream
+  #
+  def header
+    magic = @f.read(6)
+    if magic != GUE_MAGIC
+      raise ParseError, "Not a GUEMap"
+    end
+    @f.read(4)
+    version = @f.read(2).unpack('s')[0]
+    debug "VERSION: #{version}"
+    case version
+    when 4
+      crap = @f.read(2)
+      crap = @f.read(1)[0]
+      if crap == 32
+	len = @f.read(1)[0]
+	@map.name = @f.read(len)
+	crap = @f.read(1)[0]
+      end
+      if crap == 40
+	len = @f.read(1)[0]
+	if len == 255
+	  len = @f.read(2).unpack('s')[0]
+	end
+	@f.read(len)
+	crap = @f.read(1)[0]
+      end
+      hdr = @f.read(15)
+    when 3,2
+      crap = @f.read(2)
+      crap = @f.read(1)[0]
+      if crap == 32
+	len = @f.read(1)[0]
+	@map.name = @f.read(len)
+	crap = @f.read(1)[0]
+      end
+      if crap == 40
+	len = @f.read(1)[0]
+	if len == 255
+	  len = @f.read(2).unpack('s')[0]
+	end
+	@f.read(len)
+	crap = @f.read(1)[0]
+      end
+      hdr = @f.read(8)
+    else
+      raise ParseError, "Unknown GUEMap version #{version}"
+    end
+  end
+
+  #
+  # Read a connection from file stream
+  #
+  def read_connection
+    type = Connection::FREE
+    dir  = Connection::BOTH
+    dA   = @f.read(1)[0]
+    a    = @f.read(1)[0]
+    stub = false
+
+    opt = @f.read(1)[0]
+    exitAtext = exitBtext = 0
+
+    case opt
+    when 26
+      #normal connection
+    when 34
+      # up/down/in/out connection
+      exitAtext = @f.read(1)[0]
+      if exitAtext & 8 != 0
+	exitAtext -= 8
+	type = Connection::SPECIAL
+      end
+      if exitAtext & 16 != 0
+	# no exit connection
+	stub = true
+	exitAtext -= 16
+	b  = a
+	dB = dA
+      end
+      if exitAtext & 32 != 0
+	# stub connection
+	stub = true
+	exitAtext -= 32
+      end
+      if exitAtext & 64 != 0
+	exitAtext -= 64
+	dir = Connection::AtoB
+      end
+      exitBtext = @f.read(1)[0]
+      data      = @f.read(1)[0]
+    else
+      raise ParseError, "option: #{opt} unknown"
+    end
+
+    unless stub
+      dB    = @f.read(1)[0]
+      b     = @f.read(1)[0]
+      opt   = @f.read(1)[0]
+    end
+
+    data    = @f.read(1)[0]
+    data    = @f.read(1)[0] unless @f.eof?
+
+    section = @map.sections[@map.section]
+    roomA = section.rooms[a]
+    roomB = section.rooms[b] if b
+
+
+    debug "Index  : #{a}->#{b}"
+    debug "dA:   #{dA}   dB: #{dB}"
+    if roomA.name == '*'
+      if roomB.x != roomA.x or roomB.y != roomA.y
+	dirA = roomA.exit_to(roomB)
+      else
+	dirA = 0
+      end
+    else
+      dirA = DIRS[dA]
+      if dirA.kind_of?(Array)
+	dirA.each { |d|
+	  next if roomA[d]
+	  dirA = d
+	  break
+	}
+	if dirA.kind_of?(Array)
+	  dirA = dirA[0]
+	end
+      end
+      raise "Unknown direction #{dA}" unless dirA
+    end
+
+    if b
+      if roomB.name == '*'
+	dirB = (dirA + 4) % 8
+      else
+	dirB = DIRS[dB]
+	if dirB.kind_of?(Array)
+	  dirB.each { |d|
+	    next if roomB[d]
+	    dirB = d
+	    break
+	  }
+	  if dirB.kind_of?(Array)
+	    dirB = dirB[0]
+	  end
+	end
+	raise "Unknown direction #{dB}" unless dirB
+      end
+    end
+
+
+    if roomA[dirA]
+      dirA = roomA.exits.index(nil)
+    end
+
+    if roomB
+      if roomB[dirB]
+	dirB = roomB.exits.rindex(nil)
+      end
+    end
+
+
+    debug "Connect: #{roomA} ->#{roomB} "
+    debug "dirA: #{dirA} dirB: #{dirB}"
+    debug "exitA: #{exitAtext} exitB: #{exitBtext}"
+
+    begin
+      c = map.new_connection( roomA, dirA, roomB, dirB )
+
+      c.exitAtext = exitAtext
+      c.exitBtext = exitBtext
+      c.dir       = dir
+      c.type      = type
+      
+      debug c
+    rescue Section::ConnectionError
+    end
+
+  end
+
+
+  #
+  # Read a room from file stream
+  #
+  def read_room
+    x       = @f.read(1)[0]
+    data    = @f.read(1)
+    y       = @f.read(1)[0]
+    data    = @f.read(1)[0]
+
+    type    = @f.read(1)[0]
+
+    case type
+    when 41
+      r = @map.new_room(x, y)
+      r.name = "*"
+      data  = @f.read(4)
+      if data[0] == 0
+	r.name = ''
+      end
+      return
+    when 0
+      r = @map.new_room(x, y)
+      r.name = ''
+      @f.read(2)
+      return
+    end
+
+    len  = @f.read(1)[0]
+    name = ''
+    comment = ''
+
+    name = @f.read(len)
+    test = @f.read(1)[0]
+
+    case test
+    when 41
+      @f.read(4)
+    when 0
+      data = @f.read(2)
+    else
+      len     = @f.read(1)[0]
+      if len == 255
+	len = @f.read(2).unpack('s')[0]
+      end
+      comment = @f.read(len)
+      data    = @f.read(3)
+    end
+    debug "Room:    #{name.inspect}  pos: #{x}, #{y}"
+    debug "Comment: #{comment.inspect}"
+
+    # r = @map.new_room(x, y)
+    r = @map.new_room(x, y)
+    name.gsub!(/[\r\n]+/, ' ')
+    comment.gsub!(/\r/, '')
+
+    r.name  = name
+    r.tasks = comment
+  end
+
+  #
+  # Main parsing loop. 
+  #
+  def parse
+    header
+    while not @f.eof?
+      type = @f.read(1)[0]
+      data = @f.read(1)[0]
+
+      debug "type: #{type}"
+      debug "data: #{data}"
+
+      case type
+      when 2
+	read_room
+      when 3
+	read_connection
+      when 4
+	break
+      else
+	raise "Unknown type: #{type}"
+      end
+    end
+  end
+
+  def remove_dots
+    @map.sections.each do |sect|
+      sect.connections.each do |c|
+	a, b = c.room
+	next unless b
+	next if a.name == '*' or b.name != '*'
+	# OK.  We have a ROOM->* connection.  Follow it to find other room.
+	# And turn it into a complex connection.
+	dirA = a.exits.index(c)
+	dirB = b.exits.rindex(c)
+	origB   = dirB
+	dir     = Connection::BOTH
+	dirB    = nil
+	cc      = c
+	while b.name == '*'
+	  found = false
+	  b.exits.each { |e|
+	    next if not e or e == cc
+	    found = true
+	    idx  = e.index(b) ^ 1
+	    b    = e.room[idx]
+	    dirB = b.exits.index(e)
+	    dir  = e.dir
+	    cc   = e
+	    break
+	  }
+	  if not found
+	    debug "not found complement for #{cc}"
+	    break
+	  end
+	end
+
+	next if b.name == '*'
+
+	# remove the other connection
+	sect.delete_connection(cc)
+
+	c.roomB[origB] = nil
+
+	# Make connection a complex connection and remove old
+	# connection in b room
+	c.roomB = b
+	c.dir   = dir
+	b[dirB] = c
+      end
+    end
+
+
+    # Now, remove all DOT rooms and their connections
+    @map.sections.each { |sect|
+      del = sect.rooms.find_all { |r| r.name == '*' }
+      del.each { |r|
+	sect.delete_room(r)
+      }
+    } 
+  end
+
+  def reposition
+    @map.sections.each do |sect|
+      minXY, = sect.min_max_rooms
+      sect.rooms.each do |r|
+	r.x -= minXY[0]
+	r.y -= minXY[1]
+	r.x /= 4.0
+	r.y /= 4.0
+      end
+    end
+
+    @map.sections.each do |sect|
+      sect.rooms.each_with_index do |r, idx|
+	x = r.x
+	y = r.y
+	xf = x.floor
+	yf = y.floor
+	if x != xf or y != yf
+	  sect.rooms.each do |r2|
+	    next if r == r2
+	    if xf == r2.x.floor and yf == r2.y.floor
+	      dx = (x - xf).ceil
+	      dy = (y - yf).ceil
+	      sect.shift(x, y, dx, dy)
+	      break
+	    end
+	  end
+	end
+	r.x = r.x.floor.to_i
+        r.y = r.y.floor.to_i
+      end
+    end
+  end
+
+
+  def initialize(file, map = Map.new('GUE Imported Map'))
+    @map     = map
+    @complex = []
+
+    @f = File.open(file, 'rb')
+    parse
+    
+    reposition
+    remove_dots
+
+    @map.fit
+    @map.section = 0
+    if @map.kind_of?(FXMap)
+      @map.filename   = file.sub(/\.gmp$/i, '.map')
+      @map.navigation = true
+      @map.window.show
+    end
+  end
+end
+
+
+if $0 == __FILE__
+  puts "Opening file '#{ARGV[0]}'"
+  require "IFMapper/Map"
+  
+  GUEReader.new(ARGV[0])
+end