/****************************************************************************
** $Id: qsinterpreter.h  1.1.5   edited 2006-02-23T15:39:57$
**
** Copyright (C) 2001-2006 Trolltech AS.  All rights reserved.
**
** This file is part of the Qt Script for Applications framework (QSA).
**
** This file may be distributed and/or modified under the terms of the
** GNU General Public License version 2 as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL included in the
** packaging of this file.
**
** Licensees holding a valid Qt Script for Applications license may use
** this file in accordance with the Qt Script for Applications License
** Agreement provided with the Software.
**
** This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
** WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
**
** See http://www.trolltech.com/pricing.html or email sales@trolltech.com for
**   information about QSA Commercial License Agreements.
** See http://www.trolltech.com/gpl/ for GPL licensing information.
**
** Contact info@trolltech.com if any conditions of this licensing are
** not clear to you.
**
*****************************************************************************/

#ifndef QSINTERPRETER_H
#define QSINTERPRETER_H

#include "qsaglobal.h"
#include "qsproject.h"
#include "qsargument.h"

#include <qobject.h>
#include <qvariant.h>
#include <qobjectlist.h>

class QSProject;
class QSInterpreterPrivate;
class QuickInterpreter;
class QSObjectFactory;
class QSWrapperFactory;

class QSA_EXPORT QSStackFrame
{
public:
  QSStackFrame(const QString &fun = QString::null,
               const QString &file = QString::null,
               int line = 0,
               QObject *con = 0) :
    fname(file), func(fun), ln(line), cont(con) {
  }

  QString scriptName() const {
    return fname;
  }
  QString function() const {
    return func;
  }
  int line() const {
    return ln;
  }
  QObject *context() const {
    return cont;
  }
private:
  QString fname, func;
  int ln;
  QObject *cont;
};

bool operator==(const QSStackFrame &a, const QSStackFrame &b);

class QSA_EXPORT QSStackTrace : public QValueList<QSStackFrame>
{
public:
  QString toString() const;
};

class QSA_EXPORT QSInterpreter : public QObject
{
  friend class QSProject;
  friend class QSWrapperFactory; // for access to interpreter()
  friend class QSObjectFactory;
  friend class QSInterfaceFactory;
  friend class QSToolkitFactory;
  friend QuickInterpreter *get_quick_interpreter(QSInterpreter *ip);

  Q_OBJECT
  Q_ENUMS(ErrorMode)
  Q_PROPERTY(ErrorMode errorMode READ errorMode WRITE setErrorMode)
  Q_PROPERTY(int timeoutInterval READ timeoutInterval WRITE setTimeoutInterval)

public:
  enum ErrorMode { Notify, Nothing };
  enum ClassFlags { AllClasses, GlobalClasses };
  enum FunctionFlags { FunctionNames = 0,
                       FunctionSignatures = 1,
                       IncludeMemberFunctions = 2
                     };

  QSInterpreter(QObject *parent = 0, const char *name = 0);
  virtual ~QSInterpreter();

  static QSInterpreter *defaultInterpreter();

  QSArgument evaluate(const QString &code, QObject *context = 0,
                      const QString &scriptName = QString::null);
  QSArgument call(const QString &function,
                  const QSArgumentList &arguments = QSArgumentList(),
                  QObject *context = 0);
  QObject *currentContext() const;

  bool checkSyntax(const QString &code);

  void setErrorMode(ErrorMode m);
  ErrorMode errorMode() const;

  QSProject *project() const;

  QStringList functions(FunctionFlags flag = FunctionNames) const;
  QStringList functions(const QString &context,
                        uint mask = FunctionNames) const;
  QStringList functions(QObject *context,
                        FunctionFlags flag = FunctionNames) const;

  QStringList classes(ClassFlags = AllClasses) const;
  QStringList classes(const QString &context) const;
  QStringList classes(QObject *context) const;

  QStringList variables(bool includeStatic = false,
                        bool includeCustom = false,
                        bool includeMemberVariables = false) const;
  QStringList variables(const QString &context, bool includeStatic = false,
                        bool includeCustom = false,
                        bool includeMemberVariables = false) const;
  QStringList variables(QObject *context, bool includeStatic = false,
                        bool includeCustom = false,
                        bool includeMemberVariables = false) const;

  bool hasFunction(const QString &function) const;
  bool hasClass(const QString &className) const;
  bool hasVariable(const QString &variable) const;

  void addTransientVariable(const QString &variable, const QSArgument &arg, QObject *context = 0);
  QSArgument variable(const QString &variable, QObject *context = 0) const;

  QObjectList presentObjects() const;
  void addTransientObject(QObject *object);

  bool isRunning() const;

  void throwError(const QString &message);

  void addObjectFactory(QSObjectFactory *factory);
  void addWrapperFactory(QSWrapperFactory *factory);

  QSStackTrace stackTrace() const;
  QString errorMessage() const;
  bool hadError() const;

  void addTransientSignalHandler(QObject *sender,
                                 const char *signal,
                                 const char *qtscriptFunction);

  void removeTransientSignalHandler(QObject *sender,
                                    const char *signal,
                                    const char *qtscriptFunction);

  void setTimeoutInterval(int msecs);
  int timeoutInterval() const;

  // ### AbanQ
  /** Ver propiedad d->interactiveGUI_ */
  bool interactiveGUI() const;
  void setInteractiveGUI(bool on = true);
  // ### AbanQ

public slots:
  void clear();
  void stopExecution();

signals:
  void error(const QString &message, const QString &scriptName,
             int lineNumber);
  void error(const QString &message, QObject *context,
             const QString &scriptName, int lineNumber);

  void timeout(int runnningTime);

private:
  // disabled copy constructor and assignment operator
  QSInterpreter(const QSInterpreter &);
  QSInterpreter &operator=(const QSInterpreter &);
  QSInterpreter(QSProject *project, const char *name = 0);

  void init();

  // used by factory classes
  QuickInterpreter *interpreter() const;

  void removeObjectFactory(QSObjectFactory *factory);
  void removeWrapperFactory(QSWrapperFactory *factory);

private slots:
  void runtimeError(const QString &message, const QString &filename, int lineNumber);
  void runtimeError();
  void parseError();

private:
  QSInterpreterPrivate *d;

  uint running: 1;
};

inline bool QSInterpreter::isRunning() const
{
  return running;
}

#endif