cpp/openttd-patchpack/source Changeset - r28586:6c3d6a591e08

Changeset - r28586:6c3d6a591e08

Parent rev.

Child rev.

[Not reviewed]

master

0 4 0

SamuXarick - 10 months ago 2024-01-27 23:29:10
43006711+SamuXarick@users.noreply.github.com

Fix #10439: [GS] Validate story page button colour, flags, cursor and vehicle type (#11892)

Adds GSStoryPage::IsValidStoryPageButtonColour, GSStoryPage::IsValidStoryPageButtonFlags and GSStoryPage::IsValidStoryPageButtonCursor to the API.

Add missing enforced preconditions to validate parameters passed to MakePushButtonReference, MakeTileButtonReference and MakeVehicleButtonReference.

4 files changed with 71 insertions and 5 deletions:

src/script/api/game_changelog.hpp

src/script/api/script_story_page.cpp

src/script/api/script_story_page.hpp

src/story.cpp

0 comments (0 inline, 0 general)

src/script/api/game_changelog.hpp

➞

Show inline comments

@@ @@ -82,6 +82,9 @@ @@
  * \li GSIndustry::GetProductionLevel
  * \li GSIndustry::SetProductionLevel
  * \li GSStoryPage::IsValidStoryPageElementType
  * \li GSStoryPage::IsValidStoryPageButtonColour
  * \li GSStoryPage::IsValidStoryPageButtonFlags
  * \li GSStoryPage::IsValidStoryPageButtonCursor
+ *
  * API removals:
  * \li GSError::ERR_PRECONDITION_TOO_MANY_PARAMETERS, that error is never returned anymore.

src/script/api/script_story_page.cpp

➞

Show inline comments

@@ @@ -224,10 +224,32 @@ static inline bool StoryPageElementTypeR @@
 	return ScriptObject::Command<CMD_REMOVE_STORY_PAGE_ELEMENT>::Do(story_page_element_id);
+}
 /* static */ bool ScriptStoryPage::IsValidStoryPageButtonColour(StoryPageButtonColour colour)
+{
 	return ::IsValidColours((::Colours)colour);
+}
 /* static */ bool ScriptStoryPage::IsValidStoryPageButtonFlags(StoryPageButtonFlags flags)
+{
 	/* Don't allow float left and right together */
 	if ((flags & SPBF_FLOAT_LEFT) && (flags & SPBF_FLOAT_RIGHT)) return false;
 	/* Don't allow undefined flags */
 	if (flags & ~(SPBF_FLOAT_LEFT | SPBF_FLOAT_RIGHT)) return false;
 	return true;
+}
 /* static */ bool ScriptStoryPage::IsValidStoryPageButtonCursor(StoryPageButtonCursor cursor)
+{
 	return ::IsValidStoryPageButtonCursor((::StoryPageButtonCursor)cursor);
+}
 /* static */ ScriptStoryPage::StoryPageButtonFormatting ScriptStoryPage::MakePushButtonReference(StoryPageButtonColour colour, StoryPageButtonFlags flags)
+{
 	EnforcePrecondition(UINT32_MAX, IsValidStoryPageButtonColour(colour));
 	EnforcePrecondition(UINT32_MAX, IsValidStoryPageButtonFlags(flags));
 	StoryPageButtonData data;
 	data.SetColour((Colours)colour);
+	data.SetColour((::Colours)colour);
 	data.SetFlags((::StoryPageButtonFlags)flags);
 	if (!data.ValidateColour()) return UINT32_MAX;
 	if (!data.ValidateFlags()) return UINT32_MAX;
@@ @@ -236,8 +258,12 @@ static inline bool StoryPageElementTypeR @@
 /* static */ ScriptStoryPage::StoryPageButtonFormatting ScriptStoryPage::MakeTileButtonReference(StoryPageButtonColour colour, StoryPageButtonFlags flags, StoryPageButtonCursor cursor)
+{
 	EnforcePrecondition(UINT32_MAX, IsValidStoryPageButtonColour(colour));
 	EnforcePrecondition(UINT32_MAX, IsValidStoryPageButtonFlags(flags));
 	EnforcePrecondition(UINT32_MAX, IsValidStoryPageButtonCursor(cursor));
 	StoryPageButtonData data;
 	data.SetColour((Colours)colour);
+	data.SetColour((::Colours)colour);
 	data.SetFlags((::StoryPageButtonFlags)flags);
 	data.SetCursor((::StoryPageButtonCursor)cursor);
 	if (!data.ValidateColour()) return UINT32_MAX;
@@ @@ -248,8 +274,13 @@ static inline bool StoryPageElementTypeR @@
 /* static */ ScriptStoryPage::StoryPageButtonFormatting ScriptStoryPage::MakeVehicleButtonReference(StoryPageButtonColour colour, StoryPageButtonFlags flags, StoryPageButtonCursor cursor, ScriptVehicle::VehicleType vehtype)
+{
 	EnforcePrecondition(UINT32_MAX, IsValidStoryPageButtonColour(colour));
 	EnforcePrecondition(UINT32_MAX, IsValidStoryPageButtonFlags(flags));
 	EnforcePrecondition(UINT32_MAX, IsValidStoryPageButtonCursor(cursor));
 	EnforcePrecondition(UINT32_MAX, vehtype == ScriptVehicle::VT_INVALID || vehtype == ScriptVehicle::VT_RAIL || vehtype == ScriptVehicle::VT_ROAD || vehtype == ScriptVehicle::VT_WATER || vehtype == ScriptVehicle::VT_AIR);
 	StoryPageButtonData data;
 	data.SetColour((Colours)colour);
+	data.SetColour((::Colours)colour);
 	data.SetFlags((::StoryPageButtonFlags)flags);
 	data.SetCursor((::StoryPageButtonCursor)cursor);
 	data.SetVehicleType((::VehicleType)vehtype);
@@ @@ -259,4 +290,3 @@ static inline bool StoryPageElementTypeR @@
 	if (!data.ValidateVehicleType()) return UINT32_MAX;
 	return data.referenced_id;
+}

src/script/api/script_story_page.hpp

➞

Show inline comments

@@ @@ -146,7 +146,7 @@ public: @@
 	 * Colour codes usable for story page button elements.
 	 * Place a colour value in the lowest 8 bits of the \c reference parameter to the button.
 	 */
 	enum StoryPageButtonColour {
+	enum StoryPageButtonColour : byte {
 		SPBC_DARK_BLUE  = ::COLOUR_DARK_BLUE,
 		SPBC_PALE_GREEN = ::COLOUR_PALE_GREEN,
 		SPBC_PINK       = ::COLOUR_PINK,
@@ @@ -321,10 +321,33 @@ public: @@
 	static bool RemoveElement(StoryPageElementID story_page_element_id);
 	/**
 	 * Check whether this is a valid story page button colour.
 	 * @param colour The StoryPageButtonColour to check.
 	 * @return True if and only if this story page button colour is valid.
 	 */
 	static bool IsValidStoryPageButtonColour(StoryPageButtonColour colour);
 	/**
 	* Check whether this is a valid story page button flag.
 	* @param colour The StoryPageButtonFlags to check.
 	* @return True if and only if this story page button flag is valid.
 	*/
 	static bool IsValidStoryPageButtonFlags(StoryPageButtonFlags flags);
 	/**
 	 * Check whether this is a valid story page button cursor.
 	 * @param colour The StoryPageButtonCursor to check.
 	 * @return True if and only if this story page button cursor is valid.
 	 */
 	static bool IsValidStoryPageButtonCursor(StoryPageButtonCursor cursor);
 	/**
 	 * Create a reference value for SPET_BUTTON_PUSH element parameters.
 	 * @param colour The colour for the face of the button.
 	 * @param flags The formatting and layout flags for the button.
 	 * @return A reference value usable with the #NewElement and #UpdateElement functions.
 	 * @pre IsValidStoryPageButtonColour(colour).
 	 * @pre IsValidStoryPageButtonFlags(flags).
 	 */
 	static StoryPageButtonFormatting MakePushButtonReference(StoryPageButtonColour colour, StoryPageButtonFlags flags);
@@ @@ -334,6 +357,9 @@ public: @@
 	 * @param flags The formatting and layout flags for the button.
 	 * @param cursor The mouse cursor to use when the player clicks the button and the game is ready for the player to select a tile.
 	 * @return A reference value usable with the #NewElement and #UpdateElement functions.
 	 * @pre IsValidStoryPageButtonColour(colour).
 	 * @pre IsValidStoryPageButtonFlags(flags).
 	 * @pre IsValidStoryPageButtonCursor(cursor).
 	 */
 	static StoryPageButtonFormatting MakeTileButtonReference(StoryPageButtonColour colour, StoryPageButtonFlags flags, StoryPageButtonCursor cursor);
@@ @@ -344,6 +370,10 @@ public: @@
 	 * @param cursor  The mouse cursor to use when the player clicks the button and the game is ready for the player to select a vehicle.
 	 * @param vehtype The type of vehicle that will be selectable, or \c VT_INVALID to allow all types.
 	 * @return A reference value usable with the #NewElement and #UpdateElement functions.
 	 * @pre IsValidStoryPageButtonColour(colour).
 	 * @pre IsValidStoryPageButtonFlags(flags).
 	 * @pre IsValidStoryPageButtonCursor(cursor).
 	 * @pre vehtype == ScriptVehicle::VT_INVALID || vehtype == ScriptVehicle::VT_RAIL || vehtype == ScriptVehicle::VT_ROAD || vehtype == ScriptVehicle::VT_WATER || vehtype == ScriptVehicle::VT_AIR.
 	 */
 	static StoryPageButtonFormatting MakeVehicleButtonReference(StoryPageButtonColour colour, StoryPageButtonFlags flags, StoryPageButtonCursor cursor, ScriptVehicle::VehicleType vehtype);
 };

src/story.cpp

➞

Show inline comments

@@ @@ -66,13 +66,16 @@ static bool VerifyElementContentParamete @@
 			break;
 		case SPET_BUTTON_PUSH:
 			if (!button_data.ValidateColour()) return false;
 			if (!button_data.ValidateFlags()) return false;
 			return true;
 		case SPET_BUTTON_TILE:
 			if (!button_data.ValidateColour()) return false;
 			if (!button_data.ValidateFlags()) return false;
 			if (!button_data.ValidateCursor()) return false;
 			return true;
 		case SPET_BUTTON_VEHICLE:
 			if (!button_data.ValidateColour()) return false;
 			if (!button_data.ValidateFlags()) return false;
 			if (!button_data.ValidateCursor()) return false;
 			if (!button_data.ValidateVehicleType()) return false;
 			return true;

0 comments (0 inline, 0 general)