New plugin: plugin macro

This plugin let the user record and replay some macros:
 * 3 handlers: action, find and texteditor
 * almost all texteditor and cpp actions recorded
 * options page to set the directories where the macros are stored
 * optional dialog to give a name and comment at the end of a macro
 * locator integration to play a macro
 * shortcuts assignment to macro

The most important change outside the plugin macros is the isScriptable method
for command: All scriptable commands can be stored in a macro.

Merge-request: 2176
Reviewed-by: Tobias Hunger <tobias.hunger@nokia.com>

src/plugins/macros/macro.cpp

@@ -0,0 +1,203 @@
+/**************************************************************************
+**
+** This file is part of Qt Creator
+**
+** Copyright (c) 2010 Nicolas Arnaud-Cormos.
+**
+** Contact: Nokia Corporation (qt-info@nokia.com)
+**
+** Commercial Usage
+**
+** Licensees holding valid Qt Commercial licenses may use this file in
+** accordance with the Qt Commercial License Agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and Nokia.
+**
+** 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 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.
+**
+** If you are unsure which license is appropriate for your use, please
+** contact the sales department at http://qt.nokia.com/contact.
+**
+**************************************************************************/
+
+#include "macro.h"
+
+#include <coreplugin/coreconstants.h>
+
+#include <QFileInfo>
+
+using namespace Macros;
+
+/*!
+    \class Macros::Macro
+
+    \brief Represents a macro, which is more or less a list of Macros::MacroEvent
+
+    A macro is a list of events that can be replayed in Qt Creator. A macro has
+    an header consisting of the Qt Creator version where the macro was created
+    and a description.
+    The name of the macro is the filename without the extension.
+*/
+
+class Macro::MacroPrivate
+{
+public:
+    MacroPrivate();
+
+    QString description;
+    QString version;
+    QString fileName;
+    QList<MacroEvent> events;
+    int shortcutId;
+};
+
+Macro::MacroPrivate::MacroPrivate() :
+    version(Core::Constants::IDE_VERSION_LONG),
+    shortcutId(-1)
+{
+}
+
+
+
+// ---------- Macro ------------
+
+Macro::Macro() :
+    d(new MacroPrivate)
+{
+}
+
+Macro::Macro(const Macro &other):
+    d(new MacroPrivate)
+{
+    d->description = other.d->description;
+    d->version = other.d->version;
+    d->fileName = other.d->fileName;
+    d->events = other.d->events;
+    d->shortcutId = other.d->shortcutId;
+}
+
+Macro::~Macro()
+{
+    delete d;
+}
+
+Macro& Macro::operator=(const Macro &other)
+{
+    if (this == &other)
+        return *this;
+    d->description = other.d->description;
+    d->version = other.d->version;
+    d->fileName = other.d->fileName;
+    d->events = other.d->events;
+    d->shortcutId = other.d->shortcutId;
+    return *this;
+}
+
+void Macro::load(QString fileName)
+{
+    if (d->events.count())
+        return; // the macro is not empty
+
+    // Take the current filename if the parameter is null
+    if (fileName.isNull())
+        fileName = d->fileName;
+    else
+        d->fileName = fileName;
+
+    // Load all the macroevents
+    QFile file(fileName);
+    if (file.open(QFile::ReadOnly)) {
+        QDataStream stream(&file);
+        stream >> d->version;
+        stream >> d->description;
+        while (!stream.atEnd()) {
+            MacroEvent macroEvent;
+            macroEvent.load(stream);
+            append(macroEvent);
+        }
+    }
+}
+
+void Macro::loadHeader(const QString &fileName)
+{
+    d->fileName = fileName;
+    QFile file(fileName);
+    if (file.open(QFile::ReadOnly)) {
+        QDataStream stream(&file);
+        stream >> d->version;
+        stream >> d->description;
+    }
+}
+
+void Macro::save(const QString &fileName)
+{
+    QFile file(fileName);
+    if (file.open(QFile::WriteOnly)) {
+        QDataStream stream(&file);
+        stream << d->version;
+        stream << d->description;
+        foreach (const MacroEvent &event, d->events) {
+            event.save(stream);
+        }
+        d->fileName = fileName;
+    }
+}
+
+QString Macro::displayName() const
+{
+    QFileInfo fileInfo(d->fileName);
+    return fileInfo.baseName();
+}
+
+void Macro::append(const MacroEvent &event)
+{
+    d->events.append(event);
+}
+
+const QString &Macro::description() const
+{
+    return d->description;
+}
+
+void Macro::setDescription(const QString &text)
+{
+    d->description = text;
+}
+
+const QString &Macro::version() const
+{
+    return d->version;
+}
+
+const QString &Macro::fileName() const
+{
+    return d->fileName;
+}
+
+const QList<MacroEvent> &Macro::events() const
+{
+    return d->events;
+}
+
+void Macro::setShortcutId(int id)
+{
+    d->shortcutId = id;
+}
+
+int Macro::shortcutId() const
+{
+    return d->shortcutId;
+}
+
+bool Macro::isWritable() const
+{
+    QFileInfo fileInfo(d->fileName);
+    return fileInfo.exists() && fileInfo.isWritable();
+}