langtools/src/share/classes/com/sun/tools/doclets/internal/toolkit/util/Extern.java
author briangoetz
Wed, 18 Dec 2013 16:05:18 -0500
changeset 22163 3651128c74eb
parent 22159 682da512ec17
child 23974 d53628eda3d1
permissions -rw-r--r--
8030244: Update langtools to use Diamond Reviewed-by: darcy
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
10
06bc494ca11e Initial load
duke
parents:
diff changeset
     1
/*
14258
8d2148961366 8000663: clean up langtools imports
jjg
parents: 5520
diff changeset
     2
 * Copyright (c) 1998, 2012, Oracle and/or its affiliates. All rights reserved.
10
06bc494ca11e Initial load
duke
parents:
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
06bc494ca11e Initial load
duke
parents:
diff changeset
     4
 *
06bc494ca11e Initial load
duke
parents:
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
06bc494ca11e Initial load
duke
parents:
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
5520
86e4b9a9da40 6943119: Rebrand source copyright notices
ohair
parents: 1264
diff changeset
     7
 * published by the Free Software Foundation.  Oracle designates this
10
06bc494ca11e Initial load
duke
parents:
diff changeset
     8
 * particular file as subject to the "Classpath" exception as provided
5520
86e4b9a9da40 6943119: Rebrand source copyright notices
ohair
parents: 1264
diff changeset
     9
 * by Oracle in the LICENSE file that accompanied this code.
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    10
 *
06bc494ca11e Initial load
duke
parents:
diff changeset
    11
 * This code is distributed in the hope that it will be useful, but WITHOUT
06bc494ca11e Initial load
duke
parents:
diff changeset
    12
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
06bc494ca11e Initial load
duke
parents:
diff changeset
    13
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
06bc494ca11e Initial load
duke
parents:
diff changeset
    14
 * version 2 for more details (a copy is included in the LICENSE file that
06bc494ca11e Initial load
duke
parents:
diff changeset
    15
 * accompanied this code).
06bc494ca11e Initial load
duke
parents:
diff changeset
    16
 *
06bc494ca11e Initial load
duke
parents:
diff changeset
    17
 * You should have received a copy of the GNU General Public License version
06bc494ca11e Initial load
duke
parents:
diff changeset
    18
 * 2 along with this work; if not, write to the Free Software Foundation,
06bc494ca11e Initial load
duke
parents:
diff changeset
    19
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
06bc494ca11e Initial load
duke
parents:
diff changeset
    20
 *
5520
86e4b9a9da40 6943119: Rebrand source copyright notices
ohair
parents: 1264
diff changeset
    21
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
86e4b9a9da40 6943119: Rebrand source copyright notices
ohair
parents: 1264
diff changeset
    22
 * or visit www.oracle.com if you need additional information or have any
86e4b9a9da40 6943119: Rebrand source copyright notices
ohair
parents: 1264
diff changeset
    23
 * questions.
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    24
 */
06bc494ca11e Initial load
duke
parents:
diff changeset
    25
06bc494ca11e Initial load
duke
parents:
diff changeset
    26
package com.sun.tools.doclets.internal.toolkit.util;
06bc494ca11e Initial load
duke
parents:
diff changeset
    27
14258
8d2148961366 8000663: clean up langtools imports
jjg
parents: 5520
diff changeset
    28
import java.io.*;
8d2148961366 8000663: clean up langtools imports
jjg
parents: 5520
diff changeset
    29
import java.net.*;
8d2148961366 8000663: clean up langtools imports
jjg
parents: 5520
diff changeset
    30
import java.util.HashMap;
8d2148961366 8000663: clean up langtools imports
jjg
parents: 5520
diff changeset
    31
import java.util.Map;
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    32
14545
2e7bab0639b8 6493690: javadoc should have a javax.tools.Tool service provider installed in tools.jar
jjg
parents: 14368
diff changeset
    33
import javax.tools.DocumentationTool;
14368
6f4c62de6985 8001664: refactor javadoc to use abstraction to handle files
jjg
parents: 14361
diff changeset
    34
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    35
import com.sun.javadoc.*;
14258
8d2148961366 8000663: clean up langtools imports
jjg
parents: 5520
diff changeset
    36
import com.sun.tools.doclets.internal.toolkit.*;
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    37
06bc494ca11e Initial load
duke
parents:
diff changeset
    38
/**
06bc494ca11e Initial load
duke
parents:
diff changeset
    39
 * Process and manage "-link" and "-linkoffline" to external packages. The
06bc494ca11e Initial load
duke
parents:
diff changeset
    40
 * options "-link" and "-linkoffline" both depend on the fact that Javadoc now
06bc494ca11e Initial load
duke
parents:
diff changeset
    41
 * generates "package-list"(lists all the packages which are getting
06bc494ca11e Initial load
duke
parents:
diff changeset
    42
 * documented) file in the current or the destination directory, while
06bc494ca11e Initial load
duke
parents:
diff changeset
    43
 * generating the documentation.
06bc494ca11e Initial load
duke
parents:
diff changeset
    44
 *
14260
727a84636f12 8000665: fix "internal API" comments on javadoc files
jjg
parents: 14259
diff changeset
    45
 *  <p><b>This is NOT part of any supported API.
727a84636f12 8000665: fix "internal API" comments on javadoc files
jjg
parents: 14259
diff changeset
    46
 *  If you write code that depends on this, you do so at your own risk.
727a84636f12 8000665: fix "internal API" comments on javadoc files
jjg
parents: 14259
diff changeset
    47
 *  This code and its internal interfaces are subject to change or
727a84636f12 8000665: fix "internal API" comments on javadoc files
jjg
parents: 14259
diff changeset
    48
 *  deletion without notice.</b>
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    49
 *
06bc494ca11e Initial load
duke
parents:
diff changeset
    50
 * @author Atul M Dambalkar
06bc494ca11e Initial load
duke
parents:
diff changeset
    51
 * @author Robert Field
06bc494ca11e Initial load
duke
parents:
diff changeset
    52
 */
06bc494ca11e Initial load
duke
parents:
diff changeset
    53
public class Extern {
06bc494ca11e Initial load
duke
parents:
diff changeset
    54
06bc494ca11e Initial load
duke
parents:
diff changeset
    55
    /**
06bc494ca11e Initial load
duke
parents:
diff changeset
    56
     * Map package names onto Extern Item objects.
06bc494ca11e Initial load
duke
parents:
diff changeset
    57
     * Lazily initialized.
06bc494ca11e Initial load
duke
parents:
diff changeset
    58
     */
868
d0f233085cbb 6657907: javadoc has unchecked warnings
jjg
parents: 10
diff changeset
    59
    private Map<String,Item> packageToItemMap;
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    60
06bc494ca11e Initial load
duke
parents:
diff changeset
    61
    /**
06bc494ca11e Initial load
duke
parents:
diff changeset
    62
     * The global configuration information for this run.
06bc494ca11e Initial load
duke
parents:
diff changeset
    63
     */
06bc494ca11e Initial load
duke
parents:
diff changeset
    64
    private final Configuration configuration;
06bc494ca11e Initial load
duke
parents:
diff changeset
    65
06bc494ca11e Initial load
duke
parents:
diff changeset
    66
    /**
06bc494ca11e Initial load
duke
parents:
diff changeset
    67
     * True if we are using -linkoffline and false if -link is used instead.
06bc494ca11e Initial load
duke
parents:
diff changeset
    68
     */
06bc494ca11e Initial load
duke
parents:
diff changeset
    69
    private boolean linkoffline = false;
06bc494ca11e Initial load
duke
parents:
diff changeset
    70
06bc494ca11e Initial load
duke
parents:
diff changeset
    71
    /**
06bc494ca11e Initial load
duke
parents:
diff changeset
    72
     * Stores the info for one external doc set
06bc494ca11e Initial load
duke
parents:
diff changeset
    73
     */
06bc494ca11e Initial load
duke
parents:
diff changeset
    74
    private class Item {
06bc494ca11e Initial load
duke
parents:
diff changeset
    75
06bc494ca11e Initial load
duke
parents:
diff changeset
    76
        /**
06bc494ca11e Initial load
duke
parents:
diff changeset
    77
         * Package name, found in the "package-list" file in the {@link path}.
06bc494ca11e Initial load
duke
parents:
diff changeset
    78
         */
06bc494ca11e Initial load
duke
parents:
diff changeset
    79
        final String packageName;
06bc494ca11e Initial load
duke
parents:
diff changeset
    80
06bc494ca11e Initial load
duke
parents:
diff changeset
    81
        /**
06bc494ca11e Initial load
duke
parents:
diff changeset
    82
         * The URL or the directory path at which the package documentation will be
06bc494ca11e Initial load
duke
parents:
diff changeset
    83
         * avaliable.
06bc494ca11e Initial load
duke
parents:
diff changeset
    84
         */
06bc494ca11e Initial load
duke
parents:
diff changeset
    85
        final String path;
06bc494ca11e Initial load
duke
parents:
diff changeset
    86
06bc494ca11e Initial load
duke
parents:
diff changeset
    87
        /**
06bc494ca11e Initial load
duke
parents:
diff changeset
    88
         * If given path is directory path then true else if it is a URL then false.
06bc494ca11e Initial load
duke
parents:
diff changeset
    89
         */
06bc494ca11e Initial load
duke
parents:
diff changeset
    90
        final boolean relative;
06bc494ca11e Initial load
duke
parents:
diff changeset
    91
06bc494ca11e Initial load
duke
parents:
diff changeset
    92
        /**
06bc494ca11e Initial load
duke
parents:
diff changeset
    93
         * Constructor to build a Extern Item object and map it with the package name.
06bc494ca11e Initial load
duke
parents:
diff changeset
    94
         * If the same package name is found in the map, then the first mapped
06bc494ca11e Initial load
duke
parents:
diff changeset
    95
         * Item object or offline location will be retained.
06bc494ca11e Initial load
duke
parents:
diff changeset
    96
         *
14259
fb94a1df0d53 8000208: fix langtools javadoc comment issues
jjg
parents: 14258
diff changeset
    97
         * @param packageName Package name found in the "package-list" file.
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    98
         * @param path        URL or Directory path from where the "package-list"
06bc494ca11e Initial load
duke
parents:
diff changeset
    99
         * file is picked.
06bc494ca11e Initial load
duke
parents:
diff changeset
   100
         * @param relative    True if path is URL, false if directory path.
06bc494ca11e Initial load
duke
parents:
diff changeset
   101
         */
06bc494ca11e Initial load
duke
parents:
diff changeset
   102
        Item(String packageName, String path, boolean relative) {
06bc494ca11e Initial load
duke
parents:
diff changeset
   103
            this.packageName = packageName;
06bc494ca11e Initial load
duke
parents:
diff changeset
   104
            this.path = path;
06bc494ca11e Initial load
duke
parents:
diff changeset
   105
            this.relative = relative;
06bc494ca11e Initial load
duke
parents:
diff changeset
   106
            if (packageToItemMap == null) {
22163
3651128c74eb 8030244: Update langtools to use Diamond
briangoetz
parents: 22159
diff changeset
   107
                packageToItemMap = new HashMap<>();
10
06bc494ca11e Initial load
duke
parents:
diff changeset
   108
            }
06bc494ca11e Initial load
duke
parents:
diff changeset
   109
            if (!packageToItemMap.containsKey(packageName)) { // save the previous
06bc494ca11e Initial load
duke
parents:
diff changeset
   110
                packageToItemMap.put(packageName, this);        // mapped location
06bc494ca11e Initial load
duke
parents:
diff changeset
   111
            }
06bc494ca11e Initial load
duke
parents:
diff changeset
   112
        }
06bc494ca11e Initial load
duke
parents:
diff changeset
   113
06bc494ca11e Initial load
duke
parents:
diff changeset
   114
        /**
06bc494ca11e Initial load
duke
parents:
diff changeset
   115
         * String representation of "this" with packagename and the path.
06bc494ca11e Initial load
duke
parents:
diff changeset
   116
         */
06bc494ca11e Initial load
duke
parents:
diff changeset
   117
        public String toString() {
06bc494ca11e Initial load
duke
parents:
diff changeset
   118
            return packageName + (relative? " -> " : " => ") + path;
06bc494ca11e Initial load
duke
parents:
diff changeset
   119
        }
06bc494ca11e Initial load
duke
parents:
diff changeset
   120
    }
06bc494ca11e Initial load
duke
parents:
diff changeset
   121
06bc494ca11e Initial load
duke
parents:
diff changeset
   122
    public Extern(Configuration configuration) {
06bc494ca11e Initial load
duke
parents:
diff changeset
   123
        this.configuration = configuration;
06bc494ca11e Initial load
duke
parents:
diff changeset
   124
    }
06bc494ca11e Initial load
duke
parents:
diff changeset
   125
06bc494ca11e Initial load
duke
parents:
diff changeset
   126
    /**
06bc494ca11e Initial load
duke
parents:
diff changeset
   127
     * Determine if a doc item is externally documented.
06bc494ca11e Initial load
duke
parents:
diff changeset
   128
     *
06bc494ca11e Initial load
duke
parents:
diff changeset
   129
     * @param doc A ProgramElementDoc.
06bc494ca11e Initial load
duke
parents:
diff changeset
   130
     */
06bc494ca11e Initial load
duke
parents:
diff changeset
   131
    public boolean isExternal(ProgramElementDoc doc) {
06bc494ca11e Initial load
duke
parents:
diff changeset
   132
        if (packageToItemMap == null) {
06bc494ca11e Initial load
duke
parents:
diff changeset
   133
            return false;
06bc494ca11e Initial load
duke
parents:
diff changeset
   134
        }
06bc494ca11e Initial load
duke
parents:
diff changeset
   135
        return packageToItemMap.get(doc.containingPackage().name()) != null;
06bc494ca11e Initial load
duke
parents:
diff changeset
   136
    }
06bc494ca11e Initial load
duke
parents:
diff changeset
   137
06bc494ca11e Initial load
duke
parents:
diff changeset
   138
    /**
06bc494ca11e Initial load
duke
parents:
diff changeset
   139
     * Convert a link to be an external link if appropriate.
06bc494ca11e Initial load
duke
parents:
diff changeset
   140
     *
06bc494ca11e Initial load
duke
parents:
diff changeset
   141
     * @param pkgName The package name.
06bc494ca11e Initial load
duke
parents:
diff changeset
   142
     * @param relativepath    The relative path.
14358
9eda9239cba0 8000416: refactor javadoc to provide and use an abstraction for relative URIs
jjg
parents: 14357
diff changeset
   143
     * @param filename    The link to convert.
10
06bc494ca11e Initial load
duke
parents:
diff changeset
   144
     * @return if external return converted link else return null
06bc494ca11e Initial load
duke
parents:
diff changeset
   145
     */
14358
9eda9239cba0 8000416: refactor javadoc to provide and use an abstraction for relative URIs
jjg
parents: 14357
diff changeset
   146
    public DocLink getExternalLink(String pkgName,
9eda9239cba0 8000416: refactor javadoc to provide and use an abstraction for relative URIs
jjg
parents: 14357
diff changeset
   147
                                  DocPath relativepath, String filename) {
9eda9239cba0 8000416: refactor javadoc to provide and use an abstraction for relative URIs
jjg
parents: 14357
diff changeset
   148
        return getExternalLink(pkgName, relativepath, filename, null);
9eda9239cba0 8000416: refactor javadoc to provide and use an abstraction for relative URIs
jjg
parents: 14357
diff changeset
   149
    }
9eda9239cba0 8000416: refactor javadoc to provide and use an abstraction for relative URIs
jjg
parents: 14357
diff changeset
   150
9eda9239cba0 8000416: refactor javadoc to provide and use an abstraction for relative URIs
jjg
parents: 14357
diff changeset
   151
    public DocLink getExternalLink(String pkgName,
9eda9239cba0 8000416: refactor javadoc to provide and use an abstraction for relative URIs
jjg
parents: 14357
diff changeset
   152
                                  DocPath relativepath, String filename, String memberName) {
10
06bc494ca11e Initial load
duke
parents:
diff changeset
   153
        Item fnd = findPackageItem(pkgName);
14358
9eda9239cba0 8000416: refactor javadoc to provide and use an abstraction for relative URIs
jjg
parents: 14357
diff changeset
   154
        if (fnd == null)
9eda9239cba0 8000416: refactor javadoc to provide and use an abstraction for relative URIs
jjg
parents: 14357
diff changeset
   155
            return null;
9eda9239cba0 8000416: refactor javadoc to provide and use an abstraction for relative URIs
jjg
parents: 14357
diff changeset
   156
9eda9239cba0 8000416: refactor javadoc to provide and use an abstraction for relative URIs
jjg
parents: 14357
diff changeset
   157
        DocPath p = fnd.relative ?
9eda9239cba0 8000416: refactor javadoc to provide and use an abstraction for relative URIs
jjg
parents: 14357
diff changeset
   158
                relativepath.resolve(fnd.path).resolve(filename) :
9eda9239cba0 8000416: refactor javadoc to provide and use an abstraction for relative URIs
jjg
parents: 14357
diff changeset
   159
                DocPath.create(fnd.path).resolve(filename);
9eda9239cba0 8000416: refactor javadoc to provide and use an abstraction for relative URIs
jjg
parents: 14357
diff changeset
   160
9eda9239cba0 8000416: refactor javadoc to provide and use an abstraction for relative URIs
jjg
parents: 14357
diff changeset
   161
        return new DocLink(p, "is-external=true", memberName);
10
06bc494ca11e Initial load
duke
parents:
diff changeset
   162
    }
06bc494ca11e Initial load
duke
parents:
diff changeset
   163
06bc494ca11e Initial load
duke
parents:
diff changeset
   164
    /**
06bc494ca11e Initial load
duke
parents:
diff changeset
   165
     * Build the extern package list from given URL or the directory path.
06bc494ca11e Initial load
duke
parents:
diff changeset
   166
     * Flag error if the "-link" or "-linkoffline" option is already used.
06bc494ca11e Initial load
duke
parents:
diff changeset
   167
     *
06bc494ca11e Initial load
duke
parents:
diff changeset
   168
     * @param url        URL or Directory path.
06bc494ca11e Initial load
duke
parents:
diff changeset
   169
     * @param pkglisturl This can be another URL for "package-list" or ordinary
06bc494ca11e Initial load
duke
parents:
diff changeset
   170
     *                   file.
06bc494ca11e Initial load
duke
parents:
diff changeset
   171
     * @param reporter   The <code>DocErrorReporter</code> used to report errors.
14361
2814fa6977ac 8001219: Clean up use of URLs in javadoc Extern class
jjg
parents: 14358
diff changeset
   172
     * @param linkoffline True if -linkoffline is used and false if -link is used.
10
06bc494ca11e Initial load
duke
parents:
diff changeset
   173
     */
14361
2814fa6977ac 8001219: Clean up use of URLs in javadoc Extern class
jjg
parents: 14358
diff changeset
   174
    public boolean link(String url, String pkglisturl,
10
06bc494ca11e Initial load
duke
parents:
diff changeset
   175
                              DocErrorReporter reporter, boolean linkoffline) {
06bc494ca11e Initial load
duke
parents:
diff changeset
   176
        this.linkoffline = linkoffline;
14361
2814fa6977ac 8001219: Clean up use of URLs in javadoc Extern class
jjg
parents: 14358
diff changeset
   177
        try {
2814fa6977ac 8001219: Clean up use of URLs in javadoc Extern class
jjg
parents: 14358
diff changeset
   178
            url = adjustEndFileSeparator(url);
2814fa6977ac 8001219: Clean up use of URLs in javadoc Extern class
jjg
parents: 14358
diff changeset
   179
            if (isUrl(pkglisturl)) {
2814fa6977ac 8001219: Clean up use of URLs in javadoc Extern class
jjg
parents: 14358
diff changeset
   180
                readPackageListFromURL(url, toURL(pkglisturl));
2814fa6977ac 8001219: Clean up use of URLs in javadoc Extern class
jjg
parents: 14358
diff changeset
   181
            } else {
14368
6f4c62de6985 8001664: refactor javadoc to use abstraction to handle files
jjg
parents: 14361
diff changeset
   182
                readPackageListFromFile(url, DocFile.createFileForInput(configuration, pkglisturl));
14361
2814fa6977ac 8001219: Clean up use of URLs in javadoc Extern class
jjg
parents: 14358
diff changeset
   183
            }
2814fa6977ac 8001219: Clean up use of URLs in javadoc Extern class
jjg
parents: 14358
diff changeset
   184
            return true;
2814fa6977ac 8001219: Clean up use of URLs in javadoc Extern class
jjg
parents: 14358
diff changeset
   185
        } catch (Fault f) {
2814fa6977ac 8001219: Clean up use of URLs in javadoc Extern class
jjg
parents: 14358
diff changeset
   186
            reporter.printWarning(f.getMessage());
10
06bc494ca11e Initial load
duke
parents:
diff changeset
   187
            return false;
14361
2814fa6977ac 8001219: Clean up use of URLs in javadoc Extern class
jjg
parents: 14358
diff changeset
   188
        }
2814fa6977ac 8001219: Clean up use of URLs in javadoc Extern class
jjg
parents: 14358
diff changeset
   189
    }
2814fa6977ac 8001219: Clean up use of URLs in javadoc Extern class
jjg
parents: 14358
diff changeset
   190
2814fa6977ac 8001219: Clean up use of URLs in javadoc Extern class
jjg
parents: 14358
diff changeset
   191
    private URL toURL(String url) throws Fault {
2814fa6977ac 8001219: Clean up use of URLs in javadoc Extern class
jjg
parents: 14358
diff changeset
   192
        try {
2814fa6977ac 8001219: Clean up use of URLs in javadoc Extern class
jjg
parents: 14358
diff changeset
   193
            return new URL(url);
2814fa6977ac 8001219: Clean up use of URLs in javadoc Extern class
jjg
parents: 14358
diff changeset
   194
        } catch (MalformedURLException e) {
2814fa6977ac 8001219: Clean up use of URLs in javadoc Extern class
jjg
parents: 14358
diff changeset
   195
            throw new Fault(configuration.getText("doclet.MalformedURL", url), e);
2814fa6977ac 8001219: Clean up use of URLs in javadoc Extern class
jjg
parents: 14358
diff changeset
   196
        }
2814fa6977ac 8001219: Clean up use of URLs in javadoc Extern class
jjg
parents: 14358
diff changeset
   197
    }
2814fa6977ac 8001219: Clean up use of URLs in javadoc Extern class
jjg
parents: 14358
diff changeset
   198
2814fa6977ac 8001219: Clean up use of URLs in javadoc Extern class
jjg
parents: 14358
diff changeset
   199
    private class Fault extends Exception {
2814fa6977ac 8001219: Clean up use of URLs in javadoc Extern class
jjg
parents: 14358
diff changeset
   200
        private static final long serialVersionUID = 0;
2814fa6977ac 8001219: Clean up use of URLs in javadoc Extern class
jjg
parents: 14358
diff changeset
   201
2814fa6977ac 8001219: Clean up use of URLs in javadoc Extern class
jjg
parents: 14358
diff changeset
   202
        Fault(String msg, Exception cause) {
2814fa6977ac 8001219: Clean up use of URLs in javadoc Extern class
jjg
parents: 14358
diff changeset
   203
            super(msg, cause);
10
06bc494ca11e Initial load
duke
parents:
diff changeset
   204
        }
06bc494ca11e Initial load
duke
parents:
diff changeset
   205
    }
06bc494ca11e Initial load
duke
parents:
diff changeset
   206
06bc494ca11e Initial load
duke
parents:
diff changeset
   207
    /**
06bc494ca11e Initial load
duke
parents:
diff changeset
   208
     * Get the Extern Item object associated with this package name.
06bc494ca11e Initial load
duke
parents:
diff changeset
   209
     *
14259
fb94a1df0d53 8000208: fix langtools javadoc comment issues
jjg
parents: 14258
diff changeset
   210
     * @param pkgName Package name.
10
06bc494ca11e Initial load
duke
parents:
diff changeset
   211
     */
06bc494ca11e Initial load
duke
parents:
diff changeset
   212
    private Item findPackageItem(String pkgName) {
06bc494ca11e Initial load
duke
parents:
diff changeset
   213
        if (packageToItemMap == null) {
06bc494ca11e Initial load
duke
parents:
diff changeset
   214
            return null;
06bc494ca11e Initial load
duke
parents:
diff changeset
   215
        }
868
d0f233085cbb 6657907: javadoc has unchecked warnings
jjg
parents: 10
diff changeset
   216
        return packageToItemMap.get(pkgName);
10
06bc494ca11e Initial load
duke
parents:
diff changeset
   217
    }
06bc494ca11e Initial load
duke
parents:
diff changeset
   218
06bc494ca11e Initial load
duke
parents:
diff changeset
   219
    /**
06bc494ca11e Initial load
duke
parents:
diff changeset
   220
     * If the URL or Directory path is missing end file separator, add that.
06bc494ca11e Initial load
duke
parents:
diff changeset
   221
     */
06bc494ca11e Initial load
duke
parents:
diff changeset
   222
    private String adjustEndFileSeparator(String url) {
14361
2814fa6977ac 8001219: Clean up use of URLs in javadoc Extern class
jjg
parents: 14358
diff changeset
   223
        return url.endsWith("/") ? url : url + '/';
10
06bc494ca11e Initial load
duke
parents:
diff changeset
   224
    }
06bc494ca11e Initial load
duke
parents:
diff changeset
   225
06bc494ca11e Initial load
duke
parents:
diff changeset
   226
    /**
06bc494ca11e Initial load
duke
parents:
diff changeset
   227
     * Fetch the URL and read the "package-list" file.
06bc494ca11e Initial load
duke
parents:
diff changeset
   228
     *
06bc494ca11e Initial load
duke
parents:
diff changeset
   229
     * @param urlpath        Path to the packages.
06bc494ca11e Initial load
duke
parents:
diff changeset
   230
     * @param pkglisturlpath URL or the path to the "package-list" file.
06bc494ca11e Initial load
duke
parents:
diff changeset
   231
     */
14361
2814fa6977ac 8001219: Clean up use of URLs in javadoc Extern class
jjg
parents: 14358
diff changeset
   232
    private void readPackageListFromURL(String urlpath, URL pkglisturlpath)
2814fa6977ac 8001219: Clean up use of URLs in javadoc Extern class
jjg
parents: 14358
diff changeset
   233
            throws Fault {
10
06bc494ca11e Initial load
duke
parents:
diff changeset
   234
        try {
14361
2814fa6977ac 8001219: Clean up use of URLs in javadoc Extern class
jjg
parents: 14358
diff changeset
   235
            URL link = pkglisturlpath.toURI().resolve(DocPaths.PACKAGE_LIST.getPath()).toURL();
2814fa6977ac 8001219: Clean up use of URLs in javadoc Extern class
jjg
parents: 14358
diff changeset
   236
            readPackageList(link.openStream(), urlpath, false);
22159
682da512ec17 8030253: Update langtools to use strings-in-switch
briangoetz
parents: 14545
diff changeset
   237
        } catch (URISyntaxException | MalformedURLException exc) {
14361
2814fa6977ac 8001219: Clean up use of URLs in javadoc Extern class
jjg
parents: 14358
diff changeset
   238
            throw new Fault(configuration.getText("doclet.MalformedURL", pkglisturlpath.toString()), exc);
22159
682da512ec17 8030253: Update langtools to use strings-in-switch
briangoetz
parents: 14545
diff changeset
   239
        }
682da512ec17 8030253: Update langtools to use strings-in-switch
briangoetz
parents: 14545
diff changeset
   240
        catch (IOException exc) {
14361
2814fa6977ac 8001219: Clean up use of URLs in javadoc Extern class
jjg
parents: 14358
diff changeset
   241
            throw new Fault(configuration.getText("doclet.URL_error", pkglisturlpath.toString()), exc);
10
06bc494ca11e Initial load
duke
parents:
diff changeset
   242
        }
06bc494ca11e Initial load
duke
parents:
diff changeset
   243
    }
06bc494ca11e Initial load
duke
parents:
diff changeset
   244
06bc494ca11e Initial load
duke
parents:
diff changeset
   245
    /**
06bc494ca11e Initial load
duke
parents:
diff changeset
   246
     * Read the "package-list" file which is available locally.
06bc494ca11e Initial load
duke
parents:
diff changeset
   247
     *
06bc494ca11e Initial load
duke
parents:
diff changeset
   248
     * @param path URL or directory path to the packages.
06bc494ca11e Initial load
duke
parents:
diff changeset
   249
     * @param pkgListPath Path to the local "package-list" file.
06bc494ca11e Initial load
duke
parents:
diff changeset
   250
     */
14368
6f4c62de6985 8001664: refactor javadoc to use abstraction to handle files
jjg
parents: 14361
diff changeset
   251
    private void readPackageListFromFile(String path, DocFile pkgListPath)
14361
2814fa6977ac 8001219: Clean up use of URLs in javadoc Extern class
jjg
parents: 14358
diff changeset
   252
            throws Fault {
14368
6f4c62de6985 8001664: refactor javadoc to use abstraction to handle files
jjg
parents: 14361
diff changeset
   253
        DocFile file = pkgListPath.resolve(DocPaths.PACKAGE_LIST);
14361
2814fa6977ac 8001219: Clean up use of URLs in javadoc Extern class
jjg
parents: 14358
diff changeset
   254
        if (! (file.isAbsolute() || linkoffline)){
14545
2e7bab0639b8 6493690: javadoc should have a javax.tools.Tool service provider installed in tools.jar
jjg
parents: 14368
diff changeset
   255
            file = file.resolveAgainst(DocumentationTool.Location.DOCUMENTATION_OUTPUT);
10
06bc494ca11e Initial load
duke
parents:
diff changeset
   256
        }
06bc494ca11e Initial load
duke
parents:
diff changeset
   257
        try {
06bc494ca11e Initial load
duke
parents:
diff changeset
   258
            if (file.exists() && file.canRead()) {
14368
6f4c62de6985 8001664: refactor javadoc to use abstraction to handle files
jjg
parents: 14361
diff changeset
   259
                boolean pathIsRelative =
6f4c62de6985 8001664: refactor javadoc to use abstraction to handle files
jjg
parents: 14361
diff changeset
   260
                        !DocFile.createFileForInput(configuration, path).isAbsolute()
6f4c62de6985 8001664: refactor javadoc to use abstraction to handle files
jjg
parents: 14361
diff changeset
   261
                        && !isUrl(path);
6f4c62de6985 8001664: refactor javadoc to use abstraction to handle files
jjg
parents: 14361
diff changeset
   262
                readPackageList(file.openInputStream(), path, pathIsRelative);
10
06bc494ca11e Initial load
duke
parents:
diff changeset
   263
            } else {
14361
2814fa6977ac 8001219: Clean up use of URLs in javadoc Extern class
jjg
parents: 14358
diff changeset
   264
                throw new Fault(configuration.getText("doclet.File_error", file.getPath()), null);
10
06bc494ca11e Initial load
duke
parents:
diff changeset
   265
            }
06bc494ca11e Initial load
duke
parents:
diff changeset
   266
        } catch (IOException exc) {
14361
2814fa6977ac 8001219: Clean up use of URLs in javadoc Extern class
jjg
parents: 14358
diff changeset
   267
           throw new Fault(configuration.getText("doclet.File_error", file.getPath()), exc);
10
06bc494ca11e Initial load
duke
parents:
diff changeset
   268
        }
06bc494ca11e Initial load
duke
parents:
diff changeset
   269
    }
06bc494ca11e Initial load
duke
parents:
diff changeset
   270
06bc494ca11e Initial load
duke
parents:
diff changeset
   271
    /**
06bc494ca11e Initial load
duke
parents:
diff changeset
   272
     * Read the file "package-list" and for each package name found, create
06bc494ca11e Initial load
duke
parents:
diff changeset
   273
     * Extern object and associate it with the package name in the map.
06bc494ca11e Initial load
duke
parents:
diff changeset
   274
     *
06bc494ca11e Initial load
duke
parents:
diff changeset
   275
     * @param input    InputStream from the "package-list" file.
06bc494ca11e Initial load
duke
parents:
diff changeset
   276
     * @param path     URL or the directory path to the packages.
06bc494ca11e Initial load
duke
parents:
diff changeset
   277
     * @param relative Is path relative?
06bc494ca11e Initial load
duke
parents:
diff changeset
   278
     */
06bc494ca11e Initial load
duke
parents:
diff changeset
   279
    private void readPackageList(InputStream input, String path,
06bc494ca11e Initial load
duke
parents:
diff changeset
   280
                                boolean relative)
06bc494ca11e Initial load
duke
parents:
diff changeset
   281
                         throws IOException {
06bc494ca11e Initial load
duke
parents:
diff changeset
   282
        BufferedReader in = new BufferedReader(new InputStreamReader(input));
14263
473b1eaede64 8000310: Clean up use of StringBuffer in langtools
jjg
parents: 14260
diff changeset
   283
        StringBuilder strbuf = new StringBuilder();
10
06bc494ca11e Initial load
duke
parents:
diff changeset
   284
        try {
06bc494ca11e Initial load
duke
parents:
diff changeset
   285
            int c;
06bc494ca11e Initial load
duke
parents:
diff changeset
   286
            while ((c = in.read()) >= 0) {
06bc494ca11e Initial load
duke
parents:
diff changeset
   287
                char ch = (char)c;
06bc494ca11e Initial load
duke
parents:
diff changeset
   288
                if (ch == '\n' || ch == '\r') {
06bc494ca11e Initial load
duke
parents:
diff changeset
   289
                    if (strbuf.length() > 0) {
06bc494ca11e Initial load
duke
parents:
diff changeset
   290
                        String packname = strbuf.toString();
06bc494ca11e Initial load
duke
parents:
diff changeset
   291
                        String packpath = path +
06bc494ca11e Initial load
duke
parents:
diff changeset
   292
                                      packname.replace('.', '/') + '/';
06bc494ca11e Initial load
duke
parents:
diff changeset
   293
                        new Item(packname, packpath, relative);
06bc494ca11e Initial load
duke
parents:
diff changeset
   294
                        strbuf.setLength(0);
06bc494ca11e Initial load
duke
parents:
diff changeset
   295
                    }
06bc494ca11e Initial load
duke
parents:
diff changeset
   296
                } else {
06bc494ca11e Initial load
duke
parents:
diff changeset
   297
                    strbuf.append(ch);
06bc494ca11e Initial load
duke
parents:
diff changeset
   298
                }
06bc494ca11e Initial load
duke
parents:
diff changeset
   299
            }
06bc494ca11e Initial load
duke
parents:
diff changeset
   300
        } finally {
06bc494ca11e Initial load
duke
parents:
diff changeset
   301
            input.close();
06bc494ca11e Initial load
duke
parents:
diff changeset
   302
        }
06bc494ca11e Initial load
duke
parents:
diff changeset
   303
    }
06bc494ca11e Initial load
duke
parents:
diff changeset
   304
06bc494ca11e Initial load
duke
parents:
diff changeset
   305
    public boolean isUrl (String urlCandidate) {
06bc494ca11e Initial load
duke
parents:
diff changeset
   306
        try {
06bc494ca11e Initial load
duke
parents:
diff changeset
   307
            new URL(urlCandidate);
06bc494ca11e Initial load
duke
parents:
diff changeset
   308
            //No exception was thrown, so this must really be a URL.
06bc494ca11e Initial load
duke
parents:
diff changeset
   309
            return true;
06bc494ca11e Initial load
duke
parents:
diff changeset
   310
        } catch (MalformedURLException e) {
06bc494ca11e Initial load
duke
parents:
diff changeset
   311
            //Since exception is thrown, this must be a directory path.
06bc494ca11e Initial load
duke
parents:
diff changeset
   312
            return false;
06bc494ca11e Initial load
duke
parents:
diff changeset
   313
        }
06bc494ca11e Initial load
duke
parents:
diff changeset
   314
    }
06bc494ca11e Initial load
duke
parents:
diff changeset
   315
}