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 SignStruct *_new_sign_struct;

    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

	SignStruct *ss;

    27

    28

	FOR_ALL_SIGNS_FROM(ss, start_item)

    29

		ss->index = start_item++;

    30

}

    31

    32

/* Initialize the sign-pool */

    33

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

    34

    35

/**

    36

 *

    37

 * Update the coordinate of one sign

    38

 *

    39

 */

    40

static void UpdateSignVirtCoords(SignStruct *ss)

    41

{

    42

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

    43

	SetDParam(0, ss->str);

    44

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

    45

}

    46

    47

/**

    48

 *

    49

 * Update the coordinates of all signs

    50

 *

    51

 */

    52

void UpdateAllSignVirtCoords(void)

    53

{

    54

	SignStruct *ss;

    55

    56

	FOR_ALL_SIGNS(ss)

    57

		if (ss->str != 0)

    58

			UpdateSignVirtCoords(ss);

    59

    60

}

    61

    62

/**

    63

 *

    64

 * Marks the region of a sign as dirty

    65

 *

    66

 * @param ss Pointer to the SignStruct

    67

 */

    68

static void MarkSignDirty(SignStruct *ss)

    69

{

    70

	MarkAllViewportsDirty(

    71

		ss->sign.left - 6,

    72

		ss->sign.top  - 3,

    73

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

    74

		ss->sign.top  + 45);

    75

}

    76

    77

/**

    78

 *

    79

 * Allocates a new sign

    80

 *

    81

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

    82

 */

    83

static SignStruct *AllocateSign(void)

    84

{

    85

	SignStruct *ss;

    86

	FOR_ALL_SIGNS(ss) {

    87

		if (ss->str == 0) {

    88

			uint index = ss->index;

    89

    90

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

    91

			ss->index = index;

    92

    93

			return ss;

    94

		}

    95

	}

    96

    97

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

    98

	if (AddBlockToPool(&_sign_pool))

    99

		return AllocateSign();

   100

   101

	return NULL;

   102

}

   103

   104

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

   105

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

   106

 * but everybody is able to rename/remove it.

   107

 * @param x,y coordinates to place sign at

   108

 * @param p1 unused

   109

 * @param p2 unused

   110

 */

   111

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

   112

{

   113

	SignStruct *ss;

   114

   115

	/* Try to locate a new sign */

   116

	ss = AllocateSign();

   117

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

   118

   119

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

   120

	if (flags & DC_EXEC) {

   121

		ss->str = STR_280A_SIGN;

   122

		ss->x = x;

   123

		ss->y = y;

   124

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

   125

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

   126

		UpdateSignVirtCoords(ss);

   127

		MarkSignDirty(ss);

   128

		InvalidateWindow(WC_SIGN_LIST, 0);

   129

		_sign_sort_dirty = true;

   130

		_new_sign_struct = ss;

   131

	}

   132

   133

	return 0;

   134

}

   135

   136

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

   137

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

   138

 * has no meaning/effect whatsoever except for eyecandy

   139

 * @param x,y unused

   140

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

   141

 * @param p2 unused

   142

 */

   143

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

   144

{

   145

	if (!IsSignIndex(p1)) return CMD_ERROR;

   146

   147

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

   148

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

   149

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

   150

		/* Create the name */

   151

		StringID str = AllocateName(_cmd_text, 0);

   152

		if (str == 0) return CMD_ERROR;

   153

   154

		if (flags & DC_EXEC) {

   155

			SignStruct *ss = GetSign(p1);

   156

   157

			/* Delete the old name */

   158

			DeleteName(ss->str);

   159

			/* Assign the new one */

   160

			ss->str = str;

   161

			ss->owner = _current_player;

   162

   163

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

   164

			MarkSignDirty(ss);

   165

			UpdateSignVirtCoords(ss);

   166

			MarkSignDirty(ss);

   167

			InvalidateWindow(WC_SIGN_LIST, 0);

   168

			_sign_sort_dirty = true;

   169

		} else {

   170

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

   171

			DeleteName(str);

   172

		}

   173

	} else { /* Delete sign */

   174

		if (flags & DC_EXEC) {

   175

			SignStruct *ss = GetSign(p1);

   176

   177

			/* Delete the name */

   178

			DeleteName(ss->str);

   179

			ss->str = 0;

   180

   181

			MarkSignDirty(ss);

   182

			InvalidateWindow(WC_SIGN_LIST, 0);

   183

			_sign_sort_dirty = true;

   184

		}

   185

	}

   186

   187

	return 0;

   188

}

   189

   190

/**

   191

 *

   192

 * Callback function that is called after a sign is placed

   193

 *

   194

 */

   195

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

   196

{

   197

	if (success) {

   198

		ShowRenameSignWindow(_new_sign_struct);

   199

		ResetObjectToPlace();

   200

	}

   201

}

   202

   203

/**

   204

 *

   205

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

   206

 *  sign-tool is selected

   207

 *

   208

 */

   209

void PlaceProc_Sign(TileIndex tile)

   210

{

   211

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

   212

}

   213

   214

/**

   215

 *

   216

 * Initialize the signs

   217

 *

   218

 */

   219

void InitializeSigns(void)

   220

{

   221

	CleanPool(&_sign_pool);

   222

	AddBlockToPool(&_sign_pool);

   223

}

   224

   225

static const SaveLoad _sign_desc[] = {

   226

	SLE_VAR(SignStruct,str,						SLE_UINT16),

   227

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

   228

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

   229

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

   230

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

   231

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

   232

	SLE_VAR(SignStruct,z,							SLE_UINT8),

   233

	SLE_END()

   234

};

   235

   236

/**

   237

 *

   238

 * Save all signs

   239

 *

   240

 */

   241

static void Save_SIGN(void)

   242

{

   243

	SignStruct *ss;

   244

   245

	FOR_ALL_SIGNS(ss) {

   246

		/* Don't save empty signs */

   247

		if (ss->str != 0) {

   248

			SlSetArrayIndex(ss->index);

   249

			SlObject(ss, _sign_desc);

   250

		}

   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

		SignStruct *ss;

   264

   265

		if (!AddBlockIfNeeded(&_sign_pool, index))

   266

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

   267

   268

		ss = GetSign(index);

   269

		SlObject(ss, _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

};