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