dallasgroot/0ad
1
0
Fork 0
mirror of https://gitea.wildfiregames.com/0ad/0ad synced 2026-06-16 13:23:56 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions 3
0ad/source/ps/scripting/JSInterface_ConfigDB.h

43 lines
2.1 KiB
C
Raw Normal View History

Add missing ScriptInterface includes to JSInterface_L10n.cpp from d6db5a466d, JSInterface_Renderer.cpp and JSInterface_GUITypes.cpp from 4b1297b328, JSInterface_VisualReplay.cpp from b830233498, JSInterface_Game.cpp from 5f8be8e0c6, JSInterface_Simulation.cpp from 921c5515a6, JSInterface_Debug.cpp from d6cb9c845b, JSInterface_Main.cpp from 486aec18d4, refs #4772, JSInterface_Mod.cpp where it was incorrectly removed in af03c72f76. Refs D1470. Sort includes alphabetically, add recent Coding Convention macro comments. This was SVN commit r21789.
2018-04-27 09:48:44 -07:00
/* Copyright (C) 2018 Wildfire Games.
Changes the ConfigDB to expose global functions to scripts instead of properties and custom objects. Fixes #2172 Refs #1886 This was SVN commit r13914.
2013-09-29 11:56:50 -07:00
* 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_JSI_CONFIGDB
#define INCLUDED_JSI_CONFIGDB
#include "ps/ConfigDB.h"
Add missing ScriptInterface includes to JSInterface_L10n.cpp from d6db5a466d, JSInterface_Renderer.cpp and JSInterface_GUITypes.cpp from 4b1297b328, JSInterface_VisualReplay.cpp from b830233498, JSInterface_Game.cpp from 5f8be8e0c6, JSInterface_Simulation.cpp from 921c5515a6, JSInterface_Debug.cpp from d6cb9c845b, JSInterface_Main.cpp from 486aec18d4, refs #4772, JSInterface_Mod.cpp where it was incorrectly removed in af03c72f76. Refs D1470. Sort includes alphabetically, add recent Coding Convention macro comments. This was SVN commit r21789.
2018-04-27 09:48:44 -07:00
#include "scriptinterface/ScriptInterface.h"
Changes the ConfigDB to expose global functions to scripts instead of properties and custom objects. Fixes #2172 Refs #1886 This was SVN commit r13914.
2013-09-29 11:56:50 -07:00
Hide userreporter ID from mods and logfiles, since it shall be used as an authentication token for GDPR personal data requests, refs #5257, f51f78c999 / D1563. Comments by: Vladislav in irc on 2018-08-13 This was SVN commit r21867.
2018-08-22 09:02:05 -07:00
#include <string>
Changes the ConfigDB to expose global functions to scripts instead of properties and custom objects. Fixes #2172 Refs #1886 This was SVN commit r13914.
2013-09-29 11:56:50 -07:00
namespace JSI_ConfigDB
{
Hide userreporter ID from mods and logfiles, since it shall be used as an authentication token for GDPR personal data requests, refs #5257, f51f78c999 / D1563. Comments by: Vladislav in irc on 2018-08-13 This was SVN commit r21867.
2018-08-22 09:02:05 -07:00
bool IsProtectedConfigName(const std::string& name);
Use const T& for parameters of some types in script-exposed native functions Using references matches the C++ coding style better and should improve performance a bit in theory. It avoids 2 copies of T in case of the functions registered with RegisterFunction (mainy used in the GUI). It should also avoid one or two copies in case of DEFINE_INTERFACE_METHOD_X, which is used in the simulation, but I haven't bothered to count it there exactly. It is now predefined which types have to be passed by const reference and which are passed by value. Note that references can't be used as out-parameters (to return multiple values to JS). This hasn't worked before either and probably never will. This was SVN commit r17696.
2016-01-23 07:17:56 -08:00
bool GetConfigNamespace(const std::wstring& cfgNsString, EConfigNamespace& cfgNs);
allows the user to restore the default game options, refs #3737 This was SVN commit r17739.
2016-02-07 07:10:44 -08:00
bool HasChanges(ScriptInterface::CxPrivate* pCxPrivate, const std::wstring& cfgNsString);
bool SetChanges(ScriptInterface::CxPrivate* pCxPrivate, const std::wstring& cfgNsString, bool value);
Use const T& for parameters of some types in script-exposed native functions Using references matches the C++ coding style better and should improve performance a bit in theory. It avoids 2 copies of T in case of the functions registered with RegisterFunction (mainy used in the GUI). It should also avoid one or two copies in case of DEFINE_INTERFACE_METHOD_X, which is used in the simulation, but I haven't bothered to count it there exactly. It is now predefined which types have to be passed by const reference and which are passed by value. Note that references can't be used as out-parameters (to return multiple values to JS). This hasn't worked before either and probably never will. This was SVN commit r17696.
2016-01-23 07:17:56 -08:00
std::string GetValue(ScriptInterface::CxPrivate* pCxPrivate, const std::wstring& cfgNsString, const std::string& name);
bool CreateValue(ScriptInterface::CxPrivate* pCxPrivate, const std::wstring& cfgNsString, const std::string& name, const std::string& value);
allows the user to restore the default game options, refs #3737 This was SVN commit r17739.
2016-02-07 07:10:44 -08:00
bool RemoveValue(ScriptInterface::CxPrivate* pCxPrivate, const std::wstring& cfgNsString, const std::string& name);
Use const T& for parameters of some types in script-exposed native functions Using references matches the C++ coding style better and should improve performance a bit in theory. It avoids 2 copies of T in case of the functions registered with RegisterFunction (mainy used in the GUI). It should also avoid one or two copies in case of DEFINE_INTERFACE_METHOD_X, which is used in the simulation, but I haven't bothered to count it there exactly. It is now predefined which types have to be passed by const reference and which are passed by value. Note that references can't be used as out-parameters (to return multiple values to JS). This hasn't worked before either and probably never will. This was SVN commit r17696.
2016-01-23 07:17:56 -08:00
bool WriteFile(ScriptInterface::CxPrivate* pCxPrivate, const std::wstring& cfgNsString, const Path& path);
when saving an option to file, write only that value and not all the content of the user configDB, refs #3737 This was SVN commit r17738.
2016-02-07 03:31:23 -08:00
bool WriteValueToFile(ScriptInterface::CxPrivate* pCxPrivate, const std::wstring& cfgNsString, const std::string& name, const std::string& value, const Path& path);
Use const T& for parameters of some types in script-exposed native functions Using references matches the C++ coding style better and should improve performance a bit in theory. It avoids 2 copies of T in case of the functions registered with RegisterFunction (mainy used in the GUI). It should also avoid one or two copies in case of DEFINE_INTERFACE_METHOD_X, which is used in the simulation, but I haven't bothered to count it there exactly. It is now predefined which types have to be passed by const reference and which are passed by value. Note that references can't be used as out-parameters (to return multiple values to JS). This hasn't worked before either and probably never will. This was SVN commit r17696.
2016-01-23 07:17:56 -08:00
bool Reload(ScriptInterface::CxPrivate* pCxPrivate, const std::wstring& cfgNsString);
bool SetFile(ScriptInterface::CxPrivate* pCxPrivate, const std::wstring& cfgNsString, const Path& path);
Pass ScriptInterface as a const ref where possible. Reviewed By: elexis Differential Revision: https://code.wildfiregames.com/D739 This was SVN commit r20028.
2017-08-23 17:32:42 -07:00
void RegisterScriptFunctions(const ScriptInterface& scriptInterface);
Changes the ConfigDB to expose global functions to scripts instead of properties and custom objects. Fixes #2172 Refs #1886 This was SVN commit r13914.
2013-09-29 11:56:50 -07:00
}
Add missing ScriptInterface includes to JSInterface_L10n.cpp from d6db5a466d, JSInterface_Renderer.cpp and JSInterface_GUITypes.cpp from 4b1297b328, JSInterface_VisualReplay.cpp from b830233498, JSInterface_Game.cpp from 5f8be8e0c6, JSInterface_Simulation.cpp from 921c5515a6, JSInterface_Debug.cpp from d6cb9c845b, JSInterface_Main.cpp from 486aec18d4, refs #4772, JSInterface_Mod.cpp where it was incorrectly removed in af03c72f76. Refs D1470. Sort includes alphabetically, add recent Coding Convention macro comments. This was SVN commit r21789.
2018-04-27 09:48:44 -07:00
#endif // INCLUDED_JSI_CONFIGDB
Reference in a new issue Copy permalink