summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authoryexo <yexo@openttd.org>2010-02-25 20:00:11 +0000
committeryexo <yexo@openttd.org>2010-02-25 20:00:11 +0000
commit4377b5fd44f5267f89f565e46cdb3646cf322a93 (patch)
tree56b8ceaec12fb17b68cc9d28be3d3f451bfea5d5
parente2aed3664da1cc00da5c0676e71462323b021196 (diff)
downloadopenttd-4377b5fd44f5267f89f565e46cdb3646cf322a93.tar.xz
(svn r19254) -Codechange: simplify newgrf text code by introducing a few helper functions
-rw-r--r--src/newgrf_config.cpp2
-rw-r--r--src/newgrf_text.cpp104
2 files changed, 66 insertions, 40 deletions
diff --git a/src/newgrf_config.cpp b/src/newgrf_config.cpp
index 28e67e7f5..167668424 100644
--- a/src/newgrf_config.cpp
+++ b/src/newgrf_config.cpp
@@ -36,7 +36,7 @@ GRFError::~GRFError()
{
free(this->custom_message);
free(this->data);
- }
+}
/**
* Update the palettes of the graphics from the config file.
diff --git a/src/newgrf_text.cpp b/src/newgrf_text.cpp
index a0f5cb9d7..7cb94bd0a 100644
--- a/src/newgrf_text.cpp
+++ b/src/newgrf_text.cpp
@@ -326,6 +326,28 @@ char *TranslateTTDPatchCodes(uint32 grfid, const char *str)
return tmp;
}
+/**
+ * Add a GRFText to a GRFText list.
+ * @param list The list where the text should be added to.
+ * @param text_to_add The GRFText to add to the list.
+ */
+void AddGRFTextToList(GRFText **list, GRFText *text_to_add)
+{
+ GRFText **ptext, *text;
+
+ /* Loop through all languages and see if we can replace a string */
+ for (ptext = list; (text = *ptext) != NULL; ptext = &text->next) {
+ if (text->langid == text_to_add->langid) {
+ text_to_add->next = text->next;
+ *ptext = text_to_add;
+ delete text;
+ return;
+ }
+ }
+
+ /* If a string wasn't replaced, then we must append the new string */
+ *ptext = text_to_add;
+}
/**
* Add the new read string into our structure.
@@ -375,24 +397,8 @@ StringID AddGRFString(uint32 grfid, uint16 stringid, byte langid_to_add, bool ne
_grf_text[id].grfid = grfid;
_grf_text[id].stringid = stringid;
_grf_text[id].def_string = def_string;
- _grf_text[id].textholder = newtext;
- } else {
- GRFText **ptext, *text;
- bool replaced = false;
-
- /* Loop through all languages and see if we can replace a string */
- for (ptext = &_grf_text[id].textholder; (text = *ptext) != NULL; ptext = &text->next) {
- if (text->langid != langid_to_add) continue;
- newtext->next = text->next;
- *ptext = newtext;
- delete text;
- replaced = true;
- break;
- }
-
- /* If a string wasn't replaced, then we must append the new string */
- if (!replaced) *ptext = newtext;
}
+ AddGRFTextToList(&_grf_text[id].textholder, newtext);
grfmsg(3, "Added 0x%X: grfid %08X string 0x%X lang 0x%X string '%s'", id, grfid, stringid, newtext->langid, newtext->text);
@@ -422,31 +428,43 @@ StringID GetGRFStringID(uint32 grfid, uint16 stringid)
}
-const char *GetGRFStringPtr(uint16 stringid)
+/**
+ * Get a C-string from a GRFText-list. If there is a translation for the
+ * current language it is returned, otherwise the default translation
+ * is returned. If there is neither a default nor a translation for the
+ * current language NULL is returned.
+ * @param text The GRFText to get the string from.
+ */
+const char *GetGRFStringFromGRFText(const GRFText *text)
{
- const GRFText *default_text = NULL;
- const GRFText *search_text;
-
- assert(_grf_text[stringid].grfid != 0);
-
- /* Remember this grfid in case the string has included text */
- _last_grfid = _grf_text[stringid].grfid;
+ const char *default_text = NULL;
/* Search the list of lang-strings of this stringid for current lang */
- for (search_text = _grf_text[stringid].textholder; search_text != NULL; search_text = search_text->next) {
- if (search_text->langid == _currentLangID) {
- return search_text->text;
- }
+ for (; text != NULL; text = text->next) {
+ if (text->langid == _currentLangID) return text->text;
/* If the current string is English or American, set it as the
* fallback language if the specific language isn't available. */
- if (search_text->langid == GRFLX_UNSPECIFIED || (default_text == NULL && (search_text->langid == GRFLX_ENGLISH || search_text->langid == GRFLX_AMERICAN))) {
- default_text = search_text;
+ if (text->langid == GRFLX_UNSPECIFIED || (default_text == NULL && (text->langid == GRFLX_ENGLISH || text->langid == GRFLX_AMERICAN))) {
+ default_text = text->text;
}
}
- /* If there is a fallback string, return that */
- if (default_text != NULL) return default_text->text;
+ return default_text;
+}
+
+/**
+ * Get a C-string from a stringid set by a newgrf.
+ */
+const char *GetGRFStringPtr(uint16 stringid)
+{
+ assert(_grf_text[stringid].grfid != 0);
+
+ /* Remember this grfid in case the string has included text */
+ _last_grfid = _grf_text[stringid].grfid;
+
+ const char *str = GetGRFStringFromGRFText(_grf_text[stringid].textholder);
+ if (str != NULL) return str;
/* Use the default string ID if the fallback string isn't available */
return GetStringPtr(_grf_text[stringid].def_string);
@@ -480,6 +498,19 @@ bool CheckGrfLangID(byte lang_id, byte grf_version)
}
/**
+ * Delete all items of a linked GRFText list.
+ * @param grftext the head of the list to delete
+ */
+void CleanUpGRFText(GRFText *grftext)
+{
+ while (grftext != NULL) {
+ GRFText *grftext2 = grftext->next;
+ delete grftext;
+ grftext = grftext2;
+ }
+}
+
+/**
* House cleaning.
* Remove all strings and reset the text counter.
*/
@@ -488,12 +519,7 @@ void CleanUpStrings()
uint id;
for (id = 0; id < _num_grf_texts; id++) {
- GRFText *grftext = _grf_text[id].textholder;
- while (grftext != NULL) {
- GRFText *grftext2 = grftext->next;
- delete grftext;
- grftext = grftext2;
- }
+ CleanUpGRFText(_grf_text[id].textholder);
_grf_text[id].grfid = 0;
_grf_text[id].stringid = 0;
_grf_text[id].textholder = NULL;