autotoolsproject.h 5.12 KB
Newer Older
1 2
/**************************************************************************
**
Eike Ziller's avatar
Eike Ziller committed
3
** Copyright (C) 2015 Openismus GmbH.
hjk's avatar
hjk committed
4 5
** Authors: Peter Penz (ppenz@openismus.com)
**          Patricia Santana Cruz (patriciasantanacruz@gmail.com)
Eike Ziller's avatar
Eike Ziller committed
6
** Contact: http://www.qt.io/licensing
7
**
hjk's avatar
hjk committed
8
** This file is part of Qt Creator.
9
**
hjk's avatar
hjk committed
10 11 12 13
** 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
Eike Ziller's avatar
Eike Ziller committed
14 15
** a written agreement between you and The Qt Company.  For licensing terms and
** conditions see http://www.qt.io/terms-conditions.  For further information
Eike Ziller's avatar
Eike Ziller committed
16
** use the contact form at http://www.qt.io/contact-us.
17 18
**
** GNU Lesser General Public License Usage
hjk's avatar
hjk committed
19
** Alternatively, this file may be used under the terms of the GNU Lesser
Eike Ziller's avatar
Eike Ziller committed
20 21 22 23 24 25
** General Public License version 2.1 or version 3 as published by the Free
** Software Foundation and appearing in the file LICENSE.LGPLv21 and
** LICENSE.LGPLv3 included in the packaging of this file.  Please review the
** following information to ensure the GNU Lesser General Public License
** requirements will be met: https://www.gnu.org/licenses/lgpl.html and
** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
hjk's avatar
hjk committed
26
**
Eike Ziller's avatar
Eike Ziller committed
27 28
** In addition, as a special exception, The Qt Company gives you certain additional
** rights.  These rights are described in The Qt Company LGPL Exception
29 30
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
hjk's avatar
hjk committed
31
****************************************************************************/
32 33 34 35 36 37

#ifndef AUTOTOOLSPROJECT_H
#define AUTOTOOLSPROJECT_H

#include <projectexplorer/project.h>

38 39
#include <utils/fileutils.h>

40 41
#include <QFuture>

42 43
QT_FORWARD_DECLARE_CLASS(QDir)

44
namespace Utils { class FileSystemWatcher; }
45 46 47 48 49

namespace ProjectExplorer {
class Node;
class FolderNode;
}
50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73

namespace AutotoolsProjectManager {
namespace Internal {
class AutotoolsConfigurationFactory;
class AutotoolsProjectFile;
class AutotoolsProjectNode;
class AutotoolsManager;
class MakefileParserThread;
class AutotoolsTarget;

/**
 * @brief Implementation of the ProjectExplorer::Project interface.
 *
 * Loads the autotools project and embeds it into the QtCreator project tree.
 * The class AutotoolsProject is the core of the autotools project plugin.
 * It is responsible to parse the Makefile.am files and do trigger project
 * updates if a Makefile.am file or a configure.ac file has been changed.
 */
class AutotoolsProject : public ProjectExplorer::Project
{
    Q_OBJECT

public:
    AutotoolsProject(AutotoolsManager *manager, const QString &fileName);
74
    ~AutotoolsProject() override;
75

76
    QString displayName() const override;
77
    QStringList files(FilesMode fileMode) const override;
78
    static QString defaultBuildDirectory(const QString &projectPath);
79 80 81
    QStringList buildTargets() const;

protected:
82
    RestoreResult fromMap(const QVariantMap &map, QString *errorMessage) override;
83 84 85 86 87

private slots:
    /**
     *  Loads the project tree by parsing the makefiles.
     */
88
    void loadProjectTree();
89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118

    /**
     * Is invoked when the makefile parsing by m_makefileParserThread has
     * been started. Turns the mouse cursor into a busy cursor.
     */
    void makefileParsingStarted();

    /**
     * Is invoked when the makefile parsing by m_makefileParserThread has
     * been finished. Adds all sources and files into the project tree and
     * takes care listen to file changes for Makefile.am and configure.ac
     * files.
     */
    void makefileParsingFinished();

    /**
     * Is invoked, if a file of the project tree has been changed by the user.
     * If a Makefile.am or a configure.ac file has been changed, the project
     * configuration must be updated.
     */
    void onFileChanged(const QString &file);

private:
    /**
     * Creates folder-nodes and file-nodes for the project tree.
     */
    void buildFileNodeTree(const QDir &directory,
                           const QStringList &files);

    /**
119
     * Helper function for buildFileNodeTree(): Inserts a new folder-node for
120 121 122
     * the directory \p nodeDir and inserts it into \p nodes. If no parent
     * folder exists, it will be created recursively.
     */
hjk's avatar
hjk committed
123 124
    ProjectExplorer::FolderNode *insertFolderNode(const QDir &nodeDir,
                                                  QHash<QString, ProjectExplorer::Node *> &nodes);
125 126 127 128

    /**
     * @return All nodes (including sub-folder- and file-nodes) for the given parent folder.
     */
hjk's avatar
hjk committed
129
    QList<ProjectExplorer::Node *> nodes(ProjectExplorer::FolderNode *parent) const;
130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147

    /**
     * This function is in charge of the code completion.
     */
    void updateCppCodeModel();

private:
    QString m_projectName;

    /// Return value for AutotoolsProject::files()
    QStringList m_files;

    /// Watches project files for changes.
    Utils::FileSystemWatcher *m_fileWatcher;
    QStringList m_watchedFiles;

    /// Responsible for parsing the makefiles asynchronously in a thread
    MakefileParserThread *m_makefileParserThread;
148 149

    QFuture<void> m_codeModelFuture;
150 151 152 153 154 155
};

} // namespace Internal
} // namespace AutotoolsProjectManager

#endif // AUTOTOOLSPROJECT_H