bertos/dt/dnotifier.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 2005 Develer S.r.l. (http://www.develer.com/)
  30  * -->
  31  *
  32  * \brief Notifier obj (interface).
  33  *
  34  * \author Bernie Innocenti <bernie@codewiz.org>
  35  * \author Francesco Sacchi <batt@develer.com>
  36  */
  37
  38 #ifndef DT_DNOTIFIER_H
  39 #define DT_DNOTIFIER_H
  40
  41 #include <cfg/debug.h>
  42
  43 #include <dt/dtag.h>
  44 #include <struct/list.h>
  45
  46 //Fwd declaretion.
  47 struct DNotifier;
  48 struct DFilter;
  49
  50 typedef void (* update_func_ptr)(struct DNotifier *, dtag_t, dval_t);
  51 typedef void (* update_filter_ptr)(struct DFilter *, dtag_t, dval_t);
  52
  53 /**
  54  * Base object for receive and forward messages.
  55  * It contains an update function used to update itslef and a list to
  56  * notify other DNotifer eventually connected.
  57  */
  58 typedef struct DNotifier
  59 {
  60         /// Receive new attributes from other notifiers.
  61         update_func_ptr update;
  62
  63         /// List of target notifiers to set new attributes to.
  64         List targets;
  65 } DNotifier;
  66
  67 /**
  68  * Map for messages.
  69  * Used to translate src message to dst message.
  70  */
  71 typedef struct DFilterMap
  72 {
  73         DTagItem src;
  74         DTagItem dst;
  75 } DFilterMap;
  76
  77
  78 /**
  79  * A filter is an interface between two notifier.
  80  * It can translate messages between them through a map (if it is not null).
  81  */
  82 typedef struct DFilter
  83 {
  84         /// Allow creating a list of dfilter objects.
  85         Node link;
  86
  87         /// Target of the filter
  88         DNotifier *target;
  89
  90         /// Update function called by the source dnotifier
  91         update_filter_ptr update;
  92
  93         ///Map for translating messages for target
  94         const DFilterMap *map;
  95
  96         ///Used in debug to prevent inserting this filter in more than one list
  97         DB(uint8_t magic;)
  98 } DFilter;
  99
 100 /// Type for filter-mask checking
 101 typedef unsigned int dfilter_mask_t;
 102
 103 /// Filter init
 104 void filter_init(DFilter *f, const DFilterMap *map, bool masked, DNotifier *source, DNotifier *target);
 105
 106 /// Filter update function without masking capabilities.
 107 void filter_update(DFilter *f, dtag_t tag, dval_t val);
 108
 109 /// Filter update function with masking capabilities.
 110 void filter_mask_update(DFilter *f, dtag_t tag, dval_t val);
 111
 112 /// Notifier init
 113 void notifier_init(DNotifier *n);
 114
 115
 116 /**
 117  * Macro to notify the target object.
 118  */
 119 INLINE void dnotify(DNotifier *target, dtag_t tag, dval_t val)
 120 {
 121         if (target)
 122                 target->update(target, tag, val);
 123 }
 124
 125 /**
 126  * Macro to notify all the targets of \a target object.
 127  */
 128 INLINE void dnotify_targets(DNotifier *target, dtag_t tag, dval_t val)
 129 {
 130         DFilter *f;
 131         if (!LIST_EMPTY(&target->targets))
 132                 FOREACH_NODE(f, &target->targets)
 133                         f->update(f, tag, val);
 134 }
 135
 136
 137 /**
 138  * Macro that connect \a src notifier to \a tgt using \a map and passing \a opt for filtering option.
 139  * It declares a static filter to achieve connection and messages translation.
 140  * \note Due its static filter declaration, DCONNECT MUST NOT be used inside loops or in functions called multiple times.
 141  * Failing to do so will lead to unpredictable connections between notifiers.
 142  */
 143 #define DCONNECT(src, tgt, map, opt) \
 144         do { \
 145                 static DFilter _filter_; /* Declare a filter */ \
 146                 filter_init(&(_filter_), map, opt, src, tgt); /* Init it. */ \
 147         } while (0)
 148
 149
 150 #endif /* DT_DNOTIFIER_H */