Skip to content

Add onAnyEvent callback #3244

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
dmaluka merged 1 commit into from
May 14, 2024
Merged

Add onAnyEvent callback #3244

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 15 additions & 12 deletions cmd/micro/micro.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -450,10 +450,6 @@ func DoEvent() {
os.Exit(0)
}

if event == nil {
return
}

if e, ok := event.(*tcell.EventError); ok {
log.Println("tcell event error: ", e.Error())

Expand All @@ -473,13 +469,20 @@ func DoEvent() {
return
}

_, resize := event.(*tcell.EventResize)
if resize {
action.InfoBar.HandleEvent(event)
action.Tabs.HandleEvent(event)
} else if action.InfoBar.HasPrompt {
action.InfoBar.HandleEvent(event)
} else {
action.Tabs.HandleEvent(event)
if event != nil {
_, resize := event.(*tcell.EventResize)
if resize {
action.InfoBar.HandleEvent(event)
action.Tabs.HandleEvent(event)
} else if action.InfoBar.HasPrompt {
action.InfoBar.HandleEvent(event)
} else {
action.Tabs.HandleEvent(event)
}
}

err := config.RunPluginFn("onAnyEvent")
if err != nil {
screen.TermMessage(err)
}
}
4 changes: 4 additions & 0 deletions runtime/help/plugins.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,10 @@ which micro defines:

* `preRune(bufpane, rune)`: runs before the composed rune will be inserted

* `onAnyEvent()`: runs when literally anything happens. It is useful for
detecting various changes of micro's state that cannot be detected
using other callbacks.
Comment on lines +75 to +77
Copy link
Member

@JoeKar JoeKar Apr 23, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe it's worth mentioning, that the indication takes place before the update of the display is done.
Hopefully this doesn't lead to redraw-loops in the moment someone reacts to such an event, triggering an action, which then creates the next event and so on. 🤔

Copy link
Collaborator Author

@dmaluka dmaluka Apr 23, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It is the same situation as with other callbacks, right?

Copy link
Member

@JoeKar JoeKar Apr 24, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In case of drawing...yes, I think so. Then it's common sense...
In case of possible cb-event-ping-pong the possible frequency could be higher, but it's up to the plugin (developer) to not shoot his self.

Copy link
Collaborator Author

@dmaluka dmaluka Apr 26, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Generally, this should never happen, assuming that any events received by DoEvent() can be only triggered by other goroutines (and thus cannot be triggered by lua callbacks, since they run in the main goroutine).

I've briefly looked through the code to check if this is actually true... Looks like there actually is a couple of cases when the main goroutine may send an event to itself:

  1. UpdateDiff() calls its callback which sends a redraw event regardless of its synchronous param value, e.g. even if this callback is running in the main goroutine.
  2. Terminal.Close() (which is called from the main goroutine e.g. when the user closes a termpane via Ctrl-q + Ctrl-q) may send a job event to the shell.Jobs channel.

The 1st case probably only causes unneeded redraws. Even if the drawChan gets overfull with those extra redraw events, it will not cause a deadlock, since screen.Redraw() doesn't block but simply drops events in such case.

But the 2nd case, it seems, may cause a deadlock (very unlikely to happen in practice though), if the main goroutine is closing many termpanes (100+ termpanes) fast enough, causing the shell.Jobs channel overfull and thus blocking forever.

Both these cases seem to be worth fixing (especially the 2nd one), even though they are rather minor, - just to feel safe and clean, by guaranteeing no ping-pong ever, no deadlocks ever, no redundant events.


For example a function which is run every time the user saves the buffer
would be:

Expand Down