]> git.saurik.com Git - apt.git/blobdiff - apt-pkg/contrib/cmndline.cc
split up help messages for simpler reuse
[apt.git] / apt-pkg / contrib / cmndline.cc
index 629b8e9e5c099e94cc2f9e0356d726f01cf410d9..60ce90f1f839507d435f9fadbc8548fa25a59b6a 100644 (file)
@@ -1,20 +1,31 @@
 // -*- mode: cpp; mode: fold -*-
 // Description                                                         /*{{{*/
-// $Id: cmndline.cc,v 1.7 1998/12/14 02:23:47 jgg Exp $
+// $Id: cmndline.cc,v 1.15 2003/02/10 01:40:58 doogie Exp $
 /* ######################################################################
 
    Command Line Class - Sophisticated command line parser
    
+   This source is placed in the Public Domain, do with it what you will
+   It was originally written by Jason Gunthorpe <jgg@debian.org>.
+   
    ##################################################################### */
                                                                        /*}}}*/
 // Include files                                                       /*{{{*/
-#ifdef __GNUG__
-#pragma implementation "apt-pkg/cmndline.h"
-#endif
+#include<config.h>
+
+#include <apt-pkg/configuration.h>
 #include <apt-pkg/cmndline.h>
 #include <apt-pkg/error.h>
-#include <strutl.h>
+#include <apt-pkg/strutl.h>
+
+#include <stddef.h>
+#include <stdlib.h>
+#include <string.h>
+#include <string>
+
+#include <apti18n.h>
                                                                        /*}}}*/
+using namespace std;
 
 // CommandLine::CommandLine - Constructor                              /*{{{*/
 // ---------------------------------------------------------------------
@@ -22,6 +33,9 @@
 CommandLine::CommandLine(Args *AList,Configuration *Conf) : ArgList(AList), 
                                  Conf(Conf), FileList(0)
 {
+}
+CommandLine::CommandLine() : ArgList(NULL), Conf(NULL), FileList(0)
+{
 }
                                                                        /*}}}*/
 // CommandLine::~CommandLine - Destructor                              /*{{{*/
@@ -32,6 +46,82 @@ CommandLine::~CommandLine()
    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                             /*{{{*/
 // ---------------------------------------------------------------------
 /* */
@@ -56,7 +146,10 @@ bool CommandLine::Parse(int argc,const char **argv)
       
       // Double dash signifies the end of option processing
       if (*Opt == '-' && Opt[1] == 0)
+      {
+        I++;
         break;
+      }
       
       // Single dash is a short option
       if (*Opt != '-')
@@ -68,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)
-              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;
@@ -81,29 +174,28 @@ bool CommandLine::Parse(int argc,const char **argv)
       Opt++;
 
       // Match up to a = against the list
-      const char *OptEnd = Opt;
       Args *A;
-      for (; *OptEnd != 0 && *OptEnd != '='; OptEnd++);
-      for (A = ArgList; A->end() == false && 
-          stringcasecmp(Opt,OptEnd,A->LongOpt) != 0; A++);
+      const char *OptEnd = strchrnul(Opt, '=');
+      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;
       if (A->end() == true)
       {
-        for (; Opt != OptEnd && *Opt != '-'; Opt++);
-
-        if (Opt == OptEnd)
-           return _error->Error("Command line option %s is not understood",argv[I]);
+         Opt = (const char*) memchr(Opt, '-', OptEnd - Opt);
+        if (Opt == NULL)
+           return _error->Error(_("Command line option %s is not understood in combination with the other options"),argv[I]);
         Opt++;
-        cout << Opt << endl;
         
         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)
-           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)
@@ -111,12 +203,12 @@ bool CommandLine::Parse(int argc,const char **argv)
            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
         if (A->IsBoolean() == false)
-           return _error->Error("Command line option %s is not boolean",argv[I]);
+           return _error->Error(_("Command line option %s is not boolean"),argv[I]);
         PreceedMatch = true;
       }
       
@@ -130,7 +222,9 @@ bool CommandLine::Parse(int argc,const char **argv)
    for (; I != argc; I++)
       *Files++ = argv[I];
    *Files = 0;
-   
+
+   SaveInConfig(argc, argv);
+
    return true;
 }
                                                                        /*}}}*/
@@ -155,7 +249,7 @@ bool CommandLine::HandleOpt(int &I,int argc,const char *argv[],
       
       // Equals was specified but we fell off the end!
       if (Opt[1] == '=' && Argument == 0)
-        return _error->Error("Option %s requires an argument.",argv[I]);
+        return _error->Error(_("Option %s requires an argument."),argv[I]);
       if (Opt[1] == '=')
         CertainArg = true;
         
@@ -176,7 +270,7 @@ bool CommandLine::HandleOpt(int &I,int argc,const char *argv[],
    if ((A->Flags & HasArg) == HasArg)
    {
       if (Argument == 0)
-        return _error->Error("Option %s requires an argument.",argv[I]);
+        return _error->Error(_("Option %s requires an argument."),argv[I]);
       Opt += strlen(Opt);
       I += IncI;
       
@@ -184,19 +278,18 @@ bool CommandLine::HandleOpt(int &I,int argc,const char *argv[],
       if ((A->Flags & ConfigFile) == ConfigFile)
         return ReadConfigFile(*Conf,Argument);
 
-      // Arbitary item specification
+      // Arbitrary item specification
       if ((A->Flags & ArbItem) == ArbItem)
       {
-        const char *J;
-        for (J = Argument; *J != 0 && *J != '='; J++);
-        if (*J == 0)
-           return _error->Error("Option %s: Configuration item sepecification must have an =<val>.",argv[I]);
+        const char *J = strchr(Argument, '=');
+        if (J == NULL)
+           return _error->Error(_("Option %s: Configuration item specification must have an =<val>."),argv[I]);
 
         // = is trailing
         if (J[1] == 0)
         {
            if (I+1 >= argc)
-              return _error->Error("Option %s: Configuration item sepecification must have an =<val>.",argv[I]);
+              return _error->Error(_("Option %s: Configuration item specification must have an =<val>."),argv[I]);
            Conf->Set(string(Argument,J-Argument),string(argv[I++ +1]));
         }
         else
@@ -205,7 +298,12 @@ bool CommandLine::HandleOpt(int &I,int argc,const char *argv[],
         return true;
       }
       
-      Conf->Set(A->ConfName,Argument);
+      const char *I = strchrnul(A->ConfName, ' ');
+      if (*I == ' ')
+        Conf->Set(string(A->ConfName,0,I-A->ConfName),string(I+1) + Argument);
+      else
+        Conf->Set(A->ConfName,string(I) + Argument);
+        
       return true;
    }
    
@@ -220,10 +318,10 @@ bool CommandLine::HandleOpt(int &I,int argc,const char *argv[],
         
         // Conversion failed and the argument was specified with an =s
         if (EndPtr == Argument && CertainArg == true)
-           return _error->Error("Option %s requires an integer argument, not '%s'",argv[I],Argument);
+           return _error->Error(_("Option %s requires an integer argument, not '%s'"),argv[I],Argument);
 
         // Conversion was ok, set the value and return
-        if (EndPtr != Argument)
+        if (EndPtr != 0 && EndPtr != Argument && *EndPtr == 0)
         {
            Conf->Set(A->ConfName,Value);
            Opt += strlen(Opt);
@@ -243,7 +341,7 @@ bool CommandLine::HandleOpt(int &I,int argc,const char *argv[],
    // Look for an argument.
    while (1)
    {
-      // Look at preceeding text
+      // Look at preceding text
       char Buffer[300];
       if (Argument == 0)
       {
@@ -251,15 +349,14 @@ bool CommandLine::HandleOpt(int &I,int argc,const char *argv[],
            break;
         
         if (strlen(argv[I]) >= sizeof(Buffer))
-           return _error->Error("Option '%s' is too long",argv[I]);
+           return _error->Error(_("Option '%s' is too long"),argv[I]);
 
         // Skip the leading dash
         const char *J = argv[I];
         for (; *J != 0 && *J == '-'; J++);
-        
-        const char *JEnd = J;
-        for (; *JEnd != 0 && *JEnd != '-'; JEnd++);
-        if (*JEnd != 0)
+
+        const char *JEnd = strchr(J, '-');
+        if (JEnd != NULL)
         {
            strncpy(Buffer,J,JEnd - J);
            Buffer[JEnd - J] = 0;
@@ -284,7 +381,7 @@ bool CommandLine::HandleOpt(int &I,int argc,const char *argv[],
       }
 
       if (CertainArg == true)
-        return _error->Error("Sense %s is not understood, try true or false.",Argument);
+        return _error->Error(_("Sense %s is not understood, try true or false."),Argument);
       
       Argument = 0;
    }
@@ -314,8 +411,29 @@ unsigned int CommandLine::FileSize() const
 }
                                                                        /*}}}*/
 // 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;
@@ -334,9 +452,59 @@ bool CommandLine::DispatchArg(Dispatch *Map,bool NoMatch)
    if (Map[I].Match == 0)
    {
       if (NoMatch == true)
-        _error->Error("Invalid operation %s",FileList[0]);
+        _error->Error(_("Invalid operation %s"),FileList[0]);
    }
    
    return false;
 }
                                                                        /*}}}*/
+// CommandLine::SaveInConfig - for output later in a logfile or so     /*{{{*/
+// ---------------------------------------------------------------------
+/* We save the commandline here to have it around later for e.g. logging.
+   It feels a bit like a hack here and isn't bulletproof, but it is better
+   than nothing after all. */
+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;
+   for (unsigned int i = 0; i < argc && length < sizeof(cmdline); ++i, ++length)
+   {
+      for (unsigned int j = 0; argv[i][j] != '\0' && length < sizeof(cmdline)-1; ++j, ++length)
+      {
+        cmdline[length] = argv[i][j];
+        if (lastWasOption == true && argv[i][j] == '=')
+        {
+           // That is possibly an option: Quote it if it includes spaces,
+           // the benefit is that this will eliminate also most false positives
+           const char* c = strchr(&argv[i][j+1], ' ');
+           if (c == NULL) continue;
+           cmdline[++length] = '"';
+           closeQuote = true;
+        }
+      }
+      if (closeQuote == true)
+        cmdline[length++] = '"';
+      // Problem: detects also --hello
+      if (cmdline[length-1] == 'o')
+        lastWasOption = true;
+      cmdline[length] = ' ';
+   }
+   cmdline[--length] = '\0';
+   _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;
+}
+                                                                       /*}}}*/