Updated documentation

git-svn-id: https://svn.code.sf.net/p/turtle/code/trunk@655 860be788-9bd5-4423-9f1e-828f051e677b

build/boost/doc/example/customization.cpp

@@ -0,0 +1,174 @@
+// http://turtle.sourceforge.net
+//
+// Copyright Mathieu Champlon 2012
+//
+// Distributed under the Boost Software License, Version 1.0.
+// (See accompanying file LICENSE_1_0.txt or copy at
+// http://www.boost.org/LICENSE_1_0.txt)
+
+//[ mock_use_conversions
+#define MOCK_USE_CONVERSIONS
+#include <turtle/mock.hpp>
+//]
+#include "calculator.hpp"
+#include "mock_view.hpp"
+
+//[ mock_stream_user_type
+namespace user_namespace
+{
+    struct user_type
+    {};
+
+    inline mock::stream& operator<<( mock::stream& s, const user_type& )
+    {
+        return s << "user_type";
+    }
+}
+//]
+
+namespace custom_constraint_free_function_test
+{
+//[ custom_constraint_free_function
+bool custom_constraint( int actual )
+{
+    return actual == 42;
+}
+//]
+
+//[ custom_constraint_free_function_test
+BOOST_AUTO_TEST_CASE( forty_one_plus_one_is_forty_two )
+{
+    mock_view v;
+    calculator c( v );
+    MOCK_EXPECT( v.display ).with( &custom_constraint );
+    c.add( 41, 1 );
+ }
+//]
+}
+
+namespace custom_constraint_functor_test
+{
+//[ custom_constraint_functor
+struct custom_constraint
+{
+    friend bool operator==( int actual, const custom_constraint& )
+    {
+        return actual == 42;
+    }
+
+    friend std::ostream& operator<<( std::ostream& s, const custom_constraint& )
+    {
+        return s << "_ == 42";
+    }
+};
+//]
+
+//[ custom_constraint_functor_test
+BOOST_AUTO_TEST_CASE( forty_one_plus_one_is_forty_two )
+{
+    mock_view v;
+    calculator c( v );
+    MOCK_EXPECT( v.display ).with( custom_constraint() );
+    c.add( 41, 1 );
+}
+//]
+}
+
+//[ near_constraint
+template< typename Expected >
+struct near_constraint
+{
+    near_constraint( Expected expected, Expected threshold )
+      : expected_( expected )
+      , threshold_( threshold )
+    {}
+
+    template< typename Actual >
+    bool operator()( Actual actual ) const
+    {
+        return std::abs( actual - boost::unwrap_ref( expected_ ) )
+            < boost::unwrap_ref( threshold_ );
+    }
+
+    friend std::ostream& operator<<( std::ostream& s, const near_constraint& c )
+    {
+        return s << "near( " << mock::format( c.expected_ )
+            << ", " << mock::format( c.threshold_ ) << " )";
+    }
+
+    Expected expected_, threshold_;
+};
+
+template< typename Expected >
+mock::constraint< near_constraint< Expected > > near( Expected expected, Expected threshold )
+{
+    return near_constraint< Expected >( expected, threshold );
+}
+//]
+
+namespace near_constraint_test
+{
+//[ near_constraint_test
+BOOST_AUTO_TEST_CASE( forty_one_plus_one_is_forty_two_plus_or_minus_one )
+{
+   mock_view v;
+   calculator c( v );
+   MOCK_EXPECT( v.display ).with( near( 42, 1 ) );
+   c.add( 41, 1 );
+}
+//]
+}
+
+namespace near_constraint_cref_test
+{
+//[ near_constraint_cref_test
+BOOST_AUTO_TEST_CASE( forty_one_plus_one_is_forty_two_plus_or_minus_one )
+{
+   mock_view v;
+   calculator c( v );
+   int expected, threshold;
+   MOCK_EXPECT( v.display ).with( near( boost::cref( expected ), boost::cref( threshold ) ) );
+   expected = 42;
+   threshold = 1;
+   c.add( 41, 1 );
+}
+//]
+}
+
+#undef MOCK_MAX_ARGS
+//[ max_args
+#define MOCK_MAX_ARGS 20
+#include <turtle/mock.hpp>
+//]
+
+//[ custom_policy
+template< typename Result >
+struct custom_policy
+{
+    static Result abort()
+    {
+        // ...
+    }
+    template< typename Context >
+    static void fail( const char* message, const Context&, const char* file = "unknown location", int line = 0 )
+    {
+        // ...
+    }
+    template< typename Context >
+    static void call( const Context& context, const char* file, int line )
+    {
+        // ...
+    }
+    template< typename Context >
+    static void pass( const char* file, int line )
+    {
+        // ...
+    }
+};
+//]
+
+#undef MOCK_ERROR_POLICY
+//[ define_custom_policy
+#define MOCK_ERROR_POLICY custom_policy
+#include <turtle/mock.hpp>
+//]