Menu
▾
▴
loki-lib-cvs
|
From: <ric...@us...> - 2009-01-28 04:19:25
|
Revision: 953
http://loki-lib.svn.sourceforge.net/loki-lib/?rev=953&view=rev
Author: rich_sposato
Date: 2009-01-28 04:19:22 +0000 (Wed, 28 Jan 2009)
Log Message:
-----------
Added documentation comment.
Modified Paths:
--------------
trunk/include/loki/CheckReturn.h
Modified: trunk/include/loki/CheckReturn.h
===================================================================
--- trunk/include/loki/CheckReturn.h 2009-01-28 04:15:21 UTC (rev 952)
+++ trunk/include/loki/CheckReturn.h 2009-01-28 04:19:22 UTC (rev 953)
@@ -1,12 +1,12 @@
////////////////////////////////////////////////////////////////////////////////
// The Loki Library
// Copyright (c) 2007 by Rich Sposato
-// Permission to use, copy, modify, distribute and sell this software for any
-// purpose is hereby granted without fee, provided that the above copyright
-// notice appear in all copies and that both that copyright notice and this
+// Permission to use, copy, modify, distribute and sell this software for any
+// purpose is hereby granted without fee, provided that the above copyright
+// notice appear in all copies and that both that copyright notice and this
// permission notice appear in supporting documentation.
-// The author makes no representations about the
-// suitability of this software for any purpose. It is provided "as is"
+// The author makes no representations about the
+// suitability of this software for any purpose. It is provided "as is"
// without express or implied warranty.
////////////////////////////////////////////////////////////////////////////////
@@ -18,6 +18,7 @@
#include <assert.h>
#include <stdio.h>
+#include <stdexcept>
namespace Loki
@@ -34,17 +35,40 @@
/// a mechanism by which programmers can force calling functions to check the
/// return value. Or at least make them consciously choose to disregard the
/// return value. If the calling function fails to use or store the return
-/// value, the destructor asserts.
+/// value, the destructor calls the OnError policy.
///
-/// \par Return Type
-/// The returned value is copied into CheckReturn rather than accessed via a
-/// a reference or pointer since return value could be local to a function.
-/// CheckReturn works best when the return type is a built-in primitive (bool,
-/// int, etc...) a pointer, or an enum (such as an error condition enum). It
-/// can work with other types that have cheap copy operations.
+/// \par Template Parameters
+/// CheckReturn has two template parameters, Value and OnError.
+/// - Value is the return type from the function. CheckReturn stores a copy of
+/// it rather than a reference or pointer since return value could be local to
+/// a function. CheckReturn works best when the return type is a built-in
+/// primitive (bool, int, etc...) a pointer, or an enum (such as an error
+/// condition enum). It can work with other types that have cheap copy
+/// operations.
+///
+/// \par OnError Policy
+/// - OnError is a policy class indicating how to handle the situation when a
+/// caller does not check or copy the returned value. Loki provides some
+/// policy classs and you may also write your own. For example, you can write
+/// a policy to throw an exception or create a message box when the function
+/// ignores the return value. If your write your own, you only need to provide
+/// a function named "run".
+///
+/// - IgnoreReturnValue Deliberately ignores when the caller ignores the return value.
+/// - TriggerAssert Asserts in debug builds if the caller ignores the return value.
+/// - FprintfStderr Prints out an error message if the caller ignores the return value.
////////////////////////////////////////////////////////////////////////////////
+struct IgnoreReturnValue
+{
+ static void run()
+ {
+ /// Do nothing at all.
+ }
+};
+
+
struct TriggerAssert
{
static void run()
@@ -69,7 +93,7 @@
public:
/// Conversion constructor changes Value type to CheckReturn type.
- inline CheckReturn( Value value ) :
+ inline CheckReturn( const Value & value ) :
m_value( value ), m_checked( false ) {}
/// Copy-constructor allows functions to call another function within the
@@ -116,3 +140,4 @@
#endif // end file guardian
// $Log$
+
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
|
From: <syn...@us...> - 2009-01-28 18:12:23
|
Revision: 954
http://loki-lib.svn.sourceforge.net/loki-lib/?rev=954&view=rev
Author: syntheticpp
Date: 2009-01-28 18:12:10 +0000 (Wed, 28 Jan 2009)
Log Message:
-----------
Add Rich's idea to pass the value into the policy
Modified Paths:
--------------
trunk/include/loki/CheckReturn.h
Modified: trunk/include/loki/CheckReturn.h
===================================================================
--- trunk/include/loki/CheckReturn.h 2009-01-28 04:19:22 UTC (rev 953)
+++ trunk/include/loki/CheckReturn.h 2009-01-28 18:12:10 UTC (rev 954)
@@ -60,34 +60,36 @@
////////////////////////////////////////////////////////////////////////////////
+template<class T>
struct IgnoreReturnValue
{
- static void run()
+ static void run(const T&)
{
/// Do nothing at all.
}
};
-
+template<class T>
struct TriggerAssert
{
- static void run()
+ static void run(const T&)
{
assert( 0 );
}
};
-
+template<class T>
struct FprintfStderr
{
- static void run()
+ static void run(const T&)
{
fprintf(stderr, "CheckReturn: return value was not checked\n");
}
};
-template < class Value , typename OnError = TriggerAssert>
+
+template < class Value , template<class> class OnError = TriggerAssert >
class CheckReturn
{
public:
@@ -109,7 +111,7 @@
// If m_checked is false, then a function failed to check the
// return value from a function call.
if (!m_checked)
- OnError::run();
+ OnError<Value>::run(m_value);
}
/// Conversion operator changes CheckReturn back to Value type.
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
|
From: <ric...@us...> - 2009-01-29 08:24:42
|
Revision: 955
http://loki-lib.svn.sourceforge.net/loki-lib/?rev=955&view=rev
Author: rich_sposato
Date: 2009-01-29 08:24:30 +0000 (Thu, 29 Jan 2009)
Log Message:
-----------
Added documentation comments. Added a policy.
Modified Paths:
--------------
trunk/include/loki/CheckReturn.h
Modified: trunk/include/loki/CheckReturn.h
===================================================================
--- trunk/include/loki/CheckReturn.h 2009-01-28 18:12:10 UTC (rev 954)
+++ trunk/include/loki/CheckReturn.h 2009-01-29 08:24:30 UTC (rev 955)
@@ -45,18 +45,20 @@
/// primitive (bool, int, etc...) a pointer, or an enum (such as an error
/// condition enum). It can work with other types that have cheap copy
/// operations.
-///
-/// \par OnError Policy
/// - OnError is a policy class indicating how to handle the situation when a
/// caller does not check or copy the returned value. Loki provides some
/// policy classs and you may also write your own. For example, you can write
-/// a policy to throw an exception or create a message box when the function
-/// ignores the return value. If your write your own, you only need to provide
-/// a function named "run".
+/// a policy to create a message box when the function ignores the return value.
+/// That would quickly tell you places where code ignores the function call.
+/// If your write your own, you only need a templated class or struct with a
+/// public function named "run" that accepts a reference to a const value.
///
+/// @par Provided Policy Classes
/// - IgnoreReturnValue Deliberately ignores when the caller ignores the return value.
/// - TriggerAssert Asserts in debug builds if the caller ignores the return value.
/// - FprintfStderr Prints out an error message if the caller ignores the return value.
+/// - ThrowTheValue Throws the ignored value as an exception.
+/// - ThrowLogicError Throws a logic_error exception to indicate a programming error.
////////////////////////////////////////////////////////////////////////////////
@@ -65,16 +67,34 @@
{
static void run(const T&)
{
- /// Do nothing at all.
+ /// Do nothing at all.
}
};
template<class T>
+struct ThrowTheValue
+{
+ static void run(const T & value )
+ {
+ throw value;
+ }
+};
+
+template<class T>
+struct ThrowLogicError
+{
+ static void run( const T & )
+ {
+ throw ::std::logic_error( "CheckReturn: return value was not checked.\n" );
+ }
+};
+
+template<class T>
struct TriggerAssert
{
static void run(const T&)
{
- assert( 0 );
+ assert( 0 );
}
};
@@ -83,7 +103,7 @@
{
static void run(const T&)
{
- fprintf(stderr, "CheckReturn: return value was not checked\n");
+ fprintf(stderr, "CheckReturn: return value was not checked.\n");
}
};
@@ -94,45 +114,45 @@
{
public:
- /// Conversion constructor changes Value type to CheckReturn type.
- inline CheckReturn( const Value & value ) :
- m_value( value ), m_checked( false ) {}
+ /// Conversion constructor changes Value type to CheckReturn type.
+ inline CheckReturn( const Value & value ) :
+ m_value( value ), m_checked( false ) {}
- /// Copy-constructor allows functions to call another function within the
- /// return statement. The other CheckReturn's m_checked flag is set since
- /// its duty has been passed to the m_checked flag in this one.
- inline CheckReturn( const CheckReturn & that ) :
- m_value( that.m_value ), m_checked( false )
- { that.m_checked = true; }
+ /// Copy-constructor allows functions to call another function within the
+ /// return statement. The other CheckReturn's m_checked flag is set since
+ /// its duty has been passed to the m_checked flag in this one.
+ inline CheckReturn( const CheckReturn & that ) :
+ m_value( that.m_value ), m_checked( false )
+ { that.m_checked = true; }
- /// Destructor checks if return value was used.
- inline ~CheckReturn( void )
- {
+ /// Destructor checks if return value was used.
+ inline ~CheckReturn( void )
+ {
// If m_checked is false, then a function failed to check the
- // return value from a function call.
+ // return value from a function call.
if (!m_checked)
OnError<Value>::run(m_value);
- }
+ }
- /// Conversion operator changes CheckReturn back to Value type.
- inline operator Value ( void )
- {
- m_checked = true;
- return m_value;
- }
+ /// Conversion operator changes CheckReturn back to Value type.
+ inline operator Value ( void )
+ {
+ m_checked = true;
+ return m_value;
+ }
private:
- /// Default constructor not implemented.
- CheckReturn( void );
+ /// Default constructor not implemented.
+ CheckReturn( void );
- /// Copy-assignment operator not implemented.
- CheckReturn & operator = ( const CheckReturn & that );
+ /// Copy-assignment operator not implemented.
+ CheckReturn & operator = ( const CheckReturn & that );
- /// Copy of returned value.
- Value m_value;
+ /// Copy of returned value.
+ Value m_value;
- /// Flag for whether calling function checked return value yet.
- mutable bool m_checked;
+ /// Flag for whether calling function checked return value yet.
+ mutable bool m_checked;
};
// ----------------------------------------------------------------------------
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
|
From: <ric...@us...> - 2011-06-21 01:16:35
|
Revision: 1084
http://loki-lib.svn.sourceforge.net/loki-lib/?rev=1084&view=rev
Author: rich_sposato
Date: 2011-06-21 01:16:29 +0000 (Tue, 21 Jun 2011)
Log Message:
-----------
Renamed template parameter to avoid confusion.
Modified Paths:
--------------
trunk/include/loki/CheckReturn.h
Modified: trunk/include/loki/CheckReturn.h
===================================================================
--- trunk/include/loki/CheckReturn.h 2011-06-21 01:11:50 UTC (rev 1083)
+++ trunk/include/loki/CheckReturn.h 2011-06-21 01:16:29 UTC (rev 1084)
@@ -109,13 +109,13 @@
-template < class Value , template<class> class OnError = TriggerAssert >
+template < class ValueType , template<class> class OnError = TriggerAssert >
class CheckReturn
{
public:
/// Conversion constructor changes Value type to CheckReturn type.
- inline CheckReturn( const Value & value ) :
+ inline CheckReturn( const ValueType & value ) :
m_value( value ), m_checked( false ) {}
/// Copy-constructor allows functions to call another function within the
@@ -131,11 +131,11 @@
// If m_checked is false, then a function failed to check the
// return value from a function call.
if (!m_checked)
- OnError<Value>::run(m_value);
+ OnError< ValueType >::run(m_value);
}
/// Conversion operator changes CheckReturn back to Value type.
- inline operator Value ( void )
+ inline operator ValueType ( void )
{
m_checked = true;
return m_value;
@@ -149,7 +149,7 @@
CheckReturn & operator = ( const CheckReturn & that );
/// Copy of returned value.
- Value m_value;
+ ValueType m_value;
/// Flag for whether calling function checked return value yet.
mutable bool m_checked;
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
Thanks for helping keep SourceForge clean.
X