3rd-party/catch2
1
0
Fork 0
mirror of https://github.com/catchorg/Catch2.git synced 2024-11-22 21:36:11 +01:00
Code Issues Packages Projects Releases Wiki Activity

Added support for binding to methods and generating usage strings.

Browse Source 
Also renamed namespace to Clara
This commit is contained in:
Phil Nash 2013-05-01 19:01:48 +01:00
parent 46846a47f3
commit ed45ceb786
1 changed files with 124 additions and 28 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

152
projects/SelfTest/CmdLineTests.cpp
View File

@ -10,8 +10,11 @@
#endif #endif
#include "catch.hpp" #include "catch.hpp"
#include "catch_text.h"
namespace Catch { namespace Clara {
using namespace Catch;
class ArgData { class ArgData {
public: public:
@ -43,6 +46,12 @@ public:
bool operator < ( ArgData const& _other ) const { bool operator < ( ArgData const& _other ) const {
return m_weight < _other.m_weight; return m_weight < _other.m_weight;
} }
friend std::ostream& operator << ( std::ostream& os, ArgData const& _arg ) {
os << _arg.m_prefix << "<" << _arg.m_name << ">" << _arg.m_postfix;
return os;
}
protected: protected:
std::string m_prefix; std::string m_prefix;
std::string m_postfix; std::string m_postfix;
@ -91,6 +100,32 @@ public:
} }
return false; return false;
} }
std::string usage() const {
std::ostringstream oss;
oss << *this;
return oss.str();
}
friend std::ostream& operator << ( std::ostream& os, Opt const& _opt ) {
if( !_opt.m_shortOpt.empty() )
os << "-" << _opt.m_shortOpt;
if( !_opt.m_longOpt.empty() )
os << ", ";
if( !_opt.m_longOpt.empty() )
os << "--" << _opt.m_longOpt;
if( !_opt.m_args.empty() ) {
os << " : ";
typename std::vector<Arg>::const_iterator
it = _opt.m_args.begin(),
itEnd = _opt.m_args.end();
while( it != itEnd ) {
os << static_cast<ArgData const&>( *it );
if( ++it!=itEnd )
os << "|";
}
}
return os;
}
private: private:
@ -99,14 +134,30 @@ private:
virtual bool parseInto( std::string const& _arg, T& _config ) const = 0; virtual bool parseInto( std::string const& _arg, T& _config ) const = 0;
}; };
template<typename M> template<typename F>
struct Field : IField { struct Field;
Field( M const& _member ) : member( _member ) {}
template<typename C, typename M>
struct Field<M C::*> : IField {
Field( M C::* _member ) : member( _member ) {}
bool parseInto( std::string const& _arg, T& _config ) const { bool parseInto( std::string const& _arg, T& _config ) const {
return convertInto( _arg, _config.*member ); return convertInto( _arg, _config.*member );
} }
M member; M C::* member;
}; };
template<typename C, typename M>
struct Field<void (C::*)( M )> : IField {
Field( void (C::*_method)( M ) ) : method( _method ) {}
bool parseInto( std::string const& _arg, T& _config ) const {
M value;
if( !convertInto( _arg, value ) )
return false;
( _config.*method )( value );
return true;
}
void (C::*method)( M );
};
class Arg : public ArgData { class Arg : public ArgData {
public: public:
Arg() : m_field( NULL ) {} Arg() : m_field( NULL ) {}
@ -119,7 +170,7 @@ private:
if( !m_field->parseInto( strip( _arg ), _config ) ) if( !m_field->parseInto( strip( _arg ), _config ) )
throw std::domain_error( "'" + _arg + "' was not valid for <" + m_name + ">" ); throw std::domain_error( "'" + _arg + "' was not valid for <" + m_name + ">" );
} }
private: private:
Ptr<IField> m_field; Ptr<IField> m_field;
}; };
@ -203,6 +254,30 @@ public:
} }
} }
friend std::ostream& operator <<( std::ostream& os, CommandLineParser const& _parser ) {
typename std::vector<Opt<T> >::const_iterator it, itEnd = _parser.m_allOptionParsers.end();
std::size_t maxWidth = 0;
for(it = _parser.m_allOptionParsers.begin(); it != itEnd; ++it )
maxWidth = (std::max)( it->usage().size(), maxWidth );
for(it = _parser.m_allOptionParsers.begin(); it != itEnd; ++it ) {
Text usage( it->usage(), TextAttributes().setWidth( maxWidth ) );
// !TBD handle longer usage strings
Text synopsis( it->synopsis(), TextAttributes().setWidth( CATCH_CONFIG_CONSOLE_WIDTH - maxWidth -3 ) );
for( std::size_t i = 0; i < std::max( usage.size(), synopsis.size() ); ++i ) {
std::string usageCol = i < usage.size() ? usage[i] : "";
std::cout << usageCol;
if( i < synopsis.size() && !synopsis[i].empty() )
std::cout << std::string( 2 + maxWidth - usageCol.size(), ' ' )
<< synopsis[i];
std::cout << "\n";
}
}
return os;
}
private: private:
template<typename U> template<typename U>
friend class CommandLineParser; friend class CommandLineParser;
@ -217,11 +292,18 @@ private:
} // end namespace Catch } // end namespace Catch
struct TestOpt { struct TestOpt {
TestOpt() : number( 0 ) {} TestOpt() : number( 0 ), index( 0 ) {}
std::string fileName; std::string fileName;
std::string streamName; std::string streamName;
int number; int number;
int index;
void setValidIndex( int i ) {
if( i < 0 || i > 10 )
throw std::domain_error( "index must be between 0 and 10" );
index = i;
}
}; };
struct TestOpt2 { struct TestOpt2 {
@ -230,7 +312,7 @@ struct TestOpt2 {
TEST_CASE( "Arg" ) { TEST_CASE( "Arg" ) {
SECTION( "pre and post" ) { SECTION( "pre and post" ) {
Catch::ArgData preAndPost( "prefix<arg>postfix" ); Clara::ArgData preAndPost( "prefix<arg>postfix" );
CHECK( preAndPost.prefix() == "prefix" ); CHECK( preAndPost.prefix() == "prefix" );
CHECK( preAndPost.postfix() == "postfix" ); CHECK( preAndPost.postfix() == "postfix" );
CHECK( preAndPost.name() == "arg" ); CHECK( preAndPost.name() == "arg" );
@ -242,7 +324,7 @@ TEST_CASE( "Arg" ) {
CHECK_FALSE( preAndPost.isMatch( "prefixpayloadpostfixx" ) ); CHECK_FALSE( preAndPost.isMatch( "prefixpayloadpostfixx" ) );
} }
SECTION( "pre" ) { SECTION( "pre" ) {
Catch::ArgData preAndPost( "prefix<arg>" ); Clara::ArgData preAndPost( "prefix<arg>" );
CHECK( preAndPost.prefix() == "prefix" ); CHECK( preAndPost.prefix() == "prefix" );
CHECK( preAndPost.postfix() == "" ); CHECK( preAndPost.postfix() == "" );
CHECK( preAndPost.name() == "arg" ); CHECK( preAndPost.name() == "arg" );
@ -253,7 +335,7 @@ TEST_CASE( "Arg" ) {
CHECK_FALSE( preAndPost.isMatch( "postfixpayload" ) ); CHECK_FALSE( preAndPost.isMatch( "postfixpayload" ) );
} }
SECTION( "post" ) { SECTION( "post" ) {
Catch::ArgData preAndPost( "<arg>postfix" ); Clara::ArgData preAndPost( "<arg>postfix" );
CHECK( preAndPost.prefix() == "" ); CHECK( preAndPost.prefix() == "" );
CHECK( preAndPost.postfix() == "postfix" ); CHECK( preAndPost.postfix() == "postfix" );
CHECK( preAndPost.name() == "arg" ); CHECK( preAndPost.name() == "arg" );
@ -264,7 +346,7 @@ TEST_CASE( "Arg" ) {
CHECK_FALSE( preAndPost.isMatch( "payloadpostfixx" ) ); CHECK_FALSE( preAndPost.isMatch( "payloadpostfixx" ) );
} }
SECTION( "none" ) { SECTION( "none" ) {
Catch::ArgData preAndPost( "<arg>" ); Clara::ArgData preAndPost( "<arg>" );
CHECK( preAndPost.prefix() == "" ); CHECK( preAndPost.prefix() == "" );
CHECK( preAndPost.postfix() == "" ); CHECK( preAndPost.postfix() == "" );
CHECK( preAndPost.name() == "arg" ); CHECK( preAndPost.name() == "arg" );
@ -273,33 +355,27 @@ TEST_CASE( "Arg" ) {
CHECK( preAndPost.strip( "payload" ) == "payload" ); CHECK( preAndPost.strip( "payload" ) == "payload" );
} }
SECTION( "errors" ) { SECTION( "errors" ) {
CHECK_THROWS( Catch::ArgData( "" ) ); CHECK_THROWS( Clara::ArgData( "" ) );
CHECK_THROWS( Catch::ArgData( "no brackets" ) ); CHECK_THROWS( Clara::ArgData( "no brackets" ) );
CHECK_THROWS( Catch::ArgData( "<one bracket" ) ); CHECK_THROWS( Clara::ArgData( "<one bracket" ) );
CHECK_THROWS( Catch::ArgData( "one bracket>" ) ); CHECK_THROWS( Clara::ArgData( "one bracket>" ) );
CHECK_THROWS( Catch::ArgData( "><" ) ); CHECK_THROWS( Clara::ArgData( "><" ) );
CHECK_THROWS( Catch::ArgData( "<>" ) ); CHECK_THROWS( Clara::ArgData( "<>" ) );
} }
} }
TEST_CASE( "cmdline", "" ) { TEST_CASE( "cmdline", "" ) {
Catch::Opt<TestOpt> opt( "specifies output file" ); Clara::Opt<TestOpt> opt( "specifies output file" );
opt.shortOpt( "o" ) opt.shortOpt( "o" )
.longOpt( "output" ) .longOpt( "output" )
.addArg( "<filename>", &TestOpt::fileName ) .addArg( "<filename>", &TestOpt::fileName )
.addArg( "%<stream name>", &TestOpt::streamName ); .addArg( "%<stream name>", &TestOpt::streamName );
TestOpt config; TestOpt config;
Catch::CommandLineParser<TestOpt> parser; Clara::CommandLineParser<TestOpt> parser;
parser.addOption( opt ); parser.addOption( opt );
// parser.addOption( "specifies output file" )
// .shortOpt( "o" )
// .longOpt( "output" )
// .addArg( "<filename>", &TestOpt::fileName )
// .addArg( "%<stream name>", &TestOpt::streamName );
SECTION( "plain filename" ) { SECTION( "plain filename" ) {
const char* argv[] = { "test", "-o:filename.ext" }; const char* argv[] = { "test", "-o:filename.ext" };
@ -322,7 +398,7 @@ TEST_CASE( "cmdline", "" ) {
CHECK( config.streamName == "stdout" ); CHECK( config.streamName == "stdout" );
} }
parser.addOption( Catch::Opt<TestOpt>( "a number" ) parser.addOption( Clara::Opt<TestOpt>( "a number" )
.shortOpt( "n" ) .shortOpt( "n" )
.addArg( "<an integral value>", &TestOpt::number ) ); .addArg( "<an integral value>", &TestOpt::number ) );
@ -343,8 +419,8 @@ TEST_CASE( "cmdline", "" ) {
TestOpt config1; TestOpt config1;
TestOpt2 config2; TestOpt2 config2;
Catch::CommandLineParser<TestOpt2> parser2; Clara::CommandLineParser<TestOpt2> parser2;
parser2.addOption( Catch::Opt<TestOpt2>( "description" ) parser2.addOption( Clara::Opt<TestOpt2>( "description" )
.shortOpt( "d" ) .shortOpt( "d" )
.longOpt( "description" ) .longOpt( "description" )
.addArg( "<some text>", &TestOpt2::description ) ); .addArg( "<some text>", &TestOpt2::description ) );
@ -358,5 +434,25 @@ TEST_CASE( "cmdline", "" ) {
CHECK( config2.description == "some text" ); CHECK( config2.description == "some text" );
} }
SECTION( "methods" ) {
parser.addOption( Clara::Opt<TestOpt>( "An index, which is an integer between 0 and 10, inclusive" )
.shortOpt( "i" )
.addArg( "<index>", &TestOpt::setValidIndex ) );
SECTION( "in range" ) {
const char* argv[] = { "test", "-i:3" };
parser.parseArgs( sizeof(argv)/sizeof(char*), argv, config );
REQUIRE( config.index == 3 );
}
SECTION( "out of range" ) {
const char* argv[] = { "test", "-i:42" };
REQUIRE_THROWS( parser.parseArgs( sizeof(argv)/sizeof(char*), argv, config ) );
}
std::cout << parser << std::endl;
}
} }