senf/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 //-/////////////////////////////////////////////////////////////////////////////////////////////////
  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::OverloadsRange
  74 senf::console::OverloadedCommandNode::overloads()
  75     const
  76 {
  77     return boost::make_iterator_range(overloads_.begin(), overloads_.end());
  78 }
  79
  80 prefix_ senf::console::OverloadedCommandNode::OverloadedCommandNode()
  81 {}
  82
  83 //-/////////////////////////////////////////////////////////////////////////////////////////////////
  84 // senf::console::CommandOverload
  85
  86 prefix_ senf::console::CommandOverload::~CommandOverload()
  87 {}
  88
  89 prefix_ void senf::console::CommandOverload::execute(boost::any & rv, std::ostream & os,
  90                                                      ParseCommandInfo const & command)
  91 {
  92     v_execute(rv, os, command);
  93 }
  94
  95 prefix_ void senf::console::CommandOverload::operator()(boost::any & rv, std::ostream & os,
  96                                                         ParseCommandInfo const & command)
  97 {
  98     execute(rv, os, command);
  99 }
 100
 101 prefix_ unsigned senf::console::CommandOverload::numArguments()
 102     const
 103 {
 104     return v_numArguments();
 105 }
 106
 107 prefix_ void senf::console::CommandOverload::argumentDoc(unsigned index, ArgumentDoc & doc)
 108     const
 109 {
 110     return v_argumentDoc(index,doc);
 111 }
 112
 113 prefix_ std::string senf::console::CommandOverload::doc()
 114     const
 115 {
 116     return v_doc();
 117 }
 118
 119 prefix_ senf::console::OverloadedCommandNode & senf::console::CommandOverload::node()
 120     const
 121 {
 122     SENF_ASSERT( node_, "Overload not added to any node yet" );
 123     return *node_;
 124 }
 125
 126 prefix_ unsigned senf::console::CommandOverload::overloadIndex()
 127     const
 128 {
 129     return node().overloadIndex(*this);
 130 }
 131
 132 prefix_ senf::console::CommandOverload::CommandOverload()
 133     : node_(0)
 134 {}
 135
 136 //-/////////////////////////////////////////////////////////////////////////////////////////////////
 137 // senf::console::SimpleCommandOverload
 138
 139 prefix_ senf::console::SimpleCommandOverload::ptr
 140 senf::console::SimpleCommandOverload::create(Function fn)
 141 {
 142     return ptr(new SimpleCommandOverload(fn));
 143 }
 144
 145 prefix_ senf::console::SimpleCommandOverload &
 146 senf::console::SimpleCommandOverload::doc(std::string const & doc)
 147 {
 148     doc_ = doc;
 149     return *this;
 150 }
 151
 152 prefix_ senf::console::SimpleCommandOverload::SimpleCommandOverload(Function fn)
 153     : fn_ (fn)
 154 {}
 155
 156 //-/////////////////////////////////////////////////////////////////////////////////////////////////
 157 // senf::console::SimpleOverloadAttributor
 158
 159 prefix_ senf::console::SimpleOverloadAttributor::
 160 SimpleOverloadAttributor(SimpleCommandOverload::Function fn)
 161     : overload_ (SimpleCommandOverload::create(fn))
 162 {}
 163
 164 prefix_ senf::console::SimpleOverloadAttributor const &
 165 senf::console::SimpleOverloadAttributor::doc(std::string const & doc)
 166     const
 167 {
 168     doc_ = doc;
 169     return *this;
 170 }
 171
 172 prefix_ senf::console::SimpleOverloadAttributor const &
 173 senf::console::SimpleOverloadAttributor::shortdoc(std::string const & doc)
 174     const
 175 {
 176     shortdoc_ = doc;
 177     return *this;
 178 }
 179
 180 prefix_ senf::console::SimpleOverloadAttributor const &
 181 senf::console::SimpleOverloadAttributor::overloadDoc(std::string const & doc)
 182     const
 183 {
 184     overload_->doc(doc);
 185     return *this;
 186 }
 187
 188 prefix_ senf::console::OverloadedCommandNode &
 189 senf::console::SimpleOverloadAttributor::create(DirectoryNode & dir, std::string const & name)
 190     const
 191 {
 192     OverloadedCommandNode & node (OverloadedCommandNode::insertOverload(dir, name, overload_));
 193     if (doc_) node.doc(*doc_);
 194     if (shortdoc_) node.shortdoc(*shortdoc_);
 195     return node;
 196 }
 197
 198 //-/////////////////////////////////////////////////////////////////////////////////////////////////
 199 #undef prefix_
 200
 201 \f
 202 // Local Variables:
 203 // mode: c++
 204 // fill-column: 100
 205 // comment-column: 40
 206 // c-file-style: "senf"
 207 // indent-tabs-mode: nil
 208 // ispell-local-dictionary: "american"
 209 // compile-command: "scons -u test"
 210 // End: