1

/* $Id$ */

     2

     3

/** @file group_cmd.cpp Handling of the engine groups */

     4

     5

#include "stdafx.h"

     6

#include "openttd.h"

     7

#include "variables.h"

     8

#include "table/strings.h"

     9

#include "command_func.h"

    10

#include "saveload.h"

    11

#include "debug.h"

    12

#include "group.h"

    13

#include "train.h"

    14

#include "aircraft.h"

    15

#include "vehicle_gui.h"

    16

#include "misc/autoptr.hpp"

    17

#include "strings_func.h"

    18

#include "functions.h"

    19

#include "window_func.h"

    20

#include "vehicle_func.h"

    21

#include "autoreplace_base.h"

    22

#include "autoreplace_func.h"

    23

#include "string_func.h"

    24

#include "player_func.h"

    25

    26

/**

    27

 * Update the num engines of a groupID. Decrease the old one and increase the new one

    28

 * @note called in SetTrainGroupID and UpdateTrainGroupID

    29

 * @param i     EngineID we have to update

    30

 * @param old_g index of the old group

    31

 * @param new_g index of the new group

    32

 */

    33

static inline void UpdateNumEngineGroup(EngineID i, GroupID old_g, GroupID new_g)

    34

{

    35

	if (old_g != new_g) {

    36

		/* Decrease the num engines of EngineID i of the old group if it's not the default one */

    37

		if (!IsDefaultGroupID(old_g) && IsValidGroupID(old_g)) GetGroup(old_g)->num_engines[i]--;

    38

    39

		/* Increase the num engines of EngineID i of the new group if it's not the new one */

    40

		if (!IsDefaultGroupID(new_g) && IsValidGroupID(new_g)) GetGroup(new_g)->num_engines[i]++;

    41

	}

    42

}

    43

    44

    45

DEFINE_OLD_POOL_GENERIC(Group, Group)

    46

    47

    48

Group::Group(PlayerID owner)

    49

{

    50

	this->owner = owner;

    51

}

    52

    53

Group::~Group()

    54

{

    56

	this->owner = INVALID_PLAYER;

    57

}

    58

    59

bool Group::IsValid() const

    60

{

    61

	return this->owner != INVALID_PLAYER;

    62

}

    63

    64

void InitializeGroup(void)

    65

{

    66

	_Group_pool.CleanPool();

    67

	_Group_pool.AddBlockToPool();

    68

}

    69

    70

    71

static WindowClass GetWCForVT(VehicleType vt)

    72

{

    73

	switch (vt) {

    74

		default:

    75

		case VEH_TRAIN:    return WC_TRAINS_LIST;

    76

		case VEH_ROAD:     return WC_ROADVEH_LIST;

    77

		case VEH_SHIP:     return WC_SHIPS_LIST;

    78

		case VEH_AIRCRAFT: return WC_AIRCRAFT_LIST;

    79

	}

    80

}

    81

    82

    83

/**

    84

 * Create a new vehicle group.

    85

 * @param tile unused

    86

 * @param p1   vehicle type

    87

 * @param p2   unused

    88

 */

    89

CommandCost CmdCreateGroup(TileIndex tile, uint32 flags, uint32 p1, uint32 p2)

    90

{

    91

	VehicleType vt = (VehicleType)p1;

    92

	if (!IsPlayerBuildableVehicleType(vt)) return CMD_ERROR;

    93

    94

	AutoPtrT<Group> g_auto_delete;

    95

    96

	Group *g = new Group(_current_player);

    97

	if (g == NULL) return CMD_ERROR;

    98

    99

	g_auto_delete = g;

   100

   101

	if (flags & DC_EXEC) {

   102

		g->replace_protection = false;

   103

		g->vehicle_type = vt;

   104

   105

		InvalidateWindowData(GetWCForVT(vt), (vt << 11) | VLW_GROUP_LIST | _current_player);

   106

   107

		g_auto_delete.Detach();

   108

	}

   109

   110

	return CommandCost();

   111

}

   112

   113

   114

/**

   115

 * Add all vehicles in the given group to the default group and then deletes the group.

   116

 * @param tile unused

   117

 * @param p1   index of array group

   118

 *      - p1 bit 0-15 : GroupID

   119

 * @param p2   unused

   120

 */

   121

CommandCost CmdDeleteGroup(TileIndex tile, uint32 flags, uint32 p1, uint32 p2)

   122

{

   123

	if (!IsValidGroupID(p1)) return CMD_ERROR;

   124

   125

	Group *g = GetGroup(p1);

   126

	if (g->owner != _current_player) return CMD_ERROR;

   127

   128

	if (flags & DC_EXEC) {

   129

		Vehicle *v;

   130

   131

		/* Add all vehicles belong to the group to the default group */

   132

		FOR_ALL_VEHICLES(v) {

   133

			if (v->group_id == g->index && v->type == g->vehicle_type) v->group_id = DEFAULT_GROUP;

   134

		}

   135

   136

		/* If we set an autoreplace for the group we delete, remove it. */

   137

		if (_current_player < MAX_PLAYERS) {

   138

			Player *p;

   139

			EngineRenew *er;

   140

   141

			p = GetPlayer(_current_player);

   142

			FOR_ALL_ENGINE_RENEWS(er) {

   143

				if (er->group_id == g->index) RemoveEngineReplacementForPlayer(p, er->from, g->index, flags);

   144

			}

   145

		}

   146

   147

		VehicleType vt = g->vehicle_type;

   148

   149

		/* Delete the Replace Vehicle Windows */

   150

		DeleteWindowById(WC_REPLACE_VEHICLE, g->vehicle_type);

   151

		delete g;

   152

   153

		InvalidateWindowData(GetWCForVT(vt), (vt << 11) | VLW_GROUP_LIST | _current_player);

   154

	}

   155

   156

	return CommandCost();

   157

}

   158

   159

static bool IsUniqueGroupName(const char *name)

   160

{

   161

	const Group *g;

   162

	char buf[512];

   163

   164

	FOR_ALL_GROUPS(g) {

   165

		SetDParam(0, g->index);

   166

		GetString(buf, STR_GROUP_NAME, lastof(buf));

   167

		if (strcmp(buf, name) == 0) return false;

   168

	}

   169

   170

	return true;

   171

}

   172

   173

/**

   174

 * Rename a group

   175

 * @param tile unused

   176

 * @param p1   index of array group

   177

 *   - p1 bit 0-15 : GroupID

   178

 * @param p2   unused

   179

 */

   180

CommandCost CmdRenameGroup(TileIndex tile, uint32 flags, uint32 p1, uint32 p2)

   181

{

   182

	if (!IsValidGroupID(p1) || StrEmpty(_cmd_text)) return CMD_ERROR;

   183

   184

	Group *g = GetGroup(p1);

   185

	if (g->owner != _current_player) return CMD_ERROR;

   186

   187

	if (!IsUniqueGroupName(_cmd_text)) return_cmd_error(STR_NAME_MUST_BE_UNIQUE);

   188

   189

	if (flags & DC_EXEC) {

   190

		/* Delete the old name */

   192

		/* Assign the new one */

   194

   195

		InvalidateWindowData(GetWCForVT(g->vehicle_type), (g->vehicle_type << 11) | VLW_GROUP_LIST | _current_player);

   196

	}

   197

   198

	return CommandCost();

   199

}

   200

   201

   202

/**

   203

 * Add a vehicle to a group

   204

 * @param tile unused

   205

 * @param p1   index of array group

   206

 *   - p1 bit 0-15 : GroupID

   207

 * @param p2   vehicle to add to a group

   208

 *   - p2 bit 0-15 : VehicleID

   209

 */

   210

CommandCost CmdAddVehicleGroup(TileIndex tile, uint32 flags, uint32 p1, uint32 p2)

   211

{

   212

	GroupID new_g = p1;

   213

   214

	if (!IsValidVehicleID(p2) || (!IsValidGroupID(new_g) && !IsDefaultGroupID(new_g))) return CMD_ERROR;

   215

   216

	Vehicle *v = GetVehicle(p2);

   217

   218

	if (IsValidGroupID(new_g)) {

   219

		Group *g = GetGroup(new_g);

   220

		if (g->owner != _current_player || g->vehicle_type != v->type) return CMD_ERROR;

   221

	}

   222

   223

	if (v->owner != _current_player || !v->IsPrimaryVehicle()) return CMD_ERROR;

   224

   225

	if (flags & DC_EXEC) {

   226

		DecreaseGroupNumVehicle(v->group_id);

   227

		IncreaseGroupNumVehicle(new_g);

   228

   229

		switch (v->type) {

   230

			default: NOT_REACHED();

   231

			case VEH_TRAIN:

   232

				SetTrainGroupID(v, new_g);

   233

				break;

   234

			case VEH_ROAD:

   235

			case VEH_SHIP:

   236

			case VEH_AIRCRAFT:

   237

				if (IsEngineCountable(v)) UpdateNumEngineGroup(v->engine_type, v->group_id, new_g);

   238

				v->group_id = new_g;

   239

				break;

   240

		}

   241

   242

		/* Update the Replace Vehicle Windows */

   243

		InvalidateWindow(WC_REPLACE_VEHICLE, v->type);

   244

		InvalidateWindowData(GetWCForVT(v->type), (v->type << 11) | VLW_GROUP_LIST | _current_player);

   245

	}

   246

   247

	return CommandCost();

   248

}

   249

   250

/**

   251

 * Add all shared vehicles of all vehicles from a group

   252

 * @param tile unused

   253

 * @param p1   index of group array

   254

 *  - p1 bit 0-15 : GroupID

   255

 * @param p2   type of vehicles

   256

 */

   257

CommandCost CmdAddSharedVehicleGroup(TileIndex tile, uint32 flags, uint32 p1, uint32 p2)

   258

{

   259

	VehicleType type = (VehicleType)p2;

   260

	if (!IsValidGroupID(p1) || !IsPlayerBuildableVehicleType(type)) return CMD_ERROR;

   261

   262

	if (flags & DC_EXEC) {

   263

		Vehicle *v;

   264

		VehicleType type = (VehicleType)p2;

   265

		GroupID id_g = p1;

   266

   267

		/* Find the first front engine which belong to the group id_g

   268

		 * then add all shared vehicles of this front engine to the group id_g */

   269

		FOR_ALL_VEHICLES(v) {

   270

			if (v->type == type && v->IsPrimaryVehicle()) {

   271

				if (v->group_id != id_g) continue;

   272

   273

				/* For each shared vehicles add it to the group */

   274

				for (Vehicle *v2 = GetFirstVehicleFromSharedList(v); v2 != NULL; v2 = v2->next_shared) {

   275

					if (v2->group_id != id_g) CmdAddVehicleGroup(tile, flags, id_g, v2->index);

   276

				}

   277

			}

   278

		}

   279

   280

		InvalidateWindowData(GetWCForVT(type), (type << 11) | VLW_GROUP_LIST | _current_player);

   281

	}

   282

   283

	return CommandCost();

   284

}

   285

   286

   287

/**

   288

 * Remove all vehicles from a group

   289

 * @param tile unused

   290

 * @param p1   index of group array

   291

 * - p1 bit 0-15 : GroupID

   292

 * @param p2   type of vehicles

   293

 */

   294

CommandCost CmdRemoveAllVehiclesGroup(TileIndex tile, uint32 flags, uint32 p1, uint32 p2)

   295

{

   296

	VehicleType type = (VehicleType)p2;

   297

	if (!IsValidGroupID(p1) || !IsPlayerBuildableVehicleType(type)) return CMD_ERROR;

   298

   299

	Group *g = GetGroup(p1);

   300

	if (g->owner != _current_player) return CMD_ERROR;

   301

   302

	if (flags & DC_EXEC) {

   303

		GroupID old_g = p1;

   304

		Vehicle *v;

   305

   306

		/* Find each Vehicle that belongs to the group old_g and add it to the default group */

   307

		FOR_ALL_VEHICLES(v) {

   308

			if (v->type == type && v->IsPrimaryVehicle()) {

   309

				if (v->group_id != old_g) continue;

   310

   311

				/* Add The Vehicle to the default group */

   312

				CmdAddVehicleGroup(tile, flags, DEFAULT_GROUP, v->index);

   313

			}

   314

		}

   315

   316

		InvalidateWindowData(GetWCForVT(type), (type << 11) | VLW_GROUP_LIST | _current_player);

   317

	}

   318

   319

	return CommandCost();

   320

}

   321

   322

   323

/**

   324

 * (Un)set global replace protection from a group

   325

 * @param tile unused

   326

 * @param p1   index of group array

   327

 * - p1 bit 0-15 : GroupID

   328

 * @param p2

   329

 * - p2 bit 0    : 1 to set or 0 to clear protection.

   330

 */

   331

CommandCost CmdSetGroupReplaceProtection(TileIndex tile, uint32 flags, uint32 p1, uint32 p2)

   332

{

   333

	if (!IsValidGroupID(p1)) return CMD_ERROR;

   334

   335

	Group *g = GetGroup(p1);

   336

	if (g->owner != _current_player) return CMD_ERROR;

   337

   338

	if (flags & DC_EXEC) {

   339

		g->replace_protection = HasBit(p2, 0);

   340

   341

		InvalidateWindowData(GetWCForVT(g->vehicle_type), (g->vehicle_type << 11) | VLW_GROUP_LIST | _current_player);

   342

	}

   343

   344

	return CommandCost();

   345

}

   346

   347

/**

   348

 * Decrease the num_vehicle variable before delete an front engine from a group

   349

 * @note Called in CmdSellRailWagon and DeleteLasWagon,

   350

 * @param v     FrontEngine of the train we want to remove.

   351

 */

   352

void RemoveVehicleFromGroup(const Vehicle *v)

   353

{

   354

	if (!v->IsValid() || !v->IsPrimaryVehicle()) return;

   355

   356

	if (!IsDefaultGroupID(v->group_id)) DecreaseGroupNumVehicle(v->group_id);

   357

}

   358

   359

   360

/**

   361

 * Affect the groupID of a train to new_g.

   362

 * @note called in CmdAddVehicleGroup and CmdMoveRailVehicle

   363

 * @param v     First vehicle of the chain.

   364

 * @param new_g index of array group

   365

 */

   366

void SetTrainGroupID(Vehicle *v, GroupID new_g)

   367

{

   368

	if (!IsValidGroupID(new_g) && !IsDefaultGroupID(new_g)) return;

   369

   370

	assert(v->IsValid() && v->type == VEH_TRAIN && IsFrontEngine(v));

   371

   372

	for (Vehicle *u = v; u != NULL; u = u->Next()) {

   373

		if (IsEngineCountable(u)) UpdateNumEngineGroup(u->engine_type, u->group_id, new_g);

   374

   375

		u->group_id = new_g;

   376

	}

   377

   378

	/* Update the Replace Vehicle Windows */

   379

	InvalidateWindow(WC_REPLACE_VEHICLE, VEH_TRAIN);

   380

}

   381

   382

   383

/**

   384

 * Recalculates the groupID of a train. Should be called each time a vehicle is added

   385

 * to/removed from the chain,.

   386

 * @note this needs to be called too for 'wagon chains' (in the depot, without an engine)

   387

 * @note Called in CmdBuildRailVehicle, CmdBuildRailWagon, CmdMoveRailVehicle, CmdSellRailWagon

   388

 * @param v First vehicle of the chain.

   389

 */

   390

void UpdateTrainGroupID(Vehicle *v)

   391

{

   392

	assert(v->IsValid() && v->type == VEH_TRAIN && (IsFrontEngine(v) || IsFreeWagon(v)));

   393

   394

	GroupID new_g = IsFrontEngine(v) ? v->group_id : (GroupID)DEFAULT_GROUP;

   395

	for (Vehicle *u = v; u != NULL; u = u->Next()) {

   396

		if (IsEngineCountable(u)) UpdateNumEngineGroup(u->engine_type, u->group_id, new_g);

   397

   398

		u->group_id = new_g;

   399

	}

   400

   401

	/* Update the Replace Vehicle Windows */

   402

	InvalidateWindow(WC_REPLACE_VEHICLE, VEH_TRAIN);

   403

}

   404

   405

uint GetGroupNumEngines(PlayerID p, GroupID id_g, EngineID id_e)

   406

{

   407

	if (IsValidGroupID(id_g)) return GetGroup(id_g)->num_engines[id_e];

   408

   409

	uint num = GetPlayer(p)->num_engines[id_e];

   410

	if (!IsDefaultGroupID(id_g)) return num;

   411

   412

	const Group *g;

   413

	FOR_ALL_GROUPS(g) {

   414

		if (g->owner == p) num -= g->num_engines[id_e];

   415

	}

   416

	return num;

   417

}

   418

   419

void RemoveAllGroupsForPlayer(const PlayerID p)

   420

{

   421

	Group *g;

   422

   423

	FOR_ALL_GROUPS(g) {

   424

		if (p == g->owner) delete g;

   425

	}

   426

}

   427

   428

   429

static const SaveLoad _group_desc[] = {

   432

  SLE_VAR(Group, num_vehicle,        SLE_UINT16),

   433

  SLE_VAR(Group, owner,              SLE_UINT8),

   434

  SLE_VAR(Group, vehicle_type,       SLE_UINT8),

   435

  SLE_VAR(Group, replace_protection, SLE_BOOL),

   436

  SLE_END()

   437

};

   438

   439

   440

static void Save_GROUP(void)

   441

{

   442

	Group *g;

   443

   444

	FOR_ALL_GROUPS(g) {

   445

		SlSetArrayIndex(g->index);

   446

		SlObject(g, _group_desc);

   447

	}

   448

}

   449

   450

   451

static void Load_GROUP(void)

   452

{

   453

	int index;

   454

   455

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

   456

		Group *g = new (index) Group();

   457

		SlObject(g, _group_desc);

   458

	}

   459

}

   460

   461

extern const ChunkHandler _group_chunk_handlers[] = {

   462

	{ 'GRPS', Save_GROUP, Load_GROUP, CH_ARRAY | CH_LAST},

   463

};