Term-Shell-0.04000755000764000764 012153125202 13677 5ustar00shlomifshlomif000000000000Term-Shell-0.04/Changes000444000764000764 440312153125202 15330 0ustar00shlomifshlomif0000000000000.04 Mon 3 Jun 17:38:17 IDT 2013 - Add an explicit version to Term::Shell::OnScopeLeave. - to settle the PAUSE indexer. - Convert t/01require.t to Test::More and strict/warnings. - Convert t/02default.t to Test::More and strict/warnings. - Add "use warnings;" to t/03catchsmry.t . 0.03 Sun 14 Oct 11:03:52 IST 2012 - Moved test.pl under examples so it won't interfere with the building and testing. - See https://rt.cpan.org/Public/Bug/Display.html?id=40771 - Thanks to CHORNY and praveenkumar for the reports. - Correct the POD. - Add t/pod.t . - Convert the distribution to Build.PL . 0.02 Fri Feb 23 06:36:03 PST 2007 - Fix CPAN bug id 2463: help now unconditionally calls $o->summary() 0.01 Fri Jan 25 12:15:25 PST 2002 @67 - Documentation updates - Read the README - Added cmd_prefix() and cmd_suffix() - Reorganized the handlers to make more sense, given the above - Preparing for initial release 0.01 Wed Jan 23 02:46:51 PST 2002 @66 - Lots of documentation additions - Added a README - Access to the Term::ReadLine object - Added precmd(), postcmd(), preloop(), postloop(), init(), and fini() callbacks. - Added a cmd() method, which parses and runs the command-line you pass in. Used internally by cmdloop(). 0.01 Sat Dec 22 19:04:06 PST 2001 @36 - Added some more documentation and features to Term::Shell 0.01 Sat Dec 15 00:05:08 PST 2001 @26 - Remove 'quit' alias for 'exit' in Term::Shell. Smaller is better. - Changed default prompt to 'shell> '. - Added and documented the prompt_user() method. - Added the prompt_user() method to the interactive test. 0.01 Wed Dec 12 09:31:37 PST 2001 @19 - Added the comp_() sub, to override the top-level command-completion routine. 0.01 Wed Dec 12 09:01:52 PST 2001 @18 - Fixed a bug which prevented completion from working 0.01 Wed Dec 12 01:08:48 PST 2001 @17 - Added catch_*() methods to catch missing handlers. - Added an example called psh.pl (Perl SHell) - Fixed order of comp_*() handlers to match Term::ReadLine::Perl 0.01 Tue Dec 11 12:18:58 PST 2001 @16 - Added tests and documentation. Needs more doc. 0.01 Mon Dec 10 10:08:54 PST 2001 @14 - Adding initial version of Term::Shell to the repository. Needs documentation. Term-Shell-0.04/MANIFEST000444000764000764 47312153125202 15151 0ustar00shlomifshlomif000000000000Build.PL Changes MANIFEST Makefile.PL README examples/old-test.pl examples/psh.pl inc/Test/Run/Builder.pm lib/Term/Shell.pm lib/Term/Shell.pod scripts/bump-version-number.pl t/01require.t t/02default.t t/03catchsmry.t t/pod.t META.yml Module meta-data (added by MakeMaker) META.json Term-Shell-0.04/Build.PL000444000764000764 200012153125202 15320 0ustar00shlomifshlomif000000000000use strict; use warnings; use lib "./inc"; use Test::Run::Builder; my $builder = Test::Run::Builder->new( module_name => 'Term::Shell', license => 'perl', dist_author => q{Shlomi Fish }, dist_version_from => 'lib/Term/Shell.pm', requires => { 'Data::Dumper' => 0, 'Term::ReadLine' => 0, 'strict' => 0, 'warnings' => 0, }, build_requires => { 'Test' => 0, 'Test::More' => 0, 'vars' => 0, }, configure_requires => { 'Module::Build' => 0, }, add_to_cleanup => [ 'Term-Shell-*' ], create_makefile_pl => 'traditional', meta_merge => { resources => { repository => "https://github.com/shlomif/Term-Shell", }, keywords => [ 'console', 'readline', 'shell', 'term', 'terminal', ], }, ); $builder->create_build_script(); Term-Shell-0.04/Makefile.PL000444000764000764 104512153125202 16006 0ustar00shlomifshlomif000000000000# Note: this file was auto-generated by Module::Build::Compat version 0.4005 use ExtUtils::MakeMaker; WriteMakefile ( 'NAME' => 'Term::Shell', 'VERSION_FROM' => 'lib/Term/Shell.pm', 'PREREQ_PM' => { 'Data::Dumper' => 0, 'Term::ReadLine' => 0, 'Test' => 0, 'Test::More' => 0, 'strict' => 0, 'vars' => 0, 'warnings' => 0 }, 'INSTALLDIRS' => 'site', 'EXE_FILES' => [], 'PL_FILES' => {} ) ; Term-Shell-0.04/META.yml000444000764000764 146312153125202 15311 0ustar00shlomifshlomif000000000000--- abstract: 'A simple command-line shell framework.' author: - 'Shlomi Fish ' build_requires: Test: 0 Test::More: 0 vars: 0 configure_requires: Module::Build: 0 dynamic_config: 1 generated_by: 'Module::Build version 0.4005, CPAN::Meta::Converter version 2.120921' keywords: - console - readline - shell - term - terminal license: perl meta-spec: url: http://module-build.sourceforge.net/META-spec-v1.4.html version: 1.4 name: Term-Shell provides: Term::Shell: file: lib/Term/Shell.pm version: 0.04 Term::Shell::OnScopeLeave: file: lib/Term/Shell.pm version: 0.04 requires: Data::Dumper: 0 Term::ReadLine: 0 strict: 0 warnings: 0 resources: license: http://dev.perl.org/licenses/ repository: https://github.com/shlomif/Term-Shell version: 0.04 Term-Shell-0.04/META.json000444000764000764 265512153125202 15465 0ustar00shlomifshlomif000000000000{ "abstract" : "A simple command-line shell framework.", "author" : [ "Shlomi Fish " ], "dynamic_config" : 1, "generated_by" : "Module::Build version 0.4005, CPAN::Meta::Converter version 2.120921", "keywords" : [ "console", "readline", "shell", "term", "terminal" ], "license" : [ "perl_5" ], "meta-spec" : { "url" : "http://search.cpan.org/perldoc?CPAN::Meta::Spec", "version" : "2" }, "name" : "Term-Shell", "prereqs" : { "build" : { "requires" : { "Test" : "0", "Test::More" : "0", "vars" : "0" } }, "configure" : { "requires" : { "Module::Build" : "0" } }, "runtime" : { "requires" : { "Data::Dumper" : "0", "Term::ReadLine" : "0", "strict" : "0", "warnings" : "0" } } }, "provides" : { "Term::Shell" : { "file" : "lib/Term/Shell.pm", "version" : "0.04" }, "Term::Shell::OnScopeLeave" : { "file" : "lib/Term/Shell.pm", "version" : "0.04" } }, "release_status" : "stable", "resources" : { "license" : [ "http://dev.perl.org/licenses/" ], "repository" : { "url" : "https://github.com/shlomif/Term-Shell" } }, "version" : "0.04" } Term-Shell-0.04/README000444000764000764 354212153125202 14720 0ustar00shlomifshlomif000000000000INTRODUCTION Term::Shell -- Write command-line shells in Perl. Term::Shell makes it joyfully easy to write command-line interfaces in Perl. All the boring details like command-line parsing and terminal handling are done for you. Example: package MyShell; use base qw(Term::Shell); # This behaves like the system echo command, minus shell expansion sub run_echo { my $o = shift; print "@_\n" if @_; # print the arguments } package main; MyShell->new->cmdloop; Here is a sample session from this program: shell> help Type 'help command' for more detailed help on a command. Commands: echo - undocumented - no help available exit - exits the program help - prints this screen, or help on 'command' shell> echo shell> echo 1 2 3 1 2 3 shell> echo $VAR $VAR shell> exit ------------------------------------------------------------------------------ INSTALLATION: This module requires Term::ReadLine to be installed. This module has been a core module since at least 5.005_03, so it shouldn't be a problem. This module requires Text::Autoformat for some features. Text::Autoformat can be found on your nearest CPAN mirror, probably the same place you got Term::Shell. To install Term::Shell do this: perl Makefile.PL make make test make install (On ActivePerl for MSWin32, use nmake instead of make.) You have to 'make install' before you can run it successfully. ------------------------------------------------------------------------------ INFORMATION: - For more information on Term::Shell see 'perldoc Term::Shell'. - For more information on Term::ReadLine see 'perldoc Term::ReadLine'. - For more information on Text::Autoformat see 'perldoc Text::Autoformat'. Please send questions and comments to "Neil Watkiss" Copyright (c) 2002, Neil Watkiss. All Rights Reserved. Term-Shell-0.04/lib000755000764000764 012153125202 14445 5ustar00shlomifshlomif000000000000Term-Shell-0.04/lib/Term000755000764000764 012153125202 15354 5ustar00shlomifshlomif000000000000Term-Shell-0.04/lib/Term/Shell.pm000444000764000764 5546012153125202 17150 0ustar00shlomifshlomif000000000000package Term::Shell; use strict; use warnings; use Data::Dumper; use Term::ReadLine; use vars qw($VERSION); $VERSION = '0.04'; #============================================================================= # Term::Shell API methods #============================================================================= sub new { my $cls = shift; my $o = bless { term => eval { # Term::ReadKey throws ugliness all over the place if we're not # running in a terminal, which we aren't during "make test", at # least on FreeBSD. Suppress warnings here. local $SIG{__WARN__} = sub { }; Term::ReadLine->new('shell'); } || undef, }, ref($cls) || $cls; # Set up the API hash: $o->{command} = {}; $o->{API} = { args => \@_, case_ignore => ($^O eq 'MSWin32' ? 1 : 0), check_idle => 0, # changing this isn't supported class => $cls, command => $o->{command}, cmd => $o->{command}, # shorthand match_uniq => 1, pager => $ENV{PAGER} || 'internal', readline => eval { $o->{term}->ReadLine } || 'none', script => (caller(0))[1], version => $VERSION, }; # Note: the rl_completion_function doesn't pass an object as the first # argument, so we have to use a closure. This has the unfortunate effect # of preventing two instances of Term::ReadLine from coexisting. my $completion_handler = sub { $o->rl_complete(@_); }; if ($o->{API}{readline} eq 'Term::ReadLine::Gnu') { my $attribs = $o->{term}->Attribs; $attribs->{completion_function} = $completion_handler; } elsif ($o->{API}{readline} eq 'Term::ReadLine::Perl') { $readline::rl_completion_function = $readline::rl_completion_function = $completion_handler; } $o->find_handlers; $o->init; $o; } sub DESTROY { my $o = shift; $o->fini; } sub cmd { my $o = shift; $o->{line} = shift; if ($o->line =~ /\S/) { my ($cmd, @args) = $o->line_parsed; $o->run($cmd, @args); unless ($o->{command}{run}{found}) { my @c = sort $o->possible_actions($cmd, 'run'); if (@c and $o->{API}{match_uniq}) { print $o->msg_ambiguous_cmd($cmd, @c); } else { print $o->msg_unknown_cmd($cmd); } } } else { $o->run(''); } } sub stoploop { $_[0]->{stop}++ } sub cmdloop { my $o = shift; $o->{stop} = 0; $o->preloop; while (defined (my $line = $o->readline($o->prompt_str))) { $o->cmd($line); last if $o->{stop}; } $o->postloop; } *mainloop = \&cmdloop; sub readline { my $o = shift; my $prompt = shift; return $o->{term}->readline($prompt) if $o->{API}{check_idle} == 0 or not defined $o->{term}->IN; # They've asked for idle-time running of some user command. local $Term::ReadLine::toloop = 1; local *Tk::fileevent = sub { my $cls = shift; my ($file, $boring, $callback) = @_; $o->{fh} = $file; # save the filehandle! $o->{cb} = $callback; # save the callback! }; local *Tk::DoOneEvent = sub { # We'll totally cheat and do a select() here -- the timeout will be # $o->{API}{check_idle}; if the handle is ready, we'll call &$cb; # otherwise we'll call $o->idle(), which can do some processing. my $timeout = $o->{API}{check_idle}; use IO::Select; if (IO::Select->new($o->{fh})->can_read($timeout)) { # Input is ready: stop the event loop. $o->{cb}->(); } else { $o->idle; } }; $o->{term}->readline($prompt); } sub term { $_[0]->{term} } # These are likely candidates for overriding in subclasses sub init { } # called last in the ctor sub fini { } # called first in the dtor sub preloop { } sub postloop { } sub precmd { } sub postcmd { } sub prompt_str { 'shell> ' } sub idle { } sub cmd_prefix { '' } sub cmd_suffix { '' } #============================================================================= # The pager #============================================================================= sub page { my $o = shift; my $text = shift; my $maxlines = shift || $o->termsize->{rows}; my $pager = $o->{API}{pager}; # First, count the number of lines in the text: my $lines = ($text =~ tr/\n//); # If there are fewer lines than the page-lines, just print it. if ($lines < $maxlines or $maxlines == 0 or $pager eq 'none') { print $text; } # If there are more, page it, either using the external pager... elsif ($pager and $pager ne 'internal') { require File::Temp; my ($handle, $name) = File::Temp::tempfile(); select((select($handle), $| = 1)[0]); print $handle $text; close $handle; system($pager, $name) == 0 or print < 0) { my @text = @lines[$line .. $#lines]; my $ret = $o->page_internal(\@text, $maxlines, $togo, $line); last if $ret == -1; $line += $ret; $togo -= $ret; } return $line; } return $lines } sub page_internal { my $o = shift; my $lines = shift; my $maxlines = shift; my $togo = shift; my $start = shift; my $line = 1; while ($_ = shift @$lines) { print; last if $line >= ($maxlines - 1); # leave room for the prompt $line++; } my $lines_left = $togo - $line; my $current_line = $start + $line; my $total_lines = $togo + $start; my $instructions; if ($o->have_readkey) { $instructions = "any key for more, or q to quit"; } else { $instructions = "enter for more, or q to quit"; } if ($lines_left > 0) { local $| = 1; my $l = "---line $current_line/$total_lines ($instructions)---"; my $b = ' ' x length($l); print $l; my $ans = $o->readkey; print "\r$b\r" if $o->have_readkey; print "\n" if $ans =~ /q/i or not $o->have_readkey; $line = -1 if $ans =~ /q/i; } $line; } #============================================================================= # Run actions #============================================================================= sub run { my $o = shift; my $action = shift; my @args = @_; $o->do_action($action, \@args, 'run') } sub complete { my $o = shift; my $action = shift; my @args = @_; my @compls = $o->do_action($action, \@args, 'comp'); return () unless $o->{command}{comp}{found}; return @compls; } sub help { my $o = shift; my $topic = shift; my @subtopics = @_; $o->do_action($topic, \@subtopics, 'help') } sub summary { my $o = shift; my $topic = shift; $o->do_action($topic, [], 'smry') } #============================================================================= # Manually add & remove handlers #============================================================================= sub add_handlers { my $o = shift; for my $hnd (@_) { next unless $hnd =~ /^(run|help|smry|comp|catch|alias)_/o; my $t = $1; my $a = substr($hnd, length($t) + 1); # Add on the prefix and suffix if the command is defined if (length $a) { substr($a, 0, 0) = $o->cmd_prefix; $a .= $o->cmd_suffix; } $o->{handlers}{$a}{$t} = $hnd; if ($o->has_aliases($a)) { my @a = $o->get_aliases($a); for my $alias (@a) { substr($alias, 0, 0) = $o->cmd_prefix; $alias .= $o->cmd_suffix; $o->{handlers}{$alias}{$t} = $hnd; } } } } sub add_commands { my $o = shift; while (@_) { my ($cmd, $hnd) = (shift, shift); $o->{handlers}{$cmd} = $hnd; } } sub remove_handlers { my $o = shift; for my $hnd (@_) { next unless $hnd =~ /^(run|help|smry|comp|catch|alias)_/o; my $t = $1; my $a = substr($hnd, length($t) + 1); # Add on the prefix and suffix if the command is defined if (length $a) { substr($a, 0, 0) = $o->cmd_prefix; $a .= $o->cmd_suffix; } delete $o->{handlers}{$a}{$t}; } } sub remove_commands { my $o = shift; for my $name (@_) { delete $o->{handlers}{$name}; } } *add_handler = \&add_handlers; *add_command = \&add_commands; *remove_handler = \&remove_handlers; *remove_command = \&remove_commands; #============================================================================= # Utility methods #============================================================================= sub termsize { my $o = shift; my ($rows, $cols) = (24, 78); # Try several ways to get the terminal size TERMSIZE: { my $TERM = $o->{term}; last TERMSIZE unless $TERM; my $OUT = $TERM->OUT; if ($TERM and $o->{API}{readline} eq 'Term::ReadLine::Gnu') { ($rows, $cols) = $TERM->get_screen_size; last TERMSIZE; } if ($^O eq 'MSWin32' and eval { require Win32::Console }) { Win32::Console->import; # Win32::Console's DESTROY does a CloseHandle(), so save the object: $o->{win32_stdout} ||= Win32::Console->new(STD_OUTPUT_HANDLE()); my @info = $o->{win32_stdout}->Info; $cols = $info[7] - $info[5] + 1; # right - left + 1 $rows = $info[8] - $info[6] + 1; # bottom - top + 1 last TERMSIZE; } if (eval { require Term::Size }) { my @x = Term::Size::chars($OUT); if (@x == 2 and $x[0]) { ($cols, $rows) = @x; last TERMSIZE; } } if (eval { require Term::Screen }) { my $screen = Term::Screen->new; ($rows, $cols) = @$screen{qw(ROWS COLS)}; last TERMSIZE; } if (eval { require Term::ReadKey }) { ($cols, $rows) = eval { local $SIG{__WARN__} = sub {}; Term::ReadKey::GetTerminalSize($OUT); }; last TERMSIZE unless $@; } if ($ENV{LINES} or $ENV{ROWS} or $ENV{COLUMNS}) { $rows = $ENV{LINES} || $ENV{ROWS} || $rows; $cols = $ENV{COLUMNS} || $cols; last TERMSIZE; } { local $^W; local *STTY; if (open (STTY, "stty size |")) { my $l = ; ($rows, $cols) = split /\s+/, $l; close STTY; } } } return { rows => $rows, cols => $cols}; } sub readkey { my $o = shift; $o->have_readkey unless $o->{readkey}; $o->{readkey}->(); } sub have_readkey { my $o = shift; return 1 if $o->{have_readkey}; my $IN = $o->{term}->IN; if (eval { require Term::InKey }) { $o->{readkey} = \&Term::InKey::ReadKey; } elsif ($^O eq 'MSWin32' and eval { require Win32::Console }) { $o->{readkey} = sub { my $c; # from Term::InKey: eval { # Win32::Console's DESTROY does a CloseHandle(), so save it: Win32::Console->import; $o->{win32_stdin} ||= Win32::Console->new(STD_INPUT_HANDLE()); my $mode = my $orig = $o->{win32_stdin}->Mode or die $^E; $mode &= ~(ENABLE_LINE_INPUT() | ENABLE_ECHO_INPUT()); $o->{win32_stdin}->Mode($mode) or die $^E; $o->{win32_stdin}->Flush or die $^E; $c = $o->{win32_stdin}->InputChar(1); die $^E unless defined $c; $o->{win32_stdin}->Mode($orig) or die $^E; }; die "Not implemented on $^O: $@" if $@; $c; }; } elsif (eval { require Term::ReadKey }) { $o->{readkey} = sub { Term::ReadKey::ReadMode(4, $IN); my $c = getc($IN); Term::ReadKey::ReadMode(0, $IN); $c; }; } else { $o->{readkey} = sub { scalar <$IN> }; return $o->{have_readkey} = 0; } return $o->{have_readkey} = 1; } *has_readkey = \&have_readkey; sub prompt { my $o = shift; my ($prompt, $default, $completions, $casei) = @_; my $term = $o->{term}; # A closure to read the line. my $line; my $readline = sub { my ($sh, $gh) = @{$term->Features}{qw(setHistory getHistory)}; my @history = $term->GetHistory if $gh; $term->SetHistory() if $sh; $line = $o->readline($prompt); $line = $default if ((not defined $line or $line =~ /^\s*$/) and defined $default); # Restore the history $term->SetHistory(@history) if $sh; $line; }; # A closure to complete the line. my $complete = sub { my ($word, $line, $start) = @_; return $o->completions($word, $completions, $casei); }; if ($term and $term->ReadLine eq 'Term::ReadLine::Gnu') { my $attribs = $term->Attribs; local $attribs->{completion_function} = $complete; &$readline; } elsif ($term and $term->ReadLine eq 'Term::ReadLine::Perl') { local $readline::rl_completion_function = $complete; &$readline; } else { &$readline; } $line; } sub format_pairs { my $o = shift; my @keys = @{shift(@_)}; my @vals = @{shift(@_)}; my $sep = shift || ": "; my $left = shift || 0; my $ind = shift || ""; my $len = shift || 0; my $wrap = shift || 0; if ($wrap) { eval { require Text::Autoformat; Text::Autoformat->import(qw(autoformat)); }; if ($@) { warn ( "Term::Shell::format_pairs(): Text::Autoformat is required " . "for wrapping. Wrapping disabled" ) if $^W; $wrap = 0; } } my $cols = shift || $o->termsize->{cols}; $len < length($_) and $len = length($_) for @keys; my @text; for my $i (0 .. $#keys) { next unless defined $vals[$i]; my $sz = ($len - length($keys[$i])); my $lpad = $left ? "" : " " x $sz; my $rpad = $left ? " " x $sz : ""; my $l = "$ind$lpad$keys[$i]$rpad$sep"; my $wrap = $wrap & ($vals[$i] =~ /\s/ and $vals[$i] !~ /^\d/); my $form = ( $wrap ? autoformat( "$vals[$i]", # force stringification { left => length($l)+1, right => $cols, all => 1 }, ) : "$l$vals[$i]\n" ); substr($form, 0, length($l), $l); push @text, $form; } my $text = join '', @text; return wantarray ? ($text, $len) : $text; } sub print_pairs { my $o = shift; my ($text, $len) = $o->format_pairs(@_); $o->page($text); return $len; } # Handle backslash translation; doesn't do anything complicated yet. sub process_esc { my $o = shift; my $c = shift; my $q = shift; my $n; return '\\' if $c eq '\\'; return $q if $c eq $q; return "\\$c"; } # Parse a quoted string sub parse_quoted { my $o = shift; my $raw = shift; my $quote = shift; my $i=1; my $string = ''; my $c; while($i <= length($raw) and ($c=substr($raw, $i, 1)) ne $quote) { if ($c eq '\\') { $string .= $o->process_esc(substr($raw, $i+1, 1), $quote); $i++; } else { $string .= substr($raw, $i, 1); } $i++; } return ($string, $i); }; sub line { my $o = shift; $o->{line} } sub line_args { my $o = shift; my $line = shift || $o->line; $o->line_parsed($line); $o->{line_args} || ''; } sub line_parsed { my $o = shift; my $args = shift || $o->line || return (); my @args; # Parse an array of arguments. Whitespace separates, unless quoted. my $arg = undef; $o->{line_args} = undef; for(my $i=0; $i{line_args} ||= substr($args, $i); } if ($c =~ /['"]/) { my ($str, $n) = $o->parse_quoted(substr($args,$i),$c); $i += $n; $arg = (defined($arg) ? $arg : '') . $str; } # We do not parse outside of strings # elsif ($c eq '\\') { # $arg = (defined($arg) ? $arg : '') # . $o->process_esc(substr($args,$i+1,1)); # $i++; # } elsif ($c =~ /\s/) { push @args, $arg if defined $arg; $arg = undef } else { $arg .= substr($args,$i,1); } } push @args, $arg if defined($arg); return @args; } sub handler { my $o = shift; my ($command, $type, $args, $preserve_args) = @_; # First try finding the standard handler, then fallback to the # catch_$type method. The columns represent "action", "type", and "push", # which control whether the name of the command should be pushed onto the # args. my @tries = ( [$command, $type, 0], [$o->cmd_prefix . $type . $o->cmd_suffix, 'catch', 1], ); # The user can control whether or not to search for "unique" matches, # which means calling $o->possible_actions(). We always look for exact # matches. my @matches = qw(exact_action); push @matches, qw(possible_actions) if $o->{API}{match_uniq}; for my $try (@tries) { my ($cmd, $type, $add_cmd_name) = @$try; for my $match (@matches) { my @handlers = $o->$match($cmd, $type); next unless @handlers == 1; unshift @$args, $command if $add_cmd_name and not $preserve_args; return $o->unalias($handlers[0], $type) } } return undef; } sub completions { my $o = shift; my $action = shift; my $compls = shift || []; my $casei = shift; $casei = $o->{API}{case_ignore} unless defined $casei; $casei = $casei ? '(?i)' : ''; return grep { $_ =~ /$casei^\Q$action\E/ } @$compls; } #============================================================================= # Term::Shell error messages #============================================================================= sub msg_ambiguous_cmd { my ($o, $cmd, @c) = @_; local $" = "\n\t"; <handler($cmd, $type, $args); $o->{command}{$type} = { cmd => $cmd, name => $cmd, found => defined $handler ? 1 : 0, cmdfull => $fullname, cmdreal => $cmdname, handler => $handler, }; if (defined $handler) { # We've found a handler. Set up a value which will call the postcmd() # action as the subroutine leaves. Then call the precmd(), then return # the result of running the handler. $o->precmd(\$handler, \$cmd, $args); my $postcmd = Term::Shell::OnScopeLeave->new(sub { $o->postcmd(\$handler, \$cmd, $args); }); return $o->$handler(@$args); } } sub uniq { my $o = shift; my %seen; $seen{$_}++ for @_; my @ret; for (@_) { push @ret, $_ if $seen{$_}-- == 1 } @ret; } sub possible_actions { my $o = shift; my $action = shift; my $type = shift; my $casei = $o->{API}{case_ignore} ? '(?i)' : ''; my @keys = grep { $_ =~ /$casei^\Q$action\E/ } grep { exists $o->{handlers}{$_}{$type} } keys %{$o->{handlers}}; return @keys; } sub exact_action { my $o = shift; my $action = shift; my $type = shift; my $casei = $o->{API}{case_ignore} ? '(?i)' : ''; my @key = grep { $action =~ /$casei^\Q$_\E$/ } grep { exists $o->{handlers}{$_}{$type} } keys %{$o->{handlers}}; return () unless @key == 1; return $key[0]; } sub is_alias { my $o = shift; my $action = shift; exists $o->{handlers}{$action}{alias} ? 1 : 0; } sub has_aliases { my $o = shift; my $action = shift; my @a = $o->get_aliases($action); @a ? 1 : 0; } sub get_aliases { my $o = shift; my $action = shift; my @a = eval { my $hndlr = $o->{handlers}{$action}{alias}; return () unless $hndlr; $o->$hndlr(); }; $o->{aliases}{$_} = $action for @a; @a; } sub unalias { my $o = shift; my $cmd = shift; # i.e 'foozle' my $type = shift; # i.e 'run' return () unless $type; return ($cmd, $cmd, $o->{handlers}{$cmd}{$type}) unless exists $o->{aliases}{$cmd}; my $alias = $o->{aliases}{$cmd}; # I'm allowing aliases to call handlers which have been removed. This # means I can set up an alias of '!' for 'shell', then delete the 'shell' # command, so that you can only access it through '!'. That's why I'm # checking the {handlers} entry _and_ building a string. my $handler = $o->{handlers}{$alias}{$type} || "${type}_${alias}"; return ($cmd, $alias, $handler); } sub find_handlers { my $o = shift; my $pkg = shift || $o->{API}{class}; # Find the handlers in the given namespace: my %handlers; { no strict 'refs'; my @r = keys %{ $pkg . "::" }; $o->add_handlers(@r); } # Find handlers in its base classes. { no strict 'refs'; my @isa = @{ $pkg . "::ISA" }; for my $pkg (@isa) { $o->find_handlers($pkg); } } } sub rl_complete { my $o = shift; my ($word, $line, $start) = @_; # If it's a command, complete 'run_': if ($start == 0 or substr($line, 0, $start) =~ /^\s*$/) { my @compls = $o->complete('', $word, $line, $start); return @compls if $o->{command}{comp}{found}; } # If it's a subcommand, send it to any custom completion function for the # function: else { my $command = ($o->line_parsed($line))[0]; my @compls = $o->complete($command, $word, $line, $start); return @compls if $o->{command}{comp}{found}; } () } #============================================================================= # Two action handlers provided by default: help and exit. #============================================================================= sub smry_exit { "exits the program" } sub help_exit { <<'END'; Exits the program. END } sub run_exit { my $o = shift; $o->stoploop; } sub smry_help { "prints this screen, or help on 'command'" } sub help_help { <<'END' Provides help on commands... END } sub comp_help { my ($o, $word, $line, $start) = @_; my @words = $o->line_parsed($line); return [] if (@words > 2 or @words == 2 and $start == length($line)); sort $o->possible_actions($word, 'help'); } sub run_help { my $o = shift; my $cmd = shift; if ($cmd) { my $txt = $o->help($cmd, @_); if ($o->{command}{help}{found}) { $o->page($txt) } else { my @c = sort $o->possible_actions($cmd, 'help'); if (@c and $o->{API}{match_uniq}) { local $" = "\n\t"; print <{handlers}}) { next unless length($h); next unless grep{defined$o->{handlers}{$h}{$_}} qw(run smry help); my $dest = exists $o->{handlers}{$h}{run} ? \%cmds : \%docs; my $smry = do { my $x = $o->summary($h); $x ? $x : "undocumented" }; my $help = exists $o->{handlers}{$h}{help} ? (exists $o->{handlers}{$h}{smry} ? "" : " - but help available") : " - no help available"; $dest->{" $h"} = "$smry$help"; } my @t; push @t, " Commands:\n" if %cmds; push @t, scalar $o->format_pairs( [sort keys %cmds], [map {$cmds{$_}} sort keys %cmds], ' - ', 1 ); push @t, " Extra Help Topics: (not commands)\n" if %docs; push @t, scalar $o->format_pairs( [sort keys %docs], [map {$docs{$_}} sort keys %docs], ' - ', 1 ); $o->page(join '', @t); } } sub run_ { } sub comp_ { my ($o, $word, $line, $start) = @_; my @comp = grep { length($_) } sort $o->possible_actions($word, 'run'); return @comp; } package Term::Shell::OnScopeLeave; use vars qw($VERSION); $VERSION = '0.04'; sub new { return bless [@_[1 .. $#_]], ref($_[0]) || $_[0]; } sub DESTROY { my $o = shift; for my $c (@$o) { $c->(); } return; } 1; Term-Shell-0.04/lib/Term/Shell.pod000444000764000764 6000112153125202 17301 0ustar00shlomifshlomif000000000000=head1 NAME Term::Shell - A simple command-line shell framework. =head1 SYNOPSIS package MyShell; use base qw(Term::Shell); sub run_command1 { print "command 1!\n"; } sub smry_command1 { "what does command1 do?" } sub help_command1 { <<'END'; Help on 'command1', whatever that may be... END } sub run_command2 { print "command 2!\n"; } package main; my $shell = MyShell->new; $shell->cmdloop; =head1 DESCRIPTION Term::Shell lets you write simple command-line shells. All the boring details like command-line parsing, terminal handling, and tab completion are handled for you. The base class comes with two commands pre-defined: exit and help. To write a shell with an C command, do something like this: package MyShell; use base qw(Term::Shell); # or manually edit @MyShell::ISA. sub run_exec { my ($o, $cmd, @args) = @_; if ($cmd ne $0) { print "I'm sorry you're leaving us...\n"; } exec $cmd, @args; exit 1; } When Term::Shell needs to handle the C command, it will invoke this method. That's all there is to it! You write handlers, and Term::Shell handles the gory details. =head1 Using Term::Shell Shells How do you bring your shell to life? Assuming the package C contains your actions, just do this: use MyShell; my $shell = MyShell->new; # Setup code here (if you wish) # Invoke the shell $shell->cmdloop; # Cleanup code here (if you wish) Most people put the setup code in the shell itself, so you can usually get away with this: use MyShell; MyShell->new->cmdloop; It's that simple! All the actions and command handlers go in C, and your main program is simple. In fact, it's so simple that some people like to write both the actions and the invocation in the same file: package main; MyShell->new->cmdloop; package MyShell; use base qw(Term::Shell); # Actions here Adding commands to your shell is just as easy, if not easier. =head1 Adding Commands to Your Shell For every command C, Term::Shell needs a method called C, where 'foo' is what the user will type in. The method will be called with the Term::Shell object as the first parameter, followed by any arguments the user typed after the command. Several prefixes other than C are supported; each prefix tells Term::Shell to call that handler under different circumstances. The following list enumerates all the "special" prefixes. Term::Shell will ignore any method that doesn't start with a prefix listed here. =over 4 =item 1 run_foo() Adds the command C to the list of supported commands. The method's return value is saved by Term::Shell, but is not used. The method is called with the Term::Shell object as its first argument, followed by any arguments the user typed in. Special case: if you provide a method C, Term::Shell will call it whenever the user enters a blank line. A blank line is anything which matches the regular expression C. =item 2 help_foo() Adds the command C to the list of help topics. This means the user may enter 'help foo' and get a help screen. It should return a single string to be displayed to the user. The method is called with the Term::Shell object as its first argument, followed by any arguments the user typed in after 'help foo'. You can implement hierarchical help documents by using the arguments. If you do not provide a C method, typing 'help foo' produces an error message. =item 3 smry_foo() Should return a one-line summary of C, to be displayed in the help screen. This method is called with the Term::Shell object as its first argument, and no other arguments. If you do not provide a C method, then the string 'undocumented' is used instead. =item 4 comp_foo() Provides custom tab-completion for C. That means if the user types 'foo ' and then hits , this method will be called. It should return an array reference containing a list of possible completions. This method is called with the Term::Shell object as its first argument, followed by the three arguments: =over 4 =item 1 $word The word the user is trying to complete. =item 2 $line The line as typed by the user so far. =item 3 $start The offset into $line where $word starts. =back If you do not provide C, Term::Shell will always return no completions for C. Special case: if you provide C, Term::Shell will call it when the user is trying to complete the name of a command. Term::Shell provides a default C method, which completes the actions that you have written handlers for. If you want to provide tab-completion for commands that do not have handlers, override C. =item 5 alias_foo() Returns a list of aliases for C. When one of the aliases is used instead of C, the corresponding handler for C is called. =item 6 catch_run() catch_help() catch_comp() catch_smry() Called when an undefined action is entered by the user. Normally when the user enters an unrecognized command, Term::Shell will print an error message and continue. This method is called with the Term::Shell object, the command typed by the user, and then the arguments which would normally be passed to the real handler. The C methods may do anything the original function would have done. If you want, you can implement all the commands in it, but that means you're doing more work than you have to. Be lazy. =back =head2 When you want something done right... You sometimes have to do it yourself. Introducing add_handlers(). Naturally, it adds a handler to the list of defined handlers in the shell. Term::Shell can't always find the commands you want to implement by searching the inheritance tree. Having an AUTOLOAD() method, for instance, will break this system. In that situation, you may wish to tell Term::Shell about the extra commands available using add_handlers(): package MyShell; use base qw(Term::Shell); sub AUTOLOAD { if ($AUTOLOAD =~ /::run_fuzz$/) { # code for 'fuzz' command } elsif ($AUTOLOAD =~ /::run_foozle$/) { # code for 'foozle' command } } sub init { my $o = shift; $o->add_handlers("run_fuzz", "run_foozle"); } There are other ways to do this. You could write a C routine and do the same thing from there. You'd have to override C so that it would complete on "foozle" and "fuzz". The advantage to this method is that it adds the methods to the list of commands, so they show up in the help menu I you get completion for free. =head1 Removing Commands from Your Shell You're probably thinking "just don't write them". But remember, you can inherit from another shell class, and that parent may define commands you want to disable. Term::Shell provides a simple method to make itself forget about commands it already knows about: =over 4 =item 1 remove_commands() Removes all handlers associated with the given command (or list of commands). For example, Term::Shell comes with two commands (C and C) implemented with seven handlers: =over 4 =item 1 smry_exit() =item 2 help_exit() =item 3 run_exit() =item 4 smry_help() =item 5 help_help() =item 6 comp_help() =item 7 run_help() =back If you want to create a shell that doesn't implement the C command, your code might look something like this example: package MyShell; use base qw(Term::Shell); sub init { my $o = shift; $o->remove_commands("help"); } # ... define more handlers here ... =item 2 remove_handlers() Removes the given handler (or handlers) from the list of defined commands. You have to specify a full handler name, including the 'run_' prefix. You can obviously specify any of the other prefixes too. If you wanted to remove the help for the C command, but preserve the command itself, your code might look something like this: package MyShell; use base qw(Term::Shell); sub init { my $o = shift; $o->remove_handlers("help_exit"); } # ... define more handlers here ... =back =head2 Cover Your Tracks If you do remove built in commands, you should be careful not to let Term::Shell print references to them. Messages like this are guaranteed to confuse people who use your shell: shell> help Unknown command 'help'; type 'help' for a list of commands. Here's the innocuous looking code: package MyShell; use base qw(Term::Shell); sub init { my $o = shift; $o->remove_commands("help"); } MyShell->new->cmdloop; The problem is that Term::Shell has to print an error message, and by default it tells the user to use the C command to see what's available. If you remove the C command, you still have to clean up after yourself and tell Term::Shell to change its error messages: =over 4 =item 1 msg_unknown_cmd() Called when the user has entered an unrecognized command, and no action was available to satisfy it. It receives the object and the command typed by the user as its arguments. It should return an error message; by default, it is defined thusly: sub msg_unknown_cmd { my ($o, $cmd) = @_; <{API}{args}', in case you want to use them later. my $sh = Term::Shell->new(@arbitrary_args); =item 2 cmd() cmd($txt); Invokes C<$txt> as if it had been typed in at the prompt. $sh->cmd("echo 1 2 3"); =item 3 cmdloop() mainloop() Repeatedly prompts the user, reads a line, parses it, and invokes a handler. Uses C internally. MyShell->new->cmdloop; mainloop() is a synonym for cmdloop(), provided for backwards compatibility. Earlier (unreleased) versions of Term::Shell have only provided mainloop(). All documentation and examples use cmdloop() instead. =item 4 init() fini() Do any initialization or cleanup you need at shell creation (init()) and destruction (fini()) by defining these methods. No parameters are passed. =item 5 preloop() postloop() Do any initialization or cleanup you need at shell startup (preloop()) and shutdown (postloop()) by defining these methods. No parameters are passed. =item 6 precmd() postcmd() Do any initialization or cleanup before and after calling each handler. The parameters are: =over 4 =item 1 $handler A reference to the name of the handler that is about to be executed. Passed by reference so you can control which handler will be called. =item 2 $cmd A reference to the command as the user typed it. Passed by reference so you can set the command. (If the handler is a "catch_" command, it can be fooled into thinking the user typed some other command, for example.) =item 3 $args The arguments as typed by the user. This is passed as an array reference so that you can manipulate the arguments received by the handler. =back sub precmd { my $o = shift; my ($handler, $cmd, @args) = @_; # ... } =item 7 stoploop() Sets a flag in the Term::Shell object that breaks out of cmdloop(). Note that cmdloop() resets this flag each time you call it, so code like this will work: my $sh = MyShell->new; $sh->cmdloop; # an interactive session $sh->cmdloop; # prompts the user again Term::Shell's built-in run_exit() command just calls stoploop(). =item 8 idle() If you set C to a non-zero number (see L) then this method is called every C seconds. The idle() method defined in Term::Shell does nothing -- it exists only to be redefined in subclasses. package MyShell; use base qw(Term::Shell); sub init { my $o = shift; $o->{API}{check_idle} = 0.1; # 10/s } sub idle { print "Idle!\n"; } =item 9 prompt_str() Returns a string to be used as the prompt. prompt_str() is called just before calling the readline() method of Term::ReadLine. If you do not override this method, the string `shell> ' is used. package MyShell; use base qw(Term::Shell); sub prompt_str { "search> " } =item 10 prompt() Term::Shell provides this method for convenience. It's common for a handler to ask the user for more information. This method makes it easy to provide the user with a different prompt and custom completions provided by you. The prompt() method takes the following parameters: =over 4 =item 1 $prompt The prompt to display to the user. This can be any string you want. =item 2 $default The default value to provide. If the user enters a blank line (all whitespace characters) then the this value will be returned. Note: unlike ExtUtils::MakeMaker's prompt(), Term::Shell's prompt() does not modify $prompt to indicate the $default response. You have to do that yourself. =item 3 $completions An optional list of completion values. When the user hits , Term::Shell prints the completions which match what they've typed so far. Term::Shell does not enforce that the user's response is one of these values. =item 4 $casei An optional boolean value which indicates whether the completions should be matched case-insensitively or not. A true value indicates that C and C should be considered the same. =back prompt() returns the unparsed line to give you maximum flexibility. If you need the line parsed, use the line_parsed() method on the return value. =item 11 cmd_prefix() cmd_suffix() These methods should return a prefix and suffix for commands, respectively. For instance, an IRC client will have a prefix of C. Most shells have an empty prefix and suffix. =item 12 page() page($txt) Prints C<$txt> through a pager, prompting the user to press a key for the next screen full of text. =item 13 line() line_parsed() Although C is called with the parsed arguments from the command-line, you may wish to see the raw command-line. This is available through the line() method. If you want to retrieve the parsed line again, use line_parsed(). line_parsed() accepts an optional string parameter: the line to parse. If you have your own line to parse, you can pass it to line_parsed() and get back a list of arguments. This is useful inside completion methods, since you don't get a parsed list there. =item 14 run() If you want to run another handler from within a handler, and you have pre-parsed arguments, use run() instead of cmd(). cmd() parses its parameter, whereas run() takes each element as a separate parameter. It needs the name of the action to run and any arguments to pass to the handler. Term::Shell uses this method internally to invoke command handlers. =item 15 help() If you want to get the raw text of a help message, use help(). It needs the name of the help topic and any arguments to pass to the handler. Term::Shell uses this method internally to invoke help handlers. =item 16 summary() If you want to get the summary text of an action, use summary(). It needs the name of the action. Term::Shell uses this method internally to display the help page. =item 17 possible_actions() You will probably want this method in comp_foo(). possible_actions() takes a word and a list, and returns a list of possible matches. Term::Shell uses this method internally to decide which handler to run when the user enters a command. There are several arguments, but you probably won't use them all in the simple cases: =over 4 =item 1 $needle The (possible incomplete) word to try to match against the list of actions (the haystack). =item 2 $type The type with which to prefix C<$action>. This is useful when completing a real action -- you have to specify whether you want it to look for "run_" or "help_" or something else. If you leave it blank, it will use C<$action> without prefixing it. =item 3 $strip If you pass in a true value here, possible_actions() will remove an initial C<$type> from the beginning of each result before returning the results. This is useful if you want to know what the possible "run_" commands are, but you don't want to have the "run_" in the final result. If you do not specify this argument, it uses '0' (the default is not to strip the results). =item 4 $haystack You can pass in a reference to a list of strings here. Each string will be compared with C<$needle>. If you do not specify this argument, it uses the list of handlers. This is how Term::Shell matches commands typed in by the user with command handlers written by you. =back =item 18 print_pairs() This overloaded beast is used whenever Term::Shell wants to print a set of keys and values. It handles wrapping long values, indenting the whole thing, inserting the separator between the key and value, and all the rest. There are lots of parameters, but most of them are optional: =over 4 =item 1 $keys A reference to a list of keys to print. =item 2 $values A reference to a list of values to print. =item 3 $sep The string used to separate the keys and values. If omitted, ': ' is used. =item 4 $left The justification to be used to line up the keys. If true, the keys will be left-justified. If false or omitted, the keys will be right-justified. =item 5 $ind A string used to indent the whole paragraph. Internally, print_pairs() uses length(), so you shouldn't use tabs in the indent string. If omitted, the empty string is used (no indent). =item 6 $len An integer which describes the minimum length of the keys. Normally, print_pairs() calculates the longest key and assigns the column width to be as wide as the longest key plus the separator. You can force the column width to be larger using $len. If omitted, 0 is used. =item 7 $wrap A boolean which indicates whether the value should be text-wrapped using Text::Autoformat. Text is only ever wrapped if it contains at least one space. If omitted, 0 is used. =item 8 $cols An integer describing the number of columns available on the current terminal. Normally 78 is used, or the environment variable COLUMNS, but you can override the number here to simulate a right-indent. =back =item 19 term() Returns the underlying C object used to interact with the user. You can do powerful things with this object; in particular, you will cripple Term::Shell's completion scheme if you change the completion callback function. =item 20 process_esc() This method may be overridden to provide shell-like escaping of backslashes inside quoted strings. It accepts two parameters: =over 4 =item 1 $c The character which was escaped by a backslash. =item 2 $quote The quote character used to delimit this string. Either C<"> or C<'>. =back This method should return the string which should replace the backslash and the escaped character. By default, process_esc() uses escaping rules similar to Perl's single-quoted string: =over 4 =item 1 Escaped backslashes return backslashes. The string C<"123\\456"> returns C<123\456>. =item 2 Escaped quote characters return the quote character (to allow quote characters in strings). The string C<"abc\"def"> returns C. =item 3 All other backslashes are returned verbatim. The string C<"123\456"> returns C<123\456>. =back Term::Shell's quote characters cannot be overridden, unless you override line_parsed(): they are C<"> or C<'>. This may change in a future version of Term::Shell. =item 21 add_handlers() See L for information on add_handlers(). =item 22 remove_commands() remove_handlers() See L for information on remove_handlers(). =back =head1 The Term::Shell Object Term::Shell creates a hash based Perl object. The object contains information like what handlers it found, the underlying Term::ReadLine object, and any arguments passed to the constructor. This hash is broken into several subhashes. The only two subhashes that a Shell should ever use are $o->{API} and $o->{SHELL}. The first one contains all the information that Term::Shell has gathered for you. The second one is a private area where your Shell can freely store data that it might need later on. This section will describe all the Term::Shell object "API" attributes: =head2 The args Attribute This an array reference containing any arguments passed to the Term::Shell constructor. =head2 The case_ignore Attribute This boolean controls whether commands should be matched without regard to case. If this is true, then typing C will have the same effect as typing C. Defaults to true on MSWin32, and false on other platforms. =head2 The class Attribute The class of the object. This is probably the package containing the definition of your shell, but if someone subclasses I shell, it's their class. =head2 The command Attribute Whenever Term::Shell invokes an action, it stores information about the action in the C attribute. Information about the last "run" action to be invoked is stored in $o->{API}{command}{run}. The information itself is stored in a subhash containing these fields: =over 4 =item name The name of the command, as typed by the user. =item found The a boolean value indicating whether a handler could be found. =item handler The full name of the handler, if found. =back Note that this facility only stores information about the I action to be executed. It's good enough for retrieving the information about the last handler which ran, but not for much else. The following example shows a case where C calls C, and prints its return value (in this case, 42). sub run_foo { my $o = shift; my $sum = $o->run("add", 21, 21); print "21 + 21 = ", $sum, "\n"; } sub run_add { my $o = shift; my $sum = 0; $sum += $_ for @_; print "add(): sum = $sum\n"; return $sum; } At the end of run_foo(), $o->{API}{command}{run}{handler} contains the string C<"run_add">. =head2 The match_uniq Attribute This boolean controls whether the user can type in only enough of the command to make it unambiguous. If true, then if the shell has the commands C and C defined, the user can type C to run C, and C to run C. Defaults to true. =head2 The readline Attribute Which Term::ReadLine module is being used. Currently, this is always one of C, C, or C. =head2 The script Attribute The name of the script that invoked your shell. =head2 The version Attribute The version of Term::Shell you are running under. =head1 BUGS AND DEFICIENCIES There are bound to be some bugs lurking about. If you find bugs, please send them to C. =head1 SEE ALSO For more information about the underlying ReadLine module, see L. You may also want to look at L and L. For more information about the underlying formatter used by print_pairs(), see L. The API for Term::Shell was inspired by (gasp!) a Python package called C. For more information about this package, please look in the Python Library Reference, either in your Python distribution or at http://www.python.org/doc/current/lib/module-cmd.html =head1 AUTHOR Neil Watkiss (NEILW@cpan.org) =head1 COPYRIGHT Copyright (c) 2001, Neil Watkiss. All Rights Reserved. All Rights Reserved. This module is free software. It may be used, redistributed and/or modified under the same terms as Perl itself. See http://www.perl.com/perl/misc/Artistic.html Term-Shell-0.04/examples000755000764000764 012153125202 15515 5ustar00shlomifshlomif000000000000Term-Shell-0.04/examples/psh.pl000444000764000764 1055512153125202 17027 0ustar00shlomifshlomif000000000000#!/usr/bin/perl -w use strict; my $obj = PSH->new; $obj->cmdloop; package PSH; use base qw(Term::Shell); use Data::Dumper; use Cwd; sub precmd { my $o = shift; my $hnd = shift; my $cmd = shift; my $args = shift; @$args = expand(@$args); } sub expand { for (@_) { $_ =~ s[^~][$ENV{HOME}]; $_ =~ s[\$([_A-Za-z0-9]+)][$ENV{$1} || '']eg; } @_; } sub prompt_str { my $cwd = cwd; $cwd =~ s[^\Q$ENV{HOME}\E][~]; "psh:$cwd> " } sub smry_eval { "how to evaluate Perl code" } sub help_eval { <<'END'; You can evaluate snippets of Perl code just by putting them on a line beginning with !: psh:~> ! print "$_\n" for keys %ENV END } #============================================================================= # External commands #============================================================================= { my $eval_num = "000001"; sub catch_run { my ($o, $command, @args) = @_; # Evaluate perl code if it's a ! line. if ($command =~ s/^!//) { (my $code = $o->line) =~ s/^!//; my $really_long_string = <completions($word, [keys %ENV]); } my @files = glob("$word*"); return $o->completions($word, \@files); } sub comp_ { my ($o, $word, $line, $start) = @_; my @exes; use Config; for my $part (split /\Q$Config{path_sep}\E/, $ENV{PATH}) { next unless -d $part; opendir (PART, $part) or die "can't opendir $part: $!"; while (my $entry = readdir(PART)) { my $file = "$part/$entry"; push @exes, $entry if -f $file and -x $file; } closedir (PART) or die "can't closedir $part: $!"; } my @comp = grep { length($_) } $o->possible_actions($word, 'run', 1); push @comp, $o->completions($word, \@exes); @comp = sort @comp; @comp; } #============================================================================= # Shell Builtins #============================================================================= sub smry_echo { 'output the args' } sub help_echo { <<'END'; echo: echo [arg ...] Output the args. END } sub run_echo { my ($o, @args) = @_; my @exp = expand(@args); defined $_ or $_ = '' for @exp; print "@exp\n" if @exp; } sub smry_set { 'set environment variables' } sub help_set { <<'END'; set: set [ name[=value] ... ] set lets you manipulate environment variables. You can view environment variables using 'set'. To view specific variables, use 'set name'. To set environment variables, use 'set foo=bar'. END } sub run_set { my ($o, @args) = @_; if (@args) { for my $arg (@args) { my ($key, $val) = split /=/, $arg; if (defined $val) { $ENV{$key} = $val; } else { $val = $ENV{$key} || ''; print "$key=$val\n"; } } } else { my ($key, $val); while(($key, $val) = each %ENV) { print "$key=$val\n"; } } } sub smry_cd { 'change working directory' } sub help_cd { <<'END'; cd: cd [dir] Change the current directory to DIR. The variable $HOME is the default DIR. END } sub run_cd { my ($o, $dir) = @_; $dir = $ENV{HOME} unless defined $dir; chdir $dir or do { print "$0: $dir: $!\n"; return; }; $ENV{PWD} = $dir; } __END__ # Not working yet... sub smry_alias { 'view or set command aliases' } sub help_alias { <<'END'; alias: [ name[=value] ... ] 'alias' with no arguments prints the list of aliases in the form NAME=VALUE on standard output. An alias is defined for each NAME whose VALUE is given. END } sub run_alias { my $o = shift; if (@_) { for my $a (@_) { my ($key, $val) = split /=/, $a; if (defined $val) { $o->{SHELL}{alias}{$key} = $val; } else { $val = $o->{SHELL}{alias}{$key}; print "alias $key=$val\n" if defined $val; print "alias: `$key' not found\n" if not defined $val; } } } else { my ($key, $val); while (($key, $val) = each %{$o->{SHELL}{alias}}) { print "alias $key=$val\n"; } } } Term-Shell-0.04/examples/old-test.pl000444000764000764 623612153125202 17751 0ustar00shlomifshlomif000000000000#!perl -w package App; use strict; use base qw(Term::Shell); use Data::Dumper; sub init { my $o = shift; $o->remove_handlers("run_squiggle"); $o->{API}{match_uniq} = 0; # allow only exact matches $o->{API}{check_idle} = 1; # run on_idle() every 1 second } sub idle { my $o = shift; $o->{SHELL}{num}++; } # The default method (when you enter a blank line). This command is not shown # in the help or in completion lists. sub run_ { print "Default command...\n"; } # A standard command. It has a summary (smry_), help topic (help_), and an # action. But it doesn't provide custom command completion (comp_). sub smry_fuzz { "A test for bears at play" } sub help_fuzz { <<'END'; Fuzzy bears are harsh quacked, man. END } sub run_fuzz { my $o = shift; print "Please enter the name of your mother.\n"; my $l = $o->prompt('Name: ', undef, [qw(Jill Mary Blanche)]); print "Say hi to $l for me!\n"; } # This command ('proxy') runs 'foo' and prints its return value (42). sub run_proxy { my $o = shift; my $c = shift; my $r = $o->run($c || "foo", @_); print "Foo returned: ", $r, "\n"; print Dumper $o->{API}{command}; } sub catch_run { my $o = shift; my $cmd = shift; print "NOTE: catch_run() called. Emulating $cmd()\n"; print Dumper \@_; } # This command ('squiggle') has two aliases ('foo', 'bar'). It doesn't have a # summary or a help topic. It does provide custom command completion, though. # If you try to complete the line after typing 'squiggle' (or 'foo' or 'bar'), # you will be able to complete to any of the words qw(all work and no play is # no fun at). Just for fun. sub run_squiggle { print "Squiggle!\n"; return 42; } sub comp_squiggle { my $o = shift; my $word = shift; $o->{SHELL}{num}++; $o->completions($word, [qw(all work and no play is no fun at)]); } sub alias_squiggle { qw(foo bar) } # You can override the prompt sub prompt_str { my $o = shift; $o->{SHELL}{num}++; "test:$o->{SHELL}{num}> "; } sub run_attribs { my $o = shift; my $term = $o->term; print Dumper $term->Features; my @keys = qw( readline_name basic_word_break_characters ); print Dumper $term->Attribs->{$_} for @keys; } package main; if ($ENV{TEST_INTERACTIVE} or not (exists $ENV{MAKELEVEL} or exists $ENV{__MKLVL__})) { print <new('default'); my $term = $app->term; warn "Using term $term\n"; $app->cmdloop; } else { print <{properties}; $self->depends_on('code'); local @INC = @INC; # Make sure we test the module in blib/ unshift @INC, (File::Spec->catdir($p->{base_dir}, $self->blib, 'lib'), File::Spec->catdir($p->{base_dir}, $self->blib, 'arch')); $self->do_test_run_tests; } sub ACTION_distruntest { my ($self) = @_; $self->depends_on('distdir'); my $start_dir = $self->cwd; my $dist_dir = $self->dist_dir; chdir $dist_dir or die "Cannot chdir to $dist_dir: $!"; # XXX could be different names for scripts $self->run_perl_script('Build.PL') # XXX Should this be run w/ --nouse-rcfile or die "Error executing 'Build.PL' in dist directory: $!"; $self->run_perl_script('Build') or die "Error executing 'Build' in dist directory: $!"; $self->run_perl_script('Build', [], ['runtest']) or die "Error executing 'Build test' in dist directory"; chdir $start_dir; } sub do_test_run_tests { my $self = shift; require Test::Run::CmdLine::Iface; my $test_run = Test::Run::CmdLine::Iface->new( { 'test_files' => [glob("t/*.t")], } # 'backend_params' => $self->_get_backend_params(), ); return $test_run->run(); } sub ACTION_tags { return system(qw( ctags -f tags --recurse --totals --exclude=blib/** --exclude=t/lib/** --exclude=.svn --exclude='*~' --languages=Perl --langmap=Perl:+.t )); } 1; Term-Shell-0.04/t000755000764000764 012153125202 14142 5ustar00shlomifshlomif000000000000Term-Shell-0.04/t/01require.t000444000764000764 24712153125202 16264 0ustar00shlomifshlomif000000000000use strict; use warnings; use Test::More tests => 1; use Term::Shell; my $shell = Term::Shell->new; # TEST ok ($shell, "A Term::Shell instance was initialised."); Term-Shell-0.04/t/02default.t000444000764000764 244612153125202 16260 0ustar00shlomifshlomif000000000000use strict; use warnings; use Test::More tests => 6; package MyShell; use base qw(Term::Shell); sub run_command1 { print "command1\n"; } sub smry_command1 { "what does command1 do?" } sub help_command1 { <<'END'; Help on 'command1', whatever that may be... END } sub run_command2 { print "command2\n"; } package main; my $shell = MyShell->new; #============================================================================= # Command completions #============================================================================= my $cmds = [$shell->possible_actions('e', 'run')]; # TEST is_deeply ($cmds, ['exit'], "e command"); $cmds = [$shell->possible_actions('h', 'run')]; # TEST is_deeply ($cmds, ['help'], "help command"); $cmds = [$shell->possible_actions('c', 'run')]; # TEST is(scalar(@$cmds), 2, "c run"); #============================================================================= # Help completions #============================================================================= $cmds = [$shell->possible_actions('e', 'help')]; # TEST is_deeply ($cmds, ['exit'], "e completions"); $cmds = [$shell->possible_actions('h', 'help')]; # TEST is_deeply ($cmds, ['help'], 'h completions'); $cmds = [$shell->possible_actions('c', 'help')]; # TEST is_deeply ($cmds, ['command1'], 'command1 completions'); Term-Shell-0.04/t/pod.t000444000764000764 21412153125202 15223 0ustar00shlomifshlomif000000000000#!perl -T use Test::More; eval "use Test::Pod 1.14"; plan skip_all => "Test::Pod 1.14 required for testing POD" if $@; all_pod_files_ok(); Term-Shell-0.04/t/03catchsmry.t000444000764000764 210612153125202 16623 0ustar00shlomifshlomif000000000000use strict; use warnings; use Test::More tests => 1; require Term::Shell; { package Term::Shell::Test; use base 'Term::Shell'; sub summary { my $self = shift; $::called = 1; $self->SUPER::summary(@_); }; sub run_fuzz { } }; my $sh = Term::Shell::Test->new; { $sh->run_help; }; unless (is($::called, 1, "catch_smry gets called for unknown methods")) { diag "Term::Shell did not call a custom catch_smry handler"; diag "This is most likely because your version of Term::Shell"; diag "has a bug. Please upgrade to v0.02 or higher, which"; diag "should close this bug."; diag "If that is no option, patch sub help() in Term/Shell.pm, line 641ff."; diag "to:"; diag ' #my $smry = exists $o->{handlers}{$h}{smry};'; diag ' #? $o->summary($h);'; diag ' #: "undocumented";'; diag ' my $smry = $o->summary($h);'; diag 'Fixing this is not necessary - you will get no online help'; diag 'but the shell will otherwise work fine. Help is still'; diag 'available through ``perldoc WWW::Mechanize::Shell``'; }; Term-Shell-0.04/scripts000755000764000764 012153125202 15366 5ustar00shlomifshlomif000000000000Term-Shell-0.04/scripts/bump-version-number.pl000444000764000764 121012153125202 21766 0ustar00shlomifshlomif000000000000#!/usr/bin/perl use strict; use warnings; use File::Find::Object; use IO::All; my $tree = File::Find::Object->new({}, 'lib/'); my $version_n = shift(@ARGV); if (!defined($version_n)) { die "Specify version number as an argument! bump-version-number.pl '0.0.1'"; } while (my $r = $tree->next()) { if ($r =~ m{/\.svn\z}) { $tree->prune(); } elsif ($r =~ m{\.pm\z}) { my @lines = io->file($r)->getlines(); foreach (@lines) { s#(\$VERSION = '|^Version )\d+\.\d+(?:\.\d+)?('|)#$1 . $version_n . $2#e; } io->file($r)->print( @lines ); } }