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;
  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     return isAMac.booleanValue();
  49
  50   }
  51
  52   public static boolean isHeadless()
  53   {
  54     if (isHeadless == null)
  55     {
  56       isHeadless = "true".equals(System.getProperty("java.awt.headless"));
  57     }
  58     return isHeadless;
  59   }
  60
  61   /**
  62    *
  63    * @return nominal maximum command line length for this platform
  64    */
  65   public static int getMaxCommandLineLength()
  66   {
  67     // TODO: determine nominal limits for most platforms.
  68     return 2046; // this is the max length for a windows NT system.
  69   }
  70
  71   /**
  72    * escape a string according to the local platform's escape character
  73    *
  74    * @param file
  75    * @return escaped file
  76    */
  77   public static String escapeString(String file)
  78   {
  79     StringBuffer f = new StringBuffer();
  80     int p = 0, lastp = 0;
  81     while ((p = file.indexOf('\\', lastp)) > -1)
  82     {
  83       f.append(file.subSequence(lastp, p));
  84       f.append("\\\\");
  85       lastp = p + 1;
  86     }
  87     f.append(file.substring(lastp));
  88     return f.toString();
  89   }
  90
  91   /**
  92    * Answers true if the mouse event has Meta-down (Command key on Mac) or
  93    * Ctrl-down (on other o/s). Note this answers _false_ if the Ctrl key is
  94    * pressed instead of the Meta/Cmd key on Mac. To test for Ctrl-click on Mac,
  95    * you can use e.isPopupTrigger().
  96    *
  97    * @param e
  98    * @return
  99    */
 100   public static boolean isControlDown(MouseEvent e)
 101   {
 102     boolean aMac = isAMac();
 103     return isControlDown(e, aMac);
 104   }
 105
 106   /**
 107    * Overloaded version of method (to allow unit testing)
 108    *
 109    * @param e
 110    * @param aMac
 111    * @return
 112    */
 113   protected static boolean isControlDown(MouseEvent e, boolean aMac)
 114   {
 115     if (aMac)
 116     {
 117       /*
 118        * answer false for right mouse button
 119        */
 120       if (e.isPopupTrigger())
 121       {
 122         return false;
 123       }
 124       return (Toolkit.getDefaultToolkit().getMenuShortcutKeyMask() & e
 125               .getModifiers()) != 0;
 126       // could we use e.isMetaDown() here?
 127     }
 128     return e.isControlDown();
 129   }
 130 }