1

/* $Id$ */

     2

     3

/** @file currency.cpp Support for different currencies. */

     4

     5

#include "stdafx.h"

     6

#include "openttd.h"

     7

#include "currency.h"

     8

#include "news_func.h"

     9

#include "settings_type.h"

    10

#include "date_func.h"

    11

    12

#include "table/strings.h"

    13

    14

	//   exchange rate    prefix             symbol_pos

    15

	//   |  separator        |     postfix   |

    16

	//   |   |    Euro year  |       |       |    name

    17

	//   |   |    |          |       |       |    |

    18

static const CurrencySpec origin_currency_specs[NUM_CURRENCY] = {

    19

	{    1, ',', CF_NOEURO, "£",    "",      0,  STR_CURR_GBP    }, ///< british pounds

    20

	{    2, ',', CF_NOEURO, "$",    "",      0,  STR_CURR_USD    }, ///< us dollars

    21

	{    2, ',', CF_ISEURO, "€",    "",      0,  STR_CURR_EUR    }, ///< Euro

    22

	{  220, ',', CF_NOEURO, "¥",    "",      0,  STR_CURR_YEN    }, ///< yen

    23

	{   20, ',', 2002,      "",     " S.",   1,  STR_CURR_ATS    }, ///< austrian schilling

    24

	{   59, ',', 2002,      "BEF ", "",      0,  STR_CURR_BEF    }, ///< belgian franc

    25

	{    2, ',', CF_NOEURO, "CHF ", "",      0,  STR_CURR_CHF    }, ///< swiss franc

    26

	{   41, ',', CF_NOEURO, "",     " Kč",   1,  STR_CURR_CZK    }, ///< czech koruna

    27

	{    3, '.', 2002,      "DM ",  "",      0,  STR_CURR_DEM    }, ///< deutsche mark

    28

	{   11, '.', CF_NOEURO, "",     " kr",   1,  STR_CURR_DKK    }, ///< danish krone

    29

	{  245, '.', 2002,      "Pts ", "",      0,  STR_CURR_ESP    }, ///< spanish pesetas

    30

	{    9, ',', 2002,      "",     " mk",   1,  STR_CURR_FIM    }, ///< finnish markka

    31

	{   10, '.', 2002,      "FF ",  "",      0,  STR_CURR_FRF    }, ///< french francs

    32

	{  500, ',', 2002,      "",     "Dr.",   1,  STR_CURR_GRD    }, ///< greek drachma

    33

	{  378, ',', 2010,      "",     " Ft",   1,  STR_CURR_HUF    }, ///< hungarian forint

    34

	{  130, '.', CF_NOEURO, "",     " Kr",   1,  STR_CURR_ISK    }, ///< icelandic krona

    35

	{ 2850, ',', 2002,      "",     " L.",   1,  STR_CURR_ITL    }, ///< italian lira

    36

	{    3, ',', 2002,      "NLG ", "",      0,  STR_CURR_NLG    }, ///< dutch gulden

    37

	{   12, '.', CF_NOEURO, "",     " Kr",   1,  STR_CURR_NOK    }, ///< norwegian krone

    38

	{    6, ' ', CF_NOEURO, "",     " zl",   1,  STR_CURR_PLN    }, ///< polish zloty

    39

	{    5, '.', CF_NOEURO, "",     " Lei",  1,  STR_CURR_ROL    }, ///< romanian Lei

    40

	{   50, ' ', CF_NOEURO, "",     " p",    1,  STR_CURR_RUR    }, ///< russian rouble

    41

	{  352, '.', 2007,      "",     " SIT",  1,  STR_CURR_SIT    }, ///< slovenian tolar

    42

	{   13, '.', CF_NOEURO, "",     " Kr",   1,  STR_CURR_SEK    }, ///< swedish krona

    43

	{    3, '.', CF_NOEURO, "",     " YTL",  1,  STR_CURR_YTL    }, ///< turkish lira

    44

	{   52, ',', CF_NOEURO, "",     " Sk",   1,  STR_CURR_SKK    }, ///< slovak koruna

    45

	{    4, ',', CF_NOEURO, "R$ ",  "",      0,  STR_CURR_BRL    }, ///< brazil real

    46

	{   20, '.', CF_NOEURO, "",     " EEK",  1,  STR_CURR_EEK    }, ///< estonian krooni

    47

	{    1, ' ', CF_NOEURO, "",     "",      2,  STR_CURR_CUSTOM }, ///< custom currency

    48

};

    49

    50

/* Array of currencies used by the system */

    51

CurrencySpec _currency_specs[NUM_CURRENCY];

    52

    53

/**

    54

 * These enums are only declared in order to make sens

    55

 * out of the TTDPatch_To_OTTDIndex array that will follow

    56

 * Every currency used by Ottd is there, just in case TTDPatch will

    57

 * add those missing in its code

    58

 **/

    59

enum {

    60

	CURR_GBP,

    61

	CURR_USD,

    62

	CURR_EUR,

    63

	CURR_YEN,

    64

	CURR_ATS,

    65

	CURR_BEF,

    66

	CURR_CHF,

    67

	CURR_CZK,

    68

	CURR_DEM,

    69

	CURR_DKK,

    70

	CURR_ESP,

    71

	CURR_FIM,

    72

	CURR_FRF,

    73

	CURR_GRD,

    74

	CURR_HUF,

    75

	CURR_ISK,

    76

	CURR_ITL,

    77

	CURR_NLG,

    78

	CURR_NOK,

    79

	CURR_PLN,

    80

	CURR_ROL,

    81

	CURR_RUR,

    82

	CURR_SIT,

    83

	CURR_SEK,

    84

	CURR_YTL,

    85

	CURR_SKK,

    86

	CURR_BRL,

    87

	CURR_EEK,

    88

};

    89

    90

/**

    91

 * This array represent the position of OpenTTD's currencies,

    92

 * compared to TTDPatch's ones.

    93

 * When a grf sends currencies, they are based on the order defined by TTDPatch.

    94

 * So, we must reindex them to our own order.

    95

 **/

    96

const byte TTDPatch_To_OTTDIndex[] =

    97

{

    98

	CURR_GBP,

    99

	CURR_USD,

   100

	CURR_FRF,

   101

	CURR_DEM,

   102

	CURR_YEN,

   103

	CURR_ESP,

   104

	CURR_HUF,

   105

	CURR_PLN,

   106

	CURR_ATS,

   107

	CURR_BEF,

   108

	CURR_DKK,

   109

	CURR_FIM,

   110

	CURR_GRD,

   111

	CURR_CHF,

   112

	CURR_NLG,

   113

	CURR_ITL,

   114

	CURR_SEK,

   115

	CURR_RUR,

   116

	CURR_EUR,

   117

};

   118

   119

/**

   120

 * Will return the ottd's index correspondance to

   121

 * the ttdpatch's id.  If the id is bigger than the array,

   122

 * it is a grf written for ottd, thus returning the same id.

   123

 * Only called from newgrf.cpp

   124

 * @param grfcurr_id currency id coming from newgrf

   125

 * @return the corrected index

   126

 **/

   127

byte GetNewgrfCurrencyIdConverted(byte grfcurr_id)

   128

{

   129

	return (grfcurr_id >= lengthof(TTDPatch_To_OTTDIndex)) ? grfcurr_id : TTDPatch_To_OTTDIndex[grfcurr_id];

   130

}

   131

   132

/**

   133

 * get a mask of the allowed currencies depending on the year

   134

 * @return mask of currencies

   135

 */

   136

uint GetMaskOfAllowedCurrencies()

   137

{

   138

	uint mask = 0;

   139

	uint i;

   140

   141

	for (i = 0; i < NUM_CURRENCY; i++) {

   142

		Year to_euro = _currency_specs[i].to_euro;

   143

   144

		if (to_euro != CF_NOEURO && to_euro != CF_ISEURO && _cur_year >= to_euro) continue;

   145

		if (to_euro == CF_ISEURO && _cur_year < 2000) continue;

   146

		mask |= (1 << i);

   147

	}

   148

	mask |= (1 << CUSTOM_CURRENCY_ID); // always allow custom currency

   149

	return mask;

   150

}

   151

   152

/**

   153

 * Verify if the currency chosen by the user is about to be converted to Euro

   154

 **/

   155

void CheckSwitchToEuro()

   156

{

   157

	if (_currency_specs[_settings_game.locale.currency].to_euro != CF_NOEURO &&

   158

			_currency_specs[_settings_game.locale.currency].to_euro != CF_ISEURO &&

   159

			_cur_year >= _currency_specs[_settings_game.locale.currency].to_euro) {

   160

		_settings_game.locale.currency = 2; // this is the index of euro above.

   161

		AddNewsItem(STR_EURO_INTRODUCE, NS_ECONOMY, 0, 0);

   162

	}

   163

}

   164

   165

/**

   166

 * Will fill _currency_specs array with

   167

 * default values from origin_currency_specs

   168

 * Called only from newgrf.cpp and settings.cpp.

   169

 * @param preserve_custom will not reset custom currency (the latest one on the list)

   170

 *        if ever it is flagged to true. In which case, the total size of the memory to move

   171

 *        will be one currency spec less, thus preserving the custom curreny from been

   172

 *        overwritten.

   173

 **/

   174

void ResetCurrencies(bool preserve_custom)

   175

{

   176

	memcpy(&_currency_specs, &origin_currency_specs, sizeof(origin_currency_specs) - (preserve_custom ? sizeof(_custom_currency) : 0));

   177

}

   178

   179

/**

   180

 * Build a list of currency names StringIDs to use in a dropdown list

   181

 * @return Pointer to a (static) array of StringIDs

   182

 */

   183

StringID* BuildCurrencyDropdown()

   184

{

   185

	/* Allow room for all currencies, plus a terminator entry */

   186

	static StringID names[NUM_CURRENCY + 1];

   187

	uint i;

   188

   189

	/* Add each name */

   190

	for (i = 0; i < NUM_CURRENCY; i++) {

   191

		names[i] = _currency_specs[i].name;

   192

	}

   193

	/* Terminate the list */

   194

	names[i] = INVALID_STRING_ID;

   195

   196

	return names;

   197

}