Changeset - r27212:5b91b1753581
[Not reviewed]
master
0 4 0
Rubidium - 19 months ago 2023-04-27 17:21:06
rubidium@openttd.org
Codechange: use std::string instead of stredup/free for stories
4 files changed with 30 insertions and 40 deletions:
0 comments (0 inline, 0 general)
src/saveload/story_sl.cpp
Show inline comments
 
@@ -35,7 +35,7 @@ static const SaveLoad _story_page_elemen
 
	SLE_CONDVAR(StoryPageElement, type,          SLE_FILE_U16 | SLE_VAR_U8,  SL_MIN_VERSION,   SLV_185),
 
	SLE_CONDVAR(StoryPageElement, type,          SLE_UINT8,                  SLV_185, SL_MAX_VERSION),
 
	    SLE_VAR(StoryPageElement, referenced_id, SLE_UINT32),
 
	    SLE_STR(StoryPageElement, text,          SLE_STR | SLF_ALLOW_CONTROL, 0),
 
	   SLE_SSTR(StoryPageElement, text,          SLE_STR | SLF_ALLOW_CONTROL),
 
};
 

	
 
struct STPEChunkHandler : ChunkHandler {
 
@@ -77,7 +77,7 @@ static const SaveLoad _story_pages_desc[
 
	    SLE_VAR(StoryPage, date,       SLE_UINT32),
 
	SLE_CONDVAR(StoryPage, company,    SLE_FILE_U16 | SLE_VAR_U8,  SL_MIN_VERSION,   SLV_185),
 
	SLE_CONDVAR(StoryPage, company,    SLE_UINT8,                  SLV_185, SL_MAX_VERSION),
 
	    SLE_STR(StoryPage, title,      SLE_STR | SLF_ALLOW_CONTROL, 0),
 
	   SLE_SSTR(StoryPage, title,      SLE_STR | SLF_ALLOW_CONTROL),
 
};
 

	
 
struct STPAChunkHandler : ChunkHandler {
src/story.cpp
Show inline comments
 
@@ -47,16 +47,16 @@ INSTANTIATE_POOL_METHODS(StoryPage)
 
 * @param text The text parameter of the DoCommand proc
 
 * @return true, if and only if the given parameters are valid for the given page element type and page id.
 
 */
 
static bool VerifyElementContentParameters(StoryPageID page_id, StoryPageElementType type, TileIndex tile, uint32 reference, const char *text)
 
static bool VerifyElementContentParameters(StoryPageID page_id, StoryPageElementType type, TileIndex tile, uint32 reference, const std::string &text)
 
{
 
	StoryPageButtonData button_data{ reference };
 

	
 
	switch (type) {
 
		case SPET_TEXT:
 
			if (StrEmpty(text)) return false;
 
			if (text.empty()) return false;
 
			break;
 
		case SPET_LOCATION:
 
			if (StrEmpty(text)) return false;
 
			if (text.empty()) return false;
 
			if (!IsValidTile(tile)) return false;
 
			break;
 
		case SPET_GOAL:
 
@@ -91,14 +91,14 @@ static bool VerifyElementContentParamete
 
 * @param reference The reference parameter of the DoCommand proc (p2)
 
 * @param text The text parameter of the DoCommand proc
 
 */
 
static void UpdateElement(StoryPageElement &pe, TileIndex tile, uint32 reference, const char *text)
 
static void UpdateElement(StoryPageElement &pe, TileIndex tile, uint32 reference, const std::string &text)
 
{
 
	switch (pe.type) {
 
		case SPET_TEXT:
 
			pe.text = stredup(text);
 
			pe.text = text;
 
			break;
 
		case SPET_LOCATION:
 
			pe.text = stredup(text);
 
			pe.text = text;
 
			pe.referenced_id = tile;
 
			break;
 
		case SPET_GOAL:
 
@@ -107,7 +107,7 @@ static void UpdateElement(StoryPageEleme
 
		case SPET_BUTTON_PUSH:
 
		case SPET_BUTTON_TILE:
 
		case SPET_BUTTON_VEHICLE:
 
			pe.text = stredup(text);
 
			pe.text = text;
 
			pe.referenced_id = reference;
 
			break;
 
		default: NOT_REACHED();
 
@@ -220,11 +220,7 @@ std::tuple<CommandCost, StoryPageID> Cmd
 
		s->sort_value = _story_page_next_sort_value;
 
		s->date = TimerGameCalendar::date;
 
		s->company = company;
 
		if (text.empty()) {
 
			s->title = nullptr;
 
		} else {
 
			s->title = stredup(text.c_str());
 
		}
 
		s->title = text;
 

	
 
		InvalidateWindowClassesData(WC_STORY_BOOK, -1);
 
		if (StoryPage::GetNumItems() == 1) InvalidateWindowData(WC_MAIN_TOOLBAR, 0);
 
@@ -259,7 +255,7 @@ std::tuple<CommandCost, StoryPageElement
 

	
 
	if (_current_company != OWNER_DEITY) return { CMD_ERROR, INVALID_STORY_PAGE_ELEMENT };
 
	if (!StoryPage::IsValidID(page_id)) return { CMD_ERROR, INVALID_STORY_PAGE_ELEMENT };
 
	if (!VerifyElementContentParameters(page_id, type, tile, reference, text.c_str())) return { CMD_ERROR, INVALID_STORY_PAGE_ELEMENT };
 
	if (!VerifyElementContentParameters(page_id, type, tile, reference, text)) return { CMD_ERROR, INVALID_STORY_PAGE_ELEMENT };
 

	
 

	
 
	if (flags & DC_EXEC) {
 
@@ -272,7 +268,7 @@ std::tuple<CommandCost, StoryPageElement
 
		pe->sort_value = _story_page_element_next_sort_value;
 
		pe->type = type;
 
		pe->page = page_id;
 
		UpdateElement(*pe, tile, reference, text.c_str());
 
		UpdateElement(*pe, tile, reference, text);
 

	
 
		InvalidateWindowClassesData(WC_STORY_BOOK, page_id);
 

	
 
@@ -301,10 +297,10 @@ CommandCost CmdUpdateStoryPageElement(Do
 
	StoryPageID page_id = pe->page;
 
	StoryPageElementType type = pe->type;
 

	
 
	if (!VerifyElementContentParameters(page_id, type, tile, reference, text.c_str())) return CMD_ERROR;
 
	if (!VerifyElementContentParameters(page_id, type, tile, reference, text)) return CMD_ERROR;
 

	
 
	if (flags & DC_EXEC) {
 
		UpdateElement(*pe, tile, reference, text.c_str());
 
		UpdateElement(*pe, tile, reference, text);
 
		InvalidateWindowClassesData(WC_STORY_BOOK, pe->page);
 
	}
 

	
 
@@ -325,12 +321,7 @@ CommandCost CmdSetStoryPageTitle(DoComma
 

	
 
	if (flags & DC_EXEC) {
 
		StoryPage *p = StoryPage::Get(page_id);
 
		free(p->title);
 
		if (text.empty()) {
 
			p->title = nullptr;
 
		} else {
 
			p->title = stredup(text.c_str());
 
		}
 
		p->title = text;
 

	
 
		InvalidateWindowClassesData(WC_STORY_BOOK, page_id);
 
	}
src/story_base.h
Show inline comments
 
@@ -147,7 +147,7 @@ struct StoryPageElement : StoryPageEleme
 
	StoryPageElementType type; ///< Type of page element
 

	
 
	uint32 referenced_id;      ///< Id of referenced object (location, goal etc.)
 
	char *text;                ///< Static content text of page element
 
	std::string text;          ///< Static content text of page element
 

	
 
	/**
 
	 * We need an (empty) constructor so struct isn't zeroed (as C++ standard states)
 
@@ -157,16 +157,16 @@ struct StoryPageElement : StoryPageEleme
 
	/**
 
	 * (Empty) destructor has to be defined else operator delete might be called with nullptr parameter
 
	 */
 
	inline ~StoryPageElement() { free(this->text); }
 
	inline ~StoryPageElement() { }
 
};
 

	
 
/** Struct about stories, current and completed */
 
struct StoryPage : StoryPagePool::PoolItem<&_story_page_pool> {
 
	uint32 sort_value;   ///< A number that increases for every created story page. Used for sorting. The id of a story page is the pool index.
 
	uint32 sort_value;            ///< A number that increases for every created story page. Used for sorting. The id of a story page is the pool index.
 
	TimerGameCalendar::Date date; ///< Date when the page was created.
 
	CompanyID company;   ///< StoryPage is for a specific company; INVALID_COMPANY if it is global
 
	CompanyID company;            ///< StoryPage is for a specific company; INVALID_COMPANY if it is global
 

	
 
	char *title;         ///< Title of story page
 
	std::string title;            ///< Title of story page
 

	
 
	/**
 
	 * We need an (empty) constructor so struct isn't zeroed (as C++ standard states)
 
@@ -183,7 +183,6 @@ struct StoryPage : StoryPagePool::PoolIt
 
				if (spe->page == this->index) delete spe;
 
			}
 
		}
 
		free(this->title);
 
	}
 
};
 

	
src/story_gui.cpp
Show inline comments
 
@@ -60,7 +60,7 @@ protected:
 
	GUIStoryPageList story_pages;      ///< Sorted list of pages.
 
	GUIStoryPageElementList story_page_elements; ///< Sorted list of page elements that belong to the current page.
 
	StoryPageID selected_page_id;      ///< Pool index of selected page.
 
	char selected_generic_title[255];  ///< If the selected page doesn't have a custom title, this buffer is used to store a generic page title.
 
	std::string selected_generic_title;  ///< If the selected page doesn't have a custom title, this buffer is used to store a generic page title.
 

	
 
	StoryPageElementID active_button_id; ///< Which button element the player is currently using
 

	
 
@@ -188,9 +188,9 @@ protected:
 
	{
 
		/* Generate generic title if selected page have no custom title. */
 
		StoryPage *page = this->GetSelPage();
 
		if (page != nullptr && page->title == nullptr) {
 
		if (page != nullptr && page->title.empty()) {
 
			SetDParam(0, GetSelPageNum() + 1);
 
			GetString(selected_generic_title, STR_STORY_BOOK_GENERIC_PAGE_ITEM, lastof(selected_generic_title));
 
			selected_generic_title = GetString(STR_STORY_BOOK_GENERIC_PAGE_ITEM);
 
		}
 

	
 
		this->story_page_elements.ForceRebuild();
 
@@ -255,7 +255,7 @@ protected:
 
		for (const StoryPage *p : this->story_pages) {
 
			bool current_page = p->index == this->selected_page_id;
 
			DropDownListStringItem *item = nullptr;
 
			if (p->title != nullptr) {
 
			if (!p->title.empty()) {
 
				item = new DropDownListCharStringItem(p->title, p->index, current_page);
 
			} else {
 
				/* No custom title => use a generic page title with page number. */
 
@@ -295,7 +295,7 @@ protected:
 

	
 
		/* Title lines */
 
		height += FONT_HEIGHT_NORMAL; // Date always use exactly one line.
 
		SetDParamStr(0, page->title != nullptr ? page->title : this->selected_generic_title);
 
		SetDParamStr(0, !page->title.empty() ? page->title : this->selected_generic_title);
 
		height += GetStringHeight(STR_STORY_BOOK_TITLE, max_width);
 

	
 
		return height;
 
@@ -616,7 +616,7 @@ public:
 
		this->owner = (Owner)this->window_number;
 

	
 
		/* Initialize selected vars. */
 
		this->selected_generic_title[0] = '\0';
 
		this->selected_generic_title.clear();
 
		this->selected_page_id = INVALID_STORY_PAGE;
 

	
 
		this->active_button_id = INVALID_STORY_PAGE_ELEMENT;
 
@@ -655,7 +655,7 @@ public:
 
		switch (widget) {
 
			case WID_SB_SEL_PAGE: {
 
				StoryPage *page = this->GetSelPage();
 
				SetDParamStr(0, page != nullptr && page->title != nullptr ? page->title : this->selected_generic_title);
 
				SetDParamStr(0, page != nullptr && !page->title.empty() ? page->title : this->selected_generic_title);
 
				break;
 
			}
 
			case WID_SB_CAPTION:
 
@@ -713,7 +713,7 @@ public:
 
		y_offset += line_height;
 

	
 
		/* Title */
 
		SetDParamStr(0, page->title != nullptr ? page->title : this->selected_generic_title);
 
		SetDParamStr(0, !page->title.empty() ? page->title : this->selected_generic_title);
 
		y_offset = DrawStringMultiLine(0, fr.right, y_offset, fr.bottom, STR_STORY_BOOK_TITLE, TC_BLACK, SA_TOP | SA_HOR_CENTER);
 

	
 
		/* Page elements */
 
@@ -773,7 +773,7 @@ public:
 
				for (size_t i = 0; i < this->story_pages.size(); i++) {
 
					const StoryPage *s = this->story_pages[i];
 

	
 
					if (s->title != nullptr) {
 
					if (!s->title.empty()) {
 
						SetDParamStr(0, s->title);
 
					} else {
 
						SetDParamStr(0, this->selected_generic_title);
 
@@ -877,7 +877,7 @@ public:
 

	
 
			/* Was the last page removed? */
 
			if (this->story_pages.size() == 0) {
 
				this->selected_generic_title[0] = '\0';
 
				this->selected_generic_title.clear();
 
			}
 

	
 
			/* Verify page selection. */
0 comments (0 inline, 0 general)