examples/SysLibs/CommonFramework/CommonFramework.h

00001 /*
00002 Copyright (c) 2000-2010 Nokia Corporation and/or its subsidiary(-ies). All rights reserved.
00003 
00004 Redistribution and use in source and binary forms, with or without
00005 modification, are permitted provided that the following conditions are met:
00006 
00007 * Redistributions of source code must retain the above copyright notice, this
00008   list of conditions and the following disclaimer.
00009 * Redistributions in binary form must reproduce the above copyright notice,
00010   this list of conditions and the following disclaimer in the documentation
00011   and/or other materials provided with the distribution.
00012 * Neither the name of Nokia Corporation nor the names of its contributors
00013   may be used to endorse or promote products derived from this software
00014   without specific prior written permission.
00015 
00016 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
00017 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00018 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
00019 DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
00020 FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
00021 DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
00022 SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
00023 CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
00024 OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
00025 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00026 
00027 Description:  
00028 */
00029 
00030 
00031 
00032 #ifndef __CommonFramework_H
00033 #define __CommonFramework_H
00034 
00035 #include <e32base.h>
00036 #include <e32cons.h>
00037 
00038 _LIT(KTxtEPOC32EX,"EXAMPLES");
00039 _LIT(KTxtExampleCode,"Symbian platform Example Code");
00040 _LIT(KFormatFailed,"failed: leave code=%d");
00041 _LIT(KTxtOK,"ok");
00042 _LIT(KTxtPressAnyKey," [press any key]");
00043 
00044 // public
00045 LOCAL_D CConsoleBase* console; // write all your messages to this
00046 LOCAL_C void doExampleL(); // code this function for the real example
00047 
00048 // private
00049 LOCAL_C void callExampleL(); // initialize with cleanup stack, then do example
00050 
00051 GLDEF_C TInt E32Main() // main function called by E32
00052     {
00053         __UHEAP_MARK;
00054         CTrapCleanup* cleanup=CTrapCleanup::New(); // get clean-up stack
00055         TRAPD(error,callExampleL()); // more initialization, then do example
00056         __ASSERT_ALWAYS(!error,User::Panic(KTxtEPOC32EX,error));
00057         delete cleanup; // destroy clean-up stack
00058         __UHEAP_MARKEND;
00059         return 0; // and return
00060     }
00061 
00062 LOCAL_C void callExampleL() // initialize and call example code under cleanup stack
00063     {
00064         console=Console::NewL(KTxtExampleCode,TSize(KConsFullScreen,KConsFullScreen));
00065         CleanupStack::PushL(console);
00066         TRAPD(error,doExampleL()); // perform example function
00067         if (error)
00068                 console->Printf(KFormatFailed, error);
00069         else
00070                 console->Printf(KTxtOK);
00071         console->Printf(KTxtPressAnyKey);
00072         console->Getch(); // get and ignore character
00073         CleanupStack::PopAndDestroy(); // close console
00074     }
00075 
00076 #endif

Generated by  doxygen 1.6.2