1

/* $Id$ */

     2

     3

/** @file timetable_gui.cpp GUI for time tabling. */

     4

     5

#include "stdafx.h"

     6

#include "openttd.h"

     7

#include "variables.h"

     8

#include "command_func.h"

     9

#include "gui.h"

    10

#include "window_gui.h"

    11

#include "textbuf_gui.h"

    12

#include "cargotype.h"

    13

#include "strings_func.h"

    14

#include "vehicle_base.h"

    15

#include "string_func.h"

    16

#include "gfx_func.h"

    17

#include "company_func.h"

    18

#include "order_func.h"

    19

#include "settings_type.h"

    20

    21

#include "table/strings.h"

    22

    23

enum TimetableViewWindowWidgets {

    24

	TTV_WIDGET_CLOSEBOX = 0,

    25

	TTV_CAPTION,

    26

	TTV_ORDER_VIEW,

    27

	TTV_STICKY,

    28

	TTV_TIMETABLE_PANEL,

    29

	TTV_SCROLLBAR,

    30

	TTV_SUMMARY_PANEL,

    31

	TTV_CHANGE_TIME,

    32

	TTV_CLEAR_TIME,

    33

	TTV_RESET_LATENESS,

    34

	TTV_AUTOFILL,

    35

	TTV_EMPTY,

    36

	TTV_RESIZE,

    37

};

    38

    39

void SetTimetableParams(int param1, int param2, uint32 time)

    40

{

    41

	if (_settings_client.gui.timetable_in_ticks) {

    42

		SetDParam(param1, STR_TIMETABLE_TICKS);

    43

		SetDParam(param2, time);

    44

	} else {

    45

		SetDParam(param1, STR_TIMETABLE_DAYS);

    46

		SetDParam(param2, time / DAY_TICKS);

    47

	}

    48

}

    49

    50

struct TimetableWindow : Window {

    51

	int sel_index;

    52

	const Vehicle *vehicle;

    53

    54

	TimetableWindow(const WindowDesc *desc, WindowNumber window_number) : Window(desc, window_number)

    55

	{

    56

		this->vehicle = GetVehicle(window_number);

    57

		this->caption_color = this->vehicle->owner;

    58

		this->vscroll.cap = 8;

    59

		this->resize.step_height = 10;

    60

		this->sel_index = -1;

    61

    62

		this->FindWindowPlacementAndResize(desc);

    63

	}

    64

    65

	int GetOrderFromTimetableWndPt(int y, const Vehicle *v)

    66

	{

    67

		/*

    68

		 * Calculation description:

    69

		 * 15 = 14 (this->widget[TTV_ORDER_VIEW].top) + 1 (frame-line)

    70

		 * 10 = order text hight

    71

		 */

    72

		int sel = (y - 15) / 10;

    73

    74

		if ((uint)sel >= this->vscroll.cap) return INVALID_ORDER;

    75

    76

		sel += this->vscroll.pos;

    77

    78

		return (sel < v->num_orders * 2 && sel >= 0) ? sel : INVALID_ORDER;

    79

	}

    80

    81

	virtual void OnInvalidateData(int data)

    82

	{

    83

		switch (data) {

    84

			case 0:

    85

				/* Autoreplace replaced the vehicle */

    86

				this->vehicle = GetVehicle(this->window_number);

    87

				break;

    88

    89

			case -1:

    90

				/* Removed / replaced all orders (after deleting / sharing) */

    91

				if (this->sel_index == -1) break;

    92

    93

				this->DeleteChildWindows();

    94

				this->sel_index = -1;

    95

				break;

    96

    97

			default: {

    98

				/* Moving an order. If one of these is INVALID_VEH_ORDER_ID, then

    99

				 * the order is being created / removed */

   100

				if (this->sel_index == -1) break;

   101

   102

				VehicleOrderID from = GB(data, 0, 8);

   103

				VehicleOrderID to   = GB(data, 8, 8);

   104

   105

				if (from == to) break; // no need to change anything

   106

   107

				/* if from == INVALID_VEH_ORDER_ID, one order was added; if to == INVALID_VEH_ORDER_ID, one order was removed */

   108

				uint old_num_orders = this->vehicle->num_orders - (uint)(from == INVALID_VEH_ORDER_ID) + (uint)(to == INVALID_VEH_ORDER_ID);

   109

   110

				VehicleOrderID selected_order = (this->sel_index + 1) / 2;

   111

				if (selected_order == old_num_orders) selected_order = 0; // when last travel time is selected, it belongs to order 0

   112

   113

				bool travel = HasBit(this->sel_index, 0);

   114

   115

				if (from != selected_order) {

   116

					/* Moving from preceeding order? */

   117

					selected_order -= (int)(from <= selected_order);

   118

					/* Moving to   preceeding order? */

   119

					selected_order += (int)(to   <= selected_order);

   120

				} else {

   121

					/* Now we are modifying the selected order */

   122

					if (to == INVALID_VEH_ORDER_ID) {

   123

						/* Deleting selected order */

   124

						this->DeleteChildWindows();

   125

						this->sel_index = -1;

   126

						break;

   127

					} else {

   128

						/* Moving selected order */

   129

						selected_order = to;

   130

					}

   131

				}

   132

   133

				/* recompute new sel_index */

   134

				this->sel_index = 2 * selected_order - (int)travel;

   135

				/* travel time of first order needs special handling */

   136

				if (this->sel_index == -1) this->sel_index = this->vehicle->num_orders * 2 - 1;

   137

			} break;

   138

		}

   139

	}

   140

   141

   142

	virtual void OnPaint()

   143

	{

   144

		const Vehicle *v = this->vehicle;

   145

		int selected = this->sel_index;

   146

   147

		SetVScrollCount(this, v->num_orders * 2);

   148

   149

		if (v->owner == _local_company) {

   150

			bool disable = true;

   151

			if (selected != -1) {

   152

				const Order *order = GetVehicleOrder(v, ((selected + 1) / 2) % v->num_orders);

   153

				if (selected % 2 == 1) {

   154

					disable = order != NULL && order->IsType(OT_CONDITIONAL);

   155

				} else {

   156

					disable = order == NULL || ((!order->IsType(OT_GOTO_STATION) || (order->GetNonStopType() & ONSF_NO_STOP_AT_DESTINATION_STATION)) && !order->IsType(OT_CONDITIONAL));

   157

				}

   158

			}

   159

   160

			this->SetWidgetDisabledState(TTV_CHANGE_TIME, disable);

   161

			this->SetWidgetDisabledState(TTV_CLEAR_TIME, disable);

   162

   163

			this->EnableWidget(TTV_RESET_LATENESS);

   164

			this->EnableWidget(TTV_AUTOFILL);

   165

		} else {

   166

			this->DisableWidget(TTV_CHANGE_TIME);

   167

			this->DisableWidget(TTV_CLEAR_TIME);

   168

			this->DisableWidget(TTV_RESET_LATENESS);

   169

			this->DisableWidget(TTV_AUTOFILL);

   170

		}

   171

   172

		this->SetWidgetLoweredState(TTV_AUTOFILL, HasBit(v->vehicle_flags, VF_AUTOFILL_TIMETABLE));

   173

   174

		SetDParam(0, v->index);

   175

		this->DrawWidgets();

   176

   177

		int y = 15;

   178

		int i = this->vscroll.pos;

   179

		VehicleOrderID order_id = (i + 1) / 2;

   180

		bool final_order = false;

   181

   182

		const Order *order = GetVehicleOrder(v, order_id);

   183

   184

		while (order != NULL) {

   185

			/* Don't draw anything if it extends past the end of the window. */

   186

			if (i - this->vscroll.pos >= this->vscroll.cap) break;

   187

   188

			if (i % 2 == 0) {

   189

				DrawOrderString(v, order, order_id, y, i == selected, true, this->widget[TTV_TIMETABLE_PANEL].right - 4);

   190

   191

				order_id++;

   192

   193

				if (order_id >= v->num_orders) {

   194

					order = GetVehicleOrder(v, 0);

   195

					final_order = true;

   196

				} else {

   197

					order = order->next;

   198

				}

   199

			} else {

   200

				StringID string;

   201

   202

				if (order->IsType(OT_CONDITIONAL)) {

   203

					string = STR_TIMETABLE_NO_TRAVEL;

   204

				} else if (order->travel_time == 0) {

   205

					string = STR_TIMETABLE_TRAVEL_NOT_TIMETABLED;

   206

				} else {

   207

					SetTimetableParams(0, 1, order->travel_time);

   208

					string = STR_TIMETABLE_TRAVEL_FOR;

   209

				}

   210

   211

				DrawStringTruncated(2, y, string, (i == selected) ? TC_WHITE : TC_BLACK, this->widget[TTV_TIMETABLE_PANEL].right - 4);

   212

   213

				if (final_order) break;

   214

			}

   215

   216

			i++;

   217

			y += 10;

   218

		}

   219

   220

		y = this->widget[TTV_SUMMARY_PANEL].top + 1;

   221

   222

		{

   223

			uint total_time = 0;

   224

			bool complete = true;

   225

   226

			for (const Order *order = GetVehicleOrder(v, 0); order != NULL; order = order->next) {

   227

				total_time += order->travel_time + order->wait_time;

   228

				if (order->travel_time == 0 && !order->IsType(OT_CONDITIONAL)) complete = false;

   229

				if (order->wait_time == 0 && order->IsType(OT_GOTO_STATION) && !(order->GetNonStopType() & ONSF_NO_STOP_AT_DESTINATION_STATION)) complete = false;

   230

			}

   231

   232

			if (total_time != 0) {

   233

				SetTimetableParams(0, 1, total_time);

   234

				DrawString(2, y, complete ? STR_TIMETABLE_TOTAL_TIME : STR_TIMETABLE_TOTAL_TIME_INCOMPLETE, TC_BLACK);

   235

			}

   236

		}

   237

		y += 10;

   238

   239

		if (v->lateness_counter == 0 || (!_settings_client.gui.timetable_in_ticks && v->lateness_counter / DAY_TICKS == 0)) {

   240

			DrawString(2, y, STR_TIMETABLE_STATUS_ON_TIME, TC_BLACK);

   241

		} else {

   242

			SetTimetableParams(0, 1, abs(v->lateness_counter));

   243

			DrawString(2, y, v->lateness_counter < 0 ? STR_TIMETABLE_STATUS_EARLY : STR_TIMETABLE_STATUS_LATE, TC_BLACK);

   244

		}

   245

	}

   246

   247

	static inline uint32 PackTimetableArgs(const Vehicle *v, uint selected)

   248

	{

   249

		uint order_number = (selected + 1) / 2;

   250

		uint is_journey   = (selected % 2 == 1) ? 1 : 0;

   251

   252

		if (order_number >= v->num_orders) order_number = 0;

   253

   254

		return v->index | (order_number << 16) | (is_journey << 24);

   255

	}

   256

   257

	virtual void OnClick(Point pt, int widget)

   258

	{

   259

		const Vehicle *v = this->vehicle;

   260

   261

		switch (widget) {

   262

			case TTV_ORDER_VIEW: /* Order view button */

   263

				ShowOrdersWindow(v);

   264

				break;

   265

   266

			case TTV_TIMETABLE_PANEL: { /* Main panel. */

   267

				int selected = GetOrderFromTimetableWndPt(pt.y, v);

   268

   269

				this->DeleteChildWindows();

   270

				this->sel_index = (selected == INVALID_ORDER || selected == this->sel_index) ? -1 : selected;

   271

			} break;

   272

   273

			case TTV_CHANGE_TIME: { /* "Wait For" button. */

   274

				int selected = this->sel_index;

   275

				VehicleOrderID real = (selected + 1) / 2;

   276

   277

				if (real >= v->num_orders) real = 0;

   278

   279

				const Order *order = GetVehicleOrder(v, real);

   280

				StringID current = STR_EMPTY;

   281

   282

				if (order != NULL) {

   283

					uint time = (selected % 2 == 1) ? order->travel_time : order->wait_time;

   284

					if (!_settings_client.gui.timetable_in_ticks) time /= DAY_TICKS;

   285

   286

					if (time != 0) {

   287

						SetDParam(0, time);

   288

						current = STR_CONFIG_PATCHES_INT32;

   289

					}

   290

				}

   291

   292

				ShowQueryString(current, STR_TIMETABLE_CHANGE_TIME, 31, 150, this, CS_NUMERAL, QSF_NONE);

   293

			} break;

   294

   295

			case TTV_CLEAR_TIME: { /* Clear waiting time button. */

   296

				uint32 p1 = PackTimetableArgs(v, this->sel_index);

   297

				DoCommandP(0, p1, 0, NULL, CMD_CHANGE_TIMETABLE | CMD_MSG(STR_CAN_T_TIMETABLE_VEHICLE));

   298

			} break;

   299

   300

			case TTV_RESET_LATENESS: /* Reset the vehicle's late counter. */

   301

				DoCommandP(0, v->index, 0, NULL, CMD_SET_VEHICLE_ON_TIME | CMD_MSG(STR_CAN_T_TIMETABLE_VEHICLE));

   302

				break;

   303

   304

			case TTV_AUTOFILL: { /* Autofill the timetable. */

   305

				uint32 p2 = 0;

   306

				if (!HasBit(v->vehicle_flags, VF_AUTOFILL_TIMETABLE)) SetBit(p2, 0);

   307

				if (_ctrl_pressed) SetBit(p2, 1);

   308

				DoCommandP(0, v->index, p2, NULL, CMD_AUTOFILL_TIMETABLE | CMD_MSG(STR_CAN_T_TIMETABLE_VEHICLE));

   309

			} break;

   310

		}

   311

   312

		this->SetDirty();

   313

	}

   314

   315

	virtual void OnQueryTextFinished(char *str)

   316

	{

   317

		if (str == NULL) return;

   318

   319

		const Vehicle *v = this->vehicle;

   320

   321

		uint32 p1 = PackTimetableArgs(v, this->sel_index);

   322

   323

		uint64 time = StrEmpty(str) ? 0 : strtoul(str, NULL, 10);

   324

		if (!_settings_client.gui.timetable_in_ticks) time *= DAY_TICKS;

   325

   326

		uint32 p2 = minu(time, UINT16_MAX);

   327

   328

		DoCommandP(0, p1, p2, NULL, CMD_CHANGE_TIMETABLE | CMD_MSG(STR_CAN_T_TIMETABLE_VEHICLE));

   329

	}

   330

   331

	virtual void OnResize(Point new_size, Point delta)

   332

	{

   333

		/* Update the scroll + matrix */

   334

		this->vscroll.cap = (this->widget[TTV_TIMETABLE_PANEL].bottom - this->widget[TTV_TIMETABLE_PANEL].top) / 10;

   335

	}

   336

};

   337

   338

static const Widget _timetable_widgets[] = {

   339

	{   WWT_CLOSEBOX,   RESIZE_NONE,   COLOUR_GREY,     0,    10,     0,    13, STR_00C5,                   STR_018B_CLOSE_WINDOW},                // TTV_WIDGET_CLOSEBOX

   340

	{    WWT_CAPTION,   RESIZE_RIGHT,  COLOUR_GREY,    11,   326,     0,    13, STR_TIMETABLE_TITLE,        STR_018C_WINDOW_TITLE_DRAG_THIS},      // TTV_CAPTION

   341

	{ WWT_PUSHTXTBTN,   RESIZE_LR,     COLOUR_GREY,   327,   387,     0,    13, STR_ORDER_VIEW,             STR_ORDER_VIEW_TOOLTIP},               // TTV_ORDER_VIEW

   342

	{  WWT_STICKYBOX,   RESIZE_LR,     COLOUR_GREY,   388,   399,     0,    13, STR_NULL,                   STR_STICKY_BUTTON},                    // TTV_STICKY

   343

   344

	{      WWT_PANEL,   RESIZE_RB,     COLOUR_GREY,     0,   387,    14,    95, STR_NULL,                   STR_TIMETABLE_TOOLTIP},                // TTV_TIMETABLE_PANEL

   345

	{  WWT_SCROLLBAR,   RESIZE_LRB,    COLOUR_GREY,   388,   399,    14,    95, STR_NULL,                   STR_0190_SCROLL_BAR_SCROLLS_LIST},     // TTV_SCROLLBAR

   346

   347

	{      WWT_PANEL,   RESIZE_RTB,    COLOUR_GREY,     0,   399,    96,   117, STR_NULL,                   STR_NULL},                             // TTV_SUMMARY_PANEL

   348

   349

	{ WWT_PUSHTXTBTN,   RESIZE_TB,     COLOUR_GREY,     0,   109,   118,   129, STR_TIMETABLE_CHANGE_TIME,  STR_TIMETABLE_WAIT_TIME_TOOLTIP},      // TTV_CHANGE_TIME

   350

	{ WWT_PUSHTXTBTN,   RESIZE_TB,     COLOUR_GREY,   110,   219,   118,   129, STR_CLEAR_TIME,             STR_TIMETABLE_CLEAR_TIME_TOOLTIP},     // TTV_CLEAR_TIME

   351

	{ WWT_PUSHTXTBTN,   RESIZE_TB,     COLOUR_GREY,   220,   337,   118,   129, STR_RESET_LATENESS,         STR_TIMETABLE_RESET_LATENESS_TOOLTIP}, // TTV_RESET_LATENESS

   352

	{ WWT_PUSHTXTBTN,   RESIZE_TB,     COLOUR_GREY,   338,   387,   118,   129, STR_TIMETABLE_AUTOFILL,     STR_TIMETABLE_AUTOFILL_TOOLTIP},       // TTV_AUTOFILL

   353

   354

	{      WWT_PANEL,   RESIZE_RTB,    COLOUR_GREY,   388,   387,   118,   129, STR_NULL,                   STR_NULL},                             // TTV_EMPTY

   355

	{  WWT_RESIZEBOX,   RESIZE_LRTB,   COLOUR_GREY,   388,   399,   118,   129, STR_NULL,                   STR_RESIZE_BUTTON},                    // TTV_RESIZE

   356

   357

	{    WIDGETS_END }

   358

};

   359

   360

static const WindowDesc _timetable_desc = {

   361

	WDP_AUTO, WDP_AUTO, 400, 130, 400, 130,

   362

	WC_VEHICLE_TIMETABLE, WC_VEHICLE_VIEW,

   363

	WDF_STD_TOOLTIPS | WDF_STD_BTN | WDF_DEF_WIDGET | WDF_UNCLICK_BUTTONS | WDF_STICKY_BUTTON | WDF_RESIZABLE,

   364

	_timetable_widgets,

   365

};

   366

   367

void ShowTimetableWindow(const Vehicle *v)

   368

{

   369

	AllocateWindowDescFront<TimetableWindow>(&_timetable_desc, v->index);

   370

}