1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/os/persistentdata/persistentstorage/dbms/inc/D32Assert.h Fri Jun 15 03:10:57 2012 +0200
1.3 @@ -0,0 +1,130 @@
1.4 +// Copyright (c) 1998-2009 Nokia Corporation and/or its subsidiary(-ies).
1.5 +// All rights reserved.
1.6 +// This component and the accompanying materials are made available
1.7 +// under the terms of "Eclipse Public License v1.0"
1.8 +// which accompanies this distribution, and is available
1.9 +// at the URL "http://www.eclipse.org/legal/epl-v10.html".
1.10 +//
1.11 +// Initial Contributors:
1.12 +// Nokia Corporation - initial contribution.
1.13 +//
1.14 +// Contributors:
1.15 +//
1.16 +// Description:
1.17 +// Special build functions: ASSERTING, NOTIFY on Leave, TRACING
1.18 +//
1.19 +//
1.20 +
1.21 +#ifndef __D32ASSERT_H__
1.22 +#define __D32ASSERT_H__
1.23 +
1.24 +#include <e32std.h>
1.25 +
1.26 +#if defined(_DEBUG)
1.27 + #define __DEBUG(s) s
1.28 + #define _ASSERTIONS
1.29 + //#define _NOTIFY
1.30 + //#define _TRACE
1.31 + //#define __DBDUMP__
1.32 + #define __DBINVARIANT__
1.33 +#else
1.34 + #define __DEBUG(s)
1.35 +#endif
1.36 +
1.37 +#ifdef __DBDUMP__
1.38 +#include <f32file.h> //RFile
1.39 +#endif
1.40 +
1.41 +/**
1.42 +DECLARE_DB_DUMP, DECLARE_DB_DUMP2, DECLARE_DB_DUMP3 macros can be used for printing out
1.43 +DBMS security policy data to a text file.
1.44 +__DBDUMP__ macro must be defined if you want to use them.
1.45 +Usage:
1.46 +Use DECLARE_DB_DUMP macro for declaring pure virtual Dump(RFile& aFile) method in a particular class.
1.47 +Use DECLARE_DB_DUMP2 macro for declaring virtual Dump(RFile& aFile) method in a particular class.
1.48 +Use DECLARE_DB_DUMP3 macro for declaring non-virtual Dump(RFile& aFile) method in a particular class.
1.49 +@internalComponent
1.50 +*/
1.51 +
1.52 +#ifdef __DBDUMP__
1.53 +#define DECLARE_DB_DUMP(aFile) virtual void Dump(RFile& aFile) const = 0;
1.54 +#define DECLARE_DB_DUMP2(aFile) virtual void Dump(RFile& aFile) const;
1.55 +#define DECLARE_DB_DUMP3(aFile) void Dump(RFile& aFile) const;
1.56 +#else
1.57 +#define DECLARE_DB_DUMP(aFile)
1.58 +#define DECLARE_DB_DUMP2(aFile)
1.59 +#define DECLARE_DB_DUMP3(aFile)
1.60 +#endif
1.61 +
1.62 +/**
1.63 +DECLARE_DB_INVARIANT, DECLARE_DB_INVARIANT2, DB_INVARIANT, DB_INVARIANT_ASSERT
1.64 +macros can be used for asserting the internal state of DBMS security policy classes.
1.65 +__DBINVARIANT__ macro must be defined if you want to use them.
1.66 +Usage:
1.67 +Use DECLARE_DB_INVARIANT macro for declaring virtual Invariant() method in a particular class.
1.68 +Use DECLARE_DB_INVARIANT2 macro for declaring non-virtual Invariant() method in a particular class.
1.69 +Use DB_INVARIANT macro to call Invariant() method somewhere in the code.
1.70 +Use DB_INVARIANT_ASSERT macro in places, where you want to use __ASSERT macro (it may not be defined).
1.71 +@internalComponent
1.72 +*/
1.73 +
1.74 +#ifdef __DBINVARIANT__
1.75 +#define DECLARE_DB_INVARIANT() virtual void Invariant() const;
1.76 +#define DECLARE_DB_INVARIANT2() void Invariant() const;
1.77 +#define DB_INVARIANT() Invariant()
1.78 +#define DB_INVARIANT_ASSERT(aExprVal) Util::Invariant(aExprVal)
1.79 +#else
1.80 +#define DECLARE_DB_INVARIANT()
1.81 +#define DECLARE_DB_INVARIANT2()
1.82 +#define DB_INVARIANT() void(0)
1.83 +#define DB_INVARIANT_ASSERT(aExprVal) void(0)
1.84 +#endif
1.85 +
1.86 +/**
1.87 +@internalComponent
1.88 +*/
1.89 +class Util
1.90 + {
1.91 +public:
1.92 + static void Assert(const TText* aFile,TInt aLine);
1.93 +//
1.94 + static void Leave(const TText* aFile,TInt aLine,TInt aError);
1.95 + static TInt LeaveIfError(const TText* aFile,TInt aLine,TInt aError);
1.96 +//
1.97 + static void Trace(const TText* aFile,TInt aLine);
1.98 + static void Trace(const TText* aFile,TInt aLine,const TText* aString);
1.99 + static void Trace(const TText* aFile,TInt aLine,const TText* aExp,const TDesC& aDes);
1.100 + static void Trace(const TText* aFile,TInt aLine,const TText* aExp,TInt aVal);
1.101 + static void Trace(const TText* aFile,TInt aLine,const TText* aExp,const TAny* aPtr);
1.102 + static void Invariant(TBool aExprVal);
1.103 +private:
1.104 + static TPtrC Filename(const TText* aFile);
1.105 + };
1.106 +
1.107 +#define __STRING(s) _S(s)
1.108 +
1.109 +#if defined(_ASSERTIONS)
1.110 + #define __ASSERT(c) (void)((c)||(Util::Assert(__STRING(__FILE__),__LINE__),0))
1.111 +#else
1.112 + #define __ASSERT(c) void(0)
1.113 +#endif
1.114 +
1.115 +#if defined(_NOTIFY)
1.116 + #define __LEAVE(r) Util::Leave(__STRING(__FILE__),__LINE__,r)
1.117 + #define __LEAVE_IF_ERROR(r) Util::LeaveIfError(__STRING(__FILE__),__LINE__,r)
1.118 +#else
1.119 + #define __LEAVE(r) User::Leave(r)
1.120 + #define __LEAVE_IF_ERROR(r) User::LeaveIfError(r)
1.121 +#endif
1.122 +
1.123 +#if defined(_TRACE)
1.124 + #define __TRACEP() Util::Trace(__STRING(__FILE__),__LINE__)
1.125 + #define __TRACES(string) Util::Trace(__STRING(__FILE__),__LINE__,_S(string))
1.126 + #define __TRACE(exp) Util::Trace(__STRING(__FILE__),__LINE__,__STRING(#exp),exp)
1.127 +#else
1.128 + #define __TRACEP() void(0)
1.129 + #define __TRACES(string) void(0)
1.130 + #define __TRACE(exp) void(0)
1.131 +#endif
1.132 +
1.133 +#endif//__D32ASSERT_H__