mirror of
https://gitlab.winehq.org/wine/wine-gecko.git
synced 2024-09-13 09:24:08 -07:00
134 lines
3.8 KiB
C++
134 lines
3.8 KiB
C++
/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-*/
|
|
/* vim: set ts=2 sw=2 et tw=79: */
|
|
/* This Source Code Form is subject to the terms of the Mozilla Public
|
|
* License, v. 2.0. If a copy of the MPL was not distributed with this file,
|
|
* You can obtain one at http://mozilla.org/MPL/2.0/. */
|
|
|
|
/**
|
|
* A struct for tracking exceptions that need to be thrown to JS.
|
|
*/
|
|
|
|
#ifndef mozilla_ErrorResult_h
|
|
#define mozilla_ErrorResult_h
|
|
|
|
#include <stdarg.h>
|
|
|
|
#include "js/Value.h"
|
|
#include "nscore.h"
|
|
#include "mozilla/Assertions.h"
|
|
|
|
namespace mozilla {
|
|
|
|
namespace dom {
|
|
|
|
enum ErrNum {
|
|
#define MSG_DEF(_name, _argc, _str) \
|
|
_name,
|
|
#include "mozilla/dom/Errors.msg"
|
|
#undef MSG_DEF
|
|
Err_Limit
|
|
};
|
|
|
|
} // namespace dom
|
|
|
|
class ErrorResult {
|
|
public:
|
|
ErrorResult() {
|
|
mResult = NS_OK;
|
|
#ifdef DEBUG
|
|
mMightHaveUnreportedJSException = false;
|
|
#endif
|
|
}
|
|
|
|
#ifdef DEBUG
|
|
~ErrorResult() {
|
|
MOZ_ASSERT_IF(IsTypeError(), !mMessage);
|
|
MOZ_ASSERT(!mMightHaveUnreportedJSException);
|
|
}
|
|
#endif
|
|
|
|
void Throw(nsresult rv) {
|
|
MOZ_ASSERT(NS_FAILED(rv), "Please don't try throwing success");
|
|
MOZ_ASSERT(rv != NS_ERROR_TYPE_ERR, "Use ThrowTypeError()");
|
|
MOZ_ASSERT(!IsTypeError(), "Don't overwite TypeError");
|
|
MOZ_ASSERT(rv != NS_ERROR_DOM_JS_EXCEPTION, "Use ThrowJSException()");
|
|
MOZ_ASSERT(!IsJSException(), "Don't overwrite JS exceptions");
|
|
mResult = rv;
|
|
}
|
|
|
|
void ThrowTypeError(const dom::ErrNum errorNumber, ...);
|
|
void ReportTypeError(JSContext* cx);
|
|
void ClearMessage();
|
|
bool IsTypeError() const { return ErrorCode() == NS_ERROR_TYPE_ERR; }
|
|
|
|
// Facilities for throwing a preexisting JS exception value via this
|
|
// ErrorResult. The contract is that any code which might end up calling
|
|
// ThrowJSException() must call MightThrowJSException() even if no exception
|
|
// is being thrown. Code that would call ReportJSException as needed must
|
|
// first call WouldReportJSException even if this ErrorResult has not failed.
|
|
void ThrowJSException(JSContext* cx, JS::Handle<JS::Value> exn);
|
|
void ReportJSException(JSContext* cx);
|
|
bool IsJSException() const { return ErrorCode() == NS_ERROR_DOM_JS_EXCEPTION; }
|
|
void MOZ_ALWAYS_INLINE MightThrowJSException()
|
|
{
|
|
#ifdef DEBUG
|
|
mMightHaveUnreportedJSException = true;
|
|
#endif
|
|
}
|
|
void MOZ_ALWAYS_INLINE WouldReportJSException()
|
|
{
|
|
#ifdef DEBUG
|
|
mMightHaveUnreportedJSException = false;
|
|
#endif
|
|
}
|
|
|
|
// In the future, we can add overloads of Throw that take more
|
|
// interesting things, like strings or DOM exception types or
|
|
// something if desired.
|
|
|
|
// Backwards-compat to make conversion simpler. We don't call
|
|
// Throw() here because people can easily pass success codes to
|
|
// this.
|
|
void operator=(nsresult rv) {
|
|
MOZ_ASSERT(rv != NS_ERROR_TYPE_ERR, "Use ThrowTypeError()");
|
|
MOZ_ASSERT(!IsTypeError(), "Don't overwite TypeError");
|
|
MOZ_ASSERT(rv != NS_ERROR_DOM_JS_EXCEPTION, "Use ThrowJSException()");
|
|
MOZ_ASSERT(!IsJSException(), "Don't overwrite JS exceptions");
|
|
mResult = rv;
|
|
}
|
|
|
|
bool Failed() const {
|
|
return NS_FAILED(mResult);
|
|
}
|
|
|
|
nsresult ErrorCode() const {
|
|
return mResult;
|
|
}
|
|
|
|
private:
|
|
nsresult mResult;
|
|
struct Message;
|
|
// mMessage is set by ThrowTypeError and cleared (and deallocatd) by
|
|
// ReportTypeError.
|
|
// mJSException is set (and rooted) by ThrowJSException and unrooted
|
|
// by ReportJSException.
|
|
union {
|
|
Message* mMessage; // valid when IsTypeError()
|
|
JS::Value mJSException; // valid when IsJSException()
|
|
};
|
|
|
|
#ifdef DEBUG
|
|
// Used to keep track of codepaths that might throw JS exceptions,
|
|
// for assertion purposes.
|
|
bool mMightHaveUnreportedJSException;
|
|
#endif
|
|
|
|
// Not to be implemented, to make sure people always pass this by
|
|
// reference, not by value.
|
|
ErrorResult(const ErrorResult&) MOZ_DELETE;
|
|
};
|
|
|
|
} // namespace mozilla
|
|
|
|
#endif /* mozilla_ErrorResult_h */
|