NeoMutt  2022-04-29-178-g3b62e6
Teaching an old dog new tricks
DOXYGEN
notify.h File Reference

Notification API. More...

#include <stdbool.h>
#include "notify_type.h"
#include "observer.h"
+ Include dependency graph for notify.h:
+ This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions

struct Notifynotify_new (void)
 Create a new notifications handler. More...
 
void notify_free (struct Notify **ptr)
 Free a notification handler. More...
 
void notify_set_parent (struct Notify *notify, struct Notify *parent)
 Set the parent notification handler. More...
 
bool notify_send (struct Notify *notify, enum NotifyType event_type, int event_subtype, void *event_data)
 Send out a notification message. More...
 
bool notify_observer_add (struct Notify *notify, enum NotifyType type, observer_t callback, void *global_data)
 Add an observer to an object. More...
 
bool notify_observer_remove (struct Notify *notify, const observer_t callback, const void *global_data)
 Remove an observer from an object. More...
 
void notify_observer_remove_all (struct Notify *notify)
 Remove all the observers from an object. More...
 

Detailed Description

Notification API.

Authors
  • Richard Russon

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.

Definition in file notify.h.

Function Documentation

◆ notify_new()

struct Notify * notify_new ( void  )

Create a new notifications handler.

Return values
ptrNew notification handler

Definition at line 60 of file notify.c.

61{
62 struct Notify *notify = mutt_mem_calloc(1, sizeof(*notify));
63
64 STAILQ_INIT(&notify->observers);
65
66 return notify;
67}
void * mutt_mem_calloc(size_t nmemb, size_t size)
Allocate zeroed memory on the heap.
Definition: memory.c:50
#define STAILQ_INIT(head)
Definition: queue.h:372
Notification API.
Definition: notify.c:51
struct ObserverList observers
List of observers of this object.
Definition: notify.c:53
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ notify_free()

void notify_free ( struct Notify **  ptr)

Free a notification handler.

Parameters
ptrNotification handler to free

Definition at line 73 of file notify.c.

74{
75 if (!ptr || !*ptr)
76 return;
77
78 struct Notify *notify = *ptr;
79 // NOTIFY observers
80
82
83 FREE(ptr);
84}
#define FREE(x)
Definition: memory.h:43
void notify_observer_remove_all(struct Notify *notify)
Remove all the observers from an object.
Definition: notify.c:254
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ notify_set_parent()

void notify_set_parent ( struct Notify notify,
struct Notify parent 
)

Set the parent notification handler.

Parameters
notifyNotification handler to alter
parentParent notification handler

Notifications are passed up the tree of handlers.

Definition at line 93 of file notify.c.

94{
95 if (!notify)
96 return;
97
98 notify->parent = parent;
99}
struct Notify * parent
Parent of the notification object.
Definition: notify.c:52
+ Here is the caller graph for this function:

◆ notify_send()

bool notify_send ( struct Notify notify,
enum NotifyType  event_type,
int  event_subtype,
void *  event_data 
)

Send out a notification message.

Parameters
notifyNotification handler
event_typeType of event, e.g. NT_ACCOUNT
event_subtypeSubtype, e.g. NT_ACCOUNT_ADD
event_dataPrivate data associated with the event
Return values
trueSuccessfully sent

See send() for more details.

Definition at line 171 of file notify.c.

173{
174 mutt_debug(LL_NOTIFY, "sending: %s/%d\n", NotifyTypeNames[event_type], event_subtype);
175 return send(notify, notify, event_type, event_subtype, event_data);
176}
#define mutt_debug(LEVEL,...)
Definition: logging.h:84
@ LL_NOTIFY
Log of notifications.
Definition: logging.h:45
static bool send(struct Notify *source, struct Notify *current, enum NotifyType event_type, int event_subtype, void *event_data)
Send out a notification message.
Definition: notify.c:118
static char * NotifyTypeNames[]
Lookup table for NotifyType Must be the same size and order as NotifyType.
Definition: notify.c:39
+ Here is the call graph for this function:

◆ notify_observer_add()

bool notify_observer_add ( struct Notify notify,
enum NotifyType  type,
observer_t  callback,
void *  global_data 
)

Add an observer to an object.

Parameters
notifyNotification handler
typeNotification type to observe, e.g. NT_WINDOW
callbackFunction to call on a matching event, see observer_t
global_dataPrivate data associated with the observer
Return values
trueSuccessful

New observers are added to the front of the list, giving them higher priority than existing observers.

Definition at line 189 of file notify.c.

191{
192 if (!notify || !callback)
193 return false;
194
195 struct ObserverNode *np = NULL;
196 STAILQ_FOREACH(np, &notify->observers, entries)
197 {
198 if (!np->observer)
199 continue;
200
201 if ((np->observer->callback == callback) && (np->observer->global_data == global_data))
202 return true;
203 }
204
205 struct Observer *o = mutt_mem_calloc(1, sizeof(*o));
206 o->type = type;
207 o->callback = callback;
209
210 np = mutt_mem_calloc(1, sizeof(*np));
211 np->observer = o;
212 STAILQ_INSERT_HEAD(&notify->observers, np, entries);
213
214 return true;
215}
static void * global_data
Original opaque data in fallback implementation.
Definition: qsort_r.c:49
#define STAILQ_FOREACH(var, head, field)
Definition: queue.h:352
#define STAILQ_INSERT_HEAD(head, elm, field)
Definition: queue.h:383
List of Observers.
Definition: observer.h:71
struct Observer * observer
An Observer.
Definition: observer.h:72
An observer of notifications.
Definition: observer.h:61
observer_t callback
Callback function for events.
Definition: observer.h:63
void * global_data
Private data to pass to callback.
Definition: observer.h:64
enum NotifyType type
Notification type to observe, e.g. NT_WINDOW.
Definition: observer.h:62
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ notify_observer_remove()

bool notify_observer_remove ( struct Notify notify,
const observer_t  callback,
const void *  global_data 
)

Remove an observer from an object.

Parameters
notifyNotification handler
callbackFunction to call on a matching event, see observer_t
global_dataPrivate data to match specific callback
Return values
trueSuccessful
Note
This function frees the Observer, but doesn't free the ObserverNode. If send() is present higher up the call stack, removing multiple entries from the list will cause it to crash.

Definition at line 228 of file notify.c.

230{
231 if (!notify || !callback)
232 return false;
233
234 struct ObserverNode *np = NULL;
235 STAILQ_FOREACH(np, &notify->observers, entries)
236 {
237 if (!np->observer)
238 continue;
239
240 if ((np->observer->callback == callback) && (np->observer->global_data == global_data))
241 {
242 FREE(&np->observer);
243 return true;
244 }
245 }
246
247 return false;
248}
+ Here is the caller graph for this function:

◆ notify_observer_remove_all()

void notify_observer_remove_all ( struct Notify notify)

Remove all the observers from an object.

Parameters
notifyNotification handler

Definition at line 254 of file notify.c.

255{
256 if (!notify)
257 return;
258
259 struct ObserverNode *np = NULL;
260 struct ObserverNode *tmp = NULL;
261 STAILQ_FOREACH_SAFE(np, &notify->observers, entries, tmp)
262 {
263 STAILQ_REMOVE(&notify->observers, np, ObserverNode, entries);
264 FREE(&np->observer);
265 FREE(&np);
266 }
267}
#define STAILQ_REMOVE(head, elm, type, field)
Definition: queue.h:402
#define STAILQ_FOREACH_SAFE(var, head, field, tvar)
Definition: queue.h:362
+ Here is the caller graph for this function: