duke@1: /*
duke@1: * Copyright 2000-2006 Sun Microsystems, Inc. All Rights Reserved.
duke@1: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
duke@1: *
duke@1: * This code is free software; you can redistribute it and/or modify it
duke@1: * under the terms of the GNU General Public License version 2 only, as
duke@1: * published by the Free Software Foundation. Sun designates this
duke@1: * particular file as subject to the "Classpath" exception as provided
duke@1: * by Sun in the LICENSE file that accompanied this code.
duke@1: *
duke@1: * This code is distributed in the hope that it will be useful, but WITHOUT
duke@1: * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
duke@1: * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
duke@1: * version 2 for more details (a copy is included in the LICENSE file that
duke@1: * accompanied this code).
duke@1: *
duke@1: * You should have received a copy of the GNU General Public License version
duke@1: * 2 along with this work; if not, write to the Free Software Foundation,
duke@1: * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
duke@1: *
duke@1: * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
duke@1: * CA 95054 USA or visit www.sun.com if you need additional information or
duke@1: * have any questions.
duke@1: */
duke@1:
duke@1: package com.sun.tools.javadoc;
duke@1:
duke@1: import java.util.Locale;
duke@1: import java.util.HashSet;
duke@1: import java.text.Collator;
duke@1: import java.text.BreakIterator;
duke@1:
duke@1: /**
duke@1: * This class holds the information about locales.
duke@1: *
duke@1: * @since 1.4
duke@1: * @author Robert Field
duke@1: */
duke@1: class DocLocale {
duke@1:
duke@1: /**
duke@1: * The locale name will be set by Main, if option is provided on the
duke@1: * command line.
duke@1: */
duke@1: final String localeName;
duke@1:
duke@1: /**
duke@1: * The locale to be used. If user doesen't provide this,
duke@1: * then set it to default locale value.
duke@1: */
duke@1: final Locale locale;
duke@1:
duke@1: /**
duke@1: * The collator for this application. This is to take care of Locale
duke@1: * Specific or Natural Language Text sorting.
duke@1: */
duke@1: final Collator collator;
duke@1:
duke@1: /**
duke@1: * Enclosing DocEnv
duke@1: */
duke@1: private final DocEnv docenv;
duke@1:
duke@1: /**
duke@1: * Sentence instance from the BreakIterator.
duke@1: */
duke@1: private final BreakIterator sentenceBreaker;
duke@1:
duke@1: /**
duke@1: * True is we should use BreakIterator
duke@1: * to compute first sentence.
duke@1: */
duke@1: private boolean useBreakIterator = false;
duke@1:
duke@1: /**
duke@1: * The HTML sentence terminators.
duke@1: */
duke@1: static final String[] sentenceTerminators =
duke@1: {
duke@1: "
", "
", "", "" duke@1: }; duke@1: duke@1: /** duke@1: * Constructor duke@1: */ duke@1: DocLocale(DocEnv docenv, String localeName, boolean useBreakIterator) { duke@1: this.docenv = docenv; duke@1: this.localeName = localeName; duke@1: this.useBreakIterator = useBreakIterator; duke@1: locale = getLocale(); duke@1: if (locale == null) { duke@1: docenv.exit(); duke@1: } else { duke@1: Locale.setDefault(locale); duke@1: } duke@1: collator = Collator.getInstance(locale); duke@1: sentenceBreaker = BreakIterator.getSentenceInstance(locale); duke@1: } duke@1: duke@1: /** duke@1: * Get the locale if specified on the command line duke@1: * else return null and if locale option is not used duke@1: * then return default locale. duke@1: */ duke@1: private Locale getLocale() { duke@1: Locale userlocale = null; duke@1: if (localeName.length() > 0) { duke@1: int firstuscore = localeName.indexOf('_'); duke@1: int seconduscore = -1; duke@1: String language = null; duke@1: String country = null; duke@1: String variant = null; duke@1: if (firstuscore == 2) { duke@1: language = localeName.substring(0, firstuscore); duke@1: seconduscore = localeName.indexOf('_', firstuscore + 1); duke@1: if (seconduscore > 0) { duke@1: if (seconduscore != firstuscore + 3 || duke@1: localeName.length() <= seconduscore + 1) { duke@1: docenv.error(null, "main.malformed_locale_name", localeName); duke@1: return null; duke@1: } duke@1: country = localeName.substring(firstuscore + 1, duke@1: seconduscore); duke@1: variant = localeName.substring(seconduscore + 1); duke@1: } else if (localeName.length() == firstuscore + 3) { duke@1: country = localeName.substring(firstuscore + 1); duke@1: } else { duke@1: docenv.error(null, "main.malformed_locale_name", localeName); duke@1: return null; duke@1: } duke@1: } else if (firstuscore == -1 && localeName.length() == 2) { duke@1: language = localeName; duke@1: } else { duke@1: docenv.error(null, "main.malformed_locale_name", localeName); duke@1: return null; duke@1: } duke@1: userlocale = searchLocale(language, country, variant); duke@1: if (userlocale == null) { duke@1: docenv.error(null, "main.illegal_locale_name", localeName); duke@1: return null; duke@1: } else { duke@1: return userlocale; duke@1: } duke@1: } else { duke@1: return Locale.getDefault(); duke@1: } duke@1: } duke@1: duke@1: /** duke@1: * Search the locale for specified language, specified country and duke@1: * specified variant. duke@1: */ duke@1: private Locale searchLocale(String language, String country, duke@1: String variant) { duke@1: Locale[] locales = Locale.getAvailableLocales(); duke@1: for (int i = 0; i < locales.length; i++) { duke@1: if (locales[i].getLanguage().equals(language) && duke@1: (country == null || locales[i].getCountry().equals(country)) && duke@1: (variant == null || locales[i].getVariant().equals(variant))) { duke@1: return locales[i]; duke@1: } duke@1: } duke@1: return null; duke@1: } duke@1: duke@1: String localeSpecificFirstSentence(DocImpl doc, String s) { duke@1: if (s == null || s.length() == 0) { duke@1: return ""; duke@1: } duke@1: int index = s.indexOf("-->"); duke@1: if(s.trim().startsWith("