mirror of
https://github.com/fish-shell/fish-shell
synced 2024-12-30 22:58:46 +00:00
139 lines
3.3 KiB
C
139 lines
3.3 KiB
C
/** \file event.h
|
|
|
|
Functions for handling event triggers
|
|
|
|
*/
|
|
#ifndef FISH_EVENT_H
|
|
#define FISH_EVENT_H
|
|
|
|
|
|
/**
|
|
The signal number that is used to match any signal
|
|
*/
|
|
#define EVENT_ANY_SIGNAL -1
|
|
|
|
/**
|
|
The process id that is used to match any process id
|
|
*/
|
|
#define EVENT_ANY_PID 0
|
|
|
|
/**
|
|
Enumeration of event types
|
|
*/
|
|
enum
|
|
{
|
|
EVENT_ANY, /**< Matches any event type (Not always any event, as the function name may limit the choice as well */
|
|
EVENT_SIGNAL, /**< An event triggered by a signal */
|
|
EVENT_VARIABLE, /**< An event triggered by a variable update */
|
|
EVENT_EXIT, /**< An event triggered by a job or process exit */
|
|
EVENT_JOB_ID, /**< An event triggered by a job exit */
|
|
}
|
|
;
|
|
|
|
/**
|
|
The structure which represents an event. The event_t struct has
|
|
several event-related use-cases:
|
|
|
|
- When used as a parameter to event_add, it represents a class of events, and function_name is the name of the function which will be called whenever an event matching the specified class occurs. This is also how events are stored internally.
|
|
- When used as a parameter to event_get, event_remove and event_fire, it represents a class of events, and if the function_name field is non-zero, only events which call the specified function will be returned.
|
|
*/
|
|
typedef struct
|
|
{
|
|
/**
|
|
Type of event
|
|
*/
|
|
int type;
|
|
|
|
/**
|
|
The type-specific parameter
|
|
*/
|
|
union
|
|
{
|
|
/**
|
|
Signal number for signal-type events.Use EVENT_ANY_SIGNAL
|
|
to match any signal
|
|
*/
|
|
int signal;
|
|
/**
|
|
Variable name for variable-type events.
|
|
*/
|
|
const wchar_t *variable;
|
|
/**
|
|
Process id for process-type events. Use EVENT_ANY_PID to
|
|
match any pid.
|
|
*/
|
|
pid_t pid;
|
|
/**
|
|
Job id for EVENT_JOB_ID type events
|
|
*/
|
|
int job_id;
|
|
|
|
} param1;
|
|
|
|
/**
|
|
The name of the event handler function
|
|
*/
|
|
const wchar_t *function_name;
|
|
|
|
/**
|
|
The argument list. Only used when sending a new event using
|
|
event_fire. In all other situations, the value of this variable
|
|
is ignored.
|
|
*/
|
|
array_list_t arguments;
|
|
}
|
|
event_t;
|
|
|
|
/**
|
|
Add an event handler
|
|
*/
|
|
void event_add_handler( event_t *event );
|
|
|
|
/**
|
|
Remove all events matching the specified criterion.
|
|
*/
|
|
void event_remove( event_t *event );
|
|
|
|
/**
|
|
Return all events which match the specified event class
|
|
|
|
\param criterion Is the class of events to return. If the criterion has a non-null function_name, only events which trigger the specified function will return.
|
|
\param out the list to add events to. May be 0, in which case no events will be added, but the result count will still be valid
|
|
|
|
\return the number of found matches
|
|
*/
|
|
int event_get( event_t *criterion, array_list_t *out );
|
|
|
|
/**
|
|
Fire the specified event. The function_name field of the event must
|
|
be set to 0. If the event is of type EVENT_SIGNAL, no the event is
|
|
queued, and will be dispatched the next time event_fire is
|
|
called. If event is a null-pointer, all pending events are
|
|
dispatched.
|
|
|
|
\param event the specific event whose handlers should fire
|
|
*/
|
|
void event_fire( event_t *event );
|
|
|
|
/**
|
|
Initialize the event-handling library
|
|
*/
|
|
void event_init();
|
|
|
|
/**
|
|
Destroy the event-handling library
|
|
*/
|
|
void event_destroy();
|
|
|
|
/**
|
|
Free all memory used by event
|
|
*/
|
|
void event_free( event_t *e );
|
|
|
|
/**
|
|
Returns a string describing the specified event. The string should
|
|
not be freed.
|
|
*/
|
|
const wchar_t *event_get_desc( event_t *e );
|
|
|
|
#endif
|