KMacroExpander

KMacroExpander Namespace Reference

Enumerations

enum  Quoting {
  noquote, singlequote, doublequote, dollarquote,
  paren, subst, group, math
}
 

Functions

QString expandMacros (const QString &str, const QHash< QChar, QString > &map, QChar c=QLatin1Char('%'))
 
QString expandMacros (const QString &str, const QHash< QString, QString > &map, QChar c=QLatin1Char('%'))
 
QString expandMacros (const QString &str, const QHash< QChar, QStringList > &map, QChar c=QLatin1Char('%'))
 
QString expandMacros (const QString &ostr, const QHash< QString, QStringList > &map, QChar c)
 
QString expandMacrosShellQuote (const QString &str, const QHash< QChar, QString > &map, QChar c=QLatin1Char('%'))
 
QString expandMacrosShellQuote (const QString &str, const QHash< QString, QString > &map, QChar c=QLatin1Char('%'))
 
QString expandMacrosShellQuote (const QString &str, const QHash< QChar, QStringList > &map, QChar c=QLatin1Char('%'))
 
QString expandMacrosShellQuote (const QString &ostr, const QHash< QString, QStringList > &map, QChar c)
 

Detailed Description

A group of functions providing macro expansion (substitution) in strings, optionally with quoting appropriate for shell execution.

Function Documentation

KCOREADDONS_EXPORT QString KMacroExpander::expandMacros ( const QString str,
const QHash< QChar, QString > &  map,
QChar  c = QLatin1Char('%') 
)

Perform safe macro expansion (substitution) on a string.

The escape char must be quoted with itself to obtain its literal representation in the resulting string.

Parameters
strThe string to expand
mapmap with substitutions
cescape char indicating start of macro, or QChar::null if none
Returns
the string with all valid macros expanded
// Code example
map.insert('u', "/tmp/myfile.txt");
map.insert('n', "My File");
QString s = "%% Title: %u:%n";
// s is now "% Title: /tmp/myfile.txt:My File";

Definition at line 359 of file kmacroexpander.cpp.

KCOREADDONS_EXPORT QString KMacroExpander::expandMacros ( const QString str,
const QHash< QString, QString > &  map,
QChar  c = QLatin1Char('%') 
)

Perform safe macro expansion (substitution) on a string.

The escape char must be quoted with itself to obtain its literal representation in the resulting string. Macro names can consist of chars in the range [A-Za-z0-9_]; use braces to delimit macros from following words starting with these chars, or to use other chars for macro names.

Parameters
strThe string to expand
mapmap with substitutions
cescape char indicating start of macro, or QChar::null if none
Returns
the string with all valid macros expanded
// Code example
map.insert("url", "/tmp/myfile.txt");
map.insert("name", "My File");
QString s = "Title: %{url}-%name";
// s is now "Title: /tmp/myfile.txt-My File";

Definition at line 367 of file kmacroexpander.cpp.

KCOREADDONS_EXPORT QString KMacroExpander::expandMacros ( const QString ostr,
const QHash< QChar, QStringList > &  map,
QChar  c 
)

Same as above, except that the macros expand to string lists that are simply join(" ")ed together.

Definition at line 375 of file kmacroexpander.cpp.

KCOREADDONS_EXPORT QString KMacroExpander::expandMacrosShellQuote ( const QString str,
const QHash< QChar, QString > &  map,
QChar  c = QLatin1Char('%') 
)

Perform safe macro expansion (substitution) on a string for use in shell commands.

The escape char must be quoted with itself to obtain its literal representation in the resulting string.

Parameters
strThe string to expand
mapmap with substitutions
cescape char indicating start of macro, or QChar::null if none
Returns
the string with all valid macros expanded, or a null string if a shell syntax error was detected in the command
// Code example
map.insert('u', "/tmp/myfile.txt");
map.insert('n', "My File");
QString s = "kedit --caption %n %u";
// s is now "kedit --caption 'My File' '/tmp/myfile.txt'";
system(QFile::encodeName(s));

Definition at line 363 of file kmacroexpander.cpp.

KCOREADDONS_EXPORT QString KMacroExpander::expandMacrosShellQuote ( const QString str,
const QHash< QString, QString > &  map,
QChar  c = QLatin1Char('%') 
)

Perform safe macro expansion (substitution) on a string for use in shell commands.

See KMacroExpanderBase::expandMacrosShellQuote() for the exact semantics. The escape char must be quoted with itself to obtain its literal representation in the resulting string. Macro names can consist of chars in the range [A-Za-z0-9_]; use braces to delimit macros from following words starting with these chars, or to use other chars for macro names.

Parameters
strThe string to expand
mapmap with substitutions
cescape char indicating start of macro, or QChar::null if none
Returns
the string with all valid macros expanded, or a null string if a shell syntax error was detected in the command
// Code example
map.insert("url", "/tmp/myfile.txt");
map.insert("name", "My File");
QString s = "kedit --caption %name %{url}";
// s is now "kedit --caption 'My File' '/tmp/myfile.txt'";
system(QFile::encodeName(s));

Definition at line 371 of file kmacroexpander.cpp.

KCOREADDONS_EXPORT QString KMacroExpander::expandMacrosShellQuote ( const QString str,
const QHash< QChar, QStringList > &  map,
QChar  c = QLatin1Char('%') 
)

Same as above, except that the macros expand to string lists.

If the macro appears inside a quoted string, the list is simply join(" ")ed together; otherwise every element expands to a separate quoted string.

Definition at line 379 of file kmacroexpander.cpp.

This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Fri Sep 25 2020 23:03:07 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.