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_MF_ENUM_ 00051 #define _SO_MF_ENUM_ 00052 00053 #include <Inventor/SbString.h> 00054 #include <Inventor/errors/SoDebugError.h> 00055 #include <Inventor/fields/SoSubField.h> 00056 00058 // 00059 // SoMFEnum subclass of SoMField. 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 00096 class SoMFEnum : public SoMField { 00097 00098 // Use standard field stuff 00099 SO_MFIELD_HEADER(SoMFEnum, int, int); 00100 SO_MFIELD_SETVALUESPOINTER_HEADER(int); 00101 00102 public: 00103 // 00104 // Some convenience functions: 00105 // 00106 00113 void setValue(const SbName &name); 00114 00119 void getEnums(int &num, int *&vals, SbName *&names); 00120 00127 void set1Value(int index, const SbName &name); 00128 00129 private: 00130 // Sets up value/name correspondances 00131 void setEnums(int num, int *vals, SbName *names); 00132 00133 private: 00134 static void initClass(); 00135 static void exitClass(); 00136 00137 private: 00138 // TRUE if setEnums called 00139 bool legalValuesSet; 00140 00141 // Number of enumeration values 00142 int numEnums; 00143 00144 // Enumeration values 00145 int *enumValues; 00146 00147 // Mnemonic names of values 00148 SbName *enumNames; 00149 00150 // Looks up enum name, returns value. Returns FALSE if not found. 00151 virtual SbBool findEnumValue(const SbName &name, int &val); 00152 00153 // Looks up enum value, returns ptr to name. Returns FALSE if not found. 00154 virtual SbBool findEnumName(int val, const SbName *&name) const; 00155 00156 }; 00157 00158 00160 // 00161 // Debugging macros (used by other macros in this file) 00162 // The container must have a field 'firstInstance'. 00163 // 00164 #if defined(_DEBUG) 00165 # define SO__MF_ENUM_CHECK_DATA(vals, typeName, fieldName, containerMacroName) { \ 00166 if (vals == NULL && firstInstance) { \ 00167 SoDebugError::post("SO_SET_MF_ENUM_TYPE", \ 00168 "Field %s (%s, line %d): Did you forget to" \ 00169 " use SO_%s_DEFINE_ENUM_VALUE(%s, ...)?", \ 00170 fieldName, __FILE__, __LINE__, \ 00171 containerMacroName, typeName); \ 00172 } \ 00173 } 00174 #else 00175 # define SO__MF_ENUM_CHECK_DATA(vals, typeName, fieldName, containerMacroName) ; 00176 #endif 00177 00178 00180 // 00181 // This defines the specific type of enum expected by a particular 00182 // SoMFEnum field. 00183 // 00184 00185 #define SO__MF_ENUM_SET_TYPE(fieldName, enumType, contMacroName, contData) { \ 00186 int _so_mf_enum_num; \ 00187 int *_so_mf_enum_vals; \ 00188 SbName *_so_mf_enum_names; \ 00189 contData->getEnumData((char *)SO__QUOTE(enumType), \ 00190 _so_mf_enum_num, \ 00191 _so_mf_enum_vals, \ 00192 _so_mf_enum_names); \ 00193 SO__MF_ENUM_CHECK_DATA(_so_mf_enum_vals, \ 00194 SO__QUOTE(enumType), \ 00195 SO__QUOTE(fieldName), \ 00196 contMacroName); \ 00197 fieldName.setEnums(_so_mf_enum_num, \ 00198 _so_mf_enum_vals, \ 00199 _so_mf_enum_names); \ 00200 } 00201 00202 #define SO_NODE_SET_MF_ENUM_TYPE(fieldName, enumType) \ 00203 SO__MF_ENUM_SET_TYPE(fieldName,enumType,"NODE",fieldData) 00204 00205 #define SO_ENGINE_SET_MF_ENUM_TYPE(fieldName, enumType) \ 00206 SO__MF_ENUM_SET_TYPE(fieldName,enumType,"ENGINE",inputData) 00207 00208 // 00209 // End of macros 00210 // 00212 00213 #endif /* _SO_MF_ENUM_ */ 00214 00215