ArgumentParser.h

Go to the documentation of this file.

/*
 * Copyright (C) 2015 Niek Linnenbank
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
 
#ifndef __LIBAPP_ARGUMENTPARSER_H
#define __LIBAPP_ARGUMENTPARSER_H
 
#include <Types.h>
#include <Macros.h>
#include <String.h>
#include <HashTable.h>
#include <Vector.h>
#include "Argument.h"
#include "ArgumentContainer.h"
 
class ArgumentParser
{
  public:
 
    enum Result
    {
        Success,
        InvalidArgument,
        NotFound,
        AlreadyExists
    };
 
  public:
 
    ArgumentParser();
 
    virtual ~ArgumentParser();
 
    String getUsage() const;
 
    const String & name() const;
 
    void setName(const char *name);
 
    void setDescription(const String & desc);
 
    Result registerFlag(char arg,
                        const char *name,
                        const char *description);
 
    Result registerPositional(const char *name,
                              const char *description,
                              Size count = 1);
 
    Result parse(int argc,
                 char **argv,
                 ArgumentContainer & output);
 
  private:
 
    HashTable<String, Argument *> m_flags;
 
    HashTable<String, Argument *> m_flagsId;
 
    Vector<Argument *> m_positionals;
 
    String m_name;
 
    String m_description;
};
 
#endif /* __LIBAPP_ARGUMENTPARSER_H */