Re: Adding and running a major mode hook

[Eric Abrahamsen <eric@ericabrahamsen.net>]

Jacob Gerlach <jacobgerlach@gmail.com> writes:

>> If you've got the run-hooks inside the mode declaration, then the hooks
>> 
>> won't run until the user activates the mode in some particular buffer.
>> 
>> They will then run *every* time your mode is activated.
>> 
>> 
>> 
>> If you've got it at the top level of the file, the hooks will run once,
>> 
>> *while* the file is being loaded for the first time: ie quite likely
>> 
>> during emacs startup, possibly before the user's relevant customization
>> 
>> is loaded, probably before any relevant file are opened.
>
> Ahhh, this is the key piece of information that I was missing. I was
> confused by the fact that the mode declaration wasn't bothered by the
> fact that it came before the function definitions further on in the
> file.
>
>> >From what I can see from your examples above, it might be enough just to
>> 
>> have:
>> [...]
>> Then, *every time* the user activates this
>> 
>> mode, constructs are created out of whatever's in `content-list'.
>  
> The creation uses add-to-list, which checks for duplicates, so that
> won't be a problem necessarily, but it does seem like unnecessary
> overhead that I can get rid of. I will play with some conditionals to
> see what I can do about this.
>
>> Hope that didn't make it worse,
> On the contrary, much clearer now!
>
> To add a wrinkle to this, can someone explain how autoload changes this sequence? I tried to implement autoload by putting something like this in my file:
>
> (autoload 'my-mode "my-name" "My Editing Mode" t)
>
> I copied it from somewhere, but now that I read the documentation more carefully, I think I have two problems with this:
>
> First, "my-name" should actually be the filename: "mymode.el". Does
> this argument care about paths?

`autoload' uses `load', which searches for files in your 'load-path. If
the file you want to load isn't in your load-path, you can give an
absolute path, but that's probably a bad idea. You don't need the ".el"
suffix -- load will try with ".el", ".elc" and no suffix. (see
'load-suffixes)

> second, I put this line after the mode definition, but the help says:
>
> If FUNCTION is already defined other than as an autoload,
> this does nothing and returns nil.
>
> So I think it's doing nothing (and perhaps that's why it doesn't
> matter that I didn't include the file name as I should have). It also
> seems it would be much easier to make the mode autoloaded using a
> magic comment, which is how I'm fixing it.
>
> With regards to the order of code execution, how does autoloading the
> mode definition change what Eric already described? Users will still
> have(require 'my-mode) in their .emacs, which I think executes
> everything except the mode definition.
>
> Is it then redundant to put autoload on a function definition?

It's redundant to have an autoload for a function that is defined in the
same file, yes. autoloads should be put elsewhere, either in the user's
configuration or in other libraries that might theoretically depend on
your library.

Users will either use require, or autoload, but not both. Require means
"load it now" (ie the whole file is executed, probably at emacs
startup), and autoload means "load it the first time I try to use it",
which probably happens as a relevant file is being opened. Practically
speaking that's the only difference.

HTH,
Eric