List of major modes?

List of major modes?

[David Reitter]

How would I go about compiling a list of all major modes available in  
the current emacs session?
(Both loaded ones and autoloadable ones.)

My first thought was doing something like

  (apropos-internal ".*-mode$")

which works, but doesn't distinguish between major and minor modes,  
which would be important.

I cannot actually run any of the mode functions (would take way too  
long).

 From looking at the elisp level code, there is very little  
programmatic distinction between minor and major modes, at least  
nothing that could be easily detected.

thanks...

Re: List of major modes?

[rgb]

>  From looking at the elisp level code, there is very little
> programmatic distinction between minor and major modes

(kill-all-local-variables)

Should be part of major modes but not minor ones.
Derived modes won't contain a kill-all statement.

Re: List of major modes?

[Edward O'Connor]

David Reitter wrote:

> How would I go about compiling a list of all major modes available in
> the current emacs session?

>From my .emacs; originally from Kevin Rodgers:

(defun kr-major-mode-p (symbol)
  "Return non-nil if SYMBOL is a major mode.
Used in `interactive' forms to read major mode names from the user."
  (and (fboundp symbol)
       (let ((function-name (symbol-name symbol)))
         (and (string-match "-mode\\'" function-name)
              (not (string-match "\\`turn-\\(on\\|off\\)-"
                                 function-name))))
       (not (assq symbol minor-mode-alist))))

You could use this together with `mapatoms' to find all major modes.


Ted

-- 
Edward O'Connor
hober0@gmail.com

Ense petit placidam sub libertate quietem.

Re: List of major modes?

[Kevin Rodgers]

David Reitter wrote:
 > How would I go about compiling a list of all major modes available in
 > the current emacs session?
 > (Both loaded ones and autoloadable ones.)
 >
 > My first thought was doing something like
 >
 >  (apropos-internal ".*-mode$")
 >
 > which works, but doesn't distinguish between major and minor modes,
 > which would be important.
 >
 > I cannot actually run any of the mode functions (would take way too 
long).
 >
 >  From looking at the elisp level code, there is very little
 > programmatic distinction between minor and major modes, at least
 > nothing that could be easily detected.

Here's the best I could come up with:

(apropos-internal "-mode\\'"
                   (lambda (mode)
                     (and (commandp mode)
                          (string-match "\\`Major mode\\>"
                                        (documentation mode)))))

-- 
Kevin Rodgers

Re: List of major modes?

[rgb]

> Here's the best I could come up with:
>
> (apropos-internal "-mode\\'"
>                    (lambda (mode)
>                      (and (commandp mode)
>                           (string-match "\\`Major mode\\>"
>                                         (documentation mode)))))

Slick.
It needed a slight tweek on my machine running CVS Emacs.
(documentation mode) would sometimes return nil and blow up
string-match.  tooltip-mode was one that returned nil.  I don't
understand why though.  It does seem to be documented.... hmm.

(apropos-internal "-mode\\'"
                   (lambda (mode)
                     (and (commandp mode) (message "%s" mode)
                          (string-match "\\`Major mode\\>"
                                        (concat "" (documentation
mode))))))

Re: List of major modes?

[Lennart Borgman]

rgb wrote:

>>Here's the best I could come up with:
>>
>>(apropos-internal "-mode\\'"
>>                   (lambda (mode)
>>                     (and (commandp mode)
>>                          (string-match "\\`Major mode\\>"
>>                                        (documentation mode)))))
>>    
>>
>
>Slick.
>It needed a slight tweek on my machine running CVS Emacs.
>(documentation mode) would sometimes return nil and blow up
>string-match.  tooltip-mode was one that returned nil.  I don't
>understand why though.  It does seem to be documented.... hmm.
>  
>
C-h f tooltip-mode RET gives a default help string. This actually says 
that tooltip-mode is not documented.

Re: List of major modes?

[rgb]

> C-h f tooltip-mode RET gives a default help string. This actually says
> that tooltip-mode is not documented.

I was hoping you were right but C-h f tooltip-mode gives me this:

tooltip-mode is an interactive compiled Lisp function in `tooltip.el'.
It is bound to <menu-bar> <options> <showhide> <showhide-tooltip-mode>.
(tooltip-mode &optional arg)

Not documented.

[back]

Popping into tooltip.el shows this:

(define-minor-mode tooltip-mode
  "Toggle Tooltip display.
With ARG, turn tooltip mode on if and only if ARG is positive."
  :global t
...

The reason for the help string not showing up makes me doubt
the reliability of the results returned by Kevin's routine.

Re: List of major modes?

[David Reitter]

>        (not (assq symbol minor-mode-alist))))

Good idea, but unfortunately minor-mode-alist contains stuff to be  
shown in the mode-line, so we're not excluding minor modes that don't  
display anything in the mode line (mouse-wheel-mode for example).

Searching the documentation string (Kevin's idea) won't be reliable,  
obviously.

Looking for (kill-all-local-variables) in the definition would be  
another possibility, but who guarantees that this will occur in the  
mode function definition directly, and not in some function called  
from there.

The only solution I can see is to patch define-minor-mode - as a last  
resort.

- D

Re: List of major modes?

[Henrik Enberg]

> From: David Reitter <david.reitter@gmail.com>
> Date: Fri, 11 Nov 2005 17:56:14 +0000
> 
> >        (not (assq symbol minor-mode-alist))))
> 
> Good idea, but unfortunately minor-mode-alist contains stuff to be  
> shown in the mode-line, so we're not excluding minor modes that don't  
> display anything in the mode line (mouse-wheel-mode for example).

[...]

> The only solution I can see is to patch define-minor-mode - as a last  
> resort.

Not all minor-modes use define-minor-mode.  One way or another, some
stuff will slip through.

RE: List of major modes?

[Drew Adams]

    > unfortunately minor-mode-alist contains stuff to be
    > shown in the mode-line, so we're not excluding minor modes
    > that don't display anything in the mode line

    > The only solution I can see is to patch define-minor-mode -
    > as a last resort.

    Not all minor-modes use define-minor-mode.  One way or another, some
    stuff will slip through.

I agree - some stuff will slip through. I don't think you'll find a 100%
solution for excluding minor modes. There is too much overlap between the
conventions of defining major and minor modes, and too many ways to define
each.

Recent Emacs versions have `minor-mode-list' (not alist), a list of all
minor mode functions. There is no guarantee that it will be complete,
however. It is fed by `add-minor-mode'.

Re: List of major modes?

[Lennart Borgman]

Drew Adams wrote:

>Recent Emacs versions have `minor-mode-list' (not alist), a list of all
>minor mode functions. There is no guarantee that it will be complete,
>however. It is fed by `add-minor-mode'.
>  
>
Would it not be best to make something similar for major modes? There 
are some requirements for what major modes should do and why not add a 
new requirement? It will not be very difficult to add it and many users 
would surely like it.

Re: List of major modes?

[David Reitter]

On 11 Nov 2005, at 19:12, Lennart Borgman wrote:

> Drew Adams wrote:
>
>> Recent Emacs versions have `minor-mode-list' (not alist), a list  
>> of all
>> minor mode functions. There is no guarantee that it will be complete,
>> however. It is fed by `add-minor-mode'.
>>
> Would it not be best to make something similar for major modes?  
> There are some requirements for what major modes should do and why  
> not add a new requirement? It will not be very difficult to add it  
> and many users would surely like it.

Changing the conventions for major modes wouldn't work that well,  
since that would basically create an incompatibility.

The following dynamic definition seems to "sort of" work.

(defun major-modes ()
  (apropos-internal "-mode\\'"
    (lambda (mode)
      (and (commandp mode)
	  (not (string-match "\\`turn-\\(on\\|off\\)-"
	  		     (symbol-name mode)))
   	  (not (assq mode minor-mode-list))))))


I don't know, however, whether minor-mode-list is complete, i.e.  
whether it contains the not-yet-auto-loaded minor modes. From what I  
see in easy-mmode.el, it doesn't look like it. 

Re: List of major modes?

[Lennart Borgman]

David Reitter wrote:

> The following dynamic definition seems to "sort of" work.
>
> (defun major-modes ()
>  (apropos-internal "-mode\\'"
>    (lambda (mode)
>      (and (commandp mode)
>       (not (string-match "\\`turn-\\(on\\|off\\)-"
>                    (symbol-name mode)))
>         (not (assq mode minor-mode-list))))))
>
>
> I don't know, however, whether minor-mode-list is complete, i.e.  
> whether it contains the not-yet-auto-loaded minor modes. From what I  
> see in easy-mmode.el, it doesn't look like it.


Maybe I should change my mind. It looks good. If you marry this with the 
code in describe-mode you can perhaps populate minor-mode-list first 
with all minor modes. At least it seems so in that code. (Older minor 
modes seems to be in minor-mode-alist.)

Re: List of major modes?

[Kevin Rodgers]

David Reitter wrote:
 > The following dynamic definition seems to "sort of" work.
 >
 > (defun major-modes ()
 >  (apropos-internal "-mode\\'"
 >    (lambda (mode)
 >      (and (commandp mode)
 >       (not (string-match "\\`turn-\\(on\\|off\\)-"
 >                    (symbol-name mode)))
 >         (not (assq mode minor-mode-list))))))
 >
 >
 > I don't know, however, whether minor-mode-list is complete, i.e.
 > whether it contains the not-yet-auto-loaded minor modes. From what I
 > see in easy-mmode.el, it doesn't look like it.

I still think it would be better to include functions that follow the
major mode conventions than to exclude functions that don't follow the
minor mode conventions.  The Emacs Lisp manual has nodes describing both
sets of conventions.

For example:

    * The major mode should usually have its own keymap, which is used
      as the local keymap in all buffers in that mode.  The major mode
      command should call `use-local-map' to install this local map.
      *Note Active Keymaps::, for more information.

      This keymap should be stored permanently in a global variable named
      `MODENAME-mode-map'.  Normally the library that defines the mode
      sets this variable.

So you could check (keymapp (intern-soft (concat mode "-map"))) in the
apropos-internal PREDICATE.

-- 
Kevin Rodgers

Re: List of major modes?

[Lennart Borgman]

Kevin Rodgers wrote:

>
> For example:
>
>    * The major mode should usually have its own keymap, which is used
>      as the local keymap in all buffers in that mode.  The major mode
>      command should call `use-local-map' to install this local map.
>      *Note Active Keymaps::, for more information.
>
>      This keymap should be stored permanently in a global variable named
>      `MODENAME-mode-map'.  Normally the library that defines the mode
>      sets this variable.
>
> So you could check (keymapp (intern-soft (concat mode "-map"))) in the
> apropos-internal PREDICATE.
>
What about autoloading?

Re: List of major modes?

[Stefan Monnier]

>> * The major mode should usually have its own keymap, which is used
>> as the local keymap in all buffers in that mode.  The major mode
>> command should call `use-local-map' to install this local map.
>> *Note Active Keymaps::, for more information.
>> 
>> This keymap should be stored permanently in a global variable named
>> `MODENAME-mode-map'.  Normally the library that defines the mode
>> sets this variable.
>> 
>> So you could check (keymapp (intern-soft (concat mode "-map"))) in the
>> apropos-internal PREDICATE.
>> 
> What about autoloading?

Indeed, it's very difficult to tell the difference between an autoloaded
major mode and some other autoloaded function whose name ends in `-mode'.

If the autoload is complete (i.e. generated by a recent autoload.el), then
it'll include the arg list, in which case we can check whether the arglist
is empty (as the convention says).

This said, I'm still not sure why you'd want a list of major modes.


        Stefan

Re: List of major modes?

[Richard M. Stallman]

It is not correct to assume that every major mode has a keymap named
after it.  However, major mode commands take no arguments, whereas
every minor mode command takes an argument.  There may be one or two
exceptions, major mode commands that take arguments, but it would be
easy to put them on a list of exceptions.

Re: List of major modes?

[Alan Mackenzie]

On Mon, 14 Nov 2005, Kevin Rodgers wrote:

>David Reitter wrote:
> > The following dynamic definition seems to "sort of" work.

> > (defun major-modes ()
> >  (apropos-internal "-mode\\'"
> >    (lambda (mode)
> >      (and (commandp mode)
> >       (not (string-match "\\`turn-\\(on\\|off\\)-"
> >                    (symbol-name mode)))
> >         (not (assq mode minor-mode-list))))))


> > I don't know, however, whether minor-mode-list is complete, i.e.
> > whether it contains the not-yet-auto-loaded minor modes. From what I
> > see in easy-mmode.el, it doesn't look like it.

>I still think it would be better to include functions that follow the
>major mode conventions than to exclude functions that don't follow the
>minor mode conventions.  The Emacs Lisp manual has nodes describing both
>sets of conventions.

It is impossible to create a list of major modes, because a major mode is
simply a lisp function, with nothing definitive to distinguish it from
any other lisp function.

So how about having a property `emacs-mode' on symbols, with valid values
(major minor major-minor nil)?  Getting a list of major modes would then
be trivial.  (OK, for Emacs 23. ;-)

>-- 
>Kevin Rodgers

-- 
Alan Mackenzie (Munich, Germany)

Re: List of major modes?

[Lennart Borgman]

Richard M. Stallman wrote:

>It is not correct to assume that every major mode has a keymap named
>after it.  However, major mode commands take no arguments, whereas
>every minor mode command takes an argument.  There may be one or two
>exceptions, major mode commands that take arguments, but it would be
>easy to put them on a list of exceptions.
>  
>
But is information about arguments available for autoloaded functions 
that has not been loaded yet?

Re: List of major modes?

[Kevin Rodgers]

Alan Mackenzie wrote:
 > On Mon, 14 Nov 2005, Kevin Rodgers wrote:
 > > I still think it would be better to include functions that follow the
 > > major mode conventions than to exclude functions that don't follow the
 > > minor mode conventions.  The Emacs Lisp manual has nodes describing 
both
 > > sets of conventions.
 >
 > It is impossible to create a list of major modes, because a major mode is
 > simply a lisp function, with nothing definitive to distinguish it from
 > any other lisp function.

Yes.  We have been discussing heuristics that could be used in the
absence of a definitive test.

 > So how about having a property `emacs-mode' on symbols, with valid values
 > (major minor major-minor nil)?  Getting a list of major modes would then
 > be trivial.  (OK, for Emacs 23. ;-)

Did you mean (major minor global-minor nil)?

-- 
Kevin Rodgers

Re: List of major modes?

[Stefan Monnier]

> But is information about arguments available for autoloaded functions that
> has not been loaded yet?

Sometimes, yes.  See all the "(fn ...)" at the end of doctrings in
loaddefs.el.


        Stefan

Re: List of major modes?

[Richard M. Stallman]

    So how about having a property `emacs-mode' on symbols, with valid values
    (major minor major-minor nil)?  Getting a list of major modes would then
    be trivial.  (OK, for Emacs 23. ;-)

That is straightforward, but it would be substantial trouble.
Is it worth the trouble?

What benefit would it provide?  What was the reason for asking
for this?

Re: List of major modes?

[Richard M. Stallman]

    But is information about arguments available for autoloaded functions 
    that has not been loaded yet?

No, it isn't.  So my proposal won't work.

Thanks.

Re: List of major modes?

[David Reitter]

On 15 Nov 2005, at 10:22, Alan Mackenzie wrote:

> So how about having a property `emacs-mode' on symbols, with valid  
> values
> (major minor major-minor nil)?  Getting a list of major modes would  
> then
> be trivial.  (OK, for Emacs 23. ;-)

How do you make third-party packages compatible without forcing them  
to update their modes?

Richard Stallman wrote:

> That is straightforward, but it would be substantial trouble.
> Is it worth the trouble?
>
> What benefit would it provide?  What was the reason for asking
> for this?

This thread started a while ago when I was asking for a function that  
would give me a list of major mode. What I wanted to write has a  
"switch-to-major-mode" function which would offer - via a completions  
list - a good overview of what modes are available. I think that  
would benefit new users who would be able to explore Emacs that way.

It was found that there was no clean and reliable way to find all  
installed major modes.

Honestly, I don't think implementing a complex mechanism is worth the  
trouble for Emacs 22 at this point. Existing modes wouldn't be  
compatible anyways. The above "newbie function" is probably not that  
important right now.

What might make sense is to add the above property  as a  
recommendation to the mode conventions, pointing out that this will  
be a requirement for Emacs 23 modes.

Re: List of major modes?

[Richard M. Stallman]

    This thread started a while ago when I was asking for a function that  
    would give me a list of major mode. What I wanted to write has a  
    "switch-to-major-mode" function which would offer - via a completions  
    list - a good overview of what modes are available. I think that  
    would benefit new users who would be able to explore Emacs that way.

It doesn't seem terribly important.  I think that anyone who wants to
explore this way will want to look at the modes' doc strings anyway,
and those will show which ones are major modes.  You can do this just
fine with C-h a mode$, so a new feature would provide little benefit.

    What might make sense is to add the above property  as a  
    recommendation to the mode conventions, pointing out that this will  
    be a requirement for Emacs 23 modes.

That would be a lot of work for a lot of people.  My decision is to do
nothing about this.

Re: List of major modes?

[Lennart Borgman]

Richard M. Stallman wrote:

>It doesn't seem terribly important.  I think that anyone who wants to
>explore this way will want to look at the modes' doc strings anyway,
>and those will show which ones are major modes.  You can do this just
>fine with C-h a mode$, so a new feature would provide little benefit.
>
The functionality to show the doc strings from the *Apropos* buffer is 
very good. Should it not be more visible and easy to use for beginners? 
Would it not be easier for them (and many others too) if the the links 
looked the same way as those in the *info* buffer? I believe it would 
help in a case like that we are discussing here.

BTW I would prefer that the links in the *Help* buffer also looked the same.

Re: List of major modes?

[Juri Linkov]

> The functionality to show the doc strings from the *Apropos* buffer is
> very good. Should it not be more visible and easy to use for beginners?
> Would it not be easier for them (and many others too) if the the link
> looked the same way as those in the *info* buffer? I believe it would
> help in a case like that we are discussing here.
>
> BTW I would prefer that the links in the *Help* buffer also looked the same.

Links highlighted in blue stand out more than underlined argument names.
But using a foreground color for argument names might help avoid this problem.
IMO, the following colors for the Help buffer looks good:

  (set-face-foreground 'button "blue")
  (set-face-attribute 'help-argument-name nil
                      :inherit '(font-lock-constant-face italic))

-- 
Juri Linkov
http://www.jurta.org/emacs/

Re: List of major modes?

[Richard M. Stallman]

Please let's not discuss changes in faces for apropos now.
This is not a bug fix, and not a new feature, and not terribly
important.

How about instead debugging one of the recent bug reports?