main_epoc.cpp

Go to the documentation of this file.

// Defines a main function for running CL2 standalone, without being
// attached to any application.

#include "application_config.h"
#include "ac_app_context_private.h"
#include "kr_controller.h"
#include "client-run.h"
#include "epoc-ao-gerror.hpp"
#include "er_errors.h"

#include "common/utilities.h"

#include <e32base.h> // CTrapCleanup

#include <stdlib.h> // abort

static CActiveSchedulerWait* globalLoop = NULL;

// Immediate process exit.
extern "C" void ExitApplication()
{
  logt("ExitApplication");
  // This should make sure that the process gets killed, assuming it
  // is the main process that calls this.
  User::Exit(KErrGeneral);
}

// Orderly shutdown.
extern "C" void ShutdownApplication()
{
  logt("ShutdownApplication");
  if (globalLoop) {
    globalLoop->AsyncStop();
  } else {
    logt("error, no scheduler");
    ExitApplication();
  }
}

NONSHARABLE_CLASS(CMainObj) : 
  public CBase,
  public MAppContextInitObserver
{
 public:
  static CMainObj* NewL();
  ~CMainObj();
 private:
  void ConstructL();
 private: // MAppContextInitObserver
  void AppContextReady(TInt aError);
 private:
  kr_Controller* client;
};

CMainObj* CMainObj::NewL()
{
  CMainObj* obj = new (ELeave) CMainObj;
  CleanupStack::PushL(obj);
  obj->ConstructL();
  CleanupStack::Pop(obj);
  return obj;
}

CMainObj::~CMainObj()
{
  // Note that calling kr_Controller_stop is unnecessary since
  // destruction is quite sufficient for stopping.
  kr_Controller_destroy(client);
}

void CMainObj::ConstructL() // activates the object
{
  // Invokes AppContextReady upon completion.
  ac_AppContext_PlatInitAsyncL(ac_get_global_AppContext(), *this);
}

void CMainObj::AppContextReady(TInt aError)
{
  logt("app context ready");

  if (aError) {
    er_log_symbian(er_FATAL, aError, "error in app ctx async init");
    return; // not reached
  }

  GError* localError = NULL;

  client = kr_Controller_new(&localError);
  if (!client) {
    er_log_gerror(er_FATAL|er_FREE, localError, "error in client creation");
    return; // not reached
  }
    
  if (!kr_Controller_start(client, &localError)) {
    kr_Controller_destroy(client);
    er_log_gerror(er_FATAL|er_FREE, localError, "error starting client");
    return; // not reached
  }
}

static TInt MainLoop()
{
  globalLoop = new CActiveSchedulerWait;
  if (!globalLoop) {
    return KErrNoMemory;
  }

  CMainObj* mainObj = NULL;
  TRAPD(errCode, mainObj = CMainObj::NewL());
  if (errCode) {
    delete globalLoop;
    return errCode;
  }

  // Will not return unless/until explicitly stopped by
  // ShutdownApplication.
  globalLoop->Start();

  delete globalLoop;
  delete mainObj;

  return 0;
}

static TInt SubMain()
{
  TInt errCode = 0;
  errCode = cl2GlobalInit();
  if (errCode)
    return errCode;
  TRAPD(leaveCode, errCode = MainLoop());
  if (leaveCode) {
    assert(0 && "leave where not expected");
  }
  cl2GlobalCleanup();
  return errCode;
}

// On Symbian at least we might want to name this process so that it
// is easier to identify and kill. But actually we should have a
// sensible name to begin with, since we should get something like
// ekern.exe[100041af]0001, where we have the executable name, UID,
// and instance number.
// 
// Apparently also some Open C functions require that they are running
// under a TRAP. Naturally then a cleanup stack is surely also
// required. At present we are defining an E32Main rather than a main,
// so we shall do things explicitly.
// 
// In the Symbian case we must create an active scheduler within which
// to run; our event delivery mechanism requires this, and most
// certainly a lot of our system access code requires it. Note that to
// start the event loop, we must call CActiveScheduler::Start().
GLDEF_C TInt E32Main()
{
  TInt errCode = 0;
  __UHEAP_MARK;
  WITH_CLEANUP_STACK(WITH_ACTIVE_SCHEDULER(errCode = SubMain()));
  __UHEAP_MARKEND;
  return errCode;
}

/**

epoc-main.cpp

Copyright 2009 Helsinki Institute for Information Technology (HIIT)
and the authors. All rights reserved.

Authors: Tero Hasu <tero.hasu@hut.fi>

Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files
(the "Software"), to deal in the Software without restriction,
including without limitation the rights to use, copy, modify, merge,
publish, distribute, sublicense, and/or sell copies of the Software,
and to permit persons to whom the Software is furnished to do so,
subject to the following conditions:

The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

 **/