////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2002 Oliver Burn
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
//
// This library 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
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
////////////////////////////////////////////////////////////////////////////////
package com.puppycrawl.tools.checkstyle.gui;
import java.awt.BorderLayout;
import java.awt.Component;
import java.awt.GridLayout;
import java.awt.event.ActionEvent;
import java.awt.event.KeyEvent;
import java.io.File;
import java.io.IOException;
import java.util.TooManyListenersException;
import javax.swing.AbstractAction;
import javax.swing.Action;
import javax.swing.JButton;
import javax.swing.JFileChooser;
import javax.swing.JOptionPane;
import javax.swing.JPanel;
import javax.swing.JScrollPane;
import javax.swing.SwingUtilities;
import javax.swing.filechooser.FileFilter;
import antlr.ANTLRException;
import com.puppycrawl.tools.checkstyle.TreeWalker;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
import com.puppycrawl.tools.checkstyle.api.FileContents;
import com.puppycrawl.tools.checkstyle.api.Utils;
/**
* Displays information about a parse tree.
* The user can change the file that is parsed and displayed
* through a JFileChooser.
*
* @author Lars K�hne
*/
public class ParseTreeInfoPanel extends JPanel
{
private JTreeTable mTreeTable;
private ParseTreeModel mParseTreeModel;
private File mLastDirectory = null;
private File mCurrentFile = null;
private final Action reloadAction;
private static class JavaFileFilter extends FileFilter
{
public boolean accept(File f)
{
if (f == null) {
return false;
}
return f.isDirectory() || f.getName().endsWith(".java");
}
public String getDescription()
{
return "Java Source Code";
}
}
private class FileSelectionAction extends AbstractAction
{
public FileSelectionAction()
{
super("Select Java File");
putValue(Action.MNEMONIC_KEY, new Integer(KeyEvent.VK_S));
}
public void actionPerformed(ActionEvent e)
{
JFileChooser fc = new JFileChooser( mLastDirectory );
FileFilter filter = new JavaFileFilter();
fc.setFileFilter(filter);
final Component parent =
SwingUtilities.getRoot(ParseTreeInfoPanel.this);
fc.showDialog(parent, "Open");
File file = fc.getSelectedFile();
openFile(file, parent);
}
}
private class ReloadAction extends AbstractAction
{
public ReloadAction()
{
super("Reload Java File");
putValue(Action.MNEMONIC_KEY, new Integer(KeyEvent.VK_R));
}
public void actionPerformed(ActionEvent e)
{
final Component parent =
SwingUtilities.getRoot(ParseTreeInfoPanel.this);
openFile(mCurrentFile, parent);
}
}
private class FileDropListener implements FileDrop.Listener
{
private final JScrollPane mSp;
public void filesDropped(File[] files)
{
if (files != null && files.length > 0)
{
File file = files[0];
openFile(file, mSp);
}
}
public FileDropListener(JScrollPane aSp)
{
mSp = aSp;
}
}
public void openFile(File aFile, final Component aParent)
{
if (aFile != null) {
try {
DetailAST parseTree = parseFile(aFile.getAbsolutePath());
mParseTreeModel.setParseTree(parseTree);
mCurrentFile = aFile;
mLastDirectory = aFile.getParentFile();
reloadAction.setEnabled(true);
}
catch (IOException ex) {
showErrorDialog(
aParent,
"Could not open " + aFile + ": " + ex.getMessage());
}
catch (ANTLRException ex) {
showErrorDialog(
aParent,
"Could not parse " + aFile + ": " + ex.getMessage());
}
}
}
/**
* Parses a file and returns the parse tree.
* @param aFileName the file to parse
* @return the root node of the parse tree
* @throws IOException if the file cannot be opened
* @throws ANTLRException if the file is not a Java source
*/
public static DetailAST parseFile(String aFileName)
throws IOException, ANTLRException
{
final String[] lines = Utils.getLines(aFileName);
final FileContents contents = new FileContents(aFileName, lines);
return TreeWalker.parse(contents);
}
/**
* Create a new ParseTreeInfoPanel instance.
*/
public ParseTreeInfoPanel()
{
setLayout(new BorderLayout());
DetailAST treeRoot = null;
mParseTreeModel = new ParseTreeModel(treeRoot);
mTreeTable = new JTreeTable(mParseTreeModel);
final JScrollPane sp = new JScrollPane(mTreeTable);
this.add(sp, BorderLayout.CENTER);
final JPanel p = new JPanel(new GridLayout(1,2));
this.add(p, BorderLayout.SOUTH);
final JButton fileSelectionButton =
new JButton(new FileSelectionAction());
reloadAction = new ReloadAction();
reloadAction.setEnabled(false);
final JButton reloadButton = new JButton(reloadAction);
p.add(fileSelectionButton);
p.add(reloadButton);
try {
// TODO: creating an object for the side effect of the constructor
// and then ignoring the object looks strange.
new FileDrop(sp, new FileDropListener(sp));
}
catch (TooManyListenersException ex)
{
showErrorDialog(null, "Cannot initialize Drag and Drop support");
}
}
private void showErrorDialog(final Component parent, final String msg)
{
Runnable showError = new Runnable()
{
public void run()
{
JOptionPane.showMessageDialog(parent, msg);
}
};
SwingUtilities.invokeLater(showError);
}
}