• Skip to content
  • Skip to link menu
KDE API Reference
  • KDE API Reference
  • kdelibs API Reference
  • KDE Home
  • Contact Us
 

KDECore

  • sources
  • kde-4.14
  • kdelibs
  • kdecore
  • util
kshell.h
Go to the documentation of this file.
1 /*
2  This file is part of the KDE libraries
3 
4  Copyright (c) 2003,2007 Oswald Buddenhagen <ossi@kde.org>
5 
6  This library is free software; you can redistribute it and/or
7  modify it under the terms of the GNU Library General Public
8  License as published by the Free Software Foundation; either
9  version 2 of the License, or (at your option) any later version.
10 
11  This library is distributed in the hope that it will be useful,
12  but WITHOUT ANY WARRANTY; without even the implied warranty of
13  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14  Library General Public License for more details.
15 
16  You should have received a copy of the GNU Library General Public License
17  along with this library; see the file COPYING.LIB. If not, write to
18  the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
19  Boston, MA 02110-1301, USA.
20 */
21 #ifndef KSHELL_H
22 #define KSHELL_H
23 
24 #include <kdecore_export.h>
25 
26 class QStringList;
27 class QString;
28 
34 namespace KShell {
35 
39  enum Option {
40  NoOptions = 0,
41 
47  TildeExpand = 1,
48 
78  AbortOnMeta = 2
79  };
80  Q_DECLARE_FLAGS(Options, Option)
81 
82 
85  enum Errors {
89  NoError = 0,
90 
94  BadQuoting,
95 
100  FoundMeta
101  };
102 
145  KDECORE_EXPORT QStringList splitArgs( const QString &cmd, Options flags = NoOptions, Errors *err = 0 );
146 
158  KDECORE_EXPORT QString joinArgs( const QStringList &args );
159 
178  KDECORE_EXPORT QString quoteArg( const QString &arg );
179 
192  KDECORE_EXPORT QString tildeExpand( const QString &path );
193 }
194 
195 Q_DECLARE_OPERATORS_FOR_FLAGS(KShell::Options)
196 
197 #endif /* KSHELL_H */
kdecore_export.h
KShell::splitArgs
QStringList splitArgs(const QString &cmd, Options flags=NoOptions, Errors *err=0)
Splits cmd according to system shell word splitting and quoting rules.
Definition: kshell_unix.cpp:70
KShell::FoundMeta
The AbortOnMeta flag was set and an unhandled shell meta character was encoutered.
Definition: kshell.h:100
KShell::NoOptions
Definition: kshell.h:40
KShell::Errors
Errors
Status codes from splitArgs()
Definition: kshell.h:85
QString
QStringList
KShell::quoteArg
QString quoteArg(const QString &arg)
Quotes arg according to system shell rules.
Definition: kshell_unix.cpp:285
KShell::BadQuoting
Indicates a parsing error, like an unterminated quoted string.
Definition: kshell.h:94
KShell::NoError
Success.
Definition: kshell.h:89
KShell::tildeExpand
QString tildeExpand(const QString &path)
Performs tilde expansion on path.
Definition: kshell.cpp:55
KShell::joinArgs
QString joinArgs(const QStringList &args)
Quotes and joins args together according to system shell rules.
Definition: kshell.cpp:38
KShell::Option
Option
Flags for splitArgs().
Definition: kshell.h:39
KShell::AbortOnMeta
Put the parser into full shell mode and bail out if a too complex construct is encoutered.
Definition: kshell.h:78
KShell::TildeExpand
Perform tilde expansion.
Definition: kshell.h:47
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Mon Jun 22 2020 13:22:11 by doxygen 1.8.7 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

KDECore

Skip menu "KDECore"
  • Main Page
  • Namespace List
  • Namespace Members
  • Alphabetical List
  • Class List
  • Class Hierarchy
  • Class Members
  • File List
  • File Members
  • Modules
  • Related Pages

kdelibs API Reference

Skip menu "kdelibs API Reference"
  • DNSSD
  • Interfaces
  •   KHexEdit
  •   KMediaPlayer
  •   KSpeech
  •   KTextEditor
  • kconf_update
  • KDE3Support
  •   KUnitTest
  • KDECore
  • KDED
  • KDEsu
  • KDEUI
  • KDEWebKit
  • KDocTools
  • KFile
  • KHTML
  • KImgIO
  • KInit
  • kio
  • KIOSlave
  • KJS
  •   KJS-API
  •   WTF
  • kjsembed
  • KNewStuff
  • KParts
  • KPty
  • Kross
  • KUnitConversion
  • KUtils
  • Nepomuk
  • Plasma
  • Solid
  • Sonnet
  • ThreadWeaver

Search



Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal