ifmapper 0.7 → 0.8

data/HISTORY.txt

@@ -1,4 +1,35 @@
 
+v0.8 - Added the ability to create linked rooms using the Numeric Keypad.
+       Turn on NUM LOCK, select a single room and then use the numbers in 
+       the keypad to move thru an exit or add a room in a certain direction.
+
+       Changed name of the main program from IFMapper.rb to IFMapper.rbw.
+       This helps on windows in not bringing up a dummy console window.
+
+       Added Home/End/PageUp/PageDown to move nodes diagonally.  This
+       helps with the Keypad, when not in NUM LOCK mode.
+
+       Fixed a bug that effected IFMReader that I inadvertedly 
+       introduced in v0.7.
+
+       Removed Postscript support.  I just realized that GSview also reads
+       PDFs making Postscript really not needed.
+
+       Added splitting of huge sections into multiple pages when spitting
+       PDFs.
+
+       Fixed a bug that would result in a stack trace when loading an IFM
+       file that was pretty big onto an a very tiny empty map.
+
+       Added the ability to Automap a game from transcripts.  Go to
+       your game, type 'script' and the filename to save your transcript to.
+       Then, go to IFMapper and go to Map->Automap->Start.  Give it that
+       filename.  Voila.  IFMapper will start automapping the game.
+       Leave the transcript on and, as you play the game, IFMapper behind
+       the scenes will keep automapping.
+
+       # Added tooltip when zoomed out.
+
 v0.7 - Fix the issue of users trying to fire up the application from another
        directory, without cd'ing themselves to the IFMapper directory.
 

data/IFMapper.gemspec

@@ -2,19 +2,19 @@ require "rubygems"
 
 spec = Gem::Specification.new do |spec|
 	spec.name = "ifmapper"
-	spec.version = '0.7'
+	spec.version = '0.8'
 	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.rb'] + 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("icons/*")
 	spec.description = <<-EOF
 	Interactive Fiction Mapping Tool.
 EOF
 	spec.add_dependency("fxruby", ">= 1.2.6")
 	spec.add_dependency("pdf-writer", ">= 1.1.1")
-	spec.extra_rdoc_files = ["HISTORY.txt", "IFMapper.gemspec"]
+	spec.extra_rdoc_files = ["HISTORY.txt", "TODO.txt", "IFMapper.gemspec"]
 	spec.has_rdoc = true
 	spec.rubyforge_project = 'ifmapper'
 	spec.required_ruby_version = '>= 1.6.8'

data/TODO.txt

@@ -0,0 +1,7 @@
+
+- Add SVG output
+- Do Printing
+- Cleanup code (lots of ugly and duplicated code 
+  between PDF/PS output)
+- Improve window scrolling (seems like an FXRuby bug)
+- Add Undo (at least for delete)

data/lib/IFMapper/Connection.rb

@@ -37,6 +37,11 @@ class Connection
     @exitBtext = 0
   end
 
+  def stub?
+    return true unless @roomB
+    return false
+  end
+
   def to_s
     dirA = dirB = ''
     a = @roomA? @roomA.name : 'nil'

data/lib/IFMapper/FXMap.rb

@@ -29,7 +29,8 @@ class FXMap < Map
   attr          :pmap
 
   @@win = nil
-  
+
+  @@tooltip = nil
   @@cursor_arrow = nil
   @@cursor_cross = nil
   @@cursor_n = nil
@@ -41,11 +42,23 @@ class FXMap < Map
   @@cursor_w = nil
   @@cursor_nw = nil
 
-  
+  #
+  # Map has changed dramatically.  Update pathmap, title and redraw
+  #
   def _changed
     create_pathmap
-    update_title
-    draw
+    if @window and @window.shown?
+      update_title
+      draw
+    end
+  end
+
+  #
+  # Fit all rooms in map, adjusting map size if needed
+  #
+  def fit
+    super
+    create_pathmap
   end
 
   #
@@ -54,10 +67,7 @@ class FXMap < Map
   def section=(x)
     super
     @complexConnection = false
-    if @window.shown?
-      create_pathmap
-      update_title
-    end
+    _changed
   end
 
   #
@@ -195,7 +205,7 @@ class FXMap < Map
   #
   def create_pathmap
     # First, create an empty grid of width x height
-    empty_pathmap   # Hmm... needed?  Probably not.
+    empty_pathmap
     # Then, fill it in with all rooms...
     @sections[@section].rooms.each { |r| @pmap[r.x][r.y] = r }
     # And following, add all paths
@@ -356,6 +366,18 @@ class FXMap < Map
   def new_room(x, y)
     @modified = true
     r = @sections[@section].new_room(x, y)
+    @automap.add(r) if @automap
+    return r
+  end
+
+  #
+  # Function used to add a new room. x and y are absolute pixel positions
+  # in canvas.
+  #
+  def new_xy_room(x, y)
+    x = x / WW
+    y = y / HH
+    r = new_room(x, y)
     @pmap[x][y] = r
 
     r.selected = true
@@ -370,16 +392,6 @@ class FXMap < Map
     return r
   end
 
-  #
-  # Function used to add a new room. x and y are absolute pixel positions
-  # in canvas.
-  #
-  def new_xy_room(x, y)
-    x = x / WW
-    y = y / HH
-    return new_room(x, y)
-  end
-
 
   # Given a canvas (mouse) x/y position, return:
   #
@@ -480,10 +492,16 @@ class FXMap < Map
     return nil
   end
 
+  #
+  # Update the map window's title
+  #
   def update_title
     title = @name.dup
     if @navigation
-      title << "     [Read Only]"
+      title << '     [Read Only]'
+    end
+    if @automap
+      title << '     [Automap]'
     end
     title << "      Zoom: %.3f" % @zoom
     title << "      Section #{@section+1} of #{@sections.size}"
@@ -673,13 +691,8 @@ class FXMap < Map
     return unless a # User click outside map
 
     if @options['Create on Connection']
-      unless roomA
-	roomA = new_xy_room( a[0], a[1] )
-      end
-      
-      unless roomB
-	roomB = new_xy_room( b[0], b[1] )
-      end
+      roomA = new_xy_room( a[0], a[1] ) unless roomA
+      roomB = new_xy_room( b[0], b[1] ) unless roomB
     end
 
     return nil unless roomA and roomB
@@ -701,8 +714,10 @@ class FXMap < Map
 	delete_connection(c) if c.roomB == nil
       end
     end
-
-    new_connection( roomA, exitA, roomB )
+    begin
+      new_connection( roomA, exitA, roomB )
+    rescue Section::ConnectionError
+    end
   end
 
   #
@@ -768,6 +783,15 @@ class FXMap < Map
     end
   end
 
+  #
+  # Based on mouse position on canvas, create a tooltip
+  #
+  def update_cb(sender, sel, event)
+    if sel == FXWindow::ID_QUERY_TIP
+      p "tooltip"
+    end
+  end
+
   #
   # Show some help status in status line based on cursor position
   #
@@ -804,18 +828,12 @@ class FXMap < Map
   # to cursor position
   #
   def mousewheel_cb(sender, sel, event)
-#     x = event.last_x / @zoom
-#     y = event.last_y / @zoom
     case event.code
-    when -120
+    when -120   # Hmm, there does not seem to be constants for these
       zoom_out
-    when 120
+    when 120    # Hmm, there does not seem to be constants for these
       zoom_in
     end
-#     x *= @zoom
-#     y *= @zoom
-#     center_view_on_xy(x.to_i, y.to_i)
-#     draw
   end
 
   #
@@ -828,8 +846,7 @@ class FXMap < Map
   end
 
   #
-  # Select all rooms within (drag) rectangle
-  # TODO: Should add connections too
+  # Select all rooms and connections within (drag) rectangle
   #
   def select_rectangle(x1, y1, x2, y2)
     x1, x2 = x2, x1 if x2 < x1
@@ -1013,6 +1030,7 @@ class FXMap < Map
 	rmb_link_menu( submenu, c, a, idx, old_idx )
       }
       FXMenuCascade.new(menu, a.name, nil, submenu)
+      next if not b
       submenu = FXMenuPane.new(@window)
       old_idx = b.exits.rindex(c)
       0.upto(7) { |idx|
@@ -1119,7 +1137,10 @@ class FXMap < Map
     draw(sender, sel, event)
   end
 
-
+  #
+  # Close the map.  Pop up a warning box to allow saving
+  # if map has been modified.
+  #
   def close_cb()
     if @modified
       dlg = FXDialogBox.new( @window.parent, "Warning", 
@@ -1169,21 +1190,28 @@ class FXMap < Map
 	end
       }
       FXButton.new(buttons, "&No", nil, dlg, FXDialogBox::ID_ACCEPT,
-		   FRAME_RAISED|FRAME_THICK|LAYOUT_FILL_X|LAYOUT_RIGHT|LAYOUT_CENTER_Y)
+		   FRAME_RAISED|FRAME_THICK|LAYOUT_FILL_X|
+		   LAYOUT_RIGHT|LAYOUT_CENTER_Y)
       
       # Cancel
       FXButton.new(buttons, "&Cancel", nil, dlg, FXDialogBox::ID_CANCEL,
-		   FRAME_RAISED|FRAME_THICK|LAYOUT_FILL_X|LAYOUT_RIGHT|LAYOUT_CENTER_Y)
+		   FRAME_RAISED|FRAME_THICK|LAYOUT_FILL_X|
+		   LAYOUT_RIGHT|LAYOUT_CENTER_Y)
       yes.setDefault
       yes.setFocus
 
       return false if dlg.execute == 0
     end
+    @automap.destroy if @automap
+    @automap = nil
     @window.close
+    GC.start
     return true
   end
 
-
+  #
+  # Create cursors
+  #
   def _make_cursors
     pix = []
     32.times { 32.times { pix << 255 << 255 << 255 << 255 } }
@@ -1208,6 +1236,9 @@ class FXMap < Map
     @@cursor_cross.create
   end
 
+  #
+  # Create widgets for this map window
+  #
   def _make_widgets
     @scrollwindow = FXScrollWindow.new(@window, 
 				       SCROLLERS_NORMAL|SCROLLERS_TRACK)
@@ -1229,6 +1260,9 @@ class FXMap < Map
 			   LAYOUT_TOP|LAYOUT_LEFT,
     			   0, 0, width, height)
     @dirty = true
+    @canvas.connect(SEL_UPDATE, method(:update_cb))
+    # FXMAPFUNC(SEL_UPDATE, FXWindow::ID_QUERY_TIP, 'tooltip_cb')
+
     @canvas.connect(SEL_PAINT, method(:draw))
     @canvas.backColor = @options['BG Color']
 
@@ -1240,12 +1274,21 @@ class FXMap < Map
     @canvas.connect(SEL_MIDDLEBUTTONRELEASE, method(:mmb_release_cb))
     @canvas.connect(SEL_RIGHTBUTTONPRESS, method(:rmb_click_cb))
     @canvas.connect(SEL_KEYPRESS, method(:keypress_cb))
+
+    if not @@tooltip
+      @@tooltip = FXToolTip.new(@canvas.app, FXToolTip::TOOLTIP_PERMANENT)
+    end
   end
-  
+
+  #
+  # Main constructor.  Create the object, initialize the pathmap
+  # and initialize the widgets and cursors if a parent window is passed.
+  #
   def initialize(name, parent = nil, default_options = nil,
 		 icon = nil, menu = nil, mode = nil, 
 		 x = 0, y = 0, w = 0, h = 0)
     super(name)
+    @automap    = nil
     @navigation = false
     if parent
       @window  = FXMDIChild.new(parent, name, icon, menu, mode, x, y, w, h)
@@ -1290,14 +1333,18 @@ class FXMap < Map
       a = c.roomA
       b = c.roomB
       a[a.exits.index(c)] = nil
-      idx = b.exits.rindex(c)
-      b[idx] = nil if idx
+      if b
+	idx = b.exits.rindex(c)
+	b[idx] = nil if idx
+      end
     }
 
     # Recreate pathmap.  We need to recreate pathmap for all paths
     # as the removal of one path may help shorten the path of another.
     create_pathmap
 
+    @automap.remove(rooms) if @automap
+
     draw()
   end
 
@@ -1349,6 +1396,22 @@ class FXMap < Map
     @modified = true
   end
 
+
+  #
+  # Return the current active room
+  #
+  def current_room
+    rooms = @sections[@section].rooms.find_all { |r| r.selected }
+    return nil if rooms.empty? or rooms.size > 1
+    return rooms[0]
+  end
+
+  def cannot_automap(why)
+    w = FXWarningBox.new(@window, "Cannot automap.\n#{why}")
+    w.execute
+  end
+
+
   #
   # Give user some warning if he tries to modify a read-only mode.
   #
@@ -1357,6 +1420,78 @@ class FXMap < Map
     w.execute
   end
 
+
+  #
+  # Move selected rooms in one of the 8 cardinal directions.
+  #
+  def move_to(idx)
+    return navigation_warning if @navigation
+    selection = @sections[@section].rooms.find_all { |r| r.selected }
+    return if selection.empty?
+    clean_room_selection(selection)
+
+
+    dx, dy = Room::DIR_TO_VECTOR[idx]
+
+    # Check that all nodes can be moved in the specified direction
+    selection.each { |r|
+      x = r.x + dx
+      y = r.y + dy
+      if x < 0 or y < 0 or x >= @width or y >= @height or
+	  @pmap[x][y].kind_of?(Room)
+	store_room_selection(selection)
+	dir = Room::DIRECTIONS[idx]
+	status "Cannot move selection #{dir}."
+	return
+      end
+    }
+    selection.each { |r| 
+      r.x += dx
+      r.y += dy
+    }
+    update_exits(selection)
+    draw
+  end
+
+  #
+  # Move through an exit into another room.  If exit is empty, create
+  # a new neighboring room.
+  #
+  def move_thru(idx)
+    room = current_room
+    return if not room
+    exit = room[idx]
+    if exit
+      room.selected = false
+      if room == exit.roomA
+	roomB = exit.roomB
+	else
+	roomB = exit.roomA
+      end
+      roomB.selected = true
+      draw
+    else
+      return navigation_warning if @navigation
+      x, y = room.x, room.y
+      dx, dy = Room::DIR_TO_VECTOR[idx]
+      x += dx
+      y += dy
+      x = 0 if x < 0
+      y = 0 if y < 0
+      x = @width-1  if x > @width-1
+      y = @height-1 if y > @height-1
+      if not @pmap[x][y].kind_of?(Room)
+	room.selected = false
+	roomB = new_xy_room(x * WW, y * HH)
+	exitB = roomB.next_to?(room)
+	if exitB and roomB.exits[exitB] == nil
+	  new_connection( roomB, exitB, room )
+	end
+	draw
+      end
+    end
+  end
+
   #
   # Handle a keypress
   #
@@ -1394,82 +1529,38 @@ class FXMap < Map
       else
 	complex_connection
       end
+    when KEY_KP_8
+      move_thru(0)
+    when KEY_KP_9
+      move_thru(1)
+    when KEY_KP_6
+      move_thru(2)
+    when KEY_KP_3
+      move_thru(3)
+    when KEY_KP_2
+      move_thru(4)
+    when KEY_KP_1
+      move_thru(5)
+    when KEY_KP_4
+      move_thru(6)
+    when KEY_KP_7
+      move_thru(7)
     when KEY_Up
-      return navigation_warning if @navigation
-      selection = @sections[@section].rooms.find_all { |r| r.selected }
-      return if selection.empty?
-      clean_room_selection(selection)
-      # Check that all nodes can be moved up
-      selection.each { |r|
-	if r.y == 0 or @pmap[r.x][r.y-1].kind_of?(Room)
-	  store_room_selection(selection)
-	  status "Cannot move selection up."
-	  return
-	end
-      }
-      selection.each { |r| 
-	r.y -= 1
-	@pmap[r.x][r.y] = r
-      }
-      update_exits(selection)
-      draw
+      move_to(0)
     when KEY_Down
-      return navigation_warning if @navigation
-      selection = @sections[@section].rooms.find_all { |r| r.selected }
-      return if selection.empty?
-      clean_room_selection(selection)
-      # Check that all nodes can be moved up
-      selection.each { |r|
-	if r.y+1 == @height or @pmap[r.x][r.y+1].kind_of?(Room)
-	  store_room_selection(selection)
-	  status "Cannot move selection down."
-	  return
-	end
-      }
-      selection.each { |r| 
-	r.y += 1
-	@pmap[r.x][r.y] = r
-      }
-      update_exits(selection)
-      draw
+      move_to(4)
     when KEY_Left
-      return navigation_warning if @navigation
-      selection = @sections[@section].rooms.find_all { |r| r.selected }
-      return if selection.empty?
-      # Check that all nodes can be moved up
-      clean_room_selection(selection)
-      selection.each { |r|
-	if r.x == 0 or @pmap[r.x-1][r.y].kind_of?(Room)
-	  store_room_selection(selection)
-	  status "Cannot move selection left."
-	  return
-	end
-      }
-      selection.each { |r| 
-	r.x -= 1
-	@pmap[r.x][r.y] = r
-      }
-      update_exits(selection)
-      draw
+      move_to(6)
     when KEY_Right
-      return navigation_warning if @navigation
-      selection = @sections[@section].rooms.find_all { |r| r.selected }
-      return if selection.empty?
-      # Check that all nodes can be moved up
-      clean_room_selection(selection)
-      selection.each { |r|
-	if r.x+1 == @width or @pmap[r.x+1][r.y].kind_of?(Room)
-	  store_room_selection(selection)
-	  status "Cannot move selection right."
-	  return
-	end
-      }
-      selection.each { |r| 
-	r.x += 1
-	@pmap[r.x][r.y] = r
-      }
-      update_exits(selection)
-      draw
+      move_to(2)
+    when KEY_End
+      move_to(5)
+    when KEY_Home
+      move_to(7)
+    when KEY_Page_Up
+      move_to(1)
+    when KEY_Page_Down
+      move_to(3)
     end
   end
 
@@ -1567,7 +1658,7 @@ class FXMap < Map
   #
   # Draw template of room squares in background
   #
-  def draw_grid(dc, event)
+  def draw_grid(dc, event = nil)
 
     dc.foreground = "black"
     dc.lineWidth  = 0
@@ -1627,36 +1718,63 @@ class FXMap < Map
     }
   end
 
+  #
+  # Draw mapname
+  #
+  def draw_mapname(dc)
+    fontsize = (24 * @zoom).to_i
+    font = FXFont.new(@window.getApp, @options['Font Text'], fontsize)
+    font.create
+
+    x = @width * WW / 2.0 - @name.size * 24
+    dc.drawText(x, 30, @name)
+  end
+
   #
   # Print map
   #
   def print(printer)
     # dc = FXDCPrint.new(@window.getApp)
+    require 'IFMapper/MapPrinting'
     require 'IFMapper/FXDCPostscript'
     oldzoom = @zoom
     oldsection = @section
+    self.zoom = 1.0
+
+    num = pack_sections( @width, @height )
+    puts "Would pack #{@sections.size} into #{num} pages."
     begin
       dc = FXDCPostscript.new(@window.getApp)
       xmax = @width  * WW
       ymax = @height * HH
-      @zoom = 1.0
       dc.setContentRange(0, 0, xmax, ymax)
       dc.beginPrint(printer) {
+	page = -1
 	0.upto(@sections.size-1) { |p|
 	  self.section = p
 	  clear_selection
-	  dc.beginPage(p+1) {
-	    dc.lineCap = CAP_ROUND
-	    draw_connections(dc)
-	    draw_rooms(dc)
-	  }
+	  if page != sect.page
+	    dc.beginPage(sect.page)
+	    draw_mapname( dc )
+	  end
+
+	  dc.lineCap = CAP_ROUND
+	  # draw_grid(dc)
+	  draw_connections(dc)
+	  draw_rooms(dc)
+
+	  if page != sect.page
+	    page = sect.page
+	    dc.endPage()
+	  end
 	}
       }
     rescue => e
       status "#{e}"
     end
     self.section = oldsection
-    @zoom = oldzoom
+    self.zoom = oldzoom
+    draw
   end
 
   #
@@ -1693,7 +1811,9 @@ class FXMap < Map
   end
 
 
-
+  #
+  # Perform the actual saving of the map
+  #
   def _save
     if @complexConnection
       # If we have an incomplete connection, remove it
@@ -1721,6 +1841,9 @@ class FXMap < Map
     return true
   end
 
+  #
+  # Save the map.  If the map's filename is not defined, call save_as
+  #
   def save
     unless @filename
       save_as
@@ -1729,6 +1852,9 @@ class FXMap < Map
     end
   end
 
+  #
+  # Save the map under a new filename, bringing up a filerequester
+  #
   def save_as
     file = FXMapFileDialog.new(@window, "Save Map #{@name}").filename
     if file != ''
@@ -1738,7 +1864,9 @@ class FXMap < Map
     return false
   end
 
-  
+  #
+  # Open the map's property window
+  #
   def properties
     if not @@win
       @@win = FXMapDialogBox.new(@window)
@@ -1747,4 +1875,31 @@ class FXMap < Map
     @@win.show
   end
 
+  def stop_automap
+    return unless @automap
+    @automap.destroy
+    @automap = nil
+    GC.start
+    update_title
+  end
+
+  def start_automap
+    if @automap
+      stop_automap
+    end
+
+    file = FXMapFileDialog.new(@window, "Load Transcript", 
+			       [
+				 "Transcript File (*.log)",
+				 "All Files (*)"
+			       ]).filename
+    return if file == ''
+    require 'IFMapper/TranscriptReader'
+    @automap = TranscriptReader.new(self, file)
+    @automap.start
+    create_pathmap
+    draw
+    update_title
+  end
+
 end