Catch::Session Class Reference

#include <catch_session.h>

Inheritance diagram for Catch::Session:

Collaboration diagram for Catch::Session:

Public Member Functions
	Session ()
	~Session () override
void	showHelp () const
void	libIdentify ()
int	applyCommandLine (int argc, char const *const *argv)
void	useConfigData (ConfigData const &configData)
template<typename CharT >
int	run (int argc, CharT const *const argv[])
int	run ()
clara::Parser const &	cli () const
void	cli (clara::Parser const &newParser)
ConfigData &	configData ()
Config &	config ()

Detailed Description

Definition at line 19 of file catch_session.h.

Constructor & Destructor Documentation

Session()

Catch::Session::Session

(

)

Definition at line 126 of file catch_session.cpp.

                     {
        static bool alreadyInstantiated = false;
        if( alreadyInstantiated ) {
            CATCH_TRY { CATCH_INTERNAL_ERROR( "Only one instance of Catch::Session can ever be used" ); }
            CATCH_CATCH_ALL { getMutableRegistryHub().registerStartupException(); }
        }
 
        // There cannot be exceptions at startup in no-exception mode.
#if !defined(CATCH_CONFIG_DISABLE_EXCEPTIONS)
        const auto& exceptions = getRegistryHub().getStartupExceptionRegistry().getExceptions();
        if ( !exceptions.empty() ) {
            m_startupExceptions = true;
            Colour colourGuard( Colour::Red );
            Catch::cerr() << "Errors occurred during startup!" << '\n';
            // iterate over all exceptions and notify user
            for ( const auto& ex_ptr : exceptions ) {
                try {
                    std::rethrow_exception(ex_ptr);
                } catch ( std::exception const& ex ) {
                    Catch::cerr() << Column( ex.what() ).indent(2) << '\n';
                }
            }
        }
#endif
 
        alreadyInstantiated = true;
        m_cli = makeCommandLineParser( m_configData );
    }

Here is the call graph for this function:

~Session()

Catch::Session::~Session ( )

override

Definition at line 154 of file catch_session.cpp.

                      {
        Catch::cleanUp();
    }

Here is the call graph for this function:

Member Function Documentation

applyCommandLine()

int Catch::Session::applyCommandLine	(	int	argc,
		char const *const *	argv )

Definition at line 172 of file catch_session.cpp.

                                                                       {
        if( m_startupExceptions )
            return 1;
 
        auto result = m_cli.parse( clara::Args( argc, argv ) );
        if( !result ) {
            config();
            getCurrentMutableContext().setConfig(m_config);
            Catch::cerr()
                << Colour( Colour::Red )
                << "\nError(s) in input:\n"
                << Column( result.errorMessage() ).indent( 2 )
                << "\n\n";
            Catch::cerr() << "Run with -? for usage\n" << std::endl;
            return MaxExitCode;
        }
 
        if( m_configData.showHelp )
            showHelp();
        if( m_configData.libIdentify )
            libIdentify();
        m_config.reset();
        return 0;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

cli() [1/2]

clara::Parser const & Catch::Session::cli

(

)

const

Definition at line 239 of file catch_session.cpp.

                                          {
        return m_cli;
    }

cli() [2/2]

void Catch::Session::cli

(

clara::Parser const &

newParser

)

Definition at line 242 of file catch_session.cpp.

                                                    {
        m_cli = newParser;
    }

config()

Config & Catch::Session::config

(

)

Definition at line 248 of file catch_session.cpp.

                            {
        if( !m_config )
            m_config = std::make_shared<Config>( m_configData );
        return *m_config;
    }

Here is the caller graph for this function:

configData()

ConfigData & Catch::Session::configData

(

)

Definition at line 245 of file catch_session.cpp.

                                    {
        return m_configData;
    }

Here is the caller graph for this function:

libIdentify()

void Catch::Session::libIdentify

(

)

Definition at line 164 of file catch_session.cpp.

                              {
        Catch::cout()
                << std::left << std::setw(16) << "description: " << "A Catch test executable\n"
                << std::left << std::setw(16) << "category: " << "testframework\n"
                << std::left << std::setw(16) << "framework: " << "Catch Test\n"
                << std::left << std::setw(16) << "version: " << libraryVersion() << std::endl;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

run() [1/2]

int Catch::Session::run

(

)

Definition at line 226 of file catch_session.cpp.

                     {
        if( ( m_configData.waitForKeypress & WaitForKeypress::BeforeStart ) != 0 ) {
            Catch::cout() << "...waiting for enter/ return before starting" << std::endl;
            static_cast<void>(std::getchar());
        }
        int exitCode = runInternal();
        if( ( m_configData.waitForKeypress & WaitForKeypress::BeforeExit ) != 0 ) {
            Catch::cout() << "...waiting for enter/ return before exiting, with code: " << exitCode << std::endl;
            static_cast<void>(std::getchar());
        }
        return exitCode;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

run() [2/2]

template<typename CharT >

int Catch::Session::run ( int argc, CharT const *const argv[] )

inline

Definition at line 36 of file catch_session.h.

                                                      {
            if (m_startupExceptions)
                return 1;
            int returnCode = applyCommandLine(argc, argv);
            if (returnCode == 0)
                returnCode = run();
            return returnCode;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

showHelp()

void Catch::Session::showHelp

(

)

const

Definition at line 158 of file catch_session.cpp.

                                 {
        Catch::cout()
                << "\nCatch v" << libraryVersion() << "\n"
                << m_cli << std::endl
                << "For more detailed usage please see the project docs\n" << std::endl;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

useConfigData()

void Catch::Session::useConfigData

(

ConfigData const &

configData

)

Definition at line 221 of file catch_session.cpp.

                                                              {
        m_configData = configData;
        m_config.reset();
    }

Here is the call graph for this function:

---

The documentation for this class was generated from the following files:

• libraries/sys-vm/external/Catch2/include/internal/catch_session.h
• libraries/sys-vm/external/Catch2/include/internal/catch_session.cpp