// Copyright (c) 1994 - 2026 kio@little-bat.de
// BSD-2-Clause license
// https://opensource.org/licenses/BSD-2-Clause

#pragma once
#include "Item.h"
#include "Keymap.h"
#include "ZxInfo/ZxInfo.h"


//	preferred keyboard translation:	// defined in zxsp_types.h"
//		kbdphys						// prefer physical translation (from scan code)
//		kbdlog						// use logical translation (from character code)


namespace zxsp
{

using AsciiToZxkeyMap = uint8[0x80]; // Unicode     -> enum ZxspKey	(mapping 'by meaning')
using OskeyToZxkeyMap = uint8[0x40]; // OSX keycode -> enum ZxspKey	(mapping 'by key position')


/* ========================================================================
 */
class Keyboard : public Item
{
protected:
	Model model; // emulated specci model
	uint8 csh;	 // scancode of caps shift key
	uint8 ssh;	 // scancode of symbol shift key
	uint8 csh2;
	uint8 ssh2;

	AsciiToZxkeyMap ascii2zxkey_map;
	OskeyToZxkeyMap oskey2zxkey_map;

	// state:
	KeyboardMode mode;		// prefer physical or logical key translation ?
	uint		 modifiers; // modifiers down on realworld keyboard
	uint		 numkeys;	// keys pressed on real and virtual keyboard
	uint8		 zxkeys[16];
	uint8		 oskeys[16];
	uint		 stickykeys;
	Keymap		 keymap; // map of depressed keys as seen by user (incl. compound keys)

public:
	Keymap getKeymap() const volatile { return const_cast<Keymap&>(keymap); }
	void   specciKeyDown(uint8 zxkey); // called from KeyboardInspector
	void   specciKeyUp(uint8 zxkey);   // called from KeyboardInspector

	void realKeyDown(uint16 unicode, uint8 oskeycode, KeyboardModifiers); // called from MachineController
	void realKeyUp(uint16 unicode, uint8 oskeycode, KeyboardModifiers);	  // called from MachineController
	void keyBtZxKbd(uint16 unicode, uint8 oskeycode, KeyboardModifiers);  // handle Recreated ZX Keyboard

	void setKbdMode(KeyboardMode);
	void allKeysUp();

protected:
	Keyboard(Machine*, isa_id, const AsciiToZxkeyMap, const OskeyToZxkeyMap);
	~Keyboard() override = default;

	// Item interface:
	void powerOn(int32 cc) override;

private:
	virtual void convert_to_matrix(Keymap&) {}
	void		 update_keymap();
};


// ==========================================================
//						sub classes
// ==========================================================


class KeyboardZx81 : public Keyboard
{
public:
	// ZX80, ZX81, TS1000, TS1500, TK85
	explicit KeyboardZx81(Machine*, isa_id = isa_KbdZx81);

protected:
	~KeyboardZx81() override = default;
};


class KeyboardZx80 : public KeyboardZx81
{
public:
	explicit KeyboardZx80(Machine*, isa_id = isa_KbdZx80);

protected:
	~KeyboardZx80() override = default;
};


class KeyboardZxsp : public Keyboard
{
public:
	// ZXSP, TK90X, TK95
	explicit KeyboardZxsp(Machine*, isa_id = isa_KbdZxsp);

protected:
	~KeyboardZxsp() override = default;
};


class KeyboardZxPlus : public Keyboard
{
public:
	// ZXPLUS, Inves, ZX128*, ZXPlus2*, ZXPlus2A*, ZXPlus3*
	explicit KeyboardZxPlus(Machine*, isa_id = isa_KbdZxPlus);

protected:
	~KeyboardZxPlus() override = default;

	void convert_to_matrix(Keymap&) override;
};


class KeyboardTimex : public Keyboard
{
public:
	// TS2068, TC2068, u2086, TC2048
	explicit KeyboardTimex(Machine*, isa_id = isa_KbdTimex);

protected:
	~KeyboardTimex() override = default;

	void convert_to_matrix(Keymap&) override;
};


class KeyboardJupiter : public Keyboard
{
public:
	// Jupiter Ace
	explicit KeyboardJupiter(Machine*, isa_id = isa_KbdJupiter);

private:
	~KeyboardJupiter() override = default;

	void convert_to_matrix(Keymap&) override;
};

} // namespace zxsp