123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258 |
- /*
- * Licensed to the Apache Software Foundation (ASF) under one or more
- * contributor license agreements. See the NOTICE file distributed with
- * this work for additional information regarding copyright ownership.
- * The ASF licenses this file to You under the Apache License, Version 2.0
- * (the "License"); you may not use this file except in compliance with
- * the License. You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
- /* $Id$ */
-
- package org.apache.fop.hyphenation;
-
- import java.io.BufferedInputStream;
- import java.io.IOException;
- import java.io.InputStream;
- import java.io.ObjectInputStream;
- import java.net.URISyntaxException;
- import java.util.Map;
-
- import org.xml.sax.InputSource;
-
- import org.apache.commons.io.IOUtils;
- import org.apache.commons.logging.Log;
- import org.apache.commons.logging.LogFactory;
-
- import org.apache.fop.ResourceEventProducer;
- import org.apache.fop.apps.FOUserAgent;
- import org.apache.fop.apps.io.InternalResourceResolver;
- import org.apache.fop.events.EventBroadcaster;
-
- /**
- * <p>This class is the main entry point to the hyphenation package.
- * You can use only the static methods or create an instance.</p>
- *
- * <p>This work was authored by Carlos Villegas (cav@uniscope.co.jp).</p>
- */
- public final class Hyphenator {
-
- /** logging instance */
- private static final Log log = LogFactory.getLog(Hyphenator.class);
-
- /** Enables a dump of statistics. Note: If activated content is sent to System.out! */
- private static boolean statisticsDump;
-
- public static final String HYPTYPE = Hyphenator.class.toString() + "HYP";
- public static final String XMLTYPE = Hyphenator.class.toString() + "XML";
-
- private Hyphenator() {
- }
-
- public static HyphenationTree getHyphenationTree(String lang, String country,
- InternalResourceResolver resourceResolver, Map hyphPatNames, FOUserAgent foUserAgent) {
- String llccKey = HyphenationTreeCache.constructLlccKey(lang, country);
-
- HyphenationTreeCache cache = foUserAgent.getHyphenationTreeCache();
-
- // See if there was an error finding this hyphenation tree before
- if (cache == null || cache.isMissing(llccKey)) {
- return null;
- }
-
- HyphenationTree hTree;
- // first try to find it in the cache
- hTree = cache.getHyphenationTree(lang, country);
- if (hTree != null) {
- return hTree;
- }
-
- String key = HyphenationTreeCache.constructUserKey(lang, country, hyphPatNames);
- if (key == null) {
- key = llccKey;
- }
- if (resourceResolver != null) {
- hTree = getUserHyphenationTree(key, resourceResolver);
- }
- if (hTree == null) {
- hTree = getFopHyphenationTree(key);
- }
-
- if (hTree == null && country != null && !country.equals("none")) {
- return getHyphenationTree(lang, null, resourceResolver, hyphPatNames, foUserAgent);
- }
-
- // put it into the pattern cache
- if (hTree != null) {
- cache.cache(llccKey, hTree);
- } else {
- EventBroadcaster eventBroadcaster = foUserAgent.getEventBroadcaster();
- if (eventBroadcaster == null) {
- log.error("Couldn't find hyphenation pattern " + llccKey);
- } else {
- ResourceEventProducer producer = ResourceEventProducer.Provider.get(eventBroadcaster);
- String name = key.replace(HYPTYPE, "").replace(XMLTYPE, "");
- producer.hyphenationNotFound(cache, name);
- }
- cache.noteMissing(llccKey);
- }
- return hTree;
- }
-
- private static InputStream getResourceStream(String key) {
- InputStream is = null;
- // Try to use Context Class Loader to load the properties file.
- try {
- java.lang.reflect.Method getCCL = Thread.class.getMethod(
- "getContextClassLoader", new Class[0]);
- if (getCCL != null) {
- ClassLoader contextClassLoader = (ClassLoader)getCCL.invoke(
- Thread.currentThread(),
- new Object[0]);
- is = contextClassLoader.getResourceAsStream("hyph/" + key
- + ".hyp");
- }
- } catch (NoSuchMethodException e) {
- //ignore, fallback further down
- } catch (IllegalAccessException e) {
- //ignore, fallback further down
- } catch (java.lang.reflect.InvocationTargetException e) {
- //ignore, fallback further down
- }
-
- if (is == null) {
- is = Hyphenator.class.getResourceAsStream("/hyph/" + key
- + ".hyp");
- }
-
- return is;
- }
-
- private static HyphenationTree readHyphenationTree(InputStream in) {
- HyphenationTree hTree = null;
- try {
- ObjectInputStream ois = new ObjectInputStream(in);
- hTree = (HyphenationTree)ois.readObject();
- } catch (IOException ioe) {
- log.error("I/O error while loading precompiled hyphenation pattern file", ioe);
- } catch (ClassNotFoundException cnfe) {
- log.error("Error while reading hyphenation object from file", cnfe);
- }
- return hTree;
- }
-
- /**
- * Returns a hyphenation tree. This method looks in the resources (getResourceStream) for
- * the hyphenation patterns.
- * @param key the language/country key
- * @return the hyphenation tree or null if it wasn't found in the resources
- */
- public static HyphenationTree getFopHyphenationTree(String key) {
- InputStream is = getResourceStream(key);
- if (is == null) {
- if (log.isDebugEnabled()) {
- log.debug("Couldn't find precompiled hyphenation pattern "
- + key + " in resources");
- }
- return null;
- }
- return readHyphenationTree(is);
- }
-
- /**
- * Load tree from serialized file or xml file
- * using configuration settings
- * @param key language key for the requested hyphenation file
- * @param resourceResolver resource resolver to find the hyphenation files
- * @return the requested HypenationTree or null if it is not available
- */
- public static HyphenationTree getUserHyphenationTree(String key,
- InternalResourceResolver resourceResolver) {
- HyphenationTree hTree = null;
- // I use here the following convention. The file name specified in
- // the configuration is taken as the base name. First we try
- // name + ".hyp" assuming a serialized HyphenationTree. If that fails
- // we try name + ".xml", assumming a raw hyphenation pattern file.
-
- // first try serialized object
- String name = key + ".hyp";
- if (key.endsWith(HYPTYPE)) {
- name = key.replace(HYPTYPE, "");
- }
- if (!key.endsWith(XMLTYPE)) {
- try {
- InputStream in = getHyphenationTreeStream(name, resourceResolver);
- try {
- hTree = readHyphenationTree(in);
- } finally {
- IOUtils.closeQuietly(in);
- }
- return hTree;
- } catch (IOException ioe) {
- if (log.isDebugEnabled()) {
- log.debug("I/O problem while trying to load " + name, ioe);
- }
- }
- }
-
- // try the raw XML file
- name = key + ".xml";
- if (key.endsWith(XMLTYPE)) {
- name = key.replace(XMLTYPE, "");
- }
- hTree = new HyphenationTree();
- try {
- InputStream in = getHyphenationTreeStream(name, resourceResolver);
- try {
- InputSource src = new InputSource(in);
- src.setSystemId(name);
- hTree.loadPatterns(src);
- } finally {
- IOUtils.closeQuietly(in);
- }
- if (statisticsDump) {
- System.out.println("Stats: ");
- hTree.printStats();
- }
- return hTree;
- } catch (HyphenationException ex) {
- log.error("Can't load user patterns from XML file " + name + ": " + ex.getMessage());
- return null;
- } catch (IOException ioe) {
- if (log.isDebugEnabled()) {
- log.debug("I/O problem while trying to load " + name, ioe);
- }
- return null;
- }
- }
-
- private static InputStream getHyphenationTreeStream(String name,
- InternalResourceResolver resourceResolver) throws IOException {
- try {
- return new BufferedInputStream(resourceResolver.getResource(name));
- } catch (URISyntaxException use) {
- log.debug("An exception was thrown while attempting to load " + name, use);
- }
- return null;
- }
-
- public static Hyphenation hyphenate(String lang, String country, InternalResourceResolver resourceResolver,
- Map hyphPatNames,
- String word,
- int leftMin, int rightMin, FOUserAgent foUserAgent) {
- HyphenationTree hTree = getHyphenationTree(lang, country, resourceResolver, hyphPatNames, foUserAgent);
- if (hTree == null) {
- return null;
- }
- return hTree.hyphenate(word, leftMin, rightMin);
- }
-
- }
|