Re: Should prefix variable be used in function argument list

[Philip Kaludercic]

carlmarcos--- via Users list for the GNU Emacs text editor
<help-gnu-emacs@gnu.org> writes:

> When one wants to use the prefix argument when calling an interactive
> function, should one include a prefix variable in the function
> argument list? 

No, I don't think there is any general rule here.  Some functions are
meant for interactive use only so they don't pass the prefix argument
through the argument list, while functions that are both meant to be
used interactively and by other functions do so to expose the
functionality to both callers. 

> Furthermore, should the prefix argument be defined as optional?  How
> would one call the function non-interactively for such function?  Is
> it always necessary to have the prefix argument as the first argument
> in the function argument list?

Again, most of this depends on the individual case and often is a matter
of individual taste.  You get to design the interactive specification
yourself, so you get to decide what happens.

An option you didn't mention but what I occasionally make use of is to
only use `current-prefix-arg' in an interactive specification, instead
of the body.  E.g. think of something like this:

--8<---------------cut here---------------start------------->8---
(defun foo (option)
  (interactive
   (list (if current-prefix-arg
             (read-string "Option: ")
           "default")))
  (do-something-with option))
--8<---------------cut here---------------end--------------->8---