Compare commits
11 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
89d2b7226b
|
|||
|
2c53218cc7
|
|||
|
f59a472204
|
|||
|
f9113b7a35
|
|||
|
d145705a61
|
|||
|
9e6fecc94a
|
|||
|
20d0682f39
|
|||
|
d248447cb0
|
|||
|
36b964a993
|
|||
|
661ae7c87d
|
|||
|
382bb55064
|
@@ -22,6 +22,7 @@ macOS. PR are welcome if you want to fix that!
|
||||
* Table of Contents :TOC_2_gh:
|
||||
- [[#introduction][Introduction]]
|
||||
- [[#recent-breaking-changes][Recent Breaking Changes]]
|
||||
- [[#081][~0.8.1~]]
|
||||
- [[#070][~0.7.0~]]
|
||||
- [[#installation][Installation]]
|
||||
- [[#customizing][Customizing]]
|
||||
@@ -33,6 +34,11 @@ macOS. PR are welcome if you want to fix that!
|
||||
- [[#license][License]]
|
||||
|
||||
* Recent Breaking Changes
|
||||
** ~0.8.1~
|
||||
Version ~0.8.1~ removes the optional argument ~REMOTE~ from
|
||||
~eshell-info-banner--executable-find~. It now only acts according to the
|
||||
user’s preference set with ~eshell-info-banner-tramp-aware~.
|
||||
|
||||
** ~0.7.0~
|
||||
Version ~0.7.0~ renames several functions to conform with the Elisp
|
||||
Coding Conventions.
|
||||
|
||||
@@ -2,8 +2,8 @@
|
||||
|
||||
;; Author: Lucien Cartier-Tilet <lucien@phundrak.com>
|
||||
;; Maintainer: Lucien Cartier-Tilet <lucien@phundrak.com>
|
||||
;; Version: 0.8.0
|
||||
;; Package-Requires: ((emacs "25.1") (f "0.20") (s "1"))
|
||||
;; Version: 0.8.5
|
||||
;; Package-Requires: ((emacs "25.1") (s "1"))
|
||||
;; Homepage: https://github.com/Phundrak/eshell-info-banner.el
|
||||
|
||||
;; This file is not part of GNU Emacs
|
||||
@@ -60,12 +60,20 @@
|
||||
; Constants ;
|
||||
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
|
||||
|
||||
(defconst eshell-info-banner-path-separator
|
||||
(substring-no-properties (file-relative-name (expand-file-name "x" "y")) 1 2)
|
||||
"File separator used by the current operating system.")
|
||||
|
||||
(defconst eshell-info-banner--min-length-left 8
|
||||
"Minimum length of text on the left hand side of the banner.")
|
||||
|
||||
(eval-when-compile
|
||||
(defconst eshell-info-banner--macos-versions
|
||||
'(("10.4" . "Mac OS X Tiger")
|
||||
'(("10.0" . "Mac OS X Cheetah")
|
||||
("10.1" . "Mac OS X Puma")
|
||||
("10.2" . "Mac OS X Jaguar")
|
||||
("10.3" . "Mac OS X Panther")
|
||||
("10.4" . "Mac OS X Tiger")
|
||||
("10.5" . "Mac OS X Leopard")
|
||||
("10.6" . "Mac OS X Snow Leopard")
|
||||
("10.7" . "Mac OS X Lion")
|
||||
@@ -84,9 +92,15 @@
|
||||
("11.3" . "macOS Big Sur")
|
||||
("11.4" . "macOS Big Sur")
|
||||
("11.5" . "macOS Big Sur")
|
||||
("11.6" . "macOS Big Sur"))
|
||||
("11.6" . "macOS Big Sur")
|
||||
("12.0" . "macOS Monterey")
|
||||
("12.1" . "macOS Monterey")
|
||||
("12.2" . "macOS Monterey"))
|
||||
"Versions of OSX and macOS and their name."))
|
||||
|
||||
(defconst eshell-info-banner--posix-shells '("bash" "zsh" "sh")
|
||||
"List of POSIX-compliant shells to run external commands through.")
|
||||
|
||||
|
||||
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
|
||||
; Custom variables ;
|
||||
@@ -140,18 +154,18 @@
|
||||
:type 'list
|
||||
:version "0.3.0")
|
||||
|
||||
(defun eshell-info-banner--executable-find (program &optional remote)
|
||||
"Find PROGRAM executable, possibly on a REMOTE machine.
|
||||
(defun eshell-info-banner--executable-find (program)
|
||||
"Find PROGRAM executable, possibly on a remote machine.
|
||||
This is a wrapper around `executable-find' in order to avoid
|
||||
issues with older versions of the functions only accepting one
|
||||
argument."
|
||||
argument. `executable-find'’s remote argument has the value of
|
||||
`eshell-info-banner-tramp-aware'."
|
||||
(if (version< emacs-version "27.1")
|
||||
(let ((default-directory (if (and eshell-info-banner-tramp-aware
|
||||
remote)
|
||||
(let ((default-directory (if eshell-info-banner-tramp-aware
|
||||
default-directory
|
||||
"~")))
|
||||
(executable-find program))
|
||||
(executable-find program remote)))
|
||||
(executable-find program eshell-info-banner-tramp-aware)))
|
||||
|
||||
(defcustom eshell-info-banner-duf-executable "duf"
|
||||
"Path to the `duf' executable."
|
||||
@@ -209,19 +223,27 @@ argument."
|
||||
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
|
||||
|
||||
(defmacro eshell-info-banner--with-face (str &rest properties)
|
||||
"Helper macro for applying face `PROPERTIES' to `STR'."
|
||||
"Helper macro for applying face PROPERTIES to STR."
|
||||
`(propertize ,str 'face (list ,@properties)))
|
||||
|
||||
(defun eshell-info-banner--shell-command-to-string (command)
|
||||
"Execute shell command COMMAND and return its output as a string.
|
||||
Ensures the command is ran with LANG=C."
|
||||
(shell-command-to-string (format "LANG=C %s" command)))
|
||||
(let ((shell (or (seq-find (lambda (shell)
|
||||
(eshell-info-banner--executable-find shell))
|
||||
eshell-info-banner--posix-shells)
|
||||
"sh")))
|
||||
(with-temp-buffer
|
||||
(call-process shell nil t nil "-c" (concat "LANG=C " command))
|
||||
(buffer-string))))
|
||||
|
||||
(defun eshell-info-banner--progress-bar-without-prefix (bar-length used total &optional newline)
|
||||
"Display a progress bar without its prefix.
|
||||
Display a progress bar of BAR-LENGTH length, followed by an
|
||||
indication of how full the memory is with a human readable USED
|
||||
and TOTAL size."
|
||||
and TOTAL size.
|
||||
Optional argument NEWLINE: Whether to output a newline at the end
|
||||
of the progress bar."
|
||||
(let ((percentage (if (= used 0)
|
||||
0
|
||||
(/ (* 100 used) total))))
|
||||
@@ -267,7 +289,7 @@ If the executable `uptime' is not found, return nil."
|
||||
path size used percent)
|
||||
|
||||
(defun eshell-info-banner--get-longest-path (partitions)
|
||||
"Return the length of the longest partition path in `PARTITIONS'.
|
||||
"Return the length of the longest partition path in PARTITIONS.
|
||||
|
||||
The returned value is in any case greater than
|
||||
`eshell-info-banner--min-length-left'."
|
||||
@@ -277,34 +299,43 @@ The returned value is in any case greater than
|
||||
(length (eshell-info-banner--mounted-partitions-path partition)))))))
|
||||
|
||||
(defun eshell-info-banner--abbr-path (path &optional abbr)
|
||||
"Remove `$HOME' from `PATH', abbreviate parent dirs if `ABBR' non nil.
|
||||
"Remove `$HOME' from PATH, abbreviate parent dirs if ABBR non nil.
|
||||
|
||||
Abbreviate `PATH' by removing the value of `HOME' if it is
|
||||
present in the former, and if `ABBR' is t then all parent
|
||||
directories of the current `PATH' are abbreviated to only one
|
||||
character. If an abbreviated directory starts with a dot, then
|
||||
include it before the abbreviated name of the directory,
|
||||
e.g. \".config\" -> \".c\".
|
||||
Abbreviate PATH by removing the value of HOME if it is present in
|
||||
the former, and if ABBR is t then all parent directories of the
|
||||
current PATH are abbreviated to only one character. If an
|
||||
abbreviated directory starts with a dot, then include it before
|
||||
the abbreviated name of the directory, e.g. \".config\" ->
|
||||
\".c\".
|
||||
|
||||
For public use, `PATH' should be a string representing a UNIX
|
||||
path. For internal use, `PATH' can also be a list. If `PATH' is
|
||||
neither of these, an error will be thrown by the function."
|
||||
For public use, PATH should be a string representing a UNIX path.
|
||||
For internal use, PATH can also be a list. If PATH is neither of
|
||||
these, an error will be thrown by the function."
|
||||
(cond
|
||||
((stringp path) (abbreviate-file-name
|
||||
(if abbr
|
||||
(eshell-info-banner--abbr-path
|
||||
(f-split (eshell-info-banner--abbr-path path)))
|
||||
path)))
|
||||
((stringp path)
|
||||
(let ((abbr-path (abbreviate-file-name path)))
|
||||
(if abbr
|
||||
(abbreviate-file-name
|
||||
(eshell-info-banner--abbr-path
|
||||
(split-string abbr-path eshell-info-banner-path-separator t)))
|
||||
abbr-path)))
|
||||
((null path) "")
|
||||
((listp path)
|
||||
(f-join (if (= (length path) 1)
|
||||
(car path)
|
||||
(let* ((dir (car path))
|
||||
(first-char (substring dir 0 1)))
|
||||
(if (string= "." first-char)
|
||||
(substring dir 0 2)
|
||||
first-char)))
|
||||
(eshell-info-banner--abbr-path (cdr path))))
|
||||
(let ((file (eshell-info-banner--abbr-path (cdr path)))
|
||||
(directory (if (= (length path) 1)
|
||||
(car path)
|
||||
(let* ((dir (car path))
|
||||
(first-char (substring dir 0 1)))
|
||||
(if (string= "." first-char)
|
||||
(substring dir 0 2)
|
||||
first-char)))))
|
||||
(if (string= "" file)
|
||||
directory
|
||||
(let ((relative-p (not (file-name-absolute-p directory)))
|
||||
(new-dir (expand-file-name file directory)))
|
||||
(if relative-p
|
||||
(file-relative-name new-dir)
|
||||
new-dir)))))
|
||||
(t (error "Invalid argument %s, neither stringp or listp" path))))
|
||||
|
||||
(defun eshell-info-banner--get-mounted-partitions-duf ()
|
||||
@@ -413,7 +444,7 @@ Return detected partitions as a list of structs."
|
||||
nil)))))
|
||||
|
||||
(defun eshell-info-banner--partition-to-string (partition text-padding bar-length)
|
||||
"Display a progress bar showing how full a `PARTITION' is.
|
||||
"Display a progress bar showing how full a PARTITION is.
|
||||
|
||||
For TEXT-PADDING and BAR-LENGTH, see the documentation of
|
||||
`eshell-info-banner--display-memory'."
|
||||
@@ -451,19 +482,80 @@ For TEXT-PADDING and BAR-LENGTH, see the documentation of
|
||||
"\n"
|
||||
t)))
|
||||
|
||||
(defun eshell-info-banner--get-memory-unix ()
|
||||
"Get memory usage for UNIX systems.
|
||||
Compatible with Darwin and FreeBSD at least."
|
||||
(let* ((command-to-mem (lambda (command)
|
||||
(string-to-number
|
||||
(defun eshell-info-banner--get-memory-unix-command-to-mem (command)
|
||||
"Get the output of COMMAND corresponding to memory information.
|
||||
This function is to be only used on platforms which support sysctl."
|
||||
(string-to-number
|
||||
(s-trim
|
||||
(car (last
|
||||
(split-string (eshell-info-banner--shell-command-to-string command)
|
||||
" "
|
||||
t))))))
|
||||
|
||||
(defun eshell-info-banner--get-memory-netbsd ()
|
||||
"Get memory usage for NetBSD systems.
|
||||
See `eshell-info-banner--get-memory'."
|
||||
(let* ((total (eshell-info-banner--get-memory-unix-command-to-mem "sysctl hw.physmem64"))
|
||||
(used (- total
|
||||
(* 1024 (string-to-number
|
||||
(s-trim
|
||||
(cadr
|
||||
(split-string (eshell-info-banner--shell-command-to-string command)
|
||||
" "
|
||||
t)))))))
|
||||
`(("RAM"
|
||||
,(apply command-to-mem '("sysctl hw.physmem"))
|
||||
,(apply command-to-mem '("sysctl hw.usermem"))))))
|
||||
(with-temp-buffer
|
||||
(insert-file-contents-literally "/proc/meminfo")
|
||||
(save-match-data
|
||||
(string-match (rx bol
|
||||
"MemFree:"
|
||||
(* blank)
|
||||
(group (+ digit))
|
||||
(* blank)
|
||||
"kB")
|
||||
(buffer-string))
|
||||
(substring-no-properties (buffer-string)
|
||||
(match-beginning 1)
|
||||
(match-end 1))))))))))
|
||||
`(("RAM" ,total ,used))))
|
||||
|
||||
(defun eshell-info-banner--get-memory-darwin ()
|
||||
"Get memory usage for Darwin systems.
|
||||
See `eshell-info-banner--get-memory'."
|
||||
(let* ((total (eshell-info-banner--get-memory-unix-command-to-mem "sysctl -n hw.memsize"))
|
||||
(vmstat (with-temp-buffer
|
||||
(call-process "vm_stat" nil t nil)
|
||||
(buffer-string)))
|
||||
(wired (save-match-data
|
||||
(string-match (rx " wired" (* (not digit)) (+ blank) (group (+ digit)) ".")
|
||||
vmstat)
|
||||
(* 1024 4
|
||||
(string-to-number (substring-no-properties vmstat
|
||||
(match-beginning 1)
|
||||
(match-end 1))))))
|
||||
(active (save-match-data
|
||||
(string-match (rx " active" (* (not digit)) (+ blank) (group (+ digit)) ".")
|
||||
vmstat)
|
||||
(* 1024 4
|
||||
(string-to-number (substring-no-properties vmstat
|
||||
(match-beginning 1)
|
||||
(match-end 1))))))
|
||||
(compressed (save-match-data
|
||||
(if (string-match (rx " occupied" (* (not digit)) (+ blank) (group (+ digit)) ".")
|
||||
vmstat)
|
||||
(* 1024 4
|
||||
(string-to-number (substring-no-properties vmstat
|
||||
(match-beginning 1)
|
||||
(match-end 1))))
|
||||
0))))
|
||||
`(("RAM" ,total ,(+ wired active compressed)))))
|
||||
|
||||
(defun eshell-info-banner--get-memory-unix ()
|
||||
"Get memory usage for UNIX systems."
|
||||
(cond ((and (equal system-type 'berkeley-unix)
|
||||
(string-match-p "NetBSD" (eshell-info-banner--shell-command-to-string "uname")))
|
||||
(eshell-info-banner--get-memory-netbsd))
|
||||
((equal system-type 'darwin)
|
||||
(eshell-info-banner--get-memory-darwin))
|
||||
(t
|
||||
(let* ((total (eshell-info-banner--get-memory-unix-command-to-mem "sysctl hw.physmem"))
|
||||
(used (eshell-info-banner--get-memory-unix-command-to-mem "sysctl hw.usermem")))
|
||||
`(("RAM" ,total ,used))))))
|
||||
|
||||
(defun eshell-info-banner--get-memory-windows ()
|
||||
"Get memory usage for Window."
|
||||
@@ -491,16 +583,16 @@ in bytes."
|
||||
(defun eshell-info-banner--memory-to-string (type total used text-padding bar-length)
|
||||
"Display a memory’s usage with a progress bar.
|
||||
|
||||
The `TYPE' of memory will be the text on the far left, while
|
||||
`USED' and `TOTAL' will be displayed on the right of the progress
|
||||
bar. From them, a percentage will be computed which will be used
|
||||
to display a colored percentage of the progress bar and it will
|
||||
be displayed on the far right.
|
||||
The TYPE of memory will be the text on the far left, while USED
|
||||
and TOTAL will be displayed on the right of the progress bar.
|
||||
From them, a percentage will be computed which will be used to
|
||||
display a colored percentage of the progress bar and it will be
|
||||
displayed on the far right.
|
||||
|
||||
`TEXT-PADDING' will determine how many dots are necessary between
|
||||
`TYPE' and the colon.
|
||||
TEXT-PADDING will determine how many dots are necessary between
|
||||
TYPE and the colon.
|
||||
|
||||
`BAR-LENGTH' determines the length of the progress bar to be
|
||||
BAR-LENGTH determines the length of the progress bar to be
|
||||
displayed."
|
||||
(concat (s-pad-right text-padding "." type)
|
||||
": "
|
||||
@@ -516,10 +608,10 @@ bars will have this appearance:
|
||||
|
||||
TYPE......: [=========] XXG / XXG (XX%)
|
||||
|
||||
`TEXT-PADDING': the space allocated to the text at the left of the
|
||||
TEXT-PADDING: the space allocated to the text at the left of the
|
||||
progress bar.
|
||||
|
||||
`BAR-LENGTH': the length of the progress bar."
|
||||
BAR-LENGTH: the length of the progress bar."
|
||||
(mapconcat (lambda (mem)
|
||||
(eshell-info-banner--memory-to-string (nth 0 mem) (nth 1 mem)
|
||||
(nth 2 mem) text-padding
|
||||
@@ -531,7 +623,7 @@ progress bar.
|
||||
; Display information ;;;;;;;;;;;;;;;;;
|
||||
|
||||
(defun eshell-info-banner--get-color-percentage (percentage)
|
||||
"Display a `PERCENTAGE' with its according face."
|
||||
"Display a PERCENTAGE with its according face."
|
||||
(let ((percentage (if (stringp percentage)
|
||||
(string-to-number percentage)
|
||||
percentage)))
|
||||
@@ -543,12 +635,12 @@ progress bar.
|
||||
(t 'eshell-info-banner-normal-face))))
|
||||
|
||||
(defun eshell-info-banner--progress-bar (length percentage &optional invert)
|
||||
"Display a progress bar `LENGTH' long and `PERCENTAGE' full.
|
||||
"Display a progress bar LENGTH long and PERCENTAGE full.
|
||||
The full path will be displayed filled with the character
|
||||
specified by `eshell-info-banner-progress-bar-char' up to
|
||||
`PERCENTAGE' percents. The rest will be empty.
|
||||
PERCENTAGE percents. The rest will be empty.
|
||||
|
||||
If `INVERT' is t, then consider the percentage to approach
|
||||
If INVERT is t, then consider the percentage to approach
|
||||
critical levels close to 0 rather than 100."
|
||||
(let* ((length-filled (if (= 0 percentage)
|
||||
0
|
||||
@@ -570,9 +662,9 @@ critical levels close to 0 rather than 100."
|
||||
(defun eshell-info-banner--display-battery (text-padding bar-length)
|
||||
"If the computer has a battery, display its level.
|
||||
|
||||
Pad the left text with dots by `TEXT-PADDING' characters.
|
||||
Pad the left text with dots by TEXT-PADDING characters.
|
||||
|
||||
`BAR-LENGTH' indicates the length in characters of the progress
|
||||
BAR-LENGTH indicates the length in characters of the progress
|
||||
bar.
|
||||
|
||||
The usage of `eshell-info-banner-warning-percentage' and
|
||||
@@ -580,7 +672,9 @@ The usage of `eshell-info-banner-warning-percentage' and
|
||||
thought of as the “percentage of discharge” of the computer.
|
||||
Thus, setting the warning at 75% will be translated as showing
|
||||
the warning face with a battery level of 25% or less."
|
||||
(let ((battery-level (when (file-readable-p "/sys/") (battery))))
|
||||
(let ((battery-level (unless (and (equal system-type 'gnu/linux)
|
||||
(not (file-readable-p "/sys/")))
|
||||
(battery))))
|
||||
(if (or (null battery-level)
|
||||
(string= battery-level "Battery status not available")
|
||||
(string-match-p (regexp-quote "N/A") battery-level))
|
||||
@@ -662,7 +756,7 @@ If RELEASE-FILE is nil, use '/etc/os-release'."
|
||||
(insert-file-contents (concat prefix "/bedrock/etc/bedrock-release"))
|
||||
(buffer-string))))
|
||||
;; Proxmox
|
||||
((eshell-info-banner--executable-find "pveversion" eshell-info-banner-tramp-aware)
|
||||
((eshell-info-banner--executable-find "pveversion")
|
||||
(let ((distro (eshell-info-banner--shell-command-to-string "pveversion")))
|
||||
(save-match-data
|
||||
(string-match "/\\([^/]+\\)/" distro)
|
||||
@@ -670,9 +764,9 @@ If RELEASE-FILE is nil, use '/etc/os-release'."
|
||||
(substring-no-properties distro
|
||||
(match-beginning 1)
|
||||
(match-end 1))))))
|
||||
((eshell-info-banner--executable-find "hostnamectl" eshell-info-banner-tramp-aware)
|
||||
((eshell-info-banner--executable-find "hostnamectl")
|
||||
(eshell-info-banner--get-os-information-from-hostnamectl))
|
||||
((eshell-info-banner--executable-find "lsb_release" eshell-info-banner-tramp-aware)
|
||||
((eshell-info-banner--executable-find "lsb_release")
|
||||
(eshell-info-banner--get-os-information-from-lsb-release))
|
||||
((file-exists-p (concat prefix "/etc/os-release"))
|
||||
(eshell-info-banner--get-os-information-from-release-file))
|
||||
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 38 KiB After Width: | Height: | Size: 54 KiB |
Reference in New Issue
Block a user