senf/Utils/Console/Node.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 Node inline non-template implementation */
  25
  26 #include "Node.ih"
  27
  28 // Custom includes
  29 #include <senf/Utils/senfassert.hh>
  30
  31 #define prefix_ inline
  32 ///////////////////////////////cci.p///////////////////////////////////////
  33
  34 ///////////////////////////////////////////////////////////////////////////
  35 // senf::console::GenericNode
  36
  37 prefix_ senf::console::GenericNode::ptr senf::console::GenericNode::thisptr()
  38 {
  39     return shared_from_this();
  40 }
  41
  42 prefix_ senf::console::GenericNode::cptr senf::console::GenericNode::thisptr()
  43     const
  44 {
  45     return shared_from_this();
  46 }
  47
  48 prefix_ senf::console::GenericNode::~GenericNode()
  49 {}
  50
  51 prefix_ std::string const & senf::console::GenericNode::name()
  52     const
  53 {
  54     return name_;
  55 }
  56
  57 prefix_ senf::console::GenericNode::GenericNode()
  58     : parent_ (0)
  59 {}
  60
  61 prefix_ void senf::console::GenericNode::name(std::string const & name)
  62 {
  63     name_ = name;
  64 }
  65
  66 prefix_ boost::shared_ptr<senf::console::DirectoryNode> senf::console::GenericNode::parent()
  67     const
  68 {
  69     return boost::static_pointer_cast<DirectoryNode>(
  70         parent_ ? parent_->shared_from_this() : ptr() );
  71 }
  72
  73 prefix_ senf::console::GenericNode::ptr senf::console::GenericNode::unlink()
  74 {
  75     if (parent_)
  76         return parent()->remove(name());
  77     else
  78         return thisptr();
  79 }
  80
  81 prefix_ void senf::console::GenericNode::help(std::ostream & output)
  82     const
  83 {
  84     v_help(output);
  85 }
  86
  87 prefix_ std::string senf::console::GenericNode::shorthelp()
  88     const
  89 {
  90     return v_shorthelp();
  91 }
  92
  93 prefix_ bool senf::console::GenericNode::operator==(GenericNode & other)
  94     const
  95 {
  96     return this == & other;
  97 }
  98
  99 prefix_ bool senf::console::GenericNode::operator!=(GenericNode & other)
 100     const
 101 {
 102     return this != & other;
 103 }
 104
 105 prefix_ bool senf::console::GenericNode::isDirectory()
 106     const
 107 {
 108     return dynamic_cast<DirectoryNode const *>(this);
 109 }
 110
 111 prefix_ bool senf::console::GenericNode::isLink()
 112     const
 113 {
 114     return dynamic_cast<LinkNode const *>(this);
 115 }
 116
 117 prefix_ bool senf::console::GenericNode::isCommand()
 118     const
 119 {
 120     return dynamic_cast<CommandNode const *>(this);
 121 }
 122
 123 prefix_ senf::console::GenericNode const & senf::console::GenericNode::followLink()
 124     const
 125 {
 126     return isLink()
 127         ? dynamic_cast<LinkNode const *>(this)->follow()
 128         : *this;
 129 }
 130
 131 prefix_ senf::console::GenericNode & senf::console::GenericNode::followLink()
 132 {
 133     return isLink()
 134         ? dynamic_cast<LinkNode *>(this)->follow()
 135         : *this;
 136 }
 137
 138 ///////////////////////////////////////////////////////////////////////////
 139 // senf::console::LinkNode
 140
 141 prefix_ senf::console::GenericNode & senf::console::LinkNode::follow()
 142     const
 143 {
 144     return *node_;
 145 }
 146
 147 prefix_ senf::console::LinkNode::ptr senf::console::LinkNode::create(GenericNode & node)
 148 {
 149     GenericNode::ptr p (node.thisptr());
 150     while ( p->isLink() )
 151         p = dynamic_cast<LinkNode&>(*p).follow().thisptr();
 152     return ptr(new LinkNode(*p));
 153 }
 154
 155 prefix_ senf::console::LinkNode::LinkNode(GenericNode & node)
 156     : node_ (node.thisptr())
 157 {}
 158
 159 ///////////////////////////////////////////////////////////////////////////
 160 // senf::console::DirectoryNode
 161
 162 prefix_ senf::console::DirectoryNode::ptr senf::console::DirectoryNode::create()
 163 {
 164     return ptr(new DirectoryNode());
 165 }
 166
 167 prefix_ bool senf::console::DirectoryNode::hasChild(std::string const & name)
 168     const
 169 {
 170     ChildMap::const_iterator i (children_.find(name));
 171     return i != children_.end();
 172 }
 173
 174 prefix_ senf::console::GenericNode &
 175 senf::console::DirectoryNode::get(std::string const & name)
 176     const
 177 {
 178     return getLink(name).followLink();
 179 }
 180
 181 prefix_ senf::console::DirectoryNode &
 182 senf::console::DirectoryNode::getDirectory(std::string const & name)
 183     const
 184 {
 185     try {
 186         return dynamic_cast<DirectoryNode&>(get(name));
 187     }
 188     SENF_WRAP_EXC(std::bad_cast)
 189 }
 190
 191 prefix_ senf::console::DirectoryNode &
 192 senf::console::DirectoryNode::operator[](std::string const & name)
 193     const
 194 {
 195     return getDirectory(name);
 196 }
 197
 198 prefix_ senf::console::CommandNode &
 199 senf::console::DirectoryNode::getCommand(std::string const & name)
 200     const
 201 {
 202     try {
 203         return dynamic_cast<CommandNode&>(get(name));
 204     }
 205     SENF_WRAP_EXC(std::bad_cast)
 206 }
 207
 208 prefix_ senf::console::CommandNode &
 209 senf::console::DirectoryNode::operator()(std::string const & name)
 210     const
 211 {
 212     return getCommand(name);
 213 }
 214
 215 prefix_ senf::console::DirectoryNode::ChildrenRange senf::console::DirectoryNode::children()
 216     const
 217 {
 218     return boost::make_iterator_range(children_.begin(), children_.end());
 219 }
 220
 221 prefix_ senf::console::DirectoryNode::ChildrenRange
 222 senf::console::DirectoryNode::completions(std::string const & s)
 223     const
 224 {
 225     return boost::make_iterator_range(children_.lower_bound(s),
 226                                       children_.lower_bound(s + "\xff"));
 227 }
 228
 229 prefix_ senf::console::DirectoryNode::DirectoryNode()
 230 {}
 231
 232 prefix_ senf::console::DirectoryNode &
 233 senf::console::DirectoryNode::doc(std::string const & doc)
 234 {
 235     doc_ = doc;
 236     return *this;
 237 }
 238
 239 prefix_ senf::console::DirectoryNode &
 240 senf::console::DirectoryNode::shortdoc(std::string const & doc)
 241 {
 242     shortdoc_ = doc;
 243     return *this;
 244 }
 245
 246 prefix_ senf::console::DirectoryNode::ptr senf::console::DirectoryNode::thisptr()
 247 {
 248     return boost::static_pointer_cast<DirectoryNode>(shared_from_this());
 249 }
 250
 251 prefix_ senf::console::DirectoryNode::cptr senf::console::DirectoryNode::thisptr()
 252     const
 253 {
 254     return boost::static_pointer_cast<DirectoryNode const>(shared_from_this());
 255 }
 256
 257 ///////////////////////////////////////////////////////////////////////////
 258 // senf::console::detail::NodeTraverser
 259 #ifndef DOXYGEN
 260
 261 prefix_ senf::console::detail::NodeTraverser::NodeTraverser(DirectoryNode & root,
 262                                                             DirectoryNode & dir,
 263                                                             bool autocomplete)
 264     : root_ (root), dir_ (dir.thisptr()), autocomplete_ (autocomplete), init_ (false)
 265 {}
 266
 267 #endif
 268
 269 ///////////////////////////////////////////////////////////////////////////
 270 // senf::console::CommandNode
 271
 272 prefix_ senf::console::CommandNode::ptr senf::console::CommandNode::thisptr()
 273 {
 274     return boost::static_pointer_cast<CommandNode>(shared_from_this());
 275 }
 276
 277 prefix_ senf::console::CommandNode::cptr senf::console::CommandNode::thisptr()
 278     const
 279 {
 280     return boost::static_pointer_cast<CommandNode const>(shared_from_this());
 281 }
 282
 283 prefix_ senf::console::CommandNode::CommandNode()
 284 {}
 285
 286 prefix_ void senf::console::CommandNode::execute(std::ostream & output,
 287                                                  ParseCommandInfo const & command)
 288     const
 289 {
 290     boost::any rv;
 291     execute(rv, output, command);
 292 }
 293
 294 prefix_ void senf::console::CommandNode::execute(boost::any & rv, std::ostream & output,
 295                                                  ParseCommandInfo const & command)
 296     const
 297 {
 298     rv = boost::any();
 299     v_execute(rv, output, command);
 300 }
 301
 302 prefix_ void senf::console::CommandNode::operator()(std::ostream & output,
 303                                                     ParseCommandInfo const & command)
 304     const
 305 {
 306     execute(output, command);
 307 }
 308
 309 prefix_ void senf::console::CommandNode::operator()(boost::any & rv, std::ostream & output,
 310                                                     ParseCommandInfo const & command)
 311     const
 312 {
 313     execute(rv, output, command);
 314 }
 315
 316 ///////////////////////////////////////////////////////////////////////////
 317 // senf::console::SimpleCommandNode
 318
 319 prefix_ senf::console::SimpleCommandNode::SimpleCommandNode(Function const & fn)
 320     : fn_ (fn)
 321 {}
 322
 323 prefix_ senf::console::SimpleCommandNode::ptr
 324 senf::console::SimpleCommandNode::create(Function const & fn)
 325 {
 326     return ptr(new SimpleCommandNode(fn));
 327 }
 328
 329 prefix_ senf::console::SimpleCommandNode &
 330 senf::console::SimpleCommandNode::doc(std::string const & doc)
 331 {
 332     doc_ = doc;
 333     return *this;
 334 }
 335
 336 prefix_ senf::console::SimpleCommandNode &
 337 senf::console::SimpleCommandNode::shortdoc(std::string const & doc)
 338 {
 339     shortdoc_ = doc;
 340     return *this;
 341 }
 342
 343 prefix_ senf::console::SimpleCommandNode::ptr senf::console::SimpleCommandNode::thisptr()
 344 {
 345     return boost::static_pointer_cast<SimpleCommandNode>(shared_from_this());
 346 }
 347
 348 prefix_ senf::console::SimpleCommandNode::cptr senf::console::SimpleCommandNode::thisptr()
 349     const
 350 {
 351     return boost::static_pointer_cast<SimpleCommandNode const>(shared_from_this());
 352 }
 353
 354 ///////////////////////////////////////////////////////////////////////////
 355
 356 prefix_ senf::console::DirectoryNode & senf::console::provideDirectory(DirectoryNode & dir,
 357                                                                        std::string const & name)
 358 {
 359     return dir.hasChild(name) ? dir.getDirectory(name) : dir.add(name, factory::Directory());
 360 }
 361
 362
 363 ///////////////////////////////////////////////////////////////////////////
 364 // senf::console::factory::SimpleCommand
 365
 366 prefix_ senf::console::factory::SimpleCommand::SimpleCommand(SimpleCommandNode::Function fn)
 367     : node_ (SimpleCommandNode::create(fn))
 368 {}
 369
 370 prefix_ senf::console::SimpleCommandNode &
 371 senf::console::factory::SimpleCommand::create(DirectoryNode & dir, std::string const & name)
 372     const
 373 {
 374     return dir.add(name, node_);
 375 }
 376
 377 prefix_ senf::console::factory::SimpleCommand const &
 378 senf::console::factory::SimpleCommand::doc(std::string const & doc)
 379     const
 380 {
 381     node_->doc(doc);
 382     return *this;
 383 }
 384
 385 prefix_ senf::console::factory::SimpleCommand const &
 386 senf::console::factory::SimpleCommand::shortdoc(std::string const & doc)
 387     const
 388 {
 389     node_->shortdoc(doc);
 390     return *this;
 391 }
 392
 393 ///////////////////////////////////////////////////////////////////////////
 394 // senf::console::factory::Directory
 395
 396 prefix_ senf::console::factory::Directory::Directory()
 397     : node_ (DirectoryNode::create())
 398 {}
 399
 400 prefix_ senf::console::DirectoryNode &
 401 senf::console::factory::Directory::create(DirectoryNode & dir, std::string const & name)
 402     const
 403 {
 404     return dir.add(name, node_);
 405 }
 406
 407 prefix_ senf::console::factory::Directory const &
 408 senf::console::factory::Directory::doc(std::string const & doc)
 409     const
 410 {
 411     node_->doc(doc);
 412     return *this;
 413 }
 414
 415 prefix_ senf::console::factory::Directory const &
 416 senf::console::factory::Directory::shortdoc(std::string const & doc)
 417     const
 418 {
 419     node_->shortdoc(doc);
 420     return *this;
 421 }
 422
 423 ///////////////////////////////////////////////////////////////////////////
 424 // senf::console::factory::Link
 425
 426 prefix_ senf::console::factory::Link::Link(GenericNode & target)
 427     : node_ (LinkNode::create(target))
 428 {}
 429
 430 prefix_ senf::console::LinkNode & senf::console::factory::Link::create(DirectoryNode & dir,
 431                                                                        std::string const & name)
 432     const
 433 {
 434     return dir.add(name, node_);
 435 }
 436
 437 ///////////////////////////////cci.e///////////////////////////////////////
 438 #undef prefix_
 439
 440 \f
 441 // Local Variables:
 442 // mode: c++
 443 // fill-column: 100
 444 // comment-column: 40
 445 // c-file-style: "senf"
 446 // indent-tabs-mode: nil
 447 // ispell-local-dictionary: "american"
 448 // compile-command: "scons -u test"
 449 // End: