AbstractFrameLoader.h

Go to the documentation of this file.

/*****************************************************************************
 * Copyright (C) 2011 by Benjamin Hadorn (b_hadorn@bluewin.ch)
 *****************************************************************************
 * Project    : Zeus Base Library
 * Module     : AbstractFrameLoader
 * Package    : Zeus.ZeusBase
 * Author     : Benjamin Hadorn
 * Date       : 27.12.2011
 * System     : Zeus-Framework
 *****************************************************************************
 * Licence:                                                                  *
 *   This library is free software; you can redistribute it and/or modify    *
 *   it under the terms of the GNU Lesser General Public License as          *
 *   published by the Free Software Foundation; either version               *
 *   2.1 of the License, or (at your option) any later version.              *
 *                                                                           *
 *   This library is distributed in the hope that it will be useful,         *
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of          *
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the            *
 *   GNU Lesser General Public License for more details.                     *
 *                                                                           *
 *   You should have received a copy of the GNU Lesser General Public        *
 *   License along with this library; if not, write to the Free Software     *
 *   Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110, USA    *
 *****************************************************************************/

/*****************************************************************************
 * Changes:
 *  27.12.2011 bha: created zeus 2.0
 *****************************************************************************/

#ifndef AbstractFrameLoaderH
#define AbstractFrameLoaderH

#include <zeusbase/System/ZObject.h>
#include <zeusbase/System/PropertyFile.h>
#include <zeusbase/System/Directory.h>
#include <zeusbase/System/Interfaces/IXObject.hpp>

/***************************************************************************/
/***************************************************************************/
#define MStartZeusFramework(loggerclass, frameclass, retval) \
  TAutoPtr<ILogger> ptrStartLogger = new loggerclass();\
  TLoggerManager::getInstance().setRootLogger(ptrStartLogger);\
  TString strSingName = L"ILogger";\
  TSingletonManager::getInstance().addSingleton(strSingName, *ptrStartLogger);\
  \
  try\
  {\
    TAutoPtr<frameclass> ptrLoader = new frameclass(argc, argv);\
    ptrLoader->initialize();\
    if (ptrLoader->canStartup())\
    {\
      RootLogger.printfln(LOGMODE_INFO, "Start up zeus framework...");\
      RootLogger.indent();\
      ptrLoader->startup();\
      RootLogger.unindent();\
      RootLogger.printfln(LOGMODE_INFO, "done");\
      \
      retval = ptrLoader->run();\
      \
      RootLogger.printfln(LOGMODE_INFO, "Shutdown framework...");\
      RootLogger.indent();\
      ptrLoader->shutdown();\
      RootLogger.unindent();\
      RootLogger.printfln(LOGMODE_INFO, "...done");\
    }\
  }\
  catch(...)\
  {\
    RootLogger.unindent();\
    RootLogger.printfln(LOGMODE_INFO, "Exception received. Killing all life :-(");\
  }\



BEGIN_NAMESPACE_Zeus

class TArgumentParser;

/***************************************************************************/
/***************************************************************************/
zeusbase_class TAbstractFrameLoader : public TZObject
{
  public:
    TAbstractFrameLoader(const TString& strBaseName);
    TAbstractFrameLoader(const TString& strBaseName,
                         int iArgc, char* apArgs[]);
    TAbstractFrameLoader(const TString& strBaseName,
                         int iArgc, wchar_t* awcArgs[]);

    virtual void initialize();
    virtual bool canStartup();
    virtual Retval startup();
    virtual Retval shutdown();
    virtual Int run()=0;

    Retval getRootObject(IXObject*& rpRoot);

  protected:
    virtual ~TAbstractFrameLoader();
    virtual Retval buildXObjectTree(TString strFileName = L"");
    void registerClasses();

    //Initialisation methods
    virtual Retval initProperties();
    virtual Retval initSecurity();
    virtual Retval initSystemLibraries();
    virtual void initSystem();

    virtual void onInitPropertiesFailed()      {}
    virtual void onInitSecurityFailed()        {}
    virtual void onInitSystemLibrariesFailed() {}

    TDirectory m_WorkingDir;
    //Base directory;
    TAutoPtr<TDirectory> m_ptrBaseDirectory;
    TFile m_ModuleFile;
    TAutoPtr<IXObject> m_ptrRootObject;
    TAutoPtr<TPropertyFile> m_ptrSystemSettings;
    TString m_strPropertyFileName;
    TString m_strConfigFileName;
    TArgumentParser& m_rArgumentParser;
    Uint m_uiSecurityHandle;

  private:
    bool m_bInitialized;
    bool m_bStartedUp;
    TString m_strBaseName;

    void create();
    void releaseXRootObject();
};

//INLINE METHODS
/***************************************************************************/
/***************************************************************************/
inline bool TAbstractFrameLoader::canStartup()
{
  return true;
}

END_NAMESPACE_Zeus

#endif