X-Git-Url: http://g0dil.de/git?a=blobdiff_plain;f=senf%2FUtils%2FConsole%2FTraits.hh;h=a4785851d2a28198a37c6b38f5b09f40826e9dc5;hb=ab7ff164ab5ae711ec09ce2b24228510f1ffdcff;hp=e60faed7dec4c065dfd4b82abea6009f62b72765;hpb=26610f603ebdd465307b9621f532c1fe19fd5571;p=senf.git diff --git a/senf/Utils/Console/Traits.hh b/senf/Utils/Console/Traits.hh index e60faed..a478585 100644 --- a/senf/Utils/Console/Traits.hh +++ b/senf/Utils/Console/Traits.hh @@ -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 // -// 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 Traits public header */ @@ -32,57 +37,26 @@ #include #include #include "Parse.hh" -#include "Node.hh" #include "Traits.ih" //#include "Traits.mpp" -///////////////////////////////hh.p//////////////////////////////////////// +//-///////////////////////////////////////////////////////////////////////////////////////////////// namespace senf { namespace console { - /** \brief Customize return value formating - - ReturnValueTraits provides return value formatting. The default implementation provided here - will forward the call directly to senf_console_format_value(). The default implementation of - that function will write the \a value to \a os using standard iostream formatting. - - To customize this behavior for some type, either provide an implementation of - senf_console_format_value() in the types namespace or provide a specialization of - ReturnValueTraits. - - The output should \e not end in a newline since one is added automatically. - */ - template - struct ReturnValueTraits - { - typedef Type type; - - static void format(Type const & value, std::ostream & os); - ///< Write \a value to \a os - }; - - /** \brief Return value formatter - - \see ReturnValuetraits - - \related ReturnValueTraits - */ - template - void senf_console_format_value(Type const & value, std::ostream & os); - /** \brief Customize argument parsing - + ArgumentTraits provides argument parsing, Additionally, this class provides a way to get a string-description of a type and to convert a value back into it's string representation used to display default values. - - The default implementation provided here + + The default implementation provided here \li will use senf_console_parse_argument() to parse a value. This functions default implementation uses \c boost::lexical_cast and thereby \c iostreams to convert an argument consisting of a single input token into the required type. \li will name types by returning the last component of the fully scoped name (e.g. \c - "string" for \c std::string). + "string" for \c std::string). \li Will format values (for default value display) by forwarding the value to the ReturnValueTraits of that type. @@ -95,7 +69,7 @@ namespace console { { typedef Type type; - static bool const singleToken = + static bool const singleToken = boost::is_same< typeof(senf_console_parse_argument( *static_cast(0), *static_cast(0))), @@ -130,61 +104,71 @@ namespace console { template bool senf_console_parse_argument(ParseCommandInfo::TokensRange const & tokens, Type & out); - /** \brief Parse token range - This helper will invoke the correct ArgumentTraits::parse function to parse the input tokens - into the passed in variable. + /** \brief Customize return value formating - \see ArgumentTraits + ReturnValueTraits provides return value formatting. The default implementation provided here + will forward the call directly to senf_console_format_value(). The default implementation of + that function will write the \a value to \a os using standard iostream formatting. + + To customize this behavior for some type, either provide an implementation of + senf_console_format_value() in the types namespace or provide a specialization of + ReturnValueTraits. + + The output should \e not end in a newline since one is added automatically. */ template - void parse(ParseCommandInfo::TokensRange const & tokens, Type & out); + struct ReturnValueTraits + { + typedef Type type; + static void format(Type const & value, std::ostream & os); + ///< Write \a value to \a os + }; + + /** \brief Return value formatter + + \see ReturnValuetraits + + \related ReturnValueTraits + */ template - void format(Type const & value, std::ostream & os); + void senf_console_format_value(Type const & value, std::ostream & os); -#ifndef DOXYGEN - // Parse bool: true/false, yes/no, enabled/disabled, 0/1 - template <> - struct ArgumentTraits - { - typedef bool type; - static bool const singleToken = true; + /** \brief Parse token range - static void parse(ParseCommandInfo::TokensRange const & tokens, bool & out); - static std::string description(); - static std::string str(bool value); - }; + This helper will invoke the correct ArgumentTraits::parse function to parse the input tokens + into the passed in variable. - template <> - struct ReturnValueTraits - { - typedef bool type; + \see ArgumentTraits + */ + template + void parse(ParseCommandInfo::TokensRange const & tokens, Type & out); - static void format(bool value, std::ostream & os); - }; + /** \brief Format value -#endif + This helper will call the correct ArgumentTraits::str function to format \a value - /** \brief Format boolean value as \c true / \c false */ - void formatTrueFalse(bool value, std::ostream & os); + \see ArgumentTraits + */ + template + std::string str(Type const & value); - /** \brief Format boolean value as \c yes / \c no */ - void formatYesNo(bool value, std::ostream & os); + /** \brief Format return value - /** \brief Format boolean value as \c enabled / \c disabled */ - void formatEnabledDisabled(bool value, std::ostream & os); - - /** \brief Format boolean value as \c on / \c off */ - void formatOnOff(bool value, std::ostream & os); + This helper will invoke the correct ReturnValueTraits::format function to write \a value + into the \a out stream. + + \see ReturnValueTraits + */ + template + void format(Type const & value, std::ostream & os); - /** \brief Format boolean value as \c 1 / \c 0 */ - void formatOneZero(bool value, std::ostream & os); /** \brief Register enum type for argument parsing - Enum types need to be registered explicitly to support parsing. + Enum types need to be registered explicitly to support parsing. \code enum Foo { Foo1, Foo2 }; SENF_CONSOLE_REGISTER_ENUM( Foo, (Foo1)(Foo2) ); @@ -192,7 +176,17 @@ namespace console { This macro will register an enum type and it's enumerators defined at namespace scope. See \ref SENF_CONSOLE_REGISTER_ENUM_MEMBER to register a member enum type. - \note All enumerator values must be unique ignoring case. + By default, the keys used to represent the enumerator values in the console are identical to + the enumerator names in C++ (In the example above \c Foo1 and \c Foo2). You may however + override this default key using the + 'key("key", enumerator)' modifier: + \code + enum Foo { Foo1, Foo2 }; + SENF_CONSOLE_REGISTER_ENUM( Foo, (key("1", Foo1), Foo2) ); + \endcode + This will register the first enumerator \c Foo1 under the name '\c 1'. + + \note All enumerator keys must be unique ignoring case. The enum parser will accept any unique initial substring ignoring case as valid enum value. @@ -203,7 +197,7 @@ namespace console { /** \brief Register enum type for argument parsing - Enum types need to be registered explicitly to support parsing. + Enum types need to be registered explicitly to support parsing. \code class SomeClass { @@ -219,76 +213,57 @@ namespace console { # define SENF_CONSOLE_REGISTER_ENUM_MEMBER(Class, Type, Values) \ SENF_CONSOLE_REGISTER_ENUM_(Class::, Type, Values) - /** \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. + /** \brief Format boolean value as \c true / \c false */ + void formatTrueFalse(bool value, std::ostream & os); - \code - // Function taking a flags argument - void func(unsigned flags); - - // Enum containing all the possible flag values - enum MyFlags { Foo = 1, - Bar = 2, - 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)); - \endcode + /** \brief Format boolean value as \c yes / \c no */ + void formatYesNo(bool value, std::ostream & os); + + /** \brief Format boolean value as \c enabled / \c disabled */ + void formatEnabledDisabled(bool value, std::ostream & os); + + /** \brief Format boolean value as \c on / \c off */ + void formatOnOff(bool value, std::ostream & os); + + /** \brief Format boolean value as \c 1 / \c 0 */ + void formatOneZero(bool value, std::ostream & os); - To use the FlagCollection class - \li you need a function which takes a bit-mask of flags as argument - \li you define and register an enum with all possible flag values - \li you register the function with a FlagCollection argument type using \c boost::function - for the conversion. This is also possible for return values. - - 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. - - After registering this function, you can call it with a collection of flags as argument - - 
-        console:/$ help func
-        Usage:
-            func arg11:MyFlags
-        console:/$ func Foo
-        console:/$ func (Foo Boo)
-
- */ - template - struct FlagCollection - { - operator unsigned long() const { return value; } - FlagCollection() : value (0) {} - FlagCollection(unsigned long value_) : value (value_) {} - FlagCollection(Enum value_) : value (value_) {} - unsigned long value; - }; - template - struct ArgumentTraits< FlagCollection > +#ifndef DOXYGEN + + // Parse bool: true/false, yes/no, enabled/disabled, 0/1 + template <> + struct ArgumentTraits { - typedef FlagCollection type; - static bool const singleToken = false; - static void parse(ParseCommandInfo::TokensRange const & tokens, type & out); + typedef bool type; + static bool const singleToken = true; + + static void parse(ParseCommandInfo::TokensRange const & tokens, bool & out); static std::string description(); - static std::string str(type const & value); + static std::string str(bool value); }; - template - struct ReturnValueTraits< FlagCollection > + template <> + struct ReturnValueTraits { - typedef FlagCollection type; - static void format(type const & value, std::ostream & os); + typedef bool type; + + static void format(bool value, std::ostream & os); }; + template <> struct ArgumentTraits : public detail::CharArgumentTraits {}; + template <> struct ReturnValueTraits : public detail::CharReturnValueTraits {}; + template <> struct ArgumentTraits : public detail::CharArgumentTraits {}; + template <> struct ReturnValueTraits : public detail::CharReturnValueTraits {}; + template <> struct ArgumentTraits : public detail::CharArgumentTraits {}; + template <> struct ReturnValueTraits : public detail::CharReturnValueTraits {}; + +#endif + }} -///////////////////////////////hh.e//////////////////////////////////////// +//-///////////////////////////////////////////////////////////////////////////////////////////////// #include "Traits.cci" #include "Traits.ct" #include "Traits.cti"