mirrors
/
OpenRCT2
mirror of https://github.com/OpenRCT2/OpenRCT2.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

Tiny GetEntity Refactor (#12124) 

* Use default template parameter instead of specialising

* Fix null deref issues
This commit is contained in:
Duncan 2020-07-06 22:02:25 +01:00 committed by GitHub
parent 1a373e115a
commit 94b3598102
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
7 changed files with 96 additions and 30 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
src/openrct2/Game.cpp
View File

@ -618,7 +618,7 @@ void reset_all_sprite_quadrant_placements()
for (size_t i = 0; i < MAX_SPRITES; i++)
{
auto* spr = GetEntity(i);
if (spr->sprite_identifier != SPRITE_IDENTIFIER_NULL)
if (spr != nullptr && spr->sprite_identifier != SPRITE_IDENTIFIER_NULL)
{
spr->MoveTo({ spr->x, spr->y, spr->z });
}

2
src/openrct2/interface/InteractiveConsole.cpp
View File

@ -1573,7 +1573,7 @@ static int32_t cc_mp_desync(InteractiveConsole& console, const arguments_t& argv
for (int i = 0; i < MAX_SPRITES; i++)
{
auto* sprite = GetEntity(i);
if (sprite->sprite_identifier == SPRITE_IDENTIFIER_NULL)
if (sprite == nullptr || sprite->sprite_identifier == SPRITE_IDENTIFIER_NULL)
continue;
auto peep = sprite->As<Peep>();

17
src/openrct2/interface/Viewport.cpp
View File

@ -175,8 +175,16 @@ void viewport_create(
if (flags & VIEWPORT_FOCUS_TYPE_SPRITE)
{
w->viewport_target_sprite = sprite;
auto* centre_sprite = GetEntity(sprite);
centrePos = { centre_sprite->x, centre_sprite->y, centre_sprite->z };
auto* centreEntity = GetEntity(sprite);
if (centreEntity != nullptr)
{
centrePos = { centreEntity->x, centreEntity->y, centreEntity->z };
}
else
{
log_error("Invalid entity for viewport.");
return;
}
}
else
{
@ -620,7 +628,10 @@ void viewport_update_sprite_follow(rct_window* window)
if (window->viewport_target_sprite != SPRITE_INDEX_NULL && window->viewport)
{
auto* sprite = GetEntity(window->viewport_target_sprite);
if (sprite == nullptr)
{
return;
}
int32_t height = (tile_element_height({ sprite->x, sprite->y })) - 16;
int32_t underground = sprite->z < height;

6
src/openrct2/interface/Window_internal.cpp
View File

@ -10,7 +10,7 @@ void rct_window::SetLocation(int32_t newX, int32_t newY, int32_t newZ)
void rct_window::ScrollToViewport()
{
int32_t newX, newY, newZ;
int32_t newX = LOCATION_NULL, newY = LOCATION_NULL, newZ = LOCATION_NULL;
rct_window* mainWindow;
// In original checked to make sure x and y were not -1 as well.
@ -20,6 +20,10 @@ void rct_window::ScrollToViewport()
if (viewport_focus_sprite.type & VIEWPORT_FOCUS_TYPE_SPRITE)
{
auto* sprite = GetEntity(viewport_focus_sprite.sprite_id);
if (sprite == nullptr)
{
return;
}
newX = sprite->x;
newY = sprite->y;
newZ = sprite->z;

90
src/openrct2/world/Sprite.cpp
View File

@ -122,11 +122,6 @@ rct_sprite* get_sprite(size_t sprite_idx)
return &_spriteList[sprite_idx];
}
SpriteBase* GetEntity(size_t sprite_idx)
{
return GetEntity<SpriteBase>(sprite_idx);
}
uint16_t sprite_get_first_in_quadrant(const CoordsXY& spritePos)
{
return gSpriteSpatialIndex[GetSpatialIndexOffset(spritePos.x, spritePos.y)];
@ -195,6 +190,11 @@ void reset_sprite_list()
for (int32_t i = 0; i < MAX_SPRITES; ++i)
{
auto* spr = GetEntity(i);
if (spr == nullptr)
{
continue;
}
spr->sprite_identifier = SPRITE_IDENTIFIER_NULL;
spr->sprite_index = i;
spr->next = SPRITE_INDEX_NULL;
@ -231,7 +231,7 @@ void reset_sprite_spatial_index()
for (size_t i = 0; i < MAX_SPRITES; i++)
{
auto* spr = GetEntity(i);
if (spr->sprite_identifier != SPRITE_IDENTIFIER_NULL)
if (spr != nullptr && spr->sprite_identifier != SPRITE_IDENTIFIER_NULL)
{
size_t index = GetSpatialIndexOffset(spr->x, spr->y);
uint32_t nextSpriteId = gSpriteSpatialIndex[index];
@ -404,7 +404,10 @@ rct_sprite* create_sprite(SPRITE_IDENTIFIER spriteIdentifier, EntityListId linke
}
auto* sprite = GetEntity(gSpriteListHead[static_cast<uint8_t>(EntityListId::Free)]);
if (sprite == nullptr)
{
return nullptr;
}
move_sprite_to_list(sprite, linkedListIndex);
// Need to reset all sprite data, as the uninitialised values
@ -473,13 +476,29 @@ static void move_sprite_to_list(SpriteBase* sprite, EntityListId newListIndex)
else
{
// Hook up sprite->previous->next to sprite->next, removing the sprite from its old list
GetEntity(sprite->previous)->next = sprite->next;
auto previous = GetEntity(sprite->previous);
if (previous == nullptr)
{
log_error("Broken previous entity id. Entity list corrupted!");
}
else
{
previous->next = sprite->next;
}
}
// Similarly, hook up sprite->next->previous to sprite->previous
if (sprite->next != SPRITE_INDEX_NULL)
{
GetEntity(sprite->next)->previous = sprite->previous;
auto next = GetEntity(sprite->next);
if (next == nullptr)
{
log_error("Broken next entity id. Entity list corrupted!");
}
else
{
next->previous = sprite->previous;
}
}
sprite->previous = SPRITE_INDEX_NULL; // We become the new head of the target list, so there's no previous sprite
@ -493,7 +512,15 @@ static void move_sprite_to_list(SpriteBase* sprite, EntityListId newListIndex)
if (sprite->next != SPRITE_INDEX_NULL)
{
// Fix the chain by settings sprite->next->previous to sprite_index
GetEntity(sprite->next)->previous = sprite->sprite_index;
auto next = GetEntity(sprite->next);
if (next == nullptr)
{
log_error("Broken next entity id. Entity list corrupted!");
}
else
{
next->previous = sprite->sprite_index;
}
}
// These globals are probably counters for each sprite list?
@ -936,7 +963,7 @@ void sprite_position_tween_all(float alpha)
for (uint16_t i = 0; i < MAX_SPRITES; i++)
{
auto* sprite = GetEntity(i);
if (sprite_should_tween(sprite))
if (sprite != nullptr && sprite_should_tween(sprite))
{
auto posA = _spritelocations1[i];
auto posB = _spritelocations2[i];
@ -962,7 +989,7 @@ void sprite_position_tween_restore()
for (uint16_t i = 0; i < MAX_SPRITES; i++)
{
auto* sprite = GetEntity(i);
if (sprite_should_tween(sprite))
if (sprite != nullptr && sprite_should_tween(sprite))
{
sprite->Invalidate2();
@ -977,6 +1004,11 @@ void sprite_position_tween_reset()
for (uint16_t i = 0; i < MAX_SPRITES; i++)
{
auto* sprite = GetEntity(i);
if (sprite == nullptr)
{
continue;
}
_spritelocations1[i].x = _spritelocations2[i].x = sprite->x;
_spritelocations1[i].y = _spritelocations2[i].y = sprite->y;
_spritelocations1[i].z = _spritelocations2[i].z = sprite->z;
@ -1054,7 +1086,13 @@ int32_t check_for_sprite_list_cycles(bool fix)
{
// Fix head list, but only in reverse order
// This is likely not needed, but just in case
GetEntity(gSpriteListHead[i])->previous = SPRITE_INDEX_NULL;
auto head = GetEntity(gSpriteListHead[i]);
if (head == nullptr)
{
log_error("SpriteListHead is corrupted!");
return -1;
}
head->previous = SPRITE_INDEX_NULL;
// Store the leftover part of cycle to be fixed
uint16_t cycle_next = cycle_start->next;
@ -1067,7 +1105,11 @@ int32_t check_for_sprite_list_cycles(bool fix)
while (!index_is_in_list(cycle_next, static_cast<EntityListId>(i)))
{
auto* spr = GetEntity(cycle_next);
if (spr == nullptr)
{
log_error("EntityList is corrupted!");
return -1;
}
cycle_start->next = cycle_next;
spr->previous = cycle_start->sprite_index;
cycle_next = spr->next;
@ -1097,6 +1139,12 @@ int32_t fix_disjoint_sprites()
reachable[sprite_idx] = true;
// cache the tail, so we don't have to walk the list twice
null_list_tail = GetEntity(sprite_idx);
if (null_list_tail == nullptr)
{
log_error("Broken Entity list");
sprite_idx = SPRITE_INDEX_NULL;
return 0;
}
sprite_idx = null_list_tail->next;
}
@ -1106,16 +1154,24 @@ int32_t fix_disjoint_sprites()
for (uint16_t sprite_idx = 0; sprite_idx < MAX_SPRITES; sprite_idx++)
{
auto* spr = GetEntity(sprite_idx);
if (spr->sprite_identifier == SPRITE_IDENTIFIER_NULL)
if (spr != nullptr && spr->sprite_identifier == SPRITE_IDENTIFIER_NULL)
{
openrct2_assert(null_list_tail != nullptr, "Null list is empty, yet found null sprites");
spr->sprite_index = sprite_idx;
if (!reachable[sprite_idx])
{
// Add the sprite directly to the list
null_list_tail->next = sprite_idx;
if (null_list_tail == nullptr)
{
gSpriteListHead[static_cast<uint8_t>(EntityListId::Free)] = sprite_idx;
spr->previous = SPRITE_INDEX_NULL;
}
else
{
null_list_tail->next = sprite_idx;
spr->previous = null_list_tail->sprite_index;
}
spr->next = SPRITE_INDEX_NULL;
spr->previous = null_list_tail->sprite_index;
null_list_tail = spr;
count++;
reachable[sprite_idx] = true;

4
src/openrct2/world/Sprite.h
View File

@ -193,7 +193,7 @@ enum
rct_sprite* try_get_sprite(size_t spriteIndex);
rct_sprite* get_sprite(size_t sprite_idx);
template<typename T> T* GetEntity(size_t sprite_idx)
template<typename T = SpriteBase> T* GetEntity(size_t sprite_idx)
{
auto spr = reinterpret_cast<SpriteBase*>(get_sprite(sprite_idx));
if (spr == nullptr)
@ -201,11 +201,11 @@ template<typename T> T* GetEntity(size_t sprite_idx)
return spr->As<T>();
}
SpriteBase* GetEntity(size_t sprite_idx);
uint16_t GetEntityListCount(EntityListId list);
extern uint16_t gSpriteListHead[static_cast<uint8_t>(EntityListId::Count)];
extern uint16_t gSpriteListCount[static_cast<uint8_t>(EntityListId::Count)];
constexpr const uint32_t SPATIAL_INDEX_SIZE = (MAXIMUM_MAP_SIZE_TECHNICAL * MAXIMUM_MAP_SIZE_TECHNICAL) + 1;
constexpr const uint32_t SPATIAL_INDEX_LOCATION_NULL = SPATIAL_INDEX_SIZE - 1;
extern uint16_t gSpriteSpatialIndex[SPATIAL_INDEX_SIZE];

5
test/testpaint/Compat.cpp
View File

@ -162,11 +162,6 @@ rct_sprite* get_sprite(size_t sprite_idx)
return &sprite_list[sprite_idx];
}
SpriteBase* GetEntity(size_t sprite_idx)
{
return GetEntity<SpriteBase>(sprite_idx);
}
bool TileElementBase::IsLastForTile() const
{
return (this->Flags & TILE_ELEMENT_FLAG_LAST_TILE) != 0;