annotate gcc/ada/libgnat/g-tty.ads @ 158:494b0b89df80 default tip

...
author Shinji KONO <kono@ie.u-ryukyu.ac.jp>
date Mon, 25 May 2020 18:13:55 +0900
parents 1830386684a0
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
111
kono
parents:
diff changeset
1 ------------------------------------------------------------------------------
kono
parents:
diff changeset
2 -- --
kono
parents:
diff changeset
3 -- GNAT LIBRARY COMPONENTS --
kono
parents:
diff changeset
4 -- --
kono
parents:
diff changeset
5 -- G N A T . T T Y --
kono
parents:
diff changeset
6 -- --
kono
parents:
diff changeset
7 -- S p e c --
kono
parents:
diff changeset
8 -- --
145
1830386684a0 gcc-9.2.0
anatofuz
parents: 131
diff changeset
9 -- Copyright (C) 2002-2019, AdaCore --
111
kono
parents:
diff changeset
10 -- --
kono
parents:
diff changeset
11 -- GNAT is free software; you can redistribute it and/or modify it under --
kono
parents:
diff changeset
12 -- terms of the GNU General Public License as published by the Free Soft- --
kono
parents:
diff changeset
13 -- ware Foundation; either version 3, or (at your option) any later ver- --
kono
parents:
diff changeset
14 -- sion. GNAT is distributed in the hope that it will be useful, but WITH- --
kono
parents:
diff changeset
15 -- OUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY --
kono
parents:
diff changeset
16 -- or FITNESS FOR A PARTICULAR PURPOSE. --
kono
parents:
diff changeset
17 -- --
kono
parents:
diff changeset
18 -- As a special exception under Section 7 of GPL version 3, you are granted --
kono
parents:
diff changeset
19 -- additional permissions described in the GCC Runtime Library Exception, --
kono
parents:
diff changeset
20 -- version 3.1, as published by the Free Software Foundation. --
kono
parents:
diff changeset
21 -- --
kono
parents:
diff changeset
22 -- You should have received a copy of the GNU General Public License and --
kono
parents:
diff changeset
23 -- a copy of the GCC Runtime Library Exception along with this program; --
kono
parents:
diff changeset
24 -- see the files COPYING3 and COPYING.RUNTIME respectively. If not, see --
kono
parents:
diff changeset
25 -- <http://www.gnu.org/licenses/>. --
kono
parents:
diff changeset
26 -- --
kono
parents:
diff changeset
27 -- GNAT was originally developed by the GNAT team at New York University. --
kono
parents:
diff changeset
28 -- Extensive contributions were provided by Ada Core Technologies Inc. --
kono
parents:
diff changeset
29 -- --
kono
parents:
diff changeset
30 ------------------------------------------------------------------------------
kono
parents:
diff changeset
31
kono
parents:
diff changeset
32 -- This package provides control over pseudo terminals (ttys)
kono
parents:
diff changeset
33
kono
parents:
diff changeset
34 -- This package is only supported on unix systems. See function TTY_Supported
kono
parents:
diff changeset
35 -- to test dynamically whether other functions of this package can be called.
kono
parents:
diff changeset
36
kono
parents:
diff changeset
37 with System;
kono
parents:
diff changeset
38
kono
parents:
diff changeset
39 with GNAT.OS_Lib;
kono
parents:
diff changeset
40
kono
parents:
diff changeset
41 package GNAT.TTY is
kono
parents:
diff changeset
42
kono
parents:
diff changeset
43 type TTY_Handle is private;
kono
parents:
diff changeset
44 -- Handle for a tty descriptor
kono
parents:
diff changeset
45
kono
parents:
diff changeset
46 function TTY_Supported return Boolean;
kono
parents:
diff changeset
47 -- If True, the other functions of this package can be called. Otherwise,
kono
parents:
diff changeset
48 -- all functions in this package will raise Program_Error if called.
kono
parents:
diff changeset
49
kono
parents:
diff changeset
50 procedure Allocate_TTY (Handle : out TTY_Handle);
kono
parents:
diff changeset
51 -- Allocate a new tty
kono
parents:
diff changeset
52
kono
parents:
diff changeset
53 procedure Reset_TTY (Handle : TTY_Handle);
kono
parents:
diff changeset
54 -- Reset settings of a given tty
kono
parents:
diff changeset
55
kono
parents:
diff changeset
56 procedure Close_TTY (Handle : in out TTY_Handle);
kono
parents:
diff changeset
57 -- Close a given tty
kono
parents:
diff changeset
58
kono
parents:
diff changeset
59 function TTY_Name (Handle : TTY_Handle) return String;
kono
parents:
diff changeset
60 -- Return the external name of a tty. The name depends on the tty handling
kono
parents:
diff changeset
61 -- on the given target. It will typically look like: "/dev/ptya1"
kono
parents:
diff changeset
62
kono
parents:
diff changeset
63 function TTY_Descriptor
kono
parents:
diff changeset
64 (Handle : TTY_Handle) return GNAT.OS_Lib.File_Descriptor;
kono
parents:
diff changeset
65 -- Return the low level descriptor associated with Handle
kono
parents:
diff changeset
66
kono
parents:
diff changeset
67 private
kono
parents:
diff changeset
68
kono
parents:
diff changeset
69 type TTY_Handle is record
kono
parents:
diff changeset
70 Handle : System.Address := System.Null_Address;
kono
parents:
diff changeset
71 end record;
kono
parents:
diff changeset
72
kono
parents:
diff changeset
73 end GNAT.TTY;