SL/MoreCommon.pm

   1 package SL::MoreCommon;
   2
   3 require Exporter;
   4 our @ISA = qw(Exporter);
   5
   6 our @EXPORT    = qw(save_form restore_form compare_numbers any cross);
   7 our @EXPORT_OK = qw(ary_union ary_intersect ary_diff listify);
   8
   9 use YAML;
  10
  11 use SL::AM;
  12
  13 use strict;
  14
  15 sub save_form {
  16   $main::lxdebug->enter_sub();
  17
  18   my @dont_dump_keys = @_;
  19   my %not_dumped_values;
  20
  21   foreach my $key (@dont_dump_keys) {
  22     $not_dumped_values{$key} = $main::form->{$key};
  23     delete $main::form->{$key};
  24   }
  25
  26   my $old_form = YAML::Dump($main::form);
  27   $old_form =~ s|!|!:|g;
  28   $old_form =~ s|\n|!n|g;
  29   $old_form =~ s|\r|!r|g;
  30
  31   map { $main::form->{$_} = $not_dumped_values{$_} } keys %not_dumped_values;
  32
  33   $main::lxdebug->leave_sub();
  34
  35   return $old_form;
  36 }
  37
  38 sub restore_form {
  39   $main::lxdebug->enter_sub();
  40
  41   my ($old_form, $no_delete, @keep_vars) = @_;
  42
  43   my $form          = $main::form;
  44   my %keep_vars_map = map { $_ => 1 } @keep_vars;
  45
  46   map { delete $form->{$_} if (!$keep_vars_map{$_}); } keys %{$form} unless ($no_delete);
  47
  48   $old_form =~ s|!r|\r|g;
  49   $old_form =~ s|!n|\n|g;
  50   $old_form =~ s|![!:]|!|g;
  51
  52   my $new_form = YAML::Load($old_form);
  53   map { $form->{$_} = $new_form->{$_} if (!$keep_vars_map{$_}) } keys %{ $new_form };
  54
  55   $main::lxdebug->leave_sub();
  56 }
  57
  58 sub compare_numbers {
  59   $main::lxdebug->enter_sub();
  60
  61   my $a      = shift;
  62   my $a_unit = shift;
  63   my $b      = shift;
  64   my $b_unit = shift;
  65
  66   $main::all_units ||= AM->retrieve_units(\%main::myconfig, $main::form);
  67   my $units          = $main::all_units;
  68
  69   if (!$units->{$a_unit} || !$units->{$b_unit} || ($units->{$a_unit}->{base_unit} ne $units->{$b_unit}->{base_unit})) {
  70     $main::lxdebug->leave_sub();
  71     return undef;
  72   }
  73
  74   $a *= $units->{$a_unit}->{factor};
  75   $b *= $units->{$b_unit}->{factor};
  76
  77   $main::lxdebug->leave_sub();
  78
  79   return $a <=> $b;
  80 }
  81
  82 sub any (&@) {
  83   my $f = shift;
  84   return if ! @_;
  85   for (@_) {
  86     return 1 if $f->();
  87   }
  88   return 0;
  89 }
  90
  91 =item cross BLOCK ARRAY ARRAY
  92
  93 Evaluates BLOCK for each combination of elements in ARRAY1 and ARRAY2
  94 and returns a new list consisting of BLOCK's return values.
  95 The two elements are set to $a and $b.
  96 Note that those two are aliases to the original value so changing them
  97 will modify the input arrays.
  98
  99   # append each to each
 100   @a = qw/a b c/;
 101   @b = qw/1 2 3/;
 102   @x = cross { "$a$b" } @a, @b;
 103   # returns a1, a2, a3, b1, b2, b3, c1, c2, c3
 104
 105 As cross expects an array but returns a list it is not directly chainable
 106 at the moment. This will be corrected in the future.
 107
 108 =cut
 109 sub cross(&\@\@) {
 110   my $op = shift;
 111   use vars qw/@A @B/;
 112   local (*A, *B) = @_;    # syms for caller's input arrays
 113
 114   # Localise $a, $b
 115   my ($caller_a, $caller_b) = do {
 116     my $pkg = caller();
 117     no strict 'refs';
 118     \*{$pkg.'::a'}, \*{$pkg.'::b'};
 119   };
 120
 121   local(*$caller_a, *$caller_b);
 122
 123   # This map expression is also the return value.
 124   map { my $a_index = $_;
 125     map { my $b_index = $_;
 126       # assign to $a, $b as refs to caller's array elements
 127       (*$caller_a, *$caller_b) = \($A[$a_index], $B[$b_index]);
 128       $op->();    # perform the transformation
 129     }  0 .. $#B;
 130   }  0 .. $#A;
 131 }
 132
 133 sub _ary_calc_union_intersect {
 134   my ($a, $b) = @_;
 135
 136   my %count = ();
 137
 138   foreach my $e (@$a, @$b) { $count{$e}++ }
 139
 140   my @union = ();
 141   my @isect = ();
 142   foreach my $e (keys %count) {
 143     push @union, $e;
 144     push @isect, $e if $count{$e} == 2;
 145   }
 146
 147   return (\@union, \@isect);
 148 }
 149
 150 sub ary_union {
 151   return @{ (_ary_calc_union_intersect @_)[0] };
 152 }
 153
 154 sub ary_intersect {
 155   return @{ (_ary_calc_union_intersect @_)[1] };
 156 }
 157
 158 sub ary_diff {
 159   my ($a, $b) = @_;
 160   my %in_b    = map { $_ => 1 } @$b;
 161   return grep { !$in_b{$_} } @$a;
 162 }
 163
 164 sub listify {
 165   my @ary = scalar @_ > 1 ? @_ : ref $_[0] eq 'ARRAY' ? @{ $_[0] } : (@_);
 166   return wantarray ? @ary : scalar @ary;
 167 }
 168
 169 1;