Public API Reference

cstool/csapplicationframework.h

Go to the documentation of this file.

/*
  Copyright (C) 2003 by Odes B. Boatwright.

  This library is free software; you can redistribute it and/or
  modify it under the terms of the GNU Library General Public
  License as published by the Free Software Foundation; either
  version 2 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
  Library General Public License for more details.

  You should have received a copy of the GNU Library General Public
  License along with this library; if not, write to the Free
  Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
*/

#ifndef __CS_CSAPPLICATIONFRAMEWORK_H__
#define __CS_CSAPPLICATIONFRAMEWORK_H__

#include "csextern.h"

#include "cstool/initapp.h"
#include "ivaria/reporter.h"

class CS_CRYSTALSPACE_EXPORT csApplicationFramework : public csInitializer
{
private:
  static csApplicationFramework* m_Ptr;

  static const char* m_FoundationStringName;

  static char* m_ApplicationStringName;
  
  bool restartFlag;
protected:
  csApplicationFramework ();

  static bool Initialize (int argc, char* argv[]);

  static bool Start ();

  static void End ();
public:
  virtual ~csApplicationFramework ();

  static void Quit ();

protected:
  static iObjectRegistry* object_reg;
  
  virtual bool OnInitialize (int argc, char* argv[]) = 0;

  virtual bool Application () = 0;

  virtual void OnExit ();

  virtual void OnCommandLineHelp ();

  static bool SetupConfigManager (iObjectRegistry* object_reg, 
    const char* configName)
  { 
    return csInitializer::SetupConfigManager (object_reg, configName, 
      GetApplicationName());
  }
public:
  // Inline Helper Functions
  static iObjectRegistry* GetObjectRegistry () { return object_reg; };

  operator iObjectRegistry* () { return object_reg; }

  bool Open () { return OpenApplication (object_reg); }

  static void SetApplicationName (char *name)
  {
    m_ApplicationStringName = name;
  }

  static const char* GetApplicationName ()
  {
    return m_ApplicationStringName ? m_ApplicationStringName : 
      GetDefaultAppID();
  }

  static void Run ()
  {
    csDefaultRunLoop (object_reg);
  }

  void Restart();
private:
  static bool ReportLibError (const char* description, ...)
  {
    va_list args;
    va_start (args, description);
    csReportV (object_reg, CS_REPORTER_SEVERITY_ERROR,
      m_FoundationStringName,
      description, args);
    va_end (args);
    return false;
  }

public:
  static bool ReportError (const char* description, ...)
  {
    va_list args;
    va_start (args, description);
    csReportV (object_reg, CS_REPORTER_SEVERITY_ERROR,
      GetApplicationName(),
      description, args);
    va_end (args);
    return false;
  }

  static void ReportWarning (const char* description, ...)
  {
    va_list args;
    va_start (args, description);
    csReportV (object_reg, CS_REPORTER_SEVERITY_WARNING,
      GetApplicationName(),
      description, args);
    va_end (args);
  }
  
  static void ReportInfo (const char* description, ...)
  {
    va_list args;
    va_start (args, description);
    csReportV (object_reg, CS_REPORTER_SEVERITY_NOTIFY,
      GetApplicationName(),
      description, args);
    va_end (args);
  }
  
  int Main (int argc, char* argv[]);

  bool DoRestart();
};

template <class T>
class csApplicationRunner
{
public:
  static int Run (int argc, char* argv[])
  {
    int result;
    bool again;
    do
    {
      T app;
      result = app.Main (argc, argv);
      again = app.DoRestart();
    }
    while (again);
    return result;
  }
};

#endif //__CS_CSAPPLICATIONFRAMEWORK_H__

---