all messages for Emacs-related lists mirrored at yhetil.org
 help / color / mirror / code / Atom feed
From: "Pascal J. Bourguignon" <pjb@informatimago.com>
To: help-gnu-emacs@gnu.org
Subject: Re: How to write the "interactive" form for a command acting on a region
Date: Tue, 13 Jan 2015 23:38:48 +0100	[thread overview]
Message-ID: <87twzuwbk7.fsf@kuiper.lan.informatimago.com> (raw)
In-Reply-To: mailman.17860.1421186716.1147.help-gnu-emacs@gnu.org

Marcin Borkowski <mbork@wmi.amu.edu.pl> writes:

> Hi all,
>
> so I want to have a function which should do something on the region.
> If no region is active, I want it to act on the whole buffer.  If called
> from Lisp code, I want to be able to supply "begin" and/or "end"
> parameters, which (if nil) should default to (point-min) and
> (point-max).  Finally, I want my command to behave differently depending
> on whether it was called interactively or programmatically.  


If you want a different behavior, then you should have different
functions:

    (defun my-FUNCTION (…)
       …)

    (defun my-COMMAND (…)
       (interactive …)
       …
       (my-function …)
       …)

(defun my-command (start end)
   (interactive "r")
   (message "start=%s end=%s" start end))


A region is always defined, whether transient-mark-mode is on or off,
and whether the region is active or not.

Therefore interactive "r" will always give you start and end points.
You could have a command such as:

    (defun my-command (start end)
       (interactive "r")
       (if (use-region-p) ; region is active
          (my-function start end)
          (my-function (point-min) (point-max))))


Otherwise, if the behavior of your command and your function was the
same, you could write a single command, using (require 'cl) to deal with
the default values.  

But since you want to force the arguments when it's called interactively
without an active region, you will have to duplicate some code.
Separating the function and command is probablyh preferable in your
situation.

    (require 'cl)
    (defun* my-command (&optional (start (point-min)) (end (point-max)))
       (interactive "r")
       (when (and (called-interactively-p)
                  (not (use-region-p)))
          (setf start (point-min)
                end   (point-max)))
       …)


-- 
__Pascal Bourguignon__                 http://www.informatimago.com/
“The factory of the future will have only two employees, a man and a
dog. The man will be there to feed the dog. The dog will be there to
keep the man from touching the equipment.” -- Carl Bass CEO Autodesk


       reply	other threads:[~2015-01-13 22:38 UTC|newest]

Thread overview: 7+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
     [not found] <mailman.17860.1421186716.1147.help-gnu-emacs@gnu.org>
2015-01-13 22:38 ` Pascal J. Bourguignon [this message]
2015-01-13 23:06   ` How to write the "interactive" form for a command acting on a region Marcin Borkowski
     [not found]   ` <mailman.17861.1421190402.1147.help-gnu-emacs@gnu.org>
2015-01-14  2:04     ` Pascal J. Bourguignon
2015-01-14  3:49       ` Drew Adams
2015-01-13 22:05 Marcin Borkowski
2015-01-13 23:24 ` Nicolas Richard
2015-01-13 23:35   ` Marcin Borkowski

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=87twzuwbk7.fsf@kuiper.lan.informatimago.com \
    --to=pjb@informatimago.com \
    --cc=help-gnu-emacs@gnu.org \
    /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.