ifmapper 0.9.8 → 0.9.9

data/HISTORY.txt

@@ -1,3 +1,10 @@
+v0.9.9  Improvements:
+	- It is now possible to export maps in Inform 7 new (beta) syntax,
+	  albeit the English grammar is still very limited.
+	  Just name your map with extension ".inform" instead of ".inf"
+	  when saving it or exporting it.
+	- Bug fixed wrap_text() in all exporters.
+
 v0.9.8  Bug fixes:
 	- TADS Exporter was incorrectly recognizing locations with "room" in
 	  them as keywords and adding numbers to their tags.  Fixed.

data/lib/IFMapper/FXMap.rb

@@ -2014,7 +2014,20 @@ class FXMap < Map
   #
   # Export map as a set of Inform source code files
   #
-  def export_inform(file)
+  def export_inform7(file)
+    require 'IFMapper/Inform7Writer'
+    file.sub!(/.inform$/, '')
+    Inform7Writer.new(self, file)
+  end
+
+  #
+  # Export map as a set of Inform source code files
+  #
+  def export_inform(file, version = 6)
+    if file =~ /\.inform$/ or version > 6
+      return export_inform7(file)
+    end
+
     require 'IFMapper/InformWriter'
     file.sub!(/(-\d+)?\.inf/, '')
     InformWriter.new(self, file)
@@ -2032,7 +2045,7 @@ class FXMap < Map
       end
 
       case file
-      when /\.inf$/
+      when /\.inform$/, /\.inf$/
 	export_inform(file)
       when /\.ifm$/
 	export_ifm(file)

data/lib/IFMapper/FXMapperWindow.rb

@@ -9,7 +9,7 @@ end
 def no_fox
   $stderr.puts "Please install the FXRuby (FOX) library v1.2 or later."
   if $rubygems
-    $stderr.puts "You can usually do so if you do 'gem install fxruby'."
+    $stderr.puts "You can usually do so if you do 'gem install -r fxruby'."
   end
   exit(1)
 end
@@ -17,7 +17,7 @@ end
 def get_fox
   ##### ARRRGH!!!! Why does Lyle keep changing the fxruby name on each
   ##### release!
-  foxes = [ 'fox14', 'fox12', 'fox' ]
+  foxes = [ 'fox16', 'fox14', 'fox12', 'fox' ]
   foxes.each { |fox|
     begin
       require "#{fox}"
@@ -128,6 +128,9 @@ class FXMapperWindow < FXMainWindow
     map.start_automap
   end
 
+  #
+  # Properties of the automapper callback
+  #
   def automap_properties_cb(sender, sel, ptr)
     map = current_map
     return if not map or not map.automap
@@ -143,6 +146,10 @@ class FXMapperWindow < FXMainWindow
     map.stop_automap
   end
 
+
+  #
+  # Callback to Open File
+  #
   def open_cb(sender, sel, ptr)
     file = FXMapFileDialog.new(self, "Load New Map").filename
     return if file == ''
@@ -216,10 +223,16 @@ class FXMapperWindow < FXMainWindow
     status "Loaded '#{file}'."
   end
 
+  #
+  # Write a message to the status bar
+  #
   def status(msg)
     @statusbar.statusLine.text = msg
   end
 
+  #
+  # Returns current active map or nil if no maps
+  #
   def current_map
     window = @mdiclient.activeChild
     return nil unless window
@@ -230,18 +243,27 @@ class FXMapperWindow < FXMainWindow
     return nil
   end
 
+  #
+  # Callback for Save
+  #
   def save_cb(sender, sel, ptr)
     map = current_map
     return unless map
     map.save
   end
 
+  #
+  # Callback for Save As
+  #
   def save_as_cb(sender, sel, ptr)
     map = current_map
     return unless map
     map.save_as
   end
 
+  #
+  # Callback used to create new map
+  #
   def new_map_cb(*args)
     m = new_map
     m.window.create
@@ -275,7 +297,9 @@ class FXMapperWindow < FXMainWindow
     return map
   end
 
+  #
   # Load the named PNG icon from a file
+  #
   def load_icon(filename)
     begin
       filename = File.join("icons", filename) + ".png"
@@ -358,7 +382,7 @@ class FXMapperWindow < FXMainWindow
 
     d = FXMapFileDialog.new(self, "Save Map as Inform Files", 
 			    [
-			      "Inform Source Code (*.inf)"
+			      "Inform Source Code (*.inf,*.inform)",
 			    ])
     map.export_inform( d.filename ) if d.filename != ''
   end

data/lib/IFMapper/FXRoomList.rb

@@ -51,7 +51,7 @@ class FXRoomList < FXDialogBox
     end
 
     rooms.each { |r|
-      item = "#{r[0]}\t#{r[1].name}"
+      item = "#{r[0] + 1}\t#{r[1].name}"
       @box.appendItem(item, nil, nil, r)
     }
 

data/lib/IFMapper/Inform7Writer.rb

@@ -0,0 +1,496 @@
+
+
+class Inform7Writer
+
+
+  DIRECTIONS = [
+    'North',
+    'Northeast',
+    'East',
+    'Southeast',
+    'South',
+    'Southwest',
+    'West',
+    'Northwest',
+  ]
+
+  OTHERDIRS = [
+    '',
+    'Above',
+    'Below',
+    'Inside',
+    'Outside',
+  ]
+
+  IGNORE_WORDS = [
+    'a', 'the', 'and', 'of', 'your', 'to'
+  ]
+
+  IGNORED_ARTICLES = /^(?:#{IGNORE_WORDS.join('|')})$/
+
+
+
+  KEYWORDS = [
+    'include',
+    'has',
+    'with',
+    'is',
+    'in',
+    'inside',
+  ]
+  INVALID_KEYWORD = /\b(?:#{KEYWORDS.join('|')})\b/i
+
+
+  LOCATION_NAMES = [
+    'door',
+    'include',
+    'room',
+    'has',
+    'with',
+    'is',
+    'container',
+  ] + DIRECTIONS
+  INVALID_LOCATION_NAME = /^(?:#{LOCATION_NAMES.join('|')})$/i
+
+
+  #
+  # Some common animals in adventure games
+  #
+  ANIMALS = [
+    'horse',
+    'donkey',
+    'mule',
+    'goat',
+    # lizards
+    'lizard',
+    'snake',
+    'turtle',
+    # fishes
+    'fish',
+    'dolphin',
+    'whale',
+    'tortoise',
+    # dogs
+    'dog',
+    'wolf',
+    # cats
+    'cat',
+    'leopard',
+    'tiger',
+    'lion',
+    # fantastic
+    'grue',
+    # birds
+    'bird',
+    'pigeon',
+    'peacock',
+    'eagle',
+  ]
+
+  IS_ANIMAL = /\b(?:#{ANIMALS.join('|')})\b/i
+
+  PEOPLE = [
+    'child',
+    'girl',
+    'woman',
+    'lady',
+    'boy',
+    'man',
+    'attendant',
+    'doctor',
+    'engineer',
+    'bum',
+    'nerd',
+    'ghost',
+  ]
+
+  IS_PERSON = /\b(?:#{PEOPLE.join('|')})\b/i
+
+  #
+  # Some common container types
+  #
+  CONTAINERS = [
+    'box',
+    'cup',
+    'crate',
+    'tin',
+    'can',
+    'chest',
+    'wardrobe',
+    'trophy case',
+    'coffin',
+    'briefcase',
+    'suitcase',
+    'bag',
+  ]
+  IS_CONTAINER = /\b(?:#{CONTAINERS.join('|')})\b/i
+
+  #
+  # Some common wearable types
+  #
+  CLOTHES = [
+    'cape',
+    'glove',
+    'jeans',
+    'trousers',
+    'hat',
+    'gown',
+    'backpack',
+    'shirt',
+    'ring',
+    'bracelet',
+    'amulet',
+    'locket',
+  ]
+  IS_WEARABLE = /\b(?:#{CLOTHES.join('|')})\b/i
+
+  #
+  # Some common supporter types
+  #
+  SUPPORTERS = [
+    'table',
+    'shelf',
+  ]
+  IS_SUPPORTER = /\b(?:#{SUPPORTERS.join('|')})\b/i
+
+  #
+  # Some common edible types
+  #
+  FOOD = [
+    'bread',
+    'cake',
+    # drinks
+    'water',
+    'soda',
+    'beer',
+    'beverage',
+    'potion',
+    # fruits
+    'fruit',
+    'apple',
+    'orange',
+    'banana',
+    'almond',
+    'nut',
+  ]
+  IS_EDIBLE = /\b(?:#{FOOD.join('|')})\b/i
+
+  def new_tag(elem, str)
+    tag = str.dup
+
+    # Remove redundant spaces
+    tag.sub!(/^\s/, '')
+    tag.sub!(/\s$/, '')
+
+    # Invalid tag characters, replaced with _
+    tag.gsub!(/[\s"\\\#\,\.:;!\?\n\(\)]+/,'_')
+    tag.sub!(/^([\d]+)_?(.*)/, '\2\1')   # No numbers allowed at start of tag
+
+    tag.gsub!(/__/, '_')
+
+    tag.upcase!  # All tags are uppercase
+
+    # tag cannot be repeated and cannot be keyword (Doorway, Room, etc)
+    # In those cases, we add a number to the tag name.
+    idx = 0
+    if @tags.values.include?(tag) or tag =~ INVALID_LOCATION_NAME
+      idx = 1
+    end
+
+
+
+    if idx > 0
+      root = tag.dup
+      tag = "#{root}#{idx}"
+      while @tags.values.include?(tag)
+	tag = "#{root}#{idx}"
+	idx += 1
+      end
+    end
+
+
+    if elem.kind_of?(String)
+      @tags[tag] = tag
+    else
+      @tags[elem] = tag
+    end
+    return tag
+  end
+
+  def get_tag(elem, name = elem.name)
+    return @tags[elem] if @tags[elem]
+    return new_tag(elem, name)
+  end
+
+  def get_door_name(e)
+    dirA  = e.roomA.exits.index(e)
+    dirB  = e.roomB.exits.rindex(e)
+    name  = DIRECTIONS[dirA].downcase + "-" + DIRECTIONS[dirB].downcase
+    name << " door"
+  end
+
+  def get_door_tag(e)
+    get_tag(e, get_door_name(e))
+  end
+
+  def wrap_text(text, width = 75, indent = 78 - width)
+    return 'UNDER CONSTRUCTION' if not text or text == ''
+    str = inform_quote( text.dup )
+
+    if str.size > width
+      r   = ''
+      while str
+	idx = str.rindex(/[ -]/, width)
+	idx = str.size unless idx
+	r << str[0..idx]
+	str = str[idx+1..-1]
+	r << "\n" << ' ' * indent if str
+      end
+      return r
+    else
+      return str
+    end
+  end
+
+
+  #
+  # Take a text and quote it for inform's double-quote text areas.
+  #
+  def inform_quote(text)
+    str = text.dup
+    # Quote special characters
+#     str.gsub!(/@/, '@@64')
+    str.gsub!(/"/, '\'')
+#     str.gsub!(/~/, '@@126')
+#     str.gsub!(/\\/, '@@92')
+#     str.gsub!(/\^/, '@@94')
+    return str
+  end
+
+
+  def objects(r)
+    room = get_tag(r)
+    objs = r.objects.split("\n")
+    objs.each { |o|
+
+      tag = new_tag(o, o)
+
+      names = o.dup
+      names.gsub!(/"/, '')      # remove any quotes
+      names.gsub!(/\b\w\b/, '') # remove single letter words
+
+      name  = names
+      names = name.split(' ')
+
+      article = 'a '
+      if name =~ /ves$/ or name =~ /s$/
+	article = 'some '
+      elsif name[0,1] == 'a'
+	article = 'an '
+      end
+
+
+      # If name begins with uppercase, assume it is an NPC
+      type = 'a thing'
+
+      if name =~ IS_ANIMAL
+	type = 'an animal'
+      elsif name =~ IS_PERSON or name =~ /[A-Z]/
+	if name !~ /'/  # possesive, like Michael's wallet
+	  # if too many words, probably a book's title
+	  if names.size <= 3
+	    article = ''
+	    if name =~ /^(?:Miss|Mrs)/
+	      type = 'a woman'
+	    else
+	      type = 'a person'
+	    end
+	  end
+	end
+      end
+
+
+      props = ''
+
+      if tag != name
+	props << "\n   The printed name of #{tag} is \"#{article}#{name}\"."
+      end
+
+      if name =~ IS_CONTAINER
+	props << "\n   It is a container."
+      end
+
+      if name =~ IS_SUPPORTER
+	props << "\n   It is a supporter."
+      end
+
+      if name =~ IS_WEARABLE
+	props << "\n   It is wearable."
+      end
+
+      if name =~ IS_EDIBLE
+	props << "\n   It is edible."
+      end
+
+      @f.print <<"EOF"
+
+In #{room}, there is #{type} called #{tag}. #{props}
+   The description of #{tag} is \"UNDER CONSTRUCTION.\"
+EOF
+      if names.size > 1
+	names.each { |n|
+          next if n =~ IGNORED_ARTICLES
+	  @f.puts "   Understand \"#{n}\" as #{tag}."
+	}
+      end
+    }
+
+
+  end
+
+  def door(e)
+    name = get_door_name(e)
+    tag = get_tag(e, name)
+    roomA = get_tag(e.roomA)
+    roomB = get_tag(e.roomB)
+    dirA  = e.roomA.exits.index(e)
+    dirB  = e.roomB.exits.rindex(e)
+    dirA  = DIRECTIONS[dirA].downcase
+    dirB  = DIRECTIONS[dirB].downcase
+
+    props = ''
+    if e.type == Connection::LOCKED_DOOR
+      props = "It is locked."
+    elsif e.type == Connection::CLOSED_DOOR
+      props = "It is closed."
+    end
+
+    found_in = 'It is '
+    if e.dir == Connection::BOTH
+      found_in << "#{dirA} of #{roomA} and #{dirB} of #{roomB}"
+    elsif e.dir == Connection::AtoB
+      found_in << "#{dirA} of #{roomA}.  Through it is #{roomB}"
+    elsif e.dir == Connection::BtoA
+      found_in << "#{dirB} of #{roomB}.  Through it is #{roomA}"
+    end
+
+    @f.puts <<"EOF"
+
+The #{tag} is a door. #{props}  
+The printed name of #{tag} is "a #{name}".
+Understand "door" as #{tag}.
+#{found_in}.
+EOF
+
+  end
+
+
+  def room(r)
+     tag = get_tag(r)
+    name = r.name
+
+    prop = ''
+    if r.darkness
+      prop << 'dark '
+    end
+
+    @f.print "\n#{tag} is a #{prop}room."
+
+    if name != tag
+      name = inform_quote(name)
+      @f.print "  The printed name of #{tag} is \"#{name}\"."
+    end
+
+    @f.puts
+    @f.puts "  \"#{wrap_text(r.desc)}\""
+
+    # Now, handle exits...
+    r.exits.each_with_index { |e, dir|
+      next if (not e) or e.stub? or e.type == Connection::SPECIAL
+      if e.roomB == r
+	next if e.dir == Connection::AtoB
+	text = e.exitBtext 
+	b    = e.roomA
+      else
+	next if e.dir == Connection::BtoA
+	text = e.exitAtext
+	b    = e.roomB
+      end
+      @f.print '  '
+      if text == 0
+	@f.print "#{DIRECTIONS[dir]} is "
+      else
+	@f.print "#{OTHERDIRS[text]} is "
+      end
+      if e.type == Connection::CLOSED_DOOR or
+	  e.type == Connection::LOCKED_DOOR
+	@f.print get_door_tag(e)
+      else
+	@f.print get_tag(b)
+      end
+      @f.puts  '.'
+    }
+    objects(r)
+  end
+
+  def section(sect, idx)
+    name = sect.name
+    name = 'Unnamed' if name.to_s == ''
+
+    @f.puts
+    @f.puts "Section #{idx+1} - #{name}"
+    @f.puts
+
+    @f.puts
+    @f.puts "Part 1 - Room Descriptions"
+    @f.puts
+    sect.rooms.each { |r| room(r) }
+    @f.puts
+    @f.puts
+
+    @f.puts
+    @f.puts "Part 2 - Doors"
+    @f.puts
+    sect.connections.each { |e|
+      next if (e.type != Connection::LOCKED_DOOR and
+	       e.type != Connection::CLOSED_DOOR)
+      door(e)
+    }
+  end
+
+  def start
+    @f = File.open("#@root.inform", "w")
+    story = @map.name
+    story = 'Untitled' if story == ''
+    today = Date.today
+    serial = today.strftime("%y%m%d")
+
+    @f.puts 
+    @f.puts "\"#{story}\" by \"#{@map.creator}\""
+    @f.puts
+    @f.puts <<"EOF"
+The story genre is "Unknown".  The release number is 1.
+The story headline is "An Interactive Fiction".
+The story description is "".
+The story creation year is #{today.year}.
+
+
+Use full-length room descriptions. 
+
+EOF
+
+    @map.sections.each_with_index { |sect, idx|
+      section(sect, idx)
+    }
+    @f.close
+  end
+
+  def initialize(map, fileroot)
+    @tags = {}
+    @root = fileroot
+    @base = File.basename(@root)
+    @map = map
+
+    start
+  end
+end