vehicle_gui.cpp

Go to the documentation of this file.
00001 /* $Id: vehicle_gui.cpp 18868 2010-01-20 17:59:31Z frosch $ */
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   SpriteID 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 OnDoubleClick(Point pt, int widget)
00442   {
00443     if (widget == VRW_MATRIX) this->OnClick(pt, VRW_REFITBUTTON);
00444   }
00445 
00446   virtual void OnClick(Point pt, int widget)
00447   {
00448     switch (widget) {
00449       case VRW_MATRIX: { // listbox
00450         int y = pt.y - this->GetWidget<NWidgetBase>(VRW_MATRIX)->pos_y;
00451         if (y >= 0) {
00452           this->sel = (y / (int)this->resize.step_height) + this->vscroll.GetPosition();
00453           this->SetDirty();
00454         }
00455         break;
00456       }
00457 
00458       case VRW_REFITBUTTON: // refit button
00459         if (this->cargo != NULL) {
00460           const Vehicle *v = Vehicle::Get(this->window_number);
00461 
00462           if (this->order == INVALID_VEH_ORDER_ID) {
00463             if (DoCommandP(v->tile, v->index, this->cargo->cargo | this->cargo->subtype << 8, GetCmdRefitVeh(v))) delete this;
00464           } else {
00465             if (DoCommandP(v->tile, v->index, this->cargo->cargo | this->cargo->subtype << 8 | this->order << 16, CMD_ORDER_REFIT)) delete this;
00466           }
00467         }
00468         break;
00469     }
00470   }
00471 
00472   virtual void OnResize()
00473   {
00474     this->vscroll.SetCapacityFromWidget(this, VRW_MATRIX);
00475     this->GetWidget<NWidgetCore>(VRW_MATRIX)->widget_data = (this->vscroll.GetCapacity() << MAT_ROW_START) + (1 << MAT_COL_START);
00476   }
00477 };
00478 
00479 static const NWidgetPart _nested_vehicle_refit_widgets[] = {
00480   NWidget(NWID_HORIZONTAL),
00481     NWidget(WWT_CLOSEBOX, COLOUR_GREY),
00482     NWidget(WWT_CAPTION, COLOUR_GREY, VRW_CAPTION), SetDataTip(STR_REFIT_CAPTION, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
00483   EndContainer(),
00484   NWidget(WWT_TEXTBTN, COLOUR_GREY, VRW_SELECTHEADER), SetDataTip(STR_REFIT_TITLE, STR_NULL), SetResize(1, 0),
00485   /* Matrix + scrollbar. */
00486   NWidget(NWID_HORIZONTAL),
00487     NWidget(WWT_MATRIX, COLOUR_GREY, VRW_MATRIX), SetMinimalSize(228, 112), SetResize(1, 14), SetFill(1, 1), SetDataTip(0x801, STR_NULL),
00488     NWidget(WWT_SCROLLBAR, COLOUR_GREY, VRW_SCROLLBAR),
00489   EndContainer(),
00490   NWidget(WWT_PANEL, COLOUR_GREY, VRW_INFOPANEL), SetMinimalTextLines(2, WD_FRAMERECT_TOP + WD_FRAMERECT_BOTTOM), SetResize(1, 0), EndContainer(),
00491   NWidget(NWID_HORIZONTAL),
00492     NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, VRW_REFITBUTTON), SetFill(1, 0), SetResize(1, 0),
00493     NWidget(WWT_RESIZEBOX, COLOUR_GREY),
00494   EndContainer(),
00495 };
00496 
00497 static const WindowDesc _vehicle_refit_desc(
00498   WDP_AUTO, 240, 174,
00499   WC_VEHICLE_REFIT, WC_VEHICLE_VIEW,
00500   WDF_UNCLICK_BUTTONS | WDF_CONSTRUCTION,
00501   _nested_vehicle_refit_widgets, lengthof(_nested_vehicle_refit_widgets)
00502 );
00503 
00509 void ShowVehicleRefitWindow(const Vehicle *v, VehicleOrderID order, Window *parent)
00510 {
00511   DeleteWindowById(WC_VEHICLE_REFIT, v->index);
00512   RefitWindow *w = new RefitWindow(&_vehicle_refit_desc, v, order);
00513   w->parent = parent;
00514 }
00515 
00517 uint ShowRefitOptionsList(int left, int right, int y, EngineID engine)
00518 {
00519   /* List of cargo types of this engine */
00520   uint32 cmask = GetUnionOfArticulatedRefitMasks(engine, false);
00521   /* List of cargo types available in this climate */
00522   uint32 lmask = _cargo_mask;
00523   char string[512];
00524   char *b = string;
00525 
00526   /* Draw nothing if the engine is not refittable */
00527   if (CountBits(cmask) <= 1) return y;
00528 
00529   b = InlineString(b, STR_PURCHASE_INFO_REFITTABLE_TO);
00530 
00531   if (cmask == lmask) {
00532     /* Engine can be refitted to all types in this climate */
00533     b = InlineString(b, STR_PURCHASE_INFO_ALL_TYPES);
00534   } else {
00535     /* Check if we are able to refit to more cargo types and unable to. If
00536      * so, invert the cargo types to list those that we can't refit to. */
00537     if (CountBits(cmask ^ lmask) < CountBits(cmask)) {
00538       cmask ^= lmask;
00539       b = InlineString(b, STR_PURCHASE_INFO_ALL_BUT);
00540     }
00541 
00542     bool first = true;
00543 
00544     /* Add each cargo type to the list */
00545     for (CargoID cid = 0; cid < NUM_CARGO; cid++) {
00546       if (!HasBit(cmask, cid)) continue;
00547 
00548       if (b >= lastof(string) - (2 + 2 * 4)) break; // ", " and two calls to Utf8Encode()
00549 
00550       if (!first) b = strecpy(b, ", ", lastof(string));
00551       first = false;
00552 
00553       b = InlineString(b, CargoSpec::Get(cid)->name);
00554     }
00555   }
00556 
00557   /* Terminate and display the completed string */
00558   *b = '\0';
00559 
00560   /* Make sure we detect any buffer overflow */
00561   assert(b < endof(string));
00562 
00563   SetDParamStr(0, string);
00564   return DrawStringMultiLine(left, right, y, INT32_MAX, STR_JUST_RAW_STRING);
00565 }
00566 
00568 StringID GetCargoSubtypeText(const Vehicle *v)
00569 {
00570   if (HasBit(EngInfo(v->engine_type)->callback_mask, CBM_VEHICLE_CARGO_SUFFIX)) {
00571     uint16 cb = GetVehicleCallback(CBID_VEHICLE_CARGO_SUFFIX, 0, 0, v->engine_type, v);
00572     if (cb != CALLBACK_FAILED) {
00573       return GetGRFStringID(GetEngineGRFID(v->engine_type), 0xD000 + cb);
00574     }
00575   }
00576   return STR_EMPTY;
00577 }
00578 
00580 static int CDECL VehicleNumberSorter(const Vehicle * const *a, const Vehicle * const *b)
00581 {
00582   return (*a)->unitnumber - (*b)->unitnumber;
00583 }
00584 
00586 static int CDECL VehicleNameSorter(const Vehicle * const *a, const Vehicle * const *b)
00587 {
00588   static char last_name[2][64];
00589 
00590   if (*a != _last_vehicle[0]) {
00591     _last_vehicle[0] = *a;
00592     SetDParam(0, (*a)->index);
00593     GetString(last_name[0], STR_VEHICLE_NAME, lastof(last_name[0]));
00594   }
00595 
00596   if (*b != _last_vehicle[1]) {
00597     _last_vehicle[1] = *b;
00598     SetDParam(0, (*b)->index);
00599     GetString(last_name[1], STR_VEHICLE_NAME, lastof(last_name[1]));
00600   }
00601 
00602   int r = strcmp(last_name[0], last_name[1]);
00603   return (r != 0) ? r : VehicleNumberSorter(a, b);
00604 }
00605 
00607 static int CDECL VehicleAgeSorter(const Vehicle * const *a, const Vehicle * const *b)
00608 {
00609   int r = (*a)->age - (*b)->age;
00610   return (r != 0) ? r : VehicleNumberSorter(a, b);
00611 }
00612 
00614 static int CDECL VehicleProfitThisYearSorter(const Vehicle * const *a, const Vehicle * const *b)
00615 {
00616   int r = ClampToI32((*a)->GetDisplayProfitThisYear() - (*b)->GetDisplayProfitThisYear());
00617   return (r != 0) ? r : VehicleNumberSorter(a, b);
00618 }
00619 
00621 static int CDECL VehicleProfitLastYearSorter(const Vehicle * const *a, const Vehicle * const *b)
00622 {
00623   int r = ClampToI32((*a)->GetDisplayProfitLastYear() - (*b)->GetDisplayProfitLastYear());
00624   return (r != 0) ? r : VehicleNumberSorter(a, b);
00625 }
00626 
00628 static int CDECL VehicleCargoSorter(const Vehicle * const *a, const Vehicle * const *b)
00629 {
00630   const Vehicle *v;
00631   CargoArray diff;
00632 
00633   /* Append the cargo of the connected weagons */
00634   for (v = *a; v != NULL; v = v->Next()) diff[v->cargo_type] += v->cargo_cap;
00635   for (v = *b; v != NULL; v = v->Next()) diff[v->cargo_type] -= v->cargo_cap;
00636 
00637   int r = 0;
00638   for (CargoID i = 0; i < NUM_CARGO; i++) {
00639     r = diff[i];
00640     if (r != 0) break;
00641   }
00642 
00643   return (r != 0) ? r : VehicleNumberSorter(a, b);
00644 }
00645 
00647 static int CDECL VehicleReliabilitySorter(const Vehicle * const *a, const Vehicle * const *b)
00648 {
00649   int r = (*a)->reliability - (*b)->reliability;
00650   return (r != 0) ? r : VehicleNumberSorter(a, b);
00651 }
00652 
00654 static int CDECL VehicleMaxSpeedSorter(const Vehicle * const *a, const Vehicle * const *b)
00655 {
00656   int r = 0;
00657   if ((*a)->type == VEH_TRAIN && (*b)->type == VEH_TRAIN) {
00658     r = Train::From(*a)->tcache.cached_max_speed - Train::From(*b)->tcache.cached_max_speed;
00659   } else {
00660     r = (*a)->max_speed - (*b)->max_speed;
00661   }
00662   return (r != 0) ? r : VehicleNumberSorter(a, b);
00663 }
00664 
00666 static int CDECL VehicleModelSorter(const Vehicle * const *a, const Vehicle * const *b)
00667 {
00668   int r = (*a)->engine_type - (*b)->engine_type;
00669   return (r != 0) ? r : VehicleNumberSorter(a, b);
00670 }
00671 
00673 static int CDECL VehicleValueSorter(const Vehicle * const *a, const Vehicle * const *b)
00674 {
00675   const Vehicle *u;
00676   Money diff = 0;
00677 
00678   for (u = *a; u != NULL; u = u->Next()) diff += u->value;
00679   for (u = *b; u != NULL; u = u->Next()) diff -= u->value;
00680 
00681   int r = ClampToI32(diff);
00682   return (r != 0) ? r : VehicleNumberSorter(a, b);
00683 }
00684 
00686 static int CDECL VehicleLengthSorter(const Vehicle * const *a, const Vehicle * const *b)
00687 {
00688   int r = 0;
00689   switch ((*a)->type) {
00690     case VEH_TRAIN:
00691       r = Train::From(*a)->tcache.cached_total_length - Train::From(*b)->tcache.cached_total_length;
00692       break;
00693 
00694     case VEH_ROAD: {
00695       const RoadVehicle *u;
00696       for (u = RoadVehicle::From(*a); u != NULL; u = u->Next()) r += u->rcache.cached_veh_length;
00697       for (u = RoadVehicle::From(*b); u != NULL; u = u->Next()) r -= u->rcache.cached_veh_length;
00698     } break;
00699 
00700     default: NOT_REACHED();
00701   }
00702   return (r != 0) ? r : VehicleNumberSorter(a, b);
00703 }
00704 
00706 static int CDECL VehicleTimeToLiveSorter(const Vehicle * const *a, const Vehicle * const *b)
00707 {
00708   int r = ClampToI32(((*a)->max_age - (*a)->age) - ((*b)->max_age - (*b)->age));
00709   return (r != 0) ? r : VehicleNumberSorter(a, b);
00710 }
00711 
00713 static int CDECL VehicleTimetableDelaySorter(const Vehicle * const *a, const Vehicle * const *b)
00714 {
00715   int r = (*a)->lateness_counter - (*b)->lateness_counter;
00716   return (r != 0) ? r : VehicleNumberSorter(a, b);
00717 }
00718 
00719 void InitializeGUI()
00720 {
00721   MemSetT(&_sorting, 0);
00722 }
00723 
00730 static inline void ChangeVehicleWindow(WindowClass window_class, VehicleID from_index, VehicleID to_index)
00731 {
00732   Window *w = FindWindowById(window_class, from_index);
00733   if (w != NULL) {
00734     w->window_number = to_index;
00735     if (w->viewport != NULL) w->viewport->follow_vehicle = to_index;
00736     if (to_index != INVALID_VEHICLE) w->InvalidateData();
00737   }
00738 }
00739 
00745 void ChangeVehicleViewWindow(VehicleID from_index, VehicleID to_index)
00746 {
00747   ChangeVehicleWindow(WC_VEHICLE_VIEW,      from_index, to_index);
00748   ChangeVehicleWindow(WC_VEHICLE_ORDERS,    from_index, to_index);
00749   ChangeVehicleWindow(WC_VEHICLE_REFIT,     from_index, to_index);
00750   ChangeVehicleWindow(WC_VEHICLE_DETAILS,   from_index, to_index);
00751   ChangeVehicleWindow(WC_VEHICLE_TIMETABLE, from_index, to_index);
00752 }
00753 
00754 enum VehicleListWindowWidgets {
00755   VLW_WIDGET_CAPTION,
00756   VLW_WIDGET_SORT_ORDER,
00757   VLW_WIDGET_SORT_BY_PULLDOWN,
00758   VLW_WIDGET_LIST,
00759   VLW_WIDGET_SCROLLBAR,
00760   VLW_WIDGET_HIDE_BUTTONS,
00761   VLW_WIDGET_AVAILABLE_VEHICLES,
00762   VLW_WIDGET_MANAGE_VEHICLES_DROPDOWN,
00763   VLW_WIDGET_STOP_ALL,
00764   VLW_WIDGET_START_ALL,
00765 };
00766 
00767 static const NWidgetPart _nested_vehicle_list[] = {
00768   NWidget(NWID_HORIZONTAL),
00769     NWidget(WWT_CLOSEBOX, COLOUR_GREY),
00770     NWidget(WWT_CAPTION, COLOUR_GREY, VLW_WIDGET_CAPTION),
00771     NWidget(WWT_SHADEBOX, COLOUR_GREY),
00772     NWidget(WWT_STICKYBOX, COLOUR_GREY),
00773   EndContainer(),
00774 
00775   NWidget(NWID_HORIZONTAL),
00776     NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, VLW_WIDGET_SORT_ORDER), SetMinimalSize(81, 12), SetFill(0, 1), SetDataTip(STR_BUTTON_SORT_BY, STR_TOOLTIP_SORT_ORDER),
00777     NWidget(WWT_DROPDOWN, COLOUR_GREY, VLW_WIDGET_SORT_BY_PULLDOWN), SetMinimalSize(167, 12), SetFill(0, 1), SetDataTip(0x0, STR_TOOLTIP_SORT_CRITERIAP),
00778     NWidget(WWT_PANEL, COLOUR_GREY), SetMinimalSize(12, 12), SetFill(1, 1), SetResize(1, 0),
00779     EndContainer(),
00780   EndContainer(),
00781 
00782   NWidget(NWID_HORIZONTAL),
00783     NWidget(WWT_MATRIX, COLOUR_GREY, VLW_WIDGET_LIST), SetMinimalSize(248, 0), SetFill(1, 0),
00784     NWidget(WWT_SCROLLBAR, COLOUR_GREY, VLW_WIDGET_SCROLLBAR),
00785   EndContainer(),
00786 
00787   NWidget(NWID_HORIZONTAL),
00788     NWidget(NWID_SELECTION, INVALID_COLOUR, VLW_WIDGET_HIDE_BUTTONS),
00789       NWidget(NWID_HORIZONTAL),
00790         NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, VLW_WIDGET_AVAILABLE_VEHICLES), SetMinimalSize(106, 12), SetFill(0, 1),
00791                 SetDataTip(0x0, STR_VEHICLE_LIST_AVAILABLE_ENGINES_TOOLTIP),
00792         NWidget(WWT_DROPDOWN, COLOUR_GREY, VLW_WIDGET_MANAGE_VEHICLES_DROPDOWN), SetMinimalSize(118, 12), SetFill(0, 1),
00793                 SetDataTip(STR_VEHICLE_LIST_MANAGE_LIST, STR_VEHICLE_LIST_MANAGE_LIST_TOOLTIP),
00794         NWidget(WWT_PUSHIMGBTN, COLOUR_GREY, VLW_WIDGET_STOP_ALL), SetMinimalSize(12, 12), SetFill(0, 1),
00795                 SetDataTip(SPR_FLAG_VEH_STOPPED, STR_VEHICLE_LIST_MASS_STOP_LIST_TOOLTIP),
00796         NWidget(WWT_PUSHIMGBTN, COLOUR_GREY, VLW_WIDGET_START_ALL), SetMinimalSize(12, 12), SetFill(0, 1),
00797                 SetDataTip(SPR_FLAG_VEH_RUNNING, STR_VEHICLE_LIST_MASS_START_LIST_TOOLTIP),
00798         NWidget(WWT_PANEL, COLOUR_GREY), SetMinimalSize(0, 12), SetResize(1, 0), SetFill(1, 1), EndContainer(),
00799       EndContainer(),
00800       /* Widget to be shown for other companies hiding the previous 5 widgets. */
00801       NWidget(WWT_PANEL, COLOUR_GREY), SetFill(1, 1), SetResize(1, 0), EndContainer(),
00802     EndContainer(),
00803     NWidget(WWT_RESIZEBOX, COLOUR_GREY),
00804   EndContainer(),
00805 };
00806 
00807 static void DrawSmallOrderList(const Vehicle *v, int left, int right, int y, VehicleOrderID start = 0)
00808 {
00809   const Order *order = v->GetOrder(start);
00810   if (order == NULL) return;
00811 
00812   int i = 0;
00813   VehicleOrderID oid = start;
00814 
00815   do {
00816     if (oid == v->cur_order_index) DrawString(left, right, y, STR_TINY_RIGHT_ARROW, TC_BLACK);
00817 
00818     if (order->IsType(OT_GOTO_STATION)) {
00819       SetDParam(0, order->GetDestination());
00820       DrawString(left + 6, right - 6, y, STR_TINY_BLACK_STATION);
00821 
00822       y += FONT_HEIGHT_SMALL;
00823       if (++i == 4) break;
00824     }
00825 
00826     oid++;
00827     order = order->next;
00828     if (order == NULL) {
00829       order = v->orders.list->GetFirstOrder();
00830       oid = 0;
00831     }
00832   } while (oid != start);
00833 }
00834 
00844 static void DrawVehicleImage(const Vehicle *v, int left, int right, int y, VehicleID selection, int skip)
00845 {
00846   switch (v->type) {
00847     case VEH_TRAIN:    DrawTrainImage(Train::From(v), left, right, y, selection, skip); break;
00848     case VEH_ROAD:     DrawRoadVehImage(v, left, right, y, selection);  break;
00849     case VEH_SHIP:     DrawShipImage(v, left, right, y, selection);     break;
00850     case VEH_AIRCRAFT: DrawAircraftImage(v, left, right, y, selection); break;
00851     default: NOT_REACHED();
00852   }
00853 }
00854 
00861 uint GetVehicleListHeight(VehicleType type, uint divisor)
00862 {
00863   /* Name + vehicle + profit */
00864   uint base = GetVehicleHeight(type) + 2 * FONT_HEIGHT_SMALL;
00865   /* Drawing of the 4 small orders + profit*/
00866   if (type >= VEH_SHIP) base = max(base, 5U * FONT_HEIGHT_SMALL);
00867 
00868   if (divisor == 1) return base;
00869 
00870   /* Make sure the height is dividable by divisor */
00871   uint rem = base % divisor;
00872   return base + (rem == 0 ? 0 : divisor - rem);
00873 }
00874 
00881 void BaseVehicleListWindow::DrawVehicleListItems(VehicleID selected_vehicle, int line_height, const Rect &r) const
00882 {
00883   int left = r.left + WD_MATRIX_LEFT;
00884   int right = r.right - WD_MATRIX_RIGHT;
00885   int width = right - left;
00886   bool rtl = _dynlang.text_dir == TD_RTL;
00887 
00888   int text_offset = GetDigitWidth() * this->unitnumber_digits + WD_FRAMERECT_RIGHT;
00889   int text_left  = left  + (rtl ?           0 : text_offset);
00890   int text_right = right - (rtl ? text_offset :           0);
00891 
00892   bool show_orderlist = vehicle_type >= VEH_SHIP;
00893   int orderlist_left  = left  + (rtl ? 0 : max(100 + text_offset, width / 2));
00894   int orderlist_right = right - (rtl ? max(100 + text_offset, width / 2) : 0);
00895 
00896   int image_left  = (rtl && show_orderlist) ? orderlist_right : text_left;
00897   int image_right = (!rtl && show_orderlist) ? orderlist_left : text_right;
00898 
00899   int vehicle_button_x = rtl ? right - 8 : left;
00900 
00901   int y = r.top;
00902   uint max = min(this->vscroll.GetPosition() + this->vscroll.GetCapacity(), this->vehicles.Length());
00903   for (uint i = this->vscroll.GetPosition(); i < max; ++i) {
00904     const Vehicle *v = this->vehicles[i];
00905     StringID str;
00906 
00907     SetDParam(0, v->GetDisplayProfitThisYear());
00908     SetDParam(1, v->GetDisplayProfitLastYear());
00909 
00910     DrawVehicleImage(v, image_left, image_right, y + FONT_HEIGHT_SMALL - 1, selected_vehicle, 0);
00911     DrawString(text_left, text_right, y + line_height - FONT_HEIGHT_SMALL - WD_FRAMERECT_BOTTOM - 1, STR_VEHICLE_LIST_PROFIT_THIS_YEAR_LAST_YEAR);
00912 
00913     if (v->name != NULL) {
00914       /* The vehicle got a name so we will print it */
00915       SetDParam(0, v->index);
00916       DrawString(text_left, text_right, y, STR_TINY_BLACK_VEHICLE);
00917     } else if (v->group_id != DEFAULT_GROUP) {
00918       /* The vehicle has no name, but is member of a group, so print group name */
00919       SetDParam(0, v->group_id);
00920       DrawString(text_left, text_right, y, STR_TINY_GROUP, TC_BLACK);
00921     }
00922 
00923     if (show_orderlist) DrawSmallOrderList(v, orderlist_left, orderlist_right, y, v->cur_order_index);
00924 
00925     if (v->IsInDepot()) {
00926       str = STR_BLUE_COMMA;
00927     } else {
00928       str = (v->age > v->max_age - DAYS_IN_LEAP_YEAR) ? STR_RED_COMMA : STR_BLACK_COMMA;
00929     }
00930 
00931     SetDParam(0, v->unitnumber);
00932     DrawString(left, right, y + 2, str);
00933 
00934     DrawVehicleProfitButton(v, vehicle_button_x, y + FONT_HEIGHT_NORMAL + 3);
00935 
00936     y += line_height;
00937   }
00938 }
00939 
00949 struct VehicleListWindow : public BaseVehicleListWindow {
00950 private:
00952   enum ButtonPlanes {
00953     BP_SHOW_BUTTONS, 
00954     BP_HIDE_BUTTONS, 
00955   };
00956 
00957 public:
00958   VehicleListWindow(const WindowDesc *desc, WindowNumber window_number) : BaseVehicleListWindow()
00959   {
00960     uint16 window_type = window_number & VLW_MASK;
00961     CompanyID company = (CompanyID)GB(window_number, 0, 8);
00962 
00963     this->vehicle_type = (VehicleType)GB(window_number, 11, 5);
00964 
00965     /* Set up sorting. Make the window-specific _sorting variable
00966      * point to the correct global _sorting struct so we are freed
00967      * from having conditionals during window operation */
00968     switch (this->vehicle_type) {
00969       case VEH_TRAIN:    this->sorting = &_sorting.train; break;
00970       case VEH_ROAD:     this->sorting = &_sorting.roadveh; break;
00971       case VEH_SHIP:     this->sorting = &_sorting.ship; break;
00972       case VEH_AIRCRAFT: this->sorting = &_sorting.aircraft; break;
00973       default: NOT_REACHED();
00974     }
00975 
00976     this->vehicles.SetListing(*this->sorting);
00977     this->vehicles.ForceRebuild();
00978     this->vehicles.NeedResort();
00979     this->BuildVehicleList(company, GB(window_number, 16, 16), window_type);
00980     this->SortVehicleList();
00981 
00982     this->CreateNestedTree(desc);
00983 
00984     /* Set up the window widgets */
00985     this->GetWidget<NWidgetCore>(VLW_WIDGET_LIST)->tool_tip                  = STR_VEHICLE_LIST_TRAIN_LIST_TOOLTIP + this->vehicle_type;
00986     this->GetWidget<NWidgetCore>(VLW_WIDGET_AVAILABLE_VEHICLES)->widget_data = STR_VEHICLE_LIST_AVAILABLE_TRAINS + this->vehicle_type;
00987 
00988     if (window_type == VLW_SHARED_ORDERS) {
00989       this->GetWidget<NWidgetCore>(VLW_WIDGET_CAPTION)->widget_data = STR_VEHICLE_LIST_SHARED_ORDERS_LIST_CAPTION;
00990     } else {
00991       this->GetWidget<NWidgetCore>(VLW_WIDGET_CAPTION)->widget_data = STR_VEHICLE_LIST_TRAIN_CAPTION + this->vehicle_type;
00992     }
00993 
00994     this->FinishInitNested(desc, window_number);
00995     this->owner = company;
00996 
00997     if (this->vehicle_type == VEH_TRAIN) ResizeWindow(this, 65, 0);
00998   }
00999 
01000   ~VehicleListWindow()
01001   {
01002     *this->sorting = this->vehicles.GetListing();
01003   }
01004 
01005   virtual void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize)
01006   {
01007     if (widget != VLW_WIDGET_LIST) return;
01008 
01009     resize->width = 0;
01010     resize->height = GetVehicleListHeight(this->vehicle_type, 1);
01011 
01012     switch (this->vehicle_type) {
01013       case VEH_TRAIN:
01014         resize->width = 1;
01015         /* Fallthrough */
01016       case VEH_ROAD:
01017         size->height = 6 * resize->height;
01018         break;
01019       case VEH_SHIP:
01020       case VEH_AIRCRAFT:
01021         size->height = 4 * resize->height;
01022         break;
01023       default: NOT_REACHED();
01024     }
01025   }
01026 
01027   virtual void SetStringParameters(int widget) const
01028   {
01029     if (widget != VLW_WIDGET_CAPTION) return;
01030 
01031     const uint16 index = GB(this->window_number, 16, 16);
01032     switch (this->window_number & VLW_MASK) {
01033       case VLW_SHARED_ORDERS: // Shared Orders
01034         if (this->vehicles.Length() == 0) {
01035           /* We can't open this window without vehicles using this order
01036            * and we should close the window when deleting the order      */
01037           NOT_REACHED();
01038         }
01039         SetDParam(0, this->vscroll.GetCount());
01040         break;
01041 
01042       case VLW_STANDARD: // Company Name
01043         SetDParam(0, STR_COMPANY_NAME);
01044         SetDParam(1, index);
01045         SetDParam(2, this->vscroll.GetCount());
01046         break;
01047 
01048       case VLW_WAYPOINT_LIST:
01049         SetDParam(0, STR_WAYPOINT_NAME);
01050         SetDParam(1, index);
01051         SetDParam(2, this->vscroll.GetCount());
01052         break;
01053 
01054       case VLW_STATION_LIST: // Station Name
01055         SetDParam(0, STR_STATION_NAME);
01056         SetDParam(1, index);
01057         SetDParam(2, this->vscroll.GetCount());
01058         break;
01059 
01060       case VLW_DEPOT_LIST:
01061         SetDParam(0, STR_DEPOT_TRAIN_CAPTION + this->vehicle_type);
01062         if (this->vehicle_type == VEH_AIRCRAFT) {
01063           SetDParam(1, index); // Airport name
01064         } else {
01065           SetDParam(1, Depot::Get(index)->town_index);
01066         }
01067         SetDParam(2, this->vscroll.GetCount());
01068         break;
01069       default: NOT_REACHED();
01070     }
01071   }
01072 
01073   virtual void DrawWidget(const Rect &r, int widget) const
01074   {
01075     switch (widget) {
01076       case VLW_WIDGET_SORT_ORDER:
01077         /* draw arrow pointing up/down for ascending/descending sorting */
01078         this->DrawSortButtonState(widget, this->vehicles.IsDescSortOrder() ? SBS_DOWN : SBS_UP);
01079         break;
01080 
01081       case VLW_WIDGET_LIST:
01082         this->DrawVehicleListItems(INVALID_VEHICLE, this->resize.step_height, r);
01083         break;
01084     }
01085   }
01086 
01087   virtual void OnPaint()
01088   {
01089     const uint16 window_type = this->window_number & VLW_MASK;
01090 
01091     this->BuildVehicleList(this->owner, GB(this->window_number, 16, 16), window_type);
01092     this->SortVehicleList();
01093 
01094     if (this->vehicles.Length() == 0) HideDropDownMenu(this);
01095 
01096     /* Hide the widgets that we will not use in this window
01097      * Some windows contains actions only fit for the owner */
01098     int plane_to_show = (this->owner == _local_company) ? BP_SHOW_BUTTONS : BP_HIDE_BUTTONS;
01099     NWidgetStacked *nwi = this->GetWidget<NWidgetStacked>(VLW_WIDGET_HIDE_BUTTONS);
01100     if (plane_to_show != nwi->shown_plane) {
01101       nwi->SetDisplayedPlane(plane_to_show);
01102       nwi->SetDirty(this);
01103     }
01104     if (this->owner == _local_company) {
01105       this->SetWidgetDisabledState(VLW_WIDGET_AVAILABLE_VEHICLES, window_type != VLW_STANDARD);
01106       this->SetWidgetsDisabledState(this->vehicles.Length() == 0,
01107         VLW_WIDGET_MANAGE_VEHICLES_DROPDOWN,
01108         VLW_WIDGET_STOP_ALL,
01109         VLW_WIDGET_START_ALL,
01110         WIDGET_LIST_END);
01111     }
01112 
01113     /* Set text of sort by dropdown widget. */
01114     this->GetWidget<NWidgetCore>(VLW_WIDGET_SORT_BY_PULLDOWN)->widget_data = this->vehicle_sorter_names[this->vehicles.SortType()];
01115 
01116     this->DrawWidgets();
01117   }
01118 
01119   virtual void OnClick(Point pt, int widget)
01120   {
01121     switch (widget) {
01122       case VLW_WIDGET_SORT_ORDER: // Flip sorting method ascending/descending
01123         this->vehicles.ToggleSortOrder();
01124         this->SetDirty();
01125         break;
01126 
01127       case VLW_WIDGET_SORT_BY_PULLDOWN:// Select sorting criteria dropdown menu
01128         ShowDropDownMenu(this, this->vehicle_sorter_names, this->vehicles.SortType(), VLW_WIDGET_SORT_BY_PULLDOWN, 0,
01129             (this->vehicle_type == VEH_TRAIN || this->vehicle_type == VEH_ROAD) ? 0 : (1 << 10));
01130         return;
01131 
01132       case VLW_WIDGET_LIST: { // Matrix to show vehicles
01133         uint32 id_v = (pt.y - this->GetWidget<NWidgetBase>(VLW_WIDGET_LIST)->pos_y) / this->resize.step_height;
01134         const Vehicle *v;
01135 
01136         if (id_v >= this->vscroll.GetCapacity()) return; // click out of bounds
01137 
01138         id_v += this->vscroll.GetPosition();
01139 
01140         if (id_v >= this->vehicles.Length()) return; // click out of list bound
01141 
01142         v = this->vehicles[id_v];
01143 
01144         ShowVehicleViewWindow(v);
01145       } break;
01146 
01147       case VLW_WIDGET_AVAILABLE_VEHICLES:
01148         ShowBuildVehicleWindow(INVALID_TILE, this->vehicle_type);
01149         break;
01150 
01151       case VLW_WIDGET_MANAGE_VEHICLES_DROPDOWN: {
01152         static StringID action_str[] = {
01153           STR_VEHICLE_LIST_REPLACE_VEHICLES,
01154           STR_VEHICLE_LIST_SEND_FOR_SERVICING,
01155           STR_NULL,
01156           INVALID_STRING_ID
01157         };
01158 
01159         static const StringID depot_name[] = {
01160           STR_VEHICLE_LIST_SEND_TRAIN_TO_DEPOT,
01161           STR_VEHICLE_LIST_SEND_ROAD_VEHICLE_TO_DEPOT,
01162           STR_VEHICLE_LIST_SEND_SHIP_TO_DEPOT,
01163           STR_VEHICLE_LIST_SEND_AIRCRAFT_TO_HANGAR
01164         };
01165 
01166         /* XXX - Substite string since the dropdown cannot handle dynamic strings */
01167         action_str[2] = depot_name[this->vehicle_type];
01168         ShowDropDownMenu(this, action_str, 0, VLW_WIDGET_MANAGE_VEHICLES_DROPDOWN, 0, (this->window_number & VLW_MASK) == VLW_STANDARD ? 0 : 1);
01169         break;
01170       }
01171 
01172       case VLW_WIDGET_STOP_ALL:
01173       case VLW_WIDGET_START_ALL:
01174         DoCommandP(0, GB(this->window_number, 16, 16),
01175             (this->window_number & VLW_MASK) | (1 << 6) | (widget == VLW_WIDGET_START_ALL ? (1 << 5) : 0) | this->vehicle_type, CMD_MASS_START_STOP);
01176         break;
01177     }
01178   }
01179 
01180   virtual void OnDropdownSelect(int widget, int index)
01181   {
01182     switch (widget) {
01183       case VLW_WIDGET_SORT_BY_PULLDOWN:
01184         this->vehicles.SetSortType(index);
01185         break;
01186       case VLW_WIDGET_MANAGE_VEHICLES_DROPDOWN:
01187         assert(this->vehicles.Length() != 0);
01188 
01189         switch (index) {
01190           case 0: // Replace window
01191             ShowReplaceGroupVehicleWindow(DEFAULT_GROUP, this->vehicle_type);
01192             break;
01193           case 1: // Send for servicing
01194             DoCommandP(0, GB(this->window_number, 16, 16) /* StationID or OrderID (depending on VLW) */,
01195               (this->window_number & VLW_MASK) | DEPOT_MASS_SEND | DEPOT_SERVICE, GetCmdSendToDepot(this->vehicle_type));
01196             break;
01197           case 2: // Send to Depots
01198             DoCommandP(0, GB(this->window_number, 16, 16) /* StationID or OrderID (depending on VLW) */,
01199               (this->window_number & VLW_MASK) | DEPOT_MASS_SEND, GetCmdSendToDepot(this->vehicle_type));
01200             break;
01201 
01202           default: NOT_REACHED();
01203         }
01204         break;
01205       default: NOT_REACHED();
01206     }
01207     this->SetDirty();
01208   }
01209 
01210   virtual void OnTick()
01211   {
01212     if (_pause_mode != PM_UNPAUSED) return;
01213     if (this->vehicles.NeedResort()) {
01214       StationID station = ((this->window_number & VLW_MASK) == VLW_STATION_LIST) ? GB(this->window_number, 16, 16) : INVALID_STATION;
01215 
01216       DEBUG(misc, 3, "Periodic resort %d list company %d at station %d", this->vehicle_type, this->owner, station);
01217       this->SetDirty();
01218     }
01219   }
01220 
01221   virtual void OnResize()
01222   {
01223     this->vscroll.SetCapacityFromWidget(this, VLW_WIDGET_LIST);
01224     this->GetWidget<NWidgetCore>(VLW_WIDGET_LIST)->widget_data = (this->vscroll.GetCapacity() << MAT_ROW_START) + (1 << MAT_COL_START);
01225   }
01226 
01227   virtual void OnInvalidateData(int data)
01228   {
01229     if (HasBit(data, 15) && (this->window_number & VLW_MASK) == VLW_SHARED_ORDERS) {
01230       SB(this->window_number, 16, 16, GB(data, 16, 16));
01231       this->vehicles.ForceRebuild();
01232       return;
01233     }
01234 
01235     if (data == 0) {
01236       this->vehicles.ForceRebuild();
01237     } else {
01238       this->vehicles.ForceResort();
01239     }
01240   }
01241 };
01242 
01243 static WindowDesc _vehicle_list_desc(
01244   WDP_AUTO, 260, 246,
01245   WC_INVALID, WC_NONE,
01246   WDF_UNCLICK_BUTTONS,
01247   _nested_vehicle_list, lengthof(_nested_vehicle_list)
01248 );
01249 
01250 static void ShowVehicleListWindowLocal(CompanyID company, uint16 VLW_flag, VehicleType vehicle_type, uint16 unique_number)
01251 {
01252   if (!Company::IsValidID(company)) return;
01253 
01254   _vehicle_list_desc.cls = GetWindowClassForVehicleType(vehicle_type);
01255   WindowNumber num = (unique_number << 16) | (vehicle_type << 11) | VLW_flag | company;
01256   AllocateWindowDescFront<VehicleListWindow>(&_vehicle_list_desc, num);
01257 }
01258 
01259 void ShowVehicleListWindow(CompanyID company, VehicleType vehicle_type)
01260 {
01261   /* If _settings_client.gui.advanced_vehicle_list > 1, display the Advanced list
01262    * if _settings_client.gui.advanced_vehicle_list == 1, display Advanced list only for local company
01263    * if _ctrl_pressed, do the opposite action (Advanced list x Normal list)
01264    */
01265 
01266   if ((_settings_client.gui.advanced_vehicle_list > (uint)(company != _local_company)) != _ctrl_pressed) {
01267     ShowCompanyGroup(company, vehicle_type);
01268   } else {
01269     ShowVehicleListWindowLocal(company, VLW_STANDARD, vehicle_type, company);
01270   }
01271 }
01272 
01273 void ShowVehicleListWindow(CompanyID company, VehicleType vehicle_type, const Waypoint *wp)
01274 {
01275   if (wp == NULL) return;
01276   ShowVehicleListWindowLocal(company, VLW_WAYPOINT_LIST, vehicle_type, wp->index);
01277 }
01278 
01279 void ShowVehicleListWindow(const Vehicle *v)
01280 {
01281   ShowVehicleListWindowLocal(v->owner, VLW_SHARED_ORDERS, v->type, v->FirstShared()->index);
01282 }
01283 
01284 void ShowVehicleListWindow(CompanyID company, VehicleType vehicle_type, StationID station)
01285 {
01286   ShowVehicleListWindowLocal(company, VLW_STATION_LIST, vehicle_type, station);
01287 }
01288 
01289 void ShowVehicleListWindow(CompanyID company, VehicleType vehicle_type, TileIndex depot_tile)
01290 {
01291   uint16 depot_airport_index;
01292 
01293   if (vehicle_type == VEH_AIRCRAFT) {
01294     depot_airport_index = GetStationIndex(depot_tile);
01295   } else {
01296     depot_airport_index = GetDepotIndex(depot_tile);
01297   }
01298   ShowVehicleListWindowLocal(company, VLW_DEPOT_LIST, vehicle_type, depot_airport_index);
01299 }
01300 
01301 
01302 /* Unified vehicle GUI - Vehicle Details Window */
01303 
01305 enum VehicleDetailsWindowWidgets {
01306   VLD_WIDGET_CAPTION,
01307   VLD_WIDGET_RENAME_VEHICLE,
01308   VLD_WIDGET_TOP_DETAILS,
01309   VLD_WIDGET_INCREASE_SERVICING_INTERVAL,
01310   VLD_WIDGET_DECREASE_SERVICING_INTERVAL,
01311   VLD_WIDGET_SERVICING_INTERVAL,
01312   VLD_WIDGET_MIDDLE_DETAILS,
01313   VLD_WIDGET_MATRIX,
01314   VLD_WIDGET_SCROLLBAR,
01315   VLD_WIDGET_DETAILS_CARGO_CARRIED,
01316   VLD_WIDGET_DETAILS_TRAIN_VEHICLES,
01317   VLD_WIDGET_DETAILS_CAPACITY_OF_EACH,
01318   VLD_WIDGET_DETAILS_TOTAL_CARGO,
01319 };
01320 
01321 assert_compile(VLD_WIDGET_DETAILS_CARGO_CARRIED    == VLD_WIDGET_DETAILS_CARGO_CARRIED + TDW_TAB_CARGO   );
01322 assert_compile(VLD_WIDGET_DETAILS_TRAIN_VEHICLES   == VLD_WIDGET_DETAILS_CARGO_CARRIED + TDW_TAB_INFO    );
01323 assert_compile(VLD_WIDGET_DETAILS_CAPACITY_OF_EACH == VLD_WIDGET_DETAILS_CARGO_CARRIED + TDW_TAB_CAPACITY);
01324 assert_compile(VLD_WIDGET_DETAILS_TOTAL_CARGO      == VLD_WIDGET_DETAILS_CARGO_CARRIED + TDW_TAB_TOTALS  );
01325 
01327 static const NWidgetPart _nested_nontrain_vehicle_details_widgets[] = {
01328   NWidget(NWID_HORIZONTAL),
01329     NWidget(WWT_CLOSEBOX, COLOUR_GREY),
01330     NWidget(WWT_CAPTION, COLOUR_GREY, VLD_WIDGET_CAPTION), SetDataTip(STR_VEHICLE_DETAILS_CAPTION, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
01331     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 */),
01332     NWidget(WWT_SHADEBOX, COLOUR_GREY),
01333     NWidget(WWT_STICKYBOX, COLOUR_GREY),
01334   EndContainer(),
01335   NWidget(WWT_PANEL, COLOUR_GREY, VLD_WIDGET_TOP_DETAILS), SetMinimalSize(405, 42), SetResize(1, 0), EndContainer(),
01336   NWidget(WWT_PANEL, COLOUR_GREY, VLD_WIDGET_MIDDLE_DETAILS), SetMinimalSize(405, 45), SetResize(1, 0), EndContainer(),
01337   NWidget(NWID_HORIZONTAL),
01338     NWidget(NWID_BUTTON_ARROW, COLOUR_GREY, VLD_WIDGET_DECREASE_SERVICING_INTERVAL), SetFill(0, 1),
01339         SetDataTip(AWV_DECREASE, STR_VEHICLE_DETAILS_DECREASE_SERVICING_INTERVAL_TOOLTIP),
01340     NWidget(NWID_BUTTON_ARROW, COLOUR_GREY, VLD_WIDGET_INCREASE_SERVICING_INTERVAL), SetFill(0, 1),
01341         SetDataTip(AWV_INCREASE, STR_VEHICLE_DETAILS_INCREASE_SERVICING_INTERVAL_TOOLTIP),
01342     NWidget(WWT_PANEL, COLOUR_GREY, VLD_WIDGET_SERVICING_INTERVAL), SetFill(1, 1), SetResize(1, 0), EndContainer(),
01343     NWidget(WWT_RESIZEBOX, COLOUR_GREY),
01344   EndContainer(),
01345 };
01346 
01348 static const NWidgetPart _nested_train_vehicle_details_widgets[] = {
01349   NWidget(NWID_HORIZONTAL),
01350     NWidget(WWT_CLOSEBOX, COLOUR_GREY),
01351     NWidget(WWT_CAPTION, COLOUR_GREY, VLD_WIDGET_CAPTION), SetDataTip(STR_VEHICLE_DETAILS_CAPTION, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
01352     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 */),
01353     NWidget(WWT_SHADEBOX, COLOUR_GREY),
01354     NWidget(WWT_STICKYBOX, COLOUR_GREY),
01355   EndContainer(),
01356   NWidget(WWT_PANEL, COLOUR_GREY, VLD_WIDGET_TOP_DETAILS), SetResize(1, 0), SetMinimalSize(405, 42), EndContainer(),
01357   NWidget(NWID_HORIZONTAL),
01358     NWidget(WWT_MATRIX, COLOUR_GREY, VLD_WIDGET_MATRIX), SetResize(1, 1), SetMinimalSize(393, 45), SetDataTip(0x701, STR_NULL), SetFill(1, 0),
01359     NWidget(WWT_SCROLLBAR, COLOUR_GREY, VLD_WIDGET_SCROLLBAR),
01360   EndContainer(),
01361   NWidget(NWID_HORIZONTAL),
01362     NWidget(NWID_BUTTON_ARROW, COLOUR_GREY, VLD_WIDGET_DECREASE_SERVICING_INTERVAL), SetFill(0, 1),
01363         SetDataTip(AWV_DECREASE, STR_VEHICLE_DETAILS_DECREASE_SERVICING_INTERVAL_TOOLTIP),
01364     NWidget(NWID_BUTTON_ARROW, COLOUR_GREY, VLD_WIDGET_INCREASE_SERVICING_INTERVAL), SetFill(0, 1),
01365         SetDataTip(AWV_INCREASE, STR_VEHICLE_DETAILS_DECREASE_SERVICING_INTERVAL_TOOLTIP),
01366     NWidget(WWT_PANEL, COLOUR_GREY, VLD_WIDGET_SERVICING_INTERVAL), SetFill(1, 1), SetResize(1, 0), EndContainer(),
01367   EndContainer(),
01368   NWidget(NWID_HORIZONTAL),
01369     NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, VLD_WIDGET_DETAILS_CARGO_CARRIED), SetMinimalSize(96, 12),
01370         SetDataTip(STR_VEHICLE_DETAIL_TAB_CARGO, STR_VEHICLE_DETAILS_TRAIN_CARGO_TOOLTIP), SetFill(1, 0), SetResize(1, 0),
01371     NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, VLD_WIDGET_DETAILS_TRAIN_VEHICLES), SetMinimalSize(99, 12),
01372         SetDataTip(STR_VEHICLE_DETAIL_TAB_INFORMATION, STR_VEHICLE_DETAILS_TRAIN_INFORMATION_TOOLTIP), SetFill(1, 0), SetResize(1, 0),
01373     NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, VLD_WIDGET_DETAILS_CAPACITY_OF_EACH), SetMinimalSize(99, 12),
01374         SetDataTip(STR_VEHICLE_DETAIL_TAB_CAPACITIES, STR_VEHICLE_DETAILS_TRAIN_CAPACITIES_TOOLTIP), SetFill(1, 0), SetResize(1, 0),
01375     NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, VLD_WIDGET_DETAILS_TOTAL_CARGO), SetMinimalSize(99, 12),
01376         SetDataTip(STR_VEHICLE_DETAIL_TAB_TOTAL_CARGO, STR_VEHICLE_DETAILS_TRAIN_TOTAL_CARGO_TOOLTIP), SetFill(1, 0), SetResize(1, 0),
01377     NWidget(WWT_RESIZEBOX, COLOUR_GREY),
01378   EndContainer(),
01379 };
01380 
01381 
01382 extern int GetTrainDetailsWndVScroll(VehicleID veh_id, TrainDetailsWindowTabs det_tab);
01383 extern void DrawTrainDetails(const Train *v, int left, int right, int y, int vscroll_pos, uint16 vscroll_cap, TrainDetailsWindowTabs det_tab);
01384 extern void DrawRoadVehDetails(const Vehicle *v, int left, int right, int y);
01385 extern void DrawShipDetails(const Vehicle *v, int left, int right, int y);
01386 extern void DrawAircraftDetails(const Aircraft *v, int left, int right, int y);
01387 
01389 struct VehicleDetailsWindow : Window {
01390   TrainDetailsWindowTabs tab; 
01391 
01393   VehicleDetailsWindow(const WindowDesc *desc, WindowNumber window_number) : Window()
01394   {
01395     this->InitNested(desc, window_number);
01396 
01397     const Vehicle *v = Vehicle::Get(this->window_number);
01398 
01399     this->GetWidget<NWidgetCore>(VLD_WIDGET_RENAME_VEHICLE)->tool_tip = STR_VEHICLE_DETAILS_TRAIN_RENAME + v->type;
01400 
01401     this->owner = v->owner;
01402     this->tab = TDW_TAB_CARGO;
01403   }
01404 
01405   virtual void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize)
01406   {
01407     switch (widget) {
01408       case VLD_WIDGET_TOP_DETAILS: {
01409         Dimension dim = { 0, 0 };
01410         size->height = WD_FRAMERECT_TOP + 4 * FONT_HEIGHT_NORMAL + WD_FRAMERECT_BOTTOM;
01411 
01412         for (uint i = 0; i < 4; i++) SetDParam(i, INT16_MAX);
01413         static const StringID info_strings[] = {
01414           STR_VEHICLE_INFO_MAX_SPEED,
01415           STR_VEHICLE_INFO_WEIGHT_POWER_MAX_SPEED,
01416           STR_VEHICLE_INFO_WEIGHT_POWER_MAX_SPEED_MAX_TE,
01417           STR_VEHICLE_INFO_PROFIT_THIS_YEAR_LAST_YEAR,
01418           STR_VEHICLE_INFO_RELIABILITY_BREAKDOWNS
01419         };
01420         for (uint i = 0; i < lengthof(info_strings); i++) {
01421           dim = maxdim(dim, GetStringBoundingBox(info_strings[i]));
01422         }
01423         SetDParam(0, STR_VEHICLE_INFO_AGE);
01424         dim = maxdim(dim, GetStringBoundingBox(STR_VEHICLE_INFO_AGE_RUNNING_COST_YR));
01425         size->width = dim.width + WD_FRAMERECT_LEFT + WD_FRAMERECT_RIGHT;
01426       } break;
01427 
01428       case VLD_WIDGET_MIDDLE_DETAILS: {
01429         const Vehicle *v = Vehicle::Get(this->window_number);
01430         switch (v->type) {
01431           case VEH_ROAD:
01432             if (RoadVehicle::From(v)->HasArticulatedPart()) {
01433               /* An articulated RV has its text drawn under the sprite instead of after it, hence 15 pixels extra. */
01434               size->height = WD_FRAMERECT_TOP + 15 + 3 * FONT_HEIGHT_NORMAL + 2 + WD_FRAMERECT_BOTTOM;
01435               /* Add space for the cargo amount for each part. */
01436               for (const Vehicle *u = v; u != NULL; u = u->Next()) {
01437                 if (u->cargo_cap != 0) size->height += FONT_HEIGHT_NORMAL + 1;
01438               }
01439             } else {
01440               size->height = WD_FRAMERECT_TOP + 4 * FONT_HEIGHT_NORMAL + 3 + WD_FRAMERECT_BOTTOM;
01441             }
01442             break;
01443 
01444           case VEH_SHIP:
01445             size->height = WD_FRAMERECT_TOP + 4 * FONT_HEIGHT_NORMAL + 3 + WD_FRAMERECT_BOTTOM;
01446             break;
01447 
01448           case VEH_AIRCRAFT:
01449             size->height = WD_FRAMERECT_TOP + 5 * FONT_HEIGHT_NORMAL + 4 + WD_FRAMERECT_BOTTOM;
01450             break;
01451 
01452           default:
01453             NOT_REACHED(); // Train uses VLD_WIDGET_MATRIX instead.
01454         }
01455         break;
01456       }
01457 
01458       case VLD_WIDGET_MATRIX:
01459         resize->height = WD_MATRIX_TOP + FONT_HEIGHT_NORMAL + WD_MATRIX_BOTTOM;
01460         size->height = 4 * resize->height;
01461         break;
01462 
01463       case VLD_WIDGET_SERVICING_INTERVAL:
01464         SetDParam(0, 9999); // Roughly the maximum interval
01465         SetDParam(1, MAX_YEAR * DAYS_IN_YEAR); // Roughly the maximum year
01466         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;
01467         size->height = WD_FRAMERECT_TOP + FONT_HEIGHT_NORMAL + WD_FRAMERECT_BOTTOM;
01468         break;
01469     }
01470   }
01471 
01473   static bool IsVehicleServiceIntervalEnabled(const VehicleType vehicle_type, CompanyID company_id)
01474   {
01475     const VehicleDefaultSettings *vds = &Company::Get(company_id)->settings.vehicle;
01476     switch (vehicle_type) {
01477       default: NOT_REACHED();
01478       case VEH_TRAIN:    return vds->servint_trains   != 0;
01479       case VEH_ROAD:     return vds->servint_roadveh  != 0;
01480       case VEH_SHIP:     return vds->servint_ships    != 0;
01481       case VEH_AIRCRAFT: return vds->servint_aircraft != 0;
01482     }
01483   }
01484 
01496   static void DrawVehicleDetails(const Vehicle *v, int left, int right, int y, int vscroll_pos, uint vscroll_cap, TrainDetailsWindowTabs det_tab)
01497   {
01498     switch (v->type) {
01499       case VEH_TRAIN:    DrawTrainDetails(Train::From(v), left, right, y, vscroll_pos, vscroll_cap, det_tab);  break;
01500       case VEH_ROAD:     DrawRoadVehDetails(v, left, right, y);  break;
01501       case VEH_SHIP:     DrawShipDetails(v, left, right, y);     break;
01502       case VEH_AIRCRAFT: DrawAircraftDetails(Aircraft::From(v), left, right, y); break;
01503       default: NOT_REACHED();
01504     }
01505   }
01506 
01507   virtual void SetStringParameters(int widget) const
01508   {
01509     if (widget == VLD_WIDGET_CAPTION) SetDParam(0, Vehicle::Get(this->window_number)->index);
01510   }
01511 
01512   virtual void DrawWidget(const Rect &r, int widget) const
01513   {
01514     const Vehicle *v = Vehicle::Get(this->window_number);
01515 
01516     switch (widget) {
01517       case VLD_WIDGET_TOP_DETAILS: {
01518         int y = r.top + WD_FRAMERECT_TOP;
01519 
01520         /* Draw running cost */
01521         SetDParam(1, v->age / DAYS_IN_LEAP_YEAR);
01522         SetDParam(0, (v->age + DAYS_IN_YEAR < v->max_age) ? STR_VEHICLE_INFO_AGE : STR_VEHICLE_INFO_AGE_RED);
01523         SetDParam(2, v->max_age / DAYS_IN_LEAP_YEAR);
01524         SetDParam(3, v->GetDisplayRunningCost());
01525         DrawString(r.left + WD_FRAMERECT_LEFT, r.right - WD_FRAMERECT_RIGHT, y, STR_VEHICLE_INFO_AGE_RUNNING_COST_YR);
01526         y += FONT_HEIGHT_NORMAL;
01527 
01528         /* Draw max speed */
01529         switch (v->type) {
01530           case VEH_TRAIN:
01531             SetDParam(2, v->GetDisplayMaxSpeed());
01532             SetDParam(1, Train::From(v)->tcache.cached_power);
01533             SetDParam(0, Train::From(v)->tcache.cached_weight);
01534             SetDParam(3, Train::From(v)->tcache.cached_max_te / 1000);
01535             DrawString(r.left + WD_FRAMERECT_LEFT, r.right - WD_FRAMERECT_RIGHT, y, (_settings_game.vehicle.train_acceleration_model != TAM_ORIGINAL && GetRailTypeInfo(Train::From(v)->railtype)->acceleration_type != 2) ?
01536                 STR_VEHICLE_INFO_WEIGHT_POWER_MAX_SPEED_MAX_TE : STR_VEHICLE_INFO_WEIGHT_POWER_MAX_SPEED);
01537             break;
01538 
01539           case VEH_ROAD:
01540           case VEH_SHIP:
01541           case VEH_AIRCRAFT:
01542             SetDParam(0, v->GetDisplayMaxSpeed());
01543             DrawString(r.left + WD_FRAMERECT_LEFT, r.right - WD_FRAMERECT_RIGHT, y, STR_VEHICLE_INFO_MAX_SPEED);
01544             break;
01545 
01546           default: NOT_REACHED();
01547         }
01548         y += FONT_HEIGHT_NORMAL;
01549 
01550         /* Draw profit */
01551         SetDParam(0, v->GetDisplayProfitThisYear());
01552         SetDParam(1, v->GetDisplayProfitLastYear());
01553         DrawString(r.left + WD_FRAMERECT_LEFT, r.right - WD_FRAMERECT_RIGHT, y, STR_VEHICLE_INFO_PROFIT_THIS_YEAR_LAST_YEAR);
01554         y += FONT_HEIGHT_NORMAL;
01555 
01556         /* Draw breakdown & reliability */
01557         SetDParam(0, ToPercent16(v->reliability));
01558         SetDParam(1, v->breakdowns_since_last_service);
01559         DrawString(r.left + WD_FRAMERECT_LEFT, r.right - WD_FRAMERECT_RIGHT, y, STR_VEHICLE_INFO_RELIABILITY_BREAKDOWNS);
01560         break;
01561       }
01562 
01563       case VLD_WIDGET_MATRIX:
01564         /* For trains only. */
01565         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);
01566         break;
01567 
01568       case VLD_WIDGET_MIDDLE_DETAILS: {
01569         /* For other vehicles, at the place of the matrix. */
01570         bool rtl = _dynlang.text_dir == TD_RTL;
01571         uint sprite_width = max<uint>(GetSprite(v->GetImage(rtl ? DIR_E : DIR_W), ST_NORMAL)->width, 70U) + WD_FRAMERECT_LEFT + WD_FRAMERECT_RIGHT;
01572 
01573         uint text_left  = r.left  + (rtl ? 0 : sprite_width);
01574         uint text_right = r.right - (rtl ? sprite_width : 0);
01575 
01576         uint sprite_left  = rtl ? text_right : r.left;
01577         uint sprite_right = rtl ? r.right : text_left;
01578 
01579         DrawVehicleImage(v, sprite_left + WD_FRAMERECT_LEFT, sprite_right - WD_FRAMERECT_RIGHT, r.top + WD_FRAMERECT_TOP, INVALID_VEHICLE, 0);
01580         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);
01581       } break;
01582 
01583       case VLD_WIDGET_SERVICING_INTERVAL:
01584         /* Draw service interval text */
01585         SetDParam(0, v->service_interval);
01586         SetDParam(1, v->date_of_last_service);
01587         DrawString(r.left + WD_FRAMERECT_LEFT, r.right - WD_FRAMERECT_RIGHT, r.top + (r.bottom - r.top + 1 - FONT_HEIGHT_NORMAL) / 2,
01588             Company::Get(v->owner)->settings.vehicle.servint_ispercent ? STR_VEHICLE_DETAILS_SERVICING_INTERVAL_PERCENT : STR_VEHICLE_DETAILS_SERVICING_INTERVAL_DAYS);
01589         break;
01590     }
01591   }
01592 
01594   virtual void OnPaint()
01595   {
01596     const Vehicle *v = Vehicle::Get(this->window_number);
01597 
01598     this->SetWidgetDisabledState(VLD_WIDGET_RENAME_VEHICLE, v->owner != _local_company);
01599 
01600     if (v->type == VEH_TRAIN) {
01601       this->DisableWidget(this->tab + VLD_WIDGET_DETAILS_CARGO_CARRIED);
01602       this->vscroll.SetCount(GetTrainDetailsWndVScroll(v->index, this->tab));
01603     }
01604 
01605     /* Disable service-scroller when interval is set to disabled */
01606     this->SetWidgetsDisabledState(!IsVehicleServiceIntervalEnabled(v->type, v->owner),
01607       VLD_WIDGET_INCREASE_SERVICING_INTERVAL,
01608       VLD_WIDGET_DECREASE_SERVICING_INTERVAL,
01609       WIDGET_LIST_END);
01610 
01611     this->DrawWidgets();
01612   }
01613 
01614   virtual void OnClick(Point pt, int widget)
01615   {
01616     switch (widget) {
01617       case VLD_WIDGET_RENAME_VEHICLE: { // rename
01618         const Vehicle *v = Vehicle::Get(this->window_number);
01619         SetDParam(0, v->index);
01620         ShowQueryString(STR_VEHICLE_NAME, STR_QUERY_RENAME_TRAIN_CAPTION + v->type,
01621             MAX_LENGTH_VEHICLE_NAME_BYTES, MAX_LENGTH_VEHICLE_NAME_PIXELS, this, CS_ALPHANUMERAL, QSF_ENABLE_DEFAULT);
01622       } break;
01623 
01624       case VLD_WIDGET_INCREASE_SERVICING_INTERVAL:   // increase int
01625       case VLD_WIDGET_DECREASE_SERVICING_INTERVAL: { // decrease int
01626         int mod = _ctrl_pressed ? 5 : 10;
01627         const Vehicle *v = Vehicle::Get(this->window_number);
01628 
01629         mod = (widget == VLD_WIDGET_DECREASE_SERVICING_INTERVAL) ? -mod : mod;
01630         mod = GetServiceIntervalClamped(mod + v->service_interval, v->owner);
01631         if (mod == v->service_interval) return;
01632 
01633         DoCommandP(v->tile, v->index, mod, CMD_CHANGE_SERVICE_INT | CMD_MSG(STR_ERROR_CAN_T_CHANGE_SERVICING));
01634       } break;
01635 
01636       case VLD_WIDGET_DETAILS_CARGO_CARRIED:
01637       case VLD_WIDGET_DETAILS_TRAIN_VEHICLES:
01638       case VLD_WIDGET_DETAILS_CAPACITY_OF_EACH:
01639       case VLD_WIDGET_DETAILS_TOTAL_CARGO:
01640         this->SetWidgetsDisabledState(false,
01641           VLD_WIDGET_DETAILS_CARGO_CARRIED,
01642           VLD_WIDGET_DETAILS_TRAIN_VEHICLES,
01643           VLD_WIDGET_DETAILS_CAPACITY_OF_EACH,
01644           VLD_WIDGET_DETAILS_TOTAL_CARGO,
01645           widget,
01646           WIDGET_LIST_END);
01647 
01648         this->tab = (TrainDetailsWindowTabs)(widget - VLD_WIDGET_DETAILS_CARGO_CARRIED);
01649         this->SetDirty();
01650         break;
01651     }
01652   }
01653 
01654   virtual void OnQueryTextFinished(char *str)
01655   {
01656     if (str == NULL) return;
01657 
01658     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);
01659   }
01660 
01661   virtual void OnResize()
01662   {
01663     NWidgetCore *nwi = this->GetWidget<NWidgetCore>(VLD_WIDGET_MATRIX);
01664     if (nwi != NULL) {
01665       this->vscroll.SetCapacityFromWidget(this, VLD_WIDGET_MATRIX);
01666       nwi->widget_data = (this->vscroll.GetCapacity() << MAT_ROW_START) + (1 << MAT_COL_START);
01667     }
01668   }
01669 };
01670 
01672 static const WindowDesc _train_vehicle_details_desc(
01673   WDP_AUTO, 405, 178,
01674   WC_VEHICLE_DETAILS, WC_VEHICLE_VIEW,
01675   WDF_UNCLICK_BUTTONS,
01676   _nested_train_vehicle_details_widgets, lengthof(_nested_train_vehicle_details_widgets)
01677 );
01678 
01680 static const WindowDesc _nontrain_vehicle_details_desc(
01681   WDP_AUTO, 405, 113,
01682   WC_VEHICLE_DETAILS, WC_VEHICLE_VIEW,
01683   WDF_UNCLICK_BUTTONS,
01684   _nested_nontrain_vehicle_details_widgets, lengthof(_nested_nontrain_vehicle_details_widgets)
01685 );
01686 
01688 static void ShowVehicleDetailsWindow(const Vehicle *v)
01689 {
01690   DeleteWindowById(WC_VEHICLE_ORDERS, v->index, false);
01691   DeleteWindowById(WC_VEHICLE_TIMETABLE, v->index, false);
01692   AllocateWindowDescFront<VehicleDetailsWindow>((v->type == VEH_TRAIN) ? &_train_vehicle_details_desc : &_nontrain_vehicle_details_desc, v->index);
01693 }
01694 
01695 
01696 /* Unified vehicle GUI - Vehicle View Window */
01697 
01699 static const NWidgetPart _nested_vehicle_view_widgets[] = {
01700   NWidget(NWID_HORIZONTAL),
01701     NWidget(WWT_CLOSEBOX, COLOUR_GREY),
01702     NWidget(WWT_CAPTION, COLOUR_GREY, VVW_WIDGET_CAPTION), SetDataTip(STR_VEHICLE_VIEW_CAPTION, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
01703     NWidget(WWT_SHADEBOX, COLOUR_GREY),
01704     NWidget(WWT_STICKYBOX, COLOUR_GREY),
01705   EndContainer(),
01706   NWidget(NWID_HORIZONTAL),
01707     NWidget(WWT_PANEL, COLOUR_GREY),
01708       NWidget(WWT_INSET, COLOUR_GREY), SetPadding(2, 2, 2, 2),
01709         NWidget(NWID_VIEWPORT, INVALID_COLOUR, VVW_WIDGET_VIEWPORT), SetMinimalSize(226, 84), SetResize(1, 1), SetPadding(1, 1, 1, 1),
01710       EndContainer(),
01711     EndContainer(),
01712     NWidget(NWID_VERTICAL),
01713       NWidget(WWT_PUSHIMGBTN, COLOUR_GREY, VVW_WIDGET_CENTER_MAIN_VIEH), SetMinimalSize(18, 18), SetFill(1, 1), SetDataTip(SPR_CENTRE_VIEW_VEHICLE, 0x0 /* filled later */),
01714       NWidget(NWID_SELECTION, INVALID_COLOUR, VVW_WIDGET_SELECT_DEPOT_CLONE),
01715         NWidget(WWT_PUSHIMGBTN, COLOUR_GREY, VVW_WIDGET_GOTO_DEPOT), SetMinimalSize(18, 18), SetFill(1, 1), SetDataTip(0x0 /* filled later */, 0x0 /* filled later */),
01716         NWidget(WWT_PUSHIMGBTN, COLOUR_GREY, VVW_WIDGET_CLONE_VEH), SetMinimalSize(18, 18), SetFill(1, 1), SetDataTip(0x0 /* filled later */, 0x0 /* filled later */),
01717       EndContainer(),
01718       /* For trains only, 'ignore signal' button. */
01719       NWidget(WWT_PUSHIMGBTN, COLOUR_GREY, VVW_WIDGET_FORCE_PROCEED), SetMinimalSize(18, 18), SetFill(1, 1),
01720                       SetDataTip(SPR_IGNORE_SIGNALS, STR_VEHICLE_VIEW_TRAIN_IGNORE_SIGNAL_TOOLTIP),
01721       NWidget(NWID_SELECTION, INVALID_COLOUR, VVW_WIDGET_SELECT_REFIT_TURN),
01722         NWidget(WWT_PUSHIMGBTN, COLOUR_GREY, VVW_WIDGET_REFIT_VEH), SetMinimalSize(18, 18), SetFill(1, 1), SetDataTip(SPR_REFIT_VEHICLE, 0x0 /* filled later */),
01723         NWidget(WWT_PUSHIMGBTN, COLOUR_GREY, VVW_WIDGET_TURN_AROUND), SetMinimalSize(18, 18), SetFill(1, 1),
01724                         SetDataTip(SPR_FORCE_VEHICLE_TURN, STR_VEHICLE_VIEW_ROAD_VEHICLE_REVERSE_TOOLTIP),
01725       EndContainer(),
01726       NWidget(WWT_PUSHIMGBTN, COLOUR_GREY, VVW_WIDGET_SHOW_ORDERS), SetFill(1, 1), SetMinimalSize(18, 18), SetDataTip(SPR_SHOW_ORDERS, 0x0 /* filled later */),
01727       NWidget(WWT_PUSHIMGBTN, COLOUR_GREY, VVW_WIDGET_SHOW_DETAILS), SetFill(1, 1), SetMinimalSize(18, 18), SetDataTip(SPR_SHOW_VEHICLE_DETAILS, 0x0 /* filled later */),
01728       NWidget(WWT_PANEL, COLOUR_GREY), SetFill(1, 1), SetMinimalSize(18, 0), SetResize(0, 1), EndContainer(),
01729     EndContainer(),
01730   EndContainer(),
01731   NWidget(NWID_HORIZONTAL),
01732     NWidget(WWT_PUSHBTN, COLOUR_GREY, VVW_WIDGET_START_STOP_VEH), SetMinimalTextLines(1, WD_FRAMERECT_TOP + WD_FRAMERECT_BOTTOM), SetResize(1, 0), SetFill(1, 0),
01733     NWidget(WWT_RESIZEBOX, COLOUR_GREY),
01734   EndContainer(),
01735 };
01736 
01738 static const WindowDesc _vehicle_view_desc(
01739   WDP_AUTO, 250, 116,
01740   WC_VEHICLE_VIEW, WC_NONE,
01741   WDF_UNCLICK_BUTTONS,
01742   _nested_vehicle_view_widgets, lengthof(_nested_vehicle_view_widgets)
01743 );
01744 
01748 static const WindowDesc _train_view_desc(
01749   WDP_AUTO, 250, 134,
01750   WC_VEHICLE_VIEW, WC_NONE,
01751   WDF_UNCLICK_BUTTONS,
01752   _nested_vehicle_view_widgets, lengthof(_nested_vehicle_view_widgets)
01753 );
01754 
01755 
01756 /* Just to make sure, nobody has changed the vehicle type constants, as we are
01757    using them for array indexing in a number of places here. */
01758 assert_compile(VEH_TRAIN == 0);
01759 assert_compile(VEH_ROAD == 1);
01760 assert_compile(VEH_SHIP == 2);
01761 assert_compile(VEH_AIRCRAFT == 3);
01762 
01764 static const ZoomLevel _vehicle_view_zoom_levels[] = {
01765   ZOOM_LVL_TRAIN,
01766   ZOOM_LVL_ROADVEH,
01767   ZOOM_LVL_SHIP,
01768   ZOOM_LVL_AIRCRAFT,
01769 };
01770 
01771 /* Constants for geometry of vehicle view viewport */
01772 static const int VV_INITIAL_VIEWPORT_WIDTH = 226;
01773 static const int VV_INITIAL_VIEWPORT_HEIGHT = 84;
01774 static const int VV_INITIAL_VIEWPORT_HEIGHT_TRAIN = 102;
01775 
01777 enum VehicleCommandTranslation {
01778   VCT_CMD_START_STOP = 0,
01779   VCT_CMD_CLONE_VEH,
01780   VCT_CMD_TURN_AROUND,
01781 };
01782 
01784 static const uint32 _vehicle_command_translation_table[][4] = {
01785   { // VCT_CMD_START_STOP
01786     CMD_START_STOP_VEHICLE | CMD_MSG(STR_ERROR_CAN_T_STOP_START_TRAIN),
01787     CMD_START_STOP_VEHICLE | CMD_MSG(STR_ERROR_CAN_T_STOP_START_ROAD_VEHICLE),
01788     CMD_START_STOP_VEHICLE | CMD_MSG(STR_ERROR_CAN_T_STOP_START_SHIP),
01789     CMD_START_STOP_VEHICLE | CMD_MSG(STR_ERROR_CAN_T_STOP_START_AIRCRAFT)
01790   },
01791   { // VCT_CMD_CLONE_VEH
01792     CMD_CLONE_VEHICLE | CMD_MSG(STR_ERROR_CAN_T_BUY_TRAIN),
01793     CMD_CLONE_VEHICLE | CMD_MSG(STR_ERROR_CAN_T_BUY_ROAD_VEHICLE),
01794     CMD_CLONE_VEHICLE | CMD_MSG(STR_ERROR_CAN_T_BUY_SHIP),
01795     CMD_CLONE_VEHICLE | CMD_MSG(STR_ERROR_CAN_T_BUY_AIRCRAFT)
01796   },
01797   { // VCT_CMD_TURN_AROUND
01798     CMD_REVERSE_TRAIN_DIRECTION | CMD_MSG(STR_ERROR_CAN_T_REVERSE_DIRECTION_TRAIN),
01799     CMD_TURN_ROADVEH            | CMD_MSG(STR_ERROR_CAN_T_MAKE_ROAD_VEHICLE_TURN),
01800     0xffffffff, // invalid for ships
01801     0xffffffff  // invalid for aircrafts
01802   },
01803 };
01804 
01806 static bool IsVehicleRefitable(const Vehicle *v)
01807 {
01808   if (!v->IsStoppedInDepot()) return false;
01809 
01810   do {
01811     if (IsEngineRefittable(v->engine_type)) return true;
01812   } while ((v->type == VEH_TRAIN || v->type == VEH_ROAD) && (v = v->Next()) != NULL);
01813 
01814   return false;
01815 }
01816 
01818 struct VehicleViewWindow : Window {
01819 private:
01821   enum PlaneSelections {
01822     SEL_DC_GOTO_DEPOT,  
01823     SEL_DC_CLONE,       
01824 
01825     SEL_RT_REFIT,       
01826     SEL_RT_TURN_AROUND, 
01827 
01828     SEL_DC_BASEPLANE = SEL_DC_GOTO_DEPOT, 
01829     SEL_RT_BASEPLANE = SEL_RT_REFIT,      
01830   };
01831 
01835   void SelectPlane(PlaneSelections plane)
01836   {
01837     switch (plane) {
01838       case SEL_DC_GOTO_DEPOT:
01839       case SEL_DC_CLONE:
01840         this->GetWidget<NWidgetStacked>(VVW_WIDGET_SELECT_DEPOT_CLONE)->SetDisplayedPlane(plane - SEL_DC_BASEPLANE);
01841         break;
01842 
01843       case SEL_RT_REFIT:
01844       case SEL_RT_TURN_AROUND:
01845         this->GetWidget<NWidgetStacked>(VVW_WIDGET_SELECT_REFIT_TURN)->SetDisplayedPlane(plane - SEL_RT_BASEPLANE);
01846         break;
01847 
01848       default:
01849         NOT_REACHED();
01850     }
01851   }
01852 
01853 public:
01854   VehicleViewWindow(const WindowDesc *desc, WindowNumber window_number) : Window()
01855   {
01856     this->CreateNestedTree(desc);
01857 
01858     /* Sprites for the 'send to depot' button indexed by vehicle type. */
01859     static const SpriteID vehicle_view_goto_depot_sprites[] = {
01860       SPR_SEND_TRAIN_TODEPOT,
01861       SPR_SEND_ROADVEH_TODEPOT,
01862       SPR_SEND_SHIP_TODEPOT,
01863       SPR_SEND_AIRCRAFT_TODEPOT,
01864     };
01865     const Vehicle *v = Vehicle::Get(window_number);
01866     this->GetWidget<NWidgetCore>(VVW_WIDGET_GOTO_DEPOT)->widget_data = vehicle_view_goto_depot_sprites[v->type];
01867 
01868     /* Sprites for the 'clone vehicle' button indexed by vehicle type. */
01869     static const SpriteID vehicle_view_clone_sprites[] = {
01870       SPR_CLONE_TRAIN,
01871       SPR_CLONE_ROADVEH,
01872       SPR_CLONE_SHIP,
01873       SPR_CLONE_AIRCRAFT,
01874     };
01875     this->GetWidget<NWidgetCore>(VVW_WIDGET_CLONE_VEH)->widget_data = vehicle_view_clone_sprites[v->type];
01876 
01877     switch (v->type) {
01878       case VEH_TRAIN:
01879         this->GetWidget<NWidgetCore>(VVW_WIDGET_TURN_AROUND)->tool_tip = STR_VEHICLE_VIEW_TRAIN_REVERSE_TOOLTIP;
01880         break;
01881 
01882       case VEH_ROAD:
01883         break;
01884 
01885       case VEH_SHIP:
01886       case VEH_AIRCRAFT:
01887         this->SelectPlane(SEL_RT_REFIT);
01888         break;
01889 
01890       default: NOT_REACHED();
01891     }
01892     this->FinishInitNested(desc, window_number);
01893     this->owner = v->owner;
01894     this->GetWidget<NWidgetViewport>(VVW_WIDGET_VIEWPORT)->InitializeViewport(this, this->window_number | (1 << 31), _vehicle_view_zoom_levels[v->type]);
01895 
01896     this->GetWidget<NWidgetCore>(VVW_WIDGET_START_STOP_VEH)->tool_tip   = STR_VEHICLE_VIEW_TRAIN_STATE_START_STOP_TOOLTIP + v->type;
01897     this->GetWidget<NWidgetCore>(VVW_WIDGET_CENTER_MAIN_VIEH)->tool_tip = STR_VEHICLE_VIEW_TRAIN_LOCATION_TOOLTIP + v->type;
01898     this->GetWidget<NWidgetCore>(VVW_WIDGET_REFIT_VEH)->tool_tip        = STR_VEHICLE_VIEW_TRAIN_REFIT_TOOLTIP + v->type;
01899     this->GetWidget<NWidgetCore>(VVW_WIDGET_GOTO_DEPOT)->tool_tip       = STR_VEHICLE_VIEW_TRAIN_SEND_TO_DEPOT_TOOLTIP + v->type;
01900     this->GetWidget<NWidgetCore>(VVW_WIDGET_SHOW_ORDERS)->tool_tip      = STR_VEHICLE_VIEW_TRAIN_ORDERS_TOOLTIP + v->type;
01901     this->GetWidget<NWidgetCore>(VVW_WIDGET_SHOW_DETAILS)->tool_tip     = STR_VEHICLE_VIEW_TRAIN_SHOW_DETAILS_TOOLTIP + v->type;
01902     this->GetWidget<NWidgetCore>(VVW_WIDGET_CLONE_VEH)->tool_tip        = STR_VEHICLE_VIEW_CLONE_TRAIN_INFO + v->type;
01903   }
01904 
01905   ~VehicleViewWindow()
01906   {
01907     DeleteWindowById(WC_VEHICLE_ORDERS, this->window_number, false);
01908     DeleteWindowById(WC_VEHICLE_REFIT, this->window_number, false);
01909     DeleteWindowById(WC_VEHICLE_DETAILS, this->window_number, false);
01910     DeleteWindowById(WC_VEHICLE_TIMETABLE, this->window_number, false);
01911   }
01912 
01913   virtual void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize)
01914   {
01915     const Vehicle *v = Vehicle::Get(this->window_number);
01916     switch (widget) {
01917       case VVW_WIDGET_FORCE_PROCEED:
01918         if (v->type != VEH_TRAIN) {
01919           size->height = 0;
01920           size->width = 0;
01921         } break;
01922 
01923       case VVW_WIDGET_VIEWPORT:
01924         size->width = VV_INITIAL_VIEWPORT_WIDTH;
01925         size->height = (v->type == VEH_TRAIN) ? VV_INITIAL_VIEWPORT_HEIGHT_TRAIN : VV_INITIAL_VIEWPORT_HEIGHT;
01926         break;
01927     }
01928   }
01929 
01930   virtual void OnPaint()
01931   {
01932     const Vehicle *v = Vehicle::Get(this->window_number);
01933     bool is_localcompany = v->owner == _local_company;
01934     bool refitable_and_stopped_in_depot = IsVehicleRefitable(v);
01935 
01936     this->SetWidgetDisabledState(VVW_WIDGET_GOTO_DEPOT, !is_localcompany);
01937     this->SetWidgetDisabledState(VVW_WIDGET_REFIT_VEH, !refitable_and_stopped_in_depot || !is_localcompany);
01938     this->SetWidgetDisabledState(VVW_WIDGET_CLONE_VEH, !is_localcompany);
01939 
01940     if (v->type == VEH_TRAIN) {
01941       this->SetWidgetLoweredState(VVW_WIDGET_FORCE_PROCEED, Train::From(v)->force_proceed == 2);
01942       this->SetWidgetDisabledState(VVW_WIDGET_FORCE_PROCEED, !is_localcompany);
01943       this->SetWidgetDisabledState(VVW_WIDGET_TURN_AROUND, !is_localcompany);
01944     }
01945 
01946     this->DrawWidgets();
01947   }
01948 
01949   virtual void SetStringParameters(int widget) const
01950   {
01951     if (widget != VVW_WIDGET_CAPTION) return;
01952 
01953     const Vehicle *v = Vehicle::Get(this->window_number);
01954     SetDParam(0, v->index);
01955   }
01956 
01957   virtual void DrawWidget(const Rect &r, int widget) const
01958   {
01959     if (widget != VVW_WIDGET_START_STOP_VEH) return;
01960 
01961     const Vehicle *v = Vehicle::Get(this->window_number);
01962     StringID str;
01963     if (v->vehstatus & VS_CRASHED) {
01964       str = STR_VEHICLE_STATUS_CRASHED;
01965     } else if (v->type != VEH_AIRCRAFT && v->breakdown_ctr == 1) { // check for aircraft necessary?
01966       str = STR_VEHICLE_STATUS_BROKEN_DOWN;
01967     } else if (v->vehstatus & VS_STOPPED) {
01968       if (v->type == VEH_TRAIN) {
01969         if (v->cur_speed == 0) {
01970           if (Train::From(v)->tcache.cached_power == 0) {
01971             str = STR_VEHICLE_STATUS_TRAIN_NO_POWER;
01972           } else {
01973             str = STR_VEHICLE_STATUS_STOPPED;
01974           }
01975         } else {
01976           SetDParam(0, v->GetDisplaySpeed());
01977           str = STR_VEHICLE_STATUS_TRAIN_STOPPING + _settings_client.gui.vehicle_speed;
01978         }
01979       } else { // no train
01980         str = STR_VEHICLE_STATUS_STOPPED;
01981       }
01982     } else if (v->type == VEH_TRAIN && HasBit(Train::From(v)->flags, VRF_TRAIN_STUCK) && !v->current_order.IsType(OT_LOADING)) {
01983       str = STR_VEHICLE_STATUS_TRAIN_STUCK;
01984     } else { // vehicle is in a "normal" state, show current order
01985       switch (v->current_order.GetType()) {
01986         case OT_GOTO_STATION: {
01987           SetDParam(0, v->current_order.GetDestination());
01988           SetDParam(1, v->GetDisplaySpeed());
01989           str = STR_VEHICLE_STATUS_HEADING_FOR_STATION + _settings_client.gui.vehicle_speed;
01990         } break;
01991 
01992         case OT_GOTO_DEPOT: {
01993           if (v->type == VEH_AIRCRAFT) {
01994             /* Aircrafts always go to a station, even if you say depot */
01995             SetDParam(0, v->current_order.GetDestination());
01996             SetDParam(1, v->GetDisplaySpeed());
01997           } else {
01998             Depot *depot = Depot::Get(v->current_order.GetDestination());
01999             SetDParam(0, depot->town_index);
02000             SetDParam(1, v->GetDisplaySpeed());
02001           }
02002           if (v->current_order.GetDepotActionType() & ODATFB_HALT) {
02003             str = STR_VEHICLE_STATUS_HEADING_FOR_TRAIN_DEPOT + 2 * v->type + _settings_client.gui.vehicle_speed;
02004           } else {
02005             str = STR_VEHICLE_STATUS_HEADING_FOR_TRAIN_DEPOT_SERVICE + 2 * v->type + _settings_client.gui.vehicle_speed;
02006           }
02007         } break;
02008 
02009         case OT_LOADING:
02010           str = STR_VEHICLE_STATUS_LOADING_UNLOADING;
02011           break;
02012 
02013         case OT_GOTO_WAYPOINT: {
02014           assert(v->type == VEH_TRAIN || v->type == VEH_SHIP);
02015           SetDParam(0, v->current_order.GetDestination());
02016           str = STR_VEHICLE_STATUS_HEADING_FOR_WAYPOINT + _settings_client.gui.vehicle_speed;
02017           SetDParam(1, v->GetDisplaySpeed());
02018           break;
02019         }
02020 
02021         case OT_LEAVESTATION:
02022           if (v->type != VEH_AIRCRAFT) {
02023             str = STR_VEHICLE_STATUS_LEAVING;
02024             break;
02025           }
02026           /* fall-through if aircraft. Does this even happen? */
02027 
02028         default:
02029           if (v->GetNumOrders() == 0) {
02030             str = STR_VEHICLE_STATUS_NO_ORDERS + _settings_client.gui.vehicle_speed;
02031             SetDParam(0, v->GetDisplaySpeed());
02032           } else {
02033             str = STR_EMPTY;
02034           }
02035           break;
02036       }
02037     }
02038 
02039     /* draw the flag plus orders */
02040     DrawSprite(v->vehstatus & VS_STOPPED ? SPR_FLAG_VEH_STOPPED : SPR_FLAG_VEH_RUNNING, PAL_NONE, WD_FRAMERECT_LEFT, r.top + WD_FRAMERECT_TOP);
02041     DrawString(r.left + WD_FRAMERECT_LEFT + 6, r.right - WD_FRAMERECT_RIGHT, r.top + WD_FRAMERECT_TOP, str, TC_FROMSTRING, SA_CENTER);
02042   }
02043 
02044   virtual void OnClick(Point pt, int widget)
02045   {
02046     const Vehicle *v = Vehicle::Get(this->window_number);
02047 
02048     switch (widget) {
02049       case VVW_WIDGET_START_STOP_VEH: // start stop
02050         DoCommandP(v->tile, v->index, 0,
02051                     _vehicle_command_translation_table[VCT_CMD_START_STOP][v->type]);
02052         break;
02053       case VVW_WIDGET_CENTER_MAIN_VIEH: {// center main view
02054         const Window *mainwindow = FindWindowById(WC_MAIN_WINDOW, 0);
02055         /* code to allow the main window to 'follow' the vehicle if the ctrl key is pressed */
02056         if (_ctrl_pressed && mainwindow->viewport->zoom == ZOOM_LVL_NORMAL) {
02057           mainwindow->viewport->follow_vehicle = v->index;
02058         } else {
02059           ScrollMainWindowTo(v->x_pos, v->y_pos, v->z_pos);
02060         }
02061       } break;
02062 
02063       case VVW_WIDGET_GOTO_DEPOT: // goto hangar
02064         DoCommandP(v->tile, v->index, _ctrl_pressed ? DEPOT_SERVICE : 0, GetCmdSendToDepot(v));
02065         break;
02066       case VVW_WIDGET_REFIT_VEH: // refit
02067         ShowVehicleRefitWindow(v, INVALID_VEH_ORDER_ID, this);
02068         break;
02069       case VVW_WIDGET_SHOW_ORDERS: // show orders
02070         if (_ctrl_pressed) {
02071           ShowTimetableWindow(v);
02072         } else {
02073           ShowOrdersWindow(v);
02074         }
02075         break;
02076       case VVW_WIDGET_SHOW_DETAILS: // show details
02077         ShowVehicleDetailsWindow(v);
02078         break;
02079       case VVW_WIDGET_CLONE_VEH: // clone vehicle
02080         DoCommandP(v->tile, v->index, _ctrl_pressed ? 1 : 0,
02081                     _vehicle_command_translation_table[VCT_CMD_CLONE_VEH][v->type],
02082                     CcCloneVehicle);
02083         break;
02084       case VVW_WIDGET_TURN_AROUND: // turn around
02085         assert(v->type == VEH_TRAIN || v->type == VEH_ROAD);
02086         DoCommandP(v->tile, v->index, 0,
02087                     _vehicle_command_translation_table[VCT_CMD_TURN_AROUND][v->type]);
02088         break;
02089       case VVW_WIDGET_FORCE_PROCEED: // force proceed
02090         assert(v->type == VEH_TRAIN);
02091         DoCommandP(v->tile, v->index, 0, CMD_FORCE_TRAIN_PROCEED | CMD_MSG(STR_ERROR_CAN_T_MAKE_TRAIN_PASS_SIGNAL));
02092         break;
02093     }
02094   }
02095 
02096   virtual void OnResize()
02097   {
02098     if (this->viewport != NULL) {
02099       NWidgetViewport *nvp = this->GetWidget<NWidgetViewport>(VVW_WIDGET_VIEWPORT);
02100       nvp->UpdateViewportCoordinates(this);
02101     }
02102   }
02103 
02104   virtual void OnTick()
02105   {
02106     const Vehicle *v = Vehicle::Get(this->window_number);
02107     bool veh_stopped = v->IsStoppedInDepot();
02108 
02109     /* Widget VVW_WIDGET_GOTO_DEPOT must be hidden if the vehicle is already stopped in depot.
02110      * Widget VVW_WIDGET_CLONE_VEH should then be shown, since cloning is allowed only while in depot and stopped.
02111      */
02112     PlaneSelections plane = veh_stopped ? SEL_DC_CLONE : SEL_DC_GOTO_DEPOT;
02113     NWidgetStacked *nwi = this->GetWidget<NWidgetStacked>(VVW_WIDGET_SELECT_DEPOT_CLONE); // Selection widget 'send to depot' / 'clone'.
02114     if (nwi->shown_plane + SEL_DC_BASEPLANE != plane) {
02115       this->SelectPlane(plane);
02116       this->SetWidgetDirty(VVW_WIDGET_SELECT_DEPOT_CLONE);
02117     }
02118     /* The same system applies to widget VVW_WIDGET_REFIT_VEH and VVW_WIDGET_TURN_AROUND.*/
02119     if (v->type == VEH_ROAD || v->type == VEH_TRAIN) {
02120       PlaneSelections plane = veh_stopped ? SEL_RT_REFIT : SEL_RT_TURN_AROUND;
02121       NWidgetStacked *nwi = this->GetWidget<NWidgetStacked>(VVW_WIDGET_SELECT_REFIT_TURN);
02122       if (nwi->shown_plane + SEL_RT_BASEPLANE != plane) {
02123         this->SelectPlane(plane);
02124         this->SetWidgetDirty(VVW_WIDGET_SELECT_REFIT_TURN);
02125       }
02126     }
02127   }
02128 };
02129 
02130 
02132 void ShowVehicleViewWindow(const Vehicle *v)
02133 {
02134   AllocateWindowDescFront<VehicleViewWindow>((v->type == VEH_TRAIN) ? &_train_view_desc : &_vehicle_view_desc, v->index);
02135 }
02136 
02137 void StopGlobalFollowVehicle(const Vehicle *v)
02138 {
02139   Window *w = FindWindowById(WC_MAIN_WINDOW, 0);
02140   if (w != NULL && w->viewport->follow_vehicle == v->index) {
02141     ScrollMainWindowTo(v->x_pos, v->y_pos, v->z_pos, true); // lock the main view on the vehicle's last position
02142     w->viewport->follow_vehicle = INVALID_VEHICLE;
02143   }
02144 }
02145 
02146 
02154 void CcBuildPrimaryVehicle(const CommandCost &result, TileIndex tile, uint32 p1, uint32 p2)
02155 {
02156   if (result.Failed()) return;
02157 
02158   const Vehicle *v = Vehicle::Get(_new_vehicle_id);
02159   if (v->tile == _backup_orders_tile) {
02160     _backup_orders_tile = 0;
02161     RestoreVehicleOrders(v);
02162   }
02163   ShowVehicleViewWindow(v);
02164 }

Generated on Wed Jan 20 23:38:42 2010 for OpenTTD by  doxygen 1.5.6