// License: GPL. Copyright 2007 by Immanuel Scholz and others
package org.openstreetmap.josm;
import static org.openstreetmap.josm.tools.I18n.tr;
import java.awt.BorderLayout;
import java.awt.Component;
import java.awt.GridBagConstraints;
import java.awt.GridBagLayout;
import java.awt.Window;
import java.awt.event.ComponentEvent;
import java.awt.event.ComponentListener;
import java.awt.event.KeyEvent;
import java.awt.event.WindowAdapter;
import java.awt.event.WindowEvent;
import java.io.File;
import java.lang.ref.WeakReference;
import java.net.URI;
import java.net.URISyntaxException;
import java.text.MessageFormat;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import java.util.StringTokenizer;
import java.util.concurrent.Callable;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.Executors;
import java.util.concurrent.Future;
import javax.swing.Action;
import javax.swing.InputMap;
import javax.swing.JComponent;
import javax.swing.JFrame;
import javax.swing.JLabel;
import javax.swing.JOptionPane;
import javax.swing.JPanel;
import javax.swing.JTextArea;
import javax.swing.KeyStroke;
import javax.swing.UIManager;
import org.openstreetmap.gui.jmapviewer.FeatureAdapter;
import org.openstreetmap.josm.actions.JosmAction;
import org.openstreetmap.josm.actions.OpenFileAction;
import org.openstreetmap.josm.actions.downloadtasks.DownloadGpsTask;
import org.openstreetmap.josm.actions.downloadtasks.DownloadOsmTask;
import org.openstreetmap.josm.actions.downloadtasks.DownloadTask;
import org.openstreetmap.josm.actions.downloadtasks.PostDownloadHandler;
import org.openstreetmap.josm.actions.mapmode.MapMode;
import org.openstreetmap.josm.actions.search.SearchAction;
import org.openstreetmap.josm.data.Bounds;
import org.openstreetmap.josm.data.Preferences;
import org.openstreetmap.josm.data.UndoRedoHandler;
import org.openstreetmap.josm.data.coor.CoordinateFormat;
import org.openstreetmap.josm.data.coor.LatLon;
import org.openstreetmap.josm.data.osm.DataSet;
import org.openstreetmap.josm.data.osm.PrimitiveDeepCopy;
import org.openstreetmap.josm.data.projection.Projection;
import org.openstreetmap.josm.data.projection.ProjectionChangeListener;
import org.openstreetmap.josm.data.validation.OsmValidator;
import org.openstreetmap.josm.gui.GettingStarted;
import org.openstreetmap.josm.gui.MainApplication.Option;
import org.openstreetmap.josm.gui.MainMenu;
import org.openstreetmap.josm.gui.MapFrame;
import org.openstreetmap.josm.gui.MapFrameListener;
import org.openstreetmap.josm.gui.MapView;
import org.openstreetmap.josm.gui.NavigatableComponent.ViewportData;
import org.openstreetmap.josm.gui.dialogs.LayerListDialog;
import org.openstreetmap.josm.gui.io.SaveLayersDialog;
import org.openstreetmap.josm.gui.layer.Layer;
import org.openstreetmap.josm.gui.layer.OsmDataLayer;
import org.openstreetmap.josm.gui.layer.OsmDataLayer.CommandQueueListener;
import org.openstreetmap.josm.gui.preferences.ToolbarPreferences;
import org.openstreetmap.josm.gui.preferences.imagery.ImageryPreference;
import org.openstreetmap.josm.gui.preferences.map.MapPaintPreference;
import org.openstreetmap.josm.gui.preferences.map.TaggingPresetPreference;
import org.openstreetmap.josm.gui.preferences.projection.ProjectionPreference;
import org.openstreetmap.josm.gui.progress.PleaseWaitProgressMonitor;
import org.openstreetmap.josm.gui.progress.ProgressMonitorExecutor;
import org.openstreetmap.josm.gui.util.RedirectInputMap;
import org.openstreetmap.josm.io.OsmApi;
import org.openstreetmap.josm.tools.CheckParameterUtil;
import org.openstreetmap.josm.tools.I18n;
import org.openstreetmap.josm.tools.ImageProvider;
import org.openstreetmap.josm.tools.OpenBrowser;
import org.openstreetmap.josm.tools.OsmUrlToBounds;
import org.openstreetmap.josm.tools.PlatformHook;
import org.openstreetmap.josm.tools.PlatformHookOsx;
import org.openstreetmap.josm.tools.PlatformHookUnixoid;
import org.openstreetmap.josm.tools.PlatformHookWindows;
import org.openstreetmap.josm.tools.Shortcut;
import org.openstreetmap.josm.tools.Utils;
import org.openstreetmap.josm.tools.WindowGeometry;
/**
* Abstract class holding various static global variables and methods used in large parts of JOSM application.
* @since 98
*/
abstract public class Main {
/**
* Replies true if JOSM currently displays a map view. False, if it doesn't, i.e. if
* it only shows the MOTD panel.
*
* @return true if JOSM currently displays a map view
*/
static public boolean isDisplayingMapView() {
if (map == null) return false;
if (map.mapView == null) return false;
return true;
}
/**
* Global parent component for all dialogs and message boxes
*/
public static Component parent;
/**
* Global application.
*/
public static Main main;
/**
* Command-line arguments used to run the application.
*/
public static String[] commandLineArgs;
/**
* The worker thread slave. This is for executing all long and intensive
* calculations. The executed runnables are guaranteed to be executed separately
* and sequential.
*/
public final static ExecutorService worker = new ProgressMonitorExecutor();
/**
* Global application preferences
*/
public static Preferences pref;
/**
* The global paste buffer.
*/
public static final PrimitiveDeepCopy pasteBuffer = new PrimitiveDeepCopy();
/**
* The layer source from which {@link Main#pasteBuffer} data comes from.
*/
public static Layer pasteSource;
/**
* The MapFrame. Use {@link Main#setMapFrame} to set or clear it.
*/
public static MapFrame map;
/**
* Set to true, when in applet mode
*/
public static boolean applet = false;
/**
* The toolbar preference control to register new actions.
*/
public static ToolbarPreferences toolbar;
/**
* The commands undo/redo handler.
*/
public UndoRedoHandler undoRedo = new UndoRedoHandler();
/**
* The progress monitor being currently displayed.
*/
public static PleaseWaitProgressMonitor currentProgressMonitor;
/**
* The main menu bar at top of screen.
*/
public MainMenu menu;
/**
* The data validation handler.
*/
public OsmValidator validator;
/**
* The MOTD Layer.
*/
private GettingStarted gettingStarted = new GettingStarted();
private static final Collection mapFrameListeners = new ArrayList();
/**
* Logging level (3 = debug, 2 = info, 1 = warn, 0 = none).
*/
static public int log_level = 2;
/**
* Print a warning message if logging is on.
* @param msg The message to print.
*/
static public void warn(String msg) {
if (log_level < 1)
return;
System.err.println(tr("WARNING: {0}", msg));
}
/**
* Print an informational message if logging is on.
* @param msg The message to print.
*/
static public void info(String msg) {
if (log_level < 2)
return;
System.err.println(tr("INFO: {0}", msg));
}
/**
* Print an debug message if logging is on.
* @param msg The message to print.
*/
static public void debug(String msg) {
if (log_level < 3)
return;
System.err.println(tr("DEBUG: {0}", msg));
}
/**
* Print a formated warning message if logging is on. Calls {@link MessageFormat#format}
* function to format text.
* @param msg The formated message to print.
* @param objects The objects to insert into format string.
*/
static public void warn(String msg, Object... objects) {
warn(MessageFormat.format(msg, objects));
}
/**
* Print a formated informational message if logging is on. Calls {@link MessageFormat#format}
* function to format text.
* @param msg The formated message to print.
* @param objects The objects to insert into format string.
*/
static public void info(String msg, Object... objects) {
info(MessageFormat.format(msg, objects));
}
/**
* Print a formated debug message if logging is on. Calls {@link MessageFormat#format}
* function to format text.
* @param msg The formated message to print.
* @param objects The objects to insert into format string.
*/
static public void debug(String msg, Object... objects) {
debug(MessageFormat.format(msg, objects));
}
/**
* Platform specific code goes in here.
* Plugins may replace it, however, some hooks will be called before any plugins have been loeaded.
* So if you need to hook into those early ones, split your class and send the one with the early hooks
* to the JOSM team for inclusion.
*/
public static PlatformHook platform;
/**
* Whether or not the java vm is openjdk
* We use this to work around openjdk bugs
*/
public static boolean isOpenjdk;
/**
* Set or clear (if passed null) the map.
* @param map The map to set {@link Main#map} to. Can be null.
*/
public final void setMapFrame(final MapFrame map) {
MapFrame old = Main.map;
panel.setVisible(false);
panel.removeAll();
if (map != null) {
map.fillPanel(panel);
} else {
old.destroy();
panel.add(gettingStarted, BorderLayout.CENTER);
}
panel.setVisible(true);
redoUndoListener.commandChanged(0,0);
Main.map = map;
for (MapFrameListener listener : mapFrameListeners ) {
listener.mapFrameInitialized(old, map);
}
if (map == null && currentProgressMonitor != null) {
currentProgressMonitor.showForegroundDialog();
}
}
/**
* Remove the specified layer from the map. If it is the last layer,
* remove the map as well.
* @param layer The layer to remove
*/
public final synchronized void removeLayer(final Layer layer) {
if (map != null) {
map.mapView.removeLayer(layer);
if (map != null && map.mapView.getAllLayers().isEmpty()) {
setMapFrame(null);
}
}
}
private static InitStatusListener initListener = null;
public static interface InitStatusListener {
void updateStatus(String event);
}
public static void setInitStatusListener(InitStatusListener listener) {
initListener = listener;
}
public Main() {
main = this;
isOpenjdk = System.getProperty("java.vm.name").toUpperCase().indexOf("OPENJDK") != -1;
if (initListener != null) {
initListener.updateStatus(tr("Executing platform startup hook"));
}
platform.startupHook();
if (initListener != null) {
initListener.updateStatus(tr("Building main menu"));
}
contentPanePrivate.add(panel, BorderLayout.CENTER);
panel.add(gettingStarted, BorderLayout.CENTER);
menu = new MainMenu();
undoRedo.addCommandQueueListener(redoUndoListener);
// creating toolbar
contentPanePrivate.add(toolbar.control, BorderLayout.NORTH);
registerActionShortcut(menu.help, Shortcut.registerShortcut("system:help", tr("Help"),
KeyEvent.VK_F1, Shortcut.DIRECT));
// contains several initialization tasks to be executed (in parallel) by a ExecutorService
List> tasks = new ArrayList>();
tasks.add(new Callable() {
@Override
public Void call() throws Exception {
// We try to establish an API connection early, so that any API
// capabilities are already known to the editor instance. However
// if it goes wrong that's not critical at this stage.
if (initListener != null) {
initListener.updateStatus(tr("Initializing OSM API"));
}
try {
OsmApi.getOsmApi().initialize(null, true);
} catch (Exception x) {
// ignore any exception here.
}
return null;
}
});
tasks.add(new Callable() {
@Override
public Void call() throws Exception {
if (initListener != null) {
initListener.updateStatus(tr("Initializing presets"));
}
TaggingPresetPreference.initialize();
// some validator tests require the presets to be initialized
// TODO remove this dependency for parallel initialization
if (initListener != null) {
initListener.updateStatus(tr("Initializing validator"));
}
validator = new OsmValidator();
MapView.addLayerChangeListener(validator);
return null;
}
});
tasks.add(new Callable() {
@Override
public Void call() throws Exception {
if (initListener != null) {
initListener.updateStatus(tr("Initializing map styles"));
}
MapPaintPreference.initialize();
return null;
}
});
tasks.add(new Callable() {
@Override
public Void call() throws Exception {
if (initListener != null) {
initListener.updateStatus(tr("Loading imagery preferences"));
}
ImageryPreference.initialize();
return null;
}
});
try {
for (Future i : Executors.newFixedThreadPool(
Runtime.getRuntime().availableProcessors()).invokeAll(tasks)) {
i.get();
}
} catch (Exception ex) {
throw new RuntimeException(ex);
}
// hooks for the jmapviewer component
FeatureAdapter.registerBrowserAdapter(new FeatureAdapter.BrowserAdapter() {
@Override
public void openLink(String url) {
OpenBrowser.displayUrl(url);
}
});
FeatureAdapter.registerTranslationAdapter(I18n.getTranslationAdapter());
if (initListener != null) {
initListener.updateStatus(tr("Updating user interface"));
}
toolbar.refreshToolbarControl();
toolbar.control.updateUI();
contentPanePrivate.updateUI();
}
/**
* Add a new layer to the map. If no map exists, create one.
*/
public final synchronized void addLayer(final Layer layer) {
boolean noMap = map == null;
if (noMap) {
createMapFrame(layer, null);
}
layer.hookUpMapView();
map.mapView.addLayer(layer);
if (noMap) {
Main.map.setVisible(true);
}
}
public synchronized void createMapFrame(Layer firstLayer, ViewportData viewportData) {
MapFrame mapFrame = new MapFrame(contentPanePrivate, viewportData);
setMapFrame(mapFrame);
if (firstLayer != null) {
mapFrame.selectMapMode((MapMode)mapFrame.getDefaultButtonAction(), firstLayer);
}
mapFrame.initializeDialogsPane();
// bootstrapping problem: make sure the layer list dialog is going to
// listen to change events of the very first layer
//
if (firstLayer != null) {
firstLayer.addPropertyChangeListener(LayerListDialog.getInstance().getModel());
}
}
/**
* Replies true if there is an edit layer
*
* @return true if there is an edit layer
*/
public boolean hasEditLayer() {
if (getEditLayer() == null) return false;
return true;
}
/**
* Replies the current edit layer
*
* @return the current edit layer. null, if no current edit layer exists
*/
public OsmDataLayer getEditLayer() {
if (map == null) return null;
if (map.mapView == null) return null;
return map.mapView.getEditLayer();
}
/**
* Replies the current data set.
*
* @return the current data set. null, if no current data set exists
*/
public DataSet getCurrentDataSet() {
if (!hasEditLayer()) return null;
return getEditLayer().data;
}
/**
* Returns the currently active layer
*
* @return the currently active layer. null, if currently no active layer exists
*/
public Layer getActiveLayer() {
if (map == null) return null;
if (map.mapView == null) return null;
return map.mapView.getActiveLayer();
}
protected static final JPanel contentPanePrivate = new JPanel(new BorderLayout());
public static void redirectToMainContentPane(JComponent source) {
RedirectInputMap.redirect(source, contentPanePrivate);
}
public static void registerActionShortcut(JosmAction action) {
registerActionShortcut(action, action.getShortcut());
}
public static void registerActionShortcut(Action action, Shortcut shortcut) {
KeyStroke keyStroke = shortcut.getKeyStroke();
if (keyStroke == null)
return;
InputMap inputMap = contentPanePrivate.getInputMap(JComponent.WHEN_IN_FOCUSED_WINDOW);
Object existing = inputMap.get(keyStroke);
if (existing != null && !existing.equals(action)) {
System.out.println(String.format("Keystroke %s is already assigned to %s, will be overridden by %s", keyStroke, existing, action));
}
inputMap.put(keyStroke, action);
contentPanePrivate.getActionMap().put(action, action);
}
public static void unregisterShortcut(Shortcut shortcut) {
contentPanePrivate.getInputMap(JComponent.WHEN_IN_FOCUSED_WINDOW).remove(shortcut.getKeyStroke());
}
public static void unregisterActionShortcut(JosmAction action) {
unregisterActionShortcut(action, action.getShortcut());
}
public static void unregisterActionShortcut(Action action, Shortcut shortcut) {
unregisterShortcut(shortcut);
contentPanePrivate.getActionMap().remove(action);
}
/**
* Replies the registered action for the given shortcut
* @param shortcut The shortcut to look for
* @return the registered action for the given shortcut
* @since 5696
*/
public static Action getRegisteredActionShortcut(Shortcut shortcut) {
KeyStroke keyStroke = shortcut.getKeyStroke();
if (keyStroke == null)
return null;
Object action = contentPanePrivate.getInputMap(JComponent.WHEN_IN_FOCUSED_WINDOW).get(keyStroke);
if (action instanceof Action)
return (Action) action;
return null;
}
///////////////////////////////////////////////////////////////////////////
// Implementation part
///////////////////////////////////////////////////////////////////////////
/**
* Global panel.
*/
public static final JPanel panel = new JPanel(new BorderLayout());
protected static WindowGeometry geometry;
protected static int windowState = JFrame.NORMAL;
private final CommandQueueListener redoUndoListener = new CommandQueueListener(){
@Override
public void commandChanged(final int queueSize, final int redoSize) {
menu.undo.setEnabled(queueSize > 0);
menu.redo.setEnabled(redoSize > 0);
}
};
/**
* Should be called before the main constructor to setup some parameter stuff
* @param args The parsed argument list.
*/
public static void preConstructorInit(Map