1 // Copyright 2002 Adam Megacz, see the COPYING file for licensing [GPL]
4 import java.lang.reflect.*;
11 * Abstracts away the small irregularities in JVM implementations.
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.
20 public class Platform {
22 // Static Data /////////////////////////////////////////////////////////////////////////////////////
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
28 static boolean clipboardReadEnabled = false;
30 /** The appropriate Platform object for this JVM */
31 static Platform platform = null;
33 /** true if proxy autodetection has already been run */
34 static boolean alreadyDetectedProxy = false;
36 /** the result of proxy autodetection */
37 static Proxy cachedProxyInfo = null;
39 /** the current build */
40 public static String build = "unknown";
42 // VM Detection Logic /////////////////////////////////////////////////////////////////////
44 /** do-nothing method that forces <clinit> to run */
45 public static void forceLoad() { }
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
52 System.err.println("Detecting JVM...");
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;
60 //if (os_name.startsWith("Mac OS X")) platform_class = "MacOSX";
61 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";
68 // Disable 2d hardware acceleration on Jaguar
69 if (os_name.equals("Mac OS X") && os_version.equals("10.2"))
70 System.setProperty("com.apple.hwaccel", "false");
72 if (platform_class != null) {
73 platform = (Platform)Class.forName("org.xwt.plat." + platform_class).newInstance();
78 build = (String)Class.forName("org.xwt.Build").getField("build").get(null);
79 } catch (ClassNotFoundException cnfe) {
80 } catch (Exception e) {
81 if (Log.on) Log.log(Platform.class, "exception while detecting build:");
82 if (Log.on) Log.log(Platform.class, e);
84 if (Log.on) Log.log(Platform.class, "XWT build: " + build);
86 if (Log.on) Log.log(Platform.class, "XWT VM detection: vendor = " + vendor);
87 if (Log.on) Log.log(Platform.class, " version = " + version);
88 if (Log.on) Log.log(Platform.class, " os = " + os_name + " [version " + os_version + "]");
89 if (Log.on && Main.applet != null) Log.log(Platform.class, " browser = " + Main.applet.getParameter("browser"));
91 if (platform_class == null) {
92 if (Log.on) Log.log(Platform.class, "Unable to detect JVM");
93 new Platform().criticalAbort("Unable to detect JVM");
96 if (Log.on) Log.log(Platform.class, " platform = " + platform.getDescriptiveName());
97 if (Log.on) Log.log(Platform.class, " class = " + platform.getClass().getName());
100 } catch (Exception e) {
101 if (Log.on) Log.log(Platform.class, "Exception while trying to detect JVM");
102 if (Log.on) Log.log(Platform.class, e);
103 new Platform().criticalAbort("Unable to detect JVM");
109 // Methods to be Overridden ////////////////////////////////////////////////////////////////////
111 /** a string describing the VM */
112 protected String getDescriptiveName() { return "Generic Java 1.1 VM"; }
114 /** this initializes the platform; code in here can invoke methods on Platform since Platform.platform has already been set */
115 protected void init() { }
116 protected void postInit() { }
118 /** creates and returns a doublebuffer 'belonging' to <tt>owner</tt>; we need to associate DoubleBuffers to surfaces
119 * due to AWT 1.1 requirements (definately for Navigator, possibly also for MSJVM).
121 protected DoubleBuffer _createDoubleBuffer(int w, int h, Surface owner) { return null; }
123 /** creates and returns a new surface */
124 protected Surface _createSurface(Box b, boolean framed) { return null; }
126 /** creates a socket object */
127 protected Socket _getSocket(String host, int port, boolean ssl, boolean negotiate) throws IOException {
128 Socket ret = ssl ? new TinySSL(host, port, negotiate) : new Socket(java.net.InetAddress.getByName(host), port);
129 ret.setTcpNoDelay(true);
133 /** creates and returns a picture */
134 protected Picture _createPicture(int[] b, int w, int h) { return null; }
136 /** should return true if it is safe to supress full-surface dirties immediately after a window resize */
137 protected boolean _supressDirtyOnResize() { return false; }
139 /** the human-readable name of the key mapped to XWT's 'alt' key */
140 protected String _altKeyName() { return "alt"; }
142 /** opens a connection to the resource identified by URL u, and returns an InputStream */
143 protected InputStream _urlToInputStream(URL u) throws IOException { return u.openStream(); }
145 /** returns the contents of the clipboard */
146 protected String _getClipBoard() { return null; }
148 /** sets the contents of the clipboard */
149 protected void _setClipBoard(String s) { }
151 /** returns the width of the screen, in pixels */
152 protected int _getScreenWidth() { return 640; }
154 /** returns the height of the screen, in pixels */
155 protected int _getScreenHeight() { return 480; }
157 /** returns the width of a string in a platform-specific font */
158 protected int _stringWidth(String font, String text) { return 10 * text.length(); }
160 /** returns the maximum ascent of all glyphs in a given platform-specific font */
161 protected int _getMaxAscent(String font) { return 10; }
163 /** returns the maximum descent of all glyphs in a given platform-specific font */
164 protected int _getMaxDescent(String font) { return 2; }
166 /** returns a list of all platform-specific fonts available */
167 protected String[] _listFonts() { return new String[] { }; }
169 /** returns the maximum number of threads that the XWT engine can create without adversely affecting the host OS */
170 protected int _maxThreads() { return 25; }
172 /** creates a weak reference */
173 protected org.xwt.Weak _getWeak(final Object o) {
174 return new org.xwt.Weak() {
175 public Object get() { return o; }
180 protected void _exit() {
181 if (Main.applet == null) {
184 // just block ourselves forever
186 new Semaphore().block();
190 /** used to notify the user of very serious failures; usually used when logging is not working or unavailable */
191 protected void _criticalAbort(String message) { _exit(); }
193 /** used to notify the user of very serious failures; usually used when logging is not working or unavailable */
194 protected String _getDefaultFont() { return "sansserif10"; }
196 /** if true, org.xwt.Surface will generate a Click automatically after a press and a release */
197 protected boolean _needsAutoClick() { return false; }
199 /** if true, org.xwt.Surface will generate a DoubleClick automatically after recieving two clicks in a short period of time */
200 protected boolean _needsAutoDoubleClick() { return false; }
202 protected void _newBrowserWindow(String url) {
203 if (Log.on) Log.log(this, "Platform " + platform.getClass().getName() + " cannot open browser windows");
207 /** Returns null if XWT should always use direct connection; otherwise returns a ProxyInfo object with proxy settings */
208 protected synchronized Proxy _detectProxy() { return null; }
210 /** displays a platform-specific "open file" dialog and returns the chosen filename, or null if the user hit cancel */
211 protected String _fileDialog(String suggestedFileName, boolean write) { return null; }
213 /** returns true iff the platform has a case-sensitive filesystem */
214 protected boolean _isCaseSensitive() { return true; }
216 /** returns the value of the environment variable key, or null if no such key exists */
217 protected String _getEnv(String key) {
219 String os = System.getProperty("os.name").toLowerCase();
221 if (os.indexOf("windows 9") != -1 || os.indexOf("windows me") != -1) {
222 // hack -- jdk1.2/1.3 on Win32 pop open an ugly DOS box; 1.4 does not
223 if (platform.getClass().getName().endsWith("Java12")) return null;
224 p = Runtime.getRuntime().exec("command.com /c set");
225 } else if (os.indexOf("windows") > -1) {
226 // hack -- jdk1.2/1.3 on Win32 pop open an ugly DOS box; 1.4 does not
227 if (platform.getClass().getName().endsWith("Java12")) return null;
228 p = Runtime.getRuntime().exec("cmd.exe /c set");
230 p = Runtime.getRuntime().exec("env");
232 BufferedReader br = new BufferedReader(new InputStreamReader(p.getInputStream()));
234 while ((s = br.readLine()) != null)
235 if (s.startsWith(key + "="))
236 return s.substring(key.length() + 1);
237 } catch (Exception e) {
238 if (Log.on) Log.log(this, "Exception while reading from environment:");
239 if (Log.on) Log.log(this, e);
244 // Static methods -- thunk to the instance /////////////////////////////////////////////////////////////////////////
246 /** if true, org.xwt.Surface should generate Click messages automatically when a Release happens after a Press and the mouse has not moved much */
247 public static boolean needsAutoClick() { return platform._needsAutoClick(); }
249 /** if true, org.xwt.Surface should generate DoubleClick messages automatically when needed */
250 public static boolean needsAutoDoubleClick() { return platform._needsAutoDoubleClick(); }
252 /** should return true if it is safe to supress full-surface dirties immediately after a window resize */
253 public static String getDefaultFont() { return platform._getDefaultFont(); }
255 /** should return true if it is safe to supress full-surface dirties immediately after a window resize */
256 public static boolean supressDirtyOnResize() { return platform._supressDirtyOnResize(); }
258 /** returns the width of a string in a platform-specific font */
259 public static int stringWidth(String font, String text) { return platform._stringWidth(font, text); }
261 /** returns the maximum ascent of all glyphs in a given platform-specific font */
262 public static int getMaxAscent(String font) { return platform._getMaxAscent(font); }
264 /** returns the maximum descent of all glyphs in a given platform-specific font. Three pixel minimum ensures space for underline. */
265 public static int getMaxDescent(String font) { return Math.max(3, platform._getMaxDescent(font)); }
267 /** returns the maximum number of threads that the XWT engine can create without adversely affecting the host OS */
268 public static int maxThreads() { return platform._maxThreads(); }
270 /** returns a list of all platform-specific fonts available */
271 public static String[] listFonts() { return platform._listFonts(); }
273 /** creates a weak reference */
274 public static org.xwt.Weak getWeak(Object o) { return platform._getWeak(o); }
276 /** opens a connection to the resource identified by URL u, and returns an InputStream */
277 public static InputStream urlToInputStream(URL u) throws IOException { return platform._urlToInputStream(u); }
279 /** returns the contents of the clipboard */
280 public static Object getClipBoard() { return clipboardReadEnabled ? platform._getClipBoard() : null; }
282 /** sets the contents of the clipboard */
283 public static void setClipBoard(String s) { platform._setClipBoard(s); }
285 /** creates a socket object, with or without ssl encryption */
286 public static Socket getSocket(String host, int port, boolean ssl, boolean negotiate) throws IOException {
287 return platform._getSocket(host, port, ssl, negotiate);
290 /** returns the width of the screen, in pixels */
291 public static int getScreenWidth() { return platform._getScreenWidth(); }
293 /** returns the height of the screen, in pixels */
294 public static int getScreenHeight() { return platform._getScreenHeight(); }
296 /** creates and returns a doublebuffer 'belonging' to <tt>owner</tt> */
297 public static DoubleBuffer createDoubleBuffer(int w, int h, Surface s) { return platform._createDoubleBuffer(w, h, s); }
299 /** creates and returns a picture */
300 public static Picture createPicture(int[] data, int w, int h) { return platform._createPicture(data, w, h); }
302 /** creates and returns a picture */
303 public static Picture createPicture(ImageDecoder i) { return platform._createPicture(i.getData(), i.getWidth(), i.getHeight()); }
305 /** returns true iff the platform has a case-sensitive filesystem */
306 public static boolean isCaseSensitive() { return platform._isCaseSensitive(); }
308 /** returns the value of the environment variable key, or null if no such key exists */
309 public static String getEnv(String key) { return platform._getEnv(key); }
311 /** displays a platform-specific "open file" dialog and returns the chosen filename, or null if the user hit cancel */
312 public static String fileDialog(String suggestedFileName, boolean write) {
313 if (!ThreadMessage.suspendThread()) return null;
315 return platform._fileDialog(suggestedFileName, write);
317 ThreadMessage.resumeThread();
321 /** opens a new browser window */
322 public static void newBrowserWindow(String url) {
323 if (!(url.startsWith("https://") || url.startsWith("http://") || url.startsWith("ftp://") || url.startsWith("mailto:"))) {
324 if (Log.on) Log.log(Platform.class, "xwt.newBrowserWindow() only supports http and https urls");
328 // check the URL for well-formedness, as a defense against buffer overflow attacks
331 if (u.startsWith("https")) u = "http" + u.substring(5);
333 } catch (MalformedURLException e) {
334 if (Log.on) Log.log(Platform.class, "URL " + url + " is not well-formed");
335 if (Log.on) Log.log(Platform.class, e);
338 if (Log.on) Log.log(Platform.class, "newBrowserWindow, url = " + url);
339 platform._newBrowserWindow(url);
343 public static void exit() {
344 Log.log(Platform.class, "exiting via Platform.exit()");
348 /** the human-readable name of the key mapped to XWT's 'alt' key */
349 public static String altKeyName() { return platform._altKeyName(); }
351 /** used to notify the user of very serious failures; usually used when logging is not working or unavailable */
352 public static void criticalAbort(String message) {
353 if (Log.on) Log.log(Platform.class, "Critical Abort:");
354 if (Log.on) Log.log(Platform.class, message);
355 platform._criticalAbort(message);
358 /** this method invokes the platform _createSurface() method and then enforces a few post-call invariants */
359 public static Surface createSurface(Box b, boolean framed, boolean refreshable) {
360 Surface ret = platform._createSurface(b, framed);
361 ret.setInvisible(b.invisible);
362 b.set(Box.size, 0, b.size(0) < Surface.scarPicture.getWidth() ? Surface.scarPicture.getWidth() : b.size(0));
363 b.set(Box.size, 1, b.size(1) < Surface.scarPicture.getHeight() ? Surface.scarPicture.getHeight() : b.size(1));
365 Object titlebar = b.get("titlebar", null, true);
366 if (titlebar != null) ret.setTitleBarText(titlebar.toString());
368 Object icon = b.get("icon", null, true);
369 if (icon != null && !"".equals(icon)) {
370 Picture pic = Box.getPicture(icon.toString());
371 if (pic != null) ret.setIcon(pic);
372 else if (Log.on) Log.log(Platform.class, "unable to load icon " + icon);
375 ret.setLimits(b.dmin(0), b.dmin(1), b.dmax(0), b.dmax(1));
378 Surface.refreshableSurfaceWasCreated = true;
379 Surface.allSurfaces.addElement(ret);
380 ret.dirty(0, 0, ret.width, ret.height);
386 /** detects proxy settings */
387 public static synchronized Proxy detectProxy() {
389 if (cachedProxyInfo != null) return cachedProxyInfo;
390 if (alreadyDetectedProxy) return null;
391 alreadyDetectedProxy = true;
393 if (Log.on) Log.log(Platform.class, "attempting environment-variable DNS proxy detection");
394 cachedProxyInfo = Proxy.detectProxyViaManual();
395 if (cachedProxyInfo != null) return cachedProxyInfo;
397 if (Log.on) Log.log(Platform.class, "attempting " + platform.getClass().getName() + " proxy detection");
398 cachedProxyInfo = platform._detectProxy();
399 if (cachedProxyInfo != null) return cachedProxyInfo;
401 return cachedProxyInfo;
404 // Helpful font parsing stuff //////////////////////////////////////////////////////
406 public static class ParsedFont {
407 public ParsedFont() { }
408 public ParsedFont(String s) { parse(s); }
409 public int size = 10;
410 public String name = "";
412 public boolean italic = false;
413 public boolean bold = false;
414 public boolean underline = false;
415 public boolean dotted_underline = false;
417 private static int stoi(Object o) {
418 if (o == null) return 0;
419 if (o instanceof Integer) return ((Integer)o).intValue();
421 String s = o.toString();
422 try { return Integer.parseInt(s.indexOf('.') == -1 ? s : s.substring(0, s.indexOf('.'))); }
423 catch (NumberFormatException e) { return 0; }
426 public void parse(String font) {
428 while(i < font.length() && !Character.isDigit(font.charAt(i)) && font.charAt(i) != '*') i++;
429 name = font.substring(0, i).toLowerCase().replace('_', ' ');
434 dotted_underline = false;
435 if (i != font.length()) {
436 if (font.charAt(i) == '*') {
441 while (j < font.length() && Character.isDigit(font.charAt(j))) j++;
442 if (i != j) size = stoi(font.substring(i, j));
445 while(i < font.length()) {
446 switch (font.charAt(i)) {
447 case 'b': bold = true; break;
448 case 'i': italic = true; break;
449 case 'd': dotted_underline = true; break;
450 case 'u': underline = true; break;