/*============================================================================
  MetaIO
  Copyright 2000-2010 Insight Software Consortium

  Distributed under the OSI-approved BSD License (the "License");
  see accompanying file Copyright.txt for details.

  This software is distributed WITHOUT ANY WARRANTY; without even the
  implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  See the License for more information.
============================================================================*/
#include "localMetaConfiguration.h"
#if !defined(_MSC_VER) || (_MSC_VER > 1500) // do not include this file for Visual Studio 2008
#  include <cstdint>
#endif

#ifndef ITKMetaIO_METATYPES_H
#  define ITKMetaIO_METATYPES_H

/*!
 * File:
 *   MetaTypes (.h and .cpp)
 *
 * Description:
 *    This file provides the definition of the enumerated types used by
 *    metaObjects as well as the record structured used to describe the
 *    fields to be read and written by MetaObjects.
 *
 *
 * \author Stephen R. Aylward
 * \date August 29, 1999
 *
 */
#  if (METAIO_USE_NAMESPACE)
namespace METAIO_NAMESPACE
{
#  endif

constexpr size_t METAIO_MAX_WORD_SIZE=80;

typedef char     MET_ASCII_CHAR_TYPE;
typedef int8_t   MET_CHAR_TYPE;
typedef uint8_t  MET_UCHAR_TYPE;
typedef int16_t  MET_SHORT_TYPE;
typedef uint16_t MET_USHORT_TYPE;
typedef int32_t  MET_INT_TYPE;
typedef uint32_t MET_UINT_TYPE;
typedef int32_t  MET_LONG_TYPE;
typedef uint32_t MET_ULONG_TYPE;
typedef int64_t  MET_LONG_LONG_TYPE;
typedef uint64_t MET_ULONG_LONG_TYPE;
typedef float    MET_FLOAT_TYPE;
typedef double   MET_DOUBLE_TYPE;
typedef char *   MET_STRING_TYPE;


// Value types for the variables in a metaFile
// Format for variables defined in a metaFile is
//    <variable> = <value>
//       where <variable> is a designated fieldname/keyword (e.g., NDims)
//          and value is an instance of that fieldname's associated valueType
constexpr size_t MET_NUM_VALUE_TYPES = 29;

typedef enum
{
  MET_NONE = 0,
  MET_ASCII_CHAR,
  MET_CHAR,
  MET_UCHAR,
  MET_SHORT,
  MET_USHORT,
  MET_INT,
  MET_UINT,
  MET_LONG,
  MET_ULONG,
  MET_LONG_LONG,
  MET_ULONG_LONG,
  MET_FLOAT,
  MET_DOUBLE,
  MET_STRING,
  MET_CHAR_ARRAY,
  MET_UCHAR_ARRAY,
  MET_SHORT_ARRAY,
  MET_USHORT_ARRAY,
  MET_INT_ARRAY,
  MET_UINT_ARRAY,
  MET_LONG_ARRAY,
  MET_ULONG_ARRAY,
  MET_LONG_LONG_ARRAY,
  MET_ULONG_LONG_ARRAY,
  MET_FLOAT_ARRAY,
  MET_DOUBLE_ARRAY,
  MET_FLOAT_MATRIX,
  MET_OTHER
} MET_ValueEnumType;


constexpr unsigned char MET_ValueTypeSize[MET_NUM_VALUE_TYPES] = { 0, 1, 1, 1, 2, 2, 4, 4, 4, 4, 8, 8, 4, 8, 1,
                                                                   1, 1, 2, 2, 4, 4, 4, 4, 8, 8, 4, 8, 4, 0 };

static_assert((MET_OTHER + 1) == MET_NUM_VALUE_TYPES, "ERROR: Number of types defined is incorrect.");

constexpr char MET_ValueTypeName[MET_NUM_VALUE_TYPES][21] = {
  { 'M', 'E', 'T', '_', 'N', 'O', 'N', 'E', '\0', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ' },
  { 'M', 'E', 'T', '_', 'A', 'S', 'C', 'I', 'I', '_', 'C', 'H', 'A', 'R', '\0', ' ', ' ', ' ', ' ', ' ', ' ' },
  { 'M', 'E', 'T', '_', 'C', 'H', 'A', 'R', '\0', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ' },
  { 'M', 'E', 'T', '_', 'U', 'C', 'H', 'A', 'R', '\0', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ' },
  { 'M', 'E', 'T', '_', 'S', 'H', 'O', 'R', 'T', '\0', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ' },
  { 'M', 'E', 'T', '_', 'U', 'S', 'H', 'O', 'R', 'T', '\0', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ' },
  { 'M', 'E', 'T', '_', 'I', 'N', 'T', '\0', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ' },
  { 'M', 'E', 'T', '_', 'U', 'I', 'N', 'T', '\0', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ' },
  { 'M', 'E', 'T', '_', 'L', 'O', 'N', 'G', '\0', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ' },
  { 'M', 'E', 'T', '_', 'U', 'L', 'O', 'N', 'G', '\0', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ' },
  { 'M', 'E', 'T', '_', 'L', 'O', 'N', 'G', '_', 'L', 'O', 'N', 'G', '\0', ' ', ' ', ' ', ' ', ' ', ' ', ' ' },
  { 'M', 'E', 'T', '_', 'U', 'L', 'O', 'N', 'G', '_', 'L', 'O', 'N', 'G', '\0', ' ', ' ', ' ', ' ', ' ', ' ' },
  { 'M', 'E', 'T', '_', 'F', 'L', 'O', 'A', 'T', '\0', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ' },
  { 'M', 'E', 'T', '_', 'D', 'O', 'U', 'B', 'L', 'E', '\0', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ' },
  { 'M', 'E', 'T', '_', 'S', 'T', 'R', 'I', 'N', 'G', '\0', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ' },
  { 'M', 'E', 'T', '_', 'C', 'H', 'A', 'R', '_', 'A', 'R', 'R', 'A', 'Y', '\0', ' ', ' ', ' ', ' ', ' ', ' ' },
  { 'M', 'E', 'T', '_', 'U', 'C', 'H', 'A', 'R', '_', 'A', 'R', 'R', 'A', 'Y', '\0', ' ', ' ', ' ', ' ', ' ' },
  { 'M', 'E', 'T', '_', 'S', 'H', 'O', 'R', 'T', '_', 'A', 'R', 'R', 'A', 'Y', '\0', ' ', ' ', ' ', ' ', ' ' },
  { 'M', 'E', 'T', '_', 'U', 'S', 'H', 'O', 'R', 'T', '_', 'A', 'R', 'R', 'A', 'Y', '\0', ' ', ' ', ' ', ' ' },
  { 'M', 'E', 'T', '_', 'I', 'N', 'T', '_', 'A', 'R', 'R', 'A', 'Y', '\0', ' ', ' ', ' ', ' ', ' ', ' ', ' ' },
  { 'M', 'E', 'T', '_', 'U', 'I', 'N', 'T', '_', 'A', 'R', 'R', 'A', 'Y', '\0', ' ', ' ', ' ', ' ', ' ', ' ' },
  { 'M', 'E', 'T', '_', 'L', 'O', 'N', 'G', '_', 'A', 'R', 'R', 'A', 'Y', '\0', ' ', ' ', ' ', ' ', ' ', ' ' },
  { 'M', 'E', 'T', '_', 'U', 'L', 'O', 'N', 'G', '_', 'A', 'R', 'R', 'A', 'Y', '\0', ' ', ' ', ' ', ' ', ' ' },
  { 'M', 'E', 'T', '_', 'L', 'O', 'N', 'G', '_', 'L', 'O', 'N', 'G', '_', 'A', 'R', 'R', 'A', 'Y', '\0', ' ' },
  { 'M', 'E', 'T', '_', 'U', 'L', 'O', 'N', 'G', '_', 'L', 'O', 'N', 'G', '_', 'A', 'R', 'R', 'A', 'Y', '\0' },
  { 'M', 'E', 'T', '_', 'F', 'L', 'O', 'A', 'T', '_', 'A', 'R', 'R', 'A', 'Y', '\0', ' ', ' ', ' ', ' ', ' ' },
  { 'M', 'E', 'T', '_', 'D', 'O', 'U', 'B', 'L', 'E', '_', 'A', 'R', 'R', 'A', 'Y', '\0', ' ', ' ', ' ', ' ' },
  { 'M', 'E', 'T', '_', 'F', 'L', 'O', 'A', 'T', '_', 'M', 'A', 'T', 'R', 'I', 'X', '\0', ' ', ' ', ' ', ' ' },
  { 'M', 'E', 'T', '_', 'O', 'T', 'H', 'E', 'R', '\0', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ' }
};


constexpr size_t MET_NUM_ORIENTATION_TYPES = 7;

typedef enum
{
  MET_ORIENTATION_RL,
  MET_ORIENTATION_LR,
  MET_ORIENTATION_AP,
  MET_ORIENTATION_PA,
  MET_ORIENTATION_SI,
  MET_ORIENTATION_IS,
  MET_ORIENTATION_UNKNOWN
} MET_OrientationEnumType;

static_assert((MET_ORIENTATION_UNKNOWN + 1) == MET_NUM_ORIENTATION_TYPES, "ERROR: Incorrect number of items.");

constexpr char MET_OrientationTypeName[MET_NUM_ORIENTATION_TYPES][3] = { { 'R', 'L', '\0' }, { 'L', 'R', '\0' },
                                                                         { 'A', 'P', '\0' }, { 'P', 'A', '\0' },
                                                                         { 'S', 'I', '\0' }, { 'I', 'S', '\0' },
                                                                         { '?', '?', '\0' } };

constexpr size_t MET_NUM_DISTANCE_UNITS_TYPES = 4;

typedef enum
{
  MET_DISTANCE_UNITS_UNKNOWN,
  MET_DISTANCE_UNITS_UM,
  MET_DISTANCE_UNITS_MM,
  MET_DISTANCE_UNITS_CM
} MET_DistanceUnitsEnumType;

static_assert((MET_DISTANCE_UNITS_CM + 1) == MET_NUM_DISTANCE_UNITS_TYPES, "ERROR: Structure mismatch in size.");

constexpr char MET_DistanceUnitsTypeName[MET_NUM_DISTANCE_UNITS_TYPES][3] = { { '?', '\0', '\0' },
                                                                              { 'u', 'm', '\0' },
                                                                              { 'm', 'm', '\0' },
                                                                              { 'c', 'm', '\0' } };

constexpr size_t MET_NUM_INTERPOLATION_TYPES = 4;

typedef enum
{
  MET_NO_INTERPOLATION,
  MET_EXPLICIT_INTERPOLATION,
  MET_BEZIER_INTERPOLATION,
  MET_LINEAR_INTERPOLATION
} MET_InterpolationEnumType;
static_assert((MET_LINEAR_INTERPOLATION + 1) == MET_NUM_INTERPOLATION_TYPES, "ERROR: Structure mismatch in size.");

constexpr char MET_InterpolationTypeName[MET_NUM_INTERPOLATION_TYPES][17] = {
  { 'M', 'E', 'T', '_', 'N', 'O', 'N', 'E', '\0', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ' },
  { 'M', 'E', 'T', '_', 'E', 'X', 'P', 'L', 'I', 'C', 'I', 'T', '\0', ' ', ' ', ' ', ' ' },
  { 'M', 'E', 'T', '_', 'B', 'E', 'Z', 'I', 'E', 'R', '\0', ' ', ' ', ' ', ' ', ' ', ' ' },
  { 'M', 'E', 'T', '_', 'L', 'I', 'N', 'E', 'A', 'R', '\0', ' ', ' ', ' ', ' ', ' ', ' ' }
};


constexpr size_t MET_MAX_NUMBER_OF_FIELD_VALUES = 4096;
constexpr size_t MET_MAX_NAME_SIZE = 255;

// Structure used to define a field
// (variable = value definition) in a MetaFile
typedef struct
{
  char              name[MET_MAX_NAME_SIZE]; // Fieldname / keyword to designate a variable
  MET_ValueEnumType type;                    // Expected value type of the field
  bool              required;                // Is this field a required field in a metaFile
  int               dependsOn;               // If value type is an array, the size of this
                                             //    array can be defined by a different field
                                             //    (e.g., DimSize array depends on NDims)
  bool defined;                              // Has this field already been defined in the
                                             //    MetaFile being parsed
  int    length;                             // Actual/expect length of an array
  double value[MET_MAX_NUMBER_OF_FIELD_VALUES];
  // Memory and pointers for the field's value(s).
  bool terminateRead; // Set to true if field indicates end of
                      //   meta data
} MET_FieldRecordType;


#  if (METAIO_USE_NAMESPACE)
};
#  endif


#endif