1

/* $Id$ */

     2

     3

/** @file osk_gui.cpp The On Screen Keyboard GUI */

     4

     5

#include "stdafx.h"

     6

#include "openttd.h"

     7

     8

#include "textbuf_gui.h"

     9

#include "window_gui.h"

    10

#include "string_func.h"

    11

#include "strings_func.h"

    12

#include "debug.h"

    13

#include "window_func.h"

    14

#include "gfx_func.h"

    15

#include "querystring_gui.h"

    16

    17

#include "table/sprites.h"

    18

#include "table/strings.h"

    19

    20

enum OskWidgets {

    21

	OSK_WIDGET_TEXT = 3,

    22

	OSK_WIDGET_CANCEL = 5,

    23

	OSK_WIDGET_OK,

    24

	OSK_WIDGET_BACKSPACE,

    25

	OSK_WIDGET_SPECIAL,

    26

	OSK_WIDGET_CAPS,

    27

	OSK_WIDGET_SHIFT,

    28

	OSK_WIDGET_SPACE,

    29

	OSK_WIDGET_LEFT,

    30

	OSK_WIDGET_RIGHT,

    31

	OSK_WIDGET_LETTERS

    32

};

    33

    34

char _keyboard_opt[2][OSK_KEYBOARD_ENTRIES * 4 + 1];

    35

static WChar _keyboard[2][OSK_KEYBOARD_ENTRIES];

    36

    37

enum {

    38

	KEYS_NONE,

    39

	KEYS_SHIFT,

    40

	KEYS_CAPS

    41

};

    42

static byte _keystate = KEYS_NONE;

    43

    44

struct OskWindow : public Window {

    45

	StringID caption;      ///< the caption for this window.

    46

	QueryString *qs;       ///< text-input

    47

	int text_btn;          ///< widget number of parent's text field

    48

	int ok_btn;            ///< widget number of parent's ok button (=0 when ok shouldn't be passed on)

    49

	int cancel_btn;        ///< widget number of parent's cancel button (=0 when cancel shouldn't be passed on; text will be reverted to original)

    50

	Textbuf *text;         ///< pointer to parent's textbuffer (to update caret position)

    51

	char *orig_str_buf;    ///< Original string.

    52

    53

	OskWindow(const WindowDesc *desc, QueryStringBaseWindow *parent, int button, int cancel, int ok) : Window(desc)

    54

	{

    55

		this->parent = parent;

    56

		assert(parent != NULL);

    57

    58

		this->caption = (parent->widget[button].data != STR_NULL) ? parent->widget[button].data : parent->caption;

    59

    60

		this->qs         = parent;

    61

		this->text_btn   = button;

    62

		this->cancel_btn = cancel;

    63

		this->ok_btn     = ok;

    64

		this->text       = &parent->text;

    65

    66

		/* make a copy in case we need to reset later */

    67

		this->orig_str_buf = strdup(this->qs->text.buf);

    68

    69

		/* Not needed by default. */

    70

		this->DisableWidget(OSK_WIDGET_SPECIAL);

    71

    72

		this->FindWindowPlacementAndResize(desc);

    73

	}

    74

    75

	~OskWindow()

    76

	{

    77

		free(this->orig_str_buf);

    78

	}

    79

    80

	/**

    81

	 * Only show valid characters; do not show characters that would

    82

	 * only insert a space when we have a spacebar to do that or

    83

	 * characters that are not allowed to be entered.

    84

	 */

    85

	void ChangeOskDiabledState(bool shift)

    86

	{

    87

		for (uint i = 0; i < OSK_KEYBOARD_ENTRIES; i++) {

    88

			this->SetWidgetDisabledState(OSK_WIDGET_LETTERS + i,

    89

					!IsValidChar(_keyboard[shift][i], this->qs->afilter) || _keyboard[shift][i] == ' ');

    90

		}

    91

		this->SetWidgetDisabledState(OSK_WIDGET_SPACE, !IsValidChar(' ', this->qs->afilter));

    92

	}

    93

    94

	virtual void OnPaint()

    95

	{

    96

		bool shift = HasBit(_keystate, KEYS_CAPS) ^ HasBit(_keystate, KEYS_SHIFT);

    97

    98

		this->LowerWidget(OSK_WIDGET_TEXT);

    99

		this->SetWidgetLoweredState(OSK_WIDGET_SHIFT, HasBit(_keystate, KEYS_SHIFT));

   100

		this->SetWidgetLoweredState(OSK_WIDGET_CAPS, HasBit(_keystate, KEYS_CAPS));

   101

   102

		this->ChangeOskDiabledState(shift);

   103

   104

		SetDParam(0, this->caption);

   105

		this->DrawWidgets();

   106

   107

		for (uint i = 0; i < OSK_KEYBOARD_ENTRIES; i++) {

   108

			DrawCharCentered(_keyboard[shift][i],

   109

				this->widget[OSK_WIDGET_LETTERS + i].left + 8,

   110

				this->widget[OSK_WIDGET_LETTERS + i].top + 3,

   111

				TC_BLACK);

   112

		}

   113

   114

		this->qs->DrawEditBox(this, OSK_WIDGET_TEXT);

   115

	}

   116

   117

	virtual void OnClick(Point pt, int widget)

   118

	{

   119

		/* clicked a letter */

   120

		if (widget >= OSK_WIDGET_LETTERS) {

   121

			bool shift = HasBit(_keystate, KEYS_CAPS) ^ HasBit(_keystate, KEYS_SHIFT);

   122

   123

			WChar c = _keyboard[shift][widget - OSK_WIDGET_LETTERS];

   124

   125

			if (!IsValidChar(c, this->qs->afilter)) return;

   126

   127

			if (InsertTextBufferChar(&this->qs->text, c)) this->InvalidateWidget(OSK_WIDGET_TEXT);

   128

   129

			if (HasBit(_keystate, KEYS_SHIFT)) {

   130

				ToggleBit(_keystate, KEYS_SHIFT);

   131

				this->widget[OSK_WIDGET_SHIFT].color = HasBit(_keystate, KEYS_SHIFT) ? COLOUR_WHITE : COLOUR_GREY;

   132

				this->SetDirty();

   133

			}

   134

			return;

   135

		}

   136

   137

		bool delete_this = false;

   138

   139

		switch (widget) {

   140

			case OSK_WIDGET_BACKSPACE:

   141

				if (DeleteTextBufferChar(&this->qs->text, WKC_BACKSPACE)) this->InvalidateWidget(OSK_WIDGET_TEXT);

   142

				break;

   143

   144

			case OSK_WIDGET_SPECIAL:

   145

				/*

   146

				 * Anything device specific can go here.

   147

				 * The button itself is hidden by default, and when you need it you

   148

				 * can not hide it in the create event.

   149

				 */

   150

				break;

   151

   152

			case OSK_WIDGET_CAPS:

   153

				ToggleBit(_keystate, KEYS_CAPS);

   154

				this->SetDirty();

   155

				break;

   156

   157

			case OSK_WIDGET_SHIFT:

   158

				ToggleBit(_keystate, KEYS_SHIFT);

   159

				this->SetDirty();

   160

				break;

   161

   162

			case OSK_WIDGET_SPACE:

   163

				if (InsertTextBufferChar(&this->qs->text, ' ')) this->InvalidateWidget(OSK_WIDGET_TEXT);

   164

				break;

   165

   166

			case OSK_WIDGET_LEFT:

   167

				if (MoveTextBufferPos(&this->qs->text, WKC_LEFT)) this->InvalidateWidget(OSK_WIDGET_TEXT);

   168

				break;

   169

   170

			case OSK_WIDGET_RIGHT:

   171

				if (MoveTextBufferPos(&this->qs->text, WKC_RIGHT)) this->InvalidateWidget(OSK_WIDGET_TEXT);

   172

				break;

   173

   174

			case OSK_WIDGET_OK:

   175

				if (this->qs->orig == NULL || strcmp(this->qs->text.buf, this->qs->orig) != 0) {

   176

					/* pass information by simulating a button press on parent window */

   177

					if (this->ok_btn != 0) {

   178

						this->parent->OnClick(pt, this->ok_btn);

   179

						/* Window gets deleted when the parent window removes itself. */

   180

						return;

   181

					}

   182

				}

   183

				delete_this = true;

   184

				break;

   185

   186

			case OSK_WIDGET_CANCEL:

   187

				if (this->cancel_btn != 0) { // pass a cancel event to the parent window

   188

					this->parent->OnClick(pt, this->cancel_btn);

   189

					/* Window gets deleted when the parent window removes itself. */

   190

					return;

   191

				} else { // or reset to original string

   192

					strcpy(qs->text.buf, this->orig_str_buf);

   193

					UpdateTextBufferSize(&qs->text);

   194

					MoveTextBufferPos(&qs->text, WKC_END);

   195

					delete_this = true;

   196

				}

   197

				break;

   198

		}

   199

		/* make sure that the parent window's textbox also gets updated */

   200

		if (this->parent != NULL) this->parent->InvalidateWidget(this->text_btn);

   201

		if (delete_this) delete this;

   202

	}

   203

   204

	virtual void OnMouseLoop()

   205

	{

   206

		this->qs->HandleEditBox(this, OSK_WIDGET_TEXT);

   207

		/* make the caret of the parent window also blink */

   208

		this->parent->InvalidateWidget(this->text_btn);

   209

	}

   210

   211

	virtual void OnInvalidateData(int)

   212

	{

   213

		this->InvalidateWidget(OSK_WIDGET_TEXT);

   214

	}

   215

};

   216

   217

static const Widget _osk_widgets[] = {

   218

{      WWT_EMPTY, RESIZE_NONE,  COLOUR_GREY,     0,     0,     0,     0, 0x0,               STR_NULL},

   219

{    WWT_CAPTION, RESIZE_NONE,  COLOUR_GREY,     0,   255,     0,    13, STR_012D,          STR_NULL},

   220

{      WWT_PANEL, RESIZE_NONE,  COLOUR_GREY,     0,   255,    14,    29, 0x0,               STR_NULL},

   221

{    WWT_EDITBOX, RESIZE_NONE,  COLOUR_GREY,     2,   253,    16,    27, 0x0,               STR_NULL},

   222

   223

{      WWT_PANEL, RESIZE_NONE,  COLOUR_GREY,     0,   255,    30,   139, 0x0,               STR_NULL},

   224

   225

{    WWT_TEXTBTN, RESIZE_NONE,  COLOUR_GREY,     3,   108,    35,    46, STR_012E_CANCEL,   STR_NULL},

   226

{    WWT_TEXTBTN, RESIZE_NONE,  COLOUR_GREY,   111,   216,    35,    46, STR_012F_OK,       STR_NULL},

   227

{ WWT_PUSHIMGBTN, RESIZE_NONE,  COLOUR_GREY,   219,   252,    35,    46, SPR_OSK_BACKSPACE, STR_NULL},

   228

   229

{ WWT_PUSHIMGBTN, RESIZE_NONE,  COLOUR_GREY,     3,    27,    67,    82, SPR_OSK_SPECIAL,   STR_NULL},

   230

{     WWT_IMGBTN, RESIZE_NONE,  COLOUR_GREY,     3,    36,    85,   100, SPR_OSK_CAPS,      STR_NULL},

   231

{     WWT_IMGBTN, RESIZE_NONE,  COLOUR_GREY,     3,    27,   103,   118, SPR_OSK_SHIFT,     STR_NULL},

   232

   233

{ WWT_PUSHTXTBTN, RESIZE_NONE,  COLOUR_GREY,    75,   189,   121,   136, STR_EMPTY,         STR_NULL},

   234

   235

{ WWT_PUSHIMGBTN, RESIZE_NONE,  COLOUR_GREY,   219,   234,   121,   136, SPR_OSK_LEFT,      STR_NULL},

   236

{ WWT_PUSHIMGBTN, RESIZE_NONE,  COLOUR_GREY,   237,   252,   121,   136, SPR_OSK_RIGHT,     STR_NULL},

   237

   238

{    WWT_PUSHBTN, RESIZE_NONE,  COLOUR_GREY,     3,    18,    49,    64, 0x0,    STR_NULL},

   239

{    WWT_PUSHBTN, RESIZE_NONE,  COLOUR_GREY,    21,    36,    49,    64, 0x0,    STR_NULL},

   240

{    WWT_PUSHBTN, RESIZE_NONE,  COLOUR_GREY,    39,    54,    49,    64, 0x0,    STR_NULL},

   241

{    WWT_PUSHBTN, RESIZE_NONE,  COLOUR_GREY,    57,    72,    49,    64, 0x0,    STR_NULL},

   242

{    WWT_PUSHBTN, RESIZE_NONE,  COLOUR_GREY,    75,    90,    49,    64, 0x0,    STR_NULL},

   243

{    WWT_PUSHBTN, RESIZE_NONE,  COLOUR_GREY,    93,   108,    49,    64, 0x0,    STR_NULL},

   244

{    WWT_PUSHBTN, RESIZE_NONE,  COLOUR_GREY,   111,   126,    49,    64, 0x0,    STR_NULL},

   245

{    WWT_PUSHBTN, RESIZE_NONE,  COLOUR_GREY,   129,   144,    49,    64, 0x0,    STR_NULL},

   246

{    WWT_PUSHBTN, RESIZE_NONE,  COLOUR_GREY,   147,   162,    49,    64, 0x0,    STR_NULL},

   247

{    WWT_PUSHBTN, RESIZE_NONE,  COLOUR_GREY,   165,   180,    49,    64, 0x0,    STR_NULL},

   248

{    WWT_PUSHBTN, RESIZE_NONE,  COLOUR_GREY,   183,   198,    49,    64, 0x0,    STR_NULL},

   249

{    WWT_PUSHBTN, RESIZE_NONE,  COLOUR_GREY,   201,   216,    49,    64, 0x0,    STR_NULL},

   250

{    WWT_PUSHBTN, RESIZE_NONE,  COLOUR_GREY,   219,   234,    49,    64, 0x0,    STR_NULL},

   251

{    WWT_PUSHBTN, RESIZE_NONE,  COLOUR_GREY,   237,   252,    49,    64, 0x0,    STR_NULL},

   252

   253

{    WWT_PUSHBTN, RESIZE_NONE,  COLOUR_GREY,    30,    45,    67,    82, 0x0,    STR_NULL},

   254

{    WWT_PUSHBTN, RESIZE_NONE,  COLOUR_GREY,    48,    63,    67,    82, 0x0,    STR_NULL},

   255

{    WWT_PUSHBTN, RESIZE_NONE,  COLOUR_GREY,    66,    81,    67,    82, 0x0,    STR_NULL},

   256

{    WWT_PUSHBTN, RESIZE_NONE,  COLOUR_GREY,    84,    99,    67,    82, 0x0,    STR_NULL},

   257

{    WWT_PUSHBTN, RESIZE_NONE,  COLOUR_GREY,   102,   117,    67,    82, 0x0,    STR_NULL},

   258

{    WWT_PUSHBTN, RESIZE_NONE,  COLOUR_GREY,   120,   135,    67,    82, 0x0,    STR_NULL},

   259

{    WWT_PUSHBTN, RESIZE_NONE,  COLOUR_GREY,   138,   153,    67,    82, 0x0,    STR_NULL},

   260

{    WWT_PUSHBTN, RESIZE_NONE,  COLOUR_GREY,   156,   171,    67,    82, 0x0,    STR_NULL},

   261

{    WWT_PUSHBTN, RESIZE_NONE,  COLOUR_GREY,   174,   189,    67,    82, 0x0,    STR_NULL},

   262

{    WWT_PUSHBTN, RESIZE_NONE,  COLOUR_GREY,   192,   207,    67,    82, 0x0,    STR_NULL},

   263

{    WWT_PUSHBTN, RESIZE_NONE,  COLOUR_GREY,   210,   225,    67,    82, 0x0,    STR_NULL},

   264

{    WWT_PUSHBTN, RESIZE_NONE,  COLOUR_GREY,   228,   243,    67,    82, 0x0,    STR_NULL},

   265

   266

{    WWT_PUSHBTN, RESIZE_NONE,  COLOUR_GREY,    39,    54,    85,   100, 0x0,    STR_NULL},

   267

{    WWT_PUSHBTN, RESIZE_NONE,  COLOUR_GREY,    57,    72,    85,   100, 0x0,    STR_NULL},

   268

{    WWT_PUSHBTN, RESIZE_NONE,  COLOUR_GREY,    75,    90,    85,   100, 0x0,    STR_NULL},

   269

{    WWT_PUSHBTN, RESIZE_NONE,  COLOUR_GREY,    93,   108,    85,   100, 0x0,    STR_NULL},

   270

{    WWT_PUSHBTN, RESIZE_NONE,  COLOUR_GREY,   111,   126,    85,   100, 0x0,    STR_NULL},

   271

{    WWT_PUSHBTN, RESIZE_NONE,  COLOUR_GREY,   129,   144,    85,   100, 0x0,    STR_NULL},

   272

{    WWT_PUSHBTN, RESIZE_NONE,  COLOUR_GREY,   147,   162,    85,   100, 0x0,    STR_NULL},

   273

{    WWT_PUSHBTN, RESIZE_NONE,  COLOUR_GREY,   165,   180,    85,   100, 0x0,    STR_NULL},

   274

{    WWT_PUSHBTN, RESIZE_NONE,  COLOUR_GREY,   183,   198,    85,   100, 0x0,    STR_NULL},

   275

{    WWT_PUSHBTN, RESIZE_NONE,  COLOUR_GREY,   201,   216,    85,   100, 0x0,    STR_NULL},

   276

{    WWT_PUSHBTN, RESIZE_NONE,  COLOUR_GREY,   219,   234,    85,   100, 0x0,    STR_NULL},

   277

{    WWT_PUSHBTN, RESIZE_NONE,  COLOUR_GREY,   237,   252,    85,   100, 0x0,    STR_NULL},

   278

   279

{    WWT_PUSHBTN, RESIZE_NONE,  COLOUR_GREY,    30,    45,   103,   118, 0x0,    STR_NULL},

   280

{    WWT_PUSHBTN, RESIZE_NONE,  COLOUR_GREY,    48,    63,   103,   118, 0x0,    STR_NULL},

   281

{    WWT_PUSHBTN, RESIZE_NONE,  COLOUR_GREY,    66,    81,   103,   118, 0x0,    STR_NULL},

   282

{    WWT_PUSHBTN, RESIZE_NONE,  COLOUR_GREY,    84,    99,   103,   118, 0x0,    STR_NULL},

   283

{    WWT_PUSHBTN, RESIZE_NONE,  COLOUR_GREY,   102,   117,   103,   118, 0x0,    STR_NULL},

   284

{    WWT_PUSHBTN, RESIZE_NONE,  COLOUR_GREY,   120,   135,   103,   118, 0x0,    STR_NULL},

   285

{    WWT_PUSHBTN, RESIZE_NONE,  COLOUR_GREY,   138,   153,   103,   118, 0x0,    STR_NULL},

   286

{    WWT_PUSHBTN, RESIZE_NONE,  COLOUR_GREY,   156,   171,   103,   118, 0x0,    STR_NULL},

   287

{    WWT_PUSHBTN, RESIZE_NONE,  COLOUR_GREY,   174,   189,   103,   118, 0x0,    STR_NULL},

   288

{    WWT_PUSHBTN, RESIZE_NONE,  COLOUR_GREY,   192,   207,   103,   118, 0x0,    STR_NULL},

   289

{    WWT_PUSHBTN, RESIZE_NONE,  COLOUR_GREY,   210,   225,   103,   118, 0x0,    STR_NULL},

   290

{    WWT_PUSHBTN, RESIZE_NONE,  COLOUR_GREY,   228,   243,   103,   118, 0x0,    STR_NULL},

   291

   292

{   WIDGETS_END},

   293

};

   294

   295

static const WindowDesc _osk_desc = {

   296

	WDP_CENTER, WDP_CENTER, 256, 140, 256, 140,

   297

	WC_OSK, WC_NONE,

   298

	WDF_STD_TOOLTIPS | WDF_STD_BTN | WDF_DEF_WIDGET | WDF_UNCLICK_BUTTONS,

   299

	_osk_widgets,

   300

};

   301

   302

/**

   303

 * Retrieve keyboard layout from language string or (if set) config file.

   304

 * Also check for invalid characters.

   305

 */

   306

void GetKeyboardLayout()

   307

{

   308

	char keyboard[2][OSK_KEYBOARD_ENTRIES * 4 + 1];

   309

	char errormark[2][OSK_KEYBOARD_ENTRIES + 1]; // used for marking invalid chars

   310

	bool has_error = false; // true when an invalid char is detected

   311

   312

	if (StrEmpty(_keyboard_opt[0])) {

   313

		GetString(keyboard[0], STR_OSK_KEYBOARD_LAYOUT, lastof(keyboard[0]));

   314

	} else {

   315

		strecpy(keyboard[0], _keyboard_opt[0], lastof(keyboard[0]));

   316

	}

   317

   318

	if (StrEmpty(_keyboard_opt[1])) {

   319

		GetString(keyboard[1], STR_OSK_KEYBOARD_LAYOUT_CAPS, lastof(keyboard[1]));

   320

	} else {

   321

		strecpy(keyboard[1], _keyboard_opt[1], lastof(keyboard[1]));

   322

	}

   323

   324

	for (uint j = 0; j < 2; j++) {

   325

		const char *kbd = keyboard[j];

   326

		bool ended = false;

   327

		for (uint i = 0; i < OSK_KEYBOARD_ENTRIES; i++) {

   328

			_keyboard[j][i] = Utf8Consume(&kbd);

   329

   330

			/* Be lenient when the last characters are missing (is quite normal) */

   331

			if (_keyboard[j][i] == '\0' || ended) {

   332

				ended = true;

   333

				_keyboard[j][i] = ' ';

   334

				continue;

   335

			}

   336

   337

			if (IsPrintable(_keyboard[j][i])) {

   338

				errormark[j][i] = ' ';

   339

			} else {

   340

				has_error = true;

   341

				errormark[j][i] = '^';

   342

				_keyboard[j][i] = ' ';

   343

			}

   344

		}

   345

	}

   346

   347

	if (has_error) {

   348

		ShowInfoF("The keyboard layout you selected contains invalid chars. Please check those chars marked with ^.");

   349

		ShowInfoF("Normal keyboard:  %s", keyboard[0]);

   350

		ShowInfoF("                  %s", errormark[0]);

   351

		ShowInfoF("Caps Lock:        %s", keyboard[1]);

   352

		ShowInfoF("                  %s", errormark[1]);

   353

	}

   354

}

   355

   356

/**

   357

 * Show the on-screen keyboard (osk) associated with a given textbox

   358

 * @param parent pointer to the Window where this keyboard originated from

   359

 * @param q      querystr_d pointer to the query string of the parent, which is

   360

 *               shared for both windows

   361

 * @param button widget number of parent's textbox

   362

 * @param cancel widget number of parent's cancel button (0 if cancel events

   363

 *               should not be passed)

   364

 * @param ok     widget number of parent's ok button  (0 if ok events should not

   365

 *               be passed)

   366

 */

   367

void ShowOnScreenKeyboard(QueryStringBaseWindow *parent, int button, int cancel, int ok)

   368

{

   369

	DeleteWindowById(WC_OSK, 0);

   370

   371

	GetKeyboardLayout();

   372

	new OskWindow(&_osk_desc, parent, button, cancel, ok);

   373

}