OpenTTD Source: src/currency.h Source File

OpenTTD Source 14.0-beta3

currency.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 CURRENCY_H
11 #define CURRENCY_H
12
13 #include "timer/timer_game_calendar.h"
14 #include "string_func.h"
15 #include "strings_type.h"
16
17 static constexpr TimerGameCalendar::Year CF_NOEURO = 0;
18 static constexpr TimerGameCalendar::Year CF_ISEURO = 1;
19 static constexpr TimerGameCalendar::Year MIN_EURO_YEAR = 2000;
20
26 enum Currencies {
27 CURRENCY_GBP,
28 CURRENCY_USD,
29 CURRENCY_EUR,
30 CURRENCY_JPY,
31 CURRENCY_ATS,
32 CURRENCY_BEF,
33 CURRENCY_CHF,
34 CURRENCY_CZK,
35 CURRENCY_DEM,
36 CURRENCY_DKK,
37 CURRENCY_ESP,
38 CURRENCY_FIM,
39 CURRENCY_FRF,
40 CURRENCY_GRD,
41 CURRENCY_HUF,
42 CURRENCY_ISK,
43 CURRENCY_ITL,
44 CURRENCY_NLG,
45 CURRENCY_NOK,
46 CURRENCY_PLN,
47 CURRENCY_RON,
48 CURRENCY_RUR,
49 CURRENCY_SIT,
50 CURRENCY_SEK,
51 CURRENCY_YTL,
52 CURRENCY_SKK,
53 CURRENCY_BRL,
54 CURRENCY_EEK,
55 CURRENCY_LTL,
56 CURRENCY_KRW,
57 CURRENCY_ZAR,
58 CURRENCY_CUSTOM,
59 CURRENCY_GEL,
60 CURRENCY_IRR,
61 CURRENCY_RUB,
62 CURRENCY_MXN,
63 CURRENCY_NTD,
64 CURRENCY_CNY,
65 CURRENCY_HKD,
66 CURRENCY_INR,
67 CURRENCY_IDR,
68 CURRENCY_MYR,
69 CURRENCY_LVL,
70 CURRENCY_END,
71 };
72
74 struct CurrencySpec {
75 uint16_t rate;
76 std::string separator;
77 TimerGameCalendar::Year to_euro;
78 std::string prefix;
79 std::string suffix;
80 std::string code;
81
90 byte symbol_pos;
91 StringID name;
92
93 CurrencySpec() = default;
94
95 CurrencySpec(uint16_t rate, const char *separator, TimerGameCalendar::Year to_euro, const char *prefix, const char *suffix, const char *code, byte symbol_pos, StringID name) :
96 rate(rate), separator(separator), to_euro(to_euro), prefix(prefix), suffix(suffix), code(code), symbol_pos(symbol_pos), name(name)
97 {
98 }
99 };
100
101 extern CurrencySpec _currency_specs[CURRENCY_END];
102
103 /* XXX small hack, but makes the rest of the code a bit nicer to read */
104 #define _custom_currency (_currency_specs[CURRENCY_CUSTOM])
105 #define _currency ((const CurrencySpec*)&_currency_specs[GetGameSettings().locale.currency])
106
107 uint64_t GetMaskOfAllowedCurrencies();
108 void ResetCurrencies(bool preserve_custom = true);
109 byte GetNewgrfCurrencyIdConverted(byte grfcurr_id);
110
111 #endif /* CURRENCY_H */
_currency_specs
CurrencySpec _currency_specs[CURRENCY_END]
Array of currencies used by the system.
Definition: currency.cpp:76
CURRENCY_RON
@ CURRENCY_RON
Romenian Leu.
Definition: currency.h:47
CURRENCY_DEM
@ CURRENCY_DEM
Deutsche Mark.
Definition: currency.h:35
CURRENCY_HUF
@ CURRENCY_HUF
Hungarian Forint.
Definition: currency.h:41
timer_game_calendar.h
CURRENCY_ZAR
@ CURRENCY_ZAR
South African Rand.
Definition: currency.h:57
StringID
uint32_t StringID
Numeric value that represents a string, independent of the selected language.
Definition: strings_type.h:16
CURRENCY_IDR
@ CURRENCY_IDR
Indonesian Rupiah.
Definition: currency.h:67
CURRENCY_RUR
@ CURRENCY_RUR
Russian Rouble.
Definition: currency.h:48
CurrencySpec::symbol_pos
byte symbol_pos
The currency symbol is represented by two possible values, prefix and suffix Usage of one or the othe...
Definition: currency.h:90
CF_ISEURO
static constexpr TimerGameCalendar::Year CF_ISEURO
Currency is the Euro.
Definition: currency.h:18
CURRENCY_MYR
@ CURRENCY_MYR
Malaysian Ringgit.
Definition: currency.h:68
CURRENCY_PLN
@ CURRENCY_PLN
Polish Zloty.
Definition: currency.h:46
Currencies
Currencies
This enum gives the currencies a unique id which must be maintained for savegame compatibility and in...
Definition: currency.h:26
CURRENCY_BEF
@ CURRENCY_BEF
Belgian Franc.
Definition: currency.h:32
StrongType::Typedef
Templated helper to make a type-safe 'typedef' representing a single POD value.
Definition: strong_typedef_type.hpp:150
CURRENCY_LVL
@ CURRENCY_LVL
Latvian Lats.
Definition: currency.h:69
CURRENCY_SIT
@ CURRENCY_SIT
Slovenian Tolar.
Definition: currency.h:49
strings_type.h
CURRENCY_KRW
@ CURRENCY_KRW
South Korean Won.
Definition: currency.h:56
CURRENCY_GEL
@ CURRENCY_GEL
Georgian Lari.
Definition: currency.h:59
GetMaskOfAllowedCurrencies
uint64_t GetMaskOfAllowedCurrencies()
get a mask of the allowed currencies depending on the year
Definition: currency.cpp:124
MIN_EURO_YEAR
static constexpr TimerGameCalendar::Year MIN_EURO_YEAR
The earliest year custom currencies may switch to the Euro.
Definition: currency.h:19
CURRENCY_SKK
@ CURRENCY_SKK
Slovak Kornuna.
Definition: currency.h:52
CURRENCY_GBP
@ CURRENCY_GBP
British Pound.
Definition: currency.h:27
CurrencySpec::suffix
std::string suffix
Suffix to apply when formatting money in this currency.
Definition: currency.h:79
ResetCurrencies
void ResetCurrencies(bool preserve_custom=true)
Will fill _currency_specs array with default values from origin_currency_specs Called only from newgr...
Definition: currency.cpp:159
CURRENCY_CHF
@ CURRENCY_CHF
Swiss Franc.
Definition: currency.h:33
CURRENCY_MXN
@ CURRENCY_MXN
Mexican Peso.
Definition: currency.h:62
CURRENCY_USD
@ CURRENCY_USD
US Dollar.
Definition: currency.h:28
CURRENCY_NOK
@ CURRENCY_NOK
Norwegian Krone.
Definition: currency.h:45
CurrencySpec::code
std::string code
3 letter untranslated code to identify the currency.
Definition: currency.h:80
CURRENCY_YTL
@ CURRENCY_YTL
Turkish Lira.
Definition: currency.h:51
CURRENCY_DKK
@ CURRENCY_DKK
Danish Krona.
Definition: currency.h:36
CurrencySpec::rate
uint16_t rate
The conversion rate compared to the base currency.
Definition: currency.h:75
CURRENCY_FIM
@ CURRENCY_FIM
Finish Markka.
Definition: currency.h:38
CurrencySpec
Specification of a currency.
Definition: currency.h:74
CURRENCY_ESP
@ CURRENCY_ESP
Spanish Peseta.
Definition: currency.h:37
CURRENCY_LTL
@ CURRENCY_LTL
Lithuanian Litas.
Definition: currency.h:55
CURRENCY_SEK
@ CURRENCY_SEK
Swedish Krona.
Definition: currency.h:50
CURRENCY_HKD
@ CURRENCY_HKD
Hong Kong Dollar.
Definition: currency.h:65
string_func.h
CURRENCY_END
@ CURRENCY_END
always the last item
Definition: currency.h:70
CURRENCY_GRD
@ CURRENCY_GRD
Greek Drachma.
Definition: currency.h:40
CURRENCY_BRL
@ CURRENCY_BRL
Brazilian Real.
Definition: currency.h:53
CURRENCY_CZK
@ CURRENCY_CZK
Czech Koruna.
Definition: currency.h:34
CURRENCY_CNY
@ CURRENCY_CNY
Chinese Renminbi.
Definition: currency.h:64
CURRENCY_ITL
@ CURRENCY_ITL
Italian Lira.
Definition: currency.h:43
CURRENCY_NLG
@ CURRENCY_NLG
Dutch Gulden.
Definition: currency.h:44
CURRENCY_INR
@ CURRENCY_INR
Indian Rupee.
Definition: currency.h:66
CF_NOEURO
static constexpr TimerGameCalendar::Year CF_NOEURO
Currency never switches to the Euro (as far as known).
Definition: currency.h:17
CurrencySpec::to_euro
TimerGameCalendar::Year to_euro
Year of switching to the Euro. May also be CF_NOEURO or CF_ISEURO.
Definition: currency.h:77
CURRENCY_ISK
@ CURRENCY_ISK
Icelandic Krona.
Definition: currency.h:42
CurrencySpec::separator
std::string separator
The thousands separator for this currency.
Definition: currency.h:76
CURRENCY_JPY
@ CURRENCY_JPY
Japanese Yen.
Definition: currency.h:30
CURRENCY_EEK
@ CURRENCY_EEK
Estonian Krooni.
Definition: currency.h:54
GetNewgrfCurrencyIdConverted
byte GetNewgrfCurrencyIdConverted(byte grfcurr_id)
Will return the ottd's index correspondence to the ttdpatch's id.
Definition: currency.cpp:115
CURRENCY_IRR
@ CURRENCY_IRR
Iranian Rial.
Definition: currency.h:60
CURRENCY_EUR
@ CURRENCY_EUR
Euro.
Definition: currency.h:29
CURRENCY_NTD
@ CURRENCY_NTD
New Taiwan Dollar.
Definition: currency.h:63
CURRENCY_FRF
@ CURRENCY_FRF
French Franc.
Definition: currency.h:39
CurrencySpec::prefix
std::string prefix
Prefix to apply when formatting money in this currency.
Definition: currency.h:78
CURRENCY_RUB
@ CURRENCY_RUB
New Russian Ruble.
Definition: currency.h:61
CURRENCY_CUSTOM
@ CURRENCY_CUSTOM
Custom currency.
Definition: currency.h:58
CURRENCY_ATS
@ CURRENCY_ATS
Austrian Schilling.
Definition: currency.h:31