Evaluate eshell-info-banner-path-separator on compile

eshell-info-banner.el

@@ -2,8 +2,8 @@
 
 ;; Author: Lucien Cartier-Tilet <lucien@phundrak.com>
 ;; Maintainer: Lucien Cartier-Tilet <lucien@phundrak.com>
-;; Version: 0.8.3
-;; Package-Requires: ((emacs "25.1") (f "0.20") (s "1"))
+;; Version: 0.8.6
+;; 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,6 +60,11 @@
                                         ;              Constants              ;
 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 
+(eval-when-compile
+  (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.")
 
@@ -219,7 +224,7 @@ argument. `executable-find'’s remote argument has the value of
 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 
 (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)
@@ -237,7 +242,9 @@ Ensures the command is ran with LANG=C."
   "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))))
@@ -283,7 +290,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'."
@@ -293,34 +300,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 ()
@@ -429,7 +445,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'."
@@ -468,6 +484,8 @@ For TEXT-PADDING and BAR-LENGTH, see the documentation of
                         t)))
 
 (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
@@ -478,7 +496,7 @@ For TEXT-PADDING and BAR-LENGTH, see the documentation of
 (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")))
+  (let* ((total (eshell-info-banner--get-memory-unix-command-to-mem "sysctl hw.physmem64"))
          (used  (- total
                    (* 1024 (string-to-number
                             (s-trim
@@ -566,16 +584,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)
           ": "
@@ -591,10 +609,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
@@ -606,7 +624,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)))
@@ -618,12 +636,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
@@ -645,9 +663,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