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 HTTP.ProxyInfo cachedProxyInfo = null;
39 // VM Detection Logic /////////////////////////////////////////////////////////////////////
41 /** do-nothing method that forces <clinit> to run */
42 public static void forceLoad() { }
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
49 System.out.println("Detecting JVM...");
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;
56 //if (os_name.startsWith("Mac OS X")) platform_class = "MacOSX";
57 if (vendor.startsWith("Free Software Foundation")) platform_class = "Win32";
58 else if (version.startsWith("1.1") && vendor.startsWith("Netscape")) platform_class = "Netscape";
59 else if (version.startsWith("1.1") && vendor.startsWith("Microsoft")) platform_class = "Microsoft";
60 else if (version.startsWith("1.4")) platform_class = "Java14";
61 else if (!version.startsWith("1.0") && !version.startsWith("1.1")) platform_class = "Java12";
63 if (platform_class != null) {
64 platform = (Platform)Class.forName("org.xwt.plat." + platform_class).newInstance();
68 if (Log.on) Log.log(Platform.class, "XWT VM detection: vendor = " + vendor);
69 if (Log.on) Log.log(Platform.class, " version = " + version);
70 if (Log.on) Log.log(Platform.class, " os = " + os_name);
72 if (platform_class == null) {
73 if (Log.on) Log.log(Platform.class, "Unable to detect JVM");
77 if (Log.on) Log.log(Platform.class, " platform = " + platform.getDescriptiveName());
78 if (Log.on) Log.log(Platform.class, " class = " + platform.getClass().getName());
80 } catch (Exception e) {
81 if (Log.on) Log.log(Platform.class, "Exception while trying to detect JVM");
82 if (Log.on) Log.log(Platform.class, e);
89 // Methods to be Overridden ////////////////////////////////////////////////////////////////////
91 /** a string describing the VM */
92 protected String getDescriptiveName() { return "Generic Java 1.1 VM"; }
94 /** this initializes the platform; code in here can invoke methods on Platform since Platform.platform has already been set */
95 protected void init() { }
97 /** creates and returns a doublebuffer 'belonging' to <tt>owner</tt>; we need to associate DoubleBuffers to surfaces
98 * due to AWT 1.1 requirements (definately for Navigator, possibly also for MSJVM).
100 protected DoubleBuffer _createDoubleBuffer(int w, int h, Surface owner) { return null; }
102 /** creates and returns a new surface */
103 protected Surface _createSurface(Box b, boolean framed) { return null; }
105 /** creates a socket object */
106 protected Socket _getSocket(String host, int port, boolean ssl) throws IOException {
107 return ssl ? new TinySSL(host, port) : new Socket(java.net.InetAddress.getByName(host), port);
110 /** creates and returns a picture */
111 protected Picture _createPicture(int[] b, int w, int h) { return null; }
113 /** should return true if it is safe to supress full-surface dirties immediately after a window resize */
114 protected boolean _supressDirtyOnResize() { return true; }
116 /** the human-readable name of the key mapped to XWT's 'alt' key */
117 protected String _altKeyName() { return "alt"; }
119 /** opens a connection to the resource identified by URL u, and returns an InputStream */
120 protected InputStream _urlToInputStream(URL u) throws IOException { return u.openStream(); }
122 /** returns the contents of the clipboard */
123 protected String _getClipBoard() { return null; }
125 /** sets the contents of the clipboard */
126 protected void _setClipBoard(String s) { }
128 /** returns the width of the screen, in pixels */
129 protected int _getScreenWidth() { return 640; }
131 /** returns the height of the screen, in pixels */
132 protected int _getScreenHeight() { return 480; }
134 /** returns the width of a string in a platform-specific font */
135 protected int _stringWidth(String font, String text) { return 10 * text.length(); }
137 /** returns the maximum ascent of all glyphs in a given platform-specific font */
138 protected int _getMaxAscent(String font) { return 10; }
140 /** returns the maximum descent of all glyphs in a given platform-specific font */
141 protected int _getMaxDescent(String font) { return 2; }
143 /** returns a list of all platform-specific fonts available */
144 protected String[] _listFonts() { return new String[] { }; }
146 /** returns the maximum number of threads that the XWT engine can create without adversely affecting the host OS */
147 protected int _maxThreads() { return 25; }
149 /** creates a weak reference */
150 protected org.xwt.Weak _getWeak(final Object o) {
151 return new org.xwt.Weak() {
152 public Object get() { return o; }
157 protected void _exit() { System.exit(0); }
159 /** used to notify the user of very serious failures; usually used when logging is not working or unavailable */
160 protected void _criticalAbort(String message) { System.exit(-1); }
162 /** used to notify the user of very serious failures; usually used when logging is not working or unavailable */
163 protected String _getDefaultFont() { return "sansserif10"; }
165 protected boolean _needsAutoClick() { return false; }
167 protected void _newBrowserWindow(String url) {
168 if (Log.on) Log.log(this, "Platform " + platform.getClass().getName() + " cannot open browser windows");
172 /** Returns true iff the platform detected that it should be using a proxy.
173 * The platform implementation should cache the result.
174 * This method will only be called if a connection attempt failed
176 protected synchronized HTTP.ProxyInfo _detectProxy() { return null; }
178 // Static methods -- thunk to the instance /////////////////////////////////////////////////////////////////////////
180 /** if true, org.xwt.Surface should generate Click messages automatically when a Release happens after a Press and the mouse has not moved much */
181 public static boolean needsAutoClick() { return platform._needsAutoClick(); }
183 /** should return true if it is safe to supress full-surface dirties immediately after a window resize */
184 public static String getDefaultFont() { return platform._getDefaultFont(); }
186 /** should return true if it is safe to supress full-surface dirties immediately after a window resize */
187 public static boolean supressDirtyOnResize() { return platform._supressDirtyOnResize(); }
189 /** returns the width of a string in a platform-specific font */
190 public static int stringWidth(String font, String text) { return platform._stringWidth(font, text); }
192 /** returns the maximum ascent of all glyphs in a given platform-specific font */
193 public static int getMaxAscent(String font) { return platform._getMaxAscent(font); }
195 /** returns the maximum descent of all glyphs in a given platform-specific font. Three pixel minimum ensures space for underline. */
196 public static int getMaxDescent(String font) { return Math.max(3, platform._getMaxDescent(font)); }
198 /** returns the maximum number of threads that the XWT engine can create without adversely affecting the host OS */
199 public static int maxThreads() { return platform._maxThreads(); }
201 /** returns a list of all platform-specific fonts available */
202 public static String[] listFonts() { return platform._listFonts(); }
204 /** creates a weak reference */
205 public static org.xwt.Weak getWeak(Object o) { return platform._getWeak(o); }
207 /** opens a connection to the resource identified by URL u, and returns an InputStream */
208 public static InputStream urlToInputStream(URL u) throws IOException { return platform._urlToInputStream(u); }
210 /** returns the contents of the clipboard */
211 public static Object getClipBoard() { return clipboardReadEnabled ? platform._getClipBoard() : null; }
213 /** sets the contents of the clipboard */
214 public static void setClipBoard(String s) { platform._setClipBoard(s); }
216 /** creates a socket object, with or without ssl encryption */
217 public static Socket getSocket(String host, int port, boolean ssl) throws IOException { return platform._getSocket(host, port, ssl); }
219 /** returns the width of the screen, in pixels */
220 public static int getScreenWidth() { return platform._getScreenWidth(); }
222 /** returns the height of the screen, in pixels */
223 public static int getScreenHeight() { return platform._getScreenHeight(); }
225 /** creates and returns a doublebuffer 'belonging' to <tt>owner</tt> */
226 public static DoubleBuffer createDoubleBuffer(int w, int h, Surface s) { return platform._createDoubleBuffer(w, h, s); }
228 /** creates and returns a picture */
229 public static Picture createPicture(int[] data, int w, int h) { return platform._createPicture(data, w, h); }
231 /** creates and returns a picture */
232 public static Picture createPicture(ImageDecoder i) { return platform._createPicture(i.getData(), i.getWidth(), i.getHeight()); }
234 /** opens a new browser window */
235 public static void newBrowserWindow(String url) {
236 if (!(url.startsWith("https://") || url.startsWith("http://") || url.startsWith("ftp://") || url.startsWith("mailto:"))) {
237 if (Log.on) Log.log(Platform.class, "xwt.newBrowserWindow() only supports http and https urls");
240 if (Log.on) Log.log(Platform.class, "newBrowserWindow, url = " + url);
241 platform._newBrowserWindow(url);
245 public static void exit() {
246 Log.log(Platform.class, "exiting via Platform.exit()");
250 /** the human-readable name of the key mapped to XWT's 'alt' key */
251 public static String altKeyName() { return platform._altKeyName(); }
253 /** used to notify the user of very serious failures; usually used when logging is not working or unavailable */
254 public static void criticalAbort(String message) {
255 if (Log.on) Log.log(Platform.class, "Critical Abort:");
256 if (Log.on) Log.log(Platform.class, message);
257 platform._criticalAbort(message);
260 /** this method invokes the platform _createSurface() method and then enforces a few post-call invariants */
261 public static Surface createSurface(Box b, boolean framed, boolean refreshable) {
262 Surface ret = platform._createSurface(b, framed);
263 ret.setInvisible(b.invisible);
264 b.set(Box.size, 0, ret.width);
265 b.set(Box.size, 1, ret.height);
267 Object titlebar = b.get("titlebar", null, true);
268 if (titlebar != null) ret.setTitleBarText(titlebar.toString());
270 Object icon = b.get("icon", null, true);
271 if (icon != null && !"".equals(icon)) {
272 Picture pic = Box.getPicture(icon.toString());
273 if (pic != null) ret.setIcon(pic);
274 else if (Log.on) Log.log(Platform.class, "unable to load icon " + icon);
278 Surface.refreshableSurfaceWasCreated = true;
279 Surface.allSurfaces.addElement(ret);
280 ret.dirty(0, 0, ret.width, ret.height);
286 /** detects proxy settings */
287 public static synchronized HTTP.ProxyInfo detectProxy() {
289 if (cachedProxyInfo != null) return cachedProxyInfo;
290 if (alreadyDetectedProxy) return null;
291 alreadyDetectedProxy = true;
293 if (Log.on) Log.log(Platform.class, "attempting xwt-proxy DNS proxy detection");
294 cachedProxyInfo = HTTP.ProxyInfo.detectProxyViaManual();
295 if (cachedProxyInfo != null) return cachedProxyInfo;
297 if (Log.on) Log.log(Platform.class, "attempting " + platform.getClass().getName() + " proxy detection");
298 cachedProxyInfo = platform._detectProxy();
299 if (cachedProxyInfo != null) return cachedProxyInfo;
301 if (Log.on) Log.log(Platform.class, "attempting WPAD proxy detection");
302 cachedProxyInfo = HTTP.ProxyInfo.detectProxyViaWPAD();
303 if (cachedProxyInfo != null) return cachedProxyInfo;
305 return cachedProxyInfo;
308 // Helpful font parsing stuff //////////////////////////////////////////////////////
310 public static class ParsedFont {
311 public ParsedFont() { }
312 public ParsedFont(String s) { parse(s); }
313 public int size = 10;
314 public String name = "";
316 public boolean italic = false;
317 public boolean bold = false;
318 public boolean underline = false;
319 public boolean dotted_underline = false;
321 private static int stoi(Object o) {
322 if (o == null) return 0;
323 if (o instanceof Integer) return ((Integer)o).intValue();
325 String s = o.toString();
326 try { return Integer.parseInt(s.indexOf('.') == -1 ? s : s.substring(0, s.indexOf('.'))); }
327 catch (NumberFormatException e) { return 0; }
330 public void parse(String font) {
332 while(i < font.length() && !Character.isDigit(font.charAt(i))) i++;
333 name = font.substring(0, i).toLowerCase().replace('_', ' ');
338 dotted_underline = false;
339 if (i != font.length()) {
341 while (j < font.length() && Character.isDigit(font.charAt(j))) j++;
342 if (i != j) size = stoi(font.substring(i, j));
344 while(i < font.length()) {
345 switch (font.charAt(i)) {
346 case 'b': bold = true; break;
347 case 'i': italic = true; break;
348 case 'd': dotted_underline = true; break;
349 case 'u': underline = true; break;