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 "player_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

    53

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

    54

	{

    55

		this->caption_color = GetVehicle(window_number)->owner;

    56

		this->vscroll.cap = 8;

    57

		this->resize.step_height = 10;

    58

		this->sel_index = -1;

    59

    60

		this->FindWindowPlacementAndResize(desc);

    61

	}

    62

    63

	int GetOrderFromTimetableWndPt(int y, const Vehicle *v)

    64

	{

    65

		/*

    66

		 * Calculation description:

    67

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

    68

		 * 10 = order text hight

    69

		 */

    70

		int sel = (y - 15) / 10;

    71

    72

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

    73

    74

		sel += this->vscroll.pos;

    75

    76

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

    77

	}

    78

    79

	void OnPaint()

    80

	{

    81

		const Vehicle *v = GetVehicle(this->window_number);

    82

		int selected = this->sel_index;

    83

    84

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

    85

    86

		if (v->owner == _local_player) {

    87

			bool disable = true;

    88

			if (selected != -1) {

    89

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

    90

				if (selected % 2 == 1) {

    91

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

    92

				} else {

    93

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

    94

				}

    95

			}

    96

    97

			this->SetWidgetDisabledState(TTV_CHANGE_TIME, disable);

    98

			this->SetWidgetDisabledState(TTV_CLEAR_TIME, disable);

    99

   100

			this->EnableWidget(TTV_RESET_LATENESS);

   101

			this->EnableWidget(TTV_AUTOFILL);

   102

		} else {

   103

			this->DisableWidget(TTV_CHANGE_TIME);

   104

			this->DisableWidget(TTV_CLEAR_TIME);

   105

			this->DisableWidget(TTV_RESET_LATENESS);

   106

			this->DisableWidget(TTV_AUTOFILL);

   107

		}

   108

   109

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

   110

   111

		SetDParam(0, v->index);

   112

		this->DrawWidgets();

   113

   114

		int y = 15;

   115

		int i = this->vscroll.pos;

   116

		VehicleOrderID order_id = (i + 1) / 2;

   117

		bool final_order = false;

   118

   119

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

   120

   121

		while (order != NULL) {

   122

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

   123

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

   124

   125

			if (i % 2 == 0) {

   126

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

   127

   128

				order_id++;

   129

   130

				if (order_id >= v->num_orders) {

   131

					order = GetVehicleOrder(v, 0);

   132

					final_order = true;

   133

				} else {

   134

					order = order->next;

   135

				}

   136

			} else {

   137

				StringID string;

   138

   139

				if (order->IsType(OT_CONDITIONAL)) {

   140

					string = STR_TIMETABLE_NO_TRAVEL;

   141

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

   142

					string = STR_TIMETABLE_TRAVEL_NOT_TIMETABLED;

   143

				} else {

   144

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

   145

					string = STR_TIMETABLE_TRAVEL_FOR;

   146

				}

   147

   148

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

   149

   150

				if (final_order) break;

   151

			}

   152

   153

			i++;

   154

			y += 10;

   155

		}

   156

   157

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

   158

   159

		{

   160

			uint total_time = 0;

   161

			bool complete = true;

   162

   163

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

   164

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

   165

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

   166

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

   167

			}

   168

   169

			if (total_time != 0) {

   170

				SetTimetableParams(0, 1, total_time);

   171

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

   172

			}

   173

		}

   174

		y += 10;

   175

   176

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

   177

			DrawString(2, y, STR_TIMETABLE_STATUS_ON_TIME, TC_BLACK);

   178

		} else {

   179

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

   180

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

   181

		}

   182

	}

   183

   184

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

   185

	{

   186

		uint order_number = (selected + 1) / 2;

   187

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

   188

   189

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

   190

   191

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

   192

	}

   193

   194

	virtual void OnClick(Point pt, int widget)

   195

	{

   196

		const Vehicle *v = GetVehicle(this->window_number);

   197

   198

		switch (widget) {

   199

			case TTV_ORDER_VIEW: /* Order view button */

   200

				ShowOrdersWindow(v);

   201

				break;

   202

   203

			case TTV_TIMETABLE_PANEL: { /* Main panel. */

   204

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

   205

   206

				if (selected == INVALID_ORDER || selected == this->sel_index) {

   207

					/* Deselect clicked order */

   208

					this->sel_index = -1;

   209

				} else {

   210

					/* Select clicked order */

   211

					this->sel_index = selected;

   212

				}

   213

			} break;

   214

   215

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

   216

				int selected = this->sel_index;

   217

				VehicleOrderID real = (selected + 1) / 2;

   218

   219

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

   220

   221

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

   222

				StringID current = STR_EMPTY;

   223

   224

				if (order != NULL) {

   225

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

   226

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

   227

   228

					if (time != 0) {

   229

						SetDParam(0, time);

   230

						current = STR_CONFIG_PATCHES_INT32;

   231

					}

   232

				}

   233

   234

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

   235

			} break;

   236

   237

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

   238

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

   239

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

   240

			} break;

   241

   242

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

   243

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

   244

				break;

   245

   246

			case TTV_AUTOFILL: /* Autofill the timetable. */

   247

				DoCommandP(0, v->index, HasBit(v->vehicle_flags, VF_AUTOFILL_TIMETABLE) ? 0 : 1, NULL, CMD_AUTOFILL_TIMETABLE | CMD_MSG(STR_CAN_T_TIMETABLE_VEHICLE));

   248

				break;

   249

		}

   250

   251

		this->SetDirty();

   252

	}

   253

   254

	virtual void OnQueryTextFinished(char *str)

   255

	{

   256

		if (str == NULL) return;

   257

   258

		const Vehicle *v = GetVehicle(this->window_number);

   259

   260

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

   261

   262

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

   263

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

   264

   265

		uint32 p2 = minu(time, UINT16_MAX);

   266

   267

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

   268

	}

   269

   270

	virtual void OnResize(Point new_size, Point delta)

   271

	{

   272

		/* Update the scroll + matrix */

   273

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

   274

	}

   275

};

   276

   277

static const Widget _timetable_widgets[] = {

   278

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

   279

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

   280

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

   281

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

   282

   283

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

   284

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

   285

   286

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

   287

   288

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

   289

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

   290

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

   291

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

   292

   293

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

   294

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

   295

   296

	{    WIDGETS_END }

   297

};

   298

   299

static const WindowDesc _timetable_desc = {

   300

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

   301

	WC_VEHICLE_TIMETABLE, WC_VEHICLE_VIEW,

   302

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

   303

	_timetable_widgets,

   304

};

   305

   306

void ShowTimetableWindow(const Vehicle *v)

   307

{

   308

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

   309

}