ChangeLogTag: Fri Jul 18 16:03:52 UTC 2008 Chad Elliott <elliott_c@ociweb.com>

1 files changed, 40 insertions, 15 deletions

diff --git a/create_base.pl b/create_base.pl
index 33774c7b..85f1fe8b 100755
--- a/create_base.pl
+++ b/create_base.pl
@@ -46,28 +46,44 @@ sub gather_info {
     my @lines = ();
     my $pname = undef;
     while(<$fh>) {
+      ## Get the line a remove leading and trailing white space
       my $line = $_;
       $line =~ s/^\s+//;
       $line =~ s/\s+$//;
 
+      ## Look for the project declaration and pull out the name and any
+      ## parents.
       if ($line =~ /^project\s*(\(([^\)]+)\))?\s*(:.+)?\s*{$/) {
         $pname = $2;
         my $parents = $3 || '';
+
+        ## Create the default project name by removing the extension and
+        ## converting back-slashes, spaces and dashes to underscores.
+        ## This needs to be done regardless of whether the project name
+        ## was provided or not since it's used below in the
+        ## fill_type_name call.
         my $def = basename($name);
         $def =~ s/\.[^\.]+$//;
         $def =~ s/\\/_/g;
         $def =~ s/[\s\-]/_/g;
+
         if (!defined $pname || $pname eq '') {
+          ## Take the default project name since one wasn't provided.
           $pname = $def;
         }
         else {
+          ## Convert back-slashes, spaces and dashes to underscores.
           $pname =~ s/\\/_/g;
           $pname =~ s/[\s\-]/_/g;
         }
+
+        ## If the project has a '*' we need to have MPC fix that up for
+        ## us.
         $pname = Creator::fill_type_name(undef, $pname, $def);
         push(@lines, "project$parents {");
       }
       elsif ($line =~ /^(shared|static)name\s*=\s*(.+)$/) {
+        ## Add in the libs and after settings.
         my $lib = $2;
         if (defined $pname && $lib ne '') {
           push(@lines, "  libs  += $2",
@@ -79,6 +95,10 @@ sub gather_info {
     }
     close($fh);
 
+    ## Only return the lines if there is more than one line.  It is
+    ## possible (and likely) that we've read in the project declaration,
+    ## but the project did not contain a sharedname or staticname
+    ## setting.
     return @lines if ($#lines > 0);
   }
 
@@ -90,16 +110,18 @@ sub write_base {
   my @lines = gather_info($in);
 
   if ($#lines >= 0) {
-    my $fh = new FileHandle();
     if (-r $out) {
       print STDERR "ERROR: $out already exists\n";
     }
     else {
+      my $fh = new FileHandle();
       if (open($fh, ">$out")) {
         foreach my $line (@lines) {
           print $fh "$line\n";
         }
         close($fh);
+
+        ## Everything was ok, return zero.
         return 0;
       }
       else {
@@ -116,17 +138,17 @@ sub write_base {
     }
   }
 
+  ## Non-zero indicates an error (as in the shell $? value).
   return 1;
 }
 
 sub usageAndExit {
   my $str = shift;
-  if (defined $str) {
-    print STDERR "$str\n";
-  }
+  print STDERR "$str\n" if (defined $str);
   print STDERR "Create Base Project v$version\n",
                "Usage: ", basename($0), " <mpc files> <output file or ",
-               "directory>\n";
+               "directory>\n\nThis is only useful if the project ",
+               "explictly sets sharedname or staticname.\n";
   exit(0);
 }
 
@@ -135,11 +157,15 @@ sub usageAndExit {
 # ******************************************************************
 
 if ($#ARGV > 1) {
+  ## Get the last argument and make sure it's a directory.
   my $dir = pop(@ARGV);
   if (!-d $dir) {
     usageAndExit("Creating multiple base projects, but the " .
                  "last argument, $dir, is not a directory");
   }
+
+  ## Process each input file and create the base project with an implicit
+  ## base project file name.
   my $status = 0;
   foreach my $input (@ARGV) {
     my $output = $dir . '/' . lc(basename($input));
@@ -152,20 +178,19 @@ else {
   my $input  = shift;
   my $output = shift;
 
-  if (!defined $input) {
-    usageAndExit();
-  }
-  elsif (index($input, '-') == 0) {
-    usageAndExit();
-  }
+  ## Print the usage and exit if there is no input, output or the input
+  ## file looks like an option.
+  usageAndExit() if (!defined output ||
+                     !defined $input || index($input, '-') == 0);
 
-  if (!defined $output) {
-    usageAndExit();
-  }
-  elsif (-d $output) {
+  ## If the output file is a directory, we will create the output file
+  ## name based on the input file.
+  if (-d $output) {
     $output .= '/' . lc(basename($input));
     $output =~ s/mpc$/mpb/;
   }
 
+  ## Create the base project and return the status to the caller of the
+  ## script.
   exit(write_base($input, $output));
 }