Skip to content

Commit

Permalink
CMake: Use Utils::FilePath in fileapi parser and reader
Browse files Browse the repository at this point in the history 
It still relies on local host execution in some places.

Change-Id: I36adfeb93ea26b285bbf6da2aee7e0fac64a7d94
Reviewed-by: Cristian Adam <[email protected]>
  • Loading branch information
@h4tr3d
hjk authored and h4tr3d committed Jun 16, 2021
1 parent 9547f21 commit fd8256d
Show file tree
Hide file tree
Showing 4 changed files with 63 additions and 54 deletions.
66 changes: 37 additions & 29 deletions fileapiparser.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -91,11 +91,13 @@ static std::pair<QString, QString> nameValue(const QJsonObject &obj)
return std::make_pair(obj.value("name").toString(), obj.value("value").toString());
}

static QJsonDocument readJsonFile(const QString &path)
static QJsonDocument readJsonFile(const FilePath &filePath)
{
qCDebug(cmakeFileApi) << "readJsonFile:" << path;
qCDebug(cmakeFileApi) << "readJsonFile:" << filePath;

QFile file(path);
QTC_CHECK(!filePath.needsDevice());

QFile file(filePath.path());
file.open(QIODevice::ReadOnly | QIODevice::Text);
const QJsonDocument doc = QJsonDocument::fromJson(file.readAll());

Expand All @@ -116,9 +118,9 @@ std::vector<int> indexList(const QJsonValue &v)

// Reply file:

static ReplyFileContents readReplyFile(const QFileInfo &fi, QString &errorMessage)
static ReplyFileContents readReplyFile(const FilePath &filePath, QString &errorMessage)
{
const QJsonDocument document = readJsonFile(fi.filePath());
const QJsonDocument document = readJsonFile(filePath);
static const QString msg = QCoreApplication::translate("CMakeProjectManager::Internal",
"Invalid reply file created by CMake.");

Expand Down Expand Up @@ -176,7 +178,7 @@ static ReplyFileContents readReplyFile(const QFileInfo &fi, QString &errorMessag

// Cache file:

static CMakeConfig readCacheFile(const QString &cacheFile, QString &errorMessage)
static CMakeConfig readCacheFile(const FilePath &cacheFile, QString &errorMessage)
{
CMakeConfig result;

Expand Down Expand Up @@ -222,7 +224,7 @@ static CMakeConfig readCacheFile(const QString &cacheFile, QString &errorMessage

// CMake Files:

std::vector<CMakeFileInfo> readCMakeFilesFile(const QString &cmakeFilesFile, QString &errorMessage)
static std::vector<CMakeFileInfo> readCMakeFilesFile(const FilePath &cmakeFilesFile, QString &errorMessage)
{
std::vector<CMakeFileInfo> result;

Expand Down Expand Up @@ -492,7 +494,7 @@ static std::vector<Configuration> extractConfigurations(const QJsonArray &config
return result;
}

static std::vector<Configuration> readCodemodelFile(const QString &codemodelFile,
static std::vector<Configuration> readCodemodelFile(const FilePath &codemodelFile,
QString &errorMessage)
{
const QJsonDocument doc = readJsonFile(codemodelFile);
Expand All @@ -509,7 +511,7 @@ static std::vector<Configuration> readCodemodelFile(const QString &codemodelFile

// TargetDetails:

std::vector<FileApiDetails::FragmentInfo> extractFragments(const QJsonObject &obj)
static std::vector<FileApiDetails::FragmentInfo> extractFragments(const QJsonObject &obj)
{
const QJsonArray fragments = obj.value("commandFragments").toArray();
return transform<std::vector>(fragments, [](const QJsonValue &v) {
Expand All @@ -519,7 +521,7 @@ std::vector<FileApiDetails::FragmentInfo> extractFragments(const QJsonObject &ob
});
}

TargetDetails extractTargetDetails(const QJsonObject &root, QString &errorMessage)
static TargetDetails extractTargetDetails(const QJsonObject &root, QString &errorMessage)
{
TargetDetails t;
t.name = root.value("name").toString();
Expand Down Expand Up @@ -676,7 +678,7 @@ TargetDetails extractTargetDetails(const QJsonObject &root, QString &errorMessag
return t;
}

int validateBacktraceGraph(const TargetDetails &t)
static int validateBacktraceGraph(const TargetDetails &t)
{
const int backtraceFilesCount = static_cast<int>(t.backtraceGraph.files.size());
const int backtraceCommandsCount = static_cast<int>(t.backtraceGraph.commands.size());
Expand Down Expand Up @@ -710,7 +712,7 @@ int validateBacktraceGraph(const TargetDetails &t)
return backtraceNodeCount;
}

bool validateTargetDetails(const TargetDetails &t)
static bool validateTargetDetails(const TargetDetails &t)
{
// The part filled in by the codemodel file has already been covered!

Expand Down Expand Up @@ -789,7 +791,7 @@ bool validateTargetDetails(const TargetDetails &t)
return true;
}

TargetDetails readTargetFile(const QString &targetFile, QString &errorMessage)
static TargetDetails readTargetFile(const FilePath &targetFile, QString &errorMessage)
{
const QJsonDocument doc = readJsonFile(targetFile);
const QJsonObject root = doc.object();
Expand All @@ -807,13 +809,13 @@ TargetDetails readTargetFile(const QString &targetFile, QString &errorMessage)
// ReplyFileContents:
// --------------------------------------------------------------------

QString FileApiDetails::ReplyFileContents::jsonFile(const QString &kind, const QDir &replyDir) const
FilePath FileApiDetails::ReplyFileContents::jsonFile(const QString &kind, const FilePath &replyDir) const
{
const auto ro = findOrDefault(replies, equal(&ReplyObject::kind, kind));
if (ro.file.isEmpty())
return QString();
return {};
else
return replyDir.absoluteFilePath(ro.file);
return (replyDir / ro.file).absoluteFilePath();
}

// --------------------------------------------------------------------
Expand All @@ -839,8 +841,9 @@ bool FileApiParser::setupCMakeFileApi(const FilePath &buildDirectory, Utils::Fil
QTC_ASSERT(queryDir.exists(), );

bool failedBefore = false;
for (const QString &filePath : cmakeQueryFilePaths(buildDirectory)) {
QFile f(filePath);
for (const FilePath &filePath : cmakeQueryFilePaths(buildDirectory)) {
QTC_CHECK(!filePath.needsDevice());
QFile f(filePath.path());
if (!f.exists()) {
f.open(QFile::WriteOnly);
f.close();
Expand Down Expand Up @@ -871,12 +874,13 @@ static QStringList uniqueTargetFiles(const Configuration &config)
}

FileApiData FileApiParser::parseData(QFutureInterface<std::shared_ptr<FileApiQtcData>> &fi,
const QFileInfo &replyFileInfo,
const FilePath &replyFilePath,
const QString &cmakeBuildType,
QString &errorMessage)
{
QTC_CHECK(errorMessage.isEmpty());
const QDir replyDir = replyFileInfo.dir();
QTC_CHECK(!replyFilePath.needsDevice());
const FilePath replyDir = replyFilePath.parentDir();

FileApiData result;

Expand All @@ -888,7 +892,7 @@ FileApiData FileApiParser::parseData(QFutureInterface<std::shared_ptr<FileApiQtc
return false;
};

result.replyFile = readReplyFile(replyFileInfo, errorMessage);
result.replyFile = readReplyFile(replyFilePath, errorMessage);
if (cancelCheck())
return {};
result.cache = readCacheFile(result.replyFile.jsonFile("cache", replyDir), errorMessage);
Expand Down Expand Up @@ -938,7 +942,7 @@ FileApiData FileApiParser::parseData(QFutureInterface<std::shared_ptr<FileApiQtc
if (cancelCheck())
return {};
QString targetErrorMessage;
TargetDetails td = readTargetFile(replyDir.absoluteFilePath(targetFile), targetErrorMessage);
TargetDetails td = readTargetFile((replyDir / targetFile).absoluteFilePath(), targetErrorMessage);
if (targetErrorMessage.isEmpty()) {
result.targetDetails.emplace_back(std::move(td));
} else {
Expand All @@ -951,23 +955,27 @@ FileApiData FileApiParser::parseData(QFutureInterface<std::shared_ptr<FileApiQtc
return result;
}

QFileInfo FileApiParser::scanForCMakeReplyFile(const FilePath &buildDirectory)
FilePath FileApiParser::scanForCMakeReplyFile(const FilePath &buildDirectory)
{
QDir replyDir(cmakeReplyDirectory(buildDirectory).toString());
QTC_CHECK(!buildDirectory.needsDevice());
QDir replyDir(cmakeReplyDirectory(buildDirectory).path());
if (!replyDir.exists())
return {};

const QFileInfoList fis = replyDir.entryInfoList(QStringList("index-*.json"),
QDir::Files,
QDir::Name);
return fis.isEmpty() ? QFileInfo() : fis.last();
const QFileInfo fi = fis.isEmpty() ? QFileInfo() : fis.last();
return FilePath::fromFileInfo(fi);
}

QStringList FileApiParser::cmakeQueryFilePaths(const Utils::FilePath &buildDirectory)
FilePaths FileApiParser::cmakeQueryFilePaths(const FilePath &buildDirectory)
{
QDir queryDir(QDir::cleanPath(buildDirectory.pathAppended(CMAKE_RELATIVE_QUERY_PATH).toString()));
return transform(CMAKE_QUERY_FILENAMES,
[&queryDir](const QString &name) { return queryDir.absoluteFilePath(name); });
QTC_CHECK(!buildDirectory.needsDevice());
QDir queryDir(QDir::cleanPath(buildDirectory.pathAppended(CMAKE_RELATIVE_QUERY_PATH).path()));
return transform(CMAKE_QUERY_FILENAMES, [&queryDir](const QString &name) {
return FilePath::fromString(queryDir.absoluteFilePath(name));
});
}

} // namespace Internal
Expand Down
8 changes: 4 additions & 4 deletions fileapiparser.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ class ReplyFileContents

QVector<ReplyObject> replies;

QString jsonFile(const QString &kind, const QDir &replyDir) const;
Utils::FilePath jsonFile(const QString &kind, const Utils::FilePath &replyDir) const;
};

class CMakeFileInfo
Expand Down Expand Up @@ -251,16 +251,16 @@ class FileApiParser
Q_DECLARE_TR_FUNCTIONS(FileApiParser)
public:
static FileApiData parseData(QFutureInterface<std::shared_ptr<FileApiQtcData>> &fi,
const QFileInfo &replyFileInfo,
const Utils::FilePath &replyFilePath,
const QString &cmakeBuildType,
QString &errorMessage);

static bool setupCMakeFileApi(const Utils::FilePath &buildDirectory,
Utils::FileSystemWatcher &watcher);

static QStringList cmakeQueryFilePaths(const Utils::FilePath &buildDirectory);
static Utils::FilePaths cmakeQueryFilePaths(const Utils::FilePath &buildDirectory);

static QFileInfo scanForCMakeReplyFile(const Utils::FilePath &buildDirectory);
static Utils::FilePath scanForCMakeReplyFile(const Utils::FilePath &buildDirectory);
};

} // namespace Internal
Expand Down
41 changes: 21 additions & 20 deletions fileapireader.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,7 @@ void FileApiReader::parse(bool forceCMakeRun,
: QStringList());
qCDebug(cmakeFileApiMode) << "Parameters request these CMake arguments:" << args;

const QFileInfo replyFi = FileApiParser::scanForCMakeReplyFile(m_parameters.workDirectory);
const FilePath replyFile = FileApiParser::scanForCMakeReplyFile(m_parameters.workDirectory);
// Only need to update when one of the following conditions is met:
// * The user forces the cmake run,
// * The user provided arguments,
Expand All @@ -125,17 +125,14 @@ void FileApiReader::parse(bool forceCMakeRun,
// for creator to run CMake as needed,
// * A query file is newer than the reply file
const bool hasArguments = !args.isEmpty();
const bool replyFileMissing = !replyFi.exists();
const bool replyFileMissing = !replyFile.exists();
const bool cmakeFilesChanged = m_parameters.cmakeTool() && m_parameters.cmakeTool()->isAutoRun()
&& anyOf(m_cmakeFiles, [&replyFi](const FilePath &f) {
return f.toFileInfo().lastModified()
> replyFi.lastModified();
&& anyOf(m_cmakeFiles, [&replyFile](const FilePath &f) {
return f.lastModified() > replyFile.lastModified();
});
const bool queryFileChanged = anyOf(FileApiParser::cmakeQueryFilePaths(
m_parameters.workDirectory),
[&replyFi](const QString &qf) {
return QFileInfo(qf).lastModified()
> replyFi.lastModified();
const bool queryFileChanged = anyOf(FileApiParser::cmakeQueryFilePaths(m_parameters.workDirectory),
[&replyFile](const FilePath &qf) {
return qf.lastModified() > replyFile.lastModified();
});

const bool mustUpdate = forceCMakeRun || hasArguments || replyFileMissing || cmakeFilesChanged
Expand All @@ -156,7 +153,7 @@ void FileApiReader::parse(bool forceCMakeRun,
.arg(args.join("\", \""));
startCMakeState(args);
} else {
endState(replyFi);
endState(replyFile);
}
}

Expand Down Expand Up @@ -245,7 +242,7 @@ void FileApiReader::startState()
emit configurationStarted();
}

void FileApiReader::endState(const QFileInfo &replyFi)
void FileApiReader::endState(const FilePath &replyFilePath)
{
qCDebug(cmakeFileApiMode) << "FileApiReader: END STATE.";
QTC_ASSERT(m_isParsing, return );
Expand All @@ -256,14 +253,15 @@ void FileApiReader::endState(const QFileInfo &replyFi)
const FilePath topCmakeFile = m_cmakeFiles.size() == 1 ? *m_cmakeFiles.begin() : FilePath{};
const QString cmakeBuildType = m_parameters.cmakeBuildType == "Build" ? "" : m_parameters.cmakeBuildType;

m_lastReplyTimestamp = replyFi.lastModified();
QTC_CHECK(!replyFilePath.needsDevice());
m_lastReplyTimestamp = replyFilePath.lastModified();

m_future = runAsync(ProjectExplorerPlugin::sharedThreadPool(),
[replyFi, sourceDirectory, buildDirectory, topCmakeFile, cmakeBuildType](
[replyFilePath, sourceDirectory, buildDirectory, topCmakeFile, cmakeBuildType](
QFutureInterface<std::shared_ptr<FileApiQtcData>> &fi) {
auto result = std::make_shared<FileApiQtcData>();
FileApiData data = FileApiParser::parseData(fi,
replyFi,
replyFilePath,
cmakeBuildType,
result->errorMessage);
if (!result->errorMessage.isEmpty()) {
Expand Down Expand Up @@ -336,7 +334,9 @@ void FileApiReader::makeBackupConfiguration(bool store)
void FileApiReader::writeConfigurationIntoBuildDirectory(const QStringList &configurationArguments)
{
const FilePath buildDir = m_parameters.workDirectory;
QTC_ASSERT(buildDir.exists(), return );
QTC_ASSERT(buildDir.exists(), buildDir.ensureWritableDir());
if (!buildDir.exists())
buildDir.ensureWritableDir();

const FilePath settingsFile = buildDir.pathAppended("qtcsettings.cmake");

Expand Down Expand Up @@ -394,13 +394,14 @@ void FileApiReader::replyDirectoryHasChanged(const QString &directory) const
if (m_isParsing)
return; // This has been triggered by ourselves, ignore.

const QFileInfo fi = FileApiParser::scanForCMakeReplyFile(m_parameters.workDirectory);
const QString dir = fi.absolutePath();
const FilePath reply = FileApiParser::scanForCMakeReplyFile(m_parameters.workDirectory);
const FilePath dir = reply.absolutePath();
if (dir.isEmpty())
return; // CMake started to fill the result dir, but has not written a result file yet
QTC_ASSERT(dir == directory, return);
QTC_CHECK(!dir.needsDevice());
QTC_ASSERT(dir.path() == directory, return);

if (m_lastReplyTimestamp.isValid() && fi.lastModified() > m_lastReplyTimestamp)
if (m_lastReplyTimestamp.isValid() && reply.lastModified() > m_lastReplyTimestamp)
emit dirty();
}

Expand Down
2 changes: 1 addition & 1 deletion fileapireader.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ class FileApiReader final : public QObject

private:
void startState();
void endState(const QFileInfo &replyFi);
void endState(const Utils::FilePath &replyFilePath);
void startCMakeState(const QStringList &configurationArguments);
void cmakeFinishedState();

Expand Down

0 comments on commit fd8256d

Please sign in to comment.