senf/Utils/Logger/AreaRegistry.hh

   1 // $Id$
   2 //
   3 // Copyright (C) 2007
   4 // Fraunhofer Institute for Open Communication Systems (FOKUS)
   5 // Competence Center NETwork research (NET), St. Augustin, GERMANY
   6 //     Stefan Bund <g0dil@berlios.de>
   7 //
   8 // This program is free software; you can redistribute it and/or modify
   9 // it under the terms of the GNU General Public License as published by
  10 // the Free Software Foundation; either version 2 of the License, or
  11 // (at your option) any later version.
  12 //
  13 // This program is distributed in the hope that it will be useful,
  14 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  15 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16 // GNU General Public License for more details.
  17 //
  18 // You should have received a copy of the GNU General Public License
  19 // along with this program; if not, write to the
  20 // Free Software Foundation, Inc.,
  21 // 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  22
  23 /** \file
  24     \brief AreaRegistry public header */
  25
  26 #ifndef HH_SENF_Utils_Logger_AreaRegistry_
  27 #define HH_SENF_Utils_Logger_AreaRegistry_ 1
  28
  29 // Custom includes
  30 #include <map>
  31 #include <functional>
  32 #include <boost/iterator/transform_iterator.hpp>
  33 #include <senf/Utils/singleton.hh>
  34
  35 //#include "AreaRegistry.mpp"
  36 #include "AreaRegistry.ih"
  37 ///////////////////////////////hh.p////////////////////////////////////////
  38
  39 namespace senf {
  40 namespace log {
  41
  42     namespace detail { struct AreaBase; }
  43
  44     /** \brief Area registry
  45
  46         The area registry keeps track of all areas defined.
  47
  48         The area registry exposes a forward sequence interface which allows to query the list of all
  49         registered areas.
  50
  51         \implementation Area classes are defined as singletons and will automatically register with
  52         this registry.
  53      */
  54     class AreaRegistry
  55         : public senf::singleton<AreaRegistry>
  56     {
  57         typedef std::map<std::string, detail::AreaBase const *> Registry;
  58
  59         struct SelectName
  60         {
  61             typedef std::string result_type;
  62             std::string const & operator()(Registry::value_type const & v) const;
  63         };
  64
  65     public:
  66         typedef boost::transform_iterator<SelectName, Registry::const_iterator> iterator;
  67                                         ///< Iterator type
  68
  69 #       ifdef DOXYGEN
  70         // Hmm ... doxygen does not understand using declarations ...
  71         /// Access area registry singleton instance
  72         static AreaRegistry & instance();
  73 #       endif
  74
  75         using senf::singleton<AreaRegistry>::instance;
  76
  77         iterator begin();               ///< Beginning of area name sequence
  78         iterator end();                 ///< End of area name sequence
  79
  80         detail::AreaBase const * lookup(std::string const & name);
  81
  82     private:
  83         AreaRegistry();
  84
  85         void registerArea(detail::AreaBase const & area);
  86
  87         Registry registry_;
  88
  89         friend class senf::singleton<AreaRegistry>;
  90         friend class detail::AreaBase;
  91         friend class Target;
  92     };
  93
  94 }}
  95
  96 ///////////////////////////////hh.e////////////////////////////////////////
  97 #include "AreaRegistry.cci"
  98 //#include "AreaRegistry.ct"
  99 //#include "AreaRegistry.cti"
 100 #endif
 101
 102 \f
 103 // Local Variables:
 104 // mode: c++
 105 // fill-column: 100
 106 // comment-column: 40
 107 // c-file-style: "senf"
 108 // indent-tabs-mode: nil
 109 // ispell-local-dictionary: "american"
 110 // compile-command: "scons -u test"
 111 // End: