OpenTTD
currency.cpp
Go to the documentation of this file.
1 /* $Id: currency.cpp 26989 2014-10-10 23:07:59Z planetmaker $ */
2 
3 /*
4  * This file is part of OpenTTD.
5  * 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.
6  * 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.
7  * 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/>.
8  */
9 
12 #include "stdafx.h"
13 #include "core/bitmath_func.hpp"
14 
15 #include "currency.h"
16 #include "news_func.h"
17 #include "settings_type.h"
18 #include "date_func.h"
19 #include "string_type.h"
20 
21 #include "table/strings.h"
22 
23 #include "safeguards.h"
24 
25  /* exchange rate prefix symbol_pos
26  * | separator | postfix |
27  * | | Euro year | | | name
28  * | | | | | | | */
31  { 1, "", CF_NOEURO, "\xC2\xA3", "", 0, STR_GAME_OPTIONS_CURRENCY_GBP },
32  { 2, "", CF_NOEURO, "$", "", 0, STR_GAME_OPTIONS_CURRENCY_USD },
33  { 2, "", CF_ISEURO, "\xE2\x82\xAC", "", 0, STR_GAME_OPTIONS_CURRENCY_EUR },
34  { 220, "", CF_NOEURO, "\xC2\xA5", "", 0, STR_GAME_OPTIONS_CURRENCY_JPY },
35  { 27, "", 2002, "", NBSP "S.", 1, STR_GAME_OPTIONS_CURRENCY_ATS },
36  { 81, "", 2002, "BEF" NBSP, "", 0, STR_GAME_OPTIONS_CURRENCY_BEF },
37  { 2, "", CF_NOEURO, "CHF" NBSP, "", 0, STR_GAME_OPTIONS_CURRENCY_CHF },
38  { 41, "", CF_NOEURO, "", NBSP "K\xC4\x8D", 1, STR_GAME_OPTIONS_CURRENCY_CZK },
39  { 4, "", 2002, "DM" NBSP, "", 0, STR_GAME_OPTIONS_CURRENCY_DEM },
40  { 11, "", CF_NOEURO, "", NBSP "kr", 1, STR_GAME_OPTIONS_CURRENCY_DKK },
41  { 333, "", 2002, "Pts" NBSP, "", 0, STR_GAME_OPTIONS_CURRENCY_ESP },
42  { 12, "", 2002, "", NBSP "mk", 1, STR_GAME_OPTIONS_CURRENCY_FIM },
43  { 13, "", 2002, "FF" NBSP, "", 0, STR_GAME_OPTIONS_CURRENCY_FRF },
44  { 681, "", 2002, "", "Dr.", 1, STR_GAME_OPTIONS_CURRENCY_GRD },
45  { 378, "", CF_NOEURO, "", NBSP "Ft", 1, STR_GAME_OPTIONS_CURRENCY_HUF },
46  { 130, "", CF_NOEURO, "", NBSP "Kr", 1, STR_GAME_OPTIONS_CURRENCY_ISK },
47  { 3873, "", 2002, "", NBSP "L.", 1, STR_GAME_OPTIONS_CURRENCY_ITL },
48  { 4, "", 2002, "NLG" NBSP, "", 0, STR_GAME_OPTIONS_CURRENCY_NLG },
49  { 12, "", CF_NOEURO, "", NBSP "Kr", 1, STR_GAME_OPTIONS_CURRENCY_NOK },
50  { 6, "", CF_NOEURO, "", NBSP "z\xC5\x82", 1, STR_GAME_OPTIONS_CURRENCY_PLN },
51  { 5, "", CF_NOEURO, "", NBSP "Lei", 1, STR_GAME_OPTIONS_CURRENCY_RON },
52  { 50, "", CF_NOEURO, "", NBSP "p", 1, STR_GAME_OPTIONS_CURRENCY_RUR },
53  { 479, "", 2007, "", NBSP "SIT", 1, STR_GAME_OPTIONS_CURRENCY_SIT },
54  { 13, "", CF_NOEURO, "", NBSP "Kr", 1, STR_GAME_OPTIONS_CURRENCY_SEK },
55  { 3, "", CF_NOEURO, "", NBSP "TL", 1, STR_GAME_OPTIONS_CURRENCY_TRY },
56  { 60, "", 2009, "", NBSP "Sk", 1, STR_GAME_OPTIONS_CURRENCY_SKK },
57  { 4, "", CF_NOEURO, "R$" NBSP, "", 0, STR_GAME_OPTIONS_CURRENCY_BRL },
58  { 31, "", 2011, "", NBSP "EEK", 1, STR_GAME_OPTIONS_CURRENCY_EEK },
59  { 4, "", 2015, "", NBSP "Lt", 1, STR_GAME_OPTIONS_CURRENCY_LTL },
60  { 1850, "", CF_NOEURO, "\xE2\x82\xA9", "", 0, STR_GAME_OPTIONS_CURRENCY_KRW },
61  { 13, "", CF_NOEURO, "R" NBSP, "", 0, STR_GAME_OPTIONS_CURRENCY_ZAR },
62  { 1, "", CF_NOEURO, "", "", 2, STR_GAME_OPTIONS_CURRENCY_CUSTOM },
63  { 3, "", CF_NOEURO, "", NBSP "GEL", 1, STR_GAME_OPTIONS_CURRENCY_GEL },
64  { 4901, "", CF_NOEURO, "", NBSP "Rls", 1, STR_GAME_OPTIONS_CURRENCY_IRR },
65 };
66 
69 
76 const byte TTDPatch_To_OTTDIndex[] =
77 {
97 };
98 
107 byte GetNewgrfCurrencyIdConverted(byte grfcurr_id)
108 {
109  return (grfcurr_id >= lengthof(TTDPatch_To_OTTDIndex)) ? grfcurr_id : TTDPatch_To_OTTDIndex[grfcurr_id];
110 }
111 
117 {
118  uint64 mask = 0LL;
119  uint i;
120 
121  for (i = 0; i < CURRENCY_END; i++) {
122  Year to_euro = _currency_specs[i].to_euro;
123 
124  if (to_euro != CF_NOEURO && to_euro != CF_ISEURO && _cur_year >= to_euro) continue;
125  if (to_euro == CF_ISEURO && _cur_year < 2000) continue;
126  SetBit(mask, i);
127  }
128  SetBit(mask, CURRENCY_CUSTOM); // always allow custom currency
129  return mask;
130 }
131 
136 {
137  if (_currency_specs[_settings_game.locale.currency].to_euro != CF_NOEURO &&
138  _currency_specs[_settings_game.locale.currency].to_euro != CF_ISEURO &&
139  _cur_year >= _currency_specs[_settings_game.locale.currency].to_euro) {
140  _settings_game.locale.currency = 2; // this is the index of euro above.
141  AddNewsItem(STR_NEWS_EURO_INTRODUCTION, NT_ECONOMY, NF_NORMAL);
142  }
143 }
144 
151 void ResetCurrencies(bool preserve_custom)
152 {
153  for (uint i = 0; i < CURRENCY_END; i++) {
154  if (preserve_custom && i == CURRENCY_CUSTOM) continue;
155  _currency_specs[i] = origin_currency_specs[i];
156  }
157 }
158 
164 {
165  /* Allow room for all currencies, plus a terminator entry */
166  static StringID names[CURRENCY_END + 1];
167  uint i;
168 
169  /* Add each name */
170  for (i = 0; i < CURRENCY_END; i++) {
171  names[i] = _currency_specs[i].name;
172  }
173  /* Terminate the list */
174  names[i] = INVALID_STRING_ID;
175 
176  return names;
177 }
GameSettings _settings_game
Game settings of a running game or the scenario editor.
Definition: settings.cpp:77
Russian Rouble.
Definition: currency.h:48
Finish Markka.
Definition: currency.h:38
Italian Lira.
Definition: currency.h:43
void ResetCurrencies(bool preserve_custom)
Will fill _currency_specs array with default values from origin_currency_specs Called only from newgr...
Definition: currency.cpp:151
Dutch Gulden.
Definition: currency.h:44
Custom currency.
Definition: currency.h:58
Functions related to dates.
CurrencySpec _currency_specs[CURRENCY_END]
Array of currencies used by the system.
Definition: currency.cpp:68
Functions to handle different currencies.
static T SetBit(T &x, const uint8 y)
Set a bit in a variable.
Euro.
Definition: currency.h:29
Functions related to bit mathematics.
int32 Year
Type for the year, note: 0 based, i.e. starts at the year 0.
Definition: date_type.h:20
Year _cur_year
Current year, starting at 0.
Definition: date.cpp:26
Japanese Yen.
Definition: currency.h:30
US Dollar.
Definition: currency.h:28
Danish Krona.
Definition: currency.h:36
Types related to global configuration settings.
Definition of base types and functions in a cross-platform compatible way.
static const int CF_NOEURO
Currency never switches to the Euro (as far as known).
Definition: currency.h:18
Spanish Peseta.
Definition: currency.h:37
A number of safeguards to prevent using unsafe methods.
Swedish Krona.
Definition: currency.h:50
StringID * BuildCurrencyDropdown()
Build a list of currency names StringIDs to use in a dropdown list.
Definition: currency.cpp:163
Normal news item. (Newspaper with text only)
Definition: news_type.h:93
British Pound.
Definition: currency.h:27
static const CurrencySpec origin_currency_specs[CURRENCY_END]
The original currency specifications.
Definition: currency.cpp:30
const byte TTDPatch_To_OTTDIndex[]
This array represent the position of OpenTTD&#39;s currencies, compared to TTDPatch&#39;s ones...
Definition: currency.cpp:76
Belgian Franc.
Definition: currency.h:32
#define lengthof(x)
Return the length of an fixed size array.
Definition: depend.cpp:42
always the last item
Definition: currency.h:61
byte GetNewgrfCurrencyIdConverted(byte grfcurr_id)
Will return the ottd&#39;s index correspondence to the ttdpatch&#39;s id.
Definition: currency.cpp:107
Greek Drachma.
Definition: currency.h:40
French Franc.
Definition: currency.h:39
uint32 StringID
Numeric value that represents a string, independent of the selected language.
Definition: strings_type.h:18
Year to_euro
Year of switching to the Euro. May also be CF_NOEURO or CF_ISEURO.
Definition: currency.h:68
void CheckSwitchToEuro()
Verify if the currency chosen by the user is about to be converted to Euro.
Definition: currency.cpp:135
Austrian Schilling.
Definition: currency.h:31
Polish Zloty.
Definition: currency.h:46
void AddNewsItem(StringID string, NewsType type, NewsFlag flags, NewsReferenceType reftype1=NR_NONE, uint32 ref1=UINT32_MAX, NewsReferenceType reftype2=NR_NONE, uint32 ref2=UINT32_MAX, void *free_data=NULL)
Add a new newsitem to be shown.
Definition: news_gui.cpp:645
LocaleSettings locale
settings related to used currency/unit system in the current game
Specification of a currency.
Definition: currency.h:65
static const StringID INVALID_STRING_ID
Constant representing an invalid string (16bit in case it is used in savegames)
Definition: strings_type.h:19
uint64 GetMaskOfAllowedCurrencies()
get a mask of the allowed currencies depending on the year
Definition: currency.cpp:116
Types for strings.
static const int CF_ISEURO
Currency is the Euro.
Definition: currency.h:19
Functions related to news.
Swiss Franc.
Definition: currency.h:33
#define NBSP
A non-breaking space.
Definition: string_type.h:18
Deutsche Mark.
Definition: currency.h:35
Hungarian Forint.
Definition: currency.h:41
Economic changes (recession, industry up/dowm)
Definition: news_type.h:43
byte currency
currency we currently use