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 <boost/iterator/transform_iterator.hpp>
  32 #include <senf/Utils/singleton.hh>
  33
  34 //#include "AreaRegistry.mpp"
  35 #include "AreaRegistry.ih"
  36 //-/////////////////////////////////////////////////////////////////////////////////////////////////
  37
  38 namespace senf {
  39 namespace log {
  40
  41     namespace detail { struct AreaBase; }
  42
  43     /** \brief Area registry
  44
  45         The area registry keeps track of all areas defined.
  46
  47         The area registry exposes a forward sequence interface which allows to query the list of all
  48         registered areas.
  49
  50         \implementation Area classes are defined as singletons and will automatically register with
  51         this registry.
  52      */
  53     class AreaRegistry
  54         : public senf::singleton<AreaRegistry>
  55     {
  56         typedef std::map<std::string, detail::AreaBase const *> Registry;
  57
  58         struct SelectName
  59         {
  60             typedef std::string result_type;
  61             std::string const & operator()(Registry::value_type const & v) const;
  62         };
  63
  64     public:
  65         typedef boost::transform_iterator<SelectName, Registry::const_iterator> iterator;
  66                                         ///< Iterator type
  67
  68 #       ifdef DOXYGEN
  69         // Hmm ... doxygen does not understand using declarations ...
  70         /// Access area registry singleton instance
  71         static AreaRegistry & instance();
  72 #       endif
  73
  74         using senf::singleton<AreaRegistry>::instance;
  75
  76         iterator begin();               ///< Beginning of area name sequence
  77         iterator end();                 ///< End of area name sequence
  78
  79         detail::AreaBase const * lookup(std::string const & name);
  80
  81     private:
  82         AreaRegistry();
  83
  84         void registerArea(detail::AreaBase const & area);
  85
  86         Registry registry_;
  87
  88         friend class senf::singleton<AreaRegistry>;
  89         friend class detail::AreaBase;
  90         friend class Target;
  91     };
  92
  93 }}
  94
  95 //-/////////////////////////////////////////////////////////////////////////////////////////////////
  96 #include "AreaRegistry.cci"
  97 //#include "AreaRegistry.ct"
  98 //#include "AreaRegistry.cti"
  99 #endif
 100
 101 \f
 102 // Local Variables:
 103 // mode: c++
 104 // fill-column: 100
 105 // comment-column: 40
 106 // c-file-style: "senf"
 107 // indent-tabs-mode: nil
 108 // ispell-local-dictionary: "american"
 109 // compile-command: "scons -u test"
 110 // End: