Files
clang-p2996/lldb/tools/debugserver/source/PseudoTerminal.h
Jonas Devlieghere 8b3af63b89 [NFC] Remove ASCII lines from comments
A lot of comments in LLDB are surrounded by an ASCII line to delimit the
begging and end of the comment.

Its use is not really consistent across the code base, sometimes the
lines are longer, sometimes they are shorter and sometimes they are
omitted. Furthermore, it looks kind of weird with the 80 column limit,
where the comment actually extends past the line, but not by much.
Furthermore, when /// is used for Doxygen comments, it looks
particularly odd. And when // is used, it incorrectly gives the
impression that it's actually a Doxygen comment.

I assume these lines were added to improve distinguishing between
comments and code. However, given that todays editors and IDEs do a
great job at highlighting comments, I think it's worth to drop this for
the sake of consistency. The alternative is fixing all the
inconsistencies, which would create a lot more churn.

Differential revision: https://reviews.llvm.org/D60508

llvm-svn: 358135
2019-04-10 20:48:55 +00:00

81 lines
2.2 KiB
C++

//===-- PseudoTerminal.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
//
//===----------------------------------------------------------------------===//
//
// Created by Greg Clayton on 1/8/08.
//
//===----------------------------------------------------------------------===//
#ifndef __PseudoTerminal_h__
#define __PseudoTerminal_h__
#include <fcntl.h>
#include <string>
#include <termios.h>
class PseudoTerminal {
public:
enum { invalid_fd = -1, invalid_pid = -1 };
enum Status {
success = 0,
err_posix_openpt_failed = -2,
err_grantpt_failed = -3,
err_unlockpt_failed = -4,
err_ptsname_failed = -5,
err_open_slave_failed = -6,
err_fork_failed = -7,
err_setsid_failed = -8,
err_failed_to_acquire_controlling_terminal = -9,
err_dup2_failed_on_stdin = -10,
err_dup2_failed_on_stdout = -11,
err_dup2_failed_on_stderr = -12
};
// Constructors and Destructors
PseudoTerminal();
~PseudoTerminal();
void CloseMaster();
void CloseSlave();
Status OpenFirstAvailableMaster(int oflag);
Status OpenSlave(int oflag);
int MasterFD() const { return m_master_fd; }
int SlaveFD() const { return m_slave_fd; }
int ReleaseMasterFD() {
// Release ownership of the master pseudo terminal file
// descriptor without closing it. (the destructor for this
// class will close it otherwise!)
int fd = m_master_fd;
m_master_fd = invalid_fd;
return fd;
}
int ReleaseSlaveFD() {
// Release ownership of the slave pseudo terminal file
// descriptor without closing it (the destructor for this
// class will close it otherwise!)
int fd = m_slave_fd;
m_slave_fd = invalid_fd;
return fd;
}
const char *SlaveName() const;
pid_t Fork(Status &error);
protected:
// Classes that inherit from PseudoTerminal can see and modify these
int m_master_fd;
int m_slave_fd;
private:
// Outlaw copy and assignment constructors
PseudoTerminal(const PseudoTerminal &rhs);
PseudoTerminal &operator=(const PseudoTerminal &rhs);
};
#endif // #ifndef __PseudoTerminal_h__