Packets: senf::Parse_Variant documentation
[senf.git] / Utils / Logger / Area.hh
1 // $Id$
2 //
3 // Copyright (C) 2007 
4 // Fraunhofer Institut fuer offene Kommunikationssysteme (FOKUS)
5 // Kompetenzzentrum fuer Satelitenkommunikation (SatCom)
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 Area public header */
25
26 #ifndef HH_Area_
27 #define HH_Area_ 1
28
29 // Custom includes
30 #include <map>
31 #include <functional>
32 #include <boost/iterator/transform_iterator.hpp>
33 #include "../singleton.hh"
34
35 //#include "Area.mpp"
36 ///////////////////////////////hh.p////////////////////////////////////////
37
38 /** \brief Define log area
39
40     Defines a new log area named \a area. The area is defined as a symbol in the current scope.
41
42     \hideinitializer
43  */
44 #define SENF_LOG_DEF_AREA(area) SENF_LOG_DEF_AREA_I(area, ; )
45
46 namespace senf {
47 namespace log { 
48
49     namespace detail { struct AreaBase; }
50     
51     class AreaRegistry
52         : public senf::singleton<AreaRegistry>
53     {
54         typedef std::map<std::string, detail::AreaBase const *> Registry;
55
56         struct SelectName 
57         {
58             typedef std::string result_type;
59             std::string const & operator()(Registry::value_type const & v) const;
60         };
61
62     public:
63         typedef boost::transform_iterator<SelectName, Registry::const_iterator> iterator;
64
65         using senf::singleton<AreaRegistry>::instance;
66
67         iterator begin();
68         iterator end();
69
70     private:
71         AreaRegistry();
72
73         void registerArea(detail::AreaBase const & area);
74
75         Registry registry_;
76
77         friend class senf::singleton<AreaRegistry>;
78         friend class detail::AreaBase;
79         friend class Target;
80     };        
81     
82 }}
83
84 ///////////////////////////////hh.e////////////////////////////////////////
85 #include "Area.cci"
86 //#include "Area.ct"
87 //#include "Area.cti"
88 #endif
89
90 \f
91 // Local Variables:
92 // mode: c++
93 // fill-column: 100
94 // comment-column: 40
95 // c-file-style: "senf"
96 // indent-tabs-mode: nil
97 // ispell-local-dictionary: "american"
98 // compile-command: "scons -u test"
99 // End: