X-Git-Url: http://g0dil.de/git?a=blobdiff_plain;f=senf%2FUtils%2FConsole%2FTraits.hh;h=a4785851d2a28198a37c6b38f5b09f40826e9dc5;hb=ab7ff164ab5ae711ec09ce2b24228510f1ffdcff;hp=a42893cecd73700f7f4dbb66615d51c6a5ba5032;hpb=0e83cd2ee1ebc409cf73d8774b01bf01f3df22f4;p=senf.git diff --git a/senf/Utils/Console/Traits.hh b/senf/Utils/Console/Traits.hh index a42893c..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,27 +37,26 @@ #include #include #include "Parse.hh" -#include "Node.hh" #include "Traits.ih" //#include "Traits.mpp" -///////////////////////////////hh.p//////////////////////////////////////// +//-///////////////////////////////////////////////////////////////////////////////////////////////// namespace senf { namespace console { /** \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. @@ -65,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))), @@ -164,7 +168,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 enum Foo { Foo1, Foo2 }; SENF_CONSOLE_REGISTER_ENUM( Foo, (Foo1)(Foo2) ); @@ -172,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. @@ -183,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 { @@ -208,7 +222,7 @@ namespace console { /** \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); @@ -243,13 +257,13 @@ namespace console { 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 ReturnValueTraits : public detail::CharReturnValueTraits {}; #endif }} -///////////////////////////////hh.e//////////////////////////////////////// +//-///////////////////////////////////////////////////////////////////////////////////////////////// #include "Traits.cci" #include "Traits.ct" #include "Traits.cti"