Script.h

Go to the documentation of this file.

// >>>>>>   @Date:2013/07/24    <Modify>    A.Ozaki
//
// Moved the ScriptClass to DataObjects library from CoreToolkits library.
//  ex.
//   CORE_TOOLKITS_CLASS -> DATA_OBJECTS_CLASS
//   core -> objects
//
// <<<<<<   @Date:2013/07/24    <Modify>    A.Ozaki

#ifndef __KOME_OBJECTS_SCRIPT_H__
#define __KOME_OBJECTS_SCRIPT_H__


#include <vector>
#include <set>

// >>>>>>   @Date:2013/07/29    <Add>   A.Ozaki
#include    "Variant.h"
#include    "Parameters.h"
// <<<<<<   @Date:2013/07/29    <Add>   A.Ozaki

namespace kome {
    namespace objects {

        class DATA_OBJECTS_CLASS Script {
        public:
            Script();

            virtual ~Script();

        protected:
            std::string m_script;

            struct VariableInfo {
                std::string name;
                std::string desc;
            };

            std::vector< VariableInfo > m_variables;

            static std::string m_filePath;

// >>>>>>   @Date:2013/07/29    <Add>   A.Ozaki
            kome::objects::Variant      m_refVariant;

            kome::objects::Parameters   *m_pParams;
// <<<<<<   @Date:2013/07/29    <Add>   A.Ozaki

        public:
            void setScript( const char* script );

            const char* getScript();

// >>>>>>   @Date:2013/07/29    <Add>   A.Ozaki
            void    setVariant( kome::objects::Variant &var );

            const kome::objects::Variant &getVariant( void );

            void    setParameters( kome::objects::Parameters *pParams );

            const kome::objects::Parameters *getParameters( void );
// <<<<<<   @Date:2013/07/29    <Add>   A.Ozaki

        public:
            std::string getTemplate();

        public:
// >>>>>>   @Date:2013/07/29    <Add>   A.Ozaki
            std::string run( const char* script, kome::objects::Variant &var, kome::objects::Parameters *pParams );
// <<<<<<   @Date:2013/07/29    <Add>   A.Ozaki

            std::string run();

        public:
            void clearVariables();

            void addVariable( const char* name, const char* desc );

            unsigned int getNumberOfVariables();

            const char* getVariableName( const unsigned int idx );

            const char* getVariableDescription( const unsigned int idx );

        public:
            static void setScriptFilePath( const char* path );

            static const char* getScriptFilePath();

        protected:
// >>>>>>   @Date:2013/07/29    <Add>   A.Ozaki
            virtual std::string onRun( const char* script, kome::objects::Variant &var, kome::objects::Parameters *pParams ) = 0;
// <<<<<<   @Date:2013/07/29    <Add>   A.Ozaki

            virtual std::string onGetTemplate() = 0;
        };

        class ScriptManager {
        protected:
            ScriptManager();

            virtual ~ScriptManager();

        protected:
            std::set< Script* > m_scriptSet;

        public:
            void addScript( Script* script );

            void removeScript( Script* script );

        public:
            static ScriptManager& getInstance();

        };

    }
}

#endif  // __KOME_OBJECTS_SCRIPT_H__