mi32/sml.h

Go to the documentation of this file.

/******************************************************************************
 *
 * \file mi32/sml.h
 * \brief SML -- Spatial Manipulation Language
 *
 * SML is used in TNTmips for both a scripting language and for database
 * query operations.  
 *
 * \if NODOC
 * $Log: sml.h_v $
 * Revision 1.411  2004/02/10 18:49:07  dwilliss
 * Added a new callback reason
 *
 * Revision 1.410  2004/01/09 18:54:21  msmith
 * added sig
 *
 * Revision 1.409  2003/12/19 23:49:10  dwilliss
 * Deprecate some old methods
 *
 * Revision 1.408  2003/12/16 18:05:43  dwilliss
 * Added new autoclass for classes which have destructors but no default
 * constructor or copy constructor
 *
 * Revision 1.407  2003/12/11 17:59:17  dwilliss
 * New proto
 *
 * Revision 1.406  2003/11/26 18:46:24  msmith
 * added a defsig
 *
 * Revision 1.405  2003/11/26 17:53:45  dwilliss
 * DrawOptimizedLabels now takes an ELEMTYPE parameter
 *
 * Revision 1.404  2003/11/26 16:24:57  dwilliss
 * Changed some private members from int to ELEMTYPE
 * Added a version of CallFunction that takes an ELEMTYPE as well as elemnum
 *
 * Revision 1.403  2003/11/17 18:07:05  dwilliss
 * nc
 *
 * Revision 1.402  2003/11/04 18:44:50  dwilliss
 * *** empty log message ***
 *
 * Revision 1.401  2003/10/24 19:36:02  dwilliss
 * Added methods to objects to get RVC Interface class instance
 *
 * Revision 1.400  2003/10/20 16:45:18  dwilliss
 * Put back some methods that I had retired too early.
 * Turns out they were deprecated but I hadn't hidden the prototype outside
 * the DLL so old code still called them
 *
 * Revision 1.399  2003/10/20 15:43:47  dwilliss
 * Deprecated some methods
 * Moved some private prototypes to mi32p/dbqueryp.h
 *
 * Revision 1.398  2003/10/16 17:12:28  dwilliss
 * Deprecated some SMLSTRING methods.
 * StringAlloc no longer needs a length.
 *
 * Revision 1.397  2003/10/15 22:53:13  dwilliss
 * Added methods to SMLTMPSTR to eliminate need for operator overloads on
 * casting to (char*) and (UNICODE*)
 *
 * Revision 1.396  2003/10/15 22:43:22  dwilliss
 * SMLSTRING now derived from MISTRING
 * Simplifies things a LOT!
 *
 * Revision 1.395  2003/10/08 22:07:12  dwilliss
 * Added Get/SetFilePath to SMLOBJECT.  Deprecated the Get/SetFilename methods
 *
 * Revision 1.394  2003/09/30 16:25:48  dwilliss
 * Doxygen fix
 *
 * Revision 1.393  2003/09/23 14:13:18  dwilliss
 * made SMLCONTEXT a friend of SMLELEMDATA to stop a gcc warning
 *
 * Revision 1.392  2003/09/15 13:49:56  fileserver!dwilliss
 * Doxygen
 *
 * Revision 1.391  2003/09/10 22:39:45  dwilliss
 * General cleanup
 *
 * Revision 1.390  2003/09/09 21:15:38  dwilliss
 * SMLSTRING had some inline methods which is BAD when exported from a DLL
 *
 * Revision 1.389  2003/09/05 17:07:50  mju
 * Add SMLSTRING::GetSTRUTF8 method.
 *
 * Revision 1.388  2003/08/28 22:25:04  dwilliss
 * Added versions of some methods that should have been taking const pointers
 *
 * Revision 1.387  2003/08/27 14:24:20  dwilliss
 * Added CurrentFuncitonIsClassMethod()
 *
 * Revision 1.386  2003/08/26 20:57:53  dwilliss
 * Added SMLCLASSNAME for viewable
 *
 * Revision 1.385  2003/08/19 17:52:13  dwilliss
 * Allow for name aliases
 *
 * Revision 1.384  2003/08/18 19:48:30  dwilliss
 * Added support for name aliases
 *
 * Revision 1.383  2003/08/12 17:58:24  dwilliss
 * Added a version of GetLastError that doesn't take any string.  We let the
 * normal error handling mechanism take care of it for us now
 *
 * Revision 1.382  2003/08/06 22:16:22  dwilliss
 * Changed LoadPlugins/UnloadPlugins to exist on all platforms, even if they
 * do nothing.  Keep track of plugins in a simple array now
 *
 * Revision 1.381  2003/08/04 19:48:11  dwilliss
 * *** empty log message ***
 *
 * Revision 1.380  2003/08/04 17:03:37  dwilliss
 * Another method needed for debugging
 *
 * Revision 1.379  2003/08/04 16:28:28  dwilliss
 * Some methods needed for the SML Debugger
 *
 * Revision 1.378  2003/07/23 20:47:29  dwilliss
 * Added SMLCLASSMEMBER::TYPE_Enum
 *
 * Revision 1.377  2003/07/17 22:12:24  dwilliss
 * *** empty log message ***
 *
 * Revision 1.376  2003/07/17 15:40:04  dwilliss
 * Get rid of ElemList from SMLOBJECT.  Nothing seemed to use it and it's
 * going to be replaced soon anyway
 *
 * Revision 1.375  2003/07/17 15:13:02  dwilliss
 * *** empty log message ***
 *
 * Revision 1.374  2003/07/17 14:05:51  dwilliss
 * Added a proto.  Fixed the debug class
 *
 * Revision 1.373  2003/06/30 21:02:55  dwilliss
 * const change in private function
 *
 * Revision 1.372  2003/06/25 15:29:33  dwilliss
 * Added MISTRING versions of List and ListLine
 *
 * Revision 1.371  2003/06/14 02:10:21  scowan
 * Changed use of dregion to a trans2d mapgen.
 *
 * Revision 1.370  2003/06/03 17:08:27  dwilliss
 * Added an AddMethodOldCB.
 *
 * Revision 1.369  2003/06/02 20:08:44  dwilliss
 * Added stuff for OLE
 *
 * Revision 1.368  2003/05/30 17:09:07  dwilliss
 * OLE additions (private)
 *
 * Revision 1.367  2003/05/09 20:19:40  dwilliss
 * Added private class and methods to context
 *
 * Revision 1.366  2003/05/06 21:25:57  dwilliss
 * Added a CreateHisto method to SMLRASTEROBJECT
 *
 * Revision 1.365  2003/05/01 16:25:02  dwilliss
 * Added changes from tnt68 version back into DV.
 *
 * Revision 1.364  2003/04/23 21:59:07  mju
 * Remove some obsolete "main" funcs.
 * Add default flags for one Main func and elimate 'Ext' version.
 *
 * Revision 1.363  2003/03/06 17:05:37  dwilliss
 * Gave SMLELEMDATA some private methods
 *
 * Revision 1.362  2003/03/06 16:33:32  dwilliss
 * Added a couple bools to SMLELEMDATA to keep track of undo state
 *
 * Revision 1.361  2003/02/28 16:46:24  dwilliss
 * Deprecated a bunch of non-const methods.
 * Made a version of SetArgError that takes a non-const string, deprecated
 * the old one.
 *
 * Revision 1.360  2003/02/20 17:10:05  dwilliss
 * Added private members to context for parsing
 *
 * Revision 1.359  2003/02/19 21:40:20  dwilliss
 * Added a new private method to context
 *
 * Revision 1.358  2003/01/20 16:46:57  dwilliss
 * Can't use _T for template argument because MFC #defines it to char*
 * Thank-you Microsoft!
 *
 * Revision 1.357  2003/01/15 23:20:19  dwilliss
 * mostly comment changes
 *
 * Revision 1.356  2003/01/15 17:14:29  dwilliss
 * Added SMLAUTOCLASS_NEW_NOCOPY_T
 *
 * Revision 1.355  2002/12/09 17:14:10  scowan
 * Changed init from db handle method and added member to sml elem data.
 *
 * Revision 1.352  2002/12/02 18:07:53  dwilliss
 * Put it back.  Just reverse two parameters to avoid ambiguious overload
 *
 * Revision 1.351  2002/12/02 17:54:54  dwilliss
 * Ifdef'd out one of the SMLFUNCDEF constructors.  Seems to be confusing
 * VC6.0
 *
 * Revision 1.350  2002/11/27 23:27:26  dwilliss
 * Added an SMLFUNCDEF structure which provided constructors for SMLFUNC in a
 * type-safe way.
 * Deprecated the old inline methods that tried to do the same thing because
 * gcc 3.1 chokes on them.
 *
 * Revision 1.349  2002/11/27 22:01:06  dwilliss
 * Added experimental SMLFUNCVOID to provide better way to define these things
 * in a type-safe way.
 *
 * Revision 1.348  2002/11/20 17:24:26  dwilliss
 * Added SetStrictSyntax method
 *
 * Revision 1.347  2002/11/20 17:17:25  dwilliss
 * Added method for adding parser warnings
 *
 * Revision 1.346  2002/11/13 17:11:36  dwilliss
 * SMLELEMDATA now has constructor/destructor
 *
 * Revision 1.345  2002/10/08 16:43:46  dwilliss
 * Deprecated a couple methods that took non-const strings
 *
 * Revision 1.343  2002/10/01 16:39:34  dwilliss
 * Defined a new flag for SMLCONTEXT::Run()
 *
 * Revision 1.341  2002/09/10 20:47:11  dwilliss
 * Decided not to deprecate a macro yet.
 *
 * Revision 1.340  2002/09/10 20:45:15  dwilliss
 * SMLFUNCDEF macros no longer fill in description.
 *
 * Revision 1.339  2002/09/10 17:56:00  dwilliss
 * Oops.  Tried to prototype an overload of a function with C linkage
 *
 * Revision 1.338  2002/09/10 17:51:24  dwilliss
 * Clean up after deprecated stuff fixed.  Some stuff that was deprecated
 * before can just go away now
 *
 * Revision 1.337  2002/09/09 17:08:28  mju
 * Remove deprecated #defines and inlines.
 * Retire exported fns/methods with comment as to when can remove.
 *
 * Revision 1.336  2002/09/09 15:51:39  mju
 * Remove previously retired seterrorcode fns/method.
 *
 * Revision 1.335  2002/09/06 21:52:55  dwilliss
 * Added Open/CloseDatabase methods to SMLELEMDATA.  Deprecated
 * SMLELEMDATA::SetHandle(), as it has been deemed "evil"
 *
 * Revision 1.334  2002/09/03 22:38:22  dwilliss
 * Deprecate stuff
 *
 * Revision 1.333  2002/08/28 22:44:00  dwilliss
 * Added some methods to get/set segment node
 *
 * Revision 1.332  2002/08/19 15:13:35  dwilliss
 * Got rid of some new warnings generated by gcc 3.1
 *
 * Revision 1.331  2002/08/16 21:04:35  dwilliss
 * Added XML document hooks to context
 *
 * Revision 1.330  2002/07/30 19:04:55  dwilliss
 * Use 0 instead of NULL for default parm
 *
 * Revision 1.329  2002/07/16 19:26:46  dwilliss
 * Added a GetFuncGroup method to SMLFUNC
 *
 * Revision 1.328  2002/06/07 21:28:14  dwilliss
 * Changed a private function to take const FIELPATH insteadh of UNICODE*
 *
 * Revision 1.327  2002/06/05 21:10:49  dwilliss
 * Added GetFieldType method to SMLSYMBOL'
 *
 * Revision 1.326  2002/06/03 16:20:55  dwilliss
 * Added SIG value for void function taking 4 doubles
 *
 * Revision 1.325  2002/05/16 16:15:39  dwilliss
 * force SMLSYMBOL members to be private for tonights build so I can make
 * sure I didn't miss anybody using them illegally.
 *
 * Revision 1.324  2002/05/16 16:08:33  dwilliss
 * Oops.  left SMLSYMBOL members private.
 * Now only private if compiling for no deprecated (and not for rvcsys)
 *
 * Revision 1.323  2002/05/16 15:59:47  dwilliss
 * Added a few more methods to access stuff in SMLSYMBOL
 *
 * Revision 1.322  2002/05/16 14:20:07  dwilliss
 * Deprecate the old GetValue
 *
 * Revision 1.321  2002/05/16 14:12:26  dwilliss
 * Get rid of default value on one method.  Causes ambiguious function
 * because we just added a new function taking just an MISTRING and returning
 * bool instead of void
 *
 * Revision 1.320  2002/05/16 14:02:13  dwilliss
 * Added two new GetValue methods to SMLSYMBOL
 *
 * Revision 1.319  2002/05/15 22:57:18  dwilliss
 * Deprecated FastSymbol inlines
 * Added some SMLSYMBOL method to access members that were previously being
 * accessed directly.  Plan to make all members private as of 6.7
 *
 * Revision 1.318  2002/04/26 22:20:52  dwilliss
 * DBQuery_LineStyleSetPoints() should take const pointer
 *
 * Revision 1.317  2002/04/19 14:20:10  dwilliss
 * Fixed compiler warning about function pointer typedef
 *
 * Revision 1.316  2002/04/16 19:12:47  dwilliss
 * Mac compile error
 *
 * Revision 1.315  2002/04/16 17:29:45  mju
 * Parms changed to query_setupdraw.
 *
 * Revision 1.312  2002/04/05 17:42:53  dwilliss
 * Clean up error handling.  Eliminate use of varargs SetErrCode
 *
 * Revision 1.311  2002/04/05 15:04:10  mju
 * Deprecate SetErrorCodeC.
 *
 * Revision 1.307  2002/03/28 22:28:08  dwilliss
 * Gave SMLCLASSMEMBER a TYPE enum so I could define a new one
 *
 * Revision 1.306  2002/03/26 21:44:29  dwilliss
 * SMLSTRING.SetString() now takes const pointers.  non-const versions still
 * defined but prototype only available in rvcsys.dll
 *
 * Revision 1.303  2002/03/25 20:17:13  dwilliss
 * SMLAUTOCLASS now has AddMethodOld() for functions returning strings
 * SMLAUTOCLASS now has AddMember()
 *
 * Revision 1.302  2002/03/01 18:45:39  dwilliss
 * GeorefAlloc and Copy now have flags to allow allocation in temp heap
 *
 * Revision 1.301  2002/02/25 21:09:40  dwilliss
 * Added a PrevTableSym member to context
 *
 * Revision 1.300  2002/02/19 17:07:05  dwilliss
 * Internal print buffer is now MISTRING
 *
 * Revision 1.299  2002/02/12 18:19:31  dwilliss
 * context now keeps track of what things its warned about so as to not repeat
 * itself.
 *
 * Revision 1.298  2002/01/30 17:22:04  dwilliss
 * Added StrictSyntax member to context
 *
 * Revision 1.297  2001/12/28 18:10:39  dwilliss
 * A few new DOCCODE methods
 *
 * Revision 1.296  2001/12/27 17:14:56  dwilliss
 * Now has real constructor/destructor.  Still private though.  You have
 * to use functions to allocate an SMLCONTEXT, and use the Destroy() method
 * to delete it.
 *
 * Revision 1.294  2001/12/26 22:58:53  dwilliss
 * Mike and I changed our minds on the DEPRICATED thing.  It's now a constant
 * to say when the feature will be RETIRED.  If it's set, it's considered
 * to be deprecated now
 *
 * Revision 1.293  2001/12/26 22:35:35  dwilliss
 * Ok, so I spelled DEPRECATED wrong.  That's what spell check is for!
 *
 * Revision 1.292  2001/12/26 22:31:35  dwilliss
 * Defined an SML_DEPRICATED constant
 *
 * Revision 1.291  2001/12/21 00:02:20  dwilliss
 * added funcgroup to SMLFUNC
 *
 * Revision 1.290  2001/12/19 21:37:21  dwilliss
 * AutoClass stuff works now
 *
 * Revision 1.289  2001/12/19 15:12:58  dwilliss
 * Got rid of typedef that gcc didn't like.  Wasn't using it any way
 *
 * Revision 1.288  2001/12/18 21:01:31  dwilliss
 * More AutoClass changes
 *
 * Revision 1.287  2001/12/17 15:28:17  dwilliss
 * SMLAUTOCLASS setup function doesn't need to take an SMLCONTEXT
 *
 * Revision 1.286  2001/12/14 22:43:02  dwilliss
 * Autoclass stuff more solidified
 *
 * Revision 1.285  2001/12/14 20:16:34  dwilliss
 * Added SMLAUTOCLASS
 *
 * Revision 1.282  2001/12/10 21:46:39  dwilliss
 * Major changes to documentation code
 *
 * Revision 1.281  2001/10/04 19:40:18  dwilliss
 * inline functions for defining function returning class was marking them
 * as classes, not as functions returning class.
 *
 * Revision 1.280  2001/10/04 17:30:20  dwilliss
 * Some new prototypes
 *
 * Revision 1.279  2001/09/19 22:27:58  dwilliss
 * Added prototype for MFC query editor
 *
 * Revision 1.278  2001/08/08 22:42:11  dwilliss
 * Added a protected member to SMLCONTEXT
 *
 * Revision 1.277  2001/07/06 15:44:29  mju
 * Add DEFINE_SMLCLASS_AUTO macro.
 *
 * Revision 1.276  2001/05/21 17:01:02  dwilliss
 * Change CopyConstructor
 *
 * Revision 1.275  2001/02/15 21:54:35  dwilliss
 * deprecate an old function
 *
 * Revision 1.274  2001/02/15 21:49:54  dwilliss
 * proto for DBQuery_EditMISTRING
 *
 * Revision 1.273  2001/02/01 17:58:20  dwilliss
 * Added new Func def macro for functions returning class which we have to
 * name differently than SML wants
 * Added encoding conversion to SMLFILE
 *
 * Revision 1.272  2001/01/25 23:04:18  dwilliss
 * Deprecate use of SMLSTRING constructor/destructor
 *
 * Revision 1.270  2001/01/18 16:58:56  dwilliss
 * Added MemPool methods to context
 *
 * Revision 1.269  2001/01/17 23:50:51  dwilliss
 * Clean up strings a bit
 *
 * Revision 1.268  2001/01/16 22:54:07  dwilliss
 * Change all bit-field things to bool values
 *
 * Revision 1.267  2001/01/16 18:53:31  dwilliss
 * Changed the way USERDATA is done so that it can be added to both
 * strings and symbols
 *
 * Revision 1.266  2000/12/13 17:48:19  dwilliss
 * Changed two spare bytes in SMLGEOSTRUCT to "Model"
 *
 * Revision 1.265  2000/11/22 22:23:13  dwilliss
 * Added format to GetValue() method that I just added last revision
 *
 * Revision 1.264  2000/11/22 22:12:10  dwilliss
 * Added GetValue method to SMLSYMBOL taking an MISTRING to fill int
 *
 * Revision 1.263  2000/10/31 16:50:50  mju
 * Add const versions of AddObjectSymbol.
 *
 * Revision 1.262  2000/10/26 16:01:28  mju
 * Add defaults for GetLastError.
 *
 * Revision 1.261  2000/10/13 16:35:14  dwilliss
 * changed a class back to struct
 *
 * Revision 1.260  2000/10/13 14:33:00  dwilliss
 * When delaring friends, must specify friend class NAME, not just friend NAME
 *
 * Revision 1.259  2000/09/13 15:03:08  dwilliss
 * I forgot, Macs don't export class methods the same way everybody else does.
 * Gotta do something special just for them.
 *
 * Revision 1.258  2000/09/12 21:16:43  dwilliss
 * new qflag
 *
 * Revision 1.257  2000/09/08 20:27:27  dwilliss
 * Defined new QFLAG
 *
 * Revision 1.256  2000/09/07 22:05:58  dwilliss
 * Added several new methods to SMLELEMDATA and SMLTABLE
 *
 * Revision 1.255  2000/08/31 15:04:43  mju
 * Add default for 'flags' in Parse() method.
 *
 * Revision 1.253  2000/08/29 20:10:33  dwilliss
 * Added case senssitive flag to context
 *
 * Revision 1.251  2000/08/11 20:17:49  mju
 * Add context::setsegment().
 *
 * Revision 1.250  2000/07/17 17:42:30  mju
 * Add const-name versions of AddSymbol and AddClassSymbol.
 *
 * Revision 1.249  2000/06/21 17:25:32  dwilliss
 * Changed object list to keep track of own head/tail, prev/next rather than
 * using MLIST.  MLIST assumes you can make the first element of the
 * structure a LINKEDLISTNODE, but if you have a vtable, you can't
 *
 * Revision 1.248  2000/06/13 20:59:38  dwilliss
 * Added USERDATA to SMLSTRING
 *
 * Revision 1.247  2000/06/09 14:21:30  mju
 * Add context::parse() method using const string.
 *
 * Revision 1.246  2000/06/05 14:09:06  mju
 * Add SMLSYMBOL::SetValue methods using const strings.
 *
 * Revision 1.245  2000/06/05 13:50:47  mju
 * Remove evil inclusion order dependencies.
 * Add SML_EditScript() inline.
 *
 * Revision 1.244  2000/05/26 19:26:09  mju
 * Add SML_ReadScript() using MISTRING.
 *
 * Revision 1.242  2000/05/26 15:19:48  dwilliss
 * Added SMLCONTEXT::CallbackAddGlobal() and reasons
 *
 * Revision 1.241  2000/05/24 22:11:21  mju
 * Add inlines/macros for defining various types of functions.
 * Change DEFINE_SMLCLASS_SIMPLE to take classname.
 * Remove ...FUNCDEFEXT and adjust other macros accordingly.
 * Add SMLCLASSWriteTableObj prototype.
 *
 * Revision 1.240  2000/05/19 22:18:40  mju
 * Add SMLCLASSNAME #defines.
 *
 * Revision 1.239  2000/05/17 22:27:26  dwilliss
 * More doc issues
 *
 * Revision 1.238  2000/05/17 17:37:02  dwilliss
 * More documentation
 *
 * Revision 1.237  2000/05/17 15:59:59  dwilliss
 * More documentation updates.
 * Added StringAlloc methods to SMLCONTEXT so that SMLSTRING's constructors
 *   can become private (some day)
 * SMLTABLEDATA now has some exported methods (data still opaque)
 *
 * Revision 1.236  2000/05/17 14:44:08  mju
 * In _SML_ReadScript use const for filename.
 * Add SML_ReadScript() inline overload that uses FILEPATH and rearranges parms to allow most to have defaults.
 * Add default for element parm in CONTEXT::CallFunction().
 *
 * Revision 1.235  2000/05/16 20:33:04  dwilliss
 * Added ReadElement method to CAD
 *
 * Revision 1.234  2000/05/12 19:59:45  dwilliss
 * Fixed ignore/End comments
 *
 * Revision 1.231  2000/04/28 21:42:27  dwilliss
 * More documentation
 *
 * Revision 1.230  2000/04/28 20:37:47  dwilliss
 * Put extern "C" around some prototypes that I had moved
 *
 * Revision 1.229  2000/04/28 17:49:23  dwilliss
 * Massive changes that were waiting until after 6.3 went out the door
 *
 * Revision 1.227  2000/03/07 20:41:23  dwilliss
 * More methods on context
 *
 * Revision 1.226  2000/03/01 20:32:15  dwilliss
 * Added GeorefCopy() method to context
 *
 * Revision 1.225  2000/02/25 20:50:15  dwilliss
 * Oops.  Added IsDirty method to the wrong class.
 *
 * Revision 1.224  2000/02/25 20:46:24  dwilliss
 * Added IsDirty to SMLOBJECT
 *
 * Revision 1.222  1999/12/08 23:26:00  mju
 * Add macros for creating C++ class definitions.
 *
 * Revision 1.221  1999/12/06 17:27:01  mju
 * Use const filename.
 *
 * Revision 1.220  1999/11/22 17:48:29  scowan
 * More const.
 *
 * Revision 1.219  1999/11/19 23:20:03  dwilliss
 * More comments for documentation.
 * Made some members of classes const pointers
 *
 * Revision 1.214  1999/11/18  16:41:26  dwilliss
 * Added constptr member to SMLARG
 *
* Revision 1.209  1999/10/13 17:49:09  dwilliss
* All members of SMLOBJECT and SMLELEMDATA are private outside of rvcapp.dll
* now.  Must use methods to access them. (Post 6.2 release)
*
* Revision 1.208  1999/10/08 22:03:58  dwilson
* make info a struct in SMLOBJECT
*
* Revision 1.203  1999/09/17 17:15:59  dwilliss
* Added AddClassSymbol()
*
* Revision 1.202  1999/09/17 15:35:20  dwilliss
* Added prototypes for plugin init/stop functions
*
* Revision 1.196  1999/09/03 22:21:30  dwilliss
* Protos for two flavors of SetParentWidget
*
* Revision 1.195  1999/09/03 22:01:42  dwilliss
* Took out inline method in SMLCONTEXT.  Evil!
*
* Revision 1.194  1999/09/03 21:12:28  dwilliss
* More methods on SMLCONTEXT
*
* Revision 1.193  1999/09/02 20:53:53  dwilliss
* Added a bunch of methods to SMLCONTEXT to access members which
* should be private.  (Eventually they will be)
*
 * Revision 1.190  1999/07/07  22:50:39  dwilliss
 * Added some things to a few of the structures
 *
* Revision 1.189  1999/06/28 20:52:25  dwilliss
* Added preprocessor stack
*
* Revision 1.188  1999/06/25 13:56:01  dwilliss
* Got rid of a prototype that should never have been there
*
* Revision 1.187  1999/06/22 16:25:17  dwilson
* Added Desc arg to SMLFUNCDEF2
*
* Revision 1.185  1999/06/18 21:11:30  dwilliss
* Can't make SetString inline if the class is exported from a DLL
*
* Revision 1.184  1999/06/18 19:55:08  dwilliss
* Oops.  semicolon in wrong place
*
* Revision 1.183  1999/06/18 19:48:04  dwilliss
* addes SetString methods to SMLSTRING
*
* Revision 1.182  1999/06/11 15:53:55  dwilliss
* Added some more macros for class/function defn's
*
* Revision 1.181  1999/06/09 16:10:11  mju
* Use WIN32 instead of WIn95.
*
 * Revision 1.180  1999/05/27  15:15:15  mju
 * Include rvcgref as used in many SML modules.
 *
 * Revision 1.179  1999/05/26  16:03:30  mju
 * Include various RVC object headers as need for RVC...INFO structures.
 *
 * Revision 1.178  1999/05/14  19:47:17  dwilson
 * #defines for sml import/export validation functions
 *
 * Revision 1.177  1999/05/07  21:52:54  scowan
 * Foward declare menu stuff.
 *
* Revision 1.176  1999/04/30 22:34:15  dwilson
* changed size of MIEFORMATSMLCLASSARRAYSIZE to 4
*
 * Revision 1.175  1999/04/30  20:23:36  dwilson
 * revert to 2 (for now)
 *
 * Revision 1.174  1999/04/30  17:23:03  dwilson
 * changed MIEFORMATSMLCLASSARRAYSIZE to 4
 *
 * Revision 1.173  1999/04/28  17:40:24  mju
 * Include dispinfo.h.
 *
* Revision 1.167  1999/04/08 14:31:39  mju
* Use inclusion guards around every #include statement.
*
 * Revision 1.166  1999/04/07  19:39:33  dwilliss
 * added flag for WIN32_Native
 *
* Revision 1.164  1999/04/07 16:11:02  dwilliss
* Added a flag to classes to indicate WIN32_NATIVE availability
* Wrote a macro to define classes not available in win32 native
*
* Revision 1.163  1999/03/22 18:18:24  dwilliss
* Added some members to SMLFILEINFO to keep track of poll callback
*
* Revision 1.162  1999/03/17 22:35:42  dwilson
* sml imp/exp constant added
*
 * Revision 1.161  1999/03/12  17:00:07  dwilliss
 * Change SML macro so we can move installer function to different module
 *
* Revision 1.160  1999/03/10 21:01:17  dwilson
* func prototypes for sml import/export
*
* Revision 1.158  1999/03/04 15:07:35  dwilliss
* Renamed new macro so I can use it directly.  Other way had problems
* with preprocessor sometimes
*
* Revision 1.157  1999/03/03 23:05:29  dwilliss
* Added a flags to smlfunc structure
*
* Revision 1.156  1999/02/18 22:59:39  dwilliss
* SMLCLASS constructors behave more like C++ constructors now
*
* Revision 1.155  1999/02/18 20:14:55  dwilliss
* Special way to export classes on the Mac
*
* Revision 1.154  1999/02/18 16:00:58  dwilliss
* RVCAPPCLASSEXPORT now defined in rvcdefns.h, not here
*
* Revision 1.151  1999/02/16 22:49:01  dwilliss
* temp define a constructor for SMLSTRING which takes a (struct _SMLCONTEXT *)
* because programs compiled last week need it.
*
* Revision 1.150  1999/02/16 17:32:00  dwilliss
* Major changes.  Moved a gob of stuff out of dbqueryp.h to here
*
* Revision 1.148  1999/02/05 15:02:53  dwilliss
* IND is no longer an extern double.  It's a #define in ieeefp.h
* Also simplified ISIND and ISINF to use the macros defined
* in ieeefp.h
*
* Revision 1.147  1999/02/03 23:58:25  dwilliss
* Major changes to SMLSTRING
*
* Revision 1.146  1999/01/05 19:13:42  scowan
* Swapped multiple keywords
*
*
*******************************************************************************
*     Defining built-in SML functions:
*
* I   SML built-in functions come in 3 flavors: void, double, and string.
*     Functions should take 3 parameters:
*
*     static void function(numargs, arg, argtype)
*        int numargs;       # of arguments 
*        SMLARG *arg;       Array of arguments 
*        UINT8 *argtype;    STYPE_Xxxx -- See <mi32/dbquery.h> 
*
*     All built-in functions should be declared as static.
*
* II  To install a group of built-in functions, do the following:
*
*     A. For each function:
*        1. Prototype the function.
*        2. Define a static array of SMLPARM.  
*           a. Give one entry for each parameter.  
*           b. Signal the end of the array by defining a paramater
*              with NULL for a name.
*           c. If you request the type STYPE_AnyVal, you may be passed
*              either an STYPE_Constant or STYPE_String.  Check the
*              argtype array in your function and use the parm accordingly.
*           d. If you don't care how many parameters your function gets,
*              name the last parameter (not counting the NULL) "..."
*              This will match 0 or more parameters of the type requested.
*           e. Some parameters can be marked as optional, but then it's
*              up to you to figure out which ones you got.  Put optional
*              parameters at the end.
*              
*     B. Define a static array of SMLFUNC, one entry per function. 
*        the type must be either STYPE_BProcedure (void function),
*        STYPE_Function (function returning double), or STYPE_BSFunction
*        (Function returning SMLSTRING).  You will have to cast the
*        function pointer to (VOIDFUNC), or most compilers will hate you.
*        Signal the end of the array by defining a function with NULL as 
*        a name.
*
* III In the function:
*
*     A. Don't free anything passed to you -- ever!
*     B. The arg array passed is an array of unions.  Use the field that
*        matches the type of data you requested.  Rasters are passed as
*        symbols.  
*     C. If you encounter an error in your function and want to halt the
*        SML script, call one of the following, then return:
*        1. SML_SetErrorCode(int error)
*           Works for any error code listed in <mi32/errcodes.ref>
*        2. SML_SetArgError(int error, int argnum)
*           Works for SML_EXxxxx errors listed below.  Pass the 
*           argument number of the offending argument.
*
* IV. Actual install. 
*     A. Get the SML context (returned from SML_Init)
*     B. Call the following:
*           SML_InstallFunctions(context, class, func_list)
*              void *context;    (returned from SML_Init)
*              char *class;      (example: "test")
*              SMLFUNC *func_list; (see above)
*
*        Function returns 0 or an error code
*     C. In the SML editor, the functions will be shown on the
*        "Symbols..." dialog in a group called (in this example)
*        "function_test".  To make this look better, edit the
*        MIPS resource file and add the following line:
*           *function_test.labelString:      My test functions
*
 * \endif
*/
/*****************************************************************************/

#ifndef INC_MI32_SML_H
#define INC_MI32_SML_H

/*#undef SML_API_CONFORMANCE     Can't have until I can check this include file in */

#ifndef SML_API_CONFORMANCE
#define SML_API_CONFORMANCE 0
#endif

#ifndef  INC_MI32_RVCCAD_H
   #include <mi32/rvccad.h>   /* For RVCCADINFO */
#endif
#ifndef  INC_MI32_RVCGREF_H
   #include <mi32/rvcgref.h> 
#endif
#ifndef  INC_MI32_RVCRAST_H
   #include <mi32/rvcrast.h>  /* For RVCRASTINFO */
#endif
#ifndef  INC_MI32_RVCRGN_H
   #include <mi32/rvcrgn.h>   /* For RVCREGIONINFO */
#endif
#ifndef  INC_MI32_RVCTEXT_H
   #include <mi32/rvctext.h>  /* For RVCTEXTINFO */
#endif
#ifndef  INC_MI32_RVCTIN_H
   #include <mi32/rvctin.h>   /* For RVCTININFO */
#endif
#ifndef  INC_MI32_RVCVECT_H
   #include <mi32/rvcvect.h>  /* For RVCVECTINFO */
#endif
#ifndef  INC_MI32_MGUI_H
   #include <mi32/mgui.h>     /* because we need MDLGPARENT in SMLCONTEXT */
#endif
#ifndef  INC_MI32_INIDEFNS_H
   #include <mi32/inidefns.h>
#endif
#ifndef  INC_MI32_REGION_H
   #include <mi32/region.h>
#endif
#ifndef  INC_MI32_VECFUNCS_H
   #include <mi32/vecfuncs.h> /* for vector toolkit handle VEHANDLE */
#endif
#ifndef  INC_MI32_TINFUNCS_H
   #include <mi32/tinfuncs.h> /* for TIN toolkit handle TEHANDLE */
#endif
#ifndef  INC_MI32_MGD_H
   #include <mi32/mgd.h>      /* have a prototype that takes an MgdGC */
#endif
#ifndef  INC_MI32_MCB_H
   #include <mi32/mcb.h>
#endif
#ifndef  INC_MI32_MATRIX_H
   #include <mi32/matrix.h>
#endif
#ifndef  INC_MI32_CRYPTO_H
   #include <mi32/crypto.h>
#endif
#ifndef  INC_MI32_SIMPLEAR_H
   #include <mi32/simplear.h>
#endif
#ifndef  INC_MI32_MLIST_H
   #include <mi32/mlist.h>
#endif

#ifndef  INC_MI32_TEXTID_H
   #include <mi32/textid.h>
#endif

#ifndef  INC_MI32_DISPINFO_H
   #include <mi32/dispinfo.h>
#endif

#ifndef  INC_MI32_IEEEFP_H
   #include <mi32/ieeefp.h>
#endif

/* Forward Declarations */
struct MENUBARITEM;
struct MENUITEM;

class MISTRING;
class XMLDOC;

#ifdef WINNT
#pragma warning (disable: 4018) /* '!=' : signed/unsigned mismatch */
#pragma warning (disable: 4251) //! struct needs dll-interface blah blah blah
#endif

#ifdef GetObject
//! If we've included windows.h before this, they #defined GetObject 
//! for us.  We don't want it defined!
#undef GetObject
#endif

//! Use this for the desciption field of any member or function that you want
//! the documentation to show as being Deprecated.
//! The last two digits are the version in which the feature will no longer
//! be guarenteed to be available.
#define SML_RETIRE_IN_68   "RetireIn6.8"
#define SML_RETIRE_IN_69   "RetireIn6.9"

/***************************************************************************/
//! definitions used by SML inport/export 
//! allows validation func to know what type of operation is being performed

#define SMLMIE_IMPORTRASTER   1
#define SMLMIE_IMPORTVECTOR   2
#define SMLMIE_IMPORTCAD      3
#define SMLMIE_IMPORTTIN      4
#define SMLMIE_IMPORTDBASE    5

#define SMLMIE_EXPORTRASTER   6
#define SMLMIE_EXPORTVECTOR   7
#define SMLMIE_EXPORTCAD      8
#define SMLMIE_EXPORTTIN      9
#define SMLMIE_EXPORTDBASE    10


/***************************************************************************/
//! Forward decl'n of struct types so we can use pointers to them before
//! Actually defining them

struct DBCALLBACKSTRUCT;
struct SMLARGTYPELIST;
struct SMLELEMDATA;
struct SMLENUMLIST;
struct SMLCLASSSTACK;
struct _SMLTFREF;
struct SMLCONTEXT;
struct SMLSEGMENT;
struct SMLSOURCEINFO;
struct SMLPARSEPOS;
struct SMLFLAG;
struct SMLCLASS;
struct SMLFUNC;
struct SMLPARM;
struct SMLRASTBUF;
struct SMLTABLEDATA;
struct SMLONEXITDATA;
struct SMLMACHINEINSTRUCTION;
struct SMLPREPROCESSORSTACK;
struct MEXTSELELEM;
class  SMLEDITOR;
class  SMLDEBUG;
class SMLPARSER;
class SMLVM;
class SMLMEMPOOL;
class XMLNODE;

class SMLSYMBOL;
class SMLSTRING;
class DEBUGDATA;

#ifndef WIN32_NATIVE
//! Because I need to create a prototype for a method that takes
//! a CWnd even though I may not be compiling WIN32_NATIVE.
class CWnd;
struct _GUID;
#endif

struct ITypeInfo;
struct IDispatch;

class SMLOBJPROXY;

namespace RVC {
   class OBJECT;
   class RASTER;
   class VECTOR;
   class CAD;
   class TIN;
   class SHAPE;
   class REGION;
   }

//!***************************************************************************
//!   SML class names.
//!
//! Some existing code hard-codes the strings.  These defined values should
//! be used instead to avoid use of incorrect names and to make code easier
//! to understand.
//!
//! Class names in SML are case-insensitive.  The convention is to make
//! them all uppercase.  Many existing scripts will have mixed case though.
//!
//! The "Mie" classes are not listed here for simplicity.
//!
//! Keep names in alphabetical order.

#define  SMLCLASSNAME_ALLOCATION          "ALLOCATION"
#define  SMLCLASSNAME_BITMAPPATTERN       "BITMAPPATTERN"
#define  SMLCLASSNAME_BUTTONITEM          "BUTTONITEM"
#define  SMLCLASSNAME_CALLBACKLIST        "CALLBACKLIST"
#define  SMLCLASSNAME_CENTER              "CENTER"
#define  SMLCLASSNAME_COLOR               "COLOR"
#define  SMLCLASSNAME_COLORMAP            "COLORMAP"
#define  SMLCLASSNAME_COMPOSITEWIDGET     "COMPOSITEWIDGET"
#define  SMLCLASSNAME_CONTEXT             "CONTEXT"
#define  SMLCLASSNAME_DATABASE            "DATABASE"
#define  SMLCLASSNAME_DATATIP             "DATATIP"
#define  SMLCLASSNAME_DBEDITOR            "DBEDITOR"
#define  SMLCLASSNAME_DBEDITOR_SINGLERECORDVIEW    "DBEDITOR_SINGLERECORDVIEW"
#define  SMLCLASSNAME_DBEDITOR_SINGLERECORDWIDGET     "DBEDITOR_SINGLERECORDWIDGET"
#define  SMLCLASSNAME_DBEDITOR_TABULARVIEW      "DBEDITOR_TABULARVIEW"
#define  SMLCLASSNAME_DBEDITORTABLE       "DBEDITORTABLE"
#define  SMLCLASSNAME_DBFIELDINFO         "DBFIELDINFO"
#define  SMLCLASSNAME_DBTABLEINFO         "DBTABLEINFO"
#define  SMLCLASSNAME_DBTABLEVAR          "DBTABLEVAR"
#define  SMLCLASSNAME_DIALOGSHELL         "DIALOGSHELL"
#define  SMLCLASSNAME_DISP                "DISP"
#define  SMLCLASSNAME_DISPCALLBACKLIST    "DISPCALLBACKLIST"
#define  SMLCLASSNAME_DISPLAYINFO         "DISPLAYINFO"
#define  SMLCLASSNAME_ELEMSELECTPARMS     "ELEMSELECTPARMS"
#define  SMLCLASSNAME_FILE                "FILE"
#define  SMLCLASSNAME_GEOREF              "GEOREF"
#define  SMLCLASSNAME_GPSCALLBACKLIST     "GPSCALLBACKLIST"
#define  SMLCLASSNAME_GPSDATA             "GPSDATA"
#define  SMLCLASSNAME_GPSPORT             "GPSPORT"
#define  SMLCLASSNAME_GPSSYMBOL           "GPSSYMBOL"
#define  SMLCLASSNAME_GRAPHICSCONTEXT     "GRAPHICSCONTEXT"
#define  SMLCLASSNAME_GRE_GROUP           "GRE_GROUP"
#define  SMLCLASSNAME_GRE_LAYER           "GRE_LAYER"
#define  SMLCLASSNAME_GRE_LAYER_CAD       "GRE_LAYER_CAD"
#define  SMLCLASSNAME_GRE_LAYER_GEOFORMULA   "GRE_LAYER_GEOFORMULA"
#define  SMLCLASSNAME_GRE_LAYER_MAPGRID   "GRE_LAYER_MAPGRID"
#define  SMLCLASSNAME_GRE_LAYER_PINMAP    "GRE_LAYER_PINMAP"
#define  SMLCLASSNAME_GRE_LAYER_RASTER    "GRE_LAYER_RASTER"
#define  SMLCLASSNAME_GRE_LAYER_REGION    "GRE_LAYER_REGION"
#define  SMLCLASSNAME_GRE_LAYER_SCALEBAR  "GRE_LAYER_SCALEBAR"
#define  SMLCLASSNAME_GRE_LAYER_SCRIPT    "GRE_LAYER_SCRIPT"
#define  SMLCLASSNAME_GRE_LAYER_SHAPE     "GRE_LAYER_SHAPE"
#define  SMLCLASSNAME_GRE_LAYER_TEXT      "GRE_LAYER_TEXT"
#define  SMLCLASSNAME_GRE_LAYER_TIN       "GRE_LAYER_TIN"
#define  SMLCLASSNAME_GRE_LAYER_VECTOR    "GRE_LAYER_VECTOR"
#define  SMLCLASSNAME_GRE_LAYERMANAGER    "GRE_LAYERMANAGER"
#define  SMLCLASSNAME_GRE_LAYOUT          "GRE_LAYOUT"
#define  SMLCLASSNAME_GRE_VECTOR_LABELS      "GRE_VECTOR_LABELS"
#define  SMLCLASSNAME_GRE_VECTOR_LINES    "GRE_VECTOR_LINES"
#define  SMLCLASSNAME_GRE_VECTOR_NODES    "GRE_VECTOR_NODES"
#define  SMLCLASSNAME_GRE_VECTOR_POINTS      "GRE_VECTOR_POINTS"
#define  SMLCLASSNAME_GRE_VECTOR_POLYS    "GRE_VECTOR_POLYS"
#define  SMLCLASSNAME_GRE_VIEW            "GRE_VIEW"
#define  SMLCLASSNAME_GRE_VIEWABLE        "GRE_VIEWABLE"
#define  SMLCLASSNAME_GRE_VIEW3D          "GRE_VIEW3D"
#define  SMLCLASSNAME_GROUPXPOSN          "GROUPXPOSN"
#define  SMLCLASSNAME_GROUPYPOSN          "GROUPYPOSN"
#define  SMLCLASSNAME_HISTOGRAM           "HISTOGRAM"
#define  SMLCLASSNAME_INIHANDLE           "INIHANDLE"
#define  SMLCLASSNAME_LEGENDVIEW          "LEGENDVIEW"
#define  SMLCLASSNAME_LINEPATTERN         "LINEPATTERN"
#define  SMLCLASSNAME_LINESTYLE           "LINESTYLE"
#define  SMLCLASSNAME_LMCOMPONANT         "LMCOMPONANT"  //! Spelled incorrectly
#define  SMLCLASSNAME_LMCOMPONENT         SMLCLASSNAME_LMCOMPONANT
#define  SMLCLASSNAME_MAPPROJ             "MAPPROJ"
#define  SMLCLASSNAME_MAT3X3              "MAT3X3"
#define  SMLCLASSNAME_MATRIX              "MATRIX"
#define  SMLCLASSNAME_MDISPREGIONTOOL     "MDISPREGIONTOOL"
#define  SMLCLASSNAME_MDISPTOOL           "MDISPTOOL"
#define  SMLCLASSNAME_MENUITEM            "MENUITEM"
#define  SMLCLASSNAME_NETWORK             "NETWORK"
#define  SMLCLASSNAME_OBJECT              "OBJECT"
#define  SMLCLASSNAME_POINT2D             "POINT2D"
#define  SMLCLASSNAME_POINT3D             "POINT3D"
#define  SMLCLASSNAME_POINTSTYLE          "POINTSTYLE"
#define  SMLCLASSNAME_POINTSYMBOL         "POINTSYMBOL"
#define  SMLCLASSNAME_POINTTOOL           "POINTTOOL"
#define  SMLCLASSNAME_POLYSTYLE           "POLYSTYLE"
#define  SMLCLASSNAME_PORT                "PORT"
#define  SMLCLASSNAME_PORTCALLBACKLIST    "PORTCALLBACKLIST"
#define  SMLCLASSNAME_PRINTPARMS          "PRINTPARMS"
#define  SMLCLASSNAME_PROMPT              "PROMPT"
#define  SMLCLASSNAME_PROMPTNUM           "PROMPTNUM"
#define  SMLCLASSNAME_PROMPTSTR           "PROMPTSTR"
#define  SMLCLASSNAME_PUSHBUTTONITEM      "PUSHBUTTONITEM"
#define  SMLCLASSNAME_RASTER              "RASTER"
#define  SMLCLASSNAME_RASTERINFO          "RASTERINFO"
#define  SMLCLASSNAME_RECT                "RECT"
#define  SMLCLASSNAME_REGION              "REGION"
#define  SMLCLASSNAME_REGIONDATA          "REGIONDATA"
#define  SMLCLASSNAME_REGIONTOOL          "REGIONTOOL"
#define  SMLCLASSNAME_ROUTE               "ROUTE"
#define  SMLCLASSNAME_STATUSCONTEXT       "STATUSCONTEXT"
#define  SMLCLASSNAME_STATUSHANDLE        "STATUSHANDLE"
#define  SMLCLASSNAME_STOP                "STOP"
#define  SMLCLASSNAME_STYLEOBJECT         "STYLEOBJECT"
#define  SMLCLASSNAME_TEXTSTYLE           "TEXTSTYLE"
#define  SMLCLASSNAME_TIMER               "TIMER"
#define  SMLCLASSNAME_TOGGLEBUTTONITEM    "TOGGLEBUTTONITEM"
#define  SMLCLASSNAME_TOOL                "TOOL"
#define  SMLCLASSNAME_TOOLCALLBACKLIST    "TOOLCALLBACKLIST"
#define  SMLCLASSNAME_TOOLTIP             "TOOLTIP"
#define  SMLCLASSNAME_TRANSPARM           "TRANSPARM"
#define  SMLCLASSNAME_VECTOR              "VECTOR"
#define  SMLCLASSNAME_VECTORINFO          "VECTORINFO"
#define  SMLCLASSNAME_VIEWPOINT3D         "VIEWPOINT3D"

#if 0 // ifndef NO_DEPRECATED
//! The following have been renamed to be the same as their C++ counterparts
//! (eg: GRE_LAYER_RASTER).  SML has built-in aliases (setup in qqmdisp.c)
//! to allow it to continue to accept the old names.  But code should refer
//! to them as their new names

//!\deprecated
#define  SMLCLASSNAME_CADLAYER            "CADLAYER"
//!\deprecated
#define  SMLCLASSNAME_GROUP               "GROUP"
//!\deprecated
#define  SMLCLASSNAME_LAYER               "LAYER"
//!\deprecated
#define  SMLCLASSNAME_LAYERMANAGER        "LAYERMANAGER"
//!\deprecated
#define  SMLCLASSNAME_LAYOUT              "LAYOUT"
//!\deprecated
#define  SMLCLASSNAME_MAPGRIDLAYER        "MAPGRIDLAYER"
//!\deprecated
#define  SMLCLASSNAME_PINMAPLAYER         "PINMAPLAYER"
//!\deprecated
#define  SMLCLASSNAME_RASTERLAYER         "RASTERLAYER"
//!\deprecated
#define  SMLCLASSNAME_REGIONLAYER         "REGIONLAYER"
//!\deprecated
#define  SMLCLASSNAME_SCALEBARLAYER       "SCALEBARLAYER"
//!\deprecated
#define  SMLCLASSNAME_TEXTLAYER           "TEXTLAYER"
//!\deprecated
#define  SMLCLASSNAME_TINLAYER            "TINLAYER"
//!\deprecated
#define  SMLCLASSNAME_VECTORLAYER         "VECTORLAYER"
//!\deprecated
#define  SMLCLASSNAME_VECTORLAYERLABELS   "VECTORLAYERLABELS"
//!\deprecated
#define  SMLCLASSNAME_VECTORLAYERLINES    "VECTORLAYERLINES"
//!\deprecated
#define  SMLCLASSNAME_VECTORLAYERNODES    "VECTORLAYERNODES"
//!\deprecated
#define  SMLCLASSNAME_VECTORLAYERPOINTS   "VECTORLAYERPOINTS"
//!\deprecated
#define  SMLCLASSNAME_VECTORLAYERPOLYS    "VECTORLAYERPOLYS"
//!\deprecated
#define  SMLCLASSNAME_VIEW                "VIEW"
//!\deprecated
#define  SMLCLASSNAME_VIEW3D              "VIEW3D"
#endif


//! The following class names are left as mixed case because of historical usage.
#define  SMLCLASSNAME_Widget              "Widget"
#define  SMLCLASSNAME_XmBulletinBoard     "XmBulletinBoard"
#define  SMLCLASSNAME_XmCallbackList      "XmCallbackList"
#define  SMLCLASSNAME_XmDrawingArea       "XmDrawingArea"
#define  SMLCLASSNAME_XmForm              "XmForm"
#define  SMLCLASSNAME_XmFrame             "XmFrame"
#define  SMLCLASSNAME_XmHTML              "XmHTML"
#define  SMLCLASSNAME_XmLabel             "XmLabel"
#define  SMLCLASSNAME_XmManager           "XmManager"
#define  SMLCLASSNAME_XmOptionMenu        "XmOptionMenu"
#define  SMLCLASSNAME_XmPrimitive         "XmPrimitive"
#define  SMLCLASSNAME_XmPushButton        "XmPushButton"
#define  SMLCLASSNAME_XmRowColumn         "XmRowColumn"
#define  SMLCLASSNAME_XmScale             "XmScale"
#define  SMLCLASSNAME_XmScrollBar         "XmScrollBar"
#define  SMLCLASSNAME_XmScrolledWindow    "XmScrolledWindow"
#define  SMLCLASSNAME_XmSeparator         "XmSeparator"
#define  SMLCLASSNAME_XmToggleButton      "XmToggleButton"

/***************************************************************************/
/* 
 *  Symbol types 
 */

#define  STYPE_StrVar         STYPE_StringVar
#define  STYPE_Num            STYPE_Constant //!<  Same as Constant 

enum SMLSTYPE {
   STYPE_Constant = 0,  //!<   0 NUMBER 
   STYPE_NumVar,        //!<   1 FVAR 
   STYPE_StringVar,     //!<   2 SVAR 
   STYPE_Array,         //!<   3 AVAR 
   STYPE_Raster,        //!<   4 RVAR 
   STYPE_Vector,        //!<   5 VVAR 
   STYPE_CAD,           //!<   6 CVAR 
   STYPE_Region,        //!<   7 EGVAR 
   STYPE_TIN,           //!<   8 TINVAR 
   STYPE_RESERVERD,     //!<   9 reserved for whatever 
   STYPE_Keyword,       //!<  10 
   STYPE_Intrinsic,     //!<  11 BLTIN 
   STYPE_UFunction,     //!<  12 FUNCTION - User defined 
   STYPE_UProcedure,    //!<  13 PROCEDURE - User defined 
   STYPE_BFunction,     //!<  14 BFUNCTION - Built-in 
   STYPE_BSFunction,    //!<  15 BSTRFUNC - Built-in 
   STYPE_BProcedure,    //!<  16 PBROCEDURE - Built-in 
   STYPE_Table,         //!<  17 TABLE 
   STYPE_TableVar,      //!<  18 TVAR - pointer to table 
   STYPE_AnyVal,        //!<  19 ANYVAL -- Either NUMBER or STRING 
   STYPE_String,        //!<  20 String 
   STYPE_AnyObject,     //!<  21 RVAR, VVAR, or CVAR 
   STYPE_NumList,       //!<  22 NUMBER, VLVAR, or NUM_OR_LIST 
   STYPE_StrList,       //!<  23 STRING, SLVAR, or STR_OR_LIST 
   STYPE_List,          //!<  24 StrList or NumList 
   STYPE_RecList,       //!<  25 May use NUMLIST instead 
   STYPE_VectFunc,      //!<  26 Function returning an object 
   STYPE_RegionFunc,    //!<  27 Function returning an object 
   STYPE_CADFunc,       //!<  28 Function returning an object 
   STYPE_TINFunc,       //!<  29 Function returning an object 
   STYPE_ClassFunc,     //!<  30 Function returning a class ptr 
   STYPE_ClassVar,      //!<  31 Variable holding a class ptr 
   STYPE_Class,         //!<  32 Just data 
   STYPE_RastListVar,   //!<  33 
   STYPE_VectListVar,   //!<  34 
   STYPE_CADListVar,    //!<  35 
   STYPE_TINListVar,    //!<  36 
   STYPE_RegListVar,    //!<  37 
   STYPE_Enum,          //!<  38 
   STYPE_StrField,      //!<  39 
   STYPE_NumField,      //!<  40 
   STYPE_ClassArrayFunc,//!<  41 Function returning an (SMLCLASSARRAY*) 
   STYPE_ClassArrayVar, //!<  42 
   STYPE_MAXTYPE        //!<  43  Always the last one 
   };

typedef enum SMLSTYPE SMLSTYPE;
/* When adding a new STYPE, be sure to modify the following functions in dbquery.c 
**    DBQuery_STYPEtoString(), DBQuery_STYPEFlags(), 
**    _qq_stype_to_token_val(), _qq_token_val_to_stype()
*/

/***************************************************************************/
//! For historical reasons, these constants are defined weird.  They used to
//! be defined in terms of the #defines produced by YACC for the various
//! keywords.  However, those values were not "fixed" and adding a new terminal
//! to the grammer could cause the "constants" to shift.  This is bad for a
//! dll.  To keep old code working, the enums are defined to be the numbers
//!   that they were at the time I changed this to be an enum and must remain
//!   the same for all time.  

enum SMLSCOPE {
   SCOPE_NONE        = 0,
   SCOPE_TABLE       = 272,
   SCOPE_BFUNCTION   = 280,
   SCOPE_KEYWORD     = 311,
   SCOPE_GLOBAL      = 336,
   SCOPE_LOCAL       = 337,
   SCOPE_PERMANENT   = 1000
   };

typedef enum SMLSCOPE SMLSCOPE;

/***************************************************************************/
#ifndef  INC_MI32_SMLFUNCS_H
   #include <mi32/smlfuncs.h> /* Gives us prototypes for installer functions */
#endif
/***************************************************************************/

typedef long SMLMACHINEINST;  //!<  not (INT32),  Must be same size as (void *) 

/***************************************************************************/
/**
 * Parameter flag value definition
 *
 * These are meant to be statically defined and normally use (char*) in the ASCII 
 * range.  Since there are a few cases where we need Unicode, interpret the name
 * and desc as UTF8.  This will cause no change for statically defined strings,
 * as they're all chars < 128.  In the few places where we need to make one
 * Unicode, convert it to UTF8 and store that.
 */
struct SMLFLAG {
   char *name;
   UINT32 value;
   char *desc;
   };

/* Flags for SML_InstallStaticEnum().  It gets passed an array of SMLFLAGs and we have
*  to tell it what if anything to free when the context is destroied
*/
#define SMLFLAG_FreeName         0x0001
#define SMLFLAG_FreeDesc         0x0002
#define SMLFLAG_FreeFlagArray    0x0004


/***************************************************************************/

//!   \class SMLUSERDATA mi32/sml.h
//!   A class which can be used to hang USERDATA off an SMLSTRING or SMLSYMBOL
//!
//!   To use, you have to derive a class from SMLUSERDATA,
//!   Create your own ID in the enum below, and make your constructor
//! call the base class constructor, passing in your id.
//!
//!   For MicroImages employees adding derived classes, just use the
//! next available number in the TAG enum.   If using TNTsdk,
//! start your numbers at something high like 1024 so there's no
//! chance of conflicting with later additions by MicroImages.
//!   
//!                                                                     
class RVCAPPCLASSEXPORT SMLUSERDATA {
   public:

   enum TAG {
      TAG_NONE       = 0,
      TAG_TABLE      = 1,
      TAG_FIELD      = 2,
      TAG_REGEXP     = 3,
      TAG_FirstUserTag     = 1000,  //!< The first tag that AllocTag will return
      TAG_BIGNUMBER  = 0x7FFFFFF //!< Make compiler use a long, not a byte
      };

   SMLUSERDATA (
      TAG tag
      ) :
      m_tag(tag)
      {
      }

   virtual ~SMLUSERDATA (
      ) {
      }

   //! Allocate a tag to use for a user-defined SMLUSERDATA
   //! Note: You should allocate one and keep it allocated.
   //!   unless you need to attach multiple instances of the
   //!   same type
   static TAG AllocTag(); 

   TAG GetTag (
      ) const {
      return m_tag;
      }

   private:
      #ifndef GENERATING_DOXYGEN_OUTPUT
      TAG m_tag;
      static TAG s_NextTag;
      #endif // GENERATING_DOXYGEN_OUTPUT
   };


#ifndef GENERATING_DOXYGEN_OUTPUT
class SMLUSERDATACONTAINER {
   public:
   SMLUSERDATACONTAINER() : m_userdata(0) {}
   ~SMLUSERDATACONTAINER();
   void Init() { m_userdata = 0; }     //! Used if enclosing class has no constructor
   void Destroy();      //! Used if enclosing class has no destructor

   //! Attach some User Data 
   //! The data to be attached must be derived from SMLUSERDATA, and must have 
   //!   been allocated via "new".  Once attached, the container owns the 
   //! data and will "delete" it when the container is deleted.
   //! Also, if you try to attach something for a user ID that's already in use,
   //! it will delete the existing thing.
   void Attach (
      SMLUSERDATA*
      );

   //! Unattach some User Data.  
   //! If the data to be unattached isn't attached, it just ignores you.
   //! Once unattached, the data is yours to do with as you wish.  You are
   //! responsible for deleting it too.
   void Detach (
      SMLUSERDATA*
      );


   //! Get the User Data. 
   //! If no data for the given id is attached, it will just return NULL   .
   //! Do not free the data returned unless you Unattach it first.
   SMLUSERDATA* Get (
      SMLUSERDATA::TAG
      );

   private:
#ifndef GENERATING_DOXYGEN_OUTPUT
   SIMPLE_ARRAY<SMLUSERDATA*>* m_userdata;   //!< A pointer because it's only allocateed if needed (almost never)
#endif // GENERATING_DOXYGEN_OUTPUT
   };

#endif // GENERATING_DOXYGEN_OUTPUT

/***************************************************************************/
//! \class SMLSTRING mi32/sml.h
//! \brief SML string constant representation
//!
//! \note  The constructors are private. Use the various 
//! SMLCONTEXT::StringAlloc() methods instead.
class RVCAPPCLASSEXPORT SMLSTRING : public MISTRING {

   #if defined (RVCSYSDLL)
   public:
   #else
   private:
   #endif

#ifndef GENERATING_DOXYGEN_OUTPUT
   //! Constructors are private outside the DLL

   //! Constructor for empty string.
   SMLSTRING (
      );

   //! Constructor for ASCII (ISO-2022) string.
   //! Direct use of constructor outside rvcsys.dll deprecated
   //! use context->StringAlloc() instead, since the application
   //! doesn't know the size of an SMLSTRING.
   SMLSTRING (
      const char *s
      );

   //! Constructor for any encoding SMLSTRING
   //! Direct use of constructor outside rvcsys.dll deprecated
   //! use context->StringAlloc() instead, since the application
   //! doesn't know the size of an SMLSTRING.
   SMLSTRING (
      const void *s,
      CHAR_ENCODING encoding
      );

   //! Constructor for Unicode string.
   //! Direct use of constructor outside rvcsys.dll deprecated
   //! use context->StringAlloc() instead, since the application
   //! doesn't know the size of an SMLSTRING
   SMLSTRING (
      const UNICODE *s
      );

   //! Constructor for UTF8 string.
   //! Direct use of constructor outside rvcsys.dll deprecated
   //! use context->StringAlloc() instead, since the application
   //! doesn't know the size of an SMLSTRING
   SMLSTRING (
      const UINT8 *s
      );


   //! Destructor.
   ~SMLSTRING();
   
#endif // GENERATING_DOXYGEN_OUTPUT
public:


   //! Attach some User Data to the string.  
   //! The data to be attached must be derived from SMLUSERDATA, and must have 
   //!   been allocated via "new".  Once attached to the string, the string owns the 
   //! data and will "delete" it when the string is deleted.
   //! Also, if you try to attach something for a user ID that's already in use,
   //! it will delete the existing thing.
   void AttachUserData (
      SMLUSERDATA* data
      );

   //! Detach some User Data from the string.  
   //! If the data to be unattached isn't attached, it just ignores you.
   //! Once detached, the data is yours to do with as you wish.  You are
   //! responsible for deleting it too.
   void DetachUserData (
      SMLUSERDATA* data
      );


   //! Get the User Data attached to a string.
   //! If no data for the given id is attached, it will just return NULL   .
   //! Do not free the data returned unless you Unattach it first.
   SMLUSERDATA* GetUserData (
      SMLUSERDATA::TAG tag
      );

   //! Increment refcount.
   void IncRefCount ();

   //! Decrement refcount.  If it goes to zero, string deletes itself.
   void DecRefCount ();

   //! Prevent garbage collection from deleting this string.
   //! Used if the string is a "constant" in the script and
   //! the pointer to it is in the SML code
   void Lock (
      );

   int GetRefCount (
      ) const;

#if /* !defined(NO_DEPRECATED) || */ defined(RVCSYSDLL)  
   //! Get the length of the string
   //! \deprecated Now that SMLSTRING is derived from MISTRING, just use its
   //!   GetLength() method
   int GetLen (
      ) const;

   //! Returns the internal character encoding for this string.
   //! \deprecated.  Strings are always Unicode now and this always returns -1
   int GetEncoding (
      ) const;
#endif

   
   //! Lookup a string value in an array of SMLFLAGS.
   //!
   //! In an SML function, a parameter may be defined to be STYPE_String
   //! even though internally you want a number.  This function allows you
   //! to look up the value in an array of SMLFLAGs
   //!
   //! @return -1 if the string could not be found in the SMLF