summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorCraig Jennings <c@cjennings.net>2026-05-10 15:37:36 -0500
committerCraig Jennings <c@cjennings.net>2026-05-10 15:37:36 -0500
commit618bc7813b9acfcf1dfccc9c6590f6f5aece86cf (patch)
tree5719792c87bbc74ae380eb020a39d42b2ac86e48
parentf59ff9606fd96c6b1b9037ea5befb39b5e5a57b9 (diff)
downloaddotemacs-618bc7813b9acfcf1dfccc9c6590f6f5aece86cf.tar.gz
dotemacs-618bc7813b9acfcf1dfccc9c6590f6f5aece86cf.zip
refactor(external-open): extract external-open-lib for shared helpers
Same shared-helpers split-pattern that ai-vterm/vterm-config use through cj-window-toggle-lib and that calendar-sync uses through cj-org-text-lib. Pull the two pure dispatch helpers out of the external-open feature module into a sibling library so consumers that only need the dispatch don't have to require the whole feature. New `modules/external-open-lib.el' carries: - `cj/external-open-command' - `cj/external-open-launcher-p' `modules/external-open.el' stays as the feature module: the `default-open-extensions' defcustom, the `find-file' advice (`cj/find-file-auto'), and the interactive commands (`cj/xdg-open', `cj/open-this-file-with'). It now requires external-open-lib for the dispatch helpers. Migrate consumers: - system-utils.el used to require `external-open' for `cj/external-open-launcher-p' alone -- now requires `external-open-lib' directly. - dirvish-config.el calls `cj/external-open-command' from `cj/dirvish-open-file-manager-here' -- add an explicit `(require \='external-open-lib)'. Test files renamed to match the system-lib naming pattern (test-<library>-<feature>.el): - test-external-open-command.el -> test-external-open-lib-command.el - test-external-open-launcher-p.el -> test-external-open-lib-launcher-p.el No behavior change.
-rw-r--r--modules/dirvish-config.el1
-rw-r--r--modules/external-open-lib.el42
-rw-r--r--modules/external-open.el23
-rw-r--r--modules/system-utils.el2
-rw-r--r--tests/test-external-open-lib-command.el (renamed from tests/test-external-open-command.el)10
-rw-r--r--tests/test-external-open-lib-launcher-p.el (renamed from tests/test-external-open-launcher-p.el)10
6 files changed, 55 insertions, 33 deletions
diff --git a/modules/dirvish-config.el b/modules/dirvish-config.el
index d5834dac..bf91ae2e 100644
--- a/modules/dirvish-config.el
+++ b/modules/dirvish-config.el
@@ -27,6 +27,7 @@
(eval-when-compile (require 'system-utils))
(require 'host-environment)
(require 'system-lib)
+(require 'external-open-lib)
;; mark files in dirvish, attach in mu4e
(add-hook 'dired-mode-hook 'turn-on-gnus-dired-mode)
diff --git a/modules/external-open-lib.el b/modules/external-open-lib.el
new file mode 100644
index 00000000..aa90eb67
--- /dev/null
+++ b/modules/external-open-lib.el
@@ -0,0 +1,42 @@
+;;; external-open-lib.el --- Pure helpers for OS open-with dispatch -*- lexical-binding: t; -*-
+
+;; Author: Craig Jennings <c@cjennings.net>
+
+;;; Commentary:
+
+;; Pure helpers for resolving the OS-default "open" command and
+;; recognizing desktop launchers. No side effects, no state. The
+;; feature module (`external-open.el') uses these helpers; consumers
+;; that only need the dispatch (system-utils' "open with command",
+;; dirvish's "open file manager here") require this library directly
+;; instead of the feature module.
+;;
+;; Pulled out of `external-open.el' as part of utility-consolidation
+;; Phase 4. See `docs/design/utility-consolidation.org'.
+
+;;; Code:
+
+(require 'host-environment)
+
+(defun cj/external-open-command ()
+ "Return the OS-default \"open\" command for this host, or nil if unsupported.
+Returns one of \"xdg-open\" (Linux), \"open\" (macOS), \"start\" (Windows).
+Callers that require a command should error on nil with a contextual
+message so the user sees what feature is unavailable."
+ (cond
+ ((env-linux-p) "xdg-open")
+ ((env-macos-p) "open")
+ ((env-windows-p) "start")
+ (t nil)))
+
+(defun cj/external-open-launcher-p (command)
+ "Return non-nil when COMMAND is a desktop launcher.
+Launchers (xdg-open, open, start) need to be called with `call-process'
+and a zero BUFFER argument so they fully detach from Emacs. Other
+commands get `start-process-shell-command' so their output is visible."
+ (and (stringp command)
+ (member command '("xdg-open" "open" "start"))
+ t))
+
+(provide 'external-open-lib)
+;;; external-open-lib.el ends here
diff --git a/modules/external-open.el b/modules/external-open.el
index c9b5f1f6..0d6ec520 100644
--- a/modules/external-open.el
+++ b/modules/external-open.el
@@ -23,6 +23,7 @@
(require 'host-environment) ;; environment information functions
(require 'system-lib) ;; for cj/file-from-context
+(require 'external-open-lib) ;; pure dispatch helpers
(require 'cl-lib)
;; Declare platform-specific functions
@@ -89,28 +90,6 @@
:type '(repeat (regexp :tag "File extension regexp"))
:group 'external-open)
-;; ----------------------- External-Open Command Resolution -------------------
-
-(defun cj/external-open-command ()
- "Return the OS-default \"open\" command for this host, or nil if unsupported.
-Returns one of \"xdg-open\" (Linux), \"open\" (macOS), \"start\" (Windows).
-Callers that require a command should error on nil with a contextual
-message so the user sees what feature is unavailable."
- (cond
- ((env-linux-p) "xdg-open")
- ((env-macos-p) "open")
- ((env-windows-p) "start")
- (t nil)))
-
-(defun cj/external-open-launcher-p (command)
- "Return non-nil when COMMAND is a desktop launcher.
-Launchers (xdg-open, open, start) need to be called with `call-process'
-and a zero BUFFER argument so they fully detach from Emacs. Other
-commands get `start-process-shell-command' so their output is visible."
- (and (stringp command)
- (member command '("xdg-open" "open" "start"))
- t))
-
(defun cj/xdg-open (&optional filename)
"Open FILENAME (or the file at point) with the OS default handler.
Logs output and exit code to buffer *external-open.log*."
diff --git a/modules/system-utils.el b/modules/system-utils.el
index 008a5396..43200403 100644
--- a/modules/system-utils.el
+++ b/modules/system-utils.el
@@ -24,7 +24,7 @@
;;; Code:
(require 'system-lib)
-(require 'external-open)
+(require 'external-open-lib)
(declare-function dired-get-file-for-visit "dired" ())
(declare-function dired-file-name-at-point "dired" ())
diff --git a/tests/test-external-open-command.el b/tests/test-external-open-lib-command.el
index b408b305..7f54442c 100644
--- a/tests/test-external-open-command.el
+++ b/tests/test-external-open-lib-command.el
@@ -1,7 +1,7 @@
-;;; test-external-open-command.el --- Tests for cj/external-open-command -*- lexical-binding: t; -*-
+;;; test-external-open-lib-command.el --- Tests for cj/external-open-command -*- lexical-binding: t; -*-
;;; Commentary:
-;; Unit tests for `cj/external-open-command' in external-open.el. The
+;; Unit tests for `cj/external-open-command' in external-open-lib.el. The
;; function dispatches on host-environment predicates to return the
;; appropriate "open" command: xdg-open on Linux, open on macOS,
;; start on Windows. Returns nil for unsupported hosts (callers that
@@ -16,7 +16,7 @@
(setq package-user-dir (expand-file-name "elpa" user-emacs-directory))
(package-initialize)
(add-to-list 'load-path (expand-file-name "modules" user-emacs-directory))
-(require 'external-open)
+(require 'external-open-lib)
(defmacro test-eoc--with-host (linux macos windows &rest body)
"Run BODY with env-*-p predicates stubbed to LINUX, MACOS, WINDOWS."
@@ -61,5 +61,5 @@ user-error with a clear message."
(test-eoc--with-host nil nil nil
(should-not (cj/external-open-command))))
-(provide 'test-external-open-command)
-;;; test-external-open-command.el ends here
+(provide 'test-external-open-lib-command)
+;;; test-external-open-lib-command.el ends here
diff --git a/tests/test-external-open-launcher-p.el b/tests/test-external-open-lib-launcher-p.el
index 4aca3a55..928293b4 100644
--- a/tests/test-external-open-launcher-p.el
+++ b/tests/test-external-open-lib-launcher-p.el
@@ -1,7 +1,7 @@
-;;; test-external-open-launcher-p.el --- Tests for cj/external-open-launcher-p -*- lexical-binding: t; -*-
+;;; test-external-open-lib-launcher-p.el --- Tests for cj/external-open-launcher-p -*- lexical-binding: t; -*-
;;; Commentary:
-;; Unit tests for `cj/external-open-launcher-p' in external-open.el.
+;; Unit tests for `cj/external-open-launcher-p' in external-open-lib.el.
;; The predicate returns t for desktop launcher commands (xdg-open,
;; open, start) that need `call-process' with a zero buffer argument
;; to fully detach from Emacs. Anything else returns nil.
@@ -14,7 +14,7 @@
(setq package-user-dir (expand-file-name "elpa" user-emacs-directory))
(package-initialize)
(add-to-list 'load-path (expand-file-name "modules" user-emacs-directory))
-(require 'external-open)
+(require 'external-open-lib)
;;; Normal cases
@@ -51,5 +51,5 @@
"Error: nil input is handled gracefully (not in the launcher list)."
(should-not (cj/external-open-launcher-p nil)))
-(provide 'test-external-open-launcher-p)
-;;; test-external-open-launcher-p.el ends here
+(provide 'test-external-open-lib-launcher-p)
+;;; test-external-open-lib-launcher-p.el ends here