refs #756 Added class CProcessInfo to obtain a process name from its PID, and check if a process exists.

This commit is contained in:
Mathew Sutcliffe
2016-10-12 13:33:56 +01:00
parent 95beb61518
commit a08c93d53a
6 changed files with 220 additions and 0 deletions

View File

@@ -0,0 +1,62 @@
/* Copyright (C) 2016
* swift project Community / Contributors
*
* This file is part of swift project. It is subject to the license terms in the LICENSE file found in the top-level
* directory of this distribution and at http://www.swift-project.org/license.html. No part of swift project,
* including this file, may be copied, modified, propagated, or distributed except according to the terms
* contained in the LICENSE file.
*/
#include "blackmisc/processinfo.h"
#include <QFile>
#include <QFileInfo>
#include <type_traits>
#if defined(Q_OS_OSX)
#include <libproc.h>
#elif defined(Q_OS_WIN)
#include <windows.h>
#include <psapi.h>
#endif
namespace BlackMisc
{
QString CProcessInfo::convertToQString(bool) const
{
return QString("{ %1, %2 }").arg(QString::number(m_pid), m_name);
}
#if defined(Q_OS_LINUX)
QString CProcessInfo::processNameFromId(qint64 pid)
{
QString path = QFileInfo(QString("/proc/%1/exe").arg(pid)).symLinkTarget();
return QFileInfo(path).fileName();
}
#elif defined(Q_OS_OSX)
QString CProcessInfo::processNameFromId(qint64 pid)
{
char name[1024];
proc_name(pid, name, std::extent<decltype(name)>::value);
return name;
}
#elif defined(Q_OS_WIN)
QString CProcessInfo::processNameFromId(qint64 pid)
{
HANDLE proc = OpenProcess(PROCESS_QUERY_INFORMATION | PROCESS_VM_READ, FALSE, static_cast<DWORD>(pid));
if (! proc) { return ""; }
wchar_t path[1024];
auto len = GetModuleFileNameEx(proc, nullptr, path, std::extent<decltype(path)>::value);
CloseHandle(proc);
if (len <= 0) { return ""; }
return QFileInfo(QString::fromWCharArray(path)).completeBaseName();
}
#else
QString CProcessInfo::processNameFromId(qint64)
{
qFatal("Not implemented");
return "";
}
#endif
}

View File

@@ -0,0 +1,67 @@
/* Copyright (C) 2016
* swift project Community / Contributors
*
* This file is part of swift project. It is subject to the license terms in the LICENSE file found in the top-level
* directory of this distribution and at http://www.swift-project.org/license.html. No part of swift project,
* including this file, may be copied, modified, propagated, or distributed except according to the terms
* contained in the LICENSE file.
*/
//! \file
#ifndef BLACKMISC_PROCESSINFO_H
#define BLACKMISC_PROCESSINFO_H
#include "blackmisc/valueobject.h"
#include <QCoreApplication>
#include <QString>
namespace BlackMisc
{
/*!
* Value class identifying a process, with a PID and a name.
*/
class BLACKMISC_EXPORT CProcessInfo : public CValueObject<CProcessInfo>
{
public:
//! Construct an object identifying an invalid process.
CProcessInfo() {}
//! Construct an object identifying the process with the given PID.
explicit CProcessInfo(qint64 pid) : m_pid(pid), m_name(processNameFromId(pid)) {}
//! Construct an object identifying a process with the given PID and name.
CProcessInfo(qint64 pid, const QString &name) : m_pid(pid), m_name(name) {}
//! Return an object identifying the current process.
static CProcessInfo currentProcess() { return CProcessInfo(QCoreApplication::applicationPid()); }
//! True if this object identifies a process that exists.
bool exists() const { return ! m_name.isEmpty() && *this == CProcessInfo(m_pid); }
//! Get the pid.
qint64 processId() const { return m_pid; }
//! Get the process name.
const QString &processName() const { return m_name; }
//! \copydoc BlackMisc::Mixin::String::toQString
QString convertToQString(bool i18n = false) const;
private:
static QString processNameFromId(qint64 pid);
qint64 m_pid = 0;
QString m_name;
BLACK_METACLASS(
CProcessInfo,
BLACK_METAMEMBER(pid),
BLACK_METAMEMBER(name)
);
};
}
Q_DECLARE_METATYPE(BlackMisc::CProcessInfo)
#endif

View File

@@ -28,6 +28,7 @@
#include "blackmisc/network/registermetadatanetwork.h"
#include "blackmisc/pixmap.h"
#include "blackmisc/pq/registermetadatapq.h"
#include "blackmisc/processinfo.h"
#include "blackmisc/propertyindex.h"
#include "blackmisc/propertyindexlist.h"
#include "blackmisc/propertyindexvariantmap.h"
@@ -71,6 +72,7 @@ namespace BlackMisc
CNameVariantPair::registerMetadata();
CNameVariantPairList::registerMetadata();
CPixmap::registerMetadata();
CProcessInfo::registerMetadata();
CPropertyIndex::registerMetadata();
CPropertyIndex::registerMetadata();
CPropertyIndexList::registerMetadata();

View File

@@ -23,6 +23,7 @@
#include "testlibrarypath.h"
#include "testmath.h"
#include "testphysicalquantities.h"
#include "testprocess.h"
#include "testslot.h"
#include "teststringutils.h"
#include "testvaluecache.h"
@@ -95,6 +96,10 @@ namespace BlackMiscTest
CTestLibraryPath libraryPathTests;
status |= test.exec(&libraryPathTests, "blackmisc_librarypath");
}
{
CTestProcess processTests;
status |= test.exec(&processTests, "blackmisc_process");
}
return status;
}
} // namespace

View File

@@ -0,0 +1,43 @@
/* Copyright (C) 2016
* swift Project Community / Contributors
*
* This file is part of swift project. It is subject to the license terms in the LICENSE file found in the top-level
* directory of this distribution and at http://www.swift-project.org/license.html. No part of swift project,
* including this file, may be copied, modified, propagated, or distributed except according to the terms
* contained in the LICENSE file.
*/
//! \cond PRIVATE_TESTS
/*!
* \file
* \ingroup testblackmisc
*/
#include "testprocess.h"
#include "blackmisc/processinfo.h"
#include <QTest>
#include <QCoreApplication>
using namespace BlackMisc;
namespace BlackMiscTest
{
void CTestProcess::processInfo()
{
CProcessInfo invalid;
QVERIFY2(! invalid.exists(), "Invalid process shall not exist");
CProcessInfo current1(CProcessInfo::currentProcess());
CProcessInfo current2(QCoreApplication::applicationPid());
CProcessInfo current3(QCoreApplication::applicationPid(), QCoreApplication::applicationName());
QVERIFY2(current1.exists(), "Current process shall exist");
QVERIFY2(current1 == current2, "Current process equals process with current PID");
QVERIFY2(current1 == current3, "Current process equals process with current PID and name");
}
}
//! \endcond

View File

@@ -0,0 +1,41 @@
/* Copyright (C) 2016
* swift project community / contributors
*
* This file is part of swift project. It is subject to the license terms in the LICENSE file found in the top-level
* directory of this distribution and at http://www.swift-project.org/license.html. No part of swift project,
* including this file, may be copied, modified, propagated, or distributed except according to the terms
* contained in the LICENSE file.
*/
#ifndef BLACKMISCTEST_TESTPROCESS_H
#define BLACKMISCTEST_TESTPROCESS_H
//! \cond PRIVATE_TESTS
/*!
* \file
* \ingroup testblackmisc
*/
#include <QObject>
namespace BlackMiscTest
{
//! Testing process tools
class CTestProcess : public QObject
{
Q_OBJECT
public:
//! Constructor
explicit CTestProcess(QObject *parent = nullptr) : QObject(parent) {}
private slots:
//! Process info tests
void processInfo();
};
}
//! \endcond
#endif