DefaultErrorView.java

Go to the documentation of this file.

/*
 * Gridarta MMORPG map editor for Crossfire, Daimonin and similar games.
 * Copyright (C) 2000-2023 The Gridarta Developers.
 *
 * 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
 * (at your option) 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.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */
 
package net.sf.gridarta.gui.dialog.errorview;
 
import java.awt.Component;
import java.awt.Dialog;
import java.awt.Dimension;
import java.lang.reflect.InvocationTargetException;
import java.util.EnumMap;
import java.util.Map;
import java.util.concurrent.Semaphore;
import javax.swing.JButton;
import javax.swing.JOptionPane;
import javax.swing.JScrollPane;
import javax.swing.JTree;
import javax.swing.SwingUtilities;
import javax.swing.tree.DefaultMutableTreeNode;
import javax.swing.tree.DefaultTreeModel;
import javax.swing.tree.TreePath;
import net.sf.gridarta.model.errorview.ErrorView;
import net.sf.gridarta.model.errorview.ErrorViewCategory;
import net.sf.gridarta.utils.ActionBuilderUtils;
import net.sf.japi.swing.action.ActionBuilder;
import net.sf.japi.swing.action.ActionBuilderFactory;
import net.sf.japi.swing.action.ActionMethod;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
 
public class DefaultErrorView implements ErrorView {
 
    @NotNull
    private static final ActionBuilder ACTION_BUILDER = ActionBuilderFactory.getInstance().getActionBuilder("net.sf.gridarta");
 
    @NotNull
    private final DefaultTreeModel treeModel = new DefaultTreeModel(null);
 
    @NotNull
    private final DefaultMutableTreeNode treeRoot = new ErrorEntry(treeModel, "/", true);
 
    @NotNull
    private final Map<ErrorViewCategory, ErrorEntry> categories = new EnumMap<>(ErrorViewCategory.class);
 
    @Nullable
    private final Component parent;
 
    private boolean errors;
 
    @Nullable
    private Dialog dialog;
 
    @NotNull
    private final Object dialogSync = new Object();
 
    @Nullable
    private JButton okButton;
 
    @NotNull
    private final Semaphore semaphore = new Semaphore(0);
 
    public DefaultErrorView(@Nullable final Component parent) {
        treeModel.setRoot(treeRoot);
        this.parent = parent;
    }
 
    @Override
    public void addError(@NotNull final ErrorViewCategory categoryName, @NotNull final String message) {
        addEntry(categoryName, message);
        errors = true;
    }
 
    @Override
    public void addError(@NotNull final ErrorViewCategory categoryName, final int lineNo, @NotNull final String message) {
        addEntry(categoryName, lineNo + ": " + message);
        errors = true;
    }
 
    @Override
    public void addWarning(@NotNull final ErrorViewCategory categoryName, @NotNull final String message) {
        addEntry(categoryName, "Warning: " + message);
    }
 
    @Override
    public void addWarning(@NotNull final ErrorViewCategory categoryName, final int lineNo, @NotNull final String message) {
        addEntry(categoryName, "Warning: line " + lineNo + ": " + message);
    }
 
    private void addEntry(final ErrorViewCategory categoryName, final String message) {
        final Runnable runnable = () -> {
            final ErrorEntry category = getCategory(categoryName);
            final ErrorEntry errorEntry = new ErrorEntry(treeModel, message, false);
            category.add(errorEntry);
            showDialog(category, errorEntry);
        };
        if (SwingUtilities.isEventDispatchThread()) {
            runnable.run();
        } else {
            try {
                SwingUtilities.invokeAndWait(runnable);
            } catch (final InterruptedException ignored) {
                Thread.currentThread().interrupt();
            } catch (final InvocationTargetException ex) {
                throw new RuntimeException(ex);
            }
        }
    }
 
    @NotNull
    private ErrorEntry getCategory(@NotNull final ErrorViewCategory categoryName) {
        final ErrorEntry existingErrorEntry = categories.get(categoryName);
        if (existingErrorEntry != null) {
            return existingErrorEntry;
        }
 
        final ErrorEntry category = new ErrorEntry(treeModel, categoryName.toString(), true);
        categories.put(categoryName, category);
        treeRoot.add(category);
        return category;
    }
 
    @Override
    public boolean hasErrors() {
        return errors;
    }
 
    private void showDialog(@NotNull final ErrorEntry category, @NotNull final ErrorEntry errorEntry) {
        synchronized (dialogSync) {
            if (dialog == null) {
                showDialogInt(category, errorEntry);
            }
        }
    }
 
    private void showDialogInt(@NotNull final ErrorEntry category, @NotNull final ErrorEntry errorEntry) {
        final JTree tree = new JTree(treeModel);
        final JScrollPane scrollPane = new JScrollPane(tree);
        tree.setExpandsSelectedPaths(true);
        final TreePath path = new TreePath(new Object[] { treeRoot, category, errorEntry, });
        tree.setSelectionPath(path);
        tree.scrollPathToVisible(path);
        okButton = new JButton(ACTION_BUILDER.createAction(false, "errorViewOk", this));
        final JOptionPane pane = new JOptionPane(scrollPane, JOptionPane.PLAIN_MESSAGE, JOptionPane.DEFAULT_OPTION, null, new Object[] { okButton, }, okButton) {
 
            private static final long serialVersionUID = 1L;
 
            @Override
            public void setValue(@Nullable final Object newValue) {
                super.setValue(newValue);
                if (newValue != UNINITIALIZED_VALUE) {
                    errorViewOk();
                }
            }
 
        };
        pane.setPreferredSize(new Dimension(800, 600));
        assert okButton != null;
        okButton.setEnabled(false);
        dialog = pane.createDialog(parent, ActionBuilderUtils.getString(ACTION_BUILDER, "errorViewTitle"));
        pane.selectInitialValue();
        assert dialog != null;
        dialog.pack();
        assert dialog != null;
        dialog.setModal(false);
        assert dialog != null;
        dialog.setVisible(true);
    }
 
    @Override
    public void waitDialog() throws InterruptedException {
        if (hasDialog()) {
            final Runnable runnable = () -> {
                assert okButton != null;
                okButton.setEnabled(true);
            };
            if (SwingUtilities.isEventDispatchThread()) {
                runnable.run();
            } else {
                try {
                    SwingUtilities.invokeAndWait(runnable);
                } catch (final InvocationTargetException ex) {
                    throw new RuntimeException(ex);
                }
            }
 
            semaphore.acquire();
        }
 
        if (Thread.interrupted()) {
            throw new InterruptedException("current thread was interrupted");
        }
    }
 
    @ActionMethod
    public void errorViewOk() {
        synchronized (dialogSync) {
            if (dialog != null) {
                try {
                    dialog.dispose();
                    dialog = null;
                } finally {
                    semaphore.release();
                }
            }
        }
    }
 
    private boolean hasDialog() {
        synchronized (dialogSync) {
            return dialog != null;
        }
    }
 
}