• Main
• Home
• Features
• Screenshots
• Downloads
• License
• Team profile
• Documentation
• Manual
• FAQ
• Reference

Search this page:

PCMApplication.h

Go to the documentation of this file.

//
// This source file is a part of ParCompMark
// Parallel Compositing Benchmark Framework
//
// for latest info see http://parcompmark.sourceforge.net

//
// Copyright (C) 2006 IT2 ParCompMark Dev. Team
// 
// This program is free software; you can redistribute it and/or
// modify it under the terms of the GNU General Public License
// as published by the Free Software Foundation; either version 2
// of the License, or (at your option) any later version.
// 
// This program 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 General Public License for more details.
// 
// You should have received a copy of the GNU General Public License
// along with this program; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.


#ifndef __PCM_APPLICATION_H__
#  define __PCM_APPLICATION_H__

//
// Inner includes
//

#  include "PCMPremeditations.h"

#  include "PCMSingleton.h"

#  include "PCMException.h"

#  include "PCMLogger.h"

#  include "PCMPointer.h"

#  include "PCMNetServer.h"

#  include "PCMNetClient.h"

#  include "PCMStringConverter.h"

#  include "PCMCluster.h"

#  include "PCMHost.h"

#  include "PCMHostInfo.h"

#  include "PCMConfigOptions.h"

#  include "PCMPluginManager.h"

//
// Outer includes
//

#  include <readline/readline.h>

#  include <readline/history.h>

//
// Scripting bind includes (for Squirrel)
//

#  include <squirrel/squirrel.h>
#  include <squirrel/sqstdio.h>
#  include <squirrel/sqstdaux.h>
#  include <squirrel/sqplus.h>

namespace ParCompMark
{

  class Application:public Singleton < Application >
  {

        //
        // Unit test class
        //
#  ifdef PARCOMPMARK_TEST
        friend class ParCompMarkTest::TestApplication;
#  endif

        //
        // Scripting binding (for Squirrel)
        //



   public:static void squirrelGlue()
        {
         ::SqPlus::SQClassDef < Application > (_T("Application")).staticFunc(&Application::getInstance,
                                                                                _T("getInstance")).
                func(&Application::loadLowLevelScript, _T("loadLowLevelScript")).func(&Application::loadDynamicScript,
                                                                                  _T("loadDynamicScript")).
                func(&Application::loadScenarioScript, _T("loadScenarioScript")).func(&Application::pushSquirrelCommand,
                                                                                  _T("pushSquirrelCommand")).
                func(&Application::quit, _T("quit")).func(&Application::compileDynamic,
                                                        _T("compileDynamic")).func(&Application::start,
                                                                                  _T("start")).
                func(&Application::stop, _T("stop")).func(&Application::autoDetection,
                                                        _T("autoDetection")).func(&Application::cleanup,
                                                                                 _T("cleanup")).
                func(&Application::getHostListForSquirrel,
                  _T("getHostListForSquirrel")).func(&Application::getLowLevelScriptForSquirrel,
                                                        _T("getLowLevelScriptForSquirrel")).
                func(&Application::getDynamicScriptForSquirrel,
                  _T("getDynamicScriptForSquirrel")).func(&Application::hasScenarioScript,
                                                          _T("hasScenarioScript")).
                func(&Application::getDynamicScriptParametersForSquirrel,
                  _T("getDynamicScriptParametersForSquirrel")).func(&Application::getProgramInfo,
                                                                   _T("getProgramInfo")).
                staticFunc(&Application::getExpectedHostCount,
                         _T("getExpectedHostCount")).func(&Application::getDynamicScriptCompiled,
                                                         _T("getDynamicScriptCompiled")).
                func(&Application::setDynamicScriptCompiled,
                  _T("setDynamicScriptCompiled")).func(&Application::getCompRun, _T("getCompRun"));
        }


        //
        // Enumerations
        //

   protected:

        enum PostCommand
        {

         NOTHING,

         LOADSCENARIO,

         LOADDYNAMIC,

         COMPILE,

         START,

         COMPILE_START,

         STOP,

         QUIT,

         STOP_QUIT
        };

        enum DynamicScriptParameterType
        {

         STRING = 0,

         INTEGER = 1,

         REAL = 2,

         BOOL = 3
        };

        enum UserInterface
        {

         NONE,

         CONSOLE
        };

        //
        // Typedefs
        //

   protected:

        typedef struct

        {               
         s8 shortName;                                    
          std::string longName;                                                                            
          std::string description;                                                                                                                                        
         bool hasArgument;                                                                                                                                                                                                                      
         void (*handler) (const std::string &);
        } CommandLineOption;

        typedef struct

        {               
         std::string name;                                                       
         DynamicScriptParameterType type;                                                                                                         
          std::string description;                                                                                                                                                                                        
          std::set < std::string > possibleValues;                                                                                                                                                                                                                                                                                                                               
          std::string defaultValue;
        } DynamicScriptParameter;

        //
        // Class constants
        //



   public:

        static const std::string PCAPINUT;

        static const std::string PARCOMPMARKNUT;

        static const std::string UTILSNUT;

        static const std::string ABBREVIATIONSNUT;

        static const std::string DYNAMICINITNUT;

        static const std::string UIINITNUT;

        static const std::string COMMANDDIRECTORY;

        static const std::string HELPNUT;

        static const std::string PCIMPLEMENTATIONS[];

   protected:

        static const Application::CommandLineOption mCommandLineOptions[];

        static const u32 mCommandLineOptionCount;

        static const std::string mUsageString;


        //
        // Class variables
        //



   protected:

        static std::string mLibrarySearchPath;

        static bool mCommanderMode;

        static bool mGUIMode;

        static bool mManualClusterDescription;

        static std::string mClusterDescription;

        static bool mLowLevelMode;

        static bool mInteractiveParameters;

        static std::string mParameters;

        static std::string mInput;

        static std::string mOutput;

        static int mExpectedHostCount;

        static UserInterface mUserInterface;


        //
        // Variables
        //



   protected:

        HostInfo * mHostInfo;

        bool mInitialized;

        PostCommand mPostCommand;

        bool mQuiting;

        bool mOutputIsDone;

        OutputNode::Pointer mOutputDocument;

        OutputNode::Pointer mCurrentExecutionOutputDocument;

        u32 mExecutionIndex;

        OutputNode::Pointer mCollectClusterDescription;

        ConfigOptions::Pointer mConfigOptions;

        std::string mLowLevelScript;

        std::string mDynamicScript;

        std::string mScenarioScript;

        std::list < std::string > mSquirrelCommandList;

        bool mDynamicScriptCompiled;

        NetServer *mServer;

        NetClient *mClient;

        bool mCompRun;

        SqVM::Pointer mDynamicScriptSqVM;

        SqVM::Pointer mUserInterfaceSqVM;

        std::list < DynamicScriptParameter * >mDynamicScriptParameters;


        //
        // Constructors & destructor
        //



   public:

        Application();

        virtual ~ Application();


        //
        // Getters & setters
        //



   public:

        static const std::string & getLibrarySearchPath();

        static void setLibrarySearchPath(const std::string & librarysearchpath);

        HostInfo *getHostInfo() const;

        const bool & getInitialized() const;

        const Application::PostCommand & getPostCommand() const;

        const bool & getQuiting() const;

        const bool & getOutputIsDone() const;

        OutputNode::Pointer & getOutputDocument();

        OutputNode::Pointer & getCurrentExecutionOutputDocument();

        u32 & getExecutionIndex();

        OutputNode::Pointer & getCollectClusterDescription();

        ConfigOptions::Pointer & getConfigOptions();

        const std::string & getLowLevelScript() const;

        const std::string & getDynamicScript() const;

        const std::string & getScenarioScript() const;

        const std::list < std::string > &getSquirrelCommandList() const;

        bool & getDynamicScriptCompiled();

        void setDynamicScriptCompiled(const bool dynamicscriptcompiled);

        NetServer *getServer() const;

        NetClient *getClient() const;

        static const std::string & getUsageString();

        static const bool & getCommanderMode();

        static const bool & getGUIMode();

        static const bool & getManualClusterDescription();

        static const std::string & getClusterDescription();

        static const bool & getLowLevelMode();

        static const bool & getInteractiveParameters();

        static const std::string & getParameters();

        static const std::string & getInput();

        static const std::string & getOutput();

        static int &getExpectedHostCount();

        static const Application::UserInterface & getUserInterface();

        bool & getCompRun();


        //
        // Class methods
        //



   public:

        static int complement(int first, int second);

        static void parseCommandLine(const u32 & argc, const char **&argv);

        static void showHelp(const std::string & strarg);

        static void showVersion(const std::string & strarg);

        static void setCommanderOn(const std::string & strarg);

        static void setGUIOn(const std::string & strarg);

        static void setLowLevelOn(const std::string & strarg);

        static void setLowLevelScriptFile(const std::string & strarg);

        static void setDynamicScriptFile(const std::string & strarg);

        static void setScenarioScriptFile(const std::string & strarg);

        static void setCluster(const std::string & strarg);

        static void setParameters(const std::string & strarg);

        static void setInput(const std::string & strarg);

        static void setOutput(const std::string & strarg);

        static void setExpectedHostCount(const std::string & hostCount);

        static void setUserInterface(const std::string & strUI);

        static bool hasEnvironmentVariable(const std::string & name);

        static std::string getEnvironmentVariable(const std::string & name);

        static void terminateHandler();

        static void terminateHandlerNOP();

        static void unexpectedHandler();

        static void segfaultHandler(int value);

        static void interruptHandler(int value);

        static Application *getInstance();


        //
        // Methods
        //



   public:

        virtual void setupHandlers() const;

        virtual void initialize();

        virtual void finalize();

        virtual void finalizeCommander();

        virtual void finalizeSoldier();

        virtual void setFromConfigOptions();

        virtual void createVirtualMachines();

        virtual bool startOperation();

        virtual void writeOutput();

        virtual void waitForOutput();

        virtual void quit();

        virtual void compileDynamic();

        virtual void start();

        virtual void stop();

        virtual void autoDetection();

        virtual void cleanup();

        virtual char *getHostListForSquirrel();

        virtual char *getLowLevelScriptForSquirrel();

        virtual char *getDynamicScriptForSquirrel();

        virtual bool hasScenarioScript();

        virtual char *getDynamicScriptParametersForSquirrel();

        virtual char *getProgramInfo();

        virtual void calculateMessageSendTime();

        virtual void _pseudoStop();

   protected:

        virtual bool commanderOperation();

        virtual bool soldierOperation();

        virtual bool textUserInterface();

        virtual bool noUserInterface();

        virtual bool executeUserCommand(const std::string & command);

        virtual bool processSquirrelCommandList();

        virtual void doPostCommand();

        virtual void loadLowLevelScript(const char *filename);

        virtual void loadDynamicScript(const char *filename);

        virtual void loadScenarioScript(const char *filename);

        virtual void pushSquirrelCommand(const char *command);

        virtual void createLowLevelScript(const std::string & clusterDescription);

        virtual void processScenarioScript();

        virtual void setEnvironmentVariablesToSquirrel();

        virtual void initializeDynamicScriptParameters(const bool & reset);

        virtual void retrieveDynamicScriptParameters();

        virtual void _loadScenario();

        virtual void _loadDynamic();

        virtual void _compileDynamic();

        virtual void _start();

        virtual void _stop();

        virtual void _quit();


  };

  //
  // Include header implementation
  //

#  include "PCMApplication_impl.h"

}

// Declare Application class (and its enums) for SqPlus binding
DECLARE_INSTANCE_TYPE_NAME(ParCompMark::Application, Application);

#endif

© Copyright - 2006 (IT)² ParCompMark Dev. Team