2004/01/03 04:21:15
[org.ibex.core.git] / src / org / xwt / Platform.java
index c06bb8a..e400c5e 100644 (file)
@@ -17,32 +17,21 @@ import org.xwt.util.*;
  *  it in the org.xwt.plat package, and add code to this file's static
  *  block to detect the new platform.
  */
-public class Platform {
+public abstract class Platform {
 
-    // Static Data /////////////////////////////////////////////////////////////////////////////////////
-
-    /**
-     *  set to true during the delivery of a KeyPressed:C-v/A-v or Press3; it is safe to use a
-     *  'global' here, since message delivery is single-threaded and non-preemptable
-     */
-    static boolean clipboardReadEnabled = false;
-
-    /** The appropriate Platform object for this JVM */
-    static Platform platform = null;
+    public Platform() { platform = this; }
 
-    /** true if proxy autodetection has already been run */
-    static boolean alreadyDetectedProxy = false;
-
-    /** the result of proxy autodetection */
-    static HTTP.Proxy cachedProxyInfo = null;
+    // Static Data /////////////////////////////////////////////////////////////////////////////////////
 
-    /** the current build */
-    public static String build = "unknown";
+    static boolean clipboardReadEnabled = false;       ///< true iff inside a C-v/A-v/Press3 trap handler
+    static Platform platform = null;                   ///< The appropriate Platform object for this JVM
+    static boolean alreadyDetectedProxy = false;       ///< true if proxy autodetection has already been run
+    static org.xwt.HTTP.Proxy cachedProxyInfo = null;  ///< the result of proxy autodetection
+    public static String build = "unknown";            ///< the current build
 
     // VM Detection Logic /////////////////////////////////////////////////////////////////////
 
-    /** do-nothing method that forces &lt;clinit&gt; to run */
-    public static void forceLoad() { }
+    public static void forceLoad() { }                 ///< do-nothing method that forces &lt;clinit&gt; to run
 
     // If you create a new subclass of Platform, you should add logic
     // here to detect it. Do not reference your class directly -- use
@@ -65,86 +54,74 @@ public class Platform {
             else if (version.startsWith("1.1") && vendor.startsWith("Microsoft")) platform_class = "Microsoft";
             else if (!version.startsWith("1.0") && !version.startsWith("1.1")) platform_class = "Java2";
 
-            /*
-            // Disable 2d hardware acceleration on Jaguar
-            if (os_name.equals("Mac OS X") && os_version.startsWith("10.2")) System.setProperty("com.apple.hwaccel", "false");
-            */
+            // Disable 2d hardware acceleration on Jaguar (do we need this?)
+            // if (os_name.equals("Mac OS X") && os_version.startsWith("10.2")) System.setProperty("com.apple.hwaccel", "false");
+            //System.setProperty("com.apple.hwaccel", "false");
 
-            if (platform_class != null) {
-                platform = (Platform)Class.forName("org.xwt.plat." + platform_class).newInstance();
-                platform.init();
-            }
+            if (platform_class != null)
+                Class.forName("org.xwt.plat." + platform_class).newInstance();
 
+            String term = Platform.getEnv("TERM");
+            Log.color = term != null && term.length() != 0 && !term.equals("cygwin");
+            
             try {
                 build = (String)Class.forName("org.xwt.Build").getField("build").get(null);
             } catch (ClassNotFoundException cnfe) {
             } catch (Exception e) {
-                if (Log.on) Log.log(Platform.class, "exception while detecting build:");
-                if (Log.on) Log.log(Platform.class, e);
+                if (Log.on) Log.info(Platform.class, "exception while detecting build:");
+                if (Log.on) Log.info(Platform.class, e);
             }
-            if (Log.on) Log.log(Platform.class, "XWT build: " + build);
+            if (Log.on) Log.diag(Platform.class, "XWT build: " + build);
 
-            if (Log.on) Log.log(Platform.class, "XWT VM detection:   vendor = " + vendor);
-            if (Log.on) Log.log(Platform.class, "                   version = " + version);
-            if (Log.on) Log.log(Platform.class, "                        os = " + os_name + " [version " + os_version + "]");
+            if (Log.on) Log.diag(Platform.class, "XWT VM detection:   vendor = " + vendor);
+            if (Log.on) Log.diag(Platform.class, "                   version = " + version);
+            if (Log.on) Log.diag(Platform.class, "                        os = " + os_name + " [version " + os_version + "]");
 
             if (platform_class == null) {
-                if (Log.on) Log.log(Platform.class, "Unable to detect JVM");
-                new Platform().criticalAbort("Unable to detect JVM");
+                if (Log.on) Log.info(Platform.class, "Unable to detect JVM");
+                criticalAbort("Unable to detect JVM");
             }
 
-            if (Log.on) Log.log(Platform.class, "                  platform = " + platform.getDescriptiveName());
-            if (Log.on) Log.log(Platform.class, "                     class = " + platform.getClass().getName());
+            if (Log.on) Log.diag(Platform.class, "                  platform = " + platform.getDescriptiveName());
+            if (Log.on) Log.diag(Platform.class, "                     class = " + platform.getClass().getName());
             platform.postInit();
 
         } catch (Exception e) {
-            if (Log.on) Log.log(Platform.class, "Exception while trying to detect JVM");
-            if (Log.on) Log.log(Platform.class, e);
-            new Platform().criticalAbort("Unable to detect JVM");
+            if (Log.on) Log.info(Platform.class, "Exception while trying to detect JVM");
+            if (Log.on) Log.info(Platform.class, e);
+            criticalAbort("Unable to detect JVM");
         }
 
     }
 
 
-    // Methods to be Overridden ////////////////////////////////////////////////////////////////////
+    // Methods to be Overridden ///////////////////////////////////////////////////////////////////
 
     /** a string describing the VM */
     protected String getDescriptiveName() { return "Generic Java 1.1 VM"; }
 
-    /** this initializes the platform; code in here can invoke methods on Platform since Platform.platform has already been set */
-    protected void init() { }
+    /** invoked after initialization messages have been printed; useful for additional platform detection log messages */
     protected void postInit() { }
 
-    /** creates and returns a doublebuffer 'belonging' to <tt>owner</tt>; we need to associate PixelBuffers to surfaces
-     *  due to AWT 1.1 requirements (definately for Navigator, possibly also for MSJVM).
-     */
-    public static PixelBuffer createPixelBuffer(int w, int h, Surface s) { return platform._createPixelBuffer(w, h, s); }
+    protected Surface _createSurface(Box b, boolean framed) { return null; }
+    protected Picture _createPicture(Stream r) { return null; }
     protected PixelBuffer _createPixelBuffer(int w, int h, Surface owner) { return null; }
-    
-    /** creates and returns a picture */
-    public static Picture createPicture(int[] data, int w, int h) { return platform._createPicture(data, w, h); }
-    public static Picture createAlphaOnlyPicture(byte[] data, int w, int h) { return platform._createAlphaOnlyPicture(data, w, h); }
-    
-    protected Picture _createPicture(int[] b, int w, int h) { return null; }
-    protected Picture _createAlphaOnlyPicture(byte[] b, int w, int h) {
-        int[] b2 = new int[b.length];
-        for(int i=0;i<b.length;i++) b2[i] = (b[i]&0xff) << 24;
-        return _createPicture(b2,w,h);
-    }
+    protected Font.Glyph _createGlyph(org.xwt.Font f, char c) { return new DefaultGlyph(f, c); }
 
-    /** creates a socket object */
-    public static Socket getSocket(String host, int port, boolean ssl, boolean negotiate) throws IOException {
-        return platform._getSocket(host, port, ssl, negotiate);
-    }
-    protected Socket _getSocket(String host, int port, boolean ssl, boolean negotiate) throws IOException {
-        Socket ret = ssl ? new TinySSL(host, port, negotiate) : new Socket(java.net.InetAddress.getByName(host), port);
-        ret.setTcpNoDelay(true);
+    public static PixelBuffer createPixelBuffer(int w, int h, Surface s) { return platform._createPixelBuffer(w, h, s); }
+    public static Picture createPicture(Stream r) { return platform._createPicture(r); }
+    public static Font.Glyph createGlyph(org.xwt.Font f, char c) { return platform._createGlyph(f, c); }
+    public static Surface createSurface(Box b, boolean framed, boolean refreshable) {
+        Surface ret = platform._createSurface(b, framed);
+        ret.setInvisible(false);
+        ret.setLimits(b.minwidth, b.minheight, b.maxwidth, b.maxheight);
+        if (refreshable) {
+            Surface.allSurfaces.addElement(ret);
+            ret.dirty(0, 0, b.width, b.height);
+            ret.Refresh();
+        }
         return ret;
     }
-    
-    /** should return true if it is safe to supress full-surface dirties immediately after a window resize */
-    public static boolean supressDirtyOnResize() { return platform._supressDirtyOnResize(); }
-    protected boolean _supressDirtyOnResize() { return false; }
 
     /** the human-readable name of the key mapped to XWT's 'alt' key */
     public static String altKeyName() { return platform._altKeyName(); }
@@ -166,10 +143,6 @@ public class Platform {
     public static int getScreenHeight() { return platform._getScreenHeight(); }
     protected int _getScreenHeight() { return 480; }
 
-    /** returns the maximum number of threads that the XWT engine can create without adversely affecting the host OS */
-    public static int maxThreads() { return platform._maxThreads(); }
-    protected int _maxThreads() { return 25; }
-
     /** used to notify the user of very serious failures; usually used when logging is not working or unavailable */
     protected void _criticalAbort(String message) { System.exit(-1); }
 
@@ -214,25 +187,20 @@ public class Platform {
                 if (s.startsWith(key + "="))
                     return s.substring(key.length() + 1);
         } catch (Exception e) {
-            if (Log.on) Log.log(this, "Exception while reading from environment:");
-            if (Log.on) Log.log(this, e);
+            if (Log.on) Log.info(this, "Exception while reading from environment:");
+            if (Log.on) Log.info(this, e);
         }
         return null;
     }
 
     /** convert a JPEG into an Image */
-    public static synchronized Picture decodeJPEG(InputStream is, String name) { return platform._decodeJPEG(is, name); }
-    protected Picture _decodeJPEG(InputStream is, String name) { return null; }
+    public static synchronized void decodeJPEG(InputStream is, Picture p) { platform._decodeJPEG(is, p); }
+    protected abstract void _decodeJPEG(InputStream is, Picture p);
 
     /** displays a platform-specific "open file" dialog and returns the chosen filename, or null if the user hit cancel */
     protected String _fileDialog(String suggestedFileName, boolean write) { return null; }
-    public static String fileDialog(String suggestedFileName, boolean write) {
-        if (!ThreadMessage.suspendThread()) return null;
-        try {
-            return platform._fileDialog(suggestedFileName, write);
-        } finally {
-            ThreadMessage.resumeThread();
-        }
+    public static String fileDialog(String suggestedFileName, boolean write) throws org.xwt.js.JSExn {
+        return platform._fileDialog(suggestedFileName, write);
     }
 
     /** default implementation is Eric Albert's BrowserLauncher.java */
@@ -242,14 +210,14 @@ public class Platform {
             Method m = c.getMethod("openURL", new Class[] { String.class });
             m.invoke(null, new String[] { url });
         } catch (Exception e) {
-            Log.log(this, e);
+            Log.info(this, e);
         }
     }
 
     /** opens a new browser window */
     public static void newBrowserWindow(String url) {
         if (!(url.startsWith("https://") || url.startsWith("http://") || url.startsWith("ftp://") || url.startsWith("mailto:"))) {
-            if (Log.on) Log.log(Platform.class, "xwt.newBrowserWindow() only supports http and https urls");
+            if (Log.on) Log.info(Platform.class, "xwt.newBrowserWindow() only supports http and https urls");
             return;
         }
 
@@ -259,68 +227,62 @@ public class Platform {
             if (u.startsWith("https")) u = "http" + u.substring(5);
             new URL(u);
         } catch (MalformedURLException e) {
-            if (Log.on) Log.log(Platform.class, "URL " + url + " is not well-formed");
-            if (Log.on) Log.log(Platform.class, e);
+            if (Log.on) Log.info(Platform.class, "URL " + url + " is not well-formed");
+            if (Log.on) Log.info(Platform.class, e);
         }
 
-        if (Log.on) Log.log(Platform.class, "newBrowserWindow, url = " + url);
+        if (Log.on) Log.info(Platform.class, "newBrowserWindow, url = " + url);
         platform._newBrowserWindow(url);
     }
 
     /** used to notify the user of very serious failures; usually used when logging is not working or unavailable */
     public static void criticalAbort(String message) {
-        if (Log.on) Log.log(Platform.class, "Critical Abort:");
-        if (Log.on) Log.log(Platform.class, message);
+        if (Log.on) Log.info(Platform.class, "Critical Abort:");
+        if (Log.on) Log.info(Platform.class, message);
         platform._criticalAbort(message);
     }
 
-    /** this method invokes the platform _createSurface() method and then enforces a few post-call invariants */
-    protected Surface _createSurface(Box b, boolean framed) { return null; }
-    public static Surface createSurface(Box b, boolean framed, boolean refreshable) {
-        Surface ret = platform._createSurface(b, framed);
-        ret.setInvisible(false);
-
-        Object titlebar = b.get("titlebar", true);
-        if (titlebar != null) ret.setTitleBarText(titlebar.toString());
-
-        Object icon = b.get("icon", true);
-        if (icon != null && icon instanceof Res) {
-            Picture pic = Picture.fromRes((Res)icon);
-            if (pic != null) ret.setIcon(pic);
-            else if (Log.on) Log.log(Platform.class, "unable to load icon " + icon);
-        }
-
-        ret.setLimits(b.minwidth, b.minheight, b.maxwidth, b.maxheight);
-
-        if (refreshable) {
-            Surface.allSurfaces.addElement(ret);
-            ret.dirty(0, 0, b.width, b.height);
-            ret.Refresh();
-        }
-        return ret;
-    }
-
     /** detects proxy settings */
-    protected synchronized HTTP.Proxy _detectProxy() { return null; }
-    public static synchronized HTTP.Proxy detectProxy() {
+    protected synchronized org.xwt.HTTP.Proxy _detectProxy() { return null; }
+    public static synchronized org.xwt.HTTP.Proxy detectProxy() {
 
         if (cachedProxyInfo != null) return cachedProxyInfo;
         if (alreadyDetectedProxy) return null;
         alreadyDetectedProxy = true;
 
-        if (Log.on) Log.log(Platform.class, "attempting environment-variable DNS proxy detection");
-        cachedProxyInfo = HTTP.Proxy.detectProxyViaManual();
+        if (Log.on) Log.info(Platform.class, "attempting environment-variable DNS proxy detection");
+        cachedProxyInfo = org.xwt.HTTP.Proxy.detectProxyViaManual();
         if (cachedProxyInfo != null) return cachedProxyInfo;
 
-        if (Log.on) Log.log(Platform.class, "attempting " + platform.getClass().getName() + " proxy detection");
+        if (Log.on) Log.info(Platform.class, "attempting " + platform.getClass().getName() + " proxy detection");
         cachedProxyInfo = platform._detectProxy();
         if (cachedProxyInfo != null) return cachedProxyInfo;
 
         return cachedProxyInfo;
+   } 
+
+    /** returns a Scheduler instance; used to implement platform-specific schedulers */
+    protected Scheduler _getScheduler() { return new Scheduler(); }
+    public static Scheduler getScheduler() { return platform._getScheduler(); }
+
+    // FEATURE: be more efficient for many of the subclasses
+    public static class DefaultGlyph extends Font.Glyph {
+        private Picture p = null;
+        public DefaultGlyph(org.xwt.Font f, char c) { super(f, c); }
+        public Picture getPicture() {
+            if (p == null && isLoaded) {
+                p = createPicture(null);
+                p.data = new int[data.length];
+                for(int i=0; i<data.length; i++) p.data[i] = (data[i] & 0xff) << 24;
+                data = null;
+                p.width = this.width;
+                p.height = this.height;
+            }
+            return p;
+        }
     }
-    
-    public static void running() { platform._running(); }
-    public void _running() { new Semaphore().block(); }
+
+
 }