gecko/dom/src/threads/nsDOMWorkerEvents.h

348 lines
12 KiB
C++

/* -*- Mode: c++; c-basic-offset: 4; indent-tabs-mode: nil; tab-width: 40 -*- */
/* ***** BEGIN LICENSE BLOCK *****
* Version: MPL 1.1/GPL 2.0/LGPL 2.1
*
* 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 Web Workers.
*
* The Initial Developer of the Original Code is
* Mozilla Corporation.
* Portions created by the Initial Developer are Copyright (C) 2008
* the Initial Developer. All Rights Reserved.
*
* Contributor(s):
* Ben Turner <bent.mozilla@gmail.com> (Original Author)
*
* Alternatively, the contents of this file may be used under the terms of
* either the GNU General Public License Version 2 or later (the "GPL"), or
* the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
* in which case the provisions of the GPL or the LGPL are applicable instead
* of those above. If you wish to allow use of your version of this file only
* under the terms of either the GPL or the LGPL, and not to allow others to
* use your version of this file under the terms of the MPL, indicate your
* decision by deleting the provisions above and replace them with the notice
* and other provisions required by the GPL or the LGPL. If you do not delete
* the provisions above, a recipient may use your version of this file under
* the terms of any one of the MPL, the GPL or the LGPL.
*
* ***** END LICENSE BLOCK ***** */
#ifndef __NSDOMWORKEREVENTS_H__
#define __NSDOMWORKEREVENTS_H__
#include "nsIClassInfo.h"
#include "nsIDOMEvent.h"
#include "nsIDOMEventTarget.h"
#include "nsIDOMProgressEvent.h"
#include "nsIDOMWorkers.h"
#include "nsIRunnable.h"
#include "jsapi.h"
#include "nsAutoJSValHolder.h"
#include "nsAutoPtr.h"
#include "nsCOMPtr.h"
#include "nsStringGlue.h"
#include "nsDOMWorkerMacros.h"
class nsDOMWorkerXHRProxy;
class nsIXMLHttpRequest;
class nsIXPConnectWrappedNative;
/* 4d5794d6-98ab-4a6b-ad5a-8ed1fa1d4839 */
#define NS_IDOMWORKERPRIVATEEVENT_IID \
{ \
0x4d5794d6, \
0x98ab, \
0x4a6b, \
{ 0xad, 0x5a, 0x8e, 0xd1, 0xfa, 0x1d, 0x48, 0x39 } \
}
class nsIDOMWorkerPrivateEvent : public nsIDOMEvent
{
public:
NS_DECLARE_STATIC_IID_ACCESSOR(NS_IDOMWORKERPRIVATEEVENT_IID)
virtual PRBool PreventDefaultCalled() = 0;
};
#define NS_FORWARD_NSIDOMEVENT_SPECIAL \
NS_IMETHOD GetType(nsAString& aType) \
{ return mEvent->GetType(aType); } \
NS_IMETHOD GetTarget(nsIDOMEventTarget** aTarget) \
{ return mEvent->GetTarget(aTarget); } \
NS_IMETHOD GetCurrentTarget(nsIDOMEventTarget** aCurrentTarget) \
{ return mEvent->GetCurrentTarget(aCurrentTarget); } \
NS_IMETHOD GetEventPhase(PRUint16* aEventPhase) \
{ return mEvent->GetEventPhase(aEventPhase); } \
NS_IMETHOD GetBubbles(PRBool* aBubbles) \
{ return mEvent->GetBubbles(aBubbles); } \
NS_IMETHOD GetCancelable(PRBool* aCancelable) \
{ return mEvent->GetCancelable(aCancelable); } \
NS_IMETHOD GetTimeStamp(DOMTimeStamp* aTimeStamp) \
{ return mEvent->GetTimeStamp(aTimeStamp); } \
NS_IMETHOD StopPropagation() \
{ return mEvent->StopPropagation(); }
#define NS_FORWARD_NSIDOMPROGRESSEVENT_SPECIAL \
NS_IMETHOD GetLengthComputable(PRBool* aLengthComputable) \
{ return mProgressEvent->GetLengthComputable(aLengthComputable); } \
NS_IMETHOD GetLoaded(PRUint64* aLoaded) \
{ return mProgressEvent->GetLoaded(aLoaded); } \
NS_IMETHOD GetTotal(PRUint64* aTotal) \
{ return mProgressEvent->GetTotal(aTotal); }
#define NS_FORWARD_NSIWORKERMESSAGEEVENT_SPECIAL \
NS_IMETHOD GetData(nsAString& aData) \
{ return mMessageEvent->GetData(aData); } \
NS_IMETHOD GetOrigin(nsAString& aOrigin) \
{ return mMessageEvent->GetOrigin(aOrigin); } \
NS_IMETHOD GetSource(nsISupports** aSource) \
{ return mMessageEvent->GetSource(aSource); }
#define NS_FORWARD_NSIWORKERERROREVENT_SPECIAL \
NS_IMETHOD GetMessage(nsAString& aMessage) \
{ return mErrorEvent->GetMessage(aMessage); } \
NS_IMETHOD GetFilename(nsAString& aFilename) \
{ return mErrorEvent->GetFilename(aFilename); } \
NS_IMETHOD GetLineno(PRUint32* aLineno) \
{ return mErrorEvent->GetLineno(aLineno); }
class nsDOMWorkerPrivateEvent : public nsIDOMWorkerPrivateEvent,
public nsIDOMProgressEvent,
public nsIWorkerMessageEvent,
public nsIWorkerErrorEvent,
public nsIClassInfo
{
public:
NS_DECL_ISUPPORTS
NS_FORWARD_NSIDOMEVENT_SPECIAL
NS_FORWARD_NSIWORKERMESSAGEEVENT_SPECIAL
NS_FORWARD_NSIDOMPROGRESSEVENT_SPECIAL
NS_FORWARD_NSIWORKERERROREVENT_SPECIAL
NS_DECL_NSICLASSINFO
nsDOMWorkerPrivateEvent(nsIDOMEvent* aEvent);
NS_IMETHOD PreventDefault();
NS_IMETHOD InitEvent(const nsAString& aEventType,
PRBool aCanBubble,
PRBool aCancelable);
NS_IMETHOD InitProgressEvent(const nsAString& aTypeArg,
PRBool aCanBubbleArg,
PRBool aCancelableArg,
PRBool aLengthComputableArg,
PRUint64 aLoadedArg,
PRUint64 aTotalArg);
NS_IMETHOD InitMessageEvent(const nsAString& aTypeArg,
PRBool aCanBubbleArg,
PRBool aCancelableArg,
const nsAString& aDataArg,
const nsAString& aOriginArg,
nsISupports* aSourceArg);
NS_IMETHOD InitErrorEvent(const nsAString& aTypeArg,
PRBool aCanBubbleArg,
PRBool aCancelableArg,
const nsAString& aMessageArg,
const nsAString& aFilenameArg,
PRUint32 aLinenoArg);
virtual PRBool PreventDefaultCalled();
private:
nsCOMPtr<nsIDOMEvent> mEvent;
nsCOMPtr<nsIDOMProgressEvent> mProgressEvent;
nsCOMPtr<nsIWorkerMessageEvent> mMessageEvent;
nsCOMPtr<nsIWorkerErrorEvent> mErrorEvent;
PRBool mPreventDefaultCalled;
};
class nsDOMWorkerEvent : public nsIDOMEvent,
public nsIClassInfo
{
public:
NS_DECL_ISUPPORTS
NS_DECL_NSIDOMEVENT
NS_DECL_NSICLASSINFO
nsDOMWorkerEvent()
: mEventPhase(nsIDOMEvent::AT_TARGET), mTimeStamp(0), mBubbles(PR_FALSE),
mCancelable(PR_FALSE), mPreventDefaultCalled(PR_FALSE) { }
void SetTarget(nsIDOMEventTarget* aTarget) {
mTarget = aTarget;
}
PRBool PreventDefaultCalled() {
return PRBool(mPreventDefaultCalled);
}
protected:
virtual ~nsDOMWorkerEvent() { }
nsString mType;
nsCOMPtr<nsIDOMEventTarget> mTarget;
PRUint16 mEventPhase;
DOMTimeStamp mTimeStamp;
PRPackedBool mBubbles;
PRPackedBool mCancelable;
PRPackedBool mPreventDefaultCalled;
};
class nsDOMWorkerMessageEvent : public nsDOMWorkerEvent,
public nsIWorkerMessageEvent
{
public:
NS_DECL_ISUPPORTS_INHERITED
NS_FORWARD_NSIDOMEVENT(nsDOMWorkerEvent::)
NS_DECL_NSIWORKERMESSAGEEVENT
NS_DECL_NSICLASSINFO_GETINTERFACES
nsDOMWorkerMessageEvent()
: mIsJSON(PR_FALSE), mIsPrimitive(PR_FALSE), mHaveCachedJSVal(PR_FALSE),
mHaveAttemptedConversion(PR_FALSE) { }
void SetJSONData(PRBool aIsJSON, PRBool aIsPrimitive) {
mIsJSON = aIsJSON ? PR_TRUE : PR_FALSE;
mIsPrimitive = aIsPrimitive ? PR_TRUE : PR_FALSE;
}
protected:
nsString mOrigin;
nsCOMPtr<nsISupports> mSource;
nsString mData;
nsAutoJSValHolder mCachedJSVal;
PRPackedBool mIsJSON;
PRPackedBool mIsPrimitive;
PRPackedBool mHaveCachedJSVal;
PRPackedBool mHaveAttemptedConversion;
};
class nsDOMWorkerProgressEvent : public nsDOMWorkerEvent,
public nsIDOMProgressEvent
{
public:
NS_DECL_ISUPPORTS_INHERITED
NS_FORWARD_NSIDOMEVENT(nsDOMWorkerEvent::)
NS_DECL_NSIDOMPROGRESSEVENT
NS_DECL_NSICLASSINFO_GETINTERFACES
nsDOMWorkerProgressEvent()
: mLoaded(0), mTotal(0), mLengthComputable(PR_FALSE) { }
protected:
PRUint64 mLoaded;
PRUint64 mTotal;
PRBool mLengthComputable;
};
class nsDOMWorkerXHRState
{
public:
nsDOMWorkerXHRState()
: responseTextResult(NS_OK), statusTextResult(NS_OK), status(NS_OK),
statusResult(NS_OK), readyState(0), readyStateResult(NS_OK) { }
NS_IMETHOD_(nsrefcnt) AddRef();
NS_IMETHOD_(nsrefcnt) Release();
nsString responseText;
nsresult responseTextResult;
nsCString statusText;
nsresult statusTextResult;
nsresult status;
nsresult statusResult;
PRInt32 readyState;
nsresult readyStateResult;
protected:
virtual ~nsDOMWorkerXHRState() { }
nsAutoRefCnt mRefCnt;
};
enum SnapshotChoice {
WANT_SNAPSHOT,
NO_SNAPSHOT
};
class nsDOMWorkerXHREvent : public nsDOMWorkerProgressEvent,
public nsIRunnable
{
friend class nsDOMWorkerXHRProxy;
public:
NS_DECL_ISUPPORTS_INHERITED
NS_DECL_NSIRUNNABLE
NS_DECL_NSICLASSINFO_GETINTERFACES
enum SnapshotChoice {
SNAPSHOT,
NO_SNAPSHOT
};
nsDOMWorkerXHREvent(nsDOMWorkerXHRProxy* aXHRProxy);
nsresult Init(PRUint32 aXHREventType,
const nsAString& aType,
nsIDOMEvent* aEvent,
SnapshotChoice = SNAPSHOT);
static void SnapshotXHRState(nsIXMLHttpRequest* aXHR,
nsDOMWorkerXHRState* aState);
already_AddRefed<nsDOMWorkerXHRState> ForgetState() {
return mState.forget();
}
protected:
nsDOMWorkerXHRState* GetState() {
return mState;
}
nsRefPtr<nsDOMWorkerXHRProxy> mXHRProxy;
nsCOMPtr<nsIXPConnectWrappedNative> mXHRWN;
nsRefPtr<nsDOMWorkerXHRState> mState;
PRUint32 mXHREventType;
PRInt32 mChannelID;
PRPackedBool mUploadEvent;
PRPackedBool mProgressEvent;
};
class nsDOMWorkerErrorEvent : public nsDOMWorkerEvent,
public nsIWorkerErrorEvent
{
public:
NS_DECL_ISUPPORTS_INHERITED
NS_FORWARD_NSIDOMEVENT(nsDOMWorkerEvent::)
NS_DECL_NSIWORKERERROREVENT
NS_DECL_NSICLASSINFO_GETINTERFACES
nsDOMWorkerErrorEvent()
: mLineno(0) { }
protected:
nsString mMessage;
nsString mFilename;
PRUint32 mLineno;
};
#endif /* __NSDOMWORKEREVENTS_H__ */