Node.cci

Go to the documentation of this file.

//
// Copyright (c) 2020 Fraunhofer Institute for Applied Information Technology (FIT)
//                    Network Research Group (NET)
//                    Schloss Birlinghoven, 53754 Sankt Augustin, GERMANY
//                    Contact: support@wiback.org
//
// This file is part of the SENF code tree.
// It is licensed under the 3-clause BSD License (aka New BSD License).
// See LICENSE.txt in the top level directory for details or visit
// https://opensource.org/licenses/BSD-3-Clause
//


/** \file
    \brief Node inline non-template implementation */

// Custom includes

#define prefix_ inline
//-/////////////////////////////////////////////////////////////////////////////////////////////////

//-/////////////////////////////////////////////////////////////////////////////////////////////////
// senf::console::GenericNode

prefix_ senf::console::GenericNode::ptr senf::console::GenericNode::thisptr()
{
    return shared_from_this();
}

prefix_ senf::console::GenericNode::cptr senf::console::GenericNode::thisptr()
    const
{
    return shared_from_this();
}

prefix_ senf::console::GenericNode::~GenericNode()
{}

prefix_ std::string const & senf::console::GenericNode::name()
    const
{
    return name_;
}

prefix_ senf::console::GenericNode::GenericNode()
    : parent_ (nullptr)
{}

prefix_ void senf::console::GenericNode::name(std::string const & name)
{
    name_ = name;
}

prefix_ boost::shared_ptr<senf::console::DirectoryNode> senf::console::GenericNode::parent()
    const
{
    return boost::static_pointer_cast<DirectoryNode>(
        parent_ ? parent_->shared_from_this() : ptr() );
}

prefix_ senf::console::GenericNode::ptr senf::console::GenericNode::unlink()
{
    if (parent_)
        return parent()->remove(name());
    else
        return thisptr();
}

prefix_ void senf::console::GenericNode::help(std::ostream & output)
    const
{
    v_help(output);
}

prefix_ std::string senf::console::GenericNode::shorthelp()
    const
{
    return v_shorthelp();
}

prefix_ bool senf::console::GenericNode::operator==(GenericNode & other)
    const
{
    return this == & other;
}

prefix_ bool senf::console::GenericNode::operator!=(GenericNode & other)
    const
{
    return this != & other;
}

prefix_ bool senf::console::GenericNode::isDirectory()
    const
{
    return dynamic_cast<DirectoryNode const *>(this);
}

prefix_ bool senf::console::GenericNode::isLink()
    const
{
    return dynamic_cast<LinkNode const *>(this);
}

prefix_ bool senf::console::GenericNode::isCommand()
    const
{
    return dynamic_cast<CommandNode const *>(this);
}

prefix_ senf::console::GenericNode const & senf::console::GenericNode::followLink()
    const
{
    return isLink()
        ? dynamic_cast<LinkNode const *>(this)->follow()
        : *this;
}

prefix_ senf::console::GenericNode & senf::console::GenericNode::followLink()
{
    return isLink()
        ? dynamic_cast<LinkNode *>(this)->follow()
        : *this;
}

//-/////////////////////////////////////////////////////////////////////////////////////////////////
// senf::console::LinkNode

prefix_ senf::console::GenericNode & senf::console::LinkNode::follow()
    const
{
    return *node_;
}

prefix_ senf::console::LinkNode::ptr senf::console::LinkNode::create(GenericNode & node)
{
    GenericNode::ptr p (node.thisptr());
    while ( p->isLink() )
        p = dynamic_cast<LinkNode&>(*p).follow().thisptr();
    return ptr(new LinkNode(*p));
}

prefix_ senf::console::LinkNode::LinkNode(GenericNode & node)
    : node_ (node.thisptr())
{}

//-/////////////////////////////////////////////////////////////////////////////////////////////////
// senf::console::DirectoryNode

prefix_ senf::console::DirectoryNode::ptr senf::console::DirectoryNode::create()
{
    return ptr(new DirectoryNode());
}

prefix_ bool senf::console::DirectoryNode::hasChild(std::string const & name)
    const
{
    return children_.find(name) != children_.end();
}

prefix_ senf::console::GenericNode &
senf::console::DirectoryNode::get(std::string const & name)
    const
{
    return getLink(name).followLink();
}

prefix_ senf::console::DirectoryNode &
senf::console::DirectoryNode::getDirectory(std::string const & name)
    const
{
    try {
        return dynamic_cast<DirectoryNode&>(get(name));
    }
    SENF_WRAP_EXC(std::bad_cast)
}

prefix_ senf::console::DirectoryNode &
senf::console::DirectoryNode::operator[](std::string const & name)
    const
{
    return getDirectory(name);
}

prefix_ senf::console::CommandNode &
senf::console::DirectoryNode::getCommand(std::string const & name)
    const
{
    try {
        return dynamic_cast<CommandNode&>(get(name));
    }
    SENF_WRAP_EXC(std::bad_cast)
}

prefix_ senf::console::CommandNode &
senf::console::DirectoryNode::operator()(std::string const & name)
    const
{
    return getCommand(name);
}

prefix_ senf::console::DirectoryNode::ChildrenRange senf::console::DirectoryNode::children()
    const
{
    return boost::make_iterator_range(children_.begin(), children_.end());
}

prefix_ senf::console::DirectoryNode::ChildrenRange
senf::console::DirectoryNode::completions(std::string const & s)
    const
{
    return boost::make_iterator_range(children_.lower_bound(s),
                                      children_.lower_bound(s + "\xff"));
}

prefix_ senf::console::DirectoryNode::DirectoryNode()
{}

prefix_ senf::console::DirectoryNode &
senf::console::DirectoryNode::doc(std::string const & doc)
{
    doc_ = doc;
    return *this;
}

prefix_ senf::console::DirectoryNode &
senf::console::DirectoryNode::shortdoc(std::string const & doc)
{
    shortdoc_ = doc;
    return *this;
}

prefix_ senf::console::DirectoryNode::ptr senf::console::DirectoryNode::thisptr()
{
    return boost::static_pointer_cast<DirectoryNode>(shared_from_this());
}

prefix_ senf::console::DirectoryNode::cptr senf::console::DirectoryNode::thisptr()
    const
{
    return boost::static_pointer_cast<DirectoryNode const>(shared_from_this());
}

//-/////////////////////////////////////////////////////////////////////////////////////////////////
// senf::console::CommandNode

prefix_ senf::console::CommandNode::ptr senf::console::CommandNode::thisptr()
{
    return boost::static_pointer_cast<CommandNode>(shared_from_this());
}

prefix_ senf::console::CommandNode::cptr senf::console::CommandNode::thisptr()
    const
{
    return boost::static_pointer_cast<CommandNode const>(shared_from_this());
}

prefix_ senf::console::CommandNode::CommandNode()
{}

prefix_ void senf::console::CommandNode::execute(std::ostream & output,
                                                 ParseCommandInfo const & command)
    const
{
    boost::any rv;
    execute(rv, output, command);
}

prefix_ void senf::console::CommandNode::execute(boost::any & rv, std::ostream & output,
                                                 ParseCommandInfo const & command)
    const
{
    rv = boost::any();
    v_execute(rv, output, command);
}

prefix_ void senf::console::CommandNode::operator()(std::ostream & output,
                                                    ParseCommandInfo const & command)
    const
{
    execute(output, command);
}

prefix_ void senf::console::CommandNode::operator()(boost::any & rv, std::ostream & output,
                                                    ParseCommandInfo const & command)
    const
{
    execute(rv, output, command);
}

//-/////////////////////////////////////////////////////////////////////////////////////////////////
// senf::console::SimpleCommandNode

prefix_ senf::console::SimpleCommandNode::SimpleCommandNode(Function const & fn)
    : fn_ (fn)
{}

prefix_ senf::console::SimpleCommandNode::ptr
senf::console::SimpleCommandNode::create(Function const & fn)
{
    return ptr(new SimpleCommandNode(fn));
}

prefix_ senf::console::SimpleCommandNode &
senf::console::SimpleCommandNode::doc(std::string const & doc)
{
    doc_ = doc;
    return *this;
}

prefix_ senf::console::SimpleCommandNode &
senf::console::SimpleCommandNode::shortdoc(std::string const & doc)
{
    shortdoc_ = doc;
    return *this;
}

prefix_ senf::console::SimpleCommandNode::ptr senf::console::SimpleCommandNode::thisptr()
{
    return boost::static_pointer_cast<SimpleCommandNode>(shared_from_this());
}

prefix_ senf::console::SimpleCommandNode::cptr senf::console::SimpleCommandNode::thisptr()
    const
{
    return boost::static_pointer_cast<SimpleCommandNode const>(shared_from_this());
}

//-/////////////////////////////////////////////////////////////////////////////////////////////////

prefix_ senf::console::DirectoryNode & senf::console::provideDirectory(DirectoryNode & dir,
                                                                       std::string const & name)
{
    return dir.hasChild(name) ? dir.getDirectory(name) : dir.add(name, factory::Directory());
}


//-/////////////////////////////////////////////////////////////////////////////////////////////////
// senf::console::factory::SimpleCommand

prefix_ senf::console::factory::SimpleCommand::SimpleCommand(SimpleCommandNode::Function fn)
    : node_ (SimpleCommandNode::create(fn))
{}

prefix_ senf::console::SimpleCommandNode &
senf::console::factory::SimpleCommand::create(DirectoryNode & dir, std::string const & name)
    const
{
    return dir.add(name, node_);
}

prefix_ senf::console::factory::SimpleCommand const &
senf::console::factory::SimpleCommand::doc(std::string const & doc)
    const
{
    node_->doc(doc);
    return *this;
}

prefix_ senf::console::factory::SimpleCommand const &
senf::console::factory::SimpleCommand::shortdoc(std::string const & doc)
    const
{
    node_->shortdoc(doc);
    return *this;
}

//-/////////////////////////////////////////////////////////////////////////////////////////////////
// senf::console::factory::Directory

prefix_ senf::console::factory::Directory::Directory()
    : node_ (DirectoryNode::create())
{}

prefix_ senf::console::DirectoryNode &
senf::console::factory::Directory::create(DirectoryNode & dir, std::string const & name)
    const
{
    return dir.add(name, node_);
}

prefix_ senf::console::factory::Directory const &
senf::console::factory::Directory::doc(std::string const & doc)
    const
{
    node_->doc(doc);
    return *this;
}

prefix_ senf::console::factory::Directory const &
senf::console::factory::Directory::shortdoc(std::string const & doc)
    const
{
    node_->shortdoc(doc);
    return *this;
}

//-/////////////////////////////////////////////////////////////////////////////////////////////////
// senf::console::factory::Link

prefix_ senf::console::factory::Link::Link(GenericNode & target)
    : node_ (LinkNode::create(target))
{}

prefix_ senf::console::LinkNode & senf::console::factory::Link::create(DirectoryNode & dir,
                                                                       std::string const & name)
    const
{
    return dir.add(name, node_);
}

//-/////////////////////////////////////////////////////////////////////////////////////////////////
#undef prefix_


// Local Variables:
// mode: c++
// fill-column: 100
// comment-column: 40
// c-file-style: "senf"
// indent-tabs-mode: nil
// ispell-local-dictionary: "american"
// compile-command: "scons -u test"
// End: