OpenTTD Source  20241120-master-g6d3adc6169
strings_func.h
Go to the documentation of this file.
1 /*
2  * This file is part of OpenTTD.
3  * OpenTTD 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, version 2.
4  * OpenTTD 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.
5  * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
6  */
7 
10 #ifndef STRINGS_FUNC_H
11 #define STRINGS_FUNC_H
12 
13 #include "strings_type.h"
14 #include "string_type.h"
15 #include "gfx_type.h"
16 #include "core/bitmath_func.hpp"
18 #include "vehicle_type.h"
19 
26 {
27  StringTab result = (StringTab)(str >> TAB_SIZE_BITS);
28  if (result >= TEXT_TAB_NEWGRF_START) return TEXT_TAB_NEWGRF_START;
30  return result;
31 }
32 
38 inline uint GetStringIndex(StringID str)
39 {
40  return str - (GetStringTab(str) << TAB_SIZE_BITS);
41 }
42 
49 inline StringID MakeStringID(StringTab tab, uint index)
50 {
51  if (tab == TEXT_TAB_NEWGRF_START) {
52  assert(index < TAB_SIZE_NEWGRF);
53  } else if (tab == TEXT_TAB_GAMESCRIPT_START) {
54  assert(index < TAB_SIZE_GAMESCRIPT);
55  } else {
56  assert(tab < TEXT_TAB_END);
57  assert(index < TAB_SIZE);
58  }
59  return (tab << TAB_SIZE_BITS) + index;
60 }
61 
62 std::string GetString(StringID string);
63 const char *GetStringPtr(StringID string);
64 void AppendStringInPlace(std::string &result, StringID string);
65 
66 uint ConvertKmhishSpeedToDisplaySpeed(uint speed, VehicleType type);
67 uint ConvertDisplaySpeedToKmhishSpeed(uint speed, VehicleType type);
68 
75 inline int64_t PackVelocity(uint speed, VehicleType type)
76 {
77  /* Vehicle type is a byte, so packed into the top 8 bits of the 64-bit
78  * parameter, although only values from 0-3 are relevant. */
79  return speed | (static_cast<uint64_t>(type) << 56);
80 }
81 
82 void SetDParam(size_t n, uint64_t v);
83 void SetDParamMaxValue(size_t n, uint64_t max_value, uint min_count = 0, FontSize size = FS_NORMAL);
84 void SetDParamMaxDigits(size_t n, uint count, FontSize size = FS_NORMAL);
85 
86 template <typename T, std::enable_if_t<std::is_base_of<StrongTypedefBase, T>::value, int> = 0>
87 void SetDParam(size_t n, T v)
88 {
89  SetDParam(n, v.base());
90 }
91 
92 template <typename T, std::enable_if_t<std::is_base_of<StrongTypedefBase, T>::value, int> = 0>
93 void SetDParamMaxValue(size_t n, T max_value, uint min_count = 0, FontSize size = FS_NORMAL)
94 {
95  SetDParamMaxValue(n, max_value.base(), min_count, size);
96 }
97 
98 void SetDParamStr(size_t n, const char *str);
99 void SetDParamStr(size_t n, const std::string &str);
100 void SetDParamStr(size_t n, std::string &&str);
101 
102 void CopyInDParam(const std::span<const StringParameterData> backup);
103 void CopyOutDParam(std::vector<StringParameterData> &backup, size_t num);
104 bool HaveDParamChanged(const std::span<const StringParameterData> backup);
105 
106 uint64_t GetDParam(size_t n);
107 
109 
111 const char *GetCurrentLanguageIsoCode();
112 
117 public:
119  virtual ~MissingGlyphSearcher() = default;
120 
125  virtual std::optional<std::string_view> NextString() = 0;
126 
131  virtual FontSize DefaultSize() = 0;
132 
136  virtual void Reset() = 0;
137 
142  virtual bool Monospace() = 0;
143 
150  virtual void SetFontNames(struct FontCacheSettings *settings, const char *font_name, const void *os_data = nullptr) = 0;
151 
152  bool FindMissingGlyphs();
153 };
154 
155 void CheckForMissingGlyphs(bool base_font = true, MissingGlyphSearcher *search = nullptr);
156 
157 #endif /* STRINGS_FUNC_H */
Functions related to bit mathematics.
A searcher for missing glyphs.
Definition: strings_func.h:116
virtual void Reset()=0
Reset the search, i.e.
virtual void SetFontNames(struct FontCacheSettings *settings, const char *font_name, const void *os_data=nullptr)=0
Set the right font names.
virtual std::optional< std::string_view > NextString()=0
Get the next string to search through.
virtual FontSize DefaultSize()=0
Get the default (font) size of the string.
bool FindMissingGlyphs()
Check whether there are glyphs missing in the current language.
Definition: strings.cpp:2166
virtual bool Monospace()=0
Whether to search for a monospace font or not.
virtual ~MissingGlyphSearcher()=default
Make sure everything gets destructed right.
fluid_settings_t * settings
FluidSynth settings handle.
Definition: fluidsynth.cpp:21
Types related to the graphics and/or input devices.
FontSize
Available font sizes.
Definition: gfx_type.h:208
@ FS_NORMAL
Index of the normal font in the font tables.
Definition: gfx_type.h:209
Types for strings.
void AppendStringInPlace(std::string &result, StringID string)
Resolve the given StringID and append in place into an existing std::string with all the associated D...
Definition: strings.cpp:331
void SetDParam(size_t n, uint64_t v)
Set a string parameter v at index n in the global string parameter array.
Definition: strings.cpp:104
StringTab GetStringTab(StringID str)
Extract the StringTab from a StringID.
Definition: strings_func.h:25
uint ConvertDisplaySpeedToKmhishSpeed(uint speed, VehicleType type)
Convert the given display speed to the km/h-ish speed.
Definition: strings.cpp:902
uint64_t GetDParam(size_t n)
Get the current string parameter at index n from the global string parameter array.
Definition: strings.cpp:114
std::string GetString(StringID string)
Resolve the given StringID into a std::string with all the associated DParam lookups and formatting.
Definition: strings.cpp:319
void CheckForMissingGlyphs(bool base_font=true, MissingGlyphSearcher *search=nullptr)
Check whether the currently loaded language pack uses characters that the currently loaded font does ...
Definition: strings.cpp:2265
void CopyOutDParam(std::vector< StringParameterData > &backup, size_t num)
Copy num string parameters from the global string parameter array to the backup.
Definition: strings.cpp:171
void CopyInDParam(const std::span< const StringParameterData > backup)
Copy the parameters from the backup into the global string parameter array.
Definition: strings.cpp:159
uint ConvertKmhishSpeedToDisplaySpeed(uint speed, VehicleType type)
Convert the given km/h-ish speed to the display speed.
Definition: strings.cpp:892
void InitializeLanguagePacks()
Make a list of the available language packs.
Definition: strings.cpp:2110
bool HaveDParamChanged(const std::span< const StringParameterData > backup)
Checks whether the global string parameters have changed compared to the given backup.
Definition: strings.cpp:184
TextDirection _current_text_dir
Text direction of the currently selected language.
Definition: strings.cpp:56
const char * GetCurrentLanguageIsoCode()
Get the ISO language code of the currently loaded language.
Definition: strings.cpp:2157
int64_t PackVelocity(uint speed, VehicleType type)
Pack velocity and vehicle type for use with SCC_VELOCITY string parameter.
Definition: strings_func.h:75
StringID MakeStringID(StringTab tab, uint index)
Create a StringID.
Definition: strings_func.h:49
void SetDParamMaxValue(size_t n, uint64_t max_value, uint min_count=0, FontSize size=FS_NORMAL)
Set DParam n to some number that is suitable for string size computations.
Definition: strings.cpp:127
void SetDParamStr(size_t n, const char *str)
This function is used to "bind" a C string to a OpenTTD dparam slot.
Definition: strings.cpp:357
uint GetStringIndex(StringID str)
Extract the StringIndex from a StringID.
Definition: strings_func.h:38
void SetDParamMaxDigits(size_t n, uint count, FontSize size=FS_NORMAL)
Set DParam n to some number that is suitable for string size computations.
Definition: strings.cpp:143
Types related to strings.
TextDirection
Directions a text can go to.
Definition: strings_type.h:22
uint32_t StringID
Numeric value that represents a string, independent of the selected language.
Definition: strings_type.h:16
static const uint TAB_SIZE_NEWGRF
Number of strings for NewGRFs.
Definition: strings_type.h:52
static const uint TAB_SIZE_GAMESCRIPT
Number of strings for GameScripts.
Definition: strings_type.h:49
static const uint TAB_SIZE_BITS
Number of bits for the StringIndex within a StringTab.
Definition: strings_type.h:44
static const uint TAB_SIZE
Number of strings per StringTab.
Definition: strings_type.h:46
StringTab
StringTabs to group StringIDs.
Definition: strings_type.h:28
@ TEXT_TAB_NEWGRF_START
Start of NewGRF supplied strings.
Definition: strings_type.h:40
@ TEXT_TAB_GAMESCRIPT_START
Start of GameScript supplied strings.
Definition: strings_type.h:39
@ TEXT_TAB_END
End of language files.
Definition: strings_type.h:38
Type (helpers) for making a strong typedef that is a distinct type.
Settings for the four different fonts.
Definition: fontcache.h:200
Types related to vehicles.
VehicleType
Available vehicle types.
Definition: vehicle_type.h:21