Changeset 495 in ProjectBuilder for devel/pb-modules/lib/ProjectBuilder/Base.pm

Timestamp:

Jul 10, 2008, 11:36:18 AM (16 years ago)

Author:

Bruno Cornec

Message:

• all global variables are prefixed with pb
• First attempt at using locale and gettext
• use of pb_display and pb_display_init added
• Update presentation following RMLL 2008

File:

• devel/pb-modules/lib/ProjectBuilder/Base.pm (modified) (7 diffs)

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

@@ -20 +20 @@
 use Pod::Usage;
 use English;
+use locale;
+use Locale::gettext;
+use POSIX qw(setlocale);
 
 # Inherit from the "Exporter" module which handles exporting functions.
@@ -28 +31 @@
 # any code which uses this module.
  
-our $debug = 0;         # Global debug level
-our $LOG = \*STDOUT;    # File descriptor of the log file
-our $synmsg = "Error";  # Global error message
+our $pbdebug = 0;       # Global debug level
+our $pbLOG = \*STDOUT;  # File descriptor of the log file
+our $pbsynmsg = "Error";    # Global error message
+our $pbdisplaytype = "text";
+                        # default display mode for messages
+our $pblocale = "C";
 
 our @ISA = qw(Exporter);
-our @EXPORT = qw(pb_mkdir_p pb_system pb_rm_rf pb_get_date pb_log pb_log_init pb_get_uri pb_get_content pb_display_file pb_syntax_init pb_syntax pb_temp_init $debug $LOG);
+our @EXPORT = qw(pb_mkdir_p pb_system pb_rm_rf pb_get_date pb_log pb_log_init pb_display pb_display_init pb_get_uri pb_get_content pb_display_file pb_syntax_init pb_syntax pb_temp_init $pbdebug $pbLOG $pbdisplaytype $pblocale);
 
 =pod
@@ -79 +85 @@
   pb_log_init(2,\*STDOUT);
   pb_log(1,"Message to print\n");
+
+  #
+  # Manages prints of the program
+  #
+  pb_display_init("text","fr_FR:UTF-8");
+  pb_display("Message to print\n");
 
   #
@@ -220 +232 @@
 sub pb_log_init {
 
-$debug = shift || 0;
-$LOG = shift || \*STDOUT;
-pb_log(1,"Debug value: $debug\n");
+$pbdebug = shift || 0;
+$pbLOG = shift || \*STDOUT;
+pb_log(1,"Debug value: $pbdebug\n");
 
 } 
@@ -249 +261 @@
 my $msg = shift;
 
-print $LOG "$msg" if ($dlevel <= $debug);
+print $pbLOG "$msg" if ($dlevel <= $pbdebug);
+}
+
+
+=item B<pb_display_init>
+
+This function initializes the environment used by the pb_display function.
+
+The first parameter is the type of display which will be used. Could be "text", "web", "newt",...
+The second parameter is the loacle to be used.
+
+The call to B<pb_display_init> is typically done after getting a parameter on the CLI indicating the locale used or the type of interface to report messages to.
+
+=cut
+
+sub pb_display_init {
+
+$pbdisplaytype = shift || "text";
+$pblocale = shift || "C";
+
+setlocale(LC_ALL, $pblocale);
+pb_log(1,"Using $pbdisplaytype interface with $pblocale locale\n");
+
+if ($pbdisplaytype =~ /text/) {
+} elsif ($pbdisplaytype = /newt/) {
+} else {
+    die "display system $pbdisplaytype unsupported";
+}
+}
+
+=item B<pb_display>
+
+This function prints the messages passed as parameter using the configuration set up with the B<pb_display_init> function.
+
+Here is a usage example:
+
+  pb_display_init("text","fr_FR.UTF-8");
+  pb_display("Hello World\n");
+
+  will print:
+  
+  Bonjour Monde
+
+=cut 
+
+sub pb_display {
+
+my $msg = shift;
+
+if ($pbdisplaytype =~ /text/) {
+    print STDOUT gettext($msg);
+    }
 }
 
@@ -298 +361 @@
 sub pb_syntax_init {
 
-$synmsg = shift || "Error";
+$pbsynmsg = shift || "Error";
 }
 
@@ -320 +383 @@
 $filehandle = \*STDOUT if ($exit_status == 0);
 
-pod2usage( { -message => $synmsg,
+pod2usage( { -message => $pbsynmsg,
              -exitval => $exit_status  ,
              -verbose => $verbose_level,