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

#include "order_func.h"

    25

    26

#include "table/strings.h"

    27

    28

/**

    29

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

    30

 * @note called in SetTrainGroupID and UpdateTrainGroupID

    31

 * @param i     EngineID we have to update

    32

 * @param old_g index of the old group

    33

 * @param new_g index of the new group

    34

 */

    35

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

    36

{

    37

	if (old_g != new_g) {

    38

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

    39

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

    40

    41

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

    42

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

    43

	}

    44

}

    45

    46

    47

DEFINE_OLD_POOL_GENERIC(Group, Group)

    48

    49

    50

Group::Group(PlayerID owner)

    51

{

    52

	this->owner = owner;

    53

}

    54

    55

Group::~Group()

    56

{

    57

	free(this->name);

    58

	this->owner = INVALID_PLAYER;

    59

}

    60

    61

bool Group::IsValid() const

    62

{

    63

	return this->owner != INVALID_PLAYER;

    64

}

    65

    66

void InitializeGroup(void)

    67

{

    68

	_Group_pool.CleanPool();

    69

	_Group_pool.AddBlockToPool();

    70

}

    71

    72

    73

static WindowClass GetWCForVT(VehicleType vt)

    74

{

    75

	switch (vt) {

    76

		default:

    77

		case VEH_TRAIN:    return WC_TRAINS_LIST;

    78

		case VEH_ROAD:     return WC_ROADVEH_LIST;

    79

		case VEH_SHIP:     return WC_SHIPS_LIST;

    80

		case VEH_AIRCRAFT: return WC_AIRCRAFT_LIST;

    81

	}

    82

}

    83

    84

    85

/**

    86

 * Create a new vehicle group.

    87

 * @param tile unused

    88

 * @param p1   vehicle type

    89

 * @param p2   unused

    90

 */

    91

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

    92

{

    93

	VehicleType vt = (VehicleType)p1;

    94

	if (!IsPlayerBuildableVehicleType(vt)) return CMD_ERROR;

    95

    96

	AutoPtrT<Group> g_auto_delete;

    97

    98

	Group *g = new Group(_current_player);

    99

	if (g == NULL) return CMD_ERROR;

   100

   101

	g_auto_delete = g;

   102

   103

	if (flags & DC_EXEC) {

   104

		g->replace_protection = false;

   105

		g->vehicle_type = vt;

   106

   107

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

   108

   109

		g_auto_delete.Detach();

   110

	}

   111

   112

	return CommandCost();

   113

}

   114

   115

   116

/**

   117

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

   118

 * @param tile unused

   119

 * @param p1   index of array group

   120

 *      - p1 bit 0-15 : GroupID

   121

 * @param p2   unused

   122

 */

   123

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

   124

{

   125

	if (!IsValidGroupID(p1)) return CMD_ERROR;

   126

   127

	Group *g = GetGroup(p1);

   128

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

   129

   130

	if (flags & DC_EXEC) {

   131

		Vehicle *v;

   132

   133

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

   134

		FOR_ALL_VEHICLES(v) {

   135

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

   136

		}

   137

   138

		/* Update backupped orders if needed */

   139

		if (_backup_orders_data.group == g->index) _backup_orders_data.group = DEFAULT_GROUP;

   140

   141

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

   142

		if (_current_player < MAX_PLAYERS) {

   143

			Player *p;

   144

			EngineRenew *er;

   145

   146

			p = GetPlayer(_current_player);

   147

			FOR_ALL_ENGINE_RENEWS(er) {

   148

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

   149

			}

   150

		}

   151

   152

		VehicleType vt = g->vehicle_type;

   153

   154

		/* Delete the Replace Vehicle Windows */

   155

		DeleteWindowById(WC_REPLACE_VEHICLE, g->vehicle_type);

   156

		delete g;

   157

   158

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

   159

	}

   160

   161

	return CommandCost();

   162

}

   163

   164

static bool IsUniqueGroupName(const char *name)

   165

{

   166

	const Group *g;

   167

	char buf[512];

   168

   169

	FOR_ALL_GROUPS(g) {

   170

		SetDParam(0, g->index);

   171

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

   172

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

   173

	}

   174

   175

	return true;

   176

}

   177

   178

/**

   179

 * Rename a group

   180

 * @param tile unused

   181

 * @param p1   index of array group

   182

 *   - p1 bit 0-15 : GroupID

   183

 * @param p2   unused

   184

 */

   185

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

   186

{

   187

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

   188

   189

	Group *g = GetGroup(p1);

   190

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

   191

   192

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

   193

   194

	if (flags & DC_EXEC) {

   195

		/* Delete the old name */

   196

		free(g->name);

   197

		/* Assign the new one */

   198

		g->name = strdup(_cmd_text);

   199

   200

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

   201

	}

   202

   203

	return CommandCost();

   204

}

   205

   206

   207

/**

   208

 * Add a vehicle to a group

   209

 * @param tile unused

   210

 * @param p1   index of array group

   211

 *   - p1 bit 0-15 : GroupID

   212

 * @param p2   vehicle to add to a group

   213

 *   - p2 bit 0-15 : VehicleID

   214

 */

   215

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

   216

{

   217

	GroupID new_g = p1;

   218

   219

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

   220

   221

	Vehicle *v = GetVehicle(p2);

   222

   223

	if (IsValidGroupID(new_g)) {

   224

		Group *g = GetGroup(new_g);

   225

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

   226

	}

   227

   228

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

   229

   230

	if (flags & DC_EXEC) {

   231

		DecreaseGroupNumVehicle(v->group_id);

   232

		IncreaseGroupNumVehicle(new_g);

   233

   234

		switch (v->type) {

   235

			default: NOT_REACHED();

   236

			case VEH_TRAIN:

   237

				SetTrainGroupID(v, new_g);

   238

				break;

   239

			case VEH_ROAD:

   240

			case VEH_SHIP:

   241

			case VEH_AIRCRAFT:

   242

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

   243

				v->group_id = new_g;

   244

				break;

   245

		}

   246

   247

		/* Update the Replace Vehicle Windows */

   248

		InvalidateWindow(WC_REPLACE_VEHICLE, v->type);

   249

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

   250

	}

   251

   252

	return CommandCost();

   253

}

   254

   255

/**

   256

 * Add all shared vehicles of all vehicles from a group

   257

 * @param tile unused

   258

 * @param p1   index of group array

   259

 *  - p1 bit 0-15 : GroupID

   260

 * @param p2   type of vehicles

   261

 */

   262

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

   263

{

   264

	VehicleType type = (VehicleType)p2;

   265

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

   266

   267

	if (flags & DC_EXEC) {

   268

		Vehicle *v;

   269

		VehicleType type = (VehicleType)p2;

   270

		GroupID id_g = p1;

   271

   272

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

   273

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

   274

		FOR_ALL_VEHICLES(v) {

   275

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

   276

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

   277

   278

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

   279

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

   280

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

   281

				}

   282

			}

   283

		}

   284

   285

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

   286

	}

   287

   288

	return CommandCost();

   289

}

   290

   291

   292

/**

   293

 * Remove all vehicles from a group

   294

 * @param tile unused

   295

 * @param p1   index of group array

   296

 * - p1 bit 0-15 : GroupID

   297

 * @param p2   type of vehicles

   298

 */

   299

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

   300

{

   301

	VehicleType type = (VehicleType)p2;

   302

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

   303

   304

	Group *g = GetGroup(p1);

   305

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

   306

   307

	if (flags & DC_EXEC) {

   308

		GroupID old_g = p1;

   309

		Vehicle *v;

   310

   311

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

   312

		FOR_ALL_VEHICLES(v) {

   313

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

   314

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

   315

   316

				/* Add The Vehicle to the default group */

   317

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

   318

			}

   319

		}

   320

   321

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

   322

	}

   323

   324

	return CommandCost();

   325

}

   326

   327

   328

/**

   329

 * (Un)set global replace protection from a group

   330

 * @param tile unused

   331

 * @param p1   index of group array

   332

 * - p1 bit 0-15 : GroupID

   333

 * @param p2

   334

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

   335

 */

   336

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

   337

{

   338

	if (!IsValidGroupID(p1)) return CMD_ERROR;

   339

   340

	Group *g = GetGroup(p1);

   341

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

   342

   343

	if (flags & DC_EXEC) {

   344

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

   345

   346

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

   347

	}

   348

   349

	return CommandCost();

   350

}

   351

   352

/**

   353

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

   354

 * @note Called in CmdSellRailWagon and DeleteLasWagon,

   355

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

   356

 */

   357

void RemoveVehicleFromGroup(const Vehicle *v)

   358

{

   359

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

   360

   361

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

   362

}

   363

   364

   365

/**

   366

 * Affect the groupID of a train to new_g.

   367

 * @note called in CmdAddVehicleGroup and CmdMoveRailVehicle

   368

 * @param v     First vehicle of the chain.

   369

 * @param new_g index of array group

   370

 */

   371

void SetTrainGroupID(Vehicle *v, GroupID new_g)

   372

{

   373

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

   374

   375

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

   376

   377

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

   378

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

   379

   380

		u->group_id = new_g;

   381

	}

   382

   383

	/* Update the Replace Vehicle Windows */

   384

	InvalidateWindow(WC_REPLACE_VEHICLE, VEH_TRAIN);

   385

}

   386

   387

   388

/**

   389

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

   390

 * to/removed from the chain,.

   391

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

   392

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

   393

 * @param v First vehicle of the chain.

   394

 */

   395

void UpdateTrainGroupID(Vehicle *v)

   396

{

   397

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

   398

   399

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

   400

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

   401

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

   402

   403

		u->group_id = new_g;

   404

	}

   405

   406

	/* Update the Replace Vehicle Windows */

   407

	InvalidateWindow(WC_REPLACE_VEHICLE, VEH_TRAIN);

   408

}

   409

   410

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

   411

{

   412

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

   413

   414

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

   415

	if (!IsDefaultGroupID(id_g)) return num;

   416

   417

	const Group *g;

   418

	FOR_ALL_GROUPS(g) {

   419

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

   420

	}

   421

	return num;

   422

}

   423

   424

void RemoveAllGroupsForPlayer(const PlayerID p)

   425

{

   426

	Group *g;

   427

   428

	FOR_ALL_GROUPS(g) {

   429

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

   430

	}

   431

}

   432

   433

   434

static const SaveLoad _group_desc[] = {

   435

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

   436

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

   437

  SLE_VAR(Group, num_vehicle,        SLE_UINT16),

   438

  SLE_VAR(Group, owner,              SLE_UINT8),

   439

  SLE_VAR(Group, vehicle_type,       SLE_UINT8),

   440

  SLE_VAR(Group, replace_protection, SLE_BOOL),

   441

  SLE_END()

   442

};

   443

   444

   445

static void Save_GROUP(void)

   446

{

   447

	Group *g;

   448

   449

	FOR_ALL_GROUPS(g) {

   450

		SlSetArrayIndex(g->index);

   451

		SlObject(g, _group_desc);

   452

	}

   453

}

   454

   455

   456

static void Load_GROUP(void)

   457

{

   458

	int index;

   459

   460

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

   461

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

   462

		SlObject(g, _group_desc);

   463

	}

   464

}

   465

   466

extern const ChunkHandler _group_chunk_handlers[] = {

   467

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

   468

};