package Reply; our $AUTHORITY = 'cpan:DOY'; $Reply::VERSION = '0.42'; use strict; use warnings; # ABSTRACT: read, eval, print, loop, yay! use Module::Runtime qw(compose_module_name require_module); use Scalar::Util qw(blessed weaken); use Try::Tiny; use Reply::Config; sub new { my $class = shift; my %opts = @_; my $self = bless {}, $class; $self->{plugins} = []; $self->{_default_plugin} = $self->_instantiate_plugin('Defaults'); if (defined $opts{config}) { if (!ref($opts{config})) { $opts{config} = Reply::Config->new(file => $opts{config}); } $self->_load_config($opts{config}); } $self->_load_plugin($_) for @{ $opts{plugins} || [] }; return $self; } sub run { my $self = shift; while (1) { my $continue = $self->step; last unless $continue; } print "\n"; } sub step { my $self = shift; my ($line, $verbose) = @_; if (defined $line) { print $self->_wrapped_plugin('prompt'), $line, "\n" if $verbose; } else { $line = $self->_read; } return unless defined $line; $line = $self->_preprocess_line($line); try { my @result = $self->_eval($line); $self->_print_result(@result); } catch { $self->_print_error($_); }; my ($continue) = $self->_loop; return $continue; } sub _load_config { my $self = shift; my ($config) = @_; my $data = $config->data; my $root_config; for my $section (@$data) { my ($name, $data) = @$section; if ($name eq '_') { $root_config = $data; } else { $self->_load_plugin($name => $data); } } for my $line (sort grep { /^script_line/ } keys %$root_config) { $self->step($root_config->{$line}); } if (defined(my $file = $root_config->{script_file})) { my $contents = do { open my $fh, '<', $file or die "Couldn't open $file: $!"; local $/ = undef; <$fh> }; $self->step($contents); } } sub _load_plugin { my $self = shift; my ($plugin, $opts) = @_; $plugin = $self->_instantiate_plugin($plugin, $opts); push @{ $self->{plugins} }, $plugin; } sub _instantiate_plugin { my $self = shift; my ($plugin, $opts) = @_; if (!blessed($plugin)) { $plugin = compose_module_name("Reply::Plugin", $plugin); require_module($plugin); die "$plugin is not a valid plugin" unless $plugin->isa("Reply::Plugin"); my $weakself = $self; weaken($weakself); $plugin = $plugin->new( %$opts, publisher => sub { $weakself->_publish(@_) }, ); } return $plugin; } sub _plugins { my $self = shift; return ( @{ $self->{plugins} }, $self->{_default_plugin}, ); } sub _read { my $self = shift; my $prompt = $self->_wrapped_plugin('prompt'); return $self->_wrapped_plugin('read_line', $prompt); } sub _preprocess_line { my $self = shift; my ($line) = @_; if ($line =~ s/^#(\w+)(?:\s+|$)//) { ($line) = $self->_chained_plugin("command_\L$1", $line); } return "\n#line 1 \"reply input\"\n$line"; } sub _eval { my $self = shift; my ($line) = @_; ($line) = $self->_chained_plugin('mangle_line', $line) if defined $line; my ($code) = $self->_wrapped_plugin('compile', $line); return $self->_wrapped_plugin('execute', $code); } sub _print_error { my $self = shift; my ($error) = @_; ($error) = $self->_chained_plugin('mangle_error', $error); $self->_wrapped_plugin('print_error', $error); } sub _print_result { my $self = shift; my (@result) = @_; @result = $self->_chained_plugin('mangle_result', @result); $self->_wrapped_plugin('print_result', @result); } sub _loop { my $self = shift; $self->_chained_plugin('loop', 1); } sub _publish { my $self = shift; $self->_concatenate_plugin(@_); } sub _wrapped_plugin { my $self = shift; my @plugins = ref($_[0]) ? @{ shift() } : $self->_plugins; my ($method, @args) = @_; @plugins = grep { $_->can($method) } @plugins; return @args unless @plugins; my $plugin = shift @plugins; my $next = sub { $self->_wrapped_plugin(\@plugins, $method, @_) }; return $plugin->$method($next, @args); } sub _chained_plugin { my $self = shift; my @plugins = ref($_[0]) ? @{ shift() } : $self->_plugins; my ($method, @args) = @_; @plugins = grep { $_->can($method) } @plugins; for my $plugin (@plugins) { @args = $plugin->$method(@args); } return @args; } sub _concatenate_plugin { my $self = shift; my @plugins = ref($_[0]) ? @{ shift() } : $self->_plugins; my ($method, @args) = @_; @plugins = grep { $_->can($method) } @plugins; my @results; for my $plugin (@plugins) { push @results, $plugin->$method(@args); } return @results; } 1; __END__ =pod =encoding UTF-8 =head1 NAME Reply - read, eval, print, loop, yay! =head1 VERSION version 0.42 =head1 SYNOPSIS use Reply; Reply->new(config => "$ENV{HOME}/.replyrc")->run; =head1 DESCRIPTION NOTE: This is an early release, and implementation details of this module are still very much in flux. Feedback is welcome! Reply is a lightweight, extensible REPL for Perl. It is plugin-based (see L), and through plugins supports many advanced features such as coloring and pretty printing, readline support, and pluggable commands. =head1 METHODS =head2 new(%opts) Creates a new Reply instance. Valid options are: =over 4 =item config Name of a configuration file to load. This should contain INI-style configuration for plugins as described above. =item plugins An arrayref of additional plugins to load. =back =head2 run Runs the repl. Will continue looping until the C callback returns undef (typically when the user presses C), or the C callback returns false (by default, the C<#q> command quits the repl in this way). =head2 step($line, $verbose) Runs a single iteration of the repl. If C<$line> is given, it will be used as the string to evaluate (and the C and C callbacks will not be called). If C<$verbose> is true, the prompt and line will be displayed as though they were typed. Returns true if the repl can continue, and false if it was requested to quit. =head1 CONFIGURATION Configuration uses an INI-style format similar to the configuration format of L. Section names are used as the names of plugins, and any options within a section are passed as arguments to that plugin. Plugins are loaded in order as they are listed in the configuration file, which can affect the results in some cases where multiple plugins are hooking into a single callback (see L for more information). In addition to plugin configuration, there are some additional options recognized. These must be specified at the top of the file, before any section headers. =over 4 =item script_file This contains a filename whose contents will be evaluated as perl code once the configuration is done being loaded. =item script_line> Any options that start with C will be sorted by their key and then each value will be evaluated individually once the configuration is done being loaded. NOTE: this is currently a hack due to the fact that L doesn't support multiple keys with the same name in a section. This may be fixed in the future to just allow specifying C multiple times. =back =head1 BUGS No known bugs. Please report any bugs to GitHub Issues at L. =head1 SEE ALSO L =head1 SUPPORT You can find this documentation for this module with the perldoc command. perldoc Reply You can also look for information at: =over 4 =item * MetaCPAN L =item * Github L =item * RT: CPAN's request tracker L =item * CPAN Ratings L =back =head1 AUTHOR Jesse Luehrs =head1 COPYRIGHT AND LICENSE This software is Copyright (c) 2016 by Jesse Luehrs. This is free software, licensed under: The MIT (X11) License =cut