Title: JBuilder OpenTool for PMD
+ *Description: Provides an environemnACTION_PMDCheckt for using the PMD aplication from within JBuilder
+ *Copyright: Copyright (c) 2002
+ *Company: InfoEther
+ * @author David Craine + * @version 1.0 + */ + +public class PMDOpenTool { + static MessageCategory msgCat = new MessageCategory("PMD Results"); + + + + public PMDOpenTool() { + int i; + int a; + } + + public static void initOpenTool(byte majorVersion, byte minorVersion) { + if (majorVersion == PrimeTime.CURRENT_MAJOR_VERSION) { + JBuilderMenu.GROUP_Tools.add(ACTION_PMDCheck); + registerWithContentManager(); + } + } + + /** + * Registers an "PMD Checker" action with the ContentManager (Tabs) + * The action will not be visible if multiple nodes are selected + */ + private static void registerWithContentManager() + { + ContextActionProvider cap = new ContextActionProvider() + { + public Action getContextAction(Browser browser, Node[] nodes) + { + return ACTION_PMDCheck; + } + }; + + ContentManager.registerContextActionProvider(cap); + } + + public static Report instanceCheck(String text) { + + PMD pmd = new PMD(); + + ReportFactory rf = new ReportFactory(); + RuleContext ctx = new RuleContext(); + RuleSetFactory ruleSetFactory = new RuleSetFactory(); + RuleSet rules = ruleSetFactory.createRuleSet(pmd.getClass().getClassLoader().getResourceAsStream("rulesets/unusedcode.xml")); + + ctx.setReport(rf.createReport("xml")); + ctx.setSourceCodeFilename("this"); + try { + // TODO switch to use StringReader once PMD 0.4 gets released + pmd.processFile(new StringBufferInputStream(text), rules, ctx); + return ctx.getReport(); + + } catch (FileNotFoundException fnfe) { + fnfe.printStackTrace(); + } + return null; + + } + + public static /*final*/ BrowserAction ACTION_PMDCheck = + + // A new action with short menu string, mnemonic, and long menu string + new BrowserAction("PMD Checker", 'P', "Displays PMD statistics about a Java File") { + + // The function called when the menu is selected + public void actionPerformed(Browser browser) { + Node node = Browser.getActiveBrowser().getActiveNode(); + if (node instanceof JavaFileNode) { + TextNodeViewer viewer = (TextNodeViewer)Browser.getActiveBrowser().getViewerOfType(node, TextNodeViewer.class); + if (viewer != null) { + Document doc = viewer.getEditor().getDocument(); + try { + Report rpt = instanceCheck(doc.getText(0, doc.getLength())); + Browser.getActiveBrowser().getMessageView().clearMessages(msgCat);//clear the message window + if (rpt == null) { + Browser.getActiveBrowser().getMessageView().addMessage(msgCat, "Error Processing File"); + } + else if (rpt.size() == 0) { + Browser.getActiveBrowser().getMessageView().addMessage(msgCat, "No violations detexted."); + } + else { + for (Iterator i = rpt.iterator(); i.hasNext(); ) { + RuleViolation rv = (RuleViolation)i.next(); + PMDMessage pmdMsg = new PMDMessage(rv.getDescription() + " at line " + rv.getLine(), rv.getLine(), (JavaFileNode)node); + Browser.getActiveBrowser().getMessageView().addMessage(msgCat, pmdMsg);//add the result message + } + } + } + catch (Exception e) { + e.printStackTrace(); + } + + } + } + + } + }; + /** + * Main method for testing purposes + * @param args standard arguments + */ + public static void main(String[] args) { + Report ret = PMDOpenTool.instanceCheck("package abc; \npublic class foo {\npublic void bar() {int i;}\n}"); + System.out.println("PMD: " + ret); + } + +} +class PMDMessage extends Message { + + final LineMark MARK = new HighlightMark(); + JavaFileNode javaNode; + int line=0; + int column=0; + + public PMDMessage(String msg, int line, JavaFileNode node) { + super(msg); + this.line = line; + this.javaNode = node; + + } + public void selectAction(Browser browser) { + displayResult(browser, false); + } + + public void messageAction(Browser browser) { + displayResult(browser, true); + } + + private void displayResult(Browser browser, boolean requestFocus) { + try { + if (requestFocus || browser.isOpenNode(javaNode)) { + browser.setActiveNode(javaNode, requestFocus); + TextNodeViewer viewer = (TextNodeViewer)browser.getViewerOfType(javaNode, TextNodeViewer.class); + browser.setActiveViewer(javaNode, viewer, requestFocus); + EditorPane editor = viewer.getEditor(); + editor.gotoPosition(line, column, false, EditorPane.CENTER_IF_NEAR_EDGE); + if (requestFocus) + editor.requestFocus(); + else + editor.setTemporaryMark(line, MARK); + } + } + catch (Exception ex) { + ex.printStackTrace(); + } + } +} + +class HighlightMark extends LineMark { + static Style highlightStyle; + static { + StyleContext context = EditorManager.getStyleContext(); + highlightStyle = context.addStyle("line_highlight", null); + highlightStyle.addAttribute(MasterStyleContext.DISPLAY_NAME, "Line highlight"); + StyleConstants.setBackground(highlightStyle, Color.yellow); + StyleConstants.setForeground(highlightStyle, Color.black); + } + + public HighlightMark() { + super(highlightStyle); + } +}