Re: newline-and-indent vs. electric-indent-mode

[Stefan Monnier]

>>> Many (almost all?) modes bind RET to newline-and-indent,
>> Any mode which does that should be fixed.
> Ouch... I see now that my "observation" was plain wrong.

Yes and now: historically, it's been quite common for major modes to do
that kind of thing.  I've been fighting it for many years now (even
long before `electric-indent-mode`) since it's usually the reflection of
the major mode's author's preference, rather than something directly
linked to the major mode (there are several other examples of this
behavior: setting `comment-column` in the major mode is another similar
example).

>> Whether RET indents or not is a user preference, not something that
>> should depend on the kind of language you're editing.
> For most programming and markup languages indenting makes sense, but
> less so for other modes.

Concrete examples would be helpful and could be reported as bugs (I have
made efforts to setup `electric-indent-mode` such that it tries not to
get in the way in "plain text" modes, but of course that's no guarantee
that it catches all relevant cases).

> I guess it wouldn't hurt to add a sentence to the docstring of
> electric-indent-mode how it should be managed for a single buffer.  The
> method with an extra variable (electric-indent-inhibit, works only to
> disable a globally enabled mode) or an extra mode
> (electric-indent-local-mode, works both ways) is somewhat nonstandard
> and the question seems to pop up occasionally on various platforms.

`electric-indent-inhibit` doesn't inhibit auto-indentation.  It inhibits
auto-*re*indentation.

I know it takes many people by surprise (because the choices are more
refined than just "on or off" and they don't expect that), but I find it
hard to improve the docs to guide the users/programmers.

>> It sounds like a bug indeed.  I think both having two calls (one for
>> each line) or having one call (for the new line) could arguably be
>> correct, but three calls is indeed an error.
> So... I guess newline-and-indent could suppress the call to
> indent-line-function for the new line if electric-indent-mode is t and
> electric-indent-inhibit is nil and ?\n is in electric-indent-chars?

That would be one way, tho I find it fairly ugly.  Another might be to
temporarily disable `electric-indent-mode`.  The more I think about it,
the more I think this is the better choice.

> Just for the record: The results are correct, and the delay isn't
> noticeable even with the convoluted indenting routines of CPerl mode.

Usually indentation of a single line is very quick so doing twice is
indeed lost in the noise.  Of course, there are corner cases where
indentation can take a non-negligible amount of time, in which case
doubling it can be noticed (but still isn't a main worry: even if it
increases the runtime from 30s to 1min it's not that significant since
30s is really not all that much better than 1min).

Still counts as a performance bug to me.

> It is just a bit annoying when you are tracing through the routines
> trying to figure out where to fix a bug.

I suspect that there are cases where it really does introduce bugs
beyond a (minor) performance impact, e.g. in some of the major modes
where repeated TABs cycle between different indentation points.

In any case, I pushed a change to `master` to disable
`electric-indent-mode` in `newline-and-indent`, so this should hopefully
be fixed now.

> In CPerl mode, the remaining issue is actually the other way around.
> You can activate cperl-electric-linefeed via customize to do
> newline-and-indent.

More or less.  `cperl-mode` intends to offer basically 3 different
options: plain newline, newline+indent, and newline+indent+fancystuff.
And these are bound be default resp. to RET, LFD, and C-c LFD.
Then `cperl-electric-linefeed` lets you swap the last two.  Of course,
with `electric-indent-mode` RET ends up doing (more or less) what
LFD does.

IMO keybindings is more harmful than anything here, so a better choice
would be to offer only plain newline and newline+indent+fancystuff, bind
them to RET and LFD, let `electric-indent-mode` control which of RET and
LFD does which, and let `cperl-electric-linefeed` control whether
fancystuff is done at all.


        Stefan