all messages for Emacs-related lists mirrored at yhetil.org
 help / color / mirror / code / Atom feed
From: Eli Zaretskii <eliz@gnu.org>
To: Ihor Radchenko <yantar92@posteo.net>
Cc: emacs-devel@gnu.org
Subject: Re: How to run indent command in arbitrary buffer while respecting user settings?
Date: Fri, 30 Jun 2023 08:50:12 +0300	[thread overview]
Message-ID: <833529ts6j.fsf@gnu.org> (raw)
In-Reply-To: <87352avys3.fsf@localhost> (message from Ihor Radchenko on Thu, 29 Jun 2023 19:44:44 +0000)

> From: Ihor Radchenko <yantar92@posteo.net>
> Date: Thu, 29 Jun 2023 19:44:44 +0000
> 
> In Org mode, we sometimes have a need to use third-party major mode to
> do indentation:
> 
> #+begin_src emacs-lisp
> (when t
> 'indent-me)
> #+end_src
> 
> To do this, we currently create a major mode buffer containing the code
> and run whatever is bound to <TAB> there.
> 
> This, however, is broken when user re-binds <TAB> to something else.
> Or when something like evil-mode re-binds <TAB>
> (https://github.com/emacs-evil/evil/issues/1806)
> 
> I am now considering running
> (funcall-interactively #'indent-for-tab-command)
> 
> However, looking at 25 Indentation section of Elisp manual:
> 
>        The simplest way to perform indentation is the <TAB> key.  In most
>     major modes, this runs the command ‘indent-for-tab-command’.  (In C and
>     related modes, <TAB> runs the command ‘c-indent-line-or-region’, which
>     behaves similarly, *note C Indent::).
> 
> I noticed that C and related modes have some alternative setting for
> indentation. So, using `indent-for-tab-command' appear to be not as
> reliable, after all.
> 
> Is there any reliable way to perform indentation in an arbitrary major
> mode programmatically?
> 
> I notice that cc-mode.el has a comment that the current <TAB> re-binding
> is at least debatable:
> 
>   (substitute-key-definition 'indent-for-tab-command
> 			     ;; XXX Is this the right thing to do
> 			     ;; here?
> 			     'c-indent-line-or-region
> 			     c-mode-base-map global-map)
> 
> So, should I simply ignore what cc-mode does and go ahead relying upon
> `indent-for-tab-command' doing the right thing?

There are other, better alternatives: you could either call
indent-according-to-mode or (funcall indent-line-function) instead.
Yet another alternative is to use indent-region-function.



      parent reply	other threads:[~2023-06-30  5:50 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-06-29 19:44 How to run indent command in arbitrary buffer while respecting user settings? Ihor Radchenko
2023-06-30  5:01 ` Tassilo Horn
2023-06-30 11:51   ` Ihor Radchenko
2023-06-30  5:50 ` Eli Zaretskii [this message]

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

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

  git send-email \
    --in-reply-to=833529ts6j.fsf@gnu.org \
    --to=eliz@gnu.org \
    --cc=emacs-devel@gnu.org \
    --cc=yantar92@posteo.net \
    /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 external index

	https://git.savannah.gnu.org/cgit/emacs.git
	https://git.savannah.gnu.org/cgit/emacs/org-mode.git

This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.