POE/Component/Terminal.pm

#!/usr/bin/perl
##
## POE::Component::Terminal -- Terminal Component
##
## $Id: Terminal.pm,v 1.6 2002/06/15 07:46:11 cvsjoko Exp $
##
## $Log: Terminal.pm,v $
## Revision 1.6  2002/06/15 07:46:11  cvsjoko
## + bugfixes for linux
##
## Revision 1.5  2002/06/15 05:19:36  cvsjoko
## + modified order/way of key-handling-logic
##
## Revision 1.4  2002/06/15 04:28:10  cvsjoko
## immediate polling, no delay
##
## Revision 1.3  2002/06/15 04:24:15  cvsjoko
## + added modifier for running in linux or win32
## + modified order of some commands in core key-polling
##
## Revision 1.2  2002/06/15 03:45:21  cvsjoko
## + cvs id & log
## + clearing inputbuffer just after getting the "enter"-key
##
##
package POE::Component::Terminal;

use strict;
#use strict qw ( vars refs );
use warnings;


use Carp qw( croak carp );

use POE;

use Term::ReadKey;
use Data::Dumper;

$POE::Component::Terminal::VERSION = 0.01;

my @args_needed = qw (
        Alias
        Caption
        PromptPrefix
        PromptPostfix
        RequestSession
        RequestState
        ResponseSession
        ResponseState
        PromptChangeState
);

my $states = {
              _start       => 'start',
              _stop        => 'stop',
              _signal      => 'signal',
              _default     => 'default',
          pollForKey => 'pollForKey',
          recievePrompt => 'recievePrompt',
          recieveResponse => 'recieveResponse',
             };

sub RUNNING_IN_HELL () { $^O eq 'MSWin32' }

sub new {
  my $class = shift;
  $class = ref( $class ) || $class;
  #my( %args ) = ( %default_args, @_ );
  my $args = shift;

  # bless class into object ($self)
  my $self = bless {}, $class;

  ## Check args
  foreach my $arg_needed (@args_needed) {
    croak "Need $arg_needed argument." 
      unless exists $args->{ $arg_needed };
  }

  # store entries from args to object ($self)
  map { $self->{$_} = $args->{$_}; } keys %{$args};

  if ( RUNNING_IN_HELL () ) {
    $self->{conf}{KeyEnter} = 13;
    $self->{conf}{KeyBackspace} = 8;
    $self->{conf}{KeyCTRLC} = 3;
  } else {
    $self->{conf}{KeyEnter} = 10;
    $self->{conf}{KeyBackspace} = 127;
    $self->{conf}{KeyCTRLC} = 3;
  }

  ## Make our session.  See $states defined up above . . .
  POE::Session->create( object_states => [ $self => $states, ], );

  return $self;
}

##
## start -- Startup state
##
sub start {
  my( $self, $kernel, $heap, $session, $sender ) =
    @_[ OBJECT, KERNEL, HEAP, SESSION, SENDER ];

  ## Pipe up if we're debugging
  print STDERR "## ", __PACKAGE__, "::start\r\n" if $self->{Debug};

  ## Set the alias requested so we can be post'd to
  $kernel->alias_set( $self->{Alias} );

  ## Remember session that created us for posting DispatchEvent
  $self->{ _target } = $sender;

  $heap->{state}{InputBuffer} = '';
  $heap->{state}{Startup} = 1;
  $heap->{state}{Caption} = $self->{Caption};
  $heap->{state}{KeyPressed} = 0;
  $heap->{state}{RequestPending} = 0;
  
  # initially call worker-state
  ReadMode 4;
  $kernel->post($session, "pollForKey");

  return;
}

##
## stop -- Shutdown state
##
sub stop {
  my( $self, $kernel, $heap ) = @_[ OBJECT, KERNEL, HEAP ];

  ## Just pipe up if we're debugging
  print STDERR "## ", __PACKAGE__, "::stop\r\n" if $self->{_debug};

  return
}

##
## signal -- Handle any signals received
##
sub signal {
  my( $self, $heap, $signal ) = @_[ OBJECT, HEAP, ARG0 ];

  ## Just pipe up if we're debugging
  print STDERR "## ", __PACKAGE__, "::signal $signal\n" if $self->{_debug};

  ## shut things down on TERM, QUIT, or INT
  if( $signal =~ /^TERM|QUIT|INT/ ) {
    delete $heap->{wheel};      # toss our listening wheel reference

    ## Check for child wheels
    my $live_wheels = scalar keys %{$heap->{wheels}};
    if( $live_wheels ) {
      print STDERR "Exiting with $live_wheels clients still active\n"
        if $self->{_debug};
      delete $heap->{wheels};
    }
  }

  return
}

##
## default -- Catch any unhandled events for debugging
##
sub default {
  my( $self, $heap, $event ) = @_[ OBJECT, HEAP, ARG0 ];

  ## Just pipe up if we're debugging
  print STDERR "## ", __PACKAGE__, "::default got $event\n"
    if $self->{_debug};

  return
}


# ================ POE stuff

sub pollForKey {

  my ($self, $kernel, $heap, $session) = @_[OBJECT, KERNEL, HEAP, SESSION ];

  my $prompt_inlay = $heap->{state}{PromptInlay};
  if ($prompt_inlay) { $prompt_inlay .= ' '; } else { $prompt_inlay = ''; }

  my $prompt = "#> ";
  $prompt = $self->{PromptPrefix} . ' ' . $prompt_inlay . $self->{PromptPostfix};

  if ( ( 
        ( $heap->{state}{KeyPressed} == 1 ) && 
        ( $heap->{state}{RequestPending} == 0 )
       ) ||
        ( $heap->{state}{Startup} ) 
      ) {
    $heap->{state}{Startup} = 0;
    $heap->{state}{KeyPressed} = 0;
    my $outputline = $prompt . $heap->{state}{InputBuffer};
    my $s = ' ' x (length($outputline) + 1);
    print "\r", $s;
    print "\r", $outputline;
    #print $outputline;
  }

  my $key = ReadKey(-1);
  if ( defined $key ) {

#print "key: ", ord($key), "\n";
    
    # CTRL+C pressed?
    if (ord($key) == $self->{conf}{KeyCTRLC}) {
      ReadMode 1;
      print "\n";
      exit;
    }

    # enter pressed?
    if (ord($key) == $self->{conf}{KeyEnter}) {

      # if enter was pressed while request was pending,
      # we should stop waiting for output and come back to prompt again,
      if ($heap->{state}{RequestPending}) {
        $kernel->post( $self->{ResponseSession} => $self->{ResponseState} => '  < stopped waiting for response');
      }

      # send command, if buffer is filled
      my $buf = $heap->{state}{InputBuffer};
      if ($buf) {
        $heap->{state}{InputBuffer} = '';
        $heap->{state}{RequestPending} = 1;
        my $response_target = {
          ResponseSession => $self->{ResponseSession},
          ResponseState => $self->{ResponseState},
        };
        $kernel->post( $self->{RequestSession} => $self->{RequestState} => $buf, $response_target);
      }

      # prepare new loop for fresh prompt
      print "\n";

    }

    # backspace pressed?
    elsif (ord($key) == $self->{conf}{KeyBackspace}) {
      $heap->{state}{InputBuffer} = substr($heap->{state}{InputBuffer}, 0, -1);
    }

    # normal key?
    #elsif ($key =~ m/[a-zA-Z? ]/) {
    else {
      $heap->{state}{InputBuffer} .= $key;
      #print $key;
    }

    # mark "KeyPressed" for next poll
    $heap->{state}{KeyPressed} = 1;

  }

  #$kernel->post($session, "pollForKey");
  #$kernel->run_one_timeslice();
  #$kernel->post($session, "pollForKey");
  #$kernel->yield($session, "pollForKey");
  #$kernel->delay("pollForKey", 0.1);
  $kernel->delay("pollForKey", 0.001);

}


sub recieveResponse {
  my ($kernel, $heap, $session, $response) = @_[KERNEL, HEAP, SESSION, ARG0];
  if ($response) { 
    print $response, "\n";
    $heap->{state}{RequestPending} = 0;
  }
}
sub recievePrompt {
  my ($kernel, $heap, $session, $prompt_inlay) = @_[KERNEL, HEAP, SESSION, ARG0];
  $heap->{state}{PromptInlay} = $prompt_inlay;
}


1;
1	cvsjoko	1.1	#!/usr/bin/perl
2			##
3			## POE::Component::Terminal -- Terminal Component
4			##
5	cvsjoko	1.7	## $Id: Terminal.pm,v 1.6 2002/06/15 07:46:11 cvsjoko Exp $
6	cvsjoko	1.3	##
7			## $Log: Terminal.pm,v $
8	cvsjoko	1.7	## Revision 1.6 2002/06/15 07:46:11 cvsjoko
9			## + bugfixes for linux
10			##
11	cvsjoko	1.6	## Revision 1.5 2002/06/15 05:19:36 cvsjoko
12			## + modified order/way of key-handling-logic
13			##
14	cvsjoko	1.5	## Revision 1.4 2002/06/15 04:28:10 cvsjoko
15			## immediate polling, no delay
16			##
17	cvsjoko	1.4	## Revision 1.3 2002/06/15 04:24:15 cvsjoko
18			## + added modifier for running in linux or win32
19			## + modified order of some commands in core key-polling
20			##
21	cvsjoko	1.3	## Revision 1.2 2002/06/15 03:45:21 cvsjoko
22			## + cvs id & log
23			## + clearing inputbuffer just after getting the "enter"-key
24	cvsjoko	1.2	##
25	cvsjoko	1.1	##
26			package POE::Component::Terminal;
27
28			use strict;
29			#use strict qw ( vars refs );
30			use warnings;
31
32
33			use Carp qw( croak carp );
34
35			use POE;
36
37			use Term::ReadKey;
38			use Data::Dumper;
39
40			$POE::Component::Terminal::VERSION = 0.01;
41
42			my @args_needed = qw (
43			Alias
44			Caption
45			PromptPrefix
46			PromptPostfix
47			RequestSession
48			RequestState
49			ResponseSession
50			ResponseState
51			PromptChangeState
52			);
53
54			my $states = {
55			_start => 'start',
56			_stop => 'stop',
57			_signal => 'signal',
58			_default => 'default',
59			pollForKey => 'pollForKey',
60			recievePrompt => 'recievePrompt',
61			recieveResponse => 'recieveResponse',
62			};
63
64	cvsjoko	1.3	sub RUNNING_IN_HELL () { $^O eq 'MSWin32' }
65
66	cvsjoko	1.1	sub new {
67			my $class = shift;
68			$class = ref( $class ) \|\| $class;
69			#my( %args ) = ( %default_args, @_ );
70			my $args = shift;
71
72			# bless class into object ($self)
73			my $self = bless {}, $class;
74
75			## Check args
76			foreach my $arg_needed (@args_needed) {
77			croak "Need $arg_needed argument."
78			unless exists $args->{ $arg_needed };
79			}
80
81			# store entries from args to object ($self)
82			map { $self->{$_} = $args->{$_}; } keys %{$args};
83
84	cvsjoko	1.3	if ( RUNNING_IN_HELL () ) {
85	cvsjoko	1.7	$self->{conf}{KeyEnter} = 13;
86			$self->{conf}{KeyBackspace} = 8;
87			$self->{conf}{KeyCTRLC} = 3;
88	cvsjoko	1.3	} else {
89	cvsjoko	1.7	$self->{conf}{KeyEnter} = 10;
90			$self->{conf}{KeyBackspace} = 127;
91			$self->{conf}{KeyCTRLC} = 3;
92	cvsjoko	1.3	}
93
94	cvsjoko	1.1	## Make our session. See $states defined up above . . .
95			POE::Session->create( object_states => [ $self => $states, ], );
96
97			return $self;
98			}
99
100			##
101			## start -- Startup state
102			##
103			sub start {
104			my( $self, $kernel, $heap, $session, $sender ) =
105			@_[ OBJECT, KERNEL, HEAP, SESSION, SENDER ];
106
107			## Pipe up if we're debugging
108			print STDERR "## ", __PACKAGE__, "::start\r\n" if $self->{Debug};
109
110			## Set the alias requested so we can be post'd to
111			$kernel->alias_set( $self->{Alias} );
112
113			## Remember session that created us for posting DispatchEvent
114			$self->{ _target } = $sender;
115
116			$heap->{state}{InputBuffer} = '';
117			$heap->{state}{Startup} = 1;
118			$heap->{state}{Caption} = $self->{Caption};
119	cvsjoko	1.6	$heap->{state}{KeyPressed} = 0;
120			$heap->{state}{RequestPending} = 0;
121	cvsjoko	1.1
122			# initially call worker-state
123	cvsjoko	1.6	ReadMode 4;
124	cvsjoko	1.1	$kernel->post($session, "pollForKey");
125
126			return;
127			}
128
129			##
130			## stop -- Shutdown state
131			##
132			sub stop {
133			my( $self, $kernel, $heap ) = @_[ OBJECT, KERNEL, HEAP ];
134
135			## Just pipe up if we're debugging
136			print STDERR "## ", __PACKAGE__, "::stop\r\n" if $self->{_debug};
137
138			return
139			}
140
141			##
142			## signal -- Handle any signals received
143			##
144			sub signal {
145			my( $self, $heap, $signal ) = @_[ OBJECT, HEAP, ARG0 ];
146
147			## Just pipe up if we're debugging
148			print STDERR "## ", __PACKAGE__, "::signal $signal\n" if $self->{_debug};
149
150			## shut things down on TERM, QUIT, or INT
151			if( $signal =~ /^TERM\|QUIT\|INT/ ) {
152			delete $heap->{wheel}; # toss our listening wheel reference
153
154			## Check for child wheels
155			my $live_wheels = scalar keys %{$heap->{wheels}};
156			if( $live_wheels ) {
157			print STDERR "Exiting with $live_wheels clients still active\n"
158			if $self->{_debug};
159			delete $heap->{wheels};
160			}
161			}
162
163			return
164			}
165
166			##
167			## default -- Catch any unhandled events for debugging
168			##
169			sub default {
170			my( $self, $heap, $event ) = @_[ OBJECT, HEAP, ARG0 ];
171
172			## Just pipe up if we're debugging
173			print STDERR "## ", __PACKAGE__, "::default got $event\n"
174			if $self->{_debug};
175
176			return
177			}
178
179
180
181
182
183
184
185			# ================ POE stuff
186
187			sub pollForKey {
188
189			my ($self, $kernel, $heap, $session) = @_[OBJECT, KERNEL, HEAP, SESSION ];
190
191			my $prompt_inlay = $heap->{state}{PromptInlay};
192			if ($prompt_inlay) { $prompt_inlay .= ' '; } else { $prompt_inlay = ''; }
193
194			my $prompt = "#> ";
195			$prompt = $self->{PromptPrefix} . ' ' . $prompt_inlay . $self->{PromptPostfix};
196
197	cvsjoko	1.6	if ( (
198			( $heap->{state}{KeyPressed} == 1 ) &&
199			( $heap->{state}{RequestPending} == 0 )
200			) \|\|
201			( $heap->{state}{Startup} )
202			) {
203	cvsjoko	1.1	$heap->{state}{Startup} = 0;
204			$heap->{state}{KeyPressed} = 0;
205			my $outputline = $prompt . $heap->{state}{InputBuffer};
206			my $s = ' ' x (length($outputline) + 1);
207			print "\r", $s;
208			print "\r", $outputline;
209	cvsjoko	1.6	#print $outputline;
210	cvsjoko	1.1	}
211
212			my $key = ReadKey(-1);
213	cvsjoko	1.5	if ( defined $key ) {
214	cvsjoko	1.6
215			#print "key: ", ord($key), "\n";
216	cvsjoko	1.1
217	cvsjoko	1.6	# CTRL+C pressed?
218	cvsjoko	1.7	if (ord($key) == $self->{conf}{KeyCTRLC}) {
219	cvsjoko	1.6	ReadMode 1;
220			print "\n";
221			exit;
222			}
223
224	cvsjoko	1.1	# enter pressed?
225	cvsjoko	1.7	if (ord($key) == $self->{conf}{KeyEnter}) {
226	cvsjoko	1.6
227			# if enter was pressed while request was pending,
228			# we should stop waiting for output and come back to prompt again,
229			if ($heap->{state}{RequestPending}) {
230			$kernel->post( $self->{ResponseSession} => $self->{ResponseState} => ' < stopped waiting for response');
231			}
232
233			# send command, if buffer is filled
234	cvsjoko	1.1	my $buf = $heap->{state}{InputBuffer};
235			if ($buf) {
236	cvsjoko	1.2	$heap->{state}{InputBuffer} = '';
237	cvsjoko	1.1	$heap->{state}{RequestPending} = 1;
238			my $response_target = {
239			ResponseSession => $self->{ResponseSession},
240			ResponseState => $self->{ResponseState},
241			};
242			$kernel->post( $self->{RequestSession} => $self->{RequestState} => $buf, $response_target);
243			}
244
245			# prepare new loop for fresh prompt
246			print "\n";
247	cvsjoko	1.6
248	cvsjoko	1.1	}
249
250			# backspace pressed?
251	cvsjoko	1.7	elsif (ord($key) == $self->{conf}{KeyBackspace}) {
252	cvsjoko	1.1	$heap->{state}{InputBuffer} = substr($heap->{state}{InputBuffer}, 0, -1);
253	cvsjoko	1.5	}
254
255			# normal key?
256			#elsif ($key =~ m/[a-zA-Z? ]/) {
257			else {
258			$heap->{state}{InputBuffer} .= $key;
259			#print $key;
260	cvsjoko	1.1	}
261
262	cvsjoko	1.3	# mark "KeyPressed" for next poll
263			$heap->{state}{KeyPressed} = 1;
264
265	cvsjoko	1.1	}
266
267	cvsjoko	1.7	#$kernel->post($session, "pollForKey");
268	cvsjoko	1.6	#$kernel->run_one_timeslice();
269	cvsjoko	1.7	#$kernel->post($session, "pollForKey");
270	cvsjoko	1.6	#$kernel->yield($session, "pollForKey");
271	cvsjoko	1.3	#$kernel->delay("pollForKey", 0.1);
272	cvsjoko	1.7	$kernel->delay("pollForKey", 0.001);
273	cvsjoko	1.1
274			}
275
276
277
278
279			sub recieveResponse {
280			my ($kernel, $heap, $session, $response) = @_[KERNEL, HEAP, SESSION, ARG0];
281	cvsjoko	1.6	if ($response) {
282			print $response, "\n";
283			$heap->{state}{RequestPending} = 0;
284			}
285	cvsjoko	1.1	}
286			sub recievePrompt {
287			my ($kernel, $heap, $session, $prompt_inlay) = @_[KERNEL, HEAP, SESSION, ARG0];
288			$heap->{state}{PromptInlay} = $prompt_inlay;
289			}
290
291
292			1;
MailToCvsAdmin">MailToCvsAdmin	ViewVC Help
Powered by ViewVC 1.1.26