0ad/source/scriptinterface/ScriptExceptions.h
wraitii fd8f5abd2e [SM52 2/2] Update to Spidermonkey 52 APIs.
No particularly noteworthy changes, as most complex API changes were
already supported in SM45 and done.
The addition of JSStructuredCloneData allows to remove our custom class.

Changes:
- InformalValueTypeName is back in the API, so remove our
implementation.
- Stop using JSRuntime entirely in favour of JSContext*
- JSPropertyDescriptor is renamed.
- CompartmentOptions are tweaked slightly (no functional changes)
- JS::Construct - API update.
- JSClass split - API update.
- A js.msg error message was removed, so we had to use a different one.
- Tests fix: fix comparison of union instances
- Disable warning in spidermonkey Vector.h
- Update error reporting to SM52 (minor API updates)
- Ignore warnings about unused return values (would come from OOM, which
isn't recoverable)

Most of the patching was done by Itms.

Tested by: Stan, Freagarach
Fixes #4893

Differential Revision: https://code.wildfiregames.com/D3095
This was SVN commit r24203.
2020-11-18 14:39:04 +00:00

52 lines
1.8 KiB
C++

/* Copyright (C) 2020 Wildfire Games.
* This file is part of 0 A.D.
*
* 0 A.D. is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 2 of the License, or
* (at your option) any later version.
*
* 0 A.D. is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with 0 A.D. If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef INCLUDED_SCRIPTEXCEPTIONS
#define INCLUDED_SCRIPTEXCEPTIONS
struct JSContext;
class JSErrorReport;
class ScriptRequest;
namespace ScriptException
{
/**
* @return Whether there is a JS exception pending.
*/
bool IsPending(const ScriptRequest& rq);
/**
* Log and then clear the current pending exception. This function should always be called after calling a
* JS script (or anything that can throw JS errors, such as structured clones),
* in case that script doesn't catch an exception thrown during its execution.
* If no exception is pending, this does nothing.
* Note that JS code that wants to throw errors should throw new Error(...), otherwise the stack cannot be used.
* @return Whether there was a pending exception.
*/
bool CatchPending(const ScriptRequest& rq);
/**
* Raise a JS exception from C++ code.
* This is only really relevant in JSNative functions that don't use ObjectOpResult,
* as the latter overwrites the pending exception.
* Prefer either simply logging an error if you know a stack-trace will be raised elsewhere.
*/
void Raise(const ScriptRequest& rq, const char* format, ...);
}
#endif // INCLUDED_SCRIPTEXCEPTIONS