split up help messages for simpler reuse

[apt.git] / apt-pkg / contrib / cmndline.cc

diff --git a/apt-pkg/contrib/cmndline.cc b/apt-pkg/contrib/cmndline.cc
index 159f330a182488d35cf9a930f265e5def324a82e..60ce90f1f839507d435f9fadbc8548fa25a59b6a 100644 (file)
--- a/apt-pkg/contrib/cmndline.cc
+++ b/apt-pkg/contrib/cmndline.cc
@@ -18,6 +18,11 @@
 #include <apt-pkg/error.h>
 #include <apt-pkg/strutl.h>
 
 #include <apt-pkg/error.h>
 #include <apt-pkg/strutl.h>
 

+#include <stddef.h>
+#include <stdlib.h>
+#include <string.h>
+#include <string>
+

 #include <apti18n.h>
                                                                        /*}}}*/
 using namespace std;
 #include <apti18n.h>
                                                                        /*}}}*/
 using namespace std;


@@ -28,6 +33,9 @@ using namespace std;
 CommandLine::CommandLine(Args *AList,Configuration *Conf) : ArgList(AList), 
                                  Conf(Conf), FileList(0)
 {
 CommandLine::CommandLine(Args *AList,Configuration *Conf) : ArgList(AList), 
                                  Conf(Conf), FileList(0)
 {

+}
+CommandLine::CommandLine() : ArgList(NULL), Conf(NULL), FileList(0)
+{

 }
                                                                        /*}}}*/
 // CommandLine::~CommandLine - Destructor                              /*{{{*/
 }
                                                                        /*}}}*/
 // CommandLine::~CommandLine - Destructor                              /*{{{*/


@@ -38,6 +46,82 @@ CommandLine::~CommandLine()
    delete [] FileList;
 }
                                                                        /*}}}*/
    delete [] FileList;
 }
                                                                        /*}}}*/

+// CommandLine::GetCommand - return the first non-option word          /*{{{*/
+char const * CommandLine::GetCommand(Dispatch const * const Map,
+      unsigned int const argc, char const * const * const argv)
+{
+   // if there is a -- on the line there must be the word we search for either
+   // before it (as -- marks the end of the options) or right after it (as we can't
+   // decide if the command is actually an option, given that in theory, you could
+   // have parameters named like commands)
+   for (size_t i = 1; i < argc; ++i)
+   {
+      if (strcmp(argv[i], "--") != 0)
+        continue;
+      // check if command is before --
+      for (size_t k = 1; k < i; ++k)
+        for (size_t j = 0; Map[j].Match != NULL; ++j)
+           if (strcmp(argv[k], Map[j].Match) == 0)
+              return Map[j].Match;
+      // see if the next token after -- is the command
+      ++i;
+      if (i < argc)
+        for (size_t j = 0; Map[j].Match != NULL; ++j)
+           if (strcmp(argv[i], Map[j].Match) == 0)
+              return Map[j].Match;
+      // we found a --, but not a command
+      return NULL;
+   }
+   // no --, so search for the first word matching a command
+   // FIXME: How like is it that an option parameter will be also a valid Match ?
+   for (size_t i = 1; i < argc; ++i)
+   {
+      if (*(argv[i]) == '-')
+        continue;
+      for (size_t j = 0; Map[j].Match != NULL; ++j)
+        if (strcmp(argv[i], Map[j].Match) == 0)
+           return Map[j].Match;
+   }
+   return NULL;
+}
+char const * CommandLine::GetCommand(DispatchWithHelp const * const Map,
+      unsigned int const argc, char const * const * const argv)
+{
+   // if there is a -- on the line there must be the word we search for either
+   // before it (as -- marks the end of the options) or right after it (as we can't
+   // decide if the command is actually an option, given that in theory, you could
+   // have parameters named like commands)
+   for (size_t i = 1; i < argc; ++i)
+   {
+      if (strcmp(argv[i], "--") != 0)
+        continue;
+      // check if command is before --
+      for (size_t k = 1; k < i; ++k)
+        for (size_t j = 0; Map[j].Match != NULL; ++j)
+           if (strcmp(argv[k], Map[j].Match) == 0)
+              return Map[j].Match;
+      // see if the next token after -- is the command
+      ++i;
+      if (i < argc)
+        for (size_t j = 0; Map[j].Match != NULL; ++j)
+           if (strcmp(argv[i], Map[j].Match) == 0)
+              return Map[j].Match;
+      // we found a --, but not a command
+      return NULL;
+   }
+   // no --, so search for the first word matching a command
+   // FIXME: How like is it that an option parameter will be also a valid Match ?
+   for (size_t i = 1; i < argc; ++i)
+   {
+      if (*(argv[i]) == '-')
+        continue;
+      for (size_t j = 0; Map[j].Match != NULL; ++j)
+        if (strcmp(argv[i], Map[j].Match) == 0)
+           return Map[j].Match;
+   }
+   return NULL;
+}
+                                                                       /*}}}*/

 // CommandLine::Parse - Main action member                             /*{{{*/
 // ---------------------------------------------------------------------
 /* */
 // CommandLine::Parse - Main action member                             /*{{{*/
 // ---------------------------------------------------------------------
 /* */


@@ -77,7 +161,7 @@ bool CommandLine::Parse(int argc,const char **argv)
            Args *A;
            for (A = ArgList; A->end() == false && A->ShortOpt != *Opt; A++);
            if (A->end() == true)
            Args *A;
            for (A = ArgList; A->end() == false && A->ShortOpt != *Opt; A++);
            if (A->end() == true)

-              return _error->Error(_("Command line option '%c' [from %s] is not known."),*Opt,argv[I]);
+              return _error->Error(_("Command line option '%c' [from %s] is not understood in combination with the other options."),*Opt,argv[I]);

 
            if (HandleOpt(I,argc,argv,Opt,A) == false)
               return false;
 
            if (HandleOpt(I,argc,argv,Opt,A) == false)
               return false;


@@ -92,8 +176,9 @@ bool CommandLine::Parse(int argc,const char **argv)
       // Match up to a = against the list
       Args *A;
       const char *OptEnd = strchrnul(Opt, '=');
       // Match up to a = against the list
       Args *A;
       const char *OptEnd = strchrnul(Opt, '=');

-      for (A = ArgList; A->end() == false && 
-          stringcasecmp(Opt,OptEnd,A->LongOpt) != 0; A++);
+      for (A = ArgList; A->end() == false &&
+          (A->LongOpt == 0 || stringcasecmp(Opt,OptEnd,A->LongOpt) != 0);
+          ++A);

       
       // Failed, look for a word after the first - (no-foo)
       bool PreceedMatch = false;
       
       // Failed, look for a word after the first - (no-foo)
       bool PreceedMatch = false;


@@ -101,15 +186,16 @@ bool CommandLine::Parse(int argc,const char **argv)
       {
          Opt = (const char*) memchr(Opt, '-', OptEnd - Opt);
         if (Opt == NULL)
       {
          Opt = (const char*) memchr(Opt, '-', OptEnd - Opt);
         if (Opt == NULL)

-           return _error->Error(_("Command line option %s is not understood"),argv[I]);
+           return _error->Error(_("Command line option %s is not understood in combination with the other options"),argv[I]);

         Opt++;
         
         for (A = ArgList; A->end() == false &&
         Opt++;
         
         for (A = ArgList; A->end() == false &&

-             stringcasecmp(Opt,OptEnd,A->LongOpt) != 0; A++);
+             (A->LongOpt == 0 || stringcasecmp(Opt,OptEnd,A->LongOpt) != 0);
+             ++A);

 
         // Failed again..
         if (A->end() == true && OptEnd - Opt != 1)
 
         // Failed again..
         if (A->end() == true && OptEnd - Opt != 1)

-           return _error->Error(_("Command line option %s is not understood"),argv[I]);
+           return _error->Error(_("Command line option %s is not understood in combination with the other options"),argv[I]);

 
         // The option could be a single letter option prefixed by a no-..
         if (A->end() == true)
 
         // The option could be a single letter option prefixed by a no-..
         if (A->end() == true)


@@ -117,7 +203,7 @@ bool CommandLine::Parse(int argc,const char **argv)
            for (A = ArgList; A->end() == false && A->ShortOpt != *Opt; A++);
            
            if (A->end() == true)
            for (A = ArgList; A->end() == false && A->ShortOpt != *Opt; A++);
            
            if (A->end() == true)

-              return _error->Error(_("Command line option %s is not understood"),argv[I]);
+              return _error->Error(_("Command line option %s is not understood in combination with the other options"),argv[I]);

         }
         
         // The option is not boolean
         }
         
         // The option is not boolean


@@ -255,7 +341,7 @@ bool CommandLine::HandleOpt(int &I,int argc,const char *argv[],
    // Look for an argument.
    while (1)
    {
    // Look for an argument.
    while (1)
    {

-      // Look at preceeding text
+      // Look at preceding text

       char Buffer[300];
       if (Argument == 0)
       {
       char Buffer[300];
       if (Argument == 0)
       {


@@ -325,8 +411,29 @@ unsigned int CommandLine::FileSize() const
 }
                                                                        /*}}}*/
 // CommandLine::DispatchArg - Do something with the first arg          /*{{{*/
 }
                                                                        /*}}}*/
 // CommandLine::DispatchArg - Do something with the first arg          /*{{{*/

-// ---------------------------------------------------------------------
-/* */
+bool CommandLine::DispatchArg(DispatchWithHelp *Map,bool NoMatch)
+{
+   int I;
+   for (I = 0; Map[I].Match != 0; I++)
+   {
+      if (strcmp(FileList[0],Map[I].Match) == 0)
+      {
+        bool Res = Map[I].Handler(*this);
+        if (Res == false && _error->PendingError() == false)
+           _error->Error("Handler silently failed");
+        return Res;
+      }
+   }
+   
+   // No matching name
+   if (Map[I].Match == 0)
+   {
+      if (NoMatch == true)
+        _error->Error(_("Invalid operation %s"),FileList[0]);
+   }
+   
+   return false;
+}

 bool CommandLine::DispatchArg(Dispatch *Map,bool NoMatch)
 {
    int I;
 bool CommandLine::DispatchArg(Dispatch *Map,bool NoMatch)
 {
    int I;


@@ -359,6 +466,7 @@ bool CommandLine::DispatchArg(Dispatch *Map,bool NoMatch)
 void CommandLine::SaveInConfig(unsigned int const &argc, char const * const * const argv)
 {
    char cmdline[100 + argc * 50];
 void CommandLine::SaveInConfig(unsigned int const &argc, char const * const * const argv)
 {
    char cmdline[100 + argc * 50];

+   memset(cmdline, 0, sizeof(cmdline));

    unsigned int length = 0;
    bool lastWasOption = false;
    bool closeQuote = false;
    unsigned int length = 0;
    bool lastWasOption = false;
    bool closeQuote = false;


@@ -388,3 +496,15 @@ void CommandLine::SaveInConfig(unsigned int const &argc, char const * const * co
    _config->Set("CommandLine::AsString", cmdline);
 }
                                                                        /*}}}*/
    _config->Set("CommandLine::AsString", cmdline);
 }
                                                                        /*}}}*/

+CommandLine::Args CommandLine::MakeArgs(char ShortOpt, char const *LongOpt, char const *ConfName, unsigned long Flags)/*{{{*/
+{
+   /* In theory, this should be a constructor for CommandLine::Args instead,
+      but this breaks compatibility as gcc thinks this is a c++11 initializer_list */
+   CommandLine::Args arg;
+   arg.ShortOpt = ShortOpt;
+   arg.LongOpt = LongOpt;
+   arg.ConfName = ConfName;
+   arg.Flags = Flags;
+   return arg;
+}
+                                                                       /*}}}*/