2003/09/20 05:03:47
[org.ibex.core.git] / 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 <clinit> 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     /** creates a weak reference */
174     protected org.xwt.Weak _getWeak(final Object o) {
175         return new org.xwt.Weak() {
176                 public Object get() { return o; }
177             };
178     }
179
180         /** Called once XWT is initialized and the application is running. */
181         protected void _running() {}
182     
183     /** quits XWT */
184     protected void _exit() { System.exit(0); }
185
186     /** used to notify the user of very serious failures; usually used when logging is not working or unavailable */
187     protected void _criticalAbort(String message) { _exit(); }
188
189     /** used to notify the user of very serious failures; usually used when logging is not working or unavailable */
190     protected String _getDefaultFont() { return "sansserif10"; }
191
192     /** if true, org.xwt.Surface will generate a Click automatically after a press and a release */
193     protected boolean _needsAutoClick() { return false; }
194
195     /** if true, org.xwt.Surface will generate a DoubleClick automatically after recieving two clicks in a short period of time */
196     protected boolean _needsAutoDoubleClick() { return false; }
197
198     protected void _newBrowserWindow(String url) {
199         if (Log.on) Log.log(this, "Platform " + platform.getClass().getName() + " cannot open browser windows");
200         return;
201     }
202
203     /** Returns null if XWT should always use direct connection; otherwise returns a ProxyInfo object with proxy settings */
204     protected synchronized HTTP.Proxy _detectProxy() { return null; }
205
206     /** displays a platform-specific "open file" dialog and returns the chosen filename, or null if the user hit cancel */
207     protected String _fileDialog(String suggestedFileName, boolean write) { return null; }
208
209     /** returns true iff the platform has a case-sensitive filesystem */
210     protected boolean _isCaseSensitive() { return true; }
211
212     /** returns an InputStream to the builtin xwar */
213     protected InputStream _getBuiltinInputStream() {
214         return this.getClass().getClassLoader().getResourceAsStream("org/xwt/builtin.jar");
215     }
216
217     /** returns the value of the environment variable key, or null if no such key exists */
218     protected String _getEnv(String key) {
219         try {
220             String os = System.getProperty("os.name").toLowerCase();
221             Process p;
222             if (os.indexOf("windows 9") != -1 || os.indexOf("windows me") != -1) {
223                 // hack -- jdk1.2/1.3 on Win32 pop open an ugly DOS box; 1.4 does not
224                 if (platform.getClass().getName().endsWith("Java12")) return null;
225                 p = Runtime.getRuntime().exec("command.com /c set");
226             } else if (os.indexOf("windows") > -1) {
227                 // hack -- jdk1.2/1.3 on Win32 pop open an ugly DOS box; 1.4 does not
228                 if (platform.getClass().getName().endsWith("Java12")) return null;
229                 p = Runtime.getRuntime().exec("cmd.exe /c set");
230             } else {  
231                 p = Runtime.getRuntime().exec("env");
232             }
233             BufferedReader br = new BufferedReader(new InputStreamReader(p.getInputStream()));
234             String s;
235             while ((s = br.readLine()) != null)
236                 if (s.startsWith(key + "="))
237                     return s.substring(key.length() + 1);
238         } catch (Exception e) {
239             if (Log.on) Log.log(this, "Exception while reading from environment:");
240             if (Log.on) Log.log(this, e);
241         }
242         return null;
243     }
244
245     /** convert a JPEG into an Image */
246     protected ImageDecoder _decodeJPEG(InputStream is, String name) { return null; }
247
248
249     // Static methods -- thunk to the instance /////////////////////////////////////////////////////////////////////////
250
251     /** if true, org.xwt.Surface should generate Click messages automatically when a Release happens after a Press and the mouse has not moved much */
252     public static boolean needsAutoClick() { return platform._needsAutoClick(); }
253
254     /** if true, org.xwt.Surface should generate DoubleClick messages automatically when needed */
255     public static boolean needsAutoDoubleClick() { return platform._needsAutoDoubleClick(); }
256
257     /** should return true if it is safe to supress full-surface dirties immediately after a window resize */
258     public static String getDefaultFont() { return platform._getDefaultFont(); }
259
260     /** should return true if it is safe to supress full-surface dirties immediately after a window resize */
261     public static boolean supressDirtyOnResize() { return platform._supressDirtyOnResize(); }
262
263     /** returns the width of a string in a platform-specific font */
264     public static int stringWidth(String font, String text) { return platform._stringWidth(font, text); }
265
266     /** returns the maximum ascent of all glyphs in a given platform-specific font */
267     public static int getMaxAscent(String font) { return platform._getMaxAscent(font); }
268
269     /** returns the maximum descent of all glyphs in a given platform-specific font. Three pixel minimum ensures space for underline. */
270     public static int getMaxDescent(String font) { return Math.max(3, platform._getMaxDescent(font)); }
271
272     /** returns the maximum number of threads that the XWT engine can create without adversely affecting the host OS */
273     public static int maxThreads() { return platform._maxThreads(); }
274
275     /** returns a list of all platform-specific fonts available */
276     public static String[] listFonts() { return platform._listFonts(); }
277
278     /** creates a weak reference */
279     public static org.xwt.Weak getWeak(Object o) { return platform._getWeak(o); }
280
281     /** opens a connection to the resource identified by URL u, and returns an InputStream */
282     public static InputStream urlToInputStream(URL u) throws IOException { return platform._urlToInputStream(u); }
283
284     /** returns the contents of the clipboard */    
285     public static Object getClipBoard() { return clipboardReadEnabled ? platform._getClipBoard() : null; }
286
287     /** sets the contents of the clipboard */
288     public static void setClipBoard(String s) { platform._setClipBoard(s); }
289
290     /** creates a socket object, with or without ssl encryption */
291     public static Socket getSocket(String host, int port, boolean ssl, boolean negotiate) throws IOException {
292         return platform._getSocket(host, port, ssl, negotiate);
293     }
294
295     /** returns the width of the screen, in pixels */
296     public static int getScreenWidth() { return platform._getScreenWidth(); }
297
298     /** returns the height of the screen, in pixels */
299     public static int getScreenHeight() { return platform._getScreenHeight(); }
300
301     /** creates and returns a doublebuffer 'belonging' to <tt>owner</tt> */
302     public static PixelBuffer createPixelBuffer(int w, int h, Surface s) { return platform._createPixelBuffer(w, h, s); }
303
304     /** creates and returns a picture */
305     public static Picture createPicture(int[] data, int w, int h) { return platform._createPicture(data, w, h); }
306
307     /** returns an InputStream to the builtin xwar */
308     public static InputStream getBuiltinInputStream() { return platform._getBuiltinInputStream(); }
309         
310     /** creates and returns a picture */
311     public static Picture createPicture(ImageDecoder i) { return platform._createPicture(i.getData(), i.getWidth(), i.getHeight()); }
312
313     /** returns true iff the platform has a case-sensitive filesystem */
314     public static boolean isCaseSensitive() { return platform._isCaseSensitive(); }
315
316     /** returns the value of the environment variable key, or null if no such key exists */
317     public static String getEnv(String key) { return platform._getEnv(key); }
318
319     /** displays a platform-specific "open file" dialog and returns the chosen filename, or null if the user hit cancel */
320     public static String fileDialog(String suggestedFileName, boolean write) {
321         if (!ThreadMessage.suspendThread()) return null;
322         try {
323             return platform._fileDialog(suggestedFileName, write);
324         } finally {
325             ThreadMessage.resumeThread();
326         }
327     }
328
329     /** opens a new browser window */
330     public static void newBrowserWindow(String url) {
331         if (!(url.startsWith("https://") || url.startsWith("http://") || url.startsWith("ftp://") || url.startsWith("mailto:"))) {
332             if (Log.on) Log.log(Platform.class, "xwt.newBrowserWindow() only supports http and https urls");
333             return;
334         }
335
336         // check the URL for well-formedness, as a defense against buffer overflow attacks
337         try {
338             String u = url;
339             if (u.startsWith("https")) u = "http" + u.substring(5);
340             new URL(u);
341         } catch (MalformedURLException e) {
342             if (Log.on) Log.log(Platform.class, "URL " + url + " is not well-formed");
343             if (Log.on) Log.log(Platform.class, e);
344         }
345
346         if (Log.on) Log.log(Platform.class, "newBrowserWindow, url = " + url);
347         platform._newBrowserWindow(url);
348     }
349
350         /** Called once XWT is initialized and the application is running. */
351         public static void running() {
352                 Log.log(Platform.class, "XWT is running");
353                 platform._running();
354         }
355         
356     /** quits XWT */
357     public static void exit() {
358         Log.log(Platform.class, "exiting via Platform.exit()");
359         platform._exit();
360     }
361
362     /** the human-readable name of the key mapped to XWT's 'alt' key */
363     public static String altKeyName() { return platform._altKeyName(); }
364
365     /** used to notify the user of very serious failures; usually used when logging is not working or unavailable */
366     public static void criticalAbort(String message) {
367         if (Log.on) Log.log(Platform.class, "Critical Abort:");
368         if (Log.on) Log.log(Platform.class, message);
369         platform._criticalAbort(message);
370     }
371
372     /** this method invokes the platform _createSurface() method and then enforces a few post-call invariants */
373     public static Surface createSurface(Box b, boolean framed, boolean refreshable) {
374         Surface ret = platform._createSurface(b, framed);
375         b.width = b.height < Surface.scarPicture.getWidth() ? Surface.scarPicture.getWidth() : b.width;
376         b.height = b.height < Surface.scarPicture.getHeight() ? Surface.scarPicture.getHeight() : b.height;
377         ret.setInvisible(false);
378
379         Object titlebar = b.get("titlebar", true);
380         if (titlebar != null) ret.setTitleBarText(titlebar.toString());
381
382         Object icon = b.get("icon", true);
383         if (icon != null && !"".equals(icon)) {
384             Picture pic = ImageDecoder.getPicture(icon.toString());
385             if (pic != null) ret.setIcon(pic);
386             else if (Log.on) Log.log(Platform.class, "unable to load icon " + icon);
387         }
388
389         ret.setLimits(b.minwidth, b.minheight, b.maxwidth, b.maxheight);
390
391         if (refreshable) {
392             Surface.refreshableSurfaceWasCreated = true;
393             Surface.allSurfaces.addElement(ret);
394             ret.dirty(0, 0, b.width, b.height);
395             ret.Refresh();
396         }
397         return ret;
398     }
399
400     /** detects proxy settings */
401     public static synchronized HTTP.Proxy detectProxy() {
402
403         if (cachedProxyInfo != null) return cachedProxyInfo;
404         if (alreadyDetectedProxy) return null;
405         alreadyDetectedProxy = true;
406
407         if (Log.on) Log.log(Platform.class, "attempting environment-variable DNS proxy detection");
408         cachedProxyInfo = HTTP.Proxy.detectProxyViaManual();
409         if (cachedProxyInfo != null) return cachedProxyInfo;
410
411         if (Log.on) Log.log(Platform.class, "attempting " + platform.getClass().getName() + " proxy detection");
412         cachedProxyInfo = platform._detectProxy();
413         if (cachedProxyInfo != null) return cachedProxyInfo;
414
415         return cachedProxyInfo;
416     }
417
418     public static synchronized ImageDecoder decodeJPEG(InputStream is, String name) {
419         return platform._decodeJPEG(is, name);
420     }
421
422     // Helpful font parsing stuff //////////////////////////////////////////////////////
423
424     public static class ParsedFont {
425         public ParsedFont() { }
426         public ParsedFont(String s) { parse(s); }
427         public int size = 10;
428         public String name = "";
429
430         public boolean italic = false;
431         public boolean bold = false;
432         public boolean underline = false;
433         public boolean dotted_underline = false;
434
435         private static int stoi(Object o) {
436             if (o == null) return 0;
437             if (o instanceof Integer) return ((Integer)o).intValue();
438             
439             String s = o.toString(); 
440             try { return Integer.parseInt(s.indexOf('.') == -1 ? s : s.substring(0, s.indexOf('.'))); }
441             catch (NumberFormatException e) { return 0; }
442         }
443
444         public void parse(String font) {
445             int i = 0;
446             while(i < font.length() && !Character.isDigit(font.charAt(i)) && font.charAt(i) != '*') i++;
447             name = font.substring(0, i).toLowerCase().replace('_', ' ');
448             size = 10;
449             italic = false;
450             bold = false;
451             underline = false;
452             dotted_underline = false;
453             if (i != font.length()) {
454                 if (font.charAt(i) == '*') {
455                     size = 0;
456                     i++;
457                 } else {
458                     int j = i;
459                     while (j < font.length() && Character.isDigit(font.charAt(j))) j++;
460                     if (i != j) size = stoi(font.substring(i, j));
461                     i = j;
462                 }
463                 while(i < font.length()) {
464                     switch (font.charAt(i)) {
465                     case 'b': bold = true; break;
466                     case 'i': italic = true; break;
467                     case 'd': dotted_underline = true; break;
468                     case 'u': underline = true; break;
469                     }
470                     i++;
471                 }
472             }
473         }
474
475     }
476
477 }
478
479