examples/Base/MemMan/Cleanup/LeaveOnFail/LeaveOnFail.cpp

/*
Copyright (c) 2000-2010 Nokia Corporation and/or its subsidiary(-ies). All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

* Redistributions of source code must retain the above copyright notice, this
  list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
  this list of conditions and the following disclaimer in the documentation
  and/or other materials provided with the distribution.
* Neither the name of Nokia Corporation nor the names of its contributors
  may be used to endorse or promote products derived from this software
  without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Description: 
Example shows attempt to construct an object and leaves on failure. 
NOTE: the structure of this example is different to standard E32 examples 
*/




#include <e32cons.h>

//
// Common literal text
//


_LIT(KCommonFormat1,"Value of iInt is %d.\n");


  // All messages written to this
LOCAL_D CConsoleBase* console;
  
  // Flag which determines whether the doSomething() member function
  // of the CExample class should leave when called.
LOCAL_D TBool leaveFlag = ETrue;

  // Parameter for __UHEAP_SETFAIL
  // Allocation guaranteed to fail at this number of allocation attempts;
  // i.e. if set to n, allocation fails on the nth attempt. 
  // NB only used in debug mode
#ifdef _DEBUG
LOCAL_D TInt allocFailNumber = 1;
#endif
  
  // Function prototypes
LOCAL_C void doExampleL();      
LOCAL_C void callExampleL();


//
// -----> CExample (definition)
//
// The class is used by the example code
//
class CExample : public CBase
        {
public :
        void DoSomethingL();
public :
        TInt iInt;
        };


//
// -----> CExample (implementation)
//
void CExample::DoSomethingL() 
        {
          // Leave if the global flag is set
        if (leaveFlag)
                {
                _LIT(KMsgLeaving,"DoSomethingL leaving.\n");
                console->Printf(KMsgLeaving);
                User::Leave(KErrGeneral);               
                }
        console->Printf(KCommonFormat1,iInt);
        }

//
// Main function called by E32
//
GLDEF_C TInt E32Main()
    {
          // Get cleanup stack
        CTrapCleanup* cleanup=CTrapCleanup::New();

          // Some more initialization, then do the example
        TRAPD(error,callExampleL());
          
          // callExampleL() should never leave.
        _LIT(KMsgPanicEpoc32ex,"EPOC32EX");
        __ASSERT_ALWAYS(!error,User::Panic(KMsgPanicEpoc32ex,error));

          // destroy the cleanup stack
        delete cleanup;
        
          // return
        return 0;
    }


//
//
//
LOCAL_C void callExampleL() 
    {
          // Initialize and call the example code under cleanup stack.
        _LIT(KMsgExampleCode,"Symbian platform Example Code");
        console = Console::NewL(KMsgExampleCode,TSize(KConsFullScreen,KConsFullScreen));
          // Put console onto the cleanup stack.
        CleanupStack::PushL(console);

          // Perform the example function under the protection of a 
          // TRAP harness.
        TRAPD(error,doExampleL());
        _LIT(KFormat2,"failed: leave code = %d");
        _LIT(KMsgOK,"ok");
        if (error)
                console->Printf(KFormat2,error);
        else
                console->Printf(KMsgOK);
          
          // Continue
        _LIT(KMsgPressAnyKey," [press any key]");
        console->Printf(KMsgPressAnyKey);
        console->Getch();

          // Remove the console object from the cleanupstack
          // and destroy it. 
        CleanupStack::PopAndDestroy();
    }


//
// Do the example
//
void doExampleL()
        {
          // Memory alloc fails on the 'allocFailNumber' attempt. 
        __UHEAP_SETFAIL(RHeap::EDeterministic,allocFailNumber);
          // Allocate - leave if allocation fails.
          // Leave is used in place of return to indicate an error.
          //
          // Could also use - User::LeaveIfNull(myExample);
        CExample* myExample = new CExample;
        if (!myExample) User::Leave(KErrNoMemory); 
          // Do something with the CExample object
        myExample->iInt = 5;
          //
        console->Printf(KCommonFormat1,myExample->iInt);
          // Delete the CExample object
        delete myExample;
        }

---