<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en_US" xml:lang="en_US">
<head>
<title>kalarm/lib: shellprocess.h Source File (kalarm/lib)</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta http-equiv="Content-Style-Type" content="text/css" />
<meta http-equiv="pics-label" content='(pics-1.1 "http://www.icra.org/ratingsv02.html" comment "ICRAonline DE v2.0" l gen true for "http://www.kde.org" r (nz 1 vz 1 lz 1 oz 1 cb 1) "http://www.rsac.org/ratingsv01.html" l gen true for "http://www.kde.org" r (n 0 s 0 v 0 l 0))' />
<meta name="trademark" content="KDE e.V." />
<meta name="description" content="K Desktop Environment Homepage, KDE.org" />
<meta name="MSSmartTagsPreventParsing" content="true" />
<meta name="robots" content="all" />
<link rel="shortcut icon" href="../../../favicon.ico" />
<link rel="stylesheet" media="screen" type="text/css" title="APIDOX" href="doxygen.css" />
<style type="text/css">
<!--
hr { display: none; }
#content h2 { margin-left: 0px; }
table.mdTable { background-color: #f8f8f8; border: .2em solid #d7d7d7; }
td.mdRow { padding: 8px 20px; }
td.md { font-weight: bold; }
td.mdname1 { font-weight: bold; color: #602020; }
td.mdname { font-weight: bold; color: #602020; }
-->
</style>
</head>
<body>
<div id="nav_header_top" align="right">
<a href="#content" class="doNotDisplay" accesskey="2">Skip to main content ::</a>
<a href="../../.."><img id="nav_header_logo" alt="Home" align="left" src="../../../kde_gear_64.png" border="0" /></a>
<span class="doNotDisplay">::</span>
<img id="nav_header_logo_right" alt="" align="right" src="../../../pimlogo.png" border="0" />
<div id="nav_header_title" align="left">KDE PIM API Reference</div>
</div>
<div id="nav_header_bottom" align="right">
<span class="doNotDisplay">:: <a href="#navigation" accesskey="5">Skip to Link Menu</a><br/></span>
<div id="nav_header_bottom_left" style="text-align: left;">
/ <a href="../../../">API Reference</a>
/ <a href="../../html/index.html">kalarm</a> / <a href=".">lib</a>
</div>
</div>
<table id="main" border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td valign="top" class="menuheader" height="0"></td>
<td id="contentcolumn" valign="top" rowspan="2" >
<div id="content" style="padding-top: 0px;"><div style="width:100%; margin: 0px; padding: 0px;">
<h2><a name="content"></a>kalarm/lib</h2>
<!-- Generated by Doxygen 1.5.5 -->
<h1>shellprocess.h</h1><a href="shellprocess_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span>
<a name="l00002"></a>00002 <span class="comment"> * shellprocess.h - execute a process through the shell</span>
<a name="l00003"></a>00003 <span class="comment"> * Program: kalarm</span>
<a name="l00004"></a>00004 <span class="comment"> * Copyright © 2004-2006 by David Jarvie <software@astrojar.org.uk></span>
<a name="l00005"></a>00005 <span class="comment"> *</span>
<a name="l00006"></a>00006 <span class="comment"> * This program is free software; you can redistribute it and/or modify</span>
<a name="l00007"></a>00007 <span class="comment"> * it under the terms of the GNU General Public License as published by</span>
<a name="l00008"></a>00008 <span class="comment"> * the Free Software Foundation; either version 2 of the License, or</span>
<a name="l00009"></a>00009 <span class="comment"> * (at your option) any later version.</span>
<a name="l00010"></a>00010 <span class="comment"> *</span>
<a name="l00011"></a>00011 <span class="comment"> * This program is distributed in the hope that it will be useful,</span>
<a name="l00012"></a>00012 <span class="comment"> * but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="l00013"></a>00013 <span class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span>
<a name="l00014"></a>00014 <span class="comment"> * GNU General Public License for more details.</span>
<a name="l00015"></a>00015 <span class="comment"> *</span>
<a name="l00016"></a>00016 <span class="comment"> * You should have received a copy of the GNU General Public License along</span>
<a name="l00017"></a>00017 <span class="comment"> * with this program; if not, write to the Free Software Foundation, Inc.,</span>
<a name="l00018"></a>00018 <span class="comment"> * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</span>
<a name="l00019"></a>00019 <span class="comment"> */</span>
<a name="l00020"></a>00020
<a name="l00021"></a>00021 <span class="preprocessor">#ifndef SHELLPROCESS_H</span>
<a name="l00022"></a>00022 <span class="preprocessor"></span><span class="preprocessor">#define SHELLPROCESS_H</span>
<a name="l00023"></a>00023 <span class="preprocessor"></span>
<a name="l00026"></a>00026 <span class="preprocessor">#include <kprocess.h></span>
<a name="l00027"></a>00027
<a name="l00028"></a>00028
<a name="l00050"></a><a class="code" href="classShellProcess.html">00050</a> <span class="keyword">class </span><a class="code" href="classShellProcess.html" title="Enhanced KShellProcess.">ShellProcess</a> : <span class="keyword">public</span> KShellProcess
<a name="l00051"></a>00051 {
<a name="l00052"></a>00052 Q_OBJECT
<a name="l00053"></a>00053 <span class="keyword">public</span>:
<a name="l00063"></a><a class="code" href="classShellProcess.html#a621f828812dd253cd7fae7c74a6cce9">00063</a> <span class="keyword">enum</span> <a class="code" href="classShellProcess.html#a621f828812dd253cd7fae7c74a6cce9" title="Current status of the shell process.">Status</a> {
<a name="l00064"></a>00064 INACTIVE, <span class="comment">// start() has not yet been called to run the command</span>
<a name="l00065"></a>00065 RUNNING, <span class="comment">// command is currently running</span>
<a name="l00066"></a>00066 SUCCESS, <span class="comment">// command appears to have exited successfully</span>
<a name="l00067"></a>00067 UNAUTHORISED, <span class="comment">// shell commands are not authorised for this user</span>
<a name="l00068"></a>00068 DIED, <span class="comment">// command didn't exit cleanly, i.e. was killed or died</span>
<a name="l00069"></a>00069 NOT_FOUND, <span class="comment">// command either not found or not executable</span>
<a name="l00070"></a>00070 START_FAIL <span class="comment">// command couldn't be started for other reasons</span>
<a name="l00071"></a>00071 };
<a name="l00075"></a>00075 <span class="keyword">explicit</span> <a class="code" href="classShellProcess.html#b998699c68b81670630102453916eb7f" title="Constructor.">ShellProcess</a>(<span class="keyword">const</span> QString& <a class="code" href="classShellProcess.html#3dd7a7777e0860d7c2c6c20e21adea7e" title="Returns the command configured to be run.">command</a>);
<a name="l00080"></a>00080 <span class="keywordtype">bool</span> <a class="code" href="classShellProcess.html#d0d03c8890d9d65390331a08639a55cb" title="Executes the configured command.">start</a>(Communication comm = NoCommunication);
<a name="l00082"></a><a class="code" href="classShellProcess.html#08be1766b48be273e55b15234b013951">00082</a> <a class="code" href="classShellProcess.html#a621f828812dd253cd7fae7c74a6cce9" title="Current status of the shell process.">Status</a> <a class="code" href="classShellProcess.html#08be1766b48be273e55b15234b013951" title="Returns the current status of the shell process.">status</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> mStatus; }
<a name="l00086"></a><a class="code" href="classShellProcess.html#eb9085ff0fdc9818c406e3d402e5ab41">00086</a> <span class="keywordtype">bool</span> <a class="code" href="classShellProcess.html#eb9085ff0fdc9818c406e3d402e5ab41" title="Returns whether the command was run successfully.">normalExit</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> mStatus == SUCCESS; }
<a name="l00088"></a><a class="code" href="classShellProcess.html#3dd7a7777e0860d7c2c6c20e21adea7e">00088</a> <span class="keyword">const</span> QString& <a class="code" href="classShellProcess.html#3dd7a7777e0860d7c2c6c20e21adea7e" title="Returns the command configured to be run.">command</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> mCommand; }
<a name="l00093"></a>00093 QString <a class="code" href="classShellProcess.html#ff9feccbb29a96be48d6269d9ab8a0cd" title="Returns the error message corresponding to the command exit status.">errorMessage</a>() <span class="keyword">const</span>;
<a name="l00095"></a>00095 <span class="keywordtype">void</span> <a class="code" href="classShellProcess.html#cb791e66ac48bfde8099158ef1981ba0" title="Writes a string to the process&#39;s STDIN.">writeStdin</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* buffer, <span class="keywordtype">int</span> bufflen);
<a name="l00097"></a>00097 <span class="keywordtype">void</span> <a class="code" href="classShellProcess.html#ce5ee3743de668f13f183878ec9ca6d3" title="Tell the process to exit once any outstanding STDIN strings have been written.">stdinExit</a>();
<a name="l00101"></a>00101 <span class="keyword">static</span> <span class="keywordtype">bool</span> <a class="code" href="classShellProcess.html#54d0ce5a9604c1ecb73b2df02aad0004" title="Returns whether the user is authorised to run shell commands.">authorised</a>();
<a name="l00105"></a><a class="code" href="classShellProcess.html#840c439766524fdffe2046db9b01b3f4">00105</a> <span class="keyword">static</span> <span class="keyword">const</span> QCString& <a class="code" href="classShellProcess.html#840c439766524fdffe2046db9b01b3f4" title="Determines which shell to use.">shellName</a>() { <a class="code" href="classShellProcess.html#e84b465358d803a98270b9777604ab60" title="Determines which shell to use.">shellPath</a>(); <span class="keywordflow">return</span> mShellName; }
<a name="l00109"></a>00109 <span class="keyword">static</span> <span class="keyword">const</span> QCString& <a class="code" href="classShellProcess.html#e84b465358d803a98270b9777604ab60" title="Determines which shell to use.">shellPath</a>();
<a name="l00110"></a>00110
<a name="l00111"></a>00111 signals:
<a name="l00115"></a>00115 <span class="keywordtype">void</span> <a class="code" href="classShellProcess.html#700e2ae26a88d5e2a9d5d1a63be2a45e" title="Signal emitted when the shell process execution completes.">shellExited</a>(<a class="code" href="classShellProcess.html" title="Enhanced KShellProcess.">ShellProcess</a>*);
<a name="l00116"></a>00116
<a name="l00117"></a>00117 <span class="keyword">private</span> slots:
<a name="l00118"></a>00118 <span class="keywordtype">void</span> writtenStdin(KProcess*);
<a name="l00119"></a>00119 <span class="keywordtype">void</span> slotExited(KProcess*);
<a name="l00120"></a>00120
<a name="l00121"></a>00121 <span class="keyword">private</span>:
<a name="l00122"></a>00122 <span class="comment">// Prohibit the following inherited methods</span>
<a name="l00123"></a>00123 <a class="code" href="classShellProcess.html" title="Enhanced KShellProcess.">ShellProcess</a>& operator<<(<span class="keyword">const</span> QString&);
<a name="l00124"></a>00124 <a class="code" href="classShellProcess.html" title="Enhanced KShellProcess.">ShellProcess</a>& operator<<(<span class="keyword">const</span> QCString&);
<a name="l00125"></a>00125 <a class="code" href="classShellProcess.html" title="Enhanced KShellProcess.">ShellProcess</a>& operator<<(<span class="keyword">const</span> QStringList&);
<a name="l00126"></a>00126 <a class="code" href="classShellProcess.html" title="Enhanced KShellProcess.">ShellProcess</a>& operator<<(<span class="keyword">const</span> <span class="keywordtype">char</span>*);
<a name="l00127"></a>00127
<a name="l00128"></a>00128 <span class="keyword">static</span> QCString mShellName; <span class="comment">// name of shell to be used</span>
<a name="l00129"></a>00129 <span class="keyword">static</span> QCString mShellPath; <span class="comment">// path of shell to be used</span>
<a name="l00130"></a>00130 <span class="keyword">static</span> <span class="keywordtype">bool</span> mInitialised; <span class="comment">// true once static data has been initialised</span>
<a name="l00131"></a>00131 <span class="keyword">static</span> <span class="keywordtype">bool</span> mAuthorised; <span class="comment">// true if shell commands are authorised</span>
<a name="l00132"></a>00132 QString mCommand; <span class="comment">// copy of command to be executed</span>
<a name="l00133"></a>00133 QValueList<QCString> mStdinQueue; <span class="comment">// queued strings to send to STDIN</span>
<a name="l00134"></a>00134 <a class="code" href="classShellProcess.html#a621f828812dd253cd7fae7c74a6cce9" title="Current status of the shell process.">Status</a> mStatus; <span class="comment">// current execution status</span>
<a name="l00135"></a>00135 <span class="keywordtype">bool</span> mStdinExit; <span class="comment">// exit once STDIN queue has been written</span>
<a name="l00136"></a>00136 };
<a name="l00137"></a>00137
<a name="l00138"></a>00138 <span class="preprocessor">#endif // SHELLPROCESS_H</span>
</pre></div></div>
</div></div>
</td>
</tr>
<tr>
<td valign="top" id="leftmenu" width="25%">
<a name="navigation"></a>
<div class="menu_box"><h2>kalarm/lib</h2>
<div class="nav_list">
<ul><li><a href="index.html">Main Page</a></li><li><a href="hierarchy.html">Class Hierarchy</a></li><li><a href="classes.html">Alphabetical List</a></li><li><a href="annotated.html">Class List</a></li><li><a href="files.html">File List</a></li><li><a href="functions.html">Class Members</a></li></ul>
<!--
<h2>Class Picker</h2>
<div style="text-align: center;">
<form name="guideform">
<select name="guidelinks" style="width:100%;" onChange="window.location=document.guideform.guidelinks.options[document.guideform.guidelinks.selectedIndex].value">
<option value="annotated.html">-- Choose --</option>
<option value="classButtonGroup.html">buttongroup</option>, <option value="classCheckBox.html">checkbox</option>, <option value="classColourCombo.html">colourcombo</option>, <option value="classColourList.html">colourlist</option>, <option value="classComboBox.html">combobox</option>, <option value="classDailyTimer.html">dailytimer</option>, <option value="classDateEdit.html">dateedit</option>, <option value="classDateTime.html">datetime</option>, <option value="classLabel.html">label</option>, <option value="classLineEdit.html">lineedit</option>, <option value="classMessageBox.html">messagebox</option>, <option value="classMidnightTimer.html">midnighttimer</option>, <option value="classMinuteTimer.html">minutetimer</option>, <option value="classPushButton.html">pushbutton</option>, <option value="classRadioButton.html">radiobutton</option>, <option value="classShellProcess.html">shellprocess</option>, <option value="classSlider.html">slider</option>, <option value="classSpinBox.html">spinbox</option>, <option value="classSpinBox2.html">spinbox2</option>, <option value="classSynchTimer.html">synchtimer</option>, <option value="classTimeEdit.html">timeedit</option>, <option value="classTimePeriod.html">timeperiod</option>, <option value="classTimeSpinBox.html">timespinbox</option>,
</select>
</form>
</div>
-->
</div></div>
<div class="menu_box"><h2>API Dox</h2>
<div class="nav_list">
<ul>
<li><a href="../../../akregator/html/index.html">akregator</a></li><li> <a href="../../../akregator/src/html/index.html">src</a></li><li> <a href="../../../akregator/src/librss/html/index.html">librss</a></li><li><a href="../../../certmanager/html/index.html">certmanager</a></li><li> <a href="../../../certmanager/lib/html/index.html">lib</a></li><li><a href="../../../kaddressbook/html/index.html">kaddressbook</a></li><li><a href="../../../kalarm/html/index.html">kalarm</a></li><li> <a href="../../../kalarm/lib/html/index.html">lib</a></li><li><a href="../../../kandy/html/index.html">kandy</a></li><li><a href="../../../karm/html/index.html">karm</a></li><li><a href="../../../kdgantt/html/index.html">kdgantt</a></li><li><a href="../../../kgantt/html/index.html">kgantt</a></li><li><a href="../../../kioslaves/html/index.html">kioslaves</a></li><li> <a href="../../../kioslaves/imap4/html/index.html">imap4</a></li><li> <a href="../../../kioslaves/mbox/html/index.html">mbox</a></li><li><a href="../../../kitchensync/html/index.html">kitchensync</a></li><li><a href="../../../kmail/html/index.html">kmail</a></li><li><a href="../../../knotes/html/index.html">knotes</a></li><li><a href="../../../konsolekalendar/html/index.html">konsolekalendar</a></li><li><a href="../../../kontact/html/index.html">kontact</a></li><li><a href="../../../korganizer/html/index.html">korganizer</a></li><li><a href="../../../kpilot/html/index.html">kpilot</a></li><li> <a href="../../../kpilot/kpilot/html/index.html">kpilot</a></li><li> <a href="../../../kpilot/lib/html/index.html">lib</a></li><li><a href="../../../libemailfunctions/html/index.html">libemailfunctions</a></li><li><a href="../../../libkcal/html/index.html">libkcal</a></li><li><a href="../../../libkdepim/html/index.html">libkdepim</a></li><li><a href="../../../libkholidays/html/index.html">libkholidays</a></li><li><a href="../../../libkmime/html/index.html">libkmime</a></li><li><a href="../../../libkpgp/html/index.html">libkpgp</a></li><li><a href="../../../libkpimidentities/html/index.html">libkpimidentities</a></li>
</ul></div></div>
</td>
</tr>
</table>
<span class="doNotDisplay">
<a href="http://www.kde.org/" accesskey="8">KDE Home</a> |
<a href="http://accessibility.kde.org/" accesskey="9">KDE Accessibility Home</a> |
<a href="http://www.kde.org/media/accesskeys.php" accesskey="0">Description of Access Keys</a>
</span>
<div style="height: 8px"></div>
<div id="footer">
<div id="footer_left">
Maintained by <a href="mailto:groot@kde.org">Adriaan de Groot</a>
and
<a href="mailto:winter@kde.org">Allen Winter</a>.
<br/>
KDE and K Desktop Environment are trademarks of <a href="http://www.kde.org/areas/kde-ev/" title="Homepage of the KDE non-profit Organization">KDE e.V.</a> |
<a href="http://www.kde.org/contact/impressum.php">Legal</a>
</div>
<div id="footer_right"><img src="/media/images/footer_right.png" style="margin: 0px" alt="" /></div>
</div>
<!--
WARNING: DO NOT SEND MAIL TO THE FOLLOWING EMAIL ADDRESS! YOU WILL
BE BLOCKED INSTANTLY AND PERMANENTLY!
<a href="mailto:aaaatrap-425acc3b5374943f@kde.org">Block me</a>
WARNING END
-->
</body>
</html>
