SpecsCpp Namespace Reference

Namespaces
namespace	Colors
namespace	DSLs
namespace	ExceptionHandlers
namespace	Interfaces
namespace	LibAssert

Classes
class	Entrypoint
class	GlobalSpecCodeBlocks
class	GlobalSpecEnvironment
class	GlobalSpecGroup
struct	ILocalSpecExceptionHandler
struct	ILocalSpecExceptionHandlerCollection
struct	ISpec
struct	ISpecCodeBlock
struct	ISpecCommandLineOption
struct	ISpecCommandLineOptionCollection
struct	ISpecComponent
struct	ISpecDataValue
struct	ISpecDataValueCollection
struct	ISpecDocumented
struct	ISpecEnvironment
struct	ISpecGroup
struct	ISpecHasCodeBlock
struct	ISpecHasVariables
struct	ISpecOutput
struct	ISpecReporter
struct	ISpecReporterCollection
struct	ISpecRunner
struct	ISpecRunnerCollection
struct	ISpecRunOptions
struct	ISpecRunResult
struct	ISpecRunTextOptionList
struct	ISpecSetup
struct	ISpecSuiteRunResult
struct	ISpecTagCollection
struct	ISpecTeardown
struct	ISpecVariableCollection
class	LibraryLoader
class	LocalSpecExceptionHandlerCollection
class	SpecApplication
class	SpecCodeBlock
class	SpecCommandLineOption
class	SpecCommandLineOptionCollection
class	SpecComponent
class	SpecConsoleOutput
class	SpecDataValue
class	SpecDataValueCollection
class	SpecDebugReporter
class	SpecDocumented
class	SpecDone
class	SpecEnvironment
class	SpecExceptionMessage
class	SpecGroup
class	SpecHasCodeBlock
class	SpecReporterCollection
class	SpecRunnerCollection
class	SpecRunOptions
class	SpecRunResult
class	SpecRunTextOptionList
class	SpecSerialRunner
class	SpecSetup
class	SpecSuiteRunResult
class	SpecTagCollection
class	SpecTeardown
class	SpecTest
class	SpecVariableCollection

Typedefs
using	ISpecRunResultCallbackFn = IFunctionPointer< void(ISpecRunResult *)>
using	IExceptionHandler = ILocalSpecExceptionHandler
using	IExceptionMessageCallbackFn = ILocalSpecExceptionHandler::LocalSpecExceptionFailureMessageCallbackFn
using	ISpecSuiteRunResultCallbackFn = IFunctionPointer< void(ISpecSuiteRunResult *)>

Enumerations
enum class	SpecDataValueType {   Boolean , Integer , UnsignedInteger , Float ,   String , Pointer }
enum class	SpecComponentType { Group , Spec , Setup , Teardown }
enum class	RunResultStatus { Passed , Failed , NotRun , Timeout }

Functions
GlobalSpecEnvironment &	global_spec_environment ()
void	register_exception_handler (IExceptionHandler *handler)
void	register_reporter (const char *name, ISpecReporter *reporter)
void	register_runner (const char *name, ISpecRunner *runner)

Typedef Documentation

IExceptionHandler

using SpecsCpp::IExceptionHandler = typedef ILocalSpecExceptionHandler

Definition at line 389 of file API.h.

IExceptionMessageCallbackFn

using SpecsCpp::IExceptionMessageCallbackFn = typedef ILocalSpecExceptionHandler::LocalSpecExceptionFailureMessageCallbackFn

Definition at line 390 of file API.h.

ISpecRunResultCallbackFn

using SpecsCpp::ISpecRunResultCallbackFn = typedef IFunctionPointer<void(ISpecRunResult*)>

Definition at line 198 of file API.h.

ISpecSuiteRunResultCallbackFn

using SpecsCpp::ISpecSuiteRunResultCallbackFn = typedef IFunctionPointer<void(ISpecSuiteRunResult*)>

Definition at line 485 of file API.h.

Enumeration Type Documentation

RunResultStatus

enum class SpecsCpp::RunResultStatus

strong

Enumerator
Passed
Failed
NotRun
Timeout

Definition at line 165 of file API.h.

                               {
        Passed,
        Failed,
        NotRun,
        Timeout,
    };

SpecComponentType

enum class SpecsCpp::SpecComponentType

strong

Enumerator
Group
Spec
Setup
Teardown

Definition at line 128 of file API.h.

                                 {
        Group,
        Spec,
        Setup,
        Teardown,
    };

SpecDataValueType

enum class SpecsCpp::SpecDataValueType

strong

Enumerator
Boolean
Integer
UnsignedInteger
Float
String
Pointer

Definition at line 26 of file API.h.

                                 {
        Boolean,
        Integer,
        UnsignedInteger,
        Float,
        String,
        Pointer,
    };

Function Documentation

global_spec_environment()

GlobalSpecEnvironment & SpecsCpp::global_spec_environment ( )

inline

Definition at line 15 of file GlobalSpecEnvironment.h.

                                                            {
        static GlobalSpecEnvironment instance;
        return instance;
    }

Referenced by SpecsCpp::Entrypoint::main(), register_exception_handler(), register_reporter(), register_runner(), SpecsCpp::SpecCodeBlock::run(), and SpecsCpp_Load().

register_exception_handler()

void SpecsCpp::register_exception_handler ( IExceptionHandler *  handler )

inline

Definition at line 22 of file GlobalSpecEnvironment.h.

                                                                       {
        global_spec_environment().get()->local_exception_handlers()->register_exception_handler(
            handler
        );
    }

register_reporter()

void SpecsCpp::register_reporter ( const char *  name, ISpecReporter *  reporter  )

inline

Definition at line 28 of file GlobalSpecEnvironment.h.

                                                                             {
        global_spec_environment().get()->reporters()->add(name, reporter);
    }

register_runner()

void SpecsCpp::register_runner ( const char *  name, ISpecRunner *  runner  )

inline

Definition at line 32 of file GlobalSpecEnvironment.h.

                                                                       {
        global_spec_environment().get()->runners()->add(name, runner);
    }