src/com/hughes/android/dictionary/parser/DictFileParser.java

   1 // Copyright 2011 Google Inc. All Rights Reserved.
   2 //
   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
   6 //
   7 //     http://www.apache.org/licenses/LICENSE-2.0
   8 //
   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.
  14
  15 package com.hughes.android.dictionary.parser;
  16
  17 import java.io.BufferedReader;
  18 import java.io.BufferedInputStream;
  19 import java.io.DataInputStream;
  20 import java.io.File;
  21 import java.io.FileInputStream;
  22 import java.io.FileWriter;
  23 import java.io.IOException;
  24 import java.io.InputStreamReader;
  25 import java.nio.charset.Charset;
  26 import java.util.Arrays;
  27 import java.util.Collections;
  28 import java.util.LinkedHashSet;
  29 import java.util.Set;
  30 import java.util.logging.Logger;
  31 import java.util.regex.Matcher;
  32 import java.util.regex.Pattern;
  33
  34 import com.hughes.android.dictionary.engine.AbstractEntry;
  35 import com.hughes.android.dictionary.engine.DictionaryBuilder;
  36 import com.hughes.android.dictionary.engine.EntrySource;
  37 import com.hughes.android.dictionary.engine.EntryTypeName;
  38 import com.hughes.android.dictionary.engine.HtmlEntry;
  39 import com.hughes.android.dictionary.engine.IndexBuilder;
  40 import com.hughes.android.dictionary.engine.IndexBuilder.TokenData;
  41 import com.hughes.android.dictionary.engine.IndexedEntry;
  42 import com.hughes.android.dictionary.engine.Language;
  43 import com.hughes.android.dictionary.engine.PairEntry;
  44 import com.hughes.util.StringUtil;
  45
  46 public class DictFileParser implements Parser {
  47
  48     static final Logger logger = Logger.getLogger(DictFileParser.class.getName());
  49
  50     // Dictcc
  51     public static final String TAB = "\t";
  52
  53     // Chemnitz
  54     public static final String DOUBLE_COLON = " :: ";
  55     public static final String PIPE = "|";
  56
  57     static final Pattern SPACES = Pattern.compile("\\s+");
  58
  59     static final Pattern CURLY_BRACED = Pattern.compile("\\{([^}]+)\\}");
  60
  61     // http://www.regular-expressions.info/unicode.html
  62     static final Pattern NON_CHAR_DASH = Pattern.compile("[^-'\\p{L}\\p{M}\\p{N}]+");
  63     public static final Pattern NON_CHAR = Pattern.compile("[^\\p{L}\\p{M}\\p{N}]+");
  64
  65     static final Pattern TRIM_PUNC = Pattern.compile("^[^\\p{L}\\p{M}\\p{N}]+|[^\\p{L}\\p{M}\\p{N}]+$");
  66
  67     final Charset charset;
  68     final boolean flipCols;
  69
  70     final String fieldSplit;
  71     final String subfieldSplit;
  72
  73     final boolean singleLang;
  74
  75     final DictionaryBuilder dictBuilder;
  76
  77     EntrySource entrySource;
  78
  79     // final Set<String> alreadyDone = new HashSet<String>();
  80
  81     public DictFileParser(final Charset charset, boolean flipCols,
  82                           final String fieldSplit, final String subfieldSplit,
  83                           final boolean singleLang,
  84                           final DictionaryBuilder dictBuilder) {
  85         this.charset = charset;
  86         this.flipCols = flipCols;
  87         this.fieldSplit = fieldSplit;
  88         this.subfieldSplit = subfieldSplit;
  89         this.singleLang = singleLang;
  90         this.dictBuilder = dictBuilder;
  91     }
  92
  93     @Override
  94     public void parse(final File file, final EntrySource entrySouce, final int pageLimit) throws IOException {
  95         this.entrySource = entrySouce;
  96         final BufferedReader reader = new BufferedReader(new InputStreamReader(new FileInputStream(file)));
  97         String line;
  98         int count = 0;
  99         while ((line = reader.readLine()) != null) {
 100             if (pageLimit >= 0 && count >= pageLimit) {
 101                 return;
 102             }
 103             if (count % 10000 == 0) {
 104                 logger.info("count=" + count + ", line=" + line);
 105             }
 106             parseLine(line);
 107             ++count;
 108         }
 109     }
 110
 111     private void parseLine(final String line) {
 112         if (line.startsWith("#") || line.isEmpty()) {
 113             logger.info("Skipping comment line: " + line);
 114             return;
 115         }
 116         final String[] fields = StringUtil.split(line, fieldSplit);
 117         if (fields.length < 2 || fields.length > 4) {
 118             logger.warning("Malformed line, expected 3 or 4 fields, got " + fields.length + ": " + line);
 119             return;
 120         }
 121
 122         fields[0] = SPACES.matcher(fields[0]).replaceAll(" ").trim();
 123         fields[1] = SPACES.matcher(fields[1]).replaceAll(" ").trim();
 124         if (flipCols) {
 125             final String temp = fields[0];
 126             fields[0] = fields[1];
 127             fields[1] = temp;
 128         }
 129
 130         final String[][] subfields = new String[2][];
 131         if (subfieldSplit != null) {
 132             subfields[0] = StringUtil.split(fields[0], subfieldSplit);
 133             subfields[1] = StringUtil.split(fields[1], subfieldSplit);
 134             if (subfields[0].length != subfields[1].length) {
 135                 logger.warning("Number of subfields doesn't match: " + line);
 136                 return;
 137             }
 138         } else {
 139             subfields[0] = new String[] { fields[0] };
 140             subfields[1] = new String[] { fields[1] };
 141         }
 142
 143         for (int i = 0; i < subfields[0].length; ++i) {
 144             subfields[0][i] = subfields[0][i].trim();
 145             subfields[1][i] = subfields[1][i].trim();
 146             if (subfields[0][i].isEmpty() && subfields[1][i].isEmpty()) {
 147                 logger.warning("Empty pair: " + line);
 148                 continue;
 149             }
 150             if (subfields[0][i].isEmpty()) {
 151                 subfields[0][i] = "__";
 152             }
 153             if (subfields[1][i].isEmpty()) {
 154                 subfields[1][i] = "__";
 155             }
 156         }
 157
 158         if (singleLang) {
 159             HtmlEntry htmlEntry = new HtmlEntry(entrySource, fields[0]);
 160             htmlEntry.html = StringUtil.escapeUnicodeToPureHtml(fields[1], false);
 161
 162             final IndexBuilder titleIndexBuilder = dictBuilder.indexBuilders.get(0);
 163             htmlEntry.addToDictionary(titleIndexBuilder.index.dict);
 164
 165             TokenData tokenData = titleIndexBuilder.getOrCreateTokenData(fields[0]);
 166             tokenData.hasMainEntry = true;
 167             tokenData.htmlEntries.add(0, htmlEntry);
 168
 169             final String[] tokens = NON_CHAR.split(fields[0]);
 170             if (tokens.length > 1) {
 171                 for (final String token : tokens) {
 172                     assert token.length() >= 1;
 173                     if (token.length() <= 2) {
 174                         continue;
 175                     }
 176                     assert token.indexOf("-") == -1;
 177                     if (/*!alreadyDone.contains(token) && */!token.isEmpty()) {
 178                         tokenData = titleIndexBuilder.getOrCreateTokenData(token);
 179                         tokenData.htmlEntries.add(htmlEntry);
 180                     }
 181                 }
 182             }
 183             final IndexedEntry entryData = new IndexedEntry(htmlEntry);
 184             entryData.isValid = true;
 185
 186         } else {
 187             PairEntry pairEntry = new PairEntry(entrySource);
 188             for (int i = 0; i < subfields[0].length; ++i) {
 189                 pairEntry.pairs.add(new PairEntry.Pair(subfields[0][i], subfields[1][i]));
 190             }
 191             final IndexedEntry entryData = new IndexedEntry(pairEntry);
 192             entryData.isValid = true;
 193             for (int l = 0; l < 2; ++l) {
 194                 // alreadyDone.clear();
 195
 196                 final IndexBuilder indexBuilder = dictBuilder.indexBuilders.get(l);
 197                 for (int j = 0; j < subfields[l].length; ++j) {
 198                     String subfield = subfields[l][j];
 199                     if (indexBuilder.index.sortLanguage == Language.de) {
 200                         subfield = parseField_DE(indexBuilder, subfield, entryData, j);
 201                     } else if (indexBuilder.index.sortLanguage == Language.en) {
 202                         subfield = parseField_EN(indexBuilder, subfield, entryData, j);
 203                     }
 204                     parseFieldGeneric(indexBuilder, subfield, entryData, j, subfields[l].length);
 205                 }
 206             }
 207         }
 208
 209     }
 210
 211     private StringBuilder extractParenthesized(StringBuilder in, String startChar, String endChar) {
 212         StringBuilder res = new StringBuilder();
 213         int pos = 0;
 214         while ((pos = in.indexOf(startChar, pos)) != -1) {
 215             int end = in.indexOf(endChar, pos + 1);
 216             if (end == -1) break;
 217             res.append(in, pos + 1, end).append(" ");
 218             in.replace(pos, end + 1, " ");
 219             pos++; // skip the just appended space
 220         }
 221         return res;
 222     }
 223
 224     private void parseFieldGeneric(final IndexBuilder indexBuilder, String field,
 225                                    final IndexedEntry entryData, final int subfieldIdx, final int numSubFields) {
 226         final StringBuilder fieldsb = new StringBuilder(field);
 227         // remove bracketed and parenthesized stuff.
 228         final StringBuilder bracketed = extractParenthesized(fieldsb, "[", "]");
 229         final StringBuilder parenthesized = extractParenthesized(fieldsb, "(", ")");
 230
 231         field = fieldsb.toString().trim();
 232
 233         // split words on non -A-z0-9, do them.
 234         final String[] tokens = NON_CHAR_DASH.split(field);
 235
 236         final EntryTypeName entryTypeName;
 237         if (numSubFields == 1) {
 238             assert subfieldIdx == 0;
 239             if (tokens.length == 1) {
 240                 entryTypeName = EntryTypeName.ONE_WORD;
 241             } else if (tokens.length == 2) {
 242                 entryTypeName = EntryTypeName.TWO_WORDS;
 243             } else if (tokens.length == 3) {
 244                 entryTypeName = EntryTypeName.THREE_WORDS;
 245             } else if (tokens.length == 4) {
 246                 entryTypeName = EntryTypeName.FOUR_WORDS;
 247             } else {
 248                 entryTypeName = EntryTypeName.FIVE_OR_MORE_WORDS;
 249             }
 250         } else {
 251             assert numSubFields > 1;
 252             if (subfieldIdx == 0) {
 253                 if (tokens.length == 1) {
 254                     entryTypeName = EntryTypeName.MULTIROW_HEAD_ONE_WORD;
 255                 } else {
 256                     entryTypeName = EntryTypeName.MULTIROW_HEAD_MANY_WORDS;
 257                 }
 258             } else {
 259                 assert subfieldIdx > 0;
 260                 if (tokens.length == 1) {
 261                     entryTypeName = EntryTypeName.MULTIROW_TAIL_ONE_WORD;
 262                 } else {
 263                     entryTypeName = EntryTypeName.MULTIROW_TAIL_MANY_WORDS;
 264                 }
 265             }
 266         }
 267
 268         for (String token : tokens) {
 269             token = TRIM_PUNC.matcher(token).replaceAll("");
 270             if (/*!alreadyDone.contains(token) && */!token.isEmpty()) {
 271                 indexBuilder.addEntryWithTokens(entryData, Collections.singleton(token), entryTypeName);
 272                 // alreadyDone.add(token);
 273
 274                 // also split words on dashes, do them, too.
 275                 if (token.indexOf('-') != -1) {
 276                     final String[] dashed = StringUtil.split(token, "-");
 277                     for (final String dashedToken : dashed) {
 278                         if (/*!alreadyDone.contains(dashedToken) && */!dashedToken.isEmpty()) {
 279                             indexBuilder.addEntryWithTokens(entryData, Collections.singleton(dashedToken), EntryTypeName.PART_OF_HYPHENATED);
 280                         }
 281                     }
 282                 }
 283
 284             }  // if (!alreadyDone.contains(token)) {
 285         }  // for (final String token : tokens) {
 286
 287         // process bracketed stuff (split on spaces and dashes always)
 288         if (bracketed.length() > 0) {
 289             final String[] bracketedTokens = NON_CHAR.split(bracketed.toString());
 290             for (final String token : bracketedTokens) {
 291                 assert token.indexOf("-") == -1;
 292                 if (/*!alreadyDone.contains(token) && */!token.isEmpty()) {
 293                     indexBuilder.addEntryWithTokens(entryData, Collections.singleton(token), EntryTypeName.BRACKETED);
 294                 }
 295             }
 296         }
 297
 298         // process paren stuff
 299         if (parenthesized.length() > 0) {
 300             final String[] parenTokens = NON_CHAR.split(parenthesized.toString());
 301             for (final String token : parenTokens) {
 302                 assert token.indexOf("-") == -1;
 303                 if (/*!alreadyDone.contains(token) && */!token.isEmpty()) {
 304                     indexBuilder.addEntryWithTokens(entryData, Collections.singleton(token), EntryTypeName.PARENTHESIZED);
 305                 }
 306             }
 307         }
 308
 309     }
 310
 311     private String parseField_DE(final IndexBuilder indexBuilder, String field,
 312                                  final IndexedEntry entryData, final int subfieldIdx) {
 313
 314 //    final Matcher matcher = DE_NOUN.matcher(field);
 315 //    while (matcher.find()) {
 316 //      final String noun = matcher.group(1);
 317         //final String gender = matcher.group(2);
 318 //      if (alreadyDone.add(noun)) {
 319         // System.out.println("Found DE noun " + noun + ", " + gender);
 320 //        final List<EntryData> entries = indexBuilder.getOrCreateEntries(noun, EntryTypeName.NOUN);
 321 //        entries.add(entryData);
 322 //      }
 323 //    }
 324
 325         if (field.indexOf('{') == -1) return field;
 326
 327         // In English, curly braces are used for different tenses.
 328         field = CURLY_BRACED.matcher(field).replaceAll(" ");
 329
 330         return field;
 331     }
 332
 333     private String parseField_EN(final IndexBuilder indexBuilder, String field,
 334                                  final IndexedEntry entryData, final int subfieldIdx) {
 335         if (field.startsWith("to ")) {
 336             field = field.substring(3);
 337         }
 338         return field;
 339     }
 340
 341     public static Set<String> tokenize(final String text, final Pattern pattern) {
 342         final String[] split = pattern.split(text);
 343         final Set<String> result = new LinkedHashSet<>(Arrays.asList(split));
 344         result.remove("");
 345         return result;
 346     }
 347
 348
 349 }