(rontolisp) docs

uiop パッケージ

uiop は ASDF の移植性レイヤであり、Common Lisp が標準化しなかった操作 — 環境変数の 読み取り、ファイルの存在確認、ディレクトリの走査、文字列の分割 — に対して処理系非依存の ライブラリがすでに使っている綴りです。Common Lisp の一部ではありません。シンボルは 修飾子付き (uiop:getenv) で参照し、修飾なしの綴りはありません。

カバレッジの目標は uiop 3.3.7 — 組み込みの ql:quickload クライアントが取得するリリースです。このリリースは 429 個のシンボルをエクスポート しており、rontolisp はそのうちの一部を実装しています。残りは解決だけされてシグナルを 上げるので、(:import-from #:uiop) 句で名前を挙げているだけのライブラリは読み込め、 コンパイルでき、実行できます。

サブパッケージ

本家の uiopuiop/driver であり、15 個のサブパッケージの再エクスポートです。 ライブラリはどちらの綴りでも名指しできます — lack-middleware-backtrace(:import-from :uiop/image :print-condition-backtrace) と書きます。rontolisp は 15 個 すべてを登録し、各サブパッケージが自分の定義するメンバを所有して uiop がそれらを インポートします。したがってどちらの綴りも同じシンボルを指し、メンバ名が同じ 2 つの 関数にはなりません:

サブパッケージ内容実装済み
uiop/packageシンボルとパッケージの操作 (find-symbol*intern*define-package)4 / 31
uiop/package-local-nicknamesパッケージローカルニックネーム API1 / 3
uiop/package*uiop/package が定義するがエクスポートしない 3 つのコンディション・型名0 / 3
uiop/utility移植性のあるヘルパ (strcatsplit-stringif-letnot-implemented-error)68 / 68
uiop/versionバージョン比較と非推奨コンディション1 / 15
uiop/osホストの識別、環境変数、作業ディレクトリ22 / 22
uiop/pathnameパス名の代数 (subpathnameparse-unix-namestringenough-pathname)50 / 50
uiop/filesystemファイルシステムの探索・走査・変更8 / 32
uiop/streamファイル内容、一時ファイル、エンコーディング、標準ストリーム3 / 66
uiop/image終了、致命的コンディション、ダンプフック(コマンドラインは未実装)25 / 30
uiop/launch-program非同期のサブプロセス0 / 19
uiop/run-program同期のサブプロセス0 / 7
uiop/lisp-buildcompile-file* と遅延警告1 / 44
uiop/configurationXDG パスと設定ファイルの探索0 / 38
uiop/backward-driver非推奨の別名0 / 7

エクスポートの完全な一覧は src/main/resources/am/ik/rontolisp/uiop-exports.txt としてチェックインされています (1 行 1 エクスポート: サブパッケージ、シンボル、本家での定義形式)。上の数値はこの一覧に 対して測定されるので、両者は常に一緒に動きます。

実装済みのもの

専用のページを持つサブパッケージは 4 つです。うち 3 つは完全に実装済みで、uiop の 他のすべてがその上に書かれている移植性ヘルパ群 uiop/utility の 68 個 (uiop/utility)、パス名の代数 uiop/pathname の 50 個 (uiop/pathname)、そしてホストの識別・環境変数・作業ディレクトリ の 22 個 uiop/os (uiop/osuiop:getenv もここにあります) です。4 つめは uiop/image で、 uiop:quit が 4 つのバックエンドすべてでステータスコード 付きのプロセス終了を行い、致命的コンディション・バックトレース・イメージフックの 各族もここにあります。残りは以下のとおりです。

関数結果
uiop:file-exists-p(uiop:file-exists-p "f.txt")ファイルが存在すればそのパス名、存在しなければ nilprobe-file と同じ契約であり、すべてのバックエンドでその基本操作へ落とされます
uiop:directory-exists-p(uiop:directory-exists-p "src/")ディレクトリが存在すれば(末尾に / を付けた)そのパス名、存在しなければ nilfile-exists-p のディレクトリ版であり、空のディレクトリと存在しないディレクトリを区別できる唯一の手段です
uiop:directory-files(uiop:directory-files "db/" "*.up.sql")ディレクトリのうちディレクトリでないエントリ — (directory "db/*.*") からサブディレクトリを除いたものです。UIOP の省略可能な第 2 引数 (名前と型のみのワイルドカードのパス名文字列) は directory とまったく同じ規則で絞り込みます。省略するとすべてを一覧し、ディレクトリ部分を含むパターンはエラーです
uiop:subdirectories(uiop:subdirectories "src/")ディレクトリのサブディレクトリを、それぞれ末尾に / を付けて返します
uiop:collect-sub*directories(uiop:collect-sub*directories "src/" (constantly t) (constantly t) #'print)ディレクトリツリーを走査します。collectpcollector へ渡すものを、recursep が降りていく先を決めます。渡されるディレクトリはルートも含めてすべてディレクトリ形式です
uiop:read-file-string(uiop:read-file-string "db/up.sql")ファイルの内容全体を 1 つの文字列として返します。ファイルを入力用に開けるすべてのバックエンドで動きます。lite 版: 本家 UIOP の &rest キーワードは受け付けて無視します (:external-format は rontolisp には存在せず、どのバックエンドも UTF-8 で読みます)
uiop:compile-file-type(uiop:compile-file-type)nil — コンパイル済みファイルが持つパス名の型。ここには compile-file が存在せずそのような型もないため、「このパスは fasl か?」を問う呼び出し側はソースパスに対して「いいえ」を得ます
uiop:default-temporary-directory(uiop:default-temporary-directory)$TMPDIR をディレクトリ形式で。環境変数が空の場合 (--env なしの 2 つの WASM バックエンド) は #P"/tmp/"
uiop:delete-file-if-exists(uiop:delete-file-if-exists "scratch.txt")ファイルを削除します。存在しない場合はシグナルではなく nil を返します — UIOP がこれをエクスポートしている理由そのものです
uiop:get-pathname-defaults(uiop:get-pathname-defaults)相対名が解決される基準のデフォルト — 絶対なデフォルト引数が与えられない限り *default-pathname-defaults* (初期値 #P""、ホストの作業ディレクトリを指すパス名) を返します
uiop:native-namestring(uiop:native-namestring #P"/tmp/x")"/tmp/x" — パス名のホスト OS の綴り。ここでは名前文字列そのものなので namestring と同じです
uiop:add-package-local-nickname(uiop:add-package-local-nickname '#:j '#:com.example.pkg)パッケージ短縮名を登録 (lite: グローバル、パッケージごとのスコープなし)。リテラルなトップレベル呼び出しはコンパイル時ディレクティブなので、すべてのバックエンドで動作します
uiop:symbol-call(uiop:symbol-call :cl :+ 1 2)実行時にパッケージから名前を引いて適用します — 依存関係に持たないシステムを呼ぶための UIOP の遅延束縛呼び出しです

完全実装済みサブパッケージ以外の 3 つのメンバはマクロで、呼び出されるのではなく コンパイラが展開します: uiop:with-temporary-fileuiop:with-deprecationuiop:define-package (リテラルなトップレベル呼び出しは defpackage と同様に処理されます)。 uiop/pathname の 2 つのマクロ — uiop:with-pathname-defaultsuiop:with-enough-pathname — はそのページにあります。 uiop/utility 自身のマクロ — uiop:if-letuiop:nestuiop:while-collectinguiop:with-upgradability など — は そのページにあります。

未実装のもの

これ以外のエクスポートは解決はされ、操作名とともに uiop:not-implemented-error をシグナルします。一覧を登録している理由はまさにここにあります: uiop の未実装部分に 到達したプログラムは、ライブラリの奥から出てくる undefined function ではなく 1 つの 明確な答えを受け取り、ハンドラで捕捉できます:

$ rontolisp -e '(uiop:run-program "ls")'
Unhandled condition: Not (currently) implemented on rontolisp: UIOP/RUN-PROGRAM:RUN-PROGRAM

この振る舞いは 4 つのバックエンドすべてで同一です — インタプリタ、JVM、2 つの WASM 出力のいずれも同じコンディションを同じレポートでシグナルします。

rontolisp の追加分

本家がそこにエクスポートしていない名前が 2 つ uiop にあります:

  • uiop:namestring — 本家は Common Lisp のものを継承しているだけですが、ここでは エクスポートされており、namestring そのものです。 どちらの綴りも 1 つの関数を指します。
  • uiop:when-letuiop:when-let* — alexandria の名前ですが、 すでに使っているプログラムがあるため残しています。本家 UIOP は if-let だけを エクスポートしています。