/// <summary>
/// This is the main constructor used
/// </summary>
public GrammaticalRelation(Language language,
string shortName,
string longName,
GrammaticalRelation parent,
string sourcePattern,
TregexPatternCompiler tregexCompiler,
string[] targetPatterns) :
this(language, shortName, longName, parent, sourcePattern, tregexCompiler, targetPatterns, null)
{
}
/// <summary>
/// Compile the
/// <see cref="annotations"/>
/// collection given a
/// particular head finder. Subclasses should call this method at
/// least once before the class is used, and whenever the head finder
/// is changed.
/// </summary>
protected internal virtual void CompileAnnotations(IHeadFinder hf)
{
TregexPatternCompiler compiler = new TregexPatternCompiler(hf);
annotationPatterns.Clear();
foreach (KeyValuePair <string, Pair <string, Func <TregexMatcher, string> > > annotation in annotations)
{
TregexPattern compiled;
try
{
compiled = compiler.Compile(annotation.Value.First());
}
catch (TregexParseException e)
{
int nth = annotationPatterns.Count + 1;
log.Info("Parse exception on annotation pattern #" + nth + " initialization: " + e);
continue;
}
Pair <TregexPattern, Func <TregexMatcher, string> > behavior = new Pair <TregexPattern, Func <TregexMatcher, string> >(compiled, annotation.Value.Second());
annotationPatterns[annotation.Key] = behavior;
}
}
/// <summary>
/// Parses and compiles all operations from a BufferedReader into a list
/// of pairs of tregex and tsurgeon patterns.
/// </summary>
/// <param name="reader">A BufferedReader to read the operations</param>
/// <returns>A pair of a tregex and tsurgeon pattern read from reader</returns>
/// <exception cref="System.IO.IOException">If there is any I/O problem</exception>
public static IList <Pair <TregexPattern, TsurgeonPattern> > GetOperationsFromReader(BufferedReader reader, TregexPatternCompiler compiler)
{
IList <Pair <TregexPattern, TsurgeonPattern> > operations = new List <Pair <TregexPattern, TsurgeonPattern> >();
for (; ;)
{
Pair <TregexPattern, TsurgeonPattern> operation = GetOperationFromReader(reader, compiler);
if (operation == null)
{
break;
}
operations.Add(operation);
}
return(operations);
}
/// <summary>
/// Parses a tsurgeon script file and compiles all operations in the file into a list
/// of pairs of tregex and tsurgeon patterns.
/// </summary>
/// <param name="filename">A file, classpath resource or URL (perhaps gzipped) containing the tsurgeon script</param>
/// <returns>A pair of a tregex and tsurgeon pattern read from a file</returns>
/// <exception cref="System.IO.IOException">If there is any I/O problem</exception>
public static IList <Pair <TregexPattern, TsurgeonPattern> > GetOperationsFromFile(string filename, string encoding, TregexPatternCompiler compiler)
{
BufferedReader reader = IOUtils.ReaderFromString(filename, encoding);
IList <Pair <TregexPattern, TsurgeonPattern> > operations = GetOperationsFromReader(reader, compiler);
reader.Close();
return(operations);
}
/// <summary>
/// Parses a tsurgeon script text input and compiles a tregex pattern and a list
/// of tsurgeon operations into a pair.
/// </summary>
/// <param name="reader">Reader to read patterns from</param>
/// <returns>
/// A pair of a tregex and tsurgeon pattern read from a file, or
/// <see langword="null"/>
/// when the operations present in the Reader have been exhausted
/// </returns>
/// <exception cref="System.IO.IOException">If any IO problem</exception>
public static Pair <TregexPattern, TsurgeonPattern> GetOperationFromReader(BufferedReader reader, TregexPatternCompiler compiler)
{
string patternString = GetTregexPatternFromReader(reader);
// log.info("Read tregex pattern: " + patternString);
if (patternString.IsEmpty())
{
return(null);
}
TregexPattern matchPattern = compiler.Compile(patternString);
TsurgeonPattern collectedPattern = GetTsurgeonOperationsFromReader(reader);
return(new Pair <TregexPattern, TsurgeonPattern>(matchPattern, collectedPattern));
}
// = false;
// not an instantiable class
/// <summary>Usage: java edu.stanford.nlp.trees.tregex.tsurgeon.Tsurgeon [-s] -treeFile file-with-trees [-po matching-pattern operation] operation-file-1 operation-file-2 ...</summary>
/// <remarks>
/// Usage: java edu.stanford.nlp.trees.tregex.tsurgeon.Tsurgeon [-s] -treeFile file-with-trees [-po matching-pattern operation] operation-file-1 operation-file-2 ... operation-file-n
/// <h4>Arguments:</h4>
/// Each argument should be the name of a transformation file that contains a list of pattern
/// and transformation operation list pairs. That is, it is a sequence of pairs of a
/// <see cref="Edu.Stanford.Nlp.Trees.Tregex.TregexPattern"/>
/// pattern on one or more lines, then a
/// blank line (empty or whitespace), then a list of transformation operations one per line
/// (as specified by <b>Legal operation syntax</b> below) to apply when the pattern is matched,
/// and then another blank line (empty or whitespace).
/// Note the need for blank lines: The code crashes if they are not present as separators
/// (although the blank line at the end of the file can be omitted).
/// The script file can include comment lines, either whole comment lines or
/// trailing comments introduced by %, which extend to the end of line. A needed percent
/// mark can be escaped by a preceding backslash.
/// <p>
/// For example, if you want to excise an SBARQ node whenever it is the parent of an SQ node,
/// and relabel the SQ node to S, your transformation file would look like this:
/// <blockquote>
/// <code>
/// SBARQ=n1 < SQ=n2<br />
/// <br />
/// excise n1 n1<br />
/// relabel n2 S
/// </code>
/// </blockquote>
/// <h4>Options:</h4>
/// <ul>
/// <li>
/// <c>-treeFile <filename></c>
/// specify the name of the file that has the trees you want to transform.
/// <li>
/// <c>-po <matchPattern> <operation></c>
/// Apply a single operation to every tree using the specified match pattern and the specified operation. Use this option
/// when you want to quickly try the effect of one pattern/surgery combination, and are too lazy to write a transformation file.
/// <li>
/// <c>-s</c>
/// Print each output tree on one line (default is pretty-printing).
/// <li>
/// <c>-m</c>
/// For every tree that had a matching pattern, print "before" (prepended as "Operated on:") and "after" (prepended as "Result:"). Unoperated on trees just pass through the transducer as usual.
/// <li>
/// <c>-encoding X</c>
/// Uses character set X for input and output of trees.
/// <li>
/// <c>-macros <filename></c>
/// A file of macros to use on the tregex pattern. Macros should be one per line, with original and replacement separated by tabs.
/// <li>
/// <c>-hf <headFinder-class-name></c>
/// use the specified
/// <see cref="Edu.Stanford.Nlp.Trees.IHeadFinder"/>
/// class to determine headship relations.
/// <li>
/// <c>-hfArg <string></c>
/// pass a string argument in to the
/// <see cref="Edu.Stanford.Nlp.Trees.IHeadFinder"/>
/// class's constructor.
/// <c>-hfArg</c>
/// can be used multiple times to pass in multiple arguments.
/// <li>
/// <c>-trf <TreeReaderFactory-class-name></c>
/// use the specified
/// <see cref="Edu.Stanford.Nlp.Trees.ITreeReaderFactory"/>
/// class to read trees from files.
/// </ul>
/// <h4>Legal operation syntax:</h4>
/// <ul>
/// <li>
/// <c>delete <name></c>
/// deletes the node and everything below it.
/// <li>
/// <c>prune <name></c>
/// Like delete, but if, after the pruning, the parent has no children anymore, the parent is pruned too. Pruning continues to affect all ancestors until one is found with remaining children. This may result in a null tree.
/// <li>
/// <c>excise <name1> <name2></c>
/// The name1 node should either dominate or be the same as the name2 node. This excises out everything from
/// name1 to name2. All the children of name2 go into the parent of name1, where name1 was.
/// <li>
/// <c>relabel <name> <new-label></c>
/// Relabels the node to have the new label. <br />
/// There are three possible forms: <br />
/// <c>relabel nodeX VP</c>
/// - for changing a node label to an
/// alphanumeric string <br />
/// <c>relabel nodeX /''/</c>
/// - for relabeling a node to
/// something that isn't a valid identifier without quoting <br />
/// <c>relabel nodeX /^VB(.*)$/verb\\/$1/</c>
/// - for regular
/// expression based relabeling. In this case, all matches of the
/// regular expression against the node label are replaced with the
/// replacement String. This has the semantics of Java/Perl's
/// replaceAll: you may use capturing groups and put them in
/// replacements with $n. For example, if the pattern is /foo/bar/
/// and the node matched is "foo", the replaceAll semantics result in
/// "barbar". If the pattern is /^foo(.*)$/bar$1/ and node matched is
/// "foofoo", relabel will result in "barfoo". <br />
/// When using the regex replacement method, you can also use the
/// sequences ={node} and %{var} in the replacement string to use
/// captured nodes or variable strings in the replacement string.
/// For example, if the Tregex pattern was "duck=bar" and the relabel
/// is /foo/={bar}/, "foofoo" will be replaced with "duckduck". <br />
/// To concatenate two nodes named in the tregex pattern, for
/// example, you can use the pattern /^.*$/={foo}={bar}/. Note that
/// the ^.*$ is necessary to make sure the regex pattern only matches
/// and replaces once on the entire node name. <br />
/// To get an "=" or a "%" in the replacement, using \ escaping.
/// Also, as in the example you can escape a slash in the middle of
/// the second and third forms with \\/ and \\\\. <br />
/// <li>
/// <c>insert <name> <position></c>
/// or
/// <c>insert <tree> <position></c>
/// inserts the named node or tree into the position specified.
/// <li>
/// <c>move <name> <position></c>
/// moves the named node into the specified position.
/// <p>Right now the only ways to specify position are:
/// <p>
/// <c>$+ <name></c>
/// the left sister of the named node<br />
/// <c>$- <name></c>
/// the right sister of the named node<br />
/// <c>>i <name></c>
/// the i_th daughter of the named node<br />
/// <c>>-i <name></c>
/// the i_th daughter, counting from the right, of the named node.
/// <li>
/// <c>replace <name1> <name2></c>
/// deletes name1 and inserts a copy of name2 in its place.
/// <li>
/// <c>replace <name> <tree> <tree2>...</c>
/// deletes name and inserts the new tree(s) in its place. If
/// more than one replacement tree is given, each of the new
/// subtrees will be added in order where the old tree was.
/// Multiple subtrees at the root is an illegal operation and
/// will throw an exception.
/// <li>
/// <c>createSubtree <auxiliary-tree-or-label> <name1> [<name2>]</c>
/// Create a subtree out of all the nodes from
/// <c><name1></c>
/// through
/// <c><name2></c>
/// . The subtree is moved to the foot of the given
/// auxiliary tree, and the tree is inserted where the nodes of
/// the subtree used to reside. If a simple label is provided as
/// the first argument, the subtree is given a single parent with
/// a name corresponding to the label. To limit the operation to
/// just one node, elide
/// <c><name2></c>
/// .
/// <li>
/// <c>adjoin <auxiliary_tree> <name></c>
/// Adjoins the specified auxiliary tree into the named node.
/// The daughters of the target node will become the daughters of the foot of the auxiliary tree.
/// <li>
/// <c>adjoinH <auxiliary_tree> <name></c>
/// Similar to adjoin, but preserves the target node
/// and makes it the root of
/// <c><tree></c>
/// . (It is still accessible as
/// <c>name</c>
/// . The root of the
/// auxiliary tree is ignored.)
/// <li>
/// <c>adjoinF <auxiliary_tree> <name></c>
/// Similar to adjoin,
/// but preserves the target node and makes it the foot of
/// <c><tree></c>
/// .
/// (It is still accessible as
/// <c>name</c>
/// , and retains its status as parent of its children.
/// The root of the auxiliary tree is ignored.)
/// <li> <dt>
/// <c>coindex <name1> <name2> ... <nameM></c>
/// Puts a (Penn Treebank style)
/// coindexation suffix of the form "-N" on each of nodes name_1 through name_m. The value of N will be
/// automatically generated in reference to the existing coindexations in the tree, so that there is never
/// an accidental clash of indices across things that are not meant to be coindexed.
/// </ul>
/// <p>
/// In the context of
/// <c>adjoin</c>
/// ,
/// <c>adjoinH</c>
/// ,
/// <c>adjoinF</c>
/// , and
/// <c>createSubtree</c>
/// , an auxiliary
/// tree is a tree in Penn Treebank format with
/// <c>@</c>
/// on
/// exactly one of the leaves denoting the foot of the tree.
/// The operations which use the foot use the labeled node.
/// For example:
/// </p>
/// <blockquote>
/// Tsurgeon:
/// <c>adjoin (FOO (BAR@)) foo</c>
/// <br />
/// Tregex:
/// <c>B=foo</c>
/// <br />
/// Input:
/// <c>(A (B 1 2))</c>
/// Output:
/// <c>(A (FOO (BAR 1 2)))</c>
/// </blockquote>
/// <p>
/// Tsurgeon applies the same operation to the same tree for as long
/// as the given tregex operation matches. This means that infinite
/// loops are very easy to cause. One common situation where this comes up
/// is with an insert operation will repeats infinitely many times
/// unless you add an expression to the tregex that matches against
/// the inserted pattern. For example, this pattern will infinite loop:
/// </p>
/// <blockquote>
/// <code>
/// TregexPattern tregex = TregexPattern.compile("S=node << NP"); <br />
/// TsurgeonPattern tsurgeon = Tsurgeon.parseOperation("insert (NP foo) >-1 node");
/// </code>
/// </blockquote>
/// <p>
/// This pattern, though, will terminate:
/// </p>
/// <blockquote>
/// <code>
/// TregexPattern tregex = TregexPattern.compile("S=node << NP !<< foo"); <br />
/// TsurgeonPattern tsurgeon = Tsurgeon.parseOperation("insert (NP foo) >-1 node");
/// </code>
/// </blockquote>
/// <p>
/// Tsurgeon has (very) limited support for conditional statements.
/// If a pattern is prefaced with
/// <c>if exists <name></c>
/// ,
/// the rest of the pattern will only execute if
/// the named node was found in the corresponding TregexMatcher.
/// </p>
/// </remarks>
/// <param name="args">
/// a list of names of files each of which contains a single tregex matching pattern plus a list, one per line,
/// of transformation operations to apply to the matched pattern.
/// </param>
/// <exception cref="System.Exception">If an I/O or pattern syntax error</exception>
public static void Main(string[] args)
{
string headFinderClassName = null;
string headFinderOption = "-hf";
string[] headFinderArgs = null;
string headFinderArgOption = "-hfArg";
string encoding = "UTF-8";
string encodingOption = "-encoding";
if (args.Length == 0)
{
log.Info("Usage: java edu.stanford.nlp.trees.tregex.tsurgeon.Tsurgeon [-s] -treeFile <file-with-trees> [-po <matching-pattern> <operation>] <operation-file-1> <operation-file-2> ... <operation-file-n>");
System.Environment.Exit(0);
}
string treePrintFormats;
string singleLineOption = "-s";
string verboseOption = "-v";
string matchedOption = "-m";
// if set, then print original form of trees that are matched & thus operated on
string patternOperationOption = "-po";
string treeFileOption = "-treeFile";
string trfOption = "-trf";
string macroOption = "-macros";
string macroFilename = string.Empty;
IDictionary <string, int> flagMap = Generics.NewHashMap();
flagMap[patternOperationOption] = 2;
flagMap[treeFileOption] = 1;
flagMap[trfOption] = 1;
flagMap[singleLineOption] = 0;
flagMap[encodingOption] = 1;
flagMap[headFinderOption] = 1;
flagMap[macroOption] = 1;
IDictionary <string, string[]> argsMap = StringUtils.ArgsToMap(args, flagMap);
args = argsMap[null];
if (argsMap.Contains(headFinderOption))
{
headFinderClassName = argsMap[headFinderOption][0];
}
if (argsMap.Contains(headFinderArgOption))
{
headFinderArgs = argsMap[headFinderArgOption];
}
if (argsMap.Contains(verboseOption))
{
verbose = true;
}
if (argsMap.Contains(singleLineOption))
{
treePrintFormats = "oneline,";
}
else
{
treePrintFormats = "penn,";
}
if (argsMap.Contains(encodingOption))
{
encoding = argsMap[encodingOption][0];
}
if (argsMap.Contains(macroOption))
{
macroFilename = argsMap[macroOption][0];
}
TreePrint tp = new TreePrint(treePrintFormats, new PennTreebankLanguagePack());
PrintWriter pwOut = new PrintWriter(new OutputStreamWriter(System.Console.Out, encoding), true);
ITreeReaderFactory trf;
if (argsMap.Contains(trfOption))
{
string trfClass = argsMap[trfOption][0];
trf = ReflectionLoading.LoadByReflection(trfClass);
}
else
{
trf = new TregexPattern.TRegexTreeReaderFactory();
}
Treebank trees = new DiskTreebank(trf, encoding);
if (argsMap.Contains(treeFileOption))
{
trees.LoadPath(argsMap[treeFileOption][0]);
}
if (trees.IsEmpty())
{
log.Info("Warning: No trees specified to operate on. Use -treeFile path option.");
}
TregexPatternCompiler compiler;
if (headFinderClassName == null)
{
compiler = new TregexPatternCompiler();
}
else
{
IHeadFinder hf;
if (headFinderArgs == null)
{
hf = ReflectionLoading.LoadByReflection(headFinderClassName);
}
else
{
hf = ReflectionLoading.LoadByReflection(headFinderClassName, (object[])headFinderArgs);
}
compiler = new TregexPatternCompiler(hf);
}
Macros.AddAllMacros(compiler, macroFilename, encoding);
IList <Pair <TregexPattern, TsurgeonPattern> > ops = new List <Pair <TregexPattern, TsurgeonPattern> >();
if (argsMap.Contains(patternOperationOption))
{
TregexPattern matchPattern = compiler.Compile(argsMap[patternOperationOption][0]);
TsurgeonPattern p = ParseOperation(argsMap[patternOperationOption][1]);
ops.Add(new Pair <TregexPattern, TsurgeonPattern>(matchPattern, p));
}
else
{
foreach (string arg in args)
{
IList <Pair <TregexPattern, TsurgeonPattern> > pairs = GetOperationsFromFile(arg, encoding, compiler);
foreach (Pair <TregexPattern, TsurgeonPattern> pair in pairs)
{
if (verbose)
{
log.Info(pair.Second());
}
ops.Add(pair);
}
}
}
foreach (Tree t in trees)
{
Tree original = t.DeepCopy();
Tree result = ProcessPatternsOnTree(ops, t);
if (argsMap.Contains(matchedOption) && matchedOnTree)
{
pwOut.Println("Operated on: ");
DisplayTree(original, tp, pwOut);
pwOut.Println("Result: ");
}
DisplayTree(result, tp, pwOut);
}
}
// to hold the specific prep or conjunction associated with the grammatical relation
// TODO document constructor
// TODO change to put specificString after longName, and then use string... for targetPatterns
private GrammaticalRelation(Language language,
string shortName,
string longName,
GrammaticalRelation parent,
string sourcePattern,
TregexPatternCompiler tregexCompiler,
string[] targetPatterns,
string specificString)
{
this.language = language;
this.shortName = shortName;
this.longName = longName;
this.parent = parent;
this.specific = specificString; // this can be null!
if (parent != null)
{
parent.AddChild(this);
}
if (sourcePattern != null)
{
/*try {*/
this.sourcePattern = new Regex("^(" + sourcePattern + ")$", RegexOptions.Compiled);
/*} catch (java.util.regex.PatternSyntaxException e) {
* throw new RuntimeException("Bad pattern: " + sourcePattern);
* }*/
}
else
{
this.sourcePattern = null;
}
foreach (string pattern in targetPatterns)
{
try
{
TregexPattern p = tregexCompiler.Compile(pattern);
this.targetPatterns.Add(p);
}
catch (TregexParseException pe)
{
throw new SystemException("Bad pattern: " + pattern, pe);
}
}
Dictionary <string, GrammaticalRelation> sToR;
StringsToRelations.TryGetValue(language, out sToR);
if (sToR == null)
{
sToR = new Dictionary <string, GrammaticalRelation>();
StringsToRelations.Add(language, sToR);
}
if (sToR.ContainsKey(ToString()))
{
var previous = sToR[ToString()];
if (!previous.IsFromString() && !IsFromString())
{
throw new ArgumentException("There is already a relation named " + ToString() + '!');
}
else
{
/* We get here if we previously just built a fake relation from a string
* we previously read in from a file.
*/
// TODO is it worth copying all of the information from this real
// relation into the old fake one?
}
sToR[ToString()] = this;
}
else
{
sToR.Add(ToString(), this);
}
/*GrammaticalRelation previous = sToR.put(ToString(), this);
* if (previous != null) {
* if (!previous.isFromString() && !isFromString()) {
* throw new ArgumentException("There is already a relation named " + ToString() + '!');
* } else {
* /* We get here if we previously just built a fake relation from a string
* we previously read in from a file.
#1#
* // TODO is it worth copying all of the information from this real
* // relation into the old fake one?
* }
* }*/
}
private GrammaticalRelation(Language language, string shortName, string longName, Edu.Stanford.Nlp.Trees.GrammaticalRelation parent, string sourcePattern, TregexPatternCompiler tregexCompiler, string[] targetPatterns, string specificString)
{
/* Non-static stuff */
// a regexp for node values at which this relation can hold
// to hold the specific prep or conjunction associated with the grammatical relation
// TODO document constructor
// TODO change to put specificString after longName, and then use String... for targetPatterns
this.language = language;
this.shortName = shortName;
this.longName = longName;
this.parent = parent;
this.specific = specificString;
// this can be null!
if (parent != null)
{
parent.AddChild(this);
}
if (sourcePattern != null)
{
try
{
this.sourcePattern = Pattern.Compile(sourcePattern);
}
catch (PatternSyntaxException)
{
throw new Exception("Bad pattern: " + sourcePattern);
}
}
else
{
this.sourcePattern = null;
}
foreach (string pattern in targetPatterns)
{
try
{
TregexPattern p = tregexCompiler.Compile(pattern);
this.targetPatterns.Add(p);
}
catch (TregexParseException pe)
{
throw new Exception("Bad pattern: " + pattern, pe);
}
}
Edu.Stanford.Nlp.Trees.GrammaticalRelation previous;
lock (stringsToRelations)
{
IDictionary <string, Edu.Stanford.Nlp.Trees.GrammaticalRelation> sToR = stringsToRelations[language];
if (sToR == null)
{
sToR = Generics.NewHashMap();
stringsToRelations[language] = sToR;
}
previous = sToR[ToString()] = this;
}
if (previous != null)
{
if (!previous.IsFromString() && !IsFromString())
{
throw new ArgumentException("There is already a relation named " + ToString() + '!');
}
}
}
