include/tdbutil/arguments.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2004 MAK Technologies, Inc.
** All rights reserved.
*******************************************************************************/
/*******************************************************************************
** $RCSfile: arguments.h,v $ $Revision: 1.2 $ $State: Exp $
*******************************************************************************/
#ifndef arguments_H_
#define arguments_H_

//
// \file arguments.h
// \brief This file contains the declaration of the DtArguments class.
//

#include "tdbutil/tdbUtilDefines.h"
#include <vlutil/vlConfig.h>
#include <list>
#include <string>


//
// Class to create a list of arguments from specified source.  It serves to abstract 
// away the original source of the arguments (argc/argv, a string, a file, etc).
// Currently, only processes a command line (argc/argv), but could easily be extended 
// to process a file, string, etc.
class DT_DLL_tdbutil DtArguments
{
public:
   typedef std::string DtArgument;
   typedef std::list<DtArgument> DtArgumentContainer;
   typedef DtArgumentContainer::iterator DtArgumentIter;
   typedef DtArgumentContainer::const_iterator DtArgumentConstIter;

   // Reads the arguments from the old argc/argv convention for int main().
   // \note The program name, is @b not read into the arguments list as it is
   // not considered an argument.  If needed, the user should read that 
   // out of argv[0] them self.
   DtArguments(int argc, const char *argv[]);

   virtual ~DtArguments();

private:
   // not implemented
   DtArguments& operator=(const DtArguments& other);
   DtArguments(const DtArguments& other);


public:

   DtArgumentConstIter begin() const;
   DtArgumentConstIter end() const;

   unsigned numArguments() const;


private:

   void addArgument(const std::string& argument);

   // the list of arguments, in order specified
   DtArgumentContainer myArguments;
};
   

#endif