Console: Add console logging documentation
[senf.git] / Utils / Logger / Target.ih
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 Target internal header */
25
26 #ifndef IH_Target_
27 #define IH_Target_ 1
28
29 // Custom includes
30 #include <memory>
31 #include <boost/scoped_ptr.hpp>
32
33 ///////////////////////////////ih.p////////////////////////////////////////
34
35 namespace senf {
36 namespace log {
37 namespace detail {
38
39     /** \brief Internal: Target registry */
40     class TargetRegistry
41         : public senf::singleton<TargetRegistry>
42     {
43     public:
44         using senf::singleton<TargetRegistry>::instance;
45
46         void write(StreamBase const & stream, AreaBase const & area, unsigned level, 
47                    std::string msg);
48
49         void timeSource(std::auto_ptr<TimeSource> source);
50
51         void routed();
52         bool fallbackRouting();
53
54     private:
55         TargetRegistry();
56         
57         void registerTarget(Target * target);
58         void unregisterTarget(Target * target);
59
60         typedef std::set<Target *> Targets;
61         Targets targets_;
62         boost::scoped_ptr<TimeSource> timeSource_;
63
64         bool fallbackRouting_;
65         
66         friend class senf::log::Target;
67         friend class senf::singleton<TargetRegistry>;
68     };
69
70     /** \brief Internal: Write log message */
71     template <class Stream, class Area, class Level>
72     void write(std::string msg);
73
74     senf::mpl::rv<0u> RouteParameterCheck_(...);
75     senf::mpl::rv<1u> RouteParameterCheck_(StreamBase *);
76     senf::mpl::rv<2u> RouteParameterCheck_(AreaBase *);
77     template <class T> senf::mpl::rv<3u> RouteParameterCheck_(T*, typename T::SENFLogArea * = 0);
78     senf::mpl::rv<4u> RouteParameterCheck_(LevelBase *);
79
80     template < class T, class A2, class A1,
81                unsigned type = SENF_MPL_RV( RouteParameterCheck_(static_cast<T*>(0)) ) >
82     struct RouteParameters
83     {};
84
85     template <class A2, class A1>
86     struct RouteParameters<mpl::nil,A2,A1,0u>
87         : public RouteParameters<A2,A1,mpl::nil>
88     {};
89
90     struct NilLevel {
91         static unsigned const value = NONE::value;
92     };
93
94     template <>
95     struct RouteParameters<mpl::nil,mpl::nil,mpl::nil,0u>
96     {
97         typedef mpl::nil Stream;
98         typedef mpl::nil Area;
99         typedef NilLevel Level;
100     };
101
102     template <class T, class A2, class A1>
103     struct RouteParameters<T,A2,A1,1u>
104         : public RouteParameters<A2,A1,mpl::nil>
105     {
106         typedef T Stream;
107     };
108
109     template <class T, class A2, class A1>
110     struct RouteParameters<T,A2,A1,2u>
111         : public RouteParameters<A2,A1,mpl::nil>
112     {
113         typedef T Area;
114     };
115
116     template <class T, class A2, class A1>
117     struct RouteParameters<T,A2,A1,3u>
118         : public RouteParameters<A2,A1,mpl::nil>
119     {
120         typedef typename T::SENFLogArea Area;
121     };
122
123     template <class T, class A2, class A1>
124     struct RouteParameters<T,A2,A1,4u>
125         : public RouteParameters<A2,A1,mpl::nil>
126     {
127         typedef T Level;
128     };
129
130     template <class T, class RV>
131     struct InstanceP
132     {
133         static RV * value() { return & T::instance(); }
134     };
135
136     template <class RV>
137     struct InstanceP<mpl::nil, RV>
138     {
139         static RV * value() { return 0; }
140     };
141
142 }}}
143
144 ///////////////////////////////ih.e////////////////////////////////////////
145 #endif
146
147 \f
148 // Local Variables:
149 // mode: c++
150 // fill-column: 100
151 // comment-column: 40
152 // c-file-style: "senf"
153 // indent-tabs-mode: nil
154 // ispell-local-dictionary: "american"
155 // compile-command: "scons -u test"
156 // End: