Files
calyp/lib/PlaYUVerProgramOptions.h
T

351 lines
8.7 KiB
C++

/* The copyright in this software is being made available under the BSD
* License, included below. This software may be subject to other third party
* and contributor rights, including patent rights, and no such rights are
* granted under this license.
*
* Copyright (c) 2010-2014, ITU/ISO/IEC
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* * Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
* * Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
* * Neither the name of the ITU/ISO/IEC nor the names of its contributors may
* be used to endorse or promote products derived from this software without
* specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS
* BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
* THE POSSIBILITY OF SUCH DAMAGE.
*/
/**
* \file ProgramOptions.h
* \brief Input args handler
*/
#ifndef __PROGRAMOPTIONS_H__
#define __PROGRAMOPTIONS_H__
#include <iostream>
#include <sstream>
#include <string>
#include <list>
#include <map>
#include <vector>
#include "PlaYUVerDefs.h"
namespace plaYUVer
{
struct Options;
struct ParseFailure: public std::exception
{
ParseFailure( std::string arg0, std::string val0 ) throw() :
arg( arg0 ),
val( val0 )
{
}
~ParseFailure() throw()
{
}
std::string arg;
std::string val;
const char* what() const throw()
{
return "Option Parse Failure";
}
};
/** OptionBase: Virtual base class for storing information relating to a
* specific option This base class describes common elements. Type specific
* information should be stored in a derived class. */
struct OptionBase
{
OptionBase( const std::string& name, const std::string& desc ) :
arg_count( 0 ),
opt_string( name ),
opt_desc( desc )
{
}
virtual ~OptionBase()
{
}
/* parse argument arg, to obtain a value for the option */
virtual void parse( const std::string& arg ) = 0;
/* set the argument to the default value */
//virtual void setDefault() = 0;
int count()
{
return arg_count;
}
Bool isBinary()
{
return is_binary;
}
int arg_count;
std::string opt_string;
std::string opt_desc;
Bool is_binary;
};
/** Type specific option storage */
struct FlagOpt: public OptionBase
{
FlagOpt( const std::string& name, Bool default_val, const std::string& desc ) :
OptionBase( name, desc ),
opt_storage( false ),
opt_default_val( default_val )
{
is_binary = true;
}
void parse( const std::string& arg )
{
opt_storage = true;
arg_count++;
}
void setDefault()
{
opt_storage = opt_default_val;
}
Bool opt_storage;
Bool opt_default_val;
};
/** Type specific option storage */
template<typename T>
struct StandardOpt: public OptionBase
{
StandardOpt( const std::string& name, T& storage, const std::string& desc ) :
OptionBase( name, desc ),
opt_storage( storage )
{
is_binary = false;
}
void parse( const std::string& arg );
// void setDefault()
// {
// opt_storage = opt_default_val;
// }
T& opt_storage;
};
/* Generic parsing */
template<typename T>
inline void StandardOpt<T>::parse( const std::string& arg )
{
std::istringstream arg_ss( arg, std::istringstream::in );
arg_ss.exceptions( std::ios::failbit );
try
{
arg_ss >> opt_storage;
}
catch( ... )
{
throw ParseFailure( opt_string, arg );
}
arg_count++;
}
/* string parsing is specialized -- copy the whole string, not just the
* first word */
template<>
inline void StandardOpt<std::string>::parse( const std::string& arg )
{
opt_storage = arg;
arg_count++;
}
/* string parsing is specialized -- copy the whole string, not just the
* first word */
template<>
inline void StandardOpt<std::vector<std::string> >::parse( const std::string& arg )
{
opt_storage.push_back( arg );
arg_count++;
}
/** Option class for argument handling using a user provided function */
struct OptionFunc: public OptionBase
{
typedef Void (Func)( Options&, const std::string& );
OptionFunc( const std::string& name, Options& parent_, Func *func_, const std::string& desc ) :
OptionBase( name, desc ),
parent( parent_ ),
func( func_ )
{
is_binary = false;
}
void parse( const std::string& arg )
{
func( parent, arg );
arg_count++;
}
void setDefault()
{
return;
}
private:
Options& parent;
void (*func)( Options&, const std::string& );
};
class OptionSpecific;
class Options
{
public:
struct Option
{
Option() :
opt( 0 )
{
}
;
~Option()
{
if( opt )
delete opt;
}
std::list<std::string> opt_long;
std::list<std::string> opt_short;
OptionBase* opt;
};
typedef std::list<Option*> OptionsList;
Options( const std::string& name = "" );
~Options();
std::list<const char*> scanArgv( unsigned argc, const char* argv[] );
Void scanArgs( std::vector<std::string> args_array);
Void doHelp( std::ostream& out, unsigned columns = 80 );
OptionSpecific addOptions();
Void setDefaults();
OptionBase* operator[]( const std::string& optName );
OptionBase* getOption( const std::string& optName );
OptionsList& getOptionList()
{
return opt_list;
}
void addOption( OptionBase *opt );
private:
typedef std::map<std::string, OptionsList> OptionMap;
OptionMap opt_long_map;
OptionMap opt_short_map;
OptionsList opt_list;
std::string m_cOptionGroupName;
Bool m_bAllowUnkonw;
Bool storePair( Bool allow_long, Bool allow_short, const std::string& name, const std::string& value );
Bool storePair( const std::string& name, const std::string& value );
UInt parseLONG( unsigned argc, const char* argv[] );
UInt parseLONG( std::string arg );
unsigned parseSHORT( unsigned argc, const char* argv[] );
};
/* Class with templated overloaded operator(), for use by Options::addOptions() */
class OptionSpecific
{
public:
OptionSpecific( Options& parent_ ) :
parent( parent_ )
{
}
/**
* Add option described by name to the parent Options list,
* with storage for the option's value
* with default_val as the default value
* with desc as an optional help description
*/
template<typename T>
OptionSpecific&
operator()( const std::string& name, T& storage, const std::string& desc )
{
parent.addOption( new StandardOpt<T>( name, storage, desc ) );
return *this;
}
/**
* Add option described by name to the parent Options list,
* with storage for the option's value
* with default_val as the default value
* with desc as an optional help description
*/
OptionSpecific&
operator()( const std::string& name, const std::string& desc )
{
parent.addOption( new FlagOpt( name, false, desc ) );
return *this;
}
/**
* Add option described by name to the parent Options list,
* with storage for the option's value
* with default_val as the default value
* with desc as an optional help description
*/
OptionSpecific&
operator()( const std::string& name, Bool default_val, const std::string& desc )
{
parent.addOption( new FlagOpt( name, default_val, desc ) );
return *this;
}
/**
* Add option described by name to the parent Options list,
* with desc as an optional help description
* instead of storing the value somewhere, a function of type
* OptionFunc::Func is called. It is upto this function to correctly
* handle evaluating the option's value.
*/
OptionSpecific&
operator()( const std::string& name, OptionFunc::Func *func, const std::string& desc )
{
parent.addOption( new OptionFunc( name, parent, func, desc ) );
return *this;
}
private:
Options& parent;
};
} // NAMESPACE
#endif // __PROGRAMOPTIONS_H__