// $Id$
//
-// Copyright (C) 2008
+// Copyright (C) 2008
// Fraunhofer Institute for Open Communication Systems (FOKUS)
-// Competence Center NETwork research (NET), St. Augustin, GERMANY
-// Stefan Bund <g0dil@berlios.de>
//
-// This program is free software; you can redistribute it and/or modify
-// it under the terms of the GNU General Public License as published by
-// the Free Software Foundation; either version 2 of the License, or
-// (at your option) any later version.
+// The contents of this file are subject to the Fraunhofer FOKUS Public License
+// Version 1.0 (the "License"); you may not use this file except in compliance
+// with the License. You may obtain a copy of the License at
+// http://senf.berlios.de/license.html
//
-// This program is distributed in the hope that it will be useful,
-// but WITHOUT ANY WARRANTY; without even the implied warranty of
-// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
-// GNU General Public License for more details.
+// The Fraunhofer FOKUS Public License Version 1.0 is based on,
+// but modifies the Mozilla Public License Version 1.1.
+// See the full license text for the amendments.
//
-// You should have received a copy of the GNU General Public License
-// along with this program; if not, write to the
-// Free Software Foundation, Inc.,
-// 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+// Software distributed under the License is distributed on an "AS IS" basis,
+// WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
+// for the specific language governing rights and limitations under the License.
+//
+// The Original Code is Fraunhofer FOKUS code.
+//
+// The Initial Developer of the Original Code is Fraunhofer-Gesellschaft e.V.
+// (registered association), Hansastraße 27 c, 80686 Munich, Germany.
+// All Rights Reserved.
+//
+// Contributor(s):
+// Stefan Bund <g0dil@berlios.de>
/** \file
\brief OverloadedCommand public header */
#include <boost/intrusive_ptr.hpp>
#include <boost/range/iterator_range.hpp>
#include <senf/Utils/intrusive_refcount.hh>
+#include <boost/optional.hpp>
//#include "OverloadedCommand.mpp"
-///////////////////////////////hh.p////////////////////////////////////////
+//-/////////////////////////////////////////////////////////////////////////////////////////////////
namespace senf {
namespace console {
: public senf::intrusive_refcount
{
public:
- ///////////////////////////////////////////////////////////////////////////
+ //-////////////////////////////////////////////////////////////////////////
// Types
typedef boost::intrusive_ptr<CommandOverload> ptr;
typedef boost::intrusive_ptr<CommandOverload const> cptr;
- ///////////////////////////////////////////////////////////////////////////
+ //-////////////////////////////////////////////////////////////////////////
virtual ~CommandOverload();
void execute(boost::any & rv, std::ostream & os, ParseCommandInfo const & command);
///< Call the overload
/**< If the \a arguments are not acceptable for this
- overload, a SyntaxErrorException must be thrown.
+ overload, a SyntaxErrorException must be thrown.
Same as operator()() */
void operator()(boost::any & rv, std::ostream & os, ParseCommandInfo const & command);
///< Call the overload
/**< If the \a arguments are not acceptable for this
- overload, a SyntaxErrorException must be thrown.
+ overload, a SyntaxErrorException must be thrown.
Same as execute() */
-
+
unsigned numArguments() const; ///< Number of arguments this overload takes
void argumentDoc(unsigned index, ArgumentDoc & doc) const;
///< Get information on argument \a index
\param[out] doc Argument documentation */
std::string doc() const; ///< Get overload documentation
-
+
OverloadedCommandNode & node() const; ///< Access owning node
/**< \pre The command \e must have been added to an
OverloadedCommandNode. */
'SyntaxErrorException' exception is thrown.
This works by first adding an OverloadedCommandNode to the directory in question and then
- adding commands to that node. Commands are derived from CommandOverload.
+ adding commands to that node. Commands are derived from CommandOverload.
\code
senf::console::DirectoryNode & dir (...);
senf::console::OverloadedCommandNode & cmd (
typedef std::vector<CommandOverload::ptr> Overloads;
public:
- ///////////////////////////////////////////////////////////////////////////
+ //-////////////////////////////////////////////////////////////////////////
// Types
typedef boost::shared_ptr<OverloadedCommandNode> ptr;
typedef boost::iterator_range<Overloads::const_iterator> OverloadsRange;
- ///////////////////////////////////////////////////////////////////////////
+ //-////////////////////////////////////////////////////////////////////////
///\name Structors and default members
- ///@{
+ //\{
static ptr create();
- ///@}
- ///////////////////////////////////////////////////////////////////////////
-
+ //\}
+ //-////////////////////////////////////////////////////////////////////////
+
template <class Command>
Command & add(boost::intrusive_ptr<Command> overload); ///< Add an additional overload
ptr thisptr();
cptr thisptr() const;
+ static OverloadedCommandNode & insertOverload(DirectoryNode & dir, std::string const & name,
+ CommandOverload::ptr overload);
+
private:
OverloadedCommandNode();
/** \brief Basic command overload
This is an implementation of CommandOverload which allows to call an arbitrary callback with
- the correct signature
+ the correct signature
(<tt>void (std::ostream &, senf::console::ParseCommandInfo const &)</tt>)
*/
class SimpleCommandOverload
: public CommandOverload
{
public:
- ///////////////////////////////////////////////////////////////////////////
+ //-////////////////////////////////////////////////////////////////////////
// Types
typedef boost::intrusive_ptr<SimpleCommandOverload> ptr;
typedef boost::function<void (std::ostream &, ParseCommandInfo const &)> Function;
- ///////////////////////////////////////////////////////////////////////////
+ //-////////////////////////////////////////////////////////////////////////
///\name Structors and default members
- ///@{
+ //\{
static SimpleCommandOverload::ptr create(Function fn);
///< Create new SimpleCommandOverload
/**< \param[in] fn callback to call */
- ///@}
- ///////////////////////////////////////////////////////////////////////////
+ //\}
+ //-////////////////////////////////////////////////////////////////////////
SimpleCommandOverload & doc(std::string const & doc);
///< Assign overload specific documentation
std::string doc_;
};
+ class SimpleOverloadAttributor
+ : public detail::NodeFactory
+ {
+ public:
+ typedef OverloadedCommandNode node_type;
+ typedef OverloadedCommandNode & result_type;
+
+ explicit SimpleOverloadAttributor(SimpleCommandOverload::Function fn);
+
+ SimpleOverloadAttributor const & doc(std::string const & doc) const;
+ SimpleOverloadAttributor const & shortdoc(std::string const & doc) const;
+ SimpleOverloadAttributor const & overloadDoc(std::string const & doc) const;
+
+ OverloadedCommandNode & create(DirectoryNode & dir, std::string const & name) const;
+
+ private:
+ SimpleCommandOverload::ptr overload_;
+ mutable boost::optional<std::string> doc_;
+ mutable boost::optional<std::string> shortdoc_;
+ };
+
}}
-///////////////////////////////hh.e////////////////////////////////////////
+//-/////////////////////////////////////////////////////////////////////////////////////////////////
#include "OverloadedCommand.cci"
//#include "OverloadedCommand.ct"
#include "OverloadedCommand.cti"
projects / senf.git / blobdiff