mirror of
https://gitea.wildfiregames.com/0ad/0ad
synced 2026-06-20 23:33:59 -07:00
ec8b420abc
- Rename ScriptEngine, ScriptContext, ScriptInterface, ScriptRequest to
Script::Engine, Script::Context, Script::Interface, Script::Request
- Remove 'Script' prefix from filenames:
ScriptContext.* → Context.*
ScriptInterface.* → Interface.*
ScriptRequest.* → Request.*
ScriptEngine.* → Engine.*
ScriptConversions.* → Conversions.*
ScriptExceptions.* → Exceptions.*
ScriptForward.* → ForwardDeclarations.*
ScriptStats.* → Stats.*
- Update all includes, forward declarations, and friend classes
- Use namespace Script { ... } in .cpp definitions to avoid repetitive
Script:: prefix (keeping global callbacks outside)
- Rename internal implementation structs:
ScriptInterface_impl → Interface_impl
ScriptFunction → Function
- Update copyright year to 2026 in all touched files
- Suppress pre-existing cppcheck warnings (uninitvar, nullPointer, unknown
macro) by adding them to suppressions-list.txt (these are not caused
by this refactor)
Fixes #7516
80 lines
2.7 KiB
C++
80 lines
2.7 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_DEBUGSERIALIZER
|
|
#define INCLUDED_DEBUGSERIALIZER
|
|
|
|
#include "ISerializer.h"
|
|
|
|
#include "simulation2/system/Component.h"
|
|
#include "lib/code_annotation.h"
|
|
#include "lib/types.h"
|
|
#include "maths/Fixed.h"
|
|
|
|
#include <js/TypeDecls.h>
|
|
#include <cstddef>
|
|
#include <cstdint>
|
|
#include <iosfwd>
|
|
#include <string>
|
|
|
|
namespace Script { class Interface; }
|
|
|
|
/**
|
|
* Serialize to a human-readable YAML-like format.
|
|
*/
|
|
class CDebugSerializer : public ISerializer
|
|
{
|
|
NONCOPYABLE(CDebugSerializer);
|
|
public:
|
|
/**
|
|
* @param scriptInterface Script interface corresponding to any JS::Value passed to ScriptVal()
|
|
* @param stream Stream to receive UTF-8 encoded output
|
|
* @param includeDebugInfo If true then additional non-deterministic data will be included in the output
|
|
*/
|
|
CDebugSerializer(const Script::Interface& scriptInterface, std::ostream& stream, bool includeDebugInfo = true);
|
|
|
|
void Comment(const std::string& comment);
|
|
void TextLine(const std::string& text);
|
|
void Indent(int spaces);
|
|
void Dedent(int spaces);
|
|
|
|
virtual bool IsDebug() const;
|
|
virtual std::ostream& GetStream();
|
|
|
|
protected:
|
|
virtual void PutNumber(const char* name, uint8_t value);
|
|
virtual void PutNumber(const char* name, int8_t value);
|
|
virtual void PutNumber(const char* name, uint16_t value);
|
|
virtual void PutNumber(const char* name, int16_t value);
|
|
virtual void PutNumber(const char* name, uint32_t value);
|
|
virtual void PutNumber(const char* name, int32_t value);
|
|
virtual void PutNumber(const char* name, float value);
|
|
virtual void PutNumber(const char* name, double value);
|
|
virtual void PutNumber(const char* name, fixed value);
|
|
virtual void PutBool(const char* name, bool value);
|
|
virtual void PutString(const char* name, const std::string& value);
|
|
virtual void PutScriptVal(const char* name, JS::MutableHandleValue value);
|
|
virtual void PutRaw(const char* name, const u8* data, size_t len);
|
|
|
|
private:
|
|
const Script::Interface& m_ScriptInterface;
|
|
std::ostream& m_Stream;
|
|
bool m_IsDebug;
|
|
int m_Indent;
|
|
};
|
|
|
|
#endif // INCLUDED_DEBUGSERIALIZER
|