pax_global_header00006660000000000000000000000064113110640750014510gustar00rootroot0000000000000052 comment=b3e6aac13910d7e880a8d970164d55a2418b98c1 perlconsole-0.4/000075500000000000000000000000001131106407500136765ustar00rootroot00000000000000perlconsole-0.4/AUTHORS000064400000000000000000000006361131106407500147530ustar00rootroot00000000000000AUTHORS Perl Console is written by Alexis Sukrieh. It is released under the terms of the GNU GPL Licence (see COPYING for details). CONTRIBUTORS The following people contributed to Perl Console: - Antonio Terceiro (Perl Packaging). - Daniel Novotny (patch for supporting if/while/for structure in evaluated code). - S. Zachariah Sprackett (Readline history support, rc file support) perlconsole-0.4/CHANGES000064400000000000000000000013511131106407500146710ustar00rootroot000000000000002007-08- Alexis Sukrieh * New release: 0.3 * use Module::Refresh before evaluating a line * support for complex perl code (while, if, for, ...) * History saved in ~/.perlconsole_history * Support for a ~/.perlconsolerc (every line in that file will be evaluated at launch time) * Added a real namespace to the console, each variable declared with "my" are persistent in the session. * The console runs in strict mode. 2007-08-13 Alexis Sukrieh * New release: 0.2 * Support for output modes "yaml" and "Data::Dumper" * Complete rewrite in Object Oriented way, more scalable. 2007-08-10 Alexis Sukrieh * Initial release perlconsole-0.4/COPYING000064400000000000000000000431311131106407500147330ustar00rootroot00000000000000 GNU GENERAL PUBLIC LICENSE Version 2, June 1991 Copyright (C) 1989, 1991 Free Software Foundation, Inc. 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. Preamble The licenses for most software are designed to take away your freedom to share and change it. By contrast, the GNU General Public License is intended to guarantee your freedom to share and change free software--to make sure the software is free for all its users. This General Public License applies to most of the Free Software Foundation's software and to any other program whose authors commit to using it. (Some other Free Software Foundation software is covered by the GNU Library General Public License instead.) You can apply it to your programs, too. When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for this service if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs; and that you know you can do these things. To protect your rights, we need to make restrictions that forbid anyone to deny you these rights or to ask you to surrender the rights. These restrictions translate to certain responsibilities for you if you distribute copies of the software, or if you modify it. For example, if you distribute copies of such a program, whether gratis or for a fee, you must give the recipients all the rights that you have. You must make sure that they, too, receive or can get the source code. And you must show them these terms so they know their rights. We protect your rights with two steps: (1) copyright the software, and (2) offer you this license which gives you legal permission to copy, distribute and/or modify the software. Also, for each author's protection and ours, we want to make certain that everyone understands that there is no warranty for this free software. If the software is modified by someone else and passed on, we want its recipients to know that what they have is not the original, so that any problems introduced by others will not reflect on the original authors' reputations. Finally, any free program is threatened constantly by software patents. We wish to avoid the danger that redistributors of a free program will individually obtain patent licenses, in effect making the program proprietary. To prevent this, we have made it clear that any patent must be licensed for everyone's free use or not licensed at all. The precise terms and conditions for copying, distribution and modification follow. GNU GENERAL PUBLIC LICENSE TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 0. This License applies to any program or other work which contains a notice placed by the copyright holder saying it may be distributed under the terms of this General Public License. The "Program", below, refers to any such program or work, and a "work based on the Program" means either the Program or any derivative work under copyright law: that is to say, a work containing the Program or a portion of it, either verbatim or with modifications and/or translated into another language. (Hereinafter, translation is included without limitation in the term "modification".) Each licensee is addressed as "you". Activities other than copying, distribution and modification are not covered by this License; they are outside its scope. The act of running the Program is not restricted, and the output from the Program is covered only if its contents constitute a work based on the Program (independent of having been made by running the Program). Whether that is true depends on what the Program does. 1. You may copy and distribute verbatim copies of the Program's source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice and disclaimer of warranty; keep intact all the notices that refer to this License and to the absence of any warranty; and give any other recipients of the Program a copy of this License along with the Program. You may charge a fee for the physical act of transferring a copy, and you may at your option offer warranty protection in exchange for a fee. 2. You may modify your copy or copies of the Program or any portion of it, thus forming a work based on the Program, and copy and distribute such modifications or work under the terms of Section 1 above, provided that you also meet all of these conditions: a) You must cause the modified files to carry prominent notices stating that you changed the files and the date of any change. b) You must cause any work that you distribute or publish, that in whole or in part contains or is derived from the Program or any part thereof, to be licensed as a whole at no charge to all third parties under the terms of this License. c) If the modified program normally reads commands interactively when run, you must cause it, when started running for such interactive use in the most ordinary way, to print or display an announcement including an appropriate copyright notice and a notice that there is no warranty (or else, saying that you provide a warranty) and that users may redistribute the program under these conditions, and telling the user how to view a copy of this License. (Exception: if the Program itself is interactive but does not normally print such an announcement, your work based on the Program is not required to print an announcement.) These requirements apply to the modified work as a whole. If identifiable sections of that work are not derived from the Program, and can be reasonably considered independent and separate works in themselves, then this License, and its terms, do not apply to those sections when you distribute them as separate works. But when you distribute the same sections as part of a whole which is a work based on the Program, the distribution of the whole must be on the terms of this License, whose permissions for other licensees extend to the entire whole, and thus to each and every part regardless of who wrote it. Thus, it is not the intent of this section to claim rights or contest your rights to work written entirely by you; rather, the intent is to exercise the right to control the distribution of derivative or collective works based on the Program. In addition, mere aggregation of another work not based on the Program with the Program (or with a work based on the Program) on a volume of a storage or distribution medium does not bring the other work under the scope of this License. 3. You may copy and distribute the Program (or a work based on it, under Section 2) in object code or executable form under the terms of Sections 1 and 2 above provided that you also do one of the following: a) Accompany it with the complete corresponding machine-readable source code, which must be distributed under the terms of Sections 1 and 2 above on a medium customarily used for software interchange; or, b) Accompany it with a written offer, valid for at least three years, to give any third party, for a charge no more than your cost of physically performing source distribution, a complete machine-readable copy of the corresponding source code, to be distributed under the terms of Sections 1 and 2 above on a medium customarily used for software interchange; or, c) Accompany it with the information you received as to the offer to distribute corresponding source code. (This alternative is allowed only for noncommercial distribution and only if you received the program in object code or executable form with such an offer, in accord with Subsection b above.) The source code for a work means the preferred form of the work for making modifications to it. For an executable work, complete source code means all the source code for all modules it contains, plus any associated interface definition files, plus the scripts used to control compilation and installation of the executable. However, as a special exception, the source code distributed need not include anything that is normally distributed (in either source or binary form) with the major components (compiler, kernel, and so on) of the operating system on which the executable runs, unless that component itself accompanies the executable. If distribution of executable or object code is made by offering access to copy from a designated place, then offering equivalent access to copy the source code from the same place counts as distribution of the source code, even though third parties are not compelled to copy the source along with the object code. 4. You may not copy, modify, sublicense, or distribute the Program except as expressly provided under this License. Any attempt otherwise to copy, modify, sublicense or distribute the Program is void, and will automatically terminate your rights under this License. However, parties who have received copies, or rights, from you under this License will not have their licenses terminated so long as such parties remain in full compliance. 5. You are not required to accept this License, since you have not signed it. However, nothing else grants you permission to modify or distribute the Program or its derivative works. These actions are prohibited by law if you do not accept this License. Therefore, by modifying or distributing the Program (or any work based on the Program), you indicate your acceptance of this License to do so, and all its terms and conditions for copying, distributing or modifying the Program or works based on it. 6. Each time you redistribute the Program (or any work based on the Program), the recipient automatically receives a license from the original licensor to copy, distribute or modify the Program subject to these terms and conditions. You may not impose any further restrictions on the recipients' exercise of the rights granted herein. You are not responsible for enforcing compliance by third parties to this License. 7. If, as a consequence of a court judgment or allegation of patent infringement or for any other reason (not limited to patent issues), conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot distribute so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not distribute the Program at all. For example, if a patent license would not permit royalty-free redistribution of the Program by all those who receive copies directly or indirectly through you, then the only way you could satisfy both it and this License would be to refrain entirely from distribution of the Program. If any portion of this section is held invalid or unenforceable under any particular circumstance, the balance of the section is intended to apply and the section as a whole is intended to apply in other circumstances. It is not the purpose of this section to induce you to infringe any patents or other property right claims or to contest validity of any such claims; this section has the sole purpose of protecting the integrity of the free software distribution system, which is implemented by public license practices. Many people have made generous contributions to the wide range of software distributed through that system in reliance on consistent application of that system; it is up to the author/donor to decide if he or she is willing to distribute software through any other system and a licensee cannot impose that choice. This section is intended to make thoroughly clear what is believed to be a consequence of the rest of this License. 8. If the distribution and/or use of the Program is restricted in certain countries either by patents or by copyrighted interfaces, the original copyright holder who places the Program under this License may add an explicit geographical distribution limitation excluding those countries, so that distribution is permitted only in or among countries not thus excluded. In such case, this License incorporates the limitation as if written in the body of this License. 9. The Free Software Foundation may publish revised and/or new versions of the General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. Each version is given a distinguishing version number. If the Program specifies a version number of this License which applies to it and "any later version", you have the option of following the terms and conditions either of that version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of this License, you may choose any version ever published by the Free Software Foundation. 10. If you wish to incorporate parts of the Program into other free programs whose distribution conditions are different, write to the author to ask for permission. For software which is copyrighted by the Free Software Foundation, write to the Free Software Foundation; we sometimes make exceptions for this. Our decision will be guided by the two goals of preserving the free status of all derivatives of our free software and of promoting the sharing and reuse of software generally. NO WARRANTY 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. END OF TERMS AND CONDITIONS How to Apply These Terms to Your New Programs If you develop a new program, and you want it to be of the greatest possible use to the public, the best way to achieve this is to make it free software which everyone can redistribute and change under these terms. To do so, attach the following notices to the program. It is safest to attach them to the start of each source file to most effectively convey the exclusion of warranty; and each file should have at least the "copyright" line and a pointer to where the full notice is found. Copyright (C) This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA Also add information on how to contact you by electronic and paper mail. If the program is interactive, make it output a short notice like this when it starts in an interactive mode: Gnomovision version 69, Copyright (C) year name of author Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. This is free software, and you are welcome to redistribute it under certain conditions; type `show c' for details. The hypothetical commands `show w' and `show c' should show the appropriate parts of the General Public License. Of course, the commands you use may be called something other than `show w' and `show c'; they could even be mouse-clicks or menu items--whatever suits your program. You should also get your employer (if you work as a programmer) or your school, if any, to sign a "copyright disclaimer" for the program, if necessary. Here is a sample; alter the names: Yoyodyne, Inc., hereby disclaims all copyright interest in the program `Gnomovision' (which makes passes at compilers) written by James Hacker. , 1 April 1989 Ty Coon, President of Vice This General Public License does not permit incorporating your program into proprietary programs. If your program is a subroutine library, you may consider it more useful to permit linking proprietary applications with the library. If this is what you want to do, use the GNU Library General Public License instead of this License. perlconsole-0.4/INSTALL000064400000000000000000000006171131106407500147330ustar00rootroot00000000000000Install instructions ==================== Basically: $ perl Makefile.PL $ make $ make install If you want to install perlconsole system-wide, at least the last command must be run as root (e.g. with sudo). Dependencies ============ Perl Console depends on the Term::Readline module. The first step of the installation procedure will warn you in case any of the dependencies are not installed. perlconsole-0.4/MANIFEST000064400000000000000000000002671131106407500150340ustar00rootroot00000000000000CHANGES INSTALL README lib/PerlConsole/Preferences.pm lib/PerlConsole/Commands.pm lib/PerlConsole/Console.pm lib/PerlConsole.pm COPYING perlconsole Makefile.PL MANIFEST MANIFEST.SKIP perlconsole-0.4/MANIFEST.SKIP000064400000000000000000000000071131106407500155710ustar00rootroot00000000000000.bzr/* perlconsole-0.4/Makefile.PL000064400000000000000000000004451131106407500156530ustar00rootroot00000000000000use ExtUtils::MakeMaker; WriteMakefile ( NAME => 'perlconsole', VERSION_FROM => 'lib/PerlConsole.pm', EXE_FILES => ['perlconsole'], PREREQ_PM => { 'Term::ReadLine' => 0, 'B::Keywords' => 0, 'Module::Refresh' => 0, 'Lexical::Persistence' => 0}, ); perlconsole-0.4/README000064400000000000000000000004721131106407500145610ustar00rootroot00000000000000 Perl Console Perl Console is a light program that lets you evaluate Perl code interactively. It uses Readline to grab input, and provides completion with all the namespaces loaded during your session. It allows you to load a module in your session and test a function exported by it. perlconsole-0.4/lib/000075500000000000000000000000001131106407500144445ustar00rootroot00000000000000perlconsole-0.4/lib/PerlConsole.pm000064400000000000000000000000501131106407500172220ustar00rootroot00000000000000package PerlConsole; $VERSION = '0.4'; perlconsole-0.4/lib/PerlConsole/000075500000000000000000000000001131106407500166715ustar00rootroot00000000000000perlconsole-0.4/lib/PerlConsole/Commands.pm000064400000000000000000000060131131106407500207700ustar00rootroot00000000000000package PerlConsole::Commands; # Copyright © 2007 Alexis Sukrieh # # This program is free software; you can redistribute it and/or modify it under # the terms of the GNU General Public License as published by the Free Software # Foundation; either version 2 of the License, or (at your option) any later # version. # # This program is distributed in the hope that it will be useful, but WITHOUT # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS # FOR A PARTICULAR PURPOSE. See the GNU General Public License for more # details. # # You should have received a copy of the GNU General Public License along with # this program; if not, write to the Free Software Foundation, Inc., 51 # Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. use strict; use warnings; # All the internal commands of the Perl Console are defined here. my $help = { preferences => "Display all the avaialbe preferences and how to change them.", quit => "Quit the console.", }; # display the help message # returns 1 if the string is an internal command sub isInternalCommand($$) { my ($class, $code) = @_; return 0 unless $code; chomp($code); return $code =~ /^\s*:(\S+)\s*/; } # Execute the internal command given sub execute($$$) { my ($class, $console, $code) = @_; # preference : output if ($code =~ /^\s*:set/) { if ($code =~ /^\s*:set\s+(\S+)\s*=\s*(\S+)/) { my ($pref, $val) = ($1, $2); if ($pref eq "output") { $console->setOutput($val); } else { $console->setPreference($pref, $val); } } else { $console->error("invalid syntax for setting a preference, see :help preferences"); } } # The main help page elsif ($code =~ /^\s*:help\s*$/) { $console->message(PerlConsole::Commands->help($console)); } # The help page of a specified topic elsif ($code =~ /^\s*:help\s+(\S+)/) { $console->message(PerlConsole::Commands->help($console, $1)); } # display the logs stack elsif ($code =~ /^\s*:logs/) { foreach my $log (@{$console->getLogs}) { $console->message($log); } } # at this point, unrecognized command else { $console->error("no such command"); } return 1; } # Returns an help message, on a topic sub help { my ($class, $console, $topic) = @_; if (! defined $topic) { return "The following help topics are available:\n". join("\n- ", keys%{$help}); } else { # preferences have automated online help if ($topic =~ /preferences/) { return $console->{'prefs'}->help(); } elsif (grep /^$topic$/, $console->{'prefs'}->getPreferences()) { return $console->{'prefs'}->help($topic); } elsif (defined $help->{$topic}) { return $help->{$topic}; } else { return "No such help topic: $topic"; } } } # END 1; perlconsole-0.4/lib/PerlConsole/Console.pm000064400000000000000000000345701131106407500206420ustar00rootroot00000000000000package PerlConsole::Console; # This class implements all the stuff needed to communicate with # the console. # Either for displaying message in the console (error and verbose stuff) # or for launcing command, or even changing the console's context. # dependencies use strict; use warnings; use Term::ReadLine; use PerlConsole::Preferences; use PerlConsole::Commands; use Module::Refresh; use Lexical::Persistence; use Getopt::Long; use B::Keywords qw(@Functions); # These are all the built-in keywords of Perl my @perl_keywords = @B::Keywords::Functions; ############################################################## # Constructor ############################################################## sub new($@) { my ($class, $version) = @_; # the console's data structure my $self = { version => $version, prefs => new PerlConsole::Preferences, terminal => new Term::ReadLine("Perl Console"), lexical_environment => new Lexical::Persistence, rcfile => $ENV{HOME}.'/.perlconsolerc', prompt => "Perl> ", modules => {}, logs => [], errors => [], }; bless ($self, $class); # set the readline history if a Gnu terminal if ($self->{'terminal'}->ReadLine eq "Term::ReadLine::Gnu") { $SIG{'INT'} = sub { $self->clean_exit(0) }; $self->{'terminal'}->ReadHistory($ENV{HOME} . "/.perlconsole_history"); } # init the completion list with Perl internals... $self->addCompletion([@perl_keywords]); # ... and with PerlConsole's ones $self->addCompletion([$self->{'prefs'}->getPreferences]); foreach my $pref ($self->{'prefs'}->getPreferences) { $self->addCompletion($self->{'prefs'}->getValidValues($pref)); } # FIXME : we'll have to rewrite the commands stuff in a better way $self->addCompletion([qw(:quit :set :help)]); # the console's ready! return $self; } # This is where we define all the options supported # on the command-line sub parse_options { my ($self) = @_; GetOptions('rcfile=s' => \$self->{rcfile}); # cleanup of the ~ shortcut for $ENV{HOME} my $home = $ENV{HOME}; $self->{rcfile} =~ s/^~/${home}/; } # method for exiting properly and flushing the history sub clean_exit($$) { my ($self, $status) = @_; if ($self->{'terminal'}->ReadLine eq "Term::ReadLine::Gnu") { $self->{'terminal'}->WriteHistory($ENV{HOME} . "/.perlconsole_history"); } exit $status; } ############################################################## # Terminal ############################################################## sub addCompletion($$) { my ($self, $ra_list) = @_; my $attribs = $self->{'terminal'}->Attribs; $attribs->{completion_entry_function} = $attribs->{list_completion_function}; if (! defined $attribs->{completion_word}) { $attribs->{completion_word} = $ra_list; } else { foreach my $elem (@{$ra_list}) { push @{$attribs->{completion_word}}, $elem; } } } sub is_completion { my ($self, $item) = @_; my $attribs = $self->{'terminal'}->Attribs; return grep /^${item}$/, @{$attribs->{completion_word}}; } sub getInput { my ($self) = @_; return $self->{'terminal'}->readline($self->{'prompt'}); } ############################################################## # Communication methods ############################################################## sub header { my ($self) = @_; $self->message("Perl Console ".$self->{'version'}); } # add an error the error list, this is a LIFO stack, see getError. sub addError($$) { my ($self, $error) = @_; return unless defined $error; chomp ($error); push @{$self->{'errors'}}, $error; } # returns the last error message seen sub getError($) { my ($self) = @_; return $self->{'errors'}[$#{$self->{'errors'}}]; } # clear the error messages, back to an empty list. sub clearErrors($) { my ($self) = @_; $self->{'errors'} = []; } # prints an error message, and record it to the error list sub error($$) { my ($self, $string) = @_; chomp $string; $self->addError($string); print "[!] $string\n"; } sub message { my ($self, $string) = @_; if (! defined $string) { print "undef\n"; } else { chomp $string; print "$string\n"; } } # time sub getTime($) { my ($self) = @_; my ($sec, $min, $hour, $mday, $mon, $year, $wday, $yday, $isdst) = localtime(time); $mon++; $year += 1900; $mon = sprintf("%02d", $mon); $mday = sprintf("%02d", $mday); return "$year-$mon-$mday $hour:$mon:$sec"; } # push a log message on the top of the stack sub addLog($$) { my ($self, $log) = @_; push @{$self->{'logs'}}, "[".$self->getTime."] $log"; } # get the last log message and remove it sub getLog($) { my ($self) = @_; my $log = $self->{'logs'}[$#{$self->{'logs'}}]; pop @{$self->{'logs'}}; return $log; } # Return the list of all unread log message and empty it sub getLogs { my ($self) = @_; my $logs = $self->{'logs'}; $self->{'logs'} = []; return $logs; } ############################################################## # Preferences ############################################################## # accessors for the encapsulated preference object sub setPreference($$$) { my ($self, $pref, $value) = @_; my $prefs = $self->{'prefs'}; $self->addLog("setPreference: $pref = $value"); return $prefs->set($pref, $value); } sub getPreference($$) { my ($self, $pref) = @_; my $prefs = $self->{'prefs'}; my $val = $prefs->get($pref); return $val; } # set the output and take care to load the appropriate module # for the output sub setOutput($$) { my ($self, $output) = @_; my $rh_output_modules = { 'yaml' => 'YAML', 'dumper' => 'Data::Dumper', 'dump' => 'Data::Dump', 'dds' => 'Data::Dump::Streamer', }; if (exists $rh_output_modules->{$output}) { my $module = $rh_output_modules->{$output}; unless ($self->load($module)) { $self->error("Unable to load module \"$module\", ". "cannot use output mode \"$output\""); return 0; } } unless ($self->setPreference("output", $output)) { $self->error("unable to set preference output to \"$output\""); return 0; } return 1; } # this interprets a string, it calls the appropriate internal # function to deal with the provided string sub interpret($$) { my ($self, $code) = @_; # cleanup a bit the input string chomp $code; return unless length $code; # look for the exit command. $self->clean_exit(0) if $code =~ /(:quit|exit)/i; # look for console's internal language return if $self->command($code); # look for a module to import return if $self->useModule($code); # Refresh the loaded modules in @INC that have changed Module::Refresh->refresh; # looks like it's time to evaluates some code ;) $self->print_result($self->evaluate($code)); print "\n"; # look for something to save in the completion list $self->learn($code); } # this reads and interprets the contents of an rc file (~/.perlconsolerc) # at startup. It is useful for things like loading modules that we always # want present or setting up some default variables sub source_rcfile($) { my ($self) = @_; my $file = $self->{'rcfile'}; $self->addLog("loading rcfile: $file"); if ( -r $file) { if (open(RC, "<", "$file")) { while() { $self->interpret($_); } close RC; } else { $self->error("unable to read rcfile $file : $!"); } } else { $self->error("rcfile $file is not readable"); } } # Context methods # load a module in the console's namespace # also take car to import all its symbols in the complection list sub load($$;$) { my ($self, $package, $tag) = @_; unless (defined $self->{'tags'}{$package}) { $self->{'tags'}{$package} = {}; } # look for already loaded modules/tags if (defined $tag) { return 1 if defined $self->{'tags'}{$package}{$tag}; } else { return 1 if defined $self->{'modules'}{$package}; } if (eval "require $package") { if (defined $tag) { foreach my $t (split /\s+/, $tag) { eval { $package->import($t); }; if ($@) { $self->addError($@); return 0; } # mark the tag as loaded $self->{'tags'}{$package}{$tag} = 1; } } else { eval { $package->import(); }; if ($@) { $self->addError($@); return 0; } } # mark the module as loaded $self->{'modules'}{$package} = 1; return 1; } $self->addError($@); return 0; } # This function takes a module as argument and loads all its namespace # in the completion list. sub addNamespace($$) { my ($self, $module) = @_; my $namespace; eval '$namespace = \%'.$module.'::'; if ($@) { $self->error($@); } $self->addLog("loading namespace of $module"); foreach my $token (keys %$namespace) { # only put methods found that begins with a letter if ($token =~ /^([a-zA-Z]\S+)$/) { $self->addCompletion([$1]); } } } # This function reads the command line and looks for something that is worth # saving in the completion list sub learn($$) { my ($self, $code) = @_; my $env = $self->{lexical_environment}->get_context('_'); foreach my $var (keys %$env) { $self->addCompletion([substr($var, 1)]) unless $self->is_completion(substr($var, 1)); } } # Thanks a lot to Devel::REPL for the Lexical::Persistence idea # http://chainsawblues.vox.com/library/post/writing-a-perl-repl-part-3---lexical-environments.html # # We take the code given and build a sub around it, with each variable of the # lexical environment declared with my's. Then, the sub built is evaluated # in order to get its code reference, which is returned as the "compiled" # code if success. If an error occured during the sub evaluation, undef is # returned an the error message is sent to the console. sub compile($$) { my ($self, $code) = @_; # first we declare each variable in the lexical env my $code_begin = ""; foreach my $var (keys %{$self->{lexical_environment}->get_context('_')}) { $code_begin .= "my $var;\n"; } # then we prefix the user's code with those variables init and put the # resulting code inside a sub $code = "sub {\n$code_begin\n$code;\n};\n"; # then we evaluate the sub in order to get its ref my $compiled = eval "$code"; if ($@) { $self->error("compilation error: $@"); return undef; } return $compiled; } # This function takes care of evaluating the inputed code # in a way corresponding to the user's output choice. sub evaluate($$) { my ($self, $code) = @_; # compile the code to a coderef where each variables of the lexical # environment are declared $code = $self->compile($code); return undef unless defined $code; # wrap the compiled code with Lexical::Persitence # in order to catch each variable in the lexenv $code = $self->{lexical_environment}->wrap($code); return undef unless defined $code && (ref($code) eq 'CODE'); # now evaluate the coderef pointed by the sub lexenv->wrap # built for us my @result = eval { &$code(); }; # an error occured? if ($@) { $self->error("Runtime error: $@"); return undef; } return \@result; } # This function is dedicated to print the result in the good way # It takes the resulting array of the code evaluated and converts it # to the wanted output sub print_result { my ($self, $ra_result) = @_; return unless defined $ra_result and (ref($ra_result) eq 'ARRAY'); my @result = @{$ra_result}; $self->message($self->get_output(@result)); } # the outputs sub get_output($@) { my ($self, @result) = @_; my $output = $self->getPreference('output'); # default output is scalar my $str = (@result == 1) ? $result[0] : @result; # YAML output if ($output eq 'yaml') { eval '$str = YAML::Dump(@result)'; } # Data::Dumper output elsif ($output eq 'dumper') { eval '$str = Data::Dumper::Dumper(@result)'; } # Data::Dump output elsif ($output eq 'dump') { eval '$str = Data::Dump::dump(@result)'; } # Data::Dump::Streamer output elsif ($output eq 'dds') { my $to_dump = (@result > 1) ? \@result : $result[0]; if (ref($to_dump)) { eval 'my $dds = new Data::Dump::Streamer; '. '$dds->Freezer(sub { return "$_[0]"; }); '. '$dds->Data($to_dump); '. '$str = $dds->Out;'; } else { return $to_dump; } } if ($@) { $self->error("Unable to get formated output: $@"); return ""; } return $str; } # This looks for a use statement in the string and if so, try to # load the module in the namespance, with all tags sepcified in qw() # Returns 1 if the code given was about something to load, 0 else. sub useModule($$) { my ($self, $code) = @_; my $module; my $tag; if ($code =~ /use\s+(\S+)\s+qw\((.+)\)/) { $module = $1; $tag = $2; } elsif ($code =~ /use\s+(\S+)/) { $module = $1; } if (defined $module) { # drop the possible trailing ";" $module =~ s/\s*;\s*$//; if (!$self->load($module, $tag)) { my $error = $@; chomp $error; $self->error($error); } else { $self->addNamespace($module); } return 1; } return 0; } # this looks for internal command in the given string # this is used for changing the user's preference, saving the session, # loading a session, etc... # The function returns 1 if it found something to do, 0 else. sub command($$) { my ($self, $code) = @_; return 0 unless $code; if (PerlConsole::Commands->isInternalCommand($code)) { return PerlConsole::Commands->execute($self, $code); } return 0; } # END 1; perlconsole-0.4/lib/PerlConsole/Preferences.pm000064400000000000000000000043351131106407500214750ustar00rootroot00000000000000package PerlConsole::Preferences; # # This class hanldes all the preferences the user can change within the console. # use strict; use warnings; # The main data structure of the preferences, # _valid_values contains list for each possible value. sub init { my $self = { _valid_values => { output => ['scalar', 'dumper', 'yaml', 'dump', 'dds'], }, _values => { output => "scalar" } }; return $self; } # the help messages, dynamically built with the data structure sub help($;$) { my ($self, $pref) = @_; if (!defined $pref) { return "You can set a preference in the console with the following syntax:\n". ":set =\n". "Available preferences are:\n\t- ".join("\n\t- ", keys(%{$self->{'_values'}}))."\n". "see :help for details."; } else { if (defined $self->{'_valid_values'}{$pref}) { return "Valid values for preference \"$pref\" are: ".join(", ", @{$self->{'_valid_values'}{$pref}}); } else { return "No such preference: $pref"; } } } # create an empty preference object, ready for being set sub new { my ($class) = @_; my $self = PerlConsole::Preferences::init(); bless($self, $class); return $self; } # set a preference to a given value, making sure it's an available value, and # that the value given is valid. sub set($$$) { my ($self, $pref, $val) = @_; unless (defined $self->{'_valid_values'}{$pref}) { return 0; } unless (grep /$val/, @{$self->{'_valid_values'}{$pref}}) { return 0; } $self->{'_values'}{$pref} = $val; } # retrurn the preference's value sub get($$) { my ($self, $pref) = @_; unless (exists $self->{'_values'}{$pref}) { return 0; } return $self->{'_values'}{$pref}; } # returns a list of all available preferences sub getPreferences($) { my ($self) = @_; return keys %{$self->{"_valid_values"}}; } # returns a list of all possible values of a preference sub getValidValues($$) { my ($self, $pref) = @_; return [] unless defined $self->{'_valid_values'}{$pref}; return $self->{'_valid_values'}{$pref}; } # END 1; perlconsole-0.4/perlconsole000075500000000000000000000056351131106407500161620ustar00rootroot00000000000000#!/usr/bin/perl # Copyright © 2007 Alexis Sukrieh # # This program is free software; you can redistribute it and/or modify it under # the terms of the GNU General Public License as published by the Free Software # Foundation; either version 2 of the License, or (at your option) any later # version. # # This program is distributed in the hope that it will be useful, but WITHOUT # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS # FOR A PARTICULAR PURPOSE. See the GNU General Public License for more # details. # # You should have received a copy of the GNU General Public License along with # this program; if not, write to the Free Software Foundation, Inc., 51 # Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. # Perl Console is a small program that lets you evaluates Perl code # interactively. It uses Readline for grabing input and provide completion # with all the namespaces loaded during your session. # This is the main script of the program. # strict mode use strict; use warnings; # libs use PerlConsole; use PerlConsole::Console; # Init our console my $console = PerlConsole::Console->new($PerlConsole::VERSION); # look for option in the commandline $console->parse_options(); # display the header message $console->header(); # source the rcfile first $console->source_rcfile(); # Main REPL, prompting and waiting for code to evaluate while (defined (my $code = $console->getInput())) { $console->interpret($code); } # End, quitting. $console->clean_exit(0); __END__ =pod =head1 NAME perlconsole =head1 COPYRIGHT Perl Console is Copyright (C) 2007 by Alexis Sukrieh =head1 DESCRIPTION Perl Console is a small program that implements a Read-eval-print loop: it lets you evaluate Perl code interactively. It uses Readline to grab input, and provides completion with all the namespaces loaded during your session. It allows you to load a module in your session and test a function exported by it. =head1 COMMANDS It's possible to interact with the console with internal commands. The following commands are supported in this version: =over 4 =item B<:help> display the interactive help screen =item B<:quit> quit the console =item B<:set> set a preference (see PREFERENCES). =back =head1 RCFILE PerlConsole will look for a rcfile located in your home directory called: ~/.perlconsolerc Every line in that file will be evaluated as if they were issued in the console. You can then load there your favorite modules, or even define your preferences. Example of a valid ~/.perlconsolerc :set output = dumper use Date::Calc; =head1 PREFERENCES Preferences can be set with the B<:set> command. The following preferences are supported in this version: =over 4 =item B changes the output of evaluated code =back For details about commands, ype :help within the console. =head1 AUTHOR Perl Console was writen by Alexis Sukrieh . =cut perlconsole-0.4/testfile000064400000000000000000000000001131106407500154260ustar00rootroot00000000000000