00001 /*======================================================================= 00002 * Copyright 1991-1996, Silicon Graphics, Inc. 00003 * ALL RIGHTS RESERVED 00004 * 00005 * UNPUBLISHED -- Rights reserved under the copyright laws of the United 00006 * States. Use of a copyright notice is precautionary only and does not 00007 * imply publication or disclosure. 00008 * 00009 * U.S. GOVERNMENT RESTRICTED RIGHTS LEGEND: 00010 * Use, duplication or disclosure by the Government is subject to restrictions 00011 * as set forth in FAR 52.227.19(c)(2) or subparagraph (c)(1)(ii) of the Rights 00012 * in Technical Data and Computer Software clause at DFARS 252.227-7013 and/or 00013 * in similar or successor clauses in the FAR, or the DOD or NASA FAR 00014 * Supplement. Contractor/manufacturer is Silicon Graphics, Inc., 00015 * 2011 N. Shoreline Blvd. Mountain View, CA 94039-7311. 00016 * 00017 * THE CONTENT OF THIS WORK CONTAINS CONFIDENTIAL AND PROPRIETARY 00018 * INFORMATION OF SILICON GRAPHICS, INC. ANY DUPLICATION, MODIFICATION, 00019 * DISTRIBUTION, OR DISCLOSURE IN ANY FORM, IN WHOLE, OR IN PART, IS STRICTLY 00020 * PROHIBITED WITHOUT THE PRIOR EXPRESS WRITTEN PERMISSION OF SILICON 00021 * GRAPHICS, INC. 00022 **=======================================================================*/ 00023 /*======================================================================= 00024 ** Author : Paul S. Strauss (MMM yyyy) 00025 **=======================================================================*/ 00026 /*======================================================================= 00027 *** THE CONTENT OF THIS WORK IS PROPRIETARY TO FEI S.A.S, (FEI S.A.S.), *** 00028 *** AND IS DISTRIBUTED UNDER A LICENSE AGREEMENT. *** 00029 *** *** 00030 *** REPRODUCTION, DISCLOSURE, OR USE, IN WHOLE OR IN PART, OTHER THAN AS *** 00031 *** SPECIFIED IN THE LICENSE ARE NOT TO BE UNDERTAKEN EXCEPT WITH PRIOR *** 00032 *** WRITTEN AUTHORIZATION OF FEI S.A.S. *** 00033 *** *** 00034 *** RESTRICTED RIGHTS LEGEND *** 00035 *** USE, DUPLICATION, OR DISCLOSURE BY THE GOVERNMENT OF THE CONTENT OF THIS *** 00036 *** WORK OR RELATED DOCUMENTATION IS SUBJECT TO RESTRICTIONS AS SET FORTH IN *** 00037 *** SUBPARAGRAPH (C)(1) OF THE COMMERCIAL COMPUTER SOFTWARE RESTRICTED RIGHT *** 00038 *** CLAUSE AT FAR 52.227-19 OR SUBPARAGRAPH (C)(1)(II) OF THE RIGHTS IN *** 00039 *** TECHNICAL DATA AND COMPUTER SOFTWARE CLAUSE AT DFARS 52.227-7013. *** 00040 *** *** 00041 *** COPYRIGHT (C) 1996-2020 BY FEI S.A.S, *** 00042 *** BORDEAUX, FRANCE *** 00043 *** ALL RIGHTS RESERVED *** 00044 **=======================================================================*/ 00045 /*======================================================================= 00046 ** Modified by : VSG (MMM YYYY) 00047 **=======================================================================*/ 00048 00049 00050 #ifndef _SO_SF_ENUM_ 00051 #define _SO_SF_ENUM_ 00052 00053 #include <Inventor/SbString.h> 00054 #include <Inventor/errors/SoDebugError.h> 00055 #include <Inventor/fields/SoSubField.h> 00056 00058 // 00059 // SoSFEnum subclass of SoSField. This field holds enumerated types. 00060 // Each instance of the field must define enumeration mnemonics and 00061 // character strings. This stores the enumeration values as integers 00062 // (as allowed by C++). 00063 // 00065 00090 class SoSFEnum : public SoSField { 00091 // Use standard field stuff 00092 SO_SFIELD_HEADER(SoSFEnum, int, int); 00093 00094 public: 00099 void setValue(const SbName &name); 00100 00105 void getEnums(int &num, int *&vals, SbName *&names); 00106 00107 private: 00108 00109 // Sets up value/name correspondances 00110 void setEnums(int num, int *vals, SbName *names); 00111 00112 00113 private: 00114 static void initClass(); 00115 static void exitClass(); 00116 00117 // Looks up enum name, returns value. Returns FALSE if not found. 00118 virtual SbBool findEnumValue(const SbName &name, int &val); 00119 00120 private: 00121 bool legalValuesSet; // TRUE if setEnums called 00122 int numEnums; // Number of enumeration values 00123 int *enumValues; // Enumeration values 00124 SbName *enumNames; // Mnemonic names of values 00125 00126 // Looks up enum value, returns ptr to name. Returns FALSE if not found. 00127 virtual SbBool findEnumName(int val, const SbName *&name) const; 00128 00129 }; 00130 00131 00133 // 00134 // Debugging macros (used by other macros in this file). 00135 // The container must have a field 'firstInstance'. 00136 // 00137 #if defined(_DEBUG) 00138 #define SO__SF_ENUM_CHECK_DATA(vals, typeName, fieldName, containerMacroName) { \ 00139 if (vals == NULL && firstInstance) \ 00140 SoDebugError::post("SO_SET_SF_ENUM_TYPE", \ 00141 "Field %s (%s, line %d): Did you forget to" \ 00142 " use SO_%s_DEFINE_ENUM_VALUE(%s, ...)?", \ 00143 fieldName, __FILE__, __LINE__, \ 00144 containerMacroName, typeName); \ 00145 } 00146 #else 00147 #define SO__SF_ENUM_CHECK_DATA(vals, typeName, fieldName, containerMacroName) {} 00148 #endif 00149 00150 00152 // 00153 // This defines the specific type of enum expected by a particular 00154 // SoSFEnum field. 00155 // 00156 00157 #define SO__SF_ENUM_SET_TYPE(fieldName, enumType, contMacroName, contData) { \ 00158 int _so_sf_enum_num; \ 00159 int *_so_sf_enum_vals; \ 00160 SbName *_so_sf_enum_names; \ 00161 contData->getEnumData((char *)SO__QUOTE(enumType), \ 00162 _so_sf_enum_num, \ 00163 _so_sf_enum_vals, \ 00164 _so_sf_enum_names); \ 00165 SO__SF_ENUM_CHECK_DATA(_so_sf_enum_vals, \ 00166 SO__QUOTE(enumType), \ 00167 SO__QUOTE(fieldName), \ 00168 contMacroName); \ 00169 fieldName.setEnums(_so_sf_enum_num, \ 00170 _so_sf_enum_vals, \ 00171 _so_sf_enum_names); \ 00172 } 00173 00174 #define SO_NODE_SET_SF_ENUM_TYPE(fieldName, enumType) \ 00175 SO__SF_ENUM_SET_TYPE(fieldName,enumType,"NODE",fieldData) 00176 00177 #define SO_ENGINE_SET_SF_ENUM_TYPE(fieldName, enumType) \ 00178 SO__SF_ENUM_SET_TYPE(fieldName,enumType,"ENGINE",inputData) 00179 00180 // 00181 // End of macros 00182 // 00184 00185 00186 #endif /* _SO_SF_ENUM_ */ 00187 00188