CommandOptionParser.hpp

Go to the documentation of this file.

//==============================================================================
//
//  This file is part of GNSSTk, the ARL:UT GNSS Toolkit.
//
//  The GNSSTk is free software; you can redistribute it and/or modify
//  it under the terms of the GNU Lesser General Public License as published
//  by the Free Software Foundation; either version 3.0 of the License, or
//  any later version.
//
//  The GNSSTk is distributed in the hope that it will be useful,
//  but WITHOUT ANY WARRANTY; without even the implied warranty of
//  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
//  GNU Lesser General Public License for more details.
//
//  You should have received a copy of the GNU Lesser General Public
//  License along with GNSSTk; if not, write to the Free Software Foundation,
//  Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110, USA
//
//  This software was developed by Applied Research Laboratories at the
//  University of Texas at Austin.
//  Copyright 2004-2022, The Board of Regents of The University of Texas System
//
//==============================================================================
 
//==============================================================================
//
//  This software was developed by Applied Research Laboratories at the
//  University of Texas at Austin, under contract to an agency or agencies
//  within the U.S. Department of Defense. The U.S. Government retains all
//  rights to use, duplicate, distribute, disclose, or release this software.
//
//  Pursuant to DoD Directive 523024
//
//  DISTRIBUTION STATEMENT A: This software has been approved for public
//                            release, distribution is unlimited.
//
//==============================================================================
 
#ifndef COMMANDOPTIONPARSER_HPP
#define COMMANDOPTIONPARSER_HPP
 
#include "CommandOption.hpp"
 
#include <cstring>
#include <vector>
#include <map>
#include <ostream>
 
namespace gnsstk
{
 
 
   class CommandOptionParser
   {
   public:
      typedef std::map<std::string, gnsstk::CommandOption*> CommandOptionMap;
 
      CommandOptionParser(const std::string& description,
                          const CommandOptionVec& optList =
                          defaultCommandOptionList);
 
      CommandOptionParser& addOption(gnsstk::CommandOption& co);
 
      void parseOptions(int argc, char* argv[]);
 
      bool hasErrors() { return !errorStrings.empty(); }
      std::ostream& dumpErrors(std::ostream& out);
      bool helpRequested() { return !helpOptions.empty(); }
      std::ostream& printHelp(std::ostream& out, bool doPretty = true,
                              bool firstOnly = true);
 
      std::ostream& displayUsage(std::ostream& out, bool doPretty=true);
 
      std::ostream& displayUsageDoxygen(std::ostream& out);
 
   private:
      void resizeOptionArray(struct option* &oldArray, unsigned long& oldSize);
 
      CommandOptionVec optionVec;
      std::vector<std::string> errorStrings;
         //std::vector<std::string> remainingArguments;
 
      bool hasRequiredArguments;
      bool hasOptionalArguments;
 
      std::string text;
 
      std::string progName;
 
      std::vector<CommandOptionHelp*> helpOptions;
   };
}
 
#endif