From: Elijah G <eg642616@gmail.com>
To: Eli Zaretskii <eliz@gnu.org>
Cc: "João Távora" <joaotavora@gmail.com>,
philipk@posteo.net, emacs-devel@gnu.org
Subject: Re: [PATCH] Flymake Support Indicator Errors in Margin
Date: Thu, 14 Mar 2024 09:35:33 -0600 [thread overview]
Message-ID: <CACnP4NJgW8G6RJdu-W-fCMgGEey3eL9EErFBgMn8jd8=E9LMiw@mail.gmail.com> (raw)
In-Reply-To: <86msr19ipu.fsf@gnu.org>
[-- Attachment #1: Type: text/plain, Size: 1009 bytes --]
On Thu, Mar 14, 2024 at 5:05 AM Eli Zaretskii <eliz@gnu.org> wrote:
> > +(defcustom flymake-margin-indicators-string
> > + `((error ,(if (char-displayable-p 8252)
> > + "‼"
> > + "!!")
> > + compilation-error)
>
> When do you expect this value to be evaluated?
>
> In general, I wonder whether it would be simpler and wiser to use just
> "!!", and leave it to users to customize to "‼" if their displays
> support that. (We can mention the possibility in the doc string.)
I implemented it in a similar way to how display-fill-column-indicator
does with display-fill-column-indicator-character, this since I expect
users to only set left-margin-width to 1, because if there is several
errors on the same line, the indicators will be displayed next to each
other and it could be confusing.
However I agree that it is better to change it to just "!!",
I fixed the patch and added a doc string for the possibility of including
non-ASCII characters.
[-- Attachment #2: 0001-Flymake-Support-Indicator-Errors-in-Margin.patch --]
[-- Type: application/octet-stream, Size: 6810 bytes --]
From f02877c60337fd873fb04af2563e063d05762d48 Mon Sep 17 00:00:00 2001
From: Elias G <eg642616@gmail.com>
Date: Mon, 11 Mar 2024 13:35:06 -0600
Subject: [PATCH] Flymake Support Indicator Errors in Margin
Add support for displaying flymake errors in margin which
allows displaying in both graphical and text displays.
* lisp/progmodes/flymake.el (flymake-margin-indicators-string,
flymake-indicator-type): New.
(flymake--fringe-overlay-spec, flymake--equal-diagnostic-p): Rework.
(flymake-error, flymake-warning, flymake-note): Use new margin value.
---
lisp/progmodes/flymake.el | 93 +++++++++++++++++++++++++++++++++------
1 file changed, 79 insertions(+), 14 deletions(-)
diff --git a/lisp/progmodes/flymake.el b/lisp/progmodes/flymake.el
index db00cc59c0e..da7e0079fc6 100644
--- a/lisp/progmodes/flymake.el
+++ b/lisp/progmodes/flymake.el
@@ -180,6 +180,51 @@ See `flymake-error-bitmap' and `flymake-warning-bitmap'."
(const right-fringe)
(const :tag "No fringe indicators" nil)))
+(defcustom flymake-indicator-type 'fringes
+ "Indicate which indicator type to use for display errors.
+
+The value can be nil (dont indicate errors but just highlight them),
+fringes (use fringes) or margins (use margins).
+
+Difference between fringes and margin is that fringes support diplaying
+bitmaps on graphical displays and margins display text in a blank area
+of buffer that works in both graphical and text displays.
+
+See Info node `Fringes' and Info node `(elisp)Display Margins'."
+ :version "30.1"
+ :type '(choice (const :tag "Use Fringes" fringes)
+ (const :tag "Use Margins" margins)
+ (const :tag "No indicators" nil)))
+
+(defcustom flymake-margin-indicators-string
+ '((error "!!" compilation-error)
+ (warning "!" compilation-warning)
+ (note "!" compilation-info))
+ "Strings used for margins indicators.
+The value of each list may be a list of 3 elements where specifies the
+error type, its string to use and its face,
+or a list of 2 elements specifying only the error type and its string.
+
+The indicators can be both ASCII and non-ASCII (if supported) string.
+
+The option `flymake-margin-indicator-position' controls how and where
+this is used."
+ :version "30.1"
+ :type '(repeat :tag "Error types lists"
+ (list :tag "String and face for error types"
+ (symbol :tag "Error type")
+ (string :tag "String")
+ (face :tag "Face"))))
+
+(defcustom flymake-margin-indicator-position 'left-margin
+ "The position to put Flymake margin indicator.
+The value can be nil (do not use indicators), `left-margin' or `right-margin'.
+See `flymake-error-margin-string' and `flymake-warning-margin-string'."
+ :version "30.1"
+ :type '(choice (const left-margin)
+ (const right-margin)
+ (const :tag "No margin indicators" nil)))
+
(make-obsolete-variable 'flymake-start-syntax-check-on-newline
"can check on newline in post-self-insert-hook"
"27.1")
@@ -630,6 +676,7 @@ Node `(Flymake)Flymake error types'"
(put 'flymake-error 'face 'flymake-error)
(put 'flymake-error 'flymake-bitmap 'flymake-error-bitmap)
+(put 'flymake-error 'flymake-margin-string (alist-get 'error flymake-margin-indicators-string))
(put 'flymake-error 'severity (warning-numeric-level :error))
(put 'flymake-error 'mode-line-face 'flymake-error-echo)
(put 'flymake-error 'echo-face 'flymake-error-echo)
@@ -638,6 +685,7 @@ Node `(Flymake)Flymake error types'"
(put 'flymake-warning 'face 'flymake-warning)
(put 'flymake-warning 'flymake-bitmap 'flymake-warning-bitmap)
+(put 'flymake-warning 'flymake-margin-string (alist-get 'warning flymake-margin-indicators-string))
(put 'flymake-warning 'severity (warning-numeric-level :warning))
(put 'flymake-warning 'mode-line-face 'flymake-warning-echo)
(put 'flymake-warning 'echo-face 'flymake-warning-echo)
@@ -646,6 +694,7 @@ Node `(Flymake)Flymake error types'"
(put 'flymake-note 'face 'flymake-note)
(put 'flymake-note 'flymake-bitmap 'flymake-note-bitmap)
+(put 'flymake-note 'flymake-margin-string (alist-get 'note flymake-margin-indicators-string))
(put 'flymake-note 'severity (warning-numeric-level :debug))
(put 'flymake-note 'mode-line-face 'flymake-note-echo)
(put 'flymake-note 'echo-face 'flymake-note-echo)
@@ -682,19 +731,32 @@ associated `flymake-category' return DEFAULT."
(flymake--lookup-type-property type 'severity
(warning-numeric-level :error)))
-(defun flymake--fringe-overlay-spec (bitmap &optional recursed)
- (if (and (symbolp bitmap)
- (boundp bitmap)
- (not recursed))
- (flymake--fringe-overlay-spec
- (symbol-value bitmap) t)
- (and flymake-fringe-indicator-position
- bitmap
- (propertize "!" 'display
- (cons flymake-fringe-indicator-position
- (if (listp bitmap)
- bitmap
- (list bitmap)))))))
+(defun flymake--fringe-overlay-spec (indicator)
+ "Return INDICATOR as propertized string to use in error indicators."
+ (let* ((value (if (symbolp indicator)
+ (symbol-value indicator)
+ indicator))
+ (indicator-car (if (listp value)
+ (car value)
+ value))
+ (indicator-cdr (if (listp value)
+ (cdr value))))
+ (cond
+ ((symbolp indicator-car)
+ (propertize "!" 'display
+ (cons flymake-fringe-indicator-position
+ (if (listp value)
+ value
+ (list value)))))
+ ((stringp indicator-car)
+ (propertize "!"
+ 'display
+ `((margin ,flymake-margin-indicator-position)
+ ,(propertize
+ indicator-car
+ 'face
+ `(:inherit (,indicator-cdr
+ default)))))))))
(defun flymake--equal-diagnostic-p (a b)
"Tell if A and B are equivalent `flymake--diag' objects."
@@ -843,7 +905,10 @@ Return nil or the overlay created."
(flymake--fringe-overlay-spec
(flymake--lookup-type-property
type
- 'flymake-bitmap
+ (cond ((eq flymake-indicator-type 'fringes)
+ 'flymake-bitmap)
+ ((eq flymake-indicator-type 'margins)
+ 'flymake-margin-string))
(alist-get 'bitmap (alist-get type ; backward compat
flymake-diagnostic-types-alist)))))
;; (default-maybe 'after-string
--
2.44.0.windows.1
next prev parent reply other threads:[~2024-03-14 15:35 UTC|newest]
Thread overview: 31+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-03-11 23:18 [PATCH] Flymake Support Indicator Errors in Margin Elijah G
2024-03-12 9:24 ` Philip Kaludercic
2024-03-12 17:22 ` Elijah G
2024-03-13 12:18 ` Eli Zaretskii
2024-03-14 1:50 ` Elijah G
2024-03-14 11:05 ` Eli Zaretskii
2024-03-14 11:28 ` João Távora
2024-03-14 15:35 ` Elijah G [this message]
2024-03-16 11:10 ` Eli Zaretskii
2024-03-17 16:44 ` bird
2024-03-17 17:01 ` Eli Zaretskii
2024-03-17 17:34 ` Elijah G
2024-03-17 18:43 ` bird
2024-03-17 19:21 ` Elijah G
2024-03-25 1:46 ` Elijah G
2024-03-27 0:13 ` sbaugh
2024-03-27 0:36 ` Elijah G
2024-03-27 21:29 ` Elijah G
2024-03-28 6:01 ` Eli Zaretskii
2024-03-28 17:34 ` Elijah G
2024-04-06 11:36 ` Eli Zaretskii
2024-03-28 7:30 ` Juri Linkov
2024-03-28 17:44 ` Elijah G
2024-04-06 11:35 ` Eli Zaretskii
2024-04-06 20:14 ` Elijah G
2024-04-07 5:47 ` Eli Zaretskii
2024-04-07 17:20 ` Elijah G
2024-04-18 9:10 ` Eli Zaretskii
2024-03-19 7:03 ` Augusto Stoffel
2024-03-17 17:49 ` Elijah G
2024-03-19 7:04 ` Augusto Stoffel
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: https://www.gnu.org/software/emacs/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to='CACnP4NJgW8G6RJdu-W-fCMgGEey3eL9EErFBgMn8jd8=E9LMiw@mail.gmail.com' \
--to=eg642616@gmail.com \
--cc=eliz@gnu.org \
--cc=emacs-devel@gnu.org \
--cc=joaotavora@gmail.com \
--cc=philipk@posteo.net \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://git.savannah.gnu.org/cgit/emacs.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).