summaryrefslogtreecommitdiff
path: root/src/scripttools/debugging/qscriptdebuggerconsolecommandmanager_p.h
blob: 3f54fda8810bb5a19914ab306f473c883261814f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
/****************************************************************************
**
** Copyright (C) 2015 The Qt Company Ltd.
** Contact: http://www.qt.io/licensing/
**
** This file is part of the QtSCriptTools module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL21$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see http://www.qt.io/terms-conditions. For further
** information use the contact form at http://www.qt.io/contact-us.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 2.1 or version 3 as published by the Free
** Software Foundation and appearing in the file LICENSE.LGPLv21 and
** LICENSE.LGPLv3 included in the packaging of this file. Please review the
** following information to ensure the GNU Lesser General Public License
** requirements will be met: https://www.gnu.org/licenses/lgpl.html and
** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** As a special exception, The Qt Company gives you certain additional
** rights. These rights are described in The Qt Company LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
** $QT_END_LICENSE$
**
****************************************************************************/

#ifndef QSCRIPTDEBUGGERCONSOLECOMMANDMANAGER_P_H
#define QSCRIPTDEBUGGERCONSOLECOMMANDMANAGER_P_H

//
//  W A R N I N G
//  -------------
//
// This file is not part of the Qt API.  It exists purely as an
// implementation detail.  This header file may change from version to
// version without notice, or even be removed.
//
// We mean it.
//

#include <QtCore/qobjectdefs.h>
#include <QtCore/qscopedpointer.h>
#include <QtCore/qmap.h>
#include <QtCore/qlist.h>

#include "qscriptdebuggerconsolecommandgroupdata_p.h"

QT_BEGIN_NAMESPACE

class QScriptDebuggerConsoleCommand;
class QStringList;

class QScriptDebuggerConsoleCommandManagerPrivate;
class Q_AUTOTEST_EXPORT QScriptDebuggerConsoleCommandManager
{
public:
    QScriptDebuggerConsoleCommandManager();
    ~QScriptDebuggerConsoleCommandManager();

    void addCommand(QScriptDebuggerConsoleCommand *command);
    void addCommandGroup(const QString &name,
                         const QScriptDebuggerConsoleCommandGroupData &data);

    QScriptDebuggerConsoleCommand *findCommand(const QString &name) const;
    QMap<QString, QList<QScriptDebuggerConsoleCommand*> > commands() const;
    QList<QScriptDebuggerConsoleCommand*> commandsInGroup(const QString &name) const;

    QScriptDebuggerConsoleCommandGroupData commandGroupData(const QString &name) const;
    QScriptDebuggerConsoleCommandGroupMap commandGroups() const;

    QStringList completions(const QString &prefix) const;

private:
    QScopedPointer<QScriptDebuggerConsoleCommandManagerPrivate> d_ptr;

    Q_DECLARE_PRIVATE(QScriptDebuggerConsoleCommandManager)
};

QT_END_NAMESPACE

#endif