[PATCH] emacs: Add a name/version/synopsis heading in package-info buffers

[PATCH] emacs: Add a name/version/synopsis heading in package-info buffers

[Ludovic Courtès]

[-- Attachment #1: Type: text/plain, Size: 48 bytes --]

Hello,

What would think of a patch like this:


[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: Type: text/x-patch, Size: 2337 bytes --]

diff --git a/emacs/guix-info.el b/emacs/guix-info.el
index 551d79a..c3499e4e 100644
--- a/emacs/guix-info.el
+++ b/emacs/guix-info.el
@@ -198,13 +198,27 @@ ENTRIES should have a form of `guix-entries'."
                   entries
                   guix-info-delimiter))
 
+(defun guix-info-insert-heading (entry)
+  "Insert the heading for ENTRY, showing its name, version, and
+synopsis."
+  (guix-format-insert (concat (guix-get-key-val entry 'name)
+                              " " (guix-get-key-val entry 'version)
+                              "\n")
+                      'guix-package-info-heading)
+  (guix-format-insert (guix-get-key-val entry 'synopsis)
+                      'guix-package-info-synopsis)
+  (guix-format-insert "\n\n"))
+
 (defun guix-info-insert-entry (entry entry-type &optional indent-level)
   "Insert ENTRY of ENTRY-TYPE into the current info buffer.
 If INDENT-LEVEL is non-nil, indent displayed information by this
 number of `guix-info-indent' spaces."
   (let ((region-beg (point)))
+    (guix-info-insert-heading entry)
     (mapc (lambda (param)
-            (guix-info-insert-param param entry entry-type))
+            ;; The name, version, and synopsis are already displayed.
+            (unless (memq param '(name version synopsis))
+              (guix-info-insert-param param entry entry-type)))
           (guix-info-get-displayed-params entry-type))
     (when indent-level
       (indent-rigidly region-beg (point)
@@ -376,6 +390,12 @@ See `insert-text-button' for the meaning of PROPERTIES."
 (guix-define-buffer-type info package
   :required (id installed non-unique))
 
+(defface guix-package-info-heading
+  '((((type tty pc) (class color)) :weight bold)
+    (t :height 1.6 :weight bold :inherit variable-pitch))
+  "Face for package name and version headings."
+  :group 'guix-package-info)
+
 (defface guix-package-info-name
   '((t :inherit font-lock-keyword-face))
   "Face used for a name of a package."
@@ -392,7 +412,8 @@ See `insert-text-button' for the meaning of PROPERTIES."
   :group 'guix-package-info)
 
 (defface guix-package-info-synopsis
-  '((t :inherit font-lock-doc-face))
+  '((((type tty pc) (class color)) :weight bold)
+    (t :height 1.1 :weight bold :inherit variable-pitch))
   "Face used for a synopsis of a package."
   :group 'guix-package-info)
 

[-- Attachment #3: Type: text/plain, Size: 592 bytes --]


It changes the rendering of package-info buffers such that, instead of
displaying something like:

  Name        : coreutils
  Version     : 8.23
  Synopsis    : Core GNU utilities (file, text, shell)
  ...

it first displays the important info in a visible heading, and then goes
on with the other fields unchanged:

  coreutils 8.23
  Core GNU utilities (file, text, shell)

  Outputs:
    out       Delete
  ...

On X11, the package name and version are displayed in a large
variable-width font, and the synopsis is displayed in a slightly smaller
font.

Ludo’.

Re: [PATCH] emacs: Add a name/version/synopsis heading in package-info buffers

[Alex Kost]

[-- Attachment #1: Type: text/plain, Size: 2320 bytes --]

Ludovic Courtès (2014-10-29 19:25 +0300) wrote:

> Hello,
>
> What would think of a patch like this:

[...]

>  (defun guix-info-insert-entry (entry entry-type &optional indent-level)
>    "Insert ENTRY of ENTRY-TYPE into the current info buffer.
>  If INDENT-LEVEL is non-nil, indent displayed information by this
>  number of `guix-info-indent' spaces."
>    (let ((region-beg (point)))
> +    (guix-info-insert-heading entry)
>      (mapc (lambda (param)
> -            (guix-info-insert-param param entry entry-type))
> +            ;; The name, version, and synopsis are already displayed.
> +            (unless (memq param '(name version synopsis))
> +              (guix-info-insert-param param entry entry-type)))
>            (guix-info-get-displayed-params entry-type))
>      (when indent-level
>        (indent-rigidly region-beg (point)

‘guix-info-insert-entry’ is used to insert any type of information, not
only packages, so you can see artifacts (empty lines and "–") in other
"views".

[...]

> It changes the rendering of package-info buffers such that, instead of
> displaying something like:
>
>   Name        : coreutils
>   Version     : 8.23
>   Synopsis    : Core GNU utilities (file, text, shell)
>   ...
>
> it first displays the important info in a visible heading, and then goes
> on with the other fields unchanged:
>
>   coreutils 8.23
>   Core GNU utilities (file, text, shell)
>
>   Outputs:
>     out       Delete
>   ...
>
> On X11, the package name and version are displayed in a large
> variable-width font, and the synopsis is displayed in a slightly smaller
> font.

I think it's a great idea!

I'm attaching the modified version of your patch.  I added there several
variables that allow a user to specify functions for displaying info
(perhaps there will be several variants of displaying info in the
future).  So if someone would like to return to the previous variant of
displaying a package, he could do it with:

  (setq guix-info-insert-package-function nil)

Thanks again, I really like your suggestion, I just prefer to keep
previous possibilities instead of replacing them with the new ones.

Are you going to make a commit or should I do it?  (of course if you
don't have comments on my patch)


[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: tmp.diff --]
[-- Type: text/x-diff, Size: 5514 bytes --]

diff --git a/emacs/guix-info.el b/emacs/guix-info.el
index 551d79a..d4e6ecb 100644
--- a/emacs/guix-info.el
+++ b/emacs/guix-info.el
@@ -198,7 +198,8 @@ ENTRIES should have a form of `guix-entries'."
                   entries
                   guix-info-delimiter))
 
-(defun guix-info-insert-entry (entry entry-type &optional indent-level)
+(defun guix-info-insert-entry-default (entry entry-type
+                                       &optional indent-level)
   "Insert ENTRY of ENTRY-TYPE into the current info buffer.
 If INDENT-LEVEL is non-nil, indent displayed information by this
 number of `guix-info-indent' spaces."
@@ -210,6 +211,18 @@ number of `guix-info-indent' spaces."
       (indent-rigidly region-beg (point)
                       (* indent-level guix-info-indent)))))
 
+(defun guix-info-insert-entry (entry entry-type &optional indent-level)
+  "Insert ENTRY of ENTRY-TYPE into the current info buffer.
+Use `guix-info-insert-ENTRY-TYPE-function' or
+`guix-info-insert-entry-default' if it is nil."
+  (let* ((var (intern (concat "guix-info-insert-"
+                              (symbol-name entry-type)
+                              "-function")))
+         (fun (symbol-value var)))
+    (if (functionp fun)
+        (funcall fun entry)
+      (guix-info-insert-entry-default entry entry-type indent-level))))
+
 (defun guix-info-insert-param (param entry entry-type)
   "Insert title and value of a PARAM at point.
 ENTRY is alist with parameters and their values.
@@ -376,6 +389,12 @@ See `insert-text-button' for the meaning of PROPERTIES."
 (guix-define-buffer-type info package
   :required (id installed non-unique))
 
+(defface guix-package-info-heading
+  '((((type tty pc) (class color)) :weight bold)
+    (t :height 1.6 :weight bold :inherit variable-pitch))
+  "Face for package name and version headings."
+  :group 'guix-package-info)
+
 (defface guix-package-info-name
   '((t :inherit font-lock-keyword-face))
   "Face used for a name of a package."
@@ -392,7 +411,8 @@ See `insert-text-button' for the meaning of PROPERTIES."
   :group 'guix-package-info)
 
 (defface guix-package-info-synopsis
-  '((t :inherit font-lock-doc-face))
+  '((((type tty pc) (class color)) :weight bold)
+    (t :height 1.1 :weight bold :inherit variable-pitch))
   "Face used for a synopsis of a package."
   :group 'guix-package-info)
 
@@ -433,6 +453,32 @@ See `insert-text-button' for the meaning of PROPERTIES."
   "Face used if a package is obsolete."
   :group 'guix-package-info)
 
+(defvar guix-info-insert-package-function
+  #'guix-package-info-insert-with-heading
+  "Function used to insert a package information.
+It is called with a single argument - alist of package parameters.
+If nil, insert package in a default way.")
+
+(defun guix-package-info-insert-heading (entry)
+  "Insert the heading for package ENTRY.
+Show package name, version, and synopsis."
+  (guix-format-insert (concat (guix-get-key-val entry 'name) " "
+                              (guix-get-key-val entry 'version))
+                      'guix-package-info-heading)
+  (insert "\n")
+  (guix-format-insert (guix-get-key-val entry 'synopsis)
+                      'guix-package-info-synopsis)
+  (insert "\n\n"))
+
+(defun guix-package-info-insert-with-heading (entry)
+  "Insert package ENTRY with its heading at point."
+  (guix-package-info-insert-heading entry)
+  (mapc (lambda (param)
+          ;; The name, version, and synopsis are already displayed.
+          (unless (memq param '(name version synopsis))
+            (guix-info-insert-param param entry 'package)))
+        (guix-info-get-displayed-params 'package)))
+
 (defun guix-package-info-insert-description (desc &optional _)
   "Insert description DESC at point."
   (guix-info-insert-val-simple desc 'guix-package-info-description))
@@ -494,6 +540,12 @@ formatted with this string, an action button is inserted.")
 (defvar guix-package-info-obsolete-string "(This package is obsolete)"
   "String used if a package is obsolete.")
 
+(defvar guix-info-insert-installed-function nil
+  "Function used to insert an installed information.
+It is called with a single argument - alist of installed
+parameters (`output', `path', `dependencies').
+If nil, insert installed info in a default way.")
+
 (defun guix-package-info-insert-outputs (outputs entry)
   "Insert OUTPUTS from package ENTRY at point."
   (and (guix-get-key-val entry 'obsolete)
@@ -582,6 +634,11 @@ ENTRY is an alist with package info."
   :buffer-name "*Guix Package Info*"
   :required (id package-id installed non-unique))
 
+(defvar guix-info-insert-output-function nil
+  "Function used to insert an output information.
+It is called with a single argument - alist of output parameters.
+If nil, insert output in a default way.")
+
 (defun guix-output-info-insert-version (version entry)
   "Insert output VERSION and obsolete text if needed at point."
   (guix-info-insert-val-default version
@@ -625,6 +682,11 @@ ENTRY is an alist with package info."
   "Face used if a generation is not the current one."
   :group 'guix-generation-info)
 
+(defvar guix-info-insert-generation-function nil
+  "Function used to insert a generation information.
+It is called with a single argument - alist of generation parameters.
+If nil, insert generation in a default way.")
+
 (defun guix-generation-info-insert-number (number &optional _)
   "Insert generation NUMBER and action buttons."
   (guix-info-insert-val-default number 'guix-generation-info-number)

Re: [PATCH] emacs: Add a name/version/synopsis heading in package-info buffers

[Ludovic Courtès]

Alex Kost <alezost@gmail.com> skribis:

> Ludovic Courtès (2014-10-29 19:25 +0300) wrote:
>
>> Hello,
>>
>> What would think of a patch like this:
>
> [...]
>
>>  (defun guix-info-insert-entry (entry entry-type &optional indent-level)
>>    "Insert ENTRY of ENTRY-TYPE into the current info buffer.
>>  If INDENT-LEVEL is non-nil, indent displayed information by this
>>  number of `guix-info-indent' spaces."
>>    (let ((region-beg (point)))
>> +    (guix-info-insert-heading entry)
>>      (mapc (lambda (param)
>> -            (guix-info-insert-param param entry entry-type))
>> +            ;; The name, version, and synopsis are already displayed.
>> +            (unless (memq param '(name version synopsis))
>> +              (guix-info-insert-param param entry entry-type)))
>>            (guix-info-get-displayed-params entry-type))
>>      (when indent-level
>>        (indent-rigidly region-beg (point)
>
> ‘guix-info-insert-entry’ is used to insert any type of information, not
> only packages, so you can see artifacts (empty lines and "–") in other
> "views".

Ah, OK.

> I'm attaching the modified version of your patch.  I added there several
> variables that allow a user to specify functions for displaying info
> (perhaps there will be several variants of displaying info in the
> future).  So if someone would like to return to the previous variant of
> displaying a package, he could do it with:
>
>   (setq guix-info-insert-package-function nil)

Sounds good!

> Thanks again, I really like your suggestion, I just prefer to keep
> previous possibilities instead of replacing them with the new ones.

Yes, why not.  I’m a bit concerned about the cost of keeping several
variants of different things, esp. because in practice almost only one
variant would be tested.  WDYT?

> Are you going to make a commit or should I do it?  (of course if you
> don't have comments on my patch)

Please go ahead!

I’m thinking perhaps we should do something similar for the description
itself, like display it right below the synopsis.  Thoughts?

Thanks,
Ludo’.

Re: [PATCH] emacs: Add a name/version/synopsis heading in package-info buffers

[Alex Kost]

[-- Attachment #1: Type: text/plain, Size: 1144 bytes --]

Ludovic Courtès (2014-10-30 16:16 +0300) wrote:

> Alex Kost <alezost@gmail.com> skribis:

[...]

>> Thanks again, I really like your suggestion, I just prefer to keep
>> previous possibilities instead of replacing them with the new ones.
>
> Yes, why not.  I’m a bit concerned about the cost of keeping several
> variants of different things, esp. because in practice almost only one
> variant would be tested.  WDYT?

I try to keep track of all possibilities :-)

>> Are you going to make a commit or should I do it?  (of course if you
>> don't have comments on my patch)
>
> Please go ahead!

OK, I'm attaching a patch.  Is “Co-authored-by …” enough or should you
be credited in some other way?

> I’m thinking perhaps we should do something similar for the description
> itself, like display it right below the synopsis.  Thoughts?

I think a simple heading may consist of just "name version" and other
parameters may be specified by a user.  For this purpose I added
‘guix-package-info-heading-params’ variable.  Do you think a description
should also be displayed in the heading by default?


[-- Attachment #2: 0001-emacs-Add-package-info-heading.patch --]
[-- Type: text/x-diff, Size: 6988 bytes --]

From 08cb220407388142adba3e6aa884dd0d2fd5a844 Mon Sep 17 00:00:00 2001
From: Alex Kost <alezost@gmail.com>
Date: Fri, 31 Oct 2014 00:11:55 +0300
Subject: [PATCH] emacs: Add package info heading.
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Co-authored-by: Ludovic Courtès <ludo@gnu.org>

* emacs/guix-info.el: (guix-package-info-heading): New face.
  (guix-package-info-synopsis): Modify face.
  (guix-info-insert-entry-default, guix-package-info-insert-heading,
  guix-package-info-insert-with-heading): New procedures.
  (guix-package-info-heading-params, guix-info-insert-package-function,
  guix-info-insert-installed-function, guix-info-insert-output-function,
  guix-info-insert-generation-function): New variables.
---
 emacs/guix-info.el | 74 ++++++++++++++++++++++++++++++++++++++++++++++++++++--
 1 file changed, 72 insertions(+), 2 deletions(-)

diff --git a/emacs/guix-info.el b/emacs/guix-info.el
index 551d79a..88363e5 100644
--- a/emacs/guix-info.el
+++ b/emacs/guix-info.el
@@ -198,7 +198,8 @@ ENTRIES should have a form of `guix-entries'."
                   entries
                   guix-info-delimiter))
 
-(defun guix-info-insert-entry (entry entry-type &optional indent-level)
+(defun guix-info-insert-entry-default (entry entry-type
+                                       &optional indent-level)
   "Insert ENTRY of ENTRY-TYPE into the current info buffer.
 If INDENT-LEVEL is non-nil, indent displayed information by this
 number of `guix-info-indent' spaces."
@@ -210,6 +211,18 @@ number of `guix-info-indent' spaces."
       (indent-rigidly region-beg (point)
                       (* indent-level guix-info-indent)))))
 
+(defun guix-info-insert-entry (entry entry-type &optional indent-level)
+  "Insert ENTRY of ENTRY-TYPE into the current info buffer.
+Use `guix-info-insert-ENTRY-TYPE-function' or
+`guix-info-insert-entry-default' if it is nil."
+  (let* ((var (intern (concat "guix-info-insert-"
+                              (symbol-name entry-type)
+                              "-function")))
+         (fun (symbol-value var)))
+    (if (functionp fun)
+        (funcall fun entry)
+      (guix-info-insert-entry-default entry entry-type indent-level))))
+
 (defun guix-info-insert-param (param entry entry-type)
   "Insert title and value of a PARAM at point.
 ENTRY is alist with parameters and their values.
@@ -376,6 +389,12 @@ See `insert-text-button' for the meaning of PROPERTIES."
 (guix-define-buffer-type info package
   :required (id installed non-unique))
 
+(defface guix-package-info-heading
+  '((((type tty pc) (class color)) :weight bold)
+    (t :height 1.6 :weight bold :inherit variable-pitch))
+  "Face for package name and version headings."
+  :group 'guix-package-info)
+
 (defface guix-package-info-name
   '((t :inherit font-lock-keyword-face))
   "Face used for a name of a package."
@@ -392,7 +411,8 @@ See `insert-text-button' for the meaning of PROPERTIES."
   :group 'guix-package-info)
 
 (defface guix-package-info-synopsis
-  '((t :inherit font-lock-doc-face))
+  '((((type tty pc) (class color)) :weight bold)
+    (t :height 1.1 :weight bold :inherit variable-pitch))
   "Face used for a synopsis of a package."
   :group 'guix-package-info)
 
@@ -433,6 +453,40 @@ See `insert-text-button' for the meaning of PROPERTIES."
   "Face used if a package is obsolete."
   :group 'guix-package-info)
 
+(defvar guix-info-insert-package-function
+  #'guix-package-info-insert-with-heading
+  "Function used to insert a package information.
+It is called with a single argument - alist of package parameters.
+If nil, insert package in a default way.")
+
+(defvar guix-package-info-heading-params '(synopsis description)
+  "List of parameters displayed in a heading along with name and version.")
+
+(defun guix-package-info-insert-heading (entry)
+  "Insert the heading for package ENTRY.
+Show package name, version, and `guix-package-info-heading-params'."
+  (guix-format-insert (concat (guix-get-key-val entry 'name) " "
+                              (guix-get-key-val entry 'version))
+                      'guix-package-info-heading)
+  (insert "\n\n")
+  (mapc (lambda (param)
+          (let ((val  (guix-get-key-val entry param))
+                (face (guix-get-symbol (symbol-name param)
+                                       'info 'package)))
+            (when val
+              (guix-format-insert val (and (facep face) face))
+              (insert "\n\n"))))
+        guix-package-info-heading-params))
+
+(defun guix-package-info-insert-with-heading (entry)
+  "Insert package ENTRY with its heading at point."
+  (guix-package-info-insert-heading entry)
+  (mapc (lambda (param)
+          (unless (or (memq param '(name version))
+                      (memq param guix-package-info-heading-params))
+            (guix-info-insert-param param entry 'package)))
+        (guix-info-get-displayed-params 'package)))
+
 (defun guix-package-info-insert-description (desc &optional _)
   "Insert description DESC at point."
   (guix-info-insert-val-simple desc 'guix-package-info-description))
@@ -494,6 +548,12 @@ formatted with this string, an action button is inserted.")
 (defvar guix-package-info-obsolete-string "(This package is obsolete)"
   "String used if a package is obsolete.")
 
+(defvar guix-info-insert-installed-function nil
+  "Function used to insert an installed information.
+It is called with a single argument - alist of installed
+parameters (`output', `path', `dependencies').
+If nil, insert installed info in a default way.")
+
 (defun guix-package-info-insert-outputs (outputs entry)
   "Insert OUTPUTS from package ENTRY at point."
   (and (guix-get-key-val entry 'obsolete)
@@ -582,6 +642,11 @@ ENTRY is an alist with package info."
   :buffer-name "*Guix Package Info*"
   :required (id package-id installed non-unique))
 
+(defvar guix-info-insert-output-function nil
+  "Function used to insert an output information.
+It is called with a single argument - alist of output parameters.
+If nil, insert output in a default way.")
+
 (defun guix-output-info-insert-version (version entry)
   "Insert output VERSION and obsolete text if needed at point."
   (guix-info-insert-val-default version
@@ -625,6 +690,11 @@ ENTRY is an alist with package info."
   "Face used if a generation is not the current one."
   :group 'guix-generation-info)
 
+(defvar guix-info-insert-generation-function nil
+  "Function used to insert a generation information.
+It is called with a single argument - alist of generation parameters.
+If nil, insert generation in a default way.")
+
 (defun guix-generation-info-insert-number (number &optional _)
   "Insert generation NUMBER and action buttons."
   (guix-info-insert-val-default number 'guix-generation-info-number)
-- 
2.1.2

Re: [PATCH] emacs: Add a name/version/synopsis heading in package-info buffers

[Ludovic Courtès]

Alex Kost <alezost@gmail.com> skribis:

> OK, I'm attaching a patch.  Is “Co-authored-by …” enough or should you
> be credited in some other way?

It’s enough.

>> I’m thinking perhaps we should do something similar for the description
>> itself, like display it right below the synopsis.  Thoughts?
>
> I think a simple heading may consist of just "name version" and other
> parameters may be specified by a user.  For this purpose I added
> ‘guix-package-info-heading-params’ variable.  Do you think a description
> should also be displayed in the heading by default?

Yes, I like it this way.

Thanks!

Ludo’.

Re: [PATCH] emacs: Add a name/version/synopsis heading in package-info buffers

[Alex Kost]

Ludovic Courtès (2014-10-31 02:20 +0300) wrote:

> Alex Kost <alezost@gmail.com> skribis:
>
>> OK, I'm attaching a patch.  Is “Co-authored-by …” enough or should you
>> be credited in some other way?
>
> It’s enough.
>
>>> I’m thinking perhaps we should do something similar for the description
>>> itself, like display it right below the synopsis.  Thoughts?
>>
>> I think a simple heading may consist of just "name version" and other
>> parameters may be specified by a user.  For this purpose I added
>> ‘guix-package-info-heading-params’ variable.  Do you think a description
>> should also be displayed in the heading by default?
>
> Yes, I like it this way.
>
> Thanks!

Sorry, I didn't get it: may I commit that patch?

Re: [PATCH] emacs: Add a name/version/synopsis heading in package-info buffers

[Ludovic Courtès]

Alex Kost <alezost@gmail.com> skribis:

> Ludovic Courtès (2014-10-31 02:20 +0300) wrote:
>
>> Alex Kost <alezost@gmail.com> skribis:
>>
>>> OK, I'm attaching a patch.  Is “Co-authored-by …” enough or should you
>>> be credited in some other way?
>>
>> It’s enough.
>>
>>>> I’m thinking perhaps we should do something similar for the description
>>>> itself, like display it right below the synopsis.  Thoughts?
>>>
>>> I think a simple heading may consist of just "name version" and other
>>> parameters may be specified by a user.  For this purpose I added
>>> ‘guix-package-info-heading-params’ variable.  Do you think a description
>>> should also be displayed in the heading by default?
>>
>> Yes, I like it this way.

I meant: I tried this patch, and I like what it does.

>> Thanks!
>
> Sorry, I didn't get it: may I commit that patch?

Yes please!  :-)

Thanks,
Ludo’.