SoSFEnum.h

/*=======================================================================
 * Copyright 1991-1996, Silicon Graphics, Inc.
 * ALL RIGHTS RESERVED
 *
 * UNPUBLISHED -- Rights reserved under the copyright laws of the United
 * States.   Use of a copyright notice is precautionary only and does not
 * imply publication or disclosure.
 *
 * U.S. GOVERNMENT RESTRICTED RIGHTS LEGEND:
 * Use, duplication or disclosure by the Government is subject to restrictions
 * as set forth in FAR 52.227.19(c)(2) or subparagraph (c)(1)(ii) of the Rights
 * in Technical Data and Computer Software clause at DFARS 252.227-7013 and/or
 * in similar or successor clauses in the FAR, or the DOD or NASA FAR
 * Supplement.  Contractor/manufacturer is Silicon Graphics, Inc.,
 * 2011 N. Shoreline Blvd. Mountain View, CA 94039-7311.
 *
 * THE CONTENT OF THIS WORK CONTAINS CONFIDENTIAL AND PROPRIETARY
 * INFORMATION OF SILICON GRAPHICS, INC. ANY DUPLICATION, MODIFICATION,
 * DISTRIBUTION, OR DISCLOSURE IN ANY FORM, IN WHOLE, OR IN PART, IS STRICTLY
 * PROHIBITED WITHOUT THE PRIOR EXPRESS WRITTEN PERMISSION OF SILICON
 * GRAPHICS, INC.
**=======================================================================*/
/*=======================================================================
** Author      : Paul S. Strauss (MMM yyyy)
**=======================================================================*/
/*=======================================================================
 *** THE CONTENT OF THIS WORK IS PROPRIETARY TO FEI S.A.S, (FEI S.A.S.),            ***
 ***              AND IS DISTRIBUTED UNDER A LICENSE AGREEMENT.                     ***
 ***                                                                                ***
 ***  REPRODUCTION, DISCLOSURE,  OR USE,  IN WHOLE OR IN PART,  OTHER THAN AS       ***
 ***  SPECIFIED  IN THE LICENSE ARE  NOT TO BE  UNDERTAKEN  EXCEPT WITH PRIOR       ***
 ***  WRITTEN AUTHORIZATION OF FEI S.A.S.                                           ***
 ***                                                                                ***
 ***                        RESTRICTED RIGHTS LEGEND                                ***
 ***  USE, DUPLICATION, OR DISCLOSURE BY THE GOVERNMENT OF THE CONTENT OF THIS      ***
 ***  WORK OR RELATED DOCUMENTATION IS SUBJECT TO RESTRICTIONS AS SET FORTH IN      ***
 ***  SUBPARAGRAPH (C)(1) OF THE COMMERCIAL COMPUTER SOFTWARE RESTRICTED RIGHT      ***
 ***  CLAUSE  AT FAR 52.227-19  OR SUBPARAGRAPH  (C)(1)(II)  OF  THE RIGHTS IN      ***
 ***  TECHNICAL DATA AND COMPUTER SOFTWARE CLAUSE AT DFARS 52.227-7013.             ***
 ***                                                                                ***
 ***                   COPYRIGHT (C) 1996-2014 BY FEI S.A.S,                        ***
 ***                        BORDEAUX, FRANCE                                        ***
 ***                      ALL RIGHTS RESERVED                                       ***
**=======================================================================*/
/*=======================================================================
** Modified by : VSG (MMM YYYY)
**=======================================================================*/
 
 
#ifndef  _SO_SF_ENUM_
#define  _SO_SF_ENUM_
 
#include <Inventor/SbString.h>
#include <Inventor/errors/SoDebugError.h>
#include <Inventor/fields/SoSubField.h>
 
//
//  SoSFEnum subclass of SoSField. This field holds enumerated types.
//  Each instance of the field must define enumeration mnemonics and
//  character strings. This stores the enumeration values as integers
//  (as allowed by C++).
//
 
class  SoSFEnum : public SoSField {
  // Use standard field stuff
  SO_SFIELD_HEADER(SoSFEnum, int, int);
 
 public:
  void                setValue(const SbName &name);
 
  void                getEnums(int &num, int *&vals, SbName *&names);
 
 private:
 
  // Sets up value/name correspondances
  void                setEnums(int num, int *vals, SbName *names);
 
 
 private:
  static void         initClass();
  static void exitClass();
 
  // Looks up enum name, returns value. Returns FALSE if not found.
  virtual SbBool      findEnumValue(const SbName &name, int &val);
 
 private:
  bool                legalValuesSet; // TRUE if setEnums called
  int                 numEnums;       // Number of enumeration values
  int                 *enumValues;    // Enumeration values
  SbName              *enumNames;     // Mnemonic names of values
 
  // Looks up enum value, returns ptr to name. Returns FALSE if not found.
  virtual SbBool      findEnumName(int val, const SbName *&name) const;
 
};
 
 
//
//  Debugging macros (used by other macros in this file).
//  The container must have a field 'firstInstance'.
//
#if defined(_DEBUG)
#define SO__SF_ENUM_CHECK_DATA(vals, typeName, fieldName, containerMacroName) { \
  if (vals == NULL && firstInstance)                                  \
    SoDebugError::post("SO_SET_SF_ENUM_TYPE",                         \
                       "Field %s (%s, line %d): Did you forget to"    \
                       " use SO_%s_DEFINE_ENUM_VALUE(%s, ...)?",      \
                       fieldName, __FILE__, __LINE__,                 \
                       containerMacroName, typeName);                 \
}
#else
#define SO__SF_ENUM_CHECK_DATA(vals, typeName, fieldName, containerMacroName) {}
#endif
 
 
//
// This defines the specific type of enum expected by a particular
// SoSFEnum field.
//
 
#define SO__SF_ENUM_SET_TYPE(fieldName, enumType, contMacroName, contData) {    \
  int _so_sf_enum_num;                                                \
  int *_so_sf_enum_vals;                                                      \
  SbName *_so_sf_enum_names;                                          \
  contData->getEnumData((char *)SO__QUOTE(enumType),                  \
                        _so_sf_enum_num,                              \
                        _so_sf_enum_vals,                             \
                        _so_sf_enum_names);                           \
  SO__SF_ENUM_CHECK_DATA(_so_sf_enum_vals,                            \
                         SO__QUOTE(enumType),                         \
                         SO__QUOTE(fieldName),                        \
                         contMacroName);                                      \
  fieldName.setEnums(_so_sf_enum_num,                                 \
                     _so_sf_enum_vals,                                \
                     _so_sf_enum_names);                                      \
}
 
#define SO_NODE_SET_SF_ENUM_TYPE(fieldName, enumType)                         \
    SO__SF_ENUM_SET_TYPE(fieldName,enumType,"NODE",fieldData)
 
#define SO_ENGINE_SET_SF_ENUM_TYPE(fieldName, enumType)                       \
    SO__SF_ENUM_SET_TYPE(fieldName,enumType,"ENGINE",inputData)
 
//
// End of macros
//
 
 
#endif /* _SO_SF_ENUM_ */