# Namespace KMacroExpander

Module | kdecore
Namespace | KMacroExpander

### methods

- expandMacros (str, map, c)

  returns QString

  Argument | Type | Default
  --- | --- | ---
  str | QString |
  map | QHash<QChar,QString> |
  c | QChar | '%'

  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.

  str - The string to expand

  map - map with substitutions

  c - escape char indicating start of macro, or QChar.null if none Returns the string with all valid macros expanded

      // Code example
      QHash<QChar,QString> map;
      map.insert('u', "/tmp/myfile.txt");
      map.insert('n', "My File");
      QString s = "%% Title: %u:%n";
      s = KMacroExpander.expandMacros(s, map);
      // s is now "% Title: /tmp/myfile.txt:My File";

- expandMacros (str, map, c)

  returns QString

  Argument | Type | Default
  --- | --- | ---
  str | QString |
  map | QHash<QString,QString> |
  c | QChar | 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.

  str - The string to expand

  map - map with substitutions

  c - escape char indicating start of macro, or QChar.null if none Returns the string with all valid macros expanded

      // Code example
      QHash<QString,QString> map;
      map.insert("url", "/tmp/myfile.txt");
      map.insert("name", "My File");
      QString s = "Title: %{url}-%name";
      s = KMacroExpander.expandMacros(s, map);
      // s is now "Title: /tmp/myfile.txt-My File";

- expandMacros (str, map, c)

  returns QString

  Argument | Type | Default
  --- | --- | ---
  str | QString |
  map | QHash<QChar,QStringList> |
  c | QChar | QLatin1Char('%')

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

- expandMacros (str, map, c)

  returns QString

  Argument | Type | Default
  --- | --- | ---
  str | QString |
  map | QHash<QString,QStringList> |
  c | QChar | QLatin1Char('%')

- expandMacrosShellQuote (str, map, c)

  returns QString

  Argument | Type | Default
  --- | --- | ---
  str | QString |
  map | QHash<QChar,QString> |
  c | QChar | 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.

  str - The string to expand

  map - map with substitutions

  c - escape 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
      QHash<QChar,QString> map;
      map.insert('u', "/tmp/myfile.txt");
      map.insert('n', "My File");
      QString s = "kedit --caption %n %u";
      s = KMacroExpander.expandMacrosShellQuote(s, map);
      // s is now "kedit --caption 'My File' '/tmp/myfile.txt'";
      system(QFile.encodeName(s));

- expandMacrosShellQuote (str, map, c)

  returns QString

  Argument | Type | Default
  --- | --- | ---
  str | QString |
  map | QHash<QString,QString> |
  c | QChar | 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.

  str - The string to expand

  map - map with substitutions

  c - escape 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
      QHash<QString,QString> map;
      map.insert("url", "/tmp/myfile.txt");
      map.insert("name", "My File");
      QString s = "kedit --caption %name %{url}";
      s = KMacroExpander.expandMacrosShellQuote(s, map);
      // s is now "kedit --caption 'My File' '/tmp/myfile.txt'";
      system(QFile.encodeName(s));

- expandMacrosShellQuote (str, map, c)

  returns QString

  Argument | Type | Default
  --- | --- | ---
  str | QString |
  map | QHash<QChar,QStringList> |
  c | QChar | 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.

- expandMacrosShellQuote (str, map, c)

  returns QString

  Argument | Type | Default
  --- | --- | ---
  str | QString |
  map | QHash<QString,QStringList> |
  c | QChar | QLatin1Char('%')