GridartaEditor.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.maincontrol;
 
import gnu.getopt.Getopt;
import gnu.getopt.LongOpt;
import java.awt.GraphicsEnvironment;
import java.io.File;
import java.lang.reflect.InvocationTargetException;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
import java.util.Locale;
import java.util.MissingResourceException;
import java.util.ResourceBundle;
import java.util.prefs.Preferences;
import javax.swing.SwingUtilities;
import javax.swing.UIManager;
import javax.swing.UIManager.LookAndFeelInfo;
import javax.swing.UnsupportedLookAndFeelException;
import net.sf.gridarta.MainControl;
import net.sf.gridarta.commands.BatchPngCommand;
import net.sf.gridarta.commands.CollectArchesCommand;
import net.sf.gridarta.commands.SinglePngCommand;
import net.sf.gridarta.gui.dialog.errorview.ConsoleErrorView;
import net.sf.gridarta.gui.dialog.errorview.DefaultErrorView;
import net.sf.gridarta.gui.dialog.prefs.GUIPreferences;
import net.sf.gridarta.gui.filter.DefaultFilterControl;
import net.sf.gridarta.gui.filter.FilterControl;
import net.sf.gridarta.gui.map.renderer.RendererFactory;
import net.sf.gridarta.mainactions.DefaultExiter;
import net.sf.gridarta.model.archetype.Archetype;
import net.sf.gridarta.model.configsource.ConfigSource;
import net.sf.gridarta.model.configsource.ConfigSourceFactory;
import net.sf.gridarta.model.configsource.DefaultConfigSourceFactory;
import net.sf.gridarta.model.errorview.ErrorView;
import net.sf.gridarta.model.filter.NamedFilter;
import net.sf.gridarta.model.gameobject.GameObject;
import net.sf.gridarta.model.maparchobject.MapArchObject;
import net.sf.gridarta.model.mapviewsettings.DefaultMapViewSettings;
import net.sf.gridarta.model.mapviewsettings.MapViewSettings;
import net.sf.gridarta.model.settings.DefaultEditorSettings;
import net.sf.gridarta.model.settings.EditorSettings;
import net.sf.gridarta.model.settings.ProjectSettings;
import net.sf.gridarta.plugin.PluginExecutor;
import net.sf.gridarta.preferences.FilePreferencesFactory;
import net.sf.gridarta.project.ProjectModel;
import net.sf.gridarta.utils.ConfigFileUtils;
import net.sf.gridarta.utils.ResourceIcons;
import net.sf.gridarta.utils.SyntaxErrorException;
import net.sf.japi.swing.action.ActionBuilder;
import net.sf.japi.swing.action.ActionBuilderFactory;
import org.apache.log4j.Category;
import org.apache.log4j.Logger;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
 
@SuppressWarnings("UseOfSystemOutOrSystemErr")
public class GridartaEditor<G extends GameObject<G, A, R>, A extends MapArchObject<A>, R extends Archetype<G, A, R>> {
 
    @NotNull
    private static final Category LOG = Logger.getLogger(GridartaEditor.class);
 
    public GridartaEditor(@NotNull final String tipOfTheDayPackage) {
        System.setProperty("net.sf.japi.swing.tod", tipOfTheDayPackage);
        try {
            if (LOG.isInfoEnabled()) {
                LOG.info("build number: " + ResourceBundle.getBundle("build").getString("build.number"));
            }
        } catch (final MissingResourceException e) {
            LOG.warn("No build number found:", e);
        }
    }
 
    public void run(@NotNull final String actionBuilderPackage, @NotNull final String editorJarName, @NotNull final EditorFactory<G, A, R> editorFactory, @Nullable final String defaultConfig, @NotNull final String... args) {
        boolean err = false; // whether a fatal error (exit required) occurred.
        String plugin = null;
        final LongOpt[] longOpts = {
            // @formatter:off
            new LongOpt("batchpng", LongOpt.NO_ARGUMENT, null, 'b'),
            new LongOpt("normal", LongOpt.NO_ARGUMENT, null, 'n'),
            new LongOpt("singlepng", LongOpt.NO_ARGUMENT, null, 's'),
            new LongOpt("collectarches", LongOpt.NO_ARGUMENT, null, 'c'),
            new LongOpt("collectArches", LongOpt.NO_ARGUMENT, null, 'c'),
            new LongOpt("help", LongOpt.NO_ARGUMENT, null, 'h'),
            new LongOpt("noexit", LongOpt.NO_ARGUMENT, null, 2),
            new LongOpt("script", LongOpt.REQUIRED_ARGUMENT, null, 1),
            new LongOpt("plugin", LongOpt.REQUIRED_ARGUMENT, null, 1),
            new LongOpt("config", LongOpt.REQUIRED_ARGUMENT, null, 3),
            new LongOpt("use-mapdir", LongOpt.NO_ARGUMENT, null, 4),
            // @formatter:on
        };
        final Getopt g = new Getopt(editorJarName, args, "bchns", longOpts);
        GridartaRunMode mode = GridartaRunMode.NORMAL;
        File config = defaultConfig == null ? null : ConfigFileUtils.getHomeFile(defaultConfig);
        boolean useMapdir = false;
        boolean doExit = true;
        while (true) {
            final int ch = g.getopt();
            if (ch == -1) {
                break;
            }
 
            switch (ch) {
            case 'b':
                mode = GridartaRunMode.BATCH_PNG;
                break;
 
            case 'c':
                mode = GridartaRunMode.COLLECT_ARCHES;
                break;
 
            case 'h':
                usage(editorJarName, defaultConfig);
                return;
 
            case 'n':
                mode = GridartaRunMode.NORMAL;
                break;
 
            case 's':
                mode = GridartaRunMode.SINGLE_PNG;
                break;
 
            case 1:
                plugin = g.getOptarg();
                break;
 
            case 2:
                doExit = false;
                break;
 
            case 3: // --config
                config = new File(g.getOptarg());
                if (!config.exists()) {
                    System.err.println(config + ": configuration file does not exist");
                    err = true;
                }
                break;
 
            case 4: // --use-mapdir
                useMapdir = true;
                break;
 
            case '?':
            default:
                err = true;
                break;
            }
        }
        int returnCode;
        if (err) {
            returnCode = 1;
        } else {
            if (config != null) {
                System.setProperty("java.util.prefs.PreferencesFactory", "net.sf.gridarta.preferences.FilePreferencesFactory");
                FilePreferencesFactory.initialize("user_net_sf_gridarta", config);
            }
 
            // Make sure the locale is set before any ActionBuilder is used.
            final Preferences preferences = Preferences.userNodeForPackage(MainControl.class);
            final String locName = preferences.get(GUIPreferences.PREFERENCES_LANGUAGE, null);
            if (locName != null) {
                Locale.setDefault(new Locale(locName));
            }
 
            final List<String> args2 = Arrays.asList(args).subList(g.getOptind(), args.length);
 
            // Now add preferences to the ActionBuilder.
            final ActionBuilder actionBuilder = ActionBuilderFactory.getInstance().getActionBuilder("net.sf.gridarta");
            actionBuilder.addPref(DefaultMainControl.class);
            actionBuilder.addParent(ActionBuilderFactory.getInstance().getActionBuilder(actionBuilderPackage));
 
            // Create the application and give it the parameters
            final ErrorView errorView = GraphicsEnvironment.isHeadless() || mode.isConsoleMode() || plugin != null ? new ConsoleErrorView() : new DefaultErrorView(null);
            final ResourceIcons resourceIcons = new ResourceIcons();
            final ConfigSourceFactory configSourceFactory = new DefaultConfigSourceFactory();
            final EditorSettings editorSettings = new DefaultEditorSettings();
            final ProjectSettings projectSettings = editorFactory.newProjectSettings(editorSettings);
            final ConfigSource configSource = configSourceFactory.getConfigSource(mode == GridartaRunMode.COLLECT_ARCHES ? "ARCH_DIRECTORY" : projectSettings.getConfigSourceName());
            final ProjectModel<G, A, R> projectModel = new ProjectModel<>(errorView, projectSettings, editorFactory, resourceIcons, configSource);
 
            if (plugin == null) {
                final List<File> args3 = new ArrayList<>();
                for (final String arg: args2) {
                    args3.add(useMapdir ? new File(projectSettings.getMapsDirectory(), arg) : new File(arg));
                }
                try {
                    switch (mode) {
                    case NORMAL:
                        returnCode = runNormal(args3, editorFactory, errorView, resourceIcons, configSourceFactory, projectModel, editorSettings);
                        break;
 
                    case BATCH_PNG:
                        returnCode = new BatchPngCommand(args3, ImageCreatorFactory.newImageCreator(resourceIcons, editorFactory, projectModel, editorSettings)).execute();
                        break;
 
                    case SINGLE_PNG:
                        if (args3.size() != 2) {
                            throw new SyntaxErrorException("input output");
                        }
 
                        returnCode = new SinglePngCommand(args3.get(0), args3.get(1), ImageCreatorFactory.newImageCreator(resourceIcons, editorFactory, projectModel, editorSettings)).execute();
                        break;
 
                    case COLLECT_ARCHES:
                        returnCode = new CollectArchesCommand(projectModel).execute();
                        break;
 
                    default:
                        assert false;
                        returnCode = 1;
                        break;
                    }
                } catch (final SyntaxErrorException ex) {
                    System.err.println("Usage: " + ex.getMessage());
                    returnCode = 1;
                }
            } else {
                returnCode = runPlugin(plugin, errorView, args2, editorFactory, projectModel, resourceIcons, editorSettings);
            }
        }
        if (doExit && (mode != GridartaRunMode.NORMAL || returnCode != 0)) {
            System.exit(returnCode);
        }
    }
 
    private int runPlugin(@NotNull final String plugin, final ErrorView errorView, final Iterable<String> args, @NotNull final EditorFactory<G, A, R> editorFactory, @NotNull final ProjectModel<G, A, R> projectModel, @NotNull final ResourceIcons resourceIcons, @NotNull final EditorSettings editorSettings) {
        checkForErrors(errorView);
        waitDialog(errorView);
        final NamedFilter defaultNamedFilterList = new NamedFilter(projectModel.getGameObjectMatchers().getFilters());
        final FilterControl<G, A, R> filterControl = new DefaultFilterControl<>(defaultNamedFilterList, editorSettings);
        final MapViewSettings mapViewSettings = new DefaultMapViewSettings();
        final RendererFactory<G, A, R> rendererFactory = editorFactory.newRendererFactory(mapViewSettings, filterControl, projectModel.getGameObjectParser(), projectModel.getFaceObjectProviders(), resourceIcons, projectModel.getSmoothFaces());
        return new PluginExecutor<>(projectModel.getPluginModel(), projectModel.newPluginParameters(rendererFactory)).executePlugin(plugin, args);
    }
 
    private static void checkForErrors(@NotNull final ErrorView errorView) {
        if (errorView.hasErrors()) {
            waitDialog(errorView);
            DefaultExiter.callExit(1);
            throw new AssertionError();
        }
    }
 
    private static void waitDialog(final ErrorView errorView) {
        try {
            errorView.waitDialog();
        } catch (final InterruptedException ex) {
            Thread.currentThread().interrupt();
            DefaultExiter.callExit(1);
            throw new AssertionError(ex);
        }
    }
 
    private int runNormal(@NotNull final List<File> args, @NotNull final EditorFactory<G, A, R> editorFactory, @NotNull final ErrorView errorView, @NotNull final ResourceIcons resourceIcons, @NotNull final ConfigSourceFactory configSourceFactory, @NotNull final ProjectModel<G, A, R> projectModel, @NotNull final EditorSettings editorSettings) {
        try {
            for (final LookAndFeelInfo info : UIManager.getInstalledLookAndFeels()) {
                if ("Nimbus".equals(info.getName())) {
                    UIManager.setLookAndFeel(info.getClassName());
                    break;
                }
            }
        } catch (final ClassNotFoundException | IllegalAccessException | InstantiationException | UnsupportedLookAndFeelException ignored) {
        }
 
        final GUIMainControl<?, ?, ?>[] guiMainControl = new GUIMainControl<?, ?, ?>[1];
        final Runnable runnable = () -> guiMainControl[0] = new GUIMainControl<>(projectModel, editorSettings, errorView, resourceIcons, editorFactory, configSourceFactory);
        try {
            SwingUtilities.invokeAndWait(runnable);
        } catch (final InterruptedException ex) {
            LOG.fatal(ex.getMessage(), ex);
            Thread.currentThread().interrupt();
            return 1;
        } catch (final InvocationTargetException ex) {
            LOG.fatal(ex.getMessage(), ex);
            return 1;
        }
 
        checkForErrors(errorView);
        waitDialog(errorView);
 
        final Runnable runnable2 = () -> guiMainControl[0].run(args);
        try {
            SwingUtilities.invokeAndWait(runnable2);
        } catch (final InterruptedException ex) {
            LOG.fatal(ex.getMessage(), ex);
            Thread.currentThread().interrupt();
            return 1;
        } catch (final InvocationTargetException ex) {
            LOG.fatal(ex.getMessage(), ex);
            return 1;
        }
 
        return 0;
    }
 
    private static void usage(@NotNull final String editorJarName, @Nullable final String defaultConfig) {
        System.out.println("usage: java -jar " + editorJarName + " [option...] [map-file...]");
        System.out.println();
        System.out.println(" -h, --help           print this help");
        System.out.println(" -b, --batchpng       create PNG files for all given maps in their directories");
        System.out.println(" -c, --collectarches  collect archetypes");
        System.out.println(" -n, --normal         start editor with GUI (default)");
        System.out.println(" -s, --singlepng      create a PNG file from the specified map");
        System.out.println(" --config=config-file use given config file; uses " + (defaultConfig == null ? "Java preferences" : "~/.gridarta/" + defaultConfig) + " is not given");
        System.out.println(" --noexit             do not call System.exit()");
        System.out.println(" --plugin=name [arg=value...]");
        System.out.println("                      run a plugin with the given arguments");
        System.out.println(" --use-mapdir         prepend the configured maps directory to all map-file arguments");
    }
 
}