昨日の続き。
前回はファイルのスコアが書かれているCSVファイルを元にDired内のファイルをソートしてみましたが、これだけだとパッと見何の順番で並んでいるのかよく分かりませんよね。やはりファイルの一覧の中にスコアの数字そのものも表示されていないとピンときません。なので今回はDiredのファイル行の中に、ファイルに関連した任意の情報を追加する方法について考えてみようと思います。
勝手にファイル情報を追加しても大丈夫なのか
前回も書いたとおりDiredは単なるテキストバッファですから、勝手に書き替えてしまえば済む話です。本当に? 結論としては、たぶん、概ね問題ないと思います。
Diredはファイルに関する情報を変数の形では保持しておらず、全てバッファ内のテキストとして保持しています。なのでファイル名を始め全ての情報は何かコマンドを実行するたびにバッファ内のテキストから毎回抽出しなければなりません。デフォルトの -al
オプションでファイルリストを作成すると、ファイル行には左から順にファイルの種類(d)、モードビット、ハードリンク数、所有者名、グループ名、サイズ、タイムスタンプ、そしてファイル名が並びます(シンボリックリンクの場合はその後に ->
で始まる部分が追加されます)。この中で一番重要なのは当然一番右のファイル名ですが、その位置を正確に割り出すのは案外面倒な問題が伴います。そんな中で、ファイル名の左側に好きな情報を勝手に追加してしまっても大丈夫なのでしょうか。
大丈夫なのです。ファイル名の左にどんなテキストを追加してもDiredは正確にファイル名の位置を割り出すことが出来ます。
insert-directoryの秘密
その秘密はinsert-directory
という関数にあります。この関数はlsの出力をバッファに挿入する関数です(lsが無い環境ではls-lisp.elでエミュレートします)。lsと同じようにファイルパスとスイッチを引数に取ります。今回注目すべきは、スイッチとして --dired
を指定したときの挙動です。GNUのlsには --dired
(または-D)というオプションがあり、これが指定されているとlsは出力の最後にファイル名部分の範囲を先頭からの文字数で列挙してくれます。例えば次のように。
> ls -al --dired total 684 drwxr-xr-x 1 user user 0 11月 27 18:36 ./ drwxr-xr-x 1 user user 0 11月 30 15:31 ../ -rw-r--r-- 1 user user 1948 9月 25 16:55 compface.el -rw-r--r-- 1 user user 906 10月 26 18:46 compface.elc -rw-r--r-- 1 user user 12701 9月 25 16:55 exif.el -rw-r--r-- 1 user user 7640 10月 26 18:46 exif.elc -rw-r--r-- 1 user user 13135 9月 25 16:55 gravatar.el -rw-r--r-- 1 user user 9698 10月 26 18:46 gravatar.elc -rw-r--r-- 1 user user 14269 9月 25 16:55 image-converter.el -rw-r--r-- 1 user user 10276 10月 26 18:46 image-converter.elc -rw-r--r-- 1 user user 17854 9月 25 16:55 image-crop.el -rw-r--r-- 1 user user 13474 10月 26 18:46 image-crop.elc -rw-r--r-- 1 user user 84378 10月 16 04:24 image-dired.el -rw-r--r-- 1 user user 83477 10月 26 18:46 image-dired.elc -rw-r--r-- 1 user user 17044 9月 25 16:55 image-dired-dired.el -rw-r--r-- 1 user user 18328 10月 26 18:46 image-dired-dired.elc -rw-r--r-- 1 user user 29509 9月 25 16:55 image-dired-external.el -rw-r--r-- 1 user user 21633 10月 26 18:46 image-dired-external.elc -rw-r--r-- 1 user user 13209 9月 25 16:55 image-dired-tags.el -rw-r--r-- 1 user user 9952 10月 26 18:46 image-dired-tags.elc -rw-r--r-- 1 user user 8924 9月 25 16:55 image-dired-util.el -rw-r--r-- 1 user user 7195 10月 26 18:46 image-dired-util.elc -rw-r--r-- 1 user user 23171 9月 25 16:55 wallpaper.el -rw-r--r-- 1 user user 24016 10月 26 18:46 wallpaper.elc //DIRED// 59 60 109 111 160 171 219 231 279 286 334 342 390 401 449 461 509 527 575 594 642 655 703 717 765 779 827 842 890 910 958 979 1027 1050 1098 1122 1170 1189 1237 1257 1305 1324 1372 1392 1440 1452 1500 1513 //DIRED-OPTIONS// --quoting-style=literal
末尾の //DIRED//
で始まる行の後に並ぶ数字はファイル名部分の範囲を示しています。最初は59ですが、これは最初のファイル名の先頭が出力の先頭から数えて59文字目にあることを意味しています。次の60はファイル名の末尾の位置を同様に表します。つまり、一番最初の .
を指しています。以下同様に続きます。
そして重要なのは、insert-directory
はこの情報を読み取ってバッファ内のファイル名が書かれている範囲にテキストプロパティ dired-filename=t を設定するということです。
なので行の中にあるファイル名を表す範囲を特定するにはテキストプロパティが設定されている範囲を探すだけで良く、その前にどんなテキストがあってもそのテキストプロパティが存在する限り(少なくともファイル名を特定するには)問題ありません。そのテキストプロパティが設定されている場所を探す関数がdired-move-to-filename
とdired-move-to-end-of-filename
です。その中を見れば行末までの間にある dired-filename
という名前のテキストプロパティを探していることが分かります。(注:これらの関数を見るとテキストプロパティが検出できなかったときの処理も書かれていて、正規表現検索によってファイル位置の範囲を特定しようとしています。なので100%問題ないとは言い切れない部分がありますが、今回はその辺りは無視することにします)
実際に追加してみる
前回書いたコードの中から流用できるものを引っ張ってきましょう。
サンプルのCSV。
muscat.html,230 melon.html,140 grape.html,185 cherry.html,210 strawberry.html,153
これを読む関数。
(defun my-dired-sort-read-file-score (dir) (ignore-errors (with-temp-buffer (insert-file-contents (file-name-concat dir ".file-score.csv")) (goto-char (point-min)) (cl-loop until (eobp) for (file score) = (split-string (buffer-substring (point) (line-end-position)) ",") collect (cons (expand-file-name file dir) (string-to-number score)) do (forward-line)))))
一つのディレクトリの中のファイルリストの範囲を特定する関数。
(defun my-dired-next-dir-files-region () ;; ファイル名が無いところをスキップ (while (and (null (dired-move-to-filename)) (= (forward-line) 0))) (unless (eobp) (let ((beg (line-beginning-position))) ;; ファイル名があるところをスキップ (while (and (dired-move-to-filename) (= (forward-line) 0))) (cons beg (line-beginning-position)))))
それでファイルリストの中にスコアの数字を挿入する関数を作成します。
(defun my-dired-add-file-score-to-region (beg end) (when-let ((file-score-alist (my-dired-sort-read-file-score (dired-current-directory)))) (goto-char beg) (while (< (point) end) ;; 各行について (when (dired-move-to-filename) ;; ファイル名の先頭へ移動 ;; ファイル名とスコアを取得 (let* ((file (dired-get-filename nil t)) (score (alist-get file file-score-alist nil nil #'string=))) ;; 1文字左へ移動 (backward-char) ;; スコアを挿入 (insert (if score (format " %3d" score) " ")))) ;; 次の行へ (forward-line))))
バッファ内にある全ディレクトリに対してこれを適用する関数を作成します。前回作った my-dired-sort-by-file-score
関数とほとんど同じですが、今回は挿入すると末尾の位置がずれていくためマーカーを使用しています。そして my-dired-sort-region-by-file-score
の代わりに今作った my-dired-add-file-score-to-region
を呼び出すようにすればOKです。
(defun my-dired-add-file-score () (interactive nil dired-mode) (widen) (goto-char (point-min)) (let ((inhibit-read-only t)) (while-let ((files-region (my-dired-next-dir-files-region))) (let ((beg (car files-region)) (end (copy-marker (cdr files-region)))) (my-dired-add-file-score-to-region beg end) (goto-char end) (set-marker end nil)))))
前回作ったソートコマンドと一緒に使ってみるとDiredバッファは次のような見た目になりました。
c:/home/user/tmp/my-dired: drwxr-xr-x 1 user user 0 11月 30 23:14 . drwxr-xr-x 1 user user 0 11月 30 23:13 .. -rw-r--r-- 1 user user 87 11月 30 23:14 .file-score.csv -rw-r--r-- 1 user user 7 11月 30 23:13 140 melon.html -rw-r--r-- 1 user user 12 11月 30 23:14 153 strawberry.html -rw-r--r-- 1 user user 7 11月 30 23:13 185 grape.html -rw-r--r-- 1 user user 8 11月 30 23:13 210 cherry.html -rw-r--r-- 1 user user 8 11月 30 23:13 230 muscat.html
スコアが表示され、その順番でファイルが並んでいることが分かります。