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

  Program:   Visualization Toolkit
  Module:    vtkParseMain.h

  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
  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.

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

/**
 vtkParseMain.h provides argument parsing for the wrapper executables.

 Usage: vtkWrap [options] infile ...

 -D <macro[=def]>  add a macro definition
 -U <macro>        cancel a macro definition
 -I <dir>          add an include directory
 -o <file>         specify the output file
 @<file>           read arguments from a file
 --help            print a help message and exit
 --version         print the VTK version number and exit
 --hints <file>    hints file
 --types <file>    type hierarchy file

 Notes:

 1) The "-o" option is needed when there are multiple input files.
    Otherwise, the output file can be given after the input file.

 2) The "@file" option allows arguments to be stored in a file,
    instead of given on the command line.  The use of such a file
    is sometimes necessary to avoid overflowing the 8191-character
    command-line limit on Windows.  If the file is not found, then
    "@file" will be passed as as a command-line parameter.
*/

#ifndef vtkParseMain_h
#define vtkParseMain_h

#include "vtkParseData.h"
#include <stdio.h>

/**
 * Options for the wrappers
 */
typedef struct _OptionInfo
{
  int           NumberOfFiles;      /* the total number of file arguments */
  char        **Files;              /* all of the file arguments */
  char         *InputFileName;      /* the first file argument */
  char         *OutputFileName;     /* the second file, or the "-o" file */
  int           NumberOfHintFileNames; /* the total number of hints arguments */
  char        **HintFileNames;      /* all of the hints arguments */
  int           NumberOfHierarchyFileNames; /* the total number of types argument */
  char        **HierarchyFileNames; /* the file preceded by "--types" */
  int           DumpMacros; /* dump macros to output */
} OptionInfo;

#ifdef __cplusplus
extern "C" {
#endif

/**
 * Return the options provided on the command line
 */
OptionInfo *vtkParse_GetCommandLineOptions(void);

/**
 * The main function, parses the file and returns the result.
 */
FileInfo *vtkParse_Main(int argc, char *argv[]);

/**
 * A main function that can take multiple input files.
 * It does not parse the files.  It will exit on error.
 */
StringCache *vtkParse_MainMulti(int argc, char *argv[]);

#ifdef __cplusplus
} /* extern "C" */
#endif

#endif
/* VTK-HeaderTest-Exclude: vtkParseMain.h */
