senf/Utils/Logger/StreamRegistry.hh

   1 // $Id$
   2 //
   3 // Copyright (C) 2007
   4 // Fraunhofer Institute for Open Communication Systems (FOKUS)
   5 //
   6 // The contents of this file are subject to the Fraunhofer FOKUS Public License
   7 // Version 1.0 (the "License"); you may not use this file except in compliance
   8 // with the License. You may obtain a copy of the License at
   9 // http://senf.berlios.de/license.html
  10 //
  11 // The Fraunhofer FOKUS Public License Version 1.0 is based on,
  12 // but modifies the Mozilla Public License Version 1.1.
  13 // See the full license text for the amendments.
  14 //
  15 // Software distributed under the License is distributed on an "AS IS" basis,
  16 // WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  17 // for the specific language governing rights and limitations under the License.
  18 //
  19 // The Original Code is Fraunhofer FOKUS code.
  20 //
  21 // The Initial Developer of the Original Code is Fraunhofer-Gesellschaft e.V.
  22 // (registered association), Hansastraße 27 c, 80686 Munich, Germany.
  23 // All Rights Reserved.
  24 //
  25 // Contributor(s):
  26 //   Stefan Bund <g0dil@berlios.de>
  27
  28 /** \file
  29     \brief StreamRegistry public header */
  30
  31 #ifndef HH_SENF_Utils_Logger_StreamRegistry_
  32 #define HH_SENF_Utils_Logger_StreamRegistry_ 1
  33
  34 // Custom includes
  35 #include <map>
  36 #include <ext/functional>
  37 #include <boost/iterator/transform_iterator.hpp>
  38 #include <senf/Utils/singleton.hh>
  39
  40 //#include "StreamRegistry.mpp"
  41 #include "StreamRegistry.ih"
  42 //-/////////////////////////////////////////////////////////////////////////////////////////////////
  43
  44 namespace senf {
  45 namespace log {
  46
  47     namespace detail { struct StreamBase; }
  48
  49     /** \brief Stream registry
  50
  51         The stream registry keeps track of all streams defined. stream classes are defined as
  52         singletons and will automatically register with this registry.
  53
  54         The stream registry exposes a forward sequence interface which is a sequence of the names of
  55         all registered streams.
  56      */
  57     class StreamRegistry
  58         : public senf::singleton<StreamRegistry>
  59     {
  60         typedef std::map<std::string, detail::StreamBase const *> Registry;
  61
  62     public:
  63         typedef boost::transform_iterator< ::__gnu_cxx::select1st<Registry::value_type>,
  64                                            Registry::const_iterator > iterator;
  65
  66 #       ifdef DOXYGEN
  67         // Hmm ... doxygen does not understand 'using declarations' ...
  68         /// Access stream registry singleton instance
  69         static AreaRegistry & instance();
  70 #       endif
  71
  72         using senf::singleton<StreamRegistry>::instance;
  73
  74         iterator begin();
  75         iterator end();
  76
  77         detail::StreamBase const * lookup(std::string const & name);
  78
  79     private:
  80         StreamRegistry();
  81
  82         void registerStream(detail::StreamBase const & stream);
  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 //-/////////////////////////////////////////////////////////////////////////////////////////////////
  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: