231fc9cf53
Due to a technical limitation of Emacs <=28, launching Emacs out of a non-standard location is non-trivial, and `doom run` tries to promise that it can do so on demand. Emacs 29 does introduce a --init-directory switch that would make this easy, but it'll be some time before we can rely on it. So 'doom run' creates a fake $HOME in /tmp/doom.run/ and writes a bootloader there to load your Doom config remotely. But there's a problem: in this fake $HOME, none of the user's config, cache, data, or binscript directories are available, so I symlink them there. This should at least resolve the most trivial incompatibilities (like the lack of all-the-icons fonts, which typically get installed to $HOME/.local/share/fonts/ -- see #6807), but there may be yet more edge cases. Still, this is a good enough compromise for now. Fix: #6807
120 lines
4.5 KiB
EmacsLisp
120 lines
4.5 KiB
EmacsLisp
;;; lisp/cli/run.el --- launching Emacs in a sandbox -*- lexical-binding: t; -*-
|
|
;;; Commentary:
|
|
;;; Code:
|
|
|
|
;;
|
|
;;; Variables
|
|
|
|
;; None yet!
|
|
|
|
|
|
;;
|
|
;;; Commands
|
|
|
|
(defcli! run
|
|
(;; TODO Implement sandbox functionality post-3.0
|
|
;; (daemon? ("--daemon"))
|
|
;; (window-type ("--gui" "--tty"))
|
|
;; (version ("--with-emacs" version))
|
|
;; (doomversion ("--with-doom" version))
|
|
;; (profile ("--profile" name))
|
|
(repl? ("--repl") "Launch an elisp REPL")
|
|
;; &multiple
|
|
;; (calls ("-f" "--funcall" fn))
|
|
;; (loads ("-l" "--load" file))
|
|
;; (evals ( "--eval" form))
|
|
&context context
|
|
&input input
|
|
&rest args)
|
|
"Launch Doom Emacs or an Emacs sandbox
|
|
|
|
Opens from bin/doom's parent directory.
|
|
|
|
Keep in mind there is some overhead opening Doom this way. For the best
|
|
performance, it is best to run Doom out of ~/.config/emacs or ~/.emacs.d."
|
|
:benchmark nil
|
|
;; TODO Implement sandbox functionality post-3.0
|
|
;; (when version
|
|
;; (unless (executable-find "nix-shell")
|
|
;; (user-error "--emacs option is not supported without nix"))
|
|
;; ...)
|
|
(if repl?
|
|
(if input
|
|
;; Evaluate piped-in text directly, if given.
|
|
(eval (read input) t)
|
|
(doom-run-repl context))
|
|
(let* ((tempdir (doom-path (temporary-file-directory) "doom.run"))
|
|
(tempemacsdir (doom-path tempdir ".emacs.d")))
|
|
(delete-directory tempdir t) ; start from scratch
|
|
(make-directory tempemacsdir t)
|
|
;; HACK: So that Emacs doesn't lose track of local state, like user fonts,
|
|
;; configs, or binscripts, we symlink these to the sandbox.
|
|
;; REVIEW: Use `--init-directory' when we drop 29 support OR when Doom is
|
|
;; in bootloader mode.
|
|
(dolist (dir (list (or (getenv "XDG_DATA_HOME") "~/.local/share")
|
|
(or (getenv "XDG_BIN_HOME") "~/.local/bin")
|
|
(or (getenv "XDG_CONFIG_HOME") "~/.config")
|
|
(or (getenv "XDG_CACHE_HOME") "~/.cache")))
|
|
(let* ((xdg-dir (doom-path dir))
|
|
(target (doom-path tempdir (file-relative-name xdg-dir "~"))))
|
|
(when (file-directory-p xdg-dir)
|
|
(unless (file-symlink-p target)
|
|
(make-directory (file-name-directory target) t)
|
|
(make-symbolic-link xdg-dir target)))))
|
|
(with-temp-file (doom-path tempemacsdir "early-init.el")
|
|
(prin1 `(progn
|
|
(setenv "HOME" ,(getenv "HOME"))
|
|
(setenv "EMACSDIR" ,doom-emacs-dir)
|
|
(setenv "DOOMDIR" ,doom-user-dir)
|
|
(setenv "DOOMPROFILE" ,(getenv "DOOMPROFILE"))
|
|
(setq early-init-file ,(doom-path doom-emacs-dir "early-init.el"))
|
|
(load early-init-file nil (not ,init-file-debug) 'nosuffix))
|
|
(current-buffer)))
|
|
(exit! (format "HOME=%S %s %s"
|
|
tempdir
|
|
invocation-name
|
|
(combine-and-quote-strings args))))))
|
|
|
|
|
|
;;
|
|
;;; Helpers
|
|
|
|
(defun doom-run-repl (context)
|
|
"Launch a rudimentary Elisp REPL."
|
|
;; I wrote this for fun; not with any serious intention of adding a
|
|
;; fully-fledged REPL to the Doom CLI. Still, I occasionally need to check
|
|
;; something, and once this has nix integration and can sandbox Emacs versions
|
|
;; separately, it may be useful for quick tests and demos.
|
|
(let (form)
|
|
(while (setq form (read-from-minibuffer "(elisp) $ "))
|
|
(when (member form '(":quit" ":q"))
|
|
(print! "\nGoodbye!")
|
|
(exit! 0))
|
|
(let (debug-on-error)
|
|
(condition-case e
|
|
(print! "%S" (eval (read form) t))
|
|
(error
|
|
(let* ((n 0)
|
|
(frame (backtrace-frame n))
|
|
(frame-list nil)
|
|
(in-program-stack t))
|
|
(while frame
|
|
(when in-program-stack
|
|
(push (cdr frame) frame-list))
|
|
;; (when (eq (elt frame 1) 'doom-run-repl)
|
|
;; (setq in-program-stack t))
|
|
(when (eq (elt frame 1) 'doom-run-repl)
|
|
(setq in-program-stack nil))
|
|
(setq n (1+ n)
|
|
frame (backtrace-frame n)))
|
|
(let* ((depth doom-cli-backtrace-depth)
|
|
(print-escape-newlines t))
|
|
(print! (error "There was an unexpected error"))
|
|
(print-group!
|
|
(print! "%s %s" (bold "Message:") (error-message-string e))
|
|
(print! "%s %S" (bold "Details:") (cdr e))))))))
|
|
(terpri))))
|
|
|
|
(provide 'doom-cli-run)
|
|
;;; run.el ends here
|