Magic-Mirror/gecko-dev
1
0
Fork 0
mirror of https://github.com/mozilla/gecko-dev.git synced 2025-04-03 04:52:54 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Fix for bug 61692: IDLify nsIEventQueue and nsIEventQueueService. This makes it possible to create an nsISupports proxy for calling across threads in languages other than C++ (eg JS). r=dougt@netscape.com, r=jband@netscape.com, sr=brendan@mozilla.org

Browse Source
This commit is contained in:
dmose%mozilla.org 2000-12-08 04:30:36 +00:00
parent 605f245267
commit 0a3c12b78b
12 changed files with 296 additions and 238 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

BIN
xpcom/macbuild/XPCOMIDL.mcp
View File

Binary file not shown.

2
xpcom/threads/MANIFEST
View File

@ -1,4 +1,2 @@
nsAutoLock.h
nsIEventQueue.h
nsIEventQueueService.h
plevent.h

2
xpcom/threads/MANIFEST_IDL
View File

@ -1,3 +1,5 @@
nsIRunnable.idl
nsIThread.idl
nsIThreadPool.idl
nsIEventQueue.idl
nsIEventQueueService.idl

4
xpcom/threads/Makefile.in
View File

@ -44,8 +44,6 @@ CPPSRCS = \
EXPORTS = \
nsAutoLock.h \
nsIEventQueue.h \
nsIEventQueueService.h \
plevent.h \
$(NULL)
@ -53,6 +51,8 @@ XPIDLSRCS = \
nsIThread.idl \
nsIThreadPool.idl \
nsIRunnable.idl \
nsIEventQueue.idl \
nsIEventQueueService.idl \
$(NULL)
EXPORTS := $(addprefix $(srcdir)/, $(EXPORTS))

12
xpcom/threads/makefile.win
View File

@ -29,18 +29,18 @@ MODULE = xpcom_threads
EXPORTS = \
nsAutoLock.h \
nsIEventQueue.h \
nsIEventQueueService.h \
plevent.h \
$(NULL)
NO_XPT_GEN=1
XPIDL_MODULE = xpcom_thread
XPIDLSRCS = \
.\nsIThread.idl \
.\nsIThreadPool.idl \
.\nsIRunnable.idl \
XPIDLSRCS = \
.\nsIEventQueue.idl \
.\nsIEventQueueService.idl \
.\nsIThread.idl \
.\nsIThreadPool.idl \
.\nsIRunnable.idl \
$(NULL)
################################################################################

35
xpcom/threads/nsEventQueue.h
View File

@ -34,41 +34,8 @@ public:
// nsISupports interface...
NS_DECL_ISUPPORTS
// nsIEventQueue interface...
NS_IMETHOD InitEvent(PLEvent* aEvent, void* owner,
PLHandleEventProc handler,
PLDestroyEventProc destructor);
NS_IMETHOD_(PRStatus) PostEvent(PLEvent* aEvent);
NS_IMETHOD PostSynchronousEvent(PLEvent* aEvent, void** aResult);
NS_IMETHOD ProcessPendingEvents();
NS_IMETHOD EventLoop();
NS_IMETHOD EventAvailable(PRBool& aResult);
NS_IMETHOD GetEvent(PLEvent** aResult);
NS_IMETHOD HandleEvent(PLEvent* aEvent);
NS_IMETHOD WaitForEvent(PLEvent** aResult);
NS_IMETHOD_(PRInt32) GetEventQueueSelectFD();
NS_IMETHOD Init(PRBool aNative);
NS_IMETHOD InitFromPRThread(PRThread* thread, PRBool aNative);
NS_IMETHOD InitFromPLQueue(PLEventQueue* aQueue);
NS_IMETHOD EnterMonitor();
NS_IMETHOD ExitMonitor();
NS_IMETHOD RevokeEvents(void* owner);
NS_IMETHOD GetPLEventQueue(PLEventQueue** aEventQueue);
NS_IMETHOD IsQueueOnCurrentThread(PRBool *aResult);
NS_IMETHOD IsQueueNative(PRBool *aResult);
NS_IMETHOD StopAcceptingEvents();
NS_DECL_NSIEVENTQUEUE
// Helpers
static NS_METHOD Create(nsISupports* outer, const nsIID& aIID, void* *aInstancePtr);

56
xpcom/threads/nsEventQueueService.cpp
View File

@ -17,7 +17,21 @@
* Copyright (C) 1998 Netscape Communications Corporation. All
* Rights Reserved.
*
* Contributor(s):
* Contributor(s): Rick Potts <rpotts@netscape.com>
* Ramiro Estrugo <ramiro@netscape.com>
* Warren Harris <warren@netscape.com>
* Leaf Nunes <leaf@mozilla.org>
* David Matiskella <davidm@netscape.com>
* David Hyatt <hyatt@netscape.com>
* Seth Spitzer <sspitzer@netscape.com>
* Suresh Duddi <dp@netscape.com>
* Bruce Mitchener <bruce@cybersight.com>
* Scott Collins <scc@netscape.com>
* Dan Matejka <danm@netscape.com>
* Doug Turner <dougt@netscape.com>
* Stuart Parmenter <pavlov@netscape.com>
* Mike Kaply <mkaply@us.ibm.com>
* Dan Mosedale <dmose@mozilla.org>
*/
#include "nsEventQueueService.h"
@ -380,3 +394,43 @@ nsEventQueueServiceImpl::ResolveEventQueue(nsIEventQueue* queueOrConstant, nsIEv
NS_ADDREF(*resultQueue);
return NS_OK;
}
NS_IMETHODIMP
nsEventQueueServiceImpl::GetSpecialEventQueue(PRInt32 aQueue,
nsIEventQueue* *_retval)
{
nsresult rv;
// barf if someone gave us a zero pointer
//
if (!_retval) {
return NS_ERROR_NULL_POINTER;
}
// try and get the requested event queue, returning NS_ERROR_FAILURE if there
// is a problem. GetThreadEventQueue() does the AddRef() for us.
//
switch (aQueue) {
case CURRENT_THREAD_EVENT_QUEUE:
rv = GetThreadEventQueue(NS_CURRENT_THREAD, _retval);
if (NS_FAILED(rv)) {
return NS_ERROR_FAILURE;
}
break;
case UI_THREAD_EVENT_QUEUE:
rv = GetThreadEventQueue(NS_UI_THREAD, _retval);
if (NS_FAILED(rv)) {
return NS_ERROR_FAILURE;
}
break;
// somebody handed us a bogus constant
//
default:
return NS_ERROR_ILLEGAL_VALUE;
}
return NS_OK;
}

14
xpcom/threads/nsEventQueueService.h
View File

@ -43,19 +43,7 @@ public:
NS_DECL_ISUPPORTS
// nsIEventQueueService interface...
NS_IMETHOD CreateThreadEventQueue();
NS_IMETHOD CreateMonitoredThreadEventQueue();
NS_IMETHOD DestroyThreadEventQueue(void);
NS_IMETHOD GetThreadEventQueue(PRThread* aThread, nsIEventQueue** aResult);
NS_IMETHOD ResolveEventQueue(nsIEventQueue* queueOrConstant, nsIEventQueue* *resultQueue);
NS_IMETHOD CreateFromIThread(nsIThread *aThread, PRBool aNative,
nsIEventQueue **aResult);
NS_IMETHOD CreateFromPLEventQueue(PLEventQueue* aPLEventQueue, nsIEventQueue** aResult);
NS_IMETHOD PushThreadEventQueue(nsIEventQueue **aNewQueue);
NS_IMETHOD PopThreadEventQueue(nsIEventQueue *aQueue);
NS_DECL_NSIEVENTQUEUESERVICE
private:
/* Create a queue for the given thread if one does not exist.

81
xpcom/threads/nsIEventQueue.h
View File

@ -1,81 +0,0 @@
/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
*
* The contents of this file are subject to the Netscape 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/NPL/
*
* 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 Mozilla Communicator client code.
*
* The Initial Developer of the Original Code is Netscape Communications
* Corporation. Portions created by Netscape are
* Copyright (C) 1998 Netscape Communications Corporation. All
* Rights Reserved.
*
* Contributor(s):
*/
#ifndef nsIEventQueue_h__
#define nsIEventQueue_h__
#include "nsISupports.h"
#include "prthread.h"
#include "plevent.h"
// {176AFB41-00A4-11d3-9F2A-00400553EEF0}
#define NS_IEVENTQUEUE_IID \
{ 0x176afb41, 0xa4, 0x11d3, { 0x9f, 0x2a, 0x0, 0x40, 0x5, 0x53, 0xee, 0xf0 } }
// {13D86C61-00A9-11d3-9F2A-00400553EEF0}
#define NS_EVENTQUEUE_CID \
{ 0x13d86c61, 0xa9, 0x11d3, { 0x9f, 0x2a, 0x0, 0x40, 0x5, 0x53, 0xee, 0xf0 } }
#define NS_EVENTQUEUE_CONTRACTID "@mozilla.org/event-queue;1"
#define NS_EVENTQUEUE_CLASSNAME "Event Queue"
class nsIEventQueue : public nsISupports
{
public:
NS_DEFINE_STATIC_IID_ACCESSOR(NS_IEVENTQUEUE_IID);
NS_IMETHOD InitEvent(PLEvent* aEvent, void* owner,
PLHandleEventProc handler, PLDestroyEventProc destructor) = 0;
NS_IMETHOD_(PRStatus) PostEvent(PLEvent* aEvent) = 0;
NS_IMETHOD PostSynchronousEvent(PLEvent* aEvent, void** aResult) = 0;
NS_IMETHOD ProcessPendingEvents() = 0;
NS_IMETHOD EventLoop() = 0;
NS_IMETHOD EventAvailable(PRBool& aResult) = 0;
NS_IMETHOD GetEvent(PLEvent** aResult) = 0;
NS_IMETHOD HandleEvent(PLEvent* aEvent) = 0;
NS_IMETHOD WaitForEvent(PLEvent** aResult) = 0;
NS_IMETHOD_(PRInt32) GetEventQueueSelectFD() = 0;
NS_IMETHOD Init(PRBool aNative) = 0;
NS_IMETHOD InitFromPRThread(PRThread* thread, PRBool aNative) = 0;
NS_IMETHOD InitFromPLQueue(PLEventQueue* aQueue) = 0;
NS_IMETHOD EnterMonitor() = 0;
NS_IMETHOD ExitMonitor() = 0;
NS_IMETHOD RevokeEvents(void* owner) = 0;
NS_IMETHOD GetPLEventQueue(PLEventQueue** aEventQueue) = 0;
NS_IMETHOD IsQueueOnCurrentThread(PRBool *aResult) = 0;
NS_IMETHOD IsQueueNative(PRBool *aResult) = 0;
// effectively kill the queue. warning: the queue is allowed to delete
// itself any time after this.
NS_IMETHOD StopAcceptingEvents() = 0;
};
#endif /* nsIEventQueue_h___ */

94
xpcom/threads/nsIEventQueue.idl Normal file
View File

@ -0,0 +1,94 @@
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
*
* The contents of this file are subject to the Netscape 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/NPL/
*
* 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 Mozilla Communicator client code.
*
* The Initial Developer of the Original Code is Netscape Communications
* Corporation. Portions created by Netscape are
* Copyright (C) 1998 Netscape Communications Corporation. All
* Rights Reserved.
*
* Contributor(s): David Hyatt <hyatt@netscape.com>
* Suresh Duddi <dp@netscape.com>
* Doug Turner <dougt@netscape.com>
* Judson Valeski <valeski@netscape.com>
* Dan Matejka <danm@netscape.com>
* Ray Whitmer <rayw@netscape.com>
* Dan Mosedale <dmose@mozilla.org>
*/
#include "nsISupports.idl"
%{C++
#include "prthread.h"
#include "plevent.h"
// {13D86C61-00A9-11d3-9F2A-00400553EEF0}
#define NS_EVENTQUEUE_CID \
{ 0x13d86c61, 0xa9, 0x11d3, { 0x9f, 0x2a, 0x0, 0x40, 0x5, 0x53, 0xee, 0xf0 } }
#define NS_EVENTQUEUE_CONTRACTID "@mozilla.org/event-queue;1"
#define NS_EVENTQUEUE_CLASSNAME "Event Queue"
%}
// some forward decls
//
[ptr] native PLEventQueuePtr(PLEventQueue);
[ptr] native PLEventPtr(PLEvent);
[ptr] native PRThreadPtr(PRThread);
native PRStatus(PRStatus);
[ref] native PRBoolRef(PRBool);
native PLHandleEventProc(PLHandleEventProc);
native PLDestroyEventProc(PLDestroyEventProc);
[scriptable, uuid(176AFB41-00A4-11d3-9F2A-00400553EEF0)]
interface nsIEventQueue : nsISupports
{
[noscript] void initEvent(in PLEventPtr aEvent,
in voidPtr owner,
in PLHandleEventProc handler,
in PLDestroyEventProc destructor);
[notxpcom] PRStatus postEvent(in PLEventPtr aEvent);
[noscript] void postSynchronousEvent(in PLEventPtr aEvent,
out voidPtr aResult);
void processPendingEvents();
void eventLoop();
[noscript] void eventAvailable(in PRBoolRef aResult);
[noscript] PLEventPtr getEvent();
[noscript] void handleEvent(in PLEventPtr aEvent);
[noscript] PLEventPtr waitForEvent();
[notxpcom] PRInt32 getEventQueueSelectFD();
void init(in boolean aNative);
[noscript] void initFromPRThread(in PRThreadPtr thread,
in boolean aNative);
[noscript] void initFromPLQueue(in PLEventQueuePtr aQueue);
void enterMonitor();
void exitMonitor();
[noscript] void revokeEvents(in voidPtr owner);
[noscript] PLEventQueuePtr getPLEventQueue();
boolean isQueueOnCurrentThread();
boolean isQueueNative();
// effectively kill the queue. warning: the queue is allowed to delete
// itself any time after this.
void stopAcceptingEvents();
};

99
xpcom/threads/nsIEventQueueService.h
View File

@ -1,99 +0,0 @@
/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
*
* The contents of this file are subject to the Netscape 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/NPL/
*
* 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 Mozilla Communicator client code.
*
* The Initial Developer of the Original Code is Netscape Communications
* Corporation. Portions created by Netscape are
* Copyright (C) 1998 Netscape Communications Corporation. All
* Rights Reserved.
*
* Contributor(s):
*/
#ifndef nsIEventQueueService_h__
#define nsIEventQueueService_h__
#include "nsISupports.h"
#include "prthread.h"
#include "plevent.h"
#include "nsIEventQueue.h"
/* a6cf90dc-15b3-11d2-932e-00805f8add32 */
#define NS_IEVENTQUEUESERVICE_IID \
{ 0xa6cf90dc, 0x15b3, 0x11d2, \
{0x93, 0x2e, 0x00, 0x80, 0x5f, 0x8a, 0xdd, 0x32} }
/* be761f00-a3b0-11d2-996c-0080c7cb1080 */
#define NS_EVENTQUEUESERVICE_CID \
{ 0xbe761f00, 0xa3b0, 0x11d2, \
{0x99, 0x6c, 0x00, 0x80, 0xc7, 0xcb, 0x10, 0x80} }
#define NS_EVENTQUEUESERVICE_CONTRACTID "@mozilla.org/event-queue-service;1"
#define NS_EVENTQUEUESERVICE_CLASSNAME "Event Queue Service"
#define NS_CURRENT_THREAD ((PRThread*)0)
#define NS_CURRENT_EVENTQ ((nsIEventQueue*)0)
#define NS_UI_THREAD ((PRThread*)1)
#define NS_UI_THREAD_EVENTQ ((nsIEventQueue*)1)
class nsIThread;
class nsIEventQueueService : public nsISupports
{
public:
static const nsIID& GetIID() { static nsIID iid = NS_IEVENTQUEUESERVICE_IID; return iid; }
/**
* Creates and holds a native event queue for the current thread.
* "Native" queues have an associated callback mechanism which is
* automatically triggered when an event is posted. See plevent.c for details.
* @return NS_OK on success, or a host of failure indications
*/
NS_IMETHOD CreateThreadEventQueue() = 0;
/**
* Creates and hold a monitored event queue for the current thread.
* "Monitored" queues have no callback processing mechanism.
* @return NS_OK on success, or a host of failure indications
*/
NS_IMETHOD CreateMonitoredThreadEventQueue() = 0;
/**
* Somewhat misnamed, this method releases the service's hold on the event
* queue(s) for this thread. Subsequent attempts to access this thread's
* queue (GetThreadEventQueue, for example) may fail, though the queue itself
* will be destroyed only after all references to it are released and the
* queue itself is no longer actively processing events.
* @return nonsense.
*/
NS_IMETHOD DestroyThreadEventQueue(void) = 0;
NS_IMETHOD CreateFromIThread(nsIThread *aThread, PRBool aNative,
nsIEventQueue **aResult) = 0;
NS_IMETHOD CreateFromPLEventQueue(PLEventQueue* aPLEventQueue, nsIEventQueue** aResult) = 0;
// Add a new event queue for the current thread, making it the "current"
// queue. Return that queue in aNewQueue, addrefed.
NS_IMETHOD PushThreadEventQueue(nsIEventQueue **aNewQueue) = 0;
// release and disable the queue
NS_IMETHOD PopThreadEventQueue(nsIEventQueue *aQueue) = 0;
NS_IMETHOD GetThreadEventQueue(PRThread* aThread, nsIEventQueue** aResult) = 0;
NS_IMETHOD ResolveEventQueue(nsIEventQueue* queueOrConstant, nsIEventQueue* *resultQueue) = 0;
};
#endif /* nsIEventQueueService_h___ */

135
xpcom/threads/nsIEventQueueService.idl Normal file
View File

@ -0,0 +1,135 @@
/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
*
* The contents of this file are subject to the Netscape 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/NPL/
*
* 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 Mozilla Communicator client code.
*
* The Initial Developer of the Original Code is Netscape Communications
* Corporation. Portions created by Netscape are
* Copyright (C) 1998 Netscape Communications Corporation. All
* Rights Reserved.
*
* Contributor(s): Rick Potts <rpotts@netscape.com>
* David Matiskella <davidm@netscape.com>
* David Hyatt <hyatt@netscape.com>
* Suresh Duddi <dp@netscape.com>
* Scott Collins <scc@netscape.com>
* Dan Matejka <danm@netscape.com>
* Doug Turner <dougt@netscape.com>
* Ray Whitmer <rayw@netscape.com>
* Dan Mosedale <dmose@mozilla.org>
*/
#include "nsISupports.idl"
#include "nsIEventQueue.idl"
%{C++
#include "prthread.h"
#include "plevent.h"
/* be761f00-a3b0-11d2-996c-0080c7cb1080 */
#define NS_EVENTQUEUESERVICE_CID \
{ 0xbe761f00, 0xa3b0, 0x11d2, \
{0x99, 0x6c, 0x00, 0x80, 0xc7, 0xcb, 0x10, 0x80} }
#define NS_EVENTQUEUESERVICE_CONTRACTID "@mozilla.org/event-queue-service;1"
#define NS_EVENTQUEUESERVICE_CLASSNAME "Event Queue Service"
#define NS_CURRENT_THREAD ((PRThread*)0)
#define NS_CURRENT_EVENTQ ((nsIEventQueue*)0)
#define NS_UI_THREAD ((PRThread*)1)
#define NS_UI_THREAD_EVENTQ ((nsIEventQueue*)1)
%}
/* a forward decl */
interface nsIThread;
[scriptable, uuid(a6cf90dc-15b3-11d2-932e-00805f8add32)]
interface nsIEventQueueService : nsISupports
{
/**
* Creates and holds a native event queue for the current thread.
* "Native" queues have an associated callback mechanism which is
* automatically triggered when an event is posted. See plevent.c for
* details.
* @return NS_OK on success, or a host of failure indications
*/
void createThreadEventQueue();
/**
* Creates and hold a monitored event queue for the current thread.
* "Monitored" queues have no callback processing mechanism.
* @return NS_OK on success, or a host of failure indications
*/
void createMonitoredThreadEventQueue();
/**
* Somewhat misnamed, this method releases the service's hold on the event
* queue(s) for this thread. Subsequent attempts to access this thread's
* queue (GetThreadEventQueue, for example) may fail, though the queue itself
* will be destroyed only after all references to it are released and the
* queue itself is no longer actively processing events.
* @return nonsense.
*/
void destroyThreadEventQueue();
nsIEventQueue createFromIThread(in nsIThread aThread,
in boolean aNative);
[noscript] nsIEventQueue createFromPLEventQueue(in PLEventQueuePtr
aPLEventQueue);
// Add a new event queue for the current thread, making it the "current"
// queue. Return that queue, addrefed.
nsIEventQueue pushThreadEventQueue();
// release and disable the queue
void popThreadEventQueue(in nsIEventQueue aQueue);
[noscript] nsIEventQueue getThreadEventQueue(in PRThreadPtr aThread);
/**
* @deprecated in favor of getSpecialEventQueue, since that's
* scriptable and this isn't.
*
* Check for any "magic" event queue constants (NS_CURRENT_EVENTQ,
* NS_UI_THREAD_EVENTQ) and return the real event queue that they
* represent, AddRef()ed. Otherwise, return the event queue passed
* in, AddRef()ed. This is not scriptable because the arguments in
* question may be magic constants rather than real nsIEventQueues.
*
* @arg queueOrConstant either a real event queue or a magic
* constant to be resolved
*
* @return a real event queue, AddRef()ed
*/
[noscript] nsIEventQueue resolveEventQueue(in nsIEventQueue queueOrConstant);
/**
* Returns the appropriate special event queue, AddRef()ed. Really
* just a scriptable version of ResolveEventQueue.
*
* @arg aQueue Either CURRENT_THREAD_EVENT_QUEUE or
* UI_THREAD_EVENT_QUEUE
* @return The requested nsIEventQueue, AddRef()ed
* @exception NS_ERROR_NULL_POINTER Zero pointer passed in for return value
* @exception NS_ERROR_ILLEGAL_VALUE Bogus constant passed in aQueue
* @exception NS_ERROR_FAILURE Error while calling
* GetThreadEventQueue()
*/
nsIEventQueue getSpecialEventQueue(in long aQueue);
const long CURRENT_THREAD_EVENT_QUEUE = 0;
const long UI_THREAD_EVENT_QUEUE = 1;
};