This repository has been archived on 2024-10-22. You can view files and clone it, but cannot push or open issues or pull requests.
spacemacs/core/config-system.el

431 lines
18 KiB
EmacsLisp

(require 'dotspacemacs)
(require 'ht)
(defconst config-system-contrib-directory
(expand-file-name (concat user-emacs-directory "contrib/"))
"Spacemacs contribution layers base directory.")
(defconst config-system-private-directory
(expand-file-name (concat user-emacs-directory "private/"))
"Spacemacs private layers base directory.")
(defvar config-system-config-layers '()
"Alist of configuration layers with the form (symbol . plist) where
SYMBOL is the name of the layer and PLIST is a property list with the following
keys:
:contrib if t then the layer is a contribution layer.
:dir the absolute path to the base directory of the layer.
:ext-dir the absolute path to the directory containing the extensions.
")
(defvar config-system-all-packages #s(hash-table size 256 data ())
"Hash table of all declared packages in all layers where the key is a package
symbol and the value is a list of layer symbols responsible for initializing
and configuring the package.")
(defvar config-system-all-pre-extensions #s(hash-table size 128 data ())
"Hash table of all declared pre-extensions in all layers where the key is a
extension symbol and the value is the layer symbols responsible for initializing
and configuring the package.")
(defvar config-system-all-post-extensions #s(hash-table size 128 data ())
"Hash table of all declared post-extensions in all layers where the key is a
extension symbol and the value is the layer symbols responsible for initializing
and configuring the package.")
(defvar config-system-layer-paths #s(hash-table size 128 data ())
"Hash table of layers locations where the key is a layer symbol and the value
is its path.")
(defvar config-system-contrib-categories '("usr" "lang")
"List of strings corresponding to category names. A category is a
sub-directory of the contribution directory.")
(defvar config-system-excluded-packages-from-layers '()
"List of all excluded packages declared at the layer level.")
(defun config-system/package.el-initialize ()
"Initialize package.el"
(require 'package)
(unless package--initialized
(setq package-archives '(("ELPA" . "http://tromey.com/elpa/")
("gnu" . "http://elpa.gnu.org/packages/")
("melpa" . "http://melpa.org/packages/")))
(package-initialize)
;; Emacs 24.3 and above ships with python.el but in some Emacs 24.3.1 packages
;; for Ubuntu, python.el seems to be missing.
;; This hack adds marmalade repository for this case only.
(unless (or (package-installed-p 'python) (version< emacs-version "24.3"))
(add-to-list 'package-archives
'("marmalade" . "http://marmalade-repo.org/packages/")))
(setq warning-minimum-level :error)))
(defun config-system/create-layer (name)
"Ask the user for a configuration layer name and create a layer with this
name in the private layers directory."
(interactive "sConfiguration layer name: ")
(let ((layer-dir (config-system//get-private-layer-dir name)))
(cond
((string-equal "" name)
(message "Cannot create a configuration layer without a name."))
((file-exists-p layer-dir)
(message "Cannot create configuration layer \"%s\", this layer already exists."
name))
(t
(make-directory layer-dir)
(config-system//copy-template "extensions")
(config-system//copy-template "packages")
(message "Configuration layer \"%s\" successfully created." name))
)))
(defun config-system//get-private-layer-dir (name)
"Return an absolute path the the private configuration layer with name
NAME."
(concat config-system-private-directory name "/"))
(defun config-system//copy-template (template)
"Copy and replace special values of TEMPLATE to LAYER_DIR."
(let ((src (concat spacemacs-template-directory
(format "%s.template" template)))
(dest (concat (config-system//get-private-layer-dir name)
(format "%s.el" template))))
(copy-file src dest)
(find-file dest)
(save-excursion
(goto-char (point-min))
(while (re-search-forward "NAME" nil t)
(replace-match name t)))
(save-buffer)))
(defun config-system/declare-layer (sym &optional contrib)
"Declare a layer with SYM name (symbol). If CONTRIB is non nil then the layer
is a contribution layer."
(let* ((sym-name (symbol-name sym))
(base-dir (if contrib
(ht-get config-system-layer-paths sym)
user-emacs-directory))
(dir (format "%s%s/" base-dir sym-name))
(ext-dir (format "%sextensions/" dir)))
(push (cons sym (list :contrib contrib :dir dir :ext-dir ext-dir))
config-system-config-layers)))
(defun config-system//get-contrib-category-dirs ()
"Return a list of all absolute paths to the contribution categories stored
in `config-system-contrib-categories'"
(mapcar
(lambda (d) (expand-file-name
(concat config-system-contrib-directory (format "%s/" d))))
config-system-contrib-categories))
(defun config-system/discover-layers ()
"Fill the hash table `config-system-layer-paths' where the key is the
layer symbol and the value is its path."
(let ((cat-dirs (config-system//get-contrib-category-dirs)))
(mapc 'config-system/discover-layers-in-dir
(append (list config-system-contrib-directory)
cat-dirs
dotspacemacs-configuration-layer-path
;; load private layers at the end on purpose
;; we asume that the user layers must have the final word
;; on configuration choices.
(list config-system-private-directory)))))
(defun config-system/discover-layers-in-dir (dir)
"Fill the hash table `config-system-layer-paths' where the key is the
layer symbol and the value is its path for all layers found in directory DIR.
Also fill the list of excluded packages `config-system-excluded-packages-from-layers'
declared at the layer level."
(spacemacs/message "Looking for contribution layers in %s" dir)
(ignore-errors
(let ((files (directory-files dir nil nil 'nosort))
(filter-out (append config-system-contrib-categories '("." ".."))))
(dolist (f files)
(when (and (file-directory-p (concat dir f))
(not (member f filter-out)))
(spacemacs/message "-> Discovered contribution layer: %s" f)
(puthash (intern f) dir config-system-layer-paths))))))
(defun config-system/load-layers ()
"Load all declared layers."
(config-system/load-layer-files '("funcs.el" "config.el"))
(config-system/read-packages-and-extensions)
(config-system/initialize-extensions config-system-all-pre-extensions)
(config-system/install-packages)
(spacemacs/append-to-buffer spacemacs-loading-text)
(config-system/initialize-packages)
(config-system/initialize-extensions config-system-all-post-extensions)
(config-system/load-layer-files '("keybindings.el")))
(defun config-system/load-layer-files (files)
"Load the files of list FILES from all declared layers."
(dolist (layer (reverse config-system-config-layers))
(let* ((sym (car layer))
(dir (plist-get (cdr layer) :dir)))
(dolist (file files)
(let ((file (concat dir file)))
(if (file-exists-p file)
(load file)))))))
(defsubst config-system//add-layer-to-hash (pkg layer hash)
"Add LAYER to the list which the value stored in HASH with key PKG."
(let ((list (ht-get hash pkg)))
(puthash pkg (add-to-list 'list layer t) hash)))
(defun config-system//add-excluded-packages (layer)
"Add excluded packages declared in LAYER."
(let ((excl-var (intern (format "%s-excluded-packages" (symbol-name layer)))))
(when (boundp excl-var)
(setq config-system-excluded-packages-from-layers
(append config-system-excluded-packages-from-layers
(eval excl-var))))))
(defsubst config-system//filter-out-excluded-packages ()
"Remove excluded packages from the hash tables."
(mapc (lambda (h)
(dolist (x (ht-keys (eval h)))
(when (or (member x dotspacemacs-excluded-packages)
(member x config-system-excluded-packages-from-layers))
(ht-remove (eval h) x))))
'(config-system-all-packages
config-system-all-pre-extensions
config-system-all-post-extensions)))
(defun config-system/read-packages-and-extensions ()
"Load all packages and extensions declared in all layers and fill the
corresponding hash tables:
config-system-all-packages
config-system-all-pre-extensions
config-system-all-post-extensions "
(dolist (layer (reverse config-system-config-layers))
(let* ((sym (car layer))
(dir (plist-get (cdr layer) :dir))
(pkg-file (concat dir "packages.el"))
(ext-file (concat dir "extensions.el")))
(progn
;; packages
(when (file-exists-p pkg-file)
(load pkg-file)
(dolist (pkg (eval (intern (format "%s-packages" (symbol-name sym)))))
(config-system//add-excluded-packages sym)
(config-system//add-layer-to-hash pkg sym config-system-all-packages)))
;; extensions
(when (file-exists-p ext-file)
(load ext-file)
(dolist (pkg (eval (intern (format "%s-pre-extensions"
(symbol-name sym)))))
(config-system//add-excluded-packages sym)
(config-system//add-layer-to-hash pkg sym
config-system-all-pre-extensions))
(dolist (pkg (eval (intern (format "%s-post-extensions"
(symbol-name sym)))))
(config-system//add-excluded-packages sym)
(config-system//add-layer-to-hash pkg sym
config-system-all-post-extensions))))))
(config-system//filter-out-excluded-packages)
;; number of chuncks for the loading screen
(let ((total (+ (ht-size config-system-all-packages)
(ht-size config-system-all-pre-extensions)
(ht-size config-system-all-post-extensions))))
(setq spacemacs-loading-dots-chunk-threshold
(/ total spacemacs-loading-dots-chunk-count))))
(defun config-system/install-packages ()
"Install the packages all the packages if there are not currently installed."
(interactive)
(let* ((pkg-list (ht-keys config-system-all-packages))
(sorted-pkg-list (mapcar 'intern
(sort (mapcar 'symbol-name pkg-list)
'string<)))
(not-installed (remove-if 'package-installed-p sorted-pkg-list))
(not-installed-count (length not-installed)))
;; installation
(if not-installed
(progn
(spacemacs/append-to-buffer
(format "Found %s new package(s) to install...\n"
not-installed-count))
(spacemacs/append-to-buffer
"--> fetching new package repository indexes...\n")
(redisplay)
(package-refresh-contents)
(setq installed-count 0)
(dolist (pkg not-installed)
(setq installed-count (1+ installed-count))
(spacemacs/replace-last-line-of-buffer
(format "--> installing %s:%s... [%s/%s]"
(ht-get config-system-all-packages pkg)
pkg
installed-count
not-installed-count) t)
(when (not (package-installed-p pkg))
(package-install pkg))
(redisplay))
(spacemacs/append-to-buffer "\n")))))
(defun config-system/initialize-packages ()
"Initialize all the declared packages."
(ht-each 'config-system/initialize-package config-system-all-packages))
(defun config-system/initialize-package (pkg layers)
"Initialize the package PKG from the configuration layers LAYERS."
(dolist (layer layers)
(let* ((init-func (intern (format "%s/init-%s" (symbol-name layer) pkg))))
(spacemacs/loading-animation)
(if (and (package-installed-p pkg) (fboundp init-func))
(progn (spacemacs/message "Initializing %s:%s..."
(symbol-name layer) pkg)
(funcall init-func))))))
(defun config-system/initialize-extensions (ext-list)
"Initialize all the declared extensions in EXT-LIST hash table."
(ht-each 'config-system/initialize-extension ext-list))
(defun config-system/initialize-extension (ext layers)
"Initialize the extension EXT from the configuration layer LSYM."
(dolist (layer layers)
(let* ((l (assq layer config-system-config-layers))
(ext-dir (plist-get (cdr l) :ext-dir))
(init-func (intern (format "%s/init-%s" (symbol-name layer) ext))))
(add-to-list 'load-path (format "%s%s/" ext-dir ext))
(spacemacs/loading-animation)
(spacemacs/message "Initializing %s:%s..." (symbol-name layer) ext)
(if (fboundp init-func) (funcall init-func)))))
(defun config-system/initialized-packages-count ()
"Return the number of initialized packages and extensions."
(+ (ht-size config-system-all-packages)
(ht-size config-system-all-pre-extensions)
(ht-size config-system-all-post-extensions)))
(defun config-system/declare-dotspacemacs-configuration-layers ()
"Declare the configuration layer in order of appearance in list
`dotspacemacs-configuration-layers' defined in ~/.spacemacs."
(config-system/discover-layers)
(if (boundp 'dotspacemacs-configuration-layers)
(dolist (layer dotspacemacs-configuration-layers)
(config-system/declare-layer layer t))))
(defun config-system/get-layer-property (symlayer prop)
"Return the value of the PROPerty for the given SYMLAYER symbol."
(let* ((layer (assq symlayer config-system-config-layers)))
(plist-get (cdr layer) prop)))
(defun config-system/get-packages-dependencies ()
"Returns a hash map where key is a dependency package symbol and value is
a list of all packages which depend on it."
(let ((result #s(hash-table size 200 data ())))
(dolist (pkg package-alist)
(let* ((pkg-sym (car pkg))
(deps (config-system/get-package-dependencies pkg-sym)))
(dolist (dep deps)
(let* ((dep-sym (car dep))
(value (ht-get result dep-sym)))
(puthash dep-sym
(if value (add-to-list 'value pkg-sym) (list pkg-sym))
result)))))
result))
(defun config-system/get-implicit-packages ()
"Returns a list of all packages in `packages-alist' which are not found
in `config-system-all-packages'"
(let ((imp-pkgs))
(dolist (pkg package-alist)
(let ((pkg-sym (car pkg)))
(if (not (ht-contains? config-system-all-packages pkg-sym))
(add-to-list 'imp-pkgs pkg-sym))))
imp-pkgs))
(defun config-system/get-orphan-packages (implicit-pkgs dependencies)
"Return a list of all orphan packages which are basically meant to be
deleted safely."
(let ((result '()))
(dolist (imp-pkg implicit-pkgs)
(if (config-system//is-package-orphan imp-pkg dependencies)
(add-to-list 'result imp-pkg)))
result))
(defun config-system//is-package-orphan (pkg dependencies)
"Returns not nil if PKG is an orphan package."
(if (ht-contains? config-system-all-packages pkg)
nil
(if (ht-contains? dependencies pkg)
(let ((parents (ht-get dependencies pkg)))
(reduce (lambda (x y) (and x y))
(mapcar (lambda (p) (config-system//is-package-orphan
p dependencies))
parents)
:initial-value t))
(not (ht-contains? config-system-all-packages pkg)))))
(defun config-system/get-package-dependencies (package)
"Return the dependencies alist for PACKAGE."
(let ((pkg (assq package package-alist)))
(cond
((version< emacs-version "24.4") (aref (cdr pkg) 1))
(t (package-desc-reqs (cadr pkg))))))
(defun config-system/get-package-version (package)
"Return the version string for PACKAGE."
(let ((pkg (assq package package-alist)))
(cond
((version< emacs-version "24.4")
(package-version-join (aref (cdr pkg) 0)))
(t
(package-version-join (package-desc-version (cadr pkg)))))))
(defun config-system/package-delete (package)
"Delete the passed PACKAGE."
(cond
((version< emacs-version "24.4")
(package-delete (symbol-name package)
(config-system/get-package-version package)))
(t
(package-delete (cadr (assq package package-alist))))))
(defun config-system/delete-orphan-packages ()
"Delete all the orphan packages."
(interactive)
(let* ((dependencies (config-system/get-packages-dependencies))
(implicit-packages (config-system/get-implicit-packages))
(orphans (config-system/get-orphan-packages implicit-packages
dependencies))
(orphans-count (length orphans)))
;; (message "dependencies: %s" dependencies)
;; (message "implicit: %s" implicit-packages)
;; (message "orphans: %s" orphans)
(if orphans
(progn
;; for the loading dot bar
(spacemacs/append-to-buffer "OK!\n")
(spacemacs/append-to-buffer
(format "Found %s orphan package(s) to delete...\n"
orphans-count))
(setq deleted-count 0)
(dolist (orphan orphans)
(setq deleted-count (1+ deleted-count))
(spacemacs/replace-last-line-of-buffer
(format "--> deleting %s... [%s/%s]"
orphan
deleted-count
orphans-count) t)
(config-system/package-delete orphan)
(redisplay))
(spacemacs/append-to-buffer "\n"))
(spacemacs/message "No orphan package to delete."))))
(defun config-system/setup-after-init-hook ()
"Add post init processing."
(add-hook 'after-init-hook
(lambda ()
(spacemacs/append-to-buffer (format "%s\n" spacemacs-loading-done-text))
;; from jwiegley
;; https://github.com/jwiegley/dot-emacs/blob/master/init.el
(let ((elapsed (float-time
(time-subtract (current-time) emacs-start-time))))
(spacemacs/append-to-buffer
(format "[%s packages loaded in %.3fs]\n"
(config-system/initialized-packages-count)
elapsed))))))
(provide 'config-system)