doclib: Add sub-grouping to all-members page (svn status)
[senf.git] / Console / ParseParameter.cti
1 // $Id$
2 //
3 // Copyright (C) 2008 
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 ParseParameter inline template implementation */
25
26 //#include "ParseParameter.ih"
27
28 // Custom includes
29 #include "../Utils/TypeInfo.hh"
30
31 #define prefix_ inline
32 ///////////////////////////////cti.p///////////////////////////////////////
33
34 ///////////////////////////////////////////////////////////////////////////
35 // senf::console::detail::ParameterInfoBase
36
37 prefix_ senf::console::detail::ParameterInfoBase::ParameterInfoBase(std::string const & type_)
38     : type (type_), name (), hasDefault (false)
39 {}
40
41 ///////////////////////////////////////////////////////////////////////////
42 // senf::console::detail::ParameterInfo<ParameterType>
43
44 template <class ParameterType>
45 prefix_ typename senf::console::detail::ParameterInfo<ParameterType>::ptr
46 senf::console::detail::ParameterInfo<ParameterType>::create()
47 {
48     return ptr(new ParameterInfo());
49 }
50
51 template <class ParameterType>
52 prefix_ senf::console::detail::ParameterInfo<ParameterType>::ParameterInfo()
53     : ParameterInfoBase ( ParameterTraits<ParameterType>::typeDescription() ),
54       defaultValue ()
55 {}
56
57 template <class ParameterType>
58 prefix_ std::string senf::console::detail::ParameterInfo<ParameterType>::defaultValueStr()
59     const
60 {
61     return hasDefault ? ParameterTraits<ParameterType>::dump(defaultValue) : "";
62 }
63
64 ///////////////////////////////////////////////////////////////////////////
65 // senf::console::detail::ReturnValueTraits<Type>
66
67 template <class Type>
68 template <class Fn>
69 prefix_ void senf::console::detail::ReturnValueTraits<Type>::callAndWrite(Fn const & fn,
70                                                                           std::ostream & os)
71 {
72     os << fn() << "\n";
73 }
74
75 template <class Fn>
76 prefix_ void senf::console::detail::ReturnValueTraits<void>::callAndWrite(Fn const & fn,
77                                                                           std::ostream & os)
78 {
79     fn();
80 }
81
82 ///////////////////////////////////////////////////////////////////////////
83 // senf::console::detail::ParameterTraits<Type>
84
85 template <class Type>
86 prefix_ void senf::console::detail::ParameterTraits<Type>::
87 parse(ParseCommandInfo::TokensRange const & tokens, Type & out)
88 {
89     if (tokens.size() != 1)
90         throw SyntaxErrorException("parameter syntax error");
91     try {
92         out = boost::lexical_cast<Type>(tokens.begin()[0].value());
93     }
94     catch (std::bad_cast & ex) {
95         throw SyntaxErrorException("parameter syntax error");
96     }
97 }
98
99 template <class Type>
100 prefix_ std::string senf::console::detail::ParameterTraits<Type>::typeDescription()
101 {
102     std::string type (prettyName(typeid(Type)));
103     std::string::size_type i (type.rfind(':'));
104     return i == std::string::npos ? type : type.substr(i+1);
105 }
106
107 template <class Type>
108 prefix_ std::string senf::console::detail::ParameterTraits<Type>::dump(Type const & value)
109 {
110     return boost::lexical_cast<std::string>(value);
111 }
112
113 ///////////////////////////////cti.e///////////////////////////////////////
114 #undef prefix_
115
116 \f
117 // Local Variables:
118 // mode: c++
119 // fill-column: 100
120 // comment-column: 40
121 // c-file-style: "senf"
122 // indent-tabs-mode: nil
123 // ispell-local-dictionary: "american"
124 // compile-command: "scons -u test"
125 // End: