fix: type safety around const "Thing" (#1854)

Addresses the issue in const member functions where the getContainer method may return a nullptr
opentibiabr · Nov 20, 2023 · b6af793 · b6af793
1 parent 8993119
commit b6af793
Show file tree

Hide file tree

Showing 8 changed files with 36 additions and 3 deletions.
diff --git a/src/creatures/creature.hpp b/src/creatures/creature.hpp
@@ -76,15 +76,27 @@ class Creature : virtual public Thing, public SharedObject {
 	std::shared_ptr<Creature> getCreature() override final {
 		return static_self_cast<Creature>();
 	}
+	std::shared_ptr<const Creature> getCreature() const override final {
+		return static_self_cast<Creature>();
+	}
 	virtual std::shared_ptr<Player> getPlayer() {
 		return nullptr;
 	}
+	virtual std::shared_ptr<const Player> getPlayer() const {
+		return nullptr;
+	}
 	virtual std::shared_ptr<Npc> getNpc() {
 		return nullptr;
 	}
+	virtual std::shared_ptr<const Npc> getNpc() const {
+		return nullptr;
+	}
 	virtual std::shared_ptr<Monster> getMonster() {
 		return nullptr;
 	}
+	virtual std::shared_ptr<const Monster> getMonster() const {
+		return nullptr;
+	}
 
 	virtual const std::string &getName() const = 0;
 	// Real creature name, set on creature creation "createNpcType(typeName) and createMonsterType(typeName)"

diff --git a/src/creatures/monsters/monster.hpp b/src/creatures/monsters/monster.hpp
@@ -32,6 +32,9 @@ class Monster final : public Creature {
 	std::shared_ptr<Monster> getMonster() override {
 		return static_self_cast<Monster>();
 	}
+	std::shared_ptr<const Monster> getMonster() const override {
+		return static_self_cast<Monster>();
+	}
 
 	void setID() override {
 		if (id == 0) {

diff --git a/src/creatures/npcs/npc.hpp b/src/creatures/npcs/npc.hpp
@@ -40,6 +40,9 @@ class Npc final : public Creature {
 	std::shared_ptr<Npc> getNpc() override {
 		return static_self_cast<Npc>();
 	}
+	std::shared_ptr<const Npc> getNpc() const override {
+		return static_self_cast<Npc>();
+	}
 
 	void setID() override {
 		if (id == 0) {

diff --git a/src/creatures/players/player.hpp b/src/creatures/players/player.hpp
@@ -121,6 +121,9 @@ class Player final : public Creature, public Cylinder, public Bankable {
 	std::shared_ptr<Player> getPlayer() override {
 		return static_self_cast<Player>();
 	}
+	std::shared_ptr<const Player> getPlayer() const override {
+		return static_self_cast<Player>();
+	}
 
 	static std::shared_ptr<Task> createPlayerTask(uint32_t delay, std::function<void(void)> f, std::string context);
 

diff --git a/src/items/containers/container.hpp b/src/items/containers/container.hpp
@@ -55,6 +55,10 @@ class Container : public Item, public Cylinder {
 		return static_self_cast<Container>();
 	}
 
+	std::shared_ptr<const Container> getContainer() const override final {
+		return static_self_cast<Container>();
+	}
+
 	std::shared_ptr<Container> getRootContainer();
 
 	virtual std::shared_ptr<DepotLocker> getDepotLocker() {

diff --git a/src/items/item.hpp b/src/items/item.hpp
@@ -235,6 +235,9 @@ class Item : virtual public Thing, public ItemProperties, public SharedObject {
 	std::shared_ptr<Item> getItem() override final {
 		return static_self_cast<Item>();
 	}
+	std::shared_ptr<const Item> getItem() const override final {
+		return static_self_cast<Item>();
+	}
 	virtual std::shared_ptr<Teleport> getTeleport() {
 		return nullptr;
 	}

diff --git a/src/items/thing.hpp b/src/items/thing.hpp
@@ -54,19 +54,19 @@ class Thing {
 	virtual std::shared_ptr<Container> getContainer() {
 		return nullptr;
 	}
-	virtual std::shared_ptr<Container> getContainer() const {
+	virtual std::shared_ptr<const Container> getContainer() const {
 		return nullptr;
 	}
 	virtual std::shared_ptr<Item> getItem() {
 		return nullptr;
 	}
-	virtual std::shared_ptr<Item> getItem() const {
+	virtual std::shared_ptr<const Item> getItem() const {
 		return nullptr;
 	}
 	virtual std::shared_ptr<Creature> getCreature() {
 		return nullptr;
 	}
-	virtual std::shared_ptr<Creature> getCreature() const {
+	virtual std::shared_ptr<const Creature> getCreature() const {
 		return nullptr;
 	}
 

diff --git a/src/lua/global/shared_object.hpp b/src/lua/global/shared_object.hpp
@@ -29,6 +29,11 @@ class SharedObject : public std::enable_shared_from_this<SharedObject> {
 		return std::static_pointer_cast<T>(shared_from_this());
 	}
 
+	template <typename T>
+	std::shared_ptr<const T> static_self_cast() const {
+		return std::static_pointer_cast<const T>(shared_from_this());
+	}
+
 	template <typename T>
 	std::shared_ptr<T> dynamic_self_cast() {
 		return std::dynamic_pointer_cast<T>(shared_from_this());