mirror of
https://gitea.wildfiregames.com/0ad/0ad
synced 2026-06-16 05:13:58 -07:00
fcb1a4c121
- Move ScriptException to Script::Exception namespace. - Rename ScriptConversions, ScriptExceptions, ScriptForward and ScriptStats files to drop the redundant 'Script' prefix. - Rename ScriptForward.h to ForwardDeclarations.h as suggested. - Update all includes and references accordingly.
52 lines
1.8 KiB
C++
52 lines
1.8 KiB
C++
/* Copyright (C) 2026 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_SCRIPT_EXCEPTIONS
|
|
#define INCLUDED_SCRIPT_EXCEPTIONS
|
|
|
|
namespace Script { class Request; }
|
|
|
|
namespace Script
|
|
{
|
|
namespace Exception
|
|
{
|
|
/**
|
|
* @return Whether there is a JS exception pending.
|
|
*/
|
|
bool IsPending(const Script::Request& 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 Script::Request& 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 Script::Request& rq, const char* format, ...);
|
|
}
|
|
|
|
}
|
|
#endif // INCLUDED_SCRIPT_EXCEPTIONS
|