bertos/mware/observer.h

   1 /**
   2  * \file
   3  * <!--
   4  * This file is part of BeRTOS.
   5  *
   6  * Bertos is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  19  *
  20  * As a special exception, you may use this file as part of a free software
  21  * library without restriction.  Specifically, if other files instantiate
  22  * templates or use macros or inline functions from this file, or you compile
  23  * this file and link it with other files to produce an executable, this
  24  * file does not by itself cause the resulting executable to be covered by
  25  * the GNU General Public License.  This exception does not however
  26  * invalidate any other reasons why the executable file might be covered by
  27  * the GNU General Public License.
  28  *
  29  * Copyright 2006 Develer S.r.l. (http://www.develer.com/)
  30  *
  31  * -->
  32  *
  33  * \brief Simple notifier for the subject/observer pattern (interface)
  34  *
  35  * \author Bernie Innocenti <bernie@codewiz.org>
  36  */
  37 #ifndef MWARE_OBSERVER_H
  38 #define MWARE_OBSERVER_H
  39
  40 #include <struct/list.h>
  41
  42 /**
  43  *
  44  * Here's a simple example:
  45  *
  46  * \code
  47  * Subject kbd_driver;
  48  *
  49  * Observer kbd_observer;
  50  *
  51  * void key_pressed(int event, void *_param)
  52  * {
  53  *     char *param = (char *)_param;
  54  *
  55  *     if (event == EVENT_KBD_PRESSED)
  56  *         printf("You pressed %c\n", *param);
  57  * }
  58  *
  59  * void register_kbd_listener(void)
  60  * {
  61  *     observer_SetEvent(&kbd_observer, key_pressed);
  62  *     observer_Subscribe(&kbd_driver, &kbd_observer);
  63  * }
  64  * \endcode
  65  */
  66 typedef struct Observer
  67 {
  68         Node link;
  69         void (*event)(int event_id, void *param);
  70 } Observer;
  71
  72 typedef struct Subject
  73 {
  74         /// Subscribed observers.
  75         List observers;
  76
  77 } Subject;
  78
  79 void observer_SetEvent(Observer *observer, void (*event)(int event_id, void *param));
  80
  81 #define OBSERVER_INITIALIZER(callback) { { NULL, NULL }, callback }
  82
  83 void observer_InitSubject(Subject *subject);
  84
  85 /// Aggiunge un Observer all'insieme
  86 void observer_Subscribe(Subject *subject, Observer *observer);
  87
  88 /// Rimuove un Observer dall'insieme
  89 void observer_Unsubscribe(Subject *subject, Observer *observer);
  90
  91 /// per tutti gli elementi nel set notifica l'evento, chiamando la relativa
  92 /// funzione event
  93 void observer_notify(Subject *subject, int event_id, void *param);
  94
  95 #endif /* MWARE_OBSERVER_H */