• Skip to content
• Skip to link menu

KDE 3.5 API Reference

• KDE API Reference
• API Reference

• Sitemap
• Contact Us

 

KDECore

kprocess.h

Go to the documentation of this file.

/* This file is part of the KDE libraries
    Copyright (C) 1997 Christian Czezakte (e9025461@student.tuwien.ac.at)

    This library is free software; you can redistribute it and/or
    modify it under the terms of the GNU Library General Public
    License as published by the Free Software Foundation; either
    version 2 of the License, or (at your option) any later version.

    This library is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    Library General Public License for more details.

    You should have received a copy of the GNU Library General Public License
    along with this library; see the file COPYING.LIB.  If not, write to
    the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
    Boston, MA 02110-1301, USA.
*/

#ifndef __kprocess_h__
#define __kprocess_h__

#include <sys/types.h> // for pid_t
#include <sys/wait.h>
#include <signal.h>
#include <unistd.h>
#include <qvaluelist.h>
#include <qcstring.h>
#include <qobject.h>
#include "kdelibs_export.h"

class QSocketNotifier;
class KProcessPrivate;
class KPty;

class KDECORE_EXPORT KProcess : public QObject
{
  Q_OBJECT

public:

  enum Communication {
       NoCommunication = 0,
       Stdin = 1, Stdout = 2, Stderr = 4,
       AllOutput = 6, All = 7,
       NoRead = 8,
       CTtyOnly = NoRead,
       MergedStderr = 16
  };

  enum RunMode {
       DontCare,
       NotifyOnExit,
       Block,
       OwnGroup
  };

  KProcess( QObject* parent, const char *name = 0 );
 // KDE4 merge with the above
  KProcess();

  virtual ~KProcess();

  bool setExecutable(const QString& proc) KDE_DEPRECATED;


  KProcess &operator<<(const QString& arg);
  KProcess &operator<<(const char * arg);
  KProcess &operator<<(const QCString & arg);

  KProcess &operator<<(const QStringList& args);

  void clearArguments();

  virtual bool start(RunMode  runmode = NotifyOnExit,
    Communication comm = NoCommunication);

  virtual bool kill(int signo = SIGTERM);

  bool isRunning() const;

  pid_t pid() const;

  KDE_DEPRECATED pid_t getPid() const { return pid(); }

  void suspend();

  void resume();

  bool wait(int timeout = -1);

  bool normalExit() const;

  bool signalled() const;

  bool coreDumped() const;

  int exitStatus() const;

  int exitSignal() const;

  bool writeStdin(const char *buffer, int buflen);

  bool closeStdin();

  bool closeStdout();

  bool closeStderr();

  bool closePty();

  void closeAll();

  const QValueList<QCString> &args() /* const */ { return arguments; }

  void setRunPrivileged(bool keepPrivileges);

  bool runPrivileged() const;

  void setEnvironment(const QString &name, const QString &value);

  void setWorkingDirectory(const QString &dir);

  void setUseShell(bool useShell, const char *shell = 0);

  static QString quote(const QString &arg);

  void detach();

#ifdef Q_OS_UNIX

  void setUsePty(Communication comm, bool addUtmp);

  KPty *pty() const;
#endif

  enum { PrioLowest = 20, PrioLow = 10, PrioLower = 5, PrioNormal = 0,
    PrioHigher = -5, PrioHigh = -10, PrioHighest = -19 };

  bool setPriority(int prio);

signals:
  void processExited(KProcess *proc);


  void receivedStdout(KProcess *proc, char *buffer, int buflen);

  void receivedStdout(int fd, int &len); // KDE4: change, broken API


  void receivedStderr(KProcess *proc, char *buffer, int buflen);

  void wroteStdin(KProcess *proc);


protected slots:

  void slotChildOutput(int fdno);

  void slotChildError(int fdno);

  void slotSendData(int dummy); // KDE 4: remove dummy

protected:

  void setupEnvironment();

  QValueList<QCString> arguments;
  RunMode run_mode;
  bool runs;

  pid_t pid_;

  int status;


  bool keepPrivs;

  virtual int setupCommunication(Communication comm);

  virtual int commSetupDoneP();

  virtual int commSetupDoneC();


  virtual void processHasExited(int state);

  virtual void commClose();

  /* KDE 4 - commClose will be changed to perform cleanup only in all cases *
   * If @p notfd is -1, all data immediately available from the
   *  communication links should be processed.
   * If @p notfd is not -1, the communication links should be monitored
   *  for data until the file handle @p notfd becomes ready for reading.
   */
//  virtual void commDrain(int notfd);

  void setBinaryExecutable(const char *filename);

  int out[2];
  int in[2];
  int err[2];

  QSocketNotifier *innot;
  QSocketNotifier *outnot;
  QSocketNotifier *errnot;

  Communication communication;

  int childOutput(int fdno);

  int childError(int fdno);

  const char *input_data;
  int input_sent;
  int input_total;

  friend class KProcessController;

protected:
  virtual void virtual_hook( int id, void* data );
private:
  KProcessPrivate *d;
};

class KShellProcessPrivate;

class KDECORE_EXPORT KShellProcess: public KProcess
{
  Q_OBJECT

public:

  KShellProcess(const char *shellname=0);

  ~KShellProcess();

  virtual bool start(RunMode  runmode = NotifyOnExit,
          Communication comm = NoCommunication);

  static QString quote(const QString &arg);

private:
  QCString shell;

protected:
  virtual void virtual_hook( int id, void* data );
private:
  KShellProcessPrivate *d;
};



#endif

KDECore

Skip menu "KDECore"

• Main Page
• Modules
• Namespace List
• Class Hierarchy
• Alphabetical List
• Class List
• File List
• Namespace Members
• Class Members
• Related Pages

API Reference

Skip menu "API Reference"

• dcop
• DNSSD
• interfaces
• Kate
• kconf_update
• KDECore
• KDED
• kdefx
• KDEsu
• kdeui
• KDocTools
• KHTML
• KImgIO
• KInit
• kio
• kioslave
• KJS
• KNewStuff
• KParts
• KUtils

Generated for API Reference by doxygen 1.5.9
This website is maintained by Adriaan de Groot and Allen Winter.
KDE^® and the K Desktop Environment^® logo are registered trademarks of KDE e.V. | Legal