File: rlptytest

package info (click to toggle)
libterm-readline-gnu-perl 1.47-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 1,148 kB
  • sloc: perl: 2,191; makefile: 10
file content (249 lines) | stat: -rwxr-xr-x 6,592 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
#!/usr/bin/env perl
#
# rlptytest: Another test harness for the readline callback interface.
#
#   Copyright (C) 2024 Hiroo Hayashi
#
# Derived from: examples/rlptytest.c in the GNU Readline Library
#   Author: Bob Rossi <bob@brasko.net>

use strict;
use warnings;
use Term::ReadLine;
use IO::Pty;
use POSIX qw(termios_h _POSIX_VDISABLE);

# sys/ioctl.ph may not exist on some systems.
#   cf. https://perldoc.perl.org/functions/ioctl
# require 'sys/ioctl.ph';   # for TIOCGWINSZ

my $debug = 1;
my $t = new Term::ReadLine 'rlptytest';
my $a = $t->Attribs;

# Master/Slave PTY used to keep readline off of stdin/stdout.
my $masterfh;
my $slavefh;

sub quit {
    tty_reset(fileno(STDIN));
    close($masterfh);
    close($slavefh);
    print "\n";
    exit(0);
}

sub sigint {
    quit();
}

sub sigwinch {
    $t->resize_terminal();
}

# STDIN  -> user_input()     -> masterfh -> pty -> slavefh -> rl_instream -> callback_read_char()
# STDERR <- readline_input() <- masterfh <- pty <- slavefh <- rl_outstream

sub user_input {
    my $buf;
    my $MAX  = 1024;
    my $size = sysread(STDIN, $buf, $MAX);
    die "read: $!\n" unless defined $size;

    my $ret = syswrite($masterfh, $buf, $size);
    die "print: $!\n" unless $ret;
}

sub readline_input {
    my $buf;
    my $MAX  = 1024;
    my $size = sysread($masterfh, $buf, $MAX);
    die "read: $!\n" unless defined $size;

    # Display output from readline
    print STDERR $buf if ($size > 0);
}

sub rlctx_send_user_command {
    my ($line) = @_;

    # This happens when rl_callback_read_char gets EOF
    return if (!$line);
    quit() if ($line eq "exit");

    # Don't add the enter command
    if ($line && $line ne "") {
        $t->add_history($line);
    }
}

sub custom_deprep_term_function {
}

sub init_readline {
    my ($inputfh, $outputfh) = @_;
    $a->{instream}  = $inputfh;
    $a->{outstream} = $outputfh;

    # Tell readline what the prompt is if it needs to put it back
    $t->callback_handler_install("(rltest):  ", \&rlctx_send_user_command);

    # Set the terminal type to dumb so the output of readline can be
    # understood by tgdb
    $t->reset_terminal("dumb");    # always returns 0

    # For some reason, readline can not deprep the terminal.
    # However, it doesn't matter because no other application is working on
    # the terminal besides readline
    $a->{deprep_term_function} = \&custom_deprep_term_function;

    $t->using_history();
    $t->read_history(".history");
}

sub main_loop {
    while (1) {
        # Reset the fd_set, and watch for input from GDB or stdin
        my $rset = '';

        vec($rset, fileno(STDIN),     1) = 1;
        vec($rset, fileno($slavefh),  1) = 1;
        vec($rset, fileno($masterfh), 1) = 1;

        # Wait for input
        if (select($rset, undef, undef, undef) == -1) {
            if ($! && $!{EINTR}) {
                next;
            } else {
                die "select: $!\n";
            }
        }

        # Input received through the pty:  Handle it
        # Wrote to masterfd, slave fd has that input, alert readline to read it.
        $t->callback_read_char() if (vec($rset, fileno($slavefh),  1));

        # Input received through the pty.
        # Readline read from slavefd, and it wrote to the masterfd.
        readline_input()         if (vec($rset, fileno($masterfh), 1));

        # Input received:  Handle it, write to masterfd (input to readline)
        user_input()             if (vec($rset, fileno(STDIN),     1));
    }
}

# The terminal attributes before calling tty_cbreak
my $save_termios;
my ($RESET, $TCBREAK) = (0, 1);
my $ttystate = $RESET;

# tty_cbreak: Sets terminal to cbreak mode. Also known as noncanonical mode.
#    1. Signal handling is still turned on, so the user can still type those.
#    2. echo is off
#    3. Read in one char at a time.
#
# $fh    - The file handle of the terminal
sub tty_cbreak {
    my ($fh) = @_;
    my $fd = fileno($fh);

    $save_termios = POSIX::Termios->new;
    if (!defined($save_termios->getattr($fd))) {
        die "tcgetattr: $!\n";
    }
    my $buf = POSIX::Termios->new;
    if (!defined($buf->getattr($fd))) {
        die "tcgetattr: $!\n";
    }

    $buf->setlflag($buf->getlflag() & ~(ECHO | ICANON));
    $buf->setiflag($buf->getiflag() & ~(ICRNL | INLCR));
    $buf->setcc(1, VMIN);
    $buf->setcc(0, VTIME);

    $buf->setcc(_POSIX_VDISABLE, &POSIX::VLNEXT)
      if defined(&POSIX::VLNEXT) && defined(_POSIX_VDISABLE);

    $buf->setcc(_POSIX_VDISABLE, &POSIX::VDSUSP)
      if defined(&POSIX::VDSUSP) && defined(_POSIX_VDISABLE);

    # enable flow control; only stty start char can restart output
    # $buf->setiflag($buf->getiflag() | IXON | IXOFF);
    # $buf->setiflag($buf->getiflag() & ~&POSIX::IXANY) if defined(&POSIX::IXANY);

    # disable flow control; let ^S and ^Q through to pty
    $buf->setiflag($buf->getiflag() & ~(IXON | IXOFF));
    $buf->setiflag($buf->getiflag() & ~&POSIX::IXANY) if defined(&POSIX::IXANY);

    if (!defined($buf->setattr($fd, TCSAFLUSH))) {
        die "tcsetattr: $!\n";
    }

    $ttystate = $TCBREAK;

    # set size

    # my $winsize = '';
    # if (!defined(ioctl($fh, TIOCGWINSZ(), $winsize))) {
    #     die "ioctl: $!\n";
    # } else {
    #     my ($rows, $cols, $xpix, $ypix) = unpack 'S4', $winsize;
    #     warn "$rows rows and $cols cols\n" if $debug;
    # }

    # use IO::Pty->get_winsize() instead of ioctl() for better portability
    if ($slavefh->clone_winsize_from(\*STDIN)) {
        my ($rows, $cols, $xpix, $ypix) = $slavefh->get_winsize();
        warn "$rows rows and $cols cols\n" if $debug;
    }
}

sub tty_off_xon_xoff {
    my ($fh) = @_;
    my $fd = fileno($fh);

    my $buf = POSIX::Termios->new;
    if (!defined($buf->getattr($fd))) {
        die "tcgetattr: $!\n";
    }

    $buf->setiflag($buf->getiflag() & ~(IXON | IXOFF));

    if (!defined($buf->setattr($fd, TCSAFLUSH))) {
        die "tcsetattr: $!\n";
    }
}

# tty_reset: Sets the terminal attributes back to their previous state.
# PRE: tty_cbreak must have already been called.
#
# fd    - The file descrioptor of the terminal to reset.
sub tty_reset {
    my ($fd) = @_;
    return if ($ttystate != $TCBREAK);

    if (!defined($save_termios->setattr($fd, TCSAFLUSH))) {
        die "tcsetattr: $!\n";
    }
    $ttystate = $RESET;
}

#
# main
#
$masterfh = new IO::Pty;
$slavefh  = $masterfh->slave;

tty_off_xon_xoff($masterfh);

$SIG{INT}   = \&sigint;
$SIG{WINCH} = \&sigwinch;

init_readline($slavefh, $slavefh);
tty_cbreak(\*STDIN);

main_loop();

tty_reset(fileno(STDIN));

exit 0;