switch to new MPL based Fraunhofer FOKUS Public License
[senf.git] / senf / Utils / Console / Utility.hh
index 79f95d4..7536f82 100644 (file)
@@ -1,24 +1,29 @@
 // $Id$
 //
-// Copyright (C) 2009 
+// Copyright (C) 2009
 // 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 Utility public header */
 
 // Custom includes
 #include "Parse.hh"
-#include "Traits.hh"
 
 //#include "Utility.mpp"
-///////////////////////////////hh.p////////////////////////////////////////
+//-/////////////////////////////////////////////////////////////////////////////////////////////////
 
 /** \defgroup senf_console_utilities Special console utility types
 
@@ -52,9 +56,9 @@ namespace console {
         argument/return type \a CharT  to CharAsString<CharT>:
         \code
         char foo(char v) { return v; }
-        
+
         senf::console::root().add(
-            "foo", boost::function< CharAsString<char> (CharAsString<char>) >(&foo));
+            "foo", fty::Command< CharAsString<char> (CharAsString<char>) >(&foo));
         \endcode
 
         \tparam CharT character type, one of \c char, \c signed \c char or \c unsigned \c char
@@ -68,7 +72,7 @@ namespace console {
         CharAsString(CharT value_);
         operator CharT () const;
         CharT value;
-    };    
+    };
 
 #ifndef DOXYGEN
 
@@ -77,7 +81,7 @@ namespace console {
     {
         typedef CharAsString<CharT> type;
         static bool const singleToken = true;
-        
+
         static void parse(ParseCommandInfo::TokensRange const & tokens, CharAsString<CharT> & out);
         static std::string description();
         static std::string str(CharAsString<CharT> value);
@@ -87,16 +91,16 @@ namespace console {
     struct ReturnValueTraits< CharAsString<CharT> >
     {
         typedef CharAsString<CharT> type;
-        
+
         static void format(CharAsString<CharT> value, std::ostream & os);
     };
 
 #endif
 
     /** \brief Value range
-        
+
         A value range may be represented in the console either by a single value (setting both \a
-        low and \a high to the same value) or as a lower and upper bound seperated by a colon.
+        low and \a high to the same value) or as a lower and upper bound separated by a colon.
 
         \ingroup senf_console_utilities
      */
@@ -133,7 +137,7 @@ namespace console {
     /** \brief Bit-mask flag argument type
 
         senf::console::FlagCollection supplies a special argument type for use in registering
-        console commands. This argument type is used to represent a bit-mask of single flags. 
+        console commands. This argument type is used to represent a bit-mask of single flags.
 
         \code
         // Function taking a flags argument
@@ -145,9 +149,9 @@ namespace console {
                      Baz = 4,
                      Doo = 8 };
         SENF_CONSOLE_REGISTER_ENUM(MyFlags, (Foo)(Bar)(Baz)(Boo));
-        
+
         // Register the function with a FlagCollection argument type
-        consoleDir.add("func", boost::function<void (FlagCollection<MyFlags>)>(&func));
+        consoleDir.add("func", fty::Command<void (FlagCollection<MyFlags>)>(&func));
         \endcode
 
         To use the FlagCollection class
@@ -158,7 +162,7 @@ namespace console {
 
         The nice thing is, that \c boot::function supports compatible argument types and does
         automatic type conversion. Since a FlagCollection is convertible to and from unsigned long,
-        this conversion will work. 
+        this conversion will work.
 
         After registering this function, you can call it with a collection of flags as argument
 
@@ -205,7 +209,7 @@ namespace console {
 
 }}
 
-///////////////////////////////hh.e////////////////////////////////////////
+//-/////////////////////////////////////////////////////////////////////////////////////////////////
 //#include "Utility.cci"
 #include "Utility.ct"
 #include "Utility.cti"