src/org/xwt/Platform.java

   1 // Copyright 2002 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.ProxyInfo cachedProxyInfo = null;
  38
  39     // VM Detection Logic /////////////////////////////////////////////////////////////////////
  40
  41     /** do-nothing method that forces &lt;clinit&gt; to run */
  42     public static void forceLoad() { }
  43
  44     // If you create a new subclass of Platform, you should add logic
  45     // here to detect it. Do not reference your class directly -- use
  46     // reflection.
  47
  48     static {
  49         System.out.println("Detecting JVM...");
  50         try {
  51             String vendor = System.getProperty("java.vendor", "");
  52             String version = System.getProperty("java.version", "");
  53             String os_name = System.getProperty("os.name", "");
  54             String platform_class = null;
  55
  56             //if (os_name.startsWith("Mac OS X")) platform_class = "MacOSX";
  57             if (vendor.startsWith("Free Software Foundation")) {
  58                 if (os_name.startsWith("Window")) platform_class = "Win32";
  59                 else platform_class = "POSIX";
  60             } else if (version.startsWith("1.1") && vendor.startsWith("Netscape")) platform_class = "Netscape";
  61             else if (version.startsWith("1.1") && vendor.startsWith("Microsoft")) platform_class = "Microsoft";
  62             else if (version.startsWith("1.4")) platform_class = "Java14";
  63             else if (!version.startsWith("1.0") && !version.startsWith("1.1")) platform_class = "Java12";
  64
  65             if (platform_class != null) {
  66                 platform = (Platform)Class.forName("org.xwt.plat." + platform_class).newInstance();
  67                 platform.init();
  68             }
  69
  70             if (Log.on) Log.log(Platform.class, "XWT VM detection:   vendor = " + vendor);
  71             if (Log.on) Log.log(Platform.class, "                   version = " + version);
  72             if (Log.on) Log.log(Platform.class, "                        os = " + os_name);
  73
  74             if (platform_class == null) {
  75                 if (Log.on) Log.log(Platform.class, "Unable to detect JVM");
  76                 System.exit(-1);
  77             }
  78
  79             if (Log.on) Log.log(Platform.class, "                  platform = " + platform.getDescriptiveName());
  80             if (Log.on) Log.log(Platform.class, "                     class = " + platform.getClass().getName());
  81
  82         } catch (Exception e) {
  83             if (Log.on) Log.log(Platform.class, "Exception while trying to detect JVM");
  84             if (Log.on) Log.log(Platform.class, e);
  85             System.exit(-1);
  86         }
  87
  88     }
  89
  90
  91     // Methods to be Overridden ////////////////////////////////////////////////////////////////////
  92
  93     /** a string describing the VM */
  94     protected String getDescriptiveName() { return "Generic Java 1.1 VM"; }
  95
  96     /** this initializes the platform; code in here can invoke methods on Platform since Platform.platform has already been set */
  97     protected void init() { }
  98
  99     /** creates and returns a doublebuffer 'belonging' to <tt>owner</tt>; we need to associate DoubleBuffers to surfaces
 100      *  due to AWT 1.1 requirements (definately for Navigator, possibly also for MSJVM).
 101      */
 102     protected DoubleBuffer _createDoubleBuffer(int w, int h, Surface owner) { return null; }
 103
 104     /** creates and returns a new surface */
 105     protected Surface _createSurface(Box b, boolean framed) { return null; }
 106
 107     /** creates a socket object */
 108     protected Socket _getSocket(String host, int port, boolean ssl, boolean negotiate) throws IOException {
 109         return ssl ? new TinySSL(host, port, negotiate) : new Socket(java.net.InetAddress.getByName(host), port);
 110     }
 111
 112     /** creates and returns a picture */
 113     protected Picture _createPicture(int[] b, int w, int h) { return null; }
 114
 115     /** should return true if it is safe to supress full-surface dirties immediately after a window resize */
 116     protected boolean _supressDirtyOnResize() { return false; }
 117
 118     /** the human-readable name of the key mapped to XWT's 'alt' key */
 119     protected String _altKeyName() { return "alt"; }
 120
 121     /** opens a connection to the resource identified by URL u, and returns an InputStream */
 122     protected InputStream _urlToInputStream(URL u) throws IOException { return u.openStream(); }
 123
 124     /** returns the contents of the clipboard */
 125     protected String _getClipBoard() { return null; }
 126
 127     /** sets the contents of the clipboard */
 128     protected void _setClipBoard(String s) { }
 129
 130     /** returns the width of the screen, in pixels */
 131     protected int _getScreenWidth() { return 640; }
 132
 133     /** returns the height of the screen, in pixels */
 134     protected int _getScreenHeight() { return 480; }
 135
 136     /** returns the width of a string in a platform-specific font */
 137     protected int _stringWidth(String font, String text) { return 10 * text.length(); }
 138
 139     /** returns the maximum ascent of all glyphs in a given platform-specific font */
 140     protected int _getMaxAscent(String font) { return 10; }
 141
 142     /** returns the maximum descent of all glyphs in a given platform-specific font */
 143     protected int _getMaxDescent(String font) { return 2; }
 144
 145     /** returns a list of all platform-specific fonts available */
 146     protected String[] _listFonts() { return new String[] { }; }
 147
 148     /** returns the maximum number of threads that the XWT engine can create without adversely affecting the host OS */
 149     protected int _maxThreads() { return 25; }
 150
 151     /** creates a weak reference */
 152     protected org.xwt.Weak _getWeak(final Object o) {
 153         return new org.xwt.Weak() {
 154                 public Object get() { return o; }
 155             };
 156     }
 157
 158     /** quits XWT */
 159     protected void _exit() { System.exit(0); }
 160
 161     /** used to notify the user of very serious failures; usually used when logging is not working or unavailable */
 162     protected void _criticalAbort(String message) { System.exit(-1); }
 163
 164     /** used to notify the user of very serious failures; usually used when logging is not working or unavailable */
 165     protected String _getDefaultFont() { return "sansserif10"; }
 166
 167     /** if true, org.xwt.Surface will generate a Click automatically after a press and a release */
 168     protected boolean _needsAutoClick() { return false; }
 169
 170     /** if true, org.xwt.Surface will generate a DoubleClick automatically after recieving two clicks in a short period of time */
 171     protected boolean _needsAutoDoubleClick() { return false; }
 172
 173     protected void _newBrowserWindow(String url) {
 174         if (Log.on) Log.log(this, "Platform " + platform.getClass().getName() + " cannot open browser windows");
 175         return;
 176     }
 177
 178     /** Returns null if XWT should always use direct connection; otherwise returns a ProxyInfo object with proxy settings */
 179     protected synchronized HTTP.ProxyInfo _detectProxy() { return null; }
 180
 181     /** displays a platform-specific "open file" dialog and returns the chosen filename */
 182     protected String _fileDialog(String suggestedFileName, boolean write) { return null; }
 183
 184     /** returns true iff the platform has a case-sensitive filesystem */
 185     protected boolean _isCaseSensitive() { return true; }
 186
 187
 188     // Static methods -- thunk to the instance /////////////////////////////////////////////////////////////////////////
 189
 190     /** if true, org.xwt.Surface should generate Click messages automatically when a Release happens after a Press and the mouse has not moved much */
 191     public static boolean needsAutoClick() { return platform._needsAutoClick(); }
 192
 193     /** if true, org.xwt.Surface should generate DoubleClick messages automatically when needed */
 194     public static boolean needsAutoDoubleClick() { return platform._needsAutoDoubleClick(); }
 195
 196     /** should return true if it is safe to supress full-surface dirties immediately after a window resize */
 197     public static String getDefaultFont() { return platform._getDefaultFont(); }
 198
 199     /** should return true if it is safe to supress full-surface dirties immediately after a window resize */
 200     public static boolean supressDirtyOnResize() { return platform._supressDirtyOnResize(); }
 201
 202     /** returns the width of a string in a platform-specific font */
 203     public static int stringWidth(String font, String text) { return platform._stringWidth(font, text); }
 204
 205     /** returns the maximum ascent of all glyphs in a given platform-specific font */
 206     public static int getMaxAscent(String font) { return platform._getMaxAscent(font); }
 207
 208     /** returns the maximum descent of all glyphs in a given platform-specific font. Three pixel minimum ensures space for underline. */
 209     public static int getMaxDescent(String font) { return Math.max(3, platform._getMaxDescent(font)); }
 210
 211     /** returns the maximum number of threads that the XWT engine can create without adversely affecting the host OS */
 212     public static int maxThreads() { return platform._maxThreads(); }
 213
 214     /** returns a list of all platform-specific fonts available */
 215     public static String[] listFonts() { return platform._listFonts(); }
 216
 217     /** creates a weak reference */
 218     public static org.xwt.Weak getWeak(Object o) { return platform._getWeak(o); }
 219
 220     /** opens a connection to the resource identified by URL u, and returns an InputStream */
 221     public static InputStream urlToInputStream(URL u) throws IOException { return platform._urlToInputStream(u); }
 222
 223     /** returns the contents of the clipboard */
 224     public static Object getClipBoard() { return clipboardReadEnabled ? platform._getClipBoard() : null; }
 225
 226     /** sets the contents of the clipboard */
 227     public static void setClipBoard(String s) { platform._setClipBoard(s); }
 228
 229     /** creates a socket object, with or without ssl encryption */
 230     public static Socket getSocket(String host, int port, boolean ssl, boolean negotiate) throws IOException {
 231         return platform._getSocket(host, port, ssl, negotiate);
 232     }
 233
 234     /** returns the width of the screen, in pixels */
 235     public static int getScreenWidth() { return platform._getScreenWidth(); }
 236
 237     /** returns the height of the screen, in pixels */
 238     public static int getScreenHeight() { return platform._getScreenHeight(); }
 239
 240     /** creates and returns a doublebuffer 'belonging' to <tt>owner</tt> */
 241     public static DoubleBuffer createDoubleBuffer(int w, int h, Surface s) { return platform._createDoubleBuffer(w, h, s); }
 242
 243     /** creates and returns a picture */
 244     public static Picture createPicture(int[] data, int w, int h) { return platform._createPicture(data, w, h); }
 245
 246     /** creates and returns a picture */
 247     public static Picture createPicture(ImageDecoder i) { return platform._createPicture(i.getData(), i.getWidth(), i.getHeight()); }
 248
 249     /** returns true iff the platform has a case-sensitive filesystem */
 250     public static boolean isCaseSensitive() { return platform._isCaseSensitive(); }
 251
 252     /** displays a platform-specific "open file" dialog and returns the chosen filename */
 253     public static String fileDialog(String suggestedFileName, boolean write) {
 254         // put ourselves in the background
 255         Thread thread = Thread.currentThread();
 256         if (!(thread instanceof ThreadMessage)) {
 257             if (Log.on) Log.log(Platform.class, "xwt.openFile may only be called from background threads");
 258             return null;
 259         }
 260         ThreadMessage mythread = (ThreadMessage)thread;
 261         mythread.setPriority(Thread.MIN_PRIORITY);
 262         mythread.done.release();
 263
 264         try {
 265             return platform._fileDialog(suggestedFileName, write);
 266         } finally {
 267             // okay, let ourselves be brought to the foreground
 268             MessageQueue.add(mythread);
 269             mythread.setPriority(Thread.NORM_PRIORITY);
 270             mythread.go.block();
 271         }
 272     }
 273
 274     /** opens a new browser window */
 275     public static void newBrowserWindow(String url) {
 276         if (!(url.startsWith("https://") || url.startsWith("http://") || url.startsWith("ftp://") || url.startsWith("mailto:"))) {
 277             if (Log.on) Log.log(Platform.class, "xwt.newBrowserWindow() only supports http and https urls");
 278             return;
 279         }
 280         if (Log.on) Log.log(Platform.class, "newBrowserWindow, url = " + url);
 281         platform._newBrowserWindow(url);
 282     }
 283
 284     /** quits XWT */
 285     public static void exit() {
 286         Log.log(Platform.class, "exiting via Platform.exit()");
 287         platform._exit();
 288     }
 289
 290     /** the human-readable name of the key mapped to XWT's 'alt' key */
 291     public static String altKeyName() { return platform._altKeyName(); }
 292
 293     /** used to notify the user of very serious failures; usually used when logging is not working or unavailable */
 294     public static void criticalAbort(String message) {
 295         if (Log.on) Log.log(Platform.class, "Critical Abort:");
 296         if (Log.on) Log.log(Platform.class, message);
 297         platform._criticalAbort(message);
 298     }
 299
 300     /** this method invokes the platform _createSurface() method and then enforces a few post-call invariants */
 301     public static Surface createSurface(Box b, boolean framed, boolean refreshable) {
 302         Surface ret = platform._createSurface(b, framed);
 303         ret.setInvisible(b.invisible);
 304         b.set(Box.size, 0, ret.width);
 305         b.set(Box.size, 1, ret.height);
 306
 307         Object titlebar = b.get("titlebar", null, true);
 308         if (titlebar != null) ret.setTitleBarText(titlebar.toString());
 309
 310         Object icon = b.get("icon", null, true);
 311         if (icon != null && !"".equals(icon)) {
 312             Picture pic = Box.getPicture(icon.toString());
 313             if (pic != null) ret.setIcon(pic);
 314             else if (Log.on) Log.log(Platform.class, "unable to load icon " + icon);
 315         }
 316
 317         ret.setLimits(b.dmin(0), b.dmin(1), b.dmax(0), b.dmax(1));
 318
 319         if (refreshable) {
 320             Surface.refreshableSurfaceWasCreated = true;
 321             Surface.allSurfaces.addElement(ret);
 322             ret.dirty(0, 0, ret.width, ret.height);
 323             ret.Refresh();
 324         }
 325         return ret;
 326     }
 327
 328     /** detects proxy settings */
 329     public static synchronized HTTP.ProxyInfo detectProxy() {
 330
 331         if (cachedProxyInfo != null) return cachedProxyInfo;
 332         if (alreadyDetectedProxy) return null;
 333         alreadyDetectedProxy = true;
 334
 335         if (Log.on) Log.log(Platform.class, "attempting xwt-proxy DNS proxy detection");
 336         cachedProxyInfo = HTTP.ProxyInfo.detectProxyViaManual();
 337         if (cachedProxyInfo != null) return cachedProxyInfo;
 338
 339         if (Log.on) Log.log(Platform.class, "attempting " + platform.getClass().getName() + " proxy detection");
 340         cachedProxyInfo = platform._detectProxy();
 341         if (cachedProxyInfo != null) return cachedProxyInfo;
 342
 343         if (Log.on) Log.log(Platform.class, "attempting WPAD proxy detection");
 344         cachedProxyInfo = HTTP.ProxyInfo.detectProxyViaWPAD();
 345         if (cachedProxyInfo != null) return cachedProxyInfo;
 346
 347         return cachedProxyInfo;
 348     }
 349
 350     // Helpful font parsing stuff //////////////////////////////////////////////////////
 351
 352     public static class ParsedFont {
 353         public ParsedFont() { }
 354         public ParsedFont(String s) { parse(s); }
 355         public int size = 10;
 356         public String name = "";
 357
 358         public boolean italic = false;
 359         public boolean bold = false;
 360         public boolean underline = false;
 361         public boolean dotted_underline = false;
 362
 363         private static int stoi(Object o) {
 364             if (o == null) return 0;
 365             if (o instanceof Integer) return ((Integer)o).intValue();
 366
 367             String s = o.toString();
 368             try { return Integer.parseInt(s.indexOf('.') == -1 ? s : s.substring(0, s.indexOf('.'))); }
 369             catch (NumberFormatException e) { return 0; }
 370         }
 371
 372         public void parse(String font) {
 373             int i = 0;
 374             while(i < font.length() && !Character.isDigit(font.charAt(i)) && font.charAt(i) != '*') i++;
 375             name = font.substring(0, i).toLowerCase().replace('_', ' ');
 376             size = 10;
 377             italic = false;
 378             bold = false;
 379             underline = false;
 380             dotted_underline = false;
 381             if (i != font.length()) {
 382                 if (font.charAt(i) == '*') {
 383                     size = 0;
 384                     i++;
 385                 } else {
 386                     int j = i;
 387                     while (j < font.length() && Character.isDigit(font.charAt(j))) j++;
 388                     if (i != j) size = stoi(font.substring(i, j));
 389                     i = j;
 390                 }
 391                 while(i < font.length()) {
 392                     switch (font.charAt(i)) {
 393                     case 'b': bold = true; break;
 394                     case 'i': italic = true; break;
 395                     case 'd': dotted_underline = true; break;
 396                     case 'u': underline = true; break;
 397                     }
 398                     i++;
 399                 }
 400             }
 401         }
 402
 403     }
 404
 405 }
 406
 407