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

enum {

    14

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

    15

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

    16

	SIGN_POOL_MAX_BLOCKS      = 16000,

    17

};

    18

    19

/**

    20

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

    21

 */

    22

static void SignPoolNewBlock(uint start_item)

    23

{

    24

	SignStruct *ss;

    25

    26

	FOR_ALL_SIGNS_FROM(ss, start_item)

    27

		ss->index = start_item++;

    28

}

    29

    30

/* Initialize the sign-pool */

    31

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

    32

    33

/**

    34

 *

    35

 * Update the coordinate of one sign

    36

 *

    37

 */

    38

static void UpdateSignVirtCoords(SignStruct *ss)

    39

{

    40

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

    41

	SetDParam(0, ss->str);

    42

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

    43

}

    44

    45

/**

    46

 *

    47

 * Update the coordinates of all signs

    48

 *

    49

 */

    50

void UpdateAllSignVirtCoords(void)

    51

{

    52

	SignStruct *ss;

    53

    54

	FOR_ALL_SIGNS(ss)

    55

		if (ss->str != 0)

    56

			UpdateSignVirtCoords(ss);

    57

    58

}

    59

    60

/**

    61

 *

    62

 * Marks the region of a sign as dirty

    63

 *

    64

 * @param ss Pointer to the SignStruct

    65

 */

    66

static void MarkSignDirty(SignStruct *ss)

    67

{

    68

	MarkAllViewportsDirty(

    69

		ss->sign.left - 6,

    70

		ss->sign.top  - 3,

    71

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

    72

		ss->sign.top  + 45);

    73

}

    74

    75

/**

    76

 *

    77

 * Allocates a new sign

    78

 *

    79

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

    80

 */

    81

static SignStruct *AllocateSign(void)

    82

{

    83

	SignStruct *ss;

    84

	FOR_ALL_SIGNS(ss) {

    85

		if (ss->str == 0) {

    86

			uint index = ss->index;

    87

    88

			memset(ss, 0, sizeof(SignStruct));

    89

			ss->index = index;

    90

    91

			return ss;

    92

		}

    93

	}

    94

    95

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

    96

	if (AddBlockToPool(&_sign_pool))

    97

		return AllocateSign();

    98

    99

	return NULL;

   100

}

   101

   102

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

   103

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

   104

 * but everybody is able to rename/remove it.

   105

 * @param x,y coordinates to place sign at

   106

 * @param p1 unused

   107

 * @param p2 unused

   108

 */

   109

int32 CmdPlaceSign(int x, int y, uint32 flags, uint32 p1, uint32 p2)

   110

{

   111

	SignStruct *ss;

   112

   113

	/* Try to locate a new sign */

   114

	ss = AllocateSign();

   115

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

   116

   117

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

   118

	if (flags & DC_EXEC) {

   119

		ss->str = STR_280A_SIGN;

   120

		ss->x = x;

   121

		ss->y = y;

   122

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

   123

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

   124

		UpdateSignVirtCoords(ss);

   125

		MarkSignDirty(ss);

   126

		InvalidateWindow(WC_SIGN_LIST, 0);

   127

		_sign_sort_dirty = true;

   128

		_new_sign_struct = ss;

   129

	}

   130

   131

	return 0;

   132

}

   133

   134

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

   135

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

   136

 * has no meaning/effect whatsoever except for eyecandy

   137

 * @param x,y unused

   138

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

   139

 * @param p2 unused

   140

 */

   141

int32 CmdRenameSign(int x, int y, uint32 flags, uint32 p1, uint32 p2)

   142

{

   143

	if (!IsSignIndex(p1)) return CMD_ERROR;

   144

   145

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

   146

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

   147

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

   148

		/* Create the name */

   149

		StringID str = AllocateName(_cmd_text, 0);

   150

		if (str == 0) return CMD_ERROR;

   151

   152

		if (flags & DC_EXEC) {

   153

			SignStruct *ss = GetSign(p1);

   154

   155

			/* Delete the old name */

   156

			DeleteName(ss->str);

   157

			/* Assign the new one */

   158

			ss->str = str;

   159

			ss->owner = _current_player;

   160

   161

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

   162

			MarkSignDirty(ss);

   163

			UpdateSignVirtCoords(ss);

   164

			MarkSignDirty(ss);

   165

			InvalidateWindow(WC_SIGN_LIST, 0);

   166

			_sign_sort_dirty = true;

   167

		} else {

   168

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

   169

			DeleteName(str);

   170

		}

   171

	} else { /* Delete sign */

   172

		if (flags & DC_EXEC) {

   173

			SignStruct *ss = GetSign(p1);

   174

   175

			/* Delete the name */

   176

			DeleteName(ss->str);

   177

			ss->str = 0;

   178

   179

			MarkSignDirty(ss);

   180

			InvalidateWindow(WC_SIGN_LIST, 0);

   181

			_sign_sort_dirty = true;

   182

		}

   183

	}

   184

   185

	return 0;

   186

}

   187

   188

/**

   189

 *

   190

 * Callback function that is called after a sign is placed

   191

 *

   192

 */

   193

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

   194

{

   195

	if (success) {

   196

		ShowRenameSignWindow(_new_sign_struct);

   197

		ResetObjectToPlace();

   198

	}

   199

}

   200

   201

/**

   202

 *

   203

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

   204

 *  sign-tool is selected

   205

 *

   206

 */

   207

void PlaceProc_Sign(TileIndex tile)

   208

{

   209

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

   210

}

   211

   212

/**

   213

 *

   214

 * Initialize the signs

   215

 *

   216

 */

   217

void InitializeSigns(void)

   218

{

   219

	CleanPool(&_sign_pool);

   220

	AddBlockToPool(&_sign_pool);

   221

}

   222

   223

static const SaveLoad _sign_desc[] = {

   224

	SLE_VAR(SignStruct,str,						SLE_UINT16),

   225

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

   226

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

   227

	SLE_CONDVAR(SignStruct,x,					SLE_INT32, 5, 255),

   228

	SLE_CONDVAR(SignStruct,y,					SLE_INT32, 5, 255),

   229

	SLE_CONDVAR(SignStruct,owner,			SLE_UINT8, 6, 255),

   230

	SLE_VAR(SignStruct,z,							SLE_UINT8),

   231

	SLE_END()

   232

};

   233

   234

/**

   235

 *

   236

 * Save all signs

   237

 *

   238

 */

   239

static void Save_SIGN(void)

   240

{

   241

	SignStruct *ss;

   242

   243

	FOR_ALL_SIGNS(ss) {

   244

		/* Don't save empty signs */

   245

		if (ss->str != 0) {

   246

			SlSetArrayIndex(ss->index);

   247

			SlObject(ss, _sign_desc);

   248

		}

   249

	}

   250

}

   251

   252

/**

   253

 *

   254

 * Load all signs

   255

 *

   256

 */

   257

static void Load_SIGN(void)

   258

{

   259

	int index;

   260

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

   261

		SignStruct *ss;

   262

   263

		if (!AddBlockIfNeeded(&_sign_pool, index))

   264

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

   265

   266

		ss = GetSign(index);

   267

		SlObject(ss, _sign_desc);

   268

	}

   269

   270

	_sign_sort_dirty = true;

   271

}

   272

   273

const ChunkHandler _sign_chunk_handlers[] = {

   274

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

   275

};