Java Source Code Presenter

• You are here :
• home
• Java Glossary
• Student Projects
• Java Source Code Presenter
•  

©1996-2012 Roedy Green, Canadian Mind Products

Please do not email me about this project without reading the disclaimer above.

This converts Java source into HTML (Hypertext Markup Language) for public presentation, much like Jonathan Revusky’s JavaToHTML. It would colour various syntatic elements. It would use bold on a variable in the place it is defined. It would use variable sized () and {} depending on how deeply nested they are. You can see some examples of the sort of output I’m after by looking at the sample. It might use special markings to delimit methods and classes. Here is the output of a crude version I use now that generated HTML with style tags, that than the be use to control the fonts, colours, sizes etc of each component of the listing. I have chosen a rather conservative colour scheme with only subtle variations.

If, JDisplay, the above Source code display Java Applet does not work…

1. Often problems can be fixed simply by clicking the reload button on your browser.
2. Make sure you have both JavaScript and Java enabled in your browser.
3. This Java Applet needs 32-bit (not 64-bit) Java 1.1 or later. For best results use the latest 1.7.0_04. If you have both 32 and 64-bit JVMs installed, in the Java Control Panel, configure your 32-bit java.exe as the user JVM and your 64-bit java.exe as the system JVM. You also need a recent browser.
4. It works under any operating system that supports Java e.g. W2K/XP/W2003/Vista/W7-32/W7-64/Linux/Ubuntu/Solaris/OSX
5. You should see the Applet above looking much like this screenshot. If you don’t, the following hints should help you get it working:
6. Especially if this Applet has worked before, try clearing the browser cache and rebooting.
7. To ensure your Java is up to date, check with Wassup. First, download it and run it as an application independent of your browser, then run it online as an Applet to add the complication of your browser.
8. If the above Applet does not work, check the Java console for error messages.
9. If the above Applet does not work, you might have better luck with the downloadable version available below.
10. If you are using Microsoft Internet Explorer 7, 8 or 9, try another browser. Seriously. Microsoft has taken great pains, over and over, to screw up Java and every other multi-platform standardisation.
11. If you are using Microsoft Internet Explorer 7, 8 or 9, you must click to allow blocked content permission for Active X to run. This also gives permission to Java to run. Click the Information bar, and then click Allow blocked content. Unfortunately, this also allows dangerous ActiveX code to run. However, you must do this in order to get access to perfectly-safe Java Applets running in a sandbox. This is part of Microsoft’s war on Java. Don’t put up with it! Use a different browser.
12. If you are using Microsoft Internet Explorer 9, makes sure the Java Plug-In SSV helper add-in is installed and enabled. If it is not, try reinstalling the Java JRE.
13. If you have Windows 7 64-bit and Internet Explorer 64-bit, in theory you can use 64-bit Java, but I never been able to get it to work.
14. Try upgrading to a more recent version of your browser, or try a different browser e.g. Firefox, SeaMonkey, Safari or Avant.
15. If you still can’t get the program working click HELP for more detail.
16. If you can’t get the above Applet working after trying the advice above and from the HELP button below, have bugs to report or ideas to improve the program or its documentation, please send me an email at.

   Get New Java  Get New Browser  

It would render the HTML inside the Javadoc comments (e.g <b>length</b> must be &lt; 100) in human form (e.g. length must be < 100) rather than displaying it literally as it appeared in the orginal source.

For importing ordinary Java source code, a parser such as JavaCC or ANTLR (Another Tool for Language Recognition) might be useful.

The tricky part is figuring out how to do decent variable left indenting in HTML. I know of five techniques:

1. Use a dummy gif and stretch its width. This is slow, verbose, and does not look all that good in all browsers. Remember to use border="0" to avoid a line around the dummy gif.The advantage is you can also control vertical spacing by stretching the gif height.
2. Use <ul> to indent and </ul> to unindent. This has the unwanted side effect of extra blank lines. This is technically invalid, and will set HTMLValidator screaming, However, it works in all the browsers I have tried. I get rude public postings about my use of it from purists though.
3. Use <td colspan="n"></td> <td colspan="max-n">real stuff</td>. You can’t control the indentation column widths with <TABLE CELLSPACING="30", because it affects vertical spacing as well. You hide the tableness of the whole thing by using <TABLE BORDER="0". This technique has the added advantage of properly indenting wrapped long lines that don’t quite fit on the screen in some browsers. See the HTML used to create the waterfall entry.
4. Use the margin control in CSS (Cascading Style Sheets), e.g. with a <div class="group"> and a style div.group { margin-left : 10px;}
5. Use <pre>. The advantage of this is you don’t interfere at all with the original indenting or line breaks. You just do what the programmer did originally. You can’t screw it up or do it a different way from the way he likes. The problem with <pre> stuff is that the tiniest jostle and it is turned to mush, with all the lines wrapped.

You might run this as a batch utility to prepare HTML. You might also create it as an Applet that provides a scrolling display. You pass the name of a *.java file in the Applet tag or provide the source code text snippet inline. The end user can click a button to download the raw *.java file.

The problem with generating HTML and embedding it in your HTML pages is you can’t edit it. It just looks like gibberish. Further, if I change my mind on how the rendering should be done, I have to manually regenerate all the HTML from the orgininal Java (perhaps now lost) and replace the HTML. I think it would be better to post the plain Java files, and then have an Applet render them on the fly. Then people could download the pristine source without any HTML contamination effects, such an unwanted line breaks.

The other problem with generating HTML is html beautifiers break lines introducing improper white space into the program. Another problem is with <DIV> tags you can’t exactly match the indentation of the original. You must deduce the nesting depth. This gets complicated. You could do it by generating HTML with <PRE> tags or with an Applet that drew on a Canvas. To make cut and paste work, is very tricky since it would be just a bit image you are displaying. If you generated HTML and displayed it internally with Swing, at least cut and paste would come out in the wash so people could take copies of snippets of the program without fuss. The advantage of an Applet is it need not render the entire listing. The disadvantage is the browser search and search engines would not see the rendered text.

The HTML you generate can be done with <font or with <span class="operator"> type tags. The second form lets you tune the rendering just by changing the style sheet. The first type will work in Swing components, whereas the second will not.

So most likely you will want to render from plain *.java files on the fly in the Applet and give the user the option to download the plain *.java file. Render using Swing components and old-fashioned <pre> and <font tags.

JDisplay Implementation

Upsides

• I can display code snippets, code with syntax errors, and code in languages similar to Java.
• I can post large listings that scroll. I don’t need a window big enough for the whole program.
• I recreate the indenting and white space exactly as on the original.
• The Applet itself is very small, and loads quickly because it does not do any parsing.
• Rendering is extremely fast, much faster than HTML rendering.
• Parsing is extremely fast.
• You can copy/paste from the display.
• Note the variable size {} () and []. Note the bolded return to make them stand out. Note how variable, class and method definitions are bolded to make them stand out. Note the colour and font differences between classes, interfaces, variable, methods, comments etc.

Downsides

• It requires Java to work, and requires loading a small Applet for each code snippet. Applets can’t simply read the files they need. They must be bundled in resources.
• HTML in the Javadoc is rendered as-is, not interpreted.
• To change the colour scheme, you have to change the Applet code. You can’t change it just by changing a CSS style sheet.
• Snippets have to be preprocessed before use to parse them into arrays of serialised objects.
• If the user prints the entire page, the Applet windows just show up as gray squares.

How It Works

Then I write out each snippet as a serialized array of objects, each of which knows how to render itself.

The Applet then just reads the array of objects and uses drawString to render each token in the appropriate colour, font, style and size.

The problem is you can’t copy/paste from my colourful bitmap, so when you click the display turns into a black and white TextField rendering that you can copy from.

I use the Graphics.getClipBounds to only bother rendering parts of the Java source program that are scrolled on-screen.

// Graphics g is passed to your paint as a parameter.
// get x, y, width and height of region we are actually painting
Rectangle r = g.getClipBounds();

I use a macro to generate the Applet tags, and a download button for those who do not have Java to see the snippet as raw text.

Torture Test

Summary

If you go the dynamic generation Applet route, you can’t use style sheets, your program must be 100% bug free, and your end users must have recent working Java Plug-Ins with Swing. In turn you have very little work to do to prepare each new program for display. Your editors won’t be able to see, much less mess with your generated HTML. For very long programs this may be faster, since you don’t have to download all the style tags.

What are the colour-size-font-bold-coding classes? keywords, operators, packages, classes, methods, variables, class definitions (the class name in the place where the class is defined, e.g. right after public class), method definitions. variable definitions, constants, literals, string literals, assignment (=), dot (.), parentheses () with size and colour coding for nest depth, brackets [] with size and colour coding for nest depth, braces {} with size and colour coding for nest depth, operators (+ - ++ == !=… perhaps in shades to indicate 14 levels of priority lightest computed first, darkest and biggest last). I also encode a name where it is defined in bold and plain where it is referenced.

There is a such a program part of the SwingSet2 demo that comes in the demos directory of the JDK (Java Development Kit), under Progress Bar, though I have not yet figured out what classes it uses or how to work it. It tends to create displays in type too small. For inspiration:

	You can get the freshest copy of this page from:	or possibly from your local J: drive (Java virtual drive/mindprod.com website mirror)
	http://mindprod.com/project/javapresenter.html	J:\mindprod\project\javapresenter.html
	Please email your feedback for publication, letters to the editor, errors, omissions, typos, formatting errors, ambiguities, unclear wording, broken/redirected link reports, suggestions to improve this page or comments to Roedy Green : . If you want your message, your name or email kept confidential, not considered for public posting, please explicitly specify that. Unless you state otherwise, I will treat your message as a letter to the editor that I may or may not publish in the feedback section. After that, it will be too late to retract it. If you disagree with something I said, please quote it and cite the web page where you found it, tell me why you think it is wrong, and, if possible, provide some supporting evidence. Threatening to kill me or spouting obscenities has yet to persuade me to change my mind.
	Canadian Mind Products
	mindprod.com IP:[65.110.21.43]
view Blog	Your face IP:[38.107.179.211]
Feedback	You are visitor number 25,446.