qt-creator/src/plugins/cmakeprojectmanager/builddirmanager.h

/****************************************************************************
**
** 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.
**
****************************************************************************/

#ifndef CMAKE_BUILDDIRMANAGER_H
#define CMAKE_BUILDDIRMANAGER_H

#include "cmakecbpparser.h"
#include "cmakeconfigitem.h"

#include <projectexplorer/task.h>

#include <utils/environment.h>
#include <utils/qtcprocess.h>
#include <utils/fileutils.h>

#include <QByteArray>
#include <QFutureInterface>
#include <QObject>
#include <QSet>

QT_FORWARD_DECLARE_CLASS(QTemporaryDir);
QT_FORWARD_DECLARE_CLASS(QFileSystemWatcher);

namespace ProjectExplorer {
class FileNode;
class IOutputParser;
class Kit;
class Task;
} // namespace ProjectExplorer

namespace CMakeProjectManager {

class CMakeTool;

namespace Internal {

class BuildDirManager : public QObject
{
    Q_OBJECT

public:
    BuildDirManager(const Utils::FileName &sourceDir, const ProjectExplorer::Kit *k,
                    const CMakeConfig &inputConfig, const Utils::Environment &env,
                    const Utils::FileName &buildDir);
    ~BuildDirManager() override;

    const ProjectExplorer::Kit *kit() const { return m_kit; }
    const Utils::FileName buildDirectory() const { return m_buildDir; }
    const Utils::FileName sourceDirectory() const { return m_sourceDir; }
    bool isBusy() const;

    void parse();
    void forceReparse();

    bool isProjectFile(const Utils::FileName &fileName) const;
    QString projectName() const;
    QList<CMakeBuildTarget> buildTargets() const;
    QList<ProjectExplorer::FileNode *> files() const;
    CMakeConfig configuration() const;

signals:
    void parsingStarted() const;
    void dataAvailable() const;
    void errorOccured(const QString &err) const;

private:
    void extractData();

    void startCMake(CMakeTool *tool, const QString &generator, const CMakeConfig &config);

    void cmakeFinished(int code, QProcess::ExitStatus status);
    void processCMakeOutput();
    void processCMakeError();

    CMakeConfig parseConfiguration() const;

    const Utils::FileName m_sourceDir;
    Utils::FileName m_buildDir;
    const ProjectExplorer::Kit *const m_kit;
    Utils::Environment m_environment;
    CMakeConfig m_inputConfig;

    QTemporaryDir *m_tempDir = nullptr;
    Utils::QtcProcess *m_cmakeProcess = nullptr;

    QSet<Utils::FileName> m_watchedFiles;
    QString m_projectName;
    QList<CMakeBuildTarget> m_buildTargets;
    QFileSystemWatcher *m_watcher;
    QList<ProjectExplorer::FileNode *> m_files;

    // For error reporting:
    ProjectExplorer::IOutputParser *m_parser = nullptr;
    QFutureInterface<void> *m_future = nullptr;
};

} // namespace Internal
} // namespace CMakeProjectManager

#endif // CMAKE_BUILDDIRMANAGER_H