Our new feature is now implemented, tested, and documented. There's just one last thing we need to do - update the bundled modules that come with core. Specifically, because we've added some new syntax, we need to update B::Deparse to be able to deparse it.
When the isa operator was added, the deparse module needed to be informed about the new OP_ISA opcode, in this small addition: (github.com/Perl/perl5).
--- a/lib/B/Deparse.pm
+++ b/lib/B/Deparse.pm
@@ -52,7 +52,7 @@ use B qw(class main_root main_start main_cv svref_2object opnumber perlstring
MDEREF_SHIFT
);
-$VERSION = '1.51';
+$VERSION = '1.52';
use strict;
our $AUTOLOAD;
use warnings ();
@@ -3060,6 +3060,8 @@ sub pp_sge { binop(@_, "ge", 15) }
sub pp_sle { binop(@_, "le", 15) }
sub pp_scmp { maybe_targmy(@_, \&binop, "cmp", 14) }
+sub pp_isa { binop(@_, "isa", 15) }
+
sub pp_sassign { binop(@_, "=", 7, SWAP_CHILDREN) }
sub pp_aassign { binop(@_, "=", 7, SWAP_CHILDREN | LIST_CONTEXT) }
As you can see it's quite a small addition here; we just need to add a new method to the main B::Deparse package named after the new opcode. This new method calls down to the common binop function which is shared by the various binary operators, and recurses down parts of the optree, returning a combined result using the "isa" string in between the two parts.
A more complex addition was made with the try syntax, as can be seen at (github.com/Perl/perl5); abbreviated here:
+sub pp_leavetrycatch {
+ my $self = shift;
+ my ($op) = @_;
...
+ my $trycode = scopeop(0, $self, $tryblock);
+ my $catchvar = $self->padname($catch->targ);
+ my $catchcode = scopeop(0, $self, $catchblock);
+
+ return "try {\n\t$trycode\n\b}\n" .
+ "catch($catchvar) {\n\t$catchcode\n\b}\cK";
+}
As before, this adds a new method named after the new opcode (in the case of the try/catch syntax this is named OP_LEAVETRYCATCH). The body of this method too just recurses down to parts of the sub-tree it was passed; in this case being two scope ops for the bodies of the blocks, plus a lexical variable name for the catch variable. The method then again returns a new string combining the various parts together along with the required braces, linefeeds, and indentation hints.
We can tell we need to add this for our new banana feature, as currently this does not deparse properly:
leo@shy:~/src/bleadperl/perl [git]
$ ./perl -Ilib -Mexperimental=banana -MO=Deparse -ce 'print ban "Hello, world" ana;'
unexpected OP_BANANA at lib/B/Deparse.pm line 1664.
BEGIN {${^WARNING_BITS} = "\x10\x01\x00\x00\x00\x50\x04\x00\x00\x00\x00\x00\x00\x55\x51\x55\x50\x51\x45\x00"}
use feature 'banana';
print XXX;
-e syntax OK
We'll fix this by adding a new pp_banana in an appropriate place, perhaps just after the ones for lc/uc/fc. Don't forget to bump the $VERSION number too:
leo@shy:~/src/bleadperl/perl [git]
$ nvim lib/B/Deparse.pm
leo@shy:~/src/bleadperl/perl [git]
$ git diff
diff --git a/lib/B/Deparse.pm b/lib/B/Deparse.pm
index 67147f12dd..f6039a435d 100644
--- a/lib/B/Deparse.pm
+++ b/lib/B/Deparse.pm
@@ -52,7 +52,7 @@ use B qw(class main_root main_start main_cv svref_2object opnumber perlstring
MDEREF_SHIFT
);
-$VERSION = '1.56';
+$VERSION = '1.57';
use strict;
our $AUTOLOAD;
use warnings ();
@@ -2824,6 +2824,13 @@ sub pp_lc { dq_unop(@_, "lc") }
sub pp_quotemeta { maybe_targmy(@_, \&dq_unop, "quotemeta") }
sub pp_fc { dq_unop(@_, "fc") }
+sub pp_banana {
+ my $self = shift;
+ my ($op, $cx) = @_;
+ my $kid = $op->first;
+ return "ban " . $self->deparse($kid, 1) . " ana";
+}
+
sub loopex {
my $self = shift;
my ($op, $cx, $name) = @_;
This new function recurses down to deparse for the subtree, and returns a new string wrapped in the appropriate syntax for it. That should be all we need:
leo@shy:~/src/bleadperl/perl [git]
$ ./perl -Ilib -Mexperimental=banana -MO=Deparse -ce 'print ban "Hello, world" ana;'
BEGIN {${^WARNING_BITS} = "\x10\x01\x00\x00\x00\x50\x04\x00\x00\x00\x00\x00\x00\x55\x51\x55\x50\x51\x45\x00"}
use feature 'banana';
print ban 'Hello, world' ana;
-e syntax OK
Of course, this being a perl module we should remember to update its unit tests.
leo@shy:~/src/bleadperl/perl [git]
$ git diff lib/B/Deparse.t
diff --git a/lib/B/Deparse.t b/lib/B/Deparse.t
index 24eb445041..0fe6940cb3 100644
--- a/lib/B/Deparse.t
+++ b/lib/B/Deparse.t
@@ -3171,3 +3171,10 @@ try {
catch($var) {
SECOND();
}
+####
+# banana
+# CONTEXT use feature 'banana'; no warnings 'experimental::banana';
+ban 'literal' ana;
+ban $a ana;
+ban $a . $b ana;
+ban "stringify $a" ana;
leo@shy:~/src/bleadperl/perl [git]
$ ./perl t/harness lib/B/Deparse.t
../lib/B/Deparse.t .. ok
All tests successful.
Files=1, Tests=321, 9 wallclock secs ( 0.14 usr 0.00 sys + 8.99 cusr 0.38 csys = 9.51 CPU)
Result: PASS
Because in part 10 we added documentation for a new function in pod/perlfunc.pod there's another test that needs updating:
leo@shy:~/src/bleadperl/perl [git] $ ./perl t/harness ext/Pod-Functions/t/Functions.t ../ext/Pod-Functions/t/Functions.t .. 1/? # Failed test 'run as plain program' # at t/Functions.t line 55. # got: ' ... Result: FAIL
We can fix that by adding the new function to the expected list in the test file itself:
leo@shy:~/src/bleadperl/perl [git]
$ nvim ext/Pod-Functions/t/Functions.t
leo@shy:~/src/bleadperl/perl [git]
$ git diff ext/Pod-Functions/t/Functions.t
diff --git a/ext/Pod-Functions/t/Functions.t b/ext/Pod-Functions/t/Functions.t
index 2beccc1ac6..4d5b03e978 100644
--- a/ext/Pod-Functions/t/Functions.t
+++ b/ext/Pod-Functions/t/Functions.t
@@ -76,7 +76,7 @@ Functions.t - Test Pod::Functions
__DATA__
Functions for SCALARs or strings:
- chomp, chop, chr, crypt, fc, hex, index, lc, lcfirst,
+ ban, chomp, chop, chr, crypt, fc, hex, index, lc, lcfirst,
length, oct, ord, pack, q/STRING/, qq/STRING/, reverse,
rindex, sprintf, substr, tr///, uc, ucfirst, y///
leo@shy:~/src/bleadperl/perl [git]
$ ./perl t/harness ext/Pod-Functions/t/Functions.t
../ext/Pod-Functions/t/Functions.t .. ok
All tests successful.
Files=1, Tests=234, 1 wallclock secs ( 0.04 usr 0.01 sys + 0.23 cusr 0.00 csys = 0.28 CPU)
Result: PASS
At this point, we're done. We've now completed all the steps to add a new feature to the perl interpreter. As well as all the steps required to actually implement it in the core binary itself, we've updated the tests, documentation, and support modules to match.
Along the way we've seen examples from real commits into the perl tree while we made our own. Any particular design of new feature will of course have its own variations and differences - there's still many parts of the interpreter we haven't touched on in this series. It would be difficult to try to cover all the possible ideas of things that could be added or changed, but hopefully having completed this series you'll at least have a good overview of the main pieces that are likely to be involved, and have some starting-off points to explore further to see whatever additional details might be required for whatever situation you encounter.
