ifmapper 0.8.5 → 0.9

data/lib/IFMapper/InformWriter.rb

@@ -0,0 +1,349 @@
+
+
+class InformWriter
+
+
+
+  DIRECTIONS = [
+    'n_to',
+    'ne_to',
+    'e_to',
+    'se_to',
+    's_to',
+    'sw_to',
+    'w_to',
+    'nw_to',
+  ]
+
+  OTHERDIRS = [
+    '',
+    'u_to',
+    'd_to',
+    'in_to',
+    'out_to',
+  ]
+
+
+  def get_door_tag(e)
+    dirA  = e.roomA.exits.index(e)
+    dirB  = e.roomB.exits.rindex(e)
+    name  = Room::DIRECTIONS[dirA] + "_" + Room::DIRECTIONS[dirB]
+    name << "_door"
+    get_tag(e, name)
+  end
+
+  def new_tag(elem, str)
+    tag = str.dup
+
+    # Invalid tag characters, replaced with _
+    tag.gsub!(/[\s"'\/\\\-#\,.:;!\?\n\(\)]/,'_')
+ 
+    tag.gsub!(/__/, '')                  # remove reduntant __ repetitions
+    tag.sub!(/^([\d]+)_?(.*)/, '\2\1')   # No numbers allowed at start of tag
+    tag.downcase!                        # All tags are lowercase
+
+    
+
+    tag = tag[0..31]                     # Max. 32 chars. in tag (inform limit)
+
+    # tag cannot be keyword (Doorway, Room, Class, etc)
+    if tag =~ @keyword
+      tag << '1'
+    end
+
+    if @tags.values.include?(tag)
+      idx  = 2
+      root = tag[0..29]  # to leave room for number
+      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 wrap_text(text, width = 65, indent = 79 - width)
+    return 'UNDER CONSTRUCTION' unless text
+    str = inform_quote( text.dup )
+
+    if text.size > width
+      r   = ''
+      while str
+	idx = str.rindex(/[ -]/, width)
+	unless idx
+	  idx = str.index(/[ -]/, width)
+	  idx = str.size unless idx
+	end
+	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!(/"/, '@@34')
+    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!(/'/, '^')     # change ' to ^ (inform convention)
+      names.gsub!(/\b\w\b/, '') # remove single letter words
+      names = names.split(' ')
+      names = "'" + names.join("' '") + "'"
+
+      name = inform_quote(o)
+
+      classname = 'Object'
+
+      # If name begins with uppercase, assume it is an NPC
+      if name =~ /[A-Z]/
+	classname = 'NPC'
+      end
+
+      @f.print <<"EOF"
+
+#{classname} #{tag} "#{name}" #{room}
+      with name #{names},
+      description "#{name} is UNDER CONSTRUCTION.";
+EOF
+    }
+
+
+  end
+
+  def door(e)
+    tag = get_door_tag(e)
+    roomA = get_tag(e.roomA)
+    roomB = get_tag(e.roomB)
+    dirA  = e.roomA.exits.index(e)
+    dirB  = e.roomB.exits.rindex(e)
+    dirA  = Room::DIRECTIONS[dirA]
+    dirB  = Room::DIRECTIONS[dirB]
+
+    props = ''
+    if e.type == Connection::LOCKED_DOOR
+      props = "\n    has lockable locked"
+    elsif e.type == Connection::CLOSED_DOOR
+      props = "\n    has ~open"
+    end
+
+    if e.dir == Connection::BOTH
+      found_in = "#{roomA} #{roomB}"
+    elsif e.dir == Connection::AtoB
+      found_in = roomA
+    elsif e.dir == Connection::BtoA
+      found_in = roomB
+    end
+
+    @f.puts <<"EOF"
+
+! Door connecting #{e}
+Doorway #{tag} "door"
+    with name 'door',
+    side1_to  #{roomA},
+    side1_dir #{dirA}_to,
+    side2_to  #{roomB},
+    side2_dir #{dirB}_to,
+    found_in  #{found_in}#{props};
+EOF
+
+  end
+
+
+  def room(r)
+    tag = get_tag(r)
+    name = inform_quote(r.name)
+    @f.puts <<-"EOF"
+
+!-------------------- #{r.name}
+Room #{tag} "#{name}"
+EOF
+
+    @f.puts  "    with description"
+    @f.print "             \"#{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.puts  ','
+      @f.print '    '
+      if text == 0
+	@f.print "#{DIRECTIONS[dir]} "
+      else
+	@f.print "#{OTHERDIRS[text]} "
+      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
+    }
+    if r.darkness
+      @f.print "    has ~light"
+    end
+    @f.puts ";"
+
+    objects(r)
+  end
+
+  def section(sect, idx)
+    @f = File.open("#@root-#{idx}.inf", "w")
+    @f.puts '!' + '=' * 78
+    @f.puts "! Section: #{sect.name} "
+    @f.puts '!' + '=' * 78
+    sect.rooms.each { |r|
+      room(r)
+    }
+
+    @f.puts '!' + '-' * 78
+    @f.puts '!  Doorways'
+    @f.puts '!' + '-' * 78
+    sect.connections.each { |e|
+      next if (e.type != Connection::LOCKED_DOOR and
+	       e.type != Connection::CLOSED_DOOR)
+      door(e)
+    }
+    @f.close
+  end
+
+  def start
+    @f = File.open("#@root.inf", "w")
+    @f.puts '!' + '=' * 78
+    story = @map.name
+    story = 'Untitled' if story == ''
+    today = Date.today
+    serial = today.strftime("%y%m%d")
+    @f.puts <<"EOF"
+Constant Story "#{story}";
+Constant Headline
+           "^A game map done with IFMapper
+            ^by #{@map.creator}.^";
+Release 1; 
+Serial "#{serial}"; ! #{Time.now}
+
+! These constants are to make the game also potentially Glulx compatible
+#ifndef WORDSIZE;
+Constant TARGET_ZCODE;
+Constant WORDSIZE 2;
+#endif;
+
+!Constant ZDEBUG;
+
+Include "Parser";
+Include "VerbLib";
+
+
+EOF
+    @f.puts '!' + '=' * 78
+    @f.puts "! Object classes"
+    @f.puts <<"EOF"
+
+! We use Andrew MacKinnon's EasyDoors for our doors.
+Include "easydoors";
+
+! We define a class for NPC (non-player characters)
+class   NPC
+  has   animate;
+
+EOF
+
+    @f.puts '!' + '=' * 78
+    @f.puts "! Map sections"
+    @map.sections.each_index { |idx|
+      @f.puts "#include \"#@base-#{idx}.inf\";"
+    }
+
+    start_location = ''
+    if @map.sections.size > 0 and @map.sections[0].rooms[0]
+      r   = @map.sections[0].rooms[0]
+      tag = get_tag(r)
+      start_location = "location = #{tag}"
+    end
+
+    @f.puts <<"EOF";
+!============================================================================
+! Entry point routines
+
+[ Initialise;
+  #{start_location};
+  lookmode = 2; ! verbose
+  inventory_style = FULLINV_BIT + ENGLISH_BIT + RECURSE_BIT; ! wide
+];
+EOF
+
+    @f.puts <<"EOF"
+!============================================================================
+! Standard and extended grammar
+
+Include "Grammar";
+EOF
+
+    @f.close
+
+    @map.sections.each_with_index { |sect, idx|
+      section(sect, idx)
+    }
+  end
+
+  def initialize(map, fileroot)
+    @tags = {}
+    @root = fileroot
+    @base = File.basename(@root)
+    @map = map
+
+    keywords = [
+      'doorway',
+      'class',
+      'include',
+      'room',
+      'has',
+      'with',
+      'description',
+    ] + DIRECTIONS
+
+    @keyword = /^#{keywords.join('|')}$/i
+    start
+  end
+end

data/lib/IFMapper/Map.rb

@@ -52,9 +52,20 @@ class Map
 	  if not sect.connections.include?(e)
 	    $stderr.puts "Exit #{e} in room, but not in section #{sect.name}."
 	    r.exits[idx] = nil
+	    sect.connections.delete(e)
 	  end
 	}
       }
+
+      sect.connections.each { |c|
+	a = c.roomA
+	b = c.roomB
+	if not a.exits.index(c) or 
+	    (b and not b.exits.rindex(c))
+	  $stderr.puts "Exit #{c} not present in room."
+	  sect.connections.delete(c)
+	end
+      }
     }
   end
 
@@ -179,6 +190,7 @@ class Map
     _check_section
   end
 
+
 end
 
 

data/lib/IFMapper/PDFMapExporter.rb

@@ -71,6 +71,37 @@ class FXConnection
     return p
   end
 
+  def pdf_draw_door( pdf, x1, y1, x2, y2 )
+      v = [ (x2-x1), (y2-y1) ]
+      t = 10 / Math.sqrt(v[0]*v[0]+v[1]*v[1])
+      v = [ v[0]*t, v[1]*t ]
+      m = [ (x2+x1)/2, (y2+y1)/2 ]
+      x1, y1 = [m[0] + v[1], m[1] - v[0]]
+      x2, y2 = [m[0] - v[1], m[1] + v[0]]
+    if @type == LOCKED_DOOR
+      pdf.move_to(x1, y1)
+      pdf.line_to(x2, y2).stroke
+    else
+      s = PDF::Writer::StrokeStyle.new(1,
+				       :cap => :butt, 
+				       :join => :miter, 
+				       :dash => PDF::Writer::StrokeStyle::SOLID_LINE )
+      pdf.stroke_style(s)
+      v = [ v[0] / 3, v[1] / 3]
+      pdf.move_to(x1 - v[0], y1 - v[1])
+      pdf.line_to(x1 + v[0], y1 + v[1])
+      pdf.line_to(x2 + v[0], y2 + v[1])
+      pdf.line_to(x2 - v[0], y2 - v[1])
+      pdf.line_to(x1 - v[0], y1 - v[1])
+      pdf.stroke
+      s = PDF::Writer::StrokeStyle.new(2,
+				       :cap => :butt, 
+				       :join => :miter, 
+				       :dash => PDF::Writer::StrokeStyle::SOLID_LINE )
+      pdf.stroke_style(s)
+    end
+  end
+
   def pdf_draw_complex( pdf, opts )
     if opts['Paths as Curves']
       p = pdf_draw_complex_as_bspline( pdf, opts )
@@ -85,19 +116,11 @@ class FXConnection
     x2, y2 = [p[-1][0], p[-1][1]]
     pdf_draw_arrow(pdf, opts, x1, y1, x2, y2)
 
-    if @type == LOCKED_DOOR
+    if @type == LOCKED_DOOR or @type == CLOSED_DOOR
       t = p.size / 2
       x1, y1 = [ p[t].x, p[t].y ]
       x2, y2 = [ p[t-2].x, p[t-2].y ]
-
-      v = [ (x2-x1), (y2-y1) ]
-      t = 10 / Math.sqrt(v[0]*v[0]+v[1]*v[1])
-      v = [ v[0]*t, v[1]*t ]
-      m = [ (x2+x1)/2, (y2+y1)/2 ]
-      x1, y1 = [m[0] + v[1], m[1] - v[0]]
-      x2, y2 = [m[0] - v[1], m[1] + v[0]]
-      pdf.move_to(x1, y1)
-      pdf.line_to(x2, y2).stroke
+      pdf_draw_door(pdf, x1, y1, x2, y2)
     end
   end
 
@@ -110,13 +133,8 @@ class FXConnection
     pdf.move_to(x1, y1)
     pdf.line_to(x2, y2).stroke
     pdf_draw_arrow(pdf, opts, x1, y1, x2, y2)
-    if @type == LOCKED_DOOR
-      v = [ (x2-x1)*0.25, (y2-y1)*0.25 ]
-      m = [ (x2+x1)/2, (y2+y1)/2 ]
-      x1, y1 = [m[0] + v[1], m[1] - v[0]]
-      x2, y2 = [m[0] - v[1], m[1] + v[0]]
-      pdf.move_to(x1, y1)
-      pdf.line_to(x2, y2).stroke
+    if @type == LOCKED_DOOR or @type == CLOSED_DOOR
+      pdf_draw_door(pdf, x1, y1, x2, y2)
     end
   end