src/scripttools/debugging/qscriptdebuggerscriptedconsolecommand_p.h

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).
   4 ** All rights reserved.
   5 ** Contact: Nokia Corporation (qt-info@nokia.com)
   6 **
   7 ** This file is part of the QtSCriptTools module of the Qt Toolkit.
   8 **
   9 ** $QT_BEGIN_LICENSE:LGPL$
  10 ** No Commercial Usage
  11 ** This file contains pre-release code and may not be distributed.
  12 ** You may use this file in accordance with the terms and conditions
  13 ** contained in the Technology Preview License Agreement accompanying
  14 ** this package.
  15 **
  16 ** GNU Lesser General Public License Usage
  17 ** Alternatively, this file may be used under the terms of the GNU Lesser
  18 ** General Public License version 2.1 as published by the Free Software
  19 ** Foundation and appearing in the file LICENSE.LGPL included in the
  20 ** packaging of this file.  Please review the following information to
  21 ** ensure the GNU Lesser General Public License version 2.1 requirements
  22 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  23 **
  24 ** In addition, as a special exception, Nokia gives you certain additional
  25 ** rights.  These rights are described in the Nokia Qt LGPL Exception
  26 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  27 **
  28 ** If you have questions regarding the use of this file, please contact
  29 ** Nokia at qt-info@nokia.com.
  30 **
  31 **
  32 **
  33 **
  34 **
  35 **
  36 **
  37 **
  38 ** $QT_END_LICENSE$
  39 **
  40 ****************************************************************************/
  41
  42 #ifndef QSCRIPTDEBUGGERSCRIPTEDCONSOLECOMMAND_P_H
  43 #define QSCRIPTDEBUGGERSCRIPTEDCONSOLECOMMAND_P_H
  44
  45 //
  46 //  W A R N I N G
  47 //  -------------
  48 //
  49 // This file is not part of the Qt API.  It exists purely as an
  50 // implementation detail.  This header file may change from version to
  51 // version without notice, or even be removed.
  52 //
  53 // We mean it.
  54 //
  55
  56 #include "qscriptdebuggerconsolecommand_p.h"
  57
  58 QT_BEGIN_NAMESPACE
  59
  60 class QScriptValue;
  61
  62 class QScriptDebuggerScriptedConsoleCommandPrivate;
  63 class Q_AUTOTEST_EXPORT QScriptDebuggerScriptedConsoleCommand
  64     : public QScriptDebuggerConsoleCommand
  65 {
  66 protected:
  67     QScriptDebuggerScriptedConsoleCommand(const QString &name,
  68                                           const QString &group,
  69                                           const QString &shortDescription,
  70                                           const QString &longDescription,
  71                                           const QStringList &aliases,
  72                                           const QStringList &seeAlso,
  73                                           const QStringList &argumentTypes,
  74                                           const QStringList &subCommands,
  75                                           const QScriptValue &execFunction,
  76                                           const QScriptValue &responseFunction);
  77 public:
  78     ~QScriptDebuggerScriptedConsoleCommand();
  79
  80     static QScriptDebuggerScriptedConsoleCommand *parse(
  81         const QString &program, const QString &fileName,
  82         QScriptMessageHandlerInterface *messageHandler);
  83
  84     QString name() const;
  85     QString group() const;
  86     QString shortDescription() const;
  87     QString longDescription() const;
  88     QStringList aliases() const;
  89     QStringList seeAlso() const;
  90     QStringList argumentTypes() const;
  91     QStringList subCommands() const;
  92
  93     QScriptDebuggerConsoleCommandJob *createJob(
  94         const QStringList &arguments,
  95         QScriptDebuggerConsole *console,
  96         QScriptMessageHandlerInterface *messageHandler,
  97         QScriptDebuggerCommandSchedulerInterface *commandScheduler);
  98
  99 private:
 100     Q_DECLARE_PRIVATE(QScriptDebuggerScriptedConsoleCommand)
 101     Q_DISABLE_COPY(QScriptDebuggerScriptedConsoleCommand)
 102 };
 103
 104 QT_END_NAMESPACE
 105
 106 #endif