Utils/Console: Add short help to 'ls' output
[senf.git] / Utils / Console / OverloadedCommand.cci
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 OverloadedCommand inline non-template implementation */
25
26 //#include "OverloadedCommand.ih"
27
28 // Custom includes
29
30 #define prefix_ inline
31 ///////////////////////////////cci.p///////////////////////////////////////
32
33 ///////////////////////////////////////////////////////////////////////////
34 // senf::console::OverloadedCommandNode
35
36 prefix_ senf::console::OverloadedCommandNode::ptr senf::console::OverloadedCommandNode::create()
37 {
38     return ptr(new OverloadedCommandNode());
39 }
40
41 prefix_ senf::console::OverloadedCommandNode::ptr senf::console::OverloadedCommandNode::thisptr()
42 {
43     return boost::static_pointer_cast<OverloadedCommandNode>(shared_from_this());
44 }
45
46 prefix_ senf::console::OverloadedCommandNode::cptr senf::console::OverloadedCommandNode::thisptr()
47     const
48 {
49     return boost::static_pointer_cast<OverloadedCommandNode const>(shared_from_this());
50 }
51
52 prefix_ senf::console::OverloadedCommandNode &
53 senf::console::OverloadedCommandNode::doc(std::string const & doc)
54 {
55     doc_ = doc;
56     return *this;
57 }
58
59 prefix_ senf::console::OverloadedCommandNode &
60 senf::console::OverloadedCommandNode::shortdoc(std::string const & doc)
61 {
62     shortdoc_ = doc;
63     return *this;
64 }
65
66 prefix_ unsigned
67 senf::console::OverloadedCommandNode::overloadIndex(CommandOverload const & overload)
68 {
69     return find(overloads_.begin(), overloads_.end(), CommandOverload::cptr(&overload)) 
70         - overloads_.begin() + 1;
71 }
72
73 prefix_ senf::console::OverloadedCommandNode::OverloadedCommandNode()
74 {}
75
76 ///////////////////////////////////////////////////////////////////////////
77 // senf::console::CommandOverload
78
79 prefix_ senf::console::CommandOverload::~CommandOverload()
80 {}
81
82 prefix_ void senf::console::CommandOverload::execute(boost::any & rv, std::ostream & os,
83                                                      ParseCommandInfo const & command)
84 {
85     v_execute(rv, os, command);
86 }
87
88 prefix_ void senf::console::CommandOverload::operator()(boost::any & rv, std::ostream & os,
89                                                         ParseCommandInfo const & command)
90 {
91     execute(rv, os, command);
92 }
93
94 prefix_ unsigned senf::console::CommandOverload::numArguments()
95     const
96 {
97     return v_numArguments();
98 }
99
100 prefix_ void senf::console::CommandOverload::argumentDoc(unsigned index, ArgumentDoc & doc)
101     const
102 {
103     return v_argumentDoc(index,doc);
104 }
105
106 prefix_ std::string senf::console::CommandOverload::doc()
107     const
108 {
109     return v_doc();
110 }
111
112 prefix_ senf::console::OverloadedCommandNode & senf::console::CommandOverload::node()
113     const
114 {
115     SENF_ASSERT( node_ );
116     return *node_;
117 }
118
119 prefix_ unsigned senf::console::CommandOverload::overloadIndex()
120     const
121 {
122     return node().overloadIndex(*this);
123 }
124
125 prefix_ senf::console::CommandOverload::CommandOverload()
126     : node_(0)
127 {}
128
129 ///////////////////////////////////////////////////////////////////////////
130 // senf::console::SimpleCommandOverload
131
132 prefix_ senf::console::SimpleCommandOverload::ptr
133 senf::console::SimpleCommandOverload::create(Function fn)
134 {
135     return ptr(new SimpleCommandOverload(fn));
136 }
137
138 prefix_ senf::console::SimpleCommandOverload &
139 senf::console::SimpleCommandOverload::doc(std::string const & doc)
140 {
141     doc_ = doc;
142     return *this;
143 }
144
145 prefix_ senf::console::SimpleCommandOverload::SimpleCommandOverload(Function fn)
146     : fn_ (fn)
147 {}
148
149 ///////////////////////////////cci.e///////////////////////////////////////
150 #undef prefix_
151
152 \f
153 // Local Variables:
154 // mode: c++
155 // fill-column: 100
156 // comment-column: 40
157 // c-file-style: "senf"
158 // indent-tabs-mode: nil
159 // ispell-local-dictionary: "american"
160 // compile-command: "scons -u test"
161 // End: