aboutsummaryrefslogtreecommitdiff
path: root/modules/external-open.el
diff options
context:
space:
mode:
authorCraig Jennings <c@cjennings.net>2026-05-10 14:42:04 -0500
committerCraig Jennings <c@cjennings.net>2026-05-10 14:42:04 -0500
commit16396d25c2795bd7f8822a695de111d07f588b26 (patch)
treec452c193c1eb813cedcd3b4faca030d8775da4a3 /modules/external-open.el
parentc44a52a7905b605a6537e3ff9bb4fe3afede0485 (diff)
downloaddotemacs-16396d25c2795bd7f8822a695de111d07f588b26.tar.gz
dotemacs-16396d25c2795bd7f8822a695de111d07f588b26.zip
refactor(external-open): consolidate OS-open dispatch in external-open.el
Phase 4 of utility-consolidation. Three previously-overlapping helpers (system-utils' `cj/identify-external-open-command' and `cj/--open-with-is-launcher-p', plus the dirvish-only `cj/--file-manager-program-for' shipped earlier today) all answered "which OS-open program should I run?". Pull the answer into one place: external-open.el. Move and rename: - `cj/--open-with-is-launcher-p' (system-utils) -> `cj/external-open-launcher-p' (external-open). Public name now matches its module. - `cj/identify-external-open-command' (system-utils) -> `cj/external-open-command' (external-open). Returns nil for unsupported hosts instead of signaling -- callers that need a command must handle nil explicitly. The wrapper `cj/xdg-open' (also moved into external-open) converts nil to a `user-error' with a clear message, preserving the user-facing failure shape. - Delete dirvish's `cj/--file-manager-program-for' helper. `cj/dirvish-open-file-manager-here' now calls `cj/external-open-command' directly. The shell-command fallback for nil-program preserves the previous escape hatch. Break the system-utils <-> external-open recursive require by moving `cj/xdg-open' (the only system-utils function that external-open used) into external-open along with the dispatch. Tests reorganized to match the move. Two new test files (`test-external-open-command.el', `test-external-open-launcher-p.el') replace the two system-utils-named test files. The dirvish file-manager-program test goes away with the helper. 11 tests covering Normal/Boundary/Error for the dispatch (plus the new "unsupported host returns nil" contract). Add `(require \='external-open)' to system-utils.el and `(require \='system-lib)' to external-open.el (for `cj/file-from-context' which xdg-open uses).
Diffstat (limited to 'modules/external-open.el')
-rw-r--r--modules/external-open.el47
1 files changed, 46 insertions, 1 deletions
diff --git a/modules/external-open.el b/modules/external-open.el
index 9eddf352..c9b5f1f6 100644
--- a/modules/external-open.el
+++ b/modules/external-open.el
@@ -21,8 +21,8 @@
;;
;;; Code:
-(require 'system-utils) ;; for xdg-open and others
(require 'host-environment) ;; environment information functions
+(require 'system-lib) ;; for cj/file-from-context
(require 'cl-lib)
;; Declare platform-specific functions
@@ -89,6 +89,51 @@
: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*."
+ (interactive)
+ (let* ((file (expand-file-name
+ (or (cj/file-from-context filename)
+ (user-error "No file associated with this buffer"))))
+ (cmd (or (cj/external-open-command)
+ (user-error "External-open: unsupported host environment")))
+ (logbuf (get-buffer-create "*external-open.log*")))
+ (with-current-buffer logbuf
+ (goto-char (point-max))
+ (insert (format-time-string "[%Y-%m-%d %H:%M:%S] "))
+ (insert (format "Opening: %s\n" file)))
+ (cond
+ ((env-windows-p)
+ (w32-shell-execute "open" file))
+ (t
+ (call-process cmd nil 0 nil file)
+ (with-current-buffer logbuf
+ (insert " → Launched asynchronously\n"))))
+ nil))
+
;; ------------------------------- Open File With ------------------------------
(defun cj/open-this-file-with (command)