Add output exception "feature" to compound rules & do XML config

Author: AndyBlack

src/SIL.Machine.Morphology.HermitCrab/HermitCrabInput.dtd

@@ -371,8 +371,11 @@
   nonheadPartsOfSpeech refers to one or more PartOfSpeech IDs
   headSubcategorizedRules refers to one or more SyntacticRule IDs
   nonheadSubcategorizedRules refers to one or more SyntacticRule IDs
+  headProdRestrictionsMprFeatures refers to zero or more exception "features" IDs
+  nonHeadProdRestrictionsMprFeatures refers to zero or more exception "features" IDs
   outputPartOfSpeech refers to a PartOfSpeech ID
   outputSubcategorization refers to one or more SyntacticRule IDs
+  outputProdRestrictionsMprFeatures refers to zero or more exception "features" IDs
   outputObligatoryFeatures refers to one or more (HeadFeature) FeatureDefinition IDs
   (Note: what was Output Subcategorization (sub) in the text form of Hermit Crab has been split into
     the outputSubcategorization attribute plus the OutputSubcategorizationOverrides element (and its content).)
@@ -388,8 +391,11 @@
   nonHeadPartsOfSpeech IDREFS #IMPLIED
   headSubcategorizedRules IDREFS #IMPLIED
   nonHeadSubcategorizedRules IDREFS #IMPLIED
+  headProdRestrictionsMprFeatures IDREFS #IMPLIED
+  nonHeadProdRestrictionsMprFeatures IDREFS #IMPLIED
   outputPartOfSpeech IDREF #IMPLIED
   outputSubcategorization IDREFS #IMPLIED
+  outputProdRestrictionsMprFeatures IDREFS #IMPLIED
   outputObligatoryFeatures IDREFS #IMPLIED
 >
 

src/SIL.Machine.Morphology.HermitCrab/MorphologicalRules/CompoundingRule.cs

@@ -22,6 +22,7 @@ public CompoundingRule()
             NonHeadRequiredSyntacticFeatureStruct = FeatureStruct.New().Value;
             HeadProdRestrictionsMprFeatures = new MprFeatureSet();
             NonHeadProdRestrictionsMprFeatures = new MprFeatureSet();
+            OutputProdRestrictionsMprFeatures = new MprFeatureSet();
             OutSyntacticFeatureStruct = FeatureStruct.New().Value;
 
             _subrules = new List<CompoundingSubrule>();
@@ -46,6 +47,8 @@ public IList<CompoundingSubrule> Subrules
 
         public MprFeatureSet NonHeadProdRestrictionsMprFeatures { get; set; }
 
+        public MprFeatureSet OutputProdRestrictionsMprFeatures { get; set; }
+
         public FeatureStruct OutSyntacticFeatureStruct { get; set; }
 
         public ICollection<Feature> ObligatorySyntacticFeatures

src/SIL.Machine.Morphology.HermitCrab/MorphologicalRules/SynthesisCompoundingRule.cs

@@ -176,6 +176,7 @@ public IEnumerable<Word> Apply(Word input)
                         Word outWord = ApplySubrule(_rule.Subrules[i], headMatch, nonHeadMatch);
 
                         outWord.MprFeatures.AddOutput(_rule.Subrules[i].OutMprFeatures);
+                        outWord.MprFeatures.AddOutput(_rule.OutputProdRestrictionsMprFeatures);
 
                         outWord.SyntacticFeatureStruct = syntacticFS;
                         outWord.SyntacticFeatureStruct.PriorityUnion(_rule.OutSyntacticFeatureStruct);

src/SIL.Machine.Morphology.HermitCrab/XmlLanguageLoader.cs

@@ -1214,6 +1214,16 @@ out IMorphologicalRule mrule
             fs.Freeze();
             compRule.OutSyntacticFeatureStruct = fs;
 
+            compRule.HeadProdRestrictionsMprFeatures.UnionWith(
+                LoadMprFeatures((string)compRuleElem.Attribute("headProdRestrictionsMprFeatures"))
+            );
+            compRule.NonHeadProdRestrictionsMprFeatures.UnionWith(
+                LoadMprFeatures((string)compRuleElem.Attribute("nonHeadProdRestrictionsMprFeatures"))
+            );
+            compRule.OutputProdRestrictionsMprFeatures.UnionWith(
+                LoadMprFeatures((string)compRuleElem.Attribute("outputProdRestrictionsMprFeatures"))
+            );
+
             var obligHeadIDsStr = (string)compRuleElem.Attribute("outputObligatoryFeatures");
             if (!string.IsNullOrEmpty(obligHeadIDsStr))
             {

src/SIL.Machine.Morphology.HermitCrab/XmlLanguageWriter.cs

@@ -836,6 +836,26 @@ private XElement WriteCompoundingRule(CompoundingRule crule, Dictionary<IMorphol
             if (nonHeadRequiredFootFS != null)
                 ruleElem.Add(new XElement("NonHeadRequiredFootFeatures", WriteFeatureStruct(nonHeadRequiredFootFS)));
 
+            MprFeatureSet headProdRestrictionsMprFeatures = crule.HeadProdRestrictionsMprFeatures;
+            if (headProdRestrictionsMprFeatures.Count > 0)
+                ruleElem.Add(
+                    WriteIDs("headProdRestrictionsMprFeatures", crule.HeadProdRestrictionsMprFeatures, _mprFeatures)
+                );
+            MprFeatureSet nonHeadProdRestrictionsMprFeatures = crule.NonHeadProdRestrictionsMprFeatures;
+            if (nonHeadProdRestrictionsMprFeatures.Count > 0)
+                ruleElem.Add(
+                    WriteIDs(
+                        "nonHeadProdRestrictionsMprFeatures",
+                        crule.NonHeadProdRestrictionsMprFeatures,
+                        _mprFeatures
+                    )
+                );
+            MprFeatureSet outputProdRestrictionsMprFeatures = crule.OutputProdRestrictionsMprFeatures;
+            if (outputProdRestrictionsMprFeatures.Count > 0)
+                ruleElem.Add(
+                    WriteIDs("outputProdRestrictionsMprFeatures", crule.OutputProdRestrictionsMprFeatures, _mprFeatures)
+                );
+
             return ruleElem;
         }
 

tests/SIL.Machine.Morphology.HermitCrab.Tests/MorphologicalRules/CompoundingRuleTests.cs

@@ -213,7 +213,7 @@ public void ProdRestrictRule()
         // The word should no longer parse
         Assert.That(morpher.ParseWord("pʰutdat"), Is.Empty);
 
-        // Removee the exception "feature" from the head root
+        // Remove the exception "feature" from the head root
         head.MprFeatures.Remove(excFeat);
         // Add the exception "feature" to the nonhead root
         var nonhead = Allophonic.Entries.ElementAt(5);
@@ -222,6 +222,17 @@ public void ProdRestrictRule()
         output = morpher.ParseWord("pʰutdat").ToList();
         AssertMorphsEqual(output, "5 8");
         AssertRootAllomorphsEquals(output, "5");
+
+        // Test output exception "feature"
+        // The output should not have it yet
+        Assert.That(rule1.OutputProdRestrictionsMprFeatures.Count == 0);
+        // Add the exception "feature" to the output set
+        rule1.OutputProdRestrictionsMprFeatures.Add(excFeat);
+        // It should still parse and the output MprFeatures should have the exception "feature"
+        output = morpher.ParseWord("pʰutdat").ToList();
+        AssertMorphsEqual(output, "5 8");
+        AssertRootAllomorphsEquals(output, "5");
+        Assert.That(rule1.OutputProdRestrictionsMprFeatures.Contains(excFeat));
     }
 
     private static void AssertRootAllomorphsEquals(IEnumerable<Word> words, params string[] expected)

tests/SIL.Machine.Morphology.HermitCrab.Tests/TestData/XmlLanguageSerializationTests.xml

@@ -216,7 +216,7 @@
       <Stratum characterDefinitionTable="table1" morphologicalRuleOrder="unordered" phonologicalRules="prule1 prule2" morphologicalRules="mrule1">
         <Name>stratum 1</Name>
         <MorphologicalRuleDefinitions>
-          <CompoundingRule id="mrule1" blockable="false" multipleApplication="3" headPartsOfSpeech="pos1" nonHeadPartsOfSpeech="pos2" outputPartOfSpeech="pos2" outputObligatoryFeatures="hfeat2">
+          <CompoundingRule id="mrule1" blockable="false" multipleApplication="3" headPartsOfSpeech="pos1" nonHeadPartsOfSpeech="pos2" outputPartOfSpeech="pos2" outputObligatoryFeatures="hfeat2" headProdRestrictionsMprFeatures="mpr1" nonHeadProdRestrictionsMprFeatures="mpr2" outputProdRestrictionsMprFeatures="mpr3">
             <Name>compounding rule 1</Name>
             <CompoundingSubrules>
               <CompoundingSubrule>