Tue, 09 Oct 2012 19:10:00 -0700
8000663: clean up langtools imports
Reviewed-by: darcy
duke@1 | 1 | /* |
jjg@1357 | 2 | * Copyright (c) 2000, 2012, Oracle and/or its affiliates. All rights reserved. |
duke@1 | 3 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
duke@1 | 4 | * |
duke@1 | 5 | * This code is free software; you can redistribute it and/or modify it |
duke@1 | 6 | * under the terms of the GNU General Public License version 2 only, as |
ohair@554 | 7 | * published by the Free Software Foundation. Oracle designates this |
duke@1 | 8 | * particular file as subject to the "Classpath" exception as provided |
ohair@554 | 9 | * by Oracle in the LICENSE file that accompanied this code. |
duke@1 | 10 | * |
duke@1 | 11 | * This code is distributed in the hope that it will be useful, but WITHOUT |
duke@1 | 12 | * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
duke@1 | 13 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
duke@1 | 14 | * version 2 for more details (a copy is included in the LICENSE file that |
duke@1 | 15 | * accompanied this code). |
duke@1 | 16 | * |
duke@1 | 17 | * You should have received a copy of the GNU General Public License version |
duke@1 | 18 | * 2 along with this work; if not, write to the Free Software Foundation, |
duke@1 | 19 | * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
duke@1 | 20 | * |
ohair@554 | 21 | * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
ohair@554 | 22 | * or visit www.oracle.com if you need additional information or have any |
ohair@554 | 23 | * questions. |
duke@1 | 24 | */ |
duke@1 | 25 | |
duke@1 | 26 | package com.sun.tools.javadoc; |
duke@1 | 27 | |
jjg@1357 | 28 | import java.text.BreakIterator; |
jjg@1357 | 29 | import java.text.Collator; |
duke@1 | 30 | import java.util.Locale; |
duke@1 | 31 | |
duke@1 | 32 | /** |
duke@1 | 33 | * This class holds the information about locales. |
duke@1 | 34 | * |
duke@1 | 35 | * @since 1.4 |
duke@1 | 36 | * @author Robert Field |
duke@1 | 37 | */ |
duke@1 | 38 | class DocLocale { |
duke@1 | 39 | |
duke@1 | 40 | /** |
duke@1 | 41 | * The locale name will be set by Main, if option is provided on the |
duke@1 | 42 | * command line. |
duke@1 | 43 | */ |
duke@1 | 44 | final String localeName; |
duke@1 | 45 | |
duke@1 | 46 | /** |
duke@1 | 47 | * The locale to be used. If user doesen't provide this, |
duke@1 | 48 | * then set it to default locale value. |
duke@1 | 49 | */ |
duke@1 | 50 | final Locale locale; |
duke@1 | 51 | |
duke@1 | 52 | /** |
duke@1 | 53 | * The collator for this application. This is to take care of Locale |
duke@1 | 54 | * Specific or Natural Language Text sorting. |
duke@1 | 55 | */ |
duke@1 | 56 | final Collator collator; |
duke@1 | 57 | |
duke@1 | 58 | /** |
duke@1 | 59 | * Enclosing DocEnv |
duke@1 | 60 | */ |
duke@1 | 61 | private final DocEnv docenv; |
duke@1 | 62 | |
duke@1 | 63 | /** |
duke@1 | 64 | * Sentence instance from the BreakIterator. |
duke@1 | 65 | */ |
duke@1 | 66 | private final BreakIterator sentenceBreaker; |
duke@1 | 67 | |
duke@1 | 68 | /** |
duke@1 | 69 | * True is we should use <code>BreakIterator</code> |
duke@1 | 70 | * to compute first sentence. |
duke@1 | 71 | */ |
duke@1 | 72 | private boolean useBreakIterator = false; |
duke@1 | 73 | |
duke@1 | 74 | /** |
duke@1 | 75 | * The HTML sentence terminators. |
duke@1 | 76 | */ |
duke@1 | 77 | static final String[] sentenceTerminators = |
duke@1 | 78 | { |
duke@1 | 79 | "<p>", "</p>", "<h1>", "<h2>", |
duke@1 | 80 | "<h3>", "<h4>", "<h5>", "<h6>", |
duke@1 | 81 | "</h1>", "</h2>", "</h3>", "</h4>", "</h5>", |
duke@1 | 82 | "</h6>", "<hr>", "<pre>", "</pre>" |
duke@1 | 83 | }; |
duke@1 | 84 | |
duke@1 | 85 | /** |
duke@1 | 86 | * Constructor |
duke@1 | 87 | */ |
duke@1 | 88 | DocLocale(DocEnv docenv, String localeName, boolean useBreakIterator) { |
duke@1 | 89 | this.docenv = docenv; |
duke@1 | 90 | this.localeName = localeName; |
duke@1 | 91 | this.useBreakIterator = useBreakIterator; |
duke@1 | 92 | locale = getLocale(); |
duke@1 | 93 | if (locale == null) { |
duke@1 | 94 | docenv.exit(); |
duke@1 | 95 | } else { |
duke@1 | 96 | Locale.setDefault(locale); |
duke@1 | 97 | } |
duke@1 | 98 | collator = Collator.getInstance(locale); |
duke@1 | 99 | sentenceBreaker = BreakIterator.getSentenceInstance(locale); |
duke@1 | 100 | } |
duke@1 | 101 | |
duke@1 | 102 | /** |
duke@1 | 103 | * Get the locale if specified on the command line |
duke@1 | 104 | * else return null and if locale option is not used |
duke@1 | 105 | * then return default locale. |
duke@1 | 106 | */ |
duke@1 | 107 | private Locale getLocale() { |
duke@1 | 108 | Locale userlocale = null; |
duke@1 | 109 | if (localeName.length() > 0) { |
duke@1 | 110 | int firstuscore = localeName.indexOf('_'); |
duke@1 | 111 | int seconduscore = -1; |
duke@1 | 112 | String language = null; |
duke@1 | 113 | String country = null; |
duke@1 | 114 | String variant = null; |
duke@1 | 115 | if (firstuscore == 2) { |
duke@1 | 116 | language = localeName.substring(0, firstuscore); |
duke@1 | 117 | seconduscore = localeName.indexOf('_', firstuscore + 1); |
duke@1 | 118 | if (seconduscore > 0) { |
duke@1 | 119 | if (seconduscore != firstuscore + 3 || |
duke@1 | 120 | localeName.length() <= seconduscore + 1) { |
duke@1 | 121 | docenv.error(null, "main.malformed_locale_name", localeName); |
duke@1 | 122 | return null; |
duke@1 | 123 | } |
duke@1 | 124 | country = localeName.substring(firstuscore + 1, |
duke@1 | 125 | seconduscore); |
duke@1 | 126 | variant = localeName.substring(seconduscore + 1); |
duke@1 | 127 | } else if (localeName.length() == firstuscore + 3) { |
duke@1 | 128 | country = localeName.substring(firstuscore + 1); |
duke@1 | 129 | } else { |
duke@1 | 130 | docenv.error(null, "main.malformed_locale_name", localeName); |
duke@1 | 131 | return null; |
duke@1 | 132 | } |
duke@1 | 133 | } else if (firstuscore == -1 && localeName.length() == 2) { |
duke@1 | 134 | language = localeName; |
duke@1 | 135 | } else { |
duke@1 | 136 | docenv.error(null, "main.malformed_locale_name", localeName); |
duke@1 | 137 | return null; |
duke@1 | 138 | } |
duke@1 | 139 | userlocale = searchLocale(language, country, variant); |
duke@1 | 140 | if (userlocale == null) { |
duke@1 | 141 | docenv.error(null, "main.illegal_locale_name", localeName); |
duke@1 | 142 | return null; |
duke@1 | 143 | } else { |
duke@1 | 144 | return userlocale; |
duke@1 | 145 | } |
duke@1 | 146 | } else { |
duke@1 | 147 | return Locale.getDefault(); |
duke@1 | 148 | } |
duke@1 | 149 | } |
duke@1 | 150 | |
duke@1 | 151 | /** |
duke@1 | 152 | * Search the locale for specified language, specified country and |
duke@1 | 153 | * specified variant. |
duke@1 | 154 | */ |
duke@1 | 155 | private Locale searchLocale(String language, String country, |
duke@1 | 156 | String variant) { |
duke@1 | 157 | Locale[] locales = Locale.getAvailableLocales(); |
duke@1 | 158 | for (int i = 0; i < locales.length; i++) { |
duke@1 | 159 | if (locales[i].getLanguage().equals(language) && |
duke@1 | 160 | (country == null || locales[i].getCountry().equals(country)) && |
duke@1 | 161 | (variant == null || locales[i].getVariant().equals(variant))) { |
duke@1 | 162 | return locales[i]; |
duke@1 | 163 | } |
duke@1 | 164 | } |
duke@1 | 165 | return null; |
duke@1 | 166 | } |
duke@1 | 167 | |
duke@1 | 168 | String localeSpecificFirstSentence(DocImpl doc, String s) { |
duke@1 | 169 | if (s == null || s.length() == 0) { |
duke@1 | 170 | return ""; |
duke@1 | 171 | } |
duke@1 | 172 | int index = s.indexOf("-->"); |
duke@1 | 173 | if(s.trim().startsWith("<!--") && index != -1) { |
duke@1 | 174 | return localeSpecificFirstSentence(doc, s.substring(index + 3, s.length())); |
duke@1 | 175 | } |
duke@1 | 176 | if (useBreakIterator || !locale.getLanguage().equals("en")) { |
duke@1 | 177 | sentenceBreaker.setText(s.replace('\n', ' ')); |
duke@1 | 178 | int start = sentenceBreaker.first(); |
duke@1 | 179 | int end = sentenceBreaker.next(); |
duke@1 | 180 | return s.substring(start, end).trim(); |
duke@1 | 181 | } else { |
duke@1 | 182 | return englishLanguageFirstSentence(s).trim(); |
duke@1 | 183 | } |
duke@1 | 184 | } |
duke@1 | 185 | |
duke@1 | 186 | /** |
duke@1 | 187 | * Return the first sentence of a string, where a sentence ends |
duke@1 | 188 | * with a period followed be white space. |
duke@1 | 189 | */ |
duke@1 | 190 | private String englishLanguageFirstSentence(String s) { |
duke@1 | 191 | if (s == null) { |
duke@1 | 192 | return null; |
duke@1 | 193 | } |
duke@1 | 194 | int len = s.length(); |
duke@1 | 195 | boolean period = false; |
duke@1 | 196 | for (int i = 0 ; i < len ; i++) { |
duke@1 | 197 | switch (s.charAt(i)) { |
duke@1 | 198 | case '.': |
duke@1 | 199 | period = true; |
duke@1 | 200 | break; |
duke@1 | 201 | case ' ': |
duke@1 | 202 | case '\t': |
duke@1 | 203 | case '\n': |
duke@1 | 204 | case '\r': |
duke@1 | 205 | case '\f': |
duke@1 | 206 | if (period) { |
duke@1 | 207 | return s.substring(0, i); |
duke@1 | 208 | } |
duke@1 | 209 | break; |
duke@1 | 210 | case '<': |
duke@1 | 211 | if (i > 0) { |
duke@1 | 212 | if (htmlSentenceTerminatorFound(s, i)) { |
duke@1 | 213 | return s.substring(0, i); |
duke@1 | 214 | } |
duke@1 | 215 | } |
duke@1 | 216 | break; |
duke@1 | 217 | default: |
duke@1 | 218 | period = false; |
duke@1 | 219 | } |
duke@1 | 220 | } |
duke@1 | 221 | return s; |
duke@1 | 222 | } |
duke@1 | 223 | |
duke@1 | 224 | /** |
duke@1 | 225 | * Find out if there is any HTML tag in the given string. If found |
duke@1 | 226 | * return true else return false. |
duke@1 | 227 | */ |
duke@1 | 228 | private boolean htmlSentenceTerminatorFound(String str, int index) { |
duke@1 | 229 | for (int i = 0; i < sentenceTerminators.length; i++) { |
duke@1 | 230 | String terminator = sentenceTerminators[i]; |
duke@1 | 231 | if (str.regionMatches(true, index, terminator, |
duke@1 | 232 | 0, terminator.length())) { |
duke@1 | 233 | return true; |
duke@1 | 234 | } |
duke@1 | 235 | } |
duke@1 | 236 | return false; |
duke@1 | 237 | } |
duke@1 | 238 | } |