mirror of
https://github.com/ryuslash/mode-icons.git
synced 2024-11-22 01:50:28 +01:00
Cleanup documentation & code
This commit is contained in:
parent
323b48e416
commit
069cc21c7f
1 changed files with 14 additions and 11 deletions
|
@ -67,6 +67,7 @@
|
||||||
;;; Code:
|
;;; Code:
|
||||||
|
|
||||||
(require 'cl-lib)
|
(require 'cl-lib)
|
||||||
|
(require 'color)
|
||||||
|
|
||||||
(defgroup mode-icons nil
|
(defgroup mode-icons nil
|
||||||
"Provide icons for major modes."
|
"Provide icons for major modes."
|
||||||
|
@ -87,13 +88,14 @@ absolute path to ICON."
|
||||||
(concat mode-icons--directory "/icons/" icon))
|
(concat mode-icons--directory "/icons/" icon))
|
||||||
|
|
||||||
(defmacro mode-icons-save-buffer-state (&rest body)
|
(defmacro mode-icons-save-buffer-state (&rest body)
|
||||||
"Eval BODY,
|
"Eval BODY saving buffer state.
|
||||||
then restore the buffer state under the assumption that no significant
|
This macro restores the buffer state under the assumption that no
|
||||||
modification has been made in BODY. A change is considered
|
significant modification has been made in BODY. A change is
|
||||||
significant if it affects the buffer text in any way that isn't
|
considered significant if it affects the buffer text in any way
|
||||||
completely restored again. Changes in text properties like `face' or
|
that isn't completely restored again. Changes in text properties
|
||||||
`syntax-table' are considered insignificant. This macro allows text
|
like `face' or `syntax-table' are considered insignificant. This
|
||||||
properties to be changed, even in a read-only buffer.
|
macro allows text properties to be changed, even in a read-only
|
||||||
|
buffer.
|
||||||
|
|
||||||
This macro should be placed around all calculations which set
|
This macro should be placed around all calculations which set
|
||||||
\"insignificant\" text properties in a buffer, even when the buffer is
|
\"insignificant\" text properties in a buffer, even when the buffer is
|
||||||
|
@ -445,7 +447,7 @@ Use EVENT to determine location."
|
||||||
(defvar mode-icons-font-register-alist nil
|
(defvar mode-icons-font-register-alist nil
|
||||||
"Alist of characters supported.")
|
"Alist of characters supported.")
|
||||||
|
|
||||||
(defun mode-icons-supported-font-p (char font &optional dont-register)
|
(defun mode-icons-supported-font-p (char font)
|
||||||
"Determine if the CHAR is supported in FONT.
|
"Determine if the CHAR is supported in FONT.
|
||||||
When DONT-REGISTER is non-nil, don't register the font.
|
When DONT-REGISTER is non-nil, don't register the font.
|
||||||
Otherwise, register the font for use in the mode-line and
|
Otherwise, register the font for use in the mode-line and
|
||||||
|
@ -471,7 +473,7 @@ everywhere else."
|
||||||
"Determine if ICON-SPEC is suppored on your system."
|
"Determine if ICON-SPEC is suppored on your system."
|
||||||
(or
|
(or
|
||||||
(and (or (eq (nth 2 icon-spec) nil) (eq (nth 1 icon-spec) nil)) t)
|
(and (or (eq (nth 2 icon-spec) nil) (eq (nth 1 icon-spec) nil)) t)
|
||||||
(mode-icons-supported-font-p (nth 1 icon-spec) (nth 2 icon-spec) t)
|
(mode-icons-supported-font-p (nth 1 icon-spec) (nth 2 icon-spec))
|
||||||
(and (eq (nth 2 icon-spec) 'jpg) (image-type-available-p 'jpeg))
|
(and (eq (nth 2 icon-spec) 'jpg) (image-type-available-p 'jpeg))
|
||||||
(and (eq (nth 2 icon-spec) 'xpm-bw) (image-type-available-p 'xpm))
|
(and (eq (nth 2 icon-spec) 'xpm-bw) (image-type-available-p 'xpm))
|
||||||
(and (image-type-available-p (nth 2 icon-spec)))))
|
(and (image-type-available-p (nth 2 icon-spec)))))
|
||||||
|
@ -744,7 +746,7 @@ When DONT-UPDATE is non-nil, don't call `force-mode-line-update'"
|
||||||
:group 'mode-icons)
|
:group 'mode-icons)
|
||||||
|
|
||||||
(defcustom mode-icons-eol-text nil
|
(defcustom mode-icons-eol-text nil
|
||||||
"Describe end of line type
|
"Describe end of line type.
|
||||||
\(Unix) -> LF
|
\(Unix) -> LF
|
||||||
\(DOS) -> CRLF
|
\(DOS) -> CRLF
|
||||||
\(Mac) -> CR"
|
\(Mac) -> CR"
|
||||||
|
@ -792,7 +794,8 @@ STRING is the string to modify, or if absent, the value from `mode-line-eol-desc
|
||||||
|
|
||||||
|
|
||||||
(defun mode-icons-fix (&optional enable)
|
(defun mode-icons-fix (&optional enable)
|
||||||
"Fix mode-icons."
|
"Fix mode-icons.
|
||||||
|
When ENABLE is non-nil, enable the changes to the mode line."
|
||||||
(if enable
|
(if enable
|
||||||
(let ((place (or (member 'minor-mode-alist mode-line-modes)
|
(let ((place (or (member 'minor-mode-alist mode-line-modes)
|
||||||
(cl-member-if
|
(cl-member-if
|
||||||
|
|
Loading…
Reference in a new issue