File indexing completed on 2024-04-21 05:51:27

 /*
     SPDX-FileCopyrightText: 2007-2008 Robert Knight <robertknight@gmail.com>
 
     SPDX-License-Identifier: GPL-2.0-or-later
 */
 
 #ifndef SHELLCOMMAND_H
 #define SHELLCOMMAND_H
 
 // Qt
 #include <QStringList>
 
 namespace Konsole
 {
 /**
  * A class to parse and extract information about shell commands.
  *
  * ShellCommand can be used to:
  *
  * <ul>
  *      <li>Take a command-line (eg "/bin/sh -c /path/to/my/script") and split it
  *          into its component parts (eg. the command "/bin/sh" and the arguments
  *          "-c","/path/to/my/script")
  *      </li>
  *      <li>Take a command and a list of arguments and combine them to
  *          form a complete command line.
  *      </li>
  *      <li>Determine whether the binary specified by a command exists in the
  *          user's PATH.
  *      </li>
  *      <li>Determine whether a command-line specifies the execution of
  *          another command as the root user using su/sudo etc.
  *      </li>
  * </ul>
  */
 class ShellCommand
 {
 public:
     /**
      * Constructs a ShellCommand from a command line.
      *
      * @param aCommand The command line to parse.
      */
     explicit ShellCommand(const QString &aCommand);
     /**
      * Constructs a ShellCommand with the specified @p aCommand and @p aArguments.
      */
     ShellCommand(const QString &aCommand, const QStringList &aArguments);
 
     /** Returns the command. */
     QString command() const;
     /** Returns the arguments. */
     QStringList arguments() const;
 
     /**
      * Returns the full command line.
      */
     QString fullCommand() const;
 
     /** Expands environment variables in @p text .*/
     static QString expand(const QString &text);
 
     /** Expands environment variables in each string in @p list. */
     static QStringList expand(const QStringList &items);
 
     static bool isValidEnvCharacter(const QChar &ch);
 
     static bool isValidLeadingEnvCharacter(const QChar &ch);
 
 private:
     static bool expandEnv(QString &text);
 
     QStringList _arguments;
 };
 }
 
 #endif // SHELLCOMMAND_H