OpenTTD Source 20260621-master-g720d10536d
currency.cpp
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 <https://www.gnu.org/licenses/old-licenses/gpl-2.0>.
6 */
7
9
10#include "stdafx.h"
11#include "core/bitmath_func.hpp"
12
13#include "currency_func.h"
14#include "news_func.h"
15#include "settings_type.h"
16#include "string_type.h"
17#include "strings_func.h"
18#include "timer/timer.h"
19#include "timer/timer_game_calendar.h"
20
21#include "table/strings.h"
22
23#include "safeguards.h"
24
25 /* exchange rate prefix code
26 * | separator | postfix | symbol_pos
27 * | | Euro year | | | | name
28 * | | | | | | | | */
30static const std::array<CurrencySpec, CURRENCY_END> origin_currency_specs = {{
31 { 1, "", CF_NOEURO, "\u00a3", "", "GBP", CurrencySymbolPosition::Prefix, STR_GAME_OPTIONS_CURRENCY_GBP },
32 { 2, "", CF_NOEURO, "$", "", "USD", CurrencySymbolPosition::Prefix, STR_GAME_OPTIONS_CURRENCY_USD },
33 { 2, "", CF_ISEURO, "\u20ac", "", "EUR", CurrencySymbolPosition::Prefix, STR_GAME_OPTIONS_CURRENCY_EUR },
34 { 220, "", CF_NOEURO, "\u00a5", "", "JPY", CurrencySymbolPosition::Prefix, STR_GAME_OPTIONS_CURRENCY_JPY },
35 { 27, "", TimerGameCalendar::Year{2002}, "", NBSP "S.", "ATS", CurrencySymbolPosition::Suffix, STR_GAME_OPTIONS_CURRENCY_ATS },
36 { 81, "", TimerGameCalendar::Year{2002}, "BEF" NBSP, "", "BEF", CurrencySymbolPosition::Prefix, STR_GAME_OPTIONS_CURRENCY_BEF },
37 { 2, "", CF_NOEURO, "CHF" NBSP, "", "CHF", CurrencySymbolPosition::Prefix, STR_GAME_OPTIONS_CURRENCY_CHF },
38 { 41, "", CF_NOEURO, "", NBSP "K\u010d", "CZK", CurrencySymbolPosition::Suffix, STR_GAME_OPTIONS_CURRENCY_CZK },
39 { 4, "", TimerGameCalendar::Year{2002}, "DM" NBSP, "", "DEM", CurrencySymbolPosition::Prefix, STR_GAME_OPTIONS_CURRENCY_DEM },
40 { 11, "", CF_NOEURO, "", NBSP "kr", "DKK", CurrencySymbolPosition::Suffix, STR_GAME_OPTIONS_CURRENCY_DKK },
41 { 333, "", TimerGameCalendar::Year{2002}, "Pts" NBSP, "", "ESP", CurrencySymbolPosition::Prefix, STR_GAME_OPTIONS_CURRENCY_ESP },
42 { 12, "", TimerGameCalendar::Year{2002}, "", NBSP "mk", "FIM", CurrencySymbolPosition::Suffix, STR_GAME_OPTIONS_CURRENCY_FIM },
43 { 13, "", TimerGameCalendar::Year{2002}, "FF" NBSP, "", "FRF", CurrencySymbolPosition::Prefix, STR_GAME_OPTIONS_CURRENCY_FRF },
44 { 681, "", TimerGameCalendar::Year{2002}, "", "Dr.", "GRD", CurrencySymbolPosition::Suffix, STR_GAME_OPTIONS_CURRENCY_GRD },
45 { 378, "", CF_NOEURO, "", NBSP "Ft", "HUF", CurrencySymbolPosition::Suffix, STR_GAME_OPTIONS_CURRENCY_HUF },
46 { 130, "", CF_NOEURO, "", NBSP "Kr", "ISK", CurrencySymbolPosition::Suffix, STR_GAME_OPTIONS_CURRENCY_ISK },
47 { 3873, "", TimerGameCalendar::Year{2002}, "", NBSP "L.", "ITL", CurrencySymbolPosition::Suffix, STR_GAME_OPTIONS_CURRENCY_ITL },
48 { 4, "", TimerGameCalendar::Year{2002}, "NLG" NBSP, "", "NLG", CurrencySymbolPosition::Prefix, STR_GAME_OPTIONS_CURRENCY_NLG },
49 { 12, "", CF_NOEURO, "", NBSP "Kr", "NOK", CurrencySymbolPosition::Suffix, STR_GAME_OPTIONS_CURRENCY_NOK },
50 { 6, "", CF_NOEURO, "", NBSP "z\u0142", "PLN", CurrencySymbolPosition::Suffix, STR_GAME_OPTIONS_CURRENCY_PLN },
51 { 5, "", CF_NOEURO, "", NBSP "Lei", "RON", CurrencySymbolPosition::Suffix, STR_GAME_OPTIONS_CURRENCY_RON },
52 { 50, "", CF_NOEURO, "", NBSP "p", "RUR", CurrencySymbolPosition::Suffix, STR_GAME_OPTIONS_CURRENCY_RUR },
53 { 479, "", TimerGameCalendar::Year{2007}, "", NBSP "SIT", "SIT", CurrencySymbolPosition::Suffix, STR_GAME_OPTIONS_CURRENCY_SIT },
54 { 13, "", CF_NOEURO, "", NBSP "Kr", "SEK", CurrencySymbolPosition::Suffix, STR_GAME_OPTIONS_CURRENCY_SEK },
55 { 3, "", CF_NOEURO, "", NBSP "TL", "TRY", CurrencySymbolPosition::Suffix, STR_GAME_OPTIONS_CURRENCY_TRY },
56 { 60, "", TimerGameCalendar::Year{2009}, "", NBSP "Sk", "SKK", CurrencySymbolPosition::Suffix, STR_GAME_OPTIONS_CURRENCY_SKK },
57 { 4, "", CF_NOEURO, "R$" NBSP, "", "BRL", CurrencySymbolPosition::Prefix, STR_GAME_OPTIONS_CURRENCY_BRL },
58 { 31, "", TimerGameCalendar::Year{2011}, "", NBSP "EEK", "EEK", CurrencySymbolPosition::Suffix, STR_GAME_OPTIONS_CURRENCY_EEK },
59 { 4, "", TimerGameCalendar::Year{2015}, "", NBSP "Lt", "LTL", CurrencySymbolPosition::Suffix, STR_GAME_OPTIONS_CURRENCY_LTL },
60 { 1850, "", CF_NOEURO, "\u20a9", "", "KRW", CurrencySymbolPosition::Prefix, STR_GAME_OPTIONS_CURRENCY_KRW },
61 { 13, "", CF_NOEURO, "R" NBSP, "", "ZAR", CurrencySymbolPosition::Prefix, STR_GAME_OPTIONS_CURRENCY_ZAR },
62 { 1, "", CF_NOEURO, "", "", "", {CurrencySymbolPosition::Prefix, CurrencySymbolPosition::Suffix}, STR_GAME_OPTIONS_CURRENCY_CUSTOM },
63 { 3, "", CF_NOEURO, "", NBSP "GEL", "GEL", CurrencySymbolPosition::Suffix, STR_GAME_OPTIONS_CURRENCY_GEL },
64 { 4901, "", CF_NOEURO, "", NBSP "Rls", "IRR", CurrencySymbolPosition::Suffix, STR_GAME_OPTIONS_CURRENCY_IRR },
65 { 80, "", CF_NOEURO, "", NBSP "rub", "RUB", CurrencySymbolPosition::Suffix, STR_GAME_OPTIONS_CURRENCY_RUB },
66 { 24, "", CF_NOEURO, "$", "", "MXN", CurrencySymbolPosition::Prefix, STR_GAME_OPTIONS_CURRENCY_MXN },
67 { 40, "", CF_NOEURO, "NTD" NBSP, "", "NTD", CurrencySymbolPosition::Prefix, STR_GAME_OPTIONS_CURRENCY_NTD },
68 { 8, "", CF_NOEURO, "\u00a5", "", "CNY", CurrencySymbolPosition::Prefix, STR_GAME_OPTIONS_CURRENCY_CNY },
69 { 10, "", CF_NOEURO, "HKD" NBSP, "", "HKD", CurrencySymbolPosition::Prefix, STR_GAME_OPTIONS_CURRENCY_HKD },
70 { 90, "", CF_NOEURO, "\u20b9", "", "INR", CurrencySymbolPosition::Prefix, STR_GAME_OPTIONS_CURRENCY_INR },
71 { 19, "", CF_NOEURO, "Rp", "", "IDR", CurrencySymbolPosition::Prefix, STR_GAME_OPTIONS_CURRENCY_IDR },
72 { 5, "", CF_NOEURO, "RM", "", "MYR", CurrencySymbolPosition::Prefix, STR_GAME_OPTIONS_CURRENCY_MYR },
73 { 1, "", TimerGameCalendar::Year{2014}, "", NBSP "Ls", "LVL", CurrencySymbolPosition::Suffix, STR_GAME_OPTIONS_CURRENCY_LVL },
74 { 400, "", TimerGameCalendar::Year{2002}, "", "$00", "PTE", CurrencySymbolPosition::Suffix, STR_GAME_OPTIONS_CURRENCY_PTE },
75 { 50, "", CF_NOEURO, "", NBSP "\u20B4", "UAH", CurrencySymbolPosition::Suffix, STR_GAME_OPTIONS_CURRENCY_UAH },
76 {35000, "", CF_NOEURO, "", NBSP "\u20AB", "VND", CurrencySymbolPosition::Suffix, STR_GAME_OPTIONS_CURRENCY_VND },
77}};
78
80std::array<CurrencySpec, CURRENCY_END> _currency_specs;
81
110
119uint8_t GetNewgrfCurrencyIdConverted(uint8_t grfcurr_id)
120{
121 return (grfcurr_id >= lengthof(TTDPatch_To_OTTDIndex)) ? grfcurr_id : TTDPatch_To_OTTDIndex[grfcurr_id];
122}
123
128Currencies GetMaskOfAllowedCurrencies()
129{
130 Currencies mask{};
131
132 for (Currency i : EnumRange(CURRENCY_END)) {
133 TimerGameCalendar::Year to_euro = _currency_specs[i].to_euro;
134
135 if (to_euro != CF_NOEURO && to_euro != CF_ISEURO && TimerGameCalendar::year >= to_euro) continue;
136 if (to_euro == CF_ISEURO && TimerGameCalendar::year < 2000) continue;
137 mask.Set(i);
138 }
139 mask.Set(CURRENCY_CUSTOM); // always allow custom currency
140 return mask;
141}
142
146static const IntervalTimer<TimerGameCalendar> _check_switch_to_euro({TimerGameCalendar::Trigger::Year, TimerGameCalendar::Priority::None}, [](auto)
147{
148 if (_currency_specs[_settings_game.locale.currency].to_euro != CF_NOEURO &&
149 _currency_specs[_settings_game.locale.currency].to_euro != CF_ISEURO &&
150 TimerGameCalendar::year >= _currency_specs[_settings_game.locale.currency].to_euro) {
151 _settings_game.locale.currency = 2; // this is the index of euro above.
152 AddNewsItem(GetEncodedString(STR_NEWS_EURO_INTRODUCTION), NewsType::Economy, NewsStyle::Normal, {});
153 }
154});
155
162void ResetCurrencies(bool preserve_custom)
163{
164 for (Currency i : EnumRange(CURRENCY_END)) {
165 if (preserve_custom && i == CURRENCY_CUSTOM) continue;
166 _currency_specs[i] = origin_currency_specs[i];
167 }
168}
bitmath_func.hpp
Functions related to bit mathematics.
BaseBitSet::Set
constexpr Timpl & Set()
Set all bits.
Definition base_bitset_type.hpp:43
EnumRange
Iterate a range of enum values.
Definition enum_type.hpp:209
IntervalTimer
An interval timer will fire every interval, and will continue to fire until it is deleted.
Definition timer.h:76
TimerGameCalendar::year
static Year year
Current year, starting at 0.
Definition timer_game_calendar.h:28
TimerGame< struct Calendar >::Year
StrongType::Typedef< int32_t, struct YearTag< struct Calendar >, StrongType::Compare, StrongType::Integer > Year
Definition timer_game_common.h:44
GetMaskOfAllowedCurrencies
Currencies GetMaskOfAllowedCurrencies()
get a mask of the allowed currencies depending on the year
Definition currency.cpp:128
ResetCurrencies
void ResetCurrencies(bool preserve_custom)
Will fill _currency_specs array with default values from origin_currency_specs Called only from newgr...
Definition currency.cpp:162
origin_currency_specs
static const std::array< CurrencySpec, CURRENCY_END > origin_currency_specs
The original currency specifications.
Definition currency.cpp:30
TTDPatch_To_OTTDIndex
const uint8_t TTDPatch_To_OTTDIndex[]
This array represent the position of OpenTTD's currencies, compared to TTDPatch's ones.
Definition currency.cpp:88
GetNewgrfCurrencyIdConverted
uint8_t GetNewgrfCurrencyIdConverted(uint8_t grfcurr_id)
Will return the ottd's index correspondence to the ttdpatch's id.
Definition currency.cpp:119
_currency_specs
std::array< CurrencySpec, CURRENCY_END > _currency_specs
Array of currencies used by the system.
Definition currency.cpp:80
_check_switch_to_euro
static const IntervalTimer< TimerGameCalendar > _check_switch_to_euro({TimerGameCalendar::Trigger::Year, TimerGameCalendar::Priority::None}, [](auto) { if(_currency_specs[_settings_game.locale.currency].to_euro !=CF_NOEURO &&_currency_specs[_settings_game.locale.currency].to_euro !=CF_ISEURO &&TimerGameCalendar::year >=_currency_specs[_settings_game.locale.currency].to_euro) { _settings_game.locale.currency=2;AddNewsItem(GetEncodedString(STR_NEWS_EURO_INTRODUCTION), NewsType::Economy, NewsStyle::Normal, {});} })
Verify if the currency chosen by the user is about to be converted to Euro.
currency_func.h
Functions to handle different currencies.
Currencies
EnumBitSet< Currency, uint64_t, CURRENCY_END > Currencies
Bitmask of Currency.
Definition currency_type.h:76
Currency
Currency
This enum gives the currencies a unique id which must be maintained for savegame compatibility and in...
Definition currency_type.h:25
CURRENCY_GBP
@ CURRENCY_GBP
British Pound.
Definition currency_type.h:26
CURRENCY_ESP
@ CURRENCY_ESP
Spanish Peseta.
Definition currency_type.h:36
CURRENCY_FRF
@ CURRENCY_FRF
French Franc.
Definition currency_type.h:38
CURRENCY_SEK
@ CURRENCY_SEK
Swedish Krona.
Definition currency_type.h:49
CURRENCY_GRD
@ CURRENCY_GRD
Greek Drachma.
Definition currency_type.h:39
CURRENCY_JPY
@ CURRENCY_JPY
Japanese Yen.
Definition currency_type.h:29
CURRENCY_DKK
@ CURRENCY_DKK
Danish Krona.
Definition currency_type.h:35
CURRENCY_ATS
@ CURRENCY_ATS
Austrian Schilling.
Definition currency_type.h:30
CURRENCY_USD
@ CURRENCY_USD
US Dollar.
Definition currency_type.h:27
CURRENCY_END
@ CURRENCY_END
always the last item
Definition currency_type.h:72
CURRENCY_EUR
@ CURRENCY_EUR
Euro.
Definition currency_type.h:28
CURRENCY_FIM
@ CURRENCY_FIM
Finish Markka.
Definition currency_type.h:37
CURRENCY_DEM
@ CURRENCY_DEM
Deutsche Mark.
Definition currency_type.h:34
CURRENCY_BEF
@ CURRENCY_BEF
Belgian Franc.
Definition currency_type.h:31
CURRENCY_ITL
@ CURRENCY_ITL
Italian Lira.
Definition currency_type.h:42
CURRENCY_PLN
@ CURRENCY_PLN
Polish Zloty.
Definition currency_type.h:45
CURRENCY_RUR
@ CURRENCY_RUR
Russian Rouble.
Definition currency_type.h:47
CURRENCY_CHF
@ CURRENCY_CHF
Swiss Franc.
Definition currency_type.h:32
CURRENCY_CUSTOM
@ CURRENCY_CUSTOM
Custom currency.
Definition currency_type.h:57
CURRENCY_NLG
@ CURRENCY_NLG
Dutch Gulden.
Definition currency_type.h:43
CURRENCY_HUF
@ CURRENCY_HUF
Hungarian Forint.
Definition currency_type.h:40
CurrencySymbolPosition::Suffix
@ Suffix
Show the suffix value.
Definition currency_type.h:81
CurrencySymbolPosition::Prefix
@ Prefix
Show the prefix value.
Definition currency_type.h:80
CF_ISEURO
static constexpr TimerGameCalendar::Year CF_ISEURO
Currency is the Euro.
Definition currency_type.h:17
CF_NOEURO
static constexpr TimerGameCalendar::Year CF_NOEURO
Currency never switches to the Euro (as far as known).
Definition currency_type.h:16
news_func.h
Functions related to news.
AddNewsItem
void AddNewsItem(EncodedString &&headline, NewsType type, NewsStyle style, NewsFlags flags, NewsReference ref1={}, NewsReference ref2={}, std::unique_ptr< NewsAllocatedData > &&data=nullptr, AdviceType advice_type=AdviceType::Invalid)
Add a new newsitem to be shown.
Definition news_gui.cpp:917
NewsType::Economy
@ Economy
Economic changes (recession, industry up/dowm).
Definition news_type.h:37
NewsStyle::Normal
@ Normal
Normal news item. (Newspaper with text only).
Definition news_type.h:80
safeguards.h
A number of safeguards to prevent using unsafe methods.
_settings_game
GameSettings _settings_game
Game settings of a running game or the scenario editor.
Definition settings.cpp:61
settings_type.h
Types related to global configuration settings.
stdafx.h
Definition of base types and functions in a cross-platform compatible way.
lengthof
#define lengthof(array)
Return the length of an fixed size array.
Definition stdafx.h:271
string_type.h
Types for strings.
NBSP
#define NBSP
A non-breaking space.
Definition string_type.h:16
GetEncodedString
EncodedString GetEncodedString(StringID str)
Encode a string with no parameters into an encoded string.
Definition strings.cpp:90
strings_func.h
Functions related to OTTD's strings.
timer.h
Definition of Interval and OneShot timers.
timer_game_calendar.h
Definition of the game-calendar-timer.