API Overview API Index Package Overview Direct link to this page
JavaOnTracks 0.1.2
  net.jot.doclet. JOTDocletJava2HTML View Javadoc
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
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346

/*
 * To change this template, choose Tools | Templates
 * and open the template in the editor.
 */
package net.jot.doclet;

import com.sun.javadoc.ClassDoc;
import com.sun.javadoc.PackageDoc;
import com.sun.tools.doclets.formats.html.LinkInfoImpl;
import java.io.DataInputStream;
import java.io.File;
import java.io.FileInputStream;
import java.io.FileOutputStream;
import java.io.IOException;
import java.util.Hashtable;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import net.jot.logger.JOTLoggerLocation;
import net.jot.utils.JOTHTMLUtilities;
import net.jot.utils.JOTUtilities;
import net.jot.web.view.JOTViewParser;

/**
 * Converts java code file into an easier to read HTML version
 * @author thibautc
 */
public class JOTDocletJava2HTML {

    private File destFolder;
    private final JOTLoggerLocation loc = new JOTLoggerLocation(getClass());
    private final static Pattern PATTERN_PACK = Pattern.compile("^(\\s*package\\s+)(\\S+)\\s*;", Pattern.MULTILINE);
    private final static Pattern PATTERN_COMMENTS = Pattern.compile("/\\*[^*].*?\\*/", Pattern.MULTILINE | Pattern.DOTALL);
    private final static Pattern PATTERN_COMMENTS_1LINER = Pattern.compile("//.*");
    private final static Pattern PATTERN_IMPORTS = Pattern.compile("^(\\s*import\\s+)(\\S+)\\s*;", Pattern.MULTILINE);
    private final static Pattern PATTERN_JAVADOC = Pattern.compile("/\\*\\*.*?\\*/", Pattern.MULTILINE | Pattern.DOTALL);
    private final static Pattern PATTERN_PIECES = Pattern.compile("__JOT_PIECE_\\d+__");
    private final static Pattern PATTERN_STRING = Pattern.compile("".*?"");
    private final static Pattern PATTERN_ANNOTATIONS = Pattern.compile("^\\s*(@.*?)$", Pattern.MULTILINE);
    private final static Pattern PATTERN_NUMBER = Pattern.compile("(\\W)([\\-0-9]+[fFlL]?)");
    private final static Pattern PATTERN_FUNCTION = Pattern.compile("(\\S+)(\\s*\\([^)]*\\)\\s*(\\{|throws))", Pattern.MULTILINE | Pattern.DOTALL);
    private final static String[] KEYWORDS =
    {
        "abstract", "assert", "boolean", "break", "byte", "case",
        "catch", "char", "class", "const", "continue", "default", "do", "double", "else", "enum", "extends",
        "final", "finally", "float", "for", "goto", "if", "implements", "import", "instanceof", "int", "interface",
        "long", "native", "new", "package", "private", "protected", "public", "return", "short", "static", "strictfp",
        "super", "switch", "synchronized", "this", "throw", "throws", "transient", "try", "void", "volatile", "while",
        // not technically keywords ... but same idea
        "true", "false", "null"
    };
    private Hashtable pieces = new Hashtable();
    private JOTDoclet doclet;

    public JOTDocletJava2HTML(File destFolder, JOTDoclet doclet)
    {
        this.doclet=doclet;
        this.destFolder = destFolder;
    }

    public StringBuffer encodeFile(File javaFile)
    {
        StringBuffer buf=null;
        try
        {
            buf = readJavaFile(javaFile);
            buf=buf.insert(0, "\n");
            String itemName = javaFile.getName().substring(0, javaFile.getName().toLowerCase().lastIndexOf(".java"));
            buf = encodeHtml(buf);
            buf = doJavadoc(buf);
            buf = doComments(buf);
            buf = doSourceLinks(buf);
            buf = doStrings(buf);
            buf = doAnnotations(buf);
            buf = doNumbers(buf);
            buf = doFunctionNames(buf);
            for (int i = 0; i != KEYWORDS.length; i++)
            {
                buf = doKeyword(buf, KEYWORDS[i]);
            }
            buf=new StringBuffer(buf.toString().replaceFirst("\\s+("+itemName+")\\s+", " <b>$1</b> "));
            buf = reinsertPieces(buf);
            buf=buf.deleteCharAt(0);
            
        } catch (Exception e)
        {
            loc.exception("Failed encoding the java code file " + javaFile.getAbsolutePath(), e);
            e.printStackTrace();
        }
        return buf;
    }

    private File computeDestFile(String pack, String itemName)
    {
        String folder = JOTUtilities.endWithSlash(destFolder.getAbsolutePath());
        String[] packs = pack.split("\\.");
        for (int i = 0; i != packs.length; i++)
        {
            folder += packs[i] + File.separator;
        }
        return new File(folder, itemName + ".html");
    }

    private StringBuffer doAnnotations(StringBuffer buf)
    {
        StringBuffer newBuf = new StringBuffer();
        Matcher m = PATTERN_ANNOTATIONS.matcher(buf);
        while (m.find())
        {
            String key = insertPiece("<font color='#993300'>" + m.group(1) + "</font>");
            JOTViewParser.safeAppendReplacement(m, newBuf, key);
        }
        m.appendTail(newBuf);
        return newBuf;
    }

    private StringBuffer doComments(StringBuffer buf)
    {
        StringBuffer newBuf = new StringBuffer();
        Matcher m = PATTERN_COMMENTS.matcher(buf);
        while (m.find())
        {
            String key = insertPiece("<font color='#666666'>" + m.group() + "</font>");
            JOTViewParser.safeAppendReplacement(m, newBuf, key);
        }
        m.appendTail(newBuf);
        StringBuffer newBuf2 = new StringBuffer();
        m = PATTERN_COMMENTS_1LINER.matcher(newBuf);
        while (m.find())
        {
            String key = insertPiece("<font color='#666666'>" + m.group() + "</font>");
            JOTViewParser.safeAppendReplacement(m, newBuf2, key);
        }
        m.appendTail(newBuf2);
        return newBuf2;
    }

    private StringBuffer doFunctionNames(StringBuffer buf)
    {
        StringBuffer newBuf = new StringBuffer();
        Matcher m = PATTERN_FUNCTION.matcher(buf);
        while (m.find())
        {
            String name = m.group(1);
            boolean skip = false;
            for (int i = 0; i != KEYWORDS.length && !skip; i++)
            {
                if (KEYWORDS[i].equals(name))
                {
                    skip = true;
                }
            }
            if (skip == false)
            {
                String key = insertPiece("<b>" + name + "</b>" + m.group(2));
                JOTViewParser.safeAppendReplacement(m, newBuf, key);
            }
        }
        m.appendTail(newBuf);
        return newBuf;
    }

    private StringBuffer doJavadoc(StringBuffer buf)
    {
        StringBuffer newBuf = new StringBuffer();
        Matcher m = PATTERN_JAVADOC.matcher(buf);
        while (m.find())
        {
            String text = m.group();
            text = text.replaceAll("(@\\S+)", "<b>$1</b>");
            String key = insertPiece("<font color='#4444FF'>" + text + "</font>");
            JOTViewParser.safeAppendReplacement(m, newBuf, key);
        }
        m.appendTail(newBuf);
        return newBuf;
    }

    private StringBuffer doKeyword(StringBuffer buf, String keyword)
    {
        StringBuffer newBuf = new StringBuffer();
        Pattern p = Pattern.compile("(\\W+)(" + keyword + ")(\\W+)");
        Matcher m = p.matcher(buf);
        while (m.find())
        {
            JOTViewParser.safeAppendReplacement(m, newBuf, m.group(1) + "<font color='#880088'><b>" + m.group(2) + "</b></font>" + m.group(3));
        }
        m.appendTail(newBuf);
        return newBuf;
    }

    private StringBuffer doSourceLinks(StringBuffer buf) {
        Matcher m = PATTERN_PACK.matcher(buf);
        StringBuffer newBuf = new StringBuffer();
        while (m.find())
        {
            String key = insertPiece("<font color='#880088'><b>"+m.group(1)+"</b></font><a class='srclink' href='package-summary.html'>" + m.group(2) + "</a>;");
            JOTViewParser.safeAppendReplacement(m, newBuf, key);
        }
        m.appendTail(newBuf);
        m = PATTERN_IMPORTS.matcher(newBuf);
        StringBuffer newBuf2=new StringBuffer();
        while (m.find())
        {
            String imp=m.group(2);
            //System.out.println(imp);
            String link=null;
            String item="";
            //LinkFactoryImpl impl=new LinkFactoryImpl(doc);
            //impl.getLinkOutput(arg0);
            if(imp.endsWith(".*"))
            {
                item=imp.substring(0,imp.length()-2);
                PackageDoc pack=doclet.rootDoc.packageNamed(item);
                if(pack!=null)
                    link=getHref(doclet.docWriter.getPackageLink(pack,null,false,"sourcelink"));
                else
                    link=getHref(doclet.docWriter.getCrossPackageLink(item));
            }
            else
            {
                item=imp;
                //System.out.println(item);
                ClassDoc doc=doclet.rootDoc.classNamed(item);
                //System.out.println(doc.qualifiedName());
                if(doc!=null)
                {
                    LinkInfoImpl impl=new LinkInfoImpl(LinkInfoImpl.CONTEXT_CLASS, doc, null,null,false,"sourcelink");
                    link=getHref(doclet.docWriter.getLink(impl));
                }
                else
                    link=getHref(doclet.docWriter.getCrossClassLink(item, null, null, false, "sourcelink", false));
            }

            String key = insertPiece("<font color='#880088'><b>"+m.group(1)+"</b></font>"+(link==null?m.group(2):"<a class='srclink' href='"+link+"'>"+m.group(2)+"</a>")+";");
            JOTViewParser.safeAppendReplacement(m, newBuf2, key);
        }
        m.appendTail(newBuf2);
        return newBuf2;
    }
    private String getHref(String link) {
        if (link == null) {
            return null;
        }
        int i = link.indexOf("HREF=\"") + 6;
        if (i >= 6) {
            return link.substring(i, link.indexOf("\"", i));
        } else {
            return null;
        }
    }

    private StringBuffer doNumbers(StringBuffer buf)
    {
        StringBuffer newBuf = new StringBuffer();
        Matcher m = PATTERN_NUMBER.matcher(buf);
        while (m.find())
        {
            String key = insertPiece(m.group(1) + "<font color='#CC0000'>" + m.group(2) + "</font>");
            JOTViewParser.safeAppendReplacement(m, newBuf, key);
        }
        m.appendTail(newBuf);
        return newBuf;
    }

    private StringBuffer doStrings(StringBuffer buf)
    {
        StringBuffer newBuf = new StringBuffer();
        Matcher m = PATTERN_STRING.matcher(buf);
        while (m.find())
        {
            String key = insertPiece("<font color='#008800'>" + m.group() + "</font>");
            JOTViewParser.safeAppendReplacement(m, newBuf, key);
        }
        m.appendTail(newBuf);
        return newBuf;
    }

    private StringBuffer encodeHtml(StringBuffer buf)
    {
        String newText = JOTHTMLUtilities.textToHtml(buf.toString(), JOTHTMLUtilities.ENCODE_HTML_CHARS);
        return new StringBuffer(newText);
    }

    private String findPackage(StringBuffer buf) throws Exception
    {
        Matcher m = PATTERN_PACK.matcher(buf);
        if (m.find())
        {
            String pack = m.group(1);
            if (pack.endsWith(";"))
            {
                pack = pack.substring(0, pack.length() - 1);
            }
            return pack;
        } else
        {
            throw (new Exception("Package definition not found !"));
        }
    }

    private String insertPiece(String newText)
    {
        String key = "__JOT_PIECE_" + pieces.size() + "__";
        pieces.put(key, newText);
        return key;
    }

    private StringBuffer readJavaFile(File javaFile) throws IOException
    {
        int length = (int) javaFile.length();
        byte[] buffer = new byte[length];
        DataInputStream dis = new DataInputStream(new FileInputStream(javaFile));
        dis.readFully(buffer);
        dis.close();
        StringBuffer str = new StringBuffer(new String(buffer));
        return str;
    }

    private StringBuffer reinsertPieces(StringBuffer buf)
    {
        StringBuffer newBuf = new StringBuffer();
        Matcher m = PATTERN_PIECES.matcher(buf);
        while (m.find())
        {
            String value = (String) pieces.get(m.group());
            JOTViewParser.safeAppendReplacement(m, newBuf, value);
        }
        m.appendTail(newBuf);
        return newBuf;
    }

    private void writeHTMLFile(File destFile, StringBuffer buf) throws IOException
    {
        destFile.getParentFile().mkdirs();
        FileOutputStream fos = new FileOutputStream(destFile);
        buf.insert(0, "<html><body><pre>");
        buf.append("</pre></body></html>");
        fos.write(buf.toString().getBytes());
        fos.close();
    }

    public static void main(String[] args)
    {
        JOTDocletJava2HTML encoder = new JOTDocletJava2HTML(new File("/tmp"),null);
        encoder.encodeFile(new File("/tmp/JOTDoclet.java"));
    }
}

Generated By: JavaOnTracks Doclet 0.1.5     ©Thibaut Colar