ifmapper 0.9.5 → 0.9.6

data/lib/IFMapper/TADSReader.rb

@@ -11,6 +11,74 @@ class TADSReader
   class ParseError < StandardError; end
   class MapError < StandardError; end
 
+
+  # TADS 3 directional properties need to be spelled fully
+  DIRECTIONS = { 
+    'north' => 0,
+    'northeast' => 1,
+    'east' => 2,
+    'southeast' => 3,
+    'south' => 4,
+    'southwest' => 5,
+    'west' => 6,
+    'northwest' => 7,
+    'up' => 8,
+    'down' => 9,
+    'in' => 10,
+    'out' => 11
+  }
+
+  FUNCTION = /^\[ (\w+);/
+
+  GO_OBJ = /\b(#{DIRECTIONS.keys.join('|').gsub(/_to/, '_obj')})\s*:/i
+
+  # SINGLE QUOTED STRING
+  SQ = '((?:\\\\\'|[^\'])+)'
+
+  # DOUBLE QUOTED STRING
+  DQ = '((?:\\\"|[^"])+)'
+
+  # Equal sign (TADS supports C or Pascal-like =)
+  EQ = '\s*(?:=|\:=)\s*'
+
+  # Direction list in order of positioning preference.
+  DIRLIST = [ 0, 4, 2, 6, 1, 3, 5, 7 ]
+
+  DIR_EQ     = "(#{DIRECTIONS.keys.join('|')})#{EQ}"
+  DIR_TO     = /(?:^|\s+)#{DIR_EQ}/
+  DIR        = /(?:^|\s+)#{DIR_EQ}(\w+)/
+  DIR_OPEN   = /(?:^|\s+)#{DIR_EQ}\(\s*[\d\w]+\.isOpen\s*\?\s*([\d\w]+)/
+  DIR_INSELF = /(?:^|\s+)#{DIR_EQ}\(\s*[\d\w]+\.isIn\(\s*self\s*\)\s*\?\s*([\d\w]+)/
+  DIR_MSG    = /(?:^|\s+)(#{DIRECTIONS.keys.join('|')})\s*\:\s*TravelMessage\s*\{\s*\->\s*(\w+)/
+
+  ENTER_DIR = //i # needed?
+
+  OBJLOCATION = /(?:^|\s+)(?:(?:destination|location)#{EQ}(\w+)|@(\w+)|locationList#{EQ}\[([\w\s,]+)\])/
+  OBJNAME     = /(?:^|\s+)name#{EQ}(?:'#{SQ}'|\(\s*described\s*\?\s*'#{SQ}')/
+  CONNECTOR   = /(?:^|\s+)room\d+\s*#{EQ}\s*(\w+)/
+  ROOMNAME    = /(?:^|\s+)roomName#{EQ}'#{SQ}'/
+  DESCRIPTION = /(?:^|\s+)desc#{EQ}(?:\s*$|\s+"#{DQ}?("?))/
+
+
+  # TADS3 template definitions are like:
+  #  [+] [TAG:] Classes ['adjective nouns'] 'Name' @location
+  PLUS = '\s*([\+]+\s*)?'
+  TAG  = '(?:([\w\d]+)\s*:)?\s*'
+  CLS  = '([\w\s\-\>,]+)'
+  NOMS = "(?:\'#{SQ}\')?"
+  NAME = "(?:\s+\'#{SQ}\')?"
+  LOC  = '\s+(?:@([\d\w]+))?'
+
+  CLASS       = /^class\s+(\w+)\s*:\s*([\w,\s]+)/i
+  DOOR        = /(?:^|\s+)door_to(?:\s+([^,;]*)|$)/i
+  INCLUDE     = /^#include\s+[<"]([^">]+)[">]/
+
+  STD_LIB = [
+    'adv3.h',
+    'en_us.h',
+  ]
+
+
   # Take a quoted TADS string and return a valid ASCII one, replacing
   # TADS's special characters.
   def self.unquote(text)
@@ -63,6 +131,9 @@ class TADSReader
     def to_s
       "#@name tag:#@tag"
     end
+    def num_exits
+      return @exits.nitems
+    end
     def name=(x)
       @name = TADSReader::unquote(x)
     end
@@ -75,47 +146,6 @@ class TADSReader
     end
   end
 
-  # TADS 3 directional properties need to be spelled fully
-  DIRECTIONS = { 
-    'north' => 0,
-    'northeast' => 1,
-    'east' => 2,
-    'southeast' => 3,
-    'south' => 4,
-    'southwest' => 5,
-    'west' => 6,
-    'northwest' => 7,
-    'up' => 8,
-    'down' => 9,
-    'in' => 10,
-    'out' => 11
-  }
-
-  FUNCTION = /^\[ (\w+);/
-
-  GO_OBJ = /\b(#{DIRECTIONS.keys.join('|').gsub(/_to/, '_obj')})\s*:/i
-
-  # SINGLE QUOTED STRING
-  SQ = '((?:\\\'|[^\'])+)'
-
-  # DOUBLE QUOTED STRING
-  DQ = '((?:\\\"|[^"])+)'
-
-  # Equal sign (TADS supports C or Pascal-like =)
-  EQ = '\s*(?:=|\:=)\s*'
-
-  # Direction list in order of positioning preference.
-  DIRLIST = [ 0, 4, 2, 6, 1, 3, 5, 7 ]
-
-  DIR_TO    = /(?:^|\s+)(#{DIRECTIONS.keys.join('|')})#{EQ}/
-  DIR       = /(?:^|\s+)(#{DIRECTIONS.keys.join('|')})#{EQ}(\w+)/
-  ENTER_DIR = //i # needed?
-
-  OBJLOCATION = /(?:^|\s+)(?:(?:destination|location)#{EQ}(\w+)|@(\w+)|locationList#{EQ}\[([\w\s,]+)\])/
-  OBJNAME     = /(?:^|\s+)name#{EQ}'#{SQ}'/
-  CONNECTOR   = /(?:^|\s+)room\d+\s*#{EQ}\s*(\w+)/
-  ROOMNAME    = /(?:^|\s+)roomName#{EQ}'#{SQ}'/
-  DESCRIPTION = /(?:^|\s+)desc#{EQ}(?:\s*$|\s+"#{DQ}?("?))/
 
   attr_reader :map
 
@@ -167,7 +197,7 @@ class TADSReader
       full_line = @line.dup
       begin
 	parse_line
-      rescue ParseError => e
+      rescue ParseError, MapError => e
 	$stderr.puts
 	$stderr.puts "#{e} at #{file.path}, line #{line_number}:"
 	$stderr.puts ">>>> #{full_line};"
@@ -178,15 +208,6 @@ class TADSReader
   end
 
 
-  CLASS       = /^class\s+(\w+)\s*:\s*([\w,\s]+)/i
-  DOOR        = /(?:^|\s+)door_to(?:\s+([^,;]*)|$)/i
-  INCLUDE     = /^#include\s+[<"]([^">]+)[">]/
-
-  STD_LIB = [
-    'adv3.h',
-    'en_us.h',
-  ]
-
 
   def new_room
     # We assume we are a room (albeit we could be an obj)
@@ -263,15 +284,20 @@ class TADSReader
     #
     # Handle room description
     #
-    if @in_desc == 1 and @line =~ /\s*"#{DQ}("\s*)?/
-      # check for possible start description
-      @room.desc << $1
-      if $2
-	@in_desc = nil
-      else
-	@in_desc = 2
+    if @in_desc == 1 then
+      if @line =~ /^\s*"#{DQ}("\s*)?$/
+	# check for possible start description
+	@room.desc << $1
+	if $2
+	  @in_desc = nil
+	else
+	  @in_desc = 2
+	end
+	return
+      elsif @room.name == @room.tag and @line =~ /^\s*#{NOMS}#{NAME}\s*/
+	name = $1 || $2
+	@room.name = name
       end
-      return
     end
 
     if @in_desc == 2
@@ -284,13 +310,7 @@ class TADSReader
 
     # TADS3 definition is like:
     #  [+] [TAG:] Classes ['adjective nouns'] 'Name' @location
-    plus = '\s*([\+]+\s*)?'
-    tag  = '(?:(\w+)\s*:)?\s*'
-    cls  = '([\w\s\-\>,]+)'
-    noms = "(?:\'#{SQ}\'\s+)?"
-    name = "(?:\'#{SQ}\')?"
-    loc  = '\s+(?:@(\w+))?'
-    re = /^#{plus}#{tag}#{cls}#{noms}#{name}#{loc}/
+    re = /^#{PLUS}#{TAG}#{CLS}#{NOMS}#{NAME}#{LOC}/
     if @line =~ re
 
       prev  = $1
@@ -329,7 +349,7 @@ class TADSReader
 	@obj.tag = @tag
 	@tags[@tag] = @obj
 	@doors << @obj
-      elsif @clas =~ /\b(?:(?:Hidden|Secret)?Door|ThroughPassage|Stairway(?:Up|Down))\b/
+      elsif @clas =~ /\b(?:(?:Hidden|Secret)?Door|ThroughPassage|PathPassage|TravelWithMessage|Stairway(?:Up|Down))\b/
 	@desc = ''
 	@name = @name[0] || @name[1]
 	@tag  = @name if not @tag
@@ -353,10 +373,12 @@ class TADSReader
 	  @tags[@tag] = @obj
 	  @doors << @obj
 	end
+	@obj.connector = true if @clas =~ /Passage|Stairway/
       elsif @clas =~ /\b(?:Thing|Food|Person)\b/
 	@obj = nil
 	@desc = ''
 	@name = @name[0] || @name[1]
+	@name = '' if @name =~ /\//
 	@tag  = @name if not @tag
 	new_obj(loc) if @tag
       else
@@ -374,7 +396,12 @@ class TADSReader
     end
 
     if @obj
-      @obj.name      = $1 if @line =~ OBJNAME
+
+      if @obj.name == '' and @line =~ /^\s*#{NOMS}#{NAME}\s*$/
+	name = $2 || $1
+	@obj.name = name
+      end
+      @obj.name = $1 || $2 if @line =~ OBJNAME
       if @line =~ OBJLOCATION
 	if $1
 	  locs = $1.split(/\s*,\s*/)
@@ -394,10 +421,11 @@ class TADSReader
       @in_desc = 2 if $2 == ''
     end
 
-    dirs = @line.scan(DIR_TO) + @line.scan(DIR) # + @line.scan(ENTER_DIR)
+    # dirs = @line.scan(DIR_TO) + @line.scan(DIR) + @line.scan(DIR_MSG)
+    dirs = @line.scan(DIR) + @line.scan(DIR_MSG) + @line.scan(DIR_OPEN) + @line.scan(DIR_INSELF)
     if dirs.size > 0
       dirs.each { |d, room|
-	next if room == 'nil'
+	next if not room or room == 'nil' or room == 'noTravel'
 	dir = DIRECTIONS[d]
 	@room.exits[dir] = room
       }
@@ -520,23 +548,30 @@ class TADSReader
     return best
   end
 
-  def make_room(from, to, x, y, dx = 1, dy = 0 )
+  def make_room(to, x, y, dx = 1, dy = 0)
+    if not @map.free?(x, y)
+      @map.shift(x, y, dx, dy)
+    end
+    room = @map.new_room(x, y)
+    room.name = to.name
+    desc = to.desc
+    desc.gsub!(/[\t\n]/, ' ')
+    desc.squeeze!(' ')
+    room.desc     = TADSReader::unquote(desc)
+    room.darkness = !to.light
+    @tags[to.tag] = room
+    return room
+  end
+
+  def get_exit(from, to, x, y, dx = 1, dy = 0 )
     elem = @tags[to.tag]
     if elem.kind_of?(TADSRoom)
-      if not @map.free?(x, y)
-	@map.shift(x, y, dx, dy)
-      end
-      room = @map.new_room(x, y)
-      room.name     =  to.name
-      desc = to.desc
-      desc.gsub!(/[\t\n]/, ' ')
-      desc.squeeze!(' ')
-      room.desc     = TADSReader::unquote(desc)
-      room.darkness = !to.light
-      @tags[to.tag] = room
+      room = create_room(to, x, y, dx, dy)
       return [room, Connection::FREE]
     elsif elem.kind_of?(TADSDoor)
-      if elem.locked
+      if elem.connector
+	type = Connection::FREE
+      elsif elem.locked
 	type = Connection::LOCKED_DOOR
       else
 	type = Connection::CLOSED_DOOR
@@ -547,8 +582,8 @@ class TADSReader
 	o.exits.each { |e|
 	  next unless e
 	  if @tags[e] == elem
-	    res = make_room( o, o, x, y, dx, dy )
-	    return [ res[0], type ]
+	    res = create_room( o, x, y, dx, dy )
+	    return [ res, type ]
 	  end
 	}
       }
@@ -558,21 +593,22 @@ class TADSReader
 	next if @tags[tag] == from
 	@rooms.each { |o|
 	  next if o.tag != tag
-	  res = make_room( o, o, x, y, dx, dy )
-	  return [ res[0], type ]
+	  res = create_room( o, x, y, dx, dy )
+	  return [ res, type ]
 	}
       }
       
-      #raise "error: no room with door #{to.name} #{elem.name}"
+      #raise MapError, "error: no room with door #{to.name} #{elem.name}"
       return [nil, nil]
     else
       return [elem, Connection::FREE]
     end
   end
 
-  def create_room(r, x, y, dx = 1, dy = 0)
-    from, = make_room(r, r, x, y)
-    debug "CREATE ROOM #{r.name} TAG:#{r.tag} SET FROM TO: #{from}"
+  def create_room(r, x, y, dx = 2, dy = 0)
+    return @tags[r.tag] if @tags[r.tag].kind_of?(Room)
+    from, = make_room(r, x, y, dx, dy)
+    debug "CREATE ROOM #{r.name} TAG:#{r.tag}"
 
     r.exits.each_with_index { |e, exit|
       next unless e
@@ -582,7 +618,10 @@ class TADSReader
       to = @tags[e]
       if not to
 	next if @functions.include?(e)
-	raise "Room #{e} #{e.class} not found." if not to
+	if not to
+	  $stderr.puts "Exit to #{e} (#{e.class}) not found, ignored." 
+	  next
+	end
       end
 
       go = c = nil
@@ -615,14 +654,13 @@ class TADSReader
 	x = from.x + dx
 	y = from.y + dy
 	debug "#{exit} CREATE TO #{from} -> #{to.tag}"
-	to, type = make_room(from, to, x, y, dx, dy)
+	to, type = get_exit(from, to, x, y, dx, dy)
 	next if not to
       end
 
       if exit > 7
 	# choose a dir for up/down/in/out
 	go = exit - 7
-	p "GO: #{go} choose_dir"
 	dir = choose_dir(from, to, go)
       end
 
@@ -696,14 +734,20 @@ class TADSReader
       end
     }
 
-    return r
+    return from
   end
 
   #
   # Create all the stuff we found
   #
   def create
-    @rooms.each { |r| create_room(r, 0, 0) }
+    @rooms = @rooms.sort_by { |r| r.num_exits }
+    @rooms.reverse!
+
+    @rooms.each { |r| 
+      min, max = @map.sections[@map.section].min_max_rooms
+      create_room(r, max[0] + 2, 0)
+    }
     @rooms = []
     
     # Add objects to rooms
@@ -758,7 +802,21 @@ class TADSReader
     return false
   end
 
-
+  def parse_makefile(file)
+    dir = File.dirname(file)
+    files = []
+    File.foreach(file) { |line|
+      if line =~ /-source\s*([^\s]+)/
+	f = $1
+	if f !~ /^(?:[A-Z]:|\/)/
+	  f = dir + '/' + f
+	end
+	files << "#{f}.t"
+      end
+    }
+    
+    return files
+  end
 
   def set_include_dirs
     # Try to find t3make(.exe) in path.
@@ -796,13 +854,23 @@ class TADSReader
       return unless properties
     end
 
-    debug "Start parsing #{file}"
-    File.open(file) { |f|
-      parse(f)
+
+    if file =~ /.t3m/
+      files = parse_makefile(file)
+    else
+      files = file
+    end
+
+    files.each_with_index { |file, idx|
+      debug "Start parsing #{file}"
+      File.open(file) { |f|
+	parse(f)
+      }
+      debug "Done parsing #{file}"
     }
-    debug "Done parsing #{file}"
+
     puts "Rooms: #{@rooms.size}"
-    puts "Doors: #{@doors.size}"
+    puts "Doors/Connectors: #{@doors.size}"
     puts "Objects: #{@objects.size}"
 
     create
@@ -810,7 +878,6 @@ class TADSReader
 
     if @map.kind_of?(FXMap)
       @map.filename   = file.sub(/\.t$/i, '.map')
-      @map.navigation = true
       @map.options['Location Description'] = true
       @map.window.show
     end

data/lib/IFMapper/TranscriptDialogBox.rb

@@ -1,24 +1,62 @@
 
 class TranscriptDialogBox < FXDialogBox
 
+  EXPLANATION_TEXT = [
+"Classic Mode expects a short name description for all
+locations, where all words of 5 or more characters to are
+capitalized and where there is no period.  
+Commands always begin with a > prompt.",
+"Capitalized Mode expects a short name description for all
+locations, where only the first word needs to be capitalized
+and there is no period.  
+Commands always begin with a > prompt.",
+"Moonmist mode describes locations in parenthesis, with 'You
+are...' prefixed and a period at the end, inside the parenthesis.
+Commands always begin with a > prompt.",
+"Witness mode expects locations described as normal prose, using
+'You are...' as an introductory paragraph.  When in brief mode, 
+locations are expected to be in parenthesis.
+Commands always begin with a > prompt.",
+"ADRIFT mode expects locations to be like in Classic Mode (short
+names where all words of 5 or more characters are capitalized).
+However, commands do not begin with any type of prompt but start
+with a lowercase word without any margin.",
+]
+
   LOCATION_TEXT = [
 "
+> look
 West of House
 You are standing in an open field west of a white house, with a boarded
 front door.
 ",
 "
+> look
+Women's change room
+Your heels click loudly on the tiles, echoing down the banks of lockers
+that line the sides of the room.
+",
+"
+> look
 (You are now in the driveway.)
 (You're sitting in the sports car.)
 You are by the front gate of the Tresyllian Castle. You can hear the ocean
 beating urgently against the rocks far below.
 ",
 "
+> look
 You are now in the driveway entrance.
-You are standing at the foot of the driveway, the entrance to the Linder
-property. The entire lot is screened from the street and the neighbors by
-a wooden fence, except on the east side, which fronts on dense 
-bamboo woods.
+You are standing at the foot of the driveway, the entrance to the
+Linder property. The entire lot is screened from the street and the 
+neighbors by a wooden fence, except on the east side, which fronts on 
+dense bamboo woods.
+",
+"
+look
+Front of Mall
+    Although four-wheeled vehicles do pass through, this autonomous 
+spot of pavement is too narrow a place for them to stall.  It is just 
+right for bicycles and motorbikes such as yours.
 ",
   ]
 
@@ -27,10 +65,16 @@ bamboo woods.
 West of House
 ",
 "
+Women's change room
+",
+"
 (You are in the driveway.)
 ",
 "
 (driveway entrance)
+",
+"
+Front of Mall
 ",
   ]
 
@@ -41,14 +85,17 @@ West of House
 
   SHORTNAME_TYPE = [
     'Classic',
-    'Moonmist Style',
-    'Witness Style',
+    'Capitalized',
+    'Moonmist',
+    'Witness',
+    'ADRIFT',
   ]
 
   def copy_from(transcript)
     @transcript = transcript
     @type.currentNo  = transcript.identify
     @short.currentNo = transcript.shortName
+    @exp.text  = EXPLANATION_TEXT[@short.currentNo]
     @show.text = LOCATION_TEXT[@short.currentNo]
     @show2.text = LOCATION2_TEXT[@short.currentNo]
     parent = transcript.map.window
@@ -57,6 +104,7 @@ West of House
   def copy_to()
     @transcript.identify  = @type.currentNo
     @transcript.shortName = @short.currentNo
+    @exp.text  = EXPLANATION_TEXT[@short.currentNo]
     @show.text  = LOCATION_TEXT[@short.currentNo]
     @show2.text = LOCATION2_TEXT[@short.currentNo]
   end
@@ -76,6 +124,17 @@ West of House
 				    FRAME_SUNKEN|FRAME_THICK|
 				    LAYOUT_FILL_X|LAYOUT_FILL_Y)
 
+    frame = FXHorizontalFrame.new(mainFrame, LAYOUT_SIDE_TOP|LAYOUT_FILL_X)
+    FXLabel.new(frame, "Transcript Style: ", nil, 0, LAYOUT_FILL_X)
+    pane = FXPopup.new(self)
+    SHORTNAME_TYPE.each { |t|
+      FXOption.new(pane, t, nil, nil, 0, JUSTIFY_HZ_APART|ICON_AFTER_TEXT)
+    }
+    @short = FXOptionMenu.new(frame, pane, FRAME_RAISED|FRAME_THICK|
+			      JUSTIFY_HZ_APART|ICON_AFTER_TEXT|
+			      LAYOUT_CENTER_X|LAYOUT_CENTER_Y)
+
+
     frame = FXHorizontalFrame.new(mainFrame, LAYOUT_SIDE_TOP|LAYOUT_FILL_X)
     FXLabel.new(frame, "Identify Locations: ", nil, 0, LAYOUT_FILL_X)
     pane = FXPopup.new(self)
@@ -87,20 +146,19 @@ West of House
 			     LAYOUT_CENTER_X|LAYOUT_CENTER_Y)
 
 
-    frame = FXHorizontalFrame.new(mainFrame, LAYOUT_SIDE_TOP|LAYOUT_FILL_X)
-    FXLabel.new(frame, "Short Name Type: ", nil, 0, LAYOUT_FILL_X)
-    pane = FXPopup.new(self)
-    SHORTNAME_TYPE.each { |t|
-      FXOption.new(pane, t, nil, nil, 0, JUSTIFY_HZ_APART|ICON_AFTER_TEXT)
-    }
-    @short = FXOptionMenu.new(frame, pane, FRAME_RAISED|FRAME_THICK|
-			      JUSTIFY_HZ_APART|ICON_AFTER_TEXT|
-			      LAYOUT_CENTER_X|LAYOUT_CENTER_Y)
+
+    frame = FXVerticalFrame.new(mainFrame, LAYOUT_SIDE_TOP|LAYOUT_FILL_X)
+    FXLabel.new(frame, "Explanation: ", nil, 0, LAYOUT_FILL_X)
+    @exp  = FXText.new(frame, nil, 0, LAYOUT_FILL_X|LAYOUT_FILL_Y)
+    @exp.visibleRows = 4
+    @exp.visibleColumns = 60
+    @exp.backColor = mainFrame.backColor
+    @exp.disable
 
     frame = FXVerticalFrame.new(mainFrame, LAYOUT_SIDE_TOP|LAYOUT_FILL_X)
     FXLabel.new(frame, "Sample Verbose Mode: ", nil, 0, LAYOUT_FILL_X)
     @show  = FXText.new(frame, nil, 0, LAYOUT_FILL_X|LAYOUT_FILL_Y)
-    @show.visibleRows = 7
+    @show.visibleRows = 9
     @show.visibleColumns = 60
     @show.disable
     FXLabel.new(frame, "Sample Brief Mode: ", nil, 0, LAYOUT_FILL_X)