VirtualMachine.h

Go to the documentation of this file.

/*
  Copyright (C) 2008 National Institute For Space Research (INPE) - Brazil.

  This file is part of the TerraLib - a Framework for building GIS enabled
  applications.

  TerraLib 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 3 of the License,
  or (at your option) any later version.

  TerraLib 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 TerraLib. See COPYING. If not, write to
  TerraLib Team at <terralib-team@terralib.org>.
 */

/*!
  \file terralib/vm/core/VirtualMachine.h

  \brief An abstract class that defines a Virtual Machine for executing code in
  any TerraLib supported language.

  \author Frederico Augusto Bedê
  \author Gilberto Ribeiro de Queiroz
*/

#ifndef __TERRALIB_VM_CORE_VIRTUALMACHINE_H__
#define __TERRALIB_VM_CORE_VIRTUALMACHINE_H__

// TerraLib
#include "Config.h"

// STL
#include <string>

// QT
#include <QObject>

// Boost
#include <boost/noncopyable.hpp>

namespace te
{
  namespace vm
  {
    namespace core
    {
      class TEVMEXPORT VirtualMachine : public QObject,
                                        public boost::noncopyable
      {
        Q_OBJECT
       public:
        /*!
          \brief VirtualMachine
         */
        VirtualMachine()
        {
        }

        /*!
          \brief Virtual destructor.
         */
        virtual ~VirtualMachine()
        {
        }

        /*!
          \Return the name of the Virtual Machine: it is also an identifier
           about the VM type.
         */
        virtual std::string getName() const = 0;

        /*!
          \brief Return the title of Virtual Machine: a name that can be used
           by applications to show in a GUI.
         */
        virtual std::string getTitle() const = 0;

        /*!
          \brief Returns a brief description about the underlying Virtual
           Machine.
         */
        virtual std::string getDescription() const = 0;

        /*!
          \brief setFileName Sets the file that will be used in the Virtual
          Machine.
          \param file The full path filename.
         */
        virtual void setFileName(QString file) = 0;

        /*!
          \brief readline Method to be used by the language of the Virtual
           Machine when doing a input operation.
          \return A string containing the user input.
         */
        virtual std::string readline() = 0;

       public slots:
        /*!
          \brief write Writes the output coming from the Virtual Machine
          \param str The out put string received.
         */
        virtual void write(const QString& str) = 0;
        /*!
          \brief stop Stops the current running script.
         */
        virtual void stop() = 0;
        /*!
          \brief execute Executes the script file previously set.
         */
        virtual void execute() = 0;

        /*!
          \brief readline Reads a user input.
          \param msg String of the input.
         */
        virtual void readline(QString msg) = 0;
       signals:
        /*!
          \brief Signal emmited when the Virtual Machine needs to execute a
          input operation.
         */
        void requestReadline();
        /*!
          \brief output Signal emmited when the Virtual Machine receives a
           string.
          \param msg String received from the Virtual Machine.
         */
        void output(QString msg);
      };
    }  // end namespace core
  }    // end namespace vm
}  // end namespace te
#endif  // __TERRALIB_VM_CORE_VIRTUALMACHINE_H__