blob: 0d7388249356a48962fb4a06970abf832e873a7f (
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
|
/**************************************************************************
**
** This file is part of Qt Creator
**
** Copyright (C) 2011 Kläralvdalens Datakonsult AB, a KDAB Group company.
**
** Contact: Kläralvdalens Datakonsult AB (info@kdab.com)
**
**
** GNU Lesser General Public License Usage
**
** This file may be used under the terms of the GNU Lesser General Public
** License version 2.1 as published by the Free Software Foundation and
** appearing in the file LICENSE.LGPL included in the packaging of this file.
** Please review the following information to ensure the GNU Lesser General
** Public License version 2.1 requirements will be met:
** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, Nokia gives you certain additional
** rights. These rights are described in the Nokia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
** Other Usage
**
** Alternatively, this file may be used in accordance with the terms and
** conditions contained in a signed written agreement between you and Nokia.
**
** If you have questions regarding the use of this file, please contact
** Nokia at info@qt.nokia.com.
**
**************************************************************************/
#ifndef SCRIPTING_H
#define SCRIPTING_H
#include "scripting_global.h"
#include <extensionsystem/iplugin.h>
/**
\mainpage
<h1>Overall design</h1>
\li It all starts in \ref Scripting::Internal::ScriptingPlugin which is executed by Qt Creator at startup.
\li The script runner registers a locator action called <b>rs</b> - see \ref Scripting::Internal::RunScriptLocatorFilter
\li The ground work of finding scripts, registering shortcuts and starting their execution is done in \ref Scripting::Internal::ScriptManager
\li \ref Scripting::Internal::ScriptRunner contains the JavaScript engine and register the objects available in the scripts
<h1>Objects available in the scripts</h1>
\li <b>console</b> accesses an instance of \ref Scripting::Internal::Console
\code console.log("Hello world")\endcode
\li <b>editors</b> accesses an instance of \ref Scripting::Internal::Editors.
\code editors.current().selectAll()\endcode
*/
namespace Scripting {
namespace Internal {
class ScriptManager;
class ScriptingPlugin : public ExtensionSystem::IPlugin
{
Q_OBJECT
public:
ScriptingPlugin();
~ScriptingPlugin();
bool initialize(const QStringList &arguments, QString *errorString);
void extensionsInitialized();
ShutdownFlag aboutToShutdown();
private:
ScriptManager *m_scriptManager;
};
} // namespace Internal
} // namespace Scripting
#endif // SCRIPTING_H
|
