[bug#77093,rust-team,11/18] scripts: import: Support expressions defined by 'define.

Message ID c185c0310885a4fcce6df3bcf52bb2cd00abd79f.1742281797.git.hako@ultrarare.space
State New
Headers
Series New Rust packaging workflow based on lockfile importer. |

Commit Message

Hilton Chain March 18, 2025, 7:24 a.m. UTC
  * guix/utils.scm (find-definition-location): New procedure.
(find-definition-insertion-location): Define with it.
* guix/scripts/import.scm (import-as-definitions, guix-import): Support
expressions defined by 'define.

Change-Id: I03118e1a3372028b4f0530964aba871b4a1a4d25
---
 guix/scripts/import.scm | 20 +++++++++++++++-----
 guix/utils.scm          | 27 +++++++++++++++++++--------
 2 files changed, 34 insertions(+), 13 deletions(-)
  

Comments

Efraim Flashner March 18, 2025, 11:49 a.m. UTC | #1
On Tue, Mar 18, 2025 at 03:24:24PM +0800, Hilton Chain wrote:
> * guix/utils.scm (find-definition-location): New procedure.
> (find-definition-insertion-location): Define with it.
> * guix/scripts/import.scm (import-as-definitions, guix-import): Support
> expressions defined by 'define.
> 
> Change-Id: I03118e1a3372028b4f0530964aba871b4a1a4d25
> ---
>  guix/scripts/import.scm | 20 +++++++++++++++-----
>  guix/utils.scm          | 27 +++++++++++++++++++--------
>  2 files changed, 34 insertions(+), 13 deletions(-)
> 
> diff --git a/guix/scripts/import.scm b/guix/scripts/import.scm
> index 58a84d0db7..aaa3d26673 100644
> --- a/guix/scripts/import.scm
> +++ b/guix/scripts/import.scm
> @@ -30,6 +30,7 @@ (define-module (guix scripts import)
>    #:use-module (guix read-print)
>    #:use-module (guix utils)
>    #:use-module (srfi srfi-1)
> +  #:use-module (srfi srfi-26)
>    #:use-module (ice-9 format)
>    #:use-module (ice-9 match)
>    #:export (%standard-import-options
> @@ -83,7 +84,8 @@ (define (import-as-definitions importer args proc)
>          ((and expr (or ('package _ ...)
>                         ('let _ ...)))
>           (proc (package->definition expr)))
> -        ((and expr ('define-public _ ...))
> +        ((and expr (or ('define-public _ ...)
> +                       ('define _ ...)))
>           (proc expr))
>          ((expressions ...)
>           (for-each (lambda (expr)
> @@ -91,7 +93,8 @@ (define (import-as-definitions importer args proc)
>                         ((and expr (or ('package _ ...)
>                                        ('let _ ...)))
>                          (proc (package->definition expr)))
> -                       ((and expr ('define-public _ ...))
> +                       ((and expr (or ('define-public _ ...)
> +                                      ('define _ ...)))
>                          (proc expr))))
>                     expressions))
>          (x
> @@ -117,13 +120,20 @@ (define-command (guix-import . args)
>       (show-version-and-exit "guix import"))
>      ((or ("-i" file importer args ...)
>           ("--insert" file importer args ...))
> -     (let ((find-and-insert
> +     (let* ((definer?
> +              (cut member
> +                   <>
> +                   `(,@(if (member importer '("crate"))
> +                           '(define)
> +                           '())
> +                     define-public)))

This part above seems like it would break the option to use 'guix import
crate' with the --insert flag for "normal" packages.  I question how
useful it currently is in that scenario since we normally have to strip
the rust- prefix from those packages anyway.

> +            (find-and-insert
>               (lambda (expr)
>                 (match expr
> -                 (('define-public term _ ...)
> +                 (((? definer? definer) term _ ...)
>                    (let ((source-properties
>                            (find-definition-insertion-location
> -                            file term)))
> +                            file term #:definer definer)))
>                      (if source-properties
>                        (insert-expression source-properties expr)
>                        (let ((port (open-file file "a")))
> diff --git a/guix/utils.scm b/guix/utils.scm
> index c7c23d9d5b..77ec6d992a 100644
> --- a/guix/utils.scm
> +++ b/guix/utils.scm
> @@ -154,6 +154,7 @@ (define-module (guix utils)
>              edit-expression
>              delete-expression
>              insert-expression
> +            find-definition-location
>              find-definition-insertion-location
>  
>              filtered-port
> @@ -520,24 +521,34 @@ (define (insert-expression source-properties expr)
>                     (string-append expr "\n\n" str))))
>      (edit-expression source-properties insert)))
>  
> -(define (find-definition-insertion-location file term)
> -  "Search in FILE for a top-level public definition whose defined term
> -alphabetically succeeds TERM. Return the location if found, or #f
> -otherwise."
> -  (let ((search-term (symbol->string term)))
> +(define* (find-definition-location file term
> +                                   #:key (definer 'define-public)
> +                                   (pred string=))
> +  "Search in FILE for a top-level definition defined by DEFINER with defined
> +term comparing to TERM through PRED.  Return the location if PRED returns #t,
> +or #f otherwise."
> +  (let ((search-term (symbol->string term))
> +        (definer? (cut eq? definer <>)))
>      (call-with-input-file file
>        (lambda (port)
>          (do ((syntax (read-syntax port)
>                       (read-syntax port)))
>            ((match (syntax->datum syntax)
> -             (('define-public current-term _ ...)
> -              (string> (symbol->string current-term)
> -                       search-term))
> +             (((? definer?) current-term _ ...)
> +              (pred (symbol->string current-term)
> +                    search-term))
>               ((? eof-object?) #t)
>               (_ #f))
>             (and (not (eof-object? syntax))
>                  (syntax-source syntax))))))))
>  
> +(define* (find-definition-insertion-location file term
> +                                             #:key (definer 'define-public))
> +  "Search in FILE for a top-level definition defined by DEFINER with defined
> +term alphabetically succeeds TERM. Return the location if found, or #f
> +otherwise."
> +  (find-definition-location file term #:definer definer #:pred string>))
> +
>  
>  ;;;
>  ;;; Keyword arguments.
> -- 
> 2.48.1
> 
> 
> 
>
  
Hilton Chain March 18, 2025, 12:29 p.m. UTC | #2
On Tue, 18 Mar 2025 19:49:39 +0800,
Efraim Flashner wrote:
>
> [1  <text/plain; utf-8 (quoted-printable)>]
> On Tue, Mar 18, 2025 at 03:24:24PM +0800, Hilton Chain wrote:
> > * guix/utils.scm (find-definition-location): New procedure.
> > (find-definition-insertion-location): Define with it.
> > * guix/scripts/import.scm (import-as-definitions, guix-import): Support
> > expressions defined by 'define.
> >
> > Change-Id: I03118e1a3372028b4f0530964aba871b4a1a4d25
> > ---
> >  guix/scripts/import.scm | 20 +++++++++++++++-----
> >  guix/utils.scm          | 27 +++++++++++++++++++--------
> >  2 files changed, 34 insertions(+), 13 deletions(-)
> >
> > diff --git a/guix/scripts/import.scm b/guix/scripts/import.scm
> > index 58a84d0db7..aaa3d26673 100644
> > --- a/guix/scripts/import.scm
> > +++ b/guix/scripts/import.scm
> > @@ -30,6 +30,7 @@ (define-module (guix scripts import)
> >    #:use-module (guix read-print)
> >    #:use-module (guix utils)
> >    #:use-module (srfi srfi-1)
> > +  #:use-module (srfi srfi-26)
> >    #:use-module (ice-9 format)
> >    #:use-module (ice-9 match)
> >    #:export (%standard-import-options
> > @@ -83,7 +84,8 @@ (define (import-as-definitions importer args proc)
> >          ((and expr (or ('package _ ...)
> >                         ('let _ ...)))
> >           (proc (package->definition expr)))
> > -        ((and expr ('define-public _ ...))
> > +        ((and expr (or ('define-public _ ...)
> > +                       ('define _ ...)))
> >           (proc expr))
> >          ((expressions ...)
> >           (for-each (lambda (expr)
> > @@ -91,7 +93,8 @@ (define (import-as-definitions importer args proc)
> >                         ((and expr (or ('package _ ...)
> >                                        ('let _ ...)))
> >                          (proc (package->definition expr)))
> > -                       ((and expr ('define-public _ ...))
> > +                       ((and expr (or ('define-public _ ...)
> > +                                      ('define _ ...)))
> >                          (proc expr))))
> >                     expressions))
> >          (x
> > @@ -117,13 +120,20 @@ (define-command (guix-import . args)
> >       (show-version-and-exit "guix import"))
> >      ((or ("-i" file importer args ...)
> >           ("--insert" file importer args ...))
> > -     (let ((find-and-insert
> > +     (let* ((definer?
> > +              (cut member
> > +                   <>
> > +                   `(,@(if (member importer '("crate"))
> > +                           '(define)
> > +                           '())
> > +                     define-public)))
>
> This part above seems like it would break the option to use 'guix import
> crate' with the --insert flag for "normal" packages.  I question how
> useful it currently is in that scenario since we normally have to strip
> the rust- prefix from those packages anyway.

Hmmm, since the crate importer now checks both ‘define’ and ‘define-public’,
there might be ordering issue when the module to insert uses ‘define’.  But it's
still managable I think.
  
Efraim Flashner March 18, 2025, 1:16 p.m. UTC | #3
On Tue, Mar 18, 2025 at 08:29:49PM +0800, Hilton Chain wrote:
> On Tue, 18 Mar 2025 19:49:39 +0800,
> Efraim Flashner wrote:
> >
> > [1  <text/plain; utf-8 (quoted-printable)>]
> > On Tue, Mar 18, 2025 at 03:24:24PM +0800, Hilton Chain wrote:
> > > * guix/utils.scm (find-definition-location): New procedure.
> > > (find-definition-insertion-location): Define with it.
> > > * guix/scripts/import.scm (import-as-definitions, guix-import): Support
> > > expressions defined by 'define.
> > >
> > > Change-Id: I03118e1a3372028b4f0530964aba871b4a1a4d25
> > > ---
> > >  guix/scripts/import.scm | 20 +++++++++++++++-----
> > >  guix/utils.scm          | 27 +++++++++++++++++++--------
> > >  2 files changed, 34 insertions(+), 13 deletions(-)
> > >
> > > diff --git a/guix/scripts/import.scm b/guix/scripts/import.scm
> > > index 58a84d0db7..aaa3d26673 100644
> > > --- a/guix/scripts/import.scm
> > > +++ b/guix/scripts/import.scm
> > > @@ -30,6 +30,7 @@ (define-module (guix scripts import)
> > >    #:use-module (guix read-print)
> > >    #:use-module (guix utils)
> > >    #:use-module (srfi srfi-1)
> > > +  #:use-module (srfi srfi-26)
> > >    #:use-module (ice-9 format)
> > >    #:use-module (ice-9 match)
> > >    #:export (%standard-import-options
> > > @@ -83,7 +84,8 @@ (define (import-as-definitions importer args proc)
> > >          ((and expr (or ('package _ ...)
> > >                         ('let _ ...)))
> > >           (proc (package->definition expr)))
> > > -        ((and expr ('define-public _ ...))
> > > +        ((and expr (or ('define-public _ ...)
> > > +                       ('define _ ...)))
> > >           (proc expr))
> > >          ((expressions ...)
> > >           (for-each (lambda (expr)
> > > @@ -91,7 +93,8 @@ (define (import-as-definitions importer args proc)
> > >                         ((and expr (or ('package _ ...)
> > >                                        ('let _ ...)))
> > >                          (proc (package->definition expr)))
> > > -                       ((and expr ('define-public _ ...))
> > > +                       ((and expr (or ('define-public _ ...)
> > > +                                      ('define _ ...)))
> > >                          (proc expr))))
> > >                     expressions))
> > >          (x
> > > @@ -117,13 +120,20 @@ (define-command (guix-import . args)
> > >       (show-version-and-exit "guix import"))
> > >      ((or ("-i" file importer args ...)
> > >           ("--insert" file importer args ...))
> > > -     (let ((find-and-insert
> > > +     (let* ((definer?
> > > +              (cut member
> > > +                   <>
> > > +                   `(,@(if (member importer '("crate"))
> > > +                           '(define)
> > > +                           '())
> > > +                     define-public)))
> >
> > This part above seems like it would break the option to use 'guix import
> > crate' with the --insert flag for "normal" packages.  I question how
> > useful it currently is in that scenario since we normally have to strip
> > the rust- prefix from those packages anyway.
> 
> Hmmm, since the crate importer now checks both ‘define’ and ‘define-public’,
> there might be ordering issue when the module to insert uses ‘define’.  But it's
> still managable I think.

Reading it over again I think I was in need of more coffee. I thought
that the importer for cargo would only search for define, not for
define-public also.

As for needing to strip the rust- prefix, there's no change from our
current setup, so we can ignore that for now.
  

Patch

diff --git a/guix/scripts/import.scm b/guix/scripts/import.scm
index 58a84d0db7..aaa3d26673 100644
--- a/guix/scripts/import.scm
+++ b/guix/scripts/import.scm
@@ -30,6 +30,7 @@  (define-module (guix scripts import)
   #:use-module (guix read-print)
   #:use-module (guix utils)
   #:use-module (srfi srfi-1)
+  #:use-module (srfi srfi-26)
   #:use-module (ice-9 format)
   #:use-module (ice-9 match)
   #:export (%standard-import-options
@@ -83,7 +84,8 @@  (define (import-as-definitions importer args proc)
         ((and expr (or ('package _ ...)
                        ('let _ ...)))
          (proc (package->definition expr)))
-        ((and expr ('define-public _ ...))
+        ((and expr (or ('define-public _ ...)
+                       ('define _ ...)))
          (proc expr))
         ((expressions ...)
          (for-each (lambda (expr)
@@ -91,7 +93,8 @@  (define (import-as-definitions importer args proc)
                        ((and expr (or ('package _ ...)
                                       ('let _ ...)))
                         (proc (package->definition expr)))
-                       ((and expr ('define-public _ ...))
+                       ((and expr (or ('define-public _ ...)
+                                      ('define _ ...)))
                         (proc expr))))
                    expressions))
         (x
@@ -117,13 +120,20 @@  (define-command (guix-import . args)
      (show-version-and-exit "guix import"))
     ((or ("-i" file importer args ...)
          ("--insert" file importer args ...))
-     (let ((find-and-insert
+     (let* ((definer?
+              (cut member
+                   <>
+                   `(,@(if (member importer '("crate"))
+                           '(define)
+                           '())
+                     define-public)))
+            (find-and-insert
              (lambda (expr)
                (match expr
-                 (('define-public term _ ...)
+                 (((? definer? definer) term _ ...)
                   (let ((source-properties
                           (find-definition-insertion-location
-                            file term)))
+                            file term #:definer definer)))
                     (if source-properties
                       (insert-expression source-properties expr)
                       (let ((port (open-file file "a")))
diff --git a/guix/utils.scm b/guix/utils.scm
index c7c23d9d5b..77ec6d992a 100644
--- a/guix/utils.scm
+++ b/guix/utils.scm
@@ -154,6 +154,7 @@  (define-module (guix utils)
             edit-expression
             delete-expression
             insert-expression
+            find-definition-location
             find-definition-insertion-location
 
             filtered-port
@@ -520,24 +521,34 @@  (define (insert-expression source-properties expr)
                    (string-append expr "\n\n" str))))
     (edit-expression source-properties insert)))
 
-(define (find-definition-insertion-location file term)
-  "Search in FILE for a top-level public definition whose defined term
-alphabetically succeeds TERM. Return the location if found, or #f
-otherwise."
-  (let ((search-term (symbol->string term)))
+(define* (find-definition-location file term
+                                   #:key (definer 'define-public)
+                                   (pred string=))
+  "Search in FILE for a top-level definition defined by DEFINER with defined
+term comparing to TERM through PRED.  Return the location if PRED returns #t,
+or #f otherwise."
+  (let ((search-term (symbol->string term))
+        (definer? (cut eq? definer <>)))
     (call-with-input-file file
       (lambda (port)
         (do ((syntax (read-syntax port)
                      (read-syntax port)))
           ((match (syntax->datum syntax)
-             (('define-public current-term _ ...)
-              (string> (symbol->string current-term)
-                       search-term))
+             (((? definer?) current-term _ ...)
+              (pred (symbol->string current-term)
+                    search-term))
              ((? eof-object?) #t)
              (_ #f))
            (and (not (eof-object? syntax))
                 (syntax-source syntax))))))))
 
+(define* (find-definition-insertion-location file term
+                                             #:key (definer 'define-public))
+  "Search in FILE for a top-level definition defined by DEFINER with defined
+term alphabetically succeeds TERM. Return the location if found, or #f
+otherwise."
+  (find-definition-location file term #:definer definer #:pred string>))
+
 
 ;;;
 ;;; Keyword arguments.