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

     9

#include "saveload.h"

    10

#include "debug.h"

    11

#include "group.h"

    12

#include "train.h"

    13

#include "aircraft.h"

    14

#include "vehicle_gui.h"

    15

#include "misc/autoptr.hpp"

    16

#include "strings_func.h"

    17

#include "functions.h"

    18

#include "window_func.h"

    19

#include "vehicle_func.h"

    20

#include "autoreplace_base.h"

    21

#include "autoreplace_func.h"

    22

#include "string_func.h"

    23

#include "player_func.h"

    24

    27

/**

    28

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

    29

 * @note called in SetTrainGroupID and UpdateTrainGroupID

    30

 * @param i     EngineID we have to update

    31

 * @param old_g index of the old group

    32

 * @param new_g index of the new group

    33

 */

    34

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

    35

{

    36

	if (old_g != new_g) {

    37

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

    38

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

    39

    40

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

    41

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

    42

	}

    43

}

    44

    45

    46

DEFINE_OLD_POOL_GENERIC(Group, Group)

    47

    48

    49

Group::Group(PlayerID owner)

    50

{

    51

	this->owner = owner;

    52

}

    53

    54

Group::~Group()

    55

{

    56

	free(this->name);

    57

	this->owner = INVALID_PLAYER;

    58

}

    59

    60

bool Group::IsValid() const

    61

{

    62

	return this->owner != INVALID_PLAYER;

    63

}

    64

    65

void InitializeGroup(void)

    66

{

    67

	_Group_pool.CleanPool();

    68

	_Group_pool.AddBlockToPool();

    69

}

    70

    71

    72

static WindowClass GetWCForVT(VehicleType vt)

    73

{

    74

	switch (vt) {

    75

		default:

    76

		case VEH_TRAIN:    return WC_TRAINS_LIST;

    77

		case VEH_ROAD:     return WC_ROADVEH_LIST;

    78

		case VEH_SHIP:     return WC_SHIPS_LIST;

    79

		case VEH_AIRCRAFT: return WC_AIRCRAFT_LIST;

    80

	}

    81

}

    82

    83

    84

/**

    85

 * Create a new vehicle group.

    86

 * @param tile unused

    87

 * @param p1   vehicle type

    88

 * @param p2   unused

    89

 */

    90

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

    91

{

    92

	VehicleType vt = (VehicleType)p1;

    93

	if (!IsPlayerBuildableVehicleType(vt)) return CMD_ERROR;

    94

    95

	AutoPtrT<Group> g_auto_delete;

    96

    97

	Group *g = new Group(_current_player);

    98

	if (g == NULL) return CMD_ERROR;

    99

   100

	g_auto_delete = g;

   101

   102

	if (flags & DC_EXEC) {

   103

		g->replace_protection = false;

   104

		g->vehicle_type = vt;

   105

   106

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

   107

   108

		g_auto_delete.Detach();

   109

	}

   110

   111

	return CommandCost();

   112

}

   113

   114

   115

/**

   116

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

   117

 * @param tile unused

   118

 * @param p1   index of array group

   119

 *      - p1 bit 0-15 : GroupID

   120

 * @param p2   unused

   121

 */

   122

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

   123

{

   124

	if (!IsValidGroupID(p1)) return CMD_ERROR;

   125

   126

	Group *g = GetGroup(p1);

   127

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

   128

   129

	if (flags & DC_EXEC) {

   130

		Vehicle *v;

   131

   132

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

   133

		FOR_ALL_VEHICLES(v) {

   134

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

   135

		}

   136

   137

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

   138

		if (_current_player < MAX_PLAYERS) {

   139

			Player *p;

   140

			EngineRenew *er;

   141

   142

			p = GetPlayer(_current_player);

   143

			FOR_ALL_ENGINE_RENEWS(er) {

   144

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

   145

			}

   146

		}

   147

   148

		VehicleType vt = g->vehicle_type;

   149

   150

		/* Delete the Replace Vehicle Windows */

   151

		DeleteWindowById(WC_REPLACE_VEHICLE, g->vehicle_type);

   152

		delete g;

   153

   154

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

   155

	}

   156

   157

	return CommandCost();

   158

}

   159

   160

static bool IsUniqueGroupName(const char *name)

   161

{

   162

	const Group *g;

   163

	char buf[512];

   164

   165

	FOR_ALL_GROUPS(g) {

   166

		SetDParam(0, g->index);

   167

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

   168

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

   169

	}

   170

   171

	return true;

   172

}

   173

   174

/**

   175

 * Rename a group

   176

 * @param tile unused

   177

 * @param p1   index of array group

   178

 *   - p1 bit 0-15 : GroupID

   179

 * @param p2   unused

   180

 */

   181

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

   182

{

   183

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

   184

   185

	Group *g = GetGroup(p1);

   186

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

   187

   188

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

   189

   190

	if (flags & DC_EXEC) {

   191

		/* Delete the old name */

   192

		free(g->name);

   193

		/* Assign the new one */

   194

		g->name = strdup(_cmd_text);

   195

   196

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

   197

	}

   198

   199

	return CommandCost();

   200

}

   201

   202

   203

/**

   204

 * Add a vehicle to a group

   205

 * @param tile unused

   206

 * @param p1   index of array group

   207

 *   - p1 bit 0-15 : GroupID

   208

 * @param p2   vehicle to add to a group

   209

 *   - p2 bit 0-15 : VehicleID

   210

 */

   211

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

   212

{

   213

	GroupID new_g = p1;

   214

   215

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

   216

   217

	Vehicle *v = GetVehicle(p2);

   218

   219

	if (IsValidGroupID(new_g)) {

   220

		Group *g = GetGroup(new_g);

   221

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

   222

	}

   223

   224

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

   225

   226

	if (flags & DC_EXEC) {

   227

		DecreaseGroupNumVehicle(v->group_id);

   228

		IncreaseGroupNumVehicle(new_g);

   229

   230

		switch (v->type) {

   231

			default: NOT_REACHED();

   232

			case VEH_TRAIN:

   233

				SetTrainGroupID(v, new_g);

   234

				break;

   235

			case VEH_ROAD:

   236

			case VEH_SHIP:

   237

			case VEH_AIRCRAFT:

   238

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

   239

				v->group_id = new_g;

   240

				break;

   241

		}

   242

   243

		/* Update the Replace Vehicle Windows */

   244

		InvalidateWindow(WC_REPLACE_VEHICLE, v->type);

   245

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

   246

	}

   247

   248

	return CommandCost();

   249

}

   250

   251

/**

   252

 * Add all shared vehicles of all vehicles from a group

   253

 * @param tile unused

   254

 * @param p1   index of group array

   255

 *  - p1 bit 0-15 : GroupID

   256

 * @param p2   type of vehicles

   257

 */

   258

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

   259

{

   260

	VehicleType type = (VehicleType)p2;

   261

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

   262

   263

	if (flags & DC_EXEC) {

   264

		Vehicle *v;

   265

		VehicleType type = (VehicleType)p2;

   266

		GroupID id_g = p1;

   267

   268

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

   269

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

   270

		FOR_ALL_VEHICLES(v) {

   271

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

   272

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

   273

   274

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

   275

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

   276

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

   277

				}

   278

			}

   279

		}

   280

   281

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

   282

	}

   283

   284

	return CommandCost();

   285

}

   286

   287

   288

/**

   289

 * Remove all vehicles from a group

   290

 * @param tile unused

   291

 * @param p1   index of group array

   292

 * - p1 bit 0-15 : GroupID

   293

 * @param p2   type of vehicles

   294

 */

   295

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

   296

{

   297

	VehicleType type = (VehicleType)p2;

   298

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

   299

   300

	Group *g = GetGroup(p1);

   301

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

   302

   303

	if (flags & DC_EXEC) {

   304

		GroupID old_g = p1;

   305

		Vehicle *v;

   306

   307

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

   308

		FOR_ALL_VEHICLES(v) {

   309

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

   310

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

   311

   312

				/* Add The Vehicle to the default group */

   313

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

   314

			}

   315

		}

   316

   317

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

   318

	}

   319

   320

	return CommandCost();

   321

}

   322

   323

   324

/**

   325

 * (Un)set global replace protection from a group

   326

 * @param tile unused

   327

 * @param p1   index of group array

   328

 * - p1 bit 0-15 : GroupID

   329

 * @param p2

   330

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

   331

 */

   332

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

   333

{

   334

	if (!IsValidGroupID(p1)) return CMD_ERROR;

   335

   336

	Group *g = GetGroup(p1);

   337

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

   338

   339

	if (flags & DC_EXEC) {

   340

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

   341

   342

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

   343

	}

   344

   345

	return CommandCost();

   346

}

   347

   348

/**

   349

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

   350

 * @note Called in CmdSellRailWagon and DeleteLasWagon,

   351

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

   352

 */

   353

void RemoveVehicleFromGroup(const Vehicle *v)

   354

{

   355

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

   356

   357

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

   358

}

   359

   360

   361

/**

   362

 * Affect the groupID of a train to new_g.

   363

 * @note called in CmdAddVehicleGroup and CmdMoveRailVehicle

   364

 * @param v     First vehicle of the chain.

   365

 * @param new_g index of array group

   366

 */

   367

void SetTrainGroupID(Vehicle *v, GroupID new_g)

   368

{

   369

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

   370

   371

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

   372

   373

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

   374

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

   375

   376

		u->group_id = new_g;

   377

	}

   378

   379

	/* Update the Replace Vehicle Windows */

   380

	InvalidateWindow(WC_REPLACE_VEHICLE, VEH_TRAIN);

   381

}

   382

   383

   384

/**

   385

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

   386

 * to/removed from the chain,.

   387

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

   388

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

   389

 * @param v First vehicle of the chain.

   390

 */

   391

void UpdateTrainGroupID(Vehicle *v)

   392

{

   393

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

   394

   395

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

   396

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

   397

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

   398

   399

		u->group_id = new_g;

   400

	}

   401

   402

	/* Update the Replace Vehicle Windows */

   403

	InvalidateWindow(WC_REPLACE_VEHICLE, VEH_TRAIN);

   404

}

   405

   406

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

   407

{

   408

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

   409

   410

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

   411

	if (!IsDefaultGroupID(id_g)) return num;

   412

   413

	const Group *g;

   414

	FOR_ALL_GROUPS(g) {

   415

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

   416

	}

   417

	return num;

   418

}

   419

   420

void RemoveAllGroupsForPlayer(const PlayerID p)

   421

{

   422

	Group *g;

   423

   424

	FOR_ALL_GROUPS(g) {

   425

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

   426

	}

   427

}

   428

   429

   430

static const SaveLoad _group_desc[] = {

   431

  SLE_CONDVAR(Group, name,           SLE_NAME,    0, 83),

   432

  SLE_CONDSTR(Group, name,           SLE_STR, 0, 84, SL_MAX_VERSION),

   433

  SLE_VAR(Group, num_vehicle,        SLE_UINT16),

   434

  SLE_VAR(Group, owner,              SLE_UINT8),

   435

  SLE_VAR(Group, vehicle_type,       SLE_UINT8),

   436

  SLE_VAR(Group, replace_protection, SLE_BOOL),

   437

  SLE_END()

   438

};

   439

   440

   441

static void Save_GROUP(void)

   442

{

   443

	Group *g;

   444

   445

	FOR_ALL_GROUPS(g) {

   446

		SlSetArrayIndex(g->index);

   447

		SlObject(g, _group_desc);

   448

	}

   449

}

   450

   451

   452

static void Load_GROUP(void)

   453

{

   454

	int index;

   455

   456

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

   457

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

   458

		SlObject(g, _group_desc);

   459

	}

   460

}

   461

   462

extern const ChunkHandler _group_chunk_handlers[] = {

   463

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

   464

};