hsjuiz 0.2.9 → 0.2.10
raw patch · 5 files changed
+46/−7 lines, 5 filesPVP: major bump suggested
API removals or changes: PVP suggests a major version bump
API changes (from Hackage documentation)
+ Juiz: model :: Value -> ContainerManifest -> ContainerManifest
+ Juiz: modelPath :: Text -> ContainerManifest -> ContainerManifest
+ Juiz.Manifest: [cmModel] :: ContainerManifest -> !Maybe Value
+ Juiz.Manifest: model :: Value -> ContainerManifest -> ContainerManifest
+ Juiz.Manifest: modelPath :: Text -> ContainerManifest -> ContainerManifest
- Juiz.Manifest: ContainerManifest :: !Text -> !Text -> !Text -> !Text -> ![ArgumentManifest] -> ContainerManifest
+ Juiz.Manifest: ContainerManifest :: !Text -> !Text -> !Text -> !Text -> ![ArgumentManifest] -> !Maybe Value -> ContainerManifest
Files
- CHANGELOG.md +4/−0
- README.md +13/−5
- hsjuiz.cabal +1/−1
- src/Juiz.hs +2/−0
- src/Juiz/Manifest.hs +26/−1
CHANGELOG.md view
@@ -3,6 +3,10 @@ hsjuiz の版は juiz(crates.io の juiz_app、PyPI の pyjuiz / juiz-cli)と同じ番号にそろえています。 使う libjuiz_sdk も同じ版にしてください。 +## 0.2.10++- `model` / `modelPath` で Container の型の既定の 3D モデルを書けるようにした(`ContainerManifest` に `cmModel` を足した、#509)。+ ## 0.2.9 - hsjuiz の API は 0.2.8 から変えていない(Container の 3D モデル #379 と Zenoh ブローカー #487 の公開に版をそろえた。モデルは conf で書くので hsjuiz 側の追加はない)。
README.md view
@@ -189,6 +189,14 @@ - Container を作る関数の結果(`IO s` または `s`)が状態です。書き換える値は `IORef` などに入れてください (`Juiz` から `IORef` / `newIORef` / `readIORef` / `writeIORef` / `modifyIORef'` / `atomicModifyIORef'` も使えます)。 juiz は同じ Container の ContainerProcess を同時には呼びません。+- `model` で型の既定の 3D モデルを書けます(conf のインスタンスに `model:` が無いときに使われます。docs/spec/container-model.md §5.6)。+ 値は conf の `model:` と同じ形で、パスはプラグインのファイルのあるディレクトリからの相対です。+ path だけなら `modelPath "models/pantilt.glb"`。++ ```haskell+ manifest = containerManifest "pantilt_hs"+ & model (object ["path" .= JString "models/pantilt.glb", "scale" .= JFloat 0.001])+ ``` - `containerProcessManifest "型名" "Container の型名"` で ContainerProcess のマニフェストを作ります。 引数は第 1 引数(状態)の後に続く引数の順です。 - 状態は `StablePtr` に包んで juiz に渡します。Container を削除すると解放され、GC に回収されます。@@ -344,7 +352,7 @@ `scripts/install-juiz-sdk.sh` で取得して `~/.juiz/sdk/<版>` に展開できます。 ```terminal-curl -fsSL https://raw.githubusercontent.com/OpenJUIZ/juiz/main/scripts/install-juiz-sdk.sh | sh -s -- 0.2.9+curl -fsSL https://raw.githubusercontent.com/OpenJUIZ/juiz/main/scripts/install-juiz-sdk.sh | sh -s -- 0.2.10 ``` それより前の版では、juiz のソースを同じ版のタグで取得し、`cargo build --release -p juiz_sdk` でできる `target/release` の libjuiz_sdk を使います。@@ -358,8 +366,8 @@ packages: . package hsjuiz- extra-lib-dirs: /home/me/.juiz/sdk/0.2.9/lib- ghc-options: -optl-Wl,-rpath,/home/me/.juiz/sdk/0.2.9/lib+ extra-lib-dirs: /home/me/.juiz/sdk/0.2.10/lib+ ghc-options: -optl-Wl,-rpath,/home/me/.juiz/sdk/0.2.10/lib ``` ```terminal@@ -371,11 +379,11 @@ その `bindings/hsjuiz` を `cabal.project` の `packages:` に足します。 ```cabal-packages: . /home/me/juiz-0.2.9/bindings/hsjuiz+packages: . /home/me/juiz-0.2.10/bindings/hsjuiz ``` ```terminal-git clone --depth 1 --branch v0.2.9 https://github.com/OpenJUIZ/juiz.git /home/me/juiz-0.2.9+git clone --depth 1 --branch v0.2.10 https://github.com/OpenJUIZ/juiz.git /home/me/juiz-0.2.10 ``` juiz のリポジトリの中でビルドするときは、`cargo build` でできる `target/debug` の libjuiz_sdk を
hsjuiz.cabal view
@@ -1,6 +1,6 @@ cabal-version: 3.0 name: hsjuiz-version: 0.2.9+version: 0.2.10 synopsis: Write juiz processes and containers in Haskell description: Write Process / Container / Component plugins of
src/Juiz.hs view
@@ -80,6 +80,8 @@ , useMemo , readonly , containerType+ , model+ , modelPath , addArg , addBoolArg , addIntArg
src/Juiz/Manifest.hs view
@@ -31,6 +31,8 @@ , useMemo , readonly , containerType+ , model+ , modelPath , addArg , addBoolArg , addIntArg@@ -94,6 +96,9 @@ , cmFactory :: !Text -- | Container を作る関数の引数 (設定ファイルの containers に書いた値) , cmArguments :: ![ArgumentManifest]+ -- | 型の既定の 3D モデル (docs/spec/container-model.md §5.6)。conf の model: と同じ形のオブジェクト。+ -- 'Nothing' なら manifest に載せない+ , cmModel :: !(Maybe Value) } deriving (Eq, Show) @@ -161,6 +166,7 @@ , cmLanguage = "haskell" , cmFactory = "container_factory" , cmArguments = []+ , cmModel = Nothing } -- | ContainerProcess のマニフェストを作る。型名 → 結びつける Container の型名@@ -198,6 +204,24 @@ containerType :: Text -> ProcessManifest -> ProcessManifest containerType c m = m { pmContainerType = Just c } +-- | 型の既定の 3D モデル (docs/spec/container-model.md §5.6)。conf の model: と同じ形のオブジェクトで書く。+-- path はプラグインのファイル (libxxx.so など) のあるディレクトリからの相対。+-- conf のインスタンスに model: があればそちらを丸ごと使い、model: null ならモデル無しで作る。+-- 'JString' は path だけを書いたものとして扱い、'JNull' は既定のモデルを外す。+--+-- > containerManifest "pantilt_hs"+-- > & model (object ["path" .= ("models/pantilt.glb" :: Text), "scale" .= (0.001 :: Double)])+model :: Value -> ContainerManifest -> ContainerManifest+model JNull m = m { cmModel = Nothing }+model (JString p) m = m { cmModel = Just (object ["path" .= p]) }+model v m = m { cmModel = Just v }++-- | 型の既定の 3D モデルを path だけで書く ('model' の短い形)。+--+-- > containerManifest "pantilt_hs" & modelPath "models/pantilt.glb"+modelPath :: Text -> ContainerManifest -> ContainerManifest+modelPath p = model (JString p)+ -- | 同じ引数で呼ばれたときに前の結果を使い回すか (juiz の use_memo) useMemo :: Bool -> ProcessManifest -> ProcessManifest useMemo b m = m { pmUseMemo = b }@@ -288,7 +312,7 @@ containerManifestToValue = containerWithProcessesToValue [] containerWithProcessesToValue :: [ProcessManifest] -> ContainerManifest -> Value-containerWithProcessesToValue ps m = object+containerWithProcessesToValue ps m = object $ [ "type_name" .= cmTypeName m , "language" .= cmLanguage m , "description" .= cmDescription m@@ -296,6 +320,7 @@ , "arguments" .= map argumentToValue (cmArguments m) , "processes" .= map manifestToValue ps ]+ ++ maybe [] (\v -> ["model" .= v]) (cmModel m) -- | juiz に渡す形 (C++ の ComponentManifest::into_value と同じ項目)。 -- ContainerProcess の Container が Component に無い、または型名が重なっていれば Left (説明)