X-Git-Url: http://g0dil.de/git?a=blobdiff_plain;f=senf%2FUtils%2FConsole%2FProgramOptions.hh;h=f5e1c9db0f2843bd15458a0e313cb04744f683bd;hb=0003d55730b447329342161d12cf2ed23b63459e;hp=2f985f3494952f3bee2703efb6948a0619c6f8d3;hpb=601d1f509f5bb24df167a4dd5a20da67a0af9af8;p=senf.git diff --git a/senf/Utils/Console/ProgramOptions.hh b/senf/Utils/Console/ProgramOptions.hh index 2f985f3..f5e1c9d 100644 --- a/senf/Utils/Console/ProgramOptions.hh +++ b/senf/Utils/Console/ProgramOptions.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 ProgramOptions public header */ @@ -32,7 +37,7 @@ //#include "ProgramOptions.mpp" #include "ProgramOptions.ih" -///////////////////////////////hh.p//////////////////////////////////////// +//-///////////////////////////////////////////////////////////////////////////////////////////////// namespace senf { namespace console { @@ -54,7 +59,7 @@ namespace console { // Parse only options under the directory of some object. The object 'ob' // must have been registered somewhere in the node tree cf.parse(ob.dir); - + // Parse rest of the config file cf.parse(); \endcode @@ -68,19 +73,19 @@ namespace console { : public detail::BundleMixin { public: - /////////////////////////////////////////////////////////////////////////// + //-//////////////////////////////////////////////////////////////////////// ///\name Structors and default members - ///@{ - + //\{ + ProgramOptions(int argc, char const ** argv, DirectoryNode & root = root()); ///< Create ProgramOptions parser for given options /**< The given argc/argv values are those passed to main by the operating system. Especially argv[0] is \e not an option and is ignored. */ - ///@} - /////////////////////////////////////////////////////////////////////////// - + //\} + //-//////////////////////////////////////////////////////////////////////// + template ProgramOptions & nonOptions(Container & container); ///< Set container to add non-option arguments to @@ -96,7 +101,7 @@ namespace console { line. This argument will be appended (with an additional '=') to \a longOpt. If \a withArg is \c false (the default), \a longOpt may optional contain an - argument. + argument. \param[in] letter option letter \param[in] longOpt long option alias \param[in] withArg \c true, if the option should take @@ -108,7 +113,7 @@ namespace console { /** \brief Parse command line options - The command line otpions in \a argc / \a argv will be parsed, interpreting all node's + The command line options in \a argc / \a argv will be parsed, interpreting all node's relative to \a root as root node. \related ProgramOptions @@ -117,7 +122,7 @@ namespace console { /** \brief ConfigBundle source reading command line options - This cosntructor is used to create aconfig source parsing the given command line options to + This constructor is used to create a config source parsing the given command line options to add to a ConfigBundle. \related ProgramOptions @@ -125,7 +130,7 @@ namespace console { detail::ProgramOptionsSource::ptr OptionsConfig(int argc, char const ** argv); }} -///////////////////////////////hh.e//////////////////////////////////////// +//-///////////////////////////////////////////////////////////////////////////////////////////////// #include "ProgramOptions.cci" //#include "ProgramOptions.ct" #include "ProgramOptions.cti"