OpenTTD Source  12.0-beta2
autoreplace.cpp
Go to the documentation of this file.
1 /*
2  * This file is part of OpenTTD.
3  * OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
4  * OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
5  * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
6  */
7 
10 #include "stdafx.h"
11 #include "command_func.h"
12 #include "group.h"
13 #include "autoreplace_base.h"
14 #include "core/bitmath_func.hpp"
15 #include "core/pool_func.hpp"
16 
17 #include "safeguards.h"
18 
20 EngineRenewPool _enginerenew_pool("EngineRenew");
22 
23 
28 {
29  EngineRenew *er = (EngineRenew *)erl;
30 
31  while (er != nullptr) {
32  if (er->from == engine && GroupIsInGroup(group, er->group_id)) return er;
33  er = er->next;
34  }
35  return nullptr;
36 }
37 
44 {
45  EngineRenew *er = (EngineRenew *)(*erl);
46  EngineRenew *next;
47 
48  while (er != nullptr) {
49  next = er->next;
50  delete er;
51  er = next;
52  }
53  *erl = nullptr; // Empty list
54 }
55 
65 EngineID EngineReplacement(EngineRenewList erl, EngineID engine, GroupID group, bool *replace_when_old)
66 {
67  const EngineRenew *er = GetEngineReplacement(erl, engine, group);
68  if (er == nullptr && (group == DEFAULT_GROUP || (Group::IsValidID(group) && !HasBit(Group::Get(group)->flags, GroupFlags::GF_REPLACE_PROTECTION)))) {
69  /* We didn't find anything useful in the vehicle's own group so we will try ALL_GROUP */
70  er = GetEngineReplacement(erl, engine, ALL_GROUP);
71  }
72  if (replace_when_old != nullptr) *replace_when_old = er == nullptr ? false : er->replace_when_old;
73  return er == nullptr ? INVALID_ENGINE : er->to;
74 }
75 
86 CommandCost AddEngineReplacement(EngineRenewList *erl, EngineID old_engine, EngineID new_engine, GroupID group, bool replace_when_old, DoCommandFlag flags)
87 {
88  /* Check if the old vehicle is already in the list */
89  EngineRenew *er = GetEngineReplacement(*erl, old_engine, group);
90  if (er != nullptr) {
91  if (flags & DC_EXEC) {
92  er->to = new_engine;
93  er->replace_when_old = replace_when_old;
94  }
95  return CommandCost();
96  }
97 
99 
100  if (flags & DC_EXEC) {
101  er = new EngineRenew(old_engine, new_engine);
102  er->group_id = group;
103  er->replace_when_old = replace_when_old;
104 
105  /* Insert before the first element */
106  er->next = (EngineRenew *)(*erl);
107  *erl = (EngineRenewList)er;
108  }
109 
110  return CommandCost();
111 }
112 
122 {
123  EngineRenew *er = (EngineRenew *)(*erl);
124  EngineRenew *prev = nullptr;
125 
126  while (er != nullptr) {
127  if (er->from == engine && er->group_id == group) {
128  if (flags & DC_EXEC) {
129  if (prev == nullptr) { // First element
130  /* The second becomes the new first element */
131  *erl = (EngineRenewList)er->next;
132  } else {
133  /* Cut this element out */
134  prev->next = er->next;
135  }
136  delete er;
137  }
138  return CommandCost();
139  }
140  prev = er;
141  er = er->next;
142  }
143 
144  return CMD_ERROR;
145 }
INVALID_ENGINE
static const EngineID INVALID_ENGINE
Constant denoting an invalid engine.
Definition: engine_type.h:175
EngineRenew::replace_when_old
bool replace_when_old
Do replacement only when vehicle is old.
Definition: autoreplace_base.h:38
autoreplace_base.h
Pool::PoolItem<&_group_pool >::Get
static Titem * Get(size_t index)
Returns Titem with given index.
Definition: pool_type.hpp:337
GF_REPLACE_PROTECTION
@ GF_REPLACE_PROTECTION
If set to true, the global autoreplace has no effect on the group.
Definition: group.h:66
command_func.h
CMD_ERROR
static const CommandCost CMD_ERROR
Define a default return value for a failed command.
Definition: command_func.h:23
_enginerenew_pool
EngineRenewPool _enginerenew_pool("EngineRenew")
The pool of autoreplace "orders".
RemoveEngineReplacement
CommandCost RemoveEngineReplacement(EngineRenewList *erl, EngineID engine, GroupID group, DoCommandFlag flags)
Remove an engine replacement from a given renewlist.
Definition: autoreplace.cpp:121
EngineRenewList
EngineRenew * EngineRenewList
A list to group EngineRenew directives together (such as per-company).
Definition: autoreplace_type.h:13
HasBit
static bool HasBit(const T x, const uint8 y)
Checks if a bit in a value is set.
Definition: bitmath_func.hpp:103
group.h
DC_EXEC
@ DC_EXEC
execute the given command
Definition: command_type.h:348
DoCommandFlag
DoCommandFlag
List of flags for a command.
Definition: command_type.h:346
ALL_GROUP
static const GroupID ALL_GROUP
All vehicles are in this group.
Definition: group_type.h:16
bitmath_func.hpp
EngineID
uint16 EngineID
Unique identification number of an engine.
Definition: engine_type.h:21
CommandCost
Common return value for all commands.
Definition: command_type.h:23
EngineReplacement
EngineID EngineReplacement(EngineRenewList erl, EngineID engine, GroupID group, bool *replace_when_old)
Retrieve the engine replacement in a given renewlist for an original engine type.
Definition: autoreplace.cpp:65
GetEngineReplacement
static EngineRenew * GetEngineReplacement(EngineRenewList erl, EngineID engine, GroupID group)
Retrieves the EngineRenew that specifies the replacement of the given engine type from the given rene...
Definition: autoreplace.cpp:27
RemoveAllEngineReplacement
void RemoveAllEngineReplacement(EngineRenewList *erl)
Remove all engine replacement settings for the company.
Definition: autoreplace.cpp:43
safeguards.h
DEFAULT_GROUP
static const GroupID DEFAULT_GROUP
Ungrouped vehicles are in this group.
Definition: group_type.h:17
EngineRenew
Struct to store engine replacements.
Definition: autoreplace_base.h:33
stdafx.h
Pool
Base class for all pools.
Definition: pool_type.hpp:81
GroupID
uint16 GroupID
Type for all group identifiers.
Definition: group_type.h:13
AddEngineReplacement
CommandCost AddEngineReplacement(EngineRenewList *erl, EngineID old_engine, EngineID new_engine, GroupID group, bool replace_when_old, DoCommandFlag flags)
Add an engine replacement to the given renewlist.
Definition: autoreplace.cpp:86
Pool::PoolItem<&_enginerenew_pool >::CanAllocateItem
static bool CanAllocateItem(size_t n=1)
Helper functions so we can use PoolItem::Function() instead of _poolitem_pool.Function()
Definition: pool_type.hpp:307
INSTANTIATE_POOL_METHODS
#define INSTANTIATE_POOL_METHODS(name)
Force instantiation of pool methods so we don't get linker errors.
Definition: pool_func.hpp:224
Pool::PoolItem<&_group_pool >::IsValidID
static bool IsValidID(size_t index)
Tests whether given index can be used to get valid (non-nullptr) Titem.
Definition: pool_type.hpp:326
pool_func.hpp
GroupIsInGroup
bool GroupIsInGroup(GroupID search, GroupID group)
Test if GroupID group is a descendant of (or is) GroupID search.
Definition: group_cmd.cpp:868