vtkCommandOptions.h

Go to the documentation of this file.

// ----------------------------------------------------------------------------
// -                        CloudViewer: www.cloudViewer.org                  -
// ----------------------------------------------------------------------------
// Copyright (c) 2018-2024 www.cloudViewer.org
// SPDX-License-Identifier: MIT
// ----------------------------------------------------------------------------
 
#pragma once
 
#include "qPCL.h"  // needed for export macro
#include "vtkObject.h"
 
class vtkCommandOptionsInternal;
class vtkCommandOptionsXMLParser;
 
class QPCL_ENGINE_LIB_API vtkCommandOptions : public vtkObject {
public:
    static vtkCommandOptions* New();
    vtkTypeMacro(vtkCommandOptions, vtkObject);
    void PrintSelf(ostream& os, vtkIndent indent) override;
 
    int Parse(int argc, const char* const argv[]);
    void GetRemainingArguments(int* argc, char** argv[]);
 
    enum { EVERYBODY = 0, XMLONLY = 0x1 };
 
    const char* GetHelp();
 
 
    vtkGetMacro(HelpSelected, int);
    vtkSetMacro(HelpSelected, int);
 
    int GetProcessType() { return this->ProcessType; }
    void SetProcessType(int p) { this->ProcessType = p; }
 
 
    vtkGetStringMacro(UnknownArgument);
 
 
    vtkGetStringMacro(ErrorMessage);
 
    const char* GetArgv0();
 
 
    vtkGetStringMacro(ApplicationPath);
 
    int GetLastArgument();
 
    virtual int ParseExtraXMLTag(const char*, const char**) { return 1; }
 
protected:
    vtkCommandOptions();
 
    ~vtkCommandOptions() override;
 
    typedef int (*CallbackType)(const char* argument,
                                const char* value,
                                void* call_data);
 
 
    void AddBooleanArgument(const char* longarg,
                            const char* shortarg,
                            int* var,
                            const char* help,
                            int type = EVERYBODY);
    void AddDeprecatedArgument(const char* longarg,
                               const char* shortarg,
                               const char* help,
                               int type = EVERYBODY);
    void AddArgument(const char* longarg,
                     const char* shortarg,
                     int* var,
                     const char* help,
                     int type = EVERYBODY);
    void AddArgument(const char* longarg,
                     const char* shortarg,
                     char** var,
                     const char* help,
                     int type = EVERYBODY);
 
    void AddCallback(const char* longarg,
                     const char* shortarg,
                     CallbackType callback,
                     void* call_data,
                     const char* help,
                     int type = EVERYBODY);
 
    virtual void Initialize();
 
    virtual int PostProcess(int argc, const char* const* argv);
 
    virtual int WrongArgument(const char* argument);
 
    virtual int DeprecatedArgument(const char* argument);
 
    int LoadXMLConfigFile(const char*);
 
    vtkSetStringMacro(UnknownArgument);
 
    vtkSetStringMacro(ErrorMessage);
 
    // Options:
    vtkSetStringMacro(XMLConfigFile);
 
    void CleanArgcArgv();
 
    vtkSetStringMacro(ApplicationPath);
    void ComputeApplicationPath();
 
    vtkCommandOptionsXMLParser* XMLParser;
 
private:
    int Argc;
    char** Argv;
    int HelpSelected;
    char* UnknownArgument;
    char* ErrorMessage;
    char* XMLConfigFile;
    char* ApplicationPath;
    int ProcessType;  // data-server, render-server, combined-server, client
 
    vtkCommandOptions(const vtkCommandOptions&) = delete;
    void operator=(const vtkCommandOptions&) = delete;
 
    vtkCommandOptionsInternal* Internals;
 
    static int UnknownArgumentHandler(const char* argument, void* call_data);
    static int DeprecatedArgumentHandler(const char* argument,
                                         const char* value,
                                         void* call_data);
};