1

/* $Id$ */

     2

     3

#include "stdafx.h"

     4

#include "openttd.h"

     5

#include "table/strings.h"

     6

#include "functions.h"

     7

#include "player.h"

     8

#include "signs.h"

     9

#include "saveload.h"

    10

#include "command.h"

    11

#include "variables.h"

    12

    13

static Sign *_new_sign;

    14

    15

enum {

    16

	/* Max signs: 64000 (4 * 16000) */

    17

	SIGN_POOL_BLOCK_SIZE_BITS = 2,       /* In bits, so (1 << 2) == 4 */

    18

	SIGN_POOL_MAX_BLOCKS      = 16000,

    19

};

    20

    21

/**

    22

 * Called if a new block is added to the sign-pool

    23

 */

    24

static void SignPoolNewBlock(uint start_item)

    25

{

    26

	Sign *si;

    27

    28

	/* We don't use FOR_ALL here, because FOR_ALL skips invalid items.

    29

	 * TODO - This is just a temporary stage, this will be removed. */

    30

	for (si = GetSign(start_item); si != NULL; si = (si->index + 1 < GetSignPoolSize()) ? GetSign(si->index + 1) : NULL) si->index = start_item++;

    31

}

    32

    33

/* Initialize the sign-pool */

    34

MemoryPool _sign_pool = { "Signs", SIGN_POOL_MAX_BLOCKS, SIGN_POOL_BLOCK_SIZE_BITS, sizeof(Sign), &SignPoolNewBlock, NULL, 0, 0, NULL };

    35

    36

/**

    37

 *

    38

 * Update the coordinate of one sign

    39

 *

    40

 */

    41

static void UpdateSignVirtCoords(Sign *si)

    42

{

    43

	Point pt = RemapCoords(si->x, si->y, si->z);

    44

	SetDParam(0, si->str);

    45

	UpdateViewportSignPos(&si->sign, pt.x, pt.y - 6, STR_2806);

    46

}

    47

    48

/**

    49

 *

    50

 * Update the coordinates of all signs

    51

 *

    52

 */

    53

void UpdateAllSignVirtCoords(void)

    54

{

    55

	Sign *si;

    56

    57

	FOR_ALL_SIGNS(si) UpdateSignVirtCoords(si);

    58

    59

}

    60

    61

/**

    62

 *

    63

 * Marks the region of a sign as dirty

    64

 *

    65

 * @param si Pointer to the Sign

    66

 */

    67

static void MarkSignDirty(Sign *si)

    68

{

    69

	MarkAllViewportsDirty(

    70

		si->sign.left - 6,

    71

		si->sign.top  - 3,

    72

		si->sign.left + si->sign.width_1 * 4 + 12,

    73

		si->sign.top  + 45);

    74

}

    75

    76

/**

    77

 *

    78

 * Allocates a new sign

    79

 *

    80

 * @return The pointer to the new sign, or NULL if there is no more free space

    81

 */

    82

static Sign *AllocateSign(void)

    83

{

    84

	Sign *si;

    85

    86

	/* We don't use FOR_ALL here, because FOR_ALL skips invalid items.

    87

	 * TODO - This is just a temporary stage, this will be removed. */

    88

	for (si = GetSign(0); si != NULL; si = (si->index + 1 < GetSignPoolSize()) ? GetSign(si->index + 1) : NULL) {

    89

		if (!IsValidSign(si)) {

    90

			uint index = si->index;

    91

    92

			memset(si, 0, sizeof(Sign));

    93

			si->index = index;

    94

    95

			return si;

    96

		}

    97

	}

    98

    99

	/* Check if we can add a block to the pool */

   100

	if (AddBlockToPool(&_sign_pool))

   101

		return AllocateSign();

   102

   103

	return NULL;

   104

}

   105

   106

/** Place a sign at the given coordinates. Ownership of sign has

   107

 * no effect whatsoever except for the colour the sign gets for easy recognition,

   108

 * but everybody is able to rename/remove it.

   109

 * @param tile tile to place sign at

   110

 * @param p1 unused

   111

 * @param p2 unused

   112

 */

   113

int32 CmdPlaceSign(TileIndex tile, uint32 flags, uint32 p1, uint32 p2)

   114

{

   115

	Sign *si;

   116

   117

	/* Try to locate a new sign */

   118

	si = AllocateSign();

   119

	if (si == NULL) return_cmd_error(STR_2808_TOO_MANY_SIGNS);

   120

   121

	/* When we execute, really make the sign */

   122

	if (flags & DC_EXEC) {

   123

		int x = TileX(tile) * TILE_SIZE;

   124

		int y = TileY(tile) * TILE_SIZE;

   125

   126

		si->str = STR_280A_SIGN;

   127

		si->x = x;

   128

		si->y = y;

   129

		si->owner = _current_player; // owner of the sign; just eyecandy

   130

		si->z = GetSlopeZ(x,y);

   131

		UpdateSignVirtCoords(si);

   132

		MarkSignDirty(si);

   133

		InvalidateWindow(WC_SIGN_LIST, 0);

   134

		_sign_sort_dirty = true;

   135

		_new_sign = si;

   136

	}

   137

   138

	return 0;

   139

}

   140

   141

/** Rename a sign. If the new name of the sign is empty, we assume

   142

 * the user wanted to delete it. So delete it. Ownership of signs

   143

 * has no meaning/effect whatsoever except for eyecandy

   144

 * @param tile unused

   145

 * @param p1 index of the sign to be renamed/removed

   146

 * @param p2 unused

   147

 */

   148

int32 CmdRenameSign(TileIndex tile, uint32 flags, uint32 p1, uint32 p2)

   149

{

   151

   152

	/* If _cmd_text 0 means the new text for the sign is non-empty.

   153

	 * So rename the sign. If it is empty, it has no name, so delete it */

   154

	if (_cmd_text[0] != '\0') {

   155

		/* Create the name */

   156

		StringID str = AllocateName(_cmd_text, 0);

   157

		if (str == 0) return CMD_ERROR;

   158

   159

		if (flags & DC_EXEC) {

   160

			Sign *si = GetSign(p1);

   161

   162

			/* Delete the old name */

   163

			DeleteName(si->str);

   164

			/* Assign the new one */

   165

			si->str = str;

   166

			si->owner = _current_player;

   167

   168

			/* Update; mark sign dirty twice, because it can either becom longer, or shorter */

   169

			MarkSignDirty(si);

   170

			UpdateSignVirtCoords(si);

   171

			MarkSignDirty(si);

   172

			InvalidateWindow(WC_SIGN_LIST, 0);

   173

			_sign_sort_dirty = true;

   174

		} else {

   175

			/* Free the name, because we did not assign it yet */

   176

			DeleteName(str);

   177

		}

   178

	} else { /* Delete sign */

   179

		if (flags & DC_EXEC) {

   180

			Sign *si = GetSign(p1);

   181

   182

			/* Delete the name */

   183

			DeleteName(si->str);

   184

			si->str = 0;

   185

   186

			MarkSignDirty(si);

   187

			InvalidateWindow(WC_SIGN_LIST, 0);

   188

			_sign_sort_dirty = true;

   189

		}

   190

	}

   191

   192

	return 0;

   193

}

   194

   195

/**

   196

 *

   197

 * Callback function that is called after a sign is placed

   198

 *

   199

 */

   200

void CcPlaceSign(bool success, TileIndex tile, uint32 p1, uint32 p2)

   201

{

   202

	if (success) {

   203

		ShowRenameSignWindow(_new_sign);

   204

		ResetObjectToPlace();

   205

	}

   206

}

   207

   208

/**

   209

 *

   210

 * PlaceProc function, called when someone pressed the button if the

   211

 *  sign-tool is selected

   212

 *

   213

 */

   214

void PlaceProc_Sign(TileIndex tile)

   215

{

   216

	DoCommandP(tile, 0, 0, CcPlaceSign, CMD_PLACE_SIGN | CMD_MSG(STR_2809_CAN_T_PLACE_SIGN_HERE));

   217

}

   218

   219

/**

   220

 *

   221

 * Initialize the signs

   222

 *

   223

 */

   224

void InitializeSigns(void)

   225

{

   226

	CleanPool(&_sign_pool);

   227

	AddBlockToPool(&_sign_pool);

   228

}

   229

   230

static const SaveLoad _sign_desc[] = {

   231

      SLE_VAR(Sign, str,   SLE_UINT16),

   232

  SLE_CONDVAR(Sign, x,     SLE_FILE_I16 | SLE_VAR_I32, 0, 4),

   233

  SLE_CONDVAR(Sign, y,     SLE_FILE_I16 | SLE_VAR_I32, 0, 4),

   234

  SLE_CONDVAR(Sign, x,     SLE_INT32,                  5, SL_MAX_VERSION),

   235

  SLE_CONDVAR(Sign, y,     SLE_INT32,                  5, SL_MAX_VERSION),

   236

  SLE_CONDVAR(Sign, owner, SLE_UINT8,                  6, SL_MAX_VERSION),

   237

      SLE_VAR(Sign, z,     SLE_UINT8),

   238

	SLE_END()

   239

};

   240

   241

/**

   242

 *

   243

 * Save all signs

   244

 *

   245

 */

   246

static void Save_SIGN(void)

   247

{

   248

	Sign *si;

   249

   250

	FOR_ALL_SIGNS(si) {

   251

		SlSetArrayIndex(si->index);

   252

		SlObject(si, _sign_desc);

   253

	}

   254

}

   255

   256

/**

   257

 *

   258

 * Load all signs

   259

 *

   260

 */

   261

static void Load_SIGN(void)

   262

{

   263

	int index;

   264

	while ((index = SlIterateArray()) != -1) {

   265

		Sign *si;

   266

   267

		if (!AddBlockIfNeeded(&_sign_pool, index))

   268

			error("Signs: failed loading savegame: too many signs");

   269

   270

		si = GetSign(index);

   271

		SlObject(si, _sign_desc);

   272

	}

   273

   274

	_sign_sort_dirty = true;

   275

}

   276

   277

const ChunkHandler _sign_chunk_handlers[] = {

   278

	{ 'SIGN', Save_SIGN, Load_SIGN, CH_ARRAY | CH_LAST},

   279

};