unofficial mirror of emacs-devel@gnu.org 
 help / color / mirror / code / Atom feed
From: "Colin Woodbury" <colin@fosskers.ca>
To: "Stefan Monnier" <monnier@iro.umontreal.ca>
Cc: "Basil L. Contovounesios" <contovob@tcd.ie>, emacs-devel@gnu.org
Subject: Re: [PATCH] lisp/files.el: Add `file-name-set-extension`
Date: Tue, 25 May 2021 14:44:30 -0700	[thread overview]
Message-ID: <6ba4668c-9b39-40e0-a155-f7e583fd33b6@www.fastmail.com> (raw)
In-Reply-To: <jwvy2c2pkv5.fsf-monnier+emacs@gnu.org>


[-- Attachment #1.1: Type: text/plain, Size: 1534 bytes --]

Thanks Stefan, I've revised the patch according to your suggestions (see attached). I also revised the docstring.

Thanks!
Colin

On Tue, 25 May 2021, at 14:29, Stefan Monnier wrote:
> > That regex was borrowed directly from `string-trim`, to which I added
> > a `.`. You're right that the main motivation was to allow the caller to pass
> > either `.foo` or `foo` as the extension and have either case work (many
> > languages do this). Leaving the other characters in the regex seemed like
> > a sanitary thing to do, just in case they pass something bogus.
> 
> File names can be used in different ways for different purposes.
> We don't have any good reason to think that a space or a newline at the
> end of a file name (or beginning of an extension) is "bogus".
> 
> If such things occurred somewhat often and always in ways where they are
> indeed undesirable, we could consider removing them (the tradeoff
> between occasional harm and frequent error-avoidance would be
> favorable), but here this is just asking for trouble with no benefit.
> 
> > 1. Simplifying the regex to just include dots (and perhaps whitespace) (i.e. trust the caller), or;
> 
> Please do that.
> 
> > 2. Expanding the logic to sanitize both ends of both arguments, (i.e. don't trust the caller), or;
> 
> I don't think we have any reason to think we should "sanitize" it.
> 
> > 3. Adding error-throwing logic if malformed files or extensions are given (i.e. warn the user).
> 
> "Malformed" according to which standard?
> 
> 
>         Stefan
> 
> 

[-- Attachment #1.2: Type: text/html, Size: 2254 bytes --]

[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: file-name-set-extension.patch --]
[-- Type: text/x-patch; name="file-name-set-extension.patch", Size: 1050 bytes --]

diff --git a/lisp/files.el b/lisp/files.el
index 62e1702fdf..ab8be6ad9e 100644
--- a/lisp/files.el
+++ b/lisp/files.el
@@ -4889,6 +4889,21 @@ extension, the value is \"\"."
         (if period
             "")))))
 
+(defun file-name-set-extension (filename extension)
+  "Set the extension of a FILENAME to EXTENSION.
+Consolidates leading/trailing dots so that either `foo' or `.foo'
+can be passed as an EXTENSION.
+
+Returns nil if either of the FILENAME or EXTENSION are nil before
+dot consolidation, or empty afterwards."
+  (when (and filename extension)
+    (let* ((patt "[ .]+")
+           (filename (string-trim-right filename patt))
+           (extension (string-trim-left extension patt)))
+      (unless (or (string-empty-p filename)
+                  (string-empty-p extension))
+        (concat (file-name-sans-extension filename) "." extension)))))
+
 (defun file-name-base (&optional filename)
   "Return the base name of the FILENAME: no directory, no extension."
   (declare (advertised-calling-convention (filename) "27.1"))

  reply	other threads:[~2021-05-25 21:44 UTC|newest]

Thread overview: 22+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-05-25 15:50 [PATCH] lisp/files.el: Add `file-name-set-extension` Colin Woodbury
2021-05-25 17:48 ` Andreas Schwab
2021-05-25 19:42   ` Colin Woodbury
2021-05-25 18:00 ` Basil L. Contovounesios
2021-05-25 19:45   ` Colin Woodbury
2021-05-25 20:25     ` Stefan Monnier
2021-05-25 21:21       ` Colin Woodbury
2021-05-25 21:29         ` Stefan Monnier
2021-05-25 21:44           ` Colin Woodbury [this message]
2021-05-26  7:34             ` Andreas Schwab
2021-05-26 16:31               ` Colin Woodbury
2021-05-26 17:39                 ` Andreas Schwab
2021-05-31  1:16                   ` Colin Woodbury
2021-06-04 13:08                     ` Philipp
     [not found]                       ` <26B660D9-AC76-4AFC-9FFD-2F5D4DCA16C1@acm.org>
2021-06-09 20:54                         ` Colin Woodbury
2021-06-09 23:05                           ` Stefan Monnier
2021-06-10  0:42                             ` Colin Woodbury
2021-06-10  2:45                               ` Colin Woodbury
2021-06-10  7:46                           ` Michael Albinus
2021-06-10 14:40                             ` Colin Woodbury
2021-06-16  1:15                               ` Colin Woodbury
2021-06-19  9:16                                 ` Michael Albinus

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://www.gnu.org/software/emacs/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=6ba4668c-9b39-40e0-a155-f7e583fd33b6@www.fastmail.com \
    --to=colin@fosskers.ca \
    --cc=contovob@tcd.ie \
    --cc=emacs-devel@gnu.org \
    --cc=monnier@iro.umontreal.ca \
    /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/emacs.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).