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
|
/*
SPDX-FileCopyrightText: 2020 Milian Wolff <mail@milianw.de>
SPDX-License-Identifier: LGPL-2.0-or-later
*/
#pragma once
#include <QJsonObject>
#include <QDateTime>
class QString;
#include <cmakecommonexport.h>
struct CMakeProjectData;
namespace KDevelop
{
class Path;
}
/// see: https://cmake.org/cmake/help/latest/manual/cmake-file-api.7.html
namespace CMake {
namespace FileApi {
/**
* @returns true when the given @p cmakeExecutable supports the cmake-file-api, false otherwise
*/
KDEVCMAKECOMMON_EXPORT bool supported(const QString &cmakeExecutable);
/**
* Write the KDevelop-specific query file into the given @p buildDirectory.
*
* See also: https://cmake.org/cmake/help/latest/manual/cmake-file-api.7.html#v1-client-stateful-query-files
*/
KDEVCMAKECOMMON_EXPORT void writeClientQueryFile(const QString &buildDirectory);
struct ReplyIndex {
QDateTime queryLastModified;
QJsonObject data;
bool isValid() const
{
return !data.isEmpty();
}
bool isOutdated() const
{
return !queryLastModified.isValid();
}
void markOutdated()
{
queryLastModified = {};
}
};
/**
* Read and parse latest available reply index file that corresponds to our query in @p buildDirectory.
*
* See also: https://cmake.org/cmake/help/latest/manual/cmake-file-api.7.html#v1-reply-index-file
*/
KDEVCMAKECOMMON_EXPORT ReplyIndex findReplyIndexFile(const QString& buildDirectory);
/**
* Read and parse the code model referenced by the given @p replyIndex
*
* See also: https://cmake.org/cmake/help/latest/manual/cmake-file-api.7.html#id11
*/
KDEVCMAKECOMMON_EXPORT CMakeProjectData parseReplyIndexFile(const ReplyIndex& replyIndex,
const KDevelop::Path& sourceDirectory,
const KDevelop::Path& buildDirectory);
}
}
|
