ifmapper 0.9 → 0.9.5

data/HISTORY.txt

@@ -1,7 +1,134 @@
+v0.9.5  What's new:
+
+	- IFMapper now looks for Fox1.4 and 1.2, in that order.  Note that
+	  I still recommend Fox1.2, as it is more stable.
+
+	- Automapper now supports selecting how locations are identified 
+	  (either by comparing the room descriptions or just the short name) 
+	  as well as adds support for some unusual location short name
+	  formats used in some Infocom games (Moonmist, Witness).
+
+	- Automapper should now be able to automatically detect the name of
+	  the game from the transcript (at least with WinFrotz and
+	  Glux transcripts).
+
+	- Automapper was idiotically skipping the first command typed in
+	  transcript.  Fixed.
+
+	- Room descriptions now remove starting/trailing spaces or newlines.
+
+	- If possible, when getting an object, if the automapper sees an
+	  answer like "You now have the ...", it will take the object name
+	  from that line instead of from the name the user typed in his
+	  command.
+
+	- Removed some debugging put statements from automapper that had been
+	  left by mistake in v0.9.
+
+	- Added the name of the room to the statusbar when mouse is over
+	  a room.
+
+	- You can now save an .ifm, .t, or .inf file directly from the
+	  save as requester, if you type in a filename with such an
+	  extension.
+
+	- The automapper now also looks for transcripts with extensions
+	  .scr (Magnetic Scrolls/Glux) and .txt (Hugo) by default.
+	  Note that Hugo, Glux and Magnetic Scrolls transcripts do
+	  not append text to transcripts after each move, instead keeping a 
+	  buffer that gets spit out when filled.  Thus, automapping while
+	  playing a game with these interpreters game is not as interactive 
+	  as with winfrotz and similar.  This method can also lead to some 
+	  rooms to be missed or some connections be mistaken, as sometimes
+	  room descriptions will be written out only partially.
+	  Finally, TADS interpreter is the worst, in that it will actually
+	  lock the transcript file, not allowing any other program to read it.
+
+	- Cut/Copying was not allowing you to copy stub connections.  Fixed.
+
+	- Pasting was not pasting the path properties (special, door, etc)
+
+	- I changed a tad how connections are stored internally to using
+	  arrays for the two rooms and the two exit texts.  I then added
+	  code for some common operations.
+
+	- I removed the idea of BtoA connections.  Now, whenever a BtoA
+	  connection is needed, the elements in the connection are reversed.
+	  This helps immensely to simplify operations and comparisons
+	  on connections (and I should have done this much earlier).
+	  In the GUI, if you want to flip a connection from A->B to B->A,
+	  you no longer do so with clicking twice on the connection but
+	  can do so now from the right mouse menu.
+
+	- Stub connections are now drawn a tad shorter.  This helps to
+	  avoid the problem of two nearby stub connections looking as
+	  if it was a single connection.
+
+	- Connection window now correctly disables buttons when selecting
+	  looping connections.
+
+	- Looping connections are no longer drawn as curves, as they look
+	  more clear as straight lines.
+
+	- Fixed a minor display bug that would draw room index numbers
+	  with the wrong font, while editing the room.
+
+	- Help->About will now also display the FXRuby version being
+	  used.
+
+	- When adding multiple objects with 'get all' during an automapping
+	  of a transcript, you would get additional newlines.  Fixed.
+
+	- Sped up a tad path finding and most operations involving path map.
+
+	- Added a check to automapper when transcripts cannot be opened.
+	  This helps, for example, with TADS transcripts, which are locked
+	  and cannot be opened while you are still on script mode (this
+	  absolutely blows in TADS!).
+	  Previously, opening a TADS transcript in progress would just 
+	  crash IFMapper.
+
+	- Fixed yet another problem with links among rooms in different
+	  sections that could still result in crashes while automapping.
+
+	- File->Save As will now warn you if you are about to overwrite a
+	  file.
+
+	- Deleting rooms will now correctly recalculate the path map.
+
+	- IFMapper gem was not including the demo maps with extension
+	  .map.  Fixed.
+
+	- Fixed a thread racing condition which would modify the map's
+	  sizes as it was being drawn.  This could sometimes result in crashes
+	  during transcript automapping.  Now we use a mutex to avoid the
+	  problem.
+
+	- I added a work-around for a bug in Fox that would sometimes
+	  not re-initialize the canvas properly and would lead to a crash,
+	  usually after 1+ hour of use of the automapper.  This problem is not
+	  yet fixed (it is a Fox issue), but the work-around will try at
+	  least twice to make it work.
+	
+	- Switching from one map to another now immediately updates the
+	  section # in the toolbar.
+
+	- There's now a new option called Map->Room List which will
+	  list all the rooms in your map, allowing you to also select 
+	  and sort rooms from that list.
+
+	- Added new full maps for Risorgimiento Represo, Christminster, a full
+	  Anchorhead, the three Earth & Sky games, City of Secrets, Moonmist,
+	  All Roads, Trinity.
+	  Partial maps for Dreamhold, Savoir Fare, Heroine's Mantle, World's
+	  Apart, Metamorphoses, Pytho's Mask.
+	  All of these were created with the automapper, as I played those 
+	  games.
+
 v0.9 - What's new:
 
-       - Fixed a very idiotic bug in Cut algorithm.  It was basically destroying
-	 all cut connections right after they were cut.
+       - Fixed a very idiotic bug in Cut algorithm.  It was basically 
+	 destroying all cut connections right after they were cut.
 
        - Editing rooms' names or objects now results in a much, much
 	 faster redraw of the map, even if map is very complex.
@@ -10,7 +137,7 @@ v0.9 - What's new:
 	 description is often used by the the automapper during transcript
 	 mapping to determine the uniqueness of a room, albeit the main 
 	 use of editing a room description is to allow creation of 
-	 new games (currently, Inform).
+	 new games (currently, Inform/TADS3).
 
        - You can now optionally avoid displaying the task or description
 	 section on rooms.
@@ -212,8 +339,8 @@ v0.7 - Fix the issue of users trying to fire up the application from another
 
        Added IFM export.
        Note that albeit you can load and save out an IFM map file, if you load 
-       and then save an ifm file, the integrity of the ifm file created by hand 
-       will not be kept.
+       and then save an ifm file, the integrity of the ifm file created by 
+       hand will not be kept.
        Things such as ifm variables, task and object dependencies will be
        lost if you do that.  It is unlikely I will add full walkthru 
        functionality to IFMapper.

data/IFMapper.gemspec

@@ -2,13 +2,13 @@ require "rubygems"
 
 spec = Gem::Specification.new do |spec|
 	spec.name = "ifmapper"
-	spec.version = '0.9'
+	spec.version = '0.9.5'
 	spec.author = "Gonzalo Garramuno" 
 	spec.email = 'ggarram@advance.dsl.com.ar'
 	spec.homepage = 'http://www.rubyforge.org/projects/ifmapper/'
 	spec.summary = 'Interactive Fiction Mapping Tool.'
 	spec.require_path = "lib"
-	spec.files = ['IFMapper.rbw'] + Dir.glob("lib/IFMapper/*.rb") + Dir.glob("maps/*.ifm") + Dir.glob("icons/*")
+	spec.files = ['IFMapper.rbw'] + Dir.glob("lib/IFMapper/*.rb") + Dir.glob("maps/*.ifm") + Dir.glob("maps/*.map") + Dir.glob("icons/*")
 	spec.description = <<-EOF
 	Interactive Fiction Mapping Tool.
 EOF

data/TODO.txt

@@ -1,9 +1,4 @@
 
-- Ability to remove stub exits if moving in a certain direction fails.
-  Need to trap 'fail' messages for moving such as:
-       You can't go that way.
- 
-
 - Add SVG output
 - Do Printing
 - Cleanup code 

data/lib/IFMapper/AStar.rb

@@ -105,7 +105,7 @@ class AStar
     else
       # Not goal, get successors
       n.info.successors( self, n.parent )
-      @successors.each { |s|
+      @successors.each do |s|
 	newg = n.g + n.info.cost( s.info )
 
 	# Now, we need to find out if this node is on the open or close lists
@@ -128,12 +128,19 @@ class AStar
 
 	# Remove succesor from closed list if it was on it
 	@closed_list.delete(closed) if closed
-	# Remove succesor from open list if it was on it
-	@open_list.delete(open) if open
-	@open_list.push(s)
-	# Make sure open list stays sorted based on f
-	@open_list.sort!
-      }
+	# Change succesor from open list if it was on it
+	if open
+	  open.parent = s.parent
+	  open.g = s.g
+	  open.h = s.h
+	  open.f = s.f
+	else
+	  @open_list.push(s)
+	end
+      end
+      # Make sure open list stays sorted based on f
+      @open_list.sort!
+
       @closed_list.push(n)
       @successors.clear
     end
@@ -200,7 +207,7 @@ class MapNode
     if x < 0 or y < 0 or x >= @@pmap.size or y >= @@pmap[0].size
       return MAX_SCALE
     else
-      t = @@pmap[x][y]
+      t = @@pmap.at(x).at(y)
       return MAX_SCALE   if t.kind_of?(Room)
       return MAX_SCALE-1 if t.kind_of?(Connection)
       return 1

data/lib/IFMapper/Connection.rb

@@ -5,9 +5,9 @@
 #
 class Connection
   attr_accessor :type
-  attr_accessor :dir
-  attr_accessor :roomA,     :roomB
-  attr_accessor :exitAtext, :exitBtext
+  attr_reader   :dir
+  attr_accessor :room
+  attr_accessor :exitText
 
   # Type constants
   FREE        = 0
@@ -18,7 +18,7 @@ class Connection
   # Direction constants
   BOTH = 0
   AtoB = 1
-  BtoA = 2
+  BtoA = 2  # NO LONGER USED.
 
   # Text near connection (to indicate other dir)
   EXIT_TEXT = [
@@ -29,52 +29,164 @@ class Connection
     'O'
   ]
 
+  def dir=(x)
+    if x == BtoA
+      @dir = AtoB
+      flip
+    else
+      @dir = x
+    end
+  end
+
+  def roomA=(x)
+    @room[0] = x
+  end
+
+  def roomB=(x)
+    @room[1] = x
+  end
+
+  def roomA
+    return @room[0]
+  end
+
+  def roomB
+    return @room[1]
+  end
+
+  def exitAtext=(x)
+    @exitText[0] = x
+  end
+
+  def exitBtext=(x)
+    @exitText[1] = x
+  end
+
+  def exitAtext
+    return @exitText[0]
+  end
+
+  def exitBtext
+    return @exitText[1]
+  end
 
   def marshal_load(vars)
-    @type, @dir, @roomA, @roomB,
-      @exitAtext, @exitBtext = vars
+    if vars[2].kind_of?(Array)
+      @type, @dir, @room, @exitText = vars
+    else
+      @type     = vars[0]
+      @dir      = vars[1]
+      @room     = [vars[2], vars[3]]
+      @exitText = [vars[4], vars[5]]
+      if @dir == BtoA
+	@dir = AtoB
+	flip
+      end
+    end
   end
 
   def marshal_dump
-    [ @type, @dir, @roomA, @roomB, @exitAtext, @exitBtext ]
+    [ @type, @dir, @room, @exitText ]
   end
 
   def initialize( roomA, roomB, dir = BOTH, type = FREE )
-    @roomA     = roomA
-    @roomB     = roomB
-    @dir       = dir
-    @type      = type
-    @exitAtext = 0
-    @exitBtext = 0
+    @room     = []
+    @room[0]  = roomA
+    @room[1]  = roomB
+    @dir      = dir
+    @type     = type
+    @exitText = [0, 0]
+  end
+
+  #
+  # Given a room, return the index of that room in the room[] array
+  # If room is not present in connection, return nil.
+  #
+  def index(room)
+    @room.each_with_index { |r, idx| return idx if r == room }
+    return nil
   end
 
+  #
+  # Flip A and B rooms.  This is mainly used to make a oneway AtoB
+  # connection become a BtoA connection.
+  #
+  def flip
+    return unless @room[1]
+    @room.reverse!
+    @exitText.reverse!
+  end
+
+  #
+  # Return the connected direction index for each room
+  #
+  def dirs
+    dirA = @room[0].exits.index(self)
+    if @room[1]
+      dirB = @room[1].exits.rindex(self)
+    else
+      dirB = nil
+    end
+    return [dirA, dirB]
+  end
 
+  #
+  # Return true if connection is a stub exit (ie. an exit leading nowhere)
+  #
   def stub?
-    return true unless @roomB
+    return true unless @room[1]
     return false
   end
 
+  #
+  # Return true if connection is a self-looping connection
+  #
+  def loop?
+    return false if @room[0] != @room[1]
+    dirA, dirB = dirs
+    return true if dirA == dirB
+    return false
+  end
+
+  #
+  # Return true if connection is a door
+  #
+  def door?
+    return true if @type == CLOSED_DOOR or @type == LOCKED_DOOR
+    return false
+  end
+
+  #
+  # For debugging purposes, print ourselves nicely
+  #
   def to_s
     dirA = dirB = ''
-    a = @roomA? @roomA.name : 'nil'
-    b = @roomB? @roomB.name : 'nil'
-    if exitAtext > 0
-      dirA = EXIT_TEXT[exitAtext]
+    a = @room[0]? @room[0].name : 'nil'
+    b = @room[1]? @room[1].name : 'nil'
+    if @exitText[0] > 0
+      dirA = EXIT_TEXT[@exitText[0]]
     else
-      if @roomA
-	idx  = @roomA.exits.index(self)
+      if @room[0]
+	idx  = @room[0].exits.index(self)
 	dirA = Room::DIRECTIONS[idx] if idx
+	dirA = dirA.upcase
       end
     end
-    if exitBtext > 0
-      dirB = EXIT_TEXT[exitBtext]
+    if @exitText[1] > 0
+      dirB = EXIT_TEXT[@exitText[1]]
     else
-      if @roomB
-	idx  = @roomB.exits.rindex(self)
+      if @room[1]
+	idx  = @room[1].exits.rindex(self)
 	dirB = Room::DIRECTIONS[idx] if idx
+	dirB = dirB.upcase
       end
     end
-    "#{a} #{dirA}<->#{b} #{dirB}"
+    if @dir == AtoB
+      sym = '  --> '
+    else
+      sym = ' <-> '
+    end
+    "#{a} #{dirA}#{sym}#{b} #{dirB}"
   end
 end
 

data/lib/IFMapper/FXConnection.rb

@@ -38,6 +38,10 @@ class FXConnection < Connection
 
   @@win = nil
 
+  def self.no_maps
+    @@win.hide if @@win
+  end
+
   def initialize( roomA, roomB, dir = Connection::BOTH, 
 		 type = Connection::FREE )
     super( roomA, roomB, dir, type )
@@ -55,6 +59,13 @@ class FXConnection < Connection
     [ @selected ] + super
   end
 
+  def flip
+    super
+    pts.reverse!
+    gpts.reverse!
+    @@win.copy_from(self) if @@win
+  end
+
   #
   # Change selection state of connection.  If Connection Properties
   # window is open, copy the connection data to it.
@@ -69,12 +80,10 @@ class FXConnection < Connection
   #
   def toggle_direction
     # If a self-loop, we cannot change dir
-    return if @roomA == @roomB and
-      @roomA.exits.index(self) == @roomA.exits.rindex(self)
-
-    @dir += 1
-    @dir = BOTH if @dir > BtoA
+    return if @room[0] == @room[1] and
+      @room[0].exits.index(self) == @room[0].exits.rindex(self)
 
+    @dir ^= 1
     @@win.copy_from(self) if @@win
   end
 
@@ -83,21 +92,21 @@ class FXConnection < Connection
   # contiguous
   #
   def complex?()
-    return false if not @roomB
-    return true if @roomB == @roomA
-    return true unless @roomA.next_to?(@roomB)
+    return false if not @room[1]
+    return true if @room[1] == @room[0]
+    return true unless @room[0].next_to?(@room[1])
 
     # Even if rooms are next to each other, we need to
     # verify that following the exits does indeed take us to next room.
-    exitA = @roomA.exits.index(self)
+    exitA = @room[0].exits.index(self)
     dir   = Room::DIR_TO_VECTOR[exitA]
 
-    if @roomA.x + dir[0] == @roomB.x and
-	@roomA.y + dir[1] == @roomB.y
-      exitB = @roomB.exits.rindex(self)
+    if @room[0].x + dir[0] == @room[1].x and
+	@room[0].y + dir[1] == @room[1].y
+      exitB = @room[1].exits.rindex(self)
       dir   = Room::DIR_TO_VECTOR[exitB]
-      if @roomB.x + dir[0] == @roomA.x and
-	  @roomB.y + dir[1] == @roomA.y
+      if @room[1].x + dir[0] == @room[0].x and
+	  @room[1].y + dir[1] == @room[0].y
 	return false
       else
 	return true
@@ -155,16 +164,16 @@ class FXConnection < Connection
 
   def _arrow_info( x1, y1, x2, y2, zoom = 1.0 )
     pt1  = []
-    dir = 0
-    if    @dir == AtoB 
-      dir = @roomB.exits.rindex(self)
-      pt1 = [ x2, y2 ]
+    dir  = 0
+    dir  = @room[1].exits.rindex(self)
+    pt1  = [ x2, y2 ]
+    x, y = Room::DIR_TO_VECTOR[dir]
+    if @room[0] == @room[1]
+      size = 15.0
     else
-      dir = @roomA.exits.index(self)
-      pt1 = [ x1, y1 ]
+      size = 20.0
     end
-    x, y      = Room::DIR_TO_VECTOR[dir]
-    arrow_len = 20.0 / Math.sqrt(x * x + y * y)
+    arrow_len = size / Math.sqrt(x * x + y * y)
     x *= arrow_len *  zoom
     y *= arrow_len * -zoom
 
@@ -241,7 +250,16 @@ class FXConnection < Connection
   #
   def draw_complex(dc, zoom, opt)
     if opt['Paths as Curves']
-      p = draw_complex_as_bspline(dc, zoom)
+      if @room[0] == @room[1]
+	dirA, dirB = dirs
+	if dirA == dirB
+	  p = draw_complex_as_lines(dc, zoom)
+	else
+	  p = draw_complex_as_bspline(dc, zoom)
+	end
+      else
+	p = draw_complex_as_bspline(dc, zoom)
+      end
     else
       p = draw_complex_as_lines(dc, zoom)
     end
@@ -263,10 +281,10 @@ class FXConnection < Connection
   # line connections or 'stub' connections.
   #
   def draw_simple(dc, zoom)
-    dir    = @roomA.exits.index(self)
-    x1, y1 = @roomA.corner(self, zoom, dir)
-    if @roomB
-      x2, y2 = @roomB.corner(self, zoom)
+    dir    = @room[0].exits.index(self)
+    x1, y1 = @room[0].corner(self, zoom, dir)
+    if @room[1]
+      x2, y2 = @room[1].corner(self, zoom)
       dc.drawLine( x1, y1, x2, y2 )
       draw_arrow(dc, zoom, x1, y1, x2, y2)
       if @type == LOCKED_DOOR or @type == CLOSED_DOOR
@@ -275,11 +293,7 @@ class FXConnection < Connection
     else
       # Complex connection in progress or "stub" exit
       v = FXRoom::DIR_TO_VECTOR[dir]
-      x2, y2 = [ @roomA.x + v[0] * 0.5, @roomA.y + v[1] * 0.5 ]
-      x2 *= WW * zoom
-      y2 *= HH * zoom
-      x2 += WW / 2 * zoom
-      y2 += HH / 2 * zoom
+      x2, y2 = [ x1 + v[0] * WS * zoom * 0.4, y1 + v[1] * HS * zoom * 0.4 ]
       dc.drawLine( x1, y1, x2, y2 )
     end
   end
@@ -331,17 +345,17 @@ class FXConnection < Connection
   # Draw any exit text if available (exit text is 'U', 'D', 'I', 'O', etc)
   #
   def draw_exit_text(dc, zoom)
-    if @exitAtext != 0
-      dir  = @roomA.exits.index(self)
-      x, y = @roomA.corner(self, zoom, dir)
+    if @exitText[0] != 0
+      dir  = @room[0].exits.index(self)
+      x, y = @room[0].corner(self, zoom, dir)
       draw_text( dc, zoom, x, y, dir, 
-		EXIT_TEXT[@exitAtext], @dir == BtoA)
+		EXIT_TEXT[@exitText[0]], nil )
     end
-    if @exitBtext != 0
-      dir  = @roomB.exits.rindex(self)
-      x, y = @roomB.corner(self, zoom, dir)
+    if @exitText[1] != 0
+      dir  = @room[1].exits.rindex(self)
+      x, y = @room[1].corner(self, zoom, dir)
       draw_text( dc, zoom, x, y, dir, 
-		EXIT_TEXT[@exitBtext], @dir == AtoB)
+		EXIT_TEXT[@exitText[1]], @dir == AtoB)
     end
   end