Re: [ jEdit-devel ] EditBus messages, folding, and perspectives

[Alan E. <ala...@gm...>]

On 6/27/07, Shlomy Reinstein <sre...@gm...> wrote:
> Hi,
>
> There are some jEdit issues I'd like to raise, which I happened to
> encountered while working with SideKick.
>

> 2. EditBus messages: I think the documentation of these messages is a bit
> lacking (in the jEdit reference manual). The meaning of some of these
> messages is quite vague in the documentation, so, for example, I can't
> figure out which messages I should respond to for handling the event of a
> buffer switch. Because of this, I need to either examine the jEdit source
> code in order to find which messages are sent when the event I'm interested
> in takes place, or alternatively make the event happen and monitor the
> activity log for EditBus messages. SideKick currently has a bug, that it
> sometimes cannot determine the mode of the current buffer, so it doesn't
> know which parser to invoke (in which case it logs an approriate message).
> By monitoring the activity log, I found out that SideKick does not always
> respond to the right messages, so I can fix it now, but I think this
> situation can be greatly improved by making the reference documentation more
> elaborate, or, even better, add a section to the plugin development guide
> that describes the messages that are sent in various scenarios ( e.g. which
> messages are sent when the user opens a buffer, which messages are sent when
> the user modifies a buffer, etc).

The way I discover what an EditBus message does is by checking the API docs.

http://www.jedit.org/api/org/gjt/sp/jedit/EBMessage.html

The EBMessage has a number of derived classes, and you can see them
all from the API docs under "Direct Known Subclasses". Then you can
click on one and see its docs and when it is being used. If there are
any API docs that are not clear, I'd be happy to update them.

If we were to create another document that explained what EBMessages
were and when they were thrown, I'd think it should be partially
generated from what is in the API docs.