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