/usr/share/perl5/Config/Model/ValueComputer.pm is in libconfig-model-perl 2.005-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 | #
# This file is part of Config-Model
#
# This software is Copyright (c) 2012 by Dominique Dumont, Krzysztof Tyszecki.
#
# This is free software, licensed under:
#
# The GNU Lesser General Public License, Version 2.1, February 1999
#
package Config::Model::ValueComputer ;
{
$Config::Model::ValueComputer::VERSION = '2.005';
}
use warnings ;
use strict;
use Scalar::Util qw(weaken) ;
use Carp ;
use Parse::RecDescent ;
use Data::Dumper () ;
use Log::Log4perl qw(get_logger :levels);
use vars qw($compute_grammar $compute_parser) ;
my $logger = get_logger("ValueComputer") ;
=head1 NAME
Config::Model::ValueComputer - Provides configuration value computation
=head1 VERSION
version 2.005
=head1 SYNOPSIS
use Config::Model;
use Log::Log4perl qw(:easy);
Log::Log4perl->easy_init($WARN);
# define configuration tree object
my $model = Config::Model->new;
$model ->create_config_class (
name => "MyClass",
element => [
[qw/av bv/] => {type => 'leaf',
value_type => 'integer',
},
compute_int => {
type => 'leaf',
value_type => 'integer',
compute => { formula => '$a + $b',
variables => { a => '- av', b => '- bv'}
},
},
],
) ;
my $inst = $model->instance(root_class_name => 'MyClass' );
my $root = $inst->config_root ;
# put data
$root->load( step => 'av=33 bv=9' );
print "Computed value is ",$root->grab_value('compute_int'),"\n";
# Computed value is 42
=head1 DESCRIPTION
This class provides a way to compute a configuration value. This
computation uses a formula and some other configuration values from
the configuration tree.
The computed value can be overridden, in other words, the computed
value can be used as a default value.
=head1 Computed value declaration
A computed value must be declared in a 'leaf' element. The leaf element
must have a C<compute> argument pointing to a hash ref.
This array ref contains:
=over
=item *
A string formula that use variables and replace function.
=item *
A set of variable and their relative location in the tree (using the
notation explained in
L<grab() method|Config::Model::AnyThing/"grab(...)">
=item *
An optional set of replace rules.
=item *
An optional parameter to force a Perl eval of a string.
=back
=head2 Compute formula
The first element of the C<compute> array ref must be a string that
contains the computation algorithm (i.e. a formula for arithmetic
computation for integer values or a string template for string
values).
This string or formula should contain variables (like C<$foo> or
C<$bar>). Note that these variables are not interpolated by Perl.
For instance:
'My cat has $nb legs'
'$m * $c**2'
This string or formula may also contain:
=over
=item *
The index value of the current object : C<&index> or C<&index()>.
=item *
The index value of a parent object: C<&index(-)>. Ancestor index value can be retrieved
with C<&index(-2)> or C<&index(-3)>.
=item *
The element name of the current object: C<&element> or C<&element()>.
=item *
The element name of a parent object: C<&element(-)>. Likewise, ancestor element name
can be retrieved with C<&element(-2)> or C<&element(-3)>.
=item*
The full location (path) of the current object: C<&location> or C<&location()>.
=back
For instance, you could have this template string:
'my element is &element, my index is &index' .
'upper element is &element(-), upper index is &index(-)',
If you need to perform more complex operations than substitution, like
extraction with regular expressions, you can force an eval done by
Perl with C<< use_eval => 1 >>. In this case, the result of the eval
will be used as the computed value.
For instance:
# extract host from url
compute => { formula => '$old =~ m!http://[\w\.]+(?::\d+)?(/.*)!; $1 ;',
variables => { old => '- url' } ,
use_eval => 1 ,
},
# capitalize
compute => { formula => 'uc($old)',
variables => { old => '- small_caps' } ,
use_eval => 1
}
=head2 Compute variables
The following arguments will be a set of C<< key => value >> to define
the variables used in the formula. The key is a variable name used in
the computation string. The value is a string that will be used to get
the correct Value object.
In this numeric example, C<result> default value is C<av + bv>:
element => [
av => {
type => 'leaf',
value_type => 'integer'
},
bv => {
type => 'leaf',
value_type => 'integer'
},
result => {
type => 'leaf',
value_type => 'integer',
compute => { formula => '$a + $b' ,
variables => { a => '- av', b => '- bv' },
}
}
In this string example, the default value of the C<Comp> element is
actually a string made of "C<macro is >" and the value of the
"C<macro>" element of the object located 2 nodes above:
comp => {
type => 'leaf',
value_type => 'string',
compute => { formula => '"macro is $m"' ,
variables => { m => '- - macro' }
}
}
=head2 Compute replace
Sometime, using the value of a tree leaf is not enough and you need to
substitute a replacement for any value you can get. This replacement
can be done using a hash like notation within the formula using the
C<%replace> hash.
For instance, if you want to display a summary of a config, you can do :
compute_with_replace
=> {
formula => '$replace{$who} is the $replace{$what} of $replace{$country}',
variables => {
who => '! who' ,
what => '! what' ,
country => '- country',
},
replace => { chief => 'president',
America => 'USA'
},
=head2 Complex formula
C<&index>, C<&element>, and replace can be combined. But the
argument of C<&element> or C<&index> can only be a value object
specification (I.e. something like 'C<- - foo>'), it cannot be a value
replacement of another C<&element> or C<&index>.
I.e. C<&element($foo)> is ok, but C<&element(&index($foo))> is not allowed.
=head2 computed variable
Compute variables can themselves be computed :
compute => {
formula => 'get_element is $replace{$s}, indirect value is \'$v\'',
variables => { 's' => '! $where',
where => '! where_is_element',
v => '! $replace{$s}',
}
replace => { m_value_element => 'm_value',
compute_element => 'compute'
}
}
Be sure not to specify a loop when doing recursive computation.
=head2 compute override
In some case, a computed value must be interpreted as a default value
and the user must be able to override this computed default value. In
this case, you must use C<< allow_override => 1 >> with the
compute parameter:
computed_value_with_override => {
type => 'leaf',
value_type => 'string',
compute => { formula => '"macro is $m"' ,
variables => { m => '- - macro' } ,
allow_override => 1,
}
}
=head2 Undefined variables
You may need to compute value where one of the variables (i.e. other configuration
parameter) is undefined. By default, any formula will yield an undefined value if one
variable is undefined.
You may change this behavior with C<undef_is> parameter. Depending on your formula and
whether C<use_eval> is true or not, you may specify a "fallback" value that will be
used in your formula.
The most useful will probably be:
undef_is => "''", # for string values
undef_is => 0 , # for integers, boolean values
Example:
Source => {
value_type => 'string',
mandatory => 1,
migrate_from => {
use_eval => 1,
formula => '$old || $older ;',
undef_is => "''",
variables => {
older => '- Original-Source-Location',
old => '- Upstream-Source'
}
},
type => 'leaf',
},
[qw/Upstream-Source Original-Source-Location/] => {
value_type => 'string',
status => 'deprecated',
type => 'leaf'
}
=cut
# allow_override is intercepted and handled by Value object
sub new {
my $type = shift ;
my %args = @_ ;
my $self= {} ;
if ($logger->is_debug) {
my %show = %args ;
delete $show{value_object} ;
$logger->debug(Data::Dumper->Dump([\%show],['Computed_value_new_args'])) ;
}
# value_object is mostly used for error messages
foreach my $k (qw/formula value_type value_object/) {
$self->{$k} = delete $args{$k} ||
croak "Config::Model::ValueComputer:new undefined parameter $k";
}
map { $self->{$_} = delete $args{$_} || {} ; } qw/variables replace/;
map { $self->{$_} = delete $args{$_} || 0 ; } qw/use_eval/ ;
my $sui = delete $args{undef_is} ;
die "Config::Model::ValueComputer:new unexpected parameter: ",
join(' ',keys %args) if %args ;
my $need_quote = 0;
$need_quote = 1 if $self->{use_eval} and $self->{value_type} !~ /(integer|number|boolean)/;
$self->{need_quote} = $need_quote ;
$self->{undef_is} = $need_quote && defined $sui && $sui eq "''" ? "''"
: $need_quote && defined $sui ? "'$sui'"
: defined $sui && $sui eq "''" ? ''
: defined $sui ? $sui
: undef;
weaken($self->{value_object}) ;
# create parser if needed
$compute_parser ||= Parse::RecDescent->new($compute_grammar) ;
# must make a first pass at computation to subsitute index and
# element values. leaves $xxx outside of &index or &element untouched
my $result_r = $compute_parser -> pre_compute (
$self->{formula},
1,
$self->{value_object},
$self->{variables},
$self->{replace},
'yes',
$need_quote,
) ;
$self->{pre_formula} = $$result_r ;
$logger->debug("done") ;
bless $self,$type ;
}
sub formula { return shift->{formula} ;}
sub variables { return shift->{variables} ;}
sub value_object { return shift->{value_object} ;}
sub compute {
my $self = shift ;
my %args = @_ ;
my $check = $args{check} || 'yes' ;
my $pre_formula = $self->{pre_formula};
$logger->debug("called with pre_formula: $pre_formula");
my $variables = $self->compute_variables(check => $check) ;
die "internal error" unless defined $variables ;
my $result ;
my @parser_args = ( $self->{value_object},
$variables, $self->{replace}, $check, $self->{need_quote},
$self->{undef_is} ) ;
if ( $self->{use_eval}
or $self->{value_type} =~ /(integer|number|boolean)/ )
{
$logger->debug("will use eval");
my $all_defined = 1;
my @init ;
foreach my $key (sort keys %$variables) {
# no need to get variable if not used in formula;
next unless index ($pre_formula,$key) > 0 ;
my $vr = _value_from_object( $key , @parser_args);
my $v = $$vr ;
$v = $self->{undef_is} unless defined $v ;
$logger->debug("compute: var $key -> ", (defined $v ? $v : '<undef>'));
if (defined $v) { push @init, "my \$$key = $v ;\n" ; }
else {$all_defined = 0 ;}
}
if ($all_defined) {
my $formula = join('', @init) . $pre_formula ;
$logger->debug("compute: evaluating '$formula'");
$result = eval $formula;
if ($@) {
Config::Model::Exception::Formula->throw(
object => $self->{value_object},
error => "Eval of formula '$formula' failed:\n$@"
. "Make sure that your element is indeed "
. "'$self->{value_type}'"
);
}
}
}
else {
$logger->debug( "calling parser with compute on pre_formula $pre_formula");
my $formula_r = $compute_parser->compute( $pre_formula, 1, @parser_args);
$result = $$formula_r;
#$result = $self->{computed_formula} = $formula;
}
$logger->debug("compute result is '". (defined $result ? $result : '<undef>'). "'" );
return $result ;
}
sub compute_info {
my $self = shift;
my %args = @_ ;
my $check = $args{check} || 'yes' ;
$logger->debug("compute_info called with $self->{formula}" );
my $orig_variables = $self->{variables} ;
my $variables = $self->compute_variables ;
my $str = "value is computed from '$self->{formula}'";
return $str unless defined $variables ;
#print Dumper $variables ;
if (%$variables) {
$str .= ", where " ;
foreach my $k (sort keys %$variables) {
my $u_val = $variables->{$k} ;
if (ref($u_val)) {
map {
$str.= "\n\t\t'\$$k" . "{$_} is converted to '$orig_variables->{$k}{$_}'";
} sort keys %$u_val ;
}
else {
my $val ;
if (defined $u_val) {
my $obj = eval { $self->{value_object} ->grab($u_val) };
if ($@) {
my $e = $@ ;
my $msg = ref($e) ? $e->full_message : $e ;
Config::Model::Exception::Model
-> throw (
object => $self,
error => "Compute variable:\n". $msg
) ;
}
$val = $obj->get_type eq 'node' ? '<node>'
: $obj->get_type eq 'hash' ? '<hash>'
: $obj->get_type eq 'list' ? '<list>'
: $obj->fetch(check => $check) ;
}
$str.= "\n\t\t'$k' from path '$orig_variables->{$k}' is ";
$str.= defined $val ? "'$val'" : 'undef' ;
}
}
}
#$str .= " (evaluated as '$self->{computed_formula}')"
# if $self->{formula} ne $self->{computed_formula} ;
return $str ;
}
# internal. resolves variables that contains $foo or &bar
# returns a hash of variable names -> variable path
sub compute_variables {
my $self = shift ;
my %args = @_ ;
my $check = $args{check} || 'yes';
# a shallow copy should be enough as we don't allow
# replace in replacement rules
my %variables = %{$self->{variables}} ;
$logger->debug("called on variables '",
join ("', '",sort keys %variables),"'") if $logger->is_debug ;
# apply a compute on all variables until no $var is left
my $var_left = scalar (keys %variables) + 1 ;
while ($var_left) {
my $old_var_left = $var_left ;
foreach my $key (keys %variables) {
my $value = $variables{$key} ; # value may be undef
next unless defined $value;
#next if ref($value); # skip replacement rules
$logger->debug("key '$key', value '$value', left $var_left");
next unless $value =~ /\$|&/ ;
my $pre_res_r = $compute_parser
-> pre_compute ($value, 1,$self->{value_object}, \%variables, $self->{replace},$check);
$logger->debug( "key '$key', pre res '$$pre_res_r', left $var_left\n");
$variables{$key} = $$pre_res_r ;
$logger->debug("variable after pre_compute: ", join (" ",keys %variables)) if $logger->is_debug ;
if ($$pre_res_r =~ /\$/) { ;
# variables needs to be evaluated
my $res_ref = $compute_parser
-> compute ($$pre_res_r, 1,$self->{value_object}, \%variables, $self->{replace},$check);
#return undef unless defined $res ;
$variables{$key} = $$res_ref ;
$logger->debug("variable after compute: ", join (" ",keys %variables)) if $logger->is_debug;
}
{
no warnings "uninitialized" ;
$logger->debug("result $key -> '$variables{$key}' left '$var_left'");
}
}
my @var_left = grep {defined $variables{$_} && $variables{$_} =~ /[\$&]/}
sort keys %variables;
$var_left = @var_left ;
Config::Model::Exception::Formula
-> throw (
object => $self->{value_object},
error => "Can't resolve user variable: '"
. join ("','",@var_left) . "'"
)
unless ($var_left < $old_var_left);
}
$logger->debug("done");
return \%variables ;
}
sub _pre_replace {
my ( $replace_h, $pre_value ) = @_;
$logger->debug("value: _pre_replace called with value '$pre_value'");
my $result =
exists $replace_h->{$pre_value}
? $replace_h->{$pre_value}
: '$replace{' . $pre_value . '}';
return \$result;
}
sub _replace {
my ( $replace_h, $value, $value_object, $variables, $replace, $check, $need_quote, $undef_is) = @_;
if ($logger->is_debug) {
my $str = defined $value ? $value : '<undef>' ;
$logger->debug("value: _replace called with value '$str'");
}
my $result;
if ( defined $value and $value =~ /\$/ ) {
# must keep original variable
$result = '$replace{' . $value . '}';
}
elsif ( defined $value ) {
my $r = $replace_h->{$value};
$result = defined $r ? $r : $undef_is;
}
return \$result;
}
sub _function_on_object {
my ( $up, $function, $return, $value_object, $variables_h, $replace_h,
$check, $need_quote )
= @_;
$logger->debug("handling &$function($up) ");
# get now the object refered
$up =~ s/-(\d+)/'- ' x $1/x ;
my $target =
eval { $value_object->grab( step => $up, check => $check ) };
if ($@) {
my $e = $@;
my $msg = $e ? $e->full_message : '';
Config::Model::Exception::Model->throw(
object => $value_object,
error => "Compute function argument '$up':\n" . $msg
);
}
if ( $function eq 'element' ) {
my $result = $target->element_name;
Config::Model::Exception::Model->throw(
object => $value_object,
error => "'",
$target->name, "' has no element name"
) unless defined $result;
$return = \$result;
}
elsif ( $function eq 'index' ) {
my $result = $target->index_value;
Config::Model::Exception::Formula->throw(
object => $value_object,
error => "'",
$target->name, "' has no index value"
) unless defined $result;
$return = \$result;
}
else {
Config::Model::Exception::Formula->throw(
object => $value_object,
error => "Unknown computation function &$function, "
. "expected &element(...) or &index(...)"
);
}
# print "\&foo(...) result = ",$$return," \n";
# make sure that result of function is quoted (avoid bareword errors)
$$return = '"' . $$return . '"' if $need_quote ;
$logger->debug("&$function(...) returns $$return");
return $return;
}
sub _function_alone {
my ( $f_name, $return, $value_object, $variables_h, $replace_h, $check,
$need_quote )
= @_;
$logger->debug("_function_alone: handling $f_name");
my $method_name =
$f_name eq 'element' ? 'element_name'
: $f_name eq 'index' ? 'index_value'
: $f_name eq 'location' ? 'location'
: undef;
Config::Model::Exception::Formula->throw(
object => $value_object,
error => "Unknown computation function &$f_name, "
. "expected &element or &index"
) unless defined $method_name;
my $result = $value_object->$method_name();
my $vt = $value_object->value_type;
if ( $vt =~ /^integer|number|boolean$/ ) {
$result = '"' . $result . '"';
}
$return = \$result;
Config::Model::Exception::Formula->throw(
object => $value_object,
error => "Missing $f_name attribute (method '$method_name' on "
. ref($value_object) . ")\n"
) unless defined $result;
return $return;
}
sub _compute {
my ( $value_ref, $return,
$value_object, $variables_h, $replace_h, $check, $need_quote, $undef_is )
= @_;
my @values = map { $$_ } @{$value_ref};
if ($logger->is_debug) {
my @display = map { defined $_ ? $_ : '<undef>' } @values ;
$logger->debug("_compute called with values '",join("','",@display));
}
my $result = '';
# return undef if one value is undef
foreach my $v (@values) {
if ( defined $v or defined $undef_is) {
$result .= defined $v ? $v : $undef_is;
}
else {
$result = undef;
last;
}
}
return \$result;
}
sub _value_from_object {
my ( $name, $value_object, $variables_h, $replace_h, $check, $need_quote ) =
@_;
$logger->warn("Warning: No variable definition found for \$$name")
unless exists $variables_h->{$name};
# $path can be a ref for test purpose, or can be undef if path is computed from another value
my $path = $variables_h->{$name};
my $my_res;
if ($logger->is_debug) {
my $str = defined $path ? $path : '<undef>' ;
$logger->debug("replace \$$name with path $str...") ;
}
if ( defined $path and $path =~ /[\$&]/ ) {
$logger->trace("skip name $name path '$path'");
$my_res = "\$$name"; # restore name that contain '$var'
}
elsif ( defined $path ) {
$logger->trace("fetching var object '$name' with '$path'");
$my_res = eval {
$value_object->grab_value( step => $path, check => $check );
};
if ($@) {
my $e = $@;
my $msg = $e ? $e->full_message : '';
Config::Model::Exception::Model->throw(
object => $value_object,
error => "Compute argument '$name', error with '$path':\n"
. $msg
);
}
$logger->trace(
"fetched var object '$name' with '$path', result '",
defined $my_res ? $my_res : 'undef',"'"
);
}
# my_res stays undef if $path if not defined
# quote result if asked when calling compute
my $quote = $need_quote || 0;
$my_res = "'$my_res'" if $quote && $my_res;
return \$my_res; # So I can return undef ... or a ref to undef
}
$compute_grammar = << 'END_OF_GRAMMAR' ;
{
# This grammar is compatible with Parse::RecDescent < 1.90 or >= 1.90
use strict;
use warnings ;
}
# computed value may return undef even if parsing is done right. To
# avoid getting problems with Parse::RecDescent (where undef means
# that the parsing did not match), we will always return a scalar
# reference to the actual returned value
# @arg is value_object, $variables_h, $replace_h, $check,$need_quote
pre_compute: <skip:''> pre_value[@arg](s) {
# print "pre-compute on @{$item[-1]}\n";
my $str = join ( '', map { $$_ } @{ $item[-1] } ) ;
$return = \$str;
}
pre_value:
<skip:''> '$replace' '{' /\s*/ pre_value[@arg] /\s*/ '}' {
$return = Config::Model::ValueComputer::_pre_replace($arg[2], ${ $item{pre_value} } ) ;
}
| <skip:''> function '(' <commit> /\s*/ up /\s*/ ')' {
$return = Config::Model::ValueComputer::_function_on_object($item{up},$item{function},$return,@arg ) ;
}
| <skip:''> '&' /\w+/ func_param(?) {
$return = Config::Model::ValueComputer::_function_alone($item[3],$return,@arg ) ;
}
| <skip:''> /\$(\d+|_)\b/ {
my $result = $item[-1] ;
$return = \$result ;
}
| object {
# print "pre_value handling \$foo\n";
my $object = $item{object};
my $result ="\$".$object ;
$return = \$result ;
}
| <skip:''> /[^\$&]*/ {
# print "pre_value copying '$item[-1]'\n";
my $result = $item[-1] ;
$return = \$result ;
}
func_param: /\(\s*\)/
up: /-?\d*/
compute: <skip:''> value[@arg](s) {
# if one value is undef, return undef;
Config::Model::ValueComputer::_compute($item[-1],$return,@arg ) ;
}
value:
<skip:''> '$replace' '{' <commit> /\s*/ value_to_replace[@arg] /\s*/ '}' {
$return = Config::Model::ValueComputer::_replace($arg[2], ${ $item{value_to_replace} },@arg ) ;
}
| <skip:''> /\$(\d+|_)\b/ {
my $result = $item[-1] ;
$return = \$result ;
}
| <skip:''> object <commit> {
$return = Config::Model::ValueComputer::_value_from_object($item{object},@arg ) ;
1;
}
| <skip:''> /[^\$]*/ {
my $result = $item[-1] ;
$return = \$result ;
}
value_to_replace:
<skip:''> object <commit> {
$return = Config::Model::ValueComputer::_value_from_object($item{object},@arg ) ;
1;
}
| <skip:''> /[\w\-\.+]*/ {
my $result = $item[-1] ;
$return = \$result ;
}
object: <skip:''> /\$/ /[a-zA-Z]\w*/
function: <skip:''> '&' /\w+/
END_OF_GRAMMAR
1;
__END__
=head1 Examples
=head2 String substitution
[qw/sav sbv/] => {
type => 'leaf',
value_type => 'string',
},
compute_string => {
type => 'leaf',
value_type => 'string',
compute => {
formula => 'meet $a and $b',
variables => { '- sav', b => '- sbv' }
},
},
=head2 Computation with on-the-fly replacement
compute_with_replace => {
type => 'leaf',
value_type => 'string',
compute => {
formula =>
'$replace{$who} is the $replace{$what} of $replace{$country}',
variables => {
who => '! who',
what => '! what',
country => '- country',
},
replace => {
chief => 'president',
America => 'USA'
},
},
},
=head2 Extract data from a value using a Perl regexp
Extract the host name from an URL:
url => {
type => 'leaf',
value_type => 'uniline'
},
extract_host_from_url => {
type => 'leaf',
value_type => 'uniline',
compute => {
formula => '$old =~ m!http://([\w\.]+)!; $1 ;',
variables => { old => '- url' },
use_eval => 1,
},
},
=head1 AUTHOR
Dominique Dumont, (ddumont at cpan dot org)
=head1 SEE ALSO
L<Config::Model>,
L<Config::Model::Instance>,
L<Config::Model::Value>
=cut
|