source: josm/trunk/src/org/openstreetmap/josm/Main.java@ 8404

Last change on this file since 8404 was 8404, checked in by Don-vip, 9 years ago

When doing a String.toLowerCase()/toUpperCase() call, use a Locale. This avoids problems with certain locales, i.e. Lithuanian or Turkish. See PMD UseLocaleWithCaseConversions rule and String.toLowerCase() javadoc.
  • Property svn:eol-style set to native
File size: 63.1 KB
Line 
1// License: GPL. For details, see LICENSE file.
2package org.openstreetmap.josm;
3
4import static org.openstreetmap.josm.tools.I18n.tr;
5
6import java.awt.BorderLayout;
7import java.awt.Component;
8import java.awt.GridBagConstraints;
9import java.awt.GridBagLayout;
10import java.awt.Window;
11import java.awt.event.ComponentEvent;
12import java.awt.event.ComponentListener;
13import java.awt.event.KeyEvent;
14import java.awt.event.WindowAdapter;
15import java.awt.event.WindowEvent;
16import java.io.File;
17import java.lang.ref.WeakReference;
18import java.net.URI;
19import java.net.URISyntaxException;
20import java.net.URL;
21import java.text.MessageFormat;
22import java.util.ArrayList;
23import java.util.Arrays;
24import java.util.Collection;
25import java.util.Collections;
26import java.util.HashMap;
27import java.util.HashSet;
28import java.util.Iterator;
29import java.util.List;
30import java.util.Locale;
31import java.util.Map;
32import java.util.Objects;
33import java.util.Set;
34import java.util.StringTokenizer;
35import java.util.concurrent.Callable;
36import java.util.concurrent.ExecutorService;
37import java.util.concurrent.Executors;
38import java.util.concurrent.Future;
39import java.util.logging.Handler;
40import java.util.logging.Level;
41import java.util.logging.LogRecord;
42import java.util.logging.Logger;
43
44import javax.swing.Action;
45import javax.swing.InputMap;
46import javax.swing.JComponent;
47import javax.swing.JFrame;
48import javax.swing.JOptionPane;
49import javax.swing.JPanel;
50import javax.swing.JTextArea;
51import javax.swing.KeyStroke;
52import javax.swing.LookAndFeel;
53import javax.swing.UIManager;
54import javax.swing.UnsupportedLookAndFeelException;
55
56import org.openstreetmap.gui.jmapviewer.FeatureAdapter;
57import org.openstreetmap.josm.actions.JosmAction;
58import org.openstreetmap.josm.actions.OpenFileAction;
59import org.openstreetmap.josm.actions.downloadtasks.DownloadGpsTask;
60import org.openstreetmap.josm.actions.downloadtasks.DownloadOsmTask;
61import org.openstreetmap.josm.actions.downloadtasks.DownloadTask;
62import org.openstreetmap.josm.actions.downloadtasks.PostDownloadHandler;
63import org.openstreetmap.josm.actions.mapmode.DrawAction;
64import org.openstreetmap.josm.actions.mapmode.MapMode;
65import org.openstreetmap.josm.actions.search.SearchAction;
66import org.openstreetmap.josm.data.Bounds;
67import org.openstreetmap.josm.data.Preferences;
68import org.openstreetmap.josm.data.ProjectionBounds;
69import org.openstreetmap.josm.data.UndoRedoHandler;
70import org.openstreetmap.josm.data.ViewportData;
71import org.openstreetmap.josm.data.cache.JCSCacheManager;
72import org.openstreetmap.josm.data.coor.CoordinateFormat;
73import org.openstreetmap.josm.data.coor.LatLon;
74import org.openstreetmap.josm.data.osm.DataSet;
75import org.openstreetmap.josm.data.osm.OsmPrimitive;
76import org.openstreetmap.josm.data.osm.PrimitiveDeepCopy;
77import org.openstreetmap.josm.data.osm.visitor.BoundingXYVisitor;
78import org.openstreetmap.josm.data.projection.Projection;
79import org.openstreetmap.josm.data.projection.ProjectionChangeListener;
80import org.openstreetmap.josm.data.validation.OsmValidator;
81import org.openstreetmap.josm.gui.GettingStarted;
82import org.openstreetmap.josm.gui.MainApplication.Option;
83import org.openstreetmap.josm.gui.MainMenu;
84import org.openstreetmap.josm.gui.MapFrame;
85import org.openstreetmap.josm.gui.MapFrameListener;
86import org.openstreetmap.josm.gui.MapView;
87import org.openstreetmap.josm.gui.dialogs.LayerListDialog;
88import org.openstreetmap.josm.gui.help.HelpUtil;
89import org.openstreetmap.josm.gui.io.SaveLayersDialog;
90import org.openstreetmap.josm.gui.layer.AbstractModifiableLayer;
91import org.openstreetmap.josm.gui.layer.Layer;
92import org.openstreetmap.josm.gui.layer.OsmDataLayer;
93import org.openstreetmap.josm.gui.layer.OsmDataLayer.CommandQueueListener;
94import org.openstreetmap.josm.gui.preferences.ToolbarPreferences;
95import org.openstreetmap.josm.gui.preferences.imagery.ImageryPreference;
96import org.openstreetmap.josm.gui.preferences.map.MapPaintPreference;
97import org.openstreetmap.josm.gui.preferences.projection.ProjectionPreference;
98import org.openstreetmap.josm.gui.progress.PleaseWaitProgressMonitor;
99import org.openstreetmap.josm.gui.progress.ProgressMonitorExecutor;
100import org.openstreetmap.josm.gui.tagging.TaggingPresets;
101import org.openstreetmap.josm.gui.util.RedirectInputMap;
102import org.openstreetmap.josm.gui.widgets.JMultilineLabel;
103import org.openstreetmap.josm.io.FileWatcher;
104import org.openstreetmap.josm.io.OnlineResource;
105import org.openstreetmap.josm.io.OsmApi;
106import org.openstreetmap.josm.plugins.PluginHandler;
107import org.openstreetmap.josm.tools.CheckParameterUtil;
108import org.openstreetmap.josm.tools.I18n;
109import org.openstreetmap.josm.tools.ImageProvider;
110import org.openstreetmap.josm.tools.OpenBrowser;
111import org.openstreetmap.josm.tools.OsmUrlToBounds;
112import org.openstreetmap.josm.tools.PlatformHook;
113import org.openstreetmap.josm.tools.PlatformHookOsx;
114import org.openstreetmap.josm.tools.PlatformHookUnixoid;
115import org.openstreetmap.josm.tools.PlatformHookWindows;
116import org.openstreetmap.josm.tools.Shortcut;
117import org.openstreetmap.josm.tools.Utils;
118import org.openstreetmap.josm.tools.WindowGeometry;
119
120/**
121 * Abstract class holding various static global variables and methods used in large parts of JOSM application.
122 * @since 98
123 */
124public abstract class Main {
125
126 /**
127 * The JOSM website URL.
128 * @since 6897 (was public from 6143 to 6896)
129 */
130 private static final String JOSM_WEBSITE = "https://josm.openstreetmap.de";
131
132 /**
133 * The OSM website URL.
134 * @since 6897 (was public from 6453 to 6896)
135 */
136 private static final String OSM_WEBSITE = "https://www.openstreetmap.org";
137
138 /**
139 * Replies true if JOSM currently displays a map view. False, if it doesn't, i.e. if
140 * it only shows the MOTD panel.
141 *
142 * @return <code>true</code> if JOSM currently displays a map view
143 */
144 public static boolean isDisplayingMapView() {
145 if (map == null) return false;
146 if (map.mapView == null) return false;
147 return true;
148 }
149
150 /**
151 * Global parent component for all dialogs and message boxes
152 */
153 public static Component parent;
154
155 /**
156 * Global application.
157 */
158 public static volatile Main main;
159
160 /**
161 * Command-line arguments used to run the application.
162 */
163 protected static final List<String> COMMAND_LINE_ARGS = new ArrayList<>();
164
165 /**
166 * The worker thread slave. This is for executing all long and intensive
167 * calculations. The executed runnables are guaranteed to be executed separately
168 * and sequential.
169 */
170 public static final ExecutorService worker = new ProgressMonitorExecutor();
171
172 /**
173 * Global application preferences
174 */
175 public static Preferences pref;
176
177 /**
178 * The global paste buffer.
179 */
180 public static final PrimitiveDeepCopy pasteBuffer = new PrimitiveDeepCopy();
181
182 /**
183 * The layer source from which {@link Main#pasteBuffer} data comes from.
184 */
185 public static Layer pasteSource;
186
187 /**
188 * The MapFrame. Use {@link Main#setMapFrame} to set or clear it.
189 */
190 public static MapFrame map;
191
192 /**
193 * The toolbar preference control to register new actions.
194 */
195 public static volatile ToolbarPreferences toolbar;
196
197 /**
198 * The commands undo/redo handler.
199 */
200 public final UndoRedoHandler undoRedo = new UndoRedoHandler();
201
202 /**
203 * The progress monitor being currently displayed.
204 */
205 public static PleaseWaitProgressMonitor currentProgressMonitor;
206
207 /**
208 * The main menu bar at top of screen.
209 */
210 public MainMenu menu;
211
212 /**
213 * The data validation handler.
214 */
215 public OsmValidator validator;
216
217 /**
218 * The file watcher service.
219 */
220 public static final FileWatcher fileWatcher = new FileWatcher();
221
222 /**
223 * The MOTD Layer.
224 */
225 public final GettingStarted gettingStarted = new GettingStarted();
226
227 private static final Collection<MapFrameListener> mapFrameListeners = new ArrayList<>();
228
229 protected static final Map<String, Throwable> NETWORK_ERRORS = new HashMap<>();
230
231 // First lines of last 5 error and warning messages, used for bug reports
232 private static final List<String> ERRORS_AND_WARNINGS = Collections.<String>synchronizedList(new ArrayList<String>());
233
234 private static final Set<OnlineResource> OFFLINE_RESOURCES = new HashSet<>();
235
236 /**
237 * Logging level (5 = trace, 4 = debug, 3 = info, 2 = warn, 1 = error, 0 = none).
238 * @since 6248
239 */
240 public static int logLevel = 3;
241
242 private static void rememberWarnErrorMsg(String msg) {
243 // Only remember first line of message
244 int idx = msg.indexOf('\n');
245 if (idx > 0) {
246 ERRORS_AND_WARNINGS.add(msg.substring(0, idx));
247 } else {
248 ERRORS_AND_WARNINGS.add(msg);
249 }
250 // Only keep 5 lines to avoid memory leak and incomplete stacktraces in bug reports
251 while (ERRORS_AND_WARNINGS.size() > 5) {
252 ERRORS_AND_WARNINGS.remove(0);
253 }
254 }
255
256 /**
257 * Replies the first lines of last 10 error and warning messages, used for bug reports
258 * @return the first lines of last 10 error and warning messages
259 * @since 7420
260 */
261 public static final Collection<String> getLastErrorAndWarnings() {
262 return Collections.unmodifiableList(ERRORS_AND_WARNINGS);
263 }
264
265 /**
266 * Prints an error message if logging is on.
267 * @param msg The message to print.
268 * @since 6248
269 */
270 public static void error(String msg) {
271 if (logLevel < 1)
272 return;
273 if (msg != null && !msg.isEmpty()) {
274 System.err.println(tr("ERROR: {0}", msg));
275 rememberWarnErrorMsg("E: "+msg);
276 }
277 }
278
279 /**
280 * Prints a warning message if logging is on.
281 * @param msg The message to print.
282 */
283 public static void warn(String msg) {
284 if (logLevel < 2)
285 return;
286 if (msg != null && !msg.isEmpty()) {
287 System.err.println(tr("WARNING: {0}", msg));
288 rememberWarnErrorMsg("W: "+msg);
289 }
290 }
291
292 /**
293 * Prints an informational message if logging is on.
294 * @param msg The message to print.
295 */
296 public static void info(String msg) {
297 if (logLevel < 3)
298 return;
299 if (msg != null && !msg.isEmpty()) {
300 System.out.println(tr("INFO: {0}", msg));
301 }
302 }
303
304 /**
305 * Prints a debug message if logging is on.
306 * @param msg The message to print.
307 */
308 public static void debug(String msg) {
309 if (logLevel < 4)
310 return;
311 if (msg != null && !msg.isEmpty()) {
312 System.out.println(tr("DEBUG: {0}", msg));
313 }
314 }
315
316 /**
317 * Prints a trace message if logging is on.
318 * @param msg The message to print.
319 */
320 public static void trace(String msg) {
321 if (logLevel < 5)
322 return;
323 if (msg != null && !msg.isEmpty()) {
324 System.out.print("TRACE: ");
325 System.out.println(msg);
326 }
327 }
328
329 /**
330 * Determines if debug log level is enabled.
331 * Useful to avoid costly construction of debug messages when not enabled.
332 * @return {@code true} if log level is at least debug, {@code false} otherwise
333 * @since 6852
334 */
335 public static boolean isDebugEnabled() {
336 return logLevel >= 4;
337 }
338
339 /**
340 * Determines if trace log level is enabled.
341 * Useful to avoid costly construction of trace messages when not enabled.
342 * @return {@code true} if log level is at least trace, {@code false} otherwise
343 * @since 6852
344 */
345 public static boolean isTraceEnabled() {
346 return logLevel >= 5;
347 }
348
349 /**
350 * Prints a formatted error message if logging is on. Calls {@link MessageFormat#format}
351 * function to format text.
352 * @param msg The formatted message to print.
353 * @param objects The objects to insert into format string.
354 * @since 6248
355 */
356 public static void error(String msg, Object... objects) {
357 error(MessageFormat.format(msg, objects));
358 }
359
360 /**
361 * Prints a formatted warning message if logging is on. Calls {@link MessageFormat#format}
362 * function to format text.
363 * @param msg The formatted message to print.
364 * @param objects The objects to insert into format string.
365 */
366 public static void warn(String msg, Object... objects) {
367 warn(MessageFormat.format(msg, objects));
368 }
369
370 /**
371 * Prints a formatted informational message if logging is on. Calls {@link MessageFormat#format}
372 * function to format text.
373 * @param msg The formatted message to print.
374 * @param objects The objects to insert into format string.
375 */
376 public static void info(String msg, Object... objects) {
377 info(MessageFormat.format(msg, objects));
378 }
379
380 /**
381 * Prints a formatted debug message if logging is on. Calls {@link MessageFormat#format}
382 * function to format text.
383 * @param msg The formatted message to print.
384 * @param objects The objects to insert into format string.
385 */
386 public static void debug(String msg, Object... objects) {
387 debug(MessageFormat.format(msg, objects));
388 }
389
390 /**
391 * Prints a formatted trace message if logging is on. Calls {@link MessageFormat#format}
392 * function to format text.
393 * @param msg The formatted message to print.
394 * @param objects The objects to insert into format string.
395 */
396 public static void trace(String msg, Object... objects) {
397 trace(MessageFormat.format(msg, objects));
398 }
399
400 /**
401 * Prints an error message for the given Throwable.
402 * @param t The throwable object causing the error
403 * @since 6248
404 */
405 public static void error(Throwable t) {
406 error(t, true);
407 }
408
409 /**
410 * Prints a warning message for the given Throwable.
411 * @param t The throwable object causing the error
412 * @since 6248
413 */
414 public static void warn(Throwable t) {
415 warn(t, true);
416 }
417
418 /**
419 * Prints an error message for the given Throwable.
420 * @param t The throwable object causing the error
421 * @param stackTrace {@code true}, if the stacktrace should be displayed
422 * @since 6642
423 */
424 public static void error(Throwable t, boolean stackTrace) {
425 error(getErrorMessage(t));
426 if (stackTrace) {
427 t.printStackTrace();
428 }
429 }
430
431 /**
432 * Prints a warning message for the given Throwable.
433 * @param t The throwable object causing the error
434 * @param stackTrace {@code true}, if the stacktrace should be displayed
435 * @since 6642
436 */
437 public static void warn(Throwable t, boolean stackTrace) {
438 warn(getErrorMessage(t));
439 if (stackTrace) {
440 t.printStackTrace();
441 }
442 }
443
444 /**
445 * Returns a human-readable message of error, also usable for developers.
446 * @param t The error
447 * @return The human-readable error message
448 * @since 6642
449 */
450 public static String getErrorMessage(Throwable t) {
451 if (t == null) {
452 return null;
453 }
454 StringBuilder sb = new StringBuilder(t.getClass().getName());
455 String msg = t.getMessage();
456 if (msg != null) {
457 sb.append(": ").append(msg.trim());
458 }
459 Throwable cause = t.getCause();
460 if (cause != null && !cause.equals(t)) {
461 sb.append(". ").append(tr("Cause: ")).append(getErrorMessage(cause));
462 }
463 return sb.toString();
464 }
465
466 /**
467 * Platform specific code goes in here.
468 * Plugins may replace it, however, some hooks will be called before any plugins have been loeaded.
469 * So if you need to hook into those early ones, split your class and send the one with the early hooks
470 * to the JOSM team for inclusion.
471 */
472 public static volatile PlatformHook platform;
473
474 /**
475 * Whether or not the java vm is openjdk
476 * We use this to work around openjdk bugs
477 */
478 public static boolean isOpenjdk;
479
480 /**
481 * Initializes {@code Main.pref} in normal application context.
482 * @since 6471
483 */
484 public static void initApplicationPreferences() {
485 Main.pref = new Preferences();
486 }
487
488 /**
489 * Set or clear (if passed <code>null</code>) the map.
490 * @param map The map to set {@link Main#map} to. Can be null.
491 */
492 public final void setMapFrame(final MapFrame map) {
493 MapFrame old = Main.map;
494 panel.setVisible(false);
495 panel.removeAll();
496 if (map != null) {
497 map.fillPanel(panel);
498 } else {
499 old.destroy();
500 panel.add(gettingStarted, BorderLayout.CENTER);
501 }
502 panel.setVisible(true);
503 redoUndoListener.commandChanged(0,0);
504
505 Main.map = map;
506
507 for (MapFrameListener listener : mapFrameListeners ) {
508 listener.mapFrameInitialized(old, map);
509 }
510 if (map == null && currentProgressMonitor != null) {
511 currentProgressMonitor.showForegroundDialog();
512 }
513 }
514
515 /**
516 * Remove the specified layer from the map. If it is the last layer,
517 * remove the map as well.
518 * @param layer The layer to remove
519 */
520 public final synchronized void removeLayer(final Layer layer) {
521 if (map != null) {
522 map.mapView.removeLayer(layer);
523 if (isDisplayingMapView() && map.mapView.getAllLayers().isEmpty()) {
524 setMapFrame(null);
525 }
526 }
527 }
528
529 private static volatile InitStatusListener initListener = null;
530
531 public static interface InitStatusListener {
532
533 void updateStatus(String event);
534 }
535
536 public static void setInitStatusListener(InitStatusListener listener) {
537 initListener = listener;
538 }
539
540 /**
541 * Constructs new {@code Main} object. A lot of global variables are initialized here.
542 */
543 public Main() {
544 main = this;
545 isOpenjdk = System.getProperty("java.vm.name").toUpperCase(Locale.ENGLISH).indexOf("OPENJDK") != -1;
546
547 if (initListener != null) {
548 initListener.updateStatus(tr("Executing platform startup hook"));
549 }
550 platform.startupHook();
551
552 if (initListener != null) {
553 initListener.updateStatus(tr("Building main menu"));
554 }
555 contentPanePrivate.add(panel, BorderLayout.CENTER);
556 panel.add(gettingStarted, BorderLayout.CENTER);
557 menu = new MainMenu();
558
559 undoRedo.addCommandQueueListener(redoUndoListener);
560
561 // creating toolbar
562 contentPanePrivate.add(toolbar.control, BorderLayout.NORTH);
563
564 registerActionShortcut(menu.help, Shortcut.registerShortcut("system:help", tr("Help"),
565 KeyEvent.VK_F1, Shortcut.DIRECT));
566
567 // contains several initialization tasks to be executed (in parallel) by a ExecutorService
568 List<Callable<Void>> tasks = new ArrayList<>();
569
570 tasks.add(new InitializationTask(tr("Initializing OSM API")) {
571
572 @Override
573 public void initialize() throws Exception {
574 // We try to establish an API connection early, so that any API
575 // capabilities are already known to the editor instance. However
576 // if it goes wrong that's not critical at this stage.
577 try {
578 OsmApi.getOsmApi().initialize(null, true);
579 } catch (Exception e) {
580 Main.warn(getErrorMessage(Utils.getRootCause(e)));
581 }
582 }
583 });
584
585 tasks.add(new InitializationTask(tr("Initializing validator")) {
586
587 @Override
588 public void initialize() throws Exception {
589 validator = new OsmValidator();
590 MapView.addLayerChangeListener(validator);
591 }
592 });
593
594 tasks.add(new InitializationTask(tr("Initializing presets")) {
595
596 @Override
597 public void initialize() throws Exception {
598 TaggingPresets.initialize();
599 }
600 });
601
602 tasks.add(new InitializationTask(tr("Initializing map styles")) {
603
604 @Override
605 public void initialize() throws Exception {
606 MapPaintPreference.initialize();
607 }
608 });
609
610 tasks.add(new InitializationTask(tr("Loading imagery preferences")) {
611
612 @Override
613 public void initialize() throws Exception {
614 ImageryPreference.initialize();
615 }
616 });
617
618 try {
619 for (Future<Void> i : Executors.newFixedThreadPool(
620 Runtime.getRuntime().availableProcessors()).invokeAll(tasks)) {
621 i.get();
622 }
623 } catch (Exception ex) {
624 throw new RuntimeException(ex);
625 }
626
627 // hooks for the jmapviewer component
628 FeatureAdapter.registerBrowserAdapter(new FeatureAdapter.BrowserAdapter() {
629 @Override
630 public void openLink(String url) {
631 OpenBrowser.displayUrl(url);
632 }
633 });
634 FeatureAdapter.registerTranslationAdapter(I18n.getTranslationAdapter());
635 FeatureAdapter.registerLoggingAdapter(new FeatureAdapter.LoggingAdapter() {
636 @Override
637 public Logger getLogger(String name) {
638 Logger logger = Logger.getAnonymousLogger();
639 logger.setUseParentHandlers(false);
640 logger.setLevel(Level.ALL);
641 if (logger.getHandlers().length == 0) {
642 logger.addHandler(new Handler() {
643 @Override
644 public void publish(LogRecord record) {
645 String msg = MessageFormat.format(record.getMessage(), record.getParameters());
646 if (record.getLevel().intValue() >= Level.SEVERE.intValue()) {
647 Main.error(msg);
648 } else if (record.getLevel().intValue() >= Level.WARNING.intValue()) {
649 Main.warn(msg);
650 } else if (record.getLevel().intValue() >= Level.INFO.intValue()) {
651 Main.info(msg);
652 } else if (record.getLevel().intValue() >= Level.FINE.intValue()) {
653 Main.debug(msg);
654 } else {
655 Main.trace(msg);
656 }
657 }
658
659 @Override
660 public void flush() {
661 }
662
663 @Override
664 public void close() {
665 }
666 });
667 }
668 return logger;
669 }
670 });
671
672 if (initListener != null) {
673 initListener.updateStatus(tr("Updating user interface"));
674 }
675
676 toolbar.refreshToolbarControl();
677
678 toolbar.control.updateUI();
679 contentPanePrivate.updateUI();
680 }
681
682 private abstract class InitializationTask implements Callable<Void> {
683
684 private final String name;
685
686 protected InitializationTask(String name) {
687 this.name = name;
688 }
689
690 public abstract void initialize() throws Exception;
691
692 @Override
693 public Void call() throws Exception {
694 if (initListener != null) {
695 initListener.updateStatus(name);
696 }
697 final long startTime = System.currentTimeMillis();
698 initialize();
699 if (isDebugEnabled()) {
700 final long elapsedTime = System.currentTimeMillis() - startTime;
701 Main.debug(tr("{0} completed in {1}", name, Utils.getDurationString(elapsedTime)));
702 }
703 return null;
704 }
705 }
706
707 /**
708 * Add a new layer to the map.
709 *
710 * If no map exists, create one.
711 *
712 * @param layer the layer
713 *
714 * @see #addLayer(Layer, ProjectionBounds)
715 * @see #addLayer(Layer, ViewportData)
716 */
717 public final void addLayer(final Layer layer) {
718 BoundingXYVisitor v = new BoundingXYVisitor();
719 layer.visitBoundingBox(v);
720 addLayer(layer, v.getBounds());
721 }
722
723 /**
724 * Add a new layer to the map.
725 *
726 * If no map exists, create one.
727 *
728 * @param layer the layer
729 * @param bounds the bounds of the layer (target zoom area); can be null, then
730 * the viewport isn't changed
731 */
732 public final synchronized void addLayer(final Layer layer, ProjectionBounds bounds) {
733 addLayer(layer, bounds == null ? null : new ViewportData(bounds));
734 }
735
736 /**
737 * Add a new layer to the map.
738 *
739 * If no map exists, create one.
740 *
741 * @param layer the layer
742 * @param viewport the viewport to zoom to; can be null, then the viewport
743 * isn't changed
744 */
745 public final synchronized void addLayer(final Layer layer, ViewportData viewport) {
746 boolean noMap = map == null;
747 if (noMap) {
748 createMapFrame(layer, viewport);
749 }
750 layer.hookUpMapView();
751 map.mapView.addLayer(layer);
752 if (noMap) {
753 Main.map.setVisible(true);
754 } else if (viewport != null) {
755 Main.map.mapView.zoomTo(viewport);
756 }
757 }
758
759 public synchronized void createMapFrame(Layer firstLayer, ViewportData viewportData) {
760 MapFrame mapFrame = new MapFrame(contentPanePrivate, viewportData);
761 setMapFrame(mapFrame);
762 if (firstLayer != null) {
763 mapFrame.selectMapMode((MapMode)mapFrame.getDefaultButtonAction(), firstLayer);
764 }
765 mapFrame.initializeDialogsPane();
766 // bootstrapping problem: make sure the layer list dialog is going to
767 // listen to change events of the very first layer
768 //
769 if (firstLayer != null) {
770 firstLayer.addPropertyChangeListener(LayerListDialog.getInstance().getModel());
771 }
772 }
773
774 /**
775 * Replies <code>true</code> if there is an edit layer
776 *
777 * @return <code>true</code> if there is an edit layer
778 */
779 public boolean hasEditLayer() {
780 if (getEditLayer() == null) return false;
781 return true;
782 }
783
784 /**
785 * Replies the current edit layer
786 *
787 * @return the current edit layer. <code>null</code>, if no current edit layer exists
788 */
789 public OsmDataLayer getEditLayer() {
790 if (!isDisplayingMapView()) return null;
791 return map.mapView.getEditLayer();
792 }
793
794 /**
795 * Replies the current data set.
796 *
797 * @return the current data set. <code>null</code>, if no current data set exists
798 */
799 public DataSet getCurrentDataSet() {
800 if (!hasEditLayer()) return null;
801 return getEditLayer().data;
802 }
803
804 /**
805 * Replies the current selected primitives, from a end-user point of view.
806 * It is not always technically the same collection of primitives than {@link DataSet#getSelected()}.
807 * Indeed, if the user is currently in drawing mode, only the way currently being drawn is returned,
808 * see {@link DrawAction#getInProgressSelection()}.
809 *
810 * @return The current selected primitives, from a end-user point of view. Can be {@code null}.
811 * @since 6546
812 */
813 public Collection<OsmPrimitive> getInProgressSelection() {
814 if (map != null && map.mapMode instanceof DrawAction) {
815 return ((DrawAction) map.mapMode).getInProgressSelection();
816 } else {
817 DataSet ds = getCurrentDataSet();
818 if (ds == null) return null;
819 return ds.getSelected();
820 }
821 }
822
823 /**
824 * Returns the currently active layer
825 *
826 * @return the currently active layer. <code>null</code>, if currently no active layer exists
827 */
828 public Layer getActiveLayer() {
829 if (!isDisplayingMapView()) return null;
830 return map.mapView.getActiveLayer();
831 }
832
833 protected static final JPanel contentPanePrivate = new JPanel(new BorderLayout());
834
835 public static void redirectToMainContentPane(JComponent source) {
836 RedirectInputMap.redirect(source, contentPanePrivate);
837 }
838
839 public static void registerActionShortcut(JosmAction action) {
840 registerActionShortcut(action, action.getShortcut());
841 }
842
843 public static void registerActionShortcut(Action action, Shortcut shortcut) {
844 KeyStroke keyStroke = shortcut.getKeyStroke();
845 if (keyStroke == null)
846 return;
847
848 InputMap inputMap = contentPanePrivate.getInputMap(JComponent.WHEN_IN_FOCUSED_WINDOW);
849 Object existing = inputMap.get(keyStroke);
850 if (existing != null && !existing.equals(action)) {
851 info(String.format("Keystroke %s is already assigned to %s, will be overridden by %s", keyStroke, existing, action));
852 }
853 inputMap.put(keyStroke, action);
854
855 contentPanePrivate.getActionMap().put(action, action);
856 }
857
858 public static void unregisterShortcut(Shortcut shortcut) {
859 contentPanePrivate.getInputMap(JComponent.WHEN_IN_FOCUSED_WINDOW).remove(shortcut.getKeyStroke());
860 }
861
862 public static void unregisterActionShortcut(JosmAction action) {
863 unregisterActionShortcut(action, action.getShortcut());
864 }
865
866 public static void unregisterActionShortcut(Action action, Shortcut shortcut) {
867 unregisterShortcut(shortcut);
868 contentPanePrivate.getActionMap().remove(action);
869 }
870
871 /**
872 * Replies the registered action for the given shortcut
873 * @param shortcut The shortcut to look for
874 * @return the registered action for the given shortcut
875 * @since 5696
876 */
877 public static Action getRegisteredActionShortcut(Shortcut shortcut) {
878 KeyStroke keyStroke = shortcut.getKeyStroke();
879 if (keyStroke == null)
880 return null;
881 Object action = contentPanePrivate.getInputMap(JComponent.WHEN_IN_FOCUSED_WINDOW).get(keyStroke);
882 if (action instanceof Action)
883 return (Action) action;
884 return null;
885 }
886
887 ///////////////////////////////////////////////////////////////////////////
888 // Implementation part
889 ///////////////////////////////////////////////////////////////////////////
890
891 /**
892 * Global panel.
893 */
894 public static final JPanel panel = new JPanel(new BorderLayout());
895
896 protected static volatile WindowGeometry geometry;
897 protected static int windowState = JFrame.NORMAL;
898
899 private final CommandQueueListener redoUndoListener = new CommandQueueListener(){
900 @Override
901 public void commandChanged(final int queueSize, final int redoSize) {
902 menu.undo.setEnabled(queueSize > 0);
903 menu.redo.setEnabled(redoSize > 0);
904 }
905 };
906
907 /**
908 * Should be called before the main constructor to setup some parameter stuff
909 * @param args The parsed argument list.
910 */
911 public static void preConstructorInit(Map<Option, Collection<String>> args) {
912 ProjectionPreference.setProjection();
913
914 try {
915 String defaultlaf = platform.getDefaultStyle();
916 String laf = Main.pref.get("laf", defaultlaf);
917 try {
918 UIManager.setLookAndFeel(laf);
919 } catch (final NoClassDefFoundError | ClassNotFoundException e) {
920 // Try to find look and feel in plugin classloaders
921 Class<?> klass = null;
922 for (ClassLoader cl : PluginHandler.getResourceClassLoaders()) {
923 try {
924 klass = cl.loadClass(laf);
925 break;
926 } catch (ClassNotFoundException ex) {
927 // Do nothing
928 }
929 }
930 if (klass != null && LookAndFeel.class.isAssignableFrom(klass)) {
931 try {
932 UIManager.setLookAndFeel((LookAndFeel) klass.newInstance());
933 } catch (Exception ex) {
934 warn("Cannot set Look and Feel: " + laf + ": "+ex.getMessage());
935 }
936 } else {
937 info("Look and Feel not found: " + laf);
938 Main.pref.put("laf", defaultlaf);
939 }
940 } catch (final UnsupportedLookAndFeelException e) {
941 info("Look and Feel not supported: " + laf);
942 Main.pref.put("laf", defaultlaf);
943 }
944 toolbar = new ToolbarPreferences();
945 contentPanePrivate.updateUI();
946 panel.updateUI();
947 } catch (final Exception e) {
948 error(e);
949 }
950 UIManager.put("OptionPane.okIcon", ImageProvider.get("ok"));
951 UIManager.put("OptionPane.yesIcon", UIManager.get("OptionPane.okIcon"));
952 UIManager.put("OptionPane.cancelIcon", ImageProvider.get("cancel"));
953 UIManager.put("OptionPane.noIcon", UIManager.get("OptionPane.cancelIcon"));
954
955 I18n.translateJavaInternalMessages();
956
957 // init default coordinate format
958 //
959 try {
960 CoordinateFormat.setCoordinateFormat(CoordinateFormat.valueOf(Main.pref.get("coordinates")));
961 } catch (IllegalArgumentException iae) {
962 CoordinateFormat.setCoordinateFormat(CoordinateFormat.DECIMAL_DEGREES);
963 }
964
965 geometry = WindowGeometry.mainWindow("gui.geometry",
966 args.containsKey(Option.GEOMETRY) ? args.get(Option.GEOMETRY).iterator().next() : null,
967 !args.containsKey(Option.NO_MAXIMIZE) && Main.pref.getBoolean("gui.maximized", false));
968 }
969
970 protected static void postConstructorProcessCmdLine(Map<Option, Collection<String>> args) {
971 if (args.containsKey(Option.DOWNLOAD)) {
972 List<File> fileList = new ArrayList<>();
973 for (String s : args.get(Option.DOWNLOAD)) {
974 File f = null;
975 switch(paramType(s)) {
976 case httpUrl:
977 downloadFromParamHttp(false, s);
978 break;
979 case bounds:
980 downloadFromParamBounds(false, s);
981 break;
982 case fileUrl:
983 try {
984 f = new File(new URI(s));
985 } catch (URISyntaxException e) {
986 JOptionPane.showMessageDialog(
987 Main.parent,
988 tr("Ignoring malformed file URL: \"{0}\"", s),
989 tr("Warning"),
990 JOptionPane.WARNING_MESSAGE
991 );
992 }
993 if (f!=null) {
994 fileList.add(f);
995 }
996 break;
997 case fileName:
998 f = new File(s);
999 fileList.add(f);
1000 break;
1001 }
1002 }
1003 if(!fileList.isEmpty()) {
1004 OpenFileAction.openFiles(fileList, true);
1005 }
1006 }
1007 if (args.containsKey(Option.DOWNLOADGPS)) {
1008 for (String s : args.get(Option.DOWNLOADGPS)) {
1009 switch(paramType(s)) {
1010 case httpUrl:
1011 downloadFromParamHttp(true, s);
1012 break;
1013 case bounds:
1014 downloadFromParamBounds(true, s);
1015 break;
1016 case fileUrl:
1017 case fileName:
1018 JOptionPane.showMessageDialog(
1019 Main.parent,
1020 tr("Parameter \"downloadgps\" does not accept file names or file URLs"),
1021 tr("Warning"),
1022 JOptionPane.WARNING_MESSAGE
1023 );
1024 }
1025 }
1026 }
1027 if (args.containsKey(Option.SELECTION)) {
1028 for (String s : args.get(Option.SELECTION)) {
1029 SearchAction.search(s, SearchAction.SearchMode.add);
1030 }
1031 }
1032 }
1033
1034 /**
1035 * Asks user to perform "save layer" operations (save on disk and/or upload data to server) for all {@link AbstractModifiableLayer} before JOSM exits.
1036 * @return {@code true} if there was nothing to save, or if the user wants to proceed to save operations. {@code false} if the user cancels.
1037 * @since 2025
1038 */
1039 public static boolean saveUnsavedModifications() {
1040 if (!isDisplayingMapView()) return true;
1041 return saveUnsavedModifications(map.mapView.getLayersOfType(AbstractModifiableLayer.class), true);
1042 }
1043
1044 /**
1045 * Asks user to perform "save layer" operations (save on disk and/or upload data to server) before data layers deletion.
1046 *
1047 * @param selectedLayers The layers to check. Only instances of {@link AbstractModifiableLayer} are considered.
1048 * @param exit {@code true} if JOSM is exiting, {@code false} otherwise.
1049 * @return {@code true} if there was nothing to save, or if the user wants to proceed to save operations. {@code false} if the user cancels.
1050 * @since 5519
1051 */
1052 public static boolean saveUnsavedModifications(Iterable<? extends Layer> selectedLayers, boolean exit) {
1053 SaveLayersDialog dialog = new SaveLayersDialog(parent);
1054 List<AbstractModifiableLayer> layersWithUnmodifiedChanges = new ArrayList<>();
1055 for (Layer l: selectedLayers) {
1056 if (!(l instanceof AbstractModifiableLayer)) {
1057 continue;
1058 }
1059 AbstractModifiableLayer odl = (AbstractModifiableLayer)l;
1060 if ((odl.requiresSaveToFile() || (odl.requiresUploadToServer() && !odl.isUploadDiscouraged())) && odl.isModified()) {
1061 layersWithUnmodifiedChanges.add(odl);
1062 }
1063 }
1064 if (exit) {
1065 dialog.prepareForSavingAndUpdatingLayersBeforeExit();
1066 } else {
1067 dialog.prepareForSavingAndUpdatingLayersBeforeDelete();
1068 }
1069 if (!layersWithUnmodifiedChanges.isEmpty()) {
1070 dialog.getModel().populate(layersWithUnmodifiedChanges);
1071 dialog.setVisible(true);
1072 switch(dialog.getUserAction()) {
1073 case PROCEED: return true;
1074 case CANCEL:
1075 default: return false;
1076 }
1077 }
1078
1079 return true;
1080 }
1081
1082 /**
1083 * Closes JOSM and optionally terminates the Java Virtual Machine (JVM). If there are some unsaved data layers, asks first for user confirmation.
1084 * @param exit If {@code true}, the JVM is terminated by running {@link System#exit} with a given return code.
1085 * @param exitCode The return code
1086 * @return {@code true} if JOSM has been closed, {@code false} if the user has cancelled the operation.
1087 * @since 3378
1088 */
1089 public static boolean exitJosm(boolean exit, int exitCode) {
1090 JCSCacheManager.shutdown();
1091 if (Main.saveUnsavedModifications()) {
1092 geometry.remember("gui.geometry");
1093 if (map != null) {
1094 map.rememberToggleDialogWidth();
1095 }
1096 pref.put("gui.maximized", (windowState & JFrame.MAXIMIZED_BOTH) != 0);
1097 // Remove all layers because somebody may rely on layerRemoved events (like AutosaveTask)
1098 if (Main.isDisplayingMapView()) {
1099 Collection<Layer> layers = new ArrayList<>(Main.map.mapView.getAllLayers());
1100 for (Layer l: layers) {
1101 Main.main.removeLayer(l);
1102 }
1103 }
1104 if (exit) {
1105 System.exit(exitCode);
1106 }
1107 return true;
1108 }
1109 return false;
1110 }
1111
1112 /**
1113 * The type of a command line parameter, to be used in switch statements.
1114 * @see #paramType
1115 */
1116 private enum DownloadParamType { httpUrl, fileUrl, bounds, fileName }
1117
1118 /**
1119 * Guess the type of a parameter string specified on the command line with --download= or --downloadgps.
1120 * @param s A parameter string
1121 * @return The guessed parameter type
1122 */
1123 private static DownloadParamType paramType(String s) {
1124 if(s.startsWith("http:") || s.startsWith("https:")) return DownloadParamType.httpUrl;
1125 if(s.startsWith("file:")) return DownloadParamType.fileUrl;
1126 String coorPattern = "\\s*[+-]?[0-9]+(\\.[0-9]+)?\\s*";
1127 if(s.matches(coorPattern+"(,"+coorPattern+"){3}")) return DownloadParamType.bounds;
1128 // everything else must be a file name
1129 return DownloadParamType.fileName;
1130 }
1131
1132 /**
1133 * Download area specified on the command line as OSM URL.
1134 * @param rawGps Flag to download raw GPS tracks
1135 * @param s The URL parameter
1136 */
1137 private static void downloadFromParamHttp(final boolean rawGps, String s) {
1138 final Bounds b = OsmUrlToBounds.parse(s);
1139 if (b == null) {
1140 JOptionPane.showMessageDialog(
1141 Main.parent,
1142 tr("Ignoring malformed URL: \"{0}\"", s),
1143 tr("Warning"),
1144 JOptionPane.WARNING_MESSAGE
1145 );
1146 } else {
1147 downloadFromParamBounds(rawGps, b);
1148 }
1149 }
1150
1151 /**
1152 * Download area specified on the command line as bounds string.
1153 * @param rawGps Flag to download raw GPS tracks
1154 * @param s The bounds parameter
1155 */
1156 private static void downloadFromParamBounds(final boolean rawGps, String s) {
1157 final StringTokenizer st = new StringTokenizer(s, ",");
1158 if (st.countTokens() == 4) {
1159 Bounds b = new Bounds(
1160 new LatLon(Double.parseDouble(st.nextToken()),Double.parseDouble(st.nextToken())),
1161 new LatLon(Double.parseDouble(st.nextToken()),Double.parseDouble(st.nextToken()))
1162 );
1163 downloadFromParamBounds(rawGps, b);
1164 }
1165 }
1166
1167 /**
1168 * Download area specified as Bounds value.
1169 * @param rawGps Flag to download raw GPS tracks
1170 * @param b The bounds value
1171 * @see #downloadFromParamBounds(boolean, String)
1172 * @see #downloadFromParamHttp
1173 */
1174 private static void downloadFromParamBounds(final boolean rawGps, Bounds b) {
1175 DownloadTask task = rawGps ? new DownloadGpsTask() : new DownloadOsmTask();
1176 // asynchronously launch the download task ...
1177 Future<?> future = task.download(true, b, null);
1178 // ... and the continuation when the download is finished (this will wait for the download to finish)
1179 Main.worker.execute(new PostDownloadHandler(task, future));
1180 }
1181
1182 /**
1183 * Identifies the current operating system family and initializes the platform hook accordingly.
1184 * @since 1849
1185 */
1186 public static void determinePlatformHook() {
1187 String os = System.getProperty("os.name");
1188 if (os == null) {
1189 warn("Your operating system has no name, so I'm guessing its some kind of *nix.");
1190 platform = new PlatformHookUnixoid();
1191 } else if (os.toLowerCase(Locale.ENGLISH).startsWith("windows")) {
1192 platform = new PlatformHookWindows();
1193 } else if ("Linux".equals(os) || "Solaris".equals(os) ||
1194 "SunOS".equals(os) || "AIX".equals(os) ||
1195 "FreeBSD".equals(os) || "NetBSD".equals(os) || "OpenBSD".equals(os)) {
1196 platform = new PlatformHookUnixoid();
1197 } else if (os.toLowerCase(Locale.ENGLISH).startsWith("mac os x")) {
1198 platform = new PlatformHookOsx();
1199 } else {
1200 warn("I don't know your operating system '"+os+"', so I'm guessing its some kind of *nix.");
1201 platform = new PlatformHookUnixoid();
1202 }
1203 }
1204
1205 private static class WindowPositionSizeListener extends WindowAdapter implements
1206 ComponentListener {
1207 @Override
1208 public void windowStateChanged(WindowEvent e) {
1209 Main.windowState = e.getNewState();
1210 }
1211
1212 @Override
1213 public void componentHidden(ComponentEvent e) {
1214 }
1215
1216 @Override
1217 public void componentMoved(ComponentEvent e) {
1218 handleComponentEvent(e);
1219 }
1220
1221 @Override
1222 public void componentResized(ComponentEvent e) {
1223 handleComponentEvent(e);
1224 }
1225
1226 @Override
1227 public void componentShown(ComponentEvent e) {
1228 }
1229
1230 private void handleComponentEvent(ComponentEvent e) {
1231 Component c = e.getComponent();
1232 if (c instanceof JFrame && c.isVisible()) {
1233 if(Main.windowState == JFrame.NORMAL) {
1234 Main.geometry = new WindowGeometry((JFrame) c);
1235 } else {
1236 Main.geometry.fixScreen((JFrame) c);
1237 }
1238 }
1239 }
1240 }
1241
1242 protected static void addListener() {
1243 parent.addComponentListener(new WindowPositionSizeListener());
1244 ((JFrame)parent).addWindowStateListener(new WindowPositionSizeListener());
1245 }
1246
1247 /**
1248 * Determines if JOSM currently runs with Java 8 or later.
1249 * @return {@code true} if the current JVM is at least Java 8, {@code false} otherwise
1250 * @since 7894
1251 */
1252 public static boolean isJava8orLater() {
1253 String version = System.getProperty("java.version");
1254 return version != null && !version.matches("^(1\\.)?[7].*");
1255 }
1256
1257 /**
1258 * Checks that JOSM is at least running with Java 7.
1259 * @since 7001
1260 */
1261 public static void checkJavaVersion() {
1262 String version = System.getProperty("java.version");
1263 if (version != null) {
1264 if (version.matches("^(1\\.)?[789].*"))
1265 return;
1266 if (version.matches("^(1\\.)?[56].*")) {
1267 JMultilineLabel ho = new JMultilineLabel("<html>"+
1268 tr("<h2>JOSM requires Java version {0}.</h2>"+
1269 "Detected Java version: {1}.<br>"+
1270 "You can <ul><li>update your Java (JRE) or</li>"+
1271 "<li>use an earlier (Java {2} compatible) version of JOSM.</li></ul>"+
1272 "More Info:", "7", version, "6")+"</html>");
1273 JTextArea link = new JTextArea(HelpUtil.getWikiBaseHelpUrl()+"/Help/SystemRequirements");
1274 link.setEditable(false);
1275 link.setBackground(panel.getBackground());
1276 JPanel panel = new JPanel(new GridBagLayout());
1277 GridBagConstraints gbc = new GridBagConstraints();
1278 gbc.gridwidth = GridBagConstraints.REMAINDER;
1279 gbc.anchor = GridBagConstraints.WEST;
1280 gbc.weightx = 1.0;
1281 panel.add(ho, gbc);
1282 panel.add(link, gbc);
1283 final String EXIT = tr("Exit JOSM");
1284 final String CONTINUE = tr("Continue, try anyway");
1285 int ret = JOptionPane.showOptionDialog(null, panel, tr("Error"), JOptionPane.YES_NO_OPTION,
1286 JOptionPane.ERROR_MESSAGE, null, new String[] {EXIT, CONTINUE}, EXIT);
1287 if (ret == 0) {
1288 System.exit(0);
1289 }
1290 return;
1291 }
1292 }
1293 error("Could not recognize Java Version: "+version);
1294 }
1295
1296 /* ----------------------------------------------------------------------------------------- */
1297 /* projection handling - Main is a registry for a single, global projection instance */
1298 /* */
1299 /* TODO: For historical reasons the registry is implemented by Main. An alternative approach */
1300 /* would be a singleton org.openstreetmap.josm.data.projection.ProjectionRegistry class. */
1301 /* ----------------------------------------------------------------------------------------- */
1302 /**
1303 * The projection method used.
1304 * use {@link #getProjection()} and {@link #setProjection(Projection)} for access.
1305 * Use {@link #setProjection(Projection)} in order to trigger a projection change event.
1306 */
1307 private static volatile Projection proj;
1308
1309 /**
1310 * Replies the current projection.
1311 *
1312 * @return the currently active projection
1313 */
1314 public static Projection getProjection() {
1315 return proj;
1316 }
1317
1318 /**
1319 * Sets the current projection
1320 *
1321 * @param p the projection
1322 */
1323 public static void setProjection(Projection p) {
1324 CheckParameterUtil.ensureParameterNotNull(p);
1325 Projection oldValue = proj;
1326 Bounds b = isDisplayingMapView() ? map.mapView.getRealBounds() : null;
1327 proj = p;
1328 fireProjectionChanged(oldValue, proj, b);
1329 }
1330
1331 /*
1332 * Keep WeakReferences to the listeners. This relieves clients from the burden of
1333 * explicitly removing the listeners and allows us to transparently register every
1334 * created dataset as projection change listener.
1335 */
1336 private static final List<WeakReference<ProjectionChangeListener>> listeners = new ArrayList<>();
1337
1338 private static void fireProjectionChanged(Projection oldValue, Projection newValue, Bounds oldBounds) {
1339 if (newValue == null ^ oldValue == null
1340 || (newValue != null && oldValue != null && !Objects.equals(newValue.toCode(), oldValue.toCode()))) {
1341
1342 synchronized(Main.class) {
1343 Iterator<WeakReference<ProjectionChangeListener>> it = listeners.iterator();
1344 while (it.hasNext()){
1345 WeakReference<ProjectionChangeListener> wr = it.next();
1346 ProjectionChangeListener listener = wr.get();
1347 if (listener == null) {
1348 it.remove();
1349 continue;
1350 }
1351 listener.projectionChanged(oldValue, newValue);
1352 }
1353 }
1354 if (newValue != null && oldBounds != null) {
1355 Main.map.mapView.zoomTo(oldBounds);
1356 }
1357 /* TODO - remove layers with fixed projection */
1358 }
1359 }
1360
1361 /**
1362 * Register a projection change listener.
1363 *
1364 * @param listener the listener. Ignored if <code>null</code>.
1365 */
1366 public static void addProjectionChangeListener(ProjectionChangeListener listener) {
1367 if (listener == null) return;
1368 synchronized (Main.class) {
1369 for (WeakReference<ProjectionChangeListener> wr : listeners) {
1370 // already registered ? => abort
1371 if (wr.get() == listener) return;
1372 }
1373 listeners.add(new WeakReference<>(listener));
1374 }
1375 }
1376
1377 /**
1378 * Removes a projection change listener.
1379 *
1380 * @param listener the listener. Ignored if <code>null</code>.
1381 */
1382 public static void removeProjectionChangeListener(ProjectionChangeListener listener) {
1383 if (listener == null) return;
1384 synchronized(Main.class){
1385 Iterator<WeakReference<ProjectionChangeListener>> it = listeners.iterator();
1386 while (it.hasNext()){
1387 WeakReference<ProjectionChangeListener> wr = it.next();
1388 // remove the listener - and any other listener which got garbage
1389 // collected in the meantime
1390 if (wr.get() == null || wr.get() == listener) {
1391 it.remove();
1392 }
1393 }
1394 }
1395 }
1396
1397 /**
1398 * Listener for window switch events.
1399 *
1400 * These are events, when the user activates a window of another application
1401 * or comes back to JOSM. Window switches from one JOSM window to another
1402 * are not reported.
1403 */
1404 public static interface WindowSwitchListener {
1405 /**
1406 * Called when the user activates a window of another application.
1407 */
1408 void toOtherApplication();
1409 /**
1410 * Called when the user comes from a window of another application
1411 * back to JOSM.
1412 */
1413 void fromOtherApplication();
1414 }
1415
1416 private static final List<WeakReference<WindowSwitchListener>> windowSwitchListeners = new ArrayList<>();
1417
1418 /**
1419 * Register a window switch listener.
1420 *
1421 * @param listener the listener. Ignored if <code>null</code>.
1422 */
1423 public static void addWindowSwitchListener(WindowSwitchListener listener) {
1424 if (listener == null) return;
1425 synchronized (Main.class) {
1426 for (WeakReference<WindowSwitchListener> wr : windowSwitchListeners) {
1427 // already registered ? => abort
1428 if (wr.get() == listener) return;
1429 }
1430 boolean wasEmpty = windowSwitchListeners.isEmpty();
1431 windowSwitchListeners.add(new WeakReference<>(listener));
1432 if (wasEmpty) {
1433 // The following call will have no effect, when there is no window
1434 // at the time. Therefore, MasterWindowListener.setup() will also be
1435 // called, as soon as the main window is shown.
1436 MasterWindowListener.setup();
1437 }
1438 }
1439 }
1440
1441 /**
1442 * Removes a window switch listener.
1443 *
1444 * @param listener the listener. Ignored if <code>null</code>.
1445 */
1446 public static void removeWindowSwitchListener(WindowSwitchListener listener) {
1447 if (listener == null) return;
1448 synchronized (Main.class){
1449 Iterator<WeakReference<WindowSwitchListener>> it = windowSwitchListeners.iterator();
1450 while (it.hasNext()){
1451 WeakReference<WindowSwitchListener> wr = it.next();
1452 // remove the listener - and any other listener which got garbage
1453 // collected in the meantime
1454 if (wr.get() == null || wr.get() == listener) {
1455 it.remove();
1456 }
1457 }
1458 if (windowSwitchListeners.isEmpty()) {
1459 MasterWindowListener.teardown();
1460 }
1461 }
1462 }
1463
1464 /**
1465 * WindowListener, that is registered on all Windows of the application.
1466 *
1467 * Its purpose is to notify WindowSwitchListeners, that the user switches to
1468 * another application, e.g. a browser, or back to JOSM.
1469 *
1470 * When changing from JOSM to another application and back (e.g. two times
1471 * alt+tab), the active Window within JOSM may be different.
1472 * Therefore, we need to register listeners to <strong>all</strong> (visible)
1473 * Windows in JOSM, and it does not suffice to monitor the one that was
1474 * deactivated last.
1475 *
1476 * This class is only "active" on demand, i.e. when there is at least one
1477 * WindowSwitchListener registered.
1478 */
1479 protected static class MasterWindowListener extends WindowAdapter {
1480
1481 private static MasterWindowListener INSTANCE;
1482
1483 public static synchronized MasterWindowListener getInstance() {
1484 if (INSTANCE == null) {
1485 INSTANCE = new MasterWindowListener();
1486 }
1487 return INSTANCE;
1488 }
1489
1490 /**
1491 * Register listeners to all non-hidden windows.
1492 *
1493 * Windows that are created later, will be cared for in {@link #windowDeactivated(WindowEvent)}.
1494 */
1495 public static void setup() {
1496 if (!windowSwitchListeners.isEmpty()) {
1497 for (Window w : Window.getWindows()) {
1498 if (w.isShowing()) {
1499 if (!Arrays.asList(w.getWindowListeners()).contains(getInstance())) {
1500 w.addWindowListener(getInstance());
1501 }
1502 }
1503 }
1504 }
1505 }
1506
1507 /**
1508 * Unregister all listeners.
1509 */
1510 public static void teardown() {
1511 for (Window w : Window.getWindows()) {
1512 w.removeWindowListener(getInstance());
1513 }
1514 }
1515
1516 @Override
1517 public void windowActivated(WindowEvent e) {
1518 if (e.getOppositeWindow() == null) { // we come from a window of a different application
1519 // fire WindowSwitchListeners
1520 synchronized (Main.class) {
1521 Iterator<WeakReference<WindowSwitchListener>> it = windowSwitchListeners.iterator();
1522 while (it.hasNext()){
1523 WeakReference<WindowSwitchListener> wr = it.next();
1524 WindowSwitchListener listener = wr.get();
1525 if (listener == null) {
1526 it.remove();
1527 continue;
1528 }
1529 listener.fromOtherApplication();
1530 }
1531 }
1532 }
1533 }
1534
1535 @Override
1536 public void windowDeactivated(WindowEvent e) {
1537 // set up windows that have been created in the meantime
1538 for (Window w : Window.getWindows()) {
1539 if (!w.isShowing()) {
1540 w.removeWindowListener(getInstance());
1541 } else {
1542 if (!Arrays.asList(w.getWindowListeners()).contains(getInstance())) {
1543 w.addWindowListener(getInstance());
1544 }
1545 }
1546 }
1547 if (e.getOppositeWindow() == null) { // we go to a window of a different application
1548 // fire WindowSwitchListeners
1549 synchronized (Main.class) {
1550 Iterator<WeakReference<WindowSwitchListener>> it = windowSwitchListeners.iterator();
1551 while (it.hasNext()){
1552 WeakReference<WindowSwitchListener> wr = it.next();
1553 WindowSwitchListener listener = wr.get();
1554 if (listener == null) {
1555 it.remove();
1556 continue;
1557 }
1558 listener.toOtherApplication();
1559 }
1560 }
1561 }
1562 }
1563 }
1564
1565 /**
1566 * Registers a new {@code MapFrameListener} that will be notified of MapFrame changes
1567 * @param listener The MapFrameListener
1568 * @param fireWhenMapViewPresent If true, will fire an initial mapFrameInitialized event
1569 * when the MapFrame is present. Otherwise will only fire when the MapFrame is created
1570 * or destroyed.
1571 * @return {@code true} if the listeners collection changed as a result of the call
1572 */
1573 public static boolean addMapFrameListener(MapFrameListener listener, boolean fireWhenMapViewPresent) {
1574 boolean changed = listener != null ? mapFrameListeners.add(listener) : false;
1575 if (fireWhenMapViewPresent && changed && map != null) {
1576 listener.mapFrameInitialized(null, map);
1577 }
1578 return changed;
1579 }
1580
1581 /**
1582 * Registers a new {@code MapFrameListener} that will be notified of MapFrame changes
1583 * @param listener The MapFrameListener
1584 * @return {@code true} if the listeners collection changed as a result of the call
1585 * @since 5957
1586 */
1587 public static boolean addMapFrameListener(MapFrameListener listener) {
1588 return addMapFrameListener(listener, false);
1589 }
1590
1591 /**
1592 * Unregisters the given {@code MapFrameListener} from MapFrame changes
1593 * @param listener The MapFrameListener
1594 * @return {@code true} if the listeners collection changed as a result of the call
1595 * @since 5957
1596 */
1597 public static boolean removeMapFrameListener(MapFrameListener listener) {
1598 return listener != null ? mapFrameListeners.remove(listener) : false;
1599 }
1600
1601 /**
1602 * Adds a new network error that occur to give a hint about broken Internet connection.
1603 * Do not use this method for errors known for sure thrown because of a bad proxy configuration.
1604 *
1605 * @param url The accessed URL that caused the error
1606 * @param t The network error
1607 * @return The previous error associated to the given resource, if any. Can be {@code null}
1608 * @since 6642
1609 */
1610 public static Throwable addNetworkError(URL url, Throwable t) {
1611 if (url != null && t != null) {
1612 Throwable old = addNetworkError(url.toExternalForm(), t);
1613 if (old != null) {
1614 Main.warn("Already here "+old);
1615 }
1616 return old;
1617 }
1618 return null;
1619 }
1620
1621 /**
1622 * Adds a new network error that occur to give a hint about broken Internet connection.
1623 * Do not use this method for errors known for sure thrown because of a bad proxy configuration.
1624 *
1625 * @param url The accessed URL that caused the error
1626 * @param t The network error
1627 * @return The previous error associated to the given resource, if any. Can be {@code null}
1628 * @since 6642
1629 */
1630 public static Throwable addNetworkError(String url, Throwable t) {
1631 if (url != null && t != null) {
1632 return NETWORK_ERRORS.put(url, t);
1633 }
1634 return null;
1635 }
1636
1637 /**
1638 * Returns the network errors that occured until now.
1639 * @return the network errors that occured until now, indexed by URL
1640 * @since 6639
1641 */
1642 public static Map<String, Throwable> getNetworkErrors() {
1643 return new HashMap<>(NETWORK_ERRORS);
1644 }
1645
1646 /**
1647 * Returns the command-line arguments used to run the application.
1648 * @return the command-line arguments used to run the application
1649 * @since 8356
1650 */
1651 public static List<String> getCommandLineArgs() {
1652 return Collections.unmodifiableList(COMMAND_LINE_ARGS);
1653 }
1654
1655 /**
1656 * Returns the JOSM website URL.
1657 * @return the josm website URL
1658 * @since 6897
1659 */
1660 public static String getJOSMWebsite() {
1661 if (Main.pref != null)
1662 return Main.pref.get("josm.url", JOSM_WEBSITE);
1663 return JOSM_WEBSITE;
1664 }
1665
1666 /**
1667 * Returns the JOSM XML URL.
1668 * @return the josm XML URL
1669 * @since 6897
1670 */
1671 public static String getXMLBase() {
1672 // Always return HTTP (issues reported with HTTPS)
1673 return "http://josm.openstreetmap.de";
1674 }
1675
1676 /**
1677 * Returns the OSM website URL.
1678 * @return the OSM website URL
1679 * @since 6897
1680 */
1681 public static String getOSMWebsite() {
1682 if (Main.pref != null)
1683 return Main.pref.get("osm.url", OSM_WEBSITE);
1684 return OSM_WEBSITE;
1685 }
1686
1687 /**
1688 * Replies the base URL for browsing information about a primitive.
1689 * @return the base URL, i.e. https://www.openstreetmap.org
1690 * @since 7678
1691 */
1692 public static String getBaseBrowseUrl() {
1693 if (Main.pref != null)
1694 return Main.pref.get("osm-browse.url", getOSMWebsite());
1695 return getOSMWebsite();
1696 }
1697
1698 /**
1699 * Replies the base URL for browsing information about a user.
1700 * @return the base URL, i.e. https://www.openstreetmap.org/user
1701 * @since 7678
1702 */
1703 public static String getBaseUserUrl() {
1704 if (Main.pref != null)
1705 return Main.pref.get("osm-user.url", getOSMWebsite() + "/user");
1706 return getOSMWebsite() + "/user";
1707 }
1708
1709 /**
1710 * Determines if we are currently running on OSX.
1711 * @return {@code true} if we are currently running on OSX
1712 * @since 6957
1713 */
1714 public static boolean isPlatformOsx() {
1715 return Main.platform instanceof PlatformHookOsx;
1716 }
1717
1718 /**
1719 * Determines if we are currently running on Windows.
1720 * @return {@code true} if we are currently running on Windows
1721 * @since 7335
1722 */
1723 public static boolean isPlatformWindows() {
1724 return Main.platform instanceof PlatformHookWindows;
1725 }
1726
1727 /**
1728 * Determines if the given online resource is currently offline.
1729 * @param r the online resource
1730 * @return {@code true} if {@code r} is offline and should not be accessed
1731 * @since 7434
1732 */
1733 public static boolean isOffline(OnlineResource r) {
1734 return OFFLINE_RESOURCES.contains(r) || OFFLINE_RESOURCES.contains(OnlineResource.ALL);
1735 }
1736
1737 /**
1738 * Sets the given online resource to offline state.
1739 * @param r the online resource
1740 * @return {@code true} if {@code r} was not already offline
1741 * @since 7434
1742 */
1743 public static boolean setOffline(OnlineResource r) {
1744 return OFFLINE_RESOURCES.add(r);
1745 }
1746
1747 /**
1748 * Replies the set of online resources currently offline.
1749 * @return the set of online resources currently offline
1750 * @since 7434
1751 */
1752 public static Set<OnlineResource> getOfflineResources() {
1753 return new HashSet<>(OFFLINE_RESOURCES);
1754 }
1755}
Note: See TracBrowser for help on using the repository browser.