src/org/xwt/Platform.java

   1 // Copyright 2003 Adam Megacz, see the COPYING file for licensing [GPL]
   2 package org.xwt;
   3
   4 import java.lang.reflect.*;
   5 import java.net.*;
   6 import java.io.*;
   7 import java.util.*;
   8 import org.xwt.util.*;
   9
  10 /**
  11  *  Abstracts away the small irregularities in JVM implementations.
  12  *
  13  *  The default Platform class supports a vanilla JDK 1.1
  14  *  JVM. Subclasses are provided for other VMs. Methods whose names
  15  *  start with an underscore are meant to be overridden by
  16  *  subclasses. If you create a subclass of Platform, you should put
  17  *  it in the org.xwt.plat package, and add code to this file's static
  18  *  block to detect the new platform.
  19  */
  20 public class Platform {
  21
  22     // Static Data /////////////////////////////////////////////////////////////////////////////////////
  23
  24     /**
  25      *  set to true during the delivery of a KeyPressed:C-v/A-v or Press3; it is safe to use a
  26      *  'global' here, since message delivery is single-threaded and non-preemptable
  27      */
  28     static boolean clipboardReadEnabled = false;
  29
  30     /** The appropriate Platform object for this JVM */
  31     static Platform platform = null;
  32
  33     /** true if proxy autodetection has already been run */
  34     static boolean alreadyDetectedProxy = false;
  35
  36     /** the result of proxy autodetection */
  37     static HTTP.Proxy cachedProxyInfo = null;
  38
  39     /** the current build */
  40     public static String build = "unknown";
  41
  42     // VM Detection Logic /////////////////////////////////////////////////////////////////////
  43
  44     /** do-nothing method that forces &lt;clinit&gt; to run */
  45     public static void forceLoad() { }
  46
  47     // If you create a new subclass of Platform, you should add logic
  48     // here to detect it. Do not reference your class directly -- use
  49     // reflection.
  50
  51     static {
  52         System.err.println("Detecting JVM...");
  53         try {
  54             String vendor = System.getProperty("java.vendor", "");
  55             String version = System.getProperty("java.version", "");
  56             String os_name = System.getProperty("os.name", "");
  57             String os_version = System.getProperty("os.version", "");
  58             String platform_class = null;
  59
  60             if (os_name.startsWith("Darwin")) platform_class = "Darwin";
  61             else if (vendor.startsWith("Free Software Foundation")) {
  62                 if (os_name.startsWith("Window")) platform_class = "Win32";
  63                 else platform_class = "X11";
  64             } else if (version.startsWith("1.1") && vendor.startsWith("Netscape")) platform_class = "Netscape";
  65             else if (version.startsWith("1.1") && vendor.startsWith("Microsoft")) platform_class = "Microsoft";
  66             else if (!version.startsWith("1.0") && !version.startsWith("1.1")) platform_class = "Java2";
  67
  68             /*
  69         // Disable 2d hardware acceleration on Jaguar
  70         if (os_name.equals("Mac OS X") && os_version.equals("10.2"))
  71             */
  72         System.setProperty("com.apple.hwaccel", "false");
  73
  74             if (platform_class != null) {
  75                 platform = (Platform)Class.forName("org.xwt.plat." + platform_class).newInstance();
  76                 platform.init();
  77             }
  78
  79             try {
  80                 build = (String)Class.forName("org.xwt.Build").getField("build").get(null);
  81             } catch (ClassNotFoundException cnfe) {
  82             } catch (Exception e) {
  83                 if (Log.on) Log.log(Platform.class, "exception while detecting build:");
  84                 if (Log.on) Log.log(Platform.class, e);
  85             }
  86             if (Log.on) Log.log(Platform.class, "XWT build: " + build);
  87
  88             if (Log.on) Log.log(Platform.class, "XWT VM detection:   vendor = " + vendor);
  89             if (Log.on) Log.log(Platform.class, "                   version = " + version);
  90             if (Log.on) Log.log(Platform.class, "                        os = " + os_name + " [version " + os_version + "]");
  91
  92             if (platform_class == null) {
  93                 if (Log.on) Log.log(Platform.class, "Unable to detect JVM");
  94                 new Platform().criticalAbort("Unable to detect JVM");
  95             }
  96
  97             if (Log.on) Log.log(Platform.class, "                  platform = " + platform.getDescriptiveName());
  98             if (Log.on) Log.log(Platform.class, "                     class = " + platform.getClass().getName());
  99             platform.postInit();
 100
 101         } catch (Exception e) {
 102             if (Log.on) Log.log(Platform.class, "Exception while trying to detect JVM");
 103             if (Log.on) Log.log(Platform.class, e);
 104             new Platform().criticalAbort("Unable to detect JVM");
 105         }
 106
 107     }
 108
 109
 110     // Methods to be Overridden ////////////////////////////////////////////////////////////////////
 111
 112     /** a string describing the VM */
 113     protected String getDescriptiveName() { return "Generic Java 1.1 VM"; }
 114
 115     /** this initializes the platform; code in here can invoke methods on Platform since Platform.platform has already been set */
 116     protected void init() { }
 117     protected void postInit() { }
 118
 119     /** creates and returns a doublebuffer 'belonging' to <tt>owner</tt>; we need to associate PixelBuffers to surfaces
 120      *  due to AWT 1.1 requirements (definately for Navigator, possibly also for MSJVM).
 121      */
 122     protected PixelBuffer _createPixelBuffer(int w, int h, Surface owner) { return null; }
 123
 124     /** creates and returns a new surface */
 125     protected Surface _createSurface(Box b, boolean framed) { return null; }
 126
 127     /** creates a socket object */
 128     protected Socket _getSocket(String host, int port, boolean ssl, boolean negotiate) throws IOException {
 129         Socket ret = ssl ? new TinySSL(host, port, negotiate) : new Socket(java.net.InetAddress.getByName(host), port);
 130         ret.setTcpNoDelay(true);
 131         return ret;
 132     }
 133
 134     /** creates and returns a picture */
 135     protected Picture _createPicture(int[] b, int w, int h) { return null; }
 136
 137     /** should return true if it is safe to supress full-surface dirties immediately after a window resize */
 138     protected boolean _supressDirtyOnResize() { return false; }
 139
 140     /** the human-readable name of the key mapped to XWT's 'alt' key */
 141     protected String _altKeyName() { return "alt"; }
 142
 143     /** opens a connection to the resource identified by URL u, and returns an InputStream */
 144     protected InputStream _urlToInputStream(URL u) throws IOException { return u.openStream(); }
 145
 146     /** returns the contents of the clipboard */
 147     protected String _getClipBoard() { return null; }
 148
 149     /** sets the contents of the clipboard */
 150     protected void _setClipBoard(String s) { }
 151
 152     /** returns the width of the screen, in pixels */
 153     protected int _getScreenWidth() { return 640; }
 154
 155     /** returns the height of the screen, in pixels */
 156     protected int _getScreenHeight() { return 480; }
 157
 158     /** returns the width of a string in a platform-specific font */
 159     protected int _stringWidth(String font, String text) { return 10 * text.length(); }
 160
 161     /** returns the maximum ascent of all glyphs in a given platform-specific font */
 162     protected int _getMaxAscent(String font) { return 10; }
 163
 164     /** returns the maximum descent of all glyphs in a given platform-specific font */
 165     protected int _getMaxDescent(String font) { return 2; }
 166
 167     /** returns a list of all platform-specific fonts available */
 168     protected String[] _listFonts() { return new String[] { }; }
 169
 170     /** returns the maximum number of threads that the XWT engine can create without adversely affecting the host OS */
 171     protected int _maxThreads() { return 25; }
 172
 173         /** Called once XWT is initialized and the application is running. */
 174         protected void _running() {}
 175
 176     /** quits XWT */
 177     protected void _exit() { System.exit(0); }
 178
 179     /** used to notify the user of very serious failures; usually used when logging is not working or unavailable */
 180     protected void _criticalAbort(String message) { _exit(); }
 181
 182     /** used to notify the user of very serious failures; usually used when logging is not working or unavailable */
 183     protected String _getDefaultFont() { return "sansserif10"; }
 184
 185     /** if true, org.xwt.Surface will generate a Click automatically after a press and a release */
 186     protected boolean _needsAutoClick() { return false; }
 187
 188     /** if true, org.xwt.Surface will generate a DoubleClick automatically after recieving two clicks in a short period of time */
 189     protected boolean _needsAutoDoubleClick() { return false; }
 190
 191     protected void _newBrowserWindow(String url) {
 192         if (Log.on) Log.log(this, "Platform " + platform.getClass().getName() + " cannot open browser windows");
 193         return;
 194     }
 195
 196     /** Returns null if XWT should always use direct connection; otherwise returns a ProxyInfo object with proxy settings */
 197     protected synchronized HTTP.Proxy _detectProxy() { return null; }
 198
 199     /** displays a platform-specific "open file" dialog and returns the chosen filename, or null if the user hit cancel */
 200     protected String _fileDialog(String suggestedFileName, boolean write) { return null; }
 201
 202     /** returns true iff the platform has a case-sensitive filesystem */
 203     protected boolean _isCaseSensitive() { return true; }
 204
 205     /** returns an InputStream to the builtin xwar */
 206     protected InputStream _getBuiltinInputStream() {
 207         return this.getClass().getClassLoader().getResourceAsStream("org/xwt/builtin.jar");
 208     }
 209
 210     /** returns the value of the environment variable key, or null if no such key exists */
 211     protected String _getEnv(String key) {
 212         try {
 213             String os = System.getProperty("os.name").toLowerCase();
 214             Process p;
 215             if (os.indexOf("windows 9") != -1 || os.indexOf("windows me") != -1) {
 216                 // hack -- jdk1.2/1.3 on Win32 pop open an ugly DOS box; 1.4 does not
 217                 if (platform.getClass().getName().endsWith("Java12")) return null;
 218                 p = Runtime.getRuntime().exec("command.com /c set");
 219             } else if (os.indexOf("windows") > -1) {
 220                 // hack -- jdk1.2/1.3 on Win32 pop open an ugly DOS box; 1.4 does not
 221                 if (platform.getClass().getName().endsWith("Java12")) return null;
 222                 p = Runtime.getRuntime().exec("cmd.exe /c set");
 223             } else {
 224                 p = Runtime.getRuntime().exec("env");
 225             }
 226             BufferedReader br = new BufferedReader(new InputStreamReader(p.getInputStream()));
 227             String s;
 228             while ((s = br.readLine()) != null)
 229                 if (s.startsWith(key + "="))
 230                     return s.substring(key.length() + 1);
 231         } catch (Exception e) {
 232             if (Log.on) Log.log(this, "Exception while reading from environment:");
 233             if (Log.on) Log.log(this, e);
 234         }
 235         return null;
 236     }
 237
 238     /** convert a JPEG into an Image */
 239     protected ImageDecoder _decodeJPEG(InputStream is, String name) { return null; }
 240
 241
 242     // Static methods -- thunk to the instance /////////////////////////////////////////////////////////////////////////
 243
 244     /** if true, org.xwt.Surface should generate Click messages automatically when a Release happens after a Press and the mouse has not moved much */
 245     public static boolean needsAutoClick() { return platform._needsAutoClick(); }
 246
 247     /** if true, org.xwt.Surface should generate DoubleClick messages automatically when needed */
 248     public static boolean needsAutoDoubleClick() { return platform._needsAutoDoubleClick(); }
 249
 250     /** should return true if it is safe to supress full-surface dirties immediately after a window resize */
 251     public static String getDefaultFont() { return platform._getDefaultFont(); }
 252
 253     /** should return true if it is safe to supress full-surface dirties immediately after a window resize */
 254     public static boolean supressDirtyOnResize() { return platform._supressDirtyOnResize(); }
 255
 256     /** returns the width of a string in a platform-specific font */
 257     public static int stringWidth(String font, String text) { return platform._stringWidth(font, text); }
 258
 259     /** returns the maximum ascent of all glyphs in a given platform-specific font */
 260     public static int getMaxAscent(String font) { return platform._getMaxAscent(font); }
 261
 262     /** returns the maximum descent of all glyphs in a given platform-specific font. Three pixel minimum ensures space for underline. */
 263     public static int getMaxDescent(String font) { return Math.max(3, platform._getMaxDescent(font)); }
 264
 265     /** returns the maximum number of threads that the XWT engine can create without adversely affecting the host OS */
 266     public static int maxThreads() { return platform._maxThreads(); }
 267
 268     /** returns a list of all platform-specific fonts available */
 269     public static String[] listFonts() { return platform._listFonts(); }
 270
 271     /** opens a connection to the resource identified by URL u, and returns an InputStream */
 272     public static InputStream urlToInputStream(URL u) throws IOException { return platform._urlToInputStream(u); }
 273
 274     /** returns the contents of the clipboard */
 275     public static Object getClipBoard() { return clipboardReadEnabled ? platform._getClipBoard() : null; }
 276
 277     /** sets the contents of the clipboard */
 278     public static void setClipBoard(String s) { platform._setClipBoard(s); }
 279
 280     /** creates a socket object, with or without ssl encryption */
 281     public static Socket getSocket(String host, int port, boolean ssl, boolean negotiate) throws IOException {
 282         return platform._getSocket(host, port, ssl, negotiate);
 283     }
 284
 285     /** returns the width of the screen, in pixels */
 286     public static int getScreenWidth() { return platform._getScreenWidth(); }
 287
 288     /** returns the height of the screen, in pixels */
 289     public static int getScreenHeight() { return platform._getScreenHeight(); }
 290
 291     /** creates and returns a doublebuffer 'belonging' to <tt>owner</tt> */
 292     public static PixelBuffer createPixelBuffer(int w, int h, Surface s) { return platform._createPixelBuffer(w, h, s); }
 293
 294     /** creates and returns a picture */
 295     public static Picture createPicture(int[] data, int w, int h) { return platform._createPicture(data, w, h); }
 296
 297     /** returns an InputStream to the builtin xwar */
 298     public static InputStream getBuiltinInputStream() { return platform._getBuiltinInputStream(); }
 299
 300     /** creates and returns a picture */
 301     public static Picture createPicture(ImageDecoder i) { return platform._createPicture(i.getData(), i.getWidth(), i.getHeight()); }
 302
 303     /** returns true iff the platform has a case-sensitive filesystem */
 304     public static boolean isCaseSensitive() { return platform._isCaseSensitive(); }
 305
 306     /** returns the value of the environment variable key, or null if no such key exists */
 307     public static String getEnv(String key) { return platform._getEnv(key); }
 308
 309     /** displays a platform-specific "open file" dialog and returns the chosen filename, or null if the user hit cancel */
 310     public static String fileDialog(String suggestedFileName, boolean write) {
 311         if (!ThreadMessage.suspendThread()) return null;
 312         try {
 313             return platform._fileDialog(suggestedFileName, write);
 314         } finally {
 315             ThreadMessage.resumeThread();
 316         }
 317     }
 318
 319     /** opens a new browser window */
 320     public static void newBrowserWindow(String url) {
 321         if (!(url.startsWith("https://") || url.startsWith("http://") || url.startsWith("ftp://") || url.startsWith("mailto:"))) {
 322             if (Log.on) Log.log(Platform.class, "xwt.newBrowserWindow() only supports http and https urls");
 323             return;
 324         }
 325
 326         // check the URL for well-formedness, as a defense against buffer overflow attacks
 327         try {
 328             String u = url;
 329             if (u.startsWith("https")) u = "http" + u.substring(5);
 330             new URL(u);
 331         } catch (MalformedURLException e) {
 332             if (Log.on) Log.log(Platform.class, "URL " + url + " is not well-formed");
 333             if (Log.on) Log.log(Platform.class, e);
 334         }
 335
 336         if (Log.on) Log.log(Platform.class, "newBrowserWindow, url = " + url);
 337         platform._newBrowserWindow(url);
 338     }
 339
 340         /** Called once XWT is initialized and the application is running. */
 341         public static void running() {
 342                 Log.log(Platform.class, "XWT is running");
 343                 platform._running();
 344         }
 345
 346     /** quits XWT */
 347     public static void exit() {
 348         Log.log(Platform.class, "exiting via Platform.exit()");
 349         platform._exit();
 350     }
 351
 352     /** the human-readable name of the key mapped to XWT's 'alt' key */
 353     public static String altKeyName() { return platform._altKeyName(); }
 354
 355     /** used to notify the user of very serious failures; usually used when logging is not working or unavailable */
 356     public static void criticalAbort(String message) {
 357         if (Log.on) Log.log(Platform.class, "Critical Abort:");
 358         if (Log.on) Log.log(Platform.class, message);
 359         platform._criticalAbort(message);
 360     }
 361
 362     /** this method invokes the platform _createSurface() method and then enforces a few post-call invariants */
 363     public static Surface createSurface(Box b, boolean framed, boolean refreshable) {
 364         Surface ret = platform._createSurface(b, framed);
 365         b.width = b.height < Surface.scarPicture.getWidth() ? Surface.scarPicture.getWidth() : b.width;
 366         b.height = b.height < Surface.scarPicture.getHeight() ? Surface.scarPicture.getHeight() : b.height;
 367         ret.setInvisible(false);
 368
 369         Object titlebar = b.get("titlebar", true);
 370         if (titlebar != null) ret.setTitleBarText(titlebar.toString());
 371
 372         Object icon = b.get("icon", true);
 373         if (icon != null && !"".equals(icon)) {
 374             Picture pic = ImageDecoder.getPicture(icon.toString());
 375             if (pic != null) ret.setIcon(pic);
 376             else if (Log.on) Log.log(Platform.class, "unable to load icon " + icon);
 377         }
 378
 379         ret.setLimits(b.minwidth, b.minheight, b.maxwidth, b.maxheight);
 380
 381         if (refreshable) {
 382             Surface.refreshableSurfaceWasCreated = true;
 383             Surface.allSurfaces.addElement(ret);
 384             ret.dirty(0, 0, b.width, b.height);
 385             ret.Refresh();
 386         }
 387         return ret;
 388     }
 389
 390     /** detects proxy settings */
 391     public static synchronized HTTP.Proxy detectProxy() {
 392
 393         if (cachedProxyInfo != null) return cachedProxyInfo;
 394         if (alreadyDetectedProxy) return null;
 395         alreadyDetectedProxy = true;
 396
 397         if (Log.on) Log.log(Platform.class, "attempting environment-variable DNS proxy detection");
 398         cachedProxyInfo = HTTP.Proxy.detectProxyViaManual();
 399         if (cachedProxyInfo != null) return cachedProxyInfo;
 400
 401         if (Log.on) Log.log(Platform.class, "attempting " + platform.getClass().getName() + " proxy detection");
 402         cachedProxyInfo = platform._detectProxy();
 403         if (cachedProxyInfo != null) return cachedProxyInfo;
 404
 405         return cachedProxyInfo;
 406     }
 407
 408     public static synchronized ImageDecoder decodeJPEG(InputStream is, String name) {
 409         return platform._decodeJPEG(is, name);
 410     }
 411
 412     // Helpful font parsing stuff //////////////////////////////////////////////////////
 413
 414     public static class ParsedFont {
 415         public ParsedFont() { }
 416         public ParsedFont(String s) { parse(s); }
 417         public int size = 10;
 418         public String name = "";
 419
 420         public boolean italic = false;
 421         public boolean bold = false;
 422         public boolean underline = false;
 423         public boolean dotted_underline = false;
 424
 425         private static int stoi(Object o) {
 426             if (o == null) return 0;
 427             if (o instanceof Integer) return ((Integer)o).intValue();
 428
 429             String s = o.toString();
 430             try { return Integer.parseInt(s.indexOf('.') == -1 ? s : s.substring(0, s.indexOf('.'))); }
 431             catch (NumberFormatException e) { return 0; }
 432         }
 433
 434         public void parse(String font) {
 435             int i = 0;
 436             while(i < font.length() && !Character.isDigit(font.charAt(i)) && font.charAt(i) != '*') i++;
 437             name = font.substring(0, i).toLowerCase().replace('_', ' ');
 438             size = 10;
 439             italic = false;
 440             bold = false;
 441             underline = false;
 442             dotted_underline = false;
 443             if (i != font.length()) {
 444                 if (font.charAt(i) == '*') {
 445                     size = 0;
 446                     i++;
 447                 } else {
 448                     int j = i;
 449                     while (j < font.length() && Character.isDigit(font.charAt(j))) j++;
 450                     if (i != j) size = stoi(font.substring(i, j));
 451                     i = j;
 452                 }
 453                 while(i < font.length()) {
 454                     switch (font.charAt(i)) {
 455                     case 'b': bold = true; break;
 456                     case 'i': italic = true; break;
 457                     case 'd': dotted_underline = true; break;
 458                     case 'u': underline = true; break;
 459                     }
 460                     i++;
 461                 }
 462             }
 463         }
 464
 465     }
 466
 467 }
 468
 469