Annotation of nono/vm/keyboard.h, revision 1.1.1.10

1.1       root        1: //
                      2: // nono
1.1.1.4   root        3: // Copyright (C) 2020 nono project
                      4: // Licensed under nono-license.txt
1.1       root        5: //
                      6: 
                      7: #pragma once
                      8: 
                      9: #include "device.h"
1.1.1.6   root       10: #include "event.h"
                     11: #include "fixedqueue.h"
                     12: #include <mutex>
1.1       root       13: 
                     14: class Keyboard : public Device
                     15: {
1.1.1.4   root       16:        using inherited = Device;
1.1       root       17:  protected:
                     18:        Keyboard();
                     19:  public:
1.1.1.5   root       20:        virtual ~Keyboard() override;
1.1       root       21: 
1.1.1.6   root       22:        virtual void ResetHard() override;
                     23: 
                     24:        // キーを押した (外部から呼ばれる)
                     25:        void MakeKey(uint keycode);
                     26:        // キーを離した (外部から呼ばれる)
                     27:        void BreakKey(uint keycode);
1.1.1.9   root       28:        // 文字入力によるキーエミュレーション (外部から呼ばれる)
                     29:        void CharInput(uint charcode);
1.1       root       30: 
1.1.1.2   root       31:        // マウス入力
                     32:        // x, y は X, Y の前回からの移動量。
                     33:        // X は画面右に動く方向をプラス、Y は画面下に動く方向をプラスとする。
                     34:        // 移動量が VM で扱える範囲内か、それを越えていたらどうするかは
                     35:        // 継承クラスが処理する。
                     36:        // rb, lb, mb はボタンの状態。true なら押下中。
                     37:        virtual void MouseInput(int x, int y, bool rb, bool lb, bool mb) = 0;
                     38: 
1.1.1.8   root       39:        // マウスデータを VM に送信する MD 処理
                     40:        virtual void MouseSendStart() = 0;
                     41: 
1.1.1.4   root       42:        // ホストからの制御コマンド
                     43:        virtual void Command(uint32 data) = 0;
                     44: 
1.1.1.6   root       45:        // 指定のキーの押し下げ状態取得 (ソフトウェアキーボードなどから)
                     46:        bool IsPressed(uint keycode) const {
                     47:                assert(keycode < pressed.size());
                     48:                return pressed[keycode];
                     49:        }
                     50: 
                     51:        // 全てのキーの押し下げ状態取得 (ソフトウェアキーボードなどから)
                     52:        const std::vector<bool>& GetPressed() const { return pressed; }
                     53: 
1.1.1.4   root       54:        // LED 状態取得 (ソフトウェアキーボードなどから)
                     55:        const std::vector<bool>& GetLED() const { return led; }
                     56: 
1.1.1.6   root       57:        // シフト状態なら true を返す
                     58:        // シフトキーは機種によって処理が異なるため、この関数を使って
                     59:        // 状態を取得すること。
                     60:        virtual bool IsShift() const = 0;
                     61: 
1.1       root       62:        // キー名を返す (主にデバッグ表示用)
1.1.1.7   root       63:        static const std::string GetKeyName(uint code);
1.1       root       64: 
1.1.1.4   root       65:  protected:
1.1.1.6   root       66:        // キーコードには、
                     67:        // o 共通キーコード(コードのみ)、
                     68:        // o 共通キーコード(コードと Make/Break フラグあり)、
                     69:        // o 機種依存キーコード
                     70:        // の3つがあり、どれも uint なので変数名で区別することにする。
                     71:        // o keycode .. 共通キーコード
                     72:        // o keystat .. フラグ付き共通キーコード
                     73:        // o mdkey   .. 機種依存キーコード
                     74: 
                     75:        // 共通キーコードを機種別のキーコードに変換する
                     76:        virtual uint KeyToMDKey(uint keycode) const = 0;
                     77: 
1.1.1.7   root       78:        // キーを1つ処理する
                     79:        virtual void KeyInput(uint keystat) = 0;
                     80: 
                     81:        // キーを処理する (共通部分)
                     82:        bool KeyInputCommon(uint keystat);
1.1.1.6   root       83: 
1.1.1.10! root       84:        // アクティブカウンタを 1 増やす。
        !            85:        // 0 -> 1 の遷移でスケジューラに通知する。
        !            86:        void Acquire();
        !            87: 
        !            88:        // アクティブカウンタを 1 減らす。
        !            89:        // 1 -> 0 の遷移でスケジューラに通知する。
        !            90:        void Release();
        !            91: 
1.1.1.6   root       92:        // キーを VM に送信する MD 処理
                     93:        virtual void SendStart() = 0;
                     94: 
                     95:        // どのキーが押されているか (共通キーコード)
                     96:        std::vector<bool> pressed {};
                     97: 
1.1.1.10! root       98:        // アクティブカウンタ。
        !            99:        // 0 のときは UI と対話していないことを示す。
        !           100:        int active {};
1.1.1.6   root      101: 
                    102:        // ホストから来たキー入力をバッファする。
                    103:        // 実際には固定長でない普通のキューで構わないんだけど、モニタ用に中身を
                    104:        // 覗き見したいとか思うと、ほぼそのための FixedQueue を使うほうがいい。
                    105:        // 固定長である必要はないけど、無限に可変長である必要もないので。
                    106: 
                    107:        // UI からの入力を VM スレッドへ引き渡すためのバッファ。
                    108:        FixedQueue<uint, 8> inputqueue {};
                    109: 
                    110:        // 入力されたキーを VM へ送信するときのバッファ。
                    111:        FixedQueue<uint, 8> sendqueue {};
                    112: 
1.1.1.4   root      113:        // LED (true で点灯)。
                    114:        // GetLED() あたりが同じ形式で済むのでここにあるけど、機種によって
                    115:        // LED 数が違うので、何番がどのキーに対応するかの取り決めや、初期化も
                    116:        // 含めたコードはすべて派生クラス側で用意すること。
                    117:        std::vector<bool> led {};
                    118: 
1.1.1.8   root      119:        // マウス状態
                    120:        int mouse_x {};                 // 前回送信から現在までの積算値
                    121:        int mouse_y {};
                    122:        bool mouse_r {};                // 現在値
                    123:        bool mouse_l {};
                    124:        bool mouse_m {};
                    125:        bool prev_r {};                 // 前回送信時の値
                    126:        bool prev_l {};
                    127:        bool prev_m {};
                    128: 
1.1       root      129:  private:
1.1.1.6   root      130:        // キー入力を VM スレッドで処理するためのイベント
                    131:        void KeyInputCallback(Event& ev);
1.1.1.7   root      132:        Event keyinput_event { this };
1.1.1.6   root      133:        std::mutex mtx {};
                    134: 
1.1       root      135:        static std::vector<const char *> keyname;
1.1.1.9   root      136:        static std::vector<uint> char_key;
1.1       root      137: };
                    138: 
1.1.1.3   root      139: extern std::unique_ptr<Keyboard> gKeyboard;
1.1       root      140: 
1.1.1.10! root      141: // keystat は下位 8bit がキーコード。
        !           142: // 上位(今の所 8bit) は各種フラグ。
        !           143: //
        !           144: //  15  14  13  12  11  10   9   8   7   6   5   4   3   2   1   0
        !           145: // +---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+
        !           146: // |M/B|UI |  LED  |   0   |  KM_* |            Keycode            |
        !           147: // +---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+
        !           148: //   |   |     |               |
        !           149: //   |   |     |               +-- キャラクタ入力でのモディファイヤフラグ
        !           150: //   |   |     +------------------ LUNA の LED キー送信フラグ
        !           151: //   |   +------------------------ char 入力モードでキーコードを UI に通知
        !           152: //   |                             (inputqueue 内で使用する)
        !           153: //   +---------------------------- キーの Make/Break
        !           154: 
        !           155: #define KM_SHIFT                       (0x0100)        // char モードで SHIFT 押下
        !           156: #define KM_CTRL                                (0x0200)        // char モードで CTRL 押下
        !           157: 
        !           158: #define KC_FLAG_LED_MAKE       (0x1000)        // LUNA LED キーの押下を送信
        !           159: #define KC_FLAG_LED_BREAK      (0x2000)        // LUNA LED キーの開放を送信
        !           160: #define KC_FLAG_LED_DROP       (0x3000)        // LUNA LED キーを送信しない
        !           161: 
        !           162: #define KC_FLAG_POST           (0x4000)        // キーコードを UI に通知
        !           163: 
        !           164: #define KC_FLAG_MAKE           (0x0000)        // キー押下 (値は 0 だが便宜上)
        !           165: #define KC_FLAG_BREAK          (0x8000)        // キー開放
        !           166: 
        !           167: // keystat のアクセスマクロ
        !           168: #define KC_CODE(x)             ((x) & 0x00ff)  // keycode を取得
        !           169: #define KC_FLAG_LED(x) ((x) & 0x3000)  // LUNA LED キー動作を取得
        !           170: #define KC_IS_POST(x)  (((x) & KC_FLAG_POST) != 0)             // UI に通知なら true
        !           171: #define KC_IS_MAKE(x)  (((x) & KC_FLAG_BREAK) == 0)    // キー押下なら true
        !           172: #define KC_IS_BREAK(x) (((x) & KC_FLAG_BREAK) != 0)    // キー開放なら true
        !           173: 
1.1       root      174: // 抽象化キーボードレイヤーでのキーコード。
                    175: // wxWidgets で受け取ったキーコードをこれに変換して VM に入力する。
                    176: // VM のキーボードデバイスがこれを当該機種ごとのキーコードなり何なりに
                    177: // 変換して入力する。
                    178: 
                    179: #define KC_none                        (0)
                    180: 
                    181: #define KC_BREAK               (0x01)  // [X68k] BREAK
                    182: #define KC_COPY                        (0x02)  // [X68k] COPY
                    183: #define KC_romaji              (0x03)  // [X68k] ローマ字
                    184: #define KC_code                        (0x04)  // [X68k] コード入力
                    185: #define KC_kigou               (0x05)  // [X68k] 記号入力
                    186: #define KC_touroku             (0x06)  // [X68k] 登録
                    187: #define KC_HELP                        (0x07)  // [X68k] HELP
1.1.1.10! root      188: #define KC_SHIFT               (0x08)  // [X68k] SHIFT (左右の区別なし)
1.1       root      189: #define KC_TAB                 (0x09)
                    190: #define KC_CTRL                        (0x0a)
                    191: #define KC_kana                        (0x0b)  // かな
                    192: #define KC_SHIFT_L             (0x0c)  // SHIFT(左)
                    193: #define KC_SHIFT_R             (0x0d)  // SHIFT(右)
                    194: #define KC_CAPS                        (0x0e)
                    195: #define KC_SF                  (0x0f)  // [LUNA] S.F
                    196: 
                    197: #define KC_ESC                 (0x10)
                    198: #define KC_BS                  (0x11)  // BackSpace
                    199: #define KC_enter               (0x12)  // Enter (Return)
                    200: #define KC_INS                 (0x13)  // [X68k] INS
                    201: #define KC_space               (0x14)
                    202: #define KC_DEL                 (0x15)
                    203: #define KC_XFER                        (0x16)  // [LUNA] XFER
                    204: #define KC_VALID               (0x17)  // [LUNA] VALID
                    205: #define KC_PF11                        (0x18)  // [LUNA] PF11
                    206: #define KC_PF12                        (0x19)  // [LUNA] PF12
                    207: #define KC_PF13                        (0x1a)  // [LUNA] PF13
                    208: #define KC_PF14                        (0x1b)  // [LUNA] PF14
                    209: #define KC_up                  (0x1c)  // cursor up
                    210: #define KC_left                        (0x1d)  // cursor left
                    211: #define KC_right               (0x1e)  // cursor right
                    212: #define KC_down                        (0x1f)  // cursor down
                    213: 
                    214: #define KC_ROLLUP              (0x20)  // [X68k] ROLL UP
                    215: #define KC_ROLLDOWN            (0x21)  // [X68k] ROLL DOWN
                    216: #define KC_1                   (0x22)
                    217: #define KC_2                   (0x23)
                    218: #define KC_3                   (0x24)
                    219: #define KC_4                   (0x25)
                    220: #define KC_5                   (0x26)
                    221: #define KC_6                   (0x27)
                    222: #define KC_7                   (0x28)
                    223: #define KC_8                   (0x29)
                    224: #define KC_9                   (0x2a)
                    225: #define KC_0                   (0x2b)
                    226: #define KC_minus               (0x2c)
                    227: #define KC_circum              (0x2d)  // ^~
                    228: #define KC_backslash   (0x2e)  // \|
                    229: 
                    230: #define KC_OPT1                        (0x30)  // [X68k] OPT.1
                    231: #define KC_OPT2                        (0x31)  // [X68k] OPT.2
                    232: #define KC_Q                   (0x32)
                    233: #define KC_W                   (0x33)
                    234: #define KC_E                   (0x34)
                    235: #define KC_R                   (0x35)
                    236: #define KC_T                   (0x36)
                    237: #define KC_Y                   (0x37)
                    238: #define KC_U                   (0x38)
                    239: #define KC_I                   (0x39)
                    240: #define KC_O                   (0x3a)
                    241: #define KC_P                   (0x3b)
                    242: #define KC_at                  (0x3c)
                    243: #define KC_bracketleft (0x3d)  // '['
                    244: #define KC_hira                        (0x3e)  // [X68k] ひらがな
                    245: #define KC_zenkaku             (0x3f)  // [X68k] 全角
                    246: 
1.1.1.10! root      247: #define KC_HOME                        (0x40)  // [X68k] HOME
        !           248: #define KC_UNDO                        (0x41)  // [X68k] UNDO
1.1       root      249: #define KC_A                   (0x42)
                    250: #define KC_S                   (0x43)
                    251: #define KC_D                   (0x44)
                    252: #define KC_F                   (0x45)
                    253: #define KC_G                   (0x46)
                    254: #define KC_H                   (0x47)
                    255: #define KC_J                   (0x48)
                    256: #define KC_K                   (0x49)
                    257: #define KC_L                   (0x4a)
                    258: #define KC_semicolon   (0x4b)
                    259: #define KC_colon               (0x4c)
                    260: #define KC_bracketright        (0x4d)  // ']'
                    261: 
1.1.1.10! root      262: #define KC_XF1                 (0x50)  // [X68k] XF1
        !           263: #define KC_XF2                 (0x51)  // [X68k] XF2
1.1       root      264: #define KC_Z                   (0x52)
                    265: #define KC_X                   (0x53)
                    266: #define KC_C                   (0x54)
                    267: #define KC_V                   (0x55)
                    268: #define KC_B                   (0x56)
                    269: #define KC_N                   (0x57)
                    270: #define KC_M                   (0x58)
                    271: #define KC_comma               (0x59)
                    272: #define KC_period              (0x5a)
                    273: #define KC_slash               (0x5b)
                    274: #define KC_underscore  (0x5c)
1.1.1.10! root      275: #define KC_XF3                 (0x5d)  // [X68k] XF3
        !           276: #define KC_XF4                 (0x5e)  // [X68k] XF4
        !           277: #define KC_XF5                 (0x5f)  // [X68k] XF5
1.1       root      278: 
                    279: #define KC_PAD_plus            (0x61)
                    280: #define KC_PAD_minus   (0x62)
                    281: #define KC_PAD_7               (0x63)
                    282: #define KC_PAD_8               (0x64)
                    283: #define KC_PAD_9               (0x65)
                    284: #define KC_PAD_4               (0x66)
                    285: #define KC_PAD_5               (0x67)
                    286: #define KC_PAD_6               (0x68)
                    287: #define KC_PAD_1               (0x69)
                    288: #define KC_PAD_2               (0x6a)
                    289: #define KC_PAD_3               (0x6b)
                    290: #define KC_PAD_0               (0x6c)
                    291: #define KC_PAD_decimal (0x6d)  // .
                    292: #define KC_PAD_enter   (0x6e)
                    293: #define KC_PAD_CLR             (0x6f)  // [X68k] CLR
                    294: 
                    295: #define KC_F1                  (0x72)
                    296: #define KC_F2                  (0x73)
                    297: #define KC_F3                  (0x74)
                    298: #define KC_F4                  (0x75)
                    299: #define KC_F5                  (0x76)
                    300: #define KC_F6                  (0x77)
                    301: #define KC_F7                  (0x78)
                    302: #define KC_F8                  (0x79)
                    303: #define KC_F9                  (0x7a)
                    304: #define KC_F10                 (0x7b)
                    305: #define KC_PAD_multiply        (0x7c)
                    306: #define KC_PAD_divide  (0x7d)
                    307: #define KC_PAD_equal   (0x7e)
                    308: #define KC_PAD_comma   (0x7f)
                    309: 
1.1.1.10! root      310: #define KC_max                 (0x80)
1.1.1.9   root      311: 
                    312: // 文字入力モードの拡張部分
                    313: #define CC_NUL                 (0x80)  // NUL (Ctrl + @)
                    314: #define CC_F1                  (0x81)
                    315: #define CC_F2                  (0x82)
                    316: #define CC_F3                  (0x83)
                    317: #define CC_F4                  (0x84)
                    318: #define CC_F5                  (0x85)
                    319: #define CC_F6                  (0x86)
                    320: #define CC_F7                  (0x87)
                    321: #define CC_F8                  (0x88)
                    322: #define CC_F9                  (0x89)
                    323: #define CC_F10                 (0x8a)
                    324: 
                    325: #define CC_up                  (0x8c)
                    326: #define CC_left                        (0x8d)
                    327: #define CC_right               (0x8e)
                    328: #define CC_down                        (0x8f)

unix.superglobalmegacorp.com

This archive runs on limited infrastructure. Preserving old code on modern bandwidth. Automated agents are requested to crawl responsibly.