| MooseX-Declare documentation | Contained in the MooseX-Declare distribution. |
MooseX::Declare::Context - Per-keyword declaration context
This is not a subclass of Devel::Declare::Context::Simple, but it will delegate all default methods and extend it with some attributes and methods of its own.
A context object will be instanciated for every keyword that is handled by MooseX::Declare. If handlers want to communicate with other handlers (for example handlers that will only be setup inside a namespace block) it must do this via the generated code.
In addition to all the methods documented here, all methods from Devel::Declare::Context::Simple are available and will be delegated to an internally stored instance of it.
A required Str containing the file the keyword was encountered in.
An ArrayRef of CodeParts that will be used as preamble. A preamble in
this context means the beginning of the generated code.
These parts will come before the actual body and after the
preamble_code_parts. It is an ArrayRef of CodeParts.
An ArrayRef of CodeParts that will not be directly inserted
into the code, but instead be installed in a handler that will run at
the end of the scope so you can do namespace cleanups and such.
An ArrayRef that contains the stack of handlers. A keyword that was
only setup inside a scoped block will have the blockhandler be put in
the stack.
Object->add_preamble_code_parts (CodeRef @parts)
Object->add_scope_code_parts (CodeRef @parts)
Object->add_cleanup_code_parts (CodeRef @parts)
For these three methods please look at the corresponding *_code_parts
attribute in the list above. These methods are merely convenience methods
that allow adding entries to the code part containers.
True Object->inject_code_parts_here (CodePart @parts)
Will inject the passed CodeParts at the current position in the code.
Str Object->peek_next_char ()
Will return the next char without stripping it from the stream.
Object->inject_code_parts (
Bool :$inject_cleanup_code_parts,
CodeRef :$missing_block_handler
)
This will inject the code parts from the attributes above at the current
position. The preamble and scope code parts will be inserted first. Then
then call to the cleanup code will be injected, unless the options
contain a key named inject_cleanup_code_parts with a false value.
The inject_if_block method will be called if the next char is a {
indicating a following block.
If it is not a block, but a semi-colon is found and the options
contained a missing_block_handler key was passed, it will be called
as method on the context object with the code to inject and the
options as arguments. All options that are not recognized are passed
through to the missing_block_handler. You are well advised to prefix
option names in your extensions.
An ArrayRef with at least one element that stringifies to either BEGIN
or END. The other parts will be stringified and used as the body for the
generated block. An example would be this compiletime role composition:
['BEGIN', 'with q{ MyRole }']
A part of code represented by either a Str or a BlockCodePart.
This software is copyright (c) 2010 by Florian Ragwitz.
This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.
| MooseX-Declare documentation | Contained in the MooseX-Declare distribution. |
package MooseX::Declare::Context; BEGIN { $MooseX::Declare::Context::AUTHORITY = 'cpan:FLORA'; } BEGIN { $MooseX::Declare::Context::VERSION = '0.34'; } # ABSTRACT: Per-keyword declaration context use Moose 0.90; use Moose::Util::TypeConstraints; use Carp qw/croak/; use aliased 'Devel::Declare::Context::Simple', 'DDContext'; use namespace::clean -except => 'meta'; subtype 'MooseX::Declare::BlockCodePart', as 'ArrayRef', where { @$_ > 1 and sub { grep { $_[0] eq $_ } qw( BEGIN END ) } -> ($_->[0]) }; subtype 'MooseX::Declare::CodePart', as 'Str|MooseX::Declare::BlockCodePart'; has _dd_context => ( is => 'ro', isa => DDContext, required => 1, builder => '_build_dd_context', lazy => 1, handles => qr/.*/, ); has _dd_init_args => ( is => 'rw', isa => 'HashRef', default => sub { {} }, required => 1, ); has provided_by => ( is => 'ro', isa => 'ClassName', required => 1, ); has caller_file => ( is => 'rw', isa => 'Str', required => 1, ); has preamble_code_parts => ( traits => ['Array'], is => 'ro', isa => 'ArrayRef[MooseX::Declare::CodePart]', required => 1, default => sub { [] }, handles => { add_preamble_code_parts => 'push', }, ); has scope_code_parts => ( traits => ['Array'], is => 'ro', isa => 'ArrayRef[MooseX::Declare::CodePart]', required => 1, default => sub { [] }, handles => { add_scope_code_parts => 'push', }, ); has cleanup_code_parts => ( traits => ['Array'], is => 'ro', isa => 'ArrayRef[MooseX::Declare::CodePart]', required => 1, default => sub { [] }, handles => { add_cleanup_code_parts => 'push', add_early_cleanup_code_parts => 'unshift', }, ); has stack => ( is => 'rw', isa => 'ArrayRef', default => sub { [] }, required => 1, ); sub inject_code_parts_here { my ($self, @parts) = @_; # get code to inject and rest of line my $inject = $self->_joined_statements(\@parts); my $linestr = $self->get_linestr; # add code to inject to current line and inject it substr($linestr, $self->offset, 0, "$inject"); $self->set_linestr($linestr); return 1; } sub peek_next_char { my ($self) = @_; # return next char in line my $linestr = $self->get_linestr; return substr $linestr, $self->offset, 1; } sub peek_next_word { my ($self) = @_; $self->skipspace; my $len = Devel::Declare::toke_scan_word($self->offset, 1); return unless $len; my $linestr = $self->get_linestr; return substr($linestr, $self->offset, $len); } sub inject_code_parts { my ($self, %args) = @_; # default to injecting cleanup code $args{inject_cleanup_code_parts} = 1 unless exists $args{inject_cleanup_code_parts}; # add preamble and scope statements to injected code my $inject; $inject .= $self->_joined_statements('preamble'); $inject .= ';' . $self->_joined_statements('scope'); # if we should also inject the cleanup code if ($args{inject_cleanup_code_parts}) { $inject .= ';' . $self->scope_injector_call($self->_joined_statements('cleanup')); } $inject .= ';'; # we have a block if ($self->peek_next_char eq '{') { $self->inject_if_block("$inject"); } # there was no block to inject into else { # require end of statement croak "block or semi-colon expected after " . $self->declarator . " statement" unless $self->peek_next_char eq ';'; # if we can't handle non-blocks, we expect one croak "block expected after " . $self->declarator . " statement" unless exists $args{missing_block_handler}; # delegate the processing of the missing block $args{missing_block_handler}->($self, $inject, %args); } return 1; } sub _joined_statements { my ($self, $section) = @_; # if the section was not an array reference, get the # section contents of that name $section = $self->${\"${section}_code_parts"} unless ref $section; # join statements via semicolon # array references are expected to be in the form [FOO => 1, 2, 3] # which would yield BEGIN { 1; 2; 3 } return join '; ', map { not( ref $_ ) ? $_ : do { my ($block, @parts) = @$_; sprintf '%s { %s }', $block, join '; ', @parts; }; } @{ $section }; } sub BUILD { my ($self, $attrs) = @_; # remember the constructor arguments for the delegated context $self->_dd_init_args($attrs); } sub _build_dd_context { my ($self) = @_; # create delegated context with remembered arguments return DDContext->new(%{ $self->_dd_init_args }); } sub strip_word { my ($self) = @_; $self->skipspace; my $linestr = $self->get_linestr; return if substr($linestr, $self->offset, 1) =~ /[{;]/; # TODO: # - provide a reserved_words attribute # - allow keywords to consume reserved_words autodiscovery role my $word = $self->peek_next_word; return if !defined $word || $word =~ /^(?:extends|with|is)$/; return scalar $self->strip_name; } 1; __END__