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

void DestroySign(Sign *si)

   107

{

   108

	DeleteName(si->str);

   109

}

   110

   111

/**

   112

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

   113

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

   114

 * but everybody is able to rename/remove it.

   115

 * @param tile tile to place sign at

   116

 * @param p1 unused

   117

 * @param p2 unused

   118

 */

   119

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

   120

{

   121

	Sign *si;

   122

   123

	/* Try to locate a new sign */

   124

	si = AllocateSign();

   125

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

   126

   127

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

   128

	if (flags & DC_EXEC) {

   129

		int x = TileX(tile) * TILE_SIZE;

   130

		int y = TileY(tile) * TILE_SIZE;

   131

   132

		si->str = STR_280A_SIGN;

   133

		si->x = x;

   134

		si->y = y;

   135

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

   136

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

   137

		UpdateSignVirtCoords(si);

   138

		MarkSignDirty(si);

   139

		InvalidateWindow(WC_SIGN_LIST, 0);

   140

		_sign_sort_dirty = true;

   141

		_new_sign = si;

   142

	}

   143

   144

	return 0;

   145

}

   146

   147

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

   148

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

   149

 * has no meaning/effect whatsoever except for eyecandy

   150

 * @param tile unused

   151

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

   152

 * @param p2 unused

   153

 */

   154

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

   155

{

   156

	if (!IsValidSignID(p1)) return CMD_ERROR;

   157

   158

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

   159

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

   160

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

   161

		/* Create the name */

   162

		StringID str = AllocateName(_cmd_text, 0);

   163

		if (str == 0) return CMD_ERROR;

   164

   165

		if (flags & DC_EXEC) {

   166

			Sign *si = GetSign(p1);

   167

   168

			/* Delete the old name */

   169

			DeleteName(si->str);

   170

			/* Assign the new one */

   171

			si->str = str;

   172

			si->owner = _current_player;

   173

   174

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

   175

			MarkSignDirty(si);

   176

			UpdateSignVirtCoords(si);

   177

			MarkSignDirty(si);

   178

			InvalidateWindow(WC_SIGN_LIST, 0);

   179

			_sign_sort_dirty = true;

   180

		} else {

   181

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

   182

			DeleteName(str);

   183

		}

   184

	} else { /* Delete sign */

   185

		if (flags & DC_EXEC) {

   186

			Sign *si = GetSign(p1);

   187

   188

			MarkSignDirty(si);

   189

			DeleteSign(si);

   190

   191

			InvalidateWindow(WC_SIGN_LIST, 0);

   192

			_sign_sort_dirty = true;

   193

		}

   194

	}

   195

   196

	return 0;

   197

}

   198

   199

/**

   200

 *

   201

 * Callback function that is called after a sign is placed

   202

 *

   203

 */

   204

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

   205

{

   206

	if (success) {

   207

		ShowRenameSignWindow(_new_sign);

   208

		ResetObjectToPlace();

   209

	}

   210

}

   211

   212

/**

   213

 *

   214

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

   215

 *  sign-tool is selected

   216

 *

   217

 */

   218

void PlaceProc_Sign(TileIndex tile)

   219

{

   220

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

   221

}

   222

   223

/**

   224

 *

   225

 * Initialize the signs

   226

 *

   227

 */

   228

void InitializeSigns(void)

   229

{

   230

	CleanPool(&_sign_pool);

   231

	AddBlockToPool(&_sign_pool);

   232

}

   233

   234

static const SaveLoad _sign_desc[] = {

   235

      SLE_VAR(Sign, str,   SLE_UINT16),

   236

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

   237

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

   238

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

   239

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

   240

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

   241

      SLE_VAR(Sign, z,     SLE_UINT8),

   242

	SLE_END()

   243

};

   244

   245

/**

   246

 *

   247

 * Save all signs

   248

 *

   249

 */

   250

static void Save_SIGN(void)

   251

{

   252

	Sign *si;

   253

   254

	FOR_ALL_SIGNS(si) {

   255

		SlSetArrayIndex(si->index);

   256

		SlObject(si, _sign_desc);

   257

	}

   258

}

   259

   260

/**

   261

 *

   262

 * Load all signs

   263

 *

   264

 */

   265

static void Load_SIGN(void)

   266

{

   267

	int index;

   268

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

   269

		Sign *si;

   270

   271

		if (!AddBlockIfNeeded(&_sign_pool, index))

   272

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

   273

   274

		si = GetSign(index);

   275

		SlObject(si, _sign_desc);

   276

	}

   277

   278

	_sign_sort_dirty = true;

   279

}

   280

   281

const ChunkHandler _sign_chunk_handlers[] = {

   282

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

   283

};