SBProcessInfo.h

Go to the documentation of this file.

//===-- SBProcessInfo.h -----------------------------------------*- C++ -*-===//
//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See https://llvm.org/LICENSE.txt for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
//
//===----------------------------------------------------------------------===//
 
#ifndef LLDB_API_SBPROCESSINFO_H
#define LLDB_API_SBPROCESSINFO_H
 
#include "lldb/API/SBDefines.h"
 
namespace lldb {
 
class LLDB_API SBProcessInfo {
public:
  SBProcessInfo();
  SBProcessInfo(const SBProcessInfo &rhs);
 
  ~SBProcessInfo();
 
  SBProcessInfo &operator=(const SBProcessInfo &rhs);
 
  explicit operator bool() const;
 
  bool IsValid() const;
 
  const char *GetName();
 
  SBFileSpec GetExecutableFile();
 
  /// If the process was laumched with a first argument that doesn't match
  /// the executable file or name, this will return a valid string.
  const char *GetArg0();
 
  lldb::pid_t GetProcessID();
 
  uint32_t GetUserID();
 
  uint32_t GetGroupID();
 
  bool UserIDIsValid();
 
  bool GroupIDIsValid();
 
  uint32_t GetEffectiveUserID();
 
  uint32_t GetEffectiveGroupID();
 
  bool EffectiveUserIDIsValid();
 
  bool EffectiveGroupIDIsValid();
 
  lldb::pid_t GetParentProcessID();
 
  /// Return the target triple (arch-vendor-os) for the described process.
  const char *GetTriple();
 
  /// Returns the number of command line arguments for the described process.
  uint32_t GetNumArguments() const;
 
  /// Returns the command line argument at the given index, or `nullptr` if
  /// the index is out of range or if the process info is invalid..
  const char *GetArgumentAtIndex(uint32_t idx) const;
 
private:
  friend class SBProcess;
  friend class SBProcessInfoList;
 
  lldb_private::ProcessInstanceInfo &ref();
 
  void SetProcessInfo(const lldb_private::ProcessInstanceInfo &proc_info_ref);
 
  std::unique_ptr<lldb_private::ProcessInstanceInfo> m_opaque_up;
};
 
} // namespace lldb
 
#endif // LLDB_API_SBPROCESSINFO_H