mockpp.h File Reference

Common stuff for mockpp project. More...

Go to the source code of this file.

Namespaces
namespace	mockpp
	Namespace for project "Mock Objects for C++".
Defines
#define	MOCKPP_STRING_H   <string>
	actual <string> header file
#define	MOCKPP_VECTOR_H   <vector>
	actual <vector> header file
#define	MOCKPP_MAP_H   <map>
	actual <map> header file
#define	MOCKPP_SET_H   <set>
	actual <set> header file
#define	MOCKPP_FUNCTION_H   <function>
	actual <function> header file
#define	MOCKPP_ALGORITHM_H   <algorithm>
	actual <algorithm> header file
#define	MOCKPP_STL   MOCKPP_STD_NS
	Actual namespace for STL classes.
#define	MOCKPP_ANON_NS_START   namespace {
	Conditional start of anonymous namespace.
#define	MOCKPP_NS   mockpp
	Conditional mockpp namespace.
#define	MOCKPP_NS_START   namespace mockpp {
	Conditional start of mockpp namespace.
#define	MOCKPP_NS_END   }
	Conditional end of mockpp namespace.
#define	USING_NAMESPACE_MOCKPP   using namespace mockpp;
	Conditional using mockpp namespace.
#define	MOCKPP_STD_NS   std
	Actual name for std namespace.
#define	MOCKPP_THROW(x)   throw (x)
	actual implementation of throw statement when throwing a type
#define	MOCKPP_RETHROW   throw
	actual implementation of throw statement when re-throwing an undefined value
#define	MOCKPP_TRY   try
	actual implementation of try statement
#define	MOCKPP_CATCH(x)   catch(x)
	actual implementation of catch statement for a certain object
#define	MOCKPP_CATCH_ALL   catch(...)
	actual implementation of catch statement for a catch(.
#define	MOCKPP_UNLIMITED   (std::numeric_limits<unsigned>::max())
	Value representing an unlimited number.
#define	MOCKPP_FUNC_MACRO   __func__
	Returns the name of the current function or something similar unique for a whole project.
#define	MOCKPP_UNUSED(x)
	Simple macro to suppress warnings about unused variables if possible.
#define	MOCKPP_MAKE_CHAR_READABLE   1
	Output char values more readable (e.g.
#define	MOCKPP_USE_STD_EXCEPTION   1
	MOCKPP_NS::Exception is derived from std::exception.
#define	MOCKPP_BOUNDARY_DELTA   0
	ExpectationBoundary::setExpectedDelta() is activated. This method is only ativated upon reqest as it might cause problems with user's data type if there are no operator+() and operator-().
#define	MOCKPP_API_DECL0
	Returns a platform dependent symbol to export names to the linker.
#define	MOCKPP_API_IMPL0
	Returns a platform dependent symbol to export names to the linker.
#define	MOCKPP_API_DECL(type)   type
	Returns a platform dependent symbol to export names to the linker.
#define	MOCKPP_API_IMPL(type)   type
	Returns a platform dependent symbol to export names to the linker.
#define	MOCKPP_CHAR(x)   x
	make the charactor constant of type char
#define	MOCKPP_PCHAR(x)   x
	make the string literal a char literal
#define	MOCKPP_PCSTRING(x)   MOCKPP_NS::String(MOCKPP_PCHAR(x))
	transform a string literal into a MOCKPP_NS::String
#define	MOCKPP_STRING(x)   MOCKPP_NS::String(x)
	transform a potential mockpp string into a MOCKPP_NS::String
#define	MOCKPP_I18N_NOOP(x)   x
	Dummy, tags a string for translation without doing anything.
#define	mockpp_i18n(x)   x
	Dummy, prepare automatic translation within the code.
#define	MOCKPP_GET_STRING(x)   MOCKPP_NS::getLatin1(x)
	transform the string into ascii if needed
#define	mockpp_constructor
	tag for mockpp2xml: include this constructor
#define	mockpp_methods
	tag for mockpp2xml: include following methods until next [public | protected | private]
#define	MOCKPP_MEMBER_RESTRICTOR_PRIVATE   public
	Makes member public for Borland BCB5 otherwise private.
#define	MOCKPP_MEMBER_RESTRICTOR_PROTECTED   public
	Makes member public for Borland BCB5 otherwise protected.
#define	MOCKPP_UNICODE
	Defined if Unicode strings are used.
#define	CXXTEST_USE_MINI_STL
	Defined if CxxTest uses the alternative STL implementation below 3party/ministl instead of the regular STL.
#define	MOCKPP_USE_MINI_STL
	When defined mockpp uses built-in mini stl.
#define	MOCKPP_NO_NAMESPACE
	Defined if namespace support is not working properly.
#define	MOCKPP_NO_TEMPLATE_HINT
	Defined if the compiler does not support the template hint like this: value_type::template long_name<T1,T2>end_type.
#define	MOCKPP_NO_TYPENAME_FOR_STL_NS
	Using typename yields an error in certain cases when stl is in the global namespace.
#define	MOCKPP_ALTERNATIVE_STL
	When defined alternative stl in use.
#define	MOCKPP_NEED_EXPORTS
	Enable the creation of module exports.
#define	MOCKPP_API_DECL0
	Returns a platform dependent symbol to export names to the linker.
#define	MOCKPP_API_DECL
	Returns a platform dependent symbol to export names to the linker.
#define	MOCKPP_API_IMPL0
	Returns a platform dependent symbol to export names to the linker.
#define	MOCKPP_API_IMPL
	Returns a platform dependent symbol to export names to the linker.
Typedefs
typedef std::basic_string< char >	mockpp::String
	Actual type of a string (basic_string<char/wchar_t>).
typedef char	mockpp::Char
	Actual type of a single character (char/wchar_t).
typedef void(*	mockpp::AssertionFailedForwarder_t )(const AssertionFailedError &err)
	Forwarder for failures.
Functions
void	mockpp::getVersion (int &major, int &minor, int &patch, bool &debug, std::string &info)
	add template specialisation to prevent float/double ExpectationValue's
std::string	mockpp::getLatin1 (const std::string &latin1)
	Converts a string from latin1 to latin1.
AssertionFailedForwarder_t	mockpp::setAssertionFailedForwarder (AssertionFailedForwarder_t fwd)
	Sets the function pointer which handles failed assertions.

---

Detailed Description

Common stuff for mockpp project.

Id

mockpp.h 1492 2010-01-03 10:47:55Z ewald-arnold

Definition in file mockpp.h.

---

Define Documentation

#define MOCKPP_CATCH_ALL   catch(...)

actual implementation of catch statement for a catch(.

..)

#define MOCKPP_NEED_EXPORTS

Enable the creation of module exports.

Otherwise imports are created.

#define MOCKPP_UNUSED

(

x

)

Simple macro to suppress warnings about unused variables if possible.

Note: This is just an empty fallback. The actual content (if any) is in the according config-*.h. Can be used without semicolon at the end since it is already contained in the macro.

Definition at line 329 of file mockpp.h.