Files
qt-creator/plugins/fossil/fossilplugin.h
Artur Shepilko dea25a6b62 Vcs: Add Fossil SCM integration plugin
* Qt Creator base-commit: f77af5e336
* Stand-alone plugin source tree for integration into qtc super-project
* Original release: https://github.com/nomadbyte/qtcreator-plugin-fossil
* Adapted from Bazaar plugin implementation

Configuring Fossil
------------------

1. Download the [Fossil SCM client](http://fossil-scm.org) and install `fossil`
   executable file in your `PATH`.

2. Create or designate a directory to store local Fossil repositories and
   remote clones. For example: `~/fossils/qt`.

3. Configure Version Control Options for the Fossil plugin to use
   the designated directory as `Local Repositories Default path`.

Now Fossil should become available as a VCS choice to create new local
repositories, as well as a choice in `New File or Project` to clone a
remote Fossil repository.

Change-Id: I630184c1b344184d9e08ae2fc24a5e4766f834b9
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2017-02-09 16:43:38 +00:00

147 lines
4.3 KiB
C++

/****************************************************************************
**
** Copyright (c) 2016 Artur Shepilko
** 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.
**
****************************************************************************/
#pragma once
#include "fossilsettings.h"
#include <vcsbase/vcsbaseclient.h>
#include <vcsbase/vcsbaseplugin.h>
#include <coreplugin/icontext.h>
QT_BEGIN_NAMESPACE
class QAction;
QT_END_NAMESPACE
namespace Core {
class ActionContainer;
class CommandLocator;
class Id;
} // namespace Core
namespace Utils { class ParameterAction; }
namespace Fossil {
namespace Internal {
class OptionsPage;
class FossilClient;
class FossilControl;
class FossilEditorWidget;
class FossilPlugin : public VcsBase::VcsBasePlugin
{
Q_OBJECT
Q_PLUGIN_METADATA(IID "org.qt-project.Qt.QtCreatorPlugin" FILE "Fossil.json")
public:
FossilPlugin();
~FossilPlugin();
bool initialize(const QStringList &arguments, QString *errorMessage);
static FossilPlugin *instance();
FossilClient *client() const;
protected:
void updateActions(VcsBase::VcsBasePlugin::ActionState) override;
bool submitEditorAboutToClose() override;
private:
// File menu action slots
void addCurrentFile();
void deleteCurrentFile();
void annotateCurrentFile();
void diffCurrentFile();
void logCurrentFile();
void revertCurrentFile();
void statusCurrentFile();
// Directory menu action slots
void diffRepository();
void logRepository();
void revertAll();
void statusMulti();
// Repository menu action slots
void pull();
void push();
void update();
void configureRepository();
void commit();
void showCommitWidget(const QList<VcsBase::VcsBaseClient::StatusItem> &status);
void commitFromEditor();
void diffFromEditorSelected(const QStringList &files);
void createRepository();
// Methods
void createMenu(const Core::Context &context);
void createSubmitEditorActions();
void createFileActions(const Core::Context &context);
void createDirectoryActions(const Core::Context &context);
void createRepositoryActions(const Core::Context &context);
// Variables
static FossilPlugin *m_instance;
FossilClient *m_client = nullptr;
Core::CommandLocator *m_commandLocator = nullptr;
Core::ActionContainer *m_fossilContainer = nullptr;
QList<QAction *> m_repositoryActionList;
// Menu Items (file actions)
Utils::ParameterAction *m_addAction = nullptr;
Utils::ParameterAction *m_deleteAction = nullptr;
Utils::ParameterAction *m_annotateFile = nullptr;
Utils::ParameterAction *m_diffFile = nullptr;
Utils::ParameterAction *m_logFile = nullptr;
Utils::ParameterAction *m_renameFile = nullptr;
Utils::ParameterAction *m_revertFile = nullptr;
Utils::ParameterAction *m_statusFile = nullptr;
QAction *m_createRepositoryAction = nullptr;
// Submit editor actions
QAction *m_editorCommit = nullptr;
QAction *m_editorDiff = nullptr;
QAction *m_editorUndo = nullptr;
QAction *m_editorRedo = nullptr;
QAction *m_menuAction = nullptr;
QString m_submitRepository;
bool m_submitActionTriggered = false;
#ifdef WITH_TESTS
private slots:
void testDiffFileResolving_data();
void testDiffFileResolving();
void testLogResolving();
#endif
};
} // namespace Internal
} // namespace Fossil