src/controllers/cmakeapi.h

0001 /* This file is part of KDevelop
0002
0003     Copyright 2020 Milian Wolff <mail@milianw.de>
0004
0005     This library is free software; you can redistribute it and/or
0006     modify it under the terms of the GNU Library General Public
0007     License as published by the Free Software Foundation; either
0008     version 2 of the License, or (at your option) any later version.
0009
0010     This library is distributed in the hope that it will be useful,
0011     but WITHOUT ANY WARRANTY; without even the implied warranty of
0012     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
0013     Library General Public License for more details.
0014
0015     You should have received a copy of the GNU Library General Public License
0016     along with this library; see the file COPYING.LIB.  If not, write to
0017     the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
0018     Boston, MA 02110-1301, USA.
0019 */
0020
0021 #pragma once
0022
0023 #include <QVector>
0024 #include <QHash>
0025
0026 class QJsonObject;
0027 class QString;
0028 class QUrl;
0029
0030 struct CMakeProjectData;
0031
0032 /// see: https://cmake.org/cmake/help/latest/manual/cmake-file-api.7.html
0033 namespace CMake {
0034 namespace FileApi {
0035 /**
0036  * @returns true when the given @p cmakeExecutable supports the cmake-file-api, false otherwise
0037  */
0038 bool supported(const QString &cmakeExecutable);
0039
0040 /**
0041  * Write the KDevelop-specific query file into the given @p buildDirectory.
0042  *
0043  * See also: https://cmake.org/cmake/help/latest/manual/cmake-file-api.7.html#v1-client-stateful-query-files
0044  */
0045 void writeClientQueryFile(const QString &buildDirectory);
0046
0047 /**
0048  * Read and parse latest available reply index file that corresponds to our query in @p buildDirectory.
0049  *
0050  * See also: https://cmake.org/cmake/help/latest/manual/cmake-file-api.7.html#v1-reply-index-file
0051  */
0052 QJsonObject findReplyIndexFile(const QString &buildDirectory);
0053
0054 /**
0055  * Read and parse the code model referenced by the given @p replyIndex
0056  *
0057  * See also: https://cmake.org/cmake/help/latest/manual/cmake-file-api.7.html#id11
0058  */
0059  QVector<CMakeProjectData> parseReplyIndexFile(const QJsonObject& replyIndex,
0060                                                             const QUrl& sourceDirectory,
0061                                                             const QUrl& buildDirectory);
0062 }
0063 }