os/ossrv/lowlevellibsandfws/genericusabilitylib/inc/emisc.h
author sl
Tue, 10 Jun 2014 14:32:02 +0200 (2014-06-10)
changeset 1 260cb5ec6c19
permissions -rw-r--r--
Update contrib.
sl@0
     1
// Copyright (c) 2008-2009 Nokia Corporation and/or its subsidiary(-ies).
sl@0
     2
// All rights reserved.
sl@0
     3
// This component and the accompanying materials are made available
sl@0
     4
// under the terms of "Eclipse Public License v1.0"
sl@0
     5
// which accompanies this distribution, and is available
sl@0
     6
// at the URL "http://www.eclipse.org/legal/epl-v10.html".
sl@0
     7
//
sl@0
     8
// Initial Contributors:
sl@0
     9
// Nokia Corporation - initial contribution.
sl@0
    10
//
sl@0
    11
// Contributors:
sl@0
    12
//
sl@0
    13
// Description:
sl@0
    14
//
sl@0
    15
sl@0
    16
#ifndef EMISC_H
sl@0
    17
#define EMISC_H
sl@0
    18
sl@0
    19
#include <e32base.h>
sl@0
    20
sl@0
    21
/**
sl@0
    22
	@file
sl@0
    23
sl@0
    24
	Miscellaneous utilities that can help make code more readable.
sl@0
    25
*/
sl@0
    26
sl@0
    27
/**
sl@0
    28
   A convenience postfix macro that is equivalent to wrapping the
sl@0
    29
   preceding expression with User::LeaveIfError().
sl@0
    30
sl@0
    31
   The code:
sl@0
    32
   @code
sl@0
    33
   fs.Connect() OR_LEAVE;
sl@0
    34
   @endcode
sl@0
    35
sl@0
    36
   is equivalent to:
sl@0
    37
sl@0
    38
   @code
sl@0
    39
   User::LeaveIfError(fs.Connect());
sl@0
    40
   @endcode
sl@0
    41
sl@0
    42
   The implementation happens to rely on overloading operator|| for
sl@0
    43
   TLeave. However, this macro is not intended for use within general
sl@0
    44
   expressions, just to guard individual calls to methods that may
sl@0
    45
   return an error code.
sl@0
    46
 */
sl@0
    47
#define OR_LEAVE || ELeave
sl@0
    48
sl@0
    49
/**
sl@0
    50
   Enabling overload for OR_LEAVE. Should only be invoked via
sl@0
    51
   OR_LEAVE, never directly.
sl@0
    52
 */
sl@0
    53
inline void operator||(TInt aStatus, TLeave /*aTag*/)
sl@0
    54
	{
sl@0
    55
	User::LeaveIfError(aStatus);
sl@0
    56
	}
sl@0
    57
sl@0
    58
#endif // !EMISC_H
sl@0
    59