fce3187088
This was initially just to try on "pty" and "tty" for size, while discussing with other projects to try to align on vocabulary, but -- in the implemention and tests at least -- but these work out so well that I'm tempted to go with them anyway if we can't come to a concensus. We can always come back and change them again later. What I really like is that you pass the pty to functions like ptsname() and grantpt() with a 'p' in the name, and the tty to functions like ttyname() and tcsetattr() with just 't's. The use of "parent" and "child" in forkpty() seems helpful too. Also fix the documentation of forkpty(), which wasn't quite right. Test: treehugger Change-Id: Ic010c4b669f6528591c653e3701f4e41e0d0df9e
65 lines
2.5 KiB
C
65 lines
2.5 KiB
C
/*
|
|
* Copyright (C) 2014 The Android Open Source Project
|
|
* All rights reserved.
|
|
*
|
|
* Redistribution and use in source and binary forms, with or without
|
|
* modification, are permitted provided that the following conditions
|
|
* are met:
|
|
* * Redistributions of source code must retain the above copyright
|
|
* notice, this list of conditions and the following disclaimer.
|
|
* * Redistributions in binary form must reproduce the above copyright
|
|
* notice, this list of conditions and the following disclaimer in
|
|
* the documentation and/or other materials provided with the
|
|
* distribution.
|
|
*
|
|
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
|
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
|
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
|
|
* FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
|
|
* COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
|
|
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
|
|
* BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
|
|
* OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
|
|
* AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
|
|
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
|
|
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
|
|
* SUCH DAMAGE.
|
|
*/
|
|
|
|
#pragma once
|
|
|
|
/**
|
|
* @file pty.h
|
|
* @brief Pseudoterminal functions.
|
|
*/
|
|
|
|
#include <sys/cdefs.h>
|
|
|
|
#include <termios.h>
|
|
#include <sys/ioctl.h>
|
|
|
|
__BEGIN_DECLS
|
|
|
|
/**
|
|
* [openpty(3)](http://man7.org/linux/man-pages/man3/openpty.3.html) finds
|
|
* a free pseudoterminal and configures it with the given terminal and window
|
|
* size settings.
|
|
*
|
|
* Returns 0 on success and returns -1 and sets `errno` on failure.
|
|
*
|
|
* Available since API level 23.
|
|
*/
|
|
int openpty(int* _Nonnull __pty_fd, int* _Nonnull __tty_fd, char* _Nullable __tty_name, const struct termios* _Nullable __termios_ptr, const struct winsize* _Nullable __winsize_ptr) __INTRODUCED_IN(23);
|
|
|
|
/**
|
|
* [forkpty(3)](http://man7.org/linux/man-pages/man3/forkpty.3.html) creates
|
|
* a new process connected to a pseudoterminal from openpty().
|
|
*
|
|
* Returns 0 in the child/the pid of the child in the parent on success,
|
|
* and returns -1 and sets `errno` on failure.
|
|
*
|
|
* Available since API level 23.
|
|
*/
|
|
int forkpty(int* _Nonnull __parent_pty_fd, char* _Nullable __child_tty_name, const struct termios* _Nullable __termios_ptr, const struct winsize* _Nullable __winsize_ptr) __INTRODUCED_IN(23);
|
|
|
|
__END_DECLS
|