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