vtkCLIOptions.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Kitware Inc.
// SPDX-License-Identifier: BSD-3-Clause
#ifndef vtkCLIOptions_h
#define vtkCLIOptions_h

#include "vtkObject.h"
#include "vtkPVVTKExtensionsCoreModule.h" // needed for export macro

#include <memory>              // for std::unique_ptr
#include <string>              // for std::string
#include <vector>              // for std::vector
#include <vtk_cli11_forward.h> // for CLI::App

// forward declare CLI::App
namespace CLI
{
class App;
}

class VTKPVVTKEXTENSIONSCORE_EXPORT vtkCLIOptions : public vtkObject
{
public:
  static vtkCLIOptions* New();
  vtkTypeMacro(vtkCLIOptions, vtkObject);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  static vtkCLIOptions* New(const std::shared_ptr<CLI::App>& app);

  CLI::App* GetCLI11App() const;

  const char* GetHelp() const;


  void SetName(const char* name);
  const char* GetName() const;


  void SetDescription(const char* desc);
  const char* GetDescription() const;


  void SetAllowExtras(bool val);
  bool GetAllowExtras() const;


  void SetStopOnUnrecognizedArgument(bool val);
  bool GetStopOnUnrecognizedArgument() const;


  vtkSetMacro(GenerateWarnings, bool);
  vtkGetMacro(GenerateWarnings, bool);
  vtkBooleanMacro(GenerateWarnings, bool);


  vtkSetMacro(HandleLegacyArgumentFormats, bool);
  vtkGetMacro(HandleLegacyArgumentFormats, bool);
  vtkBooleanMacro(HandleLegacyArgumentFormats, bool);

  bool Parse(int& argc, char**& argv);


  const std::vector<std::string>& GetExtraArguments() const { return this->ExtraArguments; }

  const std::string& GetLastErrorMessage() const { return this->LastErrorMessage; }

  vtkGetMacro(HelpRequested, bool);

  std::string GetUsage() const;

protected:
  vtkCLIOptions();
  ~vtkCLIOptions() override;

private:
  vtkCLIOptions(const vtkCLIOptions&) = delete;
  void operator=(const vtkCLIOptions&) = delete;

  class vtkInternals;
  std::unique_ptr<vtkInternals> Internals;
  bool HandleLegacyArgumentFormats = true;
  bool GenerateWarnings = true;
  std::vector<std::string> ExtraArguments;
  std::string LastErrorMessage;
  bool HelpRequested = false;
  mutable std::string Help;
  mutable std::string Description;
};

#endif