X-Git-Url: http://g0dil.de/git?a=blobdiff_plain;f=senf%2FUtils%2FConsole%2FUtility.hh;h=7536f826ed9bfaeb45290f88acc9fbd829e383ff;hb=0003d55730b447329342161d12cf2ed23b63459e;hp=6ccc579112886c831a92e67ae530ad687d41f589;hpb=a30f975608bae2dcee151af15dc7f40602627615;p=senf.git diff --git a/senf/Utils/Console/Utility.hh b/senf/Utils/Console/Utility.hh index 6ccc579..7536f82 100644 --- a/senf/Utils/Console/Utility.hh +++ b/senf/Utils/Console/Utility.hh @@ -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 // -// 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 /** \file \brief Utility public header */ @@ -28,18 +33,76 @@ // Custom includes #include "Parse.hh" -#include "Traits.hh" //#include "Utility.mpp" -///////////////////////////////hh.p//////////////////////////////////////// +//-///////////////////////////////////////////////////////////////////////////////////////////////// + +/** \defgroup senf_console_utilities Special console utility types + + These types are provided by the %console library to support special argument or return value + formatting rules. + */ namespace senf { namespace console { + /** \brief Parse character value as single-char string + + This helper types is a wrapper around \a CharT which must be a character type. A value of + this type will be represented as a single character string, not as numeric value (the + default interpretation of char arguments in the console library). + + This wrapper is used via type conversion using \c boost::function to convert the + argument/return type \a CharT to CharAsString: + \code + char foo(char v) { return v; } + + senf::console::root().add( + "foo", fty::Command< CharAsString (CharAsString) >(&foo)); + \endcode + + \tparam CharT character type, one of \c char, \c signed \c char or \c unsigned \c char + + \ingroup senf_console_utilities + */ + template + struct CharAsString + { + CharAsString(); + CharAsString(CharT value_); + operator CharT () const; + CharT value; + }; + +#ifndef DOXYGEN + + template + struct ArgumentTraits< CharAsString > + { + typedef CharAsString type; + static bool const singleToken = true; + + static void parse(ParseCommandInfo::TokensRange const & tokens, CharAsString & out); + static std::string description(); + static std::string str(CharAsString value); + }; + + template + struct ReturnValueTraits< CharAsString > + { + typedef CharAsString type; + + static void format(CharAsString 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 */ template struct ValueRange @@ -74,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 @@ -86,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)>(&func)); + consoleDir.add("func", fty::Command)>(&func)); \endcode To use the FlagCollection class @@ -99,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 @@ -110,6 +173,8 @@ namespace console { console:/$ func Foo console:/$ func (Foo Boo) + + \ingroup senf_console_utilities */ template struct FlagCollection @@ -144,10 +209,10 @@ namespace console { }} -///////////////////////////////hh.e//////////////////////////////////////// +//-///////////////////////////////////////////////////////////////////////////////////////////////// //#include "Utility.cci" #include "Utility.ct" -//#include "Utility.cti" +#include "Utility.cti" #endif