src/currency.cpp

   1 /* $Id$ */
   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
  10 /** @file currency.cpp Support for different currencies. */
  11
  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          *   |   |    |          |              |                |  | */
  29 /** The original currency specifications. */
  30 static const CurrencySpec origin_currency_specs[CURRENCY_END] = {
  31         {    1, "", CF_NOEURO, "\xC2\xA3",     "",               0, STR_GAME_OPTIONS_CURRENCY_GBP    }, ///< british pound
  32         {    2, "", CF_NOEURO, "$",            "",               0, STR_GAME_OPTIONS_CURRENCY_USD    }, ///< american dollar
  33         {    2, "", CF_ISEURO, "\xE2\x82\xAC", "",               0, STR_GAME_OPTIONS_CURRENCY_EUR    }, ///< euro
  34         {  220, "", CF_NOEURO, "\xC2\xA5",     "",               0, STR_GAME_OPTIONS_CURRENCY_JPY    }, ///< japanese yen
  35         {   27, "", 2002,      "",             NBSP "S.",        1, STR_GAME_OPTIONS_CURRENCY_ATS    }, ///< austrian schilling
  36         {   81, "", 2002,      "BEF" NBSP,     "",               0, STR_GAME_OPTIONS_CURRENCY_BEF    }, ///< belgian franc
  37         {    2, "", CF_NOEURO, "CHF" NBSP,     "",               0, STR_GAME_OPTIONS_CURRENCY_CHF    }, ///< swiss franc
  38         {   41, "", CF_NOEURO, "",             NBSP "K\xC4\x8D", 1, STR_GAME_OPTIONS_CURRENCY_CZK    }, ///< czech koruna
  39         {    4, "", 2002,      "DM" NBSP,      "",               0, STR_GAME_OPTIONS_CURRENCY_DEM    }, ///< deutsche mark
  40         {   11, "", CF_NOEURO, "",             NBSP "kr",        1, STR_GAME_OPTIONS_CURRENCY_DKK    }, ///< danish krone
  41         {  333, "", 2002,      "Pts" NBSP,     "",               0, STR_GAME_OPTIONS_CURRENCY_ESP    }, ///< spanish peseta
  42         {   12, "", 2002,      "",             NBSP "mk",        1, STR_GAME_OPTIONS_CURRENCY_FIM    }, ///< finnish markka
  43         {   13, "", 2002,      "FF" NBSP,      "",               0, STR_GAME_OPTIONS_CURRENCY_FRF    }, ///< french franc
  44         {  681, "", 2002,      "",             "Dr.",            1, STR_GAME_OPTIONS_CURRENCY_GRD    }, ///< greek drachma
  45         {  378, "", CF_NOEURO, "",             NBSP "Ft",        1, STR_GAME_OPTIONS_CURRENCY_HUF    }, ///< hungarian forint
  46         {  130, "", CF_NOEURO, "",             NBSP "Kr",        1, STR_GAME_OPTIONS_CURRENCY_ISK    }, ///< icelandic krona
  47         { 3873, "", 2002,      "",             NBSP "L.",        1, STR_GAME_OPTIONS_CURRENCY_ITL    }, ///< italian lira
  48         {    4, "", 2002,      "NLG" NBSP,     "",               0, STR_GAME_OPTIONS_CURRENCY_NLG    }, ///< dutch gulden
  49         {   12, "", CF_NOEURO, "",             NBSP "Kr",        1, STR_GAME_OPTIONS_CURRENCY_NOK    }, ///< norwegian krone
  50         {    6, "", CF_NOEURO, "",             NBSP "z\xC5\x82", 1, STR_GAME_OPTIONS_CURRENCY_PLN    }, ///< polish zloty
  51         {    5, "", CF_NOEURO, "",             NBSP "Lei",       1, STR_GAME_OPTIONS_CURRENCY_RON    }, ///< romanian leu
  52         {   50, "", CF_NOEURO, "",             NBSP "p",         1, STR_GAME_OPTIONS_CURRENCY_RUR    }, ///< russian rouble
  53         {  479, "", 2007,      "",             NBSP "SIT",       1, STR_GAME_OPTIONS_CURRENCY_SIT    }, ///< slovenian tolar
  54         {   13, "", CF_NOEURO, "",             NBSP "Kr",        1, STR_GAME_OPTIONS_CURRENCY_SEK    }, ///< swedish krona
  55         {    3, "", CF_NOEURO, "",             NBSP "TL",        1, STR_GAME_OPTIONS_CURRENCY_TRY    }, ///< turkish lira
  56         {   60, "", 2009,      "",             NBSP "Sk",        1, STR_GAME_OPTIONS_CURRENCY_SKK    }, ///< slovak koruna
  57         {    4, "", CF_NOEURO, "R$" NBSP,      "",               0, STR_GAME_OPTIONS_CURRENCY_BRL    }, ///< brazil real
  58         {   31, "", 2011,      "",             NBSP "EEK",       1, STR_GAME_OPTIONS_CURRENCY_EEK    }, ///< estonian krooni
  59         {    4, "", 2015,      "",             NBSP "Lt",        1, STR_GAME_OPTIONS_CURRENCY_LTL    }, ///< lithuanian litas
  60         { 1850, "", CF_NOEURO, "\xE2\x82\xA9", "",               0, STR_GAME_OPTIONS_CURRENCY_KRW    }, ///< south korean won
  61         {   13, "", CF_NOEURO, "R" NBSP,       "",               0, STR_GAME_OPTIONS_CURRENCY_ZAR    }, ///< south african rand
  62         {    1, "", CF_NOEURO, "",             "",               2, STR_GAME_OPTIONS_CURRENCY_CUSTOM }, ///< custom currency (add further languages below)
  63         {    3, "", CF_NOEURO, "",             NBSP "GEL",       1, STR_GAME_OPTIONS_CURRENCY_GEL    }, ///< Georgian Lari
  64         { 4901, "", CF_NOEURO, "",             NBSP "Rls",       1, STR_GAME_OPTIONS_CURRENCY_IRR    }, ///< Iranian Rial
  65 };
  66
  67 /** Array of currencies used by the system */
  68 CurrencySpec _currency_specs[CURRENCY_END];
  69
  70 /**
  71  * This array represent the position of OpenTTD's currencies,
  72  * compared to TTDPatch's ones.
  73  * When a grf sends currencies, they are based on the order defined by TTDPatch.
  74  * So, we must reindex them to our own order.
  75  */
  76 const byte TTDPatch_To_OTTDIndex[] =
  77 {
  78         CURRENCY_GBP,
  79         CURRENCY_USD,
  80         CURRENCY_FRF,
  81         CURRENCY_DEM,
  82         CURRENCY_JPY,
  83         CURRENCY_ESP,
  84         CURRENCY_HUF,
  85         CURRENCY_PLN,
  86         CURRENCY_ATS,
  87         CURRENCY_BEF,
  88         CURRENCY_DKK,
  89         CURRENCY_FIM,
  90         CURRENCY_GRD,
  91         CURRENCY_CHF,
  92         CURRENCY_NLG,
  93         CURRENCY_ITL,
  94         CURRENCY_SEK,
  95         CURRENCY_RUR,
  96         CURRENCY_EUR,
  97 };
  98
  99 /**
 100  * Will return the ottd's index correspondence to
 101  * the ttdpatch's id.  If the id is bigger than the array,
 102  * it is a grf written for ottd, thus returning the same id.
 103  * Only called from newgrf.cpp
 104  * @param grfcurr_id currency id coming from newgrf
 105  * @return the corrected index
 106  */
 107 byte GetNewgrfCurrencyIdConverted(byte grfcurr_id)
 108 {
 109         return (grfcurr_id >= lengthof(TTDPatch_To_OTTDIndex)) ? grfcurr_id : TTDPatch_To_OTTDIndex[grfcurr_id];
 110 }
 111
 112 /**
 113  * get a mask of the allowed currencies depending on the year
 114  * @return mask of currencies
 115  */
 116 uint64 GetMaskOfAllowedCurrencies()
 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
 132 /**
 133  * Verify if the currency chosen by the user is about to be converted to Euro
 134  */
 135 void CheckSwitchToEuro()
 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
 145 /**
 146  * Will fill _currency_specs array with
 147  * default values from origin_currency_specs
 148  * Called only from newgrf.cpp and settings.cpp.
 149  * @param preserve_custom will not reset custom currency
 150  */
 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
 159 /**
 160  * Build a list of currency names StringIDs to use in a dropdown list
 161  * @return Pointer to a (static) array of StringIDs
 162  */
 163 StringID *BuildCurrencyDropdown()
 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 }