vehicle_gui.cpp

Go to the documentation of this file.
00001 /* $Id: vehicle_gui.cpp 20429 2010-08-09 21:38:18Z rubidium $ */
00002 
00003 /*
00004  * This file is part of OpenTTD.
00005  * 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.
00006  * 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.
00007  * 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/>.
00008  */
00009 
00012 #include "stdafx.h"
00013 #include "debug.h"
00014 #include "company_func.h"
00015 #include "gui.h"
00016 #include "textbuf_gui.h"
00017 #include "command_func.h"
00018 #include "vehicle_gui.h"
00019 #include "vehicle_gui_base.h"
00020 #include "viewport_func.h"
00021 #include "newgrf_engine.h"
00022 #include "newgrf_text.h"
00023 #include "waypoint_base.h"
00024 #include "roadveh.h"
00025 #include "train.h"
00026 #include "aircraft.h"
00027 #include "depot_base.h"
00028 #include "group_gui.h"
00029 #include "strings_func.h"
00030 #include "window_func.h"
00031 #include "vehicle_func.h"
00032 #include "autoreplace_gui.h"
00033 #include "string_func.h"
00034 #include "widgets/dropdown_func.h"
00035 #include "timetable.h"
00036 #include "vehiclelist.h"
00037 #include "articulated_vehicles.h"
00038 #include "cargotype.h"
00039 #include "spritecache.h"
00040 #include "core/geometry_func.hpp"
00041 #include "company_base.h"
00042 #include "engine_base.h"
00043 #include "engine_func.h"
00044 
00045 #include "table/sprites.h"
00046 #include "table/strings.h"
00047 
00048 Sorting _sorting;
00049 
00050 static GUIVehicleList::SortFunction VehicleNumberSorter;
00051 static GUIVehicleList::SortFunction VehicleNameSorter;
00052 static GUIVehicleList::SortFunction VehicleAgeSorter;
00053 static GUIVehicleList::SortFunction VehicleProfitThisYearSorter;
00054 static GUIVehicleList::SortFunction VehicleProfitLastYearSorter;
00055 static GUIVehicleList::SortFunction VehicleCargoSorter;
00056 static GUIVehicleList::SortFunction VehicleReliabilitySorter;
00057 static GUIVehicleList::SortFunction VehicleMaxSpeedSorter;
00058 static GUIVehicleList::SortFunction VehicleModelSorter;
00059 static GUIVehicleList::SortFunction VehicleValueSorter;
00060 static GUIVehicleList::SortFunction VehicleLengthSorter;
00061 static GUIVehicleList::SortFunction VehicleTimeToLiveSorter;
00062 static GUIVehicleList::SortFunction VehicleTimetableDelaySorter;
00063 
00064 GUIVehicleList::SortFunction * const BaseVehicleListWindow::vehicle_sorter_funcs[] = {
00065   &VehicleNumberSorter,
00066   &VehicleNameSorter,
00067   &VehicleAgeSorter,
00068   &VehicleProfitThisYearSorter,
00069   &VehicleProfitLastYearSorter,
00070   &VehicleCargoSorter,
00071   &VehicleReliabilitySorter,
00072   &VehicleMaxSpeedSorter,
00073   &VehicleModelSorter,
00074   &VehicleValueSorter,
00075   &VehicleLengthSorter,
00076   &VehicleTimeToLiveSorter,
00077   &VehicleTimetableDelaySorter,
00078 };
00079 
00080 const StringID BaseVehicleListWindow::vehicle_sorter_names[] = {
00081   STR_SORT_BY_NUMBER,
00082   STR_SORT_BY_NAME,
00083   STR_SORT_BY_AGE,
00084   STR_SORT_BY_PROFIT_THIS_YEAR,
00085   STR_SORT_BY_PROFIT_LAST_YEAR,
00086   STR_SORT_BY_TOTAL_CAPACITY_PER_CARGOTYPE,
00087   STR_SORT_BY_RELIABILITY,
00088   STR_SORT_BY_MAX_SPEED,
00089   STR_SORT_BY_MODEL,
00090   STR_SORT_BY_VALUE,
00091   STR_SORT_BY_LENGTH,
00092   STR_SORT_BY_LIFE_TIME,
00093   STR_SORT_BY_TIMETABLE_DELAY,
00094   INVALID_STRING_ID
00095 };
00096 
00097 void BaseVehicleListWindow::BuildVehicleList(Owner owner, uint16 index, uint16 window_type)
00098 {
00099   if (!this->vehicles.NeedRebuild()) return;
00100 
00101   DEBUG(misc, 3, "Building vehicle list for company %d at station %d", owner, index);
00102 
00103   GenerateVehicleSortList(&this->vehicles, this->vehicle_type, owner, index, window_type);
00104 
00105   uint unitnumber = 0;
00106   for (const Vehicle **v = this->vehicles.Begin(); v != this->vehicles.End(); v++) {
00107     unitnumber = max<uint>(unitnumber, (*v)->unitnumber);
00108   }
00109 
00110   /* Because 111 is much less wide than e.g. 999 we use the
00111    * wider numbers to determine the width instead of just
00112    * the random number that it seems to be. */
00113   if (unitnumber >= 1000) {
00114     this->unitnumber_digits = 4;
00115   } else if (unitnumber >= 100) {
00116     this->unitnumber_digits = 3;
00117   } else {
00118     this->unitnumber_digits = 2;
00119   }
00120 
00121   this->vehicles.RebuildDone();
00122   this->vscroll.SetCount(this->vehicles.Length());
00123 }
00124 
00125 /* cached values for VehicleNameSorter to spare many GetString() calls */
00126 static const Vehicle *_last_vehicle[2] = { NULL, NULL };
00127 
00128 void BaseVehicleListWindow::SortVehicleList()
00129 {
00130   if (this->vehicles.Sort()) return;
00131 
00132   /* invalidate cached values for name sorter - vehicle names could change */
00133   _last_vehicle[0] = _last_vehicle[1] = NULL;
00134 }
00135 
00136 void DepotSortList(VehicleList *list)
00137 {
00138   if (list->Length() < 2) return;
00139   QSortT(list->Begin(), list->Length(), &VehicleNumberSorter);
00140 }
00141 
00143 static void DrawVehicleProfitButton(const Vehicle *v, int x, int y)
00144 {
00145   PaletteID pal;
00146 
00147   /* draw profit-based coloured icons */
00148   if (v->age <= DAYS_IN_YEAR * 2) {
00149     pal = PALETTE_TO_GREY;
00150   } else if (v->GetDisplayProfitLastYear() < 0) {
00151     pal = PALETTE_TO_RED;
00152   } else if (v->GetDisplayProfitLastYear() < 10000) {
00153     pal = PALETTE_TO_YELLOW;
00154   } else {
00155     pal = PALETTE_TO_GREEN;
00156   }
00157   DrawSprite(SPR_BLOT, pal, x, y);
00158 }
00159 
00161 static const uint MAX_REFIT_CYCLE = 256;
00162 
00170 byte GetBestFittingSubType(Vehicle *v_from, Vehicle *v_for)
00171 {
00172   const Engine *e_from = Engine::Get(v_from->engine_type);
00173   const Engine *e_for  = Engine::Get(v_for->engine_type);
00174 
00175   /* If one them doesn't carry cargo, there's no need to find a sub type */
00176   if (!e_from->CanCarryCargo() || !e_for->CanCarryCargo()) return 0;
00177 
00178   if (!HasBit(e_from->info.callback_mask, CBM_VEHICLE_CARGO_SUFFIX) ||
00179       !HasBit(e_for->info.callback_mask,  CBM_VEHICLE_CARGO_SUFFIX)) {
00180     /* One of the engines doesn't have cargo suffixes, i.e. sub types. */
00181     return 0;
00182   }
00183 
00184   /* It has to be possible for v_for to carry the cargo of v_from. */
00185   if (!HasBit(e_for->info.refit_mask, v_from->cargo_type)) return 0;
00186 
00187   StringID expected_string = GetCargoSubtypeText(v_from);
00188 
00189   CargoID old_cargo_type = v_for->cargo_type;
00190   byte old_cargo_subtype = v_for->cargo_subtype;
00191   byte ret_refit_cyc = 0;
00192 
00193   /* Set the 'destination' cargo */
00194   v_for->cargo_type = v_from->cargo_type;
00195 
00196   /* Cycle through the refits */
00197   for (uint refit_cyc = 0; refit_cyc < MAX_REFIT_CYCLE; refit_cyc++) {
00198     v_for->cargo_subtype = refit_cyc;
00199 
00200     /* Make sure we don't pick up anything cached. */
00201     v_for->First()->InvalidateNewGRFCache();
00202     v_for->InvalidateNewGRFCache();
00203     uint16 callback = GetVehicleCallback(CBID_VEHICLE_CARGO_SUFFIX, 0, 0, v_for->engine_type, v_for);
00204 
00205     if (callback == 0xFF) callback = CALLBACK_FAILED;
00206     if (callback == CALLBACK_FAILED) break;
00207 
00208     if (GetCargoSubtypeText(v_for) != expected_string) continue;
00209 
00210     /* We found something matching. */
00211     ret_refit_cyc = refit_cyc;
00212     break;
00213   }
00214 
00215   /* Reset the vehicle's cargo type */
00216   v_for->cargo_type    = old_cargo_type;
00217   v_for->cargo_subtype = old_cargo_subtype;
00218 
00219   /* Make sure we don't taint the vehicle. */
00220   v_for->First()->InvalidateNewGRFCache();
00221   v_for->InvalidateNewGRFCache();
00222 
00223   return ret_refit_cyc;
00224 }
00225 
00227 struct RefitOption {
00228   CargoID cargo;    
00229   byte subtype;     
00230   uint16 value;     
00231   EngineID engine;  
00232 
00233   FORCEINLINE bool operator != (const RefitOption &other) const
00234   {
00235     return other.cargo != this->cargo || other.value != this->value;
00236   }
00237 };
00238 
00239 typedef SmallVector<RefitOption, 32> RefitList;
00240 
00246 static void BuildRefitList(const Vehicle *v, RefitList *refit_list)
00247 {
00248   refit_list->Clear();
00249   Vehicle *u = const_cast<Vehicle *>(v);
00250 
00251   do {
00252     const Engine *e = Engine::Get(u->engine_type);
00253     uint32 cmask = e->info.refit_mask;
00254     byte callback_mask = e->info.callback_mask;
00255 
00256     /* Skip this engine if it does not carry anything */
00257     if (!e->CanCarryCargo()) continue;
00258 
00259     /* Loop through all cargos in the refit mask */
00260     const CargoSpec *cs;
00261     FOR_ALL_CARGOSPECS(cs) {
00262       CargoID cid = cs->Index();
00263       /* Skip cargo type if it's not listed */
00264       if (!HasBit(cmask, cid)) continue;
00265 
00266       /* Check the vehicle's callback mask for cargo suffixes */
00267       if (HasBit(callback_mask, CBM_VEHICLE_CARGO_SUFFIX)) {
00268         /* Make a note of the original cargo type. It has to be
00269          * changed to test the cargo & subtype... */
00270         CargoID temp_cargo = u->cargo_type;
00271         byte temp_subtype  = u->cargo_subtype;
00272 
00273         u->cargo_type = cid;
00274 
00275         for (uint refit_cyc = 0; refit_cyc < MAX_REFIT_CYCLE; refit_cyc++) {
00276           u->cargo_subtype = refit_cyc;
00277 
00278           /* Make sure we don't pick up anything cached. */
00279           u->First()->InvalidateNewGRFCache();
00280           u->InvalidateNewGRFCache();
00281           uint16 callback = GetVehicleCallback(CBID_VEHICLE_CARGO_SUFFIX, 0, 0, u->engine_type, u);
00282 
00283           if (callback == 0xFF) callback = CALLBACK_FAILED;
00284           if (refit_cyc != 0 && callback == CALLBACK_FAILED) break;
00285 
00286           RefitOption option;
00287           option.cargo   = cid;
00288           option.subtype = refit_cyc;
00289           option.value   = callback;
00290           option.engine  = u->engine_type;
00291           refit_list->Include(option);
00292         }
00293 
00294         /* Reset the vehicle's cargo type */
00295         u->cargo_type    = temp_cargo;
00296         u->cargo_subtype = temp_subtype;
00297 
00298         /* And make sure we haven't tainted the cache */
00299         u->First()->InvalidateNewGRFCache();
00300         u->InvalidateNewGRFCache();
00301       } else {
00302         /* No cargo suffix callback -- use no subtype */
00303         RefitOption option;
00304         option.cargo   = cid;
00305         option.subtype = 0;
00306         option.value   = CALLBACK_FAILED;
00307         option.engine  = INVALID_ENGINE;
00308         refit_list->Include(option);
00309       }
00310     }
00311   } while ((v->type == VEH_TRAIN || v->type == VEH_ROAD) && (u = u->Next()) != NULL);
00312 }
00313 
00322 static void DrawVehicleRefitWindow(const RefitList &list, int sel, uint pos, uint rows, uint delta, const Rect &r)
00323 {
00324   uint y = r.top + WD_MATRIX_TOP;
00325   /* Draw the list, and find the selected cargo (by its position in list) */
00326   for (uint i = pos; i < pos + rows && i < list.Length(); i++) {
00327     TextColour colour = (sel == (int)i) ? TC_WHITE : TC_BLACK;
00328     const RefitOption *refit = &list[i];
00329 
00330     /* Get the cargo name */
00331     SetDParam(0, CargoSpec::Get(refit->cargo)->name);
00332 
00333     /* If the callback succeeded, draw the cargo suffix */
00334     if (refit->value != CALLBACK_FAILED) {
00335       SetDParam(1, GetGRFStringID(GetEngineGRFID(refit->engine), 0xD000 + refit->value));
00336       DrawString(r.left + WD_MATRIX_LEFT, r.right - WD_MATRIX_RIGHT, y, STR_JUST_STRING_SPACE_STRING, colour);
00337     } else {
00338       DrawString(r.left + WD_MATRIX_LEFT, r.right - WD_MATRIX_RIGHT, y, STR_JUST_STRING, colour);
00339     }
00340 
00341     y += delta;
00342   }
00343 }
00344 
00346 enum VehicleRefitWidgets {
00347   VRW_CAPTION,
00348   VRW_SELECTHEADER,
00349   VRW_MATRIX,
00350   VRW_SCROLLBAR,
00351   VRW_INFOPANEL,
00352   VRW_REFITBUTTON,
00353 };
00354 
00356 struct RefitWindow : public Window {
00357   int sel;              
00358   RefitOption *cargo;   
00359   RefitList list;       
00360   uint length;          
00361   VehicleOrderID order; 
00362 
00363   RefitWindow(const WindowDesc *desc, const Vehicle *v, VehicleOrderID order) : Window()
00364   {
00365     this->CreateNestedTree(desc);
00366 
00367     this->GetWidget<NWidgetCore>(VRW_SELECTHEADER)->tool_tip = STR_REFIT_TRAIN_LIST_TOOLTIP + v->type;
00368     this->GetWidget<NWidgetCore>(VRW_MATRIX)->tool_tip       = STR_REFIT_TRAIN_LIST_TOOLTIP + v->type;
00369     NWidgetCore *nwi = this->GetWidget<NWidgetCore>(VRW_REFITBUTTON);
00370     nwi->widget_data = STR_REFIT_TRAIN_REFIT_BUTTON + v->type;
00371     nwi->tool_tip    = STR_REFIT_TRAIN_REFIT_TOOLTIP + v->type;
00372 
00373     this->FinishInitNested(desc, v->index);
00374     this->owner = v->owner;
00375 
00376     this->order = order;
00377     this->sel  = -1;
00378     BuildRefitList(v, &this->list);
00379     if (v->type == VEH_TRAIN) this->length = CountVehiclesInChain(v);
00380     this->vscroll.SetCount(this->list.Length());
00381   }
00382 
00383   virtual void OnPaint()
00384   {
00385     Vehicle *v = Vehicle::Get(this->window_number);
00386 
00387     if (v->type == VEH_TRAIN) {
00388       uint length = CountVehiclesInChain(v);
00389 
00390       if (length != this->length) {
00391         /* Consist length has changed, so rebuild the refit list */
00392         BuildRefitList(v, &this->list);
00393         this->length = length;
00394       }
00395     }
00396 
00397     this->vscroll.SetCount(this->list.Length());
00398 
00399     this->cargo = (this->sel >= 0 && this->sel < (int)this->list.Length()) ? &this->list[this->sel] : NULL;
00400     this->DrawWidgets();
00401   }
00402 
00403   virtual void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize)
00404   {
00405     switch (widget) {
00406       case VRW_MATRIX:
00407         resize->height = WD_MATRIX_TOP + FONT_HEIGHT_NORMAL + WD_MATRIX_BOTTOM;
00408         size->height = resize->height * 8;
00409         break;
00410     }
00411   }
00412 
00413   virtual void SetStringParameters(int widget) const
00414   {
00415     if (widget == VRW_CAPTION) SetDParam(0, Vehicle::Get(this->window_number)->index);
00416   }
00417 
00418   virtual void DrawWidget(const Rect &r, int widget) const
00419   {
00420     switch (widget) {
00421       case VRW_MATRIX:
00422         DrawVehicleRefitWindow(this->list, this->sel, this->vscroll.GetPosition(), this->vscroll.GetCapacity(), this->resize.step_height, r);
00423         break;
00424 
00425       case VRW_INFOPANEL:
00426         if (this->cargo != NULL) {
00427           Vehicle *v = Vehicle::Get(this->window_number);
00428           CommandCost cost = DoCommand(v->tile, v->index, this->cargo->cargo | this->cargo->subtype << 8, DC_QUERY_COST, GetCmdRefitVeh(v->type));
00429           if (cost.Succeeded()) {
00430             SetDParam(0, this->cargo->cargo);
00431             SetDParam(1, _returned_refit_capacity);
00432             SetDParam(2, cost.GetCost());
00433             DrawStringMultiLine(r.left + WD_FRAMERECT_LEFT, r.right - WD_FRAMERECT_RIGHT,
00434                 r.top + WD_FRAMERECT_TOP, r.bottom - WD_FRAMERECT_BOTTOM, STR_REFIT_NEW_CAPACITY_COST_OF_REFIT);
00435           }
00436         }
00437         break;
00438     }
00439   }
00440 
00441   virtual void OnClick(Point pt, int widget, int click_count)
00442   {
00443     switch (widget) {
00444       case VRW_MATRIX: { // listbox
00445         int y = pt.y - this->GetWidget<NWidgetBase>(VRW_MATRIX)->pos_y;
00446         if (y >= 0) {
00447           this->sel = (y / (int)this->resize.step_height) + this->vscroll.GetPosition();
00448           this->SetDirty();
00449         }
00450         /* FIXME We need to call some InvalidateData to make this->cargo valid */
00451         if (click_count == 1) break;
00452       }
00453       /* FALL THROUGH */
00454       case VRW_REFITBUTTON: // refit button
00455         if (this->cargo != NULL) {
00456           const Vehicle *v = Vehicle::Get(this->window_number);
00457 
00458           if (this->order == INVALID_VEH_ORDER_ID) {
00459             if (DoCommandP(v->tile, v->index, this->cargo->cargo | this->cargo->subtype << 8, GetCmdRefitVeh(v))) delete this;
00460           } else {
00461             if (DoCommandP(v->tile, v->index, this->cargo->cargo | this->cargo->subtype << 8 | this->order << 16, CMD_ORDER_REFIT)) delete this;
00462           }
00463         }
00464         break;
00465     }
00466   }
00467 
00468   virtual void OnResize()
00469   {
00470     this->vscroll.SetCapacityFromWidget(this, VRW_MATRIX);
00471     this->GetWidget<NWidgetCore>(VRW_MATRIX)->widget_data = (this->vscroll.GetCapacity() << MAT_ROW_START) + (1 << MAT_COL_START);
00472   }
00473 };
00474 
00475 static const NWidgetPart _nested_vehicle_refit_widgets[] = {
00476   NWidget(NWID_HORIZONTAL),
00477     NWidget(WWT_CLOSEBOX, COLOUR_GREY),
00478     NWidget(WWT_CAPTION, COLOUR_GREY, VRW_CAPTION), SetDataTip(STR_REFIT_CAPTION, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
00479   EndContainer(),
00480   NWidget(WWT_TEXTBTN, COLOUR_GREY, VRW_SELECTHEADER), SetDataTip(STR_REFIT_TITLE, STR_NULL), SetResize(1, 0),
00481   /* Matrix + scrollbar. */
00482   NWidget(NWID_HORIZONTAL),
00483     NWidget(WWT_MATRIX, COLOUR_GREY, VRW_MATRIX), SetMinimalSize(228, 112), SetResize(1, 14), SetFill(1, 1), SetDataTip(0x801, STR_NULL),
00484     NWidget(WWT_SCROLLBAR, COLOUR_GREY, VRW_SCROLLBAR),
00485   EndContainer(),
00486   NWidget(WWT_PANEL, COLOUR_GREY, VRW_INFOPANEL), SetMinimalTextLines(2, WD_FRAMERECT_TOP + WD_FRAMERECT_BOTTOM), SetResize(1, 0), EndContainer(),
00487   NWidget(NWID_HORIZONTAL),
00488     NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, VRW_REFITBUTTON), SetFill(1, 0), SetResize(1, 0),
00489     NWidget(WWT_RESIZEBOX, COLOUR_GREY),
00490   EndContainer(),
00491 };
00492 
00493 static const WindowDesc _vehicle_refit_desc(
00494   WDP_AUTO, 240, 174,
00495   WC_VEHICLE_REFIT, WC_VEHICLE_VIEW,
00496   WDF_UNCLICK_BUTTONS | WDF_CONSTRUCTION,
00497   _nested_vehicle_refit_widgets, lengthof(_nested_vehicle_refit_widgets)
00498 );
00499 
00505 void ShowVehicleRefitWindow(const Vehicle *v, VehicleOrderID order, Window *parent)
00506 {
00507   DeleteWindowById(WC_VEHICLE_REFIT, v->index);
00508   RefitWindow *w = new RefitWindow(&_vehicle_refit_desc, v, order);
00509   w->parent = parent;
00510 }
00511 
00513 uint ShowRefitOptionsList(int left, int right, int y, EngineID engine)
00514 {
00515   /* List of cargo types of this engine */
00516   uint32 cmask = GetUnionOfArticulatedRefitMasks(engine, false);
00517   /* List of cargo types available in this climate */
00518   uint32 lmask = _cargo_mask;
00519   char string[512];
00520   char *b = string;
00521 
00522   /* Draw nothing if the engine is not refittable */
00523   if (HasAtMostOneBit(cmask)) return y;
00524 
00525   b = InlineString(b, STR_PURCHASE_INFO_REFITTABLE_TO);
00526 
00527   if (cmask == lmask) {
00528     /* Engine can be refitted to all types in this climate */
00529     b = InlineString(b, STR_PURCHASE_INFO_ALL_TYPES);
00530   } else {
00531     /* Check if we are able to refit to more cargo types and unable to. If
00532      * so, invert the cargo types to list those that we can't refit to. */
00533     if (CountBits(cmask ^ lmask) < CountBits(cmask)) {
00534       cmask ^= lmask;
00535       b = InlineString(b, STR_PURCHASE_INFO_ALL_BUT);
00536     }
00537 
00538     bool first = true;
00539 
00540     /* Add each cargo type to the list */
00541     for (CargoID cid = 0; cid < NUM_CARGO; cid++) {
00542       if (!HasBit(cmask, cid)) continue;
00543 
00544       if (b >= lastof(string) - (2 + 2 * 4)) break; // ", " and two calls to Utf8Encode()
00545 
00546       if (!first) b = strecpy(b, ", ", lastof(string));
00547       first = false;
00548 
00549       b = InlineString(b, CargoSpec::Get(cid)->name);
00550     }
00551   }
00552 
00553   /* Terminate and display the completed string */
00554   *b = '\0';
00555 
00556   /* Make sure we detect any buffer overflow */
00557   assert(b < endof(string));
00558 
00559   SetDParamStr(0, string);
00560   return DrawStringMultiLine(left, right, y, INT32_MAX, STR_JUST_RAW_STRING);
00561 }
00562 
00564 StringID GetCargoSubtypeText(const Vehicle *v)
00565 {
00566   if (HasBit(EngInfo(v->engine_type)->callback_mask, CBM_VEHICLE_CARGO_SUFFIX)) {
00567     uint16 cb = GetVehicleCallback(CBID_VEHICLE_CARGO_SUFFIX, 0, 0, v->engine_type, v);
00568     if (cb != CALLBACK_FAILED) {
00569       return GetGRFStringID(GetEngineGRFID(v->engine_type), 0xD000 + cb);
00570     }
00571   }
00572   return STR_EMPTY;
00573 }
00574 
00576 static int CDECL VehicleNumberSorter(const Vehicle * const *a, const Vehicle * const *b)
00577 {
00578   return (*a)->unitnumber - (*b)->unitnumber;
00579 }
00580 
00582 static int CDECL VehicleNameSorter(const Vehicle * const *a, const Vehicle * const *b)
00583 {
00584   static char last_name[2][64];
00585 
00586   if (*a != _last_vehicle[0]) {
00587     _last_vehicle[0] = *a;
00588     SetDParam(0, (*a)->index);
00589     GetString(last_name[0], STR_VEHICLE_NAME, lastof(last_name[0]));
00590   }
00591 
00592   if (*b != _last_vehicle[1]) {
00593     _last_vehicle[1] = *b;
00594     SetDParam(0, (*b)->index);
00595     GetString(last_name[1], STR_VEHICLE_NAME, lastof(last_name[1]));
00596   }
00597 
00598   int r = strcmp(last_name[0], last_name[1]);
00599   return (r != 0) ? r : VehicleNumberSorter(a, b);
00600 }
00601 
00603 static int CDECL VehicleAgeSorter(const Vehicle * const *a, const Vehicle * const *b)
00604 {
00605   int r = (*a)->age - (*b)->age;
00606   return (r != 0) ? r : VehicleNumberSorter(a, b);
00607 }
00608 
00610 static int CDECL VehicleProfitThisYearSorter(const Vehicle * const *a, const Vehicle * const *b)
00611 {
00612   int r = ClampToI32((*a)->GetDisplayProfitThisYear() - (*b)->GetDisplayProfitThisYear());
00613   return (r != 0) ? r : VehicleNumberSorter(a, b);
00614 }
00615 
00617 static int CDECL VehicleProfitLastYearSorter(const Vehicle * const *a, const Vehicle * const *b)
00618 {
00619   int r = ClampToI32((*a)->GetDisplayProfitLastYear() - (*b)->GetDisplayProfitLastYear());
00620   return (r != 0) ? r : VehicleNumberSorter(a, b);
00621 }
00622 
00624 static int CDECL VehicleCargoSorter(const Vehicle * const *a, const Vehicle * const *b)
00625 {
00626   const Vehicle *v;
00627   CargoArray diff;
00628 
00629   /* Append the cargo of the connected weagons */
00630   for (v = *a; v != NULL; v = v->Next()) diff[v->cargo_type] += v->cargo_cap;
00631   for (v = *b; v != NULL; v = v->Next()) diff[v->cargo_type] -= v->cargo_cap;
00632 
00633   int r = 0;
00634   for (CargoID i = 0; i < NUM_CARGO; i++) {
00635     r = diff[i];
00636     if (r != 0) break;
00637   }
00638 
00639   return (r != 0) ? r : VehicleNumberSorter(a, b);
00640 }
00641 
00643 static int CDECL VehicleReliabilitySorter(const Vehicle * const *a, const Vehicle * const *b)
00644 {
00645   int r = (*a)->reliability - (*b)->reliability;
00646   return (r != 0) ? r : VehicleNumberSorter(a, b);
00647 }
00648 
00650 static int CDECL VehicleMaxSpeedSorter(const Vehicle * const *a, const Vehicle * const *b)
00651 {
00652   int r = 0;
00653   if ((*a)->type == VEH_TRAIN && (*b)->type == VEH_TRAIN) {
00654     r = Train::From(*a)->tcache.cached_max_speed - Train::From(*b)->tcache.cached_max_speed;
00655   } else {
00656     r = (*a)->max_speed - (*b)->max_speed;
00657   }
00658   return (r != 0) ? r : VehicleNumberSorter(a, b);
00659 }
00660 
00662 static int CDECL VehicleModelSorter(const Vehicle * const *a, const Vehicle * const *b)
00663 {
00664   int r = (*a)->engine_type - (*b)->engine_type;
00665   return (r != 0) ? r : VehicleNumberSorter(a, b);
00666 }
00667 
00669 static int CDECL VehicleValueSorter(const Vehicle * const *a, const Vehicle * const *b)
00670 {
00671   const Vehicle *u;
00672   Money diff = 0;
00673 
00674   for (u = *a; u != NULL; u = u->Next()) diff += u->value;
00675   for (u = *b; u != NULL; u = u->Next()) diff -= u->value;
00676 
00677   int r = ClampToI32(diff);
00678   return (r != 0) ? r : VehicleNumberSorter(a, b);
00679 }
00680 
00682 static int CDECL VehicleLengthSorter(const Vehicle * const *a, const Vehicle * const *b)
00683 {
00684   int r = 0;
00685   switch ((*a)->type) {
00686     case VEH_TRAIN:
00687       r = Train::From(*a)->tcache.cached_total_length - Train::From(*b)->tcache.cached_total_length;
00688       break;
00689 
00690     case VEH_ROAD: {
00691       const RoadVehicle *u;
00692       for (u = RoadVehicle::From(*a); u != NULL; u = u->Next()) r += u->rcache.cached_veh_length;
00693       for (u = RoadVehicle::From(*b); u != NULL; u = u->Next()) r -= u->rcache.cached_veh_length;
00694     } break;
00695 
00696     default: NOT_REACHED();
00697   }
00698   return (r != 0) ? r : VehicleNumberSorter(a, b);
00699 }
00700 
00702 static int CDECL VehicleTimeToLiveSorter(const Vehicle * const *a, const Vehicle * const *b)
00703 {
00704   int r = ClampToI32(((*a)->max_age - (*a)->age) - ((*b)->max_age - (*b)->age));
00705   return (r != 0) ? r : VehicleNumberSorter(a, b);
00706 }
00707 
00709 static int CDECL VehicleTimetableDelaySorter(const Vehicle * const *a, const Vehicle * const *b)
00710 {
00711   int r = (*a)->lateness_counter - (*b)->lateness_counter;
00712   return (r != 0) ? r : VehicleNumberSorter(a, b);
00713 }
00714 
00715 void InitializeGUI()
00716 {
00717   MemSetT(&_sorting, 0);
00718 }
00719 
00726 static inline void ChangeVehicleWindow(WindowClass window_class, VehicleID from_index, VehicleID to_index)
00727 {
00728   Window *w = FindWindowById(window_class, from_index);
00729   if (w != NULL) {
00730     w->window_number = to_index;
00731     if (w->viewport != NULL) w->viewport->follow_vehicle = to_index;
00732     if (to_index != INVALID_VEHICLE) w->InvalidateData();
00733   }
00734 }
00735 
00741 void ChangeVehicleViewWindow(VehicleID from_index, VehicleID to_index)
00742 {
00743   ChangeVehicleWindow(WC_VEHICLE_VIEW,      from_index, to_index);
00744   ChangeVehicleWindow(WC_VEHICLE_ORDERS,    from_index, to_index);
00745   ChangeVehicleWindow(WC_VEHICLE_REFIT,     from_index, to_index);
00746   ChangeVehicleWindow(WC_VEHICLE_DETAILS,   from_index, to_index);
00747   ChangeVehicleWindow(WC_VEHICLE_TIMETABLE, from_index, to_index);
00748 }
00749 
00750 enum VehicleListWindowWidgets {
00751   VLW_WIDGET_CAPTION,
00752   VLW_WIDGET_SORT_ORDER,
00753   VLW_WIDGET_SORT_BY_PULLDOWN,
00754   VLW_WIDGET_LIST,
00755   VLW_WIDGET_SCROLLBAR,
00756   VLW_WIDGET_HIDE_BUTTONS,
00757   VLW_WIDGET_AVAILABLE_VEHICLES,
00758   VLW_WIDGET_MANAGE_VEHICLES_DROPDOWN,
00759   VLW_WIDGET_STOP_ALL,
00760   VLW_WIDGET_START_ALL,
00761 };
00762 
00763 static const NWidgetPart _nested_vehicle_list[] = {
00764   NWidget(NWID_HORIZONTAL),
00765     NWidget(WWT_CLOSEBOX, COLOUR_GREY),
00766     NWidget(WWT_CAPTION, COLOUR_GREY, VLW_WIDGET_CAPTION),
00767     NWidget(WWT_SHADEBOX, COLOUR_GREY),
00768     NWidget(WWT_STICKYBOX, COLOUR_GREY),
00769   EndContainer(),
00770 
00771   NWidget(NWID_HORIZONTAL),
00772     NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, VLW_WIDGET_SORT_ORDER), SetMinimalSize(81, 12), SetFill(0, 1), SetDataTip(STR_BUTTON_SORT_BY, STR_TOOLTIP_SORT_ORDER),
00773     NWidget(WWT_DROPDOWN, COLOUR_GREY, VLW_WIDGET_SORT_BY_PULLDOWN), SetMinimalSize(167, 12), SetFill(0, 1), SetDataTip(0x0, STR_TOOLTIP_SORT_CRITERIA),
00774     NWidget(WWT_PANEL, COLOUR_GREY), SetMinimalSize(12, 12), SetFill(1, 1), SetResize(1, 0),
00775     EndContainer(),
00776   EndContainer(),
00777 
00778   NWidget(NWID_HORIZONTAL),
00779     NWidget(WWT_MATRIX, COLOUR_GREY, VLW_WIDGET_LIST), SetMinimalSize(248, 0), SetFill(1, 0),
00780     NWidget(WWT_SCROLLBAR, COLOUR_GREY, VLW_WIDGET_SCROLLBAR),
00781   EndContainer(),
00782 
00783   NWidget(NWID_HORIZONTAL),
00784     NWidget(NWID_SELECTION, INVALID_COLOUR, VLW_WIDGET_HIDE_BUTTONS),
00785       NWidget(NWID_HORIZONTAL),
00786         NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, VLW_WIDGET_AVAILABLE_VEHICLES), SetMinimalSize(106, 12), SetFill(0, 1),
00787                 SetDataTip(STR_BLACK_STRING, STR_VEHICLE_LIST_AVAILABLE_ENGINES_TOOLTIP),
00788         NWidget(WWT_DROPDOWN, COLOUR_GREY, VLW_WIDGET_MANAGE_VEHICLES_DROPDOWN), SetMinimalSize(118, 12), SetFill(0, 1),
00789                 SetDataTip(STR_VEHICLE_LIST_MANAGE_LIST, STR_VEHICLE_LIST_MANAGE_LIST_TOOLTIP),
00790         NWidget(WWT_PUSHIMGBTN, COLOUR_GREY, VLW_WIDGET_STOP_ALL), SetMinimalSize(12, 12), SetFill(0, 1),
00791                 SetDataTip(SPR_FLAG_VEH_STOPPED, STR_VEHICLE_LIST_MASS_STOP_LIST_TOOLTIP),
00792         NWidget(WWT_PUSHIMGBTN, COLOUR_GREY, VLW_WIDGET_START_ALL), SetMinimalSize(12, 12), SetFill(0, 1),
00793                 SetDataTip(SPR_FLAG_VEH_RUNNING, STR_VEHICLE_LIST_MASS_START_LIST_TOOLTIP),
00794         NWidget(WWT_PANEL, COLOUR_GREY), SetMinimalSize(0, 12), SetResize(1, 0), SetFill(1, 1), EndContainer(),
00795       EndContainer(),
00796       /* Widget to be shown for other companies hiding the previous 5 widgets. */
00797       NWidget(WWT_PANEL, COLOUR_GREY), SetFill(1, 1), SetResize(1, 0), EndContainer(),
00798     EndContainer(),
00799     NWidget(WWT_RESIZEBOX, COLOUR_GREY),
00800   EndContainer(),
00801 };
00802 
00803 static void DrawSmallOrderList(const Vehicle *v, int left, int right, int y, VehicleOrderID start = 0)
00804 {
00805   const Order *order = v->GetOrder(start);
00806   if (order == NULL) return;
00807 
00808   int i = 0;
00809   VehicleOrderID oid = start;
00810 
00811   do {
00812     if (oid == v->cur_order_index) DrawString(left, right, y, STR_TINY_RIGHT_ARROW, TC_BLACK);
00813 
00814     if (order->IsType(OT_GOTO_STATION)) {
00815       SetDParam(0, order->GetDestination());
00816       DrawString(left + 6, right - 6, y, STR_TINY_BLACK_STATION);
00817 
00818       y += FONT_HEIGHT_SMALL;
00819       if (++i == 4) break;
00820     }
00821 
00822     oid++;
00823     order = order->next;
00824     if (order == NULL) {
00825       order = v->orders.list->GetFirstOrder();
00826       oid = 0;
00827     }
00828   } while (oid != start);
00829 }
00830 
00840 static void DrawVehicleImage(const Vehicle *v, int left, int right, int y, VehicleID selection, int skip)
00841 {
00842   switch (v->type) {
00843     case VEH_TRAIN:    DrawTrainImage(Train::From(v), left, right, y, selection, skip); break;
00844     case VEH_ROAD:     DrawRoadVehImage(v, left, right, y, selection);  break;
00845     case VEH_SHIP:     DrawShipImage(v, left, right, y, selection);     break;
00846     case VEH_AIRCRAFT: DrawAircraftImage(v, left, right, y, selection); break;
00847     default: NOT_REACHED();
00848   }
00849 }
00850 
00857 uint GetVehicleListHeight(VehicleType type, uint divisor)
00858 {
00859   /* Name + vehicle + profit */
00860   uint base = GetVehicleHeight(type) + 2 * FONT_HEIGHT_SMALL;
00861   /* Drawing of the 4 small orders + profit*/
00862   if (type >= VEH_SHIP) base = max(base, 5U * FONT_HEIGHT_SMALL);
00863 
00864   if (divisor == 1) return base;
00865 
00866   /* Make sure the height is dividable by divisor */
00867   uint rem = base % divisor;
00868   return base + (rem == 0 ? 0 : divisor - rem);
00869 }
00870 
00877 void BaseVehicleListWindow::DrawVehicleListItems(VehicleID selected_vehicle, int line_height, const Rect &r) const
00878 {
00879   int left = r.left + WD_MATRIX_LEFT;
00880   int right = r.right - WD_MATRIX_RIGHT;
00881   int width = right - left;
00882   bool rtl = _dynlang.text_dir == TD_RTL;
00883 
00884   int text_offset = GetDigitWidth() * this->unitnumber_digits + WD_FRAMERECT_RIGHT;
00885   int text_left  = left  + (rtl ?           0 : text_offset);
00886   int text_right = right - (rtl ? text_offset :           0);
00887 
00888   bool show_orderlist = vehicle_type >= VEH_SHIP;
00889   int orderlist_left  = left  + (rtl ? 0 : max(100 + text_offset, width / 2));
00890   int orderlist_right = right - (rtl ? max(100 + text_offset, width / 2) : 0);
00891 
00892   int image_left  = (rtl && show_orderlist) ? orderlist_right : text_left;
00893   int image_right = (!rtl && show_orderlist) ? orderlist_left : text_right;
00894 
00895   int vehicle_button_x = rtl ? right - 8 : left;
00896 
00897   int y = r.top;
00898   uint max = min(this->vscroll.GetPosition() + this->vscroll.GetCapacity(), this->vehicles.Length());
00899   for (uint i = this->vscroll.GetPosition(); i < max; ++i) {
00900     const Vehicle *v = this->vehicles[i];
00901     StringID str;
00902 
00903     SetDParam(0, v->GetDisplayProfitThisYear());
00904     SetDParam(1, v->GetDisplayProfitLastYear());
00905 
00906     DrawVehicleImage(v, image_left, image_right, y + FONT_HEIGHT_SMALL - 1, selected_vehicle, 0);
00907     DrawString(text_left, text_right, y + line_height - FONT_HEIGHT_SMALL - WD_FRAMERECT_BOTTOM - 1, STR_VEHICLE_LIST_PROFIT_THIS_YEAR_LAST_YEAR);
00908 
00909     if (v->name != NULL) {
00910       /* The vehicle got a name so we will print it */
00911       SetDParam(0, v->index);
00912       DrawString(text_left, text_right, y, STR_TINY_BLACK_VEHICLE);
00913     } else if (v->group_id != DEFAULT_GROUP) {
00914       /* The vehicle has no name, but is member of a group, so print group name */
00915       SetDParam(0, v->group_id);
00916       DrawString(text_left, text_right, y, STR_TINY_GROUP, TC_BLACK);
00917     }
00918 
00919     if (show_orderlist) DrawSmallOrderList(v, orderlist_left, orderlist_right, y, v->cur_order_index);
00920 
00921     if (v->IsInDepot()) {
00922       str = STR_BLUE_COMMA;
00923     } else {
00924       str = (v->age > v->max_age - DAYS_IN_LEAP_YEAR) ? STR_RED_COMMA : STR_BLACK_COMMA;
00925     }
00926 
00927     SetDParam(0, v->unitnumber);
00928     DrawString(left, right, y + 2, str);
00929 
00930     DrawVehicleProfitButton(v, vehicle_button_x, y + FONT_HEIGHT_NORMAL + 3);
00931 
00932     y += line_height;
00933   }
00934 }
00935 
00945 struct VehicleListWindow : public BaseVehicleListWindow {
00946 private:
00948   enum ButtonPlanes {
00949     BP_SHOW_BUTTONS, 
00950     BP_HIDE_BUTTONS, 
00951   };
00952 
00953 public:
00954   VehicleListWindow(const WindowDesc *desc, WindowNumber window_number) : BaseVehicleListWindow()
00955   {
00956     uint16 window_type = window_number & VLW_MASK;
00957     CompanyID company = (CompanyID)GB(window_number, 0, 8);
00958 
00959     this->vehicle_type = (VehicleType)GB(window_number, 11, 5);
00960 
00961     /* Set up sorting. Make the window-specific _sorting variable
00962      * point to the correct global _sorting struct so we are freed
00963      * from having conditionals during window operation */
00964     switch (this->vehicle_type) {
00965       case VEH_TRAIN:    this->sorting = &_sorting.train; break;
00966       case VEH_ROAD:     this->sorting = &_sorting.roadveh; break;
00967       case VEH_SHIP:     this->sorting = &_sorting.ship; break;
00968       case VEH_AIRCRAFT: this->sorting = &_sorting.aircraft; break;
00969       default: NOT_REACHED();
00970     }
00971 
00972     this->vehicles.SetListing(*this->sorting);
00973     this->vehicles.ForceRebuild();
00974     this->vehicles.NeedResort();
00975     this->BuildVehicleList(company, GB(window_number, 16, 16), window_type);
00976     this->SortVehicleList();
00977 
00978     this->CreateNestedTree(desc);
00979 
00980     /* Set up the window widgets */
00981     this->GetWidget<NWidgetCore>(VLW_WIDGET_LIST)->tool_tip = STR_VEHICLE_LIST_TRAIN_LIST_TOOLTIP + this->vehicle_type;
00982 
00983     if (window_type == VLW_SHARED_ORDERS) {
00984       this->GetWidget<NWidgetCore>(VLW_WIDGET_CAPTION)->widget_data = STR_VEHICLE_LIST_SHARED_ORDERS_LIST_CAPTION;
00985     } else {
00986       this->GetWidget<NWidgetCore>(VLW_WIDGET_CAPTION)->widget_data = STR_VEHICLE_LIST_TRAIN_CAPTION + this->vehicle_type;
00987     }
00988 
00989     this->FinishInitNested(desc, window_number);
00990     this->owner = company;
00991 
00992     if (this->vehicle_type == VEH_TRAIN) ResizeWindow(this, 65, 0);
00993   }
00994 
00995   ~VehicleListWindow()
00996   {
00997     *this->sorting = this->vehicles.GetListing();
00998   }
00999 
01000   virtual void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize)
01001   {
01002     if (widget != VLW_WIDGET_LIST) return;
01003 
01004     resize->width = 0;
01005     resize->height = GetVehicleListHeight(this->vehicle_type, 1);
01006 
01007     switch (this->vehicle_type) {
01008       case VEH_TRAIN:
01009         resize->width = 1;
01010         /* Fallthrough */
01011       case VEH_ROAD:
01012         size->height = 6 * resize->height;
01013         break;
01014       case VEH_SHIP:
01015       case VEH_AIRCRAFT:
01016         size->height = 4 * resize->height;
01017         break;
01018       default: NOT_REACHED();
01019     }
01020   }
01021 
01022   virtual void SetStringParameters(int widget) const
01023   {
01024     switch (widget) {
01025       case VLW_WIDGET_AVAILABLE_VEHICLES:
01026         SetDParam(0, STR_VEHICLE_LIST_AVAILABLE_TRAINS + this->vehicle_type);
01027         break;
01028 
01029       case VLW_WIDGET_CAPTION: {
01030         const uint16 index = GB(this->window_number, 16, 16);
01031         switch (this->window_number & VLW_MASK) {
01032           case VLW_SHARED_ORDERS: // Shared Orders
01033             if (this->vehicles.Length() == 0) {
01034               /* We can't open this window without vehicles using this order
01035               * and we should close the window when deleting the order      */
01036               NOT_REACHED();
01037             }
01038             SetDParam(0, this->vscroll.GetCount());
01039             break;
01040 
01041           case VLW_STANDARD: // Company Name
01042             SetDParam(0, STR_COMPANY_NAME);
01043             SetDParam(1, index);
01044             SetDParam(2, this->vscroll.GetCount());
01045             break;
01046 
01047           case VLW_WAYPOINT_LIST:
01048             SetDParam(0, STR_WAYPOINT_NAME);
01049             SetDParam(1, index);
01050             SetDParam(2, this->vscroll.GetCount());
01051             break;
01052 
01053           case VLW_STATION_LIST: // Station Name
01054             SetDParam(0, STR_STATION_NAME);
01055             SetDParam(1, index);
01056             SetDParam(2, this->vscroll.GetCount());
01057             break;
01058 
01059           case VLW_DEPOT_LIST:
01060             SetDParam(0, STR_DEPOT_TRAIN_CAPTION + this->vehicle_type);
01061             if (this->vehicle_type == VEH_AIRCRAFT) {
01062               SetDParam(1, index); // Airport name
01063             } else {
01064               SetDParam(1, Depot::Get(index)->town_index);
01065             }
01066             SetDParam(2, this->vscroll.GetCount());
01067             break;
01068           default: NOT_REACHED();
01069         }
01070       } break;
01071     }
01072   }
01073 
01074   virtual void DrawWidget(const Rect &r, int widget) const
01075   {
01076     switch (widget) {
01077       case VLW_WIDGET_SORT_ORDER:
01078         /* draw arrow pointing up/down for ascending/descending sorting */
01079         this->DrawSortButtonState(widget, this->vehicles.IsDescSortOrder() ? SBS_DOWN : SBS_UP);
01080         break;
01081 
01082       case VLW_WIDGET_LIST:
01083         this->DrawVehicleListItems(INVALID_VEHICLE, this->resize.step_height, r);
01084         break;
01085     }
01086   }
01087 
01088   virtual void OnPaint()
01089   {
01090     const uint16 window_type = this->window_number & VLW_MASK;
01091 
01092     this->BuildVehicleList(this->owner, GB(this->window_number, 16, 16), window_type);
01093     this->SortVehicleList();
01094 
01095     if (this->vehicles.Length() == 0 && this->IsWidgetLowered(VLW_WIDGET_MANAGE_VEHICLES_DROPDOWN)) {
01096       HideDropDownMenu(this);
01097     }
01098 
01099     /* Hide the widgets that we will not use in this window
01100      * Some windows contains actions only fit for the owner */
01101     int plane_to_show = (this->owner == _local_company) ? BP_SHOW_BUTTONS : BP_HIDE_BUTTONS;
01102     NWidgetStacked *nwi = this->GetWidget<NWidgetStacked>(VLW_WIDGET_HIDE_BUTTONS);
01103     if (plane_to_show != nwi->shown_plane) {
01104       nwi->SetDisplayedPlane(plane_to_show);
01105       nwi->SetDirty(this);
01106     }
01107     if (this->owner == _local_company) {
01108       this->SetWidgetDisabledState(VLW_WIDGET_AVAILABLE_VEHICLES, window_type != VLW_STANDARD);
01109       this->SetWidgetsDisabledState(this->vehicles.Length() == 0,
01110         VLW_WIDGET_MANAGE_VEHICLES_DROPDOWN,
01111         VLW_WIDGET_STOP_ALL,
01112         VLW_WIDGET_START_ALL,
01113         WIDGET_LIST_END);
01114     }
01115 
01116     /* Set text of sort by dropdown widget. */
01117     this->GetWidget<NWidgetCore>(VLW_WIDGET_SORT_BY_PULLDOWN)->widget_data = this->vehicle_sorter_names[this->vehicles.SortType()];
01118 
01119     this->DrawWidgets();
01120   }
01121 
01122   virtual void OnClick(Point pt, int widget, int click_count)
01123   {
01124     switch (widget) {
01125       case VLW_WIDGET_SORT_ORDER: // Flip sorting method ascending/descending
01126         this->vehicles.ToggleSortOrder();
01127         this->SetDirty();
01128         break;
01129 
01130       case VLW_WIDGET_SORT_BY_PULLDOWN:// Select sorting criteria dropdown menu
01131         ShowDropDownMenu(this, this->vehicle_sorter_names, this->vehicles.SortType(), VLW_WIDGET_SORT_BY_PULLDOWN, 0,
01132             (this->vehicle_type == VEH_TRAIN || this->vehicle_type == VEH_ROAD) ? 0 : (1 << 10));
01133         return;
01134 
01135       case VLW_WIDGET_LIST: { // Matrix to show vehicles
01136         uint32 id_v = (pt.y - this->GetWidget<NWidgetBase>(VLW_WIDGET_LIST)->pos_y) / this->resize.step_height;
01137         const Vehicle *v;
01138 
01139         if (id_v >= this->vscroll.GetCapacity()) return; // click out of bounds
01140 
01141         id_v += this->vscroll.GetPosition();
01142 
01143         if (id_v >= this->vehicles.Length()) return; // click out of list bound
01144 
01145         v = this->vehicles[id_v];
01146 
01147         ShowVehicleViewWindow(v);
01148       } break;
01149 
01150       case VLW_WIDGET_AVAILABLE_VEHICLES:
01151         ShowBuildVehicleWindow(INVALID_TILE, this->vehicle_type);
01152         break;
01153 
01154       case VLW_WIDGET_MANAGE_VEHICLES_DROPDOWN: {
01155         static StringID action_str[] = {
01156           STR_VEHICLE_LIST_REPLACE_VEHICLES,
01157           STR_VEHICLE_LIST_SEND_FOR_SERVICING,
01158           STR_NULL,
01159           INVALID_STRING_ID
01160         };
01161 
01162         static const StringID depot_name[] = {
01163           STR_VEHICLE_LIST_SEND_TRAIN_TO_DEPOT,
01164           STR_VEHICLE_LIST_SEND_ROAD_VEHICLE_TO_DEPOT,
01165           STR_VEHICLE_LIST_SEND_SHIP_TO_DEPOT,
01166           STR_VEHICLE_LIST_SEND_AIRCRAFT_TO_HANGAR
01167         };
01168 
01169         /* XXX - Substite string since the dropdown cannot handle dynamic strings */
01170         action_str[2] = depot_name[this->vehicle_type];
01171         ShowDropDownMenu(this, action_str, 0, VLW_WIDGET_MANAGE_VEHICLES_DROPDOWN, 0, (this->window_number & VLW_MASK) == VLW_STANDARD ? 0 : 1);
01172         break;
01173       }
01174 
01175       case VLW_WIDGET_STOP_ALL:
01176       case VLW_WIDGET_START_ALL:
01177         DoCommandP(0, GB(this->window_number, 16, 16),
01178             (this->window_number & VLW_MASK) | (1 << 6) | (widget == VLW_WIDGET_START_ALL ? (1 << 5) : 0) | this->vehicle_type, CMD_MASS_START_STOP);
01179         break;
01180     }
01181   }
01182 
01183   virtual void OnDropdownSelect(int widget, int index)
01184   {
01185     switch (widget) {
01186       case VLW_WIDGET_SORT_BY_PULLDOWN:
01187         this->vehicles.SetSortType(index);
01188         break;
01189       case VLW_WIDGET_MANAGE_VEHICLES_DROPDOWN:
01190         assert(this->vehicles.Length() != 0);
01191 
01192         switch (index) {
01193           case 0: // Replace window
01194             ShowReplaceGroupVehicleWindow(DEFAULT_GROUP, this->vehicle_type);
01195             break;
01196           case 1: // Send for servicing
01197             DoCommandP(0, GB(this->window_number, 16, 16) /* StationID or OrderID (depending on VLW) */,
01198               (this->window_number & VLW_MASK) | DEPOT_MASS_SEND | DEPOT_SERVICE, GetCmdSendToDepot(this->vehicle_type));
01199             break;
01200           case 2: // Send to Depots
01201             DoCommandP(0, GB(this->window_number, 16, 16) /* StationID or OrderID (depending on VLW) */,
01202               (this->window_number & VLW_MASK) | DEPOT_MASS_SEND, GetCmdSendToDepot(this->vehicle_type));
01203             break;
01204 
01205           default: NOT_REACHED();
01206         }
01207         break;
01208       default: NOT_REACHED();
01209     }
01210     this->SetDirty();
01211   }
01212 
01213   virtual void OnTick()
01214   {
01215     if (_pause_mode != PM_UNPAUSED) return;
01216     if (this->vehicles.NeedResort()) {
01217       StationID station = ((this->window_number & VLW_MASK) == VLW_STATION_LIST) ? GB(this->window_number, 16, 16) : INVALID_STATION;
01218 
01219       DEBUG(misc, 3, "Periodic resort %d list company %d at station %d", this->vehicle_type, this->owner, station);
01220       this->SetDirty();
01221     }
01222   }
01223 
01224   virtual void OnResize()
01225   {
01226     this->vscroll.SetCapacityFromWidget(this, VLW_WIDGET_LIST);
01227     this->GetWidget<NWidgetCore>(VLW_WIDGET_LIST)->widget_data = (this->vscroll.GetCapacity() << MAT_ROW_START) + (1 << MAT_COL_START);
01228   }
01229 
01230   virtual void OnInvalidateData(int data)
01231   {
01232     if (HasBit(data, 15) && (this->window_number & VLW_MASK) == VLW_SHARED_ORDERS) {
01233       SB(this->window_number, 16, 16, GB(data, 16, 16));
01234       this->vehicles.ForceRebuild();
01235       return;
01236     }
01237 
01238     if (data == 0) {
01239       this->vehicles.ForceRebuild();
01240     } else {
01241       this->vehicles.ForceResort();
01242     }
01243   }
01244 };
01245 
01246 static WindowDesc _vehicle_list_desc(
01247   WDP_AUTO, 260, 246,
01248   WC_INVALID, WC_NONE,
01249   WDF_UNCLICK_BUTTONS,
01250   _nested_vehicle_list, lengthof(_nested_vehicle_list)
01251 );
01252 
01253 static void ShowVehicleListWindowLocal(CompanyID company, uint16 VLW_flag, VehicleType vehicle_type, uint16 unique_number)
01254 {
01255   if (!Company::IsValidID(company)) {
01256     company = _local_company;
01257     /* This can happen when opening the vehicle list as a spectator.
01258      * While it would be cleaner to check this somewhere else, having
01259      * it here reduces code duplication */
01260     if (!Company::IsValidID(company)) return;
01261     _vehicle_list_desc.flags |= WDF_CONSTRUCTION;
01262   } else {
01263     _vehicle_list_desc.flags &= ~WDF_CONSTRUCTION;
01264   }
01265 
01266   _vehicle_list_desc.cls = GetWindowClassForVehicleType(vehicle_type);
01267   WindowNumber num = (unique_number << 16) | (vehicle_type << 11) | VLW_flag | company;
01268   AllocateWindowDescFront<VehicleListWindow>(&_vehicle_list_desc, num);
01269 }
01270 
01271 void ShowVehicleListWindow(CompanyID company, VehicleType vehicle_type)
01272 {
01273   /* If _settings_client.gui.advanced_vehicle_list > 1, display the Advanced list
01274    * if _settings_client.gui.advanced_vehicle_list == 1, display Advanced list only for local company
01275    * if _ctrl_pressed, do the opposite action (Advanced list x Normal list)
01276    */
01277 
01278   if ((_settings_client.gui.advanced_vehicle_list > (uint)(company != _local_company)) != _ctrl_pressed) {
01279     ShowCompanyGroup(company, vehicle_type);
01280   } else {
01281     ShowVehicleListWindowLocal(company, VLW_STANDARD, vehicle_type, company);
01282   }
01283 }
01284 
01285 void ShowVehicleListWindow(CompanyID company, VehicleType vehicle_type, const Waypoint *wp)
01286 {
01287   if (wp == NULL) return;
01288   ShowVehicleListWindowLocal(company, VLW_WAYPOINT_LIST, vehicle_type, wp->index);
01289 }
01290 
01291 void ShowVehicleListWindow(const Vehicle *v)
01292 {
01293   ShowVehicleListWindowLocal(v->owner, VLW_SHARED_ORDERS, v->type, v->FirstShared()->index);
01294 }
01295 
01296 void ShowVehicleListWindow(CompanyID company, VehicleType vehicle_type, StationID station)
01297 {
01298   ShowVehicleListWindowLocal(company, VLW_STATION_LIST, vehicle_type, station);
01299 }
01300 
01301 void ShowVehicleListWindow(CompanyID company, VehicleType vehicle_type, TileIndex depot_tile)
01302 {
01303   uint16 depot_airport_index;
01304 
01305   if (vehicle_type == VEH_AIRCRAFT) {
01306     depot_airport_index = GetStationIndex(depot_tile);
01307   } else {
01308     depot_airport_index = GetDepotIndex(depot_tile);
01309   }
01310   ShowVehicleListWindowLocal(company, VLW_DEPOT_LIST, vehicle_type, depot_airport_index);
01311 }
01312 
01313 
01314 /* Unified vehicle GUI - Vehicle Details Window */
01315 
01317 enum VehicleDetailsWindowWidgets {
01318   VLD_WIDGET_CAPTION,
01319   VLD_WIDGET_RENAME_VEHICLE,
01320   VLD_WIDGET_TOP_DETAILS,
01321   VLD_WIDGET_INCREASE_SERVICING_INTERVAL,
01322   VLD_WIDGET_DECREASE_SERVICING_INTERVAL,
01323   VLD_WIDGET_SERVICING_INTERVAL,
01324   VLD_WIDGET_MIDDLE_DETAILS,
01325   VLD_WIDGET_MATRIX,
01326   VLD_WIDGET_SCROLLBAR,
01327   VLD_WIDGET_DETAILS_CARGO_CARRIED,
01328   VLD_WIDGET_DETAILS_TRAIN_VEHICLES,
01329   VLD_WIDGET_DETAILS_CAPACITY_OF_EACH,
01330   VLD_WIDGET_DETAILS_TOTAL_CARGO,
01331 };
01332 
01333 assert_compile(VLD_WIDGET_DETAILS_CARGO_CARRIED    == VLD_WIDGET_DETAILS_CARGO_CARRIED + TDW_TAB_CARGO   );
01334 assert_compile(VLD_WIDGET_DETAILS_TRAIN_VEHICLES   == VLD_WIDGET_DETAILS_CARGO_CARRIED + TDW_TAB_INFO    );
01335 assert_compile(VLD_WIDGET_DETAILS_CAPACITY_OF_EACH == VLD_WIDGET_DETAILS_CARGO_CARRIED + TDW_TAB_CAPACITY);
01336 assert_compile(VLD_WIDGET_DETAILS_TOTAL_CARGO      == VLD_WIDGET_DETAILS_CARGO_CARRIED + TDW_TAB_TOTALS  );
01337 
01339 static const NWidgetPart _nested_nontrain_vehicle_details_widgets[] = {
01340   NWidget(NWID_HORIZONTAL),
01341     NWidget(WWT_CLOSEBOX, COLOUR_GREY),
01342     NWidget(WWT_CAPTION, COLOUR_GREY, VLD_WIDGET_CAPTION), SetDataTip(STR_VEHICLE_DETAILS_CAPTION, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
01343     NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, VLD_WIDGET_RENAME_VEHICLE), SetMinimalSize(40, 0), SetMinimalTextLines(1, WD_FRAMERECT_TOP + WD_FRAMERECT_BOTTOM + 2), SetDataTip(STR_VEHICLE_NAME_BUTTON, STR_NULL /* filled in later */),
01344     NWidget(WWT_SHADEBOX, COLOUR_GREY),
01345     NWidget(WWT_STICKYBOX, COLOUR_GREY),
01346   EndContainer(),
01347   NWidget(WWT_PANEL, COLOUR_GREY, VLD_WIDGET_TOP_DETAILS), SetMinimalSize(405, 42), SetResize(1, 0), EndContainer(),
01348   NWidget(WWT_PANEL, COLOUR_GREY, VLD_WIDGET_MIDDLE_DETAILS), SetMinimalSize(405, 45), SetResize(1, 0), EndContainer(),
01349   NWidget(NWID_HORIZONTAL),
01350     NWidget(NWID_BUTTON_ARROW, COLOUR_GREY, VLD_WIDGET_DECREASE_SERVICING_INTERVAL), SetFill(0, 1),
01351         SetDataTip(AWV_DECREASE, STR_VEHICLE_DETAILS_DECREASE_SERVICING_INTERVAL_TOOLTIP),
01352     NWidget(NWID_BUTTON_ARROW, COLOUR_GREY, VLD_WIDGET_INCREASE_SERVICING_INTERVAL), SetFill(0, 1),
01353         SetDataTip(AWV_INCREASE, STR_VEHICLE_DETAILS_INCREASE_SERVICING_INTERVAL_TOOLTIP),
01354     NWidget(WWT_PANEL, COLOUR_GREY, VLD_WIDGET_SERVICING_INTERVAL), SetFill(1, 1), SetResize(1, 0), EndContainer(),
01355     NWidget(WWT_RESIZEBOX, COLOUR_GREY),
01356   EndContainer(),
01357 };
01358 
01360 static const NWidgetPart _nested_train_vehicle_details_widgets[] = {
01361   NWidget(NWID_HORIZONTAL),
01362     NWidget(WWT_CLOSEBOX, COLOUR_GREY),
01363     NWidget(WWT_CAPTION, COLOUR_GREY, VLD_WIDGET_CAPTION), SetDataTip(STR_VEHICLE_DETAILS_CAPTION, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
01364     NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, VLD_WIDGET_RENAME_VEHICLE), SetMinimalSize(40, 0), SetMinimalTextLines(1, WD_FRAMERECT_TOP + WD_FRAMERECT_BOTTOM + 2), SetDataTip(STR_VEHICLE_NAME_BUTTON, STR_NULL /* filled in later */),
01365     NWidget(WWT_SHADEBOX, COLOUR_GREY),
01366     NWidget(WWT_STICKYBOX, COLOUR_GREY),
01367   EndContainer(),
01368   NWidget(WWT_PANEL, COLOUR_GREY, VLD_WIDGET_TOP_DETAILS), SetResize(1, 0), SetMinimalSize(405, 42), EndContainer(),
01369   NWidget(NWID_HORIZONTAL),
01370     NWidget(WWT_MATRIX, COLOUR_GREY, VLD_WIDGET_MATRIX), SetResize(1, 1), SetMinimalSize(393, 45), SetDataTip(0x701, STR_NULL), SetFill(1, 0),
01371     NWidget(WWT_SCROLLBAR, COLOUR_GREY, VLD_WIDGET_SCROLLBAR),
01372   EndContainer(),
01373   NWidget(NWID_HORIZONTAL),
01374     NWidget(NWID_BUTTON_ARROW, COLOUR_GREY, VLD_WIDGET_DECREASE_SERVICING_INTERVAL), SetFill(0, 1),
01375         SetDataTip(AWV_DECREASE, STR_VEHICLE_DETAILS_DECREASE_SERVICING_INTERVAL_TOOLTIP),
01376     NWidget(NWID_BUTTON_ARROW, COLOUR_GREY, VLD_WIDGET_INCREASE_SERVICING_INTERVAL), SetFill(0, 1),
01377         SetDataTip(AWV_INCREASE, STR_VEHICLE_DETAILS_DECREASE_SERVICING_INTERVAL_TOOLTIP),
01378     NWidget(WWT_PANEL, COLOUR_GREY, VLD_WIDGET_SERVICING_INTERVAL), SetFill(1, 1), SetResize(1, 0), EndContainer(),
01379   EndContainer(),
01380   NWidget(NWID_HORIZONTAL),
01381     NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, VLD_WIDGET_DETAILS_CARGO_CARRIED), SetMinimalSize(96, 12),
01382         SetDataTip(STR_VEHICLE_DETAIL_TAB_CARGO, STR_VEHICLE_DETAILS_TRAIN_CARGO_TOOLTIP), SetFill(1, 0), SetResize(1, 0),
01383     NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, VLD_WIDGET_DETAILS_TRAIN_VEHICLES), SetMinimalSize(99, 12),
01384         SetDataTip(STR_VEHICLE_DETAIL_TAB_INFORMATION, STR_VEHICLE_DETAILS_TRAIN_INFORMATION_TOOLTIP), SetFill(1, 0), SetResize(1, 0),
01385     NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, VLD_WIDGET_DETAILS_CAPACITY_OF_EACH), SetMinimalSize(99, 12),
01386         SetDataTip(STR_VEHICLE_DETAIL_TAB_CAPACITIES, STR_VEHICLE_DETAILS_TRAIN_CAPACITIES_TOOLTIP), SetFill(1, 0), SetResize(1, 0),
01387     NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, VLD_WIDGET_DETAILS_TOTAL_CARGO), SetMinimalSize(99, 12),
01388         SetDataTip(STR_VEHICLE_DETAIL_TAB_TOTAL_CARGO, STR_VEHICLE_DETAILS_TRAIN_TOTAL_CARGO_TOOLTIP), SetFill(1, 0), SetResize(1, 0),
01389     NWidget(WWT_RESIZEBOX, COLOUR_GREY),
01390   EndContainer(),
01391 };
01392 
01393 
01394 extern int GetTrainDetailsWndVScroll(VehicleID veh_id, TrainDetailsWindowTabs det_tab);
01395 extern void DrawTrainDetails(const Train *v, int left, int right, int y, int vscroll_pos, uint16 vscroll_cap, TrainDetailsWindowTabs det_tab);
01396 extern void DrawRoadVehDetails(const Vehicle *v, int left, int right, int y);
01397 extern void DrawShipDetails(const Vehicle *v, int left, int right, int y);
01398 extern void DrawAircraftDetails(const Aircraft *v, int left, int right, int y);
01399 
01401 struct VehicleDetailsWindow : Window {
01402   TrainDetailsWindowTabs tab; 
01403 
01405   VehicleDetailsWindow(const WindowDesc *desc, WindowNumber window_number) : Window()
01406   {
01407     this->InitNested(desc, window_number);
01408 
01409     const Vehicle *v = Vehicle::Get(this->window_number);
01410 
01411     this->GetWidget<NWidgetCore>(VLD_WIDGET_RENAME_VEHICLE)->tool_tip = STR_VEHICLE_DETAILS_TRAIN_RENAME + v->type;
01412 
01413     this->owner = v->owner;
01414     this->tab = TDW_TAB_CARGO;
01415   }
01416 
01417   virtual void OnInvalidateData(int data)
01418   {
01419     const Vehicle *v = Vehicle::Get(this->window_number);
01420     if (v->type == VEH_ROAD) {
01421       const NWidgetBase *nwid_info = this->GetWidget<NWidgetBase>(VLD_WIDGET_MIDDLE_DETAILS);
01422       uint aimed_height = this->GetRoadVehDetailsHeight(v);
01423       /* If the number of articulated parts changes, the size of the window must change too. */
01424       if (aimed_height != nwid_info->current_y) {
01425         this->ReInit();
01426       }
01427     }
01428   }
01429 
01435   uint GetRoadVehDetailsHeight(const Vehicle *v)
01436   {
01437     uint desired_height;
01438     if (RoadVehicle::From(v)->HasArticulatedPart()) {
01439       /* An articulated RV has its text drawn under the sprite instead of after it, hence 15 pixels extra. */
01440       desired_height = WD_FRAMERECT_TOP + 15 + 3 * FONT_HEIGHT_NORMAL + 2 + WD_FRAMERECT_BOTTOM;
01441       /* Add space for the cargo amount for each part. */
01442       for (const Vehicle *u = v; u != NULL; u = u->Next()) {
01443         if (u->cargo_cap != 0) desired_height += FONT_HEIGHT_NORMAL + 1;
01444       }
01445     } else {
01446       desired_height = WD_FRAMERECT_TOP + 4 * FONT_HEIGHT_NORMAL + 3 + WD_FRAMERECT_BOTTOM;
01447     }
01448     return desired_height;
01449   }
01450 
01451   virtual void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize)
01452   {
01453     switch (widget) {
01454       case VLD_WIDGET_TOP_DETAILS: {
01455         Dimension dim = { 0, 0 };
01456         size->height = WD_FRAMERECT_TOP + 4 * FONT_HEIGHT_NORMAL + WD_FRAMERECT_BOTTOM;
01457 
01458         for (uint i = 0; i < 4; i++) SetDParam(i, INT16_MAX);
01459         static const StringID info_strings[] = {
01460           STR_VEHICLE_INFO_MAX_SPEED,
01461           STR_VEHICLE_INFO_WEIGHT_POWER_MAX_SPEED,
01462           STR_VEHICLE_INFO_WEIGHT_POWER_MAX_SPEED_MAX_TE,
01463           STR_VEHICLE_INFO_PROFIT_THIS_YEAR_LAST_YEAR,
01464           STR_VEHICLE_INFO_RELIABILITY_BREAKDOWNS
01465         };
01466         for (uint i = 0; i < lengthof(info_strings); i++) {
01467           dim = maxdim(dim, GetStringBoundingBox(info_strings[i]));
01468         }
01469         SetDParam(0, STR_VEHICLE_INFO_AGE);
01470         dim = maxdim(dim, GetStringBoundingBox(STR_VEHICLE_INFO_AGE_RUNNING_COST_YR));
01471         size->width = dim.width + WD_FRAMERECT_LEFT + WD_FRAMERECT_RIGHT;
01472       } break;
01473 
01474       case VLD_WIDGET_MIDDLE_DETAILS: {
01475         const Vehicle *v = Vehicle::Get(this->window_number);
01476         switch (v->type) {
01477           case VEH_ROAD:
01478             size->height = this->GetRoadVehDetailsHeight(v);
01479             break;
01480 
01481           case VEH_SHIP:
01482             size->height = WD_FRAMERECT_TOP + 4 * FONT_HEIGHT_NORMAL + 3 + WD_FRAMERECT_BOTTOM;
01483             break;
01484 
01485           case VEH_AIRCRAFT:
01486             size->height = WD_FRAMERECT_TOP + 5 * FONT_HEIGHT_NORMAL + 4 + WD_FRAMERECT_BOTTOM;
01487             break;
01488 
01489           default:
01490             NOT_REACHED(); // Train uses VLD_WIDGET_MATRIX instead.
01491         }
01492         break;
01493       }
01494 
01495       case VLD_WIDGET_MATRIX:
01496         resize->height = WD_MATRIX_TOP + FONT_HEIGHT_NORMAL + WD_MATRIX_BOTTOM;
01497         size->height = 4 * resize->height;
01498         break;
01499 
01500       case VLD_WIDGET_SERVICING_INTERVAL:
01501         SetDParam(0, 9999); // Roughly the maximum interval
01502         SetDParam(1, MAX_YEAR * DAYS_IN_YEAR); // Roughly the maximum year
01503         size->width = max(GetStringBoundingBox(STR_VEHICLE_DETAILS_SERVICING_INTERVAL_PERCENT).width, GetStringBoundingBox(STR_VEHICLE_DETAILS_SERVICING_INTERVAL_DAYS).width) + WD_FRAMERECT_LEFT + WD_FRAMERECT_RIGHT;
01504         size->height = WD_FRAMERECT_TOP + FONT_HEIGHT_NORMAL + WD_FRAMERECT_BOTTOM;
01505         break;
01506     }
01507   }
01508 
01510   static bool IsVehicleServiceIntervalEnabled(const VehicleType vehicle_type, CompanyID company_id)
01511   {
01512     const VehicleDefaultSettings *vds = &Company::Get(company_id)->settings.vehicle;
01513     switch (vehicle_type) {
01514       default: NOT_REACHED();
01515       case VEH_TRAIN:    return vds->servint_trains   != 0;
01516       case VEH_ROAD:     return vds->servint_roadveh  != 0;
01517       case VEH_SHIP:     return vds->servint_ships    != 0;
01518       case VEH_AIRCRAFT: return vds->servint_aircraft != 0;
01519     }
01520   }
01521 
01533   static void DrawVehicleDetails(const Vehicle *v, int left, int right, int y, int vscroll_pos, uint vscroll_cap, TrainDetailsWindowTabs det_tab)
01534   {
01535     switch (v->type) {
01536       case VEH_TRAIN:    DrawTrainDetails(Train::From(v), left, right, y, vscroll_pos, vscroll_cap, det_tab);  break;
01537       case VEH_ROAD:     DrawRoadVehDetails(v, left, right, y);  break;
01538       case VEH_SHIP:     DrawShipDetails(v, left, right, y);     break;
01539       case VEH_AIRCRAFT: DrawAircraftDetails(Aircraft::From(v), left, right, y); break;
01540       default: NOT_REACHED();
01541     }
01542   }
01543 
01544   virtual void SetStringParameters(int widget) const
01545   {
01546     if (widget == VLD_WIDGET_CAPTION) SetDParam(0, Vehicle::Get(this->window_number)->index);
01547   }
01548 
01549   virtual void DrawWidget(const Rect &r, int widget) const
01550   {
01551     const Vehicle *v = Vehicle::Get(this->window_number);
01552 
01553     switch (widget) {
01554       case VLD_WIDGET_TOP_DETAILS: {
01555         int y = r.top + WD_FRAMERECT_TOP;
01556 
01557         /* Draw running cost */
01558         SetDParam(1, v->age / DAYS_IN_LEAP_YEAR);
01559         SetDParam(0, (v->age + DAYS_IN_YEAR < v->max_age) ? STR_VEHICLE_INFO_AGE : STR_VEHICLE_INFO_AGE_RED);
01560         SetDParam(2, v->max_age / DAYS_IN_LEAP_YEAR);
01561         SetDParam(3, v->GetDisplayRunningCost());
01562         DrawString(r.left + WD_FRAMERECT_LEFT, r.right - WD_FRAMERECT_RIGHT, y, STR_VEHICLE_INFO_AGE_RUNNING_COST_YR);
01563         y += FONT_HEIGHT_NORMAL;
01564 
01565         /* Draw max speed */
01566         switch (v->type) {
01567           case VEH_TRAIN:
01568             SetDParam(2, v->GetDisplayMaxSpeed());
01569             SetDParam(1, Train::From(v)->tcache.cached_power);
01570             SetDParam(0, Train::From(v)->tcache.cached_weight);
01571             SetDParam(3, Train::From(v)->tcache.cached_max_te / 1000);
01572             DrawString(r.left + WD_FRAMERECT_LEFT, r.right - WD_FRAMERECT_RIGHT, y, (_settings_game.vehicle.train_acceleration_model != AM_ORIGINAL && GetRailTypeInfo(Train::From(v)->railtype)->acceleration_type != 2) ?
01573                 STR_VEHICLE_INFO_WEIGHT_POWER_MAX_SPEED_MAX_TE : STR_VEHICLE_INFO_WEIGHT_POWER_MAX_SPEED);
01574             break;
01575 
01576           case VEH_ROAD:
01577           case VEH_SHIP:
01578           case VEH_AIRCRAFT:
01579             SetDParam(0, v->GetDisplayMaxSpeed());
01580             DrawString(r.left + WD_FRAMERECT_LEFT, r.right - WD_FRAMERECT_RIGHT, y, STR_VEHICLE_INFO_MAX_SPEED);
01581             break;
01582 
01583           default: NOT_REACHED();
01584         }
01585         y += FONT_HEIGHT_NORMAL;
01586 
01587         /* Draw profit */
01588         SetDParam(0, v->GetDisplayProfitThisYear());
01589         SetDParam(1, v->GetDisplayProfitLastYear());
01590         DrawString(r.left + WD_FRAMERECT_LEFT, r.right - WD_FRAMERECT_RIGHT, y, STR_VEHICLE_INFO_PROFIT_THIS_YEAR_LAST_YEAR);
01591         y += FONT_HEIGHT_NORMAL;
01592 
01593         /* Draw breakdown & reliability */
01594         SetDParam(0, ToPercent16(v->reliability));
01595         SetDParam(1, v->breakdowns_since_last_service);
01596         DrawString(r.left + WD_FRAMERECT_LEFT, r.right - WD_FRAMERECT_RIGHT, y, STR_VEHICLE_INFO_RELIABILITY_BREAKDOWNS);
01597         break;
01598       }
01599 
01600       case VLD_WIDGET_MATRIX:
01601         /* For trains only. */
01602         DrawVehicleDetails(v, r.left + WD_MATRIX_LEFT, r.right - WD_MATRIX_RIGHT, r.top + WD_MATRIX_TOP, this->vscroll.GetPosition(), this->vscroll.GetCapacity(), this->tab);
01603         break;
01604 
01605       case VLD_WIDGET_MIDDLE_DETAILS: {
01606         /* For other vehicles, at the place of the matrix. */
01607         bool rtl = _dynlang.text_dir == TD_RTL;
01608         uint sprite_width = max<uint>(GetSprite(v->GetImage(rtl ? DIR_E : DIR_W), ST_NORMAL)->width, 70U) + WD_FRAMERECT_LEFT + WD_FRAMERECT_RIGHT;
01609 
01610         uint text_left  = r.left  + (rtl ? 0 : sprite_width);
01611         uint text_right = r.right - (rtl ? sprite_width : 0);
01612 
01613         uint sprite_left  = rtl ? text_right : r.left;
01614         uint sprite_right = rtl ? r.right : text_left;
01615 
01616         DrawVehicleImage(v, sprite_left + WD_FRAMERECT_LEFT, sprite_right - WD_FRAMERECT_RIGHT, r.top + WD_FRAMERECT_TOP, INVALID_VEHICLE, 0);
01617         DrawVehicleDetails(v, text_left + WD_FRAMERECT_LEFT, text_right - WD_FRAMERECT_RIGHT, r.top + WD_FRAMERECT_TOP, this->vscroll.GetPosition(), this->vscroll.GetCapacity(), this->tab);
01618       } break;
01619 
01620       case VLD_WIDGET_SERVICING_INTERVAL:
01621         /* Draw service interval text */
01622         SetDParam(0, v->service_interval);
01623         SetDParam(1, v->date_of_last_service);
01624         DrawString(r.left + WD_FRAMERECT_LEFT, r.right - WD_FRAMERECT_RIGHT, r.top + (r.bottom - r.top + 1 - FONT_HEIGHT_NORMAL) / 2,
01625             Company::Get(v->owner)->settings.vehicle.servint_ispercent ? STR_VEHICLE_DETAILS_SERVICING_INTERVAL_PERCENT : STR_VEHICLE_DETAILS_SERVICING_INTERVAL_DAYS);
01626         break;
01627     }
01628   }
01629 
01631   virtual void OnPaint()
01632   {
01633     const Vehicle *v = Vehicle::Get(this->window_number);
01634 
01635     this->SetWidgetDisabledState(VLD_WIDGET_RENAME_VEHICLE, v->owner != _local_company);
01636 
01637     if (v->type == VEH_TRAIN) {
01638       this->DisableWidget(this->tab + VLD_WIDGET_DETAILS_CARGO_CARRIED);
01639       this->vscroll.SetCount(GetTrainDetailsWndVScroll(v->index, this->tab));
01640     }
01641 
01642     /* Disable service-scroller when interval is set to disabled */
01643     this->SetWidgetsDisabledState(!IsVehicleServiceIntervalEnabled(v->type, v->owner),
01644       VLD_WIDGET_INCREASE_SERVICING_INTERVAL,
01645       VLD_WIDGET_DECREASE_SERVICING_INTERVAL,
01646       WIDGET_LIST_END);
01647 
01648     this->DrawWidgets();
01649   }
01650 
01651   virtual void OnClick(Point pt, int widget, int click_count)
01652   {
01653     switch (widget) {
01654       case VLD_WIDGET_RENAME_VEHICLE: { // rename
01655         const Vehicle *v = Vehicle::Get(this->window_number);
01656         SetDParam(0, v->index);
01657         ShowQueryString(STR_VEHICLE_NAME, STR_QUERY_RENAME_TRAIN_CAPTION + v->type,
01658             MAX_LENGTH_VEHICLE_NAME_BYTES, MAX_LENGTH_VEHICLE_NAME_PIXELS, this, CS_ALPHANUMERAL, QSF_ENABLE_DEFAULT);
01659       } break;
01660 
01661       case VLD_WIDGET_INCREASE_SERVICING_INTERVAL:   // increase int
01662       case VLD_WIDGET_DECREASE_SERVICING_INTERVAL: { // decrease int
01663         int mod = _ctrl_pressed ? 5 : 10;
01664         const Vehicle *v = Vehicle::Get(this->window_number);
01665 
01666         mod = (widget == VLD_WIDGET_DECREASE_SERVICING_INTERVAL) ? -mod : mod;
01667         mod = GetServiceIntervalClamped(mod + v->service_interval, v->owner);
01668         if (mod == v->service_interval) return;
01669 
01670         DoCommandP(v->tile, v->index, mod, CMD_CHANGE_SERVICE_INT | CMD_MSG(STR_ERROR_CAN_T_CHANGE_SERVICING));
01671       } break;
01672 
01673       case VLD_WIDGET_DETAILS_CARGO_CARRIED:
01674       case VLD_WIDGET_DETAILS_TRAIN_VEHICLES:
01675       case VLD_WIDGET_DETAILS_CAPACITY_OF_EACH:
01676       case VLD_WIDGET_DETAILS_TOTAL_CARGO:
01677         this->SetWidgetsDisabledState(false,
01678           VLD_WIDGET_DETAILS_CARGO_CARRIED,
01679           VLD_WIDGET_DETAILS_TRAIN_VEHICLES,
01680           VLD_WIDGET_DETAILS_CAPACITY_OF_EACH,
01681           VLD_WIDGET_DETAILS_TOTAL_CARGO,
01682           widget,
01683           WIDGET_LIST_END);
01684 
01685         this->tab = (TrainDetailsWindowTabs)(widget - VLD_WIDGET_DETAILS_CARGO_CARRIED);
01686         this->SetDirty();
01687         break;
01688     }
01689   }
01690 
01691   virtual void OnQueryTextFinished(char *str)
01692   {
01693     if (str == NULL) return;
01694 
01695     DoCommandP(0, this->window_number, 0, CMD_RENAME_VEHICLE | CMD_MSG(STR_ERROR_CAN_T_RENAME_TRAIN + Vehicle::Get(this->window_number)->type), NULL, str);
01696   }
01697 
01698   virtual void OnResize()
01699   {
01700     NWidgetCore *nwi = this->GetWidget<NWidgetCore>(VLD_WIDGET_MATRIX);
01701     if (nwi != NULL) {
01702       this->vscroll.SetCapacityFromWidget(this, VLD_WIDGET_MATRIX);
01703       nwi->widget_data = (this->vscroll.GetCapacity() << MAT_ROW_START) + (1 << MAT_COL_START);
01704     }
01705   }
01706 };
01707 
01709 static const WindowDesc _train_vehicle_details_desc(
01710   WDP_AUTO, 405, 178,
01711   WC_VEHICLE_DETAILS, WC_VEHICLE_VIEW,
01712   WDF_UNCLICK_BUTTONS,
01713   _nested_train_vehicle_details_widgets, lengthof(_nested_train_vehicle_details_widgets)
01714 );
01715 
01717 static const WindowDesc _nontrain_vehicle_details_desc(
01718   WDP_AUTO, 405, 113,
01719   WC_VEHICLE_DETAILS, WC_VEHICLE_VIEW,
01720   WDF_UNCLICK_BUTTONS,
01721   _nested_nontrain_vehicle_details_widgets, lengthof(_nested_nontrain_vehicle_details_widgets)
01722 );
01723 
01725 static void ShowVehicleDetailsWindow(const Vehicle *v)
01726 {
01727   DeleteWindowById(WC_VEHICLE_ORDERS, v->index, false);
01728   DeleteWindowById(WC_VEHICLE_TIMETABLE, v->index, false);
01729   AllocateWindowDescFront<VehicleDetailsWindow>((v->type == VEH_TRAIN) ? &_train_vehicle_details_desc : &_nontrain_vehicle_details_desc, v->index);
01730 }
01731 
01732 
01733 /* Unified vehicle GUI - Vehicle View Window */
01734 
01736 static const NWidgetPart _nested_vehicle_view_widgets[] = {
01737   NWidget(NWID_HORIZONTAL),
01738     NWidget(WWT_CLOSEBOX, COLOUR_GREY),
01739     NWidget(WWT_CAPTION, COLOUR_GREY, VVW_WIDGET_CAPTION), SetDataTip(STR_VEHICLE_VIEW_CAPTION, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
01740     NWidget(WWT_SHADEBOX, COLOUR_GREY),
01741     NWidget(WWT_STICKYBOX, COLOUR_GREY),
01742   EndContainer(),
01743   NWidget(NWID_HORIZONTAL),
01744     NWidget(WWT_PANEL, COLOUR_GREY),
01745       NWidget(WWT_INSET, COLOUR_GREY), SetPadding(2, 2, 2, 2),
01746         NWidget(NWID_VIEWPORT, INVALID_COLOUR, VVW_WIDGET_VIEWPORT), SetMinimalSize(226, 84), SetResize(1, 1), SetPadding(1, 1, 1, 1),
01747       EndContainer(),
01748     EndContainer(),
01749     NWidget(NWID_VERTICAL),
01750       NWidget(WWT_PUSHIMGBTN, COLOUR_GREY, VVW_WIDGET_CENTER_MAIN_VIEH), SetMinimalSize(18, 18), SetFill(1, 1), SetDataTip(SPR_CENTRE_VIEW_VEHICLE, 0x0 /* filled later */),
01751       NWidget(NWID_SELECTION, INVALID_COLOUR, VVW_WIDGET_SELECT_DEPOT_CLONE),
01752         NWidget(WWT_PUSHIMGBTN, COLOUR_GREY, VVW_WIDGET_GOTO_DEPOT), SetMinimalSize(18, 18), SetFill(1, 1), SetDataTip(0x0 /* filled later */, 0x0 /* filled later */),
01753         NWidget(WWT_PUSHIMGBTN, COLOUR_GREY, VVW_WIDGET_CLONE_VEH), SetMinimalSize(18, 18), SetFill(1, 1), SetDataTip(0x0 /* filled later */, 0x0 /* filled later */),
01754       EndContainer(),
01755       /* For trains only, 'ignore signal' button. */
01756       NWidget(WWT_PUSHIMGBTN, COLOUR_GREY, VVW_WIDGET_FORCE_PROCEED), SetMinimalSize(18, 18), SetFill(1, 1),
01757                       SetDataTip(SPR_IGNORE_SIGNALS, STR_VEHICLE_VIEW_TRAIN_IGNORE_SIGNAL_TOOLTIP),
01758       NWidget(NWID_SELECTION, INVALID_COLOUR, VVW_WIDGET_SELECT_REFIT_TURN),
01759         NWidget(WWT_PUSHIMGBTN, COLOUR_GREY, VVW_WIDGET_REFIT_VEH), SetMinimalSize(18, 18), SetFill(1, 1), SetDataTip(SPR_REFIT_VEHICLE, 0x0 /* filled later */),
01760         NWidget(WWT_PUSHIMGBTN, COLOUR_GREY, VVW_WIDGET_TURN_AROUND), SetMinimalSize(18, 18), SetFill(1, 1),
01761                         SetDataTip(SPR_FORCE_VEHICLE_TURN, STR_VEHICLE_VIEW_ROAD_VEHICLE_REVERSE_TOOLTIP),
01762       EndContainer(),
01763       NWidget(WWT_PUSHIMGBTN, COLOUR_GREY, VVW_WIDGET_SHOW_ORDERS), SetFill(1, 1), SetMinimalSize(18, 18), SetDataTip(SPR_SHOW_ORDERS, 0x0 /* filled later */),
01764       NWidget(WWT_PUSHIMGBTN, COLOUR_GREY, VVW_WIDGET_SHOW_DETAILS), SetFill(1, 1), SetMinimalSize(18, 18), SetDataTip(SPR_SHOW_VEHICLE_DETAILS, 0x0 /* filled later */),
01765       NWidget(WWT_PANEL, COLOUR_GREY), SetFill(1, 1), SetMinimalSize(18, 0), SetResize(0, 1), EndContainer(),
01766     EndContainer(),
01767   EndContainer(),
01768   NWidget(NWID_HORIZONTAL),
01769     NWidget(WWT_PUSHBTN, COLOUR_GREY, VVW_WIDGET_START_STOP_VEH), SetMinimalTextLines(1, WD_FRAMERECT_TOP + WD_FRAMERECT_BOTTOM), SetResize(1, 0), SetFill(1, 0),
01770     NWidget(WWT_RESIZEBOX, COLOUR_GREY),
01771   EndContainer(),
01772 };
01773 
01775 static const WindowDesc _vehicle_view_desc(
01776   WDP_AUTO, 250, 116,
01777   WC_VEHICLE_VIEW, WC_NONE,
01778   WDF_UNCLICK_BUTTONS,
01779   _nested_vehicle_view_widgets, lengthof(_nested_vehicle_view_widgets)
01780 );
01781 
01785 static const WindowDesc _train_view_desc(
01786   WDP_AUTO, 250, 134,
01787   WC_VEHICLE_VIEW, WC_NONE,
01788   WDF_UNCLICK_BUTTONS,
01789   _nested_vehicle_view_widgets, lengthof(_nested_vehicle_view_widgets)
01790 );
01791 
01792 
01793 /* Just to make sure, nobody has changed the vehicle type constants, as we are
01794    using them for array indexing in a number of places here. */
01795 assert_compile(VEH_TRAIN == 0);
01796 assert_compile(VEH_ROAD == 1);
01797 assert_compile(VEH_SHIP == 2);
01798 assert_compile(VEH_AIRCRAFT == 3);
01799 
01801 static const ZoomLevel _vehicle_view_zoom_levels[] = {
01802   ZOOM_LVL_TRAIN,
01803   ZOOM_LVL_ROADVEH,
01804   ZOOM_LVL_SHIP,
01805   ZOOM_LVL_AIRCRAFT,
01806 };
01807 
01808 /* Constants for geometry of vehicle view viewport */
01809 static const int VV_INITIAL_VIEWPORT_WIDTH = 226;
01810 static const int VV_INITIAL_VIEWPORT_HEIGHT = 84;
01811 static const int VV_INITIAL_VIEWPORT_HEIGHT_TRAIN = 102;
01812 
01814 enum VehicleCommandTranslation {
01815   VCT_CMD_START_STOP = 0,
01816   VCT_CMD_CLONE_VEH,
01817   VCT_CMD_TURN_AROUND,
01818 };
01819 
01821 static const uint32 _vehicle_command_translation_table[][4] = {
01822   { // VCT_CMD_START_STOP
01823     CMD_START_STOP_VEHICLE | CMD_MSG(STR_ERROR_CAN_T_STOP_START_TRAIN),
01824     CMD_START_STOP_VEHICLE | CMD_MSG(STR_ERROR_CAN_T_STOP_START_ROAD_VEHICLE),
01825     CMD_START_STOP_VEHICLE | CMD_MSG(STR_ERROR_CAN_T_STOP_START_SHIP),
01826     CMD_START_STOP_VEHICLE | CMD_MSG(STR_ERROR_CAN_T_STOP_START_AIRCRAFT)
01827   },
01828   { // VCT_CMD_CLONE_VEH
01829     CMD_CLONE_VEHICLE | CMD_MSG(STR_ERROR_CAN_T_BUY_TRAIN),
01830     CMD_CLONE_VEHICLE | CMD_MSG(STR_ERROR_CAN_T_BUY_ROAD_VEHICLE),
01831     CMD_CLONE_VEHICLE | CMD_MSG(STR_ERROR_CAN_T_BUY_SHIP),
01832     CMD_CLONE_VEHICLE | CMD_MSG(STR_ERROR_CAN_T_BUY_AIRCRAFT)
01833   },
01834   { // VCT_CMD_TURN_AROUND
01835     CMD_REVERSE_TRAIN_DIRECTION | CMD_MSG(STR_ERROR_CAN_T_REVERSE_DIRECTION_TRAIN),
01836     CMD_TURN_ROADVEH            | CMD_MSG(STR_ERROR_CAN_T_MAKE_ROAD_VEHICLE_TURN),
01837     0xffffffff, // invalid for ships
01838     0xffffffff  // invalid for aircrafts
01839   },
01840 };
01841 
01843 static bool IsVehicleRefitable(const Vehicle *v)
01844 {
01845   if (!v->IsStoppedInDepot()) return false;
01846 
01847   do {
01848     if (IsEngineRefittable(v->engine_type)) return true;
01849   } while ((v->type == VEH_TRAIN || v->type == VEH_ROAD) && (v = v->Next()) != NULL);
01850 
01851   return false;
01852 }
01853 
01855 struct VehicleViewWindow : Window {
01856 private:
01858   enum PlaneSelections {
01859     SEL_DC_GOTO_DEPOT,  
01860     SEL_DC_CLONE,       
01861 
01862     SEL_RT_REFIT,       
01863     SEL_RT_TURN_AROUND, 
01864 
01865     SEL_DC_BASEPLANE = SEL_DC_GOTO_DEPOT, 
01866     SEL_RT_BASEPLANE = SEL_RT_REFIT,      
01867   };
01868 
01872   void SelectPlane(PlaneSelections plane)
01873   {
01874     switch (plane) {
01875       case SEL_DC_GOTO_DEPOT:
01876       case SEL_DC_CLONE:
01877         this->GetWidget<NWidgetStacked>(VVW_WIDGET_SELECT_DEPOT_CLONE)->SetDisplayedPlane(plane - SEL_DC_BASEPLANE);
01878         break;
01879 
01880       case SEL_RT_REFIT:
01881       case SEL_RT_TURN_AROUND:
01882         this->GetWidget<NWidgetStacked>(VVW_WIDGET_SELECT_REFIT_TURN)->SetDisplayedPlane(plane - SEL_RT_BASEPLANE);
01883         break;
01884 
01885       default:
01886         NOT_REACHED();
01887     }
01888   }
01889 
01890 public:
01891   VehicleViewWindow(const WindowDesc *desc, WindowNumber window_number) : Window()
01892   {
01893     this->CreateNestedTree(desc);
01894 
01895     /* Sprites for the 'send to depot' button indexed by vehicle type. */
01896     static const SpriteID vehicle_view_goto_depot_sprites[] = {
01897       SPR_SEND_TRAIN_TODEPOT,
01898       SPR_SEND_ROADVEH_TODEPOT,
01899       SPR_SEND_SHIP_TODEPOT,
01900       SPR_SEND_AIRCRAFT_TODEPOT,
01901     };
01902     const Vehicle *v = Vehicle::Get(window_number);
01903     this->GetWidget<NWidgetCore>(VVW_WIDGET_GOTO_DEPOT)->widget_data = vehicle_view_goto_depot_sprites[v->type];
01904 
01905     /* Sprites for the 'clone vehicle' button indexed by vehicle type. */
01906     static const SpriteID vehicle_view_clone_sprites[] = {
01907       SPR_CLONE_TRAIN,
01908       SPR_CLONE_ROADVEH,
01909       SPR_CLONE_SHIP,
01910       SPR_CLONE_AIRCRAFT,
01911     };
01912     this->GetWidget<NWidgetCore>(VVW_WIDGET_CLONE_VEH)->widget_data = vehicle_view_clone_sprites[v->type];
01913 
01914     switch (v->type) {
01915       case VEH_TRAIN:
01916         this->GetWidget<NWidgetCore>(VVW_WIDGET_TURN_AROUND)->tool_tip = STR_VEHICLE_VIEW_TRAIN_REVERSE_TOOLTIP;
01917         break;
01918 
01919       case VEH_ROAD:
01920         break;
01921 
01922       case VEH_SHIP:
01923       case VEH_AIRCRAFT:
01924         this->SelectPlane(SEL_RT_REFIT);
01925         break;
01926 
01927       default: NOT_REACHED();
01928     }
01929     this->FinishInitNested(desc, window_number);
01930     this->owner = v->owner;
01931     this->GetWidget<NWidgetViewport>(VVW_WIDGET_VIEWPORT)->InitializeViewport(this, this->window_number | (1 << 31), _vehicle_view_zoom_levels[v->type]);
01932 
01933     this->GetWidget<NWidgetCore>(VVW_WIDGET_START_STOP_VEH)->tool_tip   = STR_VEHICLE_VIEW_TRAIN_STATE_START_STOP_TOOLTIP + v->type;
01934     this->GetWidget<NWidgetCore>(VVW_WIDGET_CENTER_MAIN_VIEH)->tool_tip = STR_VEHICLE_VIEW_TRAIN_LOCATION_TOOLTIP + v->type;
01935     this->GetWidget<NWidgetCore>(VVW_WIDGET_REFIT_VEH)->tool_tip        = STR_VEHICLE_VIEW_TRAIN_REFIT_TOOLTIP + v->type;
01936     this->GetWidget<NWidgetCore>(VVW_WIDGET_GOTO_DEPOT)->tool_tip       = STR_VEHICLE_VIEW_TRAIN_SEND_TO_DEPOT_TOOLTIP + v->type;
01937     this->GetWidget<NWidgetCore>(VVW_WIDGET_SHOW_ORDERS)->tool_tip      = STR_VEHICLE_VIEW_TRAIN_ORDERS_TOOLTIP + v->type;
01938     this->GetWidget<NWidgetCore>(VVW_WIDGET_SHOW_DETAILS)->tool_tip     = STR_VEHICLE_VIEW_TRAIN_SHOW_DETAILS_TOOLTIP + v->type;
01939     this->GetWidget<NWidgetCore>(VVW_WIDGET_CLONE_VEH)->tool_tip        = STR_VEHICLE_VIEW_CLONE_TRAIN_INFO + v->type;
01940   }
01941 
01942   ~VehicleViewWindow()
01943   {
01944     DeleteWindowById(WC_VEHICLE_ORDERS, this->window_number, false);
01945     DeleteWindowById(WC_VEHICLE_REFIT, this->window_number, false);
01946     DeleteWindowById(WC_VEHICLE_DETAILS, this->window_number, false);
01947     DeleteWindowById(WC_VEHICLE_TIMETABLE, this->window_number, false);
01948   }
01949 
01950   virtual void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize)
01951   {
01952     const Vehicle *v = Vehicle::Get(this->window_number);
01953     switch (widget) {
01954       case VVW_WIDGET_FORCE_PROCEED:
01955         if (v->type != VEH_TRAIN) {
01956           size->height = 0;
01957           size->width = 0;
01958         } break;
01959 
01960       case VVW_WIDGET_VIEWPORT:
01961         size->width = VV_INITIAL_VIEWPORT_WIDTH;
01962         size->height = (v->type == VEH_TRAIN) ? VV_INITIAL_VIEWPORT_HEIGHT_TRAIN : VV_INITIAL_VIEWPORT_HEIGHT;
01963         break;
01964     }
01965   }
01966 
01967   virtual void OnPaint()
01968   {
01969     const Vehicle *v = Vehicle::Get(this->window_number);
01970     bool is_localcompany = v->owner == _local_company;
01971     bool refitable_and_stopped_in_depot = IsVehicleRefitable(v);
01972 
01973     this->SetWidgetDisabledState(VVW_WIDGET_GOTO_DEPOT, !is_localcompany);
01974     this->SetWidgetDisabledState(VVW_WIDGET_REFIT_VEH, !refitable_and_stopped_in_depot || !is_localcompany);
01975     this->SetWidgetDisabledState(VVW_WIDGET_CLONE_VEH, !is_localcompany);
01976 
01977     if (v->type == VEH_TRAIN) {
01978       this->SetWidgetLoweredState(VVW_WIDGET_FORCE_PROCEED, Train::From(v)->force_proceed == 2);
01979       this->SetWidgetDisabledState(VVW_WIDGET_FORCE_PROCEED, !is_localcompany);
01980       this->SetWidgetDisabledState(VVW_WIDGET_TURN_AROUND, !is_localcompany);
01981     }
01982 
01983     this->DrawWidgets();
01984   }
01985 
01986   virtual void SetStringParameters(int widget) const
01987   {
01988     if (widget != VVW_WIDGET_CAPTION) return;
01989 
01990     const Vehicle *v = Vehicle::Get(this->window_number);
01991     SetDParam(0, v->index);
01992   }
01993 
01994   virtual void DrawWidget(const Rect &r, int widget) const
01995   {
01996     if (widget != VVW_WIDGET_START_STOP_VEH) return;
01997 
01998     const Vehicle *v = Vehicle::Get(this->window_number);
01999     StringID str;
02000     if (v->vehstatus & VS_CRASHED) {
02001       str = STR_VEHICLE_STATUS_CRASHED;
02002     } else if (v->type != VEH_AIRCRAFT && v->breakdown_ctr == 1) { // check for aircraft necessary?
02003       str = STR_VEHICLE_STATUS_BROKEN_DOWN;
02004     } else if (v->vehstatus & VS_STOPPED) {
02005       if (v->type == VEH_TRAIN) {
02006         if (v->cur_speed == 0) {
02007           if (Train::From(v)->tcache.cached_power == 0) {
02008             str = STR_VEHICLE_STATUS_TRAIN_NO_POWER;
02009           } else {
02010             str = STR_VEHICLE_STATUS_STOPPED;
02011           }
02012         } else {
02013           SetDParam(0, v->GetDisplaySpeed());
02014           str = STR_VEHICLE_STATUS_TRAIN_STOPPING + _settings_client.gui.vehicle_speed;
02015         }
02016       } else { // no train
02017         str = STR_VEHICLE_STATUS_STOPPED;
02018       }
02019     } else if (v->type == VEH_TRAIN && HasBit(Train::From(v)->flags, VRF_TRAIN_STUCK) && !v->current_order.IsType(OT_LOADING)) {
02020       str = STR_VEHICLE_STATUS_TRAIN_STUCK;
02021     } else { // vehicle is in a "normal" state, show current order
02022       switch (v->current_order.GetType()) {
02023         case OT_GOTO_STATION: {
02024           SetDParam(0, v->current_order.GetDestination());
02025           SetDParam(1, v->GetDisplaySpeed());
02026           str = STR_VEHICLE_STATUS_HEADING_FOR_STATION + _settings_client.gui.vehicle_speed;
02027         } break;
02028 
02029         case OT_GOTO_DEPOT: {
02030           if (v->type == VEH_AIRCRAFT) {
02031             /* Aircrafts always go to a station, even if you say depot */
02032             SetDParam(0, v->current_order.GetDestination());
02033             SetDParam(1, v->GetDisplaySpeed());
02034           } else {
02035             Depot *depot = Depot::Get(v->current_order.GetDestination());
02036             SetDParam(0, depot->town_index);
02037             SetDParam(1, v->GetDisplaySpeed());
02038           }
02039           if (v->current_order.GetDepotActionType() & ODATFB_HALT) {
02040             str = STR_VEHICLE_STATUS_HEADING_FOR_TRAIN_DEPOT + 2 * v->type + _settings_client.gui.vehicle_speed;
02041           } else {
02042             str = STR_VEHICLE_STATUS_HEADING_FOR_TRAIN_DEPOT_SERVICE + 2 * v->type + _settings_client.gui.vehicle_speed;
02043           }
02044         } break;
02045 
02046         case OT_LOADING:
02047           str = STR_VEHICLE_STATUS_LOADING_UNLOADING;
02048           break;
02049 
02050         case OT_GOTO_WAYPOINT: {
02051           assert(v->type == VEH_TRAIN || v->type == VEH_SHIP);
02052           SetDParam(0, v->current_order.GetDestination());
02053           str = STR_VEHICLE_STATUS_HEADING_FOR_WAYPOINT + _settings_client.gui.vehicle_speed;
02054           SetDParam(1, v->GetDisplaySpeed());
02055           break;
02056         }
02057 
02058         case OT_LEAVESTATION:
02059           if (v->type != VEH_AIRCRAFT) {
02060             str = STR_VEHICLE_STATUS_LEAVING;
02061             break;
02062           }
02063           /* fall-through if aircraft. Does this even happen? */
02064 
02065         default:
02066           if (v->GetNumOrders() == 0) {
02067             str = STR_VEHICLE_STATUS_NO_ORDERS + _settings_client.gui.vehicle_speed;
02068             SetDParam(0, v->GetDisplaySpeed());
02069           } else {
02070             str = STR_EMPTY;
02071           }
02072           break;
02073       }
02074     }
02075 
02076     /* draw the flag plus orders */
02077     DrawSprite(v->vehstatus & VS_STOPPED ? SPR_FLAG_VEH_STOPPED : SPR_FLAG_VEH_RUNNING, PAL_NONE, WD_FRAMERECT_LEFT, r.top + WD_FRAMERECT_TOP);
02078     DrawString(r.left + WD_FRAMERECT_LEFT + 6, r.right - WD_FRAMERECT_RIGHT, r.top + WD_FRAMERECT_TOP, str, TC_FROMSTRING, SA_CENTER);
02079   }
02080 
02081   virtual void OnClick(Point pt, int widget, int click_count)
02082   {
02083     const Vehicle *v = Vehicle::Get(this->window_number);
02084 
02085     switch (widget) {
02086       case VVW_WIDGET_START_STOP_VEH: // start stop
02087         if (_ctrl_pressed) {
02088           /* Scroll to current order destination */
02089           TileIndex tile = v->current_order.GetLocation(v);
02090           if (tile != INVALID_TILE) ScrollMainWindowToTile(tile);
02091         } else {
02092           /* Start/Stop */
02093           DoCommandP(v->tile, v->index, 0,
02094             _vehicle_command_translation_table[VCT_CMD_START_STOP][v->type]);
02095         }
02096         break;
02097       case VVW_WIDGET_CENTER_MAIN_VIEH: {// center main view
02098         const Window *mainwindow = FindWindowById(WC_MAIN_WINDOW, 0);
02099         /* code to allow the main window to 'follow' the vehicle if the ctrl key is pressed */
02100         if (_ctrl_pressed && mainwindow->viewport->zoom == ZOOM_LVL_NORMAL) {
02101           mainwindow->viewport->follow_vehicle = v->index;
02102         } else {
02103           ScrollMainWindowTo(v->x_pos, v->y_pos, v->z_pos);
02104         }
02105       } break;
02106 
02107       case VVW_WIDGET_GOTO_DEPOT: // goto hangar
02108         DoCommandP(v->tile, v->index, _ctrl_pressed ? DEPOT_SERVICE : 0, GetCmdSendToDepot(v));
02109         break;
02110       case VVW_WIDGET_REFIT_VEH: // refit
02111         ShowVehicleRefitWindow(v, INVALID_VEH_ORDER_ID, this);
02112         break;
02113       case VVW_WIDGET_SHOW_ORDERS: // show orders
02114         if (_ctrl_pressed) {
02115           ShowTimetableWindow(v);
02116         } else {
02117           ShowOrdersWindow(v);
02118         }
02119         break;
02120       case VVW_WIDGET_SHOW_DETAILS: // show details
02121         ShowVehicleDetailsWindow(v);
02122         break;
02123       case VVW_WIDGET_CLONE_VEH: // clone vehicle
02124         DoCommandP(v->tile, v->index, _ctrl_pressed ? 1 : 0,
02125                     _vehicle_command_translation_table[VCT_CMD_CLONE_VEH][v->type],
02126                     CcCloneVehicle);
02127         break;
02128       case VVW_WIDGET_TURN_AROUND: // turn around
02129         assert(v->type == VEH_TRAIN || v->type == VEH_ROAD);
02130         DoCommandP(v->tile, v->index, 0,
02131                     _vehicle_command_translation_table[VCT_CMD_TURN_AROUND][v->type]);
02132         break;
02133       case VVW_WIDGET_FORCE_PROCEED: // force proceed
02134         assert(v->type == VEH_TRAIN);
02135         DoCommandP(v->tile, v->index, 0, CMD_FORCE_TRAIN_PROCEED | CMD_MSG(STR_ERROR_CAN_T_MAKE_TRAIN_PASS_SIGNAL));
02136         break;
02137     }
02138   }
02139 
02140   virtual void OnResize()
02141   {
02142     if (this->viewport != NULL) {
02143       NWidgetViewport *nvp = this->GetWidget<NWidgetViewport>(VVW_WIDGET_VIEWPORT);
02144       nvp->UpdateViewportCoordinates(this);
02145     }
02146   }
02147 
02148   virtual void OnTick()
02149   {
02150     const Vehicle *v = Vehicle::Get(this->window_number);
02151     bool veh_stopped = v->IsStoppedInDepot();
02152 
02153     /* Widget VVW_WIDGET_GOTO_DEPOT must be hidden if the vehicle is already stopped in depot.
02154      * Widget VVW_WIDGET_CLONE_VEH should then be shown, since cloning is allowed only while in depot and stopped.
02155      */
02156     PlaneSelections plane = veh_stopped ? SEL_DC_CLONE : SEL_DC_GOTO_DEPOT;
02157     NWidgetStacked *nwi = this->GetWidget<NWidgetStacked>(VVW_WIDGET_SELECT_DEPOT_CLONE); // Selection widget 'send to depot' / 'clone'.
02158     if (nwi->shown_plane + SEL_DC_BASEPLANE != plane) {
02159       this->SelectPlane(plane);
02160       this->SetWidgetDirty(VVW_WIDGET_SELECT_DEPOT_CLONE);
02161     }
02162     /* The same system applies to widget VVW_WIDGET_REFIT_VEH and VVW_WIDGET_TURN_AROUND.*/
02163     if (v->type == VEH_ROAD || v->type == VEH_TRAIN) {
02164       PlaneSelections plane = veh_stopped ? SEL_RT_REFIT : SEL_RT_TURN_AROUND;
02165       NWidgetStacked *nwi = this->GetWidget<NWidgetStacked>(VVW_WIDGET_SELECT_REFIT_TURN);
02166       if (nwi->shown_plane + SEL_RT_BASEPLANE != plane) {
02167         this->SelectPlane(plane);
02168         this->SetWidgetDirty(VVW_WIDGET_SELECT_REFIT_TURN);
02169       }
02170     }
02171   }
02172 };
02173 
02174 
02176 void ShowVehicleViewWindow(const Vehicle *v)
02177 {
02178   AllocateWindowDescFront<VehicleViewWindow>((v->type == VEH_TRAIN) ? &_train_view_desc : &_vehicle_view_desc, v->index);
02179 }
02180 
02181 void StopGlobalFollowVehicle(const Vehicle *v)
02182 {
02183   Window *w = FindWindowById(WC_MAIN_WINDOW, 0);
02184   if (w != NULL && w->viewport->follow_vehicle == v->index) {
02185     ScrollMainWindowTo(v->x_pos, v->y_pos, v->z_pos, true); // lock the main view on the vehicle's last position
02186     w->viewport->follow_vehicle = INVALID_VEHICLE;
02187   }
02188 }
02189 
02190 
02198 void CcBuildPrimaryVehicle(const CommandCost &result, TileIndex tile, uint32 p1, uint32 p2)
02199 {
02200   if (result.Failed()) return;
02201 
02202   const Vehicle *v = Vehicle::Get(_new_vehicle_id);
02203   if (v->tile == _backup_orders_tile) {
02204     _backup_orders_tile = 0;
02205     RestoreVehicleOrders(v);
02206   }
02207   ShowVehicleViewWindow(v);
02208 }

Generated on Tue Sep 14 17:06:57 2010 for OpenTTD by  doxygen 1.6.1