trustbridge: ui/processhelp.h annotate

annotate ui/processhelp.h @ 1218:5f59344dbd13

(issue68) License corrections: * the overall package is GNU GPL v==3. * Qt has to be used as GNU GPL, so mention it. * Oxygen is GNU LGPL v>=3. * minor corrections like typos, better phrasing for freedom protection, use GNU consistently.

author	Bernhard Reiter <bernhard@intevation.de>
date	Wed, 24 Sep 2014 11:17:14 +0200
parents	2a1206932f53
children	2a1aa9df8f11

rev	line source
603 cfef809b890d Add Process Management functions and ther implementation for windows. Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1 /* Copyright (C) 2014 by Bundesamt für Sicherheit in der Informationstechnik
cfef809b890d Add Process Management functions and ther implementation for windows. Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2 * Software engineering by Intevation GmbH
cfef809b890d Add Process Management functions and ther implementation for windows. Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3 *
cfef809b890d Add Process Management functions and ther implementation for windows. Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4 * This file is Free Software under the GNU GPL (v>=2)
cfef809b890d Add Process Management functions and ther implementation for windows. Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5 * and comes with ABSOLUTELY NO WARRANTY!
cfef809b890d Add Process Management functions and ther implementation for windows. Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6 * See LICENSE.txt for details.
cfef809b890d Add Process Management functions and ther implementation for windows. Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7 *
cfef809b890d Add Process Management functions and ther implementation for windows. Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	8 * Parts of this code (especially windows) are based on kpimutils processes.cpp
cfef809b890d Add Process Management functions and ther implementation for windows. Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	9 * available under LGPL 2.1 or later.
cfef809b890d Add Process Management functions and ther implementation for windows. Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	10 */
cfef809b890d Add Process Management functions and ther implementation for windows. Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	11 #ifndef PROCESSHELP_H
cfef809b890d Add Process Management functions and ther implementation for windows. Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	12 #define PROCESSHELP_H
cfef809b890d Add Process Management functions and ther implementation for windows. Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	13
cfef809b890d Add Process Management functions and ther implementation for windows. Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	14 #include <QList>
cfef809b890d Add Process Management functions and ther implementation for windows. Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	15 #include <QString>
cfef809b890d Add Process Management functions and ther implementation for windows. Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	16
cfef809b890d Add Process Management functions and ther implementation for windows. Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	17 /**
1053 78798d3af8f0 Fixed doxygen build warnings. Emanuel Schuetze <emanuel@intevation.de> parents: 782 diff changeset	18 * @file processhelp.h
78798d3af8f0 Fixed doxygen build warnings. Emanuel Schuetze <emanuel@intevation.de> parents: 782 diff changeset	19 * @brief Static helper functions for process handling
603 cfef809b890d Add Process Management functions and ther implementation for windows. Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	20 */
cfef809b890d Add Process Management functions and ther implementation for windows. Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	21
606 91dd38a71783 Style: run astyle on processhelp Andre Heinecke <andre.heinecke@intevation.de> parents: 603 diff changeset	22 namespace ProcessHelp
91dd38a71783 Style: run astyle on processhelp Andre Heinecke <andre.heinecke@intevation.de> parents: 603 diff changeset	23 {
91dd38a71783 Style: run astyle on processhelp Andre Heinecke <andre.heinecke@intevation.de> parents: 603 diff changeset	24 /**
91dd38a71783 Style: run astyle on processhelp Andre Heinecke <andre.heinecke@intevation.de> parents: 603 diff changeset	25 * @brief look up process id's for a processName
91dd38a71783 Style: run astyle on processhelp Andre Heinecke <andre.heinecke@intevation.de> parents: 603 diff changeset	26 *
91dd38a71783 Style: run astyle on processhelp Andre Heinecke <andre.heinecke@intevation.de> parents: 603 diff changeset	27 * Looks up processes run by the current user.
91dd38a71783 Style: run astyle on processhelp Andre Heinecke <andre.heinecke@intevation.de> parents: 603 diff changeset	28 *
91dd38a71783 Style: run astyle on processhelp Andre Heinecke <andre.heinecke@intevation.de> parents: 603 diff changeset	29 * @param[in] processName the name of the process to look for
91dd38a71783 Style: run astyle on processhelp Andre Heinecke <andre.heinecke@intevation.de> parents: 603 diff changeset	30 * @returns a list of pids that match this process. May be empty
91dd38a71783 Style: run astyle on processhelp Andre Heinecke <andre.heinecke@intevation.de> parents: 603 diff changeset	31 */
91dd38a71783 Style: run astyle on processhelp Andre Heinecke <andre.heinecke@intevation.de> parents: 603 diff changeset	32 const QList<int> getProcessesIdForName(const QString &processName);
603 cfef809b890d Add Process Management functions and ther implementation for windows. Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	33
606 91dd38a71783 Style: run astyle on processhelp Andre Heinecke <andre.heinecke@intevation.de> parents: 603 diff changeset	34 /**
91dd38a71783 Style: run astyle on processhelp Andre Heinecke <andre.heinecke@intevation.de> parents: 603 diff changeset	35 * @brief check if another process with the same name exists
91dd38a71783 Style: run astyle on processhelp Andre Heinecke <andre.heinecke@intevation.de> parents: 603 diff changeset	36 *
1162 2a1206932f53 (issue107) Comment all TODO's and FIXME's with issues as documented in issue107 Andre Heinecke <andre.heinecke@intevation.de> parents: 1053 diff changeset	37 * Under GNU/Linux this only works for processes that have a
2a1206932f53 (issue107) Comment all TODO's and FIXME's with issues as documented in issue107 Andre Heinecke <andre.heinecke@intevation.de> parents: 1053 diff changeset	38 * processName.pid file in QStandardPaths::DataLocation.
2a1206932f53 (issue107) Comment all TODO's and FIXME's with issues as documented in issue107 Andre Heinecke <andre.heinecke@intevation.de> parents: 1053 diff changeset	39 *
606 91dd38a71783 Style: run astyle on processhelp Andre Heinecke <andre.heinecke@intevation.de> parents: 603 diff changeset	40 * @param[in] processName name of the process to look for.
91dd38a71783 Style: run astyle on processhelp Andre Heinecke <andre.heinecke@intevation.de> parents: 603 diff changeset	41 *
91dd38a71783 Style: run astyle on processhelp Andre Heinecke <andre.heinecke@intevation.de> parents: 603 diff changeset	42 * @returns true if one or more processes (other than the current process) exist
91dd38a71783 Style: run astyle on processhelp Andre Heinecke <andre.heinecke@intevation.de> parents: 603 diff changeset	43 */
91dd38a71783 Style: run astyle on processhelp Andre Heinecke <andre.heinecke@intevation.de> parents: 603 diff changeset	44 bool otherProcessesExist(const QString &processName);
603 cfef809b890d Add Process Management functions and ther implementation for windows. Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	45
606 91dd38a71783 Style: run astyle on processhelp Andre Heinecke <andre.heinecke@intevation.de> parents: 603 diff changeset	46 /**
91dd38a71783 Style: run astyle on processhelp Andre Heinecke <andre.heinecke@intevation.de> parents: 603 diff changeset	47 * @brief Activates the window for first found process
91dd38a71783 Style: run astyle on processhelp Andre Heinecke <andre.heinecke@intevation.de> parents: 603 diff changeset	48 * @param [in] executableName executableName (without path and .exe extension)
91dd38a71783 Style: run astyle on processhelp Andre Heinecke <andre.heinecke@intevation.de> parents: 603 diff changeset	49 */
91dd38a71783 Style: run astyle on processhelp Andre Heinecke <andre.heinecke@intevation.de> parents: 603 diff changeset	50 void activateWindowForProcess(const QString &executableName);
782 20ca94680003 Implemented detection of running instance on linux using a lock file. Sascha Wilde <wilde@intevation.de> parents: 606 diff changeset	51
20ca94680003 Implemented detection of running instance on linux using a lock file. Sascha Wilde <wilde@intevation.de> parents: 606 diff changeset	52 /**
20ca94680003 Implemented detection of running instance on linux using a lock file. Sascha Wilde <wilde@intevation.de> parents: 606 diff changeset	53 * @brief Clean up internaly used infrastructure like pid/lock files.
20ca94680003 Implemented detection of running instance on linux using a lock file. Sascha Wilde <wilde@intevation.de> parents: 606 diff changeset	54 */
20ca94680003 Implemented detection of running instance on linux using a lock file. Sascha Wilde <wilde@intevation.de> parents: 606 diff changeset	55 void cleanUp(void);
603 cfef809b890d Add Process Management functions and ther implementation for windows. Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	56 }
782 20ca94680003 Implemented detection of running instance on linux using a lock file. Sascha Wilde <wilde@intevation.de> parents: 606 diff changeset	57
603 cfef809b890d Add Process Management functions and ther implementation for windows. Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	58 #endif // PROCESSHELP_H

Mercurial > trustbridge

annotate ui/processhelp.h @ 1218:5f59344dbd13