src/regref.h

   1 /**************************************************************************/
   2 /* ---------------------------------------------------------------------- */
   3 /* Copyright (C) 2006 - 2008 FRESCOR consortium partners:                 */
   4 /*                                                                        */
   5 /*   Universidad de Cantabria,              SPAIN                         */
   6 /*   University of York,                    UK                            */
   7 /*   Scuola Superiore Sant'Anna,            ITALY                         */
   8 /*   Kaiserslautern University,             GERMANY                       */
   9 /*   Univ. Politécnica  Valencia,           SPAIN                        */
  10 /*   Czech Technical University in Prague,  CZECH REPUBLIC                */
  11 /*   ENEA                                   SWEDEN                        */
  12 /*   Thales Communication S.A.              FRANCE                        */
  13 /*   Visual Tools S.A.                      SPAIN                         */
  14 /*   Rapita Systems Ltd                     UK                            */
  15 /*   Evidence                               ITALY                         */
  16 /*                                                                        */
  17 /*   See http://www.frescor.org for a link to partners' websites          */
  18 /*                                                                        */
  19 /*          FRESCOR project (FP6/2005/IST/5-034026) is funded             */
  20 /*       in part by the European Union Sixth Framework Programme          */
  21 /*       The European Union is not liable of any use that may be          */
  22 /*       made of this code.                                               */
  23 /*                                                                        */
  24 /*                                                                        */
  25 /*  This file is part of FORB (Frescor Object Request Broker)             */
  26 /*                                                                        */
  27 /* FORB is free software; you can redistribute it and/or modify it        */
  28 /* under terms of the GNU General Public License as published by the      */
  29 /* Free Software Foundation; either version 2, or (at your option) any    */
  30 /* later version.  FORB is distributed in the hope that it will be        */
  31 /* useful, but WITHOUT ANY WARRANTY; without even the implied warranty    */
  32 /* of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU    */
  33 /* General Public License for more details. You should have received a    */
  34 /* copy of the GNU General Public License along with FORB; see file       */
  35 /* COPYING. If not, write to the Free Software Foundation, 675 Mass Ave,  */
  36 /* Cambridge, MA 02139, USA.                                              */
  37 /*                                                                        */
  38 /* As a special exception, including FORB header files in a file,         */
  39 /* instantiating FORB generics or templates, or linking other files       */
  40 /* with FORB objects to produce an executable application, does not       */
  41 /* by itself cause the resulting executable application to be covered     */
  42 /* by the GNU General Public License. This exception does not             */
  43 /* however invalidate any other reasons why the executable file might be  */
  44 /* covered by the GNU Public License.                                     */
  45 /**************************************************************************/
  46
  47 /**
  48  * @file   regref.h
  49  * @author Michal Sojka <sojkam1@fel.cvut.cz>
  50  * @date   Sat Oct 11 14:46:08 2008
  51  *
  52  * @brief Handling of registered object references.
  53  *
  54  *
  55  */
  56
  57 #ifndef FORB_REGREF_H
  58 #define FORB_REGREF_H
  59
  60 #include <forb.h>
  61 #include <forb/forb-internal.h>
  62 #include <ul_gavl.h>
  63
  64 #define FORB_REGREF_NAME_LEN 32
  65
  66 /**
  67  * Type for registered names
  68  *
  69  * We must encapsulate the array in structure in order to behave as
  70  * normal C object. This is necessary for usage as GAVL key. The
  71  * reason is that typeof(&array) == typeof(array).
  72  */
  73 typedef struct {
  74         char str[FORB_REGREF_NAME_LEN];
  75 } forb_regref_name_t;
  76
  77 struct forb_regref {
  78         forb_regref_name_t name; /**< Name of the registered reference */
  79         forb_object object;      /**< Registered object reference */
  80         gavl_node_t node;        /**< Node for forb->regrefs tree */
  81 };
  82
  83 typedef struct forb_regref forb_regref_t;
  84
  85 GAVL_CUST_NODE_INT_DEC(forb_regref_nolock /* cust_prefix */,
  86                        forb_t /* cust_root_t */,
  87                        forb_regref_t /* cust_item_t */,
  88                        forb_regref_name_t /* cust_key_t */,
  89                        regrefs /* cust_root_node */,
  90                        node /* cust_item_node */,
  91                        name /* cust_item_key */,
  92                        forb_regref_cmp/* cust_cmp_fnc */);
  93
  94
  95 forb_regref_t *
  96 forb_regref_new(forb_object object, forb_regref_name_t name);
  97
  98 void
  99 forb_regref_release(forb_regref_t *regref);
 100
 101 static inline void
 102 forb_regref_insert(forb_t *forb, forb_regref_t *regref)
 103 {
 104         pthread_mutex_lock(&forb->regref_mutex);
 105         forb_regref_nolock_insert(forb, regref);
 106         pthread_mutex_unlock(&forb->regref_mutex);
 107 }
 108
 109 static inline void
 110 forb_regref_delete(forb_t *forb, forb_regref_t *regref)
 111 {
 112         pthread_mutex_lock(&forb->regref_mutex);
 113         forb_regref_nolock_delete(forb, regref);
 114         pthread_mutex_unlock(&forb->regref_mutex);
 115 }
 116
 117 static inline forb_regref_t *
 118 forb_regref_find(forb_t *forb, forb_regref_name_t const *name)
 119 {
 120         forb_regref_t *regref;
 121         pthread_mutex_lock(&forb->regref_mutex);
 122         regref = forb_regref_nolock_find(forb, name);
 123         pthread_mutex_unlock(&forb->regref_mutex);
 124         return regref;
 125 }
 126
 127 static inline forb_regref_t *
 128 forb_regref_first(forb_t *forb)
 129 {
 130         forb_regref_t *regref;
 131         pthread_mutex_lock(&forb->regref_mutex);
 132         regref = forb_regref_nolock_first(forb);
 133         pthread_mutex_unlock(&forb->regref_mutex);
 134         return regref;
 135 }
 136
 137 #endif