Common/KWCommon/vtkKWArguments.h

Go to the documentation of this file.

/*=========================================================================

  Module:    $RCSfile: vtkKWArguments.h,v $

  Copyright (c) Kitware, Inc.
  All rights reserved.
  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.

     This software is distributed WITHOUT ANY WARRANTY; without even
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
     PURPOSE.  See the above copyright notice for more information.

=========================================================================*/
#ifndef __vtkKWArguments_h
#define __vtkKWArguments_h

#include "vtkObject.h"

class vtkKWArgumentsInternal;

class VTK_EXPORT vtkKWArguments : public vtkObject
{
public:
  static vtkKWArguments* New();
  vtkTypeRevisionMacro(vtkKWArguments,vtkObject);
  void PrintSelf(ostream& os, vtkIndent indent);


  //BTX


  enum ArgumentTypeEnum { 
    NO_ARGUMENT,    // The option takes no argument             --foo
    CONCAT_ARGUMENT,// The option takes argument after no space --foobar
    SPACE_ARGUMENT, // The option takes argument after space    --foo bar
    EQUAL_ARGUMENT  // The option takes argument after equal    --foo=bar
  };

  enum VariableTypeEnum {
    NO_VARIABLE_TYPE = 0, // The variable is not specified
    INT_TYPE,             // The variable is integer (int)
    DOUBLE_TYPE,          // The variable is float (double)
    STRING_TYPE           // The variable is string (char*)
  };

  // These are prototypes for callbacks.
  typedef int(*CallbackType)(const char* argument, const char* value, 
    void* call_data);
  typedef int(*ErrorCallbackType)(const char* argument, void* client_data);

  struct CallbackStructure
    {
    const char* Argument;
    int ArgumentType;
    CallbackType Callback;
    void* CallData;
    void* Variable;
    int VariableType;
    const char* Help;
    };
  
  void Initialize(int argc, char* argv[]);

  //ETX
  

  void Initialize();
  void AddArgument(const char* arg);

  int Parse();


  void AddCallback(const char* argument, ArgumentTypeEnum type, CallbackType callback, 
                   void* call_data, const char* help);
  void AddCallback(const char* argument, ArgumentTypeEnum type, const char* help)
    {
    this->AddCallback(argument, type, 0, 0, help);
    }


  void AddHandler(const char* argument, ArgumentTypeEnum type, VariableTypeEnum vtype, void* variable, const char* help);
  void AddHandler(const char* argument, ArgumentTypeEnum type, int* variable, const char* help);
  void AddHandler(const char* argument, ArgumentTypeEnum type, double* variable, const char* help);
  void AddHandler(const char* argument, ArgumentTypeEnum type, char** variable, const char* help);
  void AddBooleanHandler(const char* argument, int* variable, const char* help);

  void AddCallbacks(CallbackStructure* callbacks);


  void SetClientData(void* client_data);
  void SetUnknownArgumentCallback(ErrorCallbackType callback);

  void GetRemainingArguments(int* argc, char*** argv);


  vtkGetStringMacro(Help);
  const char* GetHelp(const char* arg);


  vtkSetMacro(LineLength, unsigned int);
  vtkGetMacro(LineLength, unsigned int);


  int IsSpecified(const char* arg);
  const char* GetValue(const char* arg);

protected:
  vtkKWArguments();
  ~vtkKWArguments();

  vtkSetStringMacro(Help);
  void GenerateHelp();

  //BTX
  typedef vtkKWArgumentsInternal Internal;
  //ETX
  Internal* Internals;
  char* Help;

  unsigned int LineLength;

private:
  vtkKWArguments(const vtkKWArguments&); // Not implemented
  void operator=(const vtkKWArguments&); // Not implemented
};


#endif

---