From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Alan Mackenzie Newsgroups: gmane.emacs.bugs Subject: bug#50946: insert-file-contents can corrupt buffers. Date: Sun, 3 Oct 2021 15:04:27 +0000 Message-ID: References: <87ee933bcj.fsf@gmail.com> <83pmsnbnci.fsf@gnu.org> <83k0ivbjbu.fsf@gnu.org> <83czonbhex.fsf@gnu.org> <83lf3a8eo7.fsf@gnu.org> Mime-Version: 1.0 Content-Type: text/plain; charset=us-ascii Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="9875"; mail-complaints-to="usenet@ciao.gmane.io" Cc: 50946@debbugs.gnu.org, joaotavora@gmail.com To: Eli Zaretskii Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Sun Oct 03 17:06:06 2021 Return-path: Envelope-to: geb-bug-gnu-emacs@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 1mX341-0002Jv-LE for geb-bug-gnu-emacs@m.gmane-mx.org; Sun, 03 Oct 2021 17:06:05 +0200 Original-Received: from localhost ([::1]:42438 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1mX33y-0005i9-Vk for geb-bug-gnu-emacs@m.gmane-mx.org; Sun, 03 Oct 2021 11:06:03 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:60012) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1mX330-0005hB-Lz for bug-gnu-emacs@gnu.org; Sun, 03 Oct 2021 11:05:02 -0400 Original-Received: from debbugs.gnu.org ([209.51.188.43]:51410) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1mX330-0003PJ-CR for bug-gnu-emacs@gnu.org; Sun, 03 Oct 2021 11:05:02 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1mX32z-0001sb-TY for bug-gnu-emacs@gnu.org; Sun, 03 Oct 2021 11:05:01 -0400 X-Loop: help-debbugs@gnu.org Resent-From: Alan Mackenzie Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Sun, 03 Oct 2021 15:05:01 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 50946 X-GNU-PR-Package: emacs Original-Received: via spool by 50946-submit@debbugs.gnu.org id=B50946.16332734797181 (code B ref 50946); Sun, 03 Oct 2021 15:05:01 +0000 Original-Received: (at 50946) by debbugs.gnu.org; 3 Oct 2021 15:04:39 +0000 Original-Received: from localhost ([127.0.0.1]:34723 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1mX32c-0001rk-Hb for submit@debbugs.gnu.org; Sun, 03 Oct 2021 11:04:38 -0400 Original-Received: from colin.muc.de ([193.149.48.1]:24301 helo=mail.muc.de) by debbugs.gnu.org with smtp (Exim 4.84_2) (envelope-from ) id 1mX32Y-0001rV-D2 for 50946@debbugs.gnu.org; Sun, 03 Oct 2021 11:04:37 -0400 Original-Received: (qmail 62574 invoked by uid 3782); 3 Oct 2021 15:04:28 -0000 Original-Received: from acm.muc.de (p4fe1506f.dip0.t-ipconnect.de [79.225.80.111]) (using STARTTLS) by colin.muc.de (tmda-ofmipd) with ESMTP; Sun, 03 Oct 2021 17:04:28 +0200 Original-Received: (qmail 6905 invoked by uid 1000); 3 Oct 2021 15:04:27 -0000 Content-Disposition: inline In-Reply-To: <83lf3a8eo7.fsf@gnu.org> X-Submission-Agent: TMDA/1.3.x (Ph3nix) X-Primary-Address: acm@muc.de X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list X-BeenThere: bug-gnu-emacs@gnu.org List-Id: "Bug reports for GNU Emacs, the Swiss army knife of text editors" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Original-Sender: "bug-gnu-emacs" Xref: news.gmane.io gmane.emacs.bugs:216267 Archived-At: Hello, Eli. On Sun, Oct 03, 2021 at 15:40:24 +0300, Eli Zaretskii wrote: > > Date: Sun, 3 Oct 2021 12:10:19 +0000 > > Cc: joaotavora@gmail.com, 50946@debbugs.gnu.org > > From: Alan Mackenzie [ .... ] > > There are bugs in the documentation of insert-file-contents in the elisp > > manual. It confuses bytes with characters, and it fails to mention the > > need to keep BEG and END at character boundaries. I propose installing > > the following patch to the release branch: > Thanks, I will review this later. However: > > @@ -580,7 +583,8 @@ Reading from Files > > This function works like @code{insert-file-contents} except that it > > does not run @code{after-insert-file-functions}, and does not do > > format decoding, character code conversion, automatic uncompression, > > -and so on. > > +and so on. @var{beg} and @var{end}, if non-@code{nil}, should be at > > +character boundaries, as in @code{insert-file-contents}. > > @end defun > I don't think I understand why you made this second correction: > insert-file-contents-literally deals with bytes to begin with. > > The doc strings of insert-file-contents\(-literally\)? will also need to > > be updated. > In some sense, yes. Here is an updated patch, superseding my patch from midday. I have amended the descriptions of the two functions, replacing "corruption" of the buffer by "inserting raw-text characters" in the first function, and added explanation to the second. I wasn't able to find a suitable target for a cross-reference explaining "raw-text". diff --git a/doc/lispref/files.texi b/doc/lispref/files.texi index 2dc808e694..63eaf24769 100644 --- a/doc/lispref/files.texi +++ b/doc/lispref/files.texi @@ -556,14 +556,18 @@ Reading from Files If @var{beg} and @var{end} are non-@code{nil}, they should be numbers that are byte offsets specifying the portion of the file to insert. -In this case, @var{visit} must be @code{nil}. For example, +In this case, @var{visit} must be @code{nil}. Be careful to ensure +that these byte positions are at character boundaries. Otherwise, +Emacs's character code conversion will insert one or more raw-text +characters into the buffer, which is probably not what you want. For +example, @example (insert-file-contents filename nil 0 500) @end example @noindent -inserts the first 500 characters of a file. +inserts the characters coded by the first 500 bytes of a file. If the argument @var{replace} is non-@code{nil}, it means to replace the contents of the buffer (actually, just the accessible portion) with the @@ -577,10 +581,11 @@ Reading from Files @end defun @defun insert-file-contents-literally filename &optional visit beg end replace -This function works like @code{insert-file-contents} except that it -does not run @code{after-insert-file-functions}, and does not do -format decoding, character code conversion, automatic uncompression, -and so on. +This function works like @code{insert-file-contents} except that each +byte in the file is handled separately, being converted into a +raw-text character if needed. It does not run +@code{after-insert-file-functions}, and does not do format decoding, +character code conversion, automatic uncompression, and so on. @end defun If you want to pass a file name to another process so that another -- Alan Mackenzie (Nuremberg, Germany).