Console: More documentation and cleanup
[senf.git] / Console / Traits.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 Traits inline template implementation */
25
26 //#include "Traits.ih"
27
28 // Custom includes
29 #include "../Utils/TypeInfo.hh"
30
31 #define prefix_ inline
32 ///////////////////////////////cti.p///////////////////////////////////////
33
34 ///////////////////////////////////////////////////////////////////////////
35 // senf::console::detail::ReturnValueTraits<Type>
36
37 template <class Type>
38 prefix_ void senf::console::ReturnValueTraits<Type>::format(Type const & value,
39                                                             std::ostream & os)
40 {
41     os << value;
42 }
43
44 ///////////////////////////////////////////////////////////////////////////
45 // senf::console::ArgumentTraits<Type>
46
47 template <class Type>
48 prefix_ void senf::console::ArgumentTraits<Type>::
49 parse(ParseCommandInfo::TokensRange const & tokens, Type & out)
50 {
51     if (tokens.size() != 1)
52         throw SyntaxErrorException("parameter syntax error");
53
54     try {
55         out = boost::lexical_cast<Type>(tokens.begin()[0].value());
56     }
57     catch (std::bad_cast & ex) {
58         throw SyntaxErrorException("parameter syntax error");
59     }
60 }
61
62 template <class Type>
63 prefix_ std::string senf::console::ArgumentTraits<Type>::description()
64 {
65     std::string type (prettyName(typeid(Type)));
66     std::string::size_type i (type.rfind(':'));
67     return i == std::string::npos ? type : type.substr(i+1);
68 }
69
70 template <class Type>
71 prefix_ std::string senf::console::ArgumentTraits<Type>::str(Type const & value)
72 {
73     return boost::lexical_cast<std::string>(value);
74 }
75
76 ///////////////////////////////cti.e///////////////////////////////////////
77 #undef prefix_
78
79 \f
80 // Local Variables:
81 // mode: c++
82 // fill-column: 100
83 // comment-column: 40
84 // c-file-style: "senf"
85 // indent-tabs-mode: nil
86 // ispell-local-dictionary: "american"
87 // compile-command: "scons -u test"
88 // End: