aboutsummaryrefslogtreecommitdiffstats
path: root/src/plugins/qmlprojectmanager/cmakegen/generatecmakelists.h
blob: 02cf19b702826cbac0ff2ee62e572488b9f18167 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
/****************************************************************************
**
** Copyright (C) 2021 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the Qt Design Tooling
**
** 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 <projectexplorer/project.h>

#include <utils/fileutils.h>

namespace QmlProjectManager {
namespace GenerateCmake {
struct GeneratableFile {
    Utils::FilePath filePath;
    QString content;
    bool fileExists;
};

bool operator==(const GeneratableFile &left, const GeneratableFile &right);

void generateMenuEntry(QObject *parent);
void onGenerateCmakeLists();
bool isErrorFatal(int error);
int isProjectCorrectlyFormed(const Utils::FilePath &rootDir);
void showProjectDirErrorDialog(int error);
QString readTemplate(const QString &templatePath);
const QString projectEnvironmentVariable(const QString &key);

class FileQueue {
public:
    bool queueFile(const Utils::FilePath &filePath, const QString &fileContent);
    const QVector<GeneratableFile> queuedFiles() const;
    bool writeQueuedFiles();
    void filterFiles(const Utils::FilePaths keepFiles);

private:
    bool writeFile(const GeneratableFile &file);

private:
    QVector<GeneratableFile> m_queuedFiles;
};

class CmakeFileGenerator {
public:
    bool prepare(const Utils::FilePath &rootDir, bool check = true);
    const FileQueue fileQueue() const;
    void filterFileQueue(const Utils::FilePaths &keepFiles);
    bool execute();

private:
    void generateMainCmake(const Utils::FilePath &rootDir);
    void generateImportCmake(const Utils::FilePath &dir, const QString &modulePrefix = QString());
    void generateModuleCmake(const Utils::FilePath &dir, const QString &moduleUri = QString());
    bool generateEntryPointFiles(const Utils::FilePath &dir);
    bool generateMainCpp(const Utils::FilePath &dir);
    bool generateMainQml(const Utils::FilePath &dir);
    QStringList getDirectoryQmls(const Utils::FilePath &dir);
    QStringList getDirectoryResources(const Utils::FilePath &dir);
    QStringList getSingletonsFromQmldirFile(const Utils::FilePath &filePath);
    QStringList getDirectoryTreeQmls(const Utils::FilePath &dir);
    QStringList getDirectoryTreeResources(const Utils::FilePath &dir);
    void queueCmakeFile(const Utils::FilePath &filePath, const QString &content);
    bool isFileResource(const QString &relativeFilePath);
    bool isFileBlacklisted(const QString &fileName);
    bool isDirBlacklisted(const Utils::FilePath &dir);
    bool includeFile(const Utils::FilePath &filePath);

private:
    FileQueue m_fileQueue;
    QStringList m_resourceFileLocations;
    QStringList m_moduleNames;
    bool m_checkFileIsInProject;
};

} //GenerateCmake

} //QmlProjectManager