Mozilla/mozilla/java/webclient/src_moz/jni_util_export.h
edburns%acm.org bcbf08419d bug: 20659
r=gbarney
a=edburns

This checkin adds java.awt.event.MouseListener support to webclient for
mozilla.  The following files are include in this checkin.  "A" is new
file "M" is modified file.

A classes_spec/org/mozilla/webclient/WCMouseEvent.java
A classes_spec/org/mozilla/webclient/wrapper_native/WCMouseListenerImpl.java
A src_moz/DOMMouseListenerImpl.cpp
A src_moz/DOMMouseListenerImpl.h
A src_moz/dom_util.cpp
A src_moz/dom_util.h

M classes_spec/org/mozilla/webclient/EventRegistration.java
M classes_spec/org/mozilla/webclient/test/EMWindow.java
M classes_spec/org/mozilla/webclient/wrapper_native/EventRegistrationImpl.java
M classes_spec/org/mozilla/webclient/wrapper_native/NativeEventThread.java
M src_moz/DocumentLoaderObserverImpl.cpp
M src_moz/DocumentLoaderObserverImpl.h
M src_moz/EventRegistration.cpp
M src_moz/EventRegistration.h
M src_moz/Makefile.solaris
M src_moz/Makefile.win
M src_moz/NativeEventThread.cpp
M src_moz/NavigationImpl.cpp
M src_moz/RDFTreeNode.cpp
M src_moz/bal_util.cpp
M src_moz/jni_util.cpp
M src_moz/jni_util.h
M src_moz/jni_util_export.cpp
M src_moz/jni_util_export.h



A classes_spec/org/mozilla/webclient/WCMouseEvent.java

 * <P> This java.awt.event.MouseEvent subclass allows the user to access the
 * WebclientEvent.  This eventData of this WebclientEvent, if non-null,
 * is a java.util.Properties instance that contains information about
 * this event.  </P>

 * <P>The following are some interesting keys:</P>

 * <UL>

 * <LI> href
 * </LI>

 * <LI> #text
 * </LI>

 * </UL>

A classes_spec/org/mozilla/webclient/wrapper_native/WCMouseListenerImpl.java

 * This class wraps the user provided instance of
 * java.awt.event.MouseListener so it can be installed as a
 * WebclientEventListener.  Note that we implement MouseListener so we
 * can be detected by the webclient event system.  We don't do anything
 * with these methods here, though.


A src_moz/DOMMouseListenerImpl.cpp

A src_moz/DOMMouseListenerImpl.h

 * This class is the shim between the mozilla listener event system for
 * mouse events and the java MouseListener interface.
 * For each of the Mouse* methods, we call the appropriate method in java.
 * See the implementation of MouseOver for an example.

 * For each mouseEvent, we create a Properties object containing
 * information about the event.  We use methods in dom_util to do this.

A src_moz/dom_util.cpp

A src_moz/dom_util.h

/**

 * Methods to simplify webclient accessing the mozilla DOM.

 */

M classes_spec/org/mozilla/webclient/EventRegistration.java

Added support for java.awt.event.MouseListener

M classes_spec/org/mozilla/webclient/test/EMWindow.java

Implemented simle MouseListener

M classes_spec/org/mozilla/webclient/wrapper_native/EventRegistrationImpl.java

Added support for java.awt.event.MouseListener

M classes_spec/org/mozilla/webclient/wrapper_native/NativeEventThread.java

Added support for java.awt.event.MouseListener

M src_moz/DocumentLoaderObserverImpl.cpp
M src_moz/DocumentLoaderObserverImpl.h

 * We define a local IID to allow the addDocumentLoadListener and
 * addMouseListener functions in EventRegistration.{h,cpp} to
 * interrogate the currently installed DocumentLoaderObserver instance
 * in mozilla.

 */

#define NS_IDOCLOADEROBSERVERIMPL_IID_STR "fdadb2e0-3028-11d4-8a96-0080c7b9c5ba"

#define NS_IDOCLOADEROBSERVERIMPL_IID {0xfdadb2e0, 0x3028, 0x11d4, { 0x8a, 0x96, 0x00, 0x80, 0xc7, 0xb9, 0xc5, 0xba }}

/**

 * This class is the shim between the mozilla listener event system for
 * document load events and the java DocumentLoadListener interface.
 * For each of the On* methods, we call the appropriate method in java.
 * See the implementation of OnEndDocumentLoad for an example.

 * A DocumentLoaderObserverImpl instance has a "jobject target", which
 * is the Java object that should ultimately receive the events.  This
 * target will be null if the user just wants to listen for mouse
 * events.  It willl be non-null if the user wants to listen for
 * DocumentLoad events.

 * It also hosts a nsIDOMMouseListener instance, which piggybacks on the
 * nsIDocumentLoaderObserver instance.

M src_moz/EventRegistration.cpp
M src_moz/EventRegistration.h

Add support for MouseListener

M src_moz/Makefile.win

Added classes for MouseListener and Dom access

M src_moz/NativeEventThread.cpp

Added support for MouseListener

M src_moz/NavigationImpl.cpp

Added call to ReleaseStringChars for bal case.

M src_moz/RDFTreeNode.cpp

Added call to ReleaseStringChars for bal case.

M src_moz/bal_util.cpp

Added #include "wchar.h" so this file compiles on Solaris.

M src_moz/jni_util.cpp

Added implementations for util_CreatePropertiesObject,
util_DestroyPropertiesObject and util_StoreIntoPropertiesObject.

M src_moz/jni_util.h

/**

 * A JNI wrapper to create a java.util.Properties object, or the
 * equivalent object in the BAL case.

 */

jobject util_CreatePropertiesObject(JNIEnv *env, jobject reserved_NotUsed);

/**

 * A JNI wrapper to destroy the object from CreatePropertiesObject

 */

void util_DestroyPropertiesObject(JNIEnv *env, jobject propertiesObject,
                                  jobject reserved_NotUsed);

/**

 * A JNI wrapper for storing a name/value pair into the Properties
 * object created by CreatePropertiesObject

 */

void util_StoreIntoPropertiesObject(JNIEnv *env, jobject propertiesObject,
                                    jobject name, jobject value);


M src_moz/jni_util_export.cpp
M src_moz/jni_util_export.h

Added functions for allowing the BAL user to specify functions for
{creating, destroying, setting values into} properties objects.


git-svn-id: svn://10.0.0.236/trunk@70879 18797224-902f-48f8-a5cc-f745e15eee43
2000-05-25 23:51:51 +00:00

333 lines
8.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): Ed Burns <edburns@acm.org>
*
*/
/**
* Exported Util methods, called from webclient uno.
*/
#ifndef jni_util_export_h
#define jni_util_export_h
#ifdef __cplusplus
extern "C" {
#endif
#include <jni.h>
JNIEXPORT const char * JNICALL util_GetStringUTFChars(JNIEnv *env,
jstring inString);
JNIEXPORT void JNICALL util_ReleaseStringUTFChars(JNIEnv *env,
jstring inString,
const char *stringFromGet);
JNIEXPORT const jchar * JNICALL util_GetStringChars(JNIEnv *env,
jstring inString);
JNIEXPORT void JNICALL util_ReleaseStringChars(JNIEnv *env, jstring inString,
const jchar *stringFromGet);
JNIEXPORT jstring JNICALL util_NewStringUTF(JNIEnv *env,
const char * inString);
JNIEXPORT void JNICALL util_DeleteStringUTF(JNIEnv *env, jstring toDelete);
JNIEXPORT jstring JNICALL util_NewString(JNIEnv *env, const jchar *inString,
jsize len);
JNIEXPORT void JNICALL util_DeleteString(JNIEnv *env, jstring toDelete);
//
// BAL methods
//
/*
* The following methods are used by non Java JNI clients, such as
* StarOfficeDesktop.
*/
/**
* This method is used to store a mapping from a jniClass Name, such as
* "org/mozilla/webclient/DocumentLoadListener" to some external class
* type, such as
* org::mozilla::webclient::wrapper_native::uno::DocumentLoadListener.
* This table is used in util_IsInstanceOf.
* @see util_SetInstanceOfFunction
* @ret 0 on success
*/
JNIEXPORT jint JNICALL util_StoreClassMapping(const char* jniClassName,
jclass yourClassType);
JNIEXPORT jclass JNICALL util_GetClassMapping(const char* jniClassName);
/**
* Function declaration for the user defined InstanceOf function. It
* tells whether the second argument, which is an instance, is an
* instance of the type in the third argument.
* @see util_SetInstanceOfFunction
*/
typedef JNIEXPORT jboolean (JNICALL *fpInstanceOfType) (JNIEnv *env,
jobject obj,
jclass clazz);
/**
* Function declaration for the user defined EventOccurred function. It
* is called when an event occurrs. The second argument is the context
* for the event, passed in by the user as the second argument to
* NativeEventThreadImpl_nativeAddListener(). The third arcument is the
* listener object, passed in as the last argument to
* NativeEventThreadImpl_nativeAddListener(). The fourth argument is a
* listener specific type field, to indicate what kind of sub-event
* within the listener has occurred. The last argument is a listener
* sub-event specific argument. For example, when the event class is
* DocumentLoadListener, and the sub-event is "STATUS_URL_LOAD", the
* last argument is a string with a status message, ie "Contacting host
* blah...", etc.
*/
typedef JNIEXPORT void (JNICALL * fpEventOccurredType) (JNIEnv *env,
jobject nativeEventThread,
jobject webclientEventListener,
jlong eventType,
jobject eventData);
/**
* Called at app initialization to external user to provide a function
* that will fill in the event mask values for the given listener class.
* @param nullTermMaskNameArray a NULL terminated const char * array for
* the mask names.
* @param maskValueArray a parallel array for the values that match the
* corresponding elements in nullTermMaskNameArray
*/
typedef JNIEXPORT void (JNICALL * fpInitializeEventMaskType)
(JNIEnv *env,
jclass listenerClass,
const char **nullTermMaskNameArray,
jlong *maskValueArray);
/**
* Called when webclient wants to create a "Properties" object. Right
* now, no parameters are actually used.
*/
typedef JNIEXPORT jobject (JNICALL * fpCreatePropertiesObjectType)
(JNIEnv *env, jobject reserved_NotUsed);
/**
* Called after webclient is done using a "Properties" object it created
* with fpCreatePropertiesObject
* @param propertiesObject the propertiesObject created with
* fpCreatePropertiesObject
*/
typedef JNIEXPORT void (JNICALL * fpDestroyPropertiesObjectType)
(JNIEnv *env, jobject propertiesObject, jobject reserved_NotUsed);
/**
* Called after webclient has called fpCreatePropertiesObjectType when
* webclient wants to store values into the properties object.
* @param env not used
* @param propertiesObject obtained from fpCreatePropertiesObjectType
* @param name the name of the property
* @param the value of the property
*/
typedef JNIEXPORT void (JNICALL * fpStoreIntoPropertiesObjectType)
(JNIEnv *env, jobject propertiesObject, jobject name, jobject value);
/**
* This function must be called at app initialization.
* @see fpInstanceOfType
*/
JNIEXPORT void JNICALL util_SetInstanceOfFunction(fpInstanceOfType fp);
/**
* This function must be called at app initialization.
* @see fpEventOccurredType
*/
JNIEXPORT void JNICALL util_SetEventOccurredFunction(fpEventOccurredType fp);
/**
* This function must be called at app initialization.
* @see fpInitializeEventMaskType
*/
JNIEXPORT void JNICALL util_SetInitializeEventMaskFunction(fpInitializeEventMaskType fp);
/**
* This function must be called at app initialization.
* @see fpCreatePropertiesObjectType
*/
JNIEXPORT void JNICALL util_SetCreatePropertiesObjectFunction(fpCreatePropertiesObjectType fp);
/**
* This function must be called at app initialization.
* @see fpDestroyPropertiesObjectType
*/
JNIEXPORT void JNICALL util_SetDestroyPropertiesObjectFunction(fpDestroyPropertiesObjectType fp);
/**
* This function must be called at app initialization.
* @see fpStoreIntoPropertiesObjectType
*/
JNIEXPORT void JNICALL util_SetStoreIntoPropertiesObjectFunction(fpStoreIntoPropertiesObjectType fp);
/**
* defined in jni_util_export.cpp
* The function pointer set with util_SetEventOccurredFunction.
*/
extern fpEventOccurredType externalEventOccurred;
/**
* defined in jni_util_export.cpp
* The function pointer set with util_SetInstanceOfFunction.
*/
extern fpInstanceOfType externalInstanceOf;
/**
* defined in jni_util_export.cpp
* The function pointer set with util_SetInitializeEventMaskFunction
*/
extern fpInitializeEventMaskType externalInitializeEventMask;
/**
* defined in jni_util_export.cpp
* The function pointer set with util_SetCreatePropertiesObjectFunction
*/
extern fpCreatePropertiesObjectType externalCreatePropertiesObject;
/**
* defined in jni_util_export.cpp
* The function pointer set with util_SetDestroyPropertiesObjectFunction
*/
extern fpDestroyPropertiesObjectType externalDestroyPropertiesObject;
/**
* defined in jni_util_export.cpp
* The function pointer set with util_SetStoreIntoPropertiesObjectFunction
*/
extern fpStoreIntoPropertiesObjectType externalStoreIntoPropertiesObject;
/**
* Called by the mozilla event listener implementation class at
* construction time.
*/
JNIEXPORT void JNICALL
util_InitializeEventMaskValuesFromClass(const char *className,
char *maskNames[],
jlong maskValues[]);
#ifdef __cplusplus
} /* extern "C" */
#endif /* __cplusplus */
#endif // jni_util_export_h