From patchwork Tue Sep 7 19:27:35 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: =?utf-8?q?Ludovic_Court=C3=A8s?= X-Patchwork-Id: 32698 Return-Path: X-Original-To: patchwork@mira.cbaines.net Delivered-To: patchwork@mira.cbaines.net Received: by mira.cbaines.net (Postfix, from userid 113) id DECB327BBE3; Tue, 7 Sep 2021 20:28:12 +0100 (BST) X-Spam-Checker-Version: SpamAssassin 3.4.2 (2018-09-13) on mira.cbaines.net X-Spam-Level: X-Spam-Status: No, score=-2.9 required=5.0 tests=BAYES_00,MAILING_LIST_MULTI, RCVD_IN_MSPIKE_H2,SPF_HELO_PASS,URIBL_BLOCKED autolearn=unavailable autolearn_force=no version=3.4.2 Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mira.cbaines.net (Postfix) with ESMTPS id 106BA27BBE1 for ; Tue, 7 Sep 2021 20:28:12 +0100 (BST) Received: from localhost ([::1]:50252 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1mNglP-0006Ix-0O for patchwork@mira.cbaines.net; Tue, 07 Sep 2021 15:28:11 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:37488) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1mNglG-0006F5-QS for guix-patches@gnu.org; Tue, 07 Sep 2021 15:28:02 -0400 Received: from debbugs.gnu.org ([209.51.188.43]:46275) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1mNglG-0005yc-JO for guix-patches@gnu.org; Tue, 07 Sep 2021 15:28:02 -0400 Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1mNglG-0005kB-Ah for guix-patches@gnu.org; Tue, 07 Sep 2021 15:28:02 -0400 X-Loop: help-debbugs@gnu.org Subject: [bug#50286] [RFC PATCH] Let 'package-location' returns location of surrounding 'let'. Resent-From: Ludovic =?utf-8?q?Court=C3=A8s?= Original-Sender: "Debbugs-submit" Resent-CC: guix-patches@gnu.org Resent-Date: Tue, 07 Sep 2021 19:28:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 50286 X-GNU-PR-Package: guix-patches X-GNU-PR-Keywords: patch To: Maxime Devos Cc: iskarian@mgsn.dev, 50286@debbugs.gnu.org Received: via spool by 50286-submit@debbugs.gnu.org id=B50286.163104286922043 (code B ref 50286); Tue, 07 Sep 2021 19:28:02 +0000 Received: (at 50286) by debbugs.gnu.org; 7 Sep 2021 19:27:49 +0000 Received: from localhost ([127.0.0.1]:57818 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1mNgl2-0005jQ-8v for submit@debbugs.gnu.org; Tue, 07 Sep 2021 15:27:48 -0400 Received: from eggs.gnu.org ([209.51.188.92]:49516) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1mNgkz-0005jD-SO for 50286@debbugs.gnu.org; Tue, 07 Sep 2021 15:27:46 -0400 Received: from fencepost.gnu.org ([2001:470:142:3::e]:34516) by eggs.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1mNgks-0005kZ-Dm; Tue, 07 Sep 2021 15:27:38 -0400 Received: from [2a01:e0a:1d:7270:af76:b9b:ca24:c465] (port=35382 helo=ribbon) by fencepost.gnu.org with esmtpsa (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1mNgks-000173-5Y; Tue, 07 Sep 2021 15:27:38 -0400 From: Ludovic =?utf-8?q?Court=C3=A8s?= References: <0b61652d751633f78e876a27be88ed14e47527b6.camel@telenet.be> <87o89681br.fsf@gnu.org> Date: Tue, 07 Sep 2021 21:27:35 +0200 In-Reply-To: <87o89681br.fsf@gnu.org> ("Ludovic =?utf-8?q?Court=C3=A8s?= "'s message of "Mon, 06 Sep 2021 12:07:04 +0200") Message-ID: <875yvc4254.fsf_-_@gnu.org> User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/27.2 (gnu/linux) MIME-Version: 1.0 X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list X-BeenThere: guix-patches@gnu.org List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: guix-patches-bounces+patchwork=mira.cbaines.net@gnu.org Sender: "Guix-patches" X-getmail-retrieved-from-mailbox: Patches Hi Maxime & Sarah, Ludovic Courtès skribis: > Hmm, thinking out loud, what about this: use the same trick as you did, > but replace ‘define-public’ instead of ‘let’ & co., so as to be less > intrusive. > > (define-syntax-parameter current-definition-location > (identifier-syntax #f)) > > (define-syntax define-public* > (syntax-rules () > ((_ prototype body) > (define-public prototype > (syntax-parameterize ((current-definition-location > (identifier-syntax (current-source-location)))) > body))))) > > Since there’s code that assumes ‘package-location’ returns the location > of the (package …) sexp, we could add a ‘definition-location’ field in > , defaulting to ‘current-definition-location’, or tweak > ‘location’ to include both. Below is an attempt at doing this. As discussed on IRC, the first patch switches the ‘location’ field to a more compact format that may reduce load time by a tiny bit, though it’s hard to measure. The second patch introduces an extra field for the definition location; that means that records now occupy an extra word, which is not great, but unfortunately OTOH location is slightly smaller. Example: --8<---------------cut here---------------start------------->8--- scheme@(guile-user)> ,use(gnu packages base) scheme@(guile-user)> ,use(gnu packages accessibility) scheme@(guile-user)> ,use(guix) scheme@(guile-user)> (package-location footswitch) $1 = #< file: "gnu/packages/accessibility.scm" line: 257 column: 4> scheme@(guile-user)> (package-definition-location footswitch) $2 = #< file: "gnu/packages/accessibility.scm" line: 254 column: 0> scheme@(guile-user)> (package-location hello) $3 = #< file: "gnu/packages/base.scm" line: 79 column: 2> scheme@(guile-user)> (package-definition-location hello) $4 = #< file: "gnu/packages/base.scm" line: 78 column: 0> --8<---------------cut here---------------end--------------->8--- Thoughts? Thanks, Ludo’. From bc2d7144bb9ef0ea74f9ef5922d568291818de32 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ludovic=20Court=C3=A8s?= Date: Tue, 7 Sep 2021 21:19:11 +0200 Subject: [PATCH 2/2] packages: Add 'package-definition-location'. Suggested by Maxime Devos . * guix/packages.scm (current-definition-location-vector): New syntax parameter. (define-public*): New macro. ()[definition-location]: New field. (package-definition-location): New procedure. * tests/packages.scm ("package-definition-location"): New test. --- guix/packages.scm | 42 +++++++++++++++++++++++++++++++++++++++++- tests/packages.scm | 11 +++++++++++ 2 files changed, 52 insertions(+), 1 deletion(-) diff --git a/guix/packages.scm b/guix/packages.scm index 01de50ebd7..2f70ec9c64 100644 --- a/guix/packages.scm +++ b/guix/packages.scm @@ -52,6 +52,7 @@ #:re-export (%current-system %current-target-system search-path-specification) ;for convenience + #:replace ((define-public* . define-public)) #:export (content-hash content-hash? content-hash-algorithm @@ -99,6 +100,7 @@ package-supported-systems package-properties package-location + package-definition-location hidden-package hidden-package? package-superseded @@ -385,6 +387,31 @@ one-indexed line numbers." (location-line loc) (location-column loc))))) +(define-syntax-parameter current-definition-location-vector + ;; Location of the encompassing 'define-public'. + (const #f)) + +(define-syntax define-public* + (lambda (s) + "Like 'define-public' but set 'current-definition-location' for the +lexical scope of its body." + (define location + (match (syntax-source s) + (#f #f) + (properties + (let ((line (assq-ref properties 'line)) + (column (assq-ref properties 'column))) + ;; Don't repeat the file name since it's redundant with 'location'. + (and line column + #`#(#,(+ 1 line) #,column)))))) + + (syntax-case s () + ((_ prototype body ...) + #`(define-public prototype + (syntax-parameterize ((current-definition-location-vector + (lambda (s) #,location))) + body ...)))))) + ;; A package. (define-record-type* package make-package @@ -430,7 +457,10 @@ one-indexed line numbers." (location package-location-vector (default (current-location-vector)) - (innate) (sanitize sanitize-location))) + (innate) (sanitize sanitize-location)) + (definition-location package-definition-location-vector + (default (current-definition-location-vector)) + (innate))) (set-record-type-printer! (lambda (package port) @@ -455,6 +485,16 @@ it is not known." (#f #f) (#(file line column) (location file line column)))) +(define (package-definition-location package) + "Like 'package-location', but return the location of the definition +itself--i.e., that of the enclosing 'define-public' form, if any, or #f." + (match (package-definition-location-vector package) + (#f #f) + (#(line column) + (match (package-location-vector package) + (#f #f) + (#(file _ _) (location file line column)))))) + (define-syntax-rule (package/inherit p overrides ...) "Like (package (inherit P) OVERRIDES ...), except that the same transformation is done to the package P's replacement, if any. P must be a bare diff --git a/tests/packages.scm b/tests/packages.scm index 2a290bc353..3756877270 100644 --- a/tests/packages.scm +++ b/tests/packages.scm @@ -236,6 +236,17 @@ (eq? item new))) (null? (manifest-transaction-remove tx))))))) +(test-assert "package-definition-location" + (let ((location (package-location hello)) + (definition (package-definition-location hello))) + ;; Check for the usual layout of (define-public hello (package ...)). + (and (string=? (location-file location) + (location-file definition)) + (= 0 (location-column definition)) + (= 2 (location-column location)) + (= (location-line definition) + (- (location-line location) 1))))) + (test-assert "package-field-location" (let () (define (goto port line column) -- 2.33.0