senf/Utils/Console/OverloadedCommand.cci

   1 // $Id$
   2 //
   3 // Copyright (C) 2008
   4 // Fraunhofer Institute for Open Communication Systems (FOKUS)
   5 //
   6 // The contents of this file are subject to the Fraunhofer FOKUS Public License
   7 // Version 1.0 (the "License"); you may not use this file except in compliance
   8 // with the License. You may obtain a copy of the License at
   9 // http://senf.berlios.de/license.html
  10 //
  11 // The Fraunhofer FOKUS Public License Version 1.0 is based on,
  12 // but modifies the Mozilla Public License Version 1.1.
  13 // See the full license text for the amendments.
  14 //
  15 // Software distributed under the License is distributed on an "AS IS" basis,
  16 // WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  17 // for the specific language governing rights and limitations under the License.
  18 //
  19 // The Original Code is Fraunhofer FOKUS code.
  20 //
  21 // The Initial Developer of the Original Code is Fraunhofer-Gesellschaft e.V.
  22 // (registered association), Hansastraße 27 c, 80686 Munich, Germany.
  23 // All Rights Reserved.
  24 //
  25 // Contributor(s):
  26 //   Stefan Bund <g0dil@berlios.de>
  27
  28 /** \file
  29     \brief OverloadedCommand inline non-template implementation */
  30
  31 //#include "OverloadedCommand.ih"
  32
  33 // Custom includes
  34
  35 #define prefix_ inline
  36 //-/////////////////////////////////////////////////////////////////////////////////////////////////
  37
  38 //-/////////////////////////////////////////////////////////////////////////////////////////////////
  39 // senf::console::OverloadedCommandNode
  40
  41 prefix_ senf::console::OverloadedCommandNode::ptr senf::console::OverloadedCommandNode::create()
  42 {
  43     return ptr(new OverloadedCommandNode());
  44 }
  45
  46 prefix_ senf::console::OverloadedCommandNode::ptr senf::console::OverloadedCommandNode::thisptr()
  47 {
  48     return boost::static_pointer_cast<OverloadedCommandNode>(shared_from_this());
  49 }
  50
  51 prefix_ senf::console::OverloadedCommandNode::cptr senf::console::OverloadedCommandNode::thisptr()
  52     const
  53 {
  54     return boost::static_pointer_cast<OverloadedCommandNode const>(shared_from_this());
  55 }
  56
  57 prefix_ senf::console::OverloadedCommandNode &
  58 senf::console::OverloadedCommandNode::doc(std::string const & doc)
  59 {
  60     doc_ = doc;
  61     return *this;
  62 }
  63
  64 prefix_ senf::console::OverloadedCommandNode &
  65 senf::console::OverloadedCommandNode::shortdoc(std::string const & doc)
  66 {
  67     shortdoc_ = doc;
  68     return *this;
  69 }
  70
  71 prefix_ unsigned
  72 senf::console::OverloadedCommandNode::overloadIndex(CommandOverload const & overload)
  73 {
  74     return find(overloads_.begin(), overloads_.end(), CommandOverload::cptr(&overload))
  75         - overloads_.begin() + 1;
  76 }
  77
  78 prefix_ senf::console::OverloadedCommandNode::OverloadsRange
  79 senf::console::OverloadedCommandNode::overloads()
  80     const
  81 {
  82     return boost::make_iterator_range(overloads_.begin(), overloads_.end());
  83 }
  84
  85 prefix_ senf::console::OverloadedCommandNode::OverloadedCommandNode()
  86 {}
  87
  88 //-/////////////////////////////////////////////////////////////////////////////////////////////////
  89 // senf::console::CommandOverload
  90
  91 prefix_ senf::console::CommandOverload::~CommandOverload()
  92 {}
  93
  94 prefix_ void senf::console::CommandOverload::execute(boost::any & rv, std::ostream & os,
  95                                                      ParseCommandInfo const & command)
  96 {
  97     v_execute(rv, os, command);
  98 }
  99
 100 prefix_ void senf::console::CommandOverload::operator()(boost::any & rv, std::ostream & os,
 101                                                         ParseCommandInfo const & command)
 102 {
 103     execute(rv, os, command);
 104 }
 105
 106 prefix_ unsigned senf::console::CommandOverload::numArguments()
 107     const
 108 {
 109     return v_numArguments();
 110 }
 111
 112 prefix_ void senf::console::CommandOverload::argumentDoc(unsigned index, ArgumentDoc & doc)
 113     const
 114 {
 115     return v_argumentDoc(index,doc);
 116 }
 117
 118 prefix_ std::string senf::console::CommandOverload::doc()
 119     const
 120 {
 121     return v_doc();
 122 }
 123
 124 prefix_ senf::console::OverloadedCommandNode & senf::console::CommandOverload::node()
 125     const
 126 {
 127     SENF_ASSERT( node_, "Overload not added to any node yet" );
 128     return *node_;
 129 }
 130
 131 prefix_ unsigned senf::console::CommandOverload::overloadIndex()
 132     const
 133 {
 134     return node().overloadIndex(*this);
 135 }
 136
 137 prefix_ senf::console::CommandOverload::CommandOverload()
 138     : node_(0)
 139 {}
 140
 141 //-/////////////////////////////////////////////////////////////////////////////////////////////////
 142 // senf::console::SimpleCommandOverload
 143
 144 prefix_ senf::console::SimpleCommandOverload::ptr
 145 senf::console::SimpleCommandOverload::create(Function fn)
 146 {
 147     return ptr(new SimpleCommandOverload(fn));
 148 }
 149
 150 prefix_ senf::console::SimpleCommandOverload &
 151 senf::console::SimpleCommandOverload::doc(std::string const & doc)
 152 {
 153     doc_ = doc;
 154     return *this;
 155 }
 156
 157 prefix_ senf::console::SimpleCommandOverload::SimpleCommandOverload(Function fn)
 158     : fn_ (fn)
 159 {}
 160
 161 //-/////////////////////////////////////////////////////////////////////////////////////////////////
 162 // senf::console::SimpleOverloadAttributor
 163
 164 prefix_ senf::console::SimpleOverloadAttributor::
 165 SimpleOverloadAttributor(SimpleCommandOverload::Function fn)
 166     : overload_ (SimpleCommandOverload::create(fn))
 167 {}
 168
 169 prefix_ senf::console::SimpleOverloadAttributor const &
 170 senf::console::SimpleOverloadAttributor::doc(std::string const & doc)
 171     const
 172 {
 173     doc_ = doc;
 174     return *this;
 175 }
 176
 177 prefix_ senf::console::SimpleOverloadAttributor const &
 178 senf::console::SimpleOverloadAttributor::shortdoc(std::string const & doc)
 179     const
 180 {
 181     shortdoc_ = doc;
 182     return *this;
 183 }
 184
 185 prefix_ senf::console::SimpleOverloadAttributor const &
 186 senf::console::SimpleOverloadAttributor::overloadDoc(std::string const & doc)
 187     const
 188 {
 189     overload_->doc(doc);
 190     return *this;
 191 }
 192
 193 prefix_ senf::console::OverloadedCommandNode &
 194 senf::console::SimpleOverloadAttributor::create(DirectoryNode & dir, std::string const & name)
 195     const
 196 {
 197     OverloadedCommandNode & node (OverloadedCommandNode::insertOverload(dir, name, overload_));
 198     if (doc_) node.doc(*doc_);
 199     if (shortdoc_) node.shortdoc(*shortdoc_);
 200     return node;
 201 }
 202
 203 //-/////////////////////////////////////////////////////////////////////////////////////////////////
 204 #undef prefix_
 205
 206 \f
 207 // Local Variables:
 208 // mode: c++
 209 // fill-column: 100
 210 // comment-column: 40
 211 // c-file-style: "senf"
 212 // indent-tabs-mode: nil
 213 // ispell-local-dictionary: "american"
 214 // compile-command: "scons -u test"
 215 // End: