Changeset 397 in ProjectBuilder for devel/pb/lib/ProjectBuilder/Base.pm

Timestamp:

Apr 19, 2008, 1:03:02 AM (16 years ago)

Author:

Bruno Cornec

Message:

• pb_syntax is now shared
• creation of 2 new shared functions pb_syntax_init and pb_temp_init

File:

• devel/pb/lib/ProjectBuilder/Base.pm (modified) (4 diffs)

devel/pb/lib/ProjectBuilder/Base.pm

@@ -18 +18 @@
 use Data::Dumper;
 use Time::localtime qw(localtime);
+use Pod::Usage;
 use English;
 
@@ -27 +28 @@
 # any code which uses this module.
  
-our $debug = 0;
-our $LOG = \*STDOUT;
+our $debug = 0;         # Global debug level
+our $LOG = \*STDOUT;    # File descriptor of the log file
+our $synmsg = "Error";  # Global error message
 
 our @ISA = qw(Exporter);
@@ -341 +343 @@
 =cut
 
-# get content of a file in a variable
 sub pb_get_content {
 
@@ -356 +357 @@
 }
 
+=item B<pb_syntax_init>
+
+This function initializes the global variable used by the pb_syntax function.
+
+The parameter is the message string which will be printed when calling pb_syntax
+
+=cut
+
+sub pb_syntax_init {
+
+$synmsg = shift || "Error";
+}
+
+=item B<pb_syntax>
+
+This function prints the syntax expected by the application, based on pod2usage, and exits.
+The first parameter is the return value of the exit.
+The second parameter is the verbosity as expected by pod2usage.
+
+Cf: man Pod::Usage
+
+=cut
+
+sub pb_syntax {
+
+my $exit_status = shift || -1;
+my $verbose_level = shift || 0;
+
+my $filehandle = \*STDERR;
+
+$filehandle = \*STDOUT if ($exit_status == 0);
+
+pod2usage( { -message => $synmsg,
+             -exitval => $exit_status  ,
+             -verbose => $verbose_level,
+             -output  => $filehandle } );
+}
+
+=item B<pb_temp_init>
+
+This function initializes the environemnt variable PBTMP to a random value. This directory can be safely used during the whole program, it will be removed at the end automatically.
+
+=cut
+
+sub pb_temp_init {
+
+if (not defined $ENV{'TMPDIR'}) {
+    $ENV{'TMPDIR'}="/tmp";
+}
+$ENV{'PBTMP'} = tempdir( "pb.XXXXXXXXXX", DIR => $ENV{'TMPDIR'}, CLEANUP => 1 );
+}
+
+=back 
+
+=head1 WEB SITES
+
+The main Web site of the project is available at L<http://www.project-builder.org/>. Bug reports should be filled using the trac instance of the project at L<http://trac.project-builder.org/>.
+
+=head1 USER MAILING LIST
+
+None exists for the moment.
+
+=head1 AUTHORS
+
+The Project-Builder.org team L<http://trac.project-builder.org/> lead by Bruno Cornec L<mailto:bruno@project-builder.org>.
+
+=head1 COPYRIGHT
+
+Project-Builder.org is distributed under the GPL v2.0 license
+described in the file C<COPYING> included with the distribution.
+
+=cut
+
 1;