gmSimulation.h

Go to the documentation of this file.

/************************************************************************
**
** Copyright (C) 2014 by Carlos Augusto Teixera Mendes
** All rights reserved.
**
** This file is part of the "GeMA" software. It's use should respect
** the terms in the license agreement that can be found together 
** with this source code.
** It is provided AS IS, with NO WARRANTY OF ANY KIND, 
** INCLUDING THE WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR 
** A PARTICULAR PURPOSE.
**
************************************************************************/

#ifndef _GEMA_SIMULATION_H_
#define _GEMA_SIMULATION_H_

#include "gmConfig.h"
#include <gmLog.h>

#include <QString>
#include <QObject>
#include <QMutex>

class GmSimulationData;
class GmSimulationLoader;
class GmPluginLoader;
class GmPath;
class GmThreadManager;
class GmTaskManager;

class GmCommServer;

class LuaEnv;
struct lua_State;

enum GmSimulationResult
{
  GM_RESULT_OK = 0,    
  GM_RESULT_CANCELED,  
  GM_RESULT_ABORTED,   
};


class GM_API_EXPORT GmSimulation : public QObject
{
  Q_OBJECT

public:
  GmSimulation();
  ~GmSimulation();

  enum LogModes
  {
    QUIET_LOG_MODE      = 0x001,  
    VERBOSE_LOG_MODE    = 0x002,  
    NOCONSOLE_LOG_MODE  = 0x004,  
    REGRESSION_LOG_MODE = 0x008,  
    MEMORY_LOG_MODE     = 0x010,  
    NOMEMORY_LOG_MODE   = 0x020,  
    TIME_LOG_MODE       = 0x040,  
    NOTIME_LOG_MODE     = 0x080,  
    SERVER_LOG_MODE     = 0x100,  
    NOSERVER_LOG_MODE   = 0x200,  
    PLUGININFO_LOG_MODE = 0x400,  
    TIMESTATS_LOG_MODE  = 0x800,  
  };

  enum ServerMode
  {
    CONFIG_SERVER_MODE,   
    ENABLE_SERVER_MODE,   
    DISABLE_SERVER_MODE,  
    LOCAL_SERVER_MODE,    
  };

  bool initLibrary(QString configFile, QString logFile, int logMode,
                   QString logPath, QString inputPath, QString outputPath, 
                   ServerMode serverMode, unsigned localServerPort,
                   QString serverAddrFile, bool rsrcFiles);

  bool initSimulation(QString simulationFile, const QMap<QString, QString>& globalVars,
                      int timeout = -1, lua_State* state = NULL);

  GmSimulationResult run();

  void clear() { setData(NULL); }

  void printInfo();

  const GmLogCategory& logger() { return _logger; }

  LuaEnv* env() { return _env; }

  GmSimulationData* data() const { return _simulationData; }

  GmPluginLoader* pluginLoader() const;

  const GmPath* paths() const { return _paths; }


signals:
  void sectionParsed(QString section, LuaTable& data);

private slots:
  void cancelRequested();

private:
  bool setConfigFile(QString configFile, QString logFile, int logMode, 
                     ServerMode serverMode, unsigned localServerPort, QString serverAddrFile);

  bool setSimulationFile(QString file, const QMap<QString, QString>& globalVars, lua_State* state);

  bool setupLogging         (LuaEnv& env, QString logFile, int logMode);
  bool setupMonitorServer   (LuaEnv& env, ServerMode serverMode, unsigned localServerPort, bool logToServer, QString serverAddrFile);
  bool setupUnitManager     (LuaEnv& env);
  bool loadConfigValueTables(LuaEnv& env);

  void setData(GmSimulationData* data);
  void clearDataOnError(bool abort);

  void printPluginVersions(GmLogCategory& logger);

  GmSimulationData*    _simulationData;   
  GmSimulationLoader*  _simulationLoader; 
  GmPath*              _paths;            
  QVariantMap          _configConstants;  
  QVariantMap          _configOptions;    
  bool                 _rsrcFiles;        

  GmLogCategory        _logger;           

  GmCommServer*        _monitorServer;    

  QMutex _envMutex;         

  LuaEnv* _env;
  bool    _externalState; 
  bool    _redirectPrint; 
  bool    _loadCompleted; 

  QList<LuaEnv*> _workerEnvList;  
};

#endif