lisper は何をしますか?
運用ルール
このスキルを一連のアサーションとして使用してください。各アサーションは、満たされているか、違反されているか、ユーザー制約によって明示的に延期されているものとして扱ってください。好みの主張よりも正確なコードファクトを優先してください。アサーションを真にするパッケージ、シンボル、構造体、条件、マクロ展開、不変条件、テスト、または副作用境界に名前を付けてください。
ファクトを述べてください。証人に名前を付けてください。好みを論じないでください。
Common Lisp または Emacs Lisp コードについて報告するときは、短い宣言文で書いてください:
- 不変条件はコンストラクタにあります。
- 動的エクステントは
unwind-protectによって境界されています。 - マクロが評価順序を漏洩させています。
- 条件は構造化されています。
- 破壊的リスト操作が呼び出し元の構造を変更しています。
- 述語が裸です。
- コンパイラ警告が残っています。
- バッファ効果が純粋コアに漏洩しています。
アサーション
-
コードはモデルを描画します。S式はテキストである前に構文木です。問題のすべての実状態を保存してください。シンボル、タグ付き構造体 (
defstruct/cl-defstruct)、CLOS クラス、または明示的なコンストラクタを持つ代数的 alist/plist を使用してください。意味的に使用されていない区別のみを消去してください。 -
高階関数はマクロが書き換える前に合成します。Lisp はまずラムダ計算です:関数は第一級の値であり、クロージャはレキシカル環境を運び、カリー化 (
apply-partiallyまたは(lambda (x) ...)を返す) は多パラメータ配管を置き換えます。同じ構造が2回現れたら検査し、3回現れたら高階コンビネータ、カリー化クロージャ、またはジェネリック関数で抽象化してください——決して10引数の手続き的ヘルパーではありません。マクロは、評価を制御したり、レキシカルシンボルを束縛したり、コンパイル時のボイラープレートを排除したりする場合にのみ導入してください。すべてのマクロは、値引数を左から右の順に最大1回評価し、テンポラリをgensym/make-symbol(with-gensyms) で束縛しなければなりません。 -
純粋なデータ変換はイメージの可変世界の外に留めてください。命令型の
let+setq+push+nreverseループよりも、カタモーフィズム (cl-reduce/seq-reduce)、準同型マッピング (mapcar/seq-keep)、述語パイプライン (seq-filter) を優先してください。純粋なシンボリック/リスト/構造体変換を、バッファ変更、プロセスIO、ファイルシステム状態、ネットワークストリーム、タイマー、グローバルスペシャル (*earmuffs*) から分離してください。コア関数は値を受け取り値を返します。ホスト効果は名前付き境界関数に留めてください。 -
レキシカルスコープがデフォルトの法則です。すべての Emacs Lisp ファイルは、1行目に
;; -*- lexical-binding: t; -*-で始めなければなりません。Common Lisp または Emacs Lisp のすべての動的特殊変数は*earmuffs*(CL の定数には+plus-signs+) を付け、グローバル設定を変更することが明示的な契約でない限り、setq/setfでグローバルに変更するのではなく、letで動的に再束縛しなければなりません。 -
不変条件は命題です。不変条件は、まず型 (
satisfies付きdeftype、ftype宣言、defstruct:typeスロット)、次にスマートコンストラクタ (:constructor)、3番目にランタイムアサーション (check-type/cl-check-type)、4番目にテスト、最後にコメントで表現してください。コンストラクタは、構造体がそのスロット不変条件を満たすことの証明です。 -
条件は代数的ファクトであり、生の文字列ではありません。明示的な条件階層を定義してください (Common Lisp では
define-condition、Emacs Lisp ではdefine-error)。呼び出し元がエラーメッセージの部分文字列を照合せずにhandler-case、handler-bind、またはcondition-caseで処理できるように、error/cerror/signalで構造化条件をシグナルしてください。回復ポリシーが呼び出し元に属し、メカニズムが低レベル関数に属する場合には、Common Lisp の再起動 (restart-case) を使用してください。 -
Consセルの所有権は意味論的な主張です。関数の名前とドキュメント文字列が明示的に破壊的動作を宣言していない限り (
nreverse、nconc、delete、sort、cl-delete、共有 cons セルへのsetf)、入力リスト、ツリー、シーケンスを不変として扱ってください。引用リテラル ('(a b c)) や借用した呼び出し元のリストに破壊的操作を決して適用しないでください。変更が始まる境界でのみ構造を複製してください (copy-list、copy-tree、copy-sequence)。 -
品質は証言されるのではなく、目撃されます。ゼロのバイトコンパイラ警告、ゼロの
checkdoc/package-lintエラー、ゼロの SBCLSTYLE-WARNING診断は最低限に過ぎません。純粋変換、マクロ展開法則、境界入力、非ローカル脱出時の動的クリーンアップ、修正された回帰に対する ERT (ert-deftest) または FiveAM/Rove/Parachute テストを追加してください。テスト名は、それが目撃する命題を述べます。 -
ドキュメントと名前空間プレフィックスは公開契約の一部です。
- Common Lisp では:
defpackage/uiop:define-packageで明示的なパッケージを定義し、:clを超える全面的な:use汚染を避けてください。エクスポートされたすべての関数、マクロ、クラス、変数、条件をドキュメント化してください。 - Emacs Lisp では:すべての公開シンボルに
<package>-を、すべての内部シンボルに<package>--をプレフィックスとして付けてください。最初の行が完全な文であり、パラメータ参照がUPPERCASEであるcheckdoc準拠のドキュメント文字列を書いてください。Package-Requiresと;;; Commentary:ヘッダーを正確に宣言してください。
- Common Lisp では:
-
リソースのライフタイムは動的エクステントによって境界付けられます。手動の割り当てとクリーンアップをエラーの可能性のある式とペアにしないでください。すべての一時的なバッファ変更、ポイント移動、ファイルハンドル、プロセス、ソケット、またはフックインストールを
unwind-protect(またはwith-open-file、with-temp-buffer、save-excursion、save-restriction、save-match-data) でラップしてください。非ローカル脱出 (throw、return-from、signal、error) はグローバル状態とバッファをクリーンなままにしなければなりません。 -
サイズと括弧のレイアウトは構造的な信号です。各ソースファイルを1000行未満に、各
defun/defmacro実行可能ボディ (ドキュメント文字列とdeclareフォームを除く) を80行未満に保ってください。ドキュメント文字列を切り詰めたり、説明コメントを削除したり、複数の逐次副作用フォームを1行に詰め込んで行数制限を逃れようとしないでください。閉じ括弧)))を単独で末尾行に配置しないでください。標準のLispフォームセマンティクスに従ってインデントしてください (すべての Elisp マクロに(declare (indent ...))を宣言)。ファイルと関数は、恣意的な行数スライスや曖昧なutilsバケットではなく、ドメイン命題によって分割してください。 -
ロジックには名前があります。
car/cdr/nthチェーン (cadddr)、入れ子のassoc/plist-get配管、またはマルチ節and/or/not式を、それらがドメイン命題を表現している場合に、呼び出しサイトで生で公開しないでください。-pまたはpで終わる名前付きアクセサと意味論的述語を定義してください (例:order-matchable-p、same-principal-p、session-active-p)。
モデル完全性
パッケージ、構造体、関数を選ぶ前に、コードを首尾一貫させる形式的モデルに名前を付けてください。
マクロと構文変換について:
- マクロは構文から構文へのコンパイラパスです: $\text{AST}{\text{surface}} \to \text{AST}{\text{core}}$。
- サーフェス文法 (分解ラムダリスト)、束縛規律、すべてのサブフォームの評価多重度、およびターゲット展開を指定してください。
macroexpand-1/macrostepで衛生性を検証してください:自由なシンボルキャプチャなし、副作用のある引数の複数評価なし、ランタイムevalなし。- マクロが定義に展開される場合、ホストコンパイラとインスペクターのためにソース位置と宣言 (
declare、ドキュメント文字列配置) を保持してください。
双方向状態、バッファ、並行プロセスについて:
- 双方向システムは、バッファやスレッドである前に状態遷移関係です。
- ドメイン状態値を、レンダリングバッファ (Emacs UI) やワーカースレッド/ソケット (CL/Emacs プロセス) から分離してください。
- 非同期プロセス出力 (Emacs プロセスフィルター/センチネル、CL スレッド/チャネル) を、完全な状態遷移を供給する個別のイベントとしてモデル化してください: $\text{State} \times \text{Event} \to (\text{State} \times \text{List}[\text{Effect}])$。
- Emacs Lisp のプロセスフィルターは任意のチャンク境界を受け取る可能性があります。ドメインイベントをディスパッチする前に、不完全なフレームを明示的にバッファリングして解析してください。
- タイマー、センチネル、またはコールバックが非同期的に発火するときは、バッファローカル状態 (
defvar-local) をキルされたバッファ (buffer-live-p) に対してガードしてください。
条件、再起動、非ローカル制御について:
- 何が間違ったか (条件データ) を、どのように回復するか (CL の再起動、Elisp の構造化ハンドラ) と、どの回復を選択するか (外部ポリシーハンドラ) から分離してください。
- 裸の
(ignore-errors ...)または(condition-case nil ... (error nil))で条件を飲み込まないでください。ただし、無視される正確な条件タイプが絞り込まれており、フォールバック値が有効なドメイン状態である場合を除きます。
形式的ロジックコメント
ftype、deftype、または cl-defstruct が完全に表現しない証明義務を明確にする場合にのみ、形式的コメントを使用してください。関数/フォーム内では ;;、トップレベルでは ;;; を使用し、標準のLispコメント階層に従ってください (;;;; セクション、;;; トップレベル、;; インライン、; マージン)。
;;; Pre: (and ( <= 0 start end (length sequence)) (listp sequence))
;;; Post: (and (equal result (subseq sequence start end))
;;; (not (eq result sequence)))
(defun slice-copy-checked (sequence start end)
"Return a fresh subsequence of SEQUENCE from START to END."
(check-type sequence list)
(assert (<= 0 start end (length sequence)))
(copy-list (subseq sequence start end)))
;;; Invariant: (null (intersection (work-set-pending ws) (work-set-completed ws) :test #'equal))
;;; Preservation: `work-set-complete' removes ID from `pending' before consing onto `completed'.
(defstruct (work-set (:copier nil))
(pending nil :type list)
(completed nil :type list))
;;; Law: (equal (decode-packet (encode-packet x)) x) for all valid packet structs X.
これらのフォームを優先してください:
Pre: 呼び出し元が満たさなければならない条件。Post: 関数が保証する条件。新しさ/共有 (eq対equal) を含みます。Invariant: 構造体/バッファ/セッション操作全体で保存される命題。Law: テストが目撃しなければならない代数的またはマクロ展開関係。Preservation: 遷移またはunwind-protectフォームが不変条件を真に保つ理由。
意味論的述語
Lisp の -p / p 規則に従った名前付き述語を使用して、ドメインロジックを宣言的に表現してください:
- 単語ルート (Common Lisp 規則):
evenp、Orderp->orderp、validp(または Elisp では、パッケージプレフィックス付きシンボルに対して一貫して-p)。 - ハイフン付きルート (CL と Elisp の両方):
order-matchable-p、same-principal-p、lispm-session-live-p。
次を優先してください:
(when (order-matchable-p order resting-order)
(match-order book order resting-order))
(when (same-principal-p actor owner)
(grant-access actor resource))
次を避けてください:
(when (and (not (eq (order-side order) (order-side resting-order)))
(>= (order-price order) (order-price resting-order))
(plusp (order-quantity order)))
(match-order book order resting-order))
(when (and (equal (principal-id actor) (principal-id owner))
(eq (principal-realm actor) (principal-realm owner)))
(grant-access actor resource))
また、深い位置リストアクセス ((cadddr record)、(nth 4 item)) をドメインロジックで避けてください。defstruct / cl-defstruct または名前付きアクセサ関数を定義して、呼び出しサイトが cons トポロジではなくドメインコンセプトを読むようにしてください。
実装規律
ドメインから始め、方言の関数型セマンティクスを尊重してください。
- カリー化、部分適用、コンビネータ:
- 呼び出し元の
let*バインディングを反映した6つ以上の位置パラメータを持つ手続き的ヘルパーを抽出したり、let*を単一使用のfoo--part-1/foo--part-2サブルーチンにスライスしたりして、長い関数を分解しないでください。 - ローカルの
let*がすでに提供するレキシカルスコープをシミュレートするために「偽のカリー化」(例:(lambda (getter-fn) (lambda () ...)))を導入しないでください。 - 代わりに、真のドメイン不変条件をレキシカルクロージャにカリー化し (
(defun domain--matcher (query role) (lambda (event) ...))または(apply-partially #'fn fixed-arg))、小さな単項/二項変換を合成してください: $f \circ g = \lambda x., f(g(x))$。 - 反復的な命令型ポーリング、サイクルセーフなグラフトラバーサル、またはリソースブラケットパターンを、ステップ関数
(funcall step item)を受け取り値を返す高階コンビネータに置き換えてください。
- 呼び出し元の
- 等価性の精度:
eql(数値/文字)、equal(構造的文字列/リスト)、またはequalp/ ドメイン等価性が必要な場合にeqを使用しないでください。型の同値関係に一致する最も厳密な等価述語を選択し、キーが文字列または複合値である場合には、assoc、member、gethash、remove、cl-findに明示的に:test #'equalを渡してください。 - Emacs Lisp 固有の注意点:
- 1行目は
;; -*- lexical-binding: t; -*-を宣言しなければなりません。 cl-lib(cl-defstruct、cl-loop、cl-destructuring-bind、cl-check-type) を使用し、非推奨のランタイムclパッケージは使用しないでください。- すべてのポイント、マーク、ナローイング、マッチデータの副作用を
save-excursion、save-restriction、save-match-dataでガードしてください。 - 非同期境界を越えて
current-bufferを仮定するよりも、バッファ受け渡しまたは明示的な(with-current-buffer buf ...)を優先してください。 - マクロに
(declare (indent ...) (debug ...))を注釈して、インデントと Edebug インストルメンテーションが自動的に機能するようにしてください。
- 1行目は
- Common Lisp 固有の注意点:
- 公開ドメイン関数に対して
(declaim (ftype (function (...) ...) name))を宣言して、SBCL がコンパイル時型推論と網羅性チェックを実行できるようにしてください。 - オープンエンドの
case/typecaseの代わりにetypecase/ecase/ctypecaseを使用して、未処理のバリアントがすぐに構造化型エラーをシグナルするようにしてください。 - リーダーテーブルの汚染と未エクスポートシンボルの漏洩 (
pkg::internal-sym) を避けてください。 - ASDF パッケージ推論型または明示的なシリアル
:componentsとクリーンな依存関係 DAG を優先してください。
- 公開ドメイン関数に対して
- 本番パスでの禁止構文:
- 関数をディスパッチしたりコードを構築したりするためのランタイム
evalは使用しないでください (funcall、apply、またはコンパイル時マクロを使用)。 - 宣言されていない自由変数への動的な
setqは使用しないでください。 - 引用リテラルまたは非所有の呼び出し元リストへのインプレース変更 (
nconc、nreverse、delete、sort) は使用しないでください。
- 関数をディスパッチしたりコードを構築したりするためのランタイム