Utils/Console/ParsedCommand.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 ParsedCommand inline non-template implementation */
  25
  26 #include "ParsedCommand.ih"
  27
  28 // Custom includes
  29
  30 #define prefix_ inline
  31 ///////////////////////////////cci.p///////////////////////////////////////
  32
  33 ///////////////////////////////////////////////////////////////////////////
  34 // senf::console::detail::ArgumentInfoBase
  35
  36 prefix_ senf::console::detail::ArgumentInfoBase::ArgumentInfoBase(std::string const & type_,
  37                                                                   bool singleToken_)
  38     : type (type_), name (), hasDefault (false), singleToken (singleToken_)
  39 {}
  40
  41 ///////////////////////////////////////////////////////////////////////////
  42 // senf::console::ParsedCommandOverloadBase
  43
  44 prefix_ senf::console::ParsedCommandOverloadBase::ParsedCommandOverloadBase()
  45 {}
  46
  47 prefix_ senf::console::detail::ArgumentInfoBase &
  48 senf::console::ParsedCommandOverloadBase::arg(unsigned n)
  49     const
  50 {
  51     BOOST_ASSERT(n < parameters_.size());
  52     return * parameters_[n];
  53 }
  54
  55 prefix_ void senf::console::ParsedCommandOverloadBase::doc(std::string const & d)
  56 {
  57     doc_ = d;
  58 }
  59
  60 ///////////////////////////////////////////////////////////////////////////
  61 // senf::console::ParsedCommandAttributorBase
  62
  63 prefix_ senf::console::OverloadedCommandNode &
  64 senf::console::ParsedCommandAttributorBase::node()
  65     const
  66 {
  67     return overload_.node();
  68 }
  69
  70 prefix_ senf::console::ParsedCommandAttributorBase::operator OverloadedCommandNode &()
  71     const
  72 {
  73     return node();
  74 }
  75
  76 prefix_ senf::console::ParsedCommandAttributorBase::
  77 ParsedCommandAttributorBase(ParsedCommandOverloadBase & overload, unsigned index)
  78     : overload_ (overload), index_ (index)
  79 {}
  80
  81 prefix_ senf::console::ParsedCommandOverloadBase &
  82 senf::console::ParsedCommandAttributorBase::overload()
  83     const
  84 {
  85     return overload_;
  86 }
  87
  88 prefix_ void senf::console::ParsedCommandAttributorBase::argName(std::string const & name)
  89     const
  90 {
  91     overload().arg(index_).name = name;
  92 }
  93
  94 prefix_ void senf::console::ParsedCommandAttributorBase::argDoc(std::string const & doc)
  95     const
  96 {
  97     overload().arg(index_).doc = doc;
  98 }
  99
 100 prefix_ void senf::console::ParsedCommandAttributorBase::typeName(std::string const & doc)
 101     const
 102 {
 103     overload().arg(index_).type = doc;
 104 }
 105
 106 prefix_ void senf::console::ParsedCommandAttributorBase::defaultDoc(std::string const & doc)
 107     const
 108 {
 109     overload().arg(index_).defaultDoc = doc;
 110 }
 111
 112 prefix_ void senf::console::ParsedCommandAttributorBase::overloadDoc(std::string const & doc)
 113     const
 114 {
 115     overload().doc(doc);
 116 }
 117
 118 prefix_ void senf::console::ParsedCommandAttributorBase::nodeDoc(std::string const & doc)
 119     const
 120 {
 121     node().doc(doc);
 122 }
 123
 124 prefix_ void senf::console::ParsedCommandAttributorBase::shortDoc(std::string const & doc)
 125     const
 126 {
 127     node().shortdoc(doc);
 128 }
 129
 130 ///////////////////////////////cci.e///////////////////////////////////////
 131 #undef prefix_
 132
 133 \f
 134 // Local Variables:
 135 // mode: c++
 136 // fill-column: 100
 137 // comment-column: 40
 138 // c-file-style: "senf"
 139 // indent-tabs-mode: nil
 140 // ispell-local-dictionary: "american"
 141 // compile-command: "scons -u test"
 142 // End: