TITANIC: In progress adding CRoomFlags class

3 files changed, 606 insertions, 0 deletions

diff --git a/engines/titanic/module.mk b/engines/titanic/module.mk
index dac6287c28..b1b35fc3f3 100644
--- a/engines/titanic/module.mk
+++ b/engines/titanic/module.mk
@@ -11,6 +11,7 @@ MODULE_OBJS := \
 	input_handler.o \
 	input_translator.o \
 	main_game_window.o \
+	room_flags.o \
 	titanic.o \
 	carry/auditory_centre.o \
 	carry/arm.o \
diff --git a/engines/titanic/room_flags.cpp b/engines/titanic/room_flags.cpp
new file mode 100644
index 0000000000..ac3ae4943b
--- /dev/null
+++ b/engines/titanic/room_flags.cpp
@@ -0,0 +1,403 @@
+/* ScummVM - Graphic Adventure Engine
+ *
+ * ScummVM is the legal property of its developers, whose names
+ * are too numerous to list here. Please refer to the COPYRIGHT
+ * file distributed with this source distribution.
+ *
+ * This program 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.
+ *
+ * This program 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 this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ *
+ */
+
+#include "titanic/room_flags.h"
+
+namespace Titanic {
+
+#define ELEVATOR_SHIFT 18
+#define ELEVATOR_MASK 3
+#define PASSENGER_CLASS_SHIFT 16
+#define PASSENGER_CLASS_MASK 3
+#define FLOOR_SHIFT 8
+#define FLOOR_MASK 0xFF
+#define ROOM_SHIFT 1
+#define ROOM_MASK 0x7F
+
+struct TransportFlagsEntry {
+	const char *const _roomName;
+	uint _roomFlags;
+};
+struct SuccUBusFlagsEntry {
+	const char *const _roomName;
+	uint _roomFlags;
+	uint _succubusNum;
+};
+
+#define TRANSPORT_ROOMS_SIZE 6
+const TransportFlagsEntry TRANSPORT_ROOMS[TRANSPORT_ROOMS_SIZE] = {
+	{ "TopOfWell", 0xDF4D1 },
+	{ "Pellerator", 0xC95E9 },
+	{ "Dome", 0xAD171 },
+	{ "Lift", 0x96E45 },
+	{ "SGTLeisure", 0x5D3AD },
+	{ "ServiceElevator", 0x68797 }
+};
+
+#define SUCCUBUS_ROOMS_SIZE 17
+const SuccUBusFlagsEntry SUCCUBUS_ROOMS[SUCCUBUS_ROOMS_SIZE] = {
+	{ "ParrotLobby", 0x1D0D9, 3 },
+	{ "SculptureChamber", 0x465FB, 2 },
+	{ "Bar", 0x0B3D97, 2 },
+	{ "EmbLobby", 0x0CC971, 3 },
+	{ "MoonEmbLobby", 0x0CC971, 3 },
+	{ "MusicRoom", 0x0F34DB, 2 },
+	{ "MusicRoomLobby", 0x0F34DB, 2 },
+	{ "Titania", 0x8A397, 3 },
+	{ "BottomOfWell", 0x59FAD, 3 },
+	{ "Arboretum", 0x4D6AF, 1 },
+	{ "PromenadeDeck", 0x79C45, 2 },
+	{ "1stClassRestaurant", 0x896B9, 1 },
+	{ "CreatorsChamber", 0x2F86D, 2 },
+	{ "CreatorsChamberOn", 0x2F86D, 2 },
+	{ "BilgeRoom", 0x3D94B, 3 },
+	{ "BilgeRoomWith", 0x3D94B, 3 },
+	{ "Bridge", 0x39FCB, 3 }
+};
+
+int CRoomFlags::getConditionally() const {
+	if (getRoomArea() != 5 || getRoomCategory() != 5)
+		return _data;
+	else
+		return 5;
+}
+
+bool CRoomFlags::isTransportRoom() const {
+	for (int idx = 0; idx < TRANSPORT_ROOMS_SIZE; ++idx) {
+		if (TRANSPORT_ROOMS[idx]._roomFlags == _data)
+			return true;
+	}
+
+	return false;
+}
+
+int CRoomFlags::getRoomCategory() const {
+	if (getRoomNum() == 0)
+		return false;
+
+	CRoomFlags tempFlags = _data;
+	tempFlags.setRoomBits(1);
+	return tempFlags.getRoomArea() != 5;
+}
+
+CString CRoomFlags::getRoomDesc() const {
+	switch (getRoomArea()) {
+	case 1:
+	case 2:
+	case 3: {
+		CString result = getPassengerClassDesc();
+		result += ", ";
+		result += getFloorDesc();
+		result += ", ";
+		result += getElevatorDesc();
+		result += ", ";
+		result += getRoomDesc();
+		return result;
+	}
+
+	case 4:
+		if (isTransportRoom()) {
+			switch (_data) {
+			case 0x68797:
+				return "The Service Elevator";
+			case 0x5D3AD:
+				return "The Super Galactic Leisure Lounge";
+			case 0x96E45:
+				return "The Elevator";
+			case 0xAD171:
+				return "The Dome";
+			case 0xC95E9:
+				return "The Pellerator";
+			case 0xDF4D1:
+				return  "The Top of the Well";
+			default:
+				break;
+			}
+		}
+
+		if (getRoomCategory() == 0) {
+			return "Nowhere you're likely to want to go.";
+		} else {
+			CString result = getPassengerClassDesc();
+			result += ", ";
+			result += getFloorDesc();
+			return result;
+		}
+		break;
+
+	case 5:
+		switch (_data) {
+		case 0x1D0D9:
+			return "The Parrot Lobby";
+		case 0x2F86D:
+			return "The Creators' Chamber";
+		case 0x39FCB:
+			return "The Bridge";
+		case 0x3D94B:
+			return "The Bilge Room";
+		case 0x465FB:
+			return "The Sculpture Chamber";
+		case 0x4D6AF:
+			return "The Arboretum";
+		case 0x59FAD:
+			return "The Bottom of the Well";
+		case 0x79C45:
+			return "The Promenade Deck";
+		case 0x896B9:
+			return "The 1st class restaurant";
+		case 0x8A397:
+			return "Titania's Room";
+		case 0xB3D97:
+			return "The Bar";
+		case 0xCC971:
+			return "The Embarkation Lobby";
+		case 0xF34DB:
+			return  "The Music Room";
+		default:
+			break;
+		}
+		return "Unknown Room";
+
+	default:
+		break;
+	}
+
+	return "Unknown Room";
+}
+
+void CRoomFlags::setElevatorBits(uint val) {
+	_data &= ~(ELEVATOR_MASK << ELEVATOR_SHIFT);
+	_data |= (val & ELEVATOR_MASK) << ELEVATOR_SHIFT;
+}
+
+uint CRoomFlags::getElevatorBits() const {
+	return (_data >> ELEVATOR_SHIFT) & ELEVATOR_MASK;
+}
+
+void CRoomFlags::setPassengerClassBits(uint val) {
+	_data &= ~(PASSENGER_CLASS_MASK << PASSENGER_CLASS_SHIFT);
+	_data |= (val & PASSENGER_CLASS_MASK) << PASSENGER_CLASS_SHIFT;
+}
+
+uint CRoomFlags::getPassengerClassBits() const {
+	return (_data >> PASSENGER_CLASS_SHIFT) & PASSENGER_CLASS_MASK;
+}
+
+CString CRoomFlags::getPassengerClassDesc() const {
+	int classNum = getPassengerClassNum();
+
+	switch (classNum) {
+	case 1:
+		return "1st class";
+	case 2:
+		return "2nd class";
+	case 3:
+		return "SGT class";
+	default:
+		return "no class";
+	}
+}
+
+void CRoomFlags::setFloorBits(uint val) {
+	_data &= ~(FLOOR_MASK << FLOOR_SHIFT);
+	_data |= (val & FLOOR_MASK) << FLOOR_SHIFT;
+}
+
+uint CRoomFlags::getFloorBits() const {
+	return (_data >> FLOOR_SHIFT) & FLOOR_MASK;
+}
+
+uint CRoomFlags::decodeFloorBits(uint bits) const {
+	int base = 0;
+	int offset = bits & 0xF;
+
+	switch ((bits >> 4) & 0xF) {
+	case 1:
+	case 2:
+	case 3:
+		base = 40;
+		break;
+	case 4:
+		base = 10;
+		break;
+	case 5:
+		base = 20;
+		break;
+	case 6:
+		base = 30;
+		break;
+	default:
+		break;
+	}
+
+	return offset >= 10 ? 0 : base + offset;
+}
+
+void CRoomFlags::setFloorNum(uint floorNum) {
+	uint base = 0;
+
+	switch (floorNum / 10) {
+	case 0:
+		base = 0x90;
+		break;
+	case 1:
+		base = 0xD0;
+	case 2:
+		base = 0xE0;
+	case 3:
+		base = 0xF0;
+		break;
+	default:
+		break;
+	}
+
+	setFloorBits(base | (floorNum % 10));
+}
+
+uint CRoomFlags::getFloorNum() const {
+	return decodeFloorBits(getFloorBits());
+}
+
+void CRoomFlags::setRoomBits(uint roomBits) {
+	_data &= ~(ROOM_MASK << ROOM_SHIFT);
+	_data |= (roomBits & ROOM_MASK) << ROOM_SHIFT;
+}
+
+uint CRoomFlags::getRoomBits() const {
+	return (_data >> ROOM_SHIFT) & ROOM_MASK;
+}
+
+uint CRoomFlags::getRoomArea() const {
+	warning("TODO: CRoomFlags::getRoomArea");
+	return 0;
+}
+
+bool CRoomFlags::isSuccUBusRoomFlags() const {
+	for (int idx = 0; idx < SUCCUBUS_ROOMS_SIZE; ++idx) {
+		if (SUCCUBUS_ROOMS[idx]._roomFlags == _data)
+			return true;
+	}
+
+	return false;
+}
+
+bool CRoomFlags::getBit0() const {
+	return _data & 1;
+}
+
+uint CRoomFlags::getSpecialRoomFlags(const CString &roomName) {
+	for (int idx = 0; idx < SUCCUBUS_ROOMS_SIZE; ++idx) {
+		if (!roomName.compareTo(SUCCUBUS_ROOMS[idx]._roomName))
+			return SUCCUBUS_ROOMS[idx]._roomFlags;
+	}
+
+	for (int idx = 0; idx < TRANSPORT_ROOMS_SIZE; ++idx) {
+		if (!roomName.compareTo(TRANSPORT_ROOMS[idx]._roomName))
+			return TRANSPORT_ROOMS[idx]._roomFlags;
+	}
+
+	return 0;
+}
+
+uint CRoomFlags::getSuccUBusNum(const CString &roomName) {
+	for (int idx = 0; idx < SUCCUBUS_ROOMS_SIZE; ++idx) {
+		if (!roomName.compareTo(SUCCUBUS_ROOMS[idx]._roomName))
+			return SUCCUBUS_ROOMS[idx]._succubusNum;
+	}
+
+	return 0;
+}
+
+CString CRoomFlags::getSuccUBusRoomName() const {
+	for (int idx = 0; idx < SUCCUBUS_ROOMS_SIZE; ++idx) {
+		if (SUCCUBUS_ROOMS[idx]._roomFlags == _data)
+			return SUCCUBUS_ROOMS[idx]._roomName;
+	}
+
+	return CString();
+}
+
+void CRoomFlags::changeLocation(int action) {
+	uint floorNum = getFloorNum();
+	uint roomNum = getRoomNum();
+	uint elevatorNum = getElevatorNum();
+	uint classNum = getPassengerClassNum();
+	uint v10, v11, v12, v13;
+
+	switch (classNum) {
+	case 1:
+		v10 = 2;
+		v11 = 19;
+		v12 = 1;
+		v13 = 3;
+		break;
+
+	case 2:
+		v10 = 20;
+		v11 = 27;
+		v12 = 1;
+		v13 = (elevatorNum & 1) ? 3 : 4;
+		break;
+
+	case 3:
+		v10 = 28;
+		v11 = 38;
+		v12 = 1;
+		v13 = 18;
+		break;
+
+	default:
+		v10 = 0;
+		v11 = 0;
+		v12 = 0;
+		v13 = 0;
+		break;
+	}
+
+	// Perform action to change room or floor
+	switch (action) {
+	case 1:
+		if (--roomNum < v12)
+			roomNum = v12;
+		break;
+
+	case 2:
+		if (++roomNum > v13)
+			roomNum = v13;
+		break;
+
+	case 3:
+		if (--floorNum < v10)
+			floorNum = v10;
+		break;
+
+	case 4:
+		if (++floorNum > v11)
+			floorNum = v11;
+	}
+
+	// Set new floor and room
+	setFloorNum(floorNum);
+	setRoomBits(roomNum);
+}
+
+} // End of namespace Titanic
diff --git a/engines/titanic/room_flags.h b/engines/titanic/room_flags.h
new file mode 100644
index 0000000000..961452535e
--- /dev/null
+++ b/engines/titanic/room_flags.h
@@ -0,0 +1,202 @@
+/* ScummVM - Graphic Adventure Engine
+ *
+ * ScummVM is the legal property of its developers, whose names
+ * are too numerous to list here. Please refer to the COPYRIGHT
+ * file distributed with this source distribution.
+ *
+ * This program 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.
+ *
+ * This program 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 this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ *
+ */
+
+#ifndef TITANIC_ROOM_FLAGS_H
+#define TITANIC_ROOM_FLAGS_H
+
+#include "titanic/support/string.h"
+
+namespace Titanic {
+
+class CRoomFlags {
+private:
+	uint _data;
+private:
+	int getConditionally() const;
+
+	bool not5() const { return getConditionally() != 5; }
+
+	/**
+	 * Returns true if the current flags appear in the
+	 * list of transport rooms
+	 */
+	bool isTransportRoom() const;
+
+	int getRoomCategory() const;
+
+	/**
+	 * Set the bits for the elevator number
+	 */
+	void setElevatorBits(uint val);
+
+	/**
+	 * Set the bits for the passenger class
+	 */
+	void setPassengerClassBits(uint val);
+
+	/**
+	 * Set the bits for the floor number
+	 */
+	void setFloorBits(uint val);
+
+	/**
+	 * Translates bits for floor into a floor number
+	 */
+	uint decodeFloorBits(uint bits) const;
+
+	uint getRoomArea() const;
+
+	/**
+	 * Returns true if the current flags are in the succubus list
+	 */
+	bool isSuccUBusRoomFlags() const;
+
+	/**
+	 * Gets the special flags for a transport or succubus room
+	 */
+	uint getSpecialRoomFlags(const CString &roomName);
+
+	/**
+	 * Gets the succubus number associated with a given room
+	 */
+	uint getSuccUBusNum(const CString &roomName);
+
+	/**
+	 * Gets the succubus room name associated with the current room flags
+	 */
+	CString getSuccUBusRoomName() const;
+public:
+	CRoomFlags() : _data(0) {}
+	CRoomFlags(uint data) : _data(data) {}
+	operator uint() { return _data; }
+
+	/**
+	 * Set the flags value
+	 */
+	void set(uint data) { _data = data; }
+
+	/**
+	 * Get the flags value
+	 */
+	uint get() const { return _data; }
+
+	bool test5(const CRoomFlags &roomFlags) const {
+		return roomFlags.not5();
+	}
+
+	/**
+	 * Get a description for the room
+	 */
+	CString getRoomDesc() const;
+
+	/**
+	 * Get the bits for the elevator number
+	 */
+	uint getElevatorBits() const;
+
+	/**
+	 * Set the elevator number
+	 */
+	void setElevatorNum(uint val) { setElevatorBits(val - 1); }
+
+	/**
+	 * Get the elevator number
+	 */
+	uint getElevatorNum() const { return getElevatorBits() + 1; }
+
+	/**
+	 * Get a description for the elevator number
+	 */
+	CString getElevatorDesc() const {
+		return CString::format("Elevator %d", getElevatorNum());
+	}
+
+	/**
+	 * Gets the bits for the passenger class
+	 */
+	uint getPassengerClassBits() const;
+
+	/**
+	 * Gets the passenger class number
+	 */
+	uint getPassengerClassNum() const { return getPassengerClassBits(); }
+
+	/**
+	 * Get a description for the passenger class
+	 */
+	CString getPassengerClassDesc() const;
+
+	/**
+	 * Gets the bits for the floor number
+	 */
+	uint getFloorBits() const;
+
+	/**
+	 * Sets the floor number
+	 */
+	void setFloorNum(uint floorNum);
+
+	/**
+	 * Gets the floor number
+	 */
+	uint getFloorNum() const;
+
+	/**
+	 * Get a description for the floor number
+	 */
+	CString getFloorDesc() const {
+		return CString::format("Floor %d", getFloorNum());
+	}
+
+	/**
+	 * Sets the bits for the room number
+	 */
+	void setRoomBits(uint roomBits);
+
+	/**
+	 * Gets the bits for the room number
+	 */
+	uint getRoomBits() const;
+
+	/**
+	 * Gets the room number
+	 */
+	uint getRoomNum() const { return getRoomBits(); }
+
+	/**
+	 * Gets a string for the room number
+	 */
+	CString getRoomNumDesc() const {
+		return CString::format("Room %d", getRoomNum());
+	}
+
+	bool getBit0() const;
+
+	/**
+	 * Change the passenger class
+	 */
+	void changeLocation(int action);
+};
+
+} // End of namespace Titanic
+
+#endif /* TITANIC_ROOM_FLAGS_H */