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

/**

    16

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

    17

 */

    18

static void SignPoolNewBlock(uint start_item)

    19

{

    20

	Sign *si;

    21

    22

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

    23

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

    24

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

    25

}

    26

    27

/* Initialize the sign-pool */

    28

DEFINE_OLD_POOL(Sign, Sign, SignPoolNewBlock, NULL)

    29

    30

/**

    31

 *

    32

 * Update the coordinate of one sign

    33

 *

    34

 */

    35

static void UpdateSignVirtCoords(Sign *si)

    36

{

    37

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

    38

	SetDParam(0, si->str);

    39

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

    40

}

    41

    42

/**

    43

 *

    44

 * Update the coordinates of all signs

    45

 *

    46

 */

    47

void UpdateAllSignVirtCoords(void)

    48

{

    49

	Sign *si;

    50

    51

	FOR_ALL_SIGNS(si) UpdateSignVirtCoords(si);

    52

    53

}

    54

    55

/**

    56

 *

    57

 * Marks the region of a sign as dirty

    58

 *

    59

 * @param si Pointer to the Sign

    60

 */

    61

static void MarkSignDirty(Sign *si)

    62

{

    63

	MarkAllViewportsDirty(

    64

		si->sign.left - 6,

    65

		si->sign.top  - 3,

    66

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

    67

		si->sign.top  + 45);

    68

}

    69

    70

/**

    71

 *

    72

 * Allocates a new sign

    73

 *

    74

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

    75

 */

    76

static Sign *AllocateSign(void)

    77

{

    78

	Sign *si;

    79

    80

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

    81

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

    82

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

    83

		if (!IsValidSign(si)) {

    84

			uint index = si->index;

    85

    86

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

    87

			si->index = index;

    88

    89

			return si;

    90

		}

    91

	}

    92

    93

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

    94

	if (AddBlockToPool(&_Sign_pool))

    95

		return AllocateSign();

    96

    97

	return NULL;

    98

}

    99

   100

void DestroySign(Sign *si)

   101

{

   102

	DeleteName(si->str);

   103

}

   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

{

   150

	if (!IsValidSignID(p1)) return CMD_ERROR;

   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 != NULL && _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

			MarkSignDirty(si);

   183

			DeleteSign(si);

   184

   185

			InvalidateWindow(WC_SIGN_LIST, 0);

   186

			_sign_sort_dirty = true;

   187

		}

   188

	}

   189

   190

	return 0;

   191

}

   192

   193

/**

   194

 *

   195

 * Callback function that is called after a sign is placed

   196

 *

   197

 */

   198

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

   199

{

   200

	if (success) {

   201

		ShowRenameSignWindow(_new_sign);

   202

		ResetObjectToPlace();

   203

	}

   204

}

   205

   206

/**

   207

 *

   208

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

   209

 *  sign-tool is selected

   210

 *

   211

 */

   212

void PlaceProc_Sign(TileIndex tile)

   213

{

   214

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

   215

}

   216

   217

/**

   218

 *

   219

 * Initialize the signs

   220

 *

   221

 */

   222

void InitializeSigns(void)

   223

{

   224

	CleanPool(&_Sign_pool);

   225

	AddBlockToPool(&_Sign_pool);

   226

}

   227

   228

static const SaveLoad _sign_desc[] = {

   229

      SLE_VAR(Sign, str,   SLE_UINT16),

   230

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

   231

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

   232

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

   233

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

   234

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

   235

      SLE_VAR(Sign, z,     SLE_UINT8),

   236

	SLE_END()

   237

};

   238

   239

/**

   240

 *

   241

 * Save all signs

   242

 *

   243

 */

   244

static void Save_SIGN(void)

   245

{

   246

	Sign *si;

   247

   248

	FOR_ALL_SIGNS(si) {

   249

		SlSetArrayIndex(si->index);

   250

		SlObject(si, _sign_desc);

   251

	}

   252

}

   253

   254

/**

   255

 *

   256

 * Load all signs

   257

 *

   258

 */

   259

static void Load_SIGN(void)

   260

{

   261

	int index;

   262

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

   263

		Sign *si;

   264

   265

		if (!AddBlockIfNeeded(&_Sign_pool, index))

   266

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

   267

   268

		si = GetSign(index);

   269

		SlObject(si, _sign_desc);

   270

	}

   271

   272

	_sign_sort_dirty = true;

   273

}

   274

   275

const ChunkHandler _sign_chunk_handlers[] = {

   276

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

   277

};