Skip to content

Fix Lua array detection and order preservation when using toJSON #3369

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open

Fix Lua array detection and order preservation when using toJSON #3369

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
4890e40
Fix Lua array detection and order preservation when using toJSON
Pieter-Dewachter Apr 17, 2024
9060f2f
Improve code style and make sure an empty vector is correctly handled
Pieter-Dewachter Apr 18, 2024
81e4133
Add an extra comment to clarify the detection method of an array
Pieter-Dewachter May 2, 2024
c76af19
Merge branch 'master' into feature/json_arrays
Dutchman101 May 24, 2024
2408bf6
Merge branch 'master' into feature/json_arrays
Dutchman101 Jun 30, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
58 changes: 31 additions & 27 deletions Client/mods/deathmatch/logic/lua/CLuaArguments.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -533,49 +533,53 @@ json_object* CLuaArguments::WriteTableToJSONObject(bool bSerialize, CFastHashMap
bKnownTablesCreated = true;
}

pKnownTables->insert(std::make_pair(this, pKnownTables->size()));
pKnownTables->insert({this, pKnownTables->size()});

bool bIsArray = true;
unsigned int iArrayPos = 1; // lua arrays are 1 based
vector<CLuaArgument*>::const_iterator iter = m_Arguments.begin();
bool bIsArray = true;
std::vector<std::pair<std::uint32_t, CLuaArgument*>> vecSortedArguments; // lua arrays are not necessarily sorted
std::vector<CLuaArgument*>::const_iterator iter = m_Arguments.begin();
for (; iter != m_Arguments.end(); iter += 2)
{
CLuaArgument* pArgument = *iter;
if (pArgument->GetType() == LUA_TNUMBER)
{
double num = pArgument->GetNumber();
unsigned int iNum = static_cast<unsigned int>(num);
if (num == iNum)
{
if (iArrayPos != iNum) // check if the value matches its index in the table
{
bIsArray = false;
break;
}
}
else
{
bIsArray = false;
break;
}
double const num = pArgument->GetNumber();
auto const iNum = static_cast<std::uint32_t>(num);

vecSortedArguments.push_back({iNum, *(iter + 1)});
}
else
{
bIsArray = false;
break;
}
iArrayPos++;
}

if (bIsArray)
if (bIsArray && !vecSortedArguments.empty()) // the table could possibly be an array
{
json_object* my_array = json_object_new_array();
vector<CLuaArgument*>::const_iterator iter = m_Arguments.begin();
for (; iter != m_Arguments.end(); iter++)
// sort the table based on the keys (already handled correctly by std::pair)
std::sort(vecSortedArguments.begin(), vecSortedArguments.end());

// only the first and last element are checked, everything else is correct by default because the vector was sorted
// the last key should match the size of vecSortedArguments to ensure there are no gaps in this array-like table
auto const iFirstKey = vecSortedArguments.front().first;
auto const iLastKey = vecSortedArguments.back().first;

auto const iFirstArrayPos = 1U; // lua arrays are 1 based
auto const iLastArrayPos = static_cast<std::uint32_t>(vecSortedArguments.size());

if (iFirstKey != iFirstArrayPos || iLastKey != iLastArrayPos)
{
iter++; // skip the key values
CLuaArgument* pArgument = *iter;
json_object* object = pArgument->WriteToJSONObject(bSerialize, pKnownTables);
bIsArray = false;
}
}

if (bIsArray) // the table is definitely an array
{
json_object* my_array = json_object_new_array();
for (auto const& [iKey, pArgument] : vecSortedArguments)
{
json_object* object = pArgument->WriteToJSONObject(bSerialize, pKnownTables);
if (object)
{
json_object_array_add(my_array, object);
Expand Down
58 changes: 31 additions & 27 deletions Server/mods/deathmatch/logic/lua/CLuaArguments.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -609,49 +609,53 @@ json_object* CLuaArguments::WriteTableToJSONObject(bool bSerialize, CFastHashMap
bKnownTablesCreated = true;
}

pKnownTables->insert(std::make_pair(this, pKnownTables->size()));
pKnownTables->insert({this, pKnownTables->size()});

bool bIsArray = true;
unsigned int iArrayPos = 1; // lua arrays are 1 based
vector<CLuaArgument*>::const_iterator iter = m_Arguments.begin();
bool bIsArray = true;
std::vector<std::pair<std::uint32_t, CLuaArgument*>> vecSortedArguments; // lua arrays are not necessarily sorted
std::vector<CLuaArgument*>::const_iterator iter = m_Arguments.begin();
for (; iter != m_Arguments.end(); iter += 2)
{
CLuaArgument* pArgument = *iter;
if (pArgument->GetType() == LUA_TNUMBER)
{
double num = pArgument->GetNumber();
unsigned int iNum = static_cast<unsigned int>(num);
if (num == iNum)
{
if (iArrayPos != iNum) // check if the value matches its index in the table
{
bIsArray = false;
break;
}
}
else
{
bIsArray = false;
break;
}
double const num = pArgument->GetNumber();
auto const iNum = static_cast<std::uint32_t>(num);

vecSortedArguments.push_back({iNum, *(iter + 1)});
}
else
{
bIsArray = false;
break;
}
iArrayPos++;
}

if (bIsArray)
if (bIsArray && !vecSortedArguments.empty()) // the table could possibly be an array
{
json_object* my_array = json_object_new_array();
vector<CLuaArgument*>::const_iterator iter = m_Arguments.begin();
for (; iter != m_Arguments.end(); ++iter)
// sort the table based on the keys (already handled correctly by std::pair)
std::sort(vecSortedArguments.begin(), vecSortedArguments.end());

// only the first and last element are checked, everything else is correct by default because the vector was sorted
// the last key should match the size of vecSortedArguments to ensure there are no gaps in this array-like table
auto const iFirstKey = vecSortedArguments.front().first;
auto const iLastKey = vecSortedArguments.back().first;

auto const iFirstArrayPos = 1U; // lua arrays are 1 based
auto const iLastArrayPos = static_cast<std::uint32_t>(vecSortedArguments.size());

if (iFirstKey != iFirstArrayPos || iLastKey != iLastArrayPos)
{
iter++; // skip the key values
CLuaArgument* pArgument = *iter;
json_object* object = pArgument->WriteToJSONObject(bSerialize, pKnownTables);
bIsArray = false;
}
}

if (bIsArray) // the table is definitely an array
{
json_object* my_array = json_object_new_array();
for (auto const& [iKey, pArgument] : vecSortedArguments)
{
json_object* object = pArgument->WriteToJSONObject(bSerialize, pKnownTables);
if (object)
{
json_object_array_add(my_array, object);
Expand Down
Loading