src/vehiclelist.cpp

   1 /* $Id$ */
   2
   3 /*
   4  * This file is part of OpenTTD.
   5  * 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.
   6  * 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.
   7  * 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/>.
   8  */
   9
  10 /** @file vehiclelist.cpp Lists of vehicles. */
  11
  12 #include "stdafx.h"
  13 #include "train.h"
  14 #include "vehiclelist.h"
  15 #include "group.h"
  16
  17 #include "safeguards.h"
  18
  19 /**
  20  * Pack a VehicleListIdentifier in a single uint32.
  21  * @return The packed identifier.
  22  */
  23 uint32 VehicleListIdentifier::Pack() const
  24 {
  25         byte c = this->company == OWNER_NONE ? 0xF : (byte)this->company;
  26         assert(c             < (1 <<  4));
  27         assert(this->vtype   < (1 <<  2));
  28         assert(this->index   < (1 << 20));
  29         assert(this->type    < VLT_END);
  30         assert_compile(VLT_END <= (1 <<  3));
  31
  32         return c << 28 | this->type << 23 | this->vtype << 26 | this->index;
  33 }
  34
  35 /**
  36  * Unpack a VehicleListIdentifier from a single uint32.
  37  * @param data The data to unpack.
  38  * @return true iff the data was valid (enough).
  39  */
  40 bool VehicleListIdentifier::UnpackIfValid(uint32 data)
  41 {
  42         byte c        = GB(data, 28, 4);
  43         this->company = c == 0xF ? OWNER_NONE : (CompanyID)c;
  44         this->type    = (VehicleListType)GB(data, 23, 3);
  45         this->vtype   = (VehicleType)GB(data, 26, 2);
  46         this->index   = GB(data, 0, 20);
  47
  48         return this->type < VLT_END;
  49 }
  50
  51 /**
  52  * Decode a packed vehicle list identifier into a new one.
  53  * @param data The data to unpack.
  54  */
  55 /* static */ VehicleListIdentifier VehicleListIdentifier::UnPack(uint32 data)
  56 {
  57         VehicleListIdentifier result;
  58         bool ret = result.UnpackIfValid(data);
  59         assert(ret);
  60         return result;
  61 }
  62
  63 /**
  64  * Generate a list of vehicles inside a depot.
  65  * @param type    Type of vehicle
  66  * @param tile    The tile the depot is located on
  67  * @param engines Pointer to list to add vehicles to
  68  * @param wagons  Pointer to list to add wagons to (can be NULL)
  69  * @param individual_wagons If true add every wagon to \a wagons which is not attached to an engine. If false only add the first wagon of every row.
  70  */
  71 void BuildDepotVehicleList(VehicleType type, TileIndex tile, VehicleList *engines, VehicleList *wagons, bool individual_wagons)
  72 {
  73         engines->Clear();
  74         if (wagons != NULL && wagons != engines) wagons->Clear();
  75
  76         const Vehicle *v;
  77         FOR_ALL_VEHICLES(v) {
  78                 /* General tests for all vehicle types */
  79                 if (v->type != type) continue;
  80                 if (v->tile != tile) continue;
  81
  82                 switch (type) {
  83                         case VEH_TRAIN: {
  84                                 const Train *t = Train::From(v);
  85                                 if (t->IsArticulatedPart() || t->IsRearDualheaded()) continue;
  86                                 if (t->track != TRACK_BIT_DEPOT) continue;
  87                                 if (wagons != NULL && t->First()->IsFreeWagon()) {
  88                                         if (individual_wagons || t->IsFreeWagon()) *wagons->Append() = t;
  89                                         continue;
  90                                 }
  91                                 break;
  92                         }
  93
  94                         default:
  95                                 if (!v->IsInDepot()) continue;
  96                                 break;
  97                 }
  98
  99                 if (!v->IsPrimaryVehicle()) continue;
 100
 101                 *engines->Append() = v;
 102         }
 103
 104         /* Ensure the lists are not wasting too much space. If the lists are fresh
 105          * (i.e. built within a command) then this will actually do nothing. */
 106         engines->Compact();
 107         if (wagons != NULL && wagons != engines) wagons->Compact();
 108 }
 109
 110 /**
 111  * Generate a list of vehicles based on window type.
 112  * @param list Pointer to list to add vehicles to
 113  * @param vli  The identifier of this vehicle list.
 114  * @return false if invalid list is requested
 115  */
 116 bool GenerateVehicleSortList(VehicleList *list, const VehicleListIdentifier &vli)
 117 {
 118         list->Clear();
 119
 120         const Vehicle *v;
 121
 122         switch (vli.type) {
 123                 case VL_STATION_LIST:
 124                         FOR_ALL_VEHICLES(v) {
 125                                 if (v->type == vli.vtype && v->IsPrimaryVehicle()) {
 126                                         const Order *order;
 127
 128                                         FOR_VEHICLE_ORDERS(v, order) {
 129                                                 if ((order->IsType(OT_GOTO_STATION) || order->IsType(OT_GOTO_WAYPOINT) || order->IsType(OT_IMPLICIT))
 130                                                                 && order->GetDestination() == vli.index) {
 131                                                         *list->Append() = v;
 132                                                         break;
 133                                                 }
 134                                         }
 135                                 }
 136                         }
 137                         break;
 138
 139                 case VL_SHARED_ORDERS:
 140                         /* Add all vehicles from this vehicle's shared order list */
 141                         v = Vehicle::GetIfValid(vli.index);
 142                         if (v == NULL || v->type != vli.vtype || !v->IsPrimaryVehicle()) return false;
 143
 144                         for (; v != NULL; v = v->NextShared()) {
 145                                 *list->Append() = v;
 146                         }
 147                         break;
 148
 149                 case VL_GROUP_LIST:
 150                         if (vli.index != ALL_GROUP) {
 151                                 FOR_ALL_VEHICLES(v) {
 152                                         if (v->type == vli.vtype && v->IsPrimaryVehicle() &&
 153                                                         v->owner == vli.company && GroupIsInGroup(v->group_id, vli.index)) {
 154                                                 *list->Append() = v;
 155                                         }
 156                                 }
 157                                 break;
 158                         }
 159                         /* FALL THROUGH */
 160
 161                 case VL_STANDARD:
 162                         FOR_ALL_VEHICLES(v) {
 163                                 if (v->type == vli.vtype && v->owner == vli.company && v->IsPrimaryVehicle()) {
 164                                         *list->Append() = v;
 165                                 }
 166                         }
 167                         break;
 168
 169                 case VL_DEPOT_LIST:
 170                         FOR_ALL_VEHICLES(v) {
 171                                 if (v->type == vli.vtype && v->IsPrimaryVehicle()) {
 172                                         const Order *order;
 173
 174                                         FOR_VEHICLE_ORDERS(v, order) {
 175                                                 if (order->IsType(OT_GOTO_DEPOT) && !(order->GetDepotActionType() & ODATFB_NEAREST_DEPOT) && order->GetDestination() == vli.index) {
 176                                                         *list->Append() = v;
 177                                                         break;
 178                                                 }
 179                                         }
 180                                 }
 181                         }
 182                         break;
 183
 184                 default: return false;
 185         }
 186
 187         list->Compact();
 188         return true;
 189 }