NSEvent – AppleScriptの穴

Modifier Keyのリアルタイムキースキャンを行なって、CotEditor書類上に文字でカーソル描画するAppleScriptです。30 x 30 の文字数のテキストを作成し、CotEditor書類に随時転送することで書き換えています。

AppleScriptでキースキャンといえば、Script/Applet起動時にoptionやcontrolなどのmodifier keys（装飾キー）が押されているかどうかを確認して、動作内容を変更するような用途でした。AppleScriptでGUIを作るのが大変だとか、AppleScriptで気軽にGUIを呼び出せない時代には、割と使われてきた手段です。

そんな中、macOS 10.10以降でCocoaの機能が気軽に利用できるようになってきたことで、Cocoaのキースキャン機能が利用できるようになりました。前述のModifier KeysのスキャンはmacOS側のセキュリティ機構でも問題視していないようで、気軽に使えそうです。ちなみに、SHIFTキーの左右は区別できません。

先日Pixelmator Proで「もぐら叩きゲーム」を作った際にも、このModifier Keysのスキャンは利用しましたが、実際にどの程度使い物になるのか確認しておきたいと考え、AppleScriptからの操作が高速なアプリケーションで試してみることにしてみました。

CotEditorにテキストで描画した画面を転送し、毎回テキスト内容をすべて書き換えることで本格的なゲームの用途に使えるのではないかと考えました。自分ではほとんどゲームを作ったこともないので、別にゲームを量産するつもりはありませんが……。テトリスぐらいならCotEditorのメニューから呼び出すAppleScript内で実行できそうな感じがします。

→ 冗談半分でAppleScriptで作られたTetrisを探してみたら、見つかりました

CotEditorでなくても、他のエディタでも同様の操作はできると思います。

AppleScript名：KeyScan TEST v3.scpt

—
–　　Created by: Takaaki Naganoya
–　　Created on: 2020/10/03
—
–　　Copyright © 2020 Piyomaru Software, All Rights Reserved
—
use AppleScript version "2.4" — Yosemite (10.10) or later
use framework "Foundation"
use framework "AppKit" — for NSEvent
use scripting additions

–Initialize
set curPosX to 1
set curPosY to 1
set curMax to 30

set rText to ""
repeat curMax times
　　set rText to rText & "🛑"
end repeat

tell application "CotEditor"
　　write to console "Real-time Keyscan test with Modifier Keys
　　[ Control ]　　　　: Move Left
　　[ Shift ]　　　　: Move Right
　　[ Option ]　　　　: Move Up
　　[ Command ]　　: Move Down

　　[ Caps Lock ]　　: Quit this script"
　　
　　make new document
　　activate
end tell

–Main Loop
repeat
　　set leftF to my checkModifier:"control"
　　set rightF to my checkModifier:"shift"
　　set upF to my checkModifier:"option"
　　set downF to my checkModifier:"command"
　　
　　set quitF to my checkModifier:"caps"
　　
　　if quitF = true then return
　　
　　if leftF = true then
　　　　if curPosX > 1 then
　　　　　　set curPosX to curPosX – 1
　　　　end if
　　else if rightF = true then
　　　　if curPosX ≤ curMax then
　　　　　　set curPosX to curPosX + 1
　　　　end if
　　end if
　　
　　if upF = true then
　　　　if curPosY > 1 then
　　　　　　set curPosY to curPosY – 1
　　　　end if
　　else if downF = true then
　　　　if curPosY < curMax then
　　　　　　set curPosY to curPosY + 1
　　　　end if
　　end if
　　
　　
　　–make display text
　　set aText to ""
　　repeat with i from 1 to curMax + 1
　　　　if i = curPosX then
　　　　　　set aText to aText & "🛑"
　　　　else
　　　　　　set aText to aText & "㍳"
　　　　end if
　　end repeat
　　
　　
　　set bText to ""
　　repeat with y from 1 to curMax
　　　　if y = curPosY then
　　　　　　set bText to bText & rText & return
　　　　else
　　　　　　set bText to bText & aText & return
　　　　end if
　　end repeat
　　
　　my displayText(bText)
　　
end repeat

–テキスト画面描画
on displayText(aText)
　　tell application "CotEditor"
　　　　tell front document
　　　　　　set contents to aText
　　　　end tell
　　end tell
end displayText

–複数同時検出に対応
on checkModifier:keyName
　　if keyName = "option" then
　　　　set theMask to current application’s NSAlternateKeyMask as integer
　　else if keyName = "control" then
　　　　set theMask to current application’s NSControlKeyMask as integer
　　else if keyName = "command" then
　　　　set theMask to current application’s NSCommandKeyMask as integer
　　else if keyName = "shift" then
　　　　set theMask to current application’s NSShiftKeyMask as integer
　　else if keyName = "caps" then
　　　　set theMask to current application’s NSEventModifierFlagCapsLock as integer
　　else if keyName = "num" then
　　　　set theMask to current application’s NSEventModifierFlagNumericPad as integer
　　else if keyName = "help" then
　　　　set theMask to current application’s NSEventModifierFlagHelp as integer
　　else if keyName = "fn" then
　　　　set theMask to current application’s NSEventModifierFlagFunction as integer
　　else
　　　　return false
　　end if
　　
　　set theFlag to current application’s NSEvent’s modifierFlags() as integer
　　if ((theFlag div theMask) mod 2) = 0 then
　　　　return false
　　else
　　　　return true
　　end if
end checkModifier:

★Click Here to Open This Script　

Xcode上で作成するAppleScript Cocoa Applicationで、キースキャンを試してみました。

ふだん作っているものだと、各種パラメータをGUI上で設定する程度のもので、キースキャンを行う必要などこれっぽっちもないのですが、いま作っているアプリケーションでキースキャンが必要になってしまったので、昔作ったものを引っ張り出してきました。

AppleScriptのプログラムでキースキャンを行うといえば、AppleScript Appletの起動時に何らかのModifier Keys（ShiftとかOptionとかCommandとかControlとか）が押されていることを検出して動作を変更するといった処理が一般的です。ループ処理中でも、これらのキー入力を定期的に監視することはよく行なっています（処理中に停止したいという要求はあるので）。

–> Watch Demo Movie

–> Download Xcode Project Archive

本プログラムでは、Modifier Keysにかぎらずキーボード入力全般を受け付けています。ただし、キースキャン可能なのは本プログラムが最前面にある場合のみです。

掲載しているコードからではわかりませんが、キー入力の受け付けをNSWindowで行なっています。FirstResponderまわりを一切いじくらずにほぼプログラミングなしでキー受け付けを行おうとした結果NSWindowで行うことになったというわけで、これがベストとも思いません。

とりあえず「こうすればできた」というレベルをおさえておいて、そこから自分の好きな方向に機能を変更していけばよいと思います。

AppleScript名：AppDelegate.applescript

script AppDelegate
　　property parent : class "NSObject"
　　
　　— IBOutlets
　　property theWindow : missing value
　　property aButton : missing value
　　
　　property xMax : 500
　　property yMax : 500
　　
　　property aStep : 50
　　
　　on applicationWillFinishLaunching:aNotification
　　　　—
　　end applicationWillFinishLaunching:
　　
　　on applicationShouldTerminate:sender
　　　　return current application’s NSTerminateNow
　　end applicationShouldTerminate:
　　
　　
　　on buttonMove:(aCode as integer)
　　　　set curFrame to aButton’s frame()
　　　　copy curFrame to {{x, y}, {xWidth, yHeight}}
　　　　
　　　　if aCode = 123 then
　　　　　　–Left
　　　　　　if x > 0 then
　　　　　　　　set x to x – aStep
　　　　　　end if
　　　　else if aCode = 124 then
　　　　　　–Right
　　　　　　if x < xMax then
　　　　　　　　set x to x + aStep
　　　　　　end if
　　　　　　
　　　　else if aCode = 126 then
　　　　　　–Up
　　　　　　if y < yMax then
　　　　　　　　set y to y + aStep
　　　　　　end if
　　　　　　
　　　　else if aCode = 125 then
　　　　　　–Down
　　　　　　if y > 10 then
　　　　　　　　set y to y – aStep
　　　　　　end if
　　　　else if aCode = 125 then
　　　　　　
　　　　end if
　　　　
　　　　set newRect to {{x, y}, {xWidth, yHeight}}
　　　　aButton’s setFrame:newRect
　　　　aButton’s setNeedsDisplay()
　　end buttonMove:
end script

★Click Here to Open This Script　

AppleScript名：keyEventWin.applescript

script keyEvWin
　　
　　property parent : class "NSWindow"
　　
　　property aButton : missing value
　　
　　
　　on canBecomeKeyWindow:sender
　　　　return true
　　end canBecomeKeyWindow:
　　
　　on canBecomeMainWindow:sender
　　　　return true
　　end canBecomeMainWindow:
　　
　　
　　on keyDown:theEvent
　　　　set aCode to (theEvent’s keyCode) as integer
　　　　
　　　　if aCode = 123 then
　　　　　　–左
　　　　　　current application’s NSApp’s delegate()’s performSelector:"buttonMove:" withObject:(aCode)
　　　　　　
　　　　else if aCode = 124 then
　　　　　　–右
　　　　　　current application’s NSApp’s delegate()’s performSelector:"buttonMove:" withObject:(aCode)
　　　　　　
　　　　else if aCode = 126 then
　　　　　　–上
　　　　　　current application’s NSApp’s delegate()’s performSelector:"buttonMove:" withObject:(aCode)
　　　　　　
　　　　else if aCode = 125 then
　　　　　　–下
　　　　　　current application’s NSApp’s delegate()’s performSelector:"buttonMove:" withObject:(aCode)
　　　　　　
　　　　end if
　　　　
　　　　
　　end keyDown:
　　
end script

★Click Here to Open This Script　

AppleScriptの穴

Useful & Practical AppleScript archive. Click '★Click Here to Open This Script' Link to download each AppleScript

タグ: NSEvent

AppleScriptでリアルタイムキースキャンを行いCotEditor書類上にカーソル描画

AppleScriptでキースキャン