From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Maxim Cournoyer Newsgroups: gmane.lisp.guile.bugs Subject: bug#66046: [PATCH v2 3/3] ice-9: Fix 'include' when used in compilation contexts. Date: Wed, 22 Nov 2023 11:11:44 -0500 Message-ID: <20231122161204.26366-3-maxim.cournoyer@gmail.com> References: <20231122161204.26366-1-maxim.cournoyer@gmail.com> Mime-Version: 1.0 Content-Transfer-Encoding: 8bit Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="13761"; mail-complaints-to="usenet@ciao.gmane.io" Cc: Timothy Sample , Amirouche , Maxim Cournoyer , Daphne Preston-Kendal To: 66046@debbugs.gnu.org Original-X-From: bug-guile-bounces+guile-bugs=m.gmane-mx.org@gnu.org Wed Nov 22 17:13:24 2023 Return-path: Envelope-to: guile-bugs@m.gmane-mx.org Original-Received: from lists.gnu.org ([209.51.188.17]) by ciao.gmane.io with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1r5pqt-0003PS-R6 for guile-bugs@m.gmane-mx.org; Wed, 22 Nov 2023 17:13:23 +0100 Original-Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1r5pqY-0002Er-7n; Wed, 22 Nov 2023 11:13:02 -0500 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1r5pqV-0002ED-Kp for bug-guile@gnu.org; Wed, 22 Nov 2023 11:12:59 -0500 Original-Received: from debbugs.gnu.org ([2001:470:142:5::43]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1r5pqV-0002Dz-Cb for bug-guile@gnu.org; Wed, 22 Nov 2023 11:12:59 -0500 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1r5pqY-0007LY-Li for bug-guile@gnu.org; Wed, 22 Nov 2023 11:13:02 -0500 X-Loop: help-debbugs@gnu.org Resent-From: Maxim Cournoyer Original-Sender: "Debbugs-submit" Resent-CC: bug-guile@gnu.org Resent-Date: Wed, 22 Nov 2023 16:13:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 66046 X-GNU-PR-Package: guile Original-Received: via spool by 66046-submit@debbugs.gnu.org id=B66046.170066954528173 (code B ref 66046); Wed, 22 Nov 2023 16:13:02 +0000 Original-Received: (at 66046) by debbugs.gnu.org; 22 Nov 2023 16:12:25 +0000 Original-Received: from localhost ([127.0.0.1]:59747 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1r5ppw-0007KF-JV for submit@debbugs.gnu.org; Wed, 22 Nov 2023 11:12:25 -0500 Original-Received: from mail-qk1-x72a.google.com ([2607:f8b0:4864:20::72a]:53549) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1r5ppu-0007Jf-Ki for 66046@debbugs.gnu.org; Wed, 22 Nov 2023 11:12:23 -0500 Original-Received: by mail-qk1-x72a.google.com with SMTP id af79cd13be357-77d632b35faso59848985a.3 for <66046@debbugs.gnu.org>; Wed, 22 Nov 2023 08:12:19 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1700669533; x=1701274333; darn=debbugs.gnu.org; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=9YJDexYK/ONV7xcRH0TROsZg65xWLtPAx88Jh5fP5UI=; b=aELdmtnqMt6sQyVPgphlKn1HIhfd1V8fSdkGnMxUKwsO2zku8cHUnCvJ0ZzHIyO/tr sU9eI5FoxRqgPM9ySi1X6xT5b0TgrV6nt5IWUiVjwZ5EizhShliIS3mcOvl2De/XpuI8 6kwlUw6joIA4n1d2YZmZeSx+B/JHvKx9O4f8Zg6XBbRSfzX0AoRQ7It5VAeL8/P1XObW 6f60le5SgddaR1PBlhZlsLbBhuK2hAGVPJqQVgmWU/+ex+jg32kv/PLTmCcaEGfDajrv OXogwkJNjUAS2ALopRBOijgmZ9B8VdPQkl05/q88sQlc/MHgYCEXLuzJVF+onBv8AMao F3EQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1700669533; x=1701274333; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=9YJDexYK/ONV7xcRH0TROsZg65xWLtPAx88Jh5fP5UI=; b=HeYtchDWfo4Y7ZDv+M+aYpTjCsk7GyI6yZuNr7apvMAQ72og1CrieAdPybWtueKoR2 5uZphq3/rpqLqzh1oC6YImqFYlHQQsvU2PzHzjeUNuhcNGAvnce5OkvZ/Gxxo2PX5qK3 QTjictVCsHmzpQ+qxh7SXa4R0PfJwAPpeBnpy6aAeLyYvxBKrUQoiqXvphJD4VDwRs23 Kwiri0WjvuSBT01MV6eialBhigjmteH8twwFodGrjC+hHcmai+m/Dce3JJ6WW0gIsRF7 zsnUeYy4OoB/+3d+rUdPgfulPLWUwDWPOQR6VEiMj73L48QCXJ8ORTe86ryg7wm/SJaw 8WAw== X-Gm-Message-State: AOJu0YxiWYEPQ0Ysw+k7j+1ESW92/iKmlh6qF3qKld2rI7J0mntE6p1K 95m91JYbHl45YoQFr9esQuVKR43zxQY= X-Google-Smtp-Source: AGHT+IG1VrkVINboFJ529cW6RwEb3w0AeqN1vVp0xaQ03pjAmvGMHR6UCWtyecpb3ekFxCQ/srjapg== X-Received: by 2002:ac8:108c:0:b0:423:7d97:7395 with SMTP id a12-20020ac8108c000000b004237d977395mr1787604qtj.16.1700669533183; Wed, 22 Nov 2023 08:12:13 -0800 (PST) Original-Received: from localhost.localdomain (dsl-205-233-124-102.b2b2c.ca. [205.233.124.102]) by smtp.gmail.com with ESMTPSA id u7-20020ac87507000000b00419b9b1b0b0sm4516257qtq.56.2023.11.22.08.12.12 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 22 Nov 2023 08:12:12 -0800 (PST) X-Mailer: git-send-email 2.41.0 In-Reply-To: <20231122161204.26366-1-maxim.cournoyer@gmail.com> X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list X-BeenThere: bug-guile@gnu.org List-Id: "Bug reports for GUILE, GNU's Ubiquitous Extension Language" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: bug-guile-bounces+guile-bugs=m.gmane-mx.org@gnu.org Original-Sender: bug-guile-bounces+guile-bugs=m.gmane-mx.org@gnu.org Xref: news.gmane.io gmane.lisp.guile.bugs:10707 Archived-At: Fixes bug #66046. Introduce a '%file-port-stripped-prefixes' fluid that captures the pre-canonicalized file name used when compiling a file, before it gets modified in fport_canonicalize_filename. That reference that can then used by 'include' when searching for included files. * libguile/fports.c (sys_file_port_stripped_prefixes): New C fluid. (fport_canonicalize_filename): Register dirnames / stripped prefixes pairs in. (%file-port-stripped-prefixes): New corresponding Scheme fluid. * module/ice-9/boot-9.scm (call-with-include-port): New procedure, shadowing that from psyntax, that extends it to use the above fluid to compute a fallback include file directory name to try. * module/ice-9/psyntax.scm (call-with-include-port): Add comment. Strip documentation, as it's now an internal. --- Changes in v2: - Move fluid to where the file name stripping happens, in libguile - Make the fluid value an alist of the last 100 stripped prefixes - Expound test to catch edge case (include in an include) libguile/fports.c | 41 +++++++++++++++++++++-- module/ice-9/boot-9.scm | 61 ++++++++++++++++++++++++++++++++++ module/ice-9/psyntax.scm | 8 ++--- test-suite/tests/compiler.test | 8 ++--- 4 files changed, 106 insertions(+), 12 deletions(-) diff --git a/libguile/fports.c b/libguile/fports.c index 8f19216b7..12048828a 100644 --- a/libguile/fports.c +++ b/libguile/fports.c @@ -1,4 +1,4 @@ -/* Copyright 1995-2004,2006-2015,2017-2020,2022 +/* Copyright 1995-2004,2006-2015,2017-2020,2022-2023 Free Software Foundation, Inc. This file is part of Guile. @@ -43,6 +43,7 @@ #include #include +#include "alist.h" #include "async.h" #include "boolean.h" #include "dynwind.h" @@ -59,6 +60,7 @@ #include "ports-internal.h" #include "posix.h" #include "read.h" +#include "srfi-13.h" #include "strings.h" #include "symbols.h" #include "syscalls.h" @@ -123,6 +125,7 @@ SCM_DEFINE (scm_file_port_p, "file-port?", 1, 0, 0, static SCM sys_file_port_name_canonicalization; +static SCM sys_file_port_stripped_prefixes; static SCM sym_relative; static SCM sym_absolute; @@ -143,7 +146,34 @@ fport_canonicalize_filename (SCM filename) "%load-path")); rel = scm_i_relativize_path (filename, path); - return scm_is_true (rel) ? rel : filename; + if (scm_is_true (rel)) + { + SCM relative_dir = scm_dirname (rel); + SCM stripped_prefixes = scm_fluid_ref + (sys_file_port_stripped_prefixes); + + /* Extend the association list if needed, but keep its size + capped to limit memory usage. */ + if (scm_is_false (scm_assoc_ref(stripped_prefixes, relative_dir))) + { + SCM stripped_prefix = scm_string_drop_right + (filename, scm_string_length (rel)); + + stripped_prefixes = scm_cons (scm_cons (relative_dir, + stripped_prefix), + stripped_prefixes); + + if (scm_to_int (scm_length (stripped_prefixes)) > 100) + stripped_prefixes = scm_list_head (stripped_prefixes, + scm_from_int(100)); + + scm_fluid_set_x (sys_file_port_stripped_prefixes, + stripped_prefixes); + } + + return rel; + } + return filename; } else if (scm_is_eq (mode, sym_absolute)) { @@ -766,4 +796,11 @@ scm_init_fports () sys_file_port_name_canonicalization = scm_make_fluid (); scm_c_define ("%file-port-name-canonicalization", sys_file_port_name_canonicalization); + + /* Used by `include' to locate the true source when relative + canonicalization strips a leading part of the source file. */ + sys_file_port_stripped_prefixes = scm_make_fluid_with_default (SCM_EOL); + + scm_c_define ("%file-port-stripped-prefixes", + sys_file_port_stripped_prefixes); } diff --git a/module/ice-9/boot-9.scm b/module/ice-9/boot-9.scm index a5f2eea9b..a79d49ae1 100644 --- a/module/ice-9/boot-9.scm +++ b/module/ice-9/boot-9.scm @@ -2030,6 +2030,67 @@ non-locally, that exit determines the continuation." +;;; {Include} +;;; + +;;; This redefined version of call-with-include-port (first defined in +;;; psyntax.scm) also try to locate an included file using the +;;; %file-port-stripped-prefixes fluid. +(define call-with-include-port + (let ((syntax-dirname (lambda (stx) + (define src (syntax-source stx)) + (define filename (and src (assq-ref src 'filename))) + (and (string? filename) + (dirname filename))))) + (lambda* (filename proc #:key (dirname (syntax-dirname filename))) + "Like @code{call-with-input-file}, except relative paths are +searched relative to @var{dirname} instead of the current working +directory. Also, @var{filename} can be a syntax object; in that case, +and if @var{dirname} is not specified, the @code{syntax-source} of +@var{filename} is used to obtain a base directory for relative file +names. As a special case, when the @var{%file-port-stripped-prefixes} +fluid is set, its value is searched for a directory matching the dirname +inferred from FILENAME." + (let* ((filename (syntax->datum filename)) + (candidates + (cond ((absolute-file-name? filename) + (list filename)) + (dirname ;filename is relative + (let* ((rel-names (fluid-ref %file-port-stripped-prefixes)) + (stripped-prefix (and rel-names + (assoc-ref rel-names dirname))) + (fallback (and stripped-prefix + (string-append stripped-prefix + dirname)))) + (map (lambda (d) + (in-vicinity d filename)) + `(,dirname ,@(if fallback + (list fallback) + '()))))) + (else + (error + "attempt to include relative file name \ +but could not determine base dir")))) + (p (let loop ((files candidates)) + (when (null? files) + (error "could not open any of" candidates)) + (catch 'system-error + (lambda _ + (open-input-file (car files))) + (lambda _ + (loop (cdr files)))))) + (enc (file-encoding p))) + + ;; Choose the input encoding deterministically. + (set-port-encoding! p (or enc "UTF-8")) + + (call-with-values (lambda () (proc p)) + (lambda results + (close-port p) + (apply values results))))))) + + + ;;; {Time Structures} ;;; diff --git a/module/ice-9/psyntax.scm b/module/ice-9/psyntax.scm index 7811f7118..0e0370457 100644 --- a/module/ice-9/psyntax.scm +++ b/module/ice-9/psyntax.scm @@ -3256,6 +3256,8 @@ ;; Scheme code corresponding to the intermediate language forms. ((_ e) (emit (quasi #'e 0))))))) +;; Note: this procedure is later refined in ice-9/boot-9.scm after we +;; have basic exception handling. (define call-with-include-port (let ((syntax-dirname (lambda (stx) (define src (syntax-source stx)) @@ -3263,12 +3265,6 @@ (and (string? filename) (dirname filename))))) (lambda* (filename proc #:key (dirname (syntax-dirname filename))) - "Like @code{call-with-input-file}, except relative paths are -searched relative to the @var{dirname} instead of the current working -directory. Also, @var{filename} can be a syntax object; in that case, -and if @var{dirname} is not specified, the @code{syntax-source} of -@var{filename} is used to obtain a base directory for relative file -names." (let* ((filename (syntax->datum filename)) (p (open-input-file (cond ((absolute-file-name? filename) diff --git a/test-suite/tests/compiler.test b/test-suite/tests/compiler.test index ff923095a..79aee1a0e 100644 --- a/test-suite/tests/compiler.test +++ b/test-suite/tests/compiler.test @@ -501,13 +501,13 @@ #t) ;; This used to fail, because compile-file's #:canonicalization - ;; defaults to 'relative, which caused 'scm_relativize_path' to + ;; defaults to 'relative, which causes 'scm_relativize_path' to ;; strip the prefix not in the load path, to avoid baking an ;; invalid source file reference in the byte compiled output file ;; (see: https://bugs.gnu.org/66046). This was fixed by having a - ;; 'compilation-source-file' fluid that preserves the file name - ;; passed to 'compile-file', used by 'include' instead of the file - ;; name of the port. + ;; '%file-port-stripped-prefixes' fluid to preserve the stripped + ;; prefix, to be used by 'include' to reconstruct the original + ;; complete relative file name. (pass-if "relative include works with load path canonicalization" (add-to-load-path (string-append (getcwd) "/../module")) (compile-file "../module/hello.scm" #:output-file "hello.go") -- 2.41.0