frprep 0.0.1.prealpha

data/lib/common/BerkeleyInterface.rb

@@ -0,0 +1,375 @@
+# -*- coding: utf-8 -*-
+####
+# sp 21 07 05
+#
+# modified ke 30 10 05: adapted to fit into SynInterface
+#
+# represents a file containing Berkeley parses
+# 
+# underlying data structure for individual sentences: SalsaTigerSentence
+require "tempfile"
+
+require "common/SalsaTigerRegXML"
+require "common/SalsaTigerXMLHelper"
+require "common/TabFormat"
+require "common/Counter"
+
+require "common/AbstractSynInterface"
+require "common/Tiger.rb"
+
+################################################
+# Interface class
+class BerkeleyInterface < SynInterfaceSTXML
+  $stderr.puts 'Announcing Berkeley Interface' if $DEBUG
+  BerkeleyInterface.announce_me()
+
+  ###
+  def BerkeleyInterface.system()
+    return "berkeley"
+  end
+
+  ###
+  def BerkeleyInterface.service()
+    return "parser"
+  end
+
+  ###
+  # initialize to set values for all subsequent processing
+  def initialize(program_path, # string: path to system
+		 insuffix,      # string: suffix of tab files
+		 outsuffix,     # string: suffix for parsed files
+		 stsuffix,      # string: suffix for Salsa/TIGER XML files
+		 var_hash = {}) # optional arguments in a hash
+
+    super(program_path, insuffix, outsuffix, stsuffix, var_hash)
+    unless @program_path =~ /\/$/
+      @program_path = @program_path + "/"
+    end
+
+    # new: evaluate var hash
+    @pos_suffix = var_hash["pos_suffix"]
+    @lemma_suffix = var_hash["lemma_suffix"]
+    @tab_dir = var_hash["tab_dir"]
+  end
+
+  ####
+  # parse a directory with TabFormat files and write the parse trees to outputdir 
+  # I assume that the files in inputdir are smaller than 
+  # the maximum number of sentences that 
+  # Berkeley can parse in one go (i.e. that they are split)
+  def process_dir(in_dir,  # string: input directory name
+		  out_dir) # string: output directory name
+    
+# not using x64 arch, adjusting for 32 bit
+#    berkeley_prog = "java -d64 -Xmx10000m -jar #{@program_path}berkeley-parser.jar -gr #{@program_path}gerNegra.01.utf8 "
+    berkeley_prog = "java -Xmx2000m -jar #{@program_path}berkeleyParser.jar -gr #{@program_path}ger_sm5.gr"
+
+    berkeley_prog = "java -jar #{@program_path}berkeley-parser.jar -gr #{@program_path}gerNegra.01.utf8 "
+    Dir[in_dir + "*" + @insuffix].each {|inputfilename|
+      STDERR.puts "*** Parsing #{inputfilename} with Berkeley"
+      corpusfilename = File.basename(inputfilename, @insuffix)
+      parsefilename = out_dir + corpusfilename + @outsuffix
+      tempfile = Tempfile.new(corpusfilename)
+
+      # we need neither lemmata nor POS tags; berkeley can do with the words
+      corpusfile = FNTabFormatFile.new(inputfilename,nil, nil) 
+      corpusfile.each_sentence {|sentence|
+        #puts sentence.to_s
+        tempfile.puts sentence.to_s
+      }
+      tempfile.close
+      # parse and remove comments in the parser output
+      STDERR.puts "#{berkeley_prog} < #{tempfile.path} > #{parsefilename}"
+
+      # AB: for testing we leave this step out, it takes too much time.
+      # Please keep the <parsefile> intact!!!
+      Kernel.system("#{berkeley_prog} < #{tempfile.path} > #{parsefilename}")      
+
+    }
+  end
+
+  ###
+  # for a given parsed file:
+  # yield each sentence as a pair 
+  #  [SalsaTigerSentence object, FNTabFormatSentence object]
+  # of the sentence in SalsaTigerXML and the matching tab format sentence
+  #
+  # If a parse has failed, returns 
+  #  [failed_sentence (flat SalsaTigerSentence), FNTabFormatSentence] 
+  # to allow more detailed accounting for failed parses
+  # (basically just a flat structure with a failed=true attribute 
+  # at the sentence node)
+  def each_sentence(parsefilename)
+    # sanity checks
+    unless @tab_dir
+      raise "Need to set tab directory on initialization"
+    end
+   
+    # get matching tab file for this parser output file
+    parsefile = File.new(parsefilename)
+    tabfilename = @tab_dir+File.basename(parsefilename, @outsuffix)+ @insuffix
+    tabfile = FNTabFormatFile.new(tabfilename, @postag_suffix, @lemma_suffix)    
+
+    sentid = 0
+    tabfile.each_sentence {|tab_sent| # iterate over corpus sentences
+      
+      sentence_str = ""
+      status = true # error encountered? 
+      # assemble next sentence in Berkeley file by reading lines from parsefile
+      # for berkeley: 
+      while true
+        line = parsefile.gets
+
+        # search for the next "relevant" file or end of the file
+	if line.nil? or line=~/^\( *\(TOP/ or line=~/^\(\(\)/
+          break
+	end   
+        sentid +=1
+        
+      end
+     
+   
+      if line.nil? # while we search a parse, the parse file is over...
+        raise "Error: premature end of parser file!"
+      end
+      
+
+      # berkeley parser output: remove brackets /(.*)/
+      line.sub!(/^\( */, '')
+      line.sub!(/ *\) *$/, '')
+      line.gsub!(/\)\)/, ') )')
+      line.gsub!(/\)\)/, ') )')
+      line.gsub!(/(\([A-Z]+)_/, '\1-')
+
+      sentence_str = line.chomp!
+
+      # if we are here, we have a sentence_str to work on
+      # hopefully, our status is OK
+      case status
+      when true
+        if tab_sent.get_sent_id() and tab_sent.get_sent_id() != "--"
+          my_sent_id = tab_sent.get_sent_id()
+        else
+          my_sent_id = File.basename(parsefilename, @outsuffix) + "_" + sentid.to_s
+        end
+
+        st_sent = build_salsatiger(" " + sentence_str + " ", 0,
+                                   Array.new, Counter.new(0),
+                                   Counter.new(500),
+                                   SalsaTigerSentence.empty_sentence(my_sent_id.to_s))
+	if st_sent.nil?
+	  next
+	end
+        yield [st_sent, tab_sent, BerkeleyInterface.standard_mapping(st_sent, tab_sent)]
+      else # i.e. when "failed"
+        #raise "Hunh? This is a failed parse, but still we have a parse tree? Look again."
+      end
+     
+    }
+
+      # we don't have a sentence: hopefully, this is becase parsing has failed
+    
+    
+    # all TabFile sentences are consumed: 
+    # now we may just encounter comments, garbage, empty lines etc. 
+    
+    while not parsefile.eof?
+
+      case parsefile.gets
+      when nil, /^%/, /^\s*$/ # empty lines, comments, end of input indicate end of current parse 
+      else
+        raise "Error: premature end of tab file!"
+      end
+    end  
+  end
+  
+
+  ###
+  # write Salsa/TIGER XML output to file
+  def to_stxml_file(infilename,  # string: name of parse file
+		    outfilename) # string: name of output stxml file
+
+    outfile = File.new(outfilename, "w")
+    
+    outfile.puts SalsaTigerXMLHelper.get_header()
+    each_sentence(infilename) { |st_sent, tabsent|
+      outfile.puts st_sent.get()
+    }
+    outfile.puts SalsaTigerXMLHelper.get_footer()
+    outfile.close()
+  end
+
+
+
+  ########################
+  private
+
+  ###
+  # Recursive function for parsing a Berkeley parse tree and 
+  # building a SalsaTigerSentence recursively
+  #
+  # Algorithm: manage stack which contains, for the current constituent, 
+  # child constituents (if a nonterminal), and the category label.
+  # When the end of a constituent is reached, a new SynNode (TigerSalsa node) ist created.
+  # All children and the category label are popped from the stack and integrated into the 
+  # TigerSalsa data structure. The new node is re-pushed onto the stack.
+  def build_salsatiger(sentence, # string
+                    pos,      # position in string (index): integer
+                    stack,    # stack with incomplete nodes: Array
+                    termc,    # terminal counter
+                    nontc,    # nonterminal counter
+                    sent_obj) # SalsaTigerSentence
+    
+   
+
+    if sentence =~ /\(\)/
+      return nil
+    end
+
+   # main case distinction: match the beginning of our string 
+   # (i.e. what follows our current position in the string)
+    case sentence[pos..-1]
+      
+    when /^ *$/ # nothing -> whole sentence parsed
+      if stack.length == 1 
+	# sleepy always delivers one "top" node; if we don't get just one
+        # node, something has gone wrong
+        node = stack.pop
+        node.del_attribute("gf")
+        return sent_obj
+      else
+        raise "Error: more than one root node (stack length #{stack.length}). Full sentence: \n#{sentence}"
+      end    
+      
+    when /^\s*\(([^ )]+) / 
+      # match the beginning of a new constituent 
+      # (opening bracket + category + space, may not contain closing bracket)
+      cat = $1
+      if cat.nil? or cat == ""
+        raise "Error: found category nil in sentence #{sentence[pos,10]}, full sentence\n#{sentence}"
+      end
+#          STDERR.puts "new const #{cat}"
+      stack.push cat # throw the category label on the stack    
+      return build_salsatiger(sentence,pos+$&.length,stack,termc,nontc,sent_obj)    
+      
+    when /^\s*(\S+)\) /
+      # match the end of a terminal constituent (something before a closing bracket + space)
+      word = $1
+
+      comb_cat = stack.pop
+      if comb_cat.to_s == ""
+        raise "Empty cat at position #{sentence[pos,10]}, full sentence\n#{sentence}"
+      end
+
+      cat,gf = split_cat(comb_cat)
+      node = sent_obj.add_syn("t",
+                              nil,  # cat (doesn't matter here)
+                              SalsaTigerXMLHelper.escape(word), # word
+                              cat,  # pos
+                              termc.next.to_s)
+      node.set_attribute("gf",gf)
+#          STDERR.puts "completed terminal #{cat}, #{word}"
+      stack.push node
+      return build_salsatiger(sentence,pos+$&.length,stack,termc,nontc,sent_obj)    
+      
+    when /^\s*\)/ # match the end of a nonterminal (nothing before a closing bracket)
+      # now collect children:
+      # pop items from the stack until you find the category
+      children = Array.new  
+      while true
+        if stack.empty?
+          raise "Error: stack empty; cannot find more children"
+        end
+        item = stack.pop
+        case item.class.to_s
+        when "SynNode" # this is a child
+          children.push item
+        when "String" # this is the category label
+          if item.to_s == ""
+            raise "Empty cat at position #{sentence[pos,10]}, full sentence\n#{sentence}"
+          end        
+          cat,gf = split_cat(item)
+          break
+        else
+          raise "Error: unknown item class #{item.class.to_s}"
+        end
+      end
+      # now add a nonterminal node to the sentence object and 
+      # register the children nodes
+      node = sent_obj.add_syn("nt",
+                              cat, # cat
+                              nil, # word (doesn't matter)
+                              nil, # pos (doesn't matter)
+                              nontc.next.to_s)
+      children.each {|child|
+        child_gf = child.get_attribute("gf")
+        child.del_attribute("gf")
+        node.add_child(child,child_gf)
+        child.add_parent(node, child_gf)
+       }
+      node.set_attribute("gf",gf)
+#          STDERR.puts "Completed nonterm #{cat}, #{children.length} children."
+      stack.push node
+
+      return build_salsatiger(sentence,pos+$&.length, stack,termc,nontc,sent_obj)
+    else
+      raise "Error: cannot analyse sentence at pos #{pos}: #{sentence[pos..-1]}. Complete sentence: \n#{sentence}"
+    end
+  end
+
+
+
+
+  ###
+  # Berkeley delivers node labels as "phrase type"-"grammatical function"
+  # but the GF may not be present.
+
+  def split_cat(cat)
+
+    cat =~ /^([^-]*)(-([^-]*))?$/
+    unless $1
+      raise "Error: could not identify category in #{cat}"
+    end
+    
+    proper_cat = $1
+    
+    if $3    
+      gf = $3
+    else
+      gf = ""
+    end
+    
+    return [proper_cat,gf]
+    
+  end
+end
+
+
+
+################################################
+# Interpreter class
+class BerkeleyInterpreter < Tiger
+  BerkeleyInterpreter.announce_me()
+
+  ###
+  # names of the systems interpreted by this class:
+  # returns a hash service(string) -> system name (string),
+  # e.g.
+  # { "parser" => "collins", "lemmatizer" => "treetagger" }
+  def BerkeleyInterpreter.systems()
+    return {
+	"parser" => "berkeley"
+    }
+  end
+
+  ###
+  # names of additional systems that may be interpreted by this class
+  # returns a hash service(string) -> system name(string)
+  # same as names()
+  def BerkeleyInterpreter.optional_systems()
+    return {
+      "lemmatizer" => "treetagger"
+    }
+  end
+
+end

data/lib/common/CollinsInterface.rb

@@ -0,0 +1,1165 @@
+####
+# sp 15 04 05
+#
+# modified ke 30 10 05: adapted to fit into SynInterface
+#
+# represents a file containing Collins parses
+# 
+# underlying data structure for individual sentences: SalsaTigerSentence
+
+
+require "tempfile"
+require "common/TabFormat"
+require "common/SalsaTigerRegXML"
+require "common/SalsaTigerXMLHelper"
+require "common/Counter"
+
+require "common/AbstractSynInterface"
+
+################################################
+# Interface class
+class CollinsInterface < SynInterfaceSTXML
+  CollinsInterface.announce_me()
+
+  ###
+  def CollinsInterface.system()
+    return "collins"
+  end
+
+  ###
+  def CollinsInterface.service()
+    return "parser"
+  end
+
+  ###
+  # initialize to set values for all subsequent processing
+  def initialize(program_path, # string: path to system
+		 insuffix,      # string: suffix of tab files
+		 outsuffix,     # string: suffix for parsed files
+		 stsuffix,      # string: suffix for Salsa/TIGER XML files
+		 var_hash = {}) # optional arguments in a hash
+
+    super(program_path, insuffix, outsuffix, stsuffix, var_hash)
+    # I am not expecting any parameters, but I need
+    # the program path to end in a /.
+    unless @program_path =~ /\/$/
+      @program_path = @program_path + "/"
+    end
+
+    # new: evaluate var hash
+    @pos_suffix = var_hash["pos_suffix"]
+    @lemma_suffix = var_hash["lemma_suffix"]
+    @tab_dir = var_hash["tab_dir"]
+  end
+
+  
+  ###
+  # parse a bunch of TabFormat files (*.<insuffix>) with Collins model 3
+  # required: POS tags must be present
+  # produced: in outputdir, files *.<outsuffix>
+  # I assume that the files in inputdir are smaller than 
+  # the maximum number of sentences 
+  # Collins can parse in one go (i.e. that they are split) and I don't have to care
+  def process_dir(in_dir,        # string: name of input directory
+		  out_dir)       # string: name of output directory
+    print "parsing ", in_dir, " and writing to ", out_dir, "\n"
+
+    unless @pos_suffix
+      raise "Collins interface: need suffix for POS files"
+    end
+    
+    collins_prog = "gunzip -c #{@program_path}models/model3/events.gz | nice #{@program_path}code/parser"    
+    collins_params = " #{@program_path}models/model3/grammar 10000 1 1 1 1"
+    
+    Dir[in_dir+ "*" + @insuffix].each { |inputfilename|
+
+      STDERR.puts "*** Parsing #{inputfilename} with Collins"
+
+      corpusfilename = File.basename(inputfilename, @insuffix)
+      parsefilename = out_dir+corpusfilename+ @outsuffix
+      tempfile = Tempfile.new(corpusfilename)
+	
+      # we need to have part of speech tags (but no lemmas at this point)
+      # included automatically by FNTabFormatFile initialize from *.pos
+      tabfile = FNTabFormatFile.new(inputfilename,@pos_suffix)
+
+      CollinsInterface.produce_collins_input(tabfile,tempfile)
+      tempfile.close
+	print collins_prog+" "+tempfile.path+" "+ collins_params+" > "+parsefilename
+      Kernel.system(collins_prog+" "+tempfile.path+" "+
+		    collins_params+" > "+parsefilename)    
+      tempfile.close(true)
+    }
+  end
+
+  ###
+  # for a given parsed file:
+  # yield each sentence as a pair 
+  #  [SalsaTigerSentence object, FNTabFormatSentence object]
+  # of the sentence in SalsaTigerXML and the matching tab format sentence
+  #
+  # If a parse has failed, returns 
+  #  [failed_sentence (flat SalsaTigerSentence), FNTabFormatSentence] 
+  # to allow more detailed accounting for failed parses
+  def each_sentence(parsefilename)
+
+    # sanity checks
+    unless @tab_dir
+      raise "Need to set tab directory on initialization"
+    end
+
+    # get matching tab file for this parser output file
+    parserfile = File.new(parsefilename)
+    tabfilename = @tab_dir+File.basename(parsefilename, @outsuffix)+ @insuffix
+
+    corpusfile = FNTabFormatFile.new(tabfilename, @pos_suffix, @lemma_suffix)    
+
+    corpusfile.each_sentence {|tab_sent| # iterate over corpus sentences
+      
+      my_sent_id = tab_sent.get_sent_id()
+      
+      while true # find next matching line in parse file
+	line = parserfile.gets
+        # search for the next "relevant" file or end of the file
+	if line.nil? or line=~/^\(TOP/
+	  break
+	end
+      end
+	STDERR.puts line
+      # while we search a parse, the parse file is over...
+      if line.nil?
+        raise "Error: premature end of parser file!"
+      end
+      
+      line.chomp!
+      
+      # it now holds that line =~ ^(TOP
+      
+      case line
+      when /^\(TOP~/ # successful parse
+
+        st_sent = SalsaTigerSentence.empty_sentence(my_sent_id.to_s)
+
+	build_salsatiger(line,st_sent)
+	
+        yield [st_sent, tab_sent, CollinsInterface.standard_mapping(st_sent, tab_sent)]
+
+      else 
+        # failed parse: create a "failed" parse object 
+        # with one nonterminal node and all the terminals
+        
+        sent = CollinsInterface.failed_sentence(tab_sent,my_sent_id)
+        yield [sent, tab_sent, CollinsInterface.standard_mapping(sent, tab_sent)] 
+	
+      end
+    }
+    # after the end of the corpusfile, check if there are any parses left
+    while true
+      line = parserfile.gets
+      if line.nil? # if there are none, everything is fine
+        break
+      elsif line =~ /^\(TOP/ # if there are, raise an exception
+        raise "Error: premature end of corpus file!"
+      end
+    end
+  end    
+
+  ###
+  # write Salsa/TIGER XML output to file
+  def to_stxml_file(infilename,  # string: name of parse file
+		    outfilename) # string: name of output stxml file
+
+    outfile = File.new(outfilename, "w")
+    outfile.puts SalsaTigerXMLHelper.get_header()
+    each_sentence(infilename) { |st_sent, tabsent|
+      outfile.puts st_sent.get()
+    }
+    outfile.puts SalsaTigerXMLHelper.get_footer()
+    outfile.close()
+  end
+
+
+  ########################
+  private
+  
+  # Build a SalsaTigerSentence corresponding to the Collins parse in argument string.
+  #
+  # Special features: removes unary nodes and traces
+  def build_salsatiger(string,st_sent)
+    
+    nt_c = Counter.new(500)
+    t_c = Counter.new(0)
+    
+    position = 0
+    stack = Array.new
+    
+    while position < string.length
+      if string[position,1] == "(" # push nonterminal
+	nextspace = string.index(" ",position)
+	nonterminal = string[position+1..nextspace-1]
+	stack.push nonterminal
+	position = nextspace+1
+      elsif string[position,1] == ")" # reduce stack
+	tempstack = Array.new
+	while true
+          # get all Nodes from the stack and put them on a tempstack,
+          # until you find a String, which is a not-yet existing nonterminal
+	  object = stack.pop
+          if object.kind_of? SynNode
+	    tempstack.push(object) # terminal or subtree
+	  else #  string (nonterminal label)
+            if tempstack.length == 1 # skip unary nodes: do nothing and write tempstack back to stack
+              stack += tempstack
+              break
+              # puts "Unary node #{object}"
+            end
+	    nt_a = object.split("~")
+	    unless nt_a.length == 4
+              # something went wrong. maybe it's about character encoding
+              if nt_a.length() > 4
+                # yes, assume it's about character encoding
+                nt_a = [nt_a[0], nt_a[1..-3].join("~"), nt_a[-2], nt_a[-1]]
+              else
+                # whoa, _less_ pieces than expected: problem.
+                $stderr.puts "Collins parse tree translation nonrecoverable error:"
+                $stderr.puts "Unexpectedly too few components in nonterminal " + nt_a.join("~")
+                raise StandardError.new("nonrecoverable error")
+              end
+	    end
+            
+            # construct a new nonterminal            
+            node = st_sent.add_syn("nt",
+                                   SalsaTigerXMLHelper.escape(nt_a[0].strip), # cat
+                                   nil, # word (doesn't matter)
+                                   nil, # pos (doesn't matter)
+                                   nt_c.next.to_s)
+            node.set_attribute("head",SalsaTigerXMLHelper.escape(nt_a[1].strip))            
+	    tempstack.reverse.each {|child|
+	      node.add_child(child,nil)
+	      child.set_parent(node,nil)
+	    }
+	    stack.push(node)
+	    break # while
+	  end
+	end
+	position = position+2 # == nextspace+1	
+      else # terminal
+	nextspace = string.index(" ",position)
+	terminal = string[position..nextspace].strip
+	t_a = terminal.split("/")
+	unless t_a.length == 2
+	  raise "[collins] Cannot split terminal #{terminal} into word and POS!"
+        end
+        
+        word = t_a[0]
+        pos = t_a[1]
+        
+        unless pos =~ /TRACE/                   
+          # construct a new terminal
+          node = st_sent.add_syn("t",
+                                 nil,
+                                 SalsaTigerXMLHelper.escape(CollinsInterface.unescape(word)), # word
+                                 SalsaTigerXMLHelper.escape(pos), # pos
+                                 t_c.next.to_s)
+          stack.push(node)
+        end
+	position = nextspace+1
+      end
+    end
+    
+    # at the very end, we need to have exactly one syntactic root
+    
+    if stack.length != 1
+      raise "[collins] Error: Sentence has #{stack.length} roots"
+    end  
+  end
+
+
+  ####
+  # extract the Collins parser input format from a TabFormat object
+  # that includes part-of-speech (pos) 
+  #
+  def CollinsInterface.produce_collins_input(corpusfile,tempfile)
+    corpusfile.each_sentence {|s|
+      words = Array.new
+      s.each_line_parsed {|line_obj|
+	word = line_obj.get("word")
+	tag = line_obj.get("pos")
+	if tag.nil?
+	  raise "Error: FNTabFormat object not tagged!"
+	end
+	word_tag_pair = CollinsInterface.escape(word,tag)
+	if word_tag_pair =~ /\)/
+	  puts word_tag_pair
+	  puts s.to_s
+	end
+	words << word_tag_pair
+      }
+      tempfile.puts words.length.to_s+" "+words.join(" ")
+    }
+  end
+
+  ####
+  def CollinsInterface.escape(word,pos) # returns array word+" "+lemma
+    case word
+      
+      # replace opening or closing brackets
+      # word representation is {L,R}R{B,S,C} (bracket, square, curly)
+      # POS for opening brackets is LRB, closing brackets RRB
+      
+    when "("
+      return "LRB -LRB-"
+    when "["
+      return "LRS -LRB-"
+    when "{"
+      return "LRC -LRB-"
+    
+    when ")" 
+      return "RRB -RRB-"
+    when "]"
+      return "RRS -RRB-"
+    when "}"
+      return "RRC -RRB-"
+      
+      # catch those brackets or slashes inside words
+    else 
+      word.gsub!(/\(/,"LRB")
+      word.gsub!(/\)/,"RRB")
+      word.gsub!(/\[/,"LRS")
+      word.gsub!(/\]/,"RRS")
+      word.gsub!(/\{/,"LRC")
+      word.gsub!(/\}/,"RRC")
+      word.gsub!(/\//,"&Slash;")
+      return word+" "+pos
+    end
+  end
+  
+  ####
+  # replace replacements with original values
+  def CollinsInterface.unescape(word)
+    return word.gsub(/LRB/,"(").gsub(/RRB/,")").gsub(/LRS/,"[").gsub(/RRS/,"]").gsub(/LRC/,"{").gsub(/RRC/,"}").gsub(/&Slash;/,"/")
+  end
+end
+
+################################################
+# Interpreter class
+class CollinsTntInterpreter < SynInterpreter
+  CollinsTntInterpreter.announce_me()
+
+  ###
+  # names of the systems interpreted by this class:
+  # returns a hash service(string) -> system name (string),
+  # e.g.
+  # { "parser" => "collins", "lemmatizer" => "treetagger" }
+  def CollinsTntInterpreter.systems()
+    return {
+      "pos_tagger" => "treetagger",
+      "parser" => "collins"
+    }
+  end
+
+  ###
+  # names of additional systems that may be interpreted by this class
+  # returns a hash service(string) -> system name(string)
+  # same as names()
+  def CollinsTntInterpreter.optional_systems()
+    return {
+      "lemmatizer" => "treetagger"
+    }
+  end
+
+  ###
+  # generalize over POS tags.
+  #
+  # returns one of:
+  #
+  # adj:  adjective (phrase)
+  # adv:  adverb (phrase)
+  # card: numbers, quantity phrases
+  # con:  conjunction
+  # det:  determiner, including possessive/demonstrative pronouns etc.
+  # for:  foreign material
+  # noun: noun (phrase), including personal pronouns, proper names, expletives
+  # part: particles, truncated words (German compound parts)
+  # prep: preposition (phrase)
+  # pun:  punctuation, brackets, etc.
+  # sent: sentence
+  # top:  top node of a sentence
+  # verb: verb (phrase)
+  # nil:  something went wrong
+  #
+  # returns: string, or nil
+  def CollinsTntInterpreter.category(node) # SynNode
+    pt = CollinsTntInterpreter.simplified_pt(node)
+    if pt.nil?
+      # phrase type could not be determined
+      return nil
+    end
+
+    pt.to_s.strip() =~ /^([^-]*)/  
+    case $1
+    when  /^JJ/ ,/(WH)?ADJP/, /^PDT/ then  return "adj"
+    when /^RB/, /(WH)?ADVP/, /^UH/ then return "adv"
+    when /^CD/, /^QP/ then  return "card"
+    when /^CC/, /^WRB/, /^CONJP/ then return "con"
+    when /^DT/, /^POS/ then  return "det"
+    when /^FW/, /^SYM/ then  return "for"
+    when /^N/, "WHAD", "WDT", /^PRP/ , /^WHNP/, /^EX/, /^WP/  then return "noun"
+    when  /^IN/ , /^TO/, /(WH)?PP/, "RP", /^PR(T|N)/ then return "prep"
+    when /^PUNC/, /LRB/, /RRB/, /[,'".:;!?\(\)]/ then  return "pun"
+    when /^S(s|bar|BAR|G|Q|BARQ|INV)?$/, /^UCP/, /^FRAG/, /^X/, /^INTJ/ then return "sent"
+    when /^TOP/ then  return "top"
+    when /^TRACE/ then  return "trace"
+    when /^V/ , /^MD/ then return "verb"
+    else
+#      $stderr.puts "WARNING: Unknown category/POS "+c.to_s + " (English data)"
+      return nil
+    end
+  end
+
+
+  ###
+  # is relative pronoun?
+  #
+  def CollinsTntInterpreter.relative_pronoun?(node) # SynNode
+    pt = CollinsTntInterpreter.simplified_pt(node)
+    if pt.nil?
+      # phrase type could not be determined
+      return nil
+    end
+
+    pt.to_s.strip() =~ /^([^-]*)/  
+    case $1
+    when /^WDT/, /^WHAD/, /^WHNP/, /^WP/
+      return true
+    else
+      return false
+    end
+  end
+
+  ###
+  # lemma_backoff:
+  #
+  # if we have lemma information, return that,
+  # and failing that, return the word
+  #
+  # returns: string, or nil
+  def CollinsTntInterpreter.lemma_backoff(node)
+    lemma = super(node)
+    # lemmatizer has returned more than one possible lemma form: 
+    # just accept the first 
+    if lemma =~ /^([^|]+)|/ 
+      return $1
+    else
+      return lemma
+    end
+  end
+
+
+  ###
+  # simplified phrase type:
+  # like phrase type, but may simplify
+  # the constituent label
+  #
+  # returns: string
+  def CollinsTntInterpreter.simplified_pt(node)
+    CollinsTntInterpreter.pt(node) =~ /^(\w+)(-\w)*/
+    return $1
+  end
+
+  ###
+  # verb_with_particle:
+  #
+  # given a node and a nodelist,
+  # if the node represents a verb:
+  # see if the verb has a particle among the nodes in nodelist
+  # if so, return it
+  #
+  # returns: SynNode object if successful, else nil
+  def CollinsTntInterpreter.particle_of_verb(node,
+					     node_list)
+
+    # must be verb
+    unless CollinsTntInterpreter.category(node) == "verb"
+      return nil
+    end
+
+    # must have parent
+    unless node.parent
+      return nil
+    end
+
+    # look for sisters of the verb node that have the particle category
+    particles = node.parent.children.select { |sister|
+      CollinsTntInterpreter.category(sister) == "part"
+    }.map { |n| n.children}.flatten.select { |niece|
+      # now look for children of those nodes that are particles and are in the nodelist
+      nodelist.include? niece and
+	CollinsTntInterpreter.category(niece) == "part"
+    }
+
+    if particles.length == 0
+      return nil
+    else
+      return particles.first
+    end
+  end
+
+  ###
+  # auxiliary?
+  # 
+  # returns true if the given node is an auxiliary
+  # else false
+  def CollinsTntInterpreter.auxiliary?(node)
+
+    # look for
+    #             ---VP---
+    #             |      |
+    #  the given node   VP-A
+    #                    |
+    #                verb node 
+    # verb?
+    unless CollinsTntInterpreter.category(node) == "verb"
+      return false
+    end
+
+    unless (parent = node.parent) and 
+        parent.category() == "VP" 
+      return false
+    end
+    unless (vpa_node = parent.children.detect { |other_child| other_child.category() == "VP-A" })
+      return false
+    end
+    unless vpa_node.children.detect { |other_node| CollinsTntInterpreter.category(other_node) == "verb" }
+      return false
+    end
+
+    return true
+   
+  end
+
+  ###
+  # modal?
+  #
+  # returns true if the given node is a modal verb,
+  # else false
+  def CollinsTntInterpreter.modal?(node)
+    if node.part_of_speech() =~ /^MD/
+      return true
+    else
+      return false
+    end
+  end
+
+  ###
+  # voice
+  #
+  # given a constituent, return 
+  # - "active"/"passive" if it is a verb
+  # - nil, else
+  def CollinsTntInterpreter.voice(node) # SynNode
+
+    tobe = ["be","am","is","are","was","were"]
+
+    unless CollinsTntInterpreter.category(node) == "verb"
+      return nil
+    end
+
+    # if we have a gerund, a present tense, or an infitive  
+    # then we are sure that we have an active form
+    case CollinsTntInterpreter.pt(node)
+    when "VBG","VBP", "VBZ", "VB"
+      return "active"
+    end
+
+
+    # There is an ambiguity for many word forms between VBN (past participle - passive)
+    # and VBD (past tense - active)
+    
+    # so for these, we only say something if we can exclude one possibility,
+    # this is the case
+    # (a)  when there is a c-commanding "to be" somewhere. -> passive
+    # (b)  when there is no "to be", but a "to have" somewhere. -> active
+    
+    # collect lemmas of c-commanding verbs.
+
+    parent = node.parent
+    if parent.nil?
+      return nil
+    end
+    gp = parent.parent
+    if gp.nil?
+      return nil
+    end
+    
+#    other_verbs = Array.new
+#    
+#    current_node = node
+#    while current_node = current_node.parent 
+#      pt =  CollinsTntInterpreter.category(current_node)
+#      unless ["verb","sentence"].include? pt
+#        break
+#      end
+#      current_node.children.each {|child|
+#        if CollinsTntInterpreter.category(child) == "verb"
+#          other_verbs << CollinsTntInterpreter.lemma_backoff(nephew)
+#        end
+#      }
+#    end
+#    
+#    unless (tobe & other_verbs).empty?
+#      puts "passive "+node.id
+#      return "passive"
+#    end
+#    unless (tohave & other_verbs).empty?
+#      return "active"
+#    end
+    
+    if CollinsTntInterpreter.category(gp) == "verb" or CollinsTntInterpreter.category(gp) == "sent"
+      
+      current_node = node
+      
+      while current_node = current_node.parent 
+        pt =  CollinsTntInterpreter.category(current_node)
+        unless ["verb","sent"].include? pt
+          break
+        end
+        if current_node.children.detect {|nephew| tobe.include? CollinsTntInterpreter.lemma_backoff(nephew)}
+          return "passive"
+        end
+      end
+      # if no "to be" has been found...
+      return "active"
+    end
+    
+    # case 2: The grandfather is something else (e.g. a noun phrase)
+    # here, simple past forms are often mis-tagged as passives      
+    #
+    
+    # if we were cautious, we would return "dontknow" here; 
+    # however, these cases are so rare that it is unlikely that 
+    # assignments would be more reliable; so we rely on the 
+    # POS tag anyway.
+    
+    
+    case CollinsTntInterpreter.pt(node)
+    when "VBN","VBD"
+      return "passive"
+      # this must be some kind of error...
+    else
+      return nil
+    end    
+  end
+
+  ###
+  # gfs
+  #
+  # grammatical functions of a constituent:
+  # 
+  # returns: a list of pairs [relation(string), node(SynNode)]
+  # where <node> stands in the relation <relation> to the parameter
+  # that the method was called with
+  def CollinsTntInterpreter.gfs(anchor_node,    # SynNode
+                                sent)    # SalsaTigerSentence
+
+    return sent.syn_nodes.map { |gf_node|
+
+      case CollinsTntInterpreter.category(anchor_node)
+      when "adj"
+        rel = CollinsTntInterpreter.gf_adj(anchor_node, gf_node)
+      when "verb"
+        rel = CollinsTntInterpreter.gf_verb(anchor_node, gf_node)
+      when "noun"
+        rel = CollinsTntInterpreter.gf_noun(anchor_node, gf_node)
+      end
+
+      if rel
+        [rel, gf_node]
+      else
+        nil
+      end
+    }.compact()
+  end
+
+  ###
+  # informative_content_node
+  #
+  # for most constituents: nil
+  # for a PP, the NP
+  # for an SBAR, the VP
+  # for a VP, the embedded VP 
+  def CollinsTntInterpreter.informative_content_node(node)
+    this_pt = CollinsTntInterpreter.simplified_pt(node)
+
+    unless ["SBAR", "VP", "PP"].include? this_pt
+      return nil
+    end
+    
+    nh = CollinsTntInterpreter.head_terminal(node)
+    unless nh
+      return nil
+    end
+    headlemma = CollinsTntInterpreter.lemma_backoff(nh)
+
+    nonhead_children = node.children().reject { |n| 
+      nnh = CollinsTntInterpreter.head_terminal(n)
+      not(nnh) or 
+        CollinsTntInterpreter.lemma_backoff(nnh) == headlemma 
+    }
+    if nonhead_children.length() == 1
+      return nonhead_children.first
+    end
+
+    # more than one child:
+    # for SBAR and VP take child with head POS starting in VB,
+    # for PP child with head POS starting in NN
+    case this_pt
+    when "SBAR", "VP"
+      icont_child = nonhead_children.detect { |n|
+        h = CollinsTntInterpreter.head_terminal(n)
+        h and h.part_of_speech() =~ /^VB/
+      }
+    when "PP"
+      icont_child = nonhead_children.detect { |n|
+        h = CollinsTntInterpreter.head_terminal(n)
+        h and h.part_of_speech() =~ /^NN/
+      }
+    else
+      raise "Shouldn't be here"
+    end
+
+    if icont_child
+      return icont_child
+    else
+      return nonhead_children.first
+    end
+  end
+
+
+
+
+  ########
+  # prune?
+  # given a target node t and another node n of the syntactic structure,
+  # decide whether n is likely to instantiate a semantic role
+  # of t. If not, recommend n for pruning. 
+  #
+  # This method implements a slight variant of Xue and Palmer (EMNLP 2004).
+  # Pruning according to Xue & Palmer, EMNLP 2004:
+  # "Step 1: Designate the predicate as the current node and 
+  #    collect its sisters (constituents attached at the same level
+  #    as the predicate) unless its sisters are coordinated with the 
+  #    predicate. If a sister is a PP, also collect its immediate
+  #    children. 
+  #  Step 2: Reset the current node to its parent and repeat Step 1
+  #    till it reaches the top level node.
+  #
+  # Modifications made here:
+  # - paths of length 0 accepted in any case
+  #
+  # returns: false to recommend n for pruning, else true
+  def CollinsTntInterpreter.prune?(node, # SynNode
+                                   paths_to_target, # hash: node ID -> Path object: paths from target to node
+                                   terminal_index)  # hash: terminal node -> word index in sentence
+
+    path_to_target = paths_to_target[node.id()]
+
+    if not path_to_target
+      # no path from target to node: suggest for pruning
+
+      return 0
+
+    elsif path_to_target.length == 0 
+      # target may be its own role: definite accept
+
+      return 1
+
+    else
+      # consider path from target to node. 
+      # (1) If the path to the current node includes at least one Up
+      # and exactly one Down,  keep.
+      # (2) Else, if the path includes at least one Up and exactly two Down,
+      # and the current node's parent is a PP, keep
+      # (3) else discard
+
+      # count number of up and down steps in path to target
+      num_up = 0
+      num_down = 0
+      path_to_target.each_step { |direction, edgelabel, nodelabel, endnode|
+        case direction
+        when /U/
+          num_up += 1
+        when /D/
+          num_down += 1
+        end
+      }
+
+      # coordination sister between node and target?
+      conj_sister_between = CollinsTntInterpreter.conj_sister_between?(node, paths_to_target, 
+                                                                       terminal_index) 
+
+ 
+      if conj_sister_between
+        # coordination between me and the target -- drop
+        return 0
+      
+      elsif num_up >= 1 and num_down == 1
+        # case (1)
+        return  1
+
+      elsif num_up >= 1 and num_down == 2 and
+          (p = node.parent()) and CollinsTntInterpreter.category(p) == "prep"
+      
+        # case (2)
+        return 1
+
+      else
+        # case (3)
+        return 0
+      end
+    end
+  end
+
+
+  ###
+  private
+  
+  
+  ###
+  # given an anchor node and another node that may be some
+  # grammatical function of the anchor node:
+  # return the grammatical function (string) if found,
+  # else nil.
+  #
+  # here: anchor node is verb.
+  def CollinsTntInterpreter.gf_verb(anchor_node, # SynNode
+                                    gf_node) # SynNode
+
+    # first classification: according to constituent type
+    cat = CollinsTntInterpreter.category(gf_node)
+    if cat.nil?
+      return nil
+    end
+    
+    # second classification: according to path 
+    path = CollinsTntInterpreter.path_between(anchor_node, gf_node)
+    if path.nil?
+      # no path between anchor node and gf node
+      return nil
+    end
+
+    path.set_cutoff_last_pt_on_printing(true)
+    path_string = path.print(true,false,true)
+    
+    case path_string
+    when "U VP D ", "U SG D "
+      categ2 = "inside"
+    when /^U (VP U )*S(BAR)? D $/
+      categ2 = "external"
+    when /^U (VP U )*VP D ADVP D $/
+      categ2 = "external"
+    else
+      categ2 = ""
+    end
+    
+    # now evaluate based on both
+    case cat+ "+" + categ2
+    when "noun+inside"
+      # direct object
+      return  "OA"
+      
+    when "noun+external"
+      unless CollinsTntInterpreter.relative_position(gf_node, anchor_node) == "LEFT"
+        return nil
+      end
+
+      if CollinsTntInterpreter.voice(anchor_node) == "passive"
+        return "OA"
+      else
+        return "SB"
+      end
+      
+    when "prep+inside"
+      if CollinsTntInterpreter.voice(anchor_node) == "passive" and 
+          CollinsTntInterpreter.preposition(gf_node) == "by"
+	return "SB"
+      else
+	return "MO-" + CollinsTntInterpreter.preposition(gf_node).to_s
+      end
+      
+    when "sent+inside"
+      return  "OC"
+      
+    when "sent+external"
+      return  "OC"
+      
+    else
+      return nil
+    end
+  end
+  
+  ###
+  # given an anchor node and another node that may be some
+  # grammatical function of the anchor node:
+  # return the grammatical function (string) if found,
+  # else nil.
+  #
+  # here: anchor node is noun.
+  def CollinsTntInterpreter.gf_noun(anchor_node,  # SynNode
+                                    gf_node)      # SynNode
+
+    # first classification: according to constituent type
+    cat = CollinsTntInterpreter.category(gf_node)
+    if cat.nil?
+      return nil
+    end
+
+    # second classification: according to path
+    path = CollinsTntInterpreter.path_between(anchor_node, gf_node)
+    if path.nil?
+      # no path between anchor node and gf node
+      return nil
+    end
+
+    path.set_cutoff_last_pt_on_printing(true)
+    path_string = path.print(true,false,true)
+    
+    case path_string
+    when "U NPB D "
+      categ2 = "np-neighbor"
+    when "U NPB U NP D "
+      categ2 = "np-parent"
+    when "U NP D "
+      categ2 = "np-a"
+    when /^U NPB (U NP )?(U NP )?U S(BAR)? D( VP D)? $/
+      categ2 = "beyond-s"
+    when /^U NP(B)? (U NP )?U VP D $/
+      categ2 = "beyond-vp"
+    when /^U NPB (U NP )?(U NP)?U PP U VP(-A)? D $/
+      categ2 = "beyond-pp-vp"
+    else
+      categ2 = ""
+    end
+
+    # now evaluate based on both
+    case cat + "+" + categ2
+    when "noun+np-neighbor"
+      return "AG"
+
+    when "sent+np-parent"
+      return "OC"
+
+    when "prep+np-parent", "prep+np-a"
+      return "MO-" + CollinsTntInterpreter.preposition(gf_node).to_s
+      # relation of anchor noun to governing verb not covered by "gfs" method
+#     when "verb+beyond-s"
+#       return "SB-of"
+
+#     when "verb+beyond-vp"
+#       return "OA-of"
+
+#     when "verb+beyond-pp-vp"
+#       return "MO-of"
+    else
+      return nil
+    end
+  end
+  
+
+  ###
+  # given an anchor node and another node that may be some
+  # grammatical function of the anchor node:
+  # return the grammatical function (string) if found,
+  # else nil.
+  #
+  # here: anchor node is adjective.
+  def CollinsTntInterpreter.gf_adj(anchor_node,  # SynNode
+                                   gf_node)      # SynNode
+    
+    # first classification: according to constituent type
+    cat = CollinsTntInterpreter.category(gf_node)
+    if cat.nil?
+      return nil
+    end
+
+    # second classification: according to path
+    path = CollinsTntInterpreter.path_between(anchor_node, gf_node)
+    if path.nil?
+      # no path between anchor node and gf node
+      return nil
+    end
+
+    path.set_cutoff_last_pt_on_printing(true)
+    path_string = path.print(true,false,true)
+    
+    case path_string
+    when /^(U ADJP )?U NPB D $/
+      categ2 = "nnpath"
+    when "U ADJP D "
+      categ2 = "adjp-neighbor"
+    when /^(U ADJP )?U (VP U )?S(BAR)? D $/
+      categ2 = "s"
+    when /^U (ADJP U )?VP D $/
+      categ2 = "vp"
+    else
+      categ2 = ""
+    end
+    
+    # now evaluate based on both
+    case cat + "+" + categ2
+    when "noun+nnpath"
+      return "HD"
+    when "verb+adjp-neighbor"
+      return "OC"
+    when "prep+vp", "prep+adjp-neighbor"
+      return "MO-" + CollinsTntInterpreter.preposition(gf_node).to_s
+    else
+      return nil
+    end
+  end
+
+  ####
+  # auxiliary of prune?:
+  #
+  # given a node and a hash mapping node IDs to paths to target:
+  # Does that node have a sister that is a coordination and that 
+  # is between it and the target?
+  #
+  def CollinsTntInterpreter.conj_sister_between?(node, # SynNode
+                                                 paths_to_target, # Hash: node ID -> Path obj: path from node to target
+                                                 ti)  # hash: terminal node -> word index in sentence
+
+    # does node have sisters that represent coordination?
+    unless (p = node.parent())
+      return false
+    end
+
+    unless (conj_sisters = p.children.select { |sib| 
+              sib != node and CollinsTntInterpreter.category(sib) == "con" 
+            } ) and
+        not (conj_sisters.empty?)
+      return false
+    end
+
+    # represent each coordination sister, and the node itself,
+    # as a triple [node, leftmost terminal index(node), rightmost terminal index(node)
+    conj_sisters = conj_sisters.map { |n|
+      [n, CollinsTntInterpreter.lti(n, ti), CollinsTntInterpreter.rti(n, ti)]
+    }
+
+    this_triple = [node, CollinsTntInterpreter.lti(node, ti), CollinsTntInterpreter.rti(node, ti)]
+
+    # sisters closer to the target than node:
+    # also map to triples
+    sisters_closer_to_target = p.children.select { |sib|
+      sib != node and 
+        not(conj_sisters.include? sib) and
+        paths_to_target[sib.id()] and 
+        paths_to_target[sib.id()].length() < paths_to_target[node.id()].length
+    }.map { |n|
+      [n, CollinsTntInterpreter.lti(n, ti), CollinsTntInterpreter.rti(n, ti)]
+    }
+      
+    if sisters_closer_to_target.empty?
+      return false
+    end
+
+    # is there any coordination sister that is inbetween this node
+    # and some sister that is closer to the target?
+    # if so, return true
+    conj_sisters.each { |conj_triple|
+      if leftof(conj_triple, this_triple) and 
+          sisters_closer_to_target.detect { |s| CollinsTntInterpreter.leftof(s, conj_triple) }
+        
+        return true
+
+      elsif rightof(conj_triple, this_triple) and
+          sisters_closer_to_target.detect { |s| CollinsTntInterpreter.rightof(s, conj_triple) }
+            
+        return true
+      end
+    }
+    
+    # else return false
+    return false
+  end
+
+  ###
+  # lti, rti: terminal index of the leftmost/rightmost terminal of
+  # a given node (SynNode)
+  #
+  # auxiliary of conj_sister_between?
+  def CollinsTntInterpreter.lti(node, # SynNode
+                                terminal_index) # hash: terminal node -> word index in sentence
+    lt = CollinsTntInterpreter.leftmost_terminal(node)
+    unless lt
+      return nil
+    end
+
+    return terminal_index[lt]
+  end
+
+  def CollinsTntInterpreter.rti(node, # SynNode
+                                terminal_index) # hash: terminal node -> word index in sentence
+    rt = CollinsTntInterpreter.rightmost_terminal(node)
+    unless rt
+      return nil
+    end
+    
+    return terminal_index[rt]
+  end
+
+  ###
+  # leftof, rightof: given 2 triples 
+  # [node(SynNode), index of leftmost terminal(integer/nil), index of rightmost terminal(integer/nil),
+  # 
+  # auxiliaries of conj_sister_between?
+  #
+  # return true if both leftmost and rightmost terminal indices of the first triple are
+  # smaller than (for leftof) / bigger than (for rightof) the
+  # corresponding indices of the second triple
+  #
+  # return false if some index is nil
+  def CollinsTntInterpreter.leftof(triple1,
+                                   triple2)
+    dummy, lm1, rm1 = triple1
+    dummy, lm2, rm2 = triple2
+
+    if lm1.nil? or rm1.nil? or lm2.nil? or rm2.nil?
+      return false
+    elsif lm1 < lm2 and rm1 < rm2
+      return true
+    else
+      return false
+    end
+  end
+
+  def CollinsTntInterpreter.rightof(triple1, 
+                                    triple2)
+    dummy, lm1, rm1 = triple1
+    dummy, lm2, rm2 = triple2
+    
+    if lm1.nil? or rm1.nil? or lm2.nil? or rm2.nil?
+      return false
+    elsif lm1 > lm2 and rm1 > rm2
+      return true
+    else
+      return false
+    end
+  end
+end
+
+
+# use TreeTagger as replacement for TnT; re-use everything, but use treetagger as POS tagger
+
+class CollinsTreeTaggerInterpreter < CollinsTntInterpreter
+  CollinsTreeTaggerInterpreter.announce_me()
+
+  def CollinsTreeTaggerInterpreter.systems()
+    return {
+      "pos_tagger" => "treetagger",
+      "parser" => "collins"
+    }
+  end
+end
+