1 // Copyright 2012 Google Inc. All Rights Reserved.
3 // Licensed under the Apache License, Version 2.0 (the "License");
4 // you may not use this file except in compliance with the License.
5 // You may obtain a copy of the License at
7 // http://www.apache.org/licenses/LICENSE-2.0
9 // Unless required by applicable law or agreed to in writing, software
10 // distributed under the License is distributed on an "AS IS" BASIS,
11 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 // See the License for the specific language governing permissions and
13 // limitations under the License.
15 package com.hughes.android.dictionary.parser.wiktionary;
17 import java.util.Arrays;
18 import java.util.LinkedHashMap;
19 import java.util.LinkedHashSet;
20 import java.util.List;
23 import java.util.concurrent.atomic.AtomicInteger;
25 import com.hughes.android.dictionary.engine.EntryTypeName;
26 import com.hughes.android.dictionary.engine.IndexBuilder;
27 import com.hughes.android.dictionary.parser.WikiTokenizer;
28 import com.hughes.android.dictionary.parser.wiktionary.AbstractWiktionaryParser.AppendAndIndexWikiCallback;
29 import com.hughes.android.dictionary.parser.wiktionary.AbstractWiktionaryParser.NameAndArgs;
30 import com.hughes.util.ListUtil;
32 class EnFunctionCallbacks {
34 static final Map<String,FunctionCallback<EnParser>> DEFAULT = new LinkedHashMap<String, FunctionCallback<EnParser>>();
37 FunctionCallback<EnParser> callback = new TranslationCallback<EnParser>();
38 DEFAULT.put("t", callback);
39 DEFAULT.put("t+", callback);
40 DEFAULT.put("t-", callback);
41 DEFAULT.put("tø", callback);
42 DEFAULT.put("apdx-t", callback);
44 callback = new EncodingCallback();
45 Set<String> encodings = new LinkedHashSet<String>(Arrays.asList(
47 "sd-Arab", "ku-Arab", "Arab", "unicode", "Laoo", "ur-Arab", "Thai",
48 "fa-Arab", "Khmr", "Cyrl", "IPAchar", "ug-Arab", "ko-inline",
49 "Jpan", "Kore", "Hebr", "rfscript", "Beng", "Mong", "Knda", "Cyrs",
50 "yue-tsj", "Mlym", "Tfng", "Grek", "yue-yue-j"));
51 for (final String encoding : encodings) {
52 DEFAULT.put(encoding, callback);
55 callback = new l_term();
56 DEFAULT.put("l", callback);
57 DEFAULT.put("term", callback);
59 callback = new Gender();
60 DEFAULT.put("m", callback);
61 DEFAULT.put("f", callback);
62 DEFAULT.put("n", callback);
63 DEFAULT.put("p", callback);
64 DEFAULT.put("g", callback);
66 callback = new AppendArg0();
68 callback = new Ignore();
69 DEFAULT.put("trreq", callback);
70 DEFAULT.put("t-image", callback);
71 DEFAULT.put("defn", callback);
72 DEFAULT.put("rfdef", callback);
73 DEFAULT.put("rfdate", callback);
74 DEFAULT.put("rfex", callback);
75 DEFAULT.put("rfquote", callback);
76 DEFAULT.put("attention", callback);
77 DEFAULT.put("zh-attention", callback);
80 callback = new FormOf();
81 DEFAULT.put("form of", callback);
82 DEFAULT.put("conjugation of", callback);
83 DEFAULT.put("participle of", callback);
84 DEFAULT.put("present participle of", callback);
85 DEFAULT.put("past participle of", callback);
86 DEFAULT.put("feminine past participle of", callback);
87 DEFAULT.put("gerund of", callback);
88 DEFAULT.put("feminine of", callback);
89 DEFAULT.put("plural of", callback);
90 DEFAULT.put("feminine plural of", callback);
91 DEFAULT.put("inflected form of", callback);
92 DEFAULT.put("alternative form of", callback);
93 DEFAULT.put("dated form of", callback);
94 DEFAULT.put("apocopic form of", callback);
96 callback = new InflOrHead();
97 DEFAULT.put("infl", callback);
98 DEFAULT.put("head", callback);
100 callback = new AppendName();
101 DEFAULT.put("...", callback);
103 DEFAULT.put("qualifier", new QualifierCallback());
104 DEFAULT.put("italbrac", new italbrac());
105 DEFAULT.put("gloss", new gloss());
106 DEFAULT.put("not used", new not_used());
107 DEFAULT.put("wikipedia", new wikipedia());
110 static final NameAndArgs<EnParser> NAME_AND_ARGS = new NameAndArgs<EnParser>();
112 // ------------------------------------------------------------------
114 static final class TranslationCallback<T extends AbstractWiktionaryParser> implements FunctionCallback<T> {
116 public boolean onWikiFunction(final WikiTokenizer wikiTokenizer, final String name, final List<String> args,
117 final Map<String, String> namedArgs, final T parser,
118 final AppendAndIndexWikiCallback<T> appendAndIndexWikiCallback) {
120 final String transliteration = namedArgs.remove("tr");
121 final String alt = namedArgs.remove("alt");
122 namedArgs.keySet().removeAll(EnParser.USELESS_WIKI_ARGS);
123 if (args.size() < 2) {
124 if (!name.equals("ttbc")) {
125 EnParser.LOG.warning("{{t...}} with wrong args: title=" + parser.title + ", " + wikiTokenizer.token());
129 final String langCode = ListUtil.get(args, 0);
130 if (!appendAndIndexWikiCallback.langCodeToTCount.containsKey(langCode)) {
131 appendAndIndexWikiCallback.langCodeToTCount.put(langCode, new AtomicInteger());
133 appendAndIndexWikiCallback.langCodeToTCount.get(langCode).incrementAndGet();
134 final String word = ListUtil.get(args, 1);
135 appendAndIndexWikiCallback.dispatch(alt != null ? alt : word, EntryTypeName.WIKTIONARY_TITLE_MULTI);
138 if (args.size() > 2) {
139 appendAndIndexWikiCallback.builder.append(" {");
140 for (int i = 2; i < args.size(); ++i) {
142 appendAndIndexWikiCallback.builder.append("|");
144 appendAndIndexWikiCallback.builder.append(args.get(i));
146 appendAndIndexWikiCallback.builder.append("}");
149 if (transliteration != null) {
150 appendAndIndexWikiCallback.builder.append(" (");
151 appendAndIndexWikiCallback.dispatch(transliteration, EntryTypeName.WIKTIONARY_TRANSLITERATION);
152 appendAndIndexWikiCallback.builder.append(")");
156 // If alt wasn't null, we appended alt instead of the actual word
157 // we're filing under..
158 appendAndIndexWikiCallback.builder.append(" (");
159 appendAndIndexWikiCallback.dispatch(word, EntryTypeName.WIKTIONARY_TITLE_MULTI);
160 appendAndIndexWikiCallback.builder.append(")");
163 // Catch-all for anything else...
164 if (!namedArgs.isEmpty()) {
165 appendAndIndexWikiCallback.builder.append(" {");
166 EnParser.appendNamedArgs(namedArgs, appendAndIndexWikiCallback);
167 appendAndIndexWikiCallback.builder.append("}");
174 // ------------------------------------------------------------------
176 static final class QualifierCallback implements FunctionCallback<EnParser> {
178 public boolean onWikiFunction(final WikiTokenizer wikiTokenizer, final String name, final List<String> args,
179 final Map<String, String> namedArgs,
180 final EnParser parser,
181 final AppendAndIndexWikiCallback<EnParser> appendAndIndexWikiCallback) {
182 if (args.size() != 1 || !namedArgs.isEmpty()) {
183 EnParser.LOG.warning("weird qualifier: ");
186 String qualifier = args.get(0);
187 appendAndIndexWikiCallback.builder.append("(");
188 appendAndIndexWikiCallback.dispatch(qualifier, null);
189 appendAndIndexWikiCallback.builder.append(")");
194 // ------------------------------------------------------------------
196 static final class EncodingCallback implements FunctionCallback<EnParser> {
198 public boolean onWikiFunction(final WikiTokenizer wikiTokenizer, final String name, final List<String> args,
199 final Map<String, String> namedArgs,
200 final EnParser parser,
201 final AppendAndIndexWikiCallback<EnParser> appendAndIndexWikiCallback) {
202 if (!namedArgs.isEmpty()) {
203 EnParser.LOG.warning("weird encoding: " + wikiTokenizer.token());
205 if (args.size() == 0) {
206 // Things like "{{Jpan}}" exist.
210 for (int i = 0; i < args.size(); ++i) {
212 appendAndIndexWikiCallback.builder.append(", ");
214 final String arg = args.get(i);
215 // if (arg.equals(parser.title)) {
216 // parser.titleAppended = true;
218 appendAndIndexWikiCallback.dispatch(arg, appendAndIndexWikiCallback.entryTypeName);
225 // ------------------------------------------------------------------
227 static final class Gender implements FunctionCallback<EnParser> {
229 public boolean onWikiFunction(final WikiTokenizer wikiTokenizer, final String name, final List<String> args,
230 final Map<String, String> namedArgs,
231 final EnParser parser,
232 final AppendAndIndexWikiCallback<EnParser> appendAndIndexWikiCallback) {
233 if (!namedArgs.isEmpty()) {
236 appendAndIndexWikiCallback.builder.append("{");
237 appendAndIndexWikiCallback.builder.append(name);
238 for (int i = 0; i < args.size(); ++i) {
239 appendAndIndexWikiCallback.builder.append("|").append(args.get(i));
241 appendAndIndexWikiCallback.builder.append("}");
246 // ------------------------------------------------------------------
248 static final class l_term implements FunctionCallback<EnParser> {
250 public boolean onWikiFunction(final WikiTokenizer wikiTokenizer, final String name, final List<String> args,
251 final Map<String, String> namedArgs,
252 final EnParser parser,
253 final AppendAndIndexWikiCallback<EnParser> appendAndIndexWikiCallback) {
255 // for {{l}}, lang is arg 0, but not for {{term}}
256 if (name.equals("term")) {
260 final EntryTypeName entryTypeName;
261 switch (parser.state) {
262 case TRANSLATION_LINE: entryTypeName = EntryTypeName.WIKTIONARY_TRANSLATION_OTHER_TEXT; break;
263 case ENGLISH_DEF_OF_FOREIGN: entryTypeName = EntryTypeName.WIKTIONARY_ENGLISH_DEF_WIKI_LINK; break;
264 default: throw new IllegalStateException("Invalid enum value: " + parser.state);
267 final String langCode = args.get(0);
268 final IndexBuilder indexBuilder;
269 if ("".equals(langCode)) {
270 indexBuilder = parser.foreignIndexBuilder;
271 } else if ("en".equals(langCode)) {
272 indexBuilder = parser.enIndexBuilder;
274 indexBuilder = parser.foreignIndexBuilder;
277 String displayText = ListUtil.get(args, 2, "");
278 if (displayText.equals("")) {
279 displayText = ListUtil.get(args, 1, null);
282 if (displayText != null) {
283 appendAndIndexWikiCallback.dispatch(displayText, indexBuilder, entryTypeName);
285 EnParser.LOG.warning("no display text: " + wikiTokenizer.token());
288 final String tr = namedArgs.remove("tr");
290 appendAndIndexWikiCallback.builder.append(" (");
291 appendAndIndexWikiCallback.dispatch(tr, indexBuilder, EntryTypeName.WIKTIONARY_TRANSLITERATION);
292 appendAndIndexWikiCallback.builder.append(")");
295 final String gloss = ListUtil.get(args, 3, "");
296 if (!gloss.equals("")) {
297 appendAndIndexWikiCallback.builder.append(" (");
298 appendAndIndexWikiCallback.dispatch(gloss, parser.enIndexBuilder, EntryTypeName.WIKTIONARY_ENGLISH_DEF);
299 appendAndIndexWikiCallback.builder.append(")");
302 namedArgs.keySet().removeAll(EnParser.USELESS_WIKI_ARGS);
303 if (!namedArgs.isEmpty()) {
304 appendAndIndexWikiCallback.builder.append(" {").append(name);
305 EnParser.appendNamedArgs(namedArgs, appendAndIndexWikiCallback);
306 appendAndIndexWikiCallback.builder.append("}");
313 // ------------------------------------------------------------------
315 static final class AppendArg0 implements FunctionCallback<EnParser> {
317 public boolean onWikiFunction(final WikiTokenizer wikiTokenizer, final String name, final List<String> args,
318 final Map<String, String> namedArgs,
319 final EnParser parser,
320 final AppendAndIndexWikiCallback<EnParser> appendAndIndexWikiCallback) {
321 if (args.size() != 1 || !namedArgs.isEmpty()) {
324 appendAndIndexWikiCallback.dispatch(args.get(0), EntryTypeName.WIKTIONARY_TRANSLATION_OTHER_TEXT);
326 final String tr = namedArgs.remove("tr");
328 appendAndIndexWikiCallback.builder.append(" (");
329 appendAndIndexWikiCallback.dispatch(tr, EntryTypeName.WIKTIONARY_TRANSLATION_OTHER_TEXT);
330 appendAndIndexWikiCallback.builder.append(")");
331 parser.wordForms.add(tr);
338 // ------------------------------------------------------------------
340 static final class italbrac implements FunctionCallback<EnParser> {
342 public boolean onWikiFunction(final WikiTokenizer wikiTokenizer, final String name, final List<String> args,
343 final Map<String, String> namedArgs,
344 final EnParser parser,
345 final AppendAndIndexWikiCallback<EnParser> appendAndIndexWikiCallback) {
346 if (args.size() != 1 || !namedArgs.isEmpty()) {
349 appendAndIndexWikiCallback.builder.append("(");
350 appendAndIndexWikiCallback.dispatch(args.get(0), EntryTypeName.WIKTIONARY_TRANSLATION_OTHER_TEXT);
351 appendAndIndexWikiCallback.builder.append(")");
356 // ------------------------------------------------------------------
358 static final class gloss implements FunctionCallback<EnParser> {
360 public boolean onWikiFunction(final WikiTokenizer wikiTokenizer, final String name, final List<String> args,
361 final Map<String, String> namedArgs,
362 final EnParser parser,
363 final AppendAndIndexWikiCallback<EnParser> appendAndIndexWikiCallback) {
364 if (args.size() != 1 || !namedArgs.isEmpty()) {
367 appendAndIndexWikiCallback.builder.append("(");
368 appendAndIndexWikiCallback.dispatch(args.get(0), EntryTypeName.WIKTIONARY_TRANSLATION_OTHER_TEXT);
369 appendAndIndexWikiCallback.builder.append(")");
374 // ------------------------------------------------------------------
376 static final class Ignore implements FunctionCallback<EnParser> {
378 public boolean onWikiFunction(final WikiTokenizer wikiTokenizer, final String name, final List<String> args,
379 final Map<String, String> namedArgs,
380 final EnParser parser,
381 final AppendAndIndexWikiCallback<EnParser> appendAndIndexWikiCallback) {
386 // ------------------------------------------------------------------
388 static final class not_used implements FunctionCallback<EnParser> {
390 public boolean onWikiFunction(final WikiTokenizer wikiTokenizer, final String name, final List<String> args,
391 final Map<String, String> namedArgs,
392 final EnParser parser,
393 final AppendAndIndexWikiCallback<EnParser> appendAndIndexWikiCallback) {
394 appendAndIndexWikiCallback.builder.append("(not used)");
400 // ------------------------------------------------------------------
402 static final class AppendName implements FunctionCallback<EnParser> {
404 public boolean onWikiFunction(final WikiTokenizer wikiTokenizer, final String name, final List<String> args,
405 final Map<String, String> namedArgs,
406 final EnParser parser,
407 final AppendAndIndexWikiCallback<EnParser> appendAndIndexWikiCallback) {
408 if (!args.isEmpty() || !namedArgs.isEmpty()) {
411 appendAndIndexWikiCallback.builder.append(name);
416 // --------------------------------------------------------------------
417 // --------------------------------------------------------------------
420 static final class FormOf implements FunctionCallback<EnParser> {
422 public boolean onWikiFunction(final WikiTokenizer wikiTokenizer, final String name, final List<String> args,
423 final Map<String, String> namedArgs,
424 final EnParser parser,
425 final AppendAndIndexWikiCallback<EnParser> appendAndIndexWikiCallback) {
426 parser.entryIsFormOfSomething = true;
427 String formName = name;
428 if (name.equals("form of")) {
429 formName = ListUtil.remove(args, 0, null);
431 if (formName == null) {
432 EnParser.LOG.warning("Missing form name: " + parser.title);
433 formName = "form of";
435 String baseForm = ListUtil.get(args, 1, "");
436 if ("".equals(baseForm)) {
437 baseForm = ListUtil.get(args, 0, null);
438 ListUtil.remove(args, 1, "");
440 ListUtil.remove(args, 0, null);
442 namedArgs.keySet().removeAll(EnParser.USELESS_WIKI_ARGS);
444 appendAndIndexWikiCallback.builder.append("{");
445 NAME_AND_ARGS.onWikiFunction(wikiTokenizer, formName, args, namedArgs, parser, appendAndIndexWikiCallback);
446 appendAndIndexWikiCallback.builder.append("}");
447 if (baseForm != null && appendAndIndexWikiCallback.indexedEntry != null) {
448 parser.foreignIndexBuilder.addEntryWithString(appendAndIndexWikiCallback.indexedEntry, baseForm, EntryTypeName.WIKTIONARY_BASE_FORM_MULTI);
450 // null baseForm happens in Danish.
451 EnParser.LOG.warning("Null baseform: " + parser.title);
457 static final EnFunctionCallbacks.FormOf FORM_OF = new FormOf();
460 // --------------------------------------------------------------------
461 // --------------------------------------------------------------------
463 static final class wikipedia implements FunctionCallback<EnParser> {
465 public boolean onWikiFunction(final WikiTokenizer wikiTokenizer, final String name, final List<String> args,
466 final Map<String, String> namedArgs,
467 final EnParser parser,
468 final AppendAndIndexWikiCallback<EnParser> appendAndIndexWikiCallback) {
469 namedArgs.remove("lang");
470 if (args.size() > 1 || !namedArgs.isEmpty()) {
473 } else if (args.size() == 1) {
481 static final class InflOrHead implements FunctionCallback<EnParser> {
483 public boolean onWikiFunction(final WikiTokenizer wikiTokenizer, final String name, final List<String> args,
484 final Map<String, String> namedArgs,
485 final EnParser parser,
486 final AppendAndIndexWikiCallback<EnParser> appendAndIndexWikiCallback) {
487 // See: http://en.wiktionary.org/wiki/Template:infl
488 // TODO: Actually these functions should start a new WordPOS:
489 // See: http://en.wiktionary.org/wiki/quattro
490 final String langCode = ListUtil.get(args, 0);
491 String head = namedArgs.remove("head");
493 head = namedArgs.remove("title"); // Bug
499 namedArgs.keySet().removeAll(EnParser.USELESS_WIKI_ARGS);
501 final String tr = namedArgs.remove("tr");
502 String g = namedArgs.remove("g");
504 g = namedArgs.remove("gender");
506 final String g2 = namedArgs.remove("g2");
507 final String g3 = namedArgs.remove("g3");
509 // We might have already taken care of this in a generic way...
510 if (!parser.titleAppended) {
511 appendAndIndexWikiCallback.dispatch(head, EntryTypeName.WIKTIONARY_TITLE_MULTI);
512 parser.titleAppended = true;
516 appendAndIndexWikiCallback.builder.append(" {").append(g);
518 appendAndIndexWikiCallback.builder.append("|").append(g2);
521 appendAndIndexWikiCallback.builder.append("|").append(g3);
523 appendAndIndexWikiCallback.builder.append("}");
527 appendAndIndexWikiCallback.builder.append(" (");
528 appendAndIndexWikiCallback.dispatch(tr, EntryTypeName.WIKTIONARY_TITLE_MULTI);
529 appendAndIndexWikiCallback.builder.append(")");
530 parser.wordForms.add(tr);
533 final String pos = ListUtil.get(args, 1);
535 appendAndIndexWikiCallback.builder.append(" (").append(pos).append(")");
537 for (int i = 2; i < args.size(); i += 2) {
538 final String inflName = ListUtil.get(args, i);
539 final String inflValue = ListUtil.get(args, i + 1);
540 appendAndIndexWikiCallback.builder.append(", ");
541 appendAndIndexWikiCallback.dispatch(inflName, null, null);
542 if (inflValue != null && inflValue.length() > 0) {
543 appendAndIndexWikiCallback.builder.append(": ");
544 appendAndIndexWikiCallback.dispatch(inflValue, null, null);
545 parser.wordForms.add(inflValue);
548 for (final String key : namedArgs.keySet()) {
549 final String value = WikiTokenizer.toPlainText(namedArgs.get(key));
550 appendAndIndexWikiCallback.builder.append(" ");
551 appendAndIndexWikiCallback.dispatch(key, null, null);
552 appendAndIndexWikiCallback.builder.append("=");
553 appendAndIndexWikiCallback.dispatch(value, null, null);
554 parser.wordForms.add(value);
562 DEFAULT.put("it-noun", new it_noun());
564 static final class it_noun implements FunctionCallback<EnParser> {
566 public boolean onWikiFunction(final WikiTokenizer wikiTokenizer, final String name, final List<String> args,
567 final Map<String, String> namedArgs,
568 final EnParser parser,
569 final AppendAndIndexWikiCallback<EnParser> appendAndIndexWikiCallback) {
570 parser.titleAppended = true;
571 final String base = ListUtil.get(args, 0);
572 final String gender = ListUtil.get(args, 1);
573 final String singular = base + ListUtil.get(args, 2, null);
574 final String plural = base + ListUtil.get(args, 3, null);
575 appendAndIndexWikiCallback.builder.append(" ");
576 appendAndIndexWikiCallback.dispatch(singular, null, null);
577 appendAndIndexWikiCallback.builder.append(" {").append(gender).append("}, ");
578 appendAndIndexWikiCallback.dispatch(plural, null, null);
579 appendAndIndexWikiCallback.builder.append(" {pl}");
580 parser.wordForms.add(singular);
581 parser.wordForms.add(plural);
582 if (!namedArgs.isEmpty() || args.size() > 4) {
583 EnParser.LOG.warning("Invalid it-noun: " + wikiTokenizer.token());
590 DEFAULT.put("it-proper noun", new it_proper_noun());
592 static final class it_proper_noun implements FunctionCallback<EnParser> {
594 public boolean onWikiFunction(final WikiTokenizer wikiTokenizer, final String name, final List<String> args,
595 final Map<String, String> namedArgs,
596 final EnParser parser,
597 final AppendAndIndexWikiCallback<EnParser> appendAndIndexWikiCallback) {