ScxmlEditor: Initial import

Change-Id: I4701b77ebd4e2520f2616c42206ac17be3a12b60 Reviewed-by: Tobias Hunger <tobias.hunger@qt.io> Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2016-09-15 17:55:28 +02:00
parent 1a9919a208
commit 4ea332b062
237 changed files with 25257 additions and 0 deletions
--- a/src/plugins/scxmleditor/common/structure.cpp
+++ b/src/plugins/scxmleditor/common/structure.cpp
@@ -0,0 +1,294 @@
+/****************************************************************************
+**
+** Copyright (C) 2016 The Qt Company Ltd.
+** Contact: https://www.qt.io/licensing/
+**
+** This file is part of Qt Creator.
+**
+** 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 https://www.qt.io/terms-conditions. For further
+** information use the contact form at https://www.qt.io/contact-us.
+**
+** GNU General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU
+** General Public License version 3 as published by the Free Software
+** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT
+** included in the packaging of this file. Please review the following
+** information to ensure the GNU General Public License requirements will
+** be met: https://www.gnu.org/licenses/gpl-3.0.html.
+**
+****************************************************************************/
+
+#include "structure.h"
+#include "actionhandler.h"
+#include "actionprovider.h"
+#include "graphicsscene.h"
+#include "sceneutils.h"
+#include "scxmleditorconstants.h"
+#include "scxmldocument.h"
+#include "scxmlnamespace.h"
+#include "scxmltagutils.h"
+#include "scxmluifactory.h"
+#include "structuremodel.h"
+
+#include <QCheckBox>
+#include <QKeyEvent>
+#include <QLineEdit>
+#include <QRegExp>
+#include <QRegExpValidator>
+#include <QUndoStack>
+
+#include <utils/qtcassert.h>
+
+using namespace ScxmlEditor::PluginInterface;
+using namespace ScxmlEditor::Common;
+
+TreeItemDelegate::TreeItemDelegate(QObject *parent)
+    : QStyledItemDelegate(parent)
+{
+}
+
+QWidget *TreeItemDelegate::createEditor(QWidget *parent, const QStyleOptionViewItem &option, const QModelIndex &index) const
+{
+    if (index.isValid()) {
+        auto edit = new QLineEdit(parent);
+        edit->setFocusPolicy(Qt::StrongFocus);
+        QRegExp rx("^(?!xml)[_a-z][a-z0-9-._]*$");
+        rx.setCaseSensitivity(Qt::CaseInsensitive);
+        edit->setValidator(new QRegExpValidator(rx, parent));
+        return edit;
+    }
+    return QStyledItemDelegate::createEditor(parent, option, index);
+}
+
+StructureSortFilterProxyModel::StructureSortFilterProxyModel(QObject *parent)
+    : QSortFilterProxyModel(parent)
+{
+}
+
+void StructureSortFilterProxyModel::setVisibleTags(const QVector<TagType> &visibleTags)
+{
+    m_visibleTags = visibleTags;
+    if (!m_visibleTags.contains(Scxml))
+        m_visibleTags << Scxml;
+    invalidateFilter();
+}
+
+void StructureSortFilterProxyModel::setSourceModel(QAbstractItemModel *sourceModel)
+{
+    m_sourceModel = static_cast<StructureModel*>(sourceModel);
+    QSortFilterProxyModel::setSourceModel(sourceModel);
+}
+
+bool StructureSortFilterProxyModel::filterAcceptsRow(int source_row, const QModelIndex &source_parent) const
+{
+    if (m_sourceModel) {
+        ScxmlTag *tag = m_sourceModel->getItem(source_parent, source_row);
+        if (tag) {
+            ScxmlNamespace *ns = tag->document()->scxmlNamespace(tag->prefix());
+            bool nsBool = (!ns) || ns->isTagVisible(tag->tagName(false));
+            return m_visibleTags.contains(tag->tagType()) && nsBool;
+        }
+    }
+
+    return QSortFilterProxyModel::filterAcceptsRow(source_row, source_parent);
+}
+
+Structure::Structure(QWidget *parent)
+    : QFrame(parent)
+{
+    m_ui.setupUi(this);
+
+    addCheckbox(tr("Common states"), State);
+    addCheckbox(tr("Metadata"), Metadata);
+    addCheckbox(tr("Other tags"), OnEntry);
+    addCheckbox(tr("Unknown tags"), UnknownTag);
+
+    m_ui.m_tagVisibilityFrame->setVisible(false);
+    connect(m_ui.m_checkboxButton, &QToolButton::toggled, m_ui.m_tagVisibilityFrame, &QFrame::setVisible);
+
+    m_model = new StructureModel(this);
+
+    m_proxyModel = new StructureSortFilterProxyModel(this);
+    m_proxyModel->setSourceModel(m_model);
+    m_proxyModel->setDynamicSortFilter(false);
+
+    // Default set of the visible tags
+    QVector<TagType> visibleTags;
+    for (int i = 0; i < Finalize; ++i)
+        visibleTags << (TagType)i;
+    m_proxyModel->setVisibleTags(visibleTags);
+
+    m_ui.m_structureView->setModel(m_proxyModel);
+    m_ui.m_structureView->setItemDelegate(new TreeItemDelegate(this));
+
+    connect(m_ui.m_structureView, &TreeView::pressed, this, &Structure::rowActivated);
+    connect(m_ui.m_structureView, &TreeView::rightButtonClicked, this, &Structure::showMenu);
+    connect(m_ui.m_structureView, &TreeView::entered, this, &Structure::rowEntered);
+
+    connect(m_model, &StructureModel::selectIndex, this, &Structure::currentTagChanged);
+    connect(m_model, &StructureModel::childAdded, this, &Structure::childAdded);
+}
+
+void Structure::addCheckbox(const QString &name, TagType type)
+{
+    auto box = new QCheckBox;
+    box->setText(name);
+    box->setProperty(Constants::C_SCXMLTAG_TAGTYPE, type);
+    box->setCheckable(true);
+    box->setChecked(true);
+    connect(box, &QCheckBox::clicked, this, &Structure::updateCheckBoxes);
+    m_ui.m_checkboxLayout->addWidget(box);
+    m_checkboxes << box;
+}
+
+void Structure::updateCheckBoxes()
+{
+    QVector<TagType> visibleTags;
+    foreach (QCheckBox *box, m_checkboxes) {
+        if (box->isChecked()) {
+            switch ((TagType)box->property(Constants::C_SCXMLTAG_TAGTYPE).toInt()) {
+            case State:
+                visibleTags << Initial << Final << History << State << Parallel << Transition << InitialTransition;
+                break;
+            case Metadata:
+                visibleTags << Metadata << MetadataItem;
+                break;
+            case OnEntry:
+                visibleTags << OnEntry << OnExit << Raise << If << ElseIf << Else
+                            << Foreach << Log << DataModel << Data << Assign << Donedata
+                            << Content << Param << Script << Send << Cancel << Invoke << Finalize;
+                break;
+            case UnknownTag:
+                visibleTags << UnknownTag;
+                break;
+            default:
+                break;
+            }
+        }
+    }
+
+    m_proxyModel->setVisibleTags(visibleTags);
+}
+
+void Structure::setDocument(ScxmlDocument *document)
+{
+    m_currentDocument = document;
+    m_model->setDocument(document);
+    m_proxyModel->invalidate();
+    m_ui.m_structureView->expandAll();
+}
+
+void Structure::setGraphicsScene(GraphicsScene *scene)
+{
+    m_scene = scene;
+    connect(m_ui.m_structureView, &TreeView::mouseExited, m_scene, &GraphicsScene::unhighlightAll);
+}
+
+void Structure::rowEntered(const QModelIndex &index)
+{
+    QTC_ASSERT(m_scene, return);
+
+    QModelIndex ind = m_proxyModel->mapToSource(index);
+    auto tag = static_cast<ScxmlTag*>(ind.internalPointer());
+    if (tag)
+        m_scene->highlightItems(QVector<ScxmlTag*>() << tag);
+    else
+        m_scene->unhighlightAll();
+}
+
+void Structure::rowActivated(const QModelIndex &index)
+{
+    if (m_scene)
+        m_scene->unselectAll();
+
+    if (m_currentDocument) {
+        QModelIndex ind = m_proxyModel->mapToSource(index);
+        auto tag = static_cast<ScxmlTag*>(ind.internalPointer());
+        if (tag)
+            m_currentDocument->setCurrentTag(tag);
+    }
+}
+
+void Structure::currentTagChanged(const QModelIndex &sourceIndex)
+{
+    QModelIndex ind = m_proxyModel->mapFromSource(sourceIndex);
+    if (ind.isValid())
+        m_ui.m_structureView->setCurrentIndex(ind);
+}
+
+void Structure::childAdded(const QModelIndex &childIndex)
+{
+    m_proxyModel->invalidate();
+    QModelIndex ind = m_proxyModel->mapFromSource(childIndex);
+    if (ind.isValid()) {
+        m_ui.m_structureView->setCurrentIndex(ind);
+        m_ui.m_structureView->expand(ind.parent());
+    }
+}
+
+void Structure::keyPressEvent(QKeyEvent *e)
+{
+    if (e->key() == Qt::Key_Delete) {
+        QModelIndex ind = m_proxyModel->mapToSource(m_ui.m_structureView->currentIndex());
+        auto tag = static_cast<ScxmlTag*>(ind.internalPointer());
+        if (tag && m_currentDocument) {
+            m_currentDocument->undoStack()->beginMacro(tr("Remove items"));
+            m_currentDocument->removeTag(tag);
+            m_currentDocument->undoStack()->endMacro();
+        }
+    }
+    QFrame::keyPressEvent(e);
+}
+
+void Structure::showMenu(const QModelIndex &index, const QPoint &globalPos)
+{
+    if (index.isValid()) {
+        QModelIndex ind = m_proxyModel->mapToSource(index);
+        auto tag = static_cast<ScxmlTag*>(ind.internalPointer());
+        if (tag) {
+            auto menu = new QMenu;
+            menu->addAction(tr("Expand All"), m_ui.m_structureView, &TreeView::expandAll);
+            menu->addAction(tr("Collapse All"), m_ui.m_structureView, &TreeView::collapseAll);
+            menu->addSeparator();
+            menu->addAction(m_scene->actionHandler()->action(ActionCopy));
+            menu->addAction(m_scene->actionHandler()->action(ActionPaste));
+            menu->addSeparator();
+            ScxmlUiFactory *uiFactory = m_scene->uiFactory();
+            if (uiFactory) {
+                auto actionProvider = static_cast<ActionProvider*>(uiFactory->object(Constants::C_UI_FACTORY_OBJECT_ACTIONPROVIDER));
+                if (actionProvider) {
+                    actionProvider->initStateMenu(tag, menu);
+                    menu->addSeparator();
+                }
+            }
+
+            TagUtils::createChildMenu(tag, menu);
+            QAction *selectedAction = menu->exec(globalPos);
+            if (selectedAction) {
+                QVariantMap data = selectedAction->data().toMap();
+                int actionType = data.value(Constants::C_SCXMLTAG_ACTIONTYPE, -1).toInt();
+                if (actionType == TagUtils::Remove) {
+                    m_currentDocument->undoStack()->beginMacro(tr("Remove items"));
+                    m_currentDocument->setCurrentTag(tag);
+                    m_currentDocument->removeTag(tag);
+                    m_currentDocument->setCurrentTag(0);
+                    m_currentDocument->undoStack()->endMacro();
+                } else if (actionType == TagUtils::AddChild) {
+                    tag->document()->undoStack()->beginMacro(tr("Add child"));
+                    ScxmlTag *childTag = SceneUtils::addChild(tag, data, m_scene);
+                    if (childTag && childTag->tagType() <= MetadataItem)
+                        m_ui.m_structureView->edit(m_ui.m_structureView->currentIndex());
+                    tag->document()->undoStack()->endMacro();
+                }
+            }
+
+            m_proxyModel->invalidate();
+            menu->deleteLater();
+        }
+    }
+}