HaskellでGTKアプリケーションを作成する、パート1
Making a GTK application in Haskell, part 1 (floreal.tech)
要約
この記事は、Haskell、GTK 4、およびAdwaitaライブラリを使用してToDoリストアプリケーションを構築するチュートリアルシリーズのパート1です。GNOMEプロジェクトのデザイン言語であるAdwaitaのコンポーネントと、HaskellからGTKライブラリにアクセスするためのhaskell-giツールキットについて説明しています。また、Elmアーキテクチャのパターンを導入し、モデル、メッセージ、更新関数を定義しています。
全文翻訳
HaskellでGTKアプリケーションを作成する、パート1
このシリーズでは、Haskell、GTK 4、およびAdwaitaライブラリを使用してTODOリストアプリケーションを構築します。Adwaitaは多くの便利なウィジェットとスタイルを提供してくれます。早速始めましょう!
このシリーズの対象読者は、Haskellの経験があり、開発経験のある中級者です。
GTK 4, Adwaita
Adwaitaは、GNOMEプロジェクトのデザイン言語として機能するGTKコンポーネントのライブラリです。簡単に言うと、GNOMEプロジェクトがアクセシビリティとスタイル(Human Interface Guidelines, HIG)に関して行ったすべての決定は、libadwaitaにエンコードされています。
Libawaitaは多くの機能を提供します。例えば、レスポンシブデザインのアプリケーションを作成でき、デスクトップがライトテーマとダークテーマを切り替える際に実行時に色が変わります。
HaskellとGTK
このシリーズ全体を通して、GTKライブラリからHaskellバインディングを自動生成し、C APIに関連付けられるHaskellインターフェースを取得できるhaskell-giツールキットを使用します。
この記事を読みやすくするために、主要な概念を強調するために、表示されるコードは完全なものではありません。
プロジェクト全体はhttps://github.com/Floreal-Technologies/adwaita-todoで見つけることができます。
最初のウィンドウ
まず、GTK 4 / Adwaitaアプリケーションの構造の自己完結型例を以下に示します。
リソース管理(非常にクールなAdwaitaスタイルシートを含む)を処理するAdwaitaの "Application" を作成しましょう。
module Main (main) where
import GI.Adw qualified as Adw
import GI.Gio qualified as Gio
import GI.GTK qualified as Gtk
main :: IO ()
main = do
-- `new X [#attribute := value]` 構文は、プロパティを持つGtkオブジェクトを作成します。
-- ハッシュ構文はOverloadedLabelsと呼ばれます。
app <- new Adw.Application [#applicationId := "tech.floreal.TodoApp"]
-- "activate" シグナルを "activate" ハンドラに接続します。
on app #activate (activate app)
-- メインアプリケーションループを実行します。
Gio.applicationRun app Nothing
pure ()
activate :: Adw.Application -> IO ()
activate app = do
header <- new Adw.HeaderBar []
toolbar <- new Adw.ToolbarView []
Adw.toolbarViewAddTopBar toolbar header
window <-
new Adw.ApplicationWindow
[ #application := app
, #title := "Todos"
, #defaultWidth := 480
, #defaultHeight := 640
, #content := toolbar
]
Gtk.windowPresent window
見てください!「Todos」というタイトルと、480x640の寸法を持つ空のウィンドウが表示されます。
[画像: An empty window]
Model-View-Update: Elmアーキテクチャ
Elmアーキテクチャ(またはTEA)は、インタラクティブなプログラムをアーキテクトするためのパターンです。その中核には3つの概念があります。
Model
アプリケーションの状態
View
Modelをユーザーインターフェース(HTML、GTKなど)に変換する方法
Update
Messagesに基づいてModelを更新する方法
これらの概念と並んで、以下を見つけることができます。
Message
アプリケーションのユーザーによるすべての可能なインタラクションの列挙
Effects
Update関数は更新されたModelを返すだけでなく、副作用として実行されるアクションのリストも返します。これはEffectsと呼ばれます。
このアプローチはElmによって広く普及し、GTKツールキットの命令型性質を制御するのに非常に適しています。
Todoアプリ
今こそ、アプリケーションの状態とそのアクションを表現する時です。Elmアーキテクチャの精神に則り、すべてをデータ構造としてモデル化するため、どのアクションがトリガーされ、それが何を意味するのかを完全に可視化できます。
モデル
newtype TodoId = TodoId Word
deriving stock (Show)
deriving newtype (Eq, Ord)
data Todo = Todo
{
id :: TodoId,
title :: Text,
done :: Bool
}
deriving stock (Eq, Show)
data Model = Model
{
todos :: Map TodoId Todo,
nextId :: TodoId
}
deriving stock (Eq, Show)
-- In our case, the effect here represents
-- saving the todo-list on disk.
data Effect = Save [Todo]
deriving stock (Eq, Show)
init :: Model
init = Model
{
todos = Map.empty,
nextId = TodoId 0
}
メッセージ
アプリケーションとのユーザーインタラクションはメッセージとしてモデル化されます。モデルを変更する明確なアクションがある既知のアクションのセットです。
モデルを更新するためにユーザーがトリガーする可能性のあるいくつかのメッセージから始めましょう。
data Message
=
Add Text
|
SetDoneStatus TodoId Bool
deriving stock (Eq, Ord)
今のところ多くはありませんが、進むにつれて追加していきます。
モデルの更新
update :: Message -> Model -> (Model, [Effect])
update message model = case message of
Add raw ->
let text = Text.strip raw
todoId@(TodoId n) = model.nextId
todo = Todo{ id = todoId, title = text, done = False }
in if Text.null text
then (model, [])
else
withTodos
(Map.insert todo.id todo)
model{ nextId = TodoId (n + 1)}
SetDoneStatus todoId value ->
withTodos (Map.adjust (\todo -> todo {done = value}) todoId) model
where
-- This is where we determine if our todos have changed,
-- so that we can save them.
withTodos f changed =
let result = changed {todos = f changed.todos}
in if result.todos == model.todos
then (result, [])
else (result, [Save (Map.elems result.todos)])
GHCiを開いて試してみましょう。
$ cabal repl
-- Let's add a task to buy leeks
ghci> let (m1, e1) = update (Add "Buy leeks") init
-- This triggers a "Save" effect for an unfinished task
ghci> e1
[Save [Todo {id = TodoId 0, title = "Buy leeks", done = False}]]
-- Let's set the task as done
ghci> let (m2, e2) = update (SetDoneStatus (TodoId 0) True) m1
-- Since the status has changed, we have to save it
ghci> e2
[Save [Todo {id = TodoId 0, title = "Buy leeks", done = True}]]
-- Setting the task to True again does not trigger a Save effect,
-- so the effects list is empty.
ghci> update (SetDoneStatus (TodoId 0) True) m2
(Model{ nextId = TodoId 1
, todos = fromList [
(TodoId 0, Todo{ id = TodoId 0
, title = "Buy leeks"
, done = True})]
}, []) -- ← empty list!
これは、メッセージの合計型と状態を変更する更新関数としてエンコードされたドメインロジックです。
次にインターフェースを設計しましょう。
ビュー
ユーザーインターフェースの設計を始める前に、期待を書き留めておくのは良いことです。
経験上、デザインはデータから直接生まれるわけではないため、デザインの指針としてデータの形状を見ることは少なくなっています。
[画像: Draft of the UI on a piece of paper]
この場合、それは非常にシンプルですが、私は描くのが好きです。
ウィジェット
いくつかのウィジェットを使用します(名前をクリックすると、その外観のスクリーンショットが表示されます)。
ボックスは子ウィジェットを行または列に配置します。
動的にフィルタリングおよびソートできる行のリスト。後でステータスでフィルタリングし、年齢でソートするのに役立ちます。
タイトル、プレースホルダーテキスト、編集可能であることを示すアイコンを持つ行のエントリ。ListBoxのサブクラスなので、ListBox内に配置されます。
EntryRowのより制限されたバージョンで、インプレースで編集できません。アクションアイコンを取得でき、ListBox内に配置されます。
子ウィジェットを指定されたサイズに制限するウィジェット。マージンを強制して、背景が端で表示されるようにするのに役立ちます。
このウィジェットは子ウィジェットをスクロール可能にします。その名前が示すとおりの機能です。
ページと上下のバーを含むビューウィジェット。
レゴの時間
これらのビルディングブロックを使って、ウィジェットが互いにどのように接続されるかを記述しましょう。
module Todo.View (view) where
-- Imports
-- […]
-- `dispatch` は後でRuntimeモジュールで定義され、メッセージを状態/モデルの変更に変換する関数です。
view
:: (Message -> IO ()) -- dispatch function
-> Model
-> IO Gtk.Widget
view dispatch model = do
-- ここで、入力行とそのタイトル、および入力がアクティブ化されたときに
-- 入力の取得をアクティブ化するためのシグナルハンドラを定義します。
inputRow <- new Adw.EntryRow [#title := "New task"]
on entry #entryActivated $ do
text <- Gtk.editableGetText inputRow
dispatch (Add text) -- ここで "Add" メッセージを送信します
-- EntryRow は ListBox のサブクラスなので、
-- inputRow を entryBox に追加する必要があります
entryBox <- newBoxedList
Gtk.listBoxAppend entryBox inputRow
-- タスクを含む ListBox
todoList <- newBoxedList
forM_ (model.todos) $ \todo -> do
row <- new Adw.ActionRow [#title := todo.title, #useMarkup := False]
Gtk.listBoxAppend todoList row
-- メインコンテンツウィジェット。さまざまなオプションがあります。
-- 親内のマージンと向きを定義します。
content <-
new
Gtk.Box
[
#orientation := Gtk.OrientationVertical,
#spacing := 12,
#marginTop := 12,
#marginBottom := 12,
#marginStart := 12,
#marginEnd := 12
]
-- すべてを追加することを忘れないように…
Gtk.boxAppend content entryBox
Gtk.boxAppend content todoList
-- コンテンツウィジェットの親。
clamp <- new Adw.Clamp [#child := content]
scrolled <-
new
Gtk.ScrolledWindow
[
#child := clamp
]
-- 追加情報のための小さなフッター。
-- タスクの量など。
count <- new Gtk.Label [#label := Text.show (Map.size model.todos)]
footer <-
new
Gtk.Box
[
#orientation := Gtk.OrientationHorizontal,
#marginTop := 6,
#marginBottom := 6,
#marginStart := 12,
#marginEnd := 12
]
Gtk.boxAppend footer count
-- ヘッダー、コンテンツ、フッターを組み立てましょう!
header <- new Adw.HeaderBar []
toolbar <- new Adw.ToolbarView [#content := scrolled]
Adw.toolbarViewAddTopBar toolbar header
Adw.toolbarViewAddBottomBar toolbar footer
Gtk.toWidget toolbar
-- 正しい設定でListBoxを作成する簡単なヘルパー。
newBoxedList :: IO Gtk.ListBox
newBoxedList =
new
Gtk.ListBox
[
#selectionMode := Gtk.SelectionModeNone,
#cssClasses := ["boxed-list"]
]
まだ多くの視覚的なフィードバックは得られませんが、以前の紙と鉛筆のドラフトに似ていると信じてください。
ランタイム
記事の冒頭のデモコンテンツと同様に、ここでModel-View-Updateのトリオを接続します。
dispatchとstepという2つの関数を定義します。これらは非常によく連携します。
dispatchはメッセージを受け取り、GTK実行ループの優先度を処理し、stepを呼び出してモデルの更新を実行し、それがビューの更新につながります。
stepはモデルを読み取り、それに対してupdate(Model.hsから)を呼び出して新しいモデルを取得し、新しいモデルを書き込み、新しいモデルとディスパッチ関数をビューに渡します。ビューは新しいコンテンツをGtkウィジェットとして返します。そして、この新しいコンテンツをウィンドウに設定します。
ここにコードがあります。
run :: Adw.Application -> IO ()
run app = do
window <-
new
Adw.ApplicationWindow
[
#application := app,
#title := "Todos",
#defaultWidth := 480,
#defaultHeight := 640
]
ref <- newIORef Model.init
let {- rec -}
dispatch :: Model.Message -> IO ()
dispatch message =
void $ GLib.idleAdd GLib.PRIORITY_DEFAULT $ do
step message
pure GLib.SOURCE_REMOVE
step :: Model.Message -> IO ()
step message = do
oldModel <- readIORef ref
let (newModel, _effects) = Model.update message oldModel
writeIORef ref newModel
content <- View.view dispatch newModel
Adw.applicationWindowSetContent window (Just content)
content <- View.view dispatch Model.init
Adw.applicationWindowSetContent window (Just content)
Gtk.windowPresent window
これで、Mainモジュールは次のようになります。
module Main where
main :: IO ()
main = do
app <- new Adw.Application
[#applicationId := "tech.floreal.AdwaitaTodo"]
on app #activate (Runtime.run app)
Gio.applicationRun app Nothing
pure ()
そして、さあ、始めましょう!
[画像: An application window with an input entry, and a list of two items 'Touch grass' and 'Buy leeks']
かなりクールです。
これでこの記事は終わりです。次のパート2で、Todoリストアプリケーションのさらなる機能を見ていきましょう!