INTEGRATION: CWS sb14 (1.1.2); FILE ADDED

2004/02/19 14:19:44 sb 1.1.2.1: #i21150# Moved Java types from jurt to ridljar, as javamaker now generates code that uses UnoRuntime; cleaned up; deprecated environment/bridge/mapping stuff.

1 files changed, 567 insertions, 0 deletions

diff --git a/ridljar/com/sun/star/uno/UnoRuntime.java b/ridljar/com/sun/star/uno/UnoRuntime.java
new file mode 100644
index 000000000000..e20f315d3f9a
--- /dev/null
+++ b/ridljar/com/sun/star/uno/UnoRuntime.java
@@ -0,0 +1,567 @@
+/*************************************************************************
+ *
+ *  $RCSfile: UnoRuntime.java,v $
+ *
+ *  $Revision: 1.2 $
+ *
+ *  last change: $Author: rt $ $Date: 2004-03-30 16:37:54 $
+ *
+ *  The Contents of this file are made available subject to the terms of
+ *  either of the following licenses
+ *
+ *         - GNU Lesser General Public License Version 2.1
+ *         - Sun Industry Standards Source License Version 1.1
+ *
+ *  Sun Microsystems Inc., October, 2000
+ *
+ *  GNU Lesser General Public License Version 2.1
+ *  =============================================
+ *  Copyright 2000 by Sun Microsystems, Inc.
+ *  901 San Antonio Road, Palo Alto, CA 94303, USA
+ *
+ *  This library is free software; you can redistribute it and/or
+ *  modify it under the terms of the GNU Lesser General Public
+ *  License version 2.1, as published by the Free Software Foundation.
+ *
+ *  This library is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ *  Lesser General Public License for more details.
+ *
+ *  You should have received a copy of the GNU Lesser General Public
+ *  License along with this library; if not, write to the Free Software
+ *  Foundation, Inc., 59 Temple Place, Suite 330, Boston,
+ *  MA  02111-1307  USA
+ *
+ *
+ *  Sun Industry Standards Source License Version 1.1
+ *  =================================================
+ *  The contents of this file are subject to the Sun Industry Standards
+ *  Source License Version 1.1 (the "License"); You may not use this file
+ *  except in compliance with the License. You may obtain a copy of the
+ *  License at http://www.openoffice.org/license.html.
+ *
+ *  Software provided under this License is provided on an "AS IS" basis,
+ *  WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
+ *  WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
+ *  MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
+ *  See the License for the specific provisions governing your rights and
+ *  obligations concerning the Software.
+ *
+ *  The Initial Developer of the Original Code is: Sun Microsystems, Inc.
+ *
+ *  Copyright: 2000 by Sun Microsystems, Inc.
+ *
+ *  All Rights Reserved.
+ *
+ *  Contributor(s): _______________________________________
+ *
+ *
+ ************************************************************************/
+
+package com.sun.star.uno;
+
+import java.io.IOException;
+import java.lang.reflect.Constructor;
+import java.util.ArrayList;
+import java.util.Iterator;
+import com.sun.star.lib.util.WeakMap;
+
+/**
+ * The central class needed for implementing or using UNO components in Java.
+ *
+ * <p>The methods <code>generateOid</code>, <code>queryInterface</code> and
+ * <code>areSame</code> delegate calls to the implementing objects and are used
+ * instead of <code>hashCode</code>, casts, <code>instanceof</code>,
+ * <code>==</code>, and <code>equals</code>.<p>
+ *
+ * <p>For historic reasons, this class is not <code>final</code>, and has a
+ * <code>public</code> constructor.  These artifacts are considered mistakes,
+ * which might be corrected in a future version of this class, so client code
+ * should not rely on them.</p>
+ *
+ * @see com.sun.star.uno.IBridge
+ * @see com.sun.star.uno.IEnvironment
+ * @see com.sun.star.uno.IQueryInterface
+ * @since UDK 1.0
+ */
+public class UnoRuntime {
+    /**
+     * @deprecated As of UDK 3.2, do not create instances of this class.  It is
+     * considered a historic mistake to have a <code>public</code> constructor
+     * for this class, which only has <code>static</code> members.  Also, this
+     * class might be changed to become <code>final</code> in a future version.
+     */
+    public UnoRuntime() {}
+
+    /**
+     * Generates a world wide unique identifier string.
+     *
+     * <p>It is guaranteed that every invocation of this method generates a new
+     * ID, which is unique within the VM.  The quality of &ldquo;world wide
+     * unique&rdquo; will depend on the actual implementation, you should look
+     * at the source to determine if it meets your requirements.</p>
+     *
+     * @return a unique <code>String</code>
+     */
+    public static String getUniqueKey() {
+        synchronized (uniqueKeyLock) {
+            if (uniqueKeyCount == Long.MAX_VALUE) {
+                long time;
+                for (time = System.currentTimeMillis(); time == uniqueKeyTime;)
+                {
+                    // Conservatively sleep for 100 millisecond to wait for
+                    // System.currentTimeMillis() to change:
+                    try {
+                        Thread.sleep(100);
+                    } catch (InterruptedException e) {
+                        Thread.currentThread().interrupt();
+                    }
+                }
+                uniqueKeyTime = time;
+                uniqueKeyCount = Long.MIN_VALUE;
+            }
+            return uniqueKeyHostPrefix + Long.toString(uniqueKeyTime, 16) + ":"
+                + Long.toString(uniqueKeyCount++, 16);
+        }
+    }
+
+    /**
+     * Generates a world wide unique object identifier (OID) for the given
+     * object.
+     *
+     * <p>It is guaranteed that subsequent calls to this method with the same
+     *  object will give the same ID.</p>
+     *
+     * @param object any object for which a OID shall be generated; must not be
+     * <code>null</code>
+     * @return the generated OID
+     * @see com.sun.star.uno.IQueryInterface#getOid
+     */
+    public static String generateOid(Object object) {
+        String oid = null;
+        if (object instanceof IQueryInterface) {
+            oid = ((IQueryInterface) object).getOid();
+        }
+        return oid == null ? object.hashCode() + oidSuffix : oid;
+    }
+
+    /**
+     * Queries the given UNO object for the given UNO interface type.
+     *
+     * <p>This method returns <code>null</code> in case the given UNO object
+     * does not support the given UNO interface type (or is itself
+     * <code>null</code>).  Otherwise, a reference to a Java object implementing
+     * the Java interface type corresponding to the given UNO interface is
+     * returned.  In the latter case, it is unspecified whether the returned
+     * Java object is the same as the given object, or is another facet of that
+     * UNO object.</p>
+     *
+     * @param type the requested UNO interface type; must be a <code>Type</code>
+     * object representing a UNO interface type
+     * @param object a reference to any Java object representing (a facet of) a
+     * UNO object; may be <code>null</code>
+     * @return a reference to the requested UNO interface type if available,
+     * otherwise <code>null</code>
+     * @see com.sun.star.uno.IQueryInterface#queryInterface
+     */
+    public static Object queryInterface(Type type, Object object) {
+        // Gracefully handle those situations where the passed in UNO object is
+        // wrapped in an Any.  Strictly speaking, such a situation constitutes a
+        // bug, but it is anticipated that such situations will arise quite
+        // often in practice (especially since UNO Anys containing an XInterface
+        // reference are not wrapped in a Java Any, but UNO Anys containing any
+        // other interface reference are wrapped in a Java Any, which can lead
+        // to confusion).
+        if (object instanceof Any) {
+            Any a = (Any) object;
+            if (a.getType().getTypeClass() == TypeClass.INTERFACE) {
+                object = a.getObject();
+            }
+        }
+        if (object instanceof IQueryInterface) {
+            object = ((IQueryInterface) object).queryInterface(type);
+            if (object instanceof Any) {
+                Any a = (Any) object;
+                object = a.getType().getTypeClass() == TypeClass.INTERFACE
+                    ? a.getObject() : null;
+            }
+        }
+        // Ensure that the object implements the requested interface type:
+        Class c = type.getZClass();
+        if (c == null || !c.isInstance(object)) {
+            object = null;
+        }
+        return object;
+    }
+
+    /**
+     * Queries the given UNO object for the given Java class (which must
+     * represent a UNO interface type).
+     *
+     * @param ifc a Java class representing a UNO interface type
+     * @param object a reference to any Java object representing (a facet of) a
+     * UNO object; may be <code>null</code>
+     * @return a reference to the requested UNO interface type if available,
+     * otherwise <code>null</code>
+     * @see #queryInterface(Type, Object)
+     */
+    public static Object queryInterface(Class zInterface, Object object) {
+        return queryInterface(new Type(zInterface), object);
+    }
+
+    /**
+     * Tests if the given references represent facets of the same UNO object.
+     *
+     * <p>For UNO objects, it does not work to check object identity with
+     * <code>==</code> or <code>equals</code>, as there may for example be
+     * multiple Java proxies for the same UNO object, each proxy implementing
+     * different interfaces.</p>
+     *
+     * @param object1 a reference to any Java object representing (a facet of) a
+     * UNO object; may be <code>null</code>
+     * @param object2 a reference to any Java object representing (a facet of) a
+     * UNO object; may be <code>null</code>
+     * @return <code>true</code> if and only if <code>object1</code> and
+     * <code>object2</code> are both <code>null</code>, or both represent the
+     * same UNO object
+     * @see com.sun.star.uno.IQueryInterface#isSame
+     */
+    public static boolean areSame(Object object1, Object object2) {
+        return object1 == object2
+            || (object1 instanceof IQueryInterface
+                && ((IQueryInterface) object1).isSame(object2))
+            || (object2 instanceof IQueryInterface
+                && ((IQueryInterface) object2).isSame(object1));
+    }
+
+    /**
+     * Gets the current context of the current thread, or <code>null</code> if
+     * no context has been set for the current thread.
+     *
+     * <p>The current context is thread local, which means that this method
+     * returns the context that was last set for this thread.</p>
+     *
+     * @return the current context of the current thread, or <code>null</code>
+     * if no context has been set for the current thread
+     */
+    public static XCurrentContext getCurrentContext() {
+        return (XCurrentContext) currentContext.get();
+    }
+
+    /**
+     * Sets the current context for the current thread.
+     *
+     * <p>The current context is thread local.  To support a stacking behaviour,
+     * every function that sets the current context should reset it to the
+     * original value when exiting (for example, within a <code>finally</code>
+     * block).</p>
+     *
+     * @param context the context to be set; if <code>null</code>, any
+     * previously set context will be removed
+    */
+    public static void setCurrentContext(XCurrentContext context) {
+        // optimize this by using Java 1.5 ThreadLocal.remove if context == null
+        currentContext.set(context);
+    }
+
+    /**
+     * Retrieves an environment of type <code>name</code> with context
+     * <code>context</code>.
+     *
+     * <p>Environments are held weakly by this class.  If the requested
+     * environment already exists, this methods simply returns it.  Otherwise,
+     * this method looks for it under
+     * <code>com.sun.star.lib.uno.environments.<var>name</var>.<!--
+     * --><var>name</var>_environment</code>.</p>
+     *
+     * @param name the name of the environment
+     * @param context the context of the environment
+     * @see com.sun.star.uno.IEnvironment
+     *
+     * @deprecated As of UDK 3.2, this method is deprecated, without offering a
+     * replacement.
+     */
+    public static IEnvironment getEnvironment(String name, Object context)
+        throws java.lang.Exception
+    {
+        synchronized (environments) {
+            IEnvironment env = (IEnvironment) WeakMap.getValue(
+                environments.get(name + context));
+            if (env == null) {
+                Class c = Class.forName(
+                    "com.sun.star.lib.uno.environments." + name + "." + name
+                    + "_environment");
+                Constructor ctor = c.getConstructor(
+                    new Class[] { Object.class });
+                env = (IEnvironment) ctor.newInstance(new Object[] { context });
+                environments.put(name + context, env);
+            }
+            return  env;
+        }
+    }
+
+    /**
+     * Gets a bridge from environment <code>from</code> to environment
+     * <code>to</code>.
+     *
+     * <p>Creates a new bridge, if the requested bridge does not yet exist, and
+     * hands the arguments to the bridge.</p>
+     *
+     * <p>If the requested bridge does not exist, it is searched for in package
+     * <code>com.sun.star.lib.uno.bridges.<var>from</var>_<var>to</var>;</code>
+     * and the root classpath as
+     * <code><var>from</var>_<var>to</var>_bridge</code>.</p>
+     *
+     * @param from the source environment
+     * @param to the target environment
+     * @param args the initial arguments for the bridge
+     * @return the requested bridge
+     * @see #getBridgeByName
+     * @see com.sun.star.uno.IBridge
+     * @see com.sun.star.uno.IEnvironment
+     *
+     * @deprecated As of UDK 3.2, this method is deprecated, without offering a
+     * replacement.
+     */
+    public static IBridge getBridge(
+        IEnvironment from, IEnvironment to, Object[] args)
+        throws java.lang.Exception
+    {
+        synchronized (bridges) {
+            String name = from.getName() + "_" + to.getName();
+            String hashName = from.getName() + from.getContext() + "_"
+                + to.getName() + to.getContext();
+            IBridge bridge = (IBridge) WeakMap.getValue(bridges.get(hashName));
+            if(bridge == null) {
+                Class zClass = null;
+                String className =  name + "_bridge";
+                try {
+                    zClass = Class.forName(className);
+                } catch (ClassNotFoundException e) {
+                    className = "com.sun.star.lib.uno.bridges." + name + "."
+                        + className;
+                    zClass = Class.forName(className);
+                }
+                Class[] signature = {
+                    IEnvironment.class, IEnvironment.class, args.getClass() };
+                Constructor constructor = zClass.getConstructor(signature);
+                Object[] iargs = { from, to, args };
+                bridge = (IBridge) constructor.newInstance(iargs);
+                bridges.put(hashName, bridge);
+            }
+            return bridge;
+        }
+    }
+
+    /**
+     * Gets a bridge from environment <code>from</code> to environment
+     * <code>to</code>.
+     *
+     * <p>Creates a new bridge, if the requested bridge does not yet exist, and
+     * hands the arguments to the bridge.</p>
+     *
+     * <p>If the requested bridge does not exist, it is searched for in package
+     * <code>com.sun.star.lib.uno.bridges.<var>from</var>_<var>to</var>;</code>
+     * and the root classpath as
+     * <code><var>from</var>_<var>to</var>_bridge</code>.  The used environments
+     * are retrieved through <code>getEnvironment</code>.</p>
+     *
+     * @param from the name of the source environment
+     * @param fromContext the context for the source environment
+     * @param to the name of the target environment
+     * @param toContext the context for the target environment
+     * @param args the initial arguments for the bridge
+     * @return the requested bridge
+     * @see #getBridge
+     * @see #getEnvironment
+     * @see com.sun.star.uno.IBridge
+     * @see com.sun.star.uno.IEnvironment
+     *
+     * @deprecated As of UDK 3.2, this method is deprecated, without offering a
+     * replacement.
+     */
+    public static IBridge getBridgeByName(
+        String from, Object fromContext, String to, Object toContext,
+        Object[] args) throws java.lang.Exception
+    {
+        return getBridge(
+            getEnvironment(from, fromContext), getEnvironment(to, toContext),
+            args);
+    }
+
+    /**
+     * Returns an array of all active bridges.
+     *
+     * @return an array of <code>IBridge</code> objects
+     * @see com.sun.star.uno.IBridge
+     *
+     * @deprecated As of UDK 3.2, this method is deprecated, without offering a
+     * replacement.
+     */
+    public static IBridge[] getBridges() {
+        ArrayList l = new ArrayList();
+        synchronized (bridges) {
+            for (Iterator i = bridges.values().iterator(); i.hasNext();) {
+                Object o = WeakMap.getValue(i.next());
+                if (o != null) {
+                    l.add(o);
+                }
+            }
+        }
+        return (IBridge[]) l.toArray(new IBridge[l.size()]);
+    }
+
+    /**
+     * Gets a mapping from environment <code>from</code> to environment
+     * <code>to</code>.
+     *
+     * <p>Mappings are like bridges, except that with mappings one can only map
+     * in one direction.  Mappings are here for compatibility with the binary
+     * UNO API.  Mappings are implemented as wrappers around bridges.</p>
+     *
+     * @param from the source environment
+     * @param to the target environment
+     * @return the requested mapping
+     * @see com.sun.star.uno.IEnvironment
+     * @see com.sun.star.uno.IMapping
+     *
+     * @deprecated As of UDK 3.2, this method is deprecated, without offering a
+     * replacement.
+     */
+    public static IMapping getMapping(IEnvironment from, IEnvironment to)
+        throws java.lang.Exception
+    {
+        IBridge bridge;
+        try {
+            bridge = getBridge(from, to, null);
+        }
+        catch (ClassNotFoundException e) {
+            bridge = new BridgeTurner(getBridge(to, from, null));
+        }
+        return new MappingWrapper(bridge);
+    }
+
+    /**
+     * Gets a mapping from environment <code>from</code> to environment
+     * <code>to</code>.
+     *
+     * <p>The used environments are retrieved through
+     * <code>getEnvironment</code>.</p>
+     *
+     * @param from the name of the source environment
+     * @param to the name of the target environment
+     * @return the requested mapping
+     * @see #getEnvironment
+     * @see #getMapping
+     * @see com.sun.star.uno.IMapping
+     *
+     * @deprecated As of UDK 3.2, this method is deprecated, without offering a
+     * replacement.
+     */
+    public static IMapping getMappingByName(String from, String to)
+        throws java.lang.Exception
+    {
+        return getMapping(getEnvironment(from, null), getEnvironment(to, null));
+    }
+
+    /**
+     * Resets this <code>UnoRuntime</code> to its initial state.
+     *
+     * <p>Releases all references to bridges and environments.</p>
+     *
+     * @deprecated As of UDK 3.2, this method is deprecated, without offering a
+     * replacement.
+     */
+    static public boolean reset() {
+        synchronized (bridges) {
+            for (Iterator i = bridges.values().iterator(); i.hasNext();) {
+                IBridge b = (IBridge) WeakMap.getValue(i.next());
+                if (b != null) {
+                    // The following call to dispose was originally made to
+                    // com.sun.star.lib.sandbox.Disposable.dispose, which cannot
+                    // throw an InterruptedException or IOException:
+                    try {
+                        b.dispose();
+                    } catch (InterruptedException e) {
+                        Thread.currentThread().interrupted();
+                        throw new RuntimeException(
+                            "Unexpected exception in UnoRuntime.reset: " + e);
+                    } catch (IOException e) {
+                        throw new RuntimeException(
+                            "Unexpected exception in UnoRuntime.reset: " + e);
+                    }
+                }
+            }
+            bridges.clear();
+        }
+        environments.clear();
+        return bridges.isEmpty() && environments.isEmpty();
+    }
+
+    /**
+     * @deprecated As of UDK 3.2, do not use this internal field.
+     */
+    static public final boolean DEBUG = false;
+
+    private static final class BridgeTurner implements IBridge {
+        public BridgeTurner(IBridge bridge) {
+            this.bridge = bridge;
+        }
+
+        public Object mapInterfaceTo(Object object, Type type) {
+            return bridge.mapInterfaceFrom(object, type);
+        }
+
+        public Object mapInterfaceFrom(Object object, Type type) {
+            return bridge.mapInterfaceTo(object, type);
+        }
+
+        public IEnvironment getSourceEnvironment() {
+            return bridge.getTargetEnvironment();
+        }
+
+        public IEnvironment getTargetEnvironment() {
+            return bridge.getSourceEnvironment();
+        }
+
+        public void acquire() {
+            bridge.acquire();
+        }
+
+        public void release() {
+            bridge.release();
+        }
+
+        public void dispose() throws InterruptedException, IOException {
+            bridge.dispose();
+        }
+
+        private final IBridge bridge;
+    }
+
+    private static final class MappingWrapper implements IMapping {
+        public MappingWrapper(IBridge bridge) {
+            this.bridge = bridge;
+        }
+
+        public Object mapInterface(Object object, Type type) {
+            return bridge.mapInterfaceTo(object, type);
+        }
+
+        private final IBridge bridge;
+    }
+
+    private static final String uniqueKeyHostPrefix
+    = Integer.toString(new Object().hashCode(), 16) + ":";
+    private static final Object uniqueKeyLock = new Object();
+    private static long uniqueKeyTime = System.currentTimeMillis();
+    private static long uniqueKeyCount = Long.MIN_VALUE;
+
+    private static final String oidSuffix = ";java[];" + getUniqueKey();
+
+    private static final ThreadLocal currentContext = new ThreadLocal();
+
+    private static final WeakMap environments = new WeakMap();
+    private static final WeakMap bridges = new WeakMap();
+}