qtctestrunconfiguration.h

/* Copyright 2016-2020 Pascal COMBES <pascom@orange.fr>
 * 
 * This file is part of QtcDevPlugin.
 * 
 * QtcDevPlugin is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * 
 * QtcDevPlugin is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with QtcDevPlugin. If not, see <http://www.gnu.org/licenses/>
 */

#ifndef QTCTESTRUNCONFIGURATION_H
#define QTCTESTRUNCONFIGURATION_H

#include "qtcrunconfiguration.h"

#include <QWidget>

namespace ProjectExplorer {
    class ProjectNode;
    class Project;
    class Target;
}

namespace QtcDevPlugin {
namespace Internal {

class QtcTestRunConfiguration;

/*!
 * \brief The QtcTestRunConfiguration class stores information required to start a test instance of Qt Creator
 *
 * When an instance of this class is added to a target, Qt Creator will propose to the user to
 * start Qt Creator with the plugin being developped loaded. It will then start the tests
 * associated with this plugin. It also tries to ensure that all other
 * versions of the plugin are hidden (by moving them to alternative pathes) when Qt Creator stats,
 * so that the current version is the only loaded in the current Qt Creator instance.
 * Otherwide the tests of the other instance could shadow those of the current version being tested.
 *
 * This run configuration can be easily edited using QtcRunConfigurationWidget, which
 * defines a suitable form wigdet to ease this process.
 *
 * \sa QtcRunConfigurationWidget
 */
class QtcTestRunConfiguration : public QtcRunConfiguration
{
    Q_OBJECT
public:
    /*!
     * \brief Constructor
     *
     * Creates a new instance with parent target.
     * \param parent The parent build configuration
     * \param id The id for the run configuration
     * \sa initialize()
     */
    QtcTestRunConfiguration(ProjectExplorer::BuildConfiguration* parent, Utils::Id id = Utils::Id(Constants::QtcTestRunConfigurationId));

    /*!
     * \copydoc QtcRunConfiguration::commandLineArgumentsList()
     */
    virtual QStringList commandLineArgumentsList(void) const override;

    /*!
     * \brief The run configuration id
     *
     * This function returns the id for instances of this class.
     * \return The run configuration id
     */
    static Utils::Id id(void);

    /*!
     * \brief The run configuration pattern for display name
     *
     * This function returns the pattern used to generate the display name for the run configuration.
     * If %1 is used, it will be replaced by the plugin name.
     * \return The pattern for the display name of the run configuration.
     */
    static QString displayNamePattern(void);
};

} // Internal
} // QtcDevPlugin

#endif // QTCTESTRUNCONFIGURATION_H