Spec2入門(その3)

これはSmalltalk Advent Calendar 2019の記事です。

Spec2は、Pharo Smalltalk で採用されているUIフレームワークであるSpec の新しいバージョンです。Pharo 7.0 では Spec が使われていましたが、Pharo 8 では(ほぼ?)全てのUIが Spec2 で書き直されるようです。この記事では Spec2 を使った UI の実装方法について簡単に紹介します。

Squeak/Pharo Smalltalk では、UIの実現のために長らく Morphic を用いてきました。Morphic はシンプルで強力なフレームワークですが、複数のコンポーネントを組み合わせていくとアナーキーな実装をしがちで、リファクタリングや再利用の際に泣きたくなるような状況に陥りがちです。Spec/Spec2 はUIの構築に秩序をもたらし、コンポーネントの再利用がしやすく設計されています。

前回の記事ではボタンへのアイコン追加やウィンドウタイトルの設定方法について紹介しました。今回からはもう少し実用的なUI構築に向けて舵を切り直します。ただし、例によって内容は小出しにしていきます。


今回からファイル選択ダイアログを作っていこうと思います。とりあげた理由は、オレオレプロジェクトで取り組んでいるScratch 1.4風アプリに必要だからです。ちなみにScratch 1.4のファイル選択ダイアログは以下のようなものです。

左側にショートカットボタン、中央にファイル一覧があり、右側にファイルの概要が表示されるというものです。そっくり同じというわけでなくとも、Spec2を使って似たようなものを作ろうと思います。

メイン部のウィジェットを作る

中央に表示されるファイルファイル一覧のウィジェットから手を付けることにします。まずはファイルの一覧が表示されるようにしましょう。メイン部のクラス SpecFileListSample を登録します。

SpPresenter subclass: #SpecFileListSample
     instanceVariableNames: 'directory listEntries '
     classVariableNames: ''
     package: 'SpecSample'

directory は表示するディレクトリ(FileReferenceオブジェクト)を保持します。listEntries はファイルの一覧(Arrayオブジェクト)を保持します。

次に、initialize メソッドで directoryを初期化します。とりあえずPharoイメージのあるディレクトリにしておきます。

initialize
     directory := FileSystem workingDirectory.
     super initialize

メイン部にはファイル一覧を表示したいので、リストウィジェットが表示されるように initializePresenters メソッドを作ります。

initializePresenters
     listEntries := self newList.
     self focusOrder
         add: listEntries

さらに defaultSpec クラスメソッドでレイアウトを設定します。

defaultSpec
     ^ SpBoxLayout newVertical
         add: #listEntries;
         yourself

これでウィジェットの骨格ができました。実際に試してみましょう。

SpecFileListSample new openWithSpec.

ファイル一覧を表示する

リストウィジェットにファイルの一覧を表示させることにします。まず、directory が示すディレクトリ内のファイル一覧を取り出すメソッド getEntries を作ります。

getEntries
     ^ directory entries

リストウィジェットで項目を表示するためのメソッド showEntry: を作ります。項目がディレクトリなら両側をカッコで囲むようにしています。

showEntry: aFileReference
     | base |
     base := aFileReference basename.
     ^ aFileReference isDirectory
         ifTrue: [ '<' , base , '>' ]
         ifFalse: [ base ]

太字部分のように initializePresenters を修正して、ファイル一覧を設定します。

initializePresenters
     listEntries := self newList.
     listEntries items: self getEntries.
     self focusOrder
         add: listEntries

最後に connectPresenters で、設定された一覧を表示するように、リストウィジェットにブロック引数を付けて display: メッセージを送ります。

connectPresenters
     listEntries
         display: [ :m | self showEntry: m ]

これでファイル一覧が表示されました。

Spec2入門(その2)

これはSmalltalk Advent Calendar 2019の記事です。

Spec2は、Pharo Smalltalk で採用されているUIフレームワークであるSpec の新しいバージョンです。Pharo 7.0 では Spec が使われていましたが、Pharo 8 では(ほぼ?)全てのUIが Spec2 で書き直されるようです。この記事では Spec2 を使った UI の実装方法について簡単に紹介します。

Squeak/Pharo Smalltalk では、UIの実現のために長らく Morphic を用いてきました。Morphic はシンプルで強力なフレームワークですが、複数のコンポーネントを組み合わせていくとアナーキーな実装をしがちで、リファクタリングや再利用の際に泣きたくなるような状況に陥りがちです。Spec/Spec2 はUIの構築に秩序をもたらし、コンポーネントの再利用がしやすく設計されています。

前回の記事ではSpec2を用いた簡単なUIの作成方法について紹介しました。今回は前回のUIに対して若干の拡張を行います。今年の Advent Calendar は記事の集まりが悪いので、小出しにしていきます。


前回作成したのは簡単なカウンターで、ボタンを押すと数値が増減する以下のようなものです。さすがに見栄えが悪いので何とかします。

ボタンにアイコンを付ける

UpとDownのボタンに、それぞれ上下の矢印アイコンを付けましょう。アイコンは、 Smalltalk ui icons から適当なものを使うことにします。

ボタンの装飾などは initializePresenters でボタン生成時に行います。SpecSample の initializePresenters でボタンにラベルを設定していた2行を以下のように変更します。

buttonUp
    label: 'Up';
    icon: (Smalltalk ui icons iconNamed: #up).
buttonDown
    label: 'Down';
    icon: (Smalltalk ui icons iconNamed: #down).

ラベルと同様にシンプルなキーワードメッセージ式でアイコン(Formのインスタンス)を設定します。以下の式を Do it して表示してみましょう。

SpecSample new openWithSpec.

ボタンのラベルの左側にアイコンが表示されました。

ウィンドウタイトルを付ける

Untitled Window のままのウィンドウタイトルを別のものにします。Spec2 のウィジェットは別のウィジェットに自由に組み込めるため、initializePresenters や connectPresenters などのタイミングでは、ウィンドウタイトルを指定できません。

その代わり、ウィンドウフレームに組み込まれた時に送られるメッセージを捕まえて、そのタイミングでウィンドウタイトルを設定します。そのためのメソッドが initializeWindow: です。以下のように使います。

initializeWindow: aWindow
aWindow title: 'Spec Sample'

上のコードによって Spec Sample というウィンドウタイトルが設定されます。

なお、ボタン押下時などウィジェットが表示されている状態でウィンドウタイトルを変更する場合には、 self window title: ‘sample’ のようなメッセージを送ることで動的にタイトルを変更できます。

情報を小出しにする関係で、今回の記事内容は以上です。あしからず。

Spec2入門(その1)

これはSmalltalk Advent Calendar 2019の記事です。

Spec2は、Pharo Smalltalk で採用されているUIフレームワークであるSpec の新しいバージョンです。Pharo 7.0 では Spec が使われていましたが、Pharo 8 では(ほぼ?)全てのUIが Spec2 で書き直されるようです。この記事では Spec2 を使った UI の実装方法について簡単に紹介します。

Squeak/Pharo Smalltalk では、UIの実現のために長らく Morphic を用いてきました。Morphic はシンプルで強力なフレームワークですが、複数のコンポーネントを組み合わせていくとアナーキーな実装をしがちで、リファクタリングや再利用の際に泣きたくなるような状況に陥りがちです。Spec/Spec2 はUIの構築に秩序をもたらし、コンポーネントの再利用がしやすく設計されています。では、能書きはこれまでにして、具体的に Spec2 を用いた UIの実装方法を紹介しましょう。


Presenterの作成

Spec/Spec2 はVisual WorksやDolphin Smalltalk で用いられているMVP(Model View Presenter)パターンの影響を受けています。主要なUIコンポーネントを Presenterと呼んでおり、UIにおけるロジックに加えて、アプリケーションドメインとウィジェットとの連携を管理します。

Spec2ではウィジェットである Presenter を作成するのに、SpPresenter クラスを継承したクラスを作成します。Spec2に関連する全てのクラスは Sp という接頭辞が付いています。現状のPharo 8.0は Spec(1.0) と Spec2 が混在しているため、Spec2 でUIを実現するのであれば、Sp接頭辞の付いたクラスだけを用いる必要があります。

SpPresenter を継承したクラスでは、そのクラスが管理する子ウィジェットをインスタンス変数で管理します。例として、2つのボタンと1つのラベルを持つウィジェット SpecSample を作成してみましょう。

SpPresenter subclass: #SpecSample
    instanceVariableNames: 'buttonUp buttonDown labelCounter counter'
    classVariableNames: ''
    package: 'SpecSample'

ウィジェットとなるのは buttonUp と buttonDown、そしてlabelCounterです。上下ボタンを押すとカウンターが増減するため、内部状態として counter を設けています。

まずは counter を初期化するために initialize メソッドを作ります。

initialize
    counter := 0.
    super initialize

ウィジェットを作成する

ウィジェットは initialize で作成するのではなく、initializePresenters というメソッドで作成します。ボタンやラベルを作るためのヘルパーメソッドがあるのでそれらを利用します。また、ボタンラベルなども合わせて設定しておきます。

initializePresenters
    buttonUp := self newButton.
    buttonDown := self newButton.
    labelCounter := self newLabel.

    buttonUp label: 'Up'.
    buttonDown label: 'Down'.
    labelCounter label: counter asString.

    self focusOrder
       add: buttonUp;
       add: buttonDown

メソッドの最後にフォーカス順序を設定するためのコードを加えています。実際には機能しているように見えないのですが、設定するのが推奨されているようです。

レイアウトを設定する

レイアウトはクラス側で定義するため、クラス側のメソッドとして defaultSpec を追加します。

defaultSpec
    ^ SpBoxLayout newVertical
        add: #labelCounter;
        add: #buttonUp;
        add: #buttonDown;
        yourself

ここでは SpBoxLayout のインスタンスを作ってレイアウトしています。 newVertical はウィジェットを縦に並べるためのものです。インスタンス変数のシンボルを add: していくと、その順で上から下に配置されます。

試してみる

ここまでの作業でも実際に動かして試すことができます。Playground で SpecSample new openWithSpec を DoIt すればウィンドウが表示されます。

ボタンの動作を設定する

Upボタンでカウンターを増やし、Downで減らすようにしましょう。そのためにはボタンが押されたらラベルの内容を更新する必要があります。ウィジェット同士を関連づけるには、connectPresenters メソッドを定義します。

connectPresenters
    buttonUp
        action: [ counter := counter + 1.
            labelCounter label: counter asString ].
    buttonDown
        action: [ counter := counter - 1.
            labelCounter label: counter asString ]

ボタンにaction:メソッドを送ってブロックを設定すると、ボタンが押された時にブロックの内容が実行されます。ここではカウンターの変数を増減し、その結果をラベルに設定しています。先ほどと同様にウィンドウを表示してボタンを押すと、カウンターが増減されることが確認できます。

Spec2は簡単

Spec2 の簡単な例について説明しました。まだ、装飾など何もしていないので殺風景ですが、ヘルパーメソッドも多く用意されていたり、細かくレイアウト調整ができるので Spec2 を使って UI を構築するのは簡単です。後の記事でも引き続き Spec2 について説明していくつもりです。

vscode で M5Stack Gray のビルドができない

別の記事ではさらっと書いているけど、最も時間がかかったのは表記の問題によるものだった。

単に自マシン(Ubuntu 18.04)にインストール済の vscode の問題なのかもしれないけど、一応解決したのでその方法を書いておく。(そもそも、M5Stack Gray というデバイスなんだけど Platform IOでは Grey になっているのは置いておく)

通常は、platformio.ini に以下のように書いておけばビルドできるはず。

[env:m5stack-grey]
platform = espressif32
board = m5stack-grey
framework = arduino

ところが、何度ビルドしても m5stack-grey なんていう board は知らないとエラーが出てしまう。

そこで、platformio の設定を確認するために、ホームディレクトリを調べてみた。

[Home]
+ .platformio
   + .cache
   + appstate.json
   + homestate.json
   + lib
   + packages
   + penv
   + platforms

.platformio ディレクトリ内に platforms ディレクトリがあり、その中にインストール済のデバイスの情報がディレクトリごとに分かれて入っている。

[Home]
+ .platformio
   + platforms
      + espressif32
         + boards

M5Stack は espressif32 として提供されており、boards ディレクトリにデバイス情報を定義した json ファイルが格納されている。よく見ると、

+ boards
   (省略)
   m5stack-core-esp32.json
   m5stack-fire.json
   m5stick-c.json
   (省略)

M5Stack Gray 用の json ファイルが見当たらない。

どうやら、これが原因のようなので、該当する json ファイルを探してみたら以下のようなリポジトリ内に見つけた。

https://github.com/platformio/platform-espressif32/blob/master/boards/m5stack-grey.json

これを件のディレクトリにコピーすれば万事解決と思ったのだが、そのままは転送できずに若干の追記が必要だった。

*** /home/itoh/Downloads/m5stack-grey.json      2019-10-16 17:01:01.024886387 +0900
 --- m5stack-grey.json   2019-10-16 17:06:10.509753134 +0900
 
 *** 24,31 ****
       "flash_size": "16MB",
       "maximum_ram_size": 532480,
       "maximum_size": 16777216,
       "require_upload_port": true,
 !     "speed": 460800
     },
     "url": "http://www.m5stack.com",
     "vendor": "M5Stack"
 --- 24,32 ----
       "flash_size": "16MB",
       "maximum_ram_size": 532480,
       "maximum_size": 16777216,
 +     "protocol": "esptool",
       "require_upload_port": true,
 !     "speed": 921600
     },
     "url": "http://www.m5stack.com",
     "vendor": "M5Stack" 

要するに転送方法の指定とボーレートの変更を行うようにすればよい。

以上で vscode で M5Stack Gray のビルドと転送ができるようになった。

ROS2でM5StackとPCをつなぐ

Ubuntu 18.04 なPCとM5Stack GrayとをROS2で結んでみたので忘れないようにメモ。

参考にしたのは以下のサイト

使用環境

PC側

  • 普通のノートPC(本当はあまり普通じゃない GPD MicroPCだけど変わらないはず)
  • Ubuntu 18.04
  • Visual Studio Code
  • vscode の Platform IO 拡張

M5Stack側

  • M5Stack Gray (多分 Basic でも Fire でも同じ)

インストール作業いろいろ

ROS2のインストール

以下のサイトの手順にてROS2 Dashing Diademataをインストールした。「Install additional RMW implementations」以外は全て実施した。(手順は省略)

https://index.ros.org/doc/ros2/Installation/Dashing/Linux-Install-Debians/

python-rosdep2 パッケージをインストールした後で、以下を行った。

sudo rosdep init
rosdep update

サンプルプログラムのインストール

ROS2ではじめよう次世代ロボットプログラミング」で勉強中なので、書籍で説明されていたサンプルコードを使った。(丁寧でわかりやすいです)

あらかじめ working と ros2_ws のフォルダは作成済み。

cd ~/working
git clone https://github.com/youtalk/get-started-ros2.git
cd get-started-ros2
git submodule update --init
cd ~/ros2_ws
ln -s ~/working/get-started-ros2/ros2 src
rosdep install --from-paths src --ignore-src -r -y
colcon build

colcon build が何度か失敗したけど、やり直したら全てビルドできた。不思議。

Micro-XRCE-DDSのインストール

M5Stackは、Micro-XRCE-DDSをインストールしたPCと接続するとROS2でつながれるらしい。そこでMicro-XRCE-DDSをインストールする。以下のページを見ながらインストール。

https://micro-xrce-dds.readthedocs.io/en/latest/installation.html

ほぼ上の通りだが、 https://speakerdeck.com/anoken/m5stack-x-ros2?slide=16 によると、cmake のところでオプション指定しているので、そのように変更した。それがどんな意味を持っているか(まだ)わかっていない。

cd ~/working
git clone https://github.com/eProsima/Micro-XRCE-DDS.git
cd Micro-XRCE-DDS
mkdir build
cd build
cmake -DTHIRDPARTY=ON -DCONFIG_UDP_TRANSPORT_MTU=4096 -DCONFIG_SERIAL_TRANSPORT_MTU=4096 ..
make
sudo make install

ros2arduino のインストール

M5Stack 側のプログラムでは ros2arduino のライブラリが必要となるのでインストールする。vscode + platformio で開発しているので 、PIO Home から Libraries で ros2arduino を検索してインストールする。非常に簡単。

プログラミング

今回はテストとしてchatterプログラムを使用し、PC側をListener 、M5Stack側をPublisherとした。

PC側のプログラミング

PC側については、ふつうにROS2のプログラムを作成する。先ほどビルドしたROS2のサンプルプログラムとして入っているものをそのまま使用した。

. ~/ros2_ws/install/setup.bash
ros2 run hello_world listener

上記のサンプルでは、chatterトピックのメッセージを受け取って画面に表示するものである。別のターミナルを開いて以下を実行すれば、PC内で動作確認できる。

. ~/ros2_ws/install/setup.bash
ros2 run hello_world talker

動作を確認したら talker は止めておく。

M5Stack 側のプログラミング

vscode でPIO HomeからNew Project を選んで新規プロジェクトを作成する。Nameに適当な名前を入力し、Boardで適切なデバイスを選択し(使ったのは M5Stack GREY ESP32)、FrameworkはArduinoとした。

Libraries で Installed を選んで ros2arduino の Examplesを探した。今回は、 publisher_wifi_udp というそれらしいものを選んで内容をコピーし、 src/main.cpp に丸ごと貼り付けた。

サンプルからの変更点としては、以下の通り。(サンプルを見ればわかるので詳細は省略)

  • 先頭に #include <M5Stack.h> を挿入した。
  • SSID, SSID_PW を適切な内容に変更した。
  • AGENT_IP をPCのIPアドレスにした。
  • 27行目付近にある “arduino_chatter” を “chatter” に変更した。
  • setup に、適宜 M5.begin やら M5.print などを入れ、動作しているかわかるようにした。

あとは普通にビルドして、M5Stack に転送。転送すると自動的に起動するが、とりあえず放置。

動作確認

PC側では、ROS2のノード(今回は chatter の listener)と、Micro-XRCE-DDSのエージェントが必要となる。ノードの起動は上で行ったので、Micro-XRCE-DDSを起動させる。

MicroXRCEAgent udp -p 2018

ポート番号は ros2arduino のサンプルに記述されているものを指定した。

次に M5Stack をリセットして起動しなおす。アクセスポイントに接続できれば、Micro-XRCE-DDSのエージェントに接続にいく。(なので先にエージェントを起動しておく必要がある)エージェントのログに、session established と表示されれば無事に接続が済んでいる。

ばっちスクショだが、上のようになればOK。左側にMicroXRCEAgentのログ、右側にM5Stackからのメッセージが表示されている。

環境構築に少し手間取ったが、ROS2でPCとM5Stackが簡単につながるようになったのは嬉しい。これで何を作ろうかな。

micro: Maqueen の解析

micro: Maqueen は micro:bit を載せて走らせることのできるロボットプラットフォームである。DFROBOT社製で、 SWITCH SCIENCE から3,000円強で購入することができる。ちなみに、組み立て方その他はこのページに掲載されている。

中に入っているもの
組み立てたもの

プログラミングには、Scratch 3.0 をベースにした MIND+ というものを使うらしいが、githubにある拡張モジュールを使って、Microsoft MakeCode でプログラミングすることもできる。

とはいえ、MicroPython でも使えないことはなかろうと、いろいろと調べてみた。結果的には(全ての機能ではないものの)使えることがわかり、さっそく micro:witch に取り込んでみた。(いずれ公開予定)

この記事では、micro: Maqueen の各種デバイスをどのように制御するかについて調べたことをまとめる。元ネタは先ほどの拡張モジュールのソースファイル(maqueen.ts)である。


GPIO関係

ありがたいことに Maqueen のボード上には、デバイスの横にP8 のようにシルク印刷されている。まさに、左前の赤いLEDがP8と書かれているのだが、これは micro:bit のpin8に接続されていることを意味するので、プログラムから適切にアクセス(Pythonなら pin8.write_digital(1) のように)すれば、LEDが光る。

裏面にはライントレース用のフォトリフレクタがあるが、左側はP13と書かれており、 pin13 に接続されていることがわかるので、Python ならば pin13.read_digital() で値を取得できる。

項目ピン番号入出力備考
左前LED8出力1でオン
右前LED12出力1でオン
左フォトリフレクタ13入力反射があれば1
右フォトリフレクタ14入力反射があれば1

DCモータ

左右のDCモータはi2cバスを使って接続されている。デバイスのアドレスは 0x10 である。モータを扱うには3バイトのデータを書き込む必要がある。

最初のバイトは左右のモーターの区別で、M1なら0x00、M2なら0x02を指定する。(左右のどちらがM1, M2だったか忘れた。後で記載する)

2番めのバイトは回転方向で、前転なら0x00、後転なら0x01を指定する。(左右のモータは逆向きに付けられているが、同じ値の指定で前進・後退する)

3番めのバイトは回転スピードで、0から255の値を指定する。

バイト位置意味備考
0モータ指定M1=0x00, M2=0x02
1回転方向前転=0x00, 後転=0x01
2回転スピード0から255までの整数値

モータを使って戸惑ったのは、モータを回転させている途中で回転方向を切り替えても反応しないということだった。何らかの理由で回転の指示がキャンセルされてしまう。いったん回転スピードを0にして止めてから100msほど待てば、逆回転させることができた。

サーボ

ボードにサーボを取り付けることができるらしく、これもi2cバスで接続されているらしい。(まだ使ったことがない)資料によると、2バイトのデータを書き込むことでサーボを制御できるようだ。(動作未確認なので注意)

バイト位置意味備考
0サーボ指定S1=0x14, S2=0x15
1角度0から180までの整数値

フルカラーLED

ボード上にはフルカラーLEDが4つある。ただ、先の資料には記載がなく、使い方はよくわからない。NeoPixel として使えるのかも。余裕があれば調べる予定。

Hyper Keyboard pi のタッチパネル補正

ラズパイにキーボードと液晶を一体化させる Hyper Keyboard pi を手に入れた。ちょっと時間があったので作ってみたら、いくつか注意点があったので備忘として残しておく。

いろいろ書いているけど、Hyper Keyboard pi は素晴らしいです。ラズパイの使い勝手が高まります。個人的にはマストバイと思っています。

説明書は最後まで読んで取り組むべし

基本的に説明書を読んで作っていけばいいのだけど、ところどころ先に読んでおけばよかったなあということがあった。例えば、「カプトンテープって何だ?家にはないぞ。買わないと」のようなものだったり、「2枚の基板を組み上げる前に予備ハンダしとかないと後で辛いぞ」みたいなものだったり。これに限らず場当たり的に作るのが問題なのだけれど。

底板をつける前に MicroSD カードを刺す

底板を付けた後だと、ピンセットで差し込まなきゃならないことになる。

起動してもディスプレイが表示されない

HyperPixel4 で表示させるには当然のことながらドライバのインストールが必要。つまり、それまでは外部ディスプレイがないとダメ。事前に用意しよう。

ディスプレイの上下がさかさま

説明書にも書いてあるが、単にドライバインストールしただけではディスプレイの上下が反転してしまう。(正確には180度回転する)そのため、github に書かれた手順を行う必要がある。具体的には大したことなくて、「180 Degree Rotation」の通りにすれば良い。

タッチした場所にカーソルがこない

これにはまいった。画面をタッチするととんでもないところにカーソルが行ってしまう。xinput-calibrator とかインストールして設定してみても効果なし。いろいろググった末に、この issue にたどりついた。

要するに、 github でクローンしたソースファイルの一部を書き換える必要がある。具体的には、 src/hyperpixel4.dts を修正して、

         touchscreen-size-x = <800>;
         touchscreen-size-y = <480>;

         touchscreen-size-x = <480>;
         touchscreen-size-y = <800>;

にしてから、make & copy する必要がある。これでタッチの問題は解決する。

ヒートシンクは早めに設置

ラズパイの熱暴走の予防にヒートシンクをつけるなら底面の配線の前にした方がいい。すっかり忘れてラズパイを外そうとしたら、液晶から外せないくらい配線をきっちりしたせいで、ピンセットで取り付けるハメになった。ラズパイへの配線には余裕を持たそう。

PharoからCで書いたプログラムを呼び出す(その2)

これはSmalltalk Advent Calendar 2018の記事です。

前回の記事でPharoからCのプログラムを呼び出す方法について説明しました。今回もその続きで、UFFIというメカニズムを使った外部インターフェイスについて説明します。

さて、数値のような単純なデータを渡すのは簡単ですが、配列のようなデータを受け渡すには少し注意が必要です。例えば次のようなC関数を考えます。

double fsum(double *list, int n)
{
double result = 0;
for (int i = 0; i < n; i ++) {
result += list[i];
}
return result;
}

double型の要素をn個持つ配列を引数で得て、その和を求めるような場合、Pharo 側では少し工夫しなければなりません。

まず、Cの関数を呼び出すメソッドを定義します。

fsum: anArray size: anInteger
^ self ffiCall: #(double fsum #(FFIExternalArray anArray , int anInteger)) module: UFFITestLibrary

配列のパラメータを指定する部分以外は前回の記事と変わりありません。double型の要素を持つ配列を受け渡す場合には、FFIExternalArray という型を明示的に指定します。また、このメソッドが使われる時には、anArray に FFIExternalArray クラスのインスタンスが指定される必要があります。

fsum: anArray
| size arr |
size := anArray size.
^ [ arr := FFIExternalArray externalNewType: 'double' size: size.
1 to: size do: [ :i | arr at: i put: (anArray at: i) ].
self fsum: arr size: size ]
ensure: [ arr free ]

#externalNewType:size: というメッセージを使って FFIExternalArray のインスタンスを作成します。そのオブジェクトに受け渡したい要素を一つずつ設定してから、先程のメソッドを使います。使い終わったところで、作成した FFIExternalArray のインスタンスを開放します。

Cの関数の中で配列の要素に変更を加えるような場合も似たような形となります。配列の各要素を定数倍する関数を考えてみます。

void fmultiplyBy(double *list, int n, double x)
{
for (int i = 0; i < n; i ++) {
list[i] *= x;
}
}

この関数を呼び出す Pharo のメソッドは以下のようになります。

fmultiply: anArray size: anInteger by: x
^ self ffiCall: #(double fmultiplyBy #(FFIExternalArray anArray , int anInteger , double x)) module: UFFITestLibrary

上のメソッドを使うために FFIExternalArray のインスタンスを作って渡すメソッドを用意します。

fmultiply: anArray by: x
| size arr |
size := anArray size.
[ arr := FFIExternalArray externalNewType: 'double' size: size.
1 to: size do: [ :i | arr at: i put: (anArray at: i) ].
self fmultiply: arr size: size by: x.
1 to: size do: [ :i | anArray at: i put: (arr at: i) ] ]
ensure: [ arr free ]

要するに FFIExternalArray インスタンスから要素を一つずつ取り出して元の配列を変更するわけです。

以上が配列などのデータを受け渡す場合の方法となります。

残念ながら大きな配列のやり取りの場合だと、要素の出し入れに余計なコストがかかるぶん効率は良くありません。特に今回のような例では、以下のようなコードの方がずっと早いです。

a := #(1 2 3 4) asFloatArray.
a *= 2.
a.

こちらは FloatArrayPlugin という VM プラグインを用いており、C言語の関数側で配列の処理を行っています。

PharoからCで書いたプログラムを呼び出す

これはSmalltalk Advent Calendar 2018の記事です。

ごく稀にPharoから外部のプログラムを呼び出して使いたいことがあります。以前は外部プログラムを呼び出す仕組みが毎年のように変わっていたため、ちょっとご無沙汰していると置いてけぼりを食らうことが多々ありました。

最近では UFFI という仕組みで落ち着いた感がありますが、Pharo のことなのでまた変わってしまうのでしょう。

この記事では UFFI を使って Pharo から C で書いたプログラムを呼び出す方法を簡単に説明します。

Cプログラムの準備

まずは、C言語のプログラムを用意しておきましょう。普段 Linux を使っているので、Linux (64bit) を例に説明します。おそらく、mingw を使えば Windows でも同じようにいけるはずです。

int doublenumber(int n)
{
return n * 2;
}

上記のようなプログラムを用意します。ファイル名は uffitest.c とします。内容は整数を2倍する doublenumber 関数を定義しているだけです。

このプログラムをコンパイルして共有オブジェクトを作ります。

gcc -fPIC -shared -o uffitest.so uffitest.c

カレントディレクトリに uffitest.so というファイルができます。

UFFITestLibrary クラスの作成

Pharo を起動します。ここでは Linux 版のPharo6.1 のイメージを 64bit VM で起動したものとします。UFFILibrary クラスを継承した UFFITestLibrary クラスを作成します。

FFILibrary subclass: #UFFITestLibrary
instanceVariableNames: ''
classVariableNames: ''
package: 'UFFITest'

このクラスで外部のプログラムとの結びつきを定義します。そのためにメソッドを追加します。このメソッドはインスタンスメソッドとして登録します。

unixModuleName
^ 'uffitest.so'

このメソッドで先程作った uffitest.so ファイルのありかを示します。イメージと同じ場所にあるならパス指定は不要なようです。

他のOSで使う場合には別のメソッド名を用います。Mac OS Xならば macModuleName とし、Windows ならば win32ModuleName を使います。Windows は 32bit VM しか公開されていないので、先程の共有ライブラリも32btにする必要がありそうです。

外部プログラムを呼び出すメソッドの追加

doublenumber 関数を呼び出すメソッドを追加します。どんなクラスに書いてもいいのですが、ここではテストのため UFFITest クラスを作成してメソッドを登録します。

Object subclass: #UFFITest
instanceVariableNames: ''
classVariableNames: ''
package: 'UFFITest'

何の変哲もない Object クラスを継承したクラスです。このクラスのインスタンス側に doubleNumber: というメソッドを登録します。このメソッドは引数を1つ取り、その2倍の値を返します。

doubleNumber: anInteger
^ self ffiCall: #( int doublenumber (int anInteger)) module: UFFITestLibrary

このメソッドは #ffiCall:module: というメッセージを送るだけのものです。第一引数には C言語の関数プロトタイプ宣言のような形式で、呼び出す関数を指定します。また、第二引数には共有オブジェクトを定義したクラス名を指定します。

試してみる

以上で準備は完了しました。実際に使ってみましょう。Playground を開いて以下のように入力します。

UFFITest new doubleNumber: 10. 

Go を押せば結果(20)が得られます。

エラー?

External module not found というエラーメッセージが出ることがあります。これは、適切な共有オブジェクトファイルが見つからなかった時に現れます。Pharo のイメージファイルと同じディレクトリにファイルがあるか、32bit VMなのに64bitのオブジェクトファイルになっていないか、UFFITestLibrary クラスのメソッドが間違っていないかなど、確認してください。

おわりに

どうだったでしょうか?簡単にC言語の関数を呼び出せることがわかったと思います。C-API を持っているライブラリを活用する助けになれば幸いです。


micro:witch アルファ版公開

スクラッチ風のブロックプログラミング環境で micro:bit のプログラムを作成できるmicro:witch を公開しました。

https://github.com/EiichiroIto/microwitch

ドキュメントもなく、日本語化もされておらず、(ほぼ)何のテストもしていません。そのつもりでお使いください。

[2018/7/6追記]

現在は日本語化済みです。地球儀マークで「日本語」「にほんご」のいずれかを選べば日本語表示となります。

また、micro:witch 上での micro:bit のエミュレーションも不完全です。LEDとボタン程度しかまともに動作しません。

Windows 10での動作を確認しましたが、他にも動作の確認(動作しない確認でも)を行っていただけたなら twitter の投稿に返信くださると助かります。

アカウント: https://twitter.com/razdan3

[2018/6/29追記]

Windows で簡単に動かせるように必要なファイルをすべてパッケージしたので、github からダウンロードしたらすぐ利用できます。

Windows 用の簡単なインストール方法だけ載せておきます。

  1. Scratch のサイトから WinMacScratch1.4.zip をダウンロードしてください。
  2. 適当なフォルダに展開してください。
  3. 展開したフォルダにある、Scratch.image ファイルを削除してください。
  4. 上の github.com サイトで公開している、 microwitch.image, microwitch.changes, Microwitch.dll の3つのファイルをダウンロードし、先ほどのフォルダにコピーしてください。

以上です。

micro:bit が外部ドライブとして見えている状態なら、Microbit メニューからプログラムを送信できるはずです。

なお、「緑旗が押されたら」のHATブロック以降しかプログラム送信・実行しませんのでご注意ください。