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

// -*- mode: cpp; mode: fold -*-
// Description								/*{{{*/
// $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 <apt-pkg/cmndline.h>
#include <apt-pkg/error.h>
#include <apt-pkg/strutl.h>

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

// CommandLine::CommandLine - Constructor				/*{{{*/
// ---------------------------------------------------------------------
/* */
CommandLine::CommandLine(Args *AList,Configuration *Conf) : ArgList(AList), 
                                 Conf(Conf), FileList(0)
{
}
									/*}}}*/
// CommandLine::~CommandLine - Destructor				/*{{{*/
// ---------------------------------------------------------------------
/* */
CommandLine::~CommandLine()
{
   delete [] FileList;
}
									/*}}}*/
// CommandLine::Parse - Main action member				/*{{{*/
// ---------------------------------------------------------------------
/* */
bool CommandLine::Parse(int argc,const char **argv)
{
   delete [] FileList;
   FileList = new const char *[argc];
   const char **Files = FileList;
   int I;
   for (I = 1; I != argc; I++)
   {
      const char *Opt = argv[I];
      
      // It is not an option
      if (*Opt != '-')
      {
	 *Files++ = Opt;
	 continue;
      }
      
      Opt++;
      
      // Double dash signifies the end of option processing
      if (*Opt == '-' && Opt[1] == 0)
      {
	 I++;
	 break;
      }
      
      // Single dash is a short option
      if (*Opt != '-')
      {
	 // Iterate over each letter
	 while (*Opt != 0)
	 {	    
	    // Search for the option
	    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]);

	    if (HandleOpt(I,argc,argv,Opt,A) == false)
	       return false;
	    if (*Opt != 0)
	       Opt++;	       
	 }
	 continue;
      }
      
      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++);
      
      // 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++;
	 
	 for (A = ArgList; A->end() == false &&
	      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]);

	 // The option could be a single letter option prefixed by a no-..
	 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]);
	 }
	 
	 // The option is not boolean
	 if (A->IsBoolean() == false)
	    return _error->Error(_("Command line option %s is not boolean"),argv[I]);
	 PreceedMatch = true;
      }
      
      // Deal with it.
      OptEnd--;
      if (HandleOpt(I,argc,argv,OptEnd,A,PreceedMatch) == false)
	 return false;
   }
   
   // Copy any remaining file names over
   for (; I != argc; I++)
      *Files++ = argv[I];
   *Files = 0;
   
   return true;
}
									/*}}}*/
// CommandLine::HandleOpt - Handle a single option including all flags	/*{{{*/
// ---------------------------------------------------------------------
/* This is a helper function for parser, it looks at a given argument
   and looks for specific patterns in the string, it gets tokanized
   -ruffly- like -*[yes|true|enable]-(o|longopt)[=][ ][argument] */
bool CommandLine::HandleOpt(int &I,int argc,const char *argv[],
			    const char *&Opt,Args *A,bool PreceedMatch)
{
   const char *Argument = 0;
   bool CertainArg = false;
   int IncI = 0;

   /* Determine the possible location of an option or 0 if their is
      no option */
   if (Opt[1] == 0 || (Opt[1] == '=' && Opt[2] == 0))
   {
      if (I + 1 < argc && argv[I+1][0] != '-')
	 Argument = argv[I+1];
      
      // Equals was specified but we fell off the end!
      if (Opt[1] == '=' && Argument == 0)
	 return _error->Error(_("Option %s requires an argument."),argv[I]);
      if (Opt[1] == '=')
	 CertainArg = true;
	 
      IncI = 1;
   }
   else
   {
      if (Opt[1] == '=')
      {
	 CertainArg = true;
	 Argument = Opt + 2;
      }      
      else
	 Argument = Opt + 1;
   }
   
   // Option is an argument set
   if ((A->Flags & HasArg) == HasArg)
   {
      if (Argument == 0)
	 return _error->Error(_("Option %s requires an argument."),argv[I]);
      Opt += strlen(Opt);
      I += IncI;
      
      // Parse a configuration file
      if ((A->Flags & ConfigFile) == ConfigFile)
	 return ReadConfigFile(*Conf,Argument);

      // Arbitary 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 specification must have an =<val>."),argv[I]);

	 // = is trailing
	 if (J[1] == 0)
	 {
	    if (I+1 >= argc)
	       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
	    Conf->Set(string(Argument,J-Argument),string(J+1));
	 
	 return true;
      }
      
      const char *I = A->ConfName;
      for (; *I != 0 && *I != ' '; I++);
      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;
   }
   
   // Option is an integer level
   if ((A->Flags & IntLevel) == IntLevel)
   {
      // There might be an argument
      if (Argument != 0)
      {
	 char *EndPtr;
	 unsigned long Value = strtol(Argument,&EndPtr,10);
	 
	 // 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);

	 // Conversion was ok, set the value and return
	 if (EndPtr != 0 && EndPtr != Argument && *EndPtr == 0)
	 {
	    Conf->Set(A->ConfName,Value);
	    Opt += strlen(Opt);
	    I += IncI;
	    return true;
	 }	 
      }      
      
      // Increase the level
      Conf->Set(A->ConfName,Conf->FindI(A->ConfName)+1);
      return true;
   }
  
   // Option is a boolean
   int Sense = -1;  // -1 is unspecified, 0 is yes 1 is no

   // Look for an argument.
   while (1)
   {
      // Look at preceeding text
      char Buffer[300];
      if (Argument == 0)
      {
	 if (PreceedMatch == false)
	    break;
	 
	 if (strlen(argv[I]) >= sizeof(Buffer))
	    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)
	 {
	    strncpy(Buffer,J,JEnd - J);
	    Buffer[JEnd - J] = 0;
	    Argument = Buffer;
	    CertainArg = true;
	 }	 
	 else
	    break;
      }

      // Check for boolean
      Sense = StringToBool(Argument);
      if (Sense >= 0)
      {
	 // Eat the argument	 
	 if (Argument != Buffer)
	 {
	    Opt += strlen(Opt);
	    I += IncI;
	 }	 
	 break;
      }

      if (CertainArg == true)
	 return _error->Error(_("Sense %s is not understood, try true or false."),Argument);
      
      Argument = 0;
   }
      
   // Indeterminate sense depends on the flag
   if (Sense == -1)
   {
      if ((A->Flags & InvBoolean) == InvBoolean)
	 Sense = 0;
      else
	 Sense = 1;
   }
   
   Conf->Set(A->ConfName,Sense);
   return true;
}
									/*}}}*/
// CommandLine::FileSize - Count the number of filenames		/*{{{*/
// ---------------------------------------------------------------------
/* */
unsigned int CommandLine::FileSize() const
{
   unsigned int Count = 0;
   for (const char **I = FileList; I != 0 && *I != 0; I++)
      Count++;
   return Count;
}
									/*}}}*/
// CommandLine::DispatchArg - Do something with the first arg		/*{{{*/
// ---------------------------------------------------------------------
/* */
bool CommandLine::DispatchArg(Dispatch *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;
}
									/*}}}*/
Commit	Line	Data
08e8f724 AL	1	// -- mode: cpp; mode: fold --
08e8f724 AL	2	// Description /{{{/
bac2e715	3	// $Id: cmndline.cc,v 1.15 2003/02/10 01:40:58 doogie Exp $
08e8f724 AL	4	/* ######################################################################
	5
	6	Command Line Class - Sophisticated command line parser
	7
7da2b375 AL	8	This source is placed in the Public Domain, do with it what you will
	9	It was originally written by Jason Gunthorpe <jgg@debian.org>.
	10
08e8f724 AL	11	##################################################################### */
	12	/}}}/
	13	// Include files /{{{/
	14	#ifdef __GNUG__
	15	#pragma implementation "apt-pkg/cmndline.h"
	16	#endif
	17	#include <apt-pkg/cmndline.h>
	18	#include <apt-pkg/error.h>
cdcc6d34	19	#include <apt-pkg/strutl.h>
b2e465d6 AL	20
b2e465d6 AL	21	#include <apti18n.h>
08e8f724	22	/}}}/
584e4558	23	using namespace std;
08e8f724 AL	24
	25	// CommandLine::CommandLine - Constructor /{{{/
	26	// ---------------------------------------------------------------------
	27	/* */
	28	CommandLine::CommandLine(Args AList,Configuration Conf) : ArgList(AList),
	29	Conf(Conf), FileList(0)
	30	{
e1b74f61 AL	31	}
	32	/}}}/
	33	// CommandLine::~CommandLine - Destructor /{{{/
	34	// ---------------------------------------------------------------------
	35	/* */
	36	CommandLine::~CommandLine()
	37	{
	38	delete [] FileList;
08e8f724 AL	39	}
	40	/}}}/
	41	// CommandLine::Parse - Main action member /{{{/
	42	// ---------------------------------------------------------------------
	43	/* */
	44	bool CommandLine::Parse(int argc,const char **argv)
	45	{
e1b74f61	46	delete [] FileList;
08e8f724 AL	47	FileList = new const char *[argc];
	48	const char **Files = FileList;
	49	int I;
	50	for (I = 1; I != argc; I++)
	51	{
	52	const char *Opt = argv[I];
	53
	54	// It is not an option
	55	if (*Opt != '-')
	56	{
	57	*Files++ = Opt;
	58	continue;
	59	}
	60
	61	Opt++;
	62
	63	// Double dash signifies the end of option processing
	64	if (*Opt == '-' && Opt[1] == 0)
343bd48e AL	65	{
343bd48e AL	66	I++;
08e8f724	67	break;
343bd48e	68	}
08e8f724 AL	69
	70	// Single dash is a short option
	71	if (*Opt != '-')
	72	{
	73	// Iterate over each letter
	74	while (*Opt != 0)
	75	{
	76	// Search for the option
	77	Args *A;
	78	for (A = ArgList; A->end() == false && A->ShortOpt != *Opt; A++);
	79	if (A->end() == true)
b2e465d6	80	return _error->Error(_("Command line option '%c' [from %s] is not known."),*Opt,argv[I]);
08e8f724 AL	81
	82	if (HandleOpt(I,argc,argv,Opt,A) == false)
	83	return false;
	84	if (*Opt != 0)
	85	Opt++;
	86	}
	87	continue;
	88	}
	89
	90	Opt++;
	91
	92	// Match up to a = against the list
	93	const char *OptEnd = Opt;
	94	Args *A;
	95	for (; OptEnd != 0 && OptEnd != '='; OptEnd++);
	96	for (A = ArgList; A->end() == false &&
	97	stringcasecmp(Opt,OptEnd,A->LongOpt) != 0; A++);
	98
	99	// Failed, look for a word after the first - (no-foo)
0d47bd08	100	bool PreceedMatch = false;
08e8f724 AL	101	if (A->end() == true)
	102	{
	103	for (; Opt != OptEnd && *Opt != '-'; Opt++);
	104
	105	if (Opt == OptEnd)
b2e465d6	106	return _error->Error(_("Command line option %s is not understood"),argv[I]);
08e8f724 AL	107	Opt++;
	108
	109	for (A = ArgList; A->end() == false &&
	110	stringcasecmp(Opt,OptEnd,A->LongOpt) != 0; A++);
	111
	112	// Failed again..
	113	if (A->end() == true && OptEnd - Opt != 1)
b2e465d6	114	return _error->Error(_("Command line option %s is not understood"),argv[I]);
0d47bd08	115
08e8f724	116	// The option could be a single letter option prefixed by a no-..
08e8f724	117	if (A->end() == true)
0d47bd08 AL	118	{
	119	for (A = ArgList; A->end() == false && A->ShortOpt != *Opt; A++);
	120
	121	if (A->end() == true)
b2e465d6	122	return _error->Error(_("Command line option %s is not understood"),argv[I]);
0d47bd08	123	}
e1b74f61 AL	124
	125	// The option is not boolean
	126	if (A->IsBoolean() == false)
b2e465d6	127	return _error->Error(_("Command line option %s is not boolean"),argv[I]);
0d47bd08	128	PreceedMatch = true;
08e8f724 AL	129	}
	130
	131	// Deal with it.
	132	OptEnd--;
0d47bd08	133	if (HandleOpt(I,argc,argv,OptEnd,A,PreceedMatch) == false)
08e8f724 AL	134	return false;
	135	}
	136
	137	// Copy any remaining file names over
	138	for (; I != argc; I++)
	139	*Files++ = argv[I];
	140	*Files = 0;
	141
	142	return true;
	143	}
	144	/}}}/
	145	// CommandLine::HandleOpt - Handle a single option including all flags /{{{/
	146	// ---------------------------------------------------------------------
	147	/* This is a helper function for parser, it looks at a given argument
	148	and looks for specific patterns in the string, it gets tokanized
	149	-ruffly- like -[yes\|true\|enable]-(o\|longopt)[=][ ][argument] /
	150	bool CommandLine::HandleOpt(int &I,int argc,const char *argv[],
0d47bd08	151	const char &Opt,Args A,bool PreceedMatch)
08e8f724 AL	152	{
	153	const char *Argument = 0;
	154	bool CertainArg = false;
	155	int IncI = 0;
	156
	157	/* Determine the possible location of an option or 0 if their is
	158	no option */
	159	if (Opt[1] == 0 \|\| (Opt[1] == '=' && Opt[2] == 0))
	160	{
	161	if (I + 1 < argc && argv[I+1][0] != '-')
	162	Argument = argv[I+1];
	163
	164	// Equals was specified but we fell off the end!
	165	if (Opt[1] == '=' && Argument == 0)
b2e465d6	166	return _error->Error(_("Option %s requires an argument."),argv[I]);
08e8f724 AL	167	if (Opt[1] == '=')
	168	CertainArg = true;
	169
	170	IncI = 1;
	171	}
	172	else
	173	{
	174	if (Opt[1] == '=')
	175	{
	176	CertainArg = true;
	177	Argument = Opt + 2;
	178	}
	179	else
	180	Argument = Opt + 1;
	181	}
0d47bd08	182
08e8f724 AL	183	// Option is an argument set
	184	if ((A->Flags & HasArg) == HasArg)
	185	{
	186	if (Argument == 0)
b2e465d6	187	return _error->Error(_("Option %s requires an argument."),argv[I]);
08e8f724 AL	188	Opt += strlen(Opt);
	189	I += IncI;
	190
	191	// Parse a configuration file
	192	if ((A->Flags & ConfigFile) == ConfigFile)
	193	return ReadConfigFile(*Conf,Argument);
e1b74f61 AL	194
	195	// Arbitary item specification
	196	if ((A->Flags & ArbItem) == ArbItem)
	197	{
	198	const char *J;
	199	for (J = Argument; J != 0 && J != '='; J++);
	200	if (*J == 0)
bac2e715	201	return _error->Error(_("Option %s: Configuration item specification must have an =<val>."),argv[I]);
e1b74f61	202
7e798dd7 AL	203	// = is trailing
	204	if (J[1] == 0)
	205	{
	206	if (I+1 >= argc)
bac2e715	207	return _error->Error(_("Option %s: Configuration item specification must have an =<val>."),argv[I]);
7e798dd7 AL	208	Conf->Set(string(Argument,J-Argument),string(argv[I++ +1]));
	209	}
	210	else
	211	Conf->Set(string(Argument,J-Argument),string(J+1));
e1b74f61 AL	212
	213	return true;
	214	}
08e8f724	215
7f25bdff AL	216	const char *I = A->ConfName;
	217	for (; I != 0 && I != ' '; I++);
	218	if (*I == ' ')
	219	Conf->Set(string(A->ConfName,0,I-A->ConfName),string(I+1) + Argument);
	220	else
	221	Conf->Set(A->ConfName,string(I) + Argument);
	222
08e8f724 AL	223	return true;
	224	}
	225
	226	// Option is an integer level
	227	if ((A->Flags & IntLevel) == IntLevel)
	228	{
	229	// There might be an argument
	230	if (Argument != 0)
	231	{
	232	char *EndPtr;
	233	unsigned long Value = strtol(Argument,&EndPtr,10);
	234
	235	// Conversion failed and the argument was specified with an =s
	236	if (EndPtr == Argument && CertainArg == true)
b2e465d6	237	return _error->Error(_("Option %s requires an integer argument, not '%s'"),argv[I],Argument);
08e8f724 AL	238
08e8f724 AL	239	// Conversion was ok, set the value and return
9435cc9b	240	if (EndPtr != 0 && EndPtr != Argument && *EndPtr == 0)
08e8f724 AL	241	{
	242	Conf->Set(A->ConfName,Value);
	243	Opt += strlen(Opt);
	244	I += IncI;
	245	return true;
	246	}
	247	}
	248
	249	// Increase the level
	250	Conf->Set(A->ConfName,Conf->FindI(A->ConfName)+1);
	251	return true;
	252	}
	253
	254	// Option is a boolean
	255	int Sense = -1; // -1 is unspecified, 0 is yes 1 is no
	256
	257	// Look for an argument.
	258	while (1)
	259	{
	260	// Look at preceeding text
	261	char Buffer[300];
	262	if (Argument == 0)
	263	{
0d47bd08 AL	264	if (PreceedMatch == false)
	265	break;
	266
08e8f724	267	if (strlen(argv[I]) >= sizeof(Buffer))
b2e465d6	268	return _error->Error(_("Option '%s' is too long"),argv[I]);
0d47bd08 AL	269
0d47bd08 AL	270	// Skip the leading dash
08e8f724 AL	271	const char *J = argv[I];
08e8f724 AL	272	for (; J != 0 && J == '-'; J++);
0d47bd08	273
08e8f724 AL	274	const char *JEnd = J;
	275	for (; JEnd != 0 && JEnd != '-'; JEnd++);
	276	if (*JEnd != 0)
	277	{
	278	strncpy(Buffer,J,JEnd - J);
	279	Buffer[JEnd - J] = 0;
	280	Argument = Buffer;
	281	CertainArg = true;
	282	}
	283	else
	284	break;
	285	}
	286
3b5421b4 AL	287	// Check for boolean
	288	Sense = StringToBool(Argument);
	289	if (Sense >= 0)
08e8f724	290	{
08e8f724 AL	291	// Eat the argument
	292	if (Argument != Buffer)
	293	{
	294	Opt += strlen(Opt);
	295	I += IncI;
	296	}
	297	break;
	298	}
	299
08e8f724	300	if (CertainArg == true)
b2e465d6	301	return _error->Error(_("Sense %s is not understood, try true or false."),Argument);
08e8f724 AL	302
	303	Argument = 0;
	304	}
	305
	306	// Indeterminate sense depends on the flag
	307	if (Sense == -1)
	308	{
	309	if ((A->Flags & InvBoolean) == InvBoolean)
	310	Sense = 0;
	311	else
	312	Sense = 1;
	313	}
	314
	315	Conf->Set(A->ConfName,Sense);
	316	return true;
	317	}
	318	/}}}/
bc4af0b9	319	// CommandLine::FileSize - Count the number of filenames /{{{/
e1b74f61 AL	320	// ---------------------------------------------------------------------
	321	/* */
	322	unsigned int CommandLine::FileSize() const
	323	{
	324	unsigned int Count = 0;
	325	for (const char *I = FileList; I != 0 && I != 0; I++)
	326	Count++;
	327	return Count;
	328	}
	329	/}}}/
bc4af0b9 AL	330	// CommandLine::DispatchArg - Do something with the first arg /{{{/
	331	// ---------------------------------------------------------------------
	332	/* */
b0b4efb9	333	bool CommandLine::DispatchArg(Dispatch *Map,bool NoMatch)
bc4af0b9 AL	334	{
	335	int I;
	336	for (I = 0; Map[I].Match != 0; I++)
	337	{
	338	if (strcmp(FileList[0],Map[I].Match) == 0)
	339	{
	340	bool Res = Map[I].Handler(*this);
	341	if (Res == false && _error->PendingError() == false)
	342	_error->Error("Handler silently failed");
	343	return Res;
	344	}
	345	}
	346
	347	// No matching name
	348	if (Map[I].Match == 0)
b0b4efb9 AL	349	{
b0b4efb9 AL	350	if (NoMatch == true)
b2e465d6	351	_error->Error(_("Invalid operation %s"),FileList[0]);
b0b4efb9 AL	352	}
b0b4efb9 AL	353
bc4af0b9 AL	354	return false;
	355	}
	356	/}}}/