gdalargumentparser.h

/******************************************************************************
 * Project:  GDAL Utilities
 * Purpose:  GDAL argument parser
 * Author:   Even Rouault <even.rouault at spatialys.com>
 *
 * ****************************************************************************
 * Copyright (c) 2024, Even Rouault <even.rouault at spatialys.com>
 *
 * Permission is hereby granted, free of charge, to any person obtaining a
 * copy of this software and associated documentation files (the "Software"),
 * to deal in the Software without restriction, including without limitation
 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
 * and/or sell copies of the Software, and to permit persons to whom the
 * Software is furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included
 * in all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
 * DEALINGS IN THE SOFTWARE.
 ****************************************************************************/
 
#ifndef GDALARGUMENTPARSER_H
#define GDALARGUMENTPARSER_H
 
#include "cpl_port.h"
#include "cpl_conv.h"
#include "cpl_string.h"
#include "gdal.h"
 
// Rename argparse namespace to a GDAL private one
#define argparse gdal_argparse
 
// Use our locale-unaware strtod()
#define ARGPARSE_CUSTOM_STRTOD CPLStrtodM
 
#ifdef _MSC_VER
#pragma warning(push)
// unreachable code
#pragma warning(disable : 4702)
#endif
 
#include "argparse/argparse.hpp"
 
#ifdef _MSC_VER
#pragma warning(pop)
#endif
 
using namespace argparse;
 
// Place-holder macro using gettext() convention to indicate (future) translatable strings
#ifndef _
#define _(x) (x)
#endif
 
class GDALArgumentParser : public ArgumentParser
{
  public:
    explicit GDALArgumentParser(const std::string &program_name,
                                bool bForBinary);
 
    std::string usage() const;
 
    void add_extra_usage_hint(const std::string &osExtraUsageHint);
 
    void display_error_and_usage(const std::exception &err);
 
    Argument &add_quiet_argument(bool *pVar);
 
    Argument &add_input_format_argument(CPLStringList *pvar);
 
    Argument &add_output_format_argument(std::string &var);
 
    Argument &add_creation_options_argument(CPLStringList &var);
 
    Argument &add_metadata_item_options_argument(CPLStringList &var);
 
    Argument &add_open_options_argument(CPLStringList &var);
 
    Argument &add_open_options_argument(CPLStringList *pvar);
 
    Argument &add_output_type_argument(GDALDataType &eDT);
 
    Argument &add_layer_creation_options_argument(CPLStringList &var);
 
    Argument &add_dataset_creation_options_argument(CPLStringList &var);
 
    void parse_args_without_binary_name(CSLConstList papszArgs);
 
    void parse_args(const CPLStringList &aosArgs);
 
    CPLStringList get_non_positional_arguments(const CPLStringList &aosArgs);
 
    Argument &add_inverted_logic_flag(const std::string &name,
                                      bool *store_into = nullptr,
                                      const std::string &help = "");
 
    GDALArgumentParser *add_subparser(const std::string &description,
                                      bool bForBinary);
 
    GDALArgumentParser *get_subparser(const std::string &name);
 
    bool is_used_globally(const std::string &name);
 
  private:
    std::map<std::string, ArgumentParser::argument_it>::iterator
    find_argument(const std::string &name);
    std::vector<std::unique_ptr<GDALArgumentParser>> aoSubparsers;
    std::string m_osExtraUsageHint{};
};
 
#endif /* GDALARGUMENTPARSER_H */