Utils/Logger/StreamRegistry.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 StreamRegistry public header */
  25
  26 #ifndef HH_StreamRegistry_
  27 #define HH_StreamRegistry_ 1
  28
  29 // Custom includes
  30 #include <map>
  31 #include <functional>
  32 #include <boost/iterator/transform_iterator.hpp>
  33 #include "Levels.hh"
  34 #include "../singleton.hh"
  35
  36 //#include "StreamRegistry.mpp"
  37 #include "StreamRegistry.ih"
  38 ///////////////////////////////hh.p////////////////////////////////////////
  39
  40 namespace senf {
  41 namespace log {
  42
  43     namespace detail { struct StreamBase; }
  44
  45     /** \brief Stream registry
  46
  47         The stream registry keeps track of all streams defined. stream classes are defined as
  48         singletons and will automatically register with this registry.
  49
  50         The stream registry exposes a forward sequence interface which is a sequence of the names of
  51         all registered streams.
  52      */
  53     class StreamRegistry
  54         : public senf::singleton<StreamRegistry>
  55     {
  56         typedef std::map<std::string, detail::StreamBase 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
  67 #       ifdef DOXYGEN
  68         // Hmm ... doxygen does not understand 'using declarations' ...
  69         /// Access stream registry singleton instance
  70         static AreaRegistry & instance();
  71 #       endif
  72
  73         using senf::singleton<StreamRegistry>::instance;
  74
  75         iterator begin();
  76         iterator end();
  77
  78     private:
  79         StreamRegistry();
  80
  81         void registerStream(detail::StreamBase const & stream);
  82         detail::StreamBase const * lookup(std::string const & name);
  83
  84         Registry registry_;
  85
  86         friend class senf::singleton<StreamRegistry>;
  87         friend class detail::StreamBase;
  88         friend class Target;
  89     };
  90
  91 }}
  92
  93 ///////////////////////////////hh.e////////////////////////////////////////#
  94 #include "StreamRegistry.cci"
  95 //#include "StreamRegistry.ct"
  96 //#include "StreamRegistry.cti"
  97 #endif
  98
  99 \f
 100 // Local Variables:
 101 // mode: c++
 102 // fill-column: 100
 103 // comment-column: 40
 104 // c-file-style: "senf"
 105 // indent-tabs-mode: nil
 106 // ispell-local-dictionary: "american"
 107 // compile-command: "scons -u test"
 108 // End: