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;
  33
  34   private static Boolean isHeadless = null;
  35
  36   /**
  37    * sorry folks - Macs really are different
  38    *
  39    * @return true if we do things in a special way.
  40    */
  41   public static boolean isAMac()
  42   {
  43     if (isAMac == null)
  44     {
  45       isAMac = System.getProperty("os.name").indexOf("Mac") > -1;
  46     }
  47
  48     return isAMac.booleanValue();
  49
  50   }
  51
  52   /**
  53    * Check if we are on a Microsoft plaform...
  54    *
  55    * @return true if we have to cope with another platform variation
  56    */
  57   public static boolean isWindows()
  58   {
  59     if (isWindows == null)
  60     {
  61       isWindows = System.getProperty("os.name").indexOf("Win") > -1;
  62     }
  63     return isWindows.booleanValue();
  64   }
  65
  66   /**
  67    *
  68    * @return true if we are running in non-interactive no UI mode
  69    */
  70   public static boolean isHeadless()
  71   {
  72     if (isHeadless == null)
  73     {
  74       isHeadless = "true".equals(System.getProperty("java.awt.headless"));
  75     }
  76     return isHeadless;
  77   }
  78
  79   /**
  80    *
  81    * @return nominal maximum command line length for this platform
  82    */
  83   public static int getMaxCommandLineLength()
  84   {
  85     // TODO: determine nominal limits for most platforms.
  86     return 2046; // this is the max length for a windows NT system.
  87   }
  88
  89   /**
  90    * escape a string according to the local platform's escape character
  91    *
  92    * @param file
  93    * @return escaped file
  94    */
  95   public static String escapeString(String file)
  96   {
  97     StringBuffer f = new StringBuffer();
  98     int p = 0, lastp = 0;
  99     while ((p = file.indexOf('\\', lastp)) > -1)
 100     {
 101       f.append(file.subSequence(lastp, p));
 102       f.append("\\\\");
 103       lastp = p + 1;
 104     }
 105     f.append(file.substring(lastp));
 106     return f.toString();
 107   }
 108
 109   /**
 110    * Answers true if the mouse event has Meta-down (Command key on Mac) or
 111    * Ctrl-down (on other o/s). Note this answers _false_ if the Ctrl key is
 112    * pressed instead of the Meta/Cmd key on Mac. To test for Ctrl-click on Mac,
 113    * you can use e.isPopupTrigger().
 114    *
 115    * @param e
 116    * @return
 117    */
 118   public static boolean isControlDown(MouseEvent e)
 119   {
 120     boolean aMac = isAMac();
 121     return isControlDown(e, aMac);
 122   }
 123
 124   /**
 125    * Overloaded version of method (to allow unit testing)
 126    *
 127    * @param e
 128    * @param aMac
 129    * @return
 130    */
 131   protected static boolean isControlDown(MouseEvent e, boolean aMac)
 132   {
 133     if (aMac)
 134     {
 135       /*
 136        * answer false for right mouse button
 137        */
 138       if (e.isPopupTrigger())
 139       {
 140         return false;
 141       }
 142       return (jalview.util.ShortcutKeyMaskExWrapper.getMenuShortcutKeyMaskEx() // .getMenuShortcutKeyMaskEx()
 143               & e.getModifiersEx()) != 0; // getModifiers()) != 0;
 144     }
 145     return e.isControlDown();
 146   }
 147
 148   /**
 149    * A (case sensitive) file path comparator that ignores the difference between /
 150    * and \
 151    *
 152    * @param path1
 153    * @param path2
 154    * @return
 155    */
 156   public static boolean pathEquals(String path1, String path2)
 157   {
 158     if (path1 == null)
 159     {
 160       return path2 == null;
 161     }
 162     if (path2 == null)
 163     {
 164       return false;
 165     }
 166     String p1 = path1.replace('\\', '/');
 167     String p2 = path2.replace('\\', '/');
 168     return p1.equals(p2);
 169   }
 170 }