dox/Wrapping/Tools/vtkParsePreprocess.h

Go to the documentation of this file.

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

  Program:   Visualization Toolkit
  Module:    vtkParsePreprocess.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.

=========================================================================*/
/*-------------------------------------------------------------------------
  Copyright (c) 2010 David Gobbi.

  Contributed to the VisualizationToolkit by the author in June 2010
  under the terms of the Visualization Toolkit 2008 copyright.
-------------------------------------------------------------------------*/

#ifndef VTK_PARSE_PREPROCESS_H
#define VTK_PARSE_PREPROCESS_H

#include "vtkParseString.h"

#if defined(_WIN32) && !defined(__MINGW32__) && !defined(__CYGWIN__)
typedef __int64 preproc_int_t;
typedef unsigned __int64 preproc_uint_t;
#else
typedef long long preproc_int_t;
typedef unsigned long long preproc_uint_t;
#endif

typedef struct _MacroInfo
{
  const char    *Name;
  const char    *Definition;
  const char    *Comment; /* unused */
  int            NumberOfParameters; /* only if IsFunction == 1 */
  const char   **Parameters; /* symbols for parameters */
  int            IsFunction; /* this macro requires arguments */
  int            IsVariadic; /* this macro can take unlimited arguments */
  int            IsExternal; /* this macro is from an included file */
  int            IsExcluded; /* do not expand this macro */
} MacroInfo;

typedef struct _PreprocessInfo
{
  const char    *FileName;         /* the file that is being parsed */
  MacroInfo   ***MacroHashTable;   /* hash table for macro lookup */
  int            NumberOfIncludeDirectories;
  const char   **IncludeDirectories;
  int            NumberOfIncludeFiles; /* all included files */
  const char   **IncludeFiles;
  StringCache   *Strings;          /* to aid string allocation */
  int            IsExternal;       /* label all macros as "external" */
  int            ConditionalDepth; /* internal state variable */
  int            ConditionalDone;  /* internal state variable */
} PreprocessInfo;

enum _preproc_platform_t {
  VTK_PARSE_NATIVE = 0
};

enum _preproc_return_t {
  VTK_PARSE_OK = 0,
  VTK_PARSE_SKIP = 1,            /* skip next block */
  VTK_PARSE_PREPROC_DOUBLE = 2,  /* encountered a double */
  VTK_PARSE_PREPROC_FLOAT = 3,   /* encountered a float */
  VTK_PARSE_PREPROC_STRING = 4,  /* encountered a string */
  VTK_PARSE_MACRO_UNDEFINED = 5, /* macro lookup failed */
  VTK_PARSE_MACRO_REDEFINED = 6, /* attempt to redefine a macro */
  VTK_PARSE_FILE_NOT_FOUND = 7,  /* include file not found */
  VTK_PARSE_FILE_OPEN_ERROR = 8, /* include file not readable */
  VTK_PARSE_FILE_READ_ERROR = 9, /* error during read */
  VTK_PARSE_MACRO_NUMARGS = 10,  /* wrong number of args to func macro */
  VTK_PARSE_SYNTAX_ERROR = 11    /* any and all syntax errors */
};

#define VTK_PARSE_FATAL_ERROR 0xF8

#ifdef __cplusplus
extern "C" {
#endif

int vtkParsePreprocess_HandleDirective(
  PreprocessInfo *info, const char *directive);

int vtkParsePreprocess_EvaluateExpression(
  PreprocessInfo *info, const char *text,
  preproc_int_t *val, int *is_unsigned);

void vtkParsePreprocess_AddStandardMacros(
  PreprocessInfo *info, int platform);

int vtkParsePreprocess_AddMacro(
  PreprocessInfo *info, const char *name, const char *definition);

int vtkParsePreprocess_RemoveMacro(
  PreprocessInfo *info, const char *name);

MacroInfo *vtkParsePreprocess_GetMacro(
  PreprocessInfo *info, const char *name);

const char *vtkParsePreprocess_ExpandMacro(
  PreprocessInfo *info, MacroInfo *macro, const char *argstring);

void vtkParsePreprocess_FreeMacroExpansion(
  PreprocessInfo *info, MacroInfo *macro, const char *text);

const char *vtkParsePreprocess_ProcessString(
  PreprocessInfo *info, const char *text);

void vtkParsePreprocess_FreeProcessedString(
  PreprocessInfo *info, const char *text);

void vtkParsePreprocess_IncludeDirectory(
  PreprocessInfo *info, const char *name);

const char *vtkParsePreprocess_FindIncludeFile(
  PreprocessInfo *info, const char *filename, int system_first,
  int *already_loaded);

void vtkParsePreprocess_InitMacro(MacroInfo *symbol);

void vtkParsePreprocess_FreeMacro(MacroInfo *macro);

void vtkParsePreprocess_Init(
  PreprocessInfo *info, const char *filename);

void vtkParsePreprocess_Free(PreprocessInfo *info);

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

#endif