]> gitweb.fperrin.net Git - DictionaryPC.git/blobdiff - src/com/hughes/android/dictionary/parser/EnWiktionaryXmlParser.java
Better {{form of}} handling, remove "lang=..."
[DictionaryPC.git] / src / com / hughes / android / dictionary / parser / EnWiktionaryXmlParser.java
index 9c867a0a8de132a068d748557cd45d60046acea4..01af90c9da4d821d5b2369af11a805d54660ed4e 100644 (file)
@@ -38,6 +38,8 @@ import com.hughes.android.dictionary.engine.PairEntry.Pair;
 
 public class EnWiktionaryXmlParser {
   
+  private static final String TRANSLITERATION_FORMAT = " (tr. %s)";
+
   static final Logger LOG = Logger.getLogger(EnWiktionaryXmlParser.class.getName());
   
   // TODO: process {{ttbc}} lines
@@ -46,7 +48,7 @@ public class EnWiktionaryXmlParser {
       "Noun|Verb|Adjective|Adverb|Pronoun|Conjunction|Interjection|" +
       "Preposition|Proper noun|Article|Prepositional phrase|Acronym|" +
       "Abbreviation|Initialism|Contraction|Prefix|Suffix|Symbol|Letter|" +
-      "Ligature|Idiom|Phrase|{{initialism}}|" +
+      "Ligature|Idiom|Phrase|\\{\\{acronym\\}\\}|\\{\\{initialism\\}\\}|" +
       // These are @deprecated:
       "Noun form|Verb form|Adjective form|Nominal phrase|Noun phrase|" +
       "Verb phrase|Transitive verb|Intransitive verb|Reflexive verb|" +
@@ -117,8 +119,8 @@ public class EnWiktionaryXmlParser {
     heading = heading.replaceAll("=", "").trim(); 
     if (heading.equals("English")) {
       doEnglishWord(title, text);
-    } else if (langPattern.matcher(heading).matches()){
-      doForeignWord(title, text);
+    } else if (langPattern.matcher(heading).find()){
+      doForeignWord(heading, title, text);
     }
         
   }  // endPage()
@@ -144,6 +146,8 @@ public class EnWiktionaryXmlParser {
         if (partOfSpeechHeader.matcher(headerName).matches()) {
           posDepth = wikiTokenizer.headingDepth();
           pos = wikiTokenizer.headingWikiText();
+          // TODO: if we're inside the POS section, we should handle the first title line...
+          
         } else if (headerName.equals("Translations")) {
           if (pos == null) {
             LOG.warning("Translations without POS: " + title);
@@ -270,10 +274,18 @@ public class EnWiktionaryXmlParser {
     }
   }
   
+  private static <T> T get(final List<T> list, final int index, final T defaultValue) {
+    return index < list.size() ? list.get(index) : defaultValue;
+  }
+
   private static <T> T get(final List<T> list, final int index) {
-    return index < list.size() ? list.get(index) : null;
+    return get(list, index, null);
   }
-  
+
+  private static <T> T remove(final List<T> list, final int index, final T defaultValue) {
+    return index < list.size() ? list.remove(index) : defaultValue;
+  }
+
   private void doTranslationLine(final String line, final String lang, final String title, final String pos, final String sense, final String rest) {
     // Good chance we'll actually file this one...
     final PairEntry pairEntry = new PairEntry();
@@ -317,7 +329,7 @@ public class EnWiktionaryXmlParser {
               otherText.append(String.format(" {%s}", gender));
             }
             if (transliteration != null) {
-              otherText.append(String.format(" (tr. %s)", transliteration));
+              otherText.append(String.format(TRANSLITERATION_FORMAT, transliteration));
               otherIndexBuilder.addEntryWithString(indexedEntry, transliteration, EntryTypeName.WIKTIONARY_TRANSLITERATION);
             }
           //}
@@ -363,7 +375,8 @@ public class EnWiktionaryXmlParser {
           // American sign language
         } else {
           // Unindexed!
-          otherText.append(wikiTokenizer.token());
+          namedArgs.keySet().removeAll(USELESS_WIKI_ARGS);
+          WikiTokenizer.appendFunction(otherText.append("{{"), functionName, args, namedArgs).append("}}");
         }
         
       } else if (wikiTokenizer.isNewline()) {
@@ -380,7 +393,7 @@ public class EnWiktionaryXmlParser {
     }
     
     if (lang != null) {
-      otherText.insert(0, "(" + lang + ") ");
+      otherText.insert(0, String.format("(%s) ", lang));
     }
     
     StringBuilder englishText = new StringBuilder();
@@ -426,7 +439,7 @@ public class EnWiktionaryXmlParser {
   
   // -------------------------------------------------------------------------
   
-  private void doForeignWord(final String title, final String text) {
+  private void doForeignWord(final String lang, final String title, final String text) {
     final WikiTokenizer wikiTokenizer = new WikiTokenizer(text);
     while (wikiTokenizer.nextToken() != null) {
       if (wikiTokenizer.isHeading()) {
@@ -436,7 +449,7 @@ public class EnWiktionaryXmlParser {
         } else if (headingName.equals("Pronunciation")) {
           //doPronunciation(wikiLineReader);
         } else if (partOfSpeechHeader.matcher(headingName).matches()) {
-          doForeignPartOfSpeech(title, headingName, wikiTokenizer.headingDepth(), wikiTokenizer);
+          doForeignPartOfSpeech(lang, title, headingName, wikiTokenizer.headingDepth(), wikiTokenizer);
         }
       } else {
       }
@@ -462,14 +475,15 @@ public class EnWiktionaryXmlParser {
 
 
   int foreignCount = 0;
-  private void doForeignPartOfSpeech(String title, final String posHeading, final int posDepth, WikiTokenizer wikiTokenizer) {
+  private void doForeignPartOfSpeech(final String lang, String title, final String posHeading, final int posDepth, WikiTokenizer wikiTokenizer) {
     if (++foreignCount % 1000 == 0) {
-      LOG.info("***" + title + ", pos=" + posHeading + ", foreignCount=" + foreignCount);
+      LOG.info("***" + lang + ", " + title + ", pos=" + posHeading + ", foreignCount=" + foreignCount);
     }
     if (title.equals("moro")) {
       System.out.println();
     }
     
+    boolean titleAppended = false;
     final StringBuilder foreignBuilder = new StringBuilder();
     final Collection<String> wordForms = new ArrayList<String>();
     final List<ListSection> listSections = new ArrayList<ListSection>();
@@ -511,19 +525,83 @@ public class EnWiktionaryXmlParser {
         // I think just under fare.  But then we need a way to link to the entry (actually the row, since entries doesn't show up!)
         // for the conjugation table from "fa".
         // Would like to be able to link to a lang#token.
-      if (isGender(name)) {
-        appendGender(foreignBuilder, name, args);
-      } else if (name.equals("wikipedia")) {
-        namedArgs.remove("lang");
-        if (args.size() > 1 || !namedArgs.isEmpty()) {
-          // Unindexed!
-          foreignBuilder.append(wikiTokenizer.token());
-        } else if (args.size() == 1) {
-          foreignBuilder.append(wikiTokenizer.token());
-        } else {
-          //foreignBuilder.append(title);
-        }
-      } else if (name.equals("it-noun")) {
+        if (isGender(name)) {
+          appendGender(foreignBuilder, name, args);
+        } else if (name.equals("wikipedia")) {
+          namedArgs.remove("lang");
+          if (args.size() > 1 || !namedArgs.isEmpty()) {
+            // Unindexed!
+            foreignBuilder.append(wikiTokenizer.token());
+          } else if (args.size() == 1) {
+            foreignBuilder.append(wikiTokenizer.token());
+          } else {
+            //foreignBuilder.append(title);
+          }
+        } else if (name.equals("attention") || name.equals("zh-attention")) {
+          // See: http://en.wiktionary.org/wiki/Template:attention
+          // Ignore these.
+        } else if (name.equals("infl")) {
+          // See: http://en.wiktionary.org/wiki/Template:infl
+          final String langCode = get(args, 0);
+          String head = namedArgs.remove("head");
+          if (head == null) {
+            head = namedArgs.remove("title"); // Bug
+          }
+          if (head == null) {
+            head = title;
+          } else {
+            head = WikiTokenizer.toPlainText(head);
+          }
+          titleAppended = true;
+          
+          namedArgs.keySet().removeAll(USELESS_WIKI_ARGS);
+  
+          final String tr = namedArgs.remove("tr");
+          String g = namedArgs.remove("g");
+          if (g == null) {
+            g = namedArgs.remove("gender");
+          }
+          final String g2 = namedArgs.remove("g2");
+          final String g3 = namedArgs.remove("g3");
+  
+          foreignBuilder.append(head);
+    
+          if (g != null) {
+            foreignBuilder.append(" {").append(g);
+            if (g2 != null) {
+              foreignBuilder.append("|").append(g2);
+            }
+            if (g3 != null) {
+              foreignBuilder.append("|").append(g3);
+            }
+            foreignBuilder.append("}");
+          }
+    
+          if (tr != null) {
+            foreignBuilder.append(String.format(TRANSLITERATION_FORMAT, tr));
+            wordForms.add(tr);
+          }
+    
+          final String pos = get(args, 1);
+          if (pos != null) {
+            foreignBuilder.append(" (").append(pos).append(")");
+          }
+          for (int i = 2; i < args.size(); i += 2) {
+            final String inflName = get(args, i);
+            final String inflValue = get(args, i + 1);
+            foreignBuilder.append(", ").append(WikiTokenizer.toPlainText(inflName));
+            if (inflValue != null && inflValue.length() > 0) {
+              foreignBuilder.append(": ").append(WikiTokenizer.toPlainText(inflValue));
+              wordForms.add(inflValue);
+            }
+          }
+          for (final String key : namedArgs.keySet()) {
+            final String value = WikiTokenizer.toPlainText(namedArgs.get(key));
+            foreignBuilder.append(" ").append(key).append("=").append(value);
+            wordForms.add(value);
+          }
+        } else if (name.equals("it-noun")) {
+          titleAppended = true;
           final String base = get(args, 0);
           final String gender = get(args, 1);
           final String singular = base + get(args, 2);
@@ -531,6 +609,9 @@ public class EnWiktionaryXmlParser {
           foreignBuilder.append(String.format(" %s {%s}, %s {pl}", singular, gender, plural, plural));
           wordForms.add(singular);
           wordForms.add(plural);
+          if (!namedArgs.isEmpty() || args.size() > 4) {
+            LOG.warning("Invalid it-noun: " + wikiTokenizer.token());
+          }
         } else if (name.equals("it-proper noun")) {
           foreignBuilder.append(wikiTokenizer.token());
         } else if (name.equals("it-adj")) {
@@ -548,7 +629,6 @@ public class EnWiktionaryXmlParser {
           foreignBuilder.append(wikiTokenizer.token());
           // LOG.warning("Unknown function: " + wikiTokenizer.token());
         }
-        
       } else if (wikiTokenizer.isListItem()) {
         final String prefix = wikiTokenizer.listItemPrefix();
         if (lastListSection != null && 
@@ -581,8 +661,11 @@ public class EnWiktionaryXmlParser {
       // Here's where we exit.
       // Should we make an entry even if there are no foreign list items?
       String foreign = foreignBuilder.toString().trim();
-      if (!foreign.toLowerCase().startsWith(title.toLowerCase())) {
-        foreign = title + " " + foreign;
+      if (!titleAppended && !foreign.toLowerCase().startsWith(title.toLowerCase())) {
+        foreign = String.format("%s %s", title, foreign);
+      }
+      if (!langPattern.matcher(lang).matches()) {
+        foreign = String.format("(%s) %s", lang, foreign);
       }
       for (final ListSection listSection : listSections) {
         doForeignListItem(foreign, title, wordForms, listSection);
@@ -597,6 +680,8 @@ public class EnWiktionaryXmlParser {
       "imperative"
       );
 
+  // Might only want to remove "lang" if it's equal to "zh", for example.
+  static final Set<String> USELESS_WIKI_ARGS = new LinkedHashSet<String>(Arrays.asList("lang", "sc", "sort", "cat"));
 
   private void doForeignListItem(final String foreignText, String title, final Collection<String> forms, final ListSection listSection) {
     
@@ -613,7 +698,6 @@ public class EnWiktionaryXmlParser {
     final StringBuilder englishBuilder = new StringBuilder();
 
     final String mainLine = listSection.firstLine;
-    
     final WikiTokenizer englishTokenizer = new WikiTokenizer(mainLine, false);
     while (englishTokenizer.nextToken() != null) {
       // TODO handle form of....
@@ -646,20 +730,40 @@ public class EnWiktionaryXmlParser {
         }
       } else if (englishTokenizer.isFunction()) {
         final String name = englishTokenizer.functionName();
-        if (name.contains("conjugation of ") || 
-            name.contains("form of ") || 
-            name.contains("feminine of ") || 
-            name.contains("plural of ")) {
-          // Ignore these in the index, they're really annoying....
-          englishBuilder.append(englishTokenizer.token());
+        final List<String> args = englishTokenizer.functionPositionArgs();
+        final Map<String,String> namedArgs = englishTokenizer.functionNamedArgs();
+        
+        if (
+            name.equals("form of") || 
+            name.contains("conjugation of") || 
+            name.contains("participle of") || 
+            name.contains("gerund of") || 
+            name.contains("feminine of") || 
+            name.contains("plural of")) {
+          String formName = name;
+          if (name.equals("form of")) {
+            formName = args.remove(0);
+          }
+          String baseForm = get(args, 1, "");
+          if ("".equals(baseForm)) {
+            baseForm = get(args, 0, null);
+            remove(args, 1, "");
+          } else {
+            remove(args, 0, null);
+          }
+          namedArgs.keySet().removeAll(USELESS_WIKI_ARGS);
+          WikiTokenizer.appendFunction(englishBuilder.append("{"), formName, args, namedArgs).append("}");
+          otherIndexBuilder.addEntryWithString(indexedEntry, baseForm, EntryTypeName.WIKTIONARY_BASE_FORM_SINGLE, EntryTypeName.WIKTIONARY_BASE_FORM_MULTI);
+          
         } else {
-          englishBuilder.append(englishTokenizer.token());
+          namedArgs.keySet().removeAll(USELESS_WIKI_ARGS);
+          WikiTokenizer.appendFunction(englishBuilder.append("{{"), name, args, namedArgs).append("}}");
 //          LOG.warning("Unexpected function: " + englishTokenizer.token());
         }
       } else {
         if (englishTokenizer.isComment() || englishTokenizer.isMarkup()) {
         } else {
-          LOG.warning("Unexpected definition text: " + englishTokenizer.token());
+          LOG.warning("Unexpected definition type: " + englishTokenizer.token());
         }
       }
     }
@@ -670,7 +774,7 @@ public class EnWiktionaryXmlParser {
       pairEntry.pairs.add(pair);
       otherIndexBuilder.addEntryWithString(indexedEntry, title, EntryTypeName.WIKTIONARY_TITLE_SINGLE, EntryTypeName.WIKTIONARY_TITLE_MULTI);
       for (final String form : forms) {
-        otherIndexBuilder.addEntryWithString(indexedEntry, form, EntryTypeName.WIKTIONARY_FORM_SINGLE, EntryTypeName.WIKTIONARY_FORM_MULTI);
+        otherIndexBuilder.addEntryWithString(indexedEntry, form, EntryTypeName.WIKTIONARY_INFLECTD_FORM_SINGLE, EntryTypeName.WIKTIONARY_INFLECTED_FORM_MULTI);
       }
     }
     
@@ -708,24 +812,27 @@ public class EnWiktionaryXmlParser {
         if (lastForeign != null && pairEntry.pairs.size() > 0) {
           pairEntry.pairs.remove(pairEntry.pairs.size() - 1);
           final Pair pair = new Pair(formatAndIndexExampleString(nextLine, enIndexBuilder, indexedEntry), formatAndIndexExampleString(lastForeign, otherIndexBuilder, indexedEntry), swap);
-          if (pair.lang1 != "--" && pair.lang1 != "--") {
+          if (pair.lang1 != "--" || pair.lang2 != "--") {
             pairEntry.pairs.add(pair);
           }
           lastForeign = null;
         } else {
           LOG.warning("TODO: English example with no foreign: " + title + ", " + nextLine);
-          // TODO: add something.
+          final Pair pair = new Pair("--", formatAndIndexExampleString(nextLine, null, indexedEntry), swap);
+          if (pair.lang1 != "--" || pair.lang2 != "--") {
+            pairEntry.pairs.add(pair);
+          }
         }
       } else if (nextPrefix.equals("#*")) {
         // Can't really index these.
         final Pair pair = new Pair("--", formatAndIndexExampleString(nextLine, null, indexedEntry), swap);
         lastForeign = nextLine;
-        if (pair.lang1 != "--" && pair.lang1 != "--") {
+        if (pair.lang1 != "--" || pair.lang2 != "--") {
           pairEntry.pairs.add(pair);
         }
       } else if (nextPrefix.equals("#::*") || nextPrefix.equals("##") || nextPrefix.equals("#*:") || nextPrefix.equals("#:*") || true) {
         final Pair pair = new Pair("--", formatAndIndexExampleString(nextLine, null, indexedEntry), swap);
-        if (pair.lang1 != "--" && pair.lang1 != "--") {
+        if (pair.lang1 != "--" || pair.lang2 != "--") {
           pairEntry.pairs.add(pair);
         }
 //      } else {