Changeset 409 in ProjectBuilder for devel/pb-modules

Timestamp:

Apr 25, 2008, 3:13:55 PM (17 years ago)

Author:

Bruno Cornec

Message:

• Document all reusable functions in pb
• remove the useless pbproj parameter from pb_filter functions
• Addition and use of pb_conf_init and pb_conf_add in pb
• Addition and use of pb_conf_fromfile_if in Conf.pm
• preparation for 0.9.1
• Update of pbinit files for mondo to support the new interface of pb_filter functions

File:

• devel/pb-modules/lib/ProjectBuilder/Conf.pm (modified) (8 diffs)

devel/pb-modules/lib/ProjectBuilder/Conf.pm

@@ -22 +22 @@
  
 our @ISA = qw(Exporter);
-our @EXPORT = qw(pb_conf_init pb_conf_read pb_conf_read_if pb_conf_get pb_conf_get_if);
+our @EXPORT = qw(pb_conf_init pb_conf_add pb_conf_read pb_conf_read_if pb_conf_get pb_conf_get_if);
+
+# Global list of conf files
+our @pbconffiles = ();
 
 =pod
@@ -57 +60 @@
 sub pb_conf_init {
 
-my @conffiles = @_;
+@pbconffiles = @_;
+}
+
+=item B<pb_conf_add>
+
+This function adds the configuration file to the list last.
+
+=cut
+
+sub pb_conf_add {
+
+my $f = shift;
+
+push(@pbconffiles,"$f");
 }
 
@@ -84 +100 @@
 
   $k1->{'pb'}  contains 3
-  $ka->{'default'} contains 1
+  $k1->{'default'} contains 1
   $k2->{'pb'} contains 12,25
 
@@ -130 +146 @@
 }
 
-
-# Function which returns a pointer on a table
-# corresponding to a set of values queried in the conf file
-# and test the returned vaue as they need to exist in that case
-sub pb_conf_get {
-
-my @param = @_;
-my @return = pb_conf_get_if(@param);
-
-die "No params found for $ENV{'PBPROJ'}" if (not @return);
-
-foreach my $i (0..$#param) {
-    die "No $param[$i] defined for $ENV{'PBPROJ'}" if (not defined $return[$i]);
-}
-return(@return);
-}
-
-# Function which returns a pointer on a table
-# corresponding to a set of values queried in the conf file
-# Those value may be undef if they do not exist
+=item B<pb_conf_get_if>
+
+This function returns a table, corresponding to a set of values querried in the conf files or undef if it doen't exist. It takes a table of keys as an input parameter.
+
+The format of the configurations file is as follows:
+
+key tag = value1,value2,...
+
+It will gather the values from all the configurations files passed to pb_conf_init, and return the values for the keys, taking in account the order of conf files, to manage overloading.
+
+  $ cat $HOME/.pbrc
+  pbver pb = 1
+  pblist pb = 4
+  $ cat $HOME/.pbrc2
+  pbver pb = 3
+  pblist default = 5
+
+calling it like this:
+
+  pb_conf_init("$HOME/.pbrc","$HOME/.pbrc2");
+  my ($k1, $k2) = pb_conf_get_if("pbver","pblist");
+
+will allow to get the mapping:
+
+  $k1->{'pb'} contains 3
+  $k2->{'pb'} contains 4
+
+Valid chars for keys and tags are letters, numbers, '-' and '_'.
+
+=cut
+
 sub pb_conf_get_if {
 
+my @param = @_;
+
+my $ptr = undef;
+
+# the most important conf file is first, so read them in revers order
+foreach my $f (reverse @pbconffiles) {
+    $ptr = pb_conf_get_fromfile_if("$f",$ptr,@param);
+}
+
+return(@$ptr);
+}
+
+=item B<pb_conf_fromfile_if>
+
+This function returns a pointer on a table, corresponding to a merge of values querried in the conf file and the pointer on another table passed as parameter. It takes a table of keys as last input parameter.
+
+  my ($k1) = pb_conf_fromfile_if("$HOME/.pbrc",undef,"pbver","pblist");
+  my ($k2) = pb_conf_fromfile_if("$HOME/.pbrc3",$k1,"pbver","pblist");
+
+It is used internally by pb_conf_get_if and is not exported yet.
+
+=cut
+
+
+sub pb_conf_get_fromfile_if {
+
+my $conffile = shift;
+my $ptr2 = shift || undef;
 my @param = @_;
 
@@ -157 +212 @@
 my @ptr1 = ();
 my @ptr2 = ();
-@ptr1 = pb_conf_read_if("$ENV{'PBETC'}", @param) if (defined $ENV{'PBETC'});
-@ptr2 = pb_conf_read_if("$ENV{'PBROOTDIR'}/$ENV{'PBPROJ'}.pb", @param) if ((defined $ENV{'PBROOTDIR'}) and (defined $ENV{'PBPROJ'}));
+
+# @ptr1 contains the values overloading what @ptr2 may contain.
+@ptr1 = pb_conf_read_if("$conffile", @param) if (defined $conffile);
+@ptr2 = @$ptr2 if (defined $ptr2);
 
 my $p1;
@@ -169 +226 @@
     $p1 = $ptr1[$i];
     $p2 = $ptr2[$i];
-    # Always try to take the param from the home dir conf file in priority
-    # in order to mask what could be defined under the CMS to allow for overloading
+    # Always try to take the param from ptr1 
+    # in order to mask what could be defined already in ptr2
     if (not defined $p2) {
-        # No ref in CMS project conf file so use the home dir one.
+        # No ref in p2 so use p1
         $p1->{$ENV{'PBPROJ'}} = $p1->{'default'} if ((not defined $p1->{$ENV{'PBPROJ'}}) && (defined $p1->{'default'}));
     } else {
-        # Ref found in CMS project conf file
+        # Ref found in p2
         if (not defined $p1) {
-            # No ref in home dir project conf file so use the CMS one.
+            # No ref in p1 so use p2's value
             $p2->{$ENV{'PBPROJ'}} = $p2->{'default'} if ((not defined $p2->{$ENV{'PBPROJ'}}) && (defined $p2->{'default'}));
             $p1 = $p2;
@@ -196 +253 @@
             }
             # Now copy back into p1 all p2 content which doesn't exist in p1
-            # p1 content (local) always has priority over p2 (project)
+            # p1 content always has priority over p2
             foreach my $k (keys %$p2) {
                 $p1->{$k} = $p2->{$k} if (not defined $p1->{$k});
@@ -205 +262 @@
 }
 pb_log(2,"DEBUG: pb_conf_get param ptr1: ".Dumper(@ptr1)."\n");
-return(@ptr1);
-}
-
+return(\@ptr1);
+}
+
+=item B<pb_conf_get>
+
+This function is the same B<pb_conf_get_if>, except that it tests each returned value as they need to exist in that case.
+
+=cut
+
+sub pb_conf_get {
+
+my @param = @_;
+my @return = pb_conf_get_if(@param);
+
+die "No params found for $ENV{'PBPROJ'}" if (not @return);
+
+foreach my $i (0..$#param) {
+    die "No $param[$i] defined for $ENV{'PBPROJ'}" if (not defined $return[$i]);
+}
+return(@return);
+}
 
 =back