PluginEditor.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.plugin;
 
import java.awt.BorderLayout;
import java.awt.Component;
import java.awt.Container;
import java.awt.FlowLayout;
import java.awt.Font;
import java.awt.GridBagConstraints;
import java.awt.GridBagLayout;
import java.awt.Insets;
import java.awt.event.FocusEvent;
import java.awt.event.FocusListener;
import java.awt.event.MouseEvent;
import java.awt.event.MouseListener;
import java.util.IdentityHashMap;
import java.util.Map;
import javax.swing.JButton;
import javax.swing.JCheckBox;
import javax.swing.JLabel;
import javax.swing.JOptionPane;
import javax.swing.JPanel;
import javax.swing.JScrollPane;
import javax.swing.JTabbedPane;
import javax.swing.SwingConstants;
import javax.swing.event.DocumentEvent;
import javax.swing.event.DocumentListener;
import net.sf.gridarta.gui.dialog.plugin.parameter.PluginParameterViewFactory;
import net.sf.gridarta.model.archetype.Archetype;
import net.sf.gridarta.model.gameobject.GameObject;
import net.sf.gridarta.model.maparchobject.MapArchObject;
import net.sf.gridarta.plugin.Plugin;
import net.sf.gridarta.plugin.PluginModel;
import net.sf.gridarta.plugin.parameter.NoSuchParameterException;
import net.sf.gridarta.plugin.parameter.PluginParameter;
import net.sf.gridarta.utils.ActionBuilderUtils;
import net.sf.gridarta.utils.ResourceIcons;
import net.sf.japi.swing.action.ActionBuilder;
import net.sf.japi.swing.action.ActionBuilderFactory;
import net.sf.japi.swing.action.ActionMethod;
import org.fife.ui.rsyntaxtextarea.RSyntaxTextArea;
import org.fife.ui.rsyntaxtextarea.SyntaxConstants;
import org.fife.ui.rtextarea.RTextScrollPane;
import org.jetbrains.annotations.NotNull;
 
public class PluginEditor<G extends GameObject<G, A, R>, A extends MapArchObject<A>, R extends Archetype<G, A, R>> {
 
    @NotNull
    private static final ActionBuilder ACTION_BUILDER = ActionBuilderFactory.getInstance().getActionBuilder("net.sf.gridarta");
 
    @NotNull
    private final PluginController<G, A, R> pluginController;
 
    @NotNull
    private final Container panel = new JPanel(new BorderLayout());
 
    @NotNull
    private final PluginParameterViewFactory<G, A, R> pluginParameterViewFactory;
 
    @NotNull
    private final JPanel parameterTable = new JPanel(new GridBagLayout());
 
    @NotNull
    private final PluginModel<G, A, R> pluginModel;
 
    @NotNull
    private final Plugin<G, A, R> plugin;
 
    @NotNull
    private final Map<PluginParameter<G, A, R, ?>, PluginEditorRow> rows = new IdentityHashMap<>();
 
    private int selectedRow = -1;
 
    @NotNull
    private final MouseListener cellMouseListener = new MouseListener() {
 
        @Override
        public void mouseClicked(@NotNull final MouseEvent e) {
            selectTableComponent((Component) e.getSource());
        }
 
        @Override
        public void mouseEntered(@NotNull final MouseEvent e) {
        }
 
        @Override
        public void mouseExited(@NotNull final MouseEvent e) {
        }
 
        @Override
        public void mousePressed(@NotNull final MouseEvent e) {
            selectTableComponent((Component) e.getSource());
        }
 
        @Override
        public void mouseReleased(@NotNull final MouseEvent e) {
            selectTableComponent((Component) e.getSource());
        }
    };
 
    @NotNull
    private final FocusListener cellFocusListener = new FocusListener() {
 
        @Override
        public void focusGained(@NotNull final FocusEvent e) {
            selectTableComponent((Component) e.getSource());
        }
 
        @Override
        public void focusLost(@NotNull final FocusEvent e) {
        }
    };
 
    public PluginEditor(@NotNull final Plugin<G, A, R> plugin, @NotNull final PluginController<G, A, R> pluginController, @NotNull final PluginModel<G, A, R> pluginModel, @NotNull final PluginParameterViewFactory<G, A, R> pluginParameterViewFactory, @NotNull final ResourceIcons resourceIcons) {
        this.pluginController = pluginController;
        this.pluginModel = pluginModel;
        this.plugin = plugin;
        this.pluginParameterViewFactory = pluginParameterViewFactory;
 
        final JTabbedPane tabs = new JTabbedPane();
        tabs.addTab(ActionBuilderUtils.getString(ACTION_BUILDER, "pluginEditorTabOptions"), createOptionsTab(resourceIcons));
        tabs.addTab(ActionBuilderUtils.getString(ACTION_BUILDER, "pluginEditorTabParameters"), createParameterTab());
        tabs.addTab(ActionBuilderUtils.getString(ACTION_BUILDER, "pluginEditorTabCode"), createCodePanel());
        panel.add(tabs);
    }
 
    @NotNull
    private Component createOptionsTab(@NotNull final ResourceIcons resourceIcons) {
        final Container optionsTab = new JPanel(new GridBagLayout());
        final GridBagConstraints gbc = new GridBagConstraints();
 
        final Container parameterButtons = new JPanel();
        parameterButtons.setLayout(new StackLayout(5));
        parameterButtons.add(new JButton(ACTION_BUILDER.createAction(false, "pluginEditorReRegister", this)));
        parameterButtons.add(new JButton(ACTION_BUILDER.createAction(false, "pluginEditorExport", this)));
 
        gbc.fill = GridBagConstraints.HORIZONTAL;
        gbc.gridx = 0;
        gbc.gridy = 0;
        gbc.gridwidth = 2;
        gbc.weightx = 1.0;
        gbc.anchor = GridBagConstraints.CENTER;
        optionsTab.add(new JLabel(ActionBuilderUtils.getString(ACTION_BUILDER, "pluginEditorRunMode"), SwingConstants.LEFT), gbc);
 
        gbc.gridx = 0;
        gbc.gridwidth = 1;
        gbc.weightx = 0.0;
        gbc.anchor = GridBagConstraints.CENTER;
 
        gbc.gridy = 1;
        optionsTab.add(new JLabel(resourceIcons.getResourceIcon(ResourceIcons.AUTO_RUN_SMALL_ICON)), gbc);
        gbc.gridy = 2;
        optionsTab.add(new JLabel(resourceIcons.getResourceIcon(ResourceIcons.FILTER_SMALL_ICON)), gbc);
        gbc.gridy = 3;
        optionsTab.add(new JLabel(resourceIcons.getResourceIcon(ResourceIcons.RUN_PLUGIN_SMALL_ICON)), gbc);
 
        gbc.gridx = 1;
        gbc.gridwidth = 1;
        gbc.weightx = 1.0;
        gbc.anchor = GridBagConstraints.WEST;
 
        gbc.gridy = 1;
        optionsTab.add(new JCheckBox(ACTION_BUILDER.createToggle(false, "pluginEditorIsAutoRun", this)), gbc);
        gbc.gridy = 2;
        optionsTab.add(new JCheckBox(ACTION_BUILDER.createToggle(false, "pluginEditorIsFilter", this)), gbc);
        gbc.gridy = 3;
        optionsTab.add(new JCheckBox(ACTION_BUILDER.createToggle(false, "pluginEditorIsScript", this)), gbc);
 
        gbc.gridx = 0;
        gbc.gridwidth = 2;
        gbc.weightx = 1.0;
        gbc.anchor = GridBagConstraints.WEST;
        gbc.fill = GridBagConstraints.NONE;
 
        gbc.gridy = 4;
        optionsTab.add(parameterButtons, gbc);
 
        gbc.gridx = 0;
        gbc.gridy = 5;
        gbc.gridwidth = 2;
        gbc.weightx = 1.0;
        gbc.weighty = 1.0;
        gbc.fill = GridBagConstraints.BOTH;
        optionsTab.add(new JPanel(), gbc);
 
        return optionsTab;
    }
 
    @NotNull
    private Component createParameterTab() {
        plugin.addPluginListener(this::redrawTable);
 
        final Container parameterButtons = new JPanel();
        parameterButtons.setLayout(new StackLayout(5));
        parameterButtons.add(new JButton(ACTION_BUILDER.createAction(false, "pluginEditorAddParameter", this)));
        parameterButtons.add(new JButton(ACTION_BUILDER.createAction(false, "pluginEditorRemoveParameter", this)));
 
        final GridBagConstraints gbc = new GridBagConstraints();
 
        gbc.gridx = 0;
        gbc.gridy = 0;
        gbc.gridwidth = 1;
        gbc.weightx = 1.0;
        gbc.fill = GridBagConstraints.HORIZONTAL;
        gbc.anchor = GridBagConstraints.WEST;
 
        final Container parameterTab = new JPanel(new GridBagLayout());
        parameterTab.add(new JScrollPane(parameterTable), gbc);
        gbc.gridy++;
        parameterTab.add(parameterButtons, gbc);
        gbc.gridy++;
        gbc.weighty = 1.0;
        gbc.fill = GridBagConstraints.BOTH;
        parameterTab.add(new JPanel(), gbc);
 
        redrawTable();
        return parameterTab;
    }
 
    @NotNull
    private Component createCode() {
        final RSyntaxTextArea code = new RSyntaxTextArea();
        code.setText(plugin.getCode());
        code.setCaretPosition(0);
        code.setFont(new Font("Monospaced", Font.PLAIN, 14));
        code.getDocument().addDocumentListener(new DocumentListener() {
 
            @Override
            public void changedUpdate(final DocumentEvent e) {
                plugin.setCode(code.getText());
            }
 
            @Override
            public void insertUpdate(final DocumentEvent e) {
                plugin.setCode(code.getText());
            }
 
            @Override
            public void removeUpdate(final DocumentEvent e) {
                plugin.setCode(code.getText());
            }
        });
        code.setSyntaxEditingStyle(SyntaxConstants.SYNTAX_STYLE_JAVA);
        code.setRows(40);
        return new RTextScrollPane(code);
    }
 
    @NotNull
    private Component createCodePanel() {
        final Container codeBottom = new JPanel(new FlowLayout());
        codeBottom.add(new JButton(ACTION_BUILDER.createAction(false, "pluginEditorRunScript", this)));
 
        final Container codePanel = new JPanel(new BorderLayout());
        codePanel.add(createCode(), BorderLayout.CENTER);
        codePanel.add(codeBottom, BorderLayout.SOUTH);
 
        return codePanel;
    }
 
    private void selectTableComponent(@NotNull final Component c) {
        final GridBagLayout l = (GridBagLayout) parameterTable.getLayout();
        final GridBagConstraints gbc = l.getConstraints(c);
        if (gbc != null) {
            selectedRow = gbc.gridy - 1;
        }
    }
 
    private void redrawTable() {
        final GridBagConstraints gbc = new GridBagConstraints(0, 0, 1, 1, 0.1, 0.0, GridBagConstraints.CENTER, GridBagConstraints.HORIZONTAL, new Insets(0, 0, 0, 0), 5, 0);
        parameterTable.removeAll();
        parameterTable.add(ActionBuilderUtils.newLabel(ACTION_BUILDER, "pluginEditorTitleName.text"), gbc);
        gbc.gridx = 1;
        parameterTable.add(ActionBuilderUtils.newLabel(ACTION_BUILDER, "pluginEditorTitleDescription.text"), gbc);
        gbc.gridx = 2;
        parameterTable.add(ActionBuilderUtils.newLabel(ACTION_BUILDER, "pluginEditorTitleType.text"), gbc);
        gbc.gridx = 3;
        parameterTable.add(ActionBuilderUtils.newLabel(ACTION_BUILDER, "pluginEditorTitleConfig.text"), gbc);
        gbc.gridx = 4;
        parameterTable.add(ActionBuilderUtils.newLabel(ACTION_BUILDER, "pluginEditorTitleDefault.text"), gbc);
        for (final PluginParameter<G, A, R, ?> parameter : plugin) {
            final PluginEditorRow row = getOrCreateRow(parameter);
            gbc.gridy++;
            gbc.gridx = 0;
            parameterTable.add(row.getParameterNameEditor(), gbc);
            gbc.gridx = 1;
            gbc.weightx = 0.5;
            parameterTable.add(row.getParameterDescriptionEditor(), gbc);
            gbc.gridx = 2;
            gbc.weightx = 0.1;
            parameterTable.add(row.getParameterTypeEditor(), gbc);
            gbc.gridx = 3;
            parameterTable.add(row.getConfigComponent(), gbc);
            gbc.gridx = 4;
            parameterTable.add(row.getValueComponent(), gbc);
        }
        panel.repaint();
    }
 
    @NotNull
    private PluginEditorRow getOrCreateRow(@NotNull final PluginParameter<G, A, R, ?> parameter) {
        final PluginEditorRow existingRow = rows.get(parameter);
        if (existingRow != null) {
            return existingRow;
        }
 
        final PluginEditorRow row = new PluginEditorRow(plugin, parameter, pluginParameterViewFactory, cellMouseListener, cellFocusListener, panel);
        rows.put(parameter, row);
        return row;
    }
 
    @NotNull
    public Component getComponent() {
        return panel;
    }
 
    @ActionMethod
    public boolean isPluginEditorIsAutoRun() {
        return plugin.isAutoBoot();
    }
 
    @ActionMethod
    public void setPluginEditorIsAutoRun(final boolean autoRun) {
        plugin.setAutoBoot(autoRun);
    }
 
    @ActionMethod
    public boolean isPluginIsEditorFilter() {
        return plugin.isFilter();
    }
 
    @ActionMethod
    public void setPluginIsEditorFilter(final boolean filter) {
        plugin.setFilter(filter);
    }
 
    @ActionMethod
    public boolean isPluginIsScript() {
        return plugin.isScript();
    }
 
    @ActionMethod
    public void setPluginIsScript(final boolean script) {
        plugin.setScript(script);
    }
 
    @ActionMethod
    public void pluginEditorReRegister() {
        pluginModel.reRegister(plugin);
    }
 
    @ActionMethod
    public void pluginEditorExport() {
        pluginController.savePluginAs(plugin, false);
    }
 
    @ActionMethod
    public void pluginEditorAddParameter() {
        plugin.newParameter();
    }
 
    @ActionMethod
    public void pluginEditorRemoveParameter() {
        if (selectedRow < 0) {
            return;
        }
 
        final PluginParameter<G, A, R, ?> parameter;
        try {
            parameter = plugin.getParameter(selectedRow);
        } catch (final NoSuchParameterException ignored) {
            return;
        }
        final String name = parameter.getName();
        final String title = ActionBuilderUtils.getString(ACTION_BUILDER, "pluginEditorRemoveParameterConfirm.title");
        final String message = ActionBuilderUtils.format(ACTION_BUILDER, "pluginEditorRemoveParameterConfirm.message", name);
        if (JOptionPane.showConfirmDialog(panel, message, title, JOptionPane.YES_NO_OPTION) == JOptionPane.YES_OPTION) {
            plugin.removeParameter(selectedRow);
        }
    }
 
    @ActionMethod
    public void pluginEditorRunScript() {
        pluginController.runPlugin(plugin);
    }
 
}