switch to new MPL based Fraunhofer FOKUS Public License
[senf.git] / senf / Utils / Console / OverloadedCommand.cci
index c891fda..3942ef3 100644 (file)
@@ -1,24 +1,29 @@
 // $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 inline non-template implementation */
@@ -28,9 +33,9 @@
 // Custom includes
 
 #define prefix_ inline
-///////////////////////////////cci.p///////////////////////////////////////
+//-/////////////////////////////////////////////////////////////////////////////////////////////////
 
-///////////////////////////////////////////////////////////////////////////
+//-/////////////////////////////////////////////////////////////////////////////////////////////////
 // senf::console::OverloadedCommandNode
 
 prefix_ senf::console::OverloadedCommandNode::ptr senf::console::OverloadedCommandNode::create()
@@ -66,7 +71,7 @@ senf::console::OverloadedCommandNode::shortdoc(std::string const & doc)
 prefix_ unsigned
 senf::console::OverloadedCommandNode::overloadIndex(CommandOverload const & overload)
 {
-    return find(overloads_.begin(), overloads_.end(), CommandOverload::cptr(&overload)) 
+    return find(overloads_.begin(), overloads_.end(), CommandOverload::cptr(&overload))
         - overloads_.begin() + 1;
 }
 
@@ -80,7 +85,7 @@ senf::console::OverloadedCommandNode::overloads()
 prefix_ senf::console::OverloadedCommandNode::OverloadedCommandNode()
 {}
 
-///////////////////////////////////////////////////////////////////////////
+//-/////////////////////////////////////////////////////////////////////////////////////////////////
 // senf::console::CommandOverload
 
 prefix_ senf::console::CommandOverload::~CommandOverload()
@@ -119,7 +124,7 @@ prefix_ std::string senf::console::CommandOverload::doc()
 prefix_ senf::console::OverloadedCommandNode & senf::console::CommandOverload::node()
     const
 {
-    SENF_ASSERT( node_ );
+    SENF_ASSERT( node_, "Overload not added to any node yet" );
     return *node_;
 }
 
@@ -133,7 +138,7 @@ prefix_ senf::console::CommandOverload::CommandOverload()
     : node_(0)
 {}
 
-///////////////////////////////////////////////////////////////////////////
+//-/////////////////////////////////////////////////////////////////////////////////////////////////
 // senf::console::SimpleCommandOverload
 
 prefix_ senf::console::SimpleCommandOverload::ptr
@@ -153,7 +158,49 @@ prefix_ senf::console::SimpleCommandOverload::SimpleCommandOverload(Function fn)
     : fn_ (fn)
 {}
 
-///////////////////////////////cci.e///////////////////////////////////////
+//-/////////////////////////////////////////////////////////////////////////////////////////////////
+// senf::console::SimpleOverloadAttributor
+
+prefix_ senf::console::SimpleOverloadAttributor::
+SimpleOverloadAttributor(SimpleCommandOverload::Function fn)
+    : overload_ (SimpleCommandOverload::create(fn))
+{}
+
+prefix_ senf::console::SimpleOverloadAttributor const &
+senf::console::SimpleOverloadAttributor::doc(std::string const & doc)
+    const
+{
+    doc_ = doc;
+    return *this;
+}
+
+prefix_ senf::console::SimpleOverloadAttributor const &
+senf::console::SimpleOverloadAttributor::shortdoc(std::string const & doc)
+    const
+{
+    shortdoc_ = doc;
+    return *this;
+}
+
+prefix_ senf::console::SimpleOverloadAttributor const &
+senf::console::SimpleOverloadAttributor::overloadDoc(std::string const & doc)
+    const
+{
+    overload_->doc(doc);
+    return *this;
+}
+
+prefix_ senf::console::OverloadedCommandNode &
+senf::console::SimpleOverloadAttributor::create(DirectoryNode & dir, std::string const & name)
+    const
+{
+    OverloadedCommandNode & node (OverloadedCommandNode::insertOverload(dir, name, overload_));
+    if (doc_) node.doc(*doc_);
+    if (shortdoc_) node.shortdoc(*shortdoc_);
+    return node;
+}
+
+//-/////////////////////////////////////////////////////////////////////////////////////////////////
 #undef prefix_
 
 \f