145 lines
5.4 KiB
EmacsLisp
145 lines
5.4 KiB
EmacsLisp
;;; treemacs.el --- A tree style file viewer package -*- lexical-binding: t -*-
|
|
|
|
;; Copyright (C) 2024 Alexander Miller
|
|
|
|
;; This program is free software; you can redistribute it and/or modify
|
|
;; it under the terms of the GNU General Public License as published by
|
|
;; the Free Software Foundation, either version 3 of the License, or
|
|
;; (at your option) any later version.
|
|
|
|
;; This program is distributed in the hope that it will be useful,
|
|
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
;; GNU General Public License for more details.
|
|
|
|
;; You should have received a copy of the GNU General Public License
|
|
;; along with this program. If not, see <https://www.gnu.org/licenses/>.
|
|
|
|
;;; Commentary:
|
|
|
|
;; Handling of visuals in general and icons in particular.
|
|
|
|
;;; Code:
|
|
|
|
(require 'image)
|
|
(require 'pulse)
|
|
(require 'hl-line)
|
|
(require 'treemacs-core-utils)
|
|
(require 'treemacs-scope)
|
|
(require 'treemacs-themes)
|
|
(require 'treemacs-icons)
|
|
(require 'treemacs-customization)
|
|
(require 'treemacs-fringe-indicator)
|
|
(require 'treemacs-logging)
|
|
|
|
(eval-when-compile
|
|
(require 'inline)
|
|
(require 'treemacs-macros))
|
|
|
|
(treemacs-import-functions-from "treemacs-icons"
|
|
treemacs-get-icon-value)
|
|
|
|
(defvar-local treemacs--indentation-string-cache-key nil
|
|
"Cache key for `treemacs--indentation-string-cache.")
|
|
(defvar-local treemacs--indentation-string-cache (vector)
|
|
"Cached propertized indentation.")
|
|
|
|
(defvar treemacs--indent-guide-mode nil)
|
|
|
|
(defvar treemacs--saved-indent-settings nil
|
|
"Saved settings overridden by `treemacs-indent-guide-mode'.
|
|
Used to save the values of `treemacs-indentation' and
|
|
`treemacs-indentation-string'.")
|
|
|
|
(defun treemacs--do-pulse (face)
|
|
"Visually pulse current line using FACE."
|
|
(pulse-momentary-highlight-one-line (point) face))
|
|
|
|
(defsubst treemacs-pulse-on-success (&rest log-args)
|
|
"Pulse current line with `treemacs-on-success-pulse-face'.
|
|
Optionally issue a log statement with LOG-ARGS."
|
|
(declare (indent 1))
|
|
(when log-args
|
|
(treemacs-log (apply #'format log-args)))
|
|
(when treemacs-pulse-on-success
|
|
(treemacs--do-pulse 'treemacs-on-success-pulse-face)))
|
|
|
|
(defsubst treemacs-pulse-on-failure (&rest log-args)
|
|
"Pulse current line with `treemacs-on-failure-pulse-face'.
|
|
Optionally issue a log statement with LOG-ARGS."
|
|
(declare (indent 1))
|
|
(when log-args
|
|
(treemacs-log-failure (apply #'format log-args)))
|
|
(when treemacs-pulse-on-failure
|
|
(treemacs--do-pulse 'treemacs-on-failure-pulse-face)))
|
|
|
|
(defun treemacs--build-indentation-cache (depth)
|
|
"Rebuild indentation string cache up to DEPTH levels deep."
|
|
(setq treemacs--indentation-string-cache
|
|
(make-vector (1+ depth) nil)
|
|
treemacs--indentation-string-cache-key
|
|
(cons treemacs-indentation treemacs-indentation-string))
|
|
(dotimes (i (1+ depth))
|
|
(aset treemacs--indentation-string-cache i
|
|
(cond
|
|
((listp treemacs-indentation-string)
|
|
(let ((str nil)
|
|
(len (length treemacs-indentation-string)))
|
|
(dotimes (n i)
|
|
(setf str (concat str
|
|
(nth (% n len) treemacs-indentation-string))))
|
|
str))
|
|
((integerp treemacs-indentation)
|
|
(s-repeat (* i treemacs-indentation) treemacs-indentation-string))
|
|
((not window-system)
|
|
(s-repeat (* i 2) treemacs-indentation-string))
|
|
(t (propertize " "
|
|
'display
|
|
`(space . (:width (,(* (car treemacs-indentation)
|
|
i))))))))))
|
|
|
|
(define-inline treemacs--get-indentation (depth)
|
|
"Gets an indentation string DEPTH levels deep."
|
|
(inline-letevals (depth)
|
|
(inline-quote
|
|
(progn
|
|
(when (or (>= ,depth (length treemacs--indentation-string-cache))
|
|
(not (eq (car treemacs--indentation-string-cache-key) treemacs-indentation))
|
|
;; Eq is faster than string comparison, and accidentally
|
|
;; rebuilding the cache in some corner case is not disastrous.
|
|
(not (eq (cdr treemacs--indentation-string-cache-key) treemacs-indentation-string)))
|
|
(treemacs--build-indentation-cache ,depth))
|
|
(aref treemacs--indentation-string-cache ,depth)))))
|
|
|
|
(define-minor-mode treemacs-indent-guide-mode
|
|
"Toggle `treemacs-indent-guide-mode'.
|
|
When enabled treemacs will show simple indent guides for its folder structure.
|
|
The effect is achieved by overriding the values of `treemacs-indentation' and
|
|
`treemacs-indentation-string'. Disabling the mode will restore the previously
|
|
used settings."
|
|
:init-value nil
|
|
:global t
|
|
:lighter nil
|
|
:group 'treemacs
|
|
(if treemacs-indent-guide-mode
|
|
(progn
|
|
(setf
|
|
treemacs--saved-indent-settings
|
|
(cons treemacs-indentation treemacs-indentation-string)
|
|
treemacs-indentation 1
|
|
treemacs-indentation-string
|
|
(pcase-exhaustive treemacs-indent-guide-style
|
|
('line (propertize " ┃ " 'face 'font-lock-comment-face))
|
|
('block (list
|
|
" "
|
|
(propertize "██" 'face 'font-lock-comment-face))))))
|
|
(setf treemacs-indentation (car treemacs--saved-indent-settings)
|
|
treemacs-indentation-string (cdr treemacs--saved-indent-settings)))
|
|
(treemacs-without-messages
|
|
(treemacs-run-in-every-buffer
|
|
(treemacs--do-refresh (current-buffer) 'all))))
|
|
|
|
(provide 'treemacs-visuals)
|
|
|
|
;;; treemacs-visuals.el ends here
|