CompilationMacros.java - This Java code is part of a LaTeX …

/plugins/LaTeXTools/trunk/uk/co/antroy/latextools/macros/CompilationMacros.java

# · Java · 415 lines · 284 code · 102 blank · 29 comment · 34 complexity · 4597b20bbb58425b4429653aa96fa202 MD5 · raw file


/*:folding=indent:
* CompilationMacros.java - Macros to interact with the console.
* Copyright (C) 2003 Anthony Roy
*
* This program 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
* of the License, or any later version.
*
* This program 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 this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
*/
package uk.co.antroy.latextools.macros;

import console.Console;
import console.Shell;

import gnu.regexp.RE;
import gnu.regexp.REException;

import java.awt.Component;
import java.awt.Dimension;
import java.awt.Frame;
import java.awt.GridLayout;
import java.awt.Point;
import java.awt.event.ActionEvent;
import java.awt.event.ActionListener;
import java.awt.event.WindowEvent;
import java.awt.event.WindowListener;

import java.io.File;
import java.io.FilenameFilter;

import java.util.HashSet;
import java.util.Iterator;
import java.util.Set;

import javax.swing.JButton;
import javax.swing.JCheckBox;
import javax.swing.JDialog;
import javax.swing.JLabel;
import javax.swing.JOptionPane;
import javax.swing.JPanel;

import org.gjt.sp.jedit.Buffer;
import org.gjt.sp.jedit.Macros;
import org.gjt.sp.jedit.View;
import org.gjt.sp.jedit.gui.*;
import org.gjt.sp.jedit.jEdit;
import org.gjt.sp.util.*;

public class CompilationMacros {

    //~ Methods ...............................................................

    public static void bibtex(View view, Buffer buffer) {
        historyCommand(view, buffer, false, "latex.bibtex", null, "");
    }

    public static void compile(View view, Buffer buffer, boolean prompt) {
        historyCommand(view, buffer, prompt, "latex.compile", 
                       "latextools.compile.history", 
                       "Enter Compilation Command");
    }

    public static void deleteWorkingFiles(View view, Buffer buffer) {

        String tex = ProjectMacros.getMainTeXPath(buffer);

        if (!(tex.substring(tex.length() - 3, tex.length()).equals("tex"))) {
            Macros.error(view, tex + " is not a TeX file.");

            return;
        }

        String[] extensions = {
            ".log", ".bak", ".aux", ".bbl", ".blg", ".toc", ".pdf", ".xyc", 
            ".out", ".tex~", ".bak"
        };
        WorkingClassDialog dialog = new WorkingClassDialog(view, extensions);
        dialog.setVisible(true);

        Set toRemove = dialog.getToRemove();

        if (toRemove == null) {

            return;
        }

        File dir = (new File(tex)).getParentFile();
        File[] toDelete = dir.listFiles(new ExtensionFilter(toRemove));
        StringBuffer sb = new StringBuffer(
                                      "<html><h3>About to delete the following files:</h3>");

        for (int i = 0; i < toDelete.length; i++) {
            sb.append(toDelete[i]);
            sb.append("<br>");
        }

        sb.append("<br><b>Erase Now?");

        int del = Macros.confirm(view, sb.toString(), 
                                 JOptionPane.YES_NO_OPTION);

        if (del == JOptionPane.YES_OPTION) {

            for (int i = 0; i < toDelete.length; i++) {
                toDelete[i].delete();
            }
        }
    }

    public static void viewOutput(View view, Buffer buffer, boolean prompt) {
        historyCommand(view, buffer, prompt, "latex.viewoutput", 
                       "latextools.viewoutput.history", "Enter Viewer Command");
    }

    private static Point getCenter(Component parent, Component dialog) {

        Dimension pd = parent.getSize();
        Dimension cd = dialog.getSize();
        Point pp = parent.getLocation();
        Point cp = new Point(pp);
        int x = (int)((pd.getWidth() - cd.getWidth()) / 2);
        int y = (int)((pd.getHeight() - cd.getHeight()) / 2);
        cp.translate(x, y);

        return cp;
    }

    private static void historyCommand(View view, Buffer buffer, 
                                       boolean prompt, String commandProps, 
                                       String historyProps, String dialogTitle) {

        String tex = ProjectMacros.getMainTeXPath(buffer);

        if (!(tex.substring(tex.length() - 3, tex.length()).equals("tex"))) {
            Macros.error(view, tex + " is not a TeX file.");

            return;
        }

        tex = tex.substring(0, tex.length() - 4);

        String command;
        String ext;

        if (prompt) {

            CommandHistoryDialog hd = new CommandHistoryDialog(view, 
                                                               historyProps, 
                                                               dialogTitle);
            hd.setVisible(true);
            command = hd.getCommand();
            ext = hd.getExtension();

            if (command == null) {
                Macros.message(view, "Aborting...");

                return;
            }
        } else {
            command = jEdit.getProperty(commandProps + ".command");
            ext = jEdit.getProperty(commandProps + ".ext");
        }

        jEdit.saveAllBuffers(view, false);

        String texRoot = new File(tex).getParent().toString();
        StringBuffer str = new StringBuffer(command);

        if (commandProps.equals("latex.compile") && 
            jEdit.getBooleanProperty("latex.compile.parse-errors")) {
            str.append(" ").append(jEdit.getProperty("latex.compile.c-errors"));
        }

        str.append(" '").append(tex).append(ext).append("'");
        command = str.toString();

        boolean detach = jEdit.getBooleanProperty(commandProps + ".detach");
        runCommand(view, texRoot, command, detach);
    }

    private static void runCommand(View view, String dir, String command, boolean detach) {
        DockableWindowManager manager = view.getDockableWindowManager();
        manager.showDockableWindow("console");
        Console console = (Console) manager.getDockable("console");
        Shell _shell = Shell.getShell("System");
        console.setShell(_shell);
        console.run(_shell, "%kill");
        console.run(_shell, "cd " + '"' + dir + '"');
        console.run(_shell, command);

        if (detach) {
            console.run(_shell, "%detach");
        }
    }

    //~ Inner classes .........................................................

    private static class CommandHistoryDialog
        extends JDialog
        implements ActionListener,
                   WindowListener {

        //~ Instance/static variables .........................................

        private HistoryTextField htf;
        private HistoryTextField extHtf;
        private String command;
        private String extension;

        //~ Constructors ......................................................

        CommandHistoryDialog(Frame owner, String historyProps, 
                             String dialogTitle) {
            super(owner, dialogTitle, true);

            JPanel panel = new JPanel();
            htf = new HistoryTextField(historyProps, false, true);
            htf.setColumns(20);
            extHtf = new HistoryTextField(historyProps + ".ext", false, true);
            extHtf.setColumns(8);

            if (htf.getModel().getSize() > 0) {
                htf.setText(htf.getModel().getItem(0));
            }

            if (extHtf.getModel().getSize() > 0) {
                extHtf.setText(htf.getModel().getItem(0));
            }

            htf.addActionListener(this);
            panel.setLayout(new GridLayout(0, 1));
            panel.add((new JPanel()).add(htf));
            panel.add((new JPanel()).add(extHtf));

            JButton ok = new JButton("OK");
            JButton cancel = new JButton("Cancel");
            ok.addActionListener(this);
            cancel.addActionListener(this);

            JPanel buttonPanel = new JPanel();
            buttonPanel.add(ok);
            buttonPanel.add(cancel);
            panel.add(buttonPanel);
            setContentPane(panel);
            addWindowListener(this);
            pack();
            setLocation(getCenter(owner, this));
        }

        //~ Methods ...........................................................

        public String getCommand() {

            return command;
        }

        public String getExtension() {

            return extension;
        }

        public void actionPerformed(ActionEvent e) {

            if (e.getActionCommand() == "OK") {
                command = htf.getText();
                htf.addCurrentToHistory();
                extension = extHtf.getText();
                extHtf.addCurrentToHistory();
                setVisible(false);
            } else if (e.getActionCommand() == "Cancel") {
                command = null;
                extension = null;
                setVisible(false);
            }
        }

        public void windowActivated(WindowEvent e) {
        }

        public void windowClosed(WindowEvent e) {
        }

        public void windowClosing(WindowEvent e) {
            command = null;
            setVisible(false);
        }

        public void windowDeactivated(WindowEvent e) {
        }

        public void windowDeiconified(WindowEvent e) {
        }

        public void windowIconified(WindowEvent e) {
        }

        public void windowOpened(WindowEvent e) {
        }
    }

    private static class ExtensionFilter
        implements FilenameFilter {

        //~ Instance/static variables .........................................

        StringBuffer sb;
        RE regEx;

        //~ Constructors ......................................................

        ExtensionFilter(Set accept) {

            Iterator it = accept.iterator();
            sb = new StringBuffer("(\\w+?\\");
            sb.append(it.next()).append(")");

            for (; it.hasNext();) {
                sb.append("|(\\w+?\\");
                sb.append(it.next()).append(")");
            }

            sb.append("\\b");

            try {
                regEx = new RE(sb.toString());
            } catch (REException e) {
                e.printStackTrace();
            }
        }

        //~ Methods ...........................................................

        public boolean accept(File dir, String name) {

            return regEx.getMatch(name) != null;
        }
    }

    private static class WorkingClassDialog
        extends JDialog
        implements ActionListener {

        //~ Instance/static variables .........................................

        private String[] extensions;
        private Set toRemove;
        private JCheckBox[] boxes;

        //~ Constructors ......................................................

        WorkingClassDialog(Frame owner, String[] extensions) {
            super(owner, "Erase Working Files", true);
            this.extensions = extensions;
            toRemove = new HashSet();
            boxes = new JCheckBox[extensions.length];

            JPanel boxPanel = new JPanel(new GridLayout(0, 2));

            for (int i = 0; i < boxes.length; i++) {
                boxes[i] = new JCheckBox(extensions[i]);
                boxes[i].setSelected(true);
                boxPanel.add(boxes[i]);
            }

            JButton ok = new JButton("OK");
            JButton cancel = new JButton("Cancel");
            ok.addActionListener(this);
            cancel.addActionListener(this);

            if (boxes.length % 2 == 1) {
                boxPanel.add(new JLabel(""));
            }

            boxPanel.add(ok);
            boxPanel.add(cancel);
            setContentPane(boxPanel);
            pack();
            setLocation(getCenter(owner, this));
        }

        //~ Methods ...........................................................

        public Set getToRemove() {

            return toRemove;
        }

        public void actionPerformed(ActionEvent e) {

            if (e.getActionCommand() == "OK") {

                for (int i = 0; i < extensions.length; i++) {

                    if (boxes[i].isSelected()) {
                        toRemove.add(boxes[i].getText());
                    }
                }

                setVisible(false);
            } else if (e.getActionCommand() == "Cancel") {
                toRemove = null;
                setVisible(false);
            }
        }
    }
}

Summary ✨

This Java code is part of a LaTeX editor’s functionality, specifically for managing working files. It provides a dialog box to select which file extensions should be erased from the working directory. The user can choose multiple extensions and confirm their selection, allowing the editor to clean up unnecessary files. The code uses GUI components and regular expressions to implement this feature.

Tech Fingerprint

Alerts (19)

'import' Maintainability Info: Wildcard imports (e.g., `import java.util.*;`) can obscure the origin of classes and lead to namespace collisions. Prefer importing specific classes explicitly.
54 56
'Set' Raw collection type used. Specify generic type arguments (e.g., List<String>, Map<Integer, Client>) for type safety and clarity. Avoid raw types unless interacting with legacy code.
89 320 355 392
'.delete()' Correctness Info: The return value of File operations like delete(), mkdir(), renameTo() should be checked to ensure the operation succeeded.
114
'=' Maintainability Info: Avoid using unnamed 'magic' numbers directly in comparisons or assignments. Use named constants (static final variables) instead to improve readability and maintainability.
130 131 149 366
'==' Correctness Warning: Comparing String objects using '==' or '!=' checks for reference equality, not value equality. Use '.equals()' to compare String content.
273 279 399 409
Complexity hotspot; line 279 (total complexity: 3)
279
'.printStackTrace()' Avoid printing stack traces directly to std err/out. Use a proper logging framework to handle exceptions consistently and direct output appropriately.
336
'==' Maintainability Info: Avoid using unnamed 'magic' numbers directly in comparisons or assignments. Use named constants (static final variables) instead to improve readability and maintainability.
379
Complexity hotspot; line 409 (total complexity: 3)
409