core/interpreter.h

Go to the documentation of this file.

/***************************************************************************
 * interpreter.h
 * This file is part of the KDE project
 * copyright (C)2004-2006 by Sebastian Sauer (mail@dipe.org)
 *
 * This program 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 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
 * Library General Public License for more details.
 * You should have received a copy of the GNU Library General Public License
 * along with this program; see the file COPYING.  If not, write to
 * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
 * Boston, MA 02110-1301, USA.
 ***************************************************************************/

#ifndef KROSS_INTERPRETER_H
#define KROSS_INTERPRETER_H

#include "errorinterface.h"

#include <QtCore/QStringList>
#include <QtCore/QVariant>
#include <QtCore/QMap>
#include <QtCore/QObject>

namespace Kross {

    // Forward declaration.
    class Manager;
    class Action;
    class Script;
    class Interpreter;

    class KROSSCORE_EXPORT InterpreterInfo
    {
        public:

            class Option
            {
                public:

                    typedef QMap< QString, Option* > Map;

                    Option(const QString& comment, const QVariant& value)
                        : comment(comment), value(value) {}

                    QString comment;

                    QVariant value;
            };

            InterpreterInfo(const QString& interpretername, void* funcPtr, const QString& wildcard, const QStringList& mimetypes, const Option::Map& options = Option::Map());

            ~InterpreterInfo();

            const QString interpreterName() const;

            const QString wildcard() const;

            const QStringList mimeTypes() const;

            bool hasOption(const QString& name) const;

            Option* option(const QString& name) const;

            Option::Map& options();

            const QVariant optionValue(const QString& name, const QVariant& defaultvalue = QVariant()) const;

            Interpreter* interpreter();

        private:
            class Private;
            Private* const d;
    };

    class KROSSCORE_EXPORT Interpreter : public QObject, public ErrorInterface
    {
            Q_OBJECT
        public:

            explicit Interpreter(InterpreterInfo* info);

            virtual ~Interpreter();

            InterpreterInfo* interpreterInfo() const;

            virtual Script* createScript(Action* Action) = 0;

        private:
            class Private;
            Private* const d;
    };

}

#endif