Rust winapi

RustからWindowsAPIを叩いてデバイスコンテキストを使ってみる

RustからWindowsAPIを叩いてGUI（というかデバイスコンテキストを使った画面描画）をやってみた。
使ったクレートはwinapiの0.3.9と、乱数生成のためにrandの0.8.4。
CでAPIを叩くときと同じく、CreateWindow関数でウィンドウを生成し、GetMessageまたはPeekMessage関数でメッセージを取得、DispatchMessage関数でウィンドウプロシージャへメッセージを送出、ウィンドウプロシージャでメッセージを受け取って処理を振り分けるという記述になる。

1. プロジェクトを作成したいフォルダへ移動して cargo new する

例）D:\Rust\ にプロジェクトを作成する場合
1. コマンドプロンプトを起動
2. 「D:」（エンター）
3. 「cd \Rust」（エンター）
4. 「cargo new winapi」（エンター）
5. 「cd winapi」（エンター）
6. 「cargo run」（エンター）
7. 「Hello World」が出てきたらOK
8. コマンドプロンプトは閉じずにそのままにしておく

2. プロジェクトフォルダ内の Cargo.toml の [dependencies] 以下を編集する。

[dependencies]
winapi = { version = "0.3.9", features = ["winuser"] }
rand = "0.8.4"

※バージョン情報はコマンドプロンプトで「cargo search winapi」「cargo search rand」とすると各々確認できる。

3. srcフォルダ内の「main.rs」を編集する。

#![windows_subsystem = "windows"]
use std::thread;
use std::time;
use winapi::shared::windef::*;
use winapi::shared::minwindef::*;
use winapi::um::winuser::*;
use winapi::um::winnt::*;
use winapi::um::wingdi::*;
use rand::Rng;

pub unsafe extern "system" fn wnd_proc(hwnd: HWND, msg: UINT, wparam: WPARAM, lparam: LPARAM) -> LRESULT {
    /*
     * ウィンドウプロシージャ
     */
    match msg {
        WM_CREATE => {
            0 // 自分で処理をしたときは 0 を返す
        }
        WM_DESTROY => {
            PostQuitMessage(0); // ウィンドウが破棄（終了）されたときの後始末
            0
        }
        WM_SIZE => {
            0
        }
        WM_KEYDOWN => {
            0
        }
        WM_LBUTTONDOWN => {
            0
        }
        _ => {
            DefWindowProcW(hwnd, msg, wparam, lparam) // システムに処理を任せるときはこれを返す
        }
    }
}

fn to_utf16(s: &str) -> Vec<u16> {
    /*
     * u8 → u16 変換
     */
    let su = s.encode_utf16();
    su.chain(Some(0)).collect()
}

fn main() {
    let sltime = time::Duration::from_millis(30); // ウェイト用の時間（msec）
    let mut rnd = rand::thread_rng();

    unsafe {
        /*
         * ウィンドウクラス構造体
         */
        let wc = WNDCLASSW {
            style: 0,
            lpfnWndProc: Some(wnd_proc), 
            cbClsExtra: 0,
            cbWndExtra: 0,
            hInstance: 0 as HINSTANCE,
            hIcon: LoadIconW(0 as HINSTANCE, IDI_APPLICATION),
            hCursor: LoadCursorW(0 as HINSTANCE, IDI_APPLICATION),
            hbrBackground: COLOR_WINDOWTEXT as HBRUSH,
            lpszMenuName: 0 as LPCWSTR,
            lpszClassName: to_utf16("label").as_ptr(),
        };

        RegisterClassW(&wc); // ウィンドウクラスを登録

        /*
         * ウィンドウ作成（まだ表示はしていない）
         */
        let dispx = GetSystemMetrics(SM_CXSCREEN); // デスクトップの幅
        let dispy = GetSystemMetrics(SM_CYSCREEN); // デスクトップの高さ
        let hwindow = CreateWindowExW(
            0,
            to_utf16("label").as_ptr(), 
            to_utf16("Counter and Lines").as_ptr(),
            WS_OVERLAPPEDWINDOW,
            0, 0, dispx, dispy, 0 as HWND, 0 as HMENU,
            0 as HINSTANCE, std::ptr::null_mut());

        /*
         * メッセージ格納構造体
         */
        let mut msg = MSG {
            hwnd: 0 as HWND,
            message: 0 as UINT,
            wParam: 0 as WPARAM,
            lParam: 0 as LPARAM,
            time: 0 as DWORD,
            pt: POINT { x: 0, y: 0 }, 
        };

        /*
         * デバイスコンテキスト作成
         */
        let hdcf = GetDC(hwindow) as HDC; // 表画面
        SetBkMode(hdcf, OPAQUE as i32); // 背景塗りつぶしモード
        let hdc = CreateCompatibleDC(hdcf) as HDC; // 裏画面（表画面互換）
        SetBkMode(hdc, TRANSPARENT as i32); // 背景透過モード

        /*
         * 裏画面のサイズを表画面に合わせる
         */
        let mut rect = RECT { left: 0, top: 0, right: 0, bottom: 0 };
        GetClientRect(hwindow, &mut rect); // ウィンドウの左上座標と右下座標が rect 構造体に入る
        let hbm = CreateCompatibleBitmap(hdcf, rect.right, rect.bottom) as HANDLE; // 表画面と同じのサイズ・カラーモードのハンドルを作成
        SelectObject(hdc, hbm); // 裏画面を表画面と同じサイズ・カラーモードにする

        /*
         * 文字色
         */
        SetTextColor(hdc, RGB(180, 180, 255)); // テキスト色
        SetBkColor(hdc, RGB(0 , 0 , 0)); // 背景色

        /*
         * フォント
         */
        let font_size = 100;
        let hfnt = CreateFontW(
            font_size, 0, // 高さ, 幅
            0, 0, 800, // 傾き(反時計回り), 文字の向き, 太さ(0～1000)
            1, 0, 0, // Italic, 下線, 打消し線
            SHIFTJIS_CHARSET, OUT_DEFAULT_PRECIS, // キャラクタセット, 物理フォントの検索方法
            CLIP_DEFAULT_PRECIS, DEFAULT_QUALITY, // クリッピング処理, 属性
            VARIABLE_PITCH | FF_ROMAN, 0 as *const u16 // ピッチ＆ファミリ, タイプフェイスのポインタ
        ) as HANDLE;
        SelectObject(hdc, hfnt);

        /*
         * ペンとかブラシとか
         */
        let brs_cls = CreateSolidBrush(RGB(0, 0, 0)) as HANDLE; // ブラシを作成
        let pen_line = CreatePen(PS_SOLID as i32, 1, RGB(80, 220, 150)) as HANDLE; // ペンを作成
        SelectObject(hdc, brs_cls); // ブラシを選択
        SelectObject(hdc, pen_line); // ペンを選択

        /*
         * 変数
         */
        let wid = 800; // ウィンドウ横幅
        let hei = 600; // ウィンドウ高さ
        let posx = 16; // X座標
        let posy = 16; // Y座標

        const MAX_LINES: usize = 100; // 線の本数
        let mut chx: [i32; MAX_LINES] = [wid / 2; MAX_LINES];
        let mut chy: [i32; MAX_LINES] = [hei / 2; MAX_LINES];
        let mut acx: [i32; MAX_LINES] = [0; MAX_LINES];
        let mut acy: [i32; MAX_LINES] = [0; MAX_LINES];
        for i in 0..MAX_LINES {
            while acx[i] == 0 || acy[i] == 0 {
                acx[i] = rnd.gen::<i32>() % 6;
                acy[i] = rnd.gen::<i32>() % 6;
            }
        }

        let lp_max = 999999; // ループ回数

        /*
         * ウィンドウ表示
         */
        MoveWindow(hwindow, posx, posy, wid, hei, 1); // ウィンドウをリサイズ
        ShowWindow(hwindow, SW_SHOW); // ウィンドウを表示

        /*
         * メインループ
         */
        for lpc in 0..lp_max {
            let ret = PeekMessageW(&mut msg, 0 as HWND, 0, 0, PM_REMOVE);
            if ret != 0  { // メッセージがあった場合
                if msg.message == WM_QUIT {
                    break; // アプリケーション終了
                }
                TranslateMessage(&mut msg);
                DispatchMessageW(&mut msg);
            } else { // デッドタイムの場合
                /*
                 * 線を移動
                 */
                for i in 0..MAX_LINES  {
                    chx[i] += acx[i];
                    chy[i] += acy[i];
                    if chx[i] <= 0 {
                        acx[i] = (rnd.gen::<i32>() % 6 + 1).abs();
                        chx[i] = 0;
                    } else if chx[i] >= rect.right {
                        acx[i] = -(rnd.gen::<i32>() % 6 + 1).abs();
                        chx[i] = rect.right;
                    }
                    if chy[i] <= 0 {
                        acy[i] = (rnd.gen::<i32>() % 6 + 1).abs();
                        chy[i] = 0;
                    } else if chy[i] >= rect.bottom {
                        acy[i] = -(rnd.gen::<i32>() % 6 + 1).abs();
                        chy[i] = rect.bottom;
                    }
                }

                /*
                 * 裏画面を消去
                 */
                GetClientRect(hwindow, &mut rect); // ウィンドウの左上座標と右下座標が rect 構造体に入る
                Rectangle(hdc, 0, 0, rect.right, rect.bottom); // 選択したブラシで矩形描画

                /*
                 * 線を描画
                 */
                MoveToEx(hdc, chx[0], chy[0], 0 as *mut winapi::shared::windef::POINT); // カレントポジションをセット
                for i in 1..MAX_LINES {
                    LineTo(hdc, chx[i], chy[i]); // カレントポジションから線を引く
                }
                LineTo(hdc, chx[0], chy[0]);

                /*
                 * カウンタ表示
                 */
                let cnts = lpc.to_string();
                let cnt = to_utf16(&cnts);
                let cnt_len = cnt.len() as i32 - 1;
                TextOutW(hdc, 8, 8, cnt.as_ptr(), cnt_len);

                /*
                 * 裏→表転送
                 */
                BitBlt(hdcf, 0, 0, rect.right, rect.bottom, hdc, 0, 0, SRCCOPY);

                thread::sleep(sltime); // ウェイト
            }
        }

        /*
         * 後始末
         */
        DeleteObject(hbm);
        DeleteObject(hfnt);
        DeleteObject(pen_line);
        DeleteObject(brs_cls);
        DeleteDC(hdc);
        ReleaseDC(hwindow, hdcf);

    } // unsafe
}

4. cargo run する

1. コマンドプロンプトで「cargo run」（エンター）

「これは本当にRustか」と疑うほどに、CでWindowsAPIを叩いているかのような見た目だ。
関数名も型名も windows.h ほぼそのままの、Cでよく見てきたマイクロソフト記述なので、ぱっと見は本当にCでAPIを叩いている感じがする。
ところどころ、型名がむき出しになっている箇所（*mut winapi::shared::windef::POINT など）があるのはコンパイラがそう書きなさいと言ってきたのでそのまま書いたものだ。

Cと比べてRustならではの点は以下のような感じ。

ウィンドウクラスやメッセージ、RECT構造体などの宣言をするときに必ず全フィールドの初期値を書かなくてはならない
リテラルの 0 を「as HWND」などとして関数が求める型にキャストしなくてはならない
API関数の戻り値も「as HANDLE」などとしてキャストしなくてはならない。
VC++やMinGWなら「TEXT("...")」とすればコンパイラが必要に応じて適切にUTF-16変換などをしてくれるが、Rustは自前で変換関数を用意する必要がある
UTF-16に変換した文字列（Vec<u16>）を生ポインタに変換して変数に保持させると、Rustのライフタイム云々で消滅してしまうので、生ポインタが必要になる都度as_ptr()する必要がある

結構ハマったのが、GetClientRect()関数でRECT構造体に現在のウィンドウサイズを取得する箇所だ。
Cだとここは &rect として構造体のポインタを渡すところなので、「let mut rect = RECT {...} 」とした上で「&rect」をGetClientRectに渡したのだが、「types differ in mutability」エラーが出てしまう。
変数をミュータブルにしているのに「ミュータブルにしろ」とコンパイラが言ってくるのだ。
結局参照ミュータブルで「&mut rect」としてGetClientRectに渡すとうまくいった。
ミュータブル借用で渡す場合は変数をmutした上で渡す時にも&mutしてあげないといけないというRustの基本で躓いていたわけだが、Cに慣れきった頭ではここにたどり着くのに随分時間を要した。
Rustはこのミュータブル回りが結構難しいというかややこしい。（見慣れたAPI関数なのも要因かも）

また上にも書いたのだが、APIに渡す文字列への生ポインタやウィンドウクラス構造体に格納する生ポインタ（*const u16）を予め変数に代入しておくことができない。
Cだとリテラルの文字列は静的領域に置かれるのでプログラム終了まで生き続けるのだが、Rustは「ライフタイム」があるため消滅してしまうのだ。
Rustの文字列はCで言うところの unsigned char[] だと思ったほうが良いかもしれない。
関数に渡したり構造体のフィールド値として記述するその都度、as_ptr()メソッドで毎回生ポインタ化するとうまくいく。

あとRustはとにかく型に厳しい。
Cに慣れた頭でなんとなく「0」と書こうものなら、即座に「これは何型の0だ？求めている0と違うぞ」となる。
ただ、これだけ厳しいと「うっかりバグ」というものは本当に駆逐できるだろうなと思う。
Rustを書いているとCが緩々な言語に思えてくる。（実際緩々だけども）

マイクロソフトがRustからWindowsAPIを叩くためのクレートを公開するらしいので、これならもっと簡単に（Rustっぽく）APIを叩くことができそう。

[ 戻る ]