From: "Ludovic Courtès" <ludo@gnu.org>
To: Maxim Cournoyer <maxim.cournoyer@gmail.com>
Cc: 58855@debbugs.gnu.org, guix-devel@gnu.org
Subject: Layout of ‘define-configuration’ records
Date: Thu, 17 Nov 2022 23:37:49 +0100 [thread overview]
Message-ID: <87zgcpdx6q.fsf_-_@gnu.org> (raw)
In-Reply-To: <20221029041649.12144-1-maxim.cournoyer@gmail.com> (Maxim Cournoyer's message of "Sat, 29 Oct 2022 00:16:45 -0400")
Hi,
Maxim Cournoyer <maxim.cournoyer@gmail.com> skribis:
> This is so that the first field of the generated record matches the first one
> declared, which makes 'define-configuration' record API compatible with
> define-record-type* ones.
>
> * gnu/services/configuration.scm (define-configuration-helper): Move the
> %location field below the ones declared by the user.
> * gnu/services/monitoring.scm (zabbix-front-end-config): Adjust match pattern
> accordingly.
[...]
> +++ b/gnu/services/configuration.scm
> @@ -242,17 +242,17 @@ (define-record-type* #,(id #'stem #'< #'stem #'>)
> stem
> #,(id #'stem #'make- #'stem)
> #,(id #'stem #'stem #'?)
> - (%location #,(id #'stem #'stem #'-location)
> - (default (and=> (current-source-location)
> - source-properties->location))
> - (innate))
> #,@(map (lambda (name getter def)
> #`(#,name #,getter (default #,def)
> (sanitize
> #,(id #'stem #'validate- #'stem #'- name))))
> #'(field ...)
> #'(field-getter ...)
> - #'(field-default ...)))
> + #'(field-default ...))
> + (%location #,(id #'stem #'stem #'-location)
> + (default (and=> (current-source-location)
> + source-properties->location))
> + (innate)))
Moving the field last is problematic as we’ve seen for any user that
uses ‘match’ on records—something that’s not recommended but still used
a lot.
> (define (zabbix-front-end-config config)
> (match-record config <zabbix-front-end-configuration>
> - (%location db-host db-port db-name db-user db-password db-secret-file
> - zabbix-host zabbix-port)
> + (db-host db-port db-name db-user db-password db-secret-file
> + zabbix-host zabbix-port %location)
This change has no effect because ‘match-record’ matches fields by name,
precisely to avoid problems when changing the layout of record types.
I’m not sure what was meant by “compatible” in the commit log; how
fields are laid out is something user code should not be aware of.
The only thing to keep in mind is that records must not be matched with
‘match’ because then the code silently breaks when the record type
layout is changed. This is why ‘match-record’ was introduced:
https://issues.guix.gnu.org/28960#4
One last thing: placing ‘%location’ first can let us implement:
(define (configuration-location config)
(struct-ref config 0))
As if there were type inheritance. I didn’t see any indication that
this is actually done anywhere, but it could have been the case (it’s
not an unusual pattern) and it’s still something we might want to do.
Does that make sense?
Thanks,
Ludo’.
next parent reply other threads:[~2022-11-17 22:38 UTC|newest]
Thread overview: 14+ messages / expand[flat|nested] mbox.gz Atom feed top
[not found] <20221029034716.11125-1-maxim.cournoyer@gmail.com>
[not found] ` <20221029041649.12144-1-maxim.cournoyer@gmail.com>
2022-11-17 22:37 ` Ludovic Courtès [this message]
2022-11-18 16:44 ` Layout of ‘define-configuration’ records Maxim Cournoyer
2022-11-19 21:25 ` Katherine Cox-Buday
2022-11-20 13:47 ` Maxim Cournoyer
2022-11-21 10:26 ` Ludovic Courtès
2022-11-21 20:08 ` Maxim Cournoyer
2022-11-21 16:49 ` Katherine Cox-Buday
2022-11-21 21:00 ` Maxim Cournoyer
2022-11-22 14:52 ` zimoun
2022-11-25 15:18 ` Maxim Cournoyer
2022-11-21 10:22 ` Ludovic Courtès
2022-11-21 21:16 ` Maxim Cournoyer
2022-11-23 21:56 ` Ludovic Courtès
2022-11-25 15:15 ` Maxim Cournoyer
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://guix.gnu.org/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=87zgcpdx6q.fsf_-_@gnu.org \
--to=ludo@gnu.org \
--cc=58855@debbugs.gnu.org \
--cc=guix-devel@gnu.org \
--cc=maxim.cournoyer@gmail.com \
/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/guix.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).