unofficial mirror of emacs-devel@gnu.org 
 help / color / mirror / code / Atom feed
From: Stefan Monnier <monnier@iro.umontreal.ca>
To: "Paul W. Rankin" via "Emacs development discussions."
	<emacs-devel@gnu.org>
Cc: "Paul W. Rankin" <pwr@bydasein.com>
Subject: Re: declare function/macro private
Date: Sun, 06 Jun 2021 14:05:30 -0400	[thread overview]
Message-ID: <jwvwnr6swka.fsf-monnier+emacs@gnu.org> (raw)
In-Reply-To: <0278C47F-42CE-45C4-B789-83C57DF1A191@bydasein.com> (Paul W. Rankin's message of "Sun, 6 Jun 2021 14:27:58 +1000")

> Of course there's already the convention of prefix--my-private-function, but

What would be the difference between this convention and your proposed declaration?

> my thinking here is that a program could declare a function/macro as
> private, then the compiler could signal a warning/error if that function
> appeared in a library outside the library it was defined and
> declared private.

We don't have a definition for "library", sadly.

I think the "--" convention actually includes an extra information
compared to yours which could be useful here: we could warn for uses of
"foo--" if and only if the use appears in something whose name doesn't
start with "foo-".

IOW, use the string before the "--" as the definition of the "library"
(so that would support cases where a library is spread over several
files, as well as the case where a single file contains "internal
libraries").

Of course, if we enable such a warning now, we'll get a fairly large
number of warnings, I think ;-)

Another advantage of the "--" convention is that you don't need to load
the definition of that function in order to discover that it's private.


        Stefan




  parent reply	other threads:[~2021-06-06 18:05 UTC|newest]

Thread overview: 26+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-06-06  4:27 declare function/macro private Paul W. Rankin via Emacs development discussions.
2021-06-06  7:09 ` Omar Polo
2021-06-06  7:18   ` Paul W. Rankin via Emacs development discussions.
2021-06-06  9:53 ` Lars Ingebrigtsen
2021-06-06 12:43   ` Paul W. Rankin via Emacs development discussions.
2021-06-08  9:43     ` Lars Ingebrigtsen
2021-06-08 17:26       ` Robin Tarsiger
2021-06-06 18:05 ` Stefan Monnier [this message]
2021-06-06 18:12   ` Tassilo Horn
2021-06-06 20:12     ` Stefan Monnier
2021-06-07  0:51       ` Paul W. Rankin via Emacs development discussions.
2021-06-07  1:37         ` Arthur Miller
2021-06-07  1:43           ` Paul W. Rankin via Emacs development discussions.
2021-06-07 13:38             ` Arthur Miller
2021-06-07  0:59   ` Paul W. Rankin via Emacs development discussions.
2021-06-07  2:54     ` Stefan Monnier
2021-06-07 18:24       ` Arthur Miller
  -- strict thread matches above, loose matches on Subject: below --
2021-06-07  3:35 Boruch Baum
2021-06-07  4:49 ` Paul W. Rankin via Emacs development discussions.
2021-06-07  5:59   ` Stefan Monnier
2021-06-07  6:45     ` Paul W. Rankin via Emacs development discussions.
2021-06-07 12:39 ` Eli Zaretskii
2021-06-08  1:14   ` Boruch Baum
2021-06-08  4:20     ` Arthur Miller
2021-06-08  5:49       ` tomas
2021-06-08 15:46     ` Stefan Monnier

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=jwvwnr6swka.fsf-monnier+emacs@gnu.org \
    --to=monnier@iro.umontreal.ca \
    --cc=emacs-devel@gnu.org \
    --cc=pwr@bydasein.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/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).