0ad/source/ps/scripting/JSInterface_Main.cpp
trompetin17 e845da025a
Add deprecation warning to GetTextSize API
Adds a runtime warning to `Engine.GetTextSize` indicating that the API
is deprecated and will be removed in a future version.

This API does not simulate GUI rendering accurately, as it treats markup
tags like [color], [font], or [icon] as visible characters. This leads
to incorrect size measurements in modern GUI layouts.

New recommended alternatives:
- Use `Engine.GetGUITextSize(...)` for accurate measurement of raw text
  blocks, fully simulating GUI rendering.
- Use `guiObject.getTextSize()` when working within a specific GUI
  object, as it accounts for maxWidth, padding (bufferZone), and object
  constraints.

A warning is now emitted at runtime to guide developers toward these
updated APIs.
2025-06-26 17:11:24 -05:00

129 lines
3.5 KiB
C++

/* Copyright (C) 2025 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/>.
*/
#include "precompiled.h"
#include "JSInterface_Main.h"
#include "graphics/FontMetrics.h"
#include "graphics/MapReader.h"
#include "lib/sysdep/sysdep.h"
#include "lib/utf8.h"
#include "maths/Size2D.h"
#include "maths/MD5.h"
#include "ps/CLogger.h"
#include "ps/CStrIntern.h"
#include "ps/GUID.h"
#include "ps/GameSetup/Atlas.h"
#include "ps/Globals.h"
#include "ps/Hotkey.h"
#include "ps/Util.h"
#include "scriptinterface/FunctionWrapper.h"
#include "tools/atlas/GameInterface/GameLoop.h"
namespace JSI_Main
{
bool AtlasIsAvailable()
{
return ATLAS_IsAvailable();
}
bool IsAtlasRunning()
{
return g_AtlasGameLoop && g_AtlasGameLoop->running;
}
void OpenURL(const std::string& url)
{
sys_open_url(url);
}
std::wstring GetSystemUsername()
{
return sys_get_user_name();
}
std::wstring GetMatchID()
{
return ps_generate_guid().FromUTF8();
}
JS::Value LoadMapSettings(const ScriptInterface& scriptInterface, const VfsPath& pathname)
{
ScriptRequest rq(scriptInterface);
CMapSummaryReader reader;
if (reader.LoadMap(pathname) != PSRETURN_OK)
return JS::UndefinedValue();
JS::RootedValue settings(rq.cx);
reader.GetMapSettings(scriptInterface, &settings);
return settings;
}
// This value is recalculated once a frame. We take special care to
// filter it, so it is both accurate and free of jitter.
int GetFps()
{
if (!g_frequencyFilter)
return 0;
return g_frequencyFilter->StableFrequency();
}
CSize2D GetTextSize(const std::string& fontName, const std::wstring& text)
{
LOGWARNING("Engine.GetTextSize is deprecated and will be removed in a future version.Use guiObject.GetPreferedTextSize for accurate text sizing or guiObject.getTextSize for sizing within GUI objects.");
float width = 0;
float height = 0;
CStrIntern _fontName(fontName);
CFontMetrics fontMetrics(_fontName);
fontMetrics.CalculateStringSize(text.c_str(), width, height);
return CSize2D(width, height);
}
int GetTextWidth(const std::string& fontName, const std::wstring& text)
{
return GetTextSize(fontName, text).Width;
}
std::string CalculateMD5(const std::string& input)
{
u8 digest[MD5::DIGESTSIZE];
MD5 m;
m.Update((const u8*)input.c_str(), input.length());
m.Final(digest);
return Hexify(digest, MD5::DIGESTSIZE);
}
void RegisterScriptFunctions(const ScriptRequest& rq)
{
ScriptFunction::Register<&AtlasIsAvailable>(rq, "AtlasIsAvailable");
ScriptFunction::Register<&IsAtlasRunning>(rq, "IsAtlasRunning");
ScriptFunction::Register<&OpenURL>(rq, "OpenURL");
ScriptFunction::Register<&GetSystemUsername>(rq, "GetSystemUsername");
ScriptFunction::Register<&GetMatchID>(rq, "GetMatchID");
ScriptFunction::Register<&LoadMapSettings>(rq, "LoadMapSettings");
ScriptFunction::Register<&GetFps>(rq, "GetFPS");
ScriptFunction::Register<&GetTextSize>(rq, "GetTextSize");
ScriptFunction::Register<&GetTextWidth>(rq, "GetTextWidth");
ScriptFunction::Register<&CalculateMD5>(rq, "CalculateMD5");
}
}