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 "strings.h"

    12

#include "variables.h"

    13

    14

enum {

    15

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

    16

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

    17

	SIGN_POOL_MAX_BLOCKS      = 16000,

    18

};

    19

    20

/**

    21

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

    22

 */

    23

static void SignPoolNewBlock(uint start_item)

    24

{

    25

	SignStruct *ss;

    26

    27

	FOR_ALL_SIGNS_FROM(ss, start_item)

    28

		ss->index = start_item++;

    29

}

    30

    31

/* Initialize the sign-pool */

    32

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

    33

    34

/**

    35

 *

    36

 * Update the coordinate of one sign

    37

 *

    38

 */

    39

static void UpdateSignVirtCoords(SignStruct *ss)

    40

{

    41

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

    42

	SetDParam(0, ss->str);

    43

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

    44

}

    45

    46

/**

    47

 *

    48

 * Update the coordinates of all signs

    49

 *

    50

 */

    51

void UpdateAllSignVirtCoords(void)

    52

{

    53

	SignStruct *ss;

    54

    55

	FOR_ALL_SIGNS(ss)

    56

		if (ss->str != 0)

    57

			UpdateSignVirtCoords(ss);

    58

    59

}

    60

    61

/**

    62

 *

    63

 * Marks the region of a sign as dirty

    64

 *

    65

 * @param ss Pointer to the SignStruct

    66

 */

    67

static void MarkSignDirty(SignStruct *ss)

    68

{

    69

	MarkAllViewportsDirty(

    70

		ss->sign.left - 6,

    71

		ss->sign.top  - 3,

    72

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

    73

		ss->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 SignStruct *AllocateSign(void)

    83

{

    84

	SignStruct *ss;

    85

	FOR_ALL_SIGNS(ss) {

    86

		if (ss->str == 0) {

    87

			uint index = ss->index;

    88

    89

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

    90

			ss->index = index;

    91

    92

			return ss;

    93

		}

    94

	}

    95

    96

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

    97

	if (AddBlockToPool(&_sign_pool))

    98

		return AllocateSign();

    99

   100

	return NULL;

   101

}

   102

   103

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

   104

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

   105

 * but everybody is able to rename/remove it.

   106

 * @param x,y coordinates to place sign at

   107

 * @param p1 unused

   108

 * @param p2 unused

   109

 */

   110

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

   111

{

   112

	SignStruct *ss;

   113

   114

	/* Try to locate a new sign */

   115

	ss = AllocateSign();

   116

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

   117

   118

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

   119

	if (flags & DC_EXEC) {

   120

		ss->str = STR_280A_SIGN;

   121

		ss->x = x;

   122

		ss->y = y;

   123

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

   124

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

   125

		UpdateSignVirtCoords(ss);

   126

		MarkSignDirty(ss);

   127

		InvalidateWindow(WC_SIGN_LIST, 0);

   128

		_sign_sort_dirty = true;

   129

		_new_sign_struct = ss;

   130

	}

   131

   132

	return 0;

   133

}

   134

   135

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

   136

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

   137

 * has no meaning/effect whatsoever except for eyecandy

   138

 * @param x,y unused

   139

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

   140

 * @param p2 unused

   141

 */

   142

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

   143

{

   144

	if (!IsSignIndex(p1)) return CMD_ERROR;

   145

   146

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

   147

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

   148

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

   149

		/* Create the name */

   150

		StringID str = AllocateName(_cmd_text, 0);

   151

		if (str == 0) return CMD_ERROR;

   152

   153

		if (flags & DC_EXEC) {

   154

			SignStruct *ss = GetSign(p1);

   155

   156

			/* Delete the old name */

   157

			DeleteName(ss->str);

   158

			/* Assign the new one */

   159

			ss->str = str;

   160

			ss->owner = _current_player;

   161

   162

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

   163

			MarkSignDirty(ss);

   164

			UpdateSignVirtCoords(ss);

   165

			MarkSignDirty(ss);

   166

			InvalidateWindow(WC_SIGN_LIST, 0);

   167

			_sign_sort_dirty = true;

   168

		} else {

   169

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

   170

			DeleteName(str);

   171

		}

   172

	} else { /* Delete sign */

   173

		if (flags & DC_EXEC) {

   174

			SignStruct *ss = GetSign(p1);

   175

   176

			/* Delete the name */

   177

			DeleteName(ss->str);

   178

			ss->str = 0;

   179

   180

			MarkSignDirty(ss);

   181

			InvalidateWindow(WC_SIGN_LIST, 0);

   182

			_sign_sort_dirty = true;

   183

		}

   184

	}

   185

   186

	return 0;

   187

}

   188

   189

/**

   190

 *

   191

 * Callback function that is called after a sign is placed

   192

 *

   193

 */

   194

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

   195

{

   196

	if (success) {

   197

		ShowRenameSignWindow(_new_sign_struct);

   198

		ResetObjectToPlace();

   199

	}

   200

}

   201

   202

/**

   203

 *

   204

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

   205

 *  sign-tool is selected

   206

 *

   207

 */

   208

void PlaceProc_Sign(TileIndex tile)

   209

{

   210

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

   211

}

   212

   213

/**

   214

 *

   215

 * Initialize the signs

   216

 *

   217

 */

   218

void InitializeSigns(void)

   219

{

   220

	CleanPool(&_sign_pool);

   221

	AddBlockToPool(&_sign_pool);

   222

}

   223

   224

static const SaveLoad _sign_desc[] = {

   225

	SLE_VAR(SignStruct,str,						SLE_UINT16),

   226

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

   227

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

   228

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

   229

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

   230

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

   231

	SLE_VAR(SignStruct,z,							SLE_UINT8),

   232

	SLE_END()

   233

};

   234

   235

/**

   236

 *

   237

 * Save all signs

   238

 *

   239

 */

   240

static void Save_SIGN(void)

   241

{

   242

	SignStruct *ss;

   243

   244

	FOR_ALL_SIGNS(ss) {

   245

		/* Don't save empty signs */

   246

		if (ss->str != 0) {

   247

			SlSetArrayIndex(ss->index);

   248

			SlObject(ss, _sign_desc);

   249

		}

   250

	}

   251

}

   252

   253

/**

   254

 *

   255

 * Load all signs

   256

 *

   257

 */

   258

static void Load_SIGN(void)

   259

{

   260

	int index;

   261

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

   262

		SignStruct *ss;

   263

   264

		if (!AddBlockIfNeeded(&_sign_pool, index))

   265

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

   266

   267

		ss = GetSign(index);

   268

		SlObject(ss, _sign_desc);

   269

	}

   270

   271

	_sign_sort_dirty = true;

   272

}

   273

   274

const ChunkHandler _sign_chunk_handlers[] = {

   275

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

   276

};