kjsinterpreter.h

Go to the documentation of this file.

/*
 *  This file is part of the KDE libraries
 *  Copyright (C) 2008 Harri Porten (porten@kde.org)
 *
 *  This library 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 library 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 library; see the file COPYING.LIB.  If not, write to
 *  the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
 *  Boston, MA 02110-1301, USA.
 *
 */

#ifndef KJSINTERPRETER_H
#define KJSINTERPRETER_H

#include "kjsapi_export.h"
#include "kjsobject.h"
#include "kjscontext.h"

class KJSPrototype;
class KJSInterpreter;
class KJSInterpreterHandle;
class KJSResultHandle;

class KJSAPI_EXPORT KJSResult
{
    friend class KJSInterpreter;
public:
    KJSResult();
    KJSResult(const KJSResult&);
    KJSResult& operator=(const KJSResult&);
    ~KJSResult();
    bool isException() const;

    QString errorMessage() const;
    /*
     * If the evaluation was successful, i.e. isException() is false
     * this function returns the value returned by the script. Can be
     * an "undefined" (isUndefined()) value.
     */
    KJSObject value() const;

private:
    KJSResultHandle* hnd;
};

class KJSAPI_EXPORT KJSInterpreter
{
    friend class KJSResult;
    friend class KJSPrototype;
    friend class KJSContext;
public:
    KJSInterpreter();
    KJSInterpreter(const KJSGlobalObject& global);
    KJSInterpreter(const KJSInterpreter& other);
    KJSInterpreter& operator=(const KJSInterpreter& other);
    ~KJSInterpreter();

    KJSContext* globalContext();
    const KJSContext* globalContext() const;
    KJSObject globalObject();
    KJSResult evaluate(const QString& sourceURL, int startingLineNumber,
                       const QString& code,
                       KJSObject* thisValue = 0);
    KJSResult evaluate(const QString& code,
                       KJSObject* thisValue = 0);

    static bool normalizeCode(const QString& codeIn, QString* codeOut,
                              int* errLine = 0, QString* errMsg = 0);
private:
    KJSInterpreter(KJSInterpreterHandle* h);
    KJSInterpreterHandle* hnd;
    KJSContext globCtx;
};

#endif