summaryrefslogtreecommitdiff
path: root/tools/gnu/classpath/tools/doclets/htmldoclet/ExternalDocSet.java
blob: 7fd2fa0624df42c5e3c7bc09fa0407b859ef45fc (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
/* gnu.classpath.tools.doclets.htmldoclet.ExternalDocSet
   Copyright (C) 2004 Free Software Foundation, Inc.

This file is part of GNU Classpath.

GNU Classpath is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2, or (at your option)
any later version.
 
GNU Classpath is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
General Public License for more details.

You should have received a copy of the GNU General Public License
along with GNU Classpath; see the file COPYING.  If not, write to the
Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
02111-1307 USA. */

package gnu.classpath.tools.doclets.htmldoclet;

import java.io.BufferedReader;
import java.io.File;
import java.io.FileNotFoundException;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;

import java.net.MalformedURLException;
import java.net.URL;

import java.util.HashSet;
import java.util.Properties;
import java.util.Set;

import com.sun.javadoc.ClassDoc;

public class ExternalDocSet
{
   private String url;
   private String packageListDir;
   private URL docSetDirectoryURL;

   public String getPackageListDir()
   {
      return packageListDir;
   }

   public ExternalDocSet(String url,
                         String packageListDir)
   {
      this.url = url;
      this.packageListDir = packageListDir;
   }

   private Set packageNames = new HashSet();
   private boolean javadocCompatible;

   public void load(File targetDirectory)
      throws IOException, MalformedURLException
   {
      if (!url.endsWith("/")) {
         url += "/";
      }

      this.docSetDirectoryURL = new URL(targetDirectory.toURL(),
                                        url);

      URL packageListDirURL;
      if (null != packageListDir) {
         if (!packageListDir.endsWith("/")) {
           packageListDir += "/";
         }
         packageListDirURL = new URL(new File(System.getProperty("user.dir")).toURL(),
                                     packageListDir);
      }
      else {
         packageListDirURL = docSetDirectoryURL;
      }

      URL packageListURL = new URL(packageListDirURL,
                                    "package-list");
      InputStream in = packageListURL.openStream();
      if (null != in) {
         readPackages(in);
         in.close();
      }
      else {
         throw new FileNotFoundException(packageListURL.toString());
      }

      URL gjdocPropertiesURL = new URL(packageListDirURL,
                                       "gjdoc.properties");
      try {
          InputStream propertiesIn = gjdocPropertiesURL.openStream();
          if (null != in) {
              Properties properties = new Properties();
              properties.load(propertiesIn);
              propertiesIn.close();
         
              String gjdocCompatProperty = properties.getProperty("gjdoc.compat");
              if (null != gjdocCompatProperty) {
                  javadocCompatible = "true".equals(properties.getProperty("gjdoc.compat"));
              }
              else {
                  javadocCompatible = true;
              }
          }
          else {
              javadocCompatible = true;
          }
      } 
      catch (FileNotFoundException e) {
          javadocCompatible = true;
      }
   }

   public String getPackageDocURL(String packageName)
   {
      try {
         URL packageURL = new URL(docSetDirectoryURL,
                                  packageName.replace('.', '/'));
         return packageURL.toString();
      }
      catch (MalformedURLException e) {
         // This should not happen since we know that packageName is a
         // proper Java identifiers, so the resulting URL can't be
         // invalid
         throw new RuntimeException(e);
      }
   }

   public String getClassDocURL(String packageName, String typeName)
   {
      try {
         URL fileURL = new URL(docSetDirectoryURL,
                               packageName.replace('.', '/') + "/" + typeName + ".html");
         return fileURL.toString();
      }
      catch (MalformedURLException e) {
         // This should not happen since we know that packageName and
         // typeName are proper Java identifiers, so the resulting URL
         // can't be invalid
         throw new RuntimeException(e);
      }
   }

   protected void readPackages(InputStream in)
      throws IOException
   {
      BufferedReader reader
         = new BufferedReader(new InputStreamReader(in, "UTF-8"));
      String line;
      while ((line = reader.readLine()) != null) {
         line = line.trim();
         packageNames.add(line);
      }
   }

   public Set getPackageNames()
   {
      return packageNames;
   }

   public boolean isJavadocCompatible()
   {
      return javadocCompatible;
   }
}