src/jalview/util/Platform.java

   1 /*
   2  * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
   3  * Copyright (C) $$Year-Rel$$ The Jalview Authors
   4  *
   5  * This file is part of Jalview.
   6  *
   7  * Jalview is free software: you can redistribute it and/or
   8  * modify it under the terms of the GNU General Public License
   9  * as published by the Free Software Foundation, either version 3
  10  * of the License, or (at your option) any later version.
  11  *
  12  * Jalview is distributed in the hope that it will be useful, but
  13  * WITHOUT ANY WARRANTY; without even the implied warranty
  14  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  15  * PURPOSE.  See the GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
  19  * The Jalview Authors are detailed in the 'AUTHORS' file.
  20  */
  21 package jalview.util;
  22
  23 import java.awt.event.MouseEvent;
  24
  25 /**
  26  * System platform information used by Applet and Application
  27  *
  28  * @author Jim Procter
  29  */
  30 public class Platform
  31 {
  32   private static Boolean isAMac = null, isWindows = null, isLinux = null;
  33
  34   private static Boolean isHeadless = null;
  35
  36   /**
  37    * added to check LaF for Linux
  38    *
  39    * @return
  40    */
  41   public static boolean isLinux()
  42   {
  43     return (isLinux == null
  44             ? (isLinux = (System.getProperty("os.name").indexOf("Linux") >= 0))
  45             : isLinux);
  46   }
  47
  48   /**
  49    * sorry folks - Macs really are different
  50    *
  51    * @return true if we do things in a special way.
  52    */
  53   public static boolean isAMac()
  54   {
  55     if (isAMac == null)
  56     {
  57       isAMac = System.getProperty("os.name").indexOf("Mac") > -1;
  58     }
  59
  60     return isAMac.booleanValue();
  61
  62   }
  63
  64   /**
  65    * Check if we are on a Microsoft plaform...
  66    *
  67    * @return true if we have to cope with another platform variation
  68    */
  69   public static boolean isWindows()
  70   {
  71     if (isWindows == null)
  72     {
  73       isWindows = System.getProperty("os.name").indexOf("Win") > -1;
  74     }
  75     return isWindows.booleanValue();
  76   }
  77
  78   /**
  79    *
  80    * @return true if we are running in non-interactive no UI mode
  81    */
  82   public static boolean isHeadless()
  83   {
  84     if (isHeadless == null)
  85     {
  86       isHeadless = "true".equals(System.getProperty("java.awt.headless"));
  87     }
  88     return isHeadless;
  89   }
  90
  91   /**
  92    *
  93    * @return nominal maximum command line length for this platform
  94    */
  95   public static int getMaxCommandLineLength()
  96   {
  97     // TODO: determine nominal limits for most platforms.
  98     return 2046; // this is the max length for a windows NT system.
  99   }
 100
 101   /**
 102    * Answers the input with every backslash replaced with a double backslash (an
 103    * 'escaped' single backslash)
 104    *
 105    * @param s
 106    * @return
 107    */
 108   public static String escapeBackslashes(String s)
 109   {
 110     return s == null ? null : s.replace("\\", "\\\\");
 111   }
 112
 113   /**
 114    * Answers true if the mouse event has Meta-down (Command key on Mac) or
 115    * Ctrl-down (on other o/s). Note this answers _false_ if the Ctrl key is
 116    * pressed instead of the Meta/Cmd key on Mac. To test for Ctrl-click on Mac,
 117    * you can use e.isPopupTrigger().
 118    *
 119    * @param e
 120    * @return
 121    */
 122   public static boolean isControlDown(MouseEvent e)
 123   {
 124     boolean aMac = isAMac();
 125     return isControlDown(e, aMac);
 126   }
 127
 128   /**
 129    * Overloaded version of method (to allow unit testing)
 130    *
 131    * @param e
 132    * @param aMac
 133    * @return
 134    */
 135   protected static boolean isControlDown(MouseEvent e, boolean aMac)
 136   {
 137     if (aMac)
 138     {
 139       /*
 140        * answer false for right mouse button
 141        */
 142       if (e.isPopupTrigger())
 143       {
 144         return false;
 145       }
 146       return (jalview.util.ShortcutKeyMaskExWrapper
 147               .getMenuShortcutKeyMaskEx() // .getMenuShortcutKeyMaskEx()
 148               & jalview.util.ShortcutKeyMaskExWrapper
 149                       .getModifiersEx(e)) != 0; // getModifiers()) != 0;
 150     }
 151     return e.isControlDown();
 152   }
 153
 154   /**
 155    * A (case sensitive) file path comparator that ignores the difference between
 156    * / and \
 157    *
 158    * @param path1
 159    * @param path2
 160    * @return
 161    */
 162   public static boolean pathEquals(String path1, String path2)
 163   {
 164     if (path1 == null)
 165     {
 166       return path2 == null;
 167     }
 168     if (path2 == null)
 169     {
 170       return false;
 171     }
 172     String p1 = path1.replace('\\', '/');
 173     String p2 = path2.replace('\\', '/');
 174     return p1.equals(p2);
 175   }
 176 }