Changeset 4749

Timestamp:

2003-06-23T11:50:45+12:00 (21 years ago)

Author:

mdewsnip

Message:

First cut at changing pluginfo to use the data structures added to each plugin containing a description of their parameters. Pluginfo now shows options all the way up the plugin hierarchy (not just the plugin and BasPlug). The code for generating the usage text from the data structures is in BasPlug.pm.

File:

• trunk/gsdl/bin/script/pluginfo.pl (modified) (2 diffs)

trunk/gsdl/bin/script/pluginfo.pl

@@ -51 +51 @@
     print STDERR "                             it will look in the general perllib/plugins\n";
     print STDERR "                             directory\n";
-     print STDERR "   -xml                      Produces the information in an xml form, without\n";
-     print STDERR "                             'pretty' comments but with much more detail.\n";
+    print STDERR "   -xml                      Produces the information in an xml form, without\n";
+    print STDERR "                             'pretty' comments but with much more detail.\n";
 }
 
@@ -60 +60 @@
 sub main {
     my $collect = "";
-     my $xml = 0;
+    my $xml = 0;
 
     if (!parsargv::parse(\@ARGV, q^collect/.*/^, \$collect, q^xml^, \$xml )) 
-     {
-          &print_usage();
-          die "\n";
-     }
+    {
+    &print_usage();
+    die "\n";
+    }
 
     my $plugin = shift (@ARGV);
     if (!defined $plugin || $plugin eq "") {
-          print STDERR "You must provide a plugin name\n";
-          &print_usage();
-          die "\n";
+    print STDERR "You must provide a plugin name\n";
+    &print_usage();
+    die "\n";
     }
 
     if ($collect ne "") {
-          $ENV{'GSDLCOLLECTDIR'} = &util::filename_cat ($ENV{'GSDLHOME'}, "collect", $collect);
+    $ENV{'GSDLCOLLECTDIR'} = &util::filename_cat ($ENV{'GSDLHOME'}, "collect", $collect);
     } else {
-          $ENV{'GSDLCOLLECTDIR'} = $ENV{'GSDLHOME'};
+    $ENV{'GSDLCOLLECTDIR'} = $ENV{'GSDLHOME'};
     }
 
-     my $pluginfo = &plugin::load_plugins ([[$plugin]]);
+    my $pluginfo = &plugin::load_plugins ([[$plugin]]);
      
-     my $plugobj = shift @$pluginfo;
+    my $plugobj = shift @$pluginfo;
 
-     if ($xml) {     
+    if ($xml) {  
         $plugobj->print_xml_usage();
-     }
-     else 
-     {
-          my $pluginfo = &plugin::load_plugins ([[$plugin]]);
-     
-          my $plugobj = shift @$pluginfo;
-     
-          print STDERR "\n$plugin info:\n\n";
-    
-          print STDERR "Options may be passed to any plugin by including them in your collect.cfg\n";
-          print STDERR "configuration file.\n\n";
-          
-          print STDERR "Plugins may take two types of options:\n\n";
-          
-          print STDERR "General options are defined within the base class (BasPlug.pm) and are\n";
-          print STDERR "inherited by any plugin that has been correctly derived from BasPlug.\n\n";
+    }
+    else {
+    my $pluginfo = &plugin::load_plugins ([[$plugin]]);
 
-          print STDERR "Specific options are defined within the plugin itself and are available\n";
-          print STDERR "only to this particular plugin.\n\n";
-          
-          print STDERR "$plugin takes the following specific options:\n";
-          
-          $plugobj->print_usage();
-          
-          print STDERR "$plugin takes the following general options\n";
-          &BasPlug::print_general_usage($plugin);
-          
-          print STDERR "The default process_exp for $plugin is\n";
-          print STDERR "\"" . $plugobj->get_default_process_exp() . "\"\n\n";
-          
-          print STDERR "The default block_exp for $plugin is\n";
-          print STDERR "\"" . $plugobj->get_default_block_exp() . "\"\n\n";
-     }
+    my $plugobj = shift @$pluginfo;
+
+    print STDERR "\n$plugin info:\n\n";
+
+    print STDERR "Options may be passed to any plugin by including them in your collect.cfg\n";
+    print STDERR "configuration file.\n\n";
+
+    print STDERR "Plugins may take two types of options:\n\n";
+
+    print STDERR "Specific options are defined within the plugin itself, and are available\n";
+    print STDERR "only to this particular plugin.\n\n";
+
+    print STDERR "General options are inherited from parent classes of the plugin.\n\n";
+#   print STDERR "General options are defined within the base class (BasPlug.pm) and are\n";
+#   print STDERR "inherited by any plugin that has been correctly derived from BasPlug.\n\n";
+
+#   print STDERR "$plugin takes the following specific options:\n";
+    # $plugobj->print_usage();
+    $plugobj->new_print_usage();
+
+#   print STDERR "$plugin takes the following general options:\n";
+#   &BasPlug::print_general_usage($plugin);
+
+#   print STDERR " The default process_exp for $plugin is: ";
+#   print STDERR "\"" . $plugobj->get_default_process_exp() . "\"\n\n";
+
+#   print STDERR " The default block_exp for $plugin is: ";
+#   print STDERR "\"" . $plugobj->get_default_block_exp() . "\"\n\n";
+    }
 }