f0f9f9a9b1cfd94b18e11bf53a5989cd842b265f
[p5sagit/Devel-REPL.git] / lib / Devel / REPL / Plugin / MultiLine / PPI.pm
1 package Devel::REPL::Plugin::MultiLine::PPI;
2
3 use Devel::REPL::Plugin;
4 use PPI;
5 use namespace::clean -except => [ 'meta' ];
6
7 has 'continuation_prompt' => (
8   is => 'rw', required => 1, lazy => 1,
9   default => sub { '> ' }
10 );
11
12 has 'line_depth' => (
13   is => 'rw', required => 1, lazy => 1,
14   default => sub { 0 }
15 );
16
17 around 'read' => sub {
18   my $orig = shift;
19   my ($self, @args) = @_;
20   my $line = $self->$orig(@args);
21
22   if (defined $line) {
23     return $self->continue_reading_if_necessary($line, @args);
24   } else {
25     return $line;
26   }
27 };
28
29 sub continue_reading_if_necessary {
30   my ( $self, $line, @args ) = @_;
31
32   while ($self->line_needs_continuation($line)) {
33     my $orig_prompt = $self->prompt;
34     $self->prompt($self->continuation_prompt);
35
36     $self->line_depth($self->line_depth + 1);
37     my $append = $self->read(@args);
38     $self->line_depth($self->line_depth - 1);
39
40     $line .= "\n$append" if defined($append);
41
42     $self->prompt($orig_prompt);
43
44     # ^D means "shut up and eval already"
45     return $line if !defined($append);
46   }
47
48   return $line;
49 }
50
51 sub line_needs_continuation
52 {
53   my $repl = shift;
54   my $line = shift;
55
56   # add this so we can test whether the document ends in PPI::Statement::Null
57   $line .= "\n;;";
58
59   my $document = PPI::Document->new(\$line);
60   unless ( defined($document) ) {
61      die "PPI failed to parse document '$line'\n";
62   }
63
64   # adding ";" to a complete document adds a PPI::Statement::Null. we added a ;;
65   # so if it doesn't end in null then there's probably something that's
66   # incomplete
67   unless ( $document->child(-1)->isa('PPI::Statement::Null') ) {
68      return 1;
69   }
70
71   # this could use more logic, such as returning 1 on s/foo/ba<Enter>
72   my $unfinished_structure = sub
73   {
74     my ($document, $element) = @_;
75     return 0 unless $element->isa('PPI::Structure');
76     return 1 unless $element->finish;
77     return 0;
78   };
79
80   return $document->find_any($unfinished_structure);
81 }
82
83 1;
84
85 __END__
86
87 =head1 NAME
88
89 Devel::REPL::Plugin::MultiLine::PPI - read lines until all blocks are closed
90
91 =head1 SYNOPSIS
92
93     #!/usr/bin/perl 
94
95     use lib './lib';
96     use Devel::REPL;
97
98     my $repl = Devel::REPL->new;
99     $repl->load_plugin('LexEnv');
100     $repl->load_plugin('History');
101     $repl->load_plugin('MultiLine::PPI');
102     $repl->run;
103
104 =head1 DESCRIPTION
105
106 Plugin that will collect lines until you have no unfinished structures. This
107 lets you write subroutines, C<if> statements, loops, etc. more naturally.
108
109 For example, without a MultiLine plugin,
110
111     $ my $x = 3;
112     3
113     $ if ($x == 3) {
114
115 will throw a compile error, because that C<if> statement is incomplete. With a
116 MultiLine plugin,
117
118     $ my $x = 3;
119     3
120     $ if ($x == 3) {
121
122     > print "OH NOES!"
123
124     > }
125     OH NOES
126     1
127
128 you may write the code across multiple lines, such as in C<irb> and C<python>.
129
130 This module uses L<PPI>. This plugin is named C<MultiLine::PPI> because someone
131 else may conceivably implement similar behavior some other less
132 dependency-heavy way.
133
134 =head1 SEE ALSO
135
136 C<Devel::REPL>
137
138 =head1 AUTHOR
139
140 Shawn M Moore, C<< <sartak at gmail dot com> >>
141
142 =head1 COPYRIGHT AND LICENSE
143
144 Copyright (C) 2007 by Shawn M Moore
145
146 This library is free software; you can redistribute it and/or modify
147 it under the same terms as Perl itself.
148
149 =cut