Changeset 12776 in josm

Timestamp:

2017-09-07T23:41:42+02:00 (7 years ago)

Author:

bastiK

Message:

see #15229 - remove dependency of NTV2GridShiftFileWrapper on Main.platform

• PlatformHook bundles all application-wide platform dependent code, which is

convenient, but problematic for separating modules

• introduces lightweight tools.Platform for adding platform dependent code more locally

Location:

trunk/src/org/openstreetmap/josm

Files:

• Main.java (modified) (2 diffs)
• data/projection/datum/NTV2GridShiftFileWrapper.java (modified) (3 diffs)
• tools/Platform.java (added)
• tools/PlatformHook.java (modified) (3 diffs)
• tools/PlatformHookOsx.java (modified) (3 diffs)
• tools/PlatformHookUnixoid.java (modified) (3 diffs)
• tools/PlatformHookWindows.java (modified) (3 diffs)
• tools/PlatformVisitor.java (added)

trunk/src/org/openstreetmap/josm/Main.java

@@ -54 +54 @@
 import org.openstreetmap.josm.tools.JosmRuntimeException;
 import org.openstreetmap.josm.tools.Logging;
+import org.openstreetmap.josm.tools.Platform;
 import org.openstreetmap.josm.tools.PlatformHook;
 import org.openstreetmap.josm.tools.PlatformHookOsx;
@@ -772 +773 @@
      */
     public static void determinePlatformHook() {
-        String os = System.getProperty("os.name");
-        if (os == null) {
-            Logging.warn("Your operating system has no name, so I'm guessing its some kind of *nix.");
-            platform = new PlatformHookUnixoid();
-        } else if (os.toLowerCase(Locale.ENGLISH).startsWith("windows")) {
-            platform = new PlatformHookWindows();
-        } else if ("Linux".equals(os) || "Solaris".equals(os) ||
-                "SunOS".equals(os) || "AIX".equals(os) ||
-                "FreeBSD".equals(os) || "NetBSD".equals(os) || "OpenBSD".equals(os)) {
-            platform = new PlatformHookUnixoid();
-        } else if (os.toLowerCase(Locale.ENGLISH).startsWith("mac os x")) {
-            platform = new PlatformHookOsx();
-        } else {
-            Logging.warn("I don't know your operating system '"+os+"', so I'm guessing its some kind of *nix.");
-            platform = new PlatformHookUnixoid();
-        }
+        platform = Platform.determinePlatform().accept(PlatformHook.CONSTRUCT_FROM_PLATFORM);
     }
 

trunk/src/org/openstreetmap/josm/data/projection/datum/NTV2GridShiftFileWrapper.java

@@ -5 +5 @@
 import java.io.IOException;
 import java.io.InputStream;
+import java.util.Arrays;
+import java.util.Collections;
+import java.util.List;
 
 import org.openstreetmap.josm.Main;
 import org.openstreetmap.josm.io.CachedFile;
+import org.openstreetmap.josm.tools.Platform;
+import org.openstreetmap.josm.tools.PlatformVisitor;
 
 /**
@@ -29 +34 @@
 
     /**
+     * Lists default directories where the ntv2 shift files (NAD) for the proj4
+     * library would be located on different platforms.
+     */
+    public static final PlatformVisitor<List<File>> DEFAULT_PROJ4_NTV2_SHIFT_DIRS =
+            new PlatformVisitor<List<File>>() {
+        @Override
+        public List<File> visitUnixoid() {
+            return Arrays.asList(new File("/usr/local/share/proj"), new File("/usr/share/proj"));
+        }
+
+        @Override
+        public List<File> visitWindows() {
+            return Arrays.asList(new File("C:\\PROJ\\NAD"));
+        }
+
+        @Override
+        public List<File> visitOsx() {
+            return Collections.emptyList();
+        }
+    };
+
+    /**
      * Returns the actual {@link NTV2GridShiftFile} behind this wrapper.
      * The grid file is only loaded once, when first accessed.
@@ -38 +65 @@
             File grid = null;
             // Check is the grid is installed in default PROJ.4 directories
-            for (File dir : Main.platform.getDefaultProj4NadshiftDirectories()) {
+            for (File dir : Platform.determinePlatform().accept(DEFAULT_PROJ4_NTV2_SHIFT_DIRS)) {
                 File file = new File(dir, gridFileName);
                 if (file.exists() && file.isFile()) {

trunk/src/org/openstreetmap/josm/tools/PlatformHook.java

@@ -20 +20 @@
 
 import org.openstreetmap.josm.Main;
+import org.openstreetmap.josm.data.projection.datum.NTV2GridShiftFileWrapper;
 import org.openstreetmap.josm.io.CertificateAmendment.CertAmend;
 import org.openstreetmap.josm.tools.date.DateUtils;
@@ -29 +30 @@
  */
 public interface PlatformHook {
+
+    /**
+     * Visitor to construct a PlatformHook from a given {@link Platform} object.
+     */
+    public static final PlatformVisitor<PlatformHook> CONSTRUCT_FROM_PLATFORM = new PlatformVisitor<PlatformHook>() {
+        @Override
+        public PlatformHook visitUnixoid() {
+            return new PlatformHookUnixoid();
+        }
+
+        @Override
+        public PlatformHook visitWindows() {
+            return new PlatformHookWindows();
+        }
+
+        @Override
+        public PlatformHook visitOsx() {
+            return new PlatformHookUnixoid();
+        }
+    };
+
+    /**
+     * Get the platform corresponding to this platform hook.
+     * @return the platform corresponding to this platform hook
+     */
+    Platform getPlatform();
 
     /**
@@ -231 +258 @@
      * @since 11642
      */
-    List<File> getDefaultProj4NadshiftDirectories();
+    default List<File> getDefaultProj4NadshiftDirectories() {
+        return getPlatform().accept(NTV2GridShiftFileWrapper.DEFAULT_PROJ4_NTV2_SHIFT_DIRS);
+    }
 
     /**

trunk/src/org/openstreetmap/josm/tools/PlatformHookOsx.java

@@ -15 +15 @@
 import java.lang.reflect.Proxy;
 import java.util.Arrays;
-import java.util.Collections;
 import java.util.List;
 import java.util.Objects;
@@ -32 +31 @@
 
     private NativeOsCallback osCallback;
+
+    @Override
+    public Platform getPlatform() {
+        return Platform.OSX;
+    }
 
     @Override
@@ -423 +427 @@
                 Main.pref.getJOSMDirectoryBaseName());
     }
-
-    @Override
-    public List<File> getDefaultProj4NadshiftDirectories() {
-        return Collections.emptyList();
-    }
 }

trunk/src/org/openstreetmap/josm/tools/PlatformHookUnixoid.java

@@ -22 +22 @@
 import java.security.cert.X509Certificate;
 import java.util.Arrays;
-import java.util.List;
 import java.util.Locale;
 
@@ -66 +65 @@
             "尚未安裝"                // zh_TW
     };
+
+    @Override
+    public Platform getPlatform() {
+        return Platform.UNIXOID;
+    }
 
     @Override
@@ -422 +426 @@
 
     @Override
-    public List<File> getDefaultProj4NadshiftDirectories() {
-        return Arrays.asList(new File("/usr/local/share/proj"), new File("/usr/share/proj"));
-    }
-
-    @Override
     public X509Certificate getX509Certificate(CertAmend certAmend)
             throws KeyStoreException, NoSuchAlgorithmException, CertificateException, IOException {

trunk/src/org/openstreetmap/josm/tools/PlatformHookWindows.java

@@ -58 +58 @@
 import java.security.spec.X509EncodedKeySpec;
 import java.util.ArrayList;
-import java.util.Arrays;
 import java.util.Collection;
 import java.util.Enumeration;
@@ -155 +154 @@
 
     private String oSBuildNumber;
+
+    @Override
+    public Platform getPlatform() {
+        return Platform.WINDOWS;
+    }
 
     @Override
@@ -673 +677 @@
         return def;
     }
-
-    @Override
-    public List<File> getDefaultProj4NadshiftDirectories() {
-        return Arrays.asList(new File("C:\\PROJ\\NAD"));
-    }
 }