1 // Copyright 2003 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 org.xwt.HTTP.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("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";
69 // Disable 2d hardware acceleration on Jaguar
70 if (os_name.equals("Mac OS X") && os_version.startsWith("10.2")) System.setProperty("com.apple.hwaccel", "false");
73 if (platform_class != null) {
74 platform = (Platform)Class.forName("org.xwt.plat." + platform_class).newInstance();
79 build = (String)Class.forName("org.xwt.Build").getField("build").get(null);
80 } catch (ClassNotFoundException cnfe) {
81 } catch (Exception e) {
82 if (Log.on) Log.log(Platform.class, "exception while detecting build:");
83 if (Log.on) Log.log(Platform.class, e);
85 if (Log.on) Log.log(Platform.class, "XWT build: " + build);
87 if (Log.on) Log.log(Platform.class, "XWT VM detection: vendor = " + vendor);
88 if (Log.on) Log.log(Platform.class, " version = " + version);
89 if (Log.on) Log.log(Platform.class, " os = " + os_name + " [version " + os_version + "]");
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 PixelBuffers to surfaces
119 * due to AWT 1.1 requirements (definately for Navigator, possibly also for MSJVM).
121 public static PixelBuffer createPixelBuffer(int w, int h, Surface s) { return platform._createPixelBuffer(w, h, s); }
122 protected PixelBuffer _createPixelBuffer(int w, int h, Surface owner) { return null; }
124 /** creates and returns a picture */
125 public static Picture createPicture(int[] data, int w, int h) { return platform._createPicture(data, w, h); }
126 public static Picture createAlphaOnlyPicture(byte[] data, int w, int h) { return platform._createAlphaOnlyPicture(data, w, h); }
128 protected Picture _createPicture(int[] b, int w, int h) { return null; }
129 protected Picture _createAlphaOnlyPicture(byte[] b, int w, int h) {
130 int[] b2 = new int[b.length];
131 for(int i=0;i<b.length;i++) b2[i] = (b[i]&0xff) << 24;
132 return _createPicture(b2,w,h);
135 /** creates a socket object */
136 public static Socket getSocket(String host, int port, boolean ssl, boolean negotiate) throws IOException {
137 return platform._getSocket(host, port, ssl, negotiate);
139 protected Socket _getSocket(String host, int port, boolean ssl, boolean negotiate) throws IOException {
140 Socket ret = ssl ? new TinySSL(host, port, negotiate) : new Socket(java.net.InetAddress.getByName(host), port);
141 ret.setTcpNoDelay(true);
145 /** should return true if it is safe to supress full-surface dirties immediately after a window resize */
146 public static boolean supressDirtyOnResize() { return platform._supressDirtyOnResize(); }
147 protected boolean _supressDirtyOnResize() { return false; }
149 /** the human-readable name of the key mapped to XWT's 'alt' key */
150 public static String altKeyName() { return platform._altKeyName(); }
151 protected String _altKeyName() { return "alt"; }
153 /** returns the contents of the clipboard */
154 public static Object getClipBoard() { return clipboardReadEnabled ? platform._getClipBoard() : null; }
155 protected String _getClipBoard() { return null; }
157 /** sets the contents of the clipboard */
158 public static void setClipBoard(String s) { platform._setClipBoard(s); }
159 protected void _setClipBoard(String s) { }
161 /** returns the width of the screen, in pixels */
162 public static int getScreenWidth() { return platform._getScreenWidth(); }
163 protected int _getScreenWidth() { return 640; }
165 /** returns the height of the screen, in pixels */
166 public static int getScreenHeight() { return platform._getScreenHeight(); }
167 protected int _getScreenHeight() { return 480; }
169 /** returns the maximum number of threads that the XWT engine can create without adversely affecting the host OS */
170 public static int maxThreads() { return platform._maxThreads(); }
171 protected int _maxThreads() { return 25; }
173 /** used to notify the user of very serious failures; usually used when logging is not working or unavailable */
174 protected void _criticalAbort(String message) { System.exit(-1); }
176 /** if true, org.xwt.Surface will generate a Click automatically after a press and a release */
177 public static boolean needsAutoClick() { return platform._needsAutoClick(); }
178 protected boolean _needsAutoClick() { return false; }
180 /** if true, org.xwt.Surface will generate a DoubleClick automatically after recieving two clicks in a short period of time */
181 public static boolean needsAutoDoubleClick() { return platform._needsAutoDoubleClick(); }
182 protected boolean _needsAutoDoubleClick() { return false; }
184 /** returns true iff the platform has a case-sensitive filesystem */
185 public static boolean isCaseSensitive() { return platform._isCaseSensitive(); }
186 protected boolean _isCaseSensitive() { return true; }
188 /** returns an InputStream to the builtin xwar */
189 public static InputStream getBuiltinInputStream() { return platform._getBuiltinInputStream(); }
190 protected InputStream _getBuiltinInputStream() {
191 return this.getClass().getClassLoader().getResourceAsStream("org/xwt/builtin.jar");
194 /** returns the value of the environment variable key, or null if no such key exists */
195 public static String getEnv(String key) { return platform._getEnv(key); }
196 protected String _getEnv(String key) {
198 String os = System.getProperty("os.name").toLowerCase();
200 if (os.indexOf("windows 9") != -1 || os.indexOf("windows me") != -1) {
201 // hack -- jdk1.2/1.3 on Win32 pop open an ugly DOS box; 1.4 does not
202 if (platform.getClass().getName().endsWith("Java12")) return null;
203 p = Runtime.getRuntime().exec("command.com /c set");
204 } else if (os.indexOf("windows") > -1) {
205 // hack -- jdk1.2/1.3 on Win32 pop open an ugly DOS box; 1.4 does not
206 if (platform.getClass().getName().endsWith("Java12")) return null;
207 p = Runtime.getRuntime().exec("cmd.exe /c set");
209 p = Runtime.getRuntime().exec("env");
211 BufferedReader br = new BufferedReader(new InputStreamReader(p.getInputStream()));
213 while ((s = br.readLine()) != null)
214 if (s.startsWith(key + "="))
215 return s.substring(key.length() + 1);
216 } catch (Exception e) {
217 if (Log.on) Log.log(this, "Exception while reading from environment:");
218 if (Log.on) Log.log(this, e);
223 /** convert a JPEG into an Image */
224 public static synchronized Picture decodeJPEG(InputStream is, String name) { return platform._decodeJPEG(is, name); }
225 protected Picture _decodeJPEG(InputStream is, String name) { return null; }
227 /** displays a platform-specific "open file" dialog and returns the chosen filename, or null if the user hit cancel */
228 protected String _fileDialog(String suggestedFileName, boolean write) { return null; }
229 public static String fileDialog(String suggestedFileName, boolean write) {
230 // FIXME: put self in background
231 return platform._fileDialog(suggestedFileName, write);
234 /** default implementation is Eric Albert's BrowserLauncher.java */
235 protected void _newBrowserWindow(String url) {
237 Class c = Class.forName("edu.stanford.ejalbert.BrowserLauncher");
238 Method m = c.getMethod("openURL", new Class[] { String.class });
239 m.invoke(null, new String[] { url });
240 } catch (Exception e) {
245 /** opens a new browser window */
246 public static void newBrowserWindow(String url) {
247 if (!(url.startsWith("https://") || url.startsWith("http://") || url.startsWith("ftp://") || url.startsWith("mailto:"))) {
248 if (Log.on) Log.log(Platform.class, "xwt.newBrowserWindow() only supports http and https urls");
252 // check the URL for well-formedness, as a defense against buffer overflow attacks
255 if (u.startsWith("https")) u = "http" + u.substring(5);
257 } catch (MalformedURLException e) {
258 if (Log.on) Log.log(Platform.class, "URL " + url + " is not well-formed");
259 if (Log.on) Log.log(Platform.class, e);
262 if (Log.on) Log.log(Platform.class, "newBrowserWindow, url = " + url);
263 platform._newBrowserWindow(url);
266 /** used to notify the user of very serious failures; usually used when logging is not working or unavailable */
267 public static void criticalAbort(String message) {
268 if (Log.on) Log.log(Platform.class, "Critical Abort:");
269 if (Log.on) Log.log(Platform.class, message);
270 platform._criticalAbort(message);
273 /** this method invokes the platform _createSurface() method and then enforces a few post-call invariants */
274 protected Surface _createSurface(Box b, boolean framed) { return null; }
275 public static Surface createSurface(Box b, boolean framed, boolean refreshable) {
276 Surface ret = platform._createSurface(b, framed);
277 ret.setInvisible(false);
279 Object titlebar = b.get("titlebar", true);
280 if (titlebar != null) ret.setTitleBarText(titlebar.toString());
282 Object icon = b.get("icon", true);
283 if (icon != null && icon instanceof Res) {
286 Picture pic = Picture.fromRes((Res)icon);
287 if (pic != null) ret.setIcon(pic);
288 else if (Log.on) Log.log(Platform.class, "unable to load icon " + icon);
292 ret.setLimits(b.minwidth, b.minheight, b.maxwidth, b.maxheight);
295 Surface.allSurfaces.addElement(ret);
296 ret.dirty(0, 0, b.width, b.height);
302 /** detects proxy settings */
303 protected synchronized org.xwt.HTTP.Proxy _detectProxy() { return null; }
304 public static synchronized org.xwt.HTTP.Proxy detectProxy() {
306 if (cachedProxyInfo != null) return cachedProxyInfo;
307 if (alreadyDetectedProxy) return null;
308 alreadyDetectedProxy = true;
310 if (Log.on) Log.log(Platform.class, "attempting environment-variable DNS proxy detection");
311 cachedProxyInfo = org.xwt.HTTP.Proxy.detectProxyViaManual();
312 if (cachedProxyInfo != null) return cachedProxyInfo;
314 if (Log.on) Log.log(Platform.class, "attempting " + platform.getClass().getName() + " proxy detection");
315 cachedProxyInfo = platform._detectProxy();
316 if (cachedProxyInfo != null) return cachedProxyInfo;
318 return cachedProxyInfo;
321 /** returns a Scheduler instance; used to implement platform-specific schedulers */
322 protected Scheduler _getScheduler() { return new Scheduler(); }
323 public static Scheduler getScheduler() { return platform._getScheduler(); }
325 /** read an input stream into a byte array and invoke callback when ready */
326 protected void _inputStreamToByteArray(final InputStream is, final Callback c) {
327 new java.lang.Thread() {
330 final byte[] b = InputStreamToByteArray.convert(is);
331 Scheduler.add(new Scheduler.Task() { public void perform() { c.call(b); }});
332 } catch (IOException e) {
333 Log.log(Platform.class, e);
338 public static void inputStreamToByteArray(InputStream is, Callback c) { platform._inputStreamToByteArray(is, c); }
340 public static void running() { platform._running(); }
341 public void _running() { new Semaphore().block(); }