edburns%acm.org f4d7081311 This checkin adds API to cleanly destroy a BrowserControl instance. It
also modifies EmbeddedMozilla so this code is exercised.

I have changed EmbeddedMozilla to be a stub-like class that simply
displays a Frame with a single Button, titled "New Window".  Pressing
this button causes an EMWindow to be created and displayed.  EMWindow is
basically the former EmbeddedMozilla renamed, with modifications to the
WindowListener implementation to call the BrowserControl deallocation
method.

I've added a delete() method to ImplObect:

 * I know Java has automatic garbage collection and all, but explicitly
 * adding a delete method helps the gc algorithm out. <P>

 * Subclasses should override this and call super.delete() at the end of
 * their overridden delete() method.

 * @see org.mozilla.webclient.wrapper_native.ImplObjectNative#delete

and ImplObjectNative:

 * Note how we call super.delete() at the end.  THIS IS VERY IMPORTANT. <P>

 * Also, note how we don't de-allocate nativeWebShell, that is done in
 * the class that owns the nativeWebShell reference, WindowControlImpl.

 * ImplObjectNative subclasses that further override delete() are <P>

<CODE><PRE>
BookmarksImpl.java
EventRegistrationImpl.java
NativeEventThread.java
WindowControlImpl.java
</PRE><CODE> <P>

 * All other ImplObject subclasses don't have any local Ivars and thus
 * don't need to override delete().

I've added a delete() method to BrowserControlImpl:

 * Called from BrowserControlFactory.deleteBrowserControl() <P>

 * The order of deletion of objects is very important! <P>

 * We don't allow deletion if the Canvas is showing. <P>

In BrowserControlImpl's delete(), the important delete()s is for
WindowControlImpl:

 * First, we delete our eventThread, which causes the eventThread to
 * stop running.  Then we call nativeDestroyInitContext(), which
 * deallocates native resources for this window.

As stated above, NativeEventThread.delete() is called:

 * This is a very delicate method, and possibly subject to race
 * condition problems.  To combat this, our first step is to set our
 * browserControlCanvas to null, within a synchronized block which
 * synchronizes on the same object used in the run() method's event
 * loop.  By setting the browserControlCanvas ivar to null, we cause the
 * run method to return.

After all of this deleting, we return from
BrowserControlFactory.delete().


git-svn-id: svn://10.0.0.236/trunk@62772 18797224-902f-48f8-a5cc-f745e15eee43
2000-03-13 18:44:32 +00:00

171 lines
4.4 KiB
C

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
*
* The contents of this file are subject to the Mozilla Public
* 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.mozilla.org/MPL/
*
* Software distributed under the License is distributed on an "AS
* IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
* implied. See the License for the specific language governing
* rights and limitations under the License.
*
* The Original Code is RaptorCanvas.
*
* The Initial Developer of the Original Code is Kirk Baker and
* Ian Wilkinson. Portions created by Kirk Baker and Ian Wilkinson are
* Copyright (C) 1999 Kirk Baker and Ian Wilkinson. All
* Rights Reserved.
*
* Contributor(s): Kirk Baker <kbaker@eb.com>
* Ian Wilkinson <iw@ennoble.com>
* Mark Lin <mark.lin@eng.sun.com>
* Mark Goddard
* Ed Burns <edburns@acm.org>
* Ann Sunhachawee
*/
/**
* Util methods
*/
#ifndef jni_util_h
#define jni_util_h
#include <jni.h>
#include "nsCOMPtr.h" // so we can save the docShell
#include "nsIDocShell.h" // so we can save our nsIDocShell
#include "nsISessionHistory.h" // so we can save our nsISessionHistory
#include "nsIThread.h" // for PRThread
#include "nsIWebShell.h" // for nsIWebShell
#include "nsIEventQueueService.h" // for PLEventQueue
// Ashu
#ifdef XP_UNIX
#include "nsIWidget.h" // for GTKWidget
#include <gtk/gtk.h>
#endif
//
//
// local classes
//
// PENDING(edburns): this should be a class, and we should define a
// constructor and destructor for it.
struct WebShellInitContext {
#ifdef XP_UNIX
GtkWidget * parentHWnd;
#else
// PENDING(mark): Don't we need something for Mac?
HWND parentHWnd;
#endif
nsCOMPtr<nsIWebShell> webShell;
nsCOMPtr<nsIDocShell> docShell;
nsISessionHistory* sessionHistory;
PLEventQueue * actionQueue;
PRThread * embeddedThread;
JNIEnv * env;
jobject nativeEventThread;
int stopThread;
int initComplete;
int initFailCode;
int x;
int y;
int w;
int h;
int gtkWinPtr;
};
enum {
kEventQueueError = 1,
kCreateWebShellError,
kInitWebShellError,
kShowWebShellError,
kHistoryWebShellError,
kClipboardWebShellError
};
extern JavaVM *gVm;
void util_ThrowExceptionToJava (JNIEnv * env, const char * message);
/**
* This method calls PL_PostEvent(),
* http://lxr.mozilla.org/mozilla/source/xpcom/threads/plevent.c#248
* which simply uses nice monitors to insert the event into the provided
* event queue, which is from WebShellInitContext->actionQueue, which is
* created in NativeEventThread.cpp:InitMozillaStuff(). The events are
* processed in NativeEventThread.cpp:processEventLoop, which is called
* from the Java NativeEventThread.run(). See the code and comments for
* processEventLoop in NativeEventThread.cpp.
*/
void util_PostEvent (WebShellInitContext * initContext, PLEvent * event);
/**
* This method calls PL_PostSynchronousEvent(),
* http://lxr.mozilla.org/mozilla/source/xpcom/threads/plevent.c#278
* which, instead of putting the event in the queue, as in
* util_PostEvent(), either calls the event's handler directly, or puts
* it in the queue and waits for it to be processed so it can return the
* result.
*/
void * util_PostSynchronousEvent (WebShellInitContext * initContext, PLEvent * event);
/**
* simply call the java method nativeEventOccurred on
* eventRegistrationImpl, passing webclientEventListener and eventType
* as arguments.
*/
void util_SendEventToJava(JNIEnv *env, jobject eventRegistrationImpl,
jobject webclientEventListener,
jlong eventType);
char *util_GetCurrentThreadName(JNIEnv *env);
void util_DumpJavaStack(JNIEnv *env);
//
// Functions from secret JDK files
//
JNIEXPORT jvalue JNICALL
JNU_CallMethodByName(JNIEnv *env,
jboolean *hasException,
jobject obj,
const char *name,
const char *signature,
...);
JNIEXPORT jvalue JNICALL
JNU_CallMethodByNameV(JNIEnv *env,
jboolean *hasException,
jobject obj,
const char *name,
const char *signature,
va_list args);
JNIEXPORT void * JNICALL
JNU_GetEnv(JavaVM *vm, jint version);
#endif // jni_util_h